extra/zathura/files/zathura.1

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .TH "ZATHURA" "1" "2019-09-08" "0.4.4" "zathura"
   4 .SH NAME
   5 zathura \- a document viewer
   6 .
   7 .nr rst2man-indent-level 0
   8 .
   9 .de1 rstReportMargin
  10 \\$1 \\n[an-margin]
  11 level \\n[rst2man-indent-level]
  12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  13 -
  14 \\n[rst2man-indent0]
  15 \\n[rst2man-indent1]
  16 \\n[rst2man-indent2]
  17 ..
  18 .de1 INDENT
  19 .\" .rstReportMargin pre:
  20 . RS \\$1
  21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  22 . nr rst2man-indent-level +1
  23 .\" .rstReportMargin post:
  24 ..
  25 .de UNINDENT
  26 . RE
  27 .\" indent \\n[an-margin]
  28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .nr rst2man-indent-level -1
  30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  32 ..
  33 .SH SYNOPSIS
  34 .sp
  35 zathura [\-e XID] [\-c PATH] [\-d PATH] [\-p PATH] [\-w PASSWORD] [\-P NUMBER]
  36 [\-\-fork] [\-l LEVEL] [\-s] [\-x CMD] [\-\-synctex\-forward INPUT] [\-\-synctex\-pid PID]
  37 <files>
  38 .SH DESCRIPTION
  39 .sp
  40 \fBzathura\fP displays the given files. If a single hyphen\-minus (\-) is given as
  41 file name, the content will be read from the standard input. If no files are
  42 given, an empty \fBzathura\fP instance launches.
  43 .SH OPTIONS
  44 .INDENT 0.0
  45 .TP
  46 .BI \-e\fP,\fB  \-\-reparent\fB= xid
  47 Reparents to window specified by xid
  48 .TP
  49 .BI \-c\fP,\fB  \-\-config\-dir\fB= path
  50 Path to the config directory
  51 .TP
  52 .BI \-d\fP,\fB  \-\-data\-dir\fB= path
  53 Path to the data directory
  54 .TP
  55 .BI \-p\fP,\fB  \-\-plugins\-dir\fB= path
  56 Path to the directory containing plugins
  57 .TP
  58 .BI \-w\fP,\fB  \-\-password\fB= password
  59 The documents password. If multiple documents are opened at once, the
  60 password will be used for the first one and zathura will ask for the
  61 passwords of the remaining files if needed.
  62 .TP
  63 .BI \-P\fP,\fB  \-\-page\fB= number
  64 Opens the document at the given page number. Pages are numbered starting
  65 with 1, and negative numbers indicate page numbers starting from the end
  66 of the document, \-1 being the last page.
  67 .TP
  68 .BI \-l\fP,\fB  \-\-log\-level\fB= level
  69 Set log level (debug, info, warning, error)
  70 .TP
  71 .BI \-x\fP,\fB  \-\-synctex\-editor\-command\fB= command
  72 Set the synctex editor command. Overrides the synctex\-editor\-command setting.
  73 .TP
  74 .BI \-\-synctex\-forward\fB= input
  75 Jump to the given position. The switch expects the same format as specified
  76 for synctex\(aqs view \-i. If no instance is running for the specified document,
  77 a new instance will be launched (only if \-\-synctex\-pid is not specified).
  78 .TP
  79 .BI \-\-synctex\-pid\fB= pid
  80 Instead of looking for an instance having the correct file opened, try only
  81 the instance with the given PID. Note that if the given PID does not have the
  82 correct file open or does not exist, no new instance will be spanned.
  83 .TP
  84 .BI \-\-mode\fB= mode
  85 Start in a non\-default mode
  86 .TP
  87 .B \-\-fork
  88 Fork into background
  89 .TP
  90 .B \-\-version
  91 Display version string and exit
  92 .TP
  93 .B \-\-help
  94 Display help and exit
  95 .UNINDENT
  96 .SH ENVIRONMENT VARIABLES
  97 .INDENT 0.0
  98 .TP
  99 .B ZATHURA_PLUGINS_PATH
 100 Path to the directory containing plugins. This directory is only considered if
 101 no other directory was specified using \-\-plugins\-dir.
 102 .UNINDENT
 103 .SH MOUSE AND KEY BINDINGS
 104 .sp
 105 General
 106 .INDENT 0.0
 107 .INDENT 3.5
 108 .INDENT 0.0
 109 .TP
 110 .B J, PgDn
 111 Go to the next page
 112 .TP
 113 .B K, PgUp
 114 Go to the previous page
 115 .TP
 116 .B h, k, j, l
 117 Scroll to the left, down, up or right direction
 118 .TP
 119 .B Left, Down, Up, Right
 120 Scroll to the left, down, up or right direction
 121 .TP
 122 .B ^t, ^d, ^u, ^y
 123 Scroll a half page left, down, up or right
 124 .TP
 125 .B t, ^f, ^b, space, <S\-space>, y
 126 Scroll a full page left, down, up or right
 127 .TP
 128 .B gg, G, nG
 129 Goto to the first, the last or to the nth page
 130 .TP
 131 .B H, L
 132 Goto top or bottom of the current page
 133 .TP
 134 .B ^o, ^i
 135 Move backward and forward through the jump list
 136 .TP
 137 .B ^j, ^k
 138 Bisect forward and backward between the last two jump points
 139 .TP
 140 .B ^c, Escape
 141 Abort
 142 .TP
 143 .B a, s
 144 Adjust window in best\-fit or width mode
 145 .TP
 146 .B /, ?
 147 Search for text
 148 .TP
 149 .B n, N
 150 Search for the next or previous result
 151 .TP
 152 .B o, O
 153 Open document
 154 .TP
 155 .B f
 156 Follow links
 157 .TP
 158 .B F
 159 Display link target
 160 .TP
 161 .B :
 162 Enter command
 163 .TP
 164 .B r
 165 Rotate by 90 degrees
 166 .TP
 167 .B ^r
 168 Recolor (grayscale and invert colors)
 169 .TP
 170 .B R
 171 Reload document
 172 .TP
 173 .B Tab
 174 Show index and switch to \fBIndex mode\fP
 175 .TP
 176 .B d
 177 Toggle dual page view
 178 .TP
 179 .B F5
 180 Switch to presentation mode
 181 .TP
 182 .B F11
 183 Switch to fullscreen mode
 184 .TP
 185 .B ^m
 186 Toggle inputbar
 187 .TP
 188 .B ^n
 189 Toggle statusbar
 190 .TP
 191 .B +, \-, =
 192 Zoom in, out or to the original size
 193 .TP
 194 .B zI, zO, z0
 195 Zoom in, out or to the original size
 196 .TP
 197 .B n=
 198 Zoom to size n
 199 .TP
 200 .B mX
 201 Set a quickmark to a letter or number X
 202 .TP
 203 .B \(aqX
 204 Goto quickmark saved at letter or number X
 205 .TP
 206 .B q
 207 Quit
 208 .UNINDENT
 209 .UNINDENT
 210 .UNINDENT
 211 .sp
 212 Fullscreen mode
 213 .INDENT 0.0
 214 .INDENT 3.5
 215 .INDENT 0.0
 216 .TP
 217 .B J, K
 218 Go to the next or previous page
 219 .TP
 220 .B space, <S\-space>, <BackSpace>
 221 Scroll a full page down or up
 222 .TP
 223 .B gg, G, nG
 224 Goto to the first, the last or to the nth page
 225 .TP
 226 .B ^c, Escape
 227 Abort
 228 .TP
 229 .B F11
 230 Switch to normal mode
 231 .TP
 232 .B +, \-, =
 233 Zoom in, out or to the original size
 234 .TP
 235 .B zI, zO, z0
 236 Zoom in, out or to the original size
 237 .TP
 238 .B n=
 239 Zoom to size n
 240 .TP
 241 .B q
 242 Quit
 243 .UNINDENT
 244 .UNINDENT
 245 .UNINDENT
 246 .sp
 247 Presentation mode
 248 .INDENT 0.0
 249 .INDENT 3.5
 250 .INDENT 0.0
 251 .TP
 252 .B space, <S\-space>, <BackSpace>
 253 Scroll a full page down or up
 254 .TP
 255 .B ^c, Escape
 256 Abort
 257 .TP
 258 .B F5
 259 Switch to normal mode
 260 .TP
 261 .B q
 262 Quit
 263 .UNINDENT
 264 .UNINDENT
 265 .UNINDENT
 266 .sp
 267 Index mode
 268 .INDENT 0.0
 269 .INDENT 3.5
 270 .INDENT 0.0
 271 .TP
 272 .B k, j
 273 Move to upper or lower entry
 274 .TP
 275 .B l
 276 Expand entry
 277 .TP
 278 .B L
 279 Expand all entries
 280 .TP
 281 .B h
 282 Collapse entry
 283 .TP
 284 .B H
 285 Collapse all entries
 286 .TP
 287 .B space, Return
 288 Select and open entry
 289 .UNINDENT
 290 .UNINDENT
 291 .UNINDENT
 292 .sp
 293 Mouse bindings
 294 .INDENT 0.0
 295 .INDENT 3.5
 296 .INDENT 0.0
 297 .TP
 298 .B Scroll
 299 Scroll up or down
 300 .TP
 301 .B ^Scroll
 302 Zoom in or out
 303 .TP
 304 .B Hold Button2
 305 Pan the document
 306 .TP
 307 .B Button1
 308 Follow link
 309 .UNINDENT
 310 .UNINDENT
 311 .UNINDENT
 312 .SH COMMANDS
 313 .INDENT 0.0
 314 .TP
 315 .B bmark
 316 Save a bookmark
 317 .TP
 318 .B bdelete
 319 Delete a bookmark
 320 .TP
 321 .B blist
 322 List bookmarks
 323 .TP
 324 .B close
 325 Close document
 326 .TP
 327 .B exec
 328 Execute an external command
 329 .TP
 330 .B info
 331 Show document information
 332 .TP
 333 .B open
 334 Open a document
 335 .TP
 336 .B offset
 337 Set page offset
 338 .TP
 339 .B print
 340 Print document
 341 .TP
 342 .B write(!)
 343 Save document (and force overwriting)
 344 .TP
 345 .B export
 346 Export attachments
 347 .TP
 348 .B dump
 349 Write values, descriptions, etc. of all current settings to a file.
 350 .UNINDENT
 351 .SH CONFIGURATION
 352 .sp
 353 The default appearance and behaviour of zathura can be overwritten by modifying
 354 the \fIzathurarc\fP file (default path: ~/.config/zathura/zathurarc). For a detailed
 355 description please consult zathurarc(5).
 356 .SH SYNCTEX SUPPORT
 357 .sp
 358 Both synctex forward and backwards synchronization are supported by zathura, To
 359 enable synctex forward synchronization, please look at the \fI\-\-synctex\-forward\fP
 360 and \fI\-\-synctex\-editor\fP options. zathura will also emit a signal via the D\-Bus
 361 interface. To support synctex backwards synchronization, zathura provides a
 362 D\-Bus interface that can be called by the editor. For convince zathura also
 363 knows how to parse the output of the \fIsynctex view\fP command. It is enough to
 364 pass the arguments to \fIsynctex view\fP\(aqs \fI\-i\fP option to zathura via
 365 \fI\-\-synctex\-forward\fP and zathura will pass the information to the correct
 366 instance.
 367 .sp
 368 For gvim forward and backwards synchronization support can be set up as follows:
 369 First add the following to the vim configuration:
 370 .INDENT 0.0
 371 .INDENT 3.5
 372 .sp
 373 .nf
 374 .ft C
 375 function! Synctex()
 376   execute "silent !zathura \-\-synctex\-forward " . line(\(aq.\(aq) . ":" . col(\(aq.\(aq) . ":" . bufname(\(aq%\(aq) . " " . g:syncpdf
 377   redraw!
 378 endfunction
 379 map <C\-enter> :call Synctex()<cr>
 380 .ft P
 381 .fi
 382 .UNINDENT
 383 .UNINDENT
 384 .sp
 385 Then launch \fIzathura\fP with
 386 .INDENT 0.0
 387 .INDENT 3.5
 388 .sp
 389 .nf
 390 .ft C
 391 zathura \-x "gvim \-\-servername vim \-c \e"let g:syncpdf=\(aq$1\(aq\e" \-\-remote +%{line} %{input}" $file
 392 .ft P
 393 .fi
 394 .UNINDENT
 395 .UNINDENT
 396 .sp
 397 Some editors support zathura as viewer out of the box:
 398 .INDENT 0.0
 399 .IP \(bu 2
 400 LaTeXTools for SublimeText
 401 (\fI\%https://latextools.readthedocs.io/en/latest/available\-viewers/#zathura\fP)
 402 .IP \(bu 2
 403 LaTeX for Atom (\fI\%https://atom.io/packages/latex\fP)
 404 .UNINDENT
 405 .SH KNOWN BUGS
 406 .sp
 407 If GDK_NATIVE_WINDOWS is enabled you will experience problems with large
 408 documents. In this case zathura might crash or pages cannot be rendered
 409 properly. Disabling GDK_NATIVE_WINDOWS fixes this issue. The same issue may
 410 appear, if overlay\-scrollbar is enabled in GTK_MODULES.
 411 .SH SEE ALSO
 412 .sp
 413 \fIzathurarc(5)\fP
 414 .SH AUTHOR
 415 pwmt.org
 416 .SH COPYRIGHT
 417 2009-2018, pwmt.org
 418 .\" Generated by docutils manpage writer.
 419 .