1 .\" Man page generated from reStructuredText.
3 .TH "ZATHURARC" "5" "2019-09-08" "0.4.4" "zathura"
5 zathurarc \- zathura configuration file
7 .nr rst2man-indent-level 0
11 level \\n[rst2man-indent-level]
12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
19 .\" .rstReportMargin pre:
21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
22 . nr rst2man-indent-level +1
23 .\" .rstReportMargin post:
27 .\" indent \\n[an-margin]
28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .nr rst2man-indent-level -1
30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
35 /etc/zathurarc, $XDG_CONFIG_HOME/zathura/zathurarc
38 The \fIzathurarc\fP file is a simple plain text file that can be populated with
39 various commands to change the behaviour and the look of zathura which we are
40 going to describe in the following subsections. Each line (besides empty lines
41 and comments (which start with a prepended #) is evaluated on its own, so it
42 is not possible to write multiple commands in one single line.
44 .SS set \- Changing options
46 In addition to the built\-in \fB:set\fP command zathura offers more options to be
47 changed and makes those changes permanent. To overwrite an option you just have
48 to add a line structured like the following
54 set <option> <new value>
60 The \fBoption\fP field has to be replaced with the name of the option that should be
61 changed and the \fBnew value\fP field has to be replaced with the new value the
62 option should get. The type of the value can be one of the following:
65 INT \- An integer number
67 FLOAT \- A floating point number
69 STRING \- A character string
71 BOOL \- A boolean value ("true" for true, "false" for false)
74 In addition we advice you to check the options to get a more detailed view of
75 the options that can be changed and which values they should be set to.
77 The following example should give some deeper insight of how the \fBset\fP command
87 set option4 hello\e world
88 set option5 "hello world"
94 If you want to use \fBcolor codes\fP for some options, make sure to quote them
95 accordingly or to escape the hash symbol.
101 set default\-fg "#CCBBCC"
102 set default\-fg \e#CCBBCC
107 .SS include \- Including another config file
109 This commands allows one to include other configuration files. If a relative
110 path is given, the path will be resolved relative to the configuration file that
111 is currently processed.
117 include another\-config
122 .SS map \- Mapping a shortcut
124 It is possible to map or remap new key bindings to shortcut functions which
125 allows a high level of customization. The \fB:map\fP command can also be used in
126 the \fIzathurarc\fP file to make those changes permanent:
132 map [mode] <binding> <shortcut function> <argument>
139 The \fBmap\fP command expects several arguments where only the \fBbinding\fP as well as
140 the \fBshortcut\-function\fP argument is required. Since zathura uses several modes
141 it is possible to map bindings only for a specific mode by passing the \fBmode\fP
142 argument which can take one of the following values:
154 The brackets around the value are mandatory.
155 .SS Single key binding
157 The (possible) second argument defines the used key binding that should be
158 mapped to the shortcut function and is structured like the following. On the one
159 hand it is possible to just assign single letters, numbers or signs to it:
165 map a shortcut_function optional_argument
166 map b shortcut_function optional_argument
167 map c shortcut_function optional_argument
168 map 1 shortcut_function optional_argument
169 map 2 shortcut_function optional_argument
170 map 3 shortcut_function optional_argument
171 map ! shortcut_function optional_argument
172 map ? shortcut_function optional_argument
179 It is also possible to use modifiers like the Control or Alt button on the
180 keyboard. It is possible to use the following modifiers:
190 If any of the modifiers should be used for a binding, it is required to define
191 the \fBbinding\fP with the following structure:
197 map <A\-a> shortcut_function
198 map <C\-a> shortcut_function
205 zathura allows it also to assign keys like the space bar or the tab button which
206 also have to be written in between angle brackets. The following special keys
207 are currently available:
213 Identifier Description
246 Of course it is possible to combine those special keys with a modifier. The
247 usage of those keys should be explained by the following examples:
253 map <Space> shortcut_function
254 map <C\-Space> shortcut_function
261 It is also possible to map mouse buttons to shortcuts by using the following
268 Identifier Description
270 Button1 Mouse button 1
271 Button2 Mouse button 2
272 Button3 Mouse button 3
273 Button4 Mouse button 4
274 Button5 Mouse button 5
280 They can also be combined with modifiers:
286 map <Button1> shortcut_function
287 map <C\-Button1> shortcut_function
294 If a mapping does not match one of the previous definition but is still a valid
295 mapping it will be mapped as a buffer command:
307 .SS Shortcut functions
309 The following shortcut functions can be mapped:
314 Switch back to normal mode.
318 Adjust page width. Possible arguments are \fBbest\-fit\fP and \fBwidth\fP\&.
322 Change current mode. Pass the desired mode as argument.
330 Execute an external command.
342 Go to a certain page.
346 Move forwards/backwards in the jumplist. Pass \fBforward\fP as argument to
347 move to the next entry and \fBbackward\fP to move to the previous one.
351 Navigate to the next/previous page.
355 Navigate through the index.
359 Show the print dialog.
375 Rotate the page. Pass \fBrotate\-ccw\fP as argument for counterclockwise rotation
376 and \fBrotate\-cw\fP for clockwise rotation.
384 Search next/previous item. Pass \fBforward\fP as argument to search for the next
385 hit and \fBbackward\fP to search for the previous hit.
391 \fBtoggle_fullscreen\fP
399 \fBtoggle_inputbar\fP
401 Show or hide inputbar.
403 \fBtoggle_page_mode\fP
405 Toggle between one and multiple pages per row.
407 \fBtoggle_statusbar\fP
409 Show or hide statusbar.
425 Simulate key presses. Note that all keys will be interpreted as if pressing a
426 key on the keyboard. To input uppercase letters, follow the same convention as
427 for key bindings, i.e. for \fBX\fP, use \fB<S\-X>\fP\&.
431 Some shortcut function require or have optional arguments which influence the
432 behaviour of them. Those can be passed as the last argument:
445 Possible arguments are:
508 .SS unmap \- Removing a shortcut
510 In addition to mapping or remaping custom key bindings it is possible to remove
511 existing ones by using the \fB:unmap\fP command. The command is used in the
512 following way (the explanation of the parameters is described in the \fBmap\fP
513 section of this document
519 unmap [mode] <binding>
527 This section describes settings concerning the behaviour of girara and
528 zathura. The settings described here can be changed with \fBset\fP\&.
529 .SS n\-completion\-items
531 Defines the maximum number of displayed completion entries.
540 Defines the background color that is used for command line completion
546 Default value: #232323
550 Defines the foreground color that is used for command line completion
556 Default value: #DDDDDD
558 .SS completion\-group\-bg
560 Defines the background color that is used for command line completion
566 Default value: #000000
568 .SS completion\-group\-fg
570 Defines the foreground color that is used for command line completion
576 Default value: #DEDEDE
578 .SS completion\-highlight\-bg
580 Defines the background color that is used for the current command line
586 Default value: #9FBC00
588 .SS completion\-highlight\-fg
590 Defines the foreground color that is used for the current command line
596 Default value: #232323
600 Defines the default foreground color
605 Default value: #DDDDDD
609 Defines the default background color
614 Default value: #000000
618 Defines a command the should be prepended to any command run with exec.
627 Defines the font that will be used
632 Default value: monospace normal 9
636 Shows or hides GUI elements.
637 If it contains \(aqc\(aq, the command line is displayed.
638 If it contains \(aqs\(aq, the statusbar is displayed.
639 If it contains \(aqh\(aq, the horizontal scrollbar is displayed.
640 If it contains \(aqv\(aq, the vertical scrollbar is displayed.
649 Defines the background color for the inputbar
654 Default value: #131313
658 Defines the foreground color for the inputbar
663 Default value: #9FBC00
667 Defines the background color for a notification
672 Default value: #FFFFFF
676 Defines the foreground color for a notification
681 Default value: #000000
683 .SS notification\-error\-bg
685 Defines the background color for an error notification
690 Default value: #FFFFFF
692 .SS notification\-error\-fg
694 Defines the foreground color for an error notification
699 Default value: #FF1212
701 .SS notification\-warning\-bg
703 Defines the background color for a warning notification
708 Default value: #FFFFFF
710 .SS notification\-warning\-fg
712 Defines the foreground color for a warning notification
717 Default value: #FFF712
721 Defines the foreground color for a tab
726 Default value: #FFFFFF
730 Defines the background color for a tab
735 Default value: #000000
737 .SS tabbar\-focus\-fg
739 Defines the foreground color for the focused tab
744 Default value: #9FBC00
746 .SS tabbar\-focus\-bg
748 Defines the background color for the focused tab
753 Default value: #000000
757 Defines if both the horizontal and vertical scrollbars should be shown or not.
758 Deprecated, use \(aqguioptions\(aq instead.
765 .SS show\-h\-scrollbar
767 Defines whether to show/hide the horizontal scrollbar. Deprecated, use
768 \(aqguioptions\(aq instead.
775 .SS show\-v\-scrollbar
777 Defines whether to show/hide the vertical scrollbar. Deprecated, use
778 \(aqguioptions\(aq instead.
787 Defines the background color of the statusbar
792 Default value: #000000
796 Defines the foreground color of the statusbar
801 Default value: #FFFFFF
803 .SS statusbar\-h\-padding
805 Defines the horizontal padding of the statusbar and notificationbar
812 .SS statusbar\-v\-padding
814 Defines the vertical padding of the statusbar and notificationbar
823 Defines the path for a icon to be used as window icon.
832 Defines the window height on startup
841 Defines the window width on startup
850 This section describes settings concerning the behaviour of zathura.
851 .SS abort\-clear\-search
853 Defines if the search results should be cleared on abort.
862 Defines which auto adjustment mode should be used if a document is loaded.
863 Possible options are "best\-fit" and "width".
868 Default value: best\-fit
870 .SS advance\-pages\-per\-row
872 Defines if the number of pages per row should be honored when advancing a page.
879 .SS continuous\-hist\-save
881 Tells zathura whether to save document history at each page change or only when
891 Defines the database backend to use for bookmarks and input history. Possible
892 values are "plain", "sqlite" (if built with sqlite support) and "null". If
893 "null" is used, bookmarks and input history will not be stored.
902 En/Disables the D\-Bus service. If the services is disabled, SyncTeX forward
903 synchronization is not available.
912 Defines the file monitor backend used to check for changes in files. Possible
913 values are "glib", "signal" (if signal handling is supported), and "noop". The
914 "noop" file monitor does not trigger reloads.
921 .SS incremental\-search
923 En/Disables incremental search (search while typing).
932 Defines the color that is used for highlighting parts of the document (e.g.:
938 Default value: #9FBC00
940 .SS highlight\-active\-color
942 Defines the color that is used to show the current selected highlighted element
943 (e.g: current search result)
948 Default value: #00BC00
950 .SS highlight\-transparency
952 Defines the opacity of a highlighted element
961 The page padding defines the gap in pixels between each rendered page.
968 .SS page\-cache\-size
970 Defines the maximum number of pages that could be kept in the page cache. When
971 the cache is full and a new page that isn\(aqt cached becomes visible, the least
972 recently viewed page in the cache will be evicted to make room for the new one.
973 Large values for this variable are NOT recommended, because this will lead to
974 consuming a significant portion of the system memory.
981 .SS page\-thumbnail\-size
983 Defines the maximum size in pixels of the thumbnail that could be kept in the
984 thumbnail cache per page. The thumbnail is scaled for a quick preview during
985 zooming before the page is rendered. When the page is rendered, the result is
986 saved as the thumbnail only if the size is no more than this value. A larger
987 value increases quality but introduces longer delay in zooming and uses more
993 Default value: 4194304 (4M)
997 Defines the number of pages that are rendered next to each other in a row.
1004 .SS first\-page\-column
1006 Defines the column in which the first page will be displayed.
1007 This setting is stored separately for every value of pages\-per\-row according to
1008 the following pattern <1 page per row>:[<2 pages per row>[: ...]]. The last
1009 value in the list will be used for all other number of pages per row if not set
1012 Per default, the first column is set to 2 for double\-page layout, i.e. the faule
1013 is set to 1:2. A value of 1:1:3 would put the first page in dual\-page layour in
1014 the first column, and for layouts with more columns the first page would be put
1024 En/Disables recoloring
1029 Default value: false
1031 .SS recolor\-keephue
1033 En/Disables keeping original hue when recoloring
1038 Default value: false
1040 .SS recolor\-darkcolor
1042 Defines the color value that is used to represent dark colors in recoloring mode
1047 Default value: #FFFFFF
1049 .SS recolor\-lightcolor
1051 Defines the color value that is used to represent light colors in recoloring mode
1056 Default value: #000000
1058 .SS recolor\-reverse\-video
1060 Defines if original image colors should be kept while recoloring.
1065 Default value: false
1069 Defines if the "Loading..." text should be displayed if a page is rendered.
1076 .SS render\-loading\-bg
1078 Defines the background color that is used for the "Loading..." text.
1083 Default value: #FFFFFF
1085 .SS render\-loading\-fg
1087 Defines the foreground color that is used for the "Loading..." text.
1092 Default value: #000000
1096 Defines the horizontal step size of scrolling by calling the scroll command once
1105 Defines the step size of scrolling by calling the scroll command once
1112 .SS scroll\-full\-overlap
1114 Defines the proportion of the current viewing area that should be
1115 visible after scrolling a full page.
1124 Defines if the last/first page should be wrapped
1129 Default value: false
1131 .SS show\-directories
1133 Defines if the directories should be displayed in completion.
1142 Defines if hidden files and directories should be displayed in completion.
1147 Default value: false
1151 Defines the number of recent files that should be displayed in completion.
1152 If the value is negative, no upper bounds are applied. If the value is 0, no
1153 recent files are shown.
1160 .SS scroll\-page\-aware
1162 Defines if scrolling by half or full pages stops at page boundaries.
1167 Default value: false
1171 En/Disables the ability of changing zoom when following links.
1180 En/Disables aligning to the left internal link targets, for example from the
1190 En/Disables horizontally centered search results.
1197 .SS window\-title\-basename
1199 Use basename of the file in the window title.
1204 Default value: false
1206 .SS window\-title\-home\-tilde
1208 Display a short version of the file path, which replaces $HOME with ~, in the window title.
1213 Default value: false
1215 .SS window\-title\-page
1217 Display the page number in the window title.
1222 Default value: false
1224 .SS statusbar\-basename
1226 Use basename of the file in the statusbar.
1231 Default value: false
1233 .SS statusbar\-home\-tilde
1235 Display a short version of the file path, which replaces $HOME with ~, in the statusbar.
1240 Default value: false
1244 En/Disables horizontally centered zooming.
1249 Default value: false
1251 .SS vertical\-center
1253 Center the screen at the vertical midpoint of the page by default.
1258 Default value: false
1262 Defines the maximum percentage that the zoom level can be.
1271 Defines the minimum percentage that the zoom level can be.
1280 Defines the amount of percent that is zoomed in or out on each command.
1287 .SS selection\-clipboard
1289 Defines the X clipboard into which mouse\-selected data will be written. When it
1290 is "clipboard", selected data will be written to the CLIPBOARD clipboard, and
1291 can be pasted using the Ctrl+v key combination. When it is "primary", selected
1292 data will be written to the PRIMARY clipboard, and can be pasted using the
1293 middle mouse button, or the Shift\-Insert key combination.
1298 Default value: primary
1300 .SS selection\-notification
1302 Defines if a notification should be displayed after selecting text.
1311 En/Disables SyncTeX backward synchronization support.
1318 .SS synctex\-editor\-command
1320 Defines the command executed for SyncTeX backward synchronization.
1329 Defines the foreground color of the index mode.
1334 Default value: #DDDDDD
1338 Define the background color of the index mode.
1343 Default value: #232323
1345 .SS index\-active\-fg
1347 Defines the foreground color of the selected element in index mode.
1352 Default value: #232323
1354 .SS index\-active\-bg
1356 Define the background color of the selected element in index mode.
1361 Default value: #9FBC00
1365 Defines the sandbox mode to use for the seccomp syscall filter. Possible
1366 values are "none", "normal" and "strict". If "none" is used, the sandbox
1367 will be disabled. The use of "normal" will provide minimal protection and
1368 allow normal use of zathura with support for all features. The "strict" mode
1369 is a read only sandbox that is intended for viewing documents only.
1374 Default value: normal
1377 Some features are disabled when using strict sandbox mode:
1380 saving/writing files
1382 use of input methods like ibus
1386 bookmarks and history
1389 No feature regressions are expected when using normal sandbox mode.
1391 When running under WSL, the default is "none" since seccomp is not supported in
1393 .SS window\-icon\-document
1395 Defines whether the window document should be updated based on the first page of
1401 Default value: false
1403 .SS page\-right\-to\-left
1405 Defines whether pages in multi\-column view should start from the right side.
1410 Default value: false
1419 .\" Generated by docutils manpage writer.