From 55c175b1e00bcfdf10f9819ff1feefcbcf852ea6 Mon Sep 17 00:00:00 2001 From: Moritz Lipp Date: Sat, 18 Feb 2012 11:37:39 +0100 Subject: [PATCH] Update man page --- Makefile | 7 +- zathura.1 | 27 ----- zathura.1.rst | 149 +++++++++++++++++++++++++ zathurarc.5.rst | 287 ------------------------------------------------ 4 files changed, 153 insertions(+), 317 deletions(-) delete mode 100644 zathura.1 create mode 100644 zathura.1.rst delete mode 100644 zathurarc.5.rst diff --git a/Makefile b/Makefile index fd969ed..a7aae48 100644 --- a/Makefile +++ b/Makefile @@ -104,10 +104,11 @@ install: all ${PROJECT}.pc $(QUIET)cp -f zathura.h ${DESTDIR}${PREFIX}/include/${PROJECT} $(ECHO) installing manual pages $(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 \ - mkdir -p ${DESTDIR}${MANPREFIX}/man5 ; \ - rst2man ${PROJECT}rc.5.rst > ${DESTDIR}${MANPREFIX}/man5/${PROJECT}rc.5 ; \ + mkdir -p ${DESTDIR}${MANPREFIX}/man1 ; \ + 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 $(QUIET)mkdir -p ${DESTDIR}${DESKTOPPREFIX} $(ECHO) installing desktop file diff --git a/zathura.1 b/zathura.1 deleted file mode 100644 index a38bb6a..0000000 --- a/zathura.1 +++ /dev/null @@ -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. diff --git a/zathura.1.rst b/zathura.1.rst new file mode 100644 index 0000000..d328899 --- /dev/null +++ b/zathura.1.rst @@ -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, + 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 diff --git a/zathurarc.5.rst b/zathurarc.5.rst deleted file mode 100644 index 3dbfbce..0000000 --- a/zathurarc.5.rst +++ /dev/null @@ -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