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 If you want to use color codes for some options, make sure to quote
54 them accordingly or to escape the hash symbol.
55 set default-fg "#CCBBCC"
57 set default-fg \#CCBBCC
58 map - Mapping a shortcut
60 It is possible to map or remap new key bindings to shortcut functions
61 which allows a high level of customization. The :map command can also
62 be used in the zathurarc file to make those changes permanent:
63 map [mode] <binding> <shortcut function> <argument>
65 include - Including another config file
67 This commands allows one to include other configuration files. If a
68 relative path is given, the path will be resolved relative to the con‐
69 figuration file that is currently processed.
70 include another-config
72 Mode
74 The map command expects several arguments where only the binding as
75 well as the shortcut-function argument is required. Since zathura uses
76 several modes it is possible to map bindings only for a specific mode
77 by passing the mode argument which can take one of the following val‐
78 ues:
79 · normal (default)
81 · fullscreen
83 · presentation
85 · index
87 The brackets around the value are mandatory.
89 Single key binding
91 The (possible) second argument defines the used key binding that should
92 be mapped to the shortcut function and is structured like the follow‐
93 ing. On the one hand it is possible to just assign single letters, num‐
94 bers or signs to it:
95 map a shortcut_function
97 map b shortcut_function
98 map c shortcut_function
99 map 1 shortcut_function
100 map 2 shortcut_function
101 map 3 shortcut_function
102 map ! shortcut_function
103 map ? shortcut_function
104 Using modifiers
106 It is also possible to use modifiers like the Control or Alt button on
107 the keyboard. It is possible to use the following modifiers:
108 · A - Alt
110 · C - Control
112 · S - Shift
114 Now it is required to define the binding with the following structure:
116 map <A-a> shortcut_function
118 map <C-a> shortcut_function
119 Special keys
121 zathura allows it also to assign keys like the space bar or the tab
122 button which also have to be written in between angle brackets. The
123 following special keys are currently available:
124 Identifier Description
126 BackSpace Back space
128 CapsLock Caps lock
129 Esc Escape
130 Down Arrow down
131 Up Arrow up
132 Left Arrow left
133 Right Arrow right
134 F1 F1
135 F2 F2
136 F3 F3
137 F4 F4
138 F5 F5
139 F6 F6
140 F7 F7
141 F8 F8
142 F9 F9
143 F10 F10
144 F11 F11
145 F12 F12
146 PageDown Page Down
147 PageUp Page Up
148 Return Return
149 Space Space
150 Super Windows key
151 Tab Tab
152 Print Print key
153 Of course it is possible to combine those special keys with a modifier.
155 The usage of those keys should be explained by the following examples:
156 map <Space> shortcut_function
158 map <C-Space> shortcut_function
159 Mouse buttons
161 It is also possible to map mouse buttons to shortcuts by using the fol‐
162 lowing special keys:
163 Identifier Description
165 Button1 Mouse button 1
167 Button2 Mouse button 2
168 Button3 Mouse button 3
169 Button4 Mouse button 4
170 Button5 Mouse button 5
171 They can also be combined with modifiers:
173 map <Button1> shortcut_function
175 map <C-Button1> shortcut_function
176 Buffer commands
178 If a mapping does not match one of the previous definition but is still
179 a valid mapping it will be mapped as a buffer command:
180 map abc quit
182 map test quit
183 Shortcut functions
185 The following shortcut functions can be mapped:
186 · abort
188 Switch back to normal mode.
190 · adjust_window
192 Adjust page width. Possible arguments are best-fit and width.
194 · change_mode
196 Change current mode. Pass the desired mode as argument.
198 · display_link:
200 Display link target.
202 · exec:
204 Execute an external command.
206 · focus_inputbar
208 Focus inputbar.
210 · follow
212 Follow a link.
214 · goto
216 Go to a certain page.
218 · jumplist
220 Move forwards/backwards in the jumplist.
222 · navigate
224 Navigate to the next/previous page.
226 · navigate_index
228 Navigate through the index.
230 · print
232 Show the print dialog.
234 · quit
236 Quit zathura.
238 · recolor
240 Recolor pages.
242 · reload
244 Reload the document.
246 · rotate
248 Rotate the page. Pass rotate-ccw as argument for counterclockwise
250 rotation and rotate-cw for clockwise rotation.
251 · scroll
253 Scroll.
255 · search
257 Search next/previous item. Pass forward as argument to search for the
259 next hit and backward to search for the previous hit.
260 · set
262 Set an option.
264 · toggle_fullscreen
266 Toggle fullscreen.
268 · toggle_index
270 Show or hide index.
272 · toggle_inputbar
274 Show or hide inputbar.
276 · toggle_page_mode
278 Toggle between one and multiple pages per row.
280 · toggle_statusbar
282 Show or hide statusbar.
284 · zoom
286 Zoom in or out.
288 · mark_add Set a quickmark.
290 · mark_evaluate Go to a quickmark.
292 Pass arguments
294 Some shortcut function require or have optional arguments which influ‐
295 ence the behaviour of them. Those can be passed as the last argument:
296 map <C-i> zoom in
298 map <C-o> zoom out
299 Possible arguments are:
301 · best-fit
303 · bottom
305 · collapse
307 · collapse-all
309 · default
311 · down
313 · expand
315 · expand-all
317 · full-down
319 · full-up
321 · half-down
323 · half-up
325 · in
327 · left
329 · next
331 · out
333 · page-bottom
335 · page-top
337 · previous
339 · right
341 · rotate-ccw
343 · rotate-cw
345 · select
347 · specific
349 · toggle
351 · top
353 · up
355 · width
357 unmap - Removing a shortcut
359 In addition to mapping or remaping custom key bindings it is possible
360 to remove existing ones by using the :unmap command. The command is
361 used in the following way (the explanation of the parameters is
362 described in the map section of this document
363 unmap [mode] <binding>
365
367 girara
368 This section describes settings concerning the behaviour of girara and
369 zathura. The settings described here can be changed with set.
370 n-completion-items
372 Defines the maximum number of displayed completion entries.
373 · Value type: Integer
375 · Default value: 15
377 completion-bg
379 Defines the background color that is used for command line completion
380 entries
381 · Value type: String
383 · Default value: #232323
385 completion-fg
387 Defines the foreground color that is used for command line completion
388 entries
389 · Value type: String
391 · Default value: #DDDDDD
393 completion-group-bg
395 Defines the background color that is used for command line completion
396 group elements
397 · Value type: String
399 · Default value: #000000
401 completion-group-fg
403 Defines the foreground color that is used for command line completion
404 group elements
405 · Value type: String
407 · Default value: #DEDEDE
409 completion-highlight-bg
411 Defines the background color that is used for the current command line
412 completion element
413 · Value type: String
415 · Default value: #9FBC00
417 completion-highlight-fg
419 Defines the foreground color that is used for the current command line
420 completion element
421 · Value type: String
423 · Default value: #232323
425 default-fg
427 Defines the default foreground color
428 · Value type: String
430 · Default value: #DDDDDD
432 default-bg
434 Defines the default background color
435 · Value type: String
437 · Default value: #000000
439 exec-command
441 Defines a command the should be prepended to any command run with exec.
442 · Value type: String
444 · Default value:
446 font
448 Defines the font that will be used
449 · Value type: String
451 · Default value: monospace normal 9
453 guioptions
455 Shows or hides GUI elements. If it contains 'c', the command line is
456 displayed. If it contains 's', the statusbar is displayed. If it con‐
457 tains 'h', the horizontal scrollbar is displayed. If it contains 'v',
458 the vertical scrollbar is displayed.
459 · Value type: String
461 · Default value: s
463 inputbar-bg
465 Defines the background color for the inputbar
466 · Value type: String
468 · Default value: #131313
470 inputbar-fg
472 Defines the foreground color for the inputbar
473 · Value type: String
475 · Default value: #9FBC00
477 notification-bg
479 Defines the background color for a notification
480 · Value type: String
482 · Default value: #FFFFFF
484 notification-fg
486 Defines the foreground color for a notification
487 · Value type: String
489 · Default value: #000000
491 notification-error-bg
493 Defines the background color for an error notification
494 · Value type: String
496 · Default value: #FFFFFF
498 notification-error-fg
500 Defines the foreground color for an error notification
501 · Value type: String
503 · Default value: #FF1212
505 notification-warning-bg
507 Defines the background color for a warning notification
508 · Value type: String
510 · Default value: #FFFFFF
512 notification-warning-fg
514 Defines the foreground color for a warning notification
515 · Value type: String
517 · Default value: #FFF712
519 tabbar-fg
521 Defines the foreground color for a tab
522 · Value type: String
524 · Default value: #FFFFFF
526 tabbar-bg
528 Defines the background color for a tab
529 · Value type: String
531 · Default value: #000000
533 tabbar-focus-fg
535 Defines the foreground color for the focused tab
536 · Value type: String
538 · Default value: #9FBC00
540 tabbar-focus-bg
542 Defines the background color for the focused tab
543 · Value type: String
545 · Default value: #000000
547 show-scrollbars
549 Defines if both the horizontal and vertical scrollbars should be shown
550 or not. Deprecated, use 'guioptions' instead.
551 · Value type: Boolean
553 · Default value: false
555 show-h-scrollbar
557 Defines whether to show/hide the horizontal scrollbar. Deprecated, use
558 'guioptions' instead.
559 · Value type: Boolean
561 · Default value: false
563 show-v-scrollbar
565 Defines whether to show/hide the vertical scrollbar. Deprecated, use
566 'guioptions' instead.
567 · Value type: Boolean
569 · Default value: false
571 statusbar-bg
573 Defines the background color of the statusbar
574 · Value type: String
576 · Default value: #000000
578 statusbar-fg
580 Defines the foreground color of the statusbar
581 · Value type: String
583 · Default value: #FFFFFF
585 statusbar-h-padding
587 Defines the horizontal padding of the statusbar and notificationbar
588 · Value type: Integer
590 · Default value: 8
592 statusbar-v-padding
594 Defines the vertical padding of the statusbar and notificationbar
595 · Value type: Integer
597 · Default value: 2
599 window-icon
601 Defines the path for a icon to be used as window icon.
602 · Value type: String
604 · Default value:
606 window-height
608 Defines the window height on startup
609 · Value type: Integer
611 · Default value: 600
613 window-width
615 Defines the window width on startup
616 · Value type: Integer
618 · Default value: 800
620 zathura
622 This section describes settings concerning the behaviour of zathura.
623 abort-clear-search
625 Defines if the search results should be cleared on abort.
626 · Value type: Boolean
628 · Default value: true
630 adjust-open
632 Defines which auto adjustment mode should be used if a document is
633 loaded. Possible options are "best-fit" and "width".
634 · Value type: String
636 · Default value: best-fit
638 advance-pages-per-row
640 Defines if the number of pages per row should be honored when advancing
641 a page.
642 · Value type: Boolean
644 · Default value: false
646 continuous-hist-save
648 Tells zathura whether to save document history at each page change or
649 only when closing a document.
650 · Value type: Boolean
652 · Default value: false
654 database
656 Defines the database backend to use for bookmarks and input history.
657 Possible values are "plain", "sqlite" (if built with sqlite support)
658 and "null". If "null" is used, bookmarks and input history will not be
659 stored.
660 · Value type: String
662 · Default value: plain
664 dbus-service
666 En/Disables the D-Bus service. If the services is disabled, SyncTeX
667 forward synchronization is not available.
668 · Value type: Boolean
670 · Default value: true
672 filemonitor
674 Defines the file monitor backend used to check for changes in files.
675 Possible values are "glib", "signal" (if signal handling is supported),
676 and "noop". The "noop" file monitor does not trigger reloads.
677 · Value type: String
679 · Default value: glib
681 incremental-search
683 En/Disables incremental search (search while typing).
684 · Value type: Boolean
686 · Default value: true
688 highlight-color
690 Defines the color that is used for highlighting parts of the document
691 (e.g.: show search results)
692 · Value type: String
694 · Default value: #9FBC00
696 highlight-active-color
698 Defines the color that is used to show the current selected highlighted
699 element (e.g: current search result)
700 · Value type: String
702 · Default value: #00BC00
704 highlight-transparency
706 Defines the opacity of a highlighted element
707 · Value type: Float
709 · Default value: 0.5
711 page-padding
713 The page padding defines the gap in pixels between each rendered page.
714 · Value type: Integer
716 · Default value: 1
718 page-cache-size
720 Defines the maximum number of pages that could be kept in the page
721 cache. When the cache is full and a new page that isn't cached becomes
722 visible, the least recently viewed page in the cache will be evicted to
723 make room for the new one. Large values for this variable are NOT rec‐
724 ommended, because this will lead to consuming a significant portion of
725 the system memory.
726 · Value type: Integer
728 · Default value: 15
730 page-thumbnail-size
732 Defines the maximum size in pixels of the thumbnail that could be kept
733 in the thumbnail cache per page. The thumbnail is scaled for a quick
734 preview during zooming before the page is rendered. When the page is
735 rendered, the result is saved as the thumbnail only if the size is no
736 more than this value. A larger value increases quality but introduces
737 longer delay in zooming and uses more system memory.
738 · Value type: Integer
740 · Default value: 4194304 (4M)
742 pages-per-row
744 Defines the number of pages that are rendered next to each other in a
745 row.
746 · Value type: Integer
748 · Default value: 1
750 first-page-column
752 Defines the column in which the first page will be displayed. This
753 setting is stored separately for every value of pages-per-row according
754 to the following pattern <1 page per row>:[<2 pages per row>[: ...]].
755 The last value in the list will be used for all other number of pages
756 per row if not set explicitly.
757 Per default, the first column is set to 2 for double-page layout, i.e.
759 the faule is set to 1:2. A value of 1:1:3 would put the first page in
760 dual-page layour in the first column, and for layouts with more columns
761 the first page would be put in the 3rd column.
762 · Value type: String
764 · Default value: 1:2
766 recolor
768 En/Disables recoloring
769 · Value type: Boolean
771 · Default value: false
773 recolor-keephue
775 En/Disables keeping original hue when recoloring
776 · Value type: Boolean
778 · Default value: false
780 recolor-darkcolor
782 Defines the color value that is used to represent dark colors in recol‐
783 oring mode
784 · Value type: String
786 · Default value: #FFFFFF
788 recolor-lightcolor
790 Defines the color value that is used to represent light colors in
791 recoloring mode
792 · Value type: String
794 · Default value: #000000
796 recolor-reverse-video
798 Defines if original image colors should be kept while recoloring.
799 · Value type: Boolean
801 · Default value: false
803 render-loading
805 Defines if the "Loading..." text should be displayed if a page is ren‐
806 dered.
807 · Value type: Boolean
809 · Default value: true
811 render-loading-bg
813 Defines the background color that is used for the "Loading..." text.
814 · Value type: String
816 · Default value: #FFFFFF
818 render-loading-fg
820 Defines the foreground color that is used for the "Loading..." text.
821 · Value type: String
823 · Default value: #000000
825 scroll-hstep
827 Defines the horizontal step size of scrolling by calling the scroll
828 command once
829 · Value type: Float
831 · Default value: -1
833 scroll-step
835 Defines the step size of scrolling by calling the scroll command once
836 · Value type: Float
838 · Default value: 40
840 scroll-full-overlap
842 Defines the proportion of the current viewing area that should be visi‐
843 ble after scrolling a full page.
844 · Value type: Float
846 · Default value: 0
848 scroll-wrap
850 Defines if the last/first page should be wrapped
851 · Value type: Boolean
853 · Default value: false
855 show-directories
857 Defines if the directories should be displayed in completion.
858 · Value type: Boolean
860 · Default value: true
862 show-hidden
864 Defines if hidden files and directories should be displayed in comple‐
865 tion.
866 · Value type: Boolean
868 · Default value: false
870 show-recent
872 Defines the number of recent files that should be displayed in comple‐
873 tion. If the value is negative, no upper bounds are applied. If the
874 value is 0, no recent files are shown.
875 · Value type: Integer
877 · Default value: 10
879 scroll-page-aware
881 Defines if scrolling by half or full pages stops at page boundaries.
882 · Value type: Boolean
884 · Default value: false
886 smooth-scroll
888 Defines if scrolling via touchpad should be smooth.
889 · Value type: Boolean
891 · Default value: false
893 link-zoom
895 En/Disables the ability of changing zoom when following links.
896 · Value type: Boolean
898 · Default value: true
900 link-hadjust
902 En/Disables aligning to the left internal link targets, for example
903 from the index.
904 · Value type: Boolean
906 · Default value: true
908 search-hadjust
910 En/Disables horizontally centered search results.
911 · Value type: Boolean
913 · Default value: true
915 window-title-basename
917 Use basename of the file in the window title.
918 · Value type: Boolean
920 · Default value: false
922 window-title-home-tilde
924 Display a short version of the file path, which replaces $HOME with ~,
925 in the window title.
926 · Value type: Boolean
928 · Default value: false
930 window-title-page
932 Display the page number in the window title.
933 · Value type: Boolean
935 · Default value: false
937 statusbar-basename
939 Use basename of the file in the statusbar.
940 · Value type: Boolean
942 · Default value: false
944 statusbar-home-tilde
946 Display a short version of the file path, which replaces $HOME with ~,
947 in the statusbar.
948 · Value type: Boolean
950 · Default value: false
952 zoom-center
954 En/Disables horizontally centered zooming.
955 · Value type: Boolean
957 · Default value: false
959 vertical-center
961 Center the screen at the vertical midpoint of the page by default.
962 · Value type: Boolean
964 · Default value: false
966 zoom-max
968 Defines the maximum percentage that the zoom level can be.
969 · Value type: Integer
971 · Default value: 1000
973 zoom-min
975 Defines the minimum percentage that the zoom level can be.
976 · Value type: Integer
978 · Default value: 10
980 zoom-step
982 Defines the amount of percent that is zoomed in or out on each command.
983 · Value type: Integer
985 · Default value: 10
987 selection-clipboard
989 Defines the X clipboard into which mouse-selected data will be written.
990 When it is "clipboard", selected data will be written to the CLIPBOARD
991 clipboard, and can be pasted using the Ctrl+v key combination. When it
992 is "primary", selected data will be written to the PRIMARY clipboard,
993 and can be pasted using the middle mouse button, or the Shift-Insert
994 key combination.
995 · Value type: String
997 · Default value: primary
999 selection-notification
1001 Defines if a notification should be displayed after selecting text.
1002 · Value type: Boolean
1004 · Default value: true
1006 synctex
1008 En/Disables SyncTeX backward synchronization support.
1009 · Value type: Boolean
1011 · Default value: true
1013 synctex-editor-command
1015 Defines the command executed for SyncTeX backward synchronization.
1016 · Value type: String
1018 · Default value:
1020 index-fg
1022 Defines the foreground color of the index mode.
1023 · Value type: String
1025 · Default value: #DDDDDD
1027 index-bg
1029 Define the background color of the index mode.
1030 · Value type: String
1032 · Default value: #232323
1034 index-active-fg
1036 Defines the foreground color of the selected element in index mode.
1037 · Value type: String
1039 · Default value: #232323
1041 index-active-bg
1043 Define the background color of the selected element in index mode.
1044 · Value type: String
1046 · Default value: #9FBC00
1048 sandbox
1050 Defines the sandbox mode to use for the seccomp syscall filter. Possi‐
1051 ble values are "none", "normal" and "strict". If "none" is used, the
1052 sandbox will be disabled. The use of "normal" will provide minimal pro‐
1053 tection and allow normal use of seccomp with support for all features.
1054 The "strict" mode is a read only sandbox that is intended for viewing
1055 documents only.
1056 · Value type: String
1058 · Default value: normal
1060 Some features are disabled when using strict sandbox mode:
1062 · saving/writing files
1064 · use of input methods like ibus
1066 · printing
1068 · bookmarks and history
1070 No feature regressions are expected when using normal sandbox mode.
1072 window-icon-document
1074 Defines whether the window document should be updated based on the
1075 first page of a dcument.
1076 · Value type: Boolean
1078 · Default value: false
1080 page-right-to-left
1082 Defines whether pages in multi-column view should start from the right
1083 side.
1084 · Value type: Boolean
1086 · Default value: false
1088
1090 zathura(1)
1091
1093 pwmt.org
1094
1096 2009-2019, pwmt.org
10970.4.3 2018-12-22 ZATHURARC(5)