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

NAME
----
katarakt - a simple PDF viewer with two layouts

SYNOPSIS
--------
Philipp Erhardt's avatar
Philipp Erhardt committed
13
*katarakt* (['OPTIONS'] 'FILE'|'URL')*
14
15
16
17
18
19
20
21
22
23
24
25
26
27

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

There are currently two layouts.  The 'presentation layout' is very simple and
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.

28
29
For every file passed on the command line a process is spawned.

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

Philipp Erhardt's avatar
Philipp Erhardt committed
41
42
43
44
45
CONFIGURATION
-------------
Variables and key bindings can be changed by modifying the katarakt.ini file.
By default it is read from '$XDG_CONFIG_HOME'.

46
47
48
49
50
51
52
53
54
55
56
KEY BINDINGS
------------
*q* ::
	Quit *katarakt*
*1* ::
	Switch to 'presentation layout'. Views a single page at a time, scaled to
	fit the screen
*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
57
58
59
60
61
62
63
64
65
*Up*, *Down*, *Left*, *Right*, *k*, *j*, *h*, *l* ::
	Move around (up/down/left/right)
*\^u*, *^d* ::
	Scroll up/down half the screen
*BackSpace*, *Space*, *\^b*, *^f* ::
	Scroll up/down the screen. By default scrolls 90% to create an overlapping region
*PgUp*, *PgDown* ::
	Scroll up/down one page. Kind of swaps the pages in place

66
*Home*, *End*, *g*, *G* ::
67
68
69
70
71
72
73
74
75
	Go to the first/last page
*^g* ::
	Show 'goto page' bar
*f* ::
	Toggle fullscreen
*t* ::
	Toggle page number display
*r* ::
	Reload document
Philipp Erhardt's avatar
Philipp Erhardt committed
76
77
*o* ::
	Open a different document, shows a file dialog
78
79
80
81
82
83
84
85
86
*-*, *+*, *=* ::
	Adjust zoom level ('grid layout' only)
*z* ::
	Reset zoom level to default, i.e. fit width ('grid layout' only)
*[*, *]* ::
	Adjust column count ('grid layout' only)
*/* ::
	Show search bar
*n*, *N* ::
87
	Focus next/previous search hit
88
89
*\^n*, *^N* ::
	Focus next/previous search hit that is currently not visible
90
*,*, *.* ::
91
	Rotate pages left/right
Philipp Erhardt's avatar
Philipp Erhardt committed
92
93
*\^o*, *^i*, *Alt-Left*, *Alt-Right* ::
	Move backward/forward through the jump list. Entries are added automatically when jumping
94

Philipp Erhardt's avatar
Philipp Erhardt committed
95
96
VARIABLES
---------
97
98
'int' *background_opacity* ::
	223: opacity of the black background in range [0..255]. Only works when using a compositor.
99
100
'string' *default_layout* ::
	presentation: the layout on startup. Possible values: 'presentation', 'grid'
Philipp Erhardt's avatar
Philipp Erhardt committed
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
'int' *mouse_wheel_factor* ::
	120: QT delta for turning the mouse wheel 1 click
'int' *smooth_scroll_delta* ::
	30: pixel offset when moving around
'float' *screen_scroll_factor* ::
	0.9: factor for scrolling the screen. Should be \<= 1 to create an overlapping region

'int' *useless_gap* ::
	2: gap between two pages in pixels
'int' *min_page_width* ::
	150: pages can not be smaller than this
'int' *min_zoom* ::
	-14: smallest zoom value
'int' *max_zoom* ::
	30: biggest zoom value
'float' *zoom_factor* ::
	0.05: influences the number of steps between min and max
'int' *prefetch_count* ::
	3: number of pages exceeding the currently visible ones to render, back- and forwards respectively
'float' *search_padding* ::
	0.2: factor of the area on the screen to display search hits in. Moves search hits towards the center

'bool' *smooth_downscaling* ::
	true: enables the higher quality downsampling filter
'int' *thumbnail_size* ::
	32: one dimension of square thumbnails saved at run-time for every page that was once rendered

'int' *rect_expansion* ::
	2: number of pixels search rects are expanded by
130

Philipp Erhardt's avatar
Philipp Erhardt committed
131
132
133
134
135
'bool' *quit_on_init_fail* ::
	false: Quit katarakt if the document fails to open
'string' *icon_theme* ::
	The name of your icon theme. Fill in if auto detection fails.

136
137
138
139
140
141
142
143
144
145
146
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>
147
148

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