katarakt.txt 5.9 KB
Newer Older
1
2
3
4
5
6
7
8
katarakt(1)
===========
:doctype: manpage
:man source: Katarakt
:man manual: Katarakt Manual

NAME
----
Philipp Erhardt's avatar
Philipp Erhardt committed
9
katarakt - a simple PDF viewer with three layouts
10
11
12

SYNOPSIS
--------
Philipp Erhardt's avatar
Philipp Erhardt committed
13
*katarakt* (['OPTIONS'] 'FILE'|'URL')*
14
15
16
17
18

DESCRIPTION
-----------
It's a PDF viewer. It views PDFs.

Philipp Erhardt's avatar
Philipp Erhardt committed
19
There are currently three layouts. The 'presentation layout' is very simple and
20
21
22
23
24
25
26
27
only supports scrolling on a per page basis. As the name suggests the current
page is displayed in the center and zoomed to fit the window. It is active by
default.

The 'grid layout' is much more advanced and offers continuous (smooth, per
pixel) scrolling, zooming and adjusting the column count. Pages keep their
correct relative size and are shown in a grid.

Philipp Erhardt's avatar
Philipp Erhardt committed
28
29
30
31
32
The 'presenter layout' is for giving a presentation. It opens a second window,
to be viewed on the beamer, and shows the current and next slide in the main
window.

For every file passed on the command line a separate process is spawned.
33

34
35
OPTIONS
-------
Philipp Erhardt's avatar
Philipp Erhardt committed
36
*-p*, *--page* 'NUM' ::
Philipp Erhardt's avatar
Philipp Erhardt committed
37
	Start on page 'NUM'.
Philipp Erhardt's avatar
Philipp Erhardt committed
38
*-f*, *--fullscreen* ::
39
	Start in fullscreen mode.
Philipp Erhardt's avatar
Philipp Erhardt committed
40
41
42
*-q*, *--quit* ::
	Quit on initialization failure.
*-h*, *--help* ::
43
44
	Print help and exit.

Philipp Erhardt's avatar
Philipp Erhardt committed
45
46
47
48
49
CONFIGURATION
-------------
Variables and key bindings can be changed by modifying the katarakt.ini file.
By default it is read from '$XDG_CONFIG_HOME'.

50
51
52
Variables must be listed under the section "[Settings]", keys under section
"[Keys]".  For a list of all variables with a short explanation see below.

53
54
55
KEY BINDINGS
------------
*q* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
56
	Quit *katarakt*.
57
58
*1* ::
	Switch to 'presentation layout'. Views a single page at a time, scaled to
Philipp Erhardt's avatar
Philipp Erhardt committed
59
	fit the screen.
60
61
62
*2* ::
	Switch to 'grid layout'. Views pages in a continuous fashion, scaled to fit
	the width. Supports columns.
Philipp Erhardt's avatar
Philipp Erhardt committed
63
64
65
66
*3* ::
	Switch to 'presenter layout'. Views the current page and a smaller preview
	of the next page. Also, opens a second window that shows only the current
	page for displaying on a beamer.
67

Philipp Erhardt's avatar
Philipp Erhardt committed
68
*Up*, *Down*, *Left*, *Right*, *k*, *j*, *h*, *l* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
69
	Move around (up/down/left/right).
Philipp Erhardt's avatar
Philipp Erhardt committed
70
*\^u*, *^d* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
71
	Scroll up/down half the screen.
Philipp Erhardt's avatar
Philipp Erhardt committed
72
*BackSpace*, *Space*, *\^b*, *^f* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
73
	Scroll up/down the screen. By default scrolls 90% to create an overlapping region.
Philipp Erhardt's avatar
Philipp Erhardt committed
74
*PgUp*, *PgDown* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
75
	Scroll up/down one page. Kind of swaps the pages in place.
Philipp Erhardt's avatar
Philipp Erhardt committed
76

77
*Home*, *End*, *g*, *G* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
78
	Go to the first/last page.
79
*^g* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
80
	Show 'goto page' bar.
81
*f* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
82
	Toggle fullscreen.
83
*t* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
84
	Toggle the page number display in the bottom right corner.
85
*r* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
86
87
	Reload the document. This can also be achieved by sending SIGUSR1 to the
	process. *katarakt* reloads automatically if the opened file has changed.
Philipp Erhardt's avatar
Philipp Erhardt committed
88
*o* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
89
	Open a different document; shows a file dialog.
Philipp Erhardt's avatar
Philipp Erhardt committed
90
91
*F9* ::
	Toggle the table of contents.
92
*-*, *+*, *=* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
93
	Adjust zoom level ('grid layout' only).
94
*z* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
95
	Reset zoom level to default, i.e. fit width ('grid layout' only).
96
*[*, *]* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
97
	Adjust column count ('grid layout' only).
Philipp Erhardt's avatar
Philipp Erhardt committed
98
99
100
*{*, *}* ::
	Adjust the column the first page will be displayed in. Useful for reading
	in a book layout with a cover page ('grid layout' only).
101
*/* ::
102
	Show the search bar. Hitting *Esc* will hide the results, searching for an
Philipp Erhardt's avatar
Philipp Erhardt committed
103
104
	empty string will clear them. If the search term contains an uppercase
	letter the search is case sensitive ("smartcase").
105
106
*?* ::
	Show the search bar. This next search will be backwards.
107
*n*, *N* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
108
	Focus next/previous search hit.
109
*\^n*, *^N* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
110
	Focus next/previous search hit that is currently not visible.
111
*,*, *.* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
112
	Rotate pages left/right.
Philipp Erhardt's avatar
Philipp Erhardt committed
113
*\^o*, *^i*, *Alt-Left*, *Alt-Right* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
114
	Move backward/forward through the jump list. Entries are added automatically when jumping.
115
116
117
118

*m* ::
   Manually add the current page to the jump list.

119
*i* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
120
	Toggle between normal and inverted color rendering.
121

Philipp Erhardt's avatar
Philipp Erhardt committed
122
123
VARIABLES
---------
124
125
126
127
'string' *background_color* ::
	0xDF000000: Background color in ARGB Format. Alpha only works when using a compositor.
'string' *background_color_fullscreen* ::
	0xFF000000: Fullscreen background color in ARGB Format.
128
'string' *default_layout* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
129
	presentation: The layout on startup. Possible values: 'presentation', 'grid'.
Philipp Erhardt's avatar
Philipp Erhardt committed
130
'int' *mouse_wheel_factor* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
131
	120: QT delta for turning the mouse wheel 1 click.
Philipp Erhardt's avatar
Philipp Erhardt committed
132
'int' *smooth_scroll_delta* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
133
	30: Pixel offset when moving around.
Philipp Erhardt's avatar
Philipp Erhardt committed
134
'float' *screen_scroll_factor* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
135
	0.9: Factor for scrolling the screen. Should be \<= 1 to create an overlapping region.
Philipp Erhardt's avatar
Philipp Erhardt committed
136
137

'int' *useless_gap* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
138
	2: Gap between two pages in 'grid layout' in pixels.
Philipp Erhardt's avatar
Philipp Erhardt committed
139
'int' *min_page_width* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
140
	150: Pages can not be smaller than this.
Philipp Erhardt's avatar
Philipp Erhardt committed
141
'int' *min_zoom* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
142
	-14: Smallest zoom value.
Philipp Erhardt's avatar
Philipp Erhardt committed
143
'int' *max_zoom* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
144
	30: Biggest zoom value.
Philipp Erhardt's avatar
Philipp Erhardt committed
145
'float' *zoom_factor* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
146
	0.05: Influences the number of steps between min and max.
Philipp Erhardt's avatar
Philipp Erhardt committed
147
'int' *prefetch_count* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
148
	3: Number of pages exceeding the currently visible ones to render, back- and forwards respectively.
Philipp Erhardt's avatar
Philipp Erhardt committed
149
'float' *search_padding* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
150
	0.2: Factor of the area on the screen to display search hits in. Moves search hits towards the center.
Philipp Erhardt's avatar
Philipp Erhardt committed
151
152

'bool' *smooth_downscaling* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
153
	true: Enables the higher quality downsampling filter.
Philipp Erhardt's avatar
Philipp Erhardt committed
154
'int' *thumbnail_size* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
155
	32: One dimension of square thumbnails saved at run-time for every page that was once rendered.
Philipp Erhardt's avatar
Philipp Erhardt committed
156
157

'int' *rect_expansion* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
158
	2: Number of pixels search rects are expanded by.
159

Philipp Erhardt's avatar
Philipp Erhardt committed
160
'bool' *quit_on_init_fail* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
161
	false: Quit katarakt if the document fails to open.
Philipp Erhardt's avatar
Philipp Erhardt committed
162
163
164
'string' *icon_theme* ::
	The name of your icon theme. Fill in if auto detection fails.

165
166
167
168
169
170
171
172
173
'int' *click_link_button* ::
	1: The mouse button used for clicking links. Buttons 1-5 are supported.
'int' *drag_view_button* ::
	2: The mouse button used for scrolling the view. Double-clicking this
	button centers the view around the location of the click.
'int' *select_text_button* ::
	1: The mouse button used for text selection. Double- and triple-clicking
	are supported to select with word/line granularity.

174
175
176
177
178
179
180
181
182
183
184
COMMUNITY
---------
Feel free to join the IRC channel '#katarakt' on freenode.

AUTHOR
------
*katarakt* is written by Philipp Erhardt.

RESOURCES
---------
Gitweb: <http://git.cs.fau.de/?p=katarakt>
185
186

Homepage: <http://git.cs.fau.de/~go18gomu/katarakt/>