1ZATHURARC(5) zathura ZATHURARC(5)
2
6 zathurarc - zathura configuration file
7
9 /etc/zathurarc, $XDG_CONFIG_HOME/zathura/zathurarc
10
12 The zathurarc file is a simple plain text file that can be populated
13 with various commands to change the behaviour and the look of zathura
14 which we are going to describe in the following subsections. Each line
15 (besides empty lines and comments (which start with a prepended #) is
16 evaluated on its own, so it is not possible to write multiple commands
17 in one single line.
18
20 set - Changing options
21 In addition to the built-in :set command zathura offers more options to
22 be changed and makes those changes permanent. To overwrite an option
23 you just have to add a line structured like the following
24 set <option> <new value>
26 The option field has to be replaced with the name of the option that
28 should be changed and the new value field has to be replaced with the
29 new value the option should get. The type of the value can be one of
30 the following:
31 • INT - An integer number
33 • FLOAT - A floating point number
35 • STRING - A character string
37 • BOOL - A boolean value ("true" for true, "false" for false)
39 In addition we advice you to check the options to get a more detailed
41 view of the options that can be changed and which values they should be
42 set to.
43 The following example should give some deeper insight of how the set
45 command can be used
46 set option1 5
48 set option2 2.0
49 set option3 hello
50 set option4 hello\ world
51 set option5 "hello world"
52 Especially for options with strings as values, note that escaping of
54 special characters and white spaces is necessary. In the above example,
55 option4 and option5 are both set to hello world, but set option6 hello
56 world would set option6 only to hello.
57 For colors, zathura supports HTML color codes and CSS3-style rgb(r,g,b)
59 and rgba(r,g,b,a) values. If you want to use color codes for some op‐
60 tions, make sure to quote them accordingly or to escape the hash sym‐
61 bol.
62 set default-fg "#CCBBCC"
64 set default-fg \#CCBBCC
65 For rgba, note that it parses the color components as integers between
67 0 and 255 and the alpha component as float between 0 and 1.
68 include - Including another config file
70 This commands allows one to include other configuration files. If a
71 relative path is given, the path will be resolved relative to the con‐
72 figuration file that is currently processed.
73 include another-config
75 map - Mapping a shortcut
77 It is possible to map or remap new key bindings to shortcut functions
78 which allows a high level of customization. The :map command can also
79 be used in the zathurarc file to make those changes permanent:
80 map [mode] <binding> <shortcut function> <argument>
82 Mode The map command expects several arguments where only the binding
84 as well as the shortcut-function argument is required. Since za‐
85 thura uses several modes it is possible to map bindings only for
86 a specific mode by passing the mode argument which can take one
87 of the following values:
88 • normal (default)
90 • fullscreen
92 • presentation
94 • index
96 The brackets around the value are mandatory.
98 Single key binding
100 The (possible) second argument defines the used key binding that
101 should be mapped to the shortcut function and is structured like
102 the following. On the one hand it is possible to just assign
103 single letters, numbers or signs to it:
104 map a shortcut_function optional_argument
106 map b shortcut_function optional_argument
107 map c shortcut_function optional_argument
108 map 1 shortcut_function optional_argument
109 map 2 shortcut_function optional_argument
110 map 3 shortcut_function optional_argument
111 map ! shortcut_function optional_argument
112 map ? shortcut_function optional_argument
113 Using modifiers
115 It is also possible to use modifiers like the Control or Alt
116 button on the keyboard. It is possible to use the following mod‐
117 ifiers:
118 • A - Alt
120 • C - Control
122 • S - Shift
124 If any of the modifiers should be used for a binding, it is re‐
126 quired to define the binding with the following structure:
127 map <A-a> shortcut_function
129 map <C-a> shortcut_function
130 Special keys
132 zathura allows it also to assign keys like the space bar or the
133 tab button which also have to be written in between angle brack‐
134 ets. The following special keys are currently available:
135 Identifier Description
137 BackSpace Back space
139 CapsLock Caps lock
140 Esc Escape
141 Down Arrow down
142 Up Arrow up
143 Left Arrow left
144 Right Arrow right
145 F1 F1
146 F2 F2
147 F3 F3
148 F4 F4
149 F5 F5
150 F6 F6
151 F7 F7
152 F8 F8
153 F9 F9
154 F10 F10
155 F11 F11
156 F12 F12
157 PageDown Page Down
158 PageUp Page Up
159 Return Return
160 Space Space
161 Super Windows key
162 Tab Tab
163 Print Print key
164 Of course it is possible to combine those special keys with a
166 modifier. The usage of those keys should be explained by the
167 following examples:
168 map <Space> shortcut_function
170 map <C-Space> shortcut_function
171 Mouse buttons
173 It is also possible to map mouse buttons to shortcuts by using
174 the following special keys:
175 Identifier Description
177 Button1 Mouse button 1
179 Button2 Mouse button 2
180 Button3 Mouse button 3
181 Button4 Mouse button 4
182 Button5 Mouse button 5
183 They can also be combined with modifiers:
185 map <Button1> shortcut_function
187 map <C-Button1> shortcut_function
188 Buffer commands
190 If a mapping does not match one of the previous definition but
191 is still a valid mapping it will be mapped as a buffer command:
192 map abc quit
194 map test quit
195 Shortcut functions
197 The following shortcut functions can be mapped:
198 • abort
200 Switch back to normal mode.
202 • adjust_window
204 Adjust page width. Possible arguments are best-fit and width.
206 • change_mode
208 Change current mode. Pass the desired mode as argument.
210 • display_link:
212 Display link target.
214 • exec:
216 Execute an external command.
218 • focus_inputbar
220 Focus inputbar.
222 • follow
224 Follow a link.
226 • goto
228 Go to a certain page.
230 • jumplist
232 Move forwards/backwards in the jumplist. Pass forward as argu‐
234 ment to move to the next entry and backward to move to the
235 previous one.
236 • navigate
238 Navigate to the next/previous page.
240 • navigate_index
242 Navigate through the index.
244 • print
246 Show the print dialog.
248 • quit
250 Quit zathura.
252 • recolor
254 Recolor pages.
256 • reload
258 Reload the document.
260 • rotate
262 Rotate the page. Pass rotate-ccw as argument for counterclock‐
264 wise rotation and rotate-cw for clockwise rotation.
265 • scroll
267 Scroll.
269 • search
271 Search next/previous item. Pass forward as argument to search
273 for the next hit and backward to search for the previous hit.
274 • set
276 Set an option.
278 • snap_to_page
280 Snaps to the current page. Equivalent to goto <current_page>
282 • toggle_fullscreen
284 Toggle fullscreen.
286 • toggle_index
288 Show or hide index.
290 • toggle_inputbar
292 Show or hide inputbar.
294 • toggle_page_mode
296 Toggle between one and multiple pages per row.
298 • toggle_statusbar
300 Show or hide statusbar.
302 • zoom
304 Zoom in or out.
306 • mark_add
308 Set a quickmark.
310 • mark_evaluate
312 Go to a quickmark.
314 • feedkeys
316 Simulate key presses. Note that all keys will be interpreted
318 as if pressing a key on the keyboard. To input uppercase let‐
319 ters, follow the same convention as for key bindings, i.e. for
320 X, use <S-X>.
321 Pass arguments
323 Some shortcut function require or have optional arguments which
324 influence the behaviour of them. Those can be passed as the last
325 argument:
326 map <C-i> zoom in
328 map <C-o> zoom out
329 Possible arguments are:
331 • best-fit
333 • bottom
335 • backward
337 • collapse
339 • collapse-all
341 • default
343 • down
345 • expand
347 • expand-all
349 • forward
351 • full-down
353 • full-up
355 • half-down
357 • half-up
359 • in
361 • left
363 • next
365 • out
367 • page-bottom
369 • page-top
371 • previous
373 • right
375 • rotate-ccw
377 • rotate-cw
379 • select
381 • specific
383 • toggle
385 • top
387 • up
389 • width
391 unmap - Removing a shortcut
393 In addition to mapping or remaping custom key bindings it is possible
394 to remove existing ones by using the :unmap command. The command is
395 used in the following way (the explanation of the parameters is de‐
396 scribed in the map section of this document
397 unmap [mode] <binding>
399
401 This section describes settings concerning the behaviour of girara and
402 zathura. The settings described here can be changed with set.
403 girara
405 n-completion-items
406 Defines the maximum number of displayed completion entries.
407 • Value type: Integer
409 • Default value: 15
411 completion-bg
413 Defines the background color that is used for command line com‐
414 pletion entries
415 • Value type: String
417 • Default value: #232323
419 completion-fg
421 Defines the foreground color that is used for command line com‐
422 pletion entries
423 • Value type: String
425 • Default value: #DDDDDD
427 completion-group-bg
429 Defines the background color that is used for command line com‐
430 pletion group elements
431 • Value type: String
433 • Default value: #000000
435 completion-group-fg
437 Defines the foreground color that is used for command line com‐
438 pletion group elements
439 • Value type: String
441 • Default value: #DEDEDE
443 completion-highlight-bg
445 Defines the background color that is used for the current com‐
446 mand line completion element
447 • Value type: String
449 • Default value: #9FBC00
451 completion-highlight-fg
453 Defines the foreground color that is used for the current com‐
454 mand line completion element
455 • Value type: String
457 • Default value: #232323
459 default-fg
461 Defines the default foreground color
462 • Value type: String
464 • Default value: #DDDDDD
466 default-bg
468 Defines the default background color
469 • Value type: String
471 • Default value: #000000
473 exec-command
475 Defines a command the should be prepended to any command run
476 with exec.
477 • Value type: String
479 • Default value:
481 font Defines the font that will be used
483 • Value type: String
485 • Default value: monospace normal 9
487 guioptions
489 Shows or hides GUI elements. If it contains 'c', the command
490 line is displayed. If it contains 's', the statusbar is dis‐
491 played. If it contains 'h', the horizontal scrollbar is dis‐
492 played. If it contains 'v', the vertical scrollbar is dis‐
493 played.
494 • Value type: String
496 • Default value: s
498 inputbar-bg
500 Defines the background color for the inputbar
501 • Value type: String
503 • Default value: #131313
505 inputbar-fg
507 Defines the foreground color for the inputbar
508 • Value type: String
510 • Default value: #9FBC00
512 notification-bg
514 Defines the background color for a notification
515 • Value type: String
517 • Default value: #FFFFFF
519 notification-fg
521 Defines the foreground color for a notification
522 • Value type: String
524 • Default value: #000000
526 notification-error-bg
528 Defines the background color for an error notification
529 • Value type: String
531 • Default value: #FFFFFF
533 notification-error-fg
535 Defines the foreground color for an error notification
536 • Value type: String
538 • Default value: #FF1212
540 notification-warning-bg
542 Defines the background color for a warning notification
543 • Value type: String
545 • Default value: #FFFFFF
547 notification-warning-fg
549 Defines the foreground color for a warning notification
550 • Value type: String
552 • Default value: #FFF712
554 statusbar-bg
556 Defines the background color of the statusbar
557 • Value type: String
559 • Default value: #000000
561 statusbar-fg
563 Defines the foreground color of the statusbar
564 • Value type: String
566 • Default value: #FFFFFF
568 statusbar-h-padding
570 Defines the horizontal padding of the statusbar and notifica‐
571 tionbar
572 • Value type: Integer
574 • Default value: 8
576 statusbar-v-padding
578 Defines the vertical padding of the statusbar and notification‐
579 bar
580 • Value type: Integer
582 • Default value: 2
584 window-icon
586 Defines the path for a icon to be used as window icon.
587 • Value type: String
589 • Default value:
591 window-height
593 Defines the window height on startup
594 • Value type: Integer
596 • Default value: 600
598 window-width
600 Defines the window width on startup
601 • Value type: Integer
603 • Default value: 800
605 zathura
607 This section describes settings concerning the behaviour of zathura.
608 abort-clear-search
610 Defines if the search results should be cleared on abort.
611 • Value type: Boolean
613 • Default value: true
615 adjust-open
617 Defines which auto adjustment mode should be used if a document
618 is loaded. Possible options are "best-fit" and "width".
619 • Value type: String
621 • Default value: best-fit
623 advance-pages-per-row
625 Defines if the number of pages per row should be honored when
626 advancing a page.
627 • Value type: Boolean
629 • Default value: false
631 continuous-hist-save
633 Tells zathura whether to save document history at each page
634 change or only when closing a document.
635 • Value type: Boolean
637 • Default value: false
639 database
641 Defines the database backend to use for bookmarks and input his‐
642 tory. Possible values are "plain", "sqlite" (if built with
643 sqlite support) and "null". If "null" is used, bookmarks and in‐
644 put history will not be stored.
645 • Value type: String
647 • Default value: plain
649 dbus-service
651 En/Disables the D-Bus service. If the services is disabled,
652 SyncTeX forward synchronization is not available.
653 • Value type: Boolean
655 • Default value: true
657 dbus-raise-window
659 Defines whether zathura's window should be raised when receiving
660 certain commands via D-Bus.
661 • Value type: Boolean
663 • Default value: true
665 filemonitor
667 Defines the file monitor backend used to check for changes in
668 files. Possible values are "glib", "signal" (if signal handling
669 is supported), and "noop". The "noop" file monitor does not
670 trigger reloads.
671 • Value type: String
673 • Default value: glib
675 incremental-search
677 En/Disables incremental search (search while typing).
678 • Value type: Boolean
680 • Default value: true
682 highlight-color
684 Defines the color that is used for highlighting parts of the
685 document (e.g.: show search results)
686 • Value type: String
688 • Default value: #9FBC00
690 highlight-fg
692 Defines the color that is used for text when highlighting parts
693 of the document (e.g.: number for links).
694 • Value type: String
696 • Default value: #9FBC00
698 highlight-active-color
700 Defines the color that is used to show the current selected
701 highlighted element (e.g: current search result)
702 • Value type: String
704 • Default value: #00BC00
706 highlight-transparency
708 Defines the opacity of a highlighted element
709 • Value type: Float
711 • Default value: 0.5
713 page-padding
715 The page padding defines the gap in pixels between each rendered
716 page.
717 • Value type: Integer
719 • Default value: 1
721 page-cache-size
723 Defines the maximum number of pages that could be kept in the
724 page cache. When the cache is full and a new page that isn't
725 cached becomes visible, the least recently viewed page in the
726 cache will be evicted to make room for the new one. Large val‐
727 ues for this variable are NOT recommended, because this will
728 lead to consuming a significant portion of the system memory.
729 • Value type: Integer
731 • Default value: 15
733 page-thumbnail-size
735 Defines the maximum size in pixels of the thumbnail that could
736 be kept in the thumbnail cache per page. The thumbnail is scaled
737 for a quick preview during zooming before the page is rendered.
738 When the page is rendered, the result is saved as the thumbnail
739 only if the size is no more than this value. A larger value in‐
740 creases quality but introduces longer delay in zooming and uses
741 more system memory.
742 • Value type: Integer
744 • Default value: 4194304 (4M)
746 pages-per-row
748 Defines the number of pages that are rendered next to each other
749 in a row.
750 • Value type: Integer
752 • Default value: 1
754 first-page-column
756 Defines the column in which the first page will be displayed.
757 This setting is stored separately for every value of
758 pages-per-row according to the following pattern <1 page per
759 row>:[<2 pages per row>[: ...]]. The last value in the list will
760 be used for all other number of pages per row if not set explic‐
761 itly.
762 Per default, the first column is set to 2 for double-page lay‐
764 out, i.e. the value is set to 1:2. A value of 1:1:3 would put
765 the first page in dual-page layout in the first column, and for
766 layouts with more columns the first page would be put in the 3rd
767 column.
768 • Value type: String
770 • Default value: 1:2
772 recolor
774 En/Disables recoloring
775 • Value type: Boolean
777 • Default value: false
779 recolor-keephue
781 En/Disables keeping original hue when recoloring
782 • Value type: Boolean
784 • Default value: false
786 recolor-darkcolor
788 Defines the color value that is used to represent dark colors in
789 recoloring mode
790 • Value type: String
792 • Default value: #FFFFFF
794 recolor-lightcolor
796 Defines the color value that is used to represent light colors
797 in recoloring mode
798 • Value type: String
800 • Default value: #000000
802 recolor-reverse-video
804 Defines if original image colors should be kept while recolor‐
805 ing.
806 • Value type: Boolean
808 • Default value: false
810 render-loading
812 Defines if the "Loading..." text should be displayed if a page
813 is rendered.
814 • Value type: Boolean
816 • Default value: true
818 render-loading-bg
820 Defines the background color that is used for the "Loading..."
821 text.
822 • Value type: String
824 • Default value: #FFFFFF
826 render-loading-fg
828 Defines the foreground color that is used for the "Loading..."
829 text.
830 • Value type: String
832 • Default value: #000000
834 scroll-hstep
836 Defines the horizontal step size of scrolling by calling the
837 scroll command once
838 • Value type: Float
840 • Default value: -1
842 scroll-step
844 Defines the step size of scrolling by calling the scroll command
845 once
846 • Value type: Float
848 • Default value: 40
850 scroll-full-overlap
852 Defines the proportion of the current viewing area that should
853 be visible after scrolling a full page.
854 • Value type: Float
856 • Default value: 0
858 scroll-wrap
860 Defines if the last/first page should be wrapped
861 • Value type: Boolean
863 • Default value: false
865 show-directories
867 Defines if the directories should be displayed in completion.
868 • Value type: Boolean
870 • Default value: true
872 show-hidden
874 Defines if hidden files and directories should be displayed in
875 completion.
876 • Value type: Boolean
878 • Default value: false
880 show-recent
882 Defines the number of recent files that should be displayed in
883 completion. If the value is negative, no upper bounds are ap‐
884 plied. If the value is 0, no recent files are shown.
885 • Value type: Integer
887 • Default value: 10
889 scroll-page-aware
891 Defines if scrolling by half or full pages stops at page bound‐
892 aries.
893 • Value type: Boolean
895 • Default value: false
897 link-zoom
899 En/Disables the ability of changing zoom when following links.
900 • Value type: Boolean
902 • Default value: true
904 link-hadjust
906 En/Disables aligning to the left internal link targets, for ex‐
907 ample from the index.
908 • Value type: Boolean
910 • Default value: true
912 search-hadjust
914 En/Disables horizontally centered search results.
915 • Value type: Boolean
917 • Default value: true
919 window-title-basename
921 Use basename of the file in the window title.
922 • Value type: Boolean
924 • Default value: false
926 window-title-home-tilde
928 Display a short version of the file path, which replaces $HOME
929 with ~, in the window title.
930 • Value type: Boolean
932 • Default value: false
934 window-title-page
936 Display the page number in the window title.
937 • Value type: Boolean
939 • Default value: false
941 statusbar-basename
943 Use basename of the file in the statusbar.
944 • Value type: Boolean
946 • Default value: false
948 statusbar-home-tilde
950 Display a short version of the file path, which replaces $HOME
951 with ~, in the statusbar.
952 • Value type: Boolean
954 • Default value: false
956 zoom-center
958 En/Disables horizontally centered zooming.
959 • Value type: Boolean
961 • Default value: false
963 vertical-center
965 Center the screen at the vertical midpoint of the page by de‐
966 fault.
967 • Value type: Boolean
969 • Default value: false
971 zoom-max
973 Defines the maximum percentage that the zoom level can be.
974 • Value type: Integer
976 • Default value: 1000
978 zoom-min
980 Defines the minimum percentage that the zoom level can be.
981 • Value type: Integer
983 • Default value: 10
985 zoom-step
987 Defines the amount of percent that is zoomed in or out on each
988 command.
989 • Value type: Integer
991 • Default value: 10
993 selection-clipboard
995 Defines the X clipboard into which mouse-selected data will be
996 written. When it is "clipboard", selected data will be written
997 to the CLIPBOARD clipboard, and can be pasted using the Ctrl+v
998 key combination. When it is "primary", selected data will be
999 written to the PRIMARY clipboard, and can be pasted using the
1000 middle mouse button, or the Shift-Insert key combination.
1001 • Value type: String
1003 • Default value: primary
1005 selection-notification
1007 Defines if a notification should be displayed after selecting
1008 text.
1009 • Value type: Boolean
1011 • Default value: true
1013 synctex
1015 En/Disables SyncTeX backward synchronization support.
1016 • Value type: Boolean
1018 • Default value: true
1020 synctex-editor-command
1022 Defines the command executed for SyncTeX backward synchroniza‐
1023 tion.
1024 • Value type: String
1026 • Default value:
1028 index-fg
1030 Defines the foreground color of the index mode.
1031 • Value type: String
1033 • Default value: #DDDDDD
1035 index-bg
1037 Define the background color of the index mode.
1038 • Value type: String
1040 • Default value: #232323
1042 index-active-fg
1044 Defines the foreground color of the selected element in index
1045 mode.
1046 • Value type: String
1048 • Default value: #232323
1050 index-active-bg
1052 Define the background color of the selected element in index
1053 mode.
1054 • Value type: String
1056 • Default value: #9FBC00
1058 sandbox
1060 Defines the sandbox mode to use for the seccomp syscall filter.
1061 Possible values are "none", "normal" and "strict". If "none" is
1062 used, the sandbox will be disabled. The use of "normal" will
1063 provide minimal protection and allow normal use of zathura with
1064 support for all features. The "strict" mode is a read only sand‐
1065 box that is intended for viewing documents only.
1066 • Value type: String
1068 • Default value: normal
1070 Some features are disabled when using strict sandbox mode:
1072 • saving/writing files
1074 • use of input methods like ibus
1076 • printing
1078 • bookmarks and history
1080 No feature regressions are expected when using normal sandbox
1082 mode.
1083 When running under WSL, the default is "none" since seccomp is
1085 not supported in that environment.
1086 window-icon-document
1088 Defines whether the window document should be updated based on
1089 the first page of a dcument.
1090 • Value type: Boolean
1092 • Default value: false
1094 page-right-to-left
1096 Defines whether pages in multi-column view should start from the
1097 right side.
1098 • Value type: Boolean
1100 • Default value: false
1102
1104 zathura(1)
1105
1107 pwmt.org
1108
1110 2009-2022, pwmt.org
11110.4.8 2021-07-14 ZATHURARC(5)