zathura.1.rst 6.9 KB
Newer Older
Moritz Lipp's avatar
Moritz Lipp committed
1
2
3
4
5
6
Manpage
=======

Synopsis
--------

Sebastian Ramacher's avatar
Sebastian Ramacher committed
7
8
9
10
zathura [-e XID] [-c PATH] [-d PATH] [-p PATH] [-w PASSWORD] [-P NUMBER]
[--fork] [-l LEVEL] [-s] [-x CMD] [--synctex-forward INPUT] [--synctex-pid PID]
[-find STRING]
<files>
Moritz Lipp's avatar
Moritz Lipp committed
11

12
13
14
Description
-----------

Sebastian Ramacher's avatar
Sebastian Ramacher committed
15
16
17
**zathura** displays the given files. If a single hyphen-minus (-) is given as
file name, the content will be read from the standard input. If no files are
given, an empty **zathura** instance launches.
18

Moritz Lipp's avatar
Moritz Lipp committed
19
20
21
Options
-------

Sebastian Ramacher's avatar
Sebastian Ramacher committed
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
-e, --reparent=xid
  Reparents to window specified by xid

-c, --config-dir=path
  Path to the config directory

-d, --data-dir=path
  Path to the data directory

-p, --plugins-dir=path
  Path to the directory containing plugins

-w, --password=password
  The documents password. If multiple documents are opened at once, the
  password will be used for the first one and zathura will ask for the
  passwords of the remaining files if needed.

-P, --page=number
  Opens the document at the given page number. Pages are numbered starting
  with 1, and negative numbers indicate page numbers starting from the end
  of the document, -1 being the last page.

-f, --find=string
  Opens the document and searches for the given string.

-l, --log-level=level
  Set log level (debug, info, warning, error)

-x, --synctex-editor-command=command
  Set the synctex editor command. Overrides the synctex-editor-command setting.

--synctex-forward=input
  Jump to the given position. The switch expects the same format as specified
  for synctex's view -i. If no instance is running for the specified document,
  a new instance will be launched (only if --synctex-pid is not specified).

--synctex-pid=pid
  Instead of looking for an instance having the correct file opened, try only
  the instance with the given PID. Note that if the given PID does not have the
  correct file open or does not exist, no new instance will be spanned.

--mode=mode
  Start in a non-default mode

--fork
  Fork into background

--version
  Display version string and exit

--help
  Display help and exit
Moritz Lipp's avatar
Moritz Lipp committed
74
75
76
77

Mouse and key bindings
----------------------

Sebastian Ramacher's avatar
Sebastian Ramacher committed
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
General

  J, PgDn
    Go to the next page
  K, PgUp
    Go to the previous page
  h, k, j, l
    Scroll to the left, down, up or right direction
  Left, Down, Up, Right
    Scroll to the left, down, up or right direction
  ^t, ^d, ^u, ^y
    Scroll a half page left, down, up or right
  t, ^f, ^b, space, <S-space>, y
    Scroll a full page left, down, up or right
  gg, G, nG
    Goto to the first, the last or to the nth page
  P
    Snaps to the current page
  H, L
    Goto top or bottom of the current page
  ^o, ^i
    Move backward and forward through the jump list
  ^j, ^k
    Bisect forward and backward between the last two jump points
  ^c, Escape
    Abort
  a, s
    Adjust window in best-fit or width mode
  /, ?
    Search for text
  n, N
    Search for the next or previous result
  o, O
    Open document
  f
    Follow links
  F
    Display link target
Karel Král's avatar
Karel Král committed
116
117
  c
    Copy link target into the clipboard
Sebastian Ramacher's avatar
Sebastian Ramacher committed
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
  \:
    Enter command
  r
    Rotate by 90 degrees
  ^r
    Recolor (grayscale and invert colors)
  R
    Reload document
  Tab
    Show index and switch to **Index mode**
  d
    Toggle dual page view
  F5
    Switch to presentation mode
  F11
    Switch to fullscreen mode
  ^m
    Toggle inputbar
  ^n
    Toggle statusbar
  +, -, =
    Zoom in, out or to the original size
  zI, zO, z0
    Zoom in, out or to the original size
  n=
    Zoom to size n
  mX
    Set a quickmark to a letter or number X
  'X
    Goto quickmark saved at letter or number X
  q
    Quit


Fullscreen mode

  J, K
    Go to the next or previous page
  space, <S-space>, <BackSpace>
    Scroll a full page down or up
  gg, G, nG
    Goto to the first, the last or to the nth page
  ^c, Escape
    Abort
  F11
    Switch to normal mode
  +, -, =
    Zoom in, out or to the original size
  zI, zO, z0
    Zoom in, out or to the original size
  n=
    Zoom to size n
  q
    Quit

Presentation mode

  space, <S-space>, <BackSpace>
    Scroll a full page down or up
  ^c, Escape
    Abort
  F5
    Switch to normal mode
  q
    Quit

Index mode

  k, j
    Move to upper or lower entry
  l
    Expand entry
  L
    Expand all entries
  h
    Collapse entry
  H
    Collapse all entries
  space, Return
    Select and open entry


Mouse bindings

  Scroll
    Scroll up or down
  ^Scroll
    Zoom in or out
  Hold Button2
    Pan the document
  Button1
    Follow link

Moritz Lipp's avatar
Moritz Lipp committed
211
212
213
214

Commands
---------

Sebastian Ramacher's avatar
Sebastian Ramacher committed
215
216
217
218
219
220
221
222
223
224
225
226
227
bmark
  Save a bookmark

bdelete
  Delete a bookmark

blist
  List bookmarks

close
  Close document

exec
228
229
  Execute an external command. ``$FILE`` expands to the current document path,
  and ``$PAGE`` to the current page number
Sebastian Ramacher's avatar
Sebastian Ramacher committed
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250

info
  Show document information

open
  Open a document

offset
  Set page offset

print
  Print document

write(!)
  Save document (and force overwriting)

export
  Export attachments

dump
  Write values, descriptions, etc. of all current settings to a file.
Moritz Lipp's avatar
Moritz Lipp committed
251
252
253
254

Configuration
-------------

Sebastian Ramacher's avatar
Sebastian Ramacher committed
255
256
257
The default appearance and behaviour of zathura can be overwritten by modifying
the *zathurarc* file (default path: ~/.config/zathura/zathurarc). For a detailed
description please consult zathurarc(5).
Moritz Lipp's avatar
Moritz Lipp committed
258
259
260
261

Synctex support
---------------

Sebastian Ramacher's avatar
Sebastian Ramacher committed
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
Both synctex forward and backwards synchronization are supported by zathura, To
enable synctex forward synchronization, please look at the *--synctex-forward*
and *--synctex-editor* options. zathura will also emit a signal via the D-Bus
interface. To support synctex backwards synchronization, zathura provides a
D-Bus interface that can be called by the editor. For convince zathura also
knows how to parse the output of the *synctex view* command. It is enough to
pass the arguments to *synctex view*'s *-i* option to zathura via
*--synctex-forward* and zathura will pass the information to the correct
instance.

For gvim forward and backwards synchronization support can be set up as follows:
First add the following to the vim configuration:

::

    function! Synctex()
      execute "silent !zathura --synctex-forward " . line('.') . ":" . col('.') . ":" . bufname('%') . " " . g:syncpdf
      redraw!
    endfunction
    map <C-enter> :call Synctex()<cr>

Then launch *zathura* with

::

    zathura -x "gvim --servername vim -c \"let g:syncpdf='$1'\" --remote +%{line} %{input}" $file

Some editors support zathura as viewer out of the box:

* LaTeXTools for SublimeText
  (https://latextools.readthedocs.io/en/latest/available-viewers/#zathura)
* LaTeX for Atom (https://atom.io/packages/latex)
Moritz Lipp's avatar
Moritz Lipp committed
294

295
296
297
Environment variables
---------------------

Sebastian Ramacher's avatar
Sebastian Ramacher committed
298
299
300
ZATHURA_PLUGINS_PATH
  Path to the directory containing plugins. This directory is only considered if
  no other directory was specified using --plugins-dir.
301

Moritz Lipp's avatar
Moritz Lipp committed
302
303
304
Known bugs
----------

Sebastian Ramacher's avatar
Sebastian Ramacher committed
305
306
307
308
If GDK_NATIVE_WINDOWS is enabled you will experience problems with large
documents. In this case zathura might crash or pages cannot be rendered
properly. Disabling GDK_NATIVE_WINDOWS fixes this issue. The same issue may
appear, if overlay-scrollbar is enabled in GTK_MODULES.
Moritz Lipp's avatar
Moritz Lipp committed
309
310
311
312

See Also
--------
`zathurarc(5)`