diff --git a/doc/man/_bindings.txt b/doc/man/_bindings.txt deleted file mode 100644 index 84489d4..0000000 --- a/doc/man/_bindings.txt +++ /dev/null @@ -1,131 +0,0 @@ -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, , y - Scroll a full page left, down, up or right - gg, G, nG - Goto to the first, the last or to the nth page - P - Snaps to the current 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 (grayscale and invert colors) - R - Reload document - Tab - Show index and switch to **Index mode** - d - Toggle dual page view - F5 - Switch to presentation mode - F11 - 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, , - Scroll a full page down or up - gg, G, nG - Goto to the first, the last or to the nth page - ^c, Escape - Abort - F11 - 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 - -Presentation mode - - space, , - Scroll a full page down or up - ^c, Escape - Abort - F5 - Switch to normal mode - 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 - diff --git a/doc/man/_bugs.txt b/doc/man/_bugs.txt deleted file mode 100644 index f664492..0000000 --- a/doc/man/_bugs.txt +++ /dev/null @@ -1,4 +0,0 @@ -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. diff --git a/doc/man/_commands.txt b/doc/man/_commands.txt deleted file mode 100644 index 114ef2a..0000000 --- a/doc/man/_commands.txt +++ /dev/null @@ -1,35 +0,0 @@ -bmark - Save a bookmark - -bdelete - Delete a bookmark - -blist - List bookmarks - -close - Close document - -exec - Execute an external command - -info - Show document information - -open - Open a document - -offset - Set page offset - -print - Print document - -write(!) - Save document (and force overwriting) - -export - Export attachments - -dump - Write values, descriptions, etc. of all current settings to a file. diff --git a/doc/man/_configuration.txt b/doc/man/_configuration.txt deleted file mode 100644 index 0f0ba96..0000000 --- a/doc/man/_configuration.txt +++ /dev/null @@ -1,4 +0,0 @@ -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). - diff --git a/doc/man/_description.txt b/doc/man/_description.txt deleted file mode 100644 index 2a08ac5..0000000 --- a/doc/man/_description.txt +++ /dev/null @@ -1,3 +0,0 @@ -**zathura** 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 **zathura** instance launches. diff --git a/doc/man/_env.txt b/doc/man/_env.txt deleted file mode 100644 index 4d3325a..0000000 --- a/doc/man/_env.txt +++ /dev/null @@ -1,3 +0,0 @@ -ZATHURA_PLUGINS_PATH - Path to the directory containing plugins. This directory is only considered if - no other directory was specified using --plugins-dir. diff --git a/doc/man/_options.txt b/doc/man/_options.txt deleted file mode 100644 index 11a1629..0000000 --- a/doc/man/_options.txt +++ /dev/null @@ -1,52 +0,0 @@ --e, --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. - --f, --find=string - Opens the document and searches for the given string. - --l, --log-level=level - Set log level (debug, info, warning, error) - --x, --synctex-editor-command=command - Set the synctex editor command. Overrides the synctex-editor-command setting. - ---synctex-forward=input - Jump to the given position. The switch expects the same format as specified - for synctex's view -i. If no instance is running for the specified document, - a new instance will be launched (only if --synctex-pid is not specified). - ---synctex-pid=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. - ---mode=mode - Start in a non-default mode - ---fork - Fork into background - ---version - Display version string and exit - ---help - Display help and exit diff --git a/doc/man/_synctex.txt b/doc/man/_synctex.txt deleted file mode 100644 index 377fb4c..0000000 --- a/doc/man/_synctex.txt +++ /dev/null @@ -1,32 +0,0 @@ -Both synctex forward and backwards synchronization are supported by zathura, To -enable synctex forward synchronization, please look at the *--synctex-forward* -and *--synctex-editor* 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 *synctex view* command. It is enough to -pass the arguments to *synctex view*'s *-i* option to zathura via -*--synctex-forward* and zathura will pass the information to the correct -instance. - -For gvim forward and backwards synchronization support can be set up as follows: -First add the following to the vim configuration: - -:: - - function! Synctex() - execute "silent !zathura --synctex-forward " . line('.') . ":" . col('.') . ":" . bufname('%') . " " . g:syncpdf - redraw! - endfunction - map :call Synctex() - -Then launch *zathura* with - -:: - - zathura -x "gvim --servername vim -c \"let g:syncpdf='$1'\" --remote +%{line} %{input}" $file - -Some editors support zathura as viewer out of the box: - -* LaTeXTools for SublimeText - (https://latextools.readthedocs.io/en/latest/available-viewers/#zathura) -* LaTeX for Atom (https://atom.io/packages/latex) diff --git a/doc/man/_synopsis.txt b/doc/man/_synopsis.txt deleted file mode 100644 index e802966..0000000 --- a/doc/man/_synopsis.txt +++ /dev/null @@ -1,4 +0,0 @@ -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] -[-f STRING] - diff --git a/doc/man/conf.py b/doc/man/conf.py index 3b57273..2aad25f 100644 --- a/doc/man/conf.py +++ b/doc/man/conf.py @@ -8,7 +8,6 @@ import time dirname = os.path.dirname(__file__) files = glob.glob(os.path.join(dirname, '*.rst')) -files.extend(glob.glob(os.path.join(dirname, '*.txt'))) maxdate = 0 for path in files: diff --git a/doc/man/zathura.1.rst b/doc/man/zathura.1.rst index 694296c..fe2e67d 100644 --- a/doc/man/zathura.1.rst +++ b/doc/man/zathura.1.rst @@ -4,47 +4,305 @@ Manpage Synopsis -------- -.. include:: _synopsis.txt +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] + Description ----------- -.. include:: _description.txt +**zathura** 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 **zathura** instance launches. Options ------- -.. include:: _options.txt +-e, --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. + +-f, --find=string + Opens the document and searches for the given string. + +-l, --log-level=level + Set log level (debug, info, warning, error) + +-x, --synctex-editor-command=command + Set the synctex editor command. Overrides the synctex-editor-command setting. + +--synctex-forward=input + Jump to the given position. The switch expects the same format as specified + for synctex's view -i. If no instance is running for the specified document, + a new instance will be launched (only if --synctex-pid is not specified). + +--synctex-pid=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. + +--mode=mode + Start in a non-default mode + +--fork + Fork into background + +--version + Display version string and exit + +--help + Display help and exit Mouse and key bindings ---------------------- -.. include:: _bindings.txt +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, , y + Scroll a full page left, down, up or right + gg, G, nG + Goto to the first, the last or to the nth page + P + Snaps to the current 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 (grayscale and invert colors) + R + Reload document + Tab + Show index and switch to **Index mode** + d + Toggle dual page view + F5 + Switch to presentation mode + F11 + 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, , + Scroll a full page down or up + gg, G, nG + Goto to the first, the last or to the nth page + ^c, Escape + Abort + F11 + 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 + +Presentation mode + + space, , + Scroll a full page down or up + ^c, Escape + Abort + F5 + Switch to normal mode + 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 + Commands --------- -.. include:: _commands.txt +bmark + Save a bookmark + +bdelete + Delete a bookmark + +blist + List bookmarks + +close + Close document + +exec + Execute an external command + +info + Show document information + +open + Open a document + +offset + Set page offset + +print + Print document + +write(!) + Save document (and force overwriting) + +export + Export attachments + +dump + Write values, descriptions, etc. of all current settings to a file. Configuration ------------- -.. include:: _configuration.txt +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). Synctex support --------------- -.. include:: _synctex.txt +Both synctex forward and backwards synchronization are supported by zathura, To +enable synctex forward synchronization, please look at the *--synctex-forward* +and *--synctex-editor* 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 *synctex view* command. It is enough to +pass the arguments to *synctex view*'s *-i* option to zathura via +*--synctex-forward* and zathura will pass the information to the correct +instance. + +For gvim forward and backwards synchronization support can be set up as follows: +First add the following to the vim configuration: + +:: + + function! Synctex() + execute "silent !zathura --synctex-forward " . line('.') . ":" . col('.') . ":" . bufname('%') . " " . g:syncpdf + redraw! + endfunction + map :call Synctex() + +Then launch *zathura* with + +:: + + zathura -x "gvim --servername vim -c \"let g:syncpdf='$1'\" --remote +%{line} %{input}" $file + +Some editors support zathura as viewer out of the box: + +* LaTeXTools for SublimeText + (https://latextools.readthedocs.io/en/latest/available-viewers/#zathura) +* LaTeX for Atom (https://atom.io/packages/latex) Environment variables --------------------- -.. include:: _env.txt +ZATHURA_PLUGINS_PATH + Path to the directory containing plugins. This directory is only considered if + no other directory was specified using --plugins-dir. Known bugs ---------- -.. include:: _bugs.txt +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. See Also -------- diff --git a/doc/meson.build b/doc/meson.build index d178322..b67c8ab 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -11,15 +11,7 @@ if sphinx.found() output: ['zathura.1', 'zathurarc.5'], input: [ 'man/conf.py', - 'man/_bindings.txt', - 'man/_commands.txt', - 'man/_options.txt', - 'man/_synopsis.txt', 'man/zathurarc.5.rst', - 'man/_bugs.txt', - 'man/_configuration.txt', - 'man/_description.txt', - 'man/_synctex.txt', 'man/zathura.1.rst' ], build_by_default: true,