katarakt.txt 6.63 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
--------
13
*katarakt* (['OPTIONS'] 'FILE'|(-u '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
-------
36
37
*-u*, *--url* ::
	Instead of opening a local document, download it from the given URL.
Philipp Erhardt's avatar
Philipp Erhardt committed
38
*-p*, *--page* 'NUM' ::
Philipp Erhardt's avatar
Philipp Erhardt committed
39
	Start on page 'NUM'.
Philipp Erhardt's avatar
Philipp Erhardt committed
40
*-f*, *--fullscreen* ::
41
	Start in fullscreen mode.
Philipp Erhardt's avatar
Philipp Erhardt committed
42
43
44
*-q*, *--quit* ::
	Quit on initialization failure.
*-h*, *--help* ::
45
	Print help and exit.
46
47
48
*--write-defaults* 'FILE'::
	Write the built-in default configuration to 'FILE' and exit. Hint: on unix
	systems, you can use '--write-defaults /dev/stdout' to print the defaults.
49
50
*--single-instance* 'true'|'false'::
	Sets *single_instance_per_file* for the present katarakt instance only.
51

Philipp Erhardt's avatar
Philipp Erhardt committed
52
53
54
55
56
CONFIGURATION
-------------
Variables and key bindings can be changed by modifying the katarakt.ini file.
By default it is read from '$XDG_CONFIG_HOME'.

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

60
61
62
KEY BINDINGS
------------
*q* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
63
	Quit *katarakt*.
64
65
*1* ::
	Switch to 'presentation layout'. Views a single page at a time, scaled to
Philipp Erhardt's avatar
Philipp Erhardt committed
66
	fit the screen.
67
68
69
*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
70
71
72
73
*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.
74

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

84
*Home*, *End*, *g*, *G* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
85
	Go to the first/last page.
86
*^g* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
87
	Show 'goto page' bar.
88
*f* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
89
	Toggle fullscreen.
90
*t* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
91
	Toggle the page number display in the bottom right corner.
92
*r* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
93
94
	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
95
*o* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
96
	Open a different document; shows a file dialog.
97
98
*s* ::
	Show a file dialog to save the current document.
Philipp Erhardt's avatar
Philipp Erhardt committed
99
100
*F9* ::
	Toggle the table of contents.
101
*-*, *+*, *=* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
102
	Adjust zoom level ('grid layout' only).
103
*z* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
104
	Reset zoom level to default, i.e. fit width ('grid layout' only).
105
*[*, *]* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
106
	Adjust column count ('grid layout' only).
Philipp Erhardt's avatar
Philipp Erhardt committed
107
108
109
*{*, *}* ::
	Adjust the column the first page will be displayed in. Useful for reading
	in a book layout with a cover page ('grid layout' only).
110
*/* ::
111
	Show the search bar. Hitting *Esc* will hide the results, searching for an
Philipp Erhardt's avatar
Philipp Erhardt committed
112
113
	empty string will clear them. If the search term contains an uppercase
	letter the search is case sensitive ("smartcase").
114
115
*?* ::
	Show the search bar. This next search will be backwards.
116
*n*, *N* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
117
	Focus next/previous search hit.
118
*\^n*, *^N* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
119
	Focus next/previous search hit that is currently not visible.
120
*,*, *.* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
121
	Rotate pages left/right.
Philipp Erhardt's avatar
Philipp Erhardt committed
122
*\^o*, *^i*, *Alt-Left*, *Alt-Right* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
123
	Move backward/forward through the jump list. Entries are added automatically when jumping.
124
125
*^c* ::
	Copy the current selection to the global clipboard.
126
127
128
129

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

130
*i* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
131
	Toggle between normal and inverted color rendering.
132

133
134
135
*v* ::
	Swap the mouse buttons for selection and panning.

Philipp Erhardt's avatar
Philipp Erhardt committed
136
137
VARIABLES
---------
138
139
140
141
'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.
142
'string' *default_layout* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
143
	presentation: The layout on startup. Possible values: 'presentation', 'grid'.
Philipp Erhardt's avatar
Philipp Erhardt committed
144
'int' *mouse_wheel_factor* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
145
	120: QT delta for turning the mouse wheel 1 click.
Philipp Erhardt's avatar
Philipp Erhardt committed
146
'int' *smooth_scroll_delta* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
147
	30: Pixel offset when moving around.
Philipp Erhardt's avatar
Philipp Erhardt committed
148
'float' *screen_scroll_factor* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
149
	0.9: Factor for scrolling the screen. Should be \<= 1 to create an overlapping region.
Philipp Erhardt's avatar
Philipp Erhardt committed
150
151

'int' *useless_gap* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
152
	2: Gap between two pages in 'grid layout' in pixels.
Philipp Erhardt's avatar
Philipp Erhardt committed
153
'int' *min_page_width* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
154
	150: Pages can not be smaller than this.
Philipp Erhardt's avatar
Philipp Erhardt committed
155
'int' *min_zoom* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
156
	-14: Smallest zoom value.
Philipp Erhardt's avatar
Philipp Erhardt committed
157
'int' *max_zoom* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
158
	30: Biggest zoom value.
Philipp Erhardt's avatar
Philipp Erhardt committed
159
'float' *zoom_factor* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
160
	0.05: Influences the number of steps between min and max.
Philipp Erhardt's avatar
Philipp Erhardt committed
161
'int' *prefetch_count* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
162
	3: Number of pages exceeding the currently visible ones to render, back- and forwards respectively.
Philipp Erhardt's avatar
Philipp Erhardt committed
163
'float' *search_padding* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
164
	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
165
166

'bool' *smooth_downscaling* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
167
	true: Enables the higher quality downsampling filter.
Philipp Erhardt's avatar
Philipp Erhardt committed
168
'int' *thumbnail_size* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
169
	32: One dimension of square thumbnails saved at run-time for every page that was once rendered.
Philipp Erhardt's avatar
Philipp Erhardt committed
170
171

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

Philipp Erhardt's avatar
Philipp Erhardt committed
174
'bool' *quit_on_init_fail* ::
Philipp Erhardt's avatar
Philipp Erhardt committed
175
	false: Quit katarakt if the document fails to open.
176
177
178
'bool' *single_instance_per_file* ::
	If set and katarakt is called with a file that is already shown in another
	katarakt instance, then the other katarakt window is activated instead.
Philipp Erhardt's avatar
Philipp Erhardt committed
179
180
181
'string' *icon_theme* ::
	The name of your icon theme. Fill in if auto detection fails.

182
183
184
185
186
187
188
189
190
'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.

191
192
193
194
195
196
197
198
199
200
201
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>
202
203

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