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 For colors, zathura supports HTML color codes and CSS3-style rgb(r,g,b)
54 and rgba(r,g,b,a) values. If you want to use color codes for some
55 options, make sure to quote them accordingly or to escape the hash sym‐
56 bol.
57 set default-fg "#CCBBCC"
59 set default-fg \#CCBBCC
60 For rgba, note that it parses the color components as integers between
62 0 and 255 and the alpha component as float between 0 and 1.
63 include - Including another config file
65 This commands allows one to include other configuration files. If a
66 relative path is given, the path will be resolved relative to the con‐
67 figuration file that is currently processed.
68 include another-config
70 map - Mapping a shortcut
72 It is possible to map or remap new key bindings to shortcut functions
73 which allows a high level of customization. The :map command can also
74 be used in the zathurarc file to make those changes permanent:
75 map [mode] <binding> <shortcut function> <argument>
77 Mode The map command expects several arguments where only the binding
79 as well as the shortcut-function argument is required. Since
80 zathura uses several modes it is possible to map bindings only
81 for a specific mode by passing the mode argument which can take
82 one of the following values:
83 · normal (default)
85 · fullscreen
87 · presentation
89 · index
91 The brackets around the value are mandatory.
93 Single key binding
95 The (possible) second argument defines the used key binding that
96 should be mapped to the shortcut function and is structured like
97 the following. On the one hand it is possible to just assign
98 single letters, numbers or signs to it:
99 map a shortcut_function optional_argument
101 map b shortcut_function optional_argument
102 map c shortcut_function optional_argument
103 map 1 shortcut_function optional_argument
104 map 2 shortcut_function optional_argument
105 map 3 shortcut_function optional_argument
106 map ! shortcut_function optional_argument
107 map ? shortcut_function optional_argument
108 Using modifiers
110 It is also possible to use modifiers like the Control or Alt
111 button on the keyboard. It is possible to use the following mod‐
112 ifiers:
113 · A - Alt
115 · C - Control
117 · S - Shift
119 If any of the modifiers should be used for a binding, it is
121 required to define the binding with the following structure:
122 map <A-a> shortcut_function
124 map <C-a> shortcut_function
125 Special keys
127 zathura allows it also to assign keys like the space bar or the
128 tab button which also have to be written in between angle brack‐
129 ets. The following special keys are currently available:
130 Identifier Description
132 BackSpace Back space
134 CapsLock Caps lock
135 Esc Escape
136 Down Arrow down
137 Up Arrow up
138 Left Arrow left
139 Right Arrow right
140 F1 F1
141 F2 F2
142 F3 F3
143 F4 F4
144 F5 F5
145 F6 F6
146 F7 F7
147 F8 F8
148 F9 F9
149 F10 F10
150 F11 F11
151 F12 F12
152 PageDown Page Down
153 PageUp Page Up
154 Return Return
155 Space Space
156 Super Windows key
157 Tab Tab
158 Print Print key
159 Of course it is possible to combine those special keys with a
161 modifier. The usage of those keys should be explained by the
162 following examples:
163 map <Space> shortcut_function
165 map <C-Space> shortcut_function
166 Mouse buttons
168 It is also possible to map mouse buttons to shortcuts by using
169 the following special keys:
170 Identifier Description
172 Button1 Mouse button 1
174 Button2 Mouse button 2
175 Button3 Mouse button 3
176 Button4 Mouse button 4
177 Button5 Mouse button 5
178 They can also be combined with modifiers:
180 map <Button1> shortcut_function
182 map <C-Button1> shortcut_function
183 Buffer commands
185 If a mapping does not match one of the previous definition but
186 is still a valid mapping it will be mapped as a buffer command:
187 map abc quit
189 map test quit
190 Shortcut functions
192 The following shortcut functions can be mapped:
193 · abort
195 Switch back to normal mode.
197 · adjust_window
199 Adjust page width. Possible arguments are best-fit and width.
201 · change_mode
203 Change current mode. Pass the desired mode as argument.
205 · display_link:
207 Display link target.
209 · exec:
211 Execute an external command.
213 · focus_inputbar
215 Focus inputbar.
217 · follow
219 Follow a link.
221 · goto
223 Go to a certain page.
225 · jumplist
227 Move forwards/backwards in the jumplist. Pass forward as argu‐
229 ment to move to the next entry and backward to move to the
230 previous one.
231 · navigate
233 Navigate to the next/previous page.
235 · navigate_index
237 Navigate through the index.
239 · print
241 Show the print dialog.
243 · quit
245 Quit zathura.
247 · recolor
249 Recolor pages.
251 · reload
253 Reload the document.
255 · rotate
257 Rotate the page. Pass rotate-ccw as argument for counterclock‐
259 wise rotation and rotate-cw for clockwise rotation.
260 · scroll
262 Scroll.
264 · search
266 Search next/previous item. Pass forward as argument to search
268 for the next hit and backward to search for the previous hit.
269 · set
271 Set an option.
273 · toggle_fullscreen
275 Toggle fullscreen.
277 · toggle_index
279 Show or hide index.
281 · toggle_inputbar
283 Show or hide inputbar.
285 · toggle_page_mode
287 Toggle between one and multiple pages per row.
289 · toggle_statusbar
291 Show or hide statusbar.
293 · zoom
295 Zoom in or out.
297 · mark_add
299 Set a quickmark.
301 · mark_evaluate
303 Go to a quickmark.
305 · feedkeys
307 Simulate key presses. Note that all keys will be interpreted
309 as if pressing a key on the keyboard. To input uppercase let‐
310 ters, follow the same convention as for key bindings, i.e. for
311 X, use <S-X>.
312 Pass arguments
314 Some shortcut function require or have optional arguments which
315 influence the behaviour of them. Those can be passed as the last
316 argument:
317 map <C-i> zoom in
319 map <C-o> zoom out
320 Possible arguments are:
322 · best-fit
324 · bottom
326 · backward
328 · collapse
330 · collapse-all
332 · default
334 · down
336 · expand
338 · expand-all
340 · forward
342 · full-down
344 · full-up
346 · half-down
348 · half-up
350 · in
352 · left
354 · next
356 · out
358 · page-bottom
360 · page-top
362 · previous
364 · right
366 · rotate-ccw
368 · rotate-cw
370 · select
372 · specific
374 · toggle
376 · top
378 · up
380 · width
382 unmap - Removing a shortcut
384 In addition to mapping or remaping custom key bindings it is possible
385 to remove existing ones by using the :unmap command. The command is
386 used in the following way (the explanation of the parameters is
387 described in the map section of this document
388 unmap [mode] <binding>
390
392 This section describes settings concerning the behaviour of girara and
393 zathura. The settings described here can be changed with set.
394 girara
396 n-completion-items
397 Defines the maximum number of displayed completion entries.
398 · Value type: Integer
400 · Default value: 15
402 completion-bg
404 Defines the background color that is used for command line com‐
405 pletion entries
406 · Value type: String
408 · Default value: #232323
410 completion-fg
412 Defines the foreground color that is used for command line com‐
413 pletion entries
414 · Value type: String
416 · Default value: #DDDDDD
418 completion-group-bg
420 Defines the background color that is used for command line com‐
421 pletion group elements
422 · Value type: String
424 · Default value: #000000
426 completion-group-fg
428 Defines the foreground color that is used for command line com‐
429 pletion group elements
430 · Value type: String
432 · Default value: #DEDEDE
434 completion-highlight-bg
436 Defines the background color that is used for the current com‐
437 mand line completion element
438 · Value type: String
440 · Default value: #9FBC00
442 completion-highlight-fg
444 Defines the foreground color that is used for the current com‐
445 mand line completion element
446 · Value type: String
448 · Default value: #232323
450 default-fg
452 Defines the default foreground color
453 · Value type: String
455 · Default value: #DDDDDD
457 default-bg
459 Defines the default background color
460 · Value type: String
462 · Default value: #000000
464 exec-command
466 Defines a command the should be prepended to any command run
467 with exec.
468 · Value type: String
470 · Default value:
472 font Defines the font that will be used
474 · Value type: String
476 · Default value: monospace normal 9
478 guioptions
480 Shows or hides GUI elements. If it contains 'c', the command
481 line is displayed. If it contains 's', the statusbar is dis‐
482 played. If it contains 'h', the horizontal scrollbar is dis‐
483 played. If it contains 'v', the vertical scrollbar is dis‐
484 played.
485 · Value type: String
487 · Default value: s
489 inputbar-bg
491 Defines the background color for the inputbar
492 · Value type: String
494 · Default value: #131313
496 inputbar-fg
498 Defines the foreground color for the inputbar
499 · Value type: String
501 · Default value: #9FBC00
503 notification-bg
505 Defines the background color for a notification
506 · Value type: String
508 · Default value: #FFFFFF
510 notification-fg
512 Defines the foreground color for a notification
513 · Value type: String
515 · Default value: #000000
517 notification-error-bg
519 Defines the background color for an error notification
520 · Value type: String
522 · Default value: #FFFFFF
524 notification-error-fg
526 Defines the foreground color for an error notification
527 · Value type: String
529 · Default value: #FF1212
531 notification-warning-bg
533 Defines the background color for a warning notification
534 · Value type: String
536 · Default value: #FFFFFF
538 notification-warning-fg
540 Defines the foreground color for a warning notification
541 · Value type: String
543 · Default value: #FFF712
545 tabbar-fg
547 Defines the foreground color for a tab
548 · Value type: String
550 · Default value: #FFFFFF
552 tabbar-bg
554 Defines the background color for a tab
555 · Value type: String
557 · Default value: #000000
559 tabbar-focus-fg
561 Defines the foreground color for the focused tab
562 · Value type: String
564 · Default value: #9FBC00
566 tabbar-focus-bg
568 Defines the background color for the focused tab
569 · Value type: String
571 · Default value: #000000
573 show-scrollbars
575 Defines if both the horizontal and vertical scrollbars should be
576 shown or not. Deprecated, use 'guioptions' instead.
577 · Value type: Boolean
579 · Default value: false
581 show-h-scrollbar
583 Defines whether to show/hide the horizontal scrollbar. Depre‐
584 cated, use 'guioptions' instead.
585 · Value type: Boolean
587 · Default value: false
589 show-v-scrollbar
591 Defines whether to show/hide the vertical scrollbar. Deprecated,
592 use 'guioptions' instead.
593 · Value type: Boolean
595 · Default value: false
597 statusbar-bg
599 Defines the background color of the statusbar
600 · Value type: String
602 · Default value: #000000
604 statusbar-fg
606 Defines the foreground color of the statusbar
607 · Value type: String
609 · Default value: #FFFFFF
611 statusbar-h-padding
613 Defines the horizontal padding of the statusbar and notifica‐
614 tionbar
615 · Value type: Integer
617 · Default value: 8
619 statusbar-v-padding
621 Defines the vertical padding of the statusbar and notification‐
622 bar
623 · Value type: Integer
625 · Default value: 2
627 window-icon
629 Defines the path for a icon to be used as window icon.
630 · Value type: String
632 · Default value:
634 window-height
636 Defines the window height on startup
637 · Value type: Integer
639 · Default value: 600
641 window-width
643 Defines the window width on startup
644 · Value type: Integer
646 · Default value: 800
648 zathura
650 This section describes settings concerning the behaviour of zathura.
651 abort-clear-search
653 Defines if the search results should be cleared on abort.
654 · Value type: Boolean
656 · Default value: true
658 adjust-open
660 Defines which auto adjustment mode should be used if a document
661 is loaded. Possible options are "best-fit" and "width".
662 · Value type: String
664 · Default value: best-fit
666 advance-pages-per-row
668 Defines if the number of pages per row should be honored when
669 advancing a page.
670 · Value type: Boolean
672 · Default value: false
674 continuous-hist-save
676 Tells zathura whether to save document history at each page
677 change or only when closing a document.
678 · Value type: Boolean
680 · Default value: false
682 database
684 Defines the database backend to use for bookmarks and input his‐
685 tory. Possible values are "plain", "sqlite" (if built with
686 sqlite support) and "null". If "null" is used, bookmarks and
687 input history will not be stored.
688 · Value type: String
690 · Default value: plain
692 dbus-service
694 En/Disables the D-Bus service. If the services is disabled,
695 SyncTeX forward synchronization is not available.
696 · Value type: Boolean
698 · Default value: true
700 filemonitor
702 Defines the file monitor backend used to check for changes in
703 files. Possible values are "glib", "signal" (if signal handling
704 is supported), and "noop". The "noop" file monitor does not
705 trigger reloads.
706 · Value type: String
708 · Default value: glib
710 incremental-search
712 En/Disables incremental search (search while typing).
713 · Value type: Boolean
715 · Default value: true
717 highlight-color
719 Defines the color that is used for highlighting parts of the
720 document (e.g.: show search results)
721 · Value type: String
723 · Default value: #9FBC00
725 highlight-active-color
727 Defines the color that is used to show the current selected
728 highlighted element (e.g: current search result)
729 · Value type: String
731 · Default value: #00BC00
733 highlight-transparency
735 Defines the opacity of a highlighted element
736 · Value type: Float
738 · Default value: 0.5
740 page-padding
742 The page padding defines the gap in pixels between each rendered
743 page.
744 · Value type: Integer
746 · Default value: 1
748 page-cache-size
750 Defines the maximum number of pages that could be kept in the
751 page cache. When the cache is full and a new page that isn't
752 cached becomes visible, the least recently viewed page in the
753 cache will be evicted to make room for the new one. Large val‐
754 ues for this variable are NOT recommended, because this will
755 lead to consuming a significant portion of the system memory.
756 · Value type: Integer
758 · Default value: 15
760 page-thumbnail-size
762 Defines the maximum size in pixels of the thumbnail that could
763 be kept in the thumbnail cache per page. The thumbnail is scaled
764 for a quick preview during zooming before the page is rendered.
765 When the page is rendered, the result is saved as the thumbnail
766 only if the size is no more than this value. A larger value
767 increases quality but introduces longer delay in zooming and
768 uses more system memory.
769 · Value type: Integer
771 · Default value: 4194304 (4M)
773 pages-per-row
775 Defines the number of pages that are rendered next to each other
776 in a row.
777 · Value type: Integer
779 · Default value: 1
781 first-page-column
783 Defines the column in which the first page will be displayed.
784 This setting is stored separately for every value of
785 pages-per-row according to the following pattern <1 page per
786 row>:[<2 pages per row>[: ...]]. The last value in the list will
787 be used for all other number of pages per row if not set explic‐
788 itly.
789 Per default, the first column is set to 2 for double-page lay‐
791 out, i.e. the faule is set to 1:2. A value of 1:1:3 would put
792 the first page in dual-page layour in the first column, and for
793 layouts with more columns the first page would be put in the 3rd
794 column.
795 · Value type: String
797 · Default value: 1:2
799 recolor
801 En/Disables recoloring
802 · Value type: Boolean
804 · Default value: false
806 recolor-keephue
808 En/Disables keeping original hue when recoloring
809 · Value type: Boolean
811 · Default value: false
813 recolor-darkcolor
815 Defines the color value that is used to represent dark colors in
816 recoloring mode
817 · Value type: String
819 · Default value: #FFFFFF
821 recolor-lightcolor
823 Defines the color value that is used to represent light colors
824 in recoloring mode
825 · Value type: String
827 · Default value: #000000
829 recolor-reverse-video
831 Defines if original image colors should be kept while recolor‐
832 ing.
833 · Value type: Boolean
835 · Default value: false
837 render-loading
839 Defines if the "Loading..." text should be displayed if a page
840 is rendered.
841 · Value type: Boolean
843 · Default value: true
845 render-loading-bg
847 Defines the background color that is used for the "Loading..."
848 text.
849 · Value type: String
851 · Default value: #FFFFFF
853 render-loading-fg
855 Defines the foreground color that is used for the "Loading..."
856 text.
857 · Value type: String
859 · Default value: #000000
861 scroll-hstep
863 Defines the horizontal step size of scrolling by calling the
864 scroll command once
865 · Value type: Float
867 · Default value: -1
869 scroll-step
871 Defines the step size of scrolling by calling the scroll command
872 once
873 · Value type: Float
875 · Default value: 40
877 scroll-full-overlap
879 Defines the proportion of the current viewing area that should
880 be visible after scrolling a full page.
881 · Value type: Float
883 · Default value: 0
885 scroll-wrap
887 Defines if the last/first page should be wrapped
888 · Value type: Boolean
890 · Default value: false
892 show-directories
894 Defines if the directories should be displayed in completion.
895 · Value type: Boolean
897 · Default value: true
899 show-hidden
901 Defines if hidden files and directories should be displayed in
902 completion.
903 · Value type: Boolean
905 · Default value: false
907 show-recent
909 Defines the number of recent files that should be displayed in
910 completion. If the value is negative, no upper bounds are
911 applied. If the value is 0, no recent files are shown.
912 · Value type: Integer
914 · Default value: 10
916 scroll-page-aware
918 Defines if scrolling by half or full pages stops at page bound‐
919 aries.
920 · Value type: Boolean
922 · Default value: false
924 link-zoom
926 En/Disables the ability of changing zoom when following links.
927 · Value type: Boolean
929 · Default value: true
931 link-hadjust
933 En/Disables aligning to the left internal link targets, for
934 example from the index.
935 · Value type: Boolean
937 · Default value: true
939 search-hadjust
941 En/Disables horizontally centered search results.
942 · Value type: Boolean
944 · Default value: true
946 window-title-basename
948 Use basename of the file in the window title.
949 · Value type: Boolean
951 · Default value: false
953 window-title-home-tilde
955 Display a short version of the file path, which replaces $HOME
956 with ~, in the window title.
957 · Value type: Boolean
959 · Default value: false
961 window-title-page
963 Display the page number in the window title.
964 · Value type: Boolean
966 · Default value: false
968 statusbar-basename
970 Use basename of the file in the statusbar.
971 · Value type: Boolean
973 · Default value: false
975 statusbar-home-tilde
977 Display a short version of the file path, which replaces $HOME
978 with ~, in the statusbar.
979 · Value type: Boolean
981 · Default value: false
983 zoom-center
985 En/Disables horizontally centered zooming.
986 · Value type: Boolean
988 · Default value: false
990 vertical-center
992 Center the screen at the vertical midpoint of the page by
993 default.
994 · Value type: Boolean
996 · Default value: false
998 zoom-max
1000 Defines the maximum percentage that the zoom level can be.
1001 · Value type: Integer
1003 · Default value: 1000
1005 zoom-min
1007 Defines the minimum percentage that the zoom level can be.
1008 · Value type: Integer
1010 · Default value: 10
1012 zoom-step
1014 Defines the amount of percent that is zoomed in or out on each
1015 command.
1016 · Value type: Integer
1018 · Default value: 10
1020 selection-clipboard
1022 Defines the X clipboard into which mouse-selected data will be
1023 written. When it is "clipboard", selected data will be written
1024 to the CLIPBOARD clipboard, and can be pasted using the Ctrl+v
1025 key combination. When it is "primary", selected data will be
1026 written to the PRIMARY clipboard, and can be pasted using the
1027 middle mouse button, or the Shift-Insert key combination.
1028 · Value type: String
1030 · Default value: primary
1032 selection-notification
1034 Defines if a notification should be displayed after selecting
1035 text.
1036 · Value type: Boolean
1038 · Default value: true
1040 synctex
1042 En/Disables SyncTeX backward synchronization support.
1043 · Value type: Boolean
1045 · Default value: true
1047 synctex-editor-command
1049 Defines the command executed for SyncTeX backward synchroniza‐
1050 tion.
1051 · Value type: String
1053 · Default value:
1055 index-fg
1057 Defines the foreground color of the index mode.
1058 · Value type: String
1060 · Default value: #DDDDDD
1062 index-bg
1064 Define the background color of the index mode.
1065 · Value type: String
1067 · Default value: #232323
1069 index-active-fg
1071 Defines the foreground color of the selected element in index
1072 mode.
1073 · Value type: String
1075 · Default value: #232323
1077 index-active-bg
1079 Define the background color of the selected element in index
1080 mode.
1081 · Value type: String
1083 · Default value: #9FBC00
1085 sandbox
1087 Defines the sandbox mode to use for the seccomp syscall filter.
1088 Possible values are "none", "normal" and "strict". If "none" is
1089 used, the sandbox will be disabled. The use of "normal" will
1090 provide minimal protection and allow normal use of zathura with
1091 support for all features. The "strict" mode is a read only sand‐
1092 box that is intended for viewing documents only.
1093 · Value type: String
1095 · Default value: normal
1097 Some features are disabled when using strict sandbox mode:
1099 · saving/writing files
1101 · use of input methods like ibus
1103 · printing
1105 · bookmarks and history
1107 No feature regressions are expected when using normal sandbox
1109 mode.
1110 When running under WSL, the default is "none" since seccomp is
1112 not supported in that environment.
1113 window-icon-document
1115 Defines whether the window document should be updated based on
1116 the first page of a dcument.
1117 · Value type: Boolean
1119 · Default value: false
1121 page-right-to-left
1123 Defines whether pages in multi-column view should start from the
1124 right side.
1125 · Value type: Boolean
1127 · Default value: false
1129
1131 zathura(1)
1132
1134 pwmt.org
1135
1137 2009-2020, pwmt.org
11380.4.5 2020-01-06 ZATHURARC(5)