mirror of
https://git.pwmt.org/pwmt/zathura.git
synced 2025-02-27 08:14:39 +01:00
Add zathura.1 to documentation
This commit is contained in:
parent
7bce5bb321
commit
34d82b6f9b
11 changed files with 255 additions and 17 deletions
|
@ -19,4 +19,4 @@ Welcome to zathura's documentation!
|
|||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
manpage
|
||||
man/zathura.1
|
||||
|
|
117
doc/man/_bindings.txt
Normal file
117
doc/man/_bindings.txt
Normal file
|
@ -0,0 +1,117 @@
|
|||
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
|
||||
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
|
||||
\:
|
||||
Enter command
|
||||
r
|
||||
Rotate by 90 degrees
|
||||
^r
|
||||
Recolor
|
||||
R
|
||||
Reload document
|
||||
Tab
|
||||
Show index and switch to **Index mode**
|
||||
d
|
||||
Toggle dual page view
|
||||
F5
|
||||
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
|
||||
F5
|
||||
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
|
||||
|
||||
|
||||
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
|
||||
|
3
doc/man/_bugs.txt
Normal file
3
doc/man/_bugs.txt
Normal file
|
@ -0,0 +1,3 @@
|
|||
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.
|
35
doc/man/_commands.txt
Normal file
35
doc/man/_commands.txt
Normal file
|
@ -0,0 +1,35 @@
|
|||
bmark
|
||||
Save a bookmark
|
||||
|
||||
bdelete
|
||||
Delete a bookmark
|
||||
|
||||
blist
|
||||
List bookmarks
|
||||
|
||||
close
|
||||
Close document
|
||||
|
||||
exec
|
||||
Execute an external command
|
||||
|
||||
info
|
||||
Show document information
|
||||
|
||||
help
|
||||
Show help page
|
||||
|
||||
open
|
||||
Open a document
|
||||
|
||||
offset
|
||||
Set page offset
|
||||
|
||||
print
|
||||
Print document
|
||||
|
||||
write(!)
|
||||
Save document (and force overwriting)
|
||||
|
||||
export
|
||||
Export attachments
|
4
doc/man/_configuration.txt
Normal file
4
doc/man/_configuration.txt
Normal file
|
@ -0,0 +1,4 @@
|
|||
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).
|
||||
|
42
doc/man/_options.txt
Normal file
42
doc/man/_options.txt
Normal file
|
@ -0,0 +1,42 @@
|
|||
-x, --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.
|
||||
|
||||
-l, --debug=level
|
||||
Set log debug level (debug, info, warning, error)
|
||||
|
||||
-s, --synctex
|
||||
Enables synctex support
|
||||
|
||||
-x, --synctex-editor-command=command
|
||||
Set the synctex editor command
|
||||
|
||||
--synctex-forward=input
|
||||
Jump to the given position. The switch expects the same format as specified for synctex's view -i.
|
||||
|
||||
--fork
|
||||
Fork into background
|
||||
|
||||
--version
|
||||
Display version string and exit
|
||||
|
||||
--help
|
||||
Display help and exit
|
8
doc/man/_synctex.txt
Normal file
8
doc/man/_synctex.txt
Normal file
|
@ -0,0 +1,8 @@
|
|||
Both synctex forward and backwards synchronization are supported by zathura, To
|
||||
enable synctex forward synchronization, please look at the *--syntex* and
|
||||
*--synctex-editor* options. 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 *--syntex-forward* and zathura will pass the information to the
|
||||
correct instance.
|
2
doc/man/_synopsis.txt
Normal file
2
doc/man/_synopsis.txt
Normal file
|
@ -0,0 +1,2 @@
|
|||
zathura [-e XID] [-c PATH] [-d PATH] [-p PATH] [-w PASSWORD] [-p NUMBER]
|
||||
[--fork] [-l LEVEL] [-s] [-x CMD] [--synctex-forward INPUT] <files>
|
41
doc/man/zathura.1.rst
Normal file
41
doc/man/zathura.1.rst
Normal file
|
@ -0,0 +1,41 @@
|
|||
Manpage
|
||||
=======
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
.. include:: _synopsis.txt
|
||||
|
||||
Options
|
||||
-------
|
||||
|
||||
.. include:: _options.txt
|
||||
|
||||
Mouse and key bindings
|
||||
----------------------
|
||||
|
||||
.. include:: _bindings.txt
|
||||
|
||||
Commands
|
||||
---------
|
||||
|
||||
.. include:: _commands.txt
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
.. include:: _configuration.txt
|
||||
|
||||
Synctex support
|
||||
---------------
|
||||
|
||||
.. include:: _synctex.txt
|
||||
|
||||
Known bugs
|
||||
----------
|
||||
|
||||
.. include:: _bugs.txt
|
||||
|
||||
See Also
|
||||
--------
|
||||
`zathurarc(5)`
|
|
@ -1,15 +0,0 @@
|
|||
Manpage
|
||||
=======
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
See Also
|
||||
--------
|
||||
:manpage:`zathurarc(5)`
|
|
@ -4,4 +4,5 @@ Usage
|
|||
|
||||
Commandline invocation
|
||||
======================
|
||||
.. include:: synopsis.rst
|
||||
|
||||
.. include:: ../man/_synopsis.txt
|
||||
|
|
Loading…
Add table
Reference in a new issue