aboutsummaryrefslogtreecommitdiff
path: root/community/zathura/files/zathura.1
diff options
context:
space:
mode:
Diffstat (limited to 'community/zathura/files/zathura.1')
-rw-r--r--community/zathura/files/zathura.1429
1 files changed, 429 insertions, 0 deletions
diff --git a/community/zathura/files/zathura.1 b/community/zathura/files/zathura.1
new file mode 100644
index 00000000..b03abbc7
--- /dev/null
+++ b/community/zathura/files/zathura.1
@@ -0,0 +1,429 @@
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.TH "ZATHURA" "1" "2021-07-14" "0.4.8" "zathura"
+.SH NAME
+zathura \- a document viewer
+.SH SYNOPSIS
+.sp
+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>
+.SH DESCRIPTION
+.sp
+\fBzathura\fP 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 \fBzathura\fP instance launches.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.BI \-e\fP,\fB \-\-reparent\fB= xid
+Reparents to window specified by xid
+.TP
+.BI \-c\fP,\fB \-\-config\-dir\fB= path
+Path to the config directory
+.TP
+.BI \-d\fP,\fB \-\-data\-dir\fB= path
+Path to the data directory
+.TP
+.BI \-p\fP,\fB \-\-plugins\-dir\fB= path
+Path to the directory containing plugins
+.TP
+.BI \-w\fP,\fB \-\-password\fB= 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.
+.TP
+.BI \-P\fP,\fB \-\-page\fB= 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.
+.TP
+.BI \-f\fP,\fB \-\-find\fB= string
+Opens the document and searches for the given string.
+.TP
+.BI \-l\fP,\fB \-\-log\-level\fB= level
+Set log level (debug, info, warning, error)
+.TP
+.BI \-x\fP,\fB \-\-synctex\-editor\-command\fB= command
+Set the synctex editor command. Overrides the synctex\-editor\-command setting.
+.TP
+.BI \-\-synctex\-forward\fB= input
+Jump to the given position. The switch expects the same format as specified
+for synctex\(aqs view \-i. If no instance is running for the specified document,
+a new instance will be launched (only if \-\-synctex\-pid is not specified).
+.TP
+.BI \-\-synctex\-pid\fB= 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.
+.TP
+.BI \-\-mode\fB= mode
+Start in a non\-default mode
+.TP
+.B \-\-fork
+Fork into background
+.TP
+.B \-\-version
+Display version string and exit
+.TP
+.B \-\-help
+Display help and exit
+.UNINDENT
+.SH MOUSE AND KEY BINDINGS
+.sp
+General
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B J, PgDn
+Go to the next page
+.TP
+.B K, PgUp
+Go to the previous page
+.TP
+.B h, k, j, l
+Scroll to the left, down, up or right direction
+.TP
+.B Left, Down, Up, Right
+Scroll to the left, down, up or right direction
+.TP
+.B ^t, ^d, ^u, ^y
+Scroll a half page left, down, up or right
+.TP
+.B t, ^f, ^b, space, <S\-space>, y
+Scroll a full page left, down, up or right
+.TP
+.B gg, G, nG
+Goto to the first, the last or to the nth page
+.TP
+.B P
+Snaps to the current page
+.TP
+.B H, L
+Goto top or bottom of the current page
+.TP
+.B ^o, ^i
+Move backward and forward through the jump list
+.TP
+.B ^j, ^k
+Bisect forward and backward between the last two jump points
+.TP
+.B ^c, Escape
+Abort
+.TP
+.B a, s
+Adjust window in best\-fit or width mode
+.TP
+.B /, ?
+Search for text
+.TP
+.B n, N
+Search for the next or previous result
+.TP
+.B o, O
+Open document
+.TP
+.B f
+Follow links
+.TP
+.B F
+Display link target
+.TP
+.B c
+Copy link target into the clipboard
+.TP
+.B :
+Enter command
+.TP
+.B r
+Rotate by 90 degrees
+.TP
+.B ^r
+Recolor (grayscale and invert colors)
+.TP
+.B R
+Reload document
+.TP
+.B Tab
+Show index and switch to \fBIndex mode\fP
+.TP
+.B d
+Toggle dual page view
+.TP
+.B F5
+Switch to presentation mode
+.TP
+.B F11
+Switch to fullscreen mode
+.TP
+.B ^m
+Toggle inputbar
+.TP
+.B ^n
+Toggle statusbar
+.TP
+.B +, \-, =
+Zoom in, out or to the original size
+.TP
+.B zI, zO, z0
+Zoom in, out or to the original size
+.TP
+.B n=
+Zoom to size n
+.TP
+.B mX
+Set a quickmark to a letter or number X
+.TP
+.B \(aqX
+Goto quickmark saved at letter or number X
+.TP
+.B q
+Quit
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+Fullscreen mode
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B J, K
+Go to the next or previous page
+.TP
+.B space, <S\-space>, <BackSpace>
+Scroll a full page down or up
+.TP
+.B gg, G, nG
+Goto to the first, the last or to the nth page
+.TP
+.B ^c, Escape
+Abort
+.TP
+.B F11
+Switch to normal mode
+.TP
+.B +, \-, =
+Zoom in, out or to the original size
+.TP
+.B zI, zO, z0
+Zoom in, out or to the original size
+.TP
+.B n=
+Zoom to size n
+.TP
+.B q
+Quit
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+Presentation mode
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B space, <S\-space>, <BackSpace>
+Scroll a full page down or up
+.TP
+.B ^c, Escape
+Abort
+.TP
+.B F5
+Switch to normal mode
+.TP
+.B q
+Quit
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+Index mode
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B k, j
+Move to upper or lower entry
+.TP
+.B l
+Expand entry
+.TP
+.B L
+Expand all entries
+.TP
+.B h
+Collapse entry
+.TP
+.B H
+Collapse all entries
+.TP
+.B space, Return
+Select and open entry
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+Mouse bindings
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B Scroll
+Scroll up or down
+.TP
+.B ^Scroll
+Zoom in or out
+.TP
+.B Hold Button2
+Pan the document
+.TP
+.B Button1
+Follow link
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH COMMANDS
+.INDENT 0.0
+.TP
+.B bmark
+Save a bookmark
+.TP
+.B bdelete
+Delete a bookmark
+.TP
+.B blist
+List bookmarks
+.TP
+.B close
+Close document
+.TP
+.B exec
+Execute an external command
+.TP
+.B info
+Show document information
+.TP
+.B open
+Open a document
+.TP
+.B offset
+Set page offset
+.TP
+.B print
+Print document
+.TP
+.B write(!)
+Save document (and force overwriting)
+.TP
+.B export
+Export attachments
+.TP
+.B dump
+Write values, descriptions, etc. of all current settings to a file.
+.UNINDENT
+.SH CONFIGURATION
+.sp
+The default appearance and behaviour of zathura can be overwritten by modifying
+the \fIzathurarc\fP file (default path: ~/.config/zathura/zathurarc). For a detailed
+description please consult zathurarc(5).
+.SH SYNCTEX SUPPORT
+.sp
+Both synctex forward and backwards synchronization are supported by zathura, To
+enable synctex forward synchronization, please look at the \fI\-\-synctex\-forward\fP
+and \fI\-\-synctex\-editor\fP 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 \fIsynctex view\fP command. It is enough to
+pass the arguments to \fIsynctex view\fP\(aqs \fI\-i\fP option to zathura via
+\fI\-\-synctex\-forward\fP and zathura will pass the information to the correct
+instance.
+.sp
+For gvim forward and backwards synchronization support can be set up as follows:
+First add the following to the vim configuration:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+function! Synctex()
+ execute "silent !zathura \-\-synctex\-forward " . line(\(aq.\(aq) . ":" . col(\(aq.\(aq) . ":" . bufname(\(aq%\(aq) . " " . g:syncpdf
+ redraw!
+endfunction
+map <C\-enter> :call Synctex()<cr>
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Then launch \fIzathura\fP with
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+zathura \-x "gvim \-\-servername vim \-c \e"let g:syncpdf=\(aq$1\(aq\e" \-\-remote +%{line} %{input}" $file
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Some editors support zathura as viewer out of the box:
+.INDENT 0.0
+.IP \(bu 2
+LaTeXTools for SublimeText
+(\fI\%https://latextools.readthedocs.io/en/latest/available\-viewers/#zathura\fP)
+.IP \(bu 2
+LaTeX for Atom (\fI\%https://atom.io/packages/latex\fP)
+.UNINDENT
+.SH ENVIRONMENT VARIABLES
+.INDENT 0.0
+.TP
+.B ZATHURA_PLUGINS_PATH
+Path to the directory containing plugins. This directory is only considered if
+no other directory was specified using \-\-plugins\-dir.
+.UNINDENT
+.SH KNOWN BUGS
+.sp
+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.
+.SH SEE ALSO
+.sp
+\fIzathurarc(5)\fP
+.SH AUTHOR
+pwmt.org
+.SH COPYRIGHT
+2009-2018, pwmt.org
+.\" Generated by docutils manpage writer.
+.