diff options
Diffstat (limited to 'office/zathura/man/zathurarc.5')
| -rw-r--r-- | office/zathura/man/zathurarc.5 | 816 |
1 files changed, 447 insertions, 369 deletions
diff --git a/office/zathura/man/zathurarc.5 b/office/zathura/man/zathurarc.5 index 93b42be0a8..e165c7cd58 100644 --- a/office/zathura/man/zathurarc.5 +++ b/office/zathura/man/zathurarc.5 @@ -1,8 +1,5 @@ .\" Man page generated from reStructuredText. . -.TH "ZATHURARC" "5" "2017-01-11" "0.2.7" "zathura" -.SH NAME -zathurarc \- zathura configuration file . .nr rst2man-indent-level 0 . @@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. +.TH "ZATHURARC" "5" "2022-09-08" "0.5.1" "zathura" +.SH NAME +zathurarc \- zathura configuration file .SH SYNOPSIS .sp /etc/zathurarc, $XDG_CONFIG_HOME/zathura/zathurarc @@ -91,8 +91,13 @@ set option5 "hello world" .UNINDENT .UNINDENT .sp -If you want to use \fBcolor codes\fP for some options, make sure to quote them -accordingly or to escape the hash symbol. +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 @@ -104,79 +109,85 @@ set default\-fg \e#CCBBCC .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: +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 -map [mode] <binding> <shortcut function> <argument> +include another\-config .ft P .fi .UNINDENT .UNINDENT -.SS include \- Including another config file +.SS map \- Mapping a shortcut .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. +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 -include another\-config +map [mode] <binding> <shortcut function> <argument> .ft P .fi .UNINDENT .UNINDENT -.SS Mode -.sp +.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 0.0 +.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. -.SS Single key binding -.sp +.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 0.0 +.INDENT 7.0 .INDENT 3.5 .sp .nf .ft C -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 +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 -.SS Using modifiers -.sp +.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 0.0 +.INDENT 7.0 .IP \(bu 2 A \- Alt .IP \(bu 2 @@ -185,8 +196,9 @@ C \- Control S \- Shift .UNINDENT .sp -Now it is required to define the \fBbinding\fP with the following structure: -.INDENT 0.0 +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 @@ -197,12 +209,12 @@ map <C\-a> shortcut_function .fi .UNINDENT .UNINDENT -.SS Special keys -.sp +.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 0.0 +.INDENT 7.0 .INDENT 3.5 .sp .nf @@ -242,7 +254,7 @@ Print Print key .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 0.0 +.INDENT 7.0 .INDENT 3.5 .sp .nf @@ -253,11 +265,11 @@ map <C\-Space> shortcut_function .fi .UNINDENT .UNINDENT -.SS Mouse buttons -.sp +.TP +.B \fIMouse buttons\fP It is also possible to map mouse buttons to shortcuts by using the following special keys: -.INDENT 0.0 +.INDENT 7.0 .INDENT 3.5 .sp .nf @@ -273,6 +285,7 @@ Button5 Mouse button 5 .fi .UNINDENT .UNINDENT +.UNINDENT .sp They can also be combined with modifiers: .INDENT 0.0 @@ -286,11 +299,12 @@ map <C\-Button1> shortcut_function .fi .UNINDENT .UNINDENT -.SS Buffer commands -.sp +.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 0.0 +.INDENT 7.0 .INDENT 3.5 .sp .nf @@ -301,10 +315,10 @@ map test quit .fi .UNINDENT .UNINDENT -.SS Shortcut functions -.sp +.TP +.B \fIShortcut functions\fP The following shortcut functions can be mapped: -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 \fBabort\fP .sp @@ -322,6 +336,11 @@ Change current mode. Pass the desired mode as argument. .sp Display link target. .IP \(bu 2 +\fBexec\fP: +.sp +Execute an external command. \fB$FILE\fP expands to the current document path, +and \fB$PAGE\fP to the current page number. +.IP \(bu 2 \fBfocus_inputbar\fP .sp Focus inputbar. @@ -336,7 +355,8 @@ Go to a certain page. .IP \(bu 2 \fBjumplist\fP .sp -Move forwards/backwards in the jumplist. +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 @@ -380,6 +400,10 @@ hit and \fBbackward\fP to search for the previous hit. .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. @@ -405,29 +429,44 @@ Show or hide statusbar. 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. -.UNINDENT -.SS Pass arguments +.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 0.0 +.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 0.0 +.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 @@ -440,6 +479,8 @@ expand .IP \(bu 2 expand\-all .IP \(bu 2 +forward +.IP \(bu 2 full\-down .IP \(bu 2 full\-up @@ -480,6 +521,7 @@ 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 @@ -497,836 +539,872 @@ unmap [mode] <binding> .UNINDENT .UNINDENT .SH OPTIONS -.SS girara .sp -This section describes settings concerning the behaviour of libgirara and +This section describes settings concerning the behaviour of girara and zathura. The settings described here can be changed with \fBset\fP\&. -.SS n\-completion\-items -.sp -Defines the maximum number of displayed completion entries. +.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 -.SS completion\-bg -.sp +.TP +.B \fIcompletion\-bg\fP Defines the background color that is used for command line completion entries -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #232323 .UNINDENT -.SS completion\-fg -.sp +.TP +.B \fIcompletion\-fg\fP Defines the foreground color that is used for command line completion entries -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #DDDDDD .UNINDENT -.SS completion\-group\-bg -.sp +.TP +.B \fIcompletion\-group\-bg\fP Defines the background color that is used for command line completion group elements -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #000000 .UNINDENT -.SS completion\-group\-fg -.sp +.TP +.B \fIcompletion\-group\-fg\fP Defines the foreground color that is used for command line completion group elements -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #DEDEDE .UNINDENT -.SS completion\-highlight\-bg -.sp +.TP +.B \fIcompletion\-highlight\-bg\fP Defines the background color that is used for the current command line completion element -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #9FBC00 .UNINDENT -.SS completion\-highlight\-fg -.sp +.TP +.B \fIcompletion\-highlight\-fg\fP Defines the foreground color that is used for the current command line completion element -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #232323 .UNINDENT -.SS default\-fg -.sp +.TP +.B \fIdefault\-fg\fP Defines the default foreground color -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #DDDDDD .UNINDENT -.SS default\-bg -.sp +.TP +.B \fIdefault\-bg\fP Defines the default background color -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #000000 .UNINDENT -.SS exec\-command -.sp -Defines a command the should be prepanded to any command run with exec. -.INDENT 0.0 +.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 -.SS font -.sp +.TP +.B \fIfont\fP Defines the font that will be used -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: monospace normal 9 .UNINDENT -.SS guioptions -.sp +.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 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: s .UNINDENT -.SS inputbar\-bg -.sp +.TP +.B \fIinputbar\-bg\fP Defines the background color for the inputbar -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #131313 .UNINDENT -.SS inputbar\-fg -.sp +.TP +.B \fIinputbar\-fg\fP Defines the foreground color for the inputbar -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #9FBC00 .UNINDENT -.SS notification\-bg -.sp +.TP +.B \fInotification\-bg\fP Defines the background color for a notification -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #FFFFFF .UNINDENT -.SS notification\-fg -.sp +.TP +.B \fInotification\-fg\fP Defines the foreground color for a notification -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #000000 .UNINDENT -.SS notification\-error\-bg -.sp +.TP +.B \fInotification\-error\-bg\fP Defines the background color for an error notification -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #FFFFFF .UNINDENT -.SS notification\-error\-fg -.sp +.TP +.B \fInotification\-error\-fg\fP Defines the foreground color for an error notification -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #FF1212 .UNINDENT -.SS notification\-warning\-bg -.sp +.TP +.B \fInotification\-warning\-bg\fP Defines the background color for a warning notification -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #FFFFFF .UNINDENT -.SS notification\-warning\-fg -.sp +.TP +.B \fInotification\-warning\-fg\fP Defines the foreground color for a warning notification -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #FFF712 .UNINDENT -.SS tabbar\-fg -.sp -Defines the foreground color for a tab -.INDENT 0.0 -.IP \(bu 2 -Value type: String -.IP \(bu 2 -Default value: #FFFFFF -.UNINDENT -.SS tabbar\-bg -.sp -Defines the background color for a tab -.INDENT 0.0 -.IP \(bu 2 -Value type: String -.IP \(bu 2 -Default value: #000000 -.UNINDENT -.SS tabbar\-focus\-fg -.sp -Defines the foreground color for the focused tab -.INDENT 0.0 -.IP \(bu 2 -Value type: String -.IP \(bu 2 -Default value: #9FBC00 -.UNINDENT -.SS tabbar\-focus\-bg -.sp -Defines the background color for the focused tab -.INDENT 0.0 -.IP \(bu 2 -Value type: String -.IP \(bu 2 -Default value: #000000 -.UNINDENT -.SS show\-scrollbars -.sp -Defines if both the horizontal and vertical scrollbars should be shown or not. -Deprecated, use \(aqguioptions\(aq instead. -.INDENT 0.0 -.IP \(bu 2 -Value type: Boolean -.IP \(bu 2 -Default value: false -.UNINDENT -.SS show\-h\-scrollbar -.sp -Defines whether to show/hide the horizontal scrollbar. Deprecated, use -\(aqguioptions\(aq instead. -.INDENT 0.0 -.IP \(bu 2 -Value type: Boolean -.IP \(bu 2 -Default value: false -.UNINDENT -.SS show\-v\-scrollbar -.sp -Defines whether to show/hide the vertical scrollbar. Deprecated, use -\(aqguioptions\(aq instead. -.INDENT 0.0 -.IP \(bu 2 -Value type: Boolean -.IP \(bu 2 -Default value: false -.UNINDENT -.SS statusbar\-bg -.sp +.TP +.B \fIstatusbar\-bg\fP Defines the background color of the statusbar -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #000000 .UNINDENT -.SS statusbar\-fg -.sp +.TP +.B \fIstatusbar\-fg\fP Defines the foreground color of the statusbar -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #FFFFFF .UNINDENT -.SS statusbar\-h\-padding -.sp +.TP +.B \fIstatusbar\-h\-padding\fP Defines the horizontal padding of the statusbar and notificationbar -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Integer .IP \(bu 2 Default value: 8 .UNINDENT -.SS statusbar\-v\-padding -.sp +.TP +.B \fIstatusbar\-v\-padding\fP Defines the vertical padding of the statusbar and notificationbar -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Integer .IP \(bu 2 Default value: 2 .UNINDENT -.SS window\-icon -.sp +.TP +.B \fIwindow\-icon\fP Defines the path for a icon to be used as window icon. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: .UNINDENT -.SS window\-height -.sp +.TP +.B \fIwindow\-height\fP Defines the window height on startup -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Integer .IP \(bu 2 Default value: 600 .UNINDENT -.SS window\-width -.sp +.TP +.B \fIwindow\-width\fP Defines the window width on startup -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Integer .IP \(bu 2 Default value: 800 .UNINDENT +.UNINDENT .SS zathura -.sp +.INDENT 0.0 +.INDENT 3.5 This section describes settings concerning the behaviour of zathura. -.SS abort\-clear\-search -.sp -Defines if the search results should be cleared on abort. +.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 -.SS adjust\-open -.sp +.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 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: best\-fit .UNINDENT -.SS advance\-pages\-per\-row -.sp +.TP +.B \fIadvance\-pages\-per\-row\fP Defines if the number of pages per row should be honored when advancing a page. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: false .UNINDENT -.SS database -.sp +.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 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: plain .UNINDENT -.SS dbus\-service -.sp +.TP +.B \fIdbus\-service\fP En/Disables the D\-Bus service. If the services is disabled, SyncTeX forward synchronization is not available. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: true .UNINDENT -.SS filemonitor -.sp -Defines the filemonitor backend. Possible values are "glib" and "signal" (if -signal handling is supported). -.INDENT 0.0 +.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 -.SS incremental\-search -.sp +.TP +.B \fIincremental\-search\fP En/Disables incremental search (search while typing). -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: true .UNINDENT -.SS highlight\-color -.sp +.TP +.B \fIhighlight\-color\fP Defines the color that is used for highlighting parts of the document (e.g.: show search results) -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #9FBC00 .UNINDENT -.SS highlight\-active\-color -.sp +.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 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #00BC00 .UNINDENT -.SS highlight\-transparency -.sp +.TP +.B \fIhighlight\-transparency\fP Defines the opacity of a highlighted element -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Float .IP \(bu 2 Default value: 0.5 .UNINDENT -.SS page\-padding -.sp +.TP +.B \fIpage\-padding\fP The page padding defines the gap in pixels between each rendered page. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Integer .IP \(bu 2 Default value: 1 .UNINDENT -.SS page\-cache\-size -.sp +.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 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Integer .IP \(bu 2 Default value: 15 .UNINDENT -.SS page\-thumbnail\-size -.sp +.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 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Integer .IP \(bu 2 Default value: 4194304 (4M) .UNINDENT -.SS pages\-per\-row -.sp +.TP +.B \fIpages\-per\-row\fP Defines the number of pages that are rendered next to each other in a row. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Integer .IP \(bu 2 Default value: 1 .UNINDENT -.SS first\-page\-column -.sp +.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. -.INDENT 0.0 +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 -.SS recolor -.sp +.TP +.B \fIrecolor\fP En/Disables recoloring -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: false .UNINDENT -.SS recolor\-keephue -.sp +.TP +.B \fIrecolor\-keephue\fP En/Disables keeping original hue when recoloring -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: false .UNINDENT -.SS recolor\-darkcolor -.sp +.TP +.B \fIrecolor\-darkcolor\fP Defines the color value that is used to represent dark colors in recoloring mode -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #FFFFFF .UNINDENT -.SS recolor\-lightcolor -.sp +.TP +.B \fIrecolor\-lightcolor\fP Defines the color value that is used to represent light colors in recoloring mode -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #000000 .UNINDENT -.SS recolor\-reverse\-video -.sp +.TP +.B \fIrecolor\-reverse\-video\fP Defines if original image colors should be kept while recoloring. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: false .UNINDENT -.SS render\-loading -.sp +.TP +.B \fIrender\-loading\fP Defines if the "Loading..." text should be displayed if a page is rendered. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: true .UNINDENT -.SS render\-loading\-bg -.sp +.TP +.B \fIrender\-loading\-bg\fP Defines the background color that is used for the "Loading..." text. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #FFFFFF .UNINDENT -.SS render\-loading\-fg -.sp +.TP +.B \fIrender\-loading\-fg\fP Defines the foreground color that is used for the "Loading..." text. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #000000 .UNINDENT -.SS scroll\-hstep -.sp +.TP +.B \fIscroll\-hstep\fP Defines the horizontal step size of scrolling by calling the scroll command once -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Float .IP \(bu 2 Default value: \-1 .UNINDENT -.SS scroll\-step -.sp +.TP +.B \fIscroll\-step\fP Defines the step size of scrolling by calling the scroll command once -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Float .IP \(bu 2 Default value: 40 .UNINDENT -.SS scroll\-full\-overlap -.sp +.TP +.B \fIscroll\-full\-overlap\fP Defines the proportion of the current viewing area that should be visible after scrolling a full page. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Float .IP \(bu 2 Default value: 0 .UNINDENT -.SS scroll\-wrap -.sp +.TP +.B \fIscroll\-wrap\fP Defines if the last/first page should be wrapped -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: false .UNINDENT -.SS show\-directories -.sp +.TP +.B \fIshow\-directories\fP Defines if the directories should be displayed in completion. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: true .UNINDENT -.SS show\-hidden -.sp +.TP +.B \fIshow\-hidden\fP Defines if hidden files and directories should be displayed in completion. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: false .UNINDENT -.SS show\-recent -.sp +.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 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Integer .IP \(bu 2 Default value: 10 .UNINDENT -.SS scroll\-page\-aware -.sp +.TP +.B \fIscroll\-page\-aware\fP Defines if scrolling by half or full pages stops at page boundaries. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: false .UNINDENT -.SS smooth\-scroll -.sp -Defines if scrolling via touchpad should be smooth(only available with gtk >= 3.4). -.INDENT 0.0 -.IP \(bu 2 -Value type: Boolean -.IP \(bu 2 -Default value: false -.UNINDENT -.SS link\-zoom -.sp +.TP +.B \fIlink\-zoom\fP En/Disables the ability of changing zoom when following links. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: true .UNINDENT -.SS link\-hadjust -.sp +.TP +.B \fIlink\-hadjust\fP En/Disables aligning to the left internal link targets, for example from the index. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: true .UNINDENT -.SS search\-hadjust -.sp +.TP +.B \fIsearch\-hadjust\fP En/Disables horizontally centered search results. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: true .UNINDENT -.SS window\-title\-basename -.sp +.TP +.B \fIwindow\-title\-basename\fP Use basename of the file in the window title. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: false .UNINDENT -.SS window\-title\-home\-tilde -.sp +.TP +.B \fIwindow\-title\-home\-tilde\fP Display a short version of the file path, which replaces $HOME with ~, in the window title. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: false .UNINDENT -.SS window\-title\-page -.sp +.TP +.B \fIwindow\-title\-page\fP Display the page number in the window title. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: false .UNINDENT -.SS statusbar\-basename -.sp +.TP +.B \fIstatusbar\-basename\fP Use basename of the file in the statusbar. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: false .UNINDENT -.SS statusbar\-home\-tilde -.sp +.TP +.B \fIstatusbar\-page\-percent\fP +Display (current page / total pages) as a percent 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 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: false .UNINDENT -.SS zoom\-center -.sp +.TP +.B \fIzoom\-center\fP En/Disables horizontally centered zooming. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: false .UNINDENT -.SS zoom\-max -.sp +.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 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Integer .IP \(bu 2 Default value: 1000 .UNINDENT -.SS zoom\-min -.sp +.TP +.B \fIzoom\-min\fP Defines the minimum percentage that the zoom level can be. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Integer .IP \(bu 2 Default value: 10 .UNINDENT -.SS zoom\-step -.sp +.TP +.B \fIzoom\-step\fP Defines the amount of percent that is zoomed in or out on each command. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Integer .IP \(bu 2 Default value: 10 .UNINDENT -.SS selection\-clipboard -.sp +.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 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: primary .UNINDENT -.SS selection\-notification -.sp +.TP +.B \fIselection\-notification\fP Defines if a notification should be displayed after selecting text. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: true .UNINDENT -.SS synctex -.sp +.TP +.B \fIsynctex\fP En/Disables SyncTeX backward synchronization support. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: Boolean .IP \(bu 2 Default value: true .UNINDENT -.SS synctex\-editor\-command -.sp +.TP +.B \fIsynctex\-editor\-command\fP Defines the command executed for SyncTeX backward synchronization. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: .UNINDENT -.SS index\-fg -.sp +.TP +.B \fIindex\-fg\fP Defines the foreground color of the index mode. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #DDDDDD .UNINDENT -.SS index\-bg -.sp +.TP +.B \fIindex\-bg\fP Define the background color of the index mode. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #232323 .UNINDENT -.SS index\-active\-fg -.sp +.TP +.B \fIindex\-active\-fg\fP Defines the foreground color of the selected element in index mode. -.INDENT 0.0 +.INDENT 7.0 .IP \(bu 2 Value type: String .IP \(bu 2 Default value: #232323 .UNINDENT -.SS index\-active\-bg -.sp +.TP +.B \fIindex\-active\-bg\fP Define the background color of the selected element in index mode. -.INDENT 0.0 +.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 +The strict sandbox mode is still experimental with some libc implementations. +Currently supported and tested libc implementations: glibc +.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-2015, pwmt.org +2009-2018, pwmt.org .\" Generated by docutils manpage writer. . |