mirror of
https://git.pwmt.org/pwmt/zathura.git
synced 2024-12-29 11:06:00 +01:00
Update man page
This commit is contained in:
Moritz Lipp
parent
bf0bb66503
commit
55c175b1e0
4 changed files with 153 additions and 317 deletions
7
Makefile
7
Makefile
|
|
@ -104,10 +104,11 @@ install: all ${PROJECT}.pc
|
||||||
$(QUIET)cp -f zathura.h ${DESTDIR}${PREFIX}/include/${PROJECT}
|
$(QUIET)cp -f zathura.h ${DESTDIR}${PREFIX}/include/${PROJECT}
|
||||||
$(ECHO) installing manual pages
|
$(ECHO) installing manual pages
|
||||||
$(QUIET)mkdir -p ${DESTDIR}${MANPREFIX}/man1
|
$(QUIET)mkdir -p ${DESTDIR}${MANPREFIX}/man1
|
||||||
$(QUIET)sed "s/VERSION/${VERSION}/g" < ${PROJECT}.1 > ${DESTDIR}${MANPREFIX}/man1/${PROJECT}.1
|
|
||||||
$(QUIET)if which rst2man > /dev/null ; then \
|
$(QUIET)if which rst2man > /dev/null ; then \
|
||||||
mkdir -p ${DESTDIR}${MANPREFIX}/man5 ; \
|
mkdir -p ${DESTDIR}${MANPREFIX}/man1 ; \
|
||||||
rst2man ${PROJECT}rc.5.rst > ${DESTDIR}${MANPREFIX}/man5/${PROJECT}rc.5 ; \
|
sed "s/VERSION/${VERSION}/g" < ${PROJECT}.1.rst > ${PROJECT}-v.1.rst ; \
|
||||||
|
rst2man ${PROJECT}-v.1.rst > ${DESTDIR}${MANPREFIX}/man1/${PROJECT}.1 ; \
|
||||||
|
rm -f ${PROJECT}-v.1.rst ; \
|
||||||
fi
|
fi
|
||||||
$(QUIET)mkdir -p ${DESTDIR}${DESKTOPPREFIX}
|
$(QUIET)mkdir -p ${DESTDIR}${DESKTOPPREFIX}
|
||||||
$(ECHO) installing desktop file
|
$(ECHO) installing desktop file
|
||||||
|
|
|
||||||
27
zathura.1
27
zathura.1
|
|
@ -1,27 +0,0 @@
|
||||||
.TH ZATHURA 1 zathura\-VERSION
|
|
||||||
|
|
||||||
.SH NAME
|
|
||||||
zathura \- a document viewer
|
|
||||||
|
|
||||||
.SH SYNOPSIS
|
|
||||||
.B zathura
|
|
||||||
.RB [options]
|
|
||||||
.RB [file]
|
|
||||||
.RB [password]
|
|
||||||
|
|
||||||
.SH DESCRIPTION
|
|
||||||
zathura is a highly customizable and functional document viewer.
|
|
||||||
|
|
||||||
.SH OPTIONS
|
|
||||||
.TP
|
|
||||||
.B "-e xid"
|
|
||||||
Reparents to window specified by xid.
|
|
||||||
.TP
|
|
||||||
.B "-c path"
|
|
||||||
Path to the config directory.
|
|
||||||
.TP
|
|
||||||
.B "-d path"
|
|
||||||
Path to the data directory.
|
|
||||||
.TP
|
|
||||||
.B "-p path"
|
|
||||||
Path to the plugin directory.
|
|
||||||
149
zathura.1.rst
Normal file
149
zathura.1.rst
Normal file
|
|
@ -0,0 +1,149 @@
|
||||||
|
=======
|
||||||
|
zathura
|
||||||
|
=======
|
||||||
|
|
||||||
|
-----------------
|
||||||
|
a document viewer
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
:Author: pwmt.org
|
||||||
|
:Date: VERSION
|
||||||
|
:Manual section: 1
|
||||||
|
|
||||||
|
SYNOPOSIS
|
||||||
|
=========
|
||||||
|
| zathura [OPTION]...
|
||||||
|
| zathura [OPTION]... FILE
|
||||||
|
| zathura [OPTION]... FILE PASSWORD
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
===========
|
||||||
|
zathura is a highly customizable and functional document viewer. It provides a
|
||||||
|
minimalistic and space saving interface as well as an easy usage that mainly
|
||||||
|
focuses on keyboard interaction.
|
||||||
|
|
||||||
|
OPTIONS
|
||||||
|
=======
|
||||||
|
|
||||||
|
-e [xid], --reparent [xid]
|
||||||
|
Reparents to window specified by xid
|
||||||
|
|
||||||
|
-c [path], --config-dir [path]
|
||||||
|
Path to the config directory
|
||||||
|
|
||||||
|
-d [path], --data-dir [path]
|
||||||
|
Path to the data directory
|
||||||
|
|
||||||
|
-p [path], --plugins-dir [path]
|
||||||
|
Path to the directory containing plugins
|
||||||
|
|
||||||
|
--fork
|
||||||
|
Fork into the background
|
||||||
|
|
||||||
|
MOUSE AND KEY BINDINGS
|
||||||
|
======================
|
||||||
|
|
||||||
|
J, K
|
||||||
|
Go to the next or 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
|
||||||
|
^d, ^u
|
||||||
|
Scroll a half page down or up
|
||||||
|
^f, ^b, space, <S-space>
|
||||||
|
Scroll a full page down or up
|
||||||
|
gg, G, nG
|
||||||
|
Goto to the first, the last or to the nth page
|
||||||
|
^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
|
||||||
|
\:
|
||||||
|
Enter command
|
||||||
|
r
|
||||||
|
Rotate by 90 degrees
|
||||||
|
^i
|
||||||
|
Recolor
|
||||||
|
R
|
||||||
|
Reload document
|
||||||
|
Tab
|
||||||
|
Show index and switch to **Index mode**
|
||||||
|
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
|
||||||
|
|
||||||
|
Index mode
|
||||||
|
----------
|
||||||
|
|
||||||
|
k, j
|
||||||
|
Move to upper or lower entry
|
||||||
|
l
|
||||||
|
Expand entry
|
||||||
|
h
|
||||||
|
Collapse entry
|
||||||
|
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
|
||||||
|
|
||||||
|
COMMANDS
|
||||||
|
========
|
||||||
|
bmark
|
||||||
|
Save a bookmark
|
||||||
|
bdelete
|
||||||
|
Delete a bookmark
|
||||||
|
blist
|
||||||
|
List bookmarks
|
||||||
|
close
|
||||||
|
Close document
|
||||||
|
info
|
||||||
|
Show document information
|
||||||
|
help
|
||||||
|
Show help page
|
||||||
|
open, o
|
||||||
|
Open a document
|
||||||
|
print
|
||||||
|
Print document
|
||||||
|
write, write!
|
||||||
|
Save document (and force overwriting)
|
||||||
|
export
|
||||||
|
Export attachments
|
||||||
|
|
||||||
|
CONFIGURATION
|
||||||
|
=============
|
||||||
|
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 visit http://pwmt.org/projects/zathura/configuration
|
||||||
287
zathurarc.5.rst
287
zathurarc.5.rst
|
|
@ -1,287 +0,0 @@
|
||||||
===========
|
|
||||||
zathurarc
|
|
||||||
===========
|
|
||||||
|
|
||||||
--------------------------
|
|
||||||
zathura configuration file
|
|
||||||
--------------------------
|
|
||||||
|
|
||||||
:Author: pwmt.org
|
|
||||||
:Date: 02.02.2012
|
|
||||||
:Manual section: 5
|
|
||||||
|
|
||||||
SYNOPOSIS
|
|
||||||
=========
|
|
||||||
|
|
||||||
/etc/zathurarc, $XDG_CONFIG_HOME/zathura/zathurarc
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
===========
|
|
||||||
|
|
||||||
The zathurarc file is a simple plain text file that can be populated with
|
|
||||||
various commands to change the behaviour and the look of zathura which we are
|
|
||||||
going to describe in the following subsections. Each line (besides empty lines
|
|
||||||
and comments (which start with a prepended #)) is evaluated on its own, so it is
|
|
||||||
not possible to write multiple commands in one single line.
|
|
||||||
|
|
||||||
The following commands can be used:
|
|
||||||
|
|
||||||
set - Changing the options
|
|
||||||
--------------------------
|
|
||||||
|
|
||||||
In addition to the build-in :set command zathura offers more options to be
|
|
||||||
changed and makes those changes permanent. To overwrite an option you just have
|
|
||||||
to add a line structured like the following:
|
|
||||||
|
|
||||||
::
|
|
||||||
set <option> <new value>
|
|
||||||
|
|
||||||
The option field has to be replaced with the name of the option that should be
|
|
||||||
changed and the new value field has to be replaced with the new value the option
|
|
||||||
should get. The type of the value can be one of the following:
|
|
||||||
|
|
||||||
* INT - An integer number
|
|
||||||
* FLOAT - A floating point number
|
|
||||||
* STRING - A character string
|
|
||||||
* BOOL - A boolean value (“true” for true, “false” for false)
|
|
||||||
|
|
||||||
In addition we advice you to check the List of options to get a more detailed
|
|
||||||
view of the options that can be changed and which values they should be set to.
|
|
||||||
|
|
||||||
The following example should give some deeper insight of how the set command can
|
|
||||||
be used:
|
|
||||||
|
|
||||||
::
|
|
||||||
set option1 5
|
|
||||||
set option2 2.0
|
|
||||||
set option3 hello
|
|
||||||
set option4 hello\ world
|
|
||||||
set option5 "hello world"
|
|
||||||
|
|
||||||
Possible options are:
|
|
||||||
|
|
||||||
page-padding
|
|
||||||
^^^^^^^^^^^^
|
|
||||||
The page padding defines the gap in pixels between each rendered page and can
|
|
||||||
not be changed during runtime.
|
|
||||||
|
|
||||||
* Value type: Integer
|
|
||||||
* Default value: 1
|
|
||||||
|
|
||||||
pages-per-row
|
|
||||||
^^^^^^^^^^^^^
|
|
||||||
Defines the number of pages that are rendered next to each other in a row.
|
|
||||||
|
|
||||||
* Value type: Integer
|
|
||||||
* Default value: 1
|
|
||||||
|
|
||||||
highlight-color
|
|
||||||
^^^^^^^^^^^^^^^
|
|
||||||
Defines the color value that is used to highlight things in the document, e.g
|
|
||||||
all search results.
|
|
||||||
|
|
||||||
* Value type: String
|
|
||||||
* Default value: #9FBC00
|
|
||||||
|
|
||||||
highlight-active-color
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
Defines the color value that is used to mark the active highlight in the
|
|
||||||
document, e.g the current search results.
|
|
||||||
|
|
||||||
recolor-darkcolor
|
|
||||||
^^^^^^^^^^^^^^^^^^
|
|
||||||
Defines the color value that is used to represent dark colors in recoloring mode
|
|
||||||
|
|
||||||
* Value type: String
|
|
||||||
* Default value: #FFFFFF
|
|
||||||
|
|
||||||
recolor-lightcolor
|
|
||||||
^^^^^^^^^^^^^^^^^^^
|
|
||||||
Defines the color value that is used to represent light colors in recoloring mode
|
|
||||||
|
|
||||||
* Value type: String
|
|
||||||
* Default value: #000000
|
|
||||||
|
|
||||||
zoom-step
|
|
||||||
^^^^^^^^^
|
|
||||||
Defines the amount of percent that is zoomed in or out on each comand.
|
|
||||||
|
|
||||||
* Value type: Integer
|
|
||||||
* Default value: 10
|
|
||||||
|
|
||||||
map - Mapping a shortcut
|
|
||||||
------------------------
|
|
||||||
It is possible to map or remap new key bindings to shortcut functions which
|
|
||||||
allows a high level of customization. The *:map* command can also be used in
|
|
||||||
the *zathurarc* file to make those changes permanent::
|
|
||||||
|
|
||||||
map [mode] <binding> <shortcut function> <argument>
|
|
||||||
|
|
||||||
Mode
|
|
||||||
^^^^
|
|
||||||
The *map* command expects several arguments where only the *binding* as well as
|
|
||||||
the *shortcut-function* argument is required. Since zathura uses several odes it
|
|
||||||
is possible to map bindings only for a specific mode by passing the *mode*
|
|
||||||
argument which can take one of the following values:
|
|
||||||
|
|
||||||
* normal (default)
|
|
||||||
* visual
|
|
||||||
* insert
|
|
||||||
* index
|
|
||||||
|
|
||||||
The brackets around the value are mandatory.
|
|
||||||
|
|
||||||
Single key binding
|
|
||||||
^^^^^^^^^^^^^^^^^^
|
|
||||||
The (possible) second argument defines the used key binding that should be
|
|
||||||
mapped to the shortcut function and is structured like the following. On the one
|
|
||||||
hand it is possible to just assign single letters, numbers or signs to it::
|
|
||||||
|
|
||||||
map a shortcut_function
|
|
||||||
map b shortcut_function
|
|
||||||
map c shortcut_function
|
|
||||||
map 1 shortcut_function
|
|
||||||
map 2 shortcut_function
|
|
||||||
map 3 shortcut_function
|
|
||||||
map ! shortcut_function
|
|
||||||
map ? shortcut_function
|
|
||||||
|
|
||||||
Using modifiers
|
|
||||||
^^^^^^^^^^^^^^^
|
|
||||||
It is also possible to use modifiers like the *Control* or *Alt* button on the
|
|
||||||
keyboard. It is possible to use the following modifiers:
|
|
||||||
|
|
||||||
* A - *Alt*
|
|
||||||
* C - *Control*
|
|
||||||
* S - *Shift*
|
|
||||||
|
|
||||||
Now it is required to define the *binding* with the following structure::
|
|
||||||
|
|
||||||
map <A-a> shortcut_function
|
|
||||||
map <C-a> shortcut_function
|
|
||||||
|
|
||||||
Special keys
|
|
||||||
^^^^^^^^^^^^
|
|
||||||
zathura allows it also to assign keys like the space bar or the tab button which
|
|
||||||
also have to be written in between angle brackets. The following special keys
|
|
||||||
are currently available:
|
|
||||||
|
|
||||||
========== =================
|
|
||||||
Identifier Description
|
|
||||||
========== =================
|
|
||||||
BackSpace *Back space*
|
|
||||||
CapsLock *Caps lock*
|
|
||||||
Esc *Escape*
|
|
||||||
Down *Arrow down*
|
|
||||||
Up *Arrow up*
|
|
||||||
Left *Arrow left*
|
|
||||||
Right *A7row right*
|
|
||||||
F1 *F1*
|
|
||||||
F2 *F2*
|
|
||||||
F3 *F3*
|
|
||||||
F4 *F4*
|
|
||||||
F5 *F5*
|
|
||||||
F6 *F6*
|
|
||||||
F7 *F7*
|
|
||||||
F8 *F8*
|
|
||||||
F9 *F9*
|
|
||||||
F10 *F10*
|
|
||||||
F11 *F11*
|
|
||||||
F12 *F12*
|
|
||||||
PageDown *Page Down*
|
|
||||||
PageUp *Page Up*
|
|
||||||
Return *Return*
|
|
||||||
Space *Space*
|
|
||||||
Super *Windows button*
|
|
||||||
Tab *Tab*
|
|
||||||
========== =================
|
|
||||||
|
|
||||||
Of course it is possible to combine those special keys with a modifier. The
|
|
||||||
usage of those keys should be explained by the following examples::
|
|
||||||
|
|
||||||
map <Space> shortcut_function
|
|
||||||
map <C-Space> shortcut_function
|
|
||||||
|
|
||||||
Mouse buttons
|
|
||||||
^^^^^^^^^^^^^
|
|
||||||
It is also possible to map mouse buttons to shortcuts by using the following
|
|
||||||
special keys:
|
|
||||||
|
|
||||||
========== ================
|
|
||||||
Identifier Description
|
|
||||||
========== ================
|
|
||||||
Button1 *Mouse button 1*
|
|
||||||
Button2 *Mouse button 2*
|
|
||||||
Button3 *Mouse button 3*
|
|
||||||
Button4 *Mouse button 4*
|
|
||||||
Button5 *Mouse button 5*
|
|
||||||
========== ================
|
|
||||||
|
|
||||||
They can also be combined with modifiers::
|
|
||||||
|
|
||||||
map <Button1> shortcut_function
|
|
||||||
map <C-Button1> shortcut_function
|
|
||||||
|
|
||||||
Buffer commands
|
|
||||||
^^^^^^^^^^^^^^^
|
|
||||||
If a mapping does not match one of the previous definition but is still a valid
|
|
||||||
mapping it will be mapped as a buffer command::
|
|
||||||
|
|
||||||
map abc quit
|
|
||||||
map test quit
|
|
||||||
|
|
||||||
Shortcut functions
|
|
||||||
^^^^^^^^^^^^^^^^^^
|
|
||||||
The following shortcut functions can be mapped:
|
|
||||||
|
|
||||||
================= ====================================
|
|
||||||
Function Description
|
|
||||||
================= ====================================
|
|
||||||
abort *Switch back to normal mode*
|
|
||||||
adjust *Adjust page width*
|
|
||||||
change_mode *Change current mode*
|
|
||||||
focus_inputbar *Focus inputbar*
|
|
||||||
follow *Follow a link*
|
|
||||||
goto *Go to a certain page*
|
|
||||||
index_navigate *Navigate through the index*
|
|
||||||
naviate *Navigate to the next/previous page*
|
|
||||||
quit *Quit zathura*
|
|
||||||
recolor *Recolor the pages*
|
|
||||||
reload *Reload the document*
|
|
||||||
rotate *Rotate the page*
|
|
||||||
scroll *Scroll*
|
|
||||||
search *Search next/previous item*
|
|
||||||
toggle_fullscreen *Toggle fullscreen*
|
|
||||||
toggle_index *Show or hide index*
|
|
||||||
toggle_inputbar *Show or hide inputbar*
|
|
||||||
toggle_statusbar *Show or hide statusbar*
|
|
||||||
zoom *Zoom in or out*
|
|
||||||
================= ====================================
|
|
||||||
|
|
||||||
Pass arguments
|
|
||||||
^^^^^^^^^^^^^^
|
|
||||||
Some shortcut function require or have optional arguments which influence the
|
|
||||||
behaviour of them. Those can be passed as the last argument::
|
|
||||||
|
|
||||||
map <C-i> zoom in
|
|
||||||
map <C-o> zoom out
|
|
||||||
|
|
||||||
unmap - Removing a shortcut
|
|
||||||
---------------------------
|
|
||||||
In addition to mapping or remaping custom key bindings it is possible to remove
|
|
||||||
existing ones by using the *:unmap* command. The command is used in the
|
|
||||||
following way (the explanation of the parameters is described in the *map*
|
|
||||||
section of this document::
|
|
||||||
|
|
||||||
unmap [mode] <binding>
|
|
||||||
|
|
||||||
EXAMPLE
|
|
||||||
=======
|
|
||||||
|
|
||||||
::
|
|
||||||
# zathurarc
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
========
|
|
||||||
|
|
||||||
zathura(1)
|
|
||||||
Loading…
Reference in a new issue