diff options
Diffstat (limited to 'community/zathura/files/zathurarc.5')
| -rw-r--r-- | community/zathura/files/zathurarc.5 | 1397 |
1 files changed, 1397 insertions, 0 deletions
diff --git a/community/zathura/files/zathurarc.5 b/community/zathura/files/zathurarc.5 new file mode 100644 index 00000000..ba9f1a3c --- /dev/null +++ b/community/zathura/files/zathurarc.5 @@ -0,0 +1,1397 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "ZATHURARC" "5" "2021-07-14" "0.4.8" "zathura" +.SH NAME +zathurarc \- zathura configuration file +.SH SYNOPSIS +.sp +/etc/zathurarc, $XDG_CONFIG_HOME/zathura/zathurarc +.SH DESCRIPTION +.sp +The \fIzathurarc\fP 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. +.SH COMMANDS +.SS set \- Changing options +.sp +In addition to the built\-in \fB:set\fP 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 +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +set <option> <new value> +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +The \fBoption\fP field has to be replaced with the name of the option that should be +changed and the \fBnew value\fP field has to be replaced with the new value the +option should get. The type of the value can be one of the following: +.INDENT 0.0 +.IP \(bu 2 +INT \- An integer number +.IP \(bu 2 +FLOAT \- A floating point number +.IP \(bu 2 +STRING \- A character string +.IP \(bu 2 +BOOL \- A boolean value ("true" for true, "false" for false) +.UNINDENT +.sp +In addition we advice you to check the options to get a more detailed view of +the options that can be changed and which values they should be set to. +.sp +The following example should give some deeper insight of how the \fBset\fP command +can be used +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +set option1 5 +set option2 2.0 +set option3 hello +set option4 hello\e world +set option5 "hello world" +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Especially for options with strings as values, note that escaping of special characters and white +spaces is necessary. In the above example, \fBoption4\fP and \fBoption5\fP are both set to \fBhello +world\fP, but \fBset option6 hello world\fP would set \fBoption6\fP only to \fBhello\fP\&. +.sp +For colors, zathura supports HTML color codes and CSS3\-style \fBrgb(r,g,b)\fP and \fBrgba(r,g,b,a)\fP +values. If you want to use color codes for some options, make sure to quote them accordingly or +to escape the hash symbol. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +set default\-fg "#CCBBCC" +set default\-fg \e#CCBBCC +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +For \fBrgba\fP, note that it parses the color components as integers between 0 and 255 and the alpha +component as float between 0 and 1. +.SS include \- Including another config file +.sp +This commands allows one to include other configuration files. If a relative +path is given, the path will be resolved relative to the configuration file that +is currently processed. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +include another\-config +.ft P +.fi +.UNINDENT +.UNINDENT +.SS map \- Mapping a shortcut +.sp +It is possible to map or remap new key bindings to shortcut functions which +allows a high level of customization. The \fB:map\fP command can also be used in +the \fIzathurarc\fP file to make those changes permanent: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +map [mode] <binding> <shortcut function> <argument> +.ft P +.fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \fIMode\fP +The \fBmap\fP command expects several arguments where only the \fBbinding\fP as well as +the \fBshortcut\-function\fP argument is required. Since zathura uses several modes +it is possible to map bindings only for a specific mode by passing the \fBmode\fP +argument which can take one of the following values: +.INDENT 7.0 +.IP \(bu 2 +normal (default) +.IP \(bu 2 +fullscreen +.IP \(bu 2 +presentation +.IP \(bu 2 +index +.UNINDENT +.sp +The brackets around the value are mandatory. +.TP +.B \fISingle key binding\fP +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: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +map a shortcut_function optional_argument +map b shortcut_function optional_argument +map c shortcut_function optional_argument +map 1 shortcut_function optional_argument +map 2 shortcut_function optional_argument +map 3 shortcut_function optional_argument +map ! shortcut_function optional_argument +map ? shortcut_function optional_argument +.ft P +.fi +.UNINDENT +.UNINDENT +.TP +.B \fIUsing modifiers\fP +It is also possible to use modifiers like the Control or Alt button on the +keyboard. It is possible to use the following modifiers: +.INDENT 7.0 +.IP \(bu 2 +A \- Alt +.IP \(bu 2 +C \- Control +.IP \(bu 2 +S \- Shift +.UNINDENT +.sp +If any of the modifiers should be used for a binding, it is required to define +the \fBbinding\fP with the following structure: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +map <A\-a> shortcut_function +map <C\-a> shortcut_function +.ft P +.fi +.UNINDENT +.UNINDENT +.TP +.B \fISpecial keys\fP +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: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +Identifier Description + +BackSpace Back space +CapsLock Caps lock +Esc Escape +Down Arrow down +Up Arrow up +Left Arrow left +Right Arrow 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 key +Tab Tab +Print Print key +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +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: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +map <Space> shortcut_function +map <C\-Space> shortcut_function +.ft P +.fi +.UNINDENT +.UNINDENT +.TP +.B \fIMouse buttons\fP +It is also possible to map mouse buttons to shortcuts by using the following +special keys: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +Identifier Description + +Button1 Mouse button 1 +Button2 Mouse button 2 +Button3 Mouse button 3 +Button4 Mouse button 4 +Button5 Mouse button 5 +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.sp +They can also be combined with modifiers: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +map <Button1> shortcut_function +map <C\-Button1> shortcut_function +.ft P +.fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \fIBuffer commands\fP +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: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +map abc quit +map test quit +.ft P +.fi +.UNINDENT +.UNINDENT +.TP +.B \fIShortcut functions\fP +The following shortcut functions can be mapped: +.INDENT 7.0 +.IP \(bu 2 +\fBabort\fP +.sp +Switch back to normal mode. +.IP \(bu 2 +\fBadjust_window\fP +.sp +Adjust page width. Possible arguments are \fBbest\-fit\fP and \fBwidth\fP\&. +.IP \(bu 2 +\fBchange_mode\fP +.sp +Change current mode. Pass the desired mode as argument. +.IP \(bu 2 +\fBdisplay_link\fP: +.sp +Display link target. +.IP \(bu 2 +\fBexec\fP: +.sp +Execute an external command. +.IP \(bu 2 +\fBfocus_inputbar\fP +.sp +Focus inputbar. +.IP \(bu 2 +\fBfollow\fP +.sp +Follow a link. +.IP \(bu 2 +\fBgoto\fP +.sp +Go to a certain page. +.IP \(bu 2 +\fBjumplist\fP +.sp +Move forwards/backwards in the jumplist. Pass \fBforward\fP as argument to +move to the next entry and \fBbackward\fP to move to the previous one. +.IP \(bu 2 +\fBnavigate\fP +.sp +Navigate to the next/previous page. +.IP \(bu 2 +\fBnavigate_index\fP +.sp +Navigate through the index. +.IP \(bu 2 +\fBprint\fP +.sp +Show the print dialog. +.IP \(bu 2 +\fBquit\fP +.sp +Quit zathura. +.IP \(bu 2 +\fBrecolor\fP +.sp +Recolor pages. +.IP \(bu 2 +\fBreload\fP +.sp +Reload the document. +.IP \(bu 2 +\fBrotate\fP +.sp +Rotate the page. Pass \fBrotate\-ccw\fP as argument for counterclockwise rotation +and \fBrotate\-cw\fP for clockwise rotation. +.IP \(bu 2 +\fBscroll\fP +.sp +Scroll. +.IP \(bu 2 +\fBsearch\fP +.sp +Search next/previous item. Pass \fBforward\fP as argument to search for the next +hit and \fBbackward\fP to search for the previous hit. +.IP \(bu 2 +\fBset\fP +.sp +Set an option. +.IP \(bu 2 +\fBsnap_to_page\fP +.sp +Snaps to the current page. Equivalent to \fBgoto <current_page>\fP +.IP \(bu 2 +\fBtoggle_fullscreen\fP +.sp +Toggle fullscreen. +.IP \(bu 2 +\fBtoggle_index\fP +.sp +Show or hide index. +.IP \(bu 2 +\fBtoggle_inputbar\fP +.sp +Show or hide inputbar. +.IP \(bu 2 +\fBtoggle_page_mode\fP +.sp +Toggle between one and multiple pages per row. +.IP \(bu 2 +\fBtoggle_statusbar\fP +.sp +Show or hide statusbar. +.IP \(bu 2 +\fBzoom\fP +.sp +Zoom in or out. +.IP \(bu 2 +\fBmark_add\fP +.sp +Set a quickmark. +.IP \(bu 2 +\fBmark_evaluate\fP +.sp +Go to a quickmark. +.IP \(bu 2 +\fBfeedkeys\fP +.sp +Simulate key presses. Note that all keys will be interpreted as if pressing a +key on the keyboard. To input uppercase letters, follow the same convention as +for key bindings, i.e. for \fBX\fP, use \fB<S\-X>\fP\&. +.UNINDENT +.TP +.B \fIPass arguments\fP +Some shortcut function require or have optional arguments which influence the +behaviour of them. Those can be passed as the last argument: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +map <C\-i> zoom in +map <C\-o> zoom out +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Possible arguments are: +.INDENT 7.0 +.IP \(bu 2 +best\-fit +.IP \(bu 2 +bottom +.IP \(bu 2 +backward +.IP \(bu 2 +collapse +.IP \(bu 2 +collapse\-all +.IP \(bu 2 +default +.IP \(bu 2 +down +.IP \(bu 2 +expand +.IP \(bu 2 +expand\-all +.IP \(bu 2 +forward +.IP \(bu 2 +full\-down +.IP \(bu 2 +full\-up +.IP \(bu 2 +half\-down +.IP \(bu 2 +half\-up +.IP \(bu 2 +in +.IP \(bu 2 +left +.IP \(bu 2 +next +.IP \(bu 2 +out +.IP \(bu 2 +page\-bottom +.IP \(bu 2 +page\-top +.IP \(bu 2 +previous +.IP \(bu 2 +right +.IP \(bu 2 +rotate\-ccw +.IP \(bu 2 +rotate\-cw +.IP \(bu 2 +select +.IP \(bu 2 +specific +.IP \(bu 2 +toggle +.IP \(bu 2 +top +.IP \(bu 2 +up +.IP \(bu 2 +width +.UNINDENT +.UNINDENT +.SS unmap \- Removing a shortcut +.sp +In addition to mapping or remaping custom key bindings it is possible to remove +existing ones by using the \fB:unmap\fP command. The command is used in the +following way (the explanation of the parameters is described in the \fBmap\fP +section of this document +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +unmap [mode] <binding> +.ft P +.fi +.UNINDENT +.UNINDENT +.SH OPTIONS +.sp +This section describes settings concerning the behaviour of girara and +zathura. The settings described here can be changed with \fBset\fP\&. +.SS girara +.INDENT 0.0 +.TP +.B \fIn\-completion\-items\fP +Defines the maximum number of displayed completion entries. +.INDENT 7.0 +.IP \(bu 2 +Value type: Integer +.IP \(bu 2 +Default value: 15 +.UNINDENT +.TP +.B \fIcompletion\-bg\fP +Defines the background color that is used for command line completion +entries +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #232323 +.UNINDENT +.TP +.B \fIcompletion\-fg\fP +Defines the foreground color that is used for command line completion +entries +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #DDDDDD +.UNINDENT +.TP +.B \fIcompletion\-group\-bg\fP +Defines the background color that is used for command line completion +group elements +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #000000 +.UNINDENT +.TP +.B \fIcompletion\-group\-fg\fP +Defines the foreground color that is used for command line completion +group elements +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #DEDEDE +.UNINDENT +.TP +.B \fIcompletion\-highlight\-bg\fP +Defines the background color that is used for the current command line +completion element +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #9FBC00 +.UNINDENT +.TP +.B \fIcompletion\-highlight\-fg\fP +Defines the foreground color that is used for the current command line +completion element +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #232323 +.UNINDENT +.TP +.B \fIdefault\-fg\fP +Defines the default foreground color +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #DDDDDD +.UNINDENT +.TP +.B \fIdefault\-bg\fP +Defines the default background color +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #000000 +.UNINDENT +.TP +.B \fIexec\-command\fP +Defines a command the should be prepended to any command run with exec. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: +.UNINDENT +.TP +.B \fIfont\fP +Defines the font that will be used +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: monospace normal 9 +.UNINDENT +.TP +.B \fIguioptions\fP +Shows or hides GUI elements. +If it contains \(aqc\(aq, the command line is displayed. +If it contains \(aqs\(aq, the statusbar is displayed. +If it contains \(aqh\(aq, the horizontal scrollbar is displayed. +If it contains \(aqv\(aq, the vertical scrollbar is displayed. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: s +.UNINDENT +.TP +.B \fIinputbar\-bg\fP +Defines the background color for the inputbar +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #131313 +.UNINDENT +.TP +.B \fIinputbar\-fg\fP +Defines the foreground color for the inputbar +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #9FBC00 +.UNINDENT +.TP +.B \fInotification\-bg\fP +Defines the background color for a notification +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #FFFFFF +.UNINDENT +.TP +.B \fInotification\-fg\fP +Defines the foreground color for a notification +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #000000 +.UNINDENT +.TP +.B \fInotification\-error\-bg\fP +Defines the background color for an error notification +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #FFFFFF +.UNINDENT +.TP +.B \fInotification\-error\-fg\fP +Defines the foreground color for an error notification +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #FF1212 +.UNINDENT +.TP +.B \fInotification\-warning\-bg\fP +Defines the background color for a warning notification +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #FFFFFF +.UNINDENT +.TP +.B \fInotification\-warning\-fg\fP +Defines the foreground color for a warning notification +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #FFF712 +.UNINDENT +.TP +.B \fIstatusbar\-bg\fP +Defines the background color of the statusbar +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #000000 +.UNINDENT +.TP +.B \fIstatusbar\-fg\fP +Defines the foreground color of the statusbar +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #FFFFFF +.UNINDENT +.TP +.B \fIstatusbar\-h\-padding\fP +Defines the horizontal padding of the statusbar and notificationbar +.INDENT 7.0 +.IP \(bu 2 +Value type: Integer +.IP \(bu 2 +Default value: 8 +.UNINDENT +.TP +.B \fIstatusbar\-v\-padding\fP +Defines the vertical padding of the statusbar and notificationbar +.INDENT 7.0 +.IP \(bu 2 +Value type: Integer +.IP \(bu 2 +Default value: 2 +.UNINDENT +.TP +.B \fIwindow\-icon\fP +Defines the path for a icon to be used as window icon. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: +.UNINDENT +.TP +.B \fIwindow\-height\fP +Defines the window height on startup +.INDENT 7.0 +.IP \(bu 2 +Value type: Integer +.IP \(bu 2 +Default value: 600 +.UNINDENT +.TP +.B \fIwindow\-width\fP +Defines the window width on startup +.INDENT 7.0 +.IP \(bu 2 +Value type: Integer +.IP \(bu 2 +Default value: 800 +.UNINDENT +.UNINDENT +.SS zathura +.INDENT 0.0 +.INDENT 3.5 +This section describes settings concerning the behaviour of zathura. +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \fIabort\-clear\-search\fP +Defines if the search results should be cleared on abort. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: true +.UNINDENT +.TP +.B \fIadjust\-open\fP +Defines which auto adjustment mode should be used if a document is loaded. +Possible options are "best\-fit" and "width". +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: best\-fit +.UNINDENT +.TP +.B \fIadvance\-pages\-per\-row\fP +Defines if the number of pages per row should be honored when advancing a page. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIcontinuous\-hist\-save\fP +Tells zathura whether to save document history at each page change or only when +closing a document. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIdatabase\fP +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. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: plain +.UNINDENT +.TP +.B \fIdbus\-service\fP +En/Disables the D\-Bus service. If the services is disabled, SyncTeX forward +synchronization is not available. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: true +.UNINDENT +.TP +.B \fIdbus\-raise\-window\fP +Defines whether zathura\(aqs window should be raised when receiving certain +commands via D\-Bus. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: true +.UNINDENT +.TP +.B \fIfilemonitor\fP +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. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: glib +.UNINDENT +.TP +.B \fIincremental\-search\fP +En/Disables incremental search (search while typing). +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: true +.UNINDENT +.TP +.B \fIhighlight\-color\fP +Defines the color that is used for highlighting parts of the document (e.g.: +show search results) +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #9FBC00 +.UNINDENT +.TP +.B \fIhighlight\-fg\fP +Defines the color that is used for text when highlighting parts of the +document (e.g.: number for links). +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #9FBC00 +.UNINDENT +.TP +.B \fIhighlight\-active\-color\fP +Defines the color that is used to show the current selected highlighted element +(e.g: current search result) +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #00BC00 +.UNINDENT +.TP +.B \fIhighlight\-transparency\fP +Defines the opacity of a highlighted element +.INDENT 7.0 +.IP \(bu 2 +Value type: Float +.IP \(bu 2 +Default value: 0.5 +.UNINDENT +.TP +.B \fIpage\-padding\fP +The page padding defines the gap in pixels between each rendered page. +.INDENT 7.0 +.IP \(bu 2 +Value type: Integer +.IP \(bu 2 +Default value: 1 +.UNINDENT +.TP +.B \fIpage\-cache\-size\fP +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\(aqt cached becomes visible, the least +recently viewed page in the cache will be evicted to make room for the new one. +Large values for this variable are NOT recommended, because this will lead to +consuming a significant portion of the system memory. +.INDENT 7.0 +.IP \(bu 2 +Value type: Integer +.IP \(bu 2 +Default value: 15 +.UNINDENT +.TP +.B \fIpage\-thumbnail\-size\fP +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 +saved as the thumbnail only if the size is no more than this value. A larger +value increases quality but introduces longer delay in zooming and uses more +system memory. +.INDENT 7.0 +.IP \(bu 2 +Value type: Integer +.IP \(bu 2 +Default value: 4194304 (4M) +.UNINDENT +.TP +.B \fIpages\-per\-row\fP +Defines the number of pages that are rendered next to each other in a row. +.INDENT 7.0 +.IP \(bu 2 +Value type: Integer +.IP \(bu 2 +Default value: 1 +.UNINDENT +.TP +.B \fIfirst\-page\-column\fP +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 +value in the list will be used for all other number of pages per row if not set +explicitly. +.sp +Per default, the first column is set to 2 for double\-page layout, i.e. the value +is set to 1:2. A value of 1:1:3 would put the first page in dual\-page layout in +the first column, and for layouts with more columns the first page would be put +in the 3rd column. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: 1:2 +.UNINDENT +.TP +.B \fIrecolor\fP +En/Disables recoloring +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIrecolor\-keephue\fP +En/Disables keeping original hue when recoloring +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIrecolor\-darkcolor\fP +Defines the color value that is used to represent dark colors in recoloring mode +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #FFFFFF +.UNINDENT +.TP +.B \fIrecolor\-lightcolor\fP +Defines the color value that is used to represent light colors in recoloring mode +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #000000 +.UNINDENT +.TP +.B \fIrecolor\-reverse\-video\fP +Defines if original image colors should be kept while recoloring. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIrender\-loading\fP +Defines if the "Loading..." text should be displayed if a page is rendered. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: true +.UNINDENT +.TP +.B \fIrender\-loading\-bg\fP +Defines the background color that is used for the "Loading..." text. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #FFFFFF +.UNINDENT +.TP +.B \fIrender\-loading\-fg\fP +Defines the foreground color that is used for the "Loading..." text. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #000000 +.UNINDENT +.TP +.B \fIscroll\-hstep\fP +Defines the horizontal step size of scrolling by calling the scroll command once +.INDENT 7.0 +.IP \(bu 2 +Value type: Float +.IP \(bu 2 +Default value: \-1 +.UNINDENT +.TP +.B \fIscroll\-step\fP +Defines the step size of scrolling by calling the scroll command once +.INDENT 7.0 +.IP \(bu 2 +Value type: Float +.IP \(bu 2 +Default value: 40 +.UNINDENT +.TP +.B \fIscroll\-full\-overlap\fP +Defines the proportion of the current viewing area that should be +visible after scrolling a full page. +.INDENT 7.0 +.IP \(bu 2 +Value type: Float +.IP \(bu 2 +Default value: 0 +.UNINDENT +.TP +.B \fIscroll\-wrap\fP +Defines if the last/first page should be wrapped +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIshow\-directories\fP +Defines if the directories should be displayed in completion. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: true +.UNINDENT +.TP +.B \fIshow\-hidden\fP +Defines if hidden files and directories should be displayed in completion. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIshow\-recent\fP +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. +.INDENT 7.0 +.IP \(bu 2 +Value type: Integer +.IP \(bu 2 +Default value: 10 +.UNINDENT +.TP +.B \fIscroll\-page\-aware\fP +Defines if scrolling by half or full pages stops at page boundaries. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIlink\-zoom\fP +En/Disables the ability of changing zoom when following links. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: true +.UNINDENT +.TP +.B \fIlink\-hadjust\fP +En/Disables aligning to the left internal link targets, for example from the +index. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: true +.UNINDENT +.TP +.B \fIsearch\-hadjust\fP +En/Disables horizontally centered search results. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: true +.UNINDENT +.TP +.B \fIwindow\-title\-basename\fP +Use basename of the file in the window title. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIwindow\-title\-home\-tilde\fP +Display a short version of the file path, which replaces $HOME with ~, in the window title. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIwindow\-title\-page\fP +Display the page number in the window title. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIstatusbar\-basename\fP +Use basename of the file in the statusbar. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIstatusbar\-home\-tilde\fP +Display a short version of the file path, which replaces $HOME with ~, in the statusbar. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIzoom\-center\fP +En/Disables horizontally centered zooming. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIvertical\-center\fP +Center the screen at the vertical midpoint of the page by default. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIzoom\-max\fP +Defines the maximum percentage that the zoom level can be. +.INDENT 7.0 +.IP \(bu 2 +Value type: Integer +.IP \(bu 2 +Default value: 1000 +.UNINDENT +.TP +.B \fIzoom\-min\fP +Defines the minimum percentage that the zoom level can be. +.INDENT 7.0 +.IP \(bu 2 +Value type: Integer +.IP \(bu 2 +Default value: 10 +.UNINDENT +.TP +.B \fIzoom\-step\fP +Defines the amount of percent that is zoomed in or out on each command. +.INDENT 7.0 +.IP \(bu 2 +Value type: Integer +.IP \(bu 2 +Default value: 10 +.UNINDENT +.TP +.B \fIselection\-clipboard\fP +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 +data will be written to the PRIMARY clipboard, and can be pasted using the +middle mouse button, or the Shift\-Insert key combination. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: primary +.UNINDENT +.TP +.B \fIselection\-notification\fP +Defines if a notification should be displayed after selecting text. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: true +.UNINDENT +.TP +.B \fIsynctex\fP +En/Disables SyncTeX backward synchronization support. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: true +.UNINDENT +.TP +.B \fIsynctex\-editor\-command\fP +Defines the command executed for SyncTeX backward synchronization. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: +.UNINDENT +.TP +.B \fIindex\-fg\fP +Defines the foreground color of the index mode. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #DDDDDD +.UNINDENT +.TP +.B \fIindex\-bg\fP +Define the background color of the index mode. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #232323 +.UNINDENT +.TP +.B \fIindex\-active\-fg\fP +Defines the foreground color of the selected element in index mode. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #232323 +.UNINDENT +.TP +.B \fIindex\-active\-bg\fP +Define the background color of the selected element in index mode. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: #9FBC00 +.UNINDENT +.TP +.B \fIsandbox\fP +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 +allow normal use of zathura with support for all features. The "strict" mode +is a read only sandbox that is intended for viewing documents only. +.INDENT 7.0 +.IP \(bu 2 +Value type: String +.IP \(bu 2 +Default value: normal +.UNINDENT +.sp +Some features are disabled when using strict sandbox mode: +.INDENT 7.0 +.IP \(bu 2 +saving/writing files +.IP \(bu 2 +use of input methods like ibus +.IP \(bu 2 +printing +.IP \(bu 2 +bookmarks and history +.UNINDENT +.sp +No feature regressions are expected when using normal sandbox mode. +.sp +When running under WSL, the default is "none" since seccomp is not supported in +that environment. +.TP +.B \fIwindow\-icon\-document\fP +Defines whether the window document should be updated based on the first page of +a dcument. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.TP +.B \fIpage\-right\-to\-left\fP +Defines whether pages in multi\-column view should start from the right side. +.INDENT 7.0 +.IP \(bu 2 +Value type: Boolean +.IP \(bu 2 +Default value: false +.UNINDENT +.UNINDENT +.SH SEE ALSO +.sp +zathura(1) +.SH AUTHOR +pwmt.org +.SH COPYRIGHT +2009-2018, pwmt.org +.\" Generated by docutils manpage writer. +. |