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 op‐
55 tions, 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 za‐
80 thura uses several modes it is possible to map bindings only for
81 a specific mode by passing the mode argument which can take one
82 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 re‐
121 quired 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 • snap_to_page
275 Snaps to the current page. Equivalent to goto <current_page>
277 • toggle_fullscreen
279 Toggle fullscreen.
281 • toggle_index
283 Show or hide index.
285 • toggle_inputbar
287 Show or hide inputbar.
289 • toggle_page_mode
291 Toggle between one and multiple pages per row.
293 • toggle_statusbar
295 Show or hide statusbar.
297 • zoom
299 Zoom in or out.
301 • mark_add
303 Set a quickmark.
305 • mark_evaluate
307 Go to a quickmark.
309 • feedkeys
311 Simulate key presses. Note that all keys will be interpreted
313 as if pressing a key on the keyboard. To input uppercase let‐
314 ters, follow the same convention as for key bindings, i.e. for
315 X, use <S-X>.
316 Pass arguments
318 Some shortcut function require or have optional arguments which
319 influence the behaviour of them. Those can be passed as the last
320 argument:
321 map <C-i> zoom in
323 map <C-o> zoom out
324 Possible arguments are:
326 • best-fit
328 • bottom
330 • backward
332 • collapse
334 • collapse-all
336 • default
338 • down
340 • expand
342 • expand-all
344 • forward
346 • full-down
348 • full-up
350 • half-down
352 • half-up
354 • in
356 • left
358 • next
360 • out
362 • page-bottom
364 • page-top
366 • previous
368 • right
370 • rotate-ccw
372 • rotate-cw
374 • select
376 • specific
378 • toggle
380 • top
382 • up
384 • width
386 unmap - Removing a shortcut
388 In addition to mapping or remaping custom key bindings it is possible
389 to remove existing ones by using the :unmap command. The command is
390 used in the following way (the explanation of the parameters is de‐
391 scribed in the map section of this document
392 unmap [mode] <binding>
394
396 This section describes settings concerning the behaviour of girara and
397 zathura. The settings described here can be changed with set.
398 girara
400 n-completion-items
401 Defines the maximum number of displayed completion entries.
402 • Value type: Integer
404 • Default value: 15
406 completion-bg
408 Defines the background color that is used for command line com‐
409 pletion entries
410 • Value type: String
412 • Default value: #232323
414 completion-fg
416 Defines the foreground color that is used for command line com‐
417 pletion entries
418 • Value type: String
420 • Default value: #DDDDDD
422 completion-group-bg
424 Defines the background color that is used for command line com‐
425 pletion group elements
426 • Value type: String
428 • Default value: #000000
430 completion-group-fg
432 Defines the foreground color that is used for command line com‐
433 pletion group elements
434 • Value type: String
436 • Default value: #DEDEDE
438 completion-highlight-bg
440 Defines the background color that is used for the current com‐
441 mand line completion element
442 • Value type: String
444 • Default value: #9FBC00
446 completion-highlight-fg
448 Defines the foreground color that is used for the current com‐
449 mand line completion element
450 • Value type: String
452 • Default value: #232323
454 default-fg
456 Defines the default foreground color
457 • Value type: String
459 • Default value: #DDDDDD
461 default-bg
463 Defines the default background color
464 • Value type: String
466 • Default value: #000000
468 exec-command
470 Defines a command the should be prepended to any command run
471 with exec.
472 • Value type: String
474 • Default value:
476 font Defines the font that will be used
478 • Value type: String
480 • Default value: monospace normal 9
482 guioptions
484 Shows or hides GUI elements. If it contains 'c', the command
485 line is displayed. If it contains 's', the statusbar is dis‐
486 played. If it contains 'h', the horizontal scrollbar is dis‐
487 played. If it contains 'v', the vertical scrollbar is dis‐
488 played.
489 • Value type: String
491 • Default value: s
493 inputbar-bg
495 Defines the background color for the inputbar
496 • Value type: String
498 • Default value: #131313
500 inputbar-fg
502 Defines the foreground color for the inputbar
503 • Value type: String
505 • Default value: #9FBC00
507 notification-bg
509 Defines the background color for a notification
510 • Value type: String
512 • Default value: #FFFFFF
514 notification-fg
516 Defines the foreground color for a notification
517 • Value type: String
519 • Default value: #000000
521 notification-error-bg
523 Defines the background color for an error notification
524 • Value type: String
526 • Default value: #FFFFFF
528 notification-error-fg
530 Defines the foreground color for an error notification
531 • Value type: String
533 • Default value: #FF1212
535 notification-warning-bg
537 Defines the background color for a warning notification
538 • Value type: String
540 • Default value: #FFFFFF
542 notification-warning-fg
544 Defines the foreground color for a warning notification
545 • Value type: String
547 • Default value: #FFF712
549 tabbar-fg
551 Defines the foreground color for a tab
552 • Value type: String
554 • Default value: #FFFFFF
556 tabbar-bg
558 Defines the background color for a tab
559 • Value type: String
561 • Default value: #000000
563 tabbar-focus-fg
565 Defines the foreground color for the focused tab
566 • Value type: String
568 • Default value: #9FBC00
570 tabbar-focus-bg
572 Defines the background color for the focused tab
573 • Value type: String
575 • Default value: #000000
577 show-scrollbars
579 Defines if both the horizontal and vertical scrollbars should be
580 shown or not. Deprecated, use 'guioptions' instead.
581 • Value type: Boolean
583 • Default value: false
585 show-h-scrollbar
587 Defines whether to show/hide the horizontal scrollbar. Depre‐
588 cated, use 'guioptions' instead.
589 • Value type: Boolean
591 • Default value: false
593 show-v-scrollbar
595 Defines whether to show/hide the vertical scrollbar. Deprecated,
596 use 'guioptions' instead.
597 • Value type: Boolean
599 • Default value: false
601 statusbar-bg
603 Defines the background color of the statusbar
604 • Value type: String
606 • Default value: #000000
608 statusbar-fg
610 Defines the foreground color of the statusbar
611 • Value type: String
613 • Default value: #FFFFFF
615 statusbar-h-padding
617 Defines the horizontal padding of the statusbar and notifica‐
618 tionbar
619 • Value type: Integer
621 • Default value: 8
623 statusbar-v-padding
625 Defines the vertical padding of the statusbar and notification‐
626 bar
627 • Value type: Integer
629 • Default value: 2
631 window-icon
633 Defines the path for a icon to be used as window icon.
634 • Value type: String
636 • Default value:
638 window-height
640 Defines the window height on startup
641 • Value type: Integer
643 • Default value: 600
645 window-width
647 Defines the window width on startup
648 • Value type: Integer
650 • Default value: 800
652 zathura
654 This section describes settings concerning the behaviour of zathura.
655 abort-clear-search
657 Defines if the search results should be cleared on abort.
658 • Value type: Boolean
660 • Default value: true
662 adjust-open
664 Defines which auto adjustment mode should be used if a document
665 is loaded. Possible options are "best-fit" and "width".
666 • Value type: String
668 • Default value: best-fit
670 advance-pages-per-row
672 Defines if the number of pages per row should be honored when
673 advancing a page.
674 • Value type: Boolean
676 • Default value: false
678 continuous-hist-save
680 Tells zathura whether to save document history at each page
681 change or only when closing a document.
682 • Value type: Boolean
684 • Default value: false
686 database
688 Defines the database backend to use for bookmarks and input his‐
689 tory. Possible values are "plain", "sqlite" (if built with
690 sqlite support) and "null". If "null" is used, bookmarks and in‐
691 put history will not be stored.
692 • Value type: String
694 • Default value: plain
696 dbus-service
698 En/Disables the D-Bus service. If the services is disabled,
699 SyncTeX forward synchronization is not available.
700 • Value type: Boolean
702 • Default value: true
704 filemonitor
706 Defines the file monitor backend used to check for changes in
707 files. Possible values are "glib", "signal" (if signal handling
708 is supported), and "noop". The "noop" file monitor does not
709 trigger reloads.
710 • Value type: String
712 • Default value: glib
714 incremental-search
716 En/Disables incremental search (search while typing).
717 • Value type: Boolean
719 • Default value: true
721 highlight-color
723 Defines the color that is used for highlighting parts of the
724 document (e.g.: show search results)
725 • Value type: String
727 • Default value: #9FBC00
729 highlight-active-color
731 Defines the color that is used to show the current selected
732 highlighted element (e.g: current search result)
733 • Value type: String
735 • Default value: #00BC00
737 highlight-transparency
739 Defines the opacity of a highlighted element
740 • Value type: Float
742 • Default value: 0.5
744 page-padding
746 The page padding defines the gap in pixels between each rendered
747 page.
748 • Value type: Integer
750 • Default value: 1
752 page-cache-size
754 Defines the maximum number of pages that could be kept in the
755 page cache. When the cache is full and a new page that isn't
756 cached becomes visible, the least recently viewed page in the
757 cache will be evicted to make room for the new one. Large val‐
758 ues for this variable are NOT recommended, because this will
759 lead to consuming a significant portion of the system memory.
760 • Value type: Integer
762 • Default value: 15
764 page-thumbnail-size
766 Defines the maximum size in pixels of the thumbnail that could
767 be kept in the thumbnail cache per page. The thumbnail is scaled
768 for a quick preview during zooming before the page is rendered.
769 When the page is rendered, the result is saved as the thumbnail
770 only if the size is no more than this value. A larger value in‐
771 creases quality but introduces longer delay in zooming and uses
772 more system memory.
773 • Value type: Integer
775 • Default value: 4194304 (4M)
777 pages-per-row
779 Defines the number of pages that are rendered next to each other
780 in a row.
781 • Value type: Integer
783 • Default value: 1
785 first-page-column
787 Defines the column in which the first page will be displayed.
788 This setting is stored separately for every value of
789 pages-per-row according to the following pattern <1 page per
790 row>:[<2 pages per row>[: ...]]. The last value in the list will
791 be used for all other number of pages per row if not set explic‐
792 itly.
793 Per default, the first column is set to 2 for double-page lay‐
795 out, i.e. the value is set to 1:2. A value of 1:1:3 would put
796 the first page in dual-page layout in the first column, and for
797 layouts with more columns the first page would be put in the 3rd
798 column.
799 • Value type: String
801 • Default value: 1:2
803 recolor
805 En/Disables recoloring
806 • Value type: Boolean
808 • Default value: false
810 recolor-keephue
812 En/Disables keeping original hue when recoloring
813 • Value type: Boolean
815 • Default value: false
817 recolor-darkcolor
819 Defines the color value that is used to represent dark colors in
820 recoloring mode
821 • Value type: String
823 • Default value: #FFFFFF
825 recolor-lightcolor
827 Defines the color value that is used to represent light colors
828 in recoloring mode
829 • Value type: String
831 • Default value: #000000
833 recolor-reverse-video
835 Defines if original image colors should be kept while recolor‐
836 ing.
837 • Value type: Boolean
839 • Default value: false
841 render-loading
843 Defines if the "Loading..." text should be displayed if a page
844 is rendered.
845 • Value type: Boolean
847 • Default value: true
849 render-loading-bg
851 Defines the background color that is used for the "Loading..."
852 text.
853 • Value type: String
855 • Default value: #FFFFFF
857 render-loading-fg
859 Defines the foreground color that is used for the "Loading..."
860 text.
861 • Value type: String
863 • Default value: #000000
865 scroll-hstep
867 Defines the horizontal step size of scrolling by calling the
868 scroll command once
869 • Value type: Float
871 • Default value: -1
873 scroll-step
875 Defines the step size of scrolling by calling the scroll command
876 once
877 • Value type: Float
879 • Default value: 40
881 scroll-full-overlap
883 Defines the proportion of the current viewing area that should
884 be visible after scrolling a full page.
885 • Value type: Float
887 • Default value: 0
889 scroll-wrap
891 Defines if the last/first page should be wrapped
892 • Value type: Boolean
894 • Default value: false
896 show-directories
898 Defines if the directories should be displayed in completion.
899 • Value type: Boolean
901 • Default value: true
903 show-hidden
905 Defines if hidden files and directories should be displayed in
906 completion.
907 • Value type: Boolean
909 • Default value: false
911 show-recent
913 Defines the number of recent files that should be displayed in
914 completion. If the value is negative, no upper bounds are ap‐
915 plied. If the value is 0, no recent files are shown.
916 • Value type: Integer
918 • Default value: 10
920 scroll-page-aware
922 Defines if scrolling by half or full pages stops at page bound‐
923 aries.
924 • Value type: Boolean
926 • Default value: false
928 link-zoom
930 En/Disables the ability of changing zoom when following links.
931 • Value type: Boolean
933 • Default value: true
935 link-hadjust
937 En/Disables aligning to the left internal link targets, for ex‐
938 ample from the index.
939 • Value type: Boolean
941 • Default value: true
943 search-hadjust
945 En/Disables horizontally centered search results.
946 • Value type: Boolean
948 • Default value: true
950 window-title-basename
952 Use basename of the file in the window title.
953 • Value type: Boolean
955 • Default value: false
957 window-title-home-tilde
959 Display a short version of the file path, which replaces $HOME
960 with ~, in the window title.
961 • Value type: Boolean
963 • Default value: false
965 window-title-page
967 Display the page number in the window title.
968 • Value type: Boolean
970 • Default value: false
972 statusbar-basename
974 Use basename of the file in the statusbar.
975 • Value type: Boolean
977 • Default value: false
979 statusbar-home-tilde
981 Display a short version of the file path, which replaces $HOME
982 with ~, in the statusbar.
983 • Value type: Boolean
985 • Default value: false
987 zoom-center
989 En/Disables horizontally centered zooming.
990 • Value type: Boolean
992 • Default value: false
994 vertical-center
996 Center the screen at the vertical midpoint of the page by de‐
997 fault.
998 • Value type: Boolean
1000 • Default value: false
1002 zoom-max
1004 Defines the maximum percentage that the zoom level can be.
1005 • Value type: Integer
1007 • Default value: 1000
1009 zoom-min
1011 Defines the minimum percentage that the zoom level can be.
1012 • Value type: Integer
1014 • Default value: 10
1016 zoom-step
1018 Defines the amount of percent that is zoomed in or out on each
1019 command.
1020 • Value type: Integer
1022 • Default value: 10
1024 selection-clipboard
1026 Defines the X clipboard into which mouse-selected data will be
1027 written. When it is "clipboard", selected data will be written
1028 to the CLIPBOARD clipboard, and can be pasted using the Ctrl+v
1029 key combination. When it is "primary", selected data will be
1030 written to the PRIMARY clipboard, and can be pasted using the
1031 middle mouse button, or the Shift-Insert key combination.
1032 • Value type: String
1034 • Default value: primary
1036 selection-notification
1038 Defines if a notification should be displayed after selecting
1039 text.
1040 • Value type: Boolean
1042 • Default value: true
1044 synctex
1046 En/Disables SyncTeX backward synchronization support.
1047 • Value type: Boolean
1049 • Default value: true
1051 synctex-editor-command
1053 Defines the command executed for SyncTeX backward synchroniza‐
1054 tion.
1055 • Value type: String
1057 • Default value:
1059 index-fg
1061 Defines the foreground color of the index mode.
1062 • Value type: String
1064 • Default value: #DDDDDD
1066 index-bg
1068 Define the background color of the index mode.
1069 • Value type: String
1071 • Default value: #232323
1073 index-active-fg
1075 Defines the foreground color of the selected element in index
1076 mode.
1077 • Value type: String
1079 • Default value: #232323
1081 index-active-bg
1083 Define the background color of the selected element in index
1084 mode.
1085 • Value type: String
1087 • Default value: #9FBC00
1089 sandbox
1091 Defines the sandbox mode to use for the seccomp syscall filter.
1092 Possible values are "none", "normal" and "strict". If "none" is
1093 used, the sandbox will be disabled. The use of "normal" will
1094 provide minimal protection and allow normal use of zathura with
1095 support for all features. The "strict" mode is a read only sand‐
1096 box that is intended for viewing documents only.
1097 • Value type: String
1099 • Default value: normal
1101 Some features are disabled when using strict sandbox mode:
1103 • saving/writing files
1105 • use of input methods like ibus
1107 • printing
1109 • bookmarks and history
1111 No feature regressions are expected when using normal sandbox
1113 mode.
1114 When running under WSL, the default is "none" since seccomp is
1116 not supported in that environment.
1117 window-icon-document
1119 Defines whether the window document should be updated based on
1120 the first page of a dcument.
1121 • Value type: Boolean
1123 • Default value: false
1125 page-right-to-left
1127 Defines whether pages in multi-column view should start from the
1128 right side.
1129 • Value type: Boolean
1131 • Default value: false
1133
1135 zathura(1)
1136
1138 pwmt.org
1139
1141 2009-2021, pwmt.org
11420.4.7 2020-09-03 ZATHURARC(5)