reformat the rest pages used to create man pages

- in zathura.1.rst, move "Environmental variables" section closer to bottom

- in zathurarc.5.rst, change from using subsections to using
  definitions (in order to make levels clearer on output to terminal)
This commit is contained in:
Greg Minshall 2019-11-26 15:49:09 +05:30
parent 8d60f5187d
commit 6248cdbed4
2 changed files with 591 additions and 688 deletions

View file

@ -16,11 +16,6 @@ Options
.. include:: _options.txt
Environment variables
---------------------
.. include:: _env.txt
Mouse and key bindings
----------------------
@ -41,6 +36,11 @@ Synctex support
.. include:: _synctex.txt
Environment variables
---------------------
.. include:: _env.txt
Known bugs
----------

View file

@ -1,6 +1,6 @@
=========
*********
zathurarc
=========
*********
SYNOPSIS
========
@ -88,8 +88,7 @@ the *zathurarc* file to make those changes permanent:
map [mode] <binding> <shortcut function> <argument>
Mode
^^^^
*Mode*
The ``map`` command expects several arguments where only the ``binding`` as well as
the ``shortcut-function`` argument is required. Since zathura uses several modes
it is possible to map bindings only for a specific mode by passing the ``mode``
@ -102,8 +101,7 @@ argument which can take one of the following values:
The brackets around the value are mandatory.
Single key binding
^^^^^^^^^^^^^^^^^^
*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:
@ -119,8 +117,7 @@ hand it is possible to just assign single letters, numbers or signs to it:
map ! shortcut_function optional_argument
map ? shortcut_function optional_argument
Using modifiers
^^^^^^^^^^^^^^^
*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:
@ -136,8 +133,7 @@ the ``binding`` with the following structure:
map <A-a> shortcut_function
map <C-a> shortcut_function
Special keys
^^^^^^^^^^^^
*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:
@ -181,8 +177,7 @@ usage of those keys should be explained by the following examples:
map <Space> shortcut_function
map <C-Space> shortcut_function
Mouse buttons
^^^^^^^^^^^^^
*Mouse buttons*
It is also possible to map mouse buttons to shortcuts by using the following
special keys:
@ -203,8 +198,7 @@ They can also be combined with modifiers:
map <Button1> shortcut_function
map <C-Button1> shortcut_function
Buffer commands
^^^^^^^^^^^^^^^
*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:
@ -213,8 +207,7 @@ mapping it will be mapped as a buffer command:
map abc quit
map test quit
Shortcut functions
^^^^^^^^^^^^^^^^^^
*Shortcut functions*
The following shortcut functions can be mapped:
* ``abort``
@ -335,8 +328,7 @@ The following shortcut functions can be mapped:
for key bindings, i.e. for ``X``, use ``<S-X>``.
Pass arguments
^^^^^^^^^^^^^^
*Pass arguments*
Some shortcut function require or have optional arguments which influence the
behaviour of them. Those can be passed as the last argument:
@ -393,96 +385,85 @@ section of this document
OPTIONS
=======
girara
------
This section describes settings concerning the behaviour of girara and
zathura. The settings described here can be changed with ``set``.
n-completion-items
^^^^^^^^^^^^^^^^^^
girara
------
*n-completion-items*
Defines the maximum number of displayed completion entries.
* Value type: Integer
* Default value: 15
completion-bg
^^^^^^^^^^^^^
*completion-bg*
Defines the background color that is used for command line completion
entries
* Value type: String
* Default value: #232323
completion-fg
^^^^^^^^^^^^^
*completion-fg*
Defines the foreground color that is used for command line completion
entries
* Value type: String
* Default value: #DDDDDD
completion-group-bg
^^^^^^^^^^^^^^^^^^^
*completion-group-bg*
Defines the background color that is used for command line completion
group elements
* Value type: String
* Default value: #000000
completion-group-fg
^^^^^^^^^^^^^^^^^^^
*completion-group-fg*
Defines the foreground color that is used for command line completion
group elements
* Value type: String
* Default value: #DEDEDE
completion-highlight-bg
^^^^^^^^^^^^^^^^^^^^^^^
*completion-highlight-bg*
Defines the background color that is used for the current command line
completion element
* Value type: String
* Default value: #9FBC00
completion-highlight-fg
^^^^^^^^^^^^^^^^^^^^^^^
*completion-highlight-fg*
Defines the foreground color that is used for the current command line
completion element
* Value type: String
* Default value: #232323
default-fg
^^^^^^^^^^
*default-fg*
Defines the default foreground color
* Value type: String
* Default value: #DDDDDD
default-bg
^^^^^^^^^^
*default-bg*
Defines the default background color
* Value type: String
* Default value: #000000
exec-command
^^^^^^^^^^^^
*exec-command*
Defines a command the should be prepended to any command run with exec.
* Value type: String
* Default value:
font
^^^^
*font*
Defines the font that will be used
* Value type: String
* Default value: monospace normal 9
guioptions
^^^^^^^^^^
*guioptions*
Shows or hides GUI elements.
If it contains 'c', the command line is displayed.
If it contains 's', the statusbar is displayed.
@ -492,158 +473,136 @@ If it contains 'v', the vertical scrollbar is displayed.
* Value type: String
* Default value: s
inputbar-bg
^^^^^^^^^^^
*inputbar-bg*
Defines the background color for the inputbar
* Value type: String
* Default value: #131313
inputbar-fg
^^^^^^^^^^^
*inputbar-fg*
Defines the foreground color for the inputbar
* Value type: String
* Default value: #9FBC00
notification-bg
^^^^^^^^^^^^^^^^^^^^^
*notification-bg*
Defines the background color for a notification
* Value type: String
* Default value: #FFFFFF
notification-fg
^^^^^^^^^^^^^^^^^^^^^
*notification-fg*
Defines the foreground color for a notification
* Value type: String
* Default value: #000000
notification-error-bg
^^^^^^^^^^^^^^^^^^^^^
*notification-error-bg*
Defines the background color for an error notification
* Value type: String
* Default value: #FFFFFF
notification-error-fg
^^^^^^^^^^^^^^^^^^^^^
*notification-error-fg*
Defines the foreground color for an error notification
* Value type: String
* Default value: #FF1212
notification-warning-bg
^^^^^^^^^^^^^^^^^^^^^^^
*notification-warning-bg*
Defines the background color for a warning notification
* Value type: String
* Default value: #FFFFFF
notification-warning-fg
^^^^^^^^^^^^^^^^^^^^^^^
*notification-warning-fg*
Defines the foreground color for a warning notification
* Value type: String
* Default value: #FFF712
tabbar-fg
^^^^^^^^^
*tabbar-fg*
Defines the foreground color for a tab
* Value type: String
* Default value: #FFFFFF
tabbar-bg
^^^^^^^^^
*tabbar-bg*
Defines the background color for a tab
* Value type: String
* Default value: #000000
tabbar-focus-fg
^^^^^^^^^^^^^^^
*tabbar-focus-fg*
Defines the foreground color for the focused tab
* Value type: String
* Default value: #9FBC00
tabbar-focus-bg
^^^^^^^^^^^^^^^
*tabbar-focus-bg*
Defines the background color for the focused tab
* Value type: String
* Default value: #000000
show-scrollbars
^^^^^^^^^^^^^^^
*show-scrollbars*
Defines if both the horizontal and vertical scrollbars should be shown or not.
Deprecated, use 'guioptions' instead.
* Value type: Boolean
* Default value: false
show-h-scrollbar
^^^^^^^^^^^^^^^^
*show-h-scrollbar*
Defines whether to show/hide the horizontal scrollbar. Deprecated, use
'guioptions' instead.
* Value type: Boolean
* Default value: false
show-v-scrollbar
^^^^^^^^^^^^^^^^
*show-v-scrollbar*
Defines whether to show/hide the vertical scrollbar. Deprecated, use
'guioptions' instead.
* Value type: Boolean
* Default value: false
statusbar-bg
^^^^^^^^^^^^
*statusbar-bg*
Defines the background color of the statusbar
* Value type: String
* Default value: #000000
statusbar-fg
^^^^^^^^^^^^
*statusbar-fg*
Defines the foreground color of the statusbar
* Value type: String
* Default value: #FFFFFF
statusbar-h-padding
^^^^^^^^^^^^^^^^^^^
*statusbar-h-padding*
Defines the horizontal padding of the statusbar and notificationbar
* Value type: Integer
* Default value: 8
statusbar-v-padding
^^^^^^^^^^^^^^^^^^^
*statusbar-v-padding*
Defines the vertical padding of the statusbar and notificationbar
* Value type: Integer
* Default value: 2
window-icon
^^^^^^^^^^^
*window-icon*
Defines the path for a icon to be used as window icon.
* Value type: String
* Default value:
window-height
^^^^^^^^^^^^^
*window-height*
Defines the window height on startup
* Value type: Integer
* Default value: 600
window-width
^^^^^^^^^^^^
*window-width*
Defines the window width on startup
* Value type: Integer
@ -654,38 +613,33 @@ zathura
This section describes settings concerning the behaviour of zathura.
abort-clear-search
^^^^^^^^^^^^^^^^^^
*abort-clear-search*
Defines if the search results should be cleared on abort.
* Value type: Boolean
* Default value: true
adjust-open
^^^^^^^^^^^
*adjust-open*
Defines which auto adjustment mode should be used if a document is loaded.
Possible options are "best-fit" and "width".
* Value type: String
* Default value: best-fit
advance-pages-per-row
^^^^^^^^^^^^^^^^^^^^^
*advance-pages-per-row*
Defines if the number of pages per row should be honored when advancing a page.
* Value type: Boolean
* Default value: false
continuous-hist-save
^^^^^^^^^^^^^^^^^^^^
*continuous-hist-save*
Tells zathura whether to save document history at each page change or only when
closing a document.
* Value type: Boolean
* Default value: false
database
^^^^^^^^
*database*
Defines the database backend to use for bookmarks and input history. Possible
values are "plain", "sqlite" (if built with sqlite support) and "null". If
"null" is used, bookmarks and input history will not be stored.
@ -693,16 +647,14 @@ values are "plain", "sqlite" (if built with sqlite support) and "null". If
* Value type: String
* Default value: plain
dbus-service
^^^^^^^^^^^^
*dbus-service*
En/Disables the D-Bus service. If the services is disabled, SyncTeX forward
synchronization is not available.
* Value type: Boolean
* Default value: true
filemonitor
^^^^^^^^^^^
*filemonitor*
Defines the file monitor backend used to check for changes in files. Possible
values are "glib", "signal" (if signal handling is supported), and "noop". The
"noop" file monitor does not trigger reloads.
@ -710,45 +662,39 @@ values are "glib", "signal" (if signal handling is supported), and "noop". The
* Value type: String
* Default value: glib
incremental-search
^^^^^^^^^^^^^^^^^^
*incremental-search*
En/Disables incremental search (search while typing).
* Value type: Boolean
* Default value: true
highlight-color
^^^^^^^^^^^^^^^
*highlight-color*
Defines the color that is used for highlighting parts of the document (e.g.:
show search results)
* Value type: String
* Default value: #9FBC00
highlight-active-color
^^^^^^^^^^^^^^^^^^^^^^
*highlight-active-color*
Defines the color that is used to show the current selected highlighted element
(e.g: current search result)
* Value type: String
* Default value: #00BC00
highlight-transparency
^^^^^^^^^^^^^^^^^^^^^^
*highlight-transparency*
Defines the opacity of a highlighted element
* Value type: Float
* Default value: 0.5
page-padding
^^^^^^^^^^^^
*page-padding*
The page padding defines the gap in pixels between each rendered page.
* Value type: Integer
* Default value: 1
page-cache-size
^^^^^^^^^^^^^^^
*page-cache-size*
Defines the maximum number of pages that could be kept in the page cache. When
the cache is full and a new page that isn't cached becomes visible, the least
recently viewed page in the cache will be evicted to make room for the new one.
@ -758,8 +704,7 @@ consuming a significant portion of the system memory.
* Value type: Integer
* Default value: 15
page-thumbnail-size
^^^^^^^^^^^^^^^^^^^
*page-thumbnail-size*
Defines the maximum size in pixels of the thumbnail that could be kept in the
thumbnail cache per page. The thumbnail is scaled for a quick preview during
zooming before the page is rendered. When the page is rendered, the result is
@ -770,15 +715,13 @@ system memory.
* Value type: Integer
* Default value: 4194304 (4M)
pages-per-row
^^^^^^^^^^^^^
*pages-per-row*
Defines the number of pages that are rendered next to each other in a row.
* Value type: Integer
* Default value: 1
first-page-column
^^^^^^^^^^^^^^^^^
*first-page-column*
Defines the column in which the first page will be displayed.
This setting is stored separately for every value of pages-per-row according to
the following pattern <1 page per row>:[<2 pages per row>[: ...]]. The last
@ -793,108 +736,93 @@ in the 3rd column.
* Value type: String
* Default value: 1:2
recolor
^^^^^^^
*recolor*
En/Disables recoloring
* Value type: Boolean
* Default value: false
recolor-keephue
^^^^^^^^^^^^^^^
*recolor-keephue*
En/Disables keeping original hue when recoloring
* Value type: Boolean
* Default value: false
recolor-darkcolor
^^^^^^^^^^^^^^^^^
*recolor-darkcolor*
Defines the color value that is used to represent dark colors in recoloring mode
* Value type: String
* Default value: #FFFFFF
recolor-lightcolor
^^^^^^^^^^^^^^^^^^
*recolor-lightcolor*
Defines the color value that is used to represent light colors in recoloring mode
* Value type: String
* Default value: #000000
recolor-reverse-video
^^^^^^^^^^^^^^^^^^^^^
*recolor-reverse-video*
Defines if original image colors should be kept while recoloring.
* Value type: Boolean
* Default value: false
render-loading
^^^^^^^^^^^^^^
*render-loading*
Defines if the "Loading..." text should be displayed if a page is rendered.
* Value type: Boolean
* Default value: true
render-loading-bg
^^^^^^^^^^^^^^^^^
*render-loading-bg*
Defines the background color that is used for the "Loading..." text.
* Value type: String
* Default value: #FFFFFF
render-loading-fg
^^^^^^^^^^^^^^^^^
*render-loading-fg*
Defines the foreground color that is used for the "Loading..." text.
* Value type: String
* Default value: #000000
scroll-hstep
^^^^^^^^^^^^
*scroll-hstep*
Defines the horizontal step size of scrolling by calling the scroll command once
* Value type: Float
* Default value: -1
scroll-step
^^^^^^^^^^^
*scroll-step*
Defines the step size of scrolling by calling the scroll command once
* Value type: Float
* Default value: 40
scroll-full-overlap
^^^^^^^^^^^^^^^^^^^
*scroll-full-overlap*
Defines the proportion of the current viewing area that should be
visible after scrolling a full page.
* Value type: Float
* Default value: 0
scroll-wrap
^^^^^^^^^^^
*scroll-wrap*
Defines if the last/first page should be wrapped
* Value type: Boolean
* Default value: false
show-directories
^^^^^^^^^^^^^^^^
*show-directories*
Defines if the directories should be displayed in completion.
* Value type: Boolean
* Default value: true
show-hidden
^^^^^^^^^^^
*show-hidden*
Defines if hidden files and directories should be displayed in completion.
* Value type: Boolean
* Default value: false
show-recent
^^^^^^^^^^^
*show-recent*
Defines the number of recent files that should be displayed in completion.
If the value is negative, no upper bounds are applied. If the value is 0, no
recent files are shown.
@ -902,107 +830,92 @@ recent files are shown.
* Value type: Integer
* Default value: 10
scroll-page-aware
^^^^^^^^^^^^^^^^^
*scroll-page-aware*
Defines if scrolling by half or full pages stops at page boundaries.
* Value type: Boolean
* Default value: false
link-zoom
^^^^^^^^^
*link-zoom*
En/Disables the ability of changing zoom when following links.
* Value type: Boolean
* Default value: true
link-hadjust
^^^^^^^^^^^^
*link-hadjust*
En/Disables aligning to the left internal link targets, for example from the
index.
* Value type: Boolean
* Default value: true
search-hadjust
^^^^^^^^^^^^^^
*search-hadjust*
En/Disables horizontally centered search results.
* Value type: Boolean
* Default value: true
window-title-basename
^^^^^^^^^^^^^^^^^^^^^
*window-title-basename*
Use basename of the file in the window title.
* Value type: Boolean
* Default value: false
window-title-home-tilde
^^^^^^^^^^^^^^^^^^^^^^^
*window-title-home-tilde*
Display a short version of the file path, which replaces $HOME with ~, in the window title.
* Value type: Boolean
* Default value: false
window-title-page
^^^^^^^^^^^^^^^^^
*window-title-page*
Display the page number in the window title.
* Value type: Boolean
* Default value: false
statusbar-basename
^^^^^^^^^^^^^^^^^^
*statusbar-basename*
Use basename of the file in the statusbar.
* Value type: Boolean
* Default value: false
statusbar-home-tilde
^^^^^^^^^^^^^^^^^^^^
*statusbar-home-tilde*
Display a short version of the file path, which replaces $HOME with ~, in the statusbar.
* Value type: Boolean
* Default value: false
zoom-center
^^^^^^^^^^^
*zoom-center*
En/Disables horizontally centered zooming.
* Value type: Boolean
* Default value: false
vertical-center
^^^^^^^^^^^^^^^
*vertical-center*
Center the screen at the vertical midpoint of the page by default.
* Value type: Boolean
* Default value: false
zoom-max
^^^^^^^^
*zoom-max*
Defines the maximum percentage that the zoom level can be.
* Value type: Integer
* Default value: 1000
zoom-min
^^^^^^^^
*zoom-min*
Defines the minimum percentage that the zoom level can be.
* Value type: Integer
* Default value: 10
zoom-step
^^^^^^^^^
*zoom-step*
Defines the amount of percent that is zoomed in or out on each command.
* Value type: Integer
* Default value: 10
selection-clipboard
^^^^^^^^^^^^^^^^^^^
*selection-clipboard*
Defines the X clipboard into which mouse-selected data will be written. When it
is "clipboard", selected data will be written to the CLIPBOARD clipboard, and
can be pasted using the Ctrl+v key combination. When it is "primary", selected
@ -1012,57 +925,49 @@ middle mouse button, or the Shift-Insert key combination.
* Value type: String
* Default value: primary
selection-notification
^^^^^^^^^^^^^^^^^^^^^^
*selection-notification*
Defines if a notification should be displayed after selecting text.
* Value type: Boolean
* Default value: true
synctex
^^^^^^^
*synctex*
En/Disables SyncTeX backward synchronization support.
* Value type: Boolean
* Default value: true
synctex-editor-command
^^^^^^^^^^^^^^^^^^^^^^
*synctex-editor-command*
Defines the command executed for SyncTeX backward synchronization.
* Value type: String
* Default value:
index-fg
^^^^^^^^
*index-fg*
Defines the foreground color of the index mode.
* Value type: String
* Default value: #DDDDDD
index-bg
^^^^^^^^
*index-bg*
Define the background color of the index mode.
* Value type: String
* Default value: #232323
index-active-fg
^^^^^^^^^^^^^^^
*index-active-fg*
Defines the foreground color of the selected element in index mode.
* Value type: String
* Default value: #232323
index-active-bg
^^^^^^^^^^^^^^^
*index-active-bg*
Define the background color of the selected element in index mode.
* Value type: String
* Default value: #9FBC00
sandbox
^^^^^^^
*sandbox*
Defines the sandbox mode to use for the seccomp syscall filter. Possible
values are "none", "normal" and "strict". If "none" is used, the sandbox
will be disabled. The use of "normal" will provide minimal protection and
@ -1084,16 +989,14 @@ No feature regressions are expected when using normal sandbox mode.
When running under WSL, the default is "none" since seccomp is not supported in
that environment.
window-icon-document
^^^^^^^^^^^^^^^^^^^^
*window-icon-document*
Defines whether the window document should be updated based on the first page of
a dcument.
* Value type: Boolean
* Default value: false
page-right-to-left
^^^^^^^^^^^^^^^^^^
*page-right-to-left*
Defines whether pages in multi-column view should start from the right side.
* Value type: Boolean