zathurarc.5.rst 23 KB
Newer Older
Moritz Lipp's avatar
Moritz Lipp committed
1 2 3 4 5 6 7 8 9 10 11 12 13
=========
zathurarc
=========

SYNOPSIS
========

/etc/zathurarc, $XDG_CONFIG_HOME/zathura/zathurarc

DESCRIPTION
===========

The *zathurarc* file is a simple plain text file that can be populated with
14 15 16 17
various commands to change the behaviour and the look of zathura which we are
going to describe in the following subsections. Each line (besides empty lines
and comments (which start with a prepended #) is evaluated on its own, so it
is not possible to write multiple commands in one single line.
Moritz Lipp's avatar
Moritz Lipp committed
18

19 20 21
COMMANDS
========

22
set - Changing options
Sebastian Ramacher's avatar
Sebastian Ramacher committed
23
----------------------
24

25
In addition to the built-in ``:set`` command zathura offers more options to be
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
changed and makes those changes permanent. To overwrite an option you just have
to add a line structured like the following

::

    set <option> <new value>

The ``option`` field has to be replaced with the name of the option that should be
changed and the ``new value`` field has to be replaced with the new value the
option should get. The type of the value can be one of the following:

* INT - An integer number
* FLOAT - A floating point number
* STRING - A character string
* BOOL - A boolean value ("true" for true, "false" for false)

In addition we advice you to check the options to get a more detailed view of
the options that can be changed and which values they should be set to.

The following example should give some deeper insight of how the ``set`` command
can be used

::

    set option1 5
    set option2 2.0
    set option3 hello
    set option4 hello\ world
    set option5 "hello world"

Moritz Lipp's avatar
Moritz Lipp committed
56 57 58 59 60 61 62 63 64

If you want to use ``color codes`` for some options, make sure to quote them
accordingly or to escape the hash symbol.

::

    set default-fg "#CCBBCC"
    set default-fg \#CCBBCC

65 66 67 68 69 70 71 72 73 74
map - Mapping a shortcut
------------------------
It is possible to map or remap new key bindings to shortcut functions which
allows a high level of customization. The ``:map`` command can also be used in
the *zathurarc* file to make those changes permanent:

::

    map [mode] <binding> <shortcut function> <argument>

Sebastian Ramacher's avatar
Sebastian Ramacher committed
75 76
include - Including another config file
---------------------------------------
Sebastian Ramacher's avatar
Sebastian Ramacher committed
77 78 79
This commands allows one to include other configuration files. If a relative
path is given, the path will be resolved relative to the configuration file that
is currently processed.
Sebastian Ramacher's avatar
Sebastian Ramacher committed
80 81 82 83 84

::

    include another-config

85 86 87 88 89 90 91 92
Mode
^^^^
The ``map`` command expects several arguments where only the ``binding`` as well as
the ``shortcut-function`` argument is required. Since zathura uses several modes
it is possible to map bindings only for a specific mode by passing the ``mode``
argument which can take one of the following values:

* normal (default)
Moritz Lipp's avatar
Moritz Lipp committed
93
* fullscreen
Sebastian Ramacher's avatar
Sebastian Ramacher committed
94
* presentation
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
* index

The brackets around the value are mandatory.

Single key binding
^^^^^^^^^^^^^^^^^^
The (possible) second argument defines the used key binding that should be
mapped to the shortcut function and is structured like the following. On the one
hand it is possible to just assign single letters, numbers or signs to it:

::

    map a shortcut_function
    map b shortcut_function
    map c shortcut_function
    map 1 shortcut_function
    map 2 shortcut_function
    map 3 shortcut_function
    map ! shortcut_function
    map ? shortcut_function

Using modifiers
^^^^^^^^^^^^^^^
It is also possible to use modifiers like the Control or Alt button on the
keyboard. It is possible to use the following modifiers:

* A - Alt
* C - Control
* S - Shift

Now it is required to define the ``binding`` with the following structure:

::

    map <A-a> shortcut_function
    map <C-a> shortcut_function

Special keys
^^^^^^^^^^^^
zathura allows it also to assign keys like the space bar or the tab button which
also have to be written in between angle brackets. The following special keys
are currently available:

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
::

    Identifier Description

    BackSpace  Back space
    CapsLock   Caps lock
    Esc        Escape
    Down       Arrow down
    Up         Arrow up
    Left       Arrow left
    Right      Arrow right
    F1         F1
    F2         F2
    F3         F3
    F4         F4
    F5         F5
    F6         F6
    F7         F7
    F8         F8
    F9         F9
    F10        F10
    F11        F11
    F12        F12
    PageDown   Page Down
    PageUp     Page Up
    Return     Return
    Space      Space
165
    Super      Windows key
166
    Tab        Tab
Sebastian Ramacher's avatar
Sebastian Ramacher committed
167
    Print      Print key
168 169 170 171 172 173 174 175 176 177 178 179 180 181

Of course it is possible to combine those special keys with a modifier. The
usage of those keys should be explained by the following examples:

::

    map <Space> shortcut_function
    map <C-Space> shortcut_function

Mouse buttons
^^^^^^^^^^^^^
It is also possible to map mouse buttons to shortcuts by using the following
special keys:

182 183 184 185 186 187 188 189 190
::

    Identifier Description

    Button1    Mouse button 1
    Button2    Mouse button 2
    Button3    Mouse button 3
    Button4    Mouse button 4
    Button5    Mouse button 5
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212

They can also be combined with modifiers:

::

    map <Button1> shortcut_function
    map <C-Button1> shortcut_function

Buffer commands
^^^^^^^^^^^^^^^
If a mapping does not match one of the previous definition but is still a valid
mapping it will be mapped as a buffer command:

::

    map abc quit
    map test quit

Shortcut functions
^^^^^^^^^^^^^^^^^^
The following shortcut functions can be mapped:

213
* ``abort``
214

215 216 217 218 219 220 221 222 223 224 225 226 227 228
  Switch back to normal mode.

* ``adjust_window``

  Adjust page width. Possible arguments are ``best-fit`` and ``width``.

* ``change_mode``

  Change current mode. Pass the desired mode as argument.

* ``display_link``:

  Display link target.

Sebastian Ramacher's avatar
Sebastian Ramacher committed
229 230 231 232
* ``exec``:

  Execute an external command.

233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
* ``focus_inputbar``

  Focus inputbar.

* ``follow``

  Follow a link.

* ``goto``

  Go to a certain page.

* ``jumplist``

  Move forwards/backwards in the jumplist.

* ``navigate``

  Navigate to the next/previous page.

* ``navigate_index``

  Navigate through the index.

* ``print``

  Show the print dialog.

* ``quit``

  Quit zathura.

* ``recolor``

  Recolor pages.

* ``reload``

  Reload the document.

* ``rotate``

  Rotate the page. Pass ``rotate-ccw`` as argument for counterclockwise rotation
  and ``rotate-cw`` for clockwise rotation.

* ``scroll``

  Scroll.

* ``search``

  Search next/previous item. Pass ``forward`` as argument to search for the next
  hit and ``backward`` to search for the previous hit.

* ``set``

  Set an option.

* ``toggle_fullscreen``

  Toggle fullscreen.

* ``toggle_index``

  Show or hide index.

* ``toggle_inputbar``

  Show or hide inputbar.

* ``toggle_page_mode``

  Toggle between one and multiple pages per row.

* ``toggle_statusbar``

  Show or hide statusbar.

* ``zoom``
312

313
  Zoom in or out.
314

315 316 317 318 319 320 321
* ``mark_add``
  Set a quickmark.

* ``mark_evaluate``
  Go to a quickmark.


322 323 324 325 326
Pass arguments
^^^^^^^^^^^^^^
Some shortcut function require or have optional arguments which influence the
behaviour of them. Those can be passed as the last argument:

Sebastian Ramacher's avatar
Sebastian Ramacher committed
327 328
::

329 330 331 332 333
    map <C-i> zoom in
    map <C-o> zoom out

Possible arguments are:

334
* best-fit
335
* bottom
336 337
* collapse
* collapse-all
338 339
* default
* down
340 341
* expand
* expand-all
342 343 344 345 346 347 348 349
* full-down
* full-up
* half-down
* half-up
* in
* left
* next
* out
350 351
* page-bottom
* page-top
352 353
* previous
* right
354 355
* rotate-ccw
* rotate-cw
356
* select
357
* specific
358
* toggle
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
* top
* up
* width

unmap - Removing a shortcut
---------------------------
In addition to mapping or remaping custom key bindings it is possible to remove
existing ones by using the ``:unmap`` command. The command is used in the
following way (the explanation of the parameters is described in the ``map``
section of this document

::

    unmap [mode] <binding>


375 376
OPTIONS
=======
377 378 379

girara
------
Sebastian Ramacher's avatar
Sebastian Ramacher committed
380
This section describes settings concerning the behaviour of girara and
381 382 383 384 385 386
zathura. The settings described here can be changed with ``set``.

n-completion-items
^^^^^^^^^^^^^^^^^^
Defines the maximum number of displayed completion entries.

387
* Value type: Integer
388 389 390 391 392 393 394
* Default value: 15

completion-bg
^^^^^^^^^^^^^
Defines the background color that is used for command line completion
entries

395
* Value type: String
396 397 398 399 400 401 402
* Default value: #232323

completion-fg
^^^^^^^^^^^^^
Defines the foreground color that is used for command line completion
entries

403
* Value type: String
404 405 406 407 408 409 410
* Default value: #DDDDDD

completion-group-bg
^^^^^^^^^^^^^^^^^^^
Defines the background color that is used for command line completion
group elements

411
* Value type: String
412 413 414 415 416 417 418
* Default value: #000000

completion-group-fg
^^^^^^^^^^^^^^^^^^^
Defines the foreground color that is used for command line completion
group elements

419
* Value type: String
420 421 422 423 424 425 426
* Default value: #DEDEDE

completion-highlight-bg
^^^^^^^^^^^^^^^^^^^^^^^
Defines the background color that is used for the current command line
completion element

427
* Value type: String
428 429 430 431 432 433 434
* Default value: #9FBC00

completion-highlight-fg
^^^^^^^^^^^^^^^^^^^^^^^
Defines the foreground color that is used for the current command line
completion element

435
* Value type: String
436 437 438 439 440 441
* Default value: #232323

default-fg
^^^^^^^^^^
Defines the default foreground color

442
* Value type: String
443 444 445 446 447 448
* Default value: #DDDDDD

default-bg
^^^^^^^^^^
Defines the default background color

449
* Value type: String
450 451
* Default value: #000000

452 453
exec-command
^^^^^^^^^^^^
Sebastian Ramacher's avatar
Sebastian Ramacher committed
454
Defines a command the should be prepended to any command run with exec.
455 456 457 458

* Value type: String
* Default value:

459 460 461 462
font
^^^^
Defines the font that will be used

463
* Value type: String
464 465
* Default value: monospace normal 9

466 467 468
guioptions
^^^^^^^^^^
Shows or hides GUI elements.
469 470
If it contains 'c', the command line is displayed.
If it contains 's', the statusbar is displayed.
Robert Schütz's avatar
Robert Schütz committed
471 472
If it contains 'h', the horizontal scrollbar is displayed.
If it contains 'v', the vertical scrollbar is displayed.
473 474 475 476

* Value type: String
* Default value: s

477 478 479 480
inputbar-bg
^^^^^^^^^^^
Defines the background color for the inputbar

481
* Value type: String
482 483 484 485 486 487
* Default value: #131313

inputbar-fg
^^^^^^^^^^^
Defines the foreground color for the inputbar

488
* Value type: String
489 490
* Default value: #9FBC00

491 492 493 494 495 496 497 498 499 500 501 502 503 504
notification-bg
^^^^^^^^^^^^^^^^^^^^^
Defines the background color for a notification

* Value type: String
* Default value: #FFFFFF

notification-fg
^^^^^^^^^^^^^^^^^^^^^
Defines the foreground color for a notification

* Value type: String
* Default value: #000000

505 506 507 508
notification-error-bg
^^^^^^^^^^^^^^^^^^^^^
Defines the background color for an error notification

509
* Value type: String
510 511 512 513 514 515
* Default value: #FFFFFF

notification-error-fg
^^^^^^^^^^^^^^^^^^^^^
Defines the foreground color for an error notification

516
* Value type: String
517 518 519 520 521 522
* Default value: #FF1212

notification-warning-bg
^^^^^^^^^^^^^^^^^^^^^^^
Defines the background color for a warning notification

523
* Value type: String
524 525 526 527 528 529
* Default value: #FFFFFF

notification-warning-fg
^^^^^^^^^^^^^^^^^^^^^^^
Defines the foreground color for a warning notification

530
* Value type: String
531 532 533 534 535 536
* Default value: #FFF712

tabbar-fg
^^^^^^^^^
Defines the foreground color for a tab

537
* Value type: String
538 539 540 541 542 543
* Default value: #FFFFFF

tabbar-bg
^^^^^^^^^
Defines the background color for a tab

544
* Value type: String
545 546 547 548 549 550
* Default value: #000000

tabbar-focus-fg
^^^^^^^^^^^^^^^
Defines the foreground color for the focused tab

551
* Value type: String
552 553 554 555 556 557
* Default value: #9FBC00

tabbar-focus-bg
^^^^^^^^^^^^^^^
Defines the background color for the focused tab

558
* Value type: String
559 560 561 562
* Default value: #000000

show-scrollbars
^^^^^^^^^^^^^^^
563 564
Defines if both the horizontal and vertical scrollbars should be shown or not.
Deprecated, use 'guioptions' instead.
565 566 567 568 569 570

* Value type: Boolean
* Default value: false

show-h-scrollbar
^^^^^^^^^^^^^^^^
571 572
Defines whether to show/hide the horizontal scrollbar. Deprecated, use
'guioptions' instead.
573 574 575 576 577 578

* Value type: Boolean
* Default value: false

show-v-scrollbar
^^^^^^^^^^^^^^^^
579 580
Defines whether to show/hide the vertical scrollbar. Deprecated, use
'guioptions' instead.
581

582
* Value type: Boolean
583 584 585 586 587 588
* Default value: false

statusbar-bg
^^^^^^^^^^^^
Defines the background color of the statusbar

589
* Value type: String
590 591 592 593 594 595
* Default value: #000000

statusbar-fg
^^^^^^^^^^^^
Defines the foreground color of the statusbar

596
* Value type: String
597 598
* Default value: #FFFFFF

599 600 601 602 603 604 605 606 607 608 609 610 611 612
statusbar-h-padding
^^^^^^^^^^^^^^^^^^^
Defines the horizontal padding of the statusbar and notificationbar

* Value type: Integer
* Default value: 8

statusbar-v-padding
^^^^^^^^^^^^^^^^^^^
Defines the vertical padding of the statusbar and notificationbar

* Value type: Integer
* Default value: 2

Sebastian Ramacher's avatar
Sebastian Ramacher committed
613 614 615 616 617 618 619
window-icon
^^^^^^^^^^^
Defines the path for a icon to be used as window icon.

* Value type: String
* Default value:

620 621 622 623
window-height
^^^^^^^^^^^^^
Defines the window height on startup

624
* Value type: Integer
625 626 627 628 629 630
* Default value: 600

window-width
^^^^^^^^^^^^
Defines the window width on startup

631
* Value type: Integer
632 633 634 635 636 637 638
* Default value: 800

zathura
-------

This section describes settings concerning the behaviour of zathura.

639 640 641 642 643 644 645
abort-clear-search
^^^^^^^^^^^^^^^^^^
Defines if the search results should be cleared on abort.

* Value type: Boolean
* Default value: true

646 647 648 649 650
adjust-open
^^^^^^^^^^^
Defines which auto adjustment mode should be used if a document is loaded.
Possible options are "best-fit" and "width".

651
* Value type: String
652 653
* Default value: best-fit

654 655 656 657
advance-pages-per-row
^^^^^^^^^^^^^^^^^^^^^
Defines if the number of pages per row should be honored when advancing a page.

658
* Value type: Boolean
659 660
* Default value: false

Deven Lahoti's avatar
Deven Lahoti committed
661 662 663 664 665 666 667 668
continuous-hist-save
^^^^^^^^^^^^^^^^^^^^
Tells zathura whether to save document history at each page change or only when
closing a document.

* Value type: Boolean
* Default value: false

669 670 671 672 673 674 675 676 677
database
^^^^^^^^
Defines the database backend to use for bookmarks and input history. Possible
values are "plain", "sqlite" (if built with sqlite support) and "null". If
"null" is used, bookmarks and input history will not be stored.

* Value type: String
* Default value: plain

678
dbus-service
679
^^^^^^^^^^^^
680 681 682 683 684 685
En/Disables the D-Bus service. If the services is disabled, SyncTeX forward
synchronization is not available.

* Value type: Boolean
* Default value: true

686 687
filemonitor
^^^^^^^^^^^
688 689 690
Defines the file monitor backend used to check for changes in files. Possible
values are "glib", "signal" (if signal handling is supported), and "noop". The
"noop" file monitor does not trigger reloads.
691 692 693 694

* Value type: String
* Default value: glib

695 696 697 698 699
incremental-search
^^^^^^^^^^^^^^^^^^
En/Disables incremental search (search while typing).

* Value type: Boolean
700
* Default value: true
701

702 703 704 705 706
highlight-color
^^^^^^^^^^^^^^^
Defines the color that is used for highlighting parts of the document (e.g.:
show search results)

707
* Value type: String
708 709 710 711 712 713 714
* Default value: #9FBC00

highlight-active-color
^^^^^^^^^^^^^^^^^^^^^^
Defines the color that is used to show the current selected highlighted element
(e.g: current search result)

715
* Value type: String
716 717 718 719 720 721
* Default value: #00BC00

highlight-transparency
^^^^^^^^^^^^^^^^^^^^^^
Defines the opacity of a highlighted element

722
* Value type: Float
723 724 725 726
* Default value: 0.5

page-padding
^^^^^^^^^^^^
Sebastian Ramacher's avatar
Sebastian Ramacher committed
727
The page padding defines the gap in pixels between each rendered page.
728

729
* Value type: Integer
730 731
* Default value: 1

732 733 734 735 736 737 738
page-cache-size
^^^^^^^^^^^^^^^
Defines the maximum number of pages that could be kept in the page cache. When
the cache is full and a new page that isn't cached becomes visible, the least
recently viewed page in the cache will be evicted to make room for the new one.
Large values for this variable are NOT recommended, because this will lead to
consuming a significant portion of the system memory.
Sebastian Ramacher's avatar
Sebastian Ramacher committed
739

740
* Value type: Integer
741
* Default value: 15
Sebastian Ramacher's avatar
Sebastian Ramacher committed
742

743 744 745 746 747 748 749 750 751 752 753 754
page-thumbnail-size
^^^^^^^^^^^^^^^^^^^
Defines the maximum size in pixels of the thumbnail that could be kept in the
thumbnail cache per page. The thumbnail is scaled for a quick preview during
zooming before the page is rendered. When the page is rendered, the result is
saved as the thumbnail only if the size is no more than this value. A larger
value increases quality but introduces longer delay in zooming and uses more
system memory.

* Value type: Integer
* Default value: 4194304 (4M)

755 756 757 758
pages-per-row
^^^^^^^^^^^^^
Defines the number of pages that are rendered next to each other in a row.

759
* Value type: Integer
760 761
* Default value: 1

762 763 764
first-page-column
^^^^^^^^^^^^^^^^^
Defines the column in which the first page will be displayed.
765
This setting is stored separately for every value of pages-per-row according to
766 767
the following pattern <1 page per row>:[<2 pages per row>[: ...]]. The last
value in the list will be used for all other number of pages per row if not set
Sebastian Ramacher's avatar
Sebastian Ramacher committed
768
explicitly.
769

Sebastian Ramacher's avatar
Sebastian Ramacher committed
770 771 772 773
Per default, the first column is set to 2 for double-page layout, i.e. the faule
is set to 1:2. A value of 1:1:3 would put the first page in dual-page layour in
the first column, and for layouts with more columns the first page would be put
in the 3rd column.
774

775 776
* Value type: String
* Default value: 1:2
777

778 779 780 781
recolor
^^^^^^^
En/Disables recoloring

782
* Value type: Boolean
783 784
* Default value: false

785 786 787 788 789 790 791
recolor-keephue
^^^^^^^^^^^^^^^
En/Disables keeping original hue when recoloring

* Value type: Boolean
* Default value: false

792 793 794 795
recolor-darkcolor
^^^^^^^^^^^^^^^^^
Defines the color value that is used to represent dark colors in recoloring mode

796
* Value type: String
797 798 799 800 801 802
* Default value: #FFFFFF

recolor-lightcolor
^^^^^^^^^^^^^^^^^^
Defines the color value that is used to represent light colors in recoloring mode

803
* Value type: String
804 805
* Default value: #000000

Sebastian Ramacher's avatar
Sebastian Ramacher committed
806 807 808 809 810 811 812
recolor-reverse-video
^^^^^^^^^^^^^^^^^^^^^
Defines if original image colors should be kept while recoloring.

* Value type: Boolean
* Default value: false

813 814 815 816
render-loading
^^^^^^^^^^^^^^
Defines if the "Loading..." text should be displayed if a page is rendered.

817
* Value type: Boolean
818 819
* Default value: true

820 821 822 823 824 825 826 827 828 829 830 831 832 833
render-loading-bg
^^^^^^^^^^^^^^^^^
Defines the background color that is used for the "Loading..." text.

* Value type: String
* Default value: #FFFFFF

render-loading-fg
^^^^^^^^^^^^^^^^^
Defines the foreground color that is used for the "Loading..." text.

* Value type: String
* Default value: #000000

Julian Orth's avatar
Julian Orth committed
834 835 836 837
scroll-hstep
^^^^^^^^^^^^
Defines the horizontal step size of scrolling by calling the scroll command once

838
* Value type: Float
Julian Orth's avatar
Julian Orth committed
839 840
* Default value: -1

841 842 843 844
scroll-step
^^^^^^^^^^^
Defines the step size of scrolling by calling the scroll command once

845
* Value type: Float
846 847
* Default value: 40

848 849 850 851 852 853
scroll-full-overlap
^^^^^^^^^^^^^^^^^^^
Defines the proportion of the current viewing area that should be
visible after scrolling a full page.

* Value type: Float
854
* Default value: 0
855

856 857 858 859
scroll-wrap
^^^^^^^^^^^
Defines if the last/first page should be wrapped

860
* Value type: Boolean
861 862
* Default value: false

863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879

show-directories
^^^^^^^^^^^^^^^^
Defines if the directories should be displayed in completion.

* Value type: Boolean
* Default value: true

show-hidden
^^^^^^^^^^^
Defines if hidden files and directories should be displayed in completion.

* Value type: Boolean
* Default value: false

show-recent
^^^^^^^^^^^
880 881 882
Defines the number of recent files that should be displayed in completion.
If the value is negative, no upper bounds are applied. If the value is 0, no
recent files are shown.
883

884 885
* Value type: Integer
* Default value: 10
886

887 888 889 890 891 892 893
scroll-page-aware
^^^^^^^^^^^^^^^^^
Defines if scrolling by half or full pages stops at page boundaries.

* Value type: Boolean
* Default value: false

894 895
smooth-scroll
^^^^^^^^^^^^^
Sebastian Ramacher's avatar
Sebastian Ramacher committed
896
Defines if scrolling via touchpad should be smooth.
897 898 899 900

* Value type: Boolean
* Default value: false

901 902
link-zoom
^^^^^^^^^
Sebastian Ramacher's avatar
Sebastian Ramacher committed
903
En/Disables the ability of changing zoom when following links.
904 905 906 907

* Value type: Boolean
* Default value: true

908 909
link-hadjust
^^^^^^^^^^^^
Sebastian Ramacher's avatar
Sebastian Ramacher committed
910 911
En/Disables aligning to the left internal link targets, for example from the
index.
912 913 914 915

* Value type: Boolean
* Default value: true

Julian Orth's avatar
Julian Orth committed
916 917
search-hadjust
^^^^^^^^^^^^^^
Sebastian Ramacher's avatar
Sebastian Ramacher committed
918
En/Disables horizontally centered search results.
Julian Orth's avatar
Julian Orth committed
919

920
* Value type: Boolean
Julian Orth's avatar
Julian Orth committed
921 922
* Default value: true

923 924 925 926 927 928 929
window-title-basename
^^^^^^^^^^^^^^^^^^^^^
Use basename of the file in the window title.

* Value type: Boolean
* Default value: false

930 931 932 933 934 935 936
window-title-home-tilde
^^^^^^^^^^^^^^^^^^^^^^^
Display a short version of the file path, which replaces $HOME with ~, in the window title.

* Value type: Boolean
* Default value: false

937 938 939 940 941 942 943
window-title-page
^^^^^^^^^^^^^^^^^
Display the page number in the window title.

* Value type: Boolean
* Default value: false

944 945 946 947 948 949 950
statusbar-basename
^^^^^^^^^^^^^^^^^^
Use basename of the file in the statusbar.

* Value type: Boolean
* Default value: false

951 952 953 954 955 956 957
statusbar-home-tilde
^^^^^^^^^^^^^^^^^^^^
Display a short version of the file path, which replaces $HOME with ~, in the statusbar.

* Value type: Boolean
* Default value: false

Julian Orth's avatar
Julian Orth committed
958 959
zoom-center
^^^^^^^^^^^
Sebastian Ramacher's avatar
Sebastian Ramacher committed
960
En/Disables horizontally centered zooming.
Julian Orth's avatar
Julian Orth committed
961

962
* Value type: Boolean
963
* Default value: false
Julian Orth's avatar
Julian Orth committed
964

Deven Lahoti's avatar
Deven Lahoti committed
965
vertical-center
Sebastian Ramacher's avatar
Sebastian Ramacher committed
966
^^^^^^^^^^^^^^^
Deven Lahoti's avatar
Deven Lahoti committed
967 968 969 970 971
Center the screen at the vertical midpoint of the page by default.

* Value type: Boolean
* Default value: false

972 973
zoom-max
^^^^^^^^
Sebastian Ramacher's avatar
Sebastian Ramacher committed
974
Defines the maximum percentage that the zoom level can be.
975

976
* Value type: Integer
977 978 979 980
* Default value: 1000

zoom-min
^^^^^^^^
Sebastian Ramacher's avatar
Sebastian Ramacher committed
981
Defines the minimum percentage that the zoom level can be.
982

983
* Value type: Integer
984 985 986 987
* Default value: 10

zoom-step
^^^^^^^^^
Sebastian Ramacher's avatar
Sebastian Ramacher committed
988
Defines the amount of percent that is zoomed in or out on each command.
989

990
* Value type: Integer
991
* Default value: 10
Moritz Lipp's avatar
Moritz Lipp committed
992

993 994
selection-clipboard
^^^^^^^^^^^^^^^^^^^
Sebastian Ramacher's avatar
Sebastian Ramacher committed
995
Defines the X clipboard into which mouse-selected data will be written.  When it
996 997 998 999 1000 1001
is "clipboard", selected data will be written to the CLIPBOARD clipboard, and
can be pasted using the Ctrl+v key combination.  When it is "primary", selected
data will be written to the PRIMARY clipboard, and can be pasted using the
middle mouse button, or the Shift-Insert key combination.

* Value type: String
1002
* Default value: primary
1003

1004 1005 1006 1007 1008 1009 1010
selection-notification
^^^^^^^^^^^^^^^^^^^^^^
Defines if a notification should be displayed after selecting text.

* Value type: Boolean
* Default value: true

1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
synctex
^^^^^^^
En/Disables SyncTeX backward synchronization support.

* Value type: Boolean
* Default value: true

synctex-editor-command
^^^^^^^^^^^^^^^^^^^^^^
Defines the command executed for SyncTeX backward synchronization.

* Value type: String
* Default value:

1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
index-fg
^^^^^^^^
Defines the foreground color of the index mode.

* Value type: String
* Default value: #DDDDDD

index-bg
^^^^^^^^
Define the background color of the index mode.

* Value type: String
* Default value: #232323

index-active-fg
^^^^^^^^^^^^^^^
Defines the foreground color of the selected element in index mode.

* Value type: String
* Default value: #232323

index-active-bg
^^^^^^^^^^^^^^^
Define the background color of the selected element in index mode.

* Value type: String
* Default value: #9FBC00

valoq's avatar
valoq committed
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
sandbox
^^^^^^^
Defines the sandbox mode to use for the seccomp syscall filter. Possible
values are "none", "normal" and "strict". If "none" is used, the sandbox
will be disabled. The use of "normal" will provide minimal protection and
allow normal use of seccomp with support for all features. The "strict" mode
is a read only sandbox that is intended for viewing documents only.

* Value type: String
* Default value: normal
1063

Sebastian Ramacher's avatar
Sebastian Ramacher committed
1064 1065 1066 1067 1068 1069 1070 1071
Some features are disabled when using strict sandbox mode:

* saving/writing files
* use of input methods like ibus
* printing
* bookmarks and history

No feature regressions are expected when using normal sandbox mode.
1072

1073 1074 1075 1076 1077 1078
window-icon-document
^^^^^^^^^^^^^^^^^^^^
Defines whether the window document should be updated based on the first page of
a dcument.

* Value type: Boolean
1079 1080 1081 1082 1083 1084 1085 1086
* Default value: false

page-right-to-left
^^^^^^^^^^^^^^^^^^
Defines whether pages in multi-column view should start from the right side.

* Value type: Boolean
* Default value: false
1087

Moritz Lipp's avatar
Moritz Lipp committed
1088 1089 1090 1091
SEE ALSO
========

zathura(1)