extra/zathura/files/zathurarc.5

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .TH "ZATHURARC" "5" "2019-09-08" "0.4.4" "zathura"
   4 .SH NAME
   5 zathurarc \- zathura configuration file
   6 .
   7 .nr rst2man-indent-level 0
   8 .
   9 .de1 rstReportMargin
  10 \\$1 \\n[an-margin]
  11 level \\n[rst2man-indent-level]
  12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  13 -
  14 \\n[rst2man-indent0]
  15 \\n[rst2man-indent1]
  16 \\n[rst2man-indent2]
  17 ..
  18 .de1 INDENT
  19 .\" .rstReportMargin pre:
  20 . RS \\$1
  21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  22 . nr rst2man-indent-level +1
  23 .\" .rstReportMargin post:
  24 ..
  25 .de UNINDENT
  26 . RE
  27 .\" indent \\n[an-margin]
  28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .nr rst2man-indent-level -1
  30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  32 ..
  33 .SH SYNOPSIS
  34 .sp
  35 /etc/zathurarc, $XDG_CONFIG_HOME/zathura/zathurarc
  36 .SH DESCRIPTION
  37 .sp
  38 The \fIzathurarc\fP file is a simple plain text file that can be populated with
  39 various commands to change the behaviour and the look of zathura which we are
  40 going to describe in the following subsections. Each line (besides empty lines
  41 and comments (which start with a prepended #) is evaluated on its own, so it
  42 is not possible to write multiple commands in one single line.
  43 .SH COMMANDS
  44 .SS set \- Changing options
  45 .sp
  46 In addition to the built\-in \fB:set\fP command zathura offers more options to be
  47 changed and makes those changes permanent. To overwrite an option you just have
  48 to add a line structured like the following
  49 .INDENT 0.0
  50 .INDENT 3.5
  51 .sp
  52 .nf
  53 .ft C
  54 set <option> <new value>
  55 .ft P
  56 .fi
  57 .UNINDENT
  58 .UNINDENT
  59 .sp
  60 The \fBoption\fP field has to be replaced with the name of the option that should be
  61 changed and the \fBnew value\fP field has to be replaced with the new value the
  62 option should get. The type of the value can be one of the following:
  63 .INDENT 0.0
  64 .IP \(bu 2
  65 INT \- An integer number
  66 .IP \(bu 2
  67 FLOAT \- A floating point number
  68 .IP \(bu 2
  69 STRING \- A character string
  70 .IP \(bu 2
  71 BOOL \- A boolean value ("true" for true, "false" for false)
  72 .UNINDENT
  73 .sp
  74 In addition we advice you to check the options to get a more detailed view of
  75 the options that can be changed and which values they should be set to.
  76 .sp
  77 The following example should give some deeper insight of how the \fBset\fP command
  78 can be used
  79 .INDENT 0.0
  80 .INDENT 3.5
  81 .sp
  82 .nf
  83 .ft C
  84 set option1 5
  85 set option2 2.0
  86 set option3 hello
  87 set option4 hello\e world
  88 set option5 "hello world"
  89 .ft P
  90 .fi
  91 .UNINDENT
  92 .UNINDENT
  93 .sp
  94 If you want to use \fBcolor codes\fP for some options, make sure to quote them
  95 accordingly or to escape the hash symbol.
  96 .INDENT 0.0
  97 .INDENT 3.5
  98 .sp
  99 .nf
 100 .ft C
 101 set default\-fg "#CCBBCC"
 102 set default\-fg \e#CCBBCC
 103 .ft P
 104 .fi
 105 .UNINDENT
 106 .UNINDENT
 107 .SS include \- Including another config file
 108 .sp
 109 This commands allows one to include other configuration files. If a relative
 110 path is given, the path will be resolved relative to the configuration file that
 111 is currently processed.
 112 .INDENT 0.0
 113 .INDENT 3.5
 114 .sp
 115 .nf
 116 .ft C
 117 include another\-config
 118 .ft P
 119 .fi
 120 .UNINDENT
 121 .UNINDENT
 122 .SS map \- Mapping a shortcut
 123 .sp
 124 It is possible to map or remap new key bindings to shortcut functions which
 125 allows a high level of customization. The \fB:map\fP command can also be used in
 126 the \fIzathurarc\fP file to make those changes permanent:
 127 .INDENT 0.0
 128 .INDENT 3.5
 129 .sp
 130 .nf
 131 .ft C
 132 map [mode] <binding> <shortcut function> <argument>
 133 .ft P
 134 .fi
 135 .UNINDENT
 136 .UNINDENT
 137 .SS Mode
 138 .sp
 139 The \fBmap\fP command expects several arguments where only the \fBbinding\fP as well as
 140 the \fBshortcut\-function\fP argument is required. Since zathura uses several modes
 141 it is possible to map bindings only for a specific mode by passing the \fBmode\fP
 142 argument which can take one of the following values:
 143 .INDENT 0.0
 144 .IP \(bu 2
 145 normal (default)
 146 .IP \(bu 2
 147 fullscreen
 148 .IP \(bu 2
 149 presentation
 150 .IP \(bu 2
 151 index
 152 .UNINDENT
 153 .sp
 154 The brackets around the value are mandatory.
 155 .SS Single key binding
 156 .sp
 157 The (possible) second argument defines the used key binding that should be
 158 mapped to the shortcut function and is structured like the following. On the one
 159 hand it is possible to just assign single letters, numbers or signs to it:
 160 .INDENT 0.0
 161 .INDENT 3.5
 162 .sp
 163 .nf
 164 .ft C
 165 map a shortcut_function optional_argument
 166 map b shortcut_function optional_argument
 167 map c shortcut_function optional_argument
 168 map 1 shortcut_function optional_argument
 169 map 2 shortcut_function optional_argument
 170 map 3 shortcut_function optional_argument
 171 map ! shortcut_function optional_argument
 172 map ? shortcut_function optional_argument
 173 .ft P
 174 .fi
 175 .UNINDENT
 176 .UNINDENT
 177 .SS Using modifiers
 178 .sp
 179 It is also possible to use modifiers like the Control or Alt button on the
 180 keyboard. It is possible to use the following modifiers:
 181 .INDENT 0.0
 182 .IP \(bu 2
 183 A \- Alt
 184 .IP \(bu 2
 185 C \- Control
 186 .IP \(bu 2
 187 S \- Shift
 188 .UNINDENT
 189 .sp
 190 If any of the modifiers should be used for a binding, it is required to define
 191 the \fBbinding\fP with the following structure:
 192 .INDENT 0.0
 193 .INDENT 3.5
 194 .sp
 195 .nf
 196 .ft C
 197 map <A\-a> shortcut_function
 198 map <C\-a> shortcut_function
 199 .ft P
 200 .fi
 201 .UNINDENT
 202 .UNINDENT
 203 .SS Special keys
 204 .sp
 205 zathura allows it also to assign keys like the space bar or the tab button which
 206 also have to be written in between angle brackets. The following special keys
 207 are currently available:
 208 .INDENT 0.0
 209 .INDENT 3.5
 210 .sp
 211 .nf
 212 .ft C
 213 Identifier Description
 214
 215 BackSpace  Back space
 216 CapsLock   Caps lock
 217 Esc        Escape
 218 Down       Arrow down
 219 Up         Arrow up
 220 Left       Arrow left
 221 Right      Arrow right
 222 F1         F1
 223 F2         F2
 224 F3         F3
 225 F4         F4
 226 F5         F5
 227 F6         F6
 228 F7         F7
 229 F8         F8
 230 F9         F9
 231 F10        F10
 232 F11        F11
 233 F12        F12
 234 PageDown   Page Down
 235 PageUp     Page Up
 236 Return     Return
 237 Space      Space
 238 Super      Windows key
 239 Tab        Tab
 240 Print      Print key
 241 .ft P
 242 .fi
 243 .UNINDENT
 244 .UNINDENT
 245 .sp
 246 Of course it is possible to combine those special keys with a modifier. The
 247 usage of those keys should be explained by the following examples:
 248 .INDENT 0.0
 249 .INDENT 3.5
 250 .sp
 251 .nf
 252 .ft C
 253 map <Space> shortcut_function
 254 map <C\-Space> shortcut_function
 255 .ft P
 256 .fi
 257 .UNINDENT
 258 .UNINDENT
 259 .SS Mouse buttons
 260 .sp
 261 It is also possible to map mouse buttons to shortcuts by using the following
 262 special keys:
 263 .INDENT 0.0
 264 .INDENT 3.5
 265 .sp
 266 .nf
 267 .ft C
 268 Identifier Description
 269
 270 Button1    Mouse button 1
 271 Button2    Mouse button 2
 272 Button3    Mouse button 3
 273 Button4    Mouse button 4
 274 Button5    Mouse button 5
 275 .ft P
 276 .fi
 277 .UNINDENT
 278 .UNINDENT
 279 .sp
 280 They can also be combined with modifiers:
 281 .INDENT 0.0
 282 .INDENT 3.5
 283 .sp
 284 .nf
 285 .ft C
 286 map <Button1> shortcut_function
 287 map <C\-Button1> shortcut_function
 288 .ft P
 289 .fi
 290 .UNINDENT
 291 .UNINDENT
 292 .SS Buffer commands
 293 .sp
 294 If a mapping does not match one of the previous definition but is still a valid
 295 mapping it will be mapped as a buffer command:
 296 .INDENT 0.0
 297 .INDENT 3.5
 298 .sp
 299 .nf
 300 .ft C
 301 map abc quit
 302 map test quit
 303 .ft P
 304 .fi
 305 .UNINDENT
 306 .UNINDENT
 307 .SS Shortcut functions
 308 .sp
 309 The following shortcut functions can be mapped:
 310 .INDENT 0.0
 311 .IP \(bu 2
 312 \fBabort\fP
 313 .sp
 314 Switch back to normal mode.
 315 .IP \(bu 2
 316 \fBadjust_window\fP
 317 .sp
 318 Adjust page width. Possible arguments are \fBbest\-fit\fP and \fBwidth\fP\&.
 319 .IP \(bu 2
 320 \fBchange_mode\fP
 321 .sp
 322 Change current mode. Pass the desired mode as argument.
 323 .IP \(bu 2
 324 \fBdisplay_link\fP:
 325 .sp
 326 Display link target.
 327 .IP \(bu 2
 328 \fBexec\fP:
 329 .sp
 330 Execute an external command.
 331 .IP \(bu 2
 332 \fBfocus_inputbar\fP
 333 .sp
 334 Focus inputbar.
 335 .IP \(bu 2
 336 \fBfollow\fP
 337 .sp
 338 Follow a link.
 339 .IP \(bu 2
 340 \fBgoto\fP
 341 .sp
 342 Go to a certain page.
 343 .IP \(bu 2
 344 \fBjumplist\fP
 345 .sp
 346 Move forwards/backwards in the jumplist. Pass \fBforward\fP as argument to
 347 move to the next entry and \fBbackward\fP to move to the previous one.
 348 .IP \(bu 2
 349 \fBnavigate\fP
 350 .sp
 351 Navigate to the next/previous page.
 352 .IP \(bu 2
 353 \fBnavigate_index\fP
 354 .sp
 355 Navigate through the index.
 356 .IP \(bu 2
 357 \fBprint\fP
 358 .sp
 359 Show the print dialog.
 360 .IP \(bu 2
 361 \fBquit\fP
 362 .sp
 363 Quit zathura.
 364 .IP \(bu 2
 365 \fBrecolor\fP
 366 .sp
 367 Recolor pages.
 368 .IP \(bu 2
 369 \fBreload\fP
 370 .sp
 371 Reload the document.
 372 .IP \(bu 2
 373 \fBrotate\fP
 374 .sp
 375 Rotate the page. Pass \fBrotate\-ccw\fP as argument for counterclockwise rotation
 376 and \fBrotate\-cw\fP for clockwise rotation.
 377 .IP \(bu 2
 378 \fBscroll\fP
 379 .sp
 380 Scroll.
 381 .IP \(bu 2
 382 \fBsearch\fP
 383 .sp
 384 Search next/previous item. Pass \fBforward\fP as argument to search for the next
 385 hit and \fBbackward\fP to search for the previous hit.
 386 .IP \(bu 2
 387 \fBset\fP
 388 .sp
 389 Set an option.
 390 .IP \(bu 2
 391 \fBtoggle_fullscreen\fP
 392 .sp
 393 Toggle fullscreen.
 394 .IP \(bu 2
 395 \fBtoggle_index\fP
 396 .sp
 397 Show or hide index.
 398 .IP \(bu 2
 399 \fBtoggle_inputbar\fP
 400 .sp
 401 Show or hide inputbar.
 402 .IP \(bu 2
 403 \fBtoggle_page_mode\fP
 404 .sp
 405 Toggle between one and multiple pages per row.
 406 .IP \(bu 2
 407 \fBtoggle_statusbar\fP
 408 .sp
 409 Show or hide statusbar.
 410 .IP \(bu 2
 411 \fBzoom\fP
 412 .sp
 413 Zoom in or out.
 414 .IP \(bu 2
 415 \fBmark_add\fP
 416 .sp
 417 Set a quickmark.
 418 .IP \(bu 2
 419 \fBmark_evaluate\fP
 420 .sp
 421 Go to a quickmark.
 422 .IP \(bu 2
 423 \fBfeedkeys\fP
 424 .sp
 425 Simulate key presses. Note that all keys will be interpreted as if pressing a
 426 key on the keyboard. To input uppercase letters, follow the same convention as
 427 for key bindings, i.e. for \fBX\fP, use \fB<S\-X>\fP\&.
 428 .UNINDENT
 429 .SS Pass arguments
 430 .sp
 431 Some shortcut function require or have optional arguments which influence the
 432 behaviour of them. Those can be passed as the last argument:
 433 .INDENT 0.0
 434 .INDENT 3.5
 435 .sp
 436 .nf
 437 .ft C
 438 map <C\-i> zoom in
 439 map <C\-o> zoom out
 440 .ft P
 441 .fi
 442 .UNINDENT
 443 .UNINDENT
 444 .sp
 445 Possible arguments are:
 446 .INDENT 0.0
 447 .IP \(bu 2
 448 best\-fit
 449 .IP \(bu 2
 450 bottom
 451 .IP \(bu 2
 452 backward
 453 .IP \(bu 2
 454 collapse
 455 .IP \(bu 2
 456 collapse\-all
 457 .IP \(bu 2
 458 default
 459 .IP \(bu 2
 460 down
 461 .IP \(bu 2
 462 expand
 463 .IP \(bu 2
 464 expand\-all
 465 .IP \(bu 2
 466 forward
 467 .IP \(bu 2
 468 full\-down
 469 .IP \(bu 2
 470 full\-up
 471 .IP \(bu 2
 472 half\-down
 473 .IP \(bu 2
 474 half\-up
 475 .IP \(bu 2
 476 in
 477 .IP \(bu 2
 478 left
 479 .IP \(bu 2
 480 next
 481 .IP \(bu 2
 482 out
 483 .IP \(bu 2
 484 page\-bottom
 485 .IP \(bu 2
 486 page\-top
 487 .IP \(bu 2
 488 previous
 489 .IP \(bu 2
 490 right
 491 .IP \(bu 2
 492 rotate\-ccw
 493 .IP \(bu 2
 494 rotate\-cw
 495 .IP \(bu 2
 496 select
 497 .IP \(bu 2
 498 specific
 499 .IP \(bu 2
 500 toggle
 501 .IP \(bu 2
 502 top
 503 .IP \(bu 2
 504 up
 505 .IP \(bu 2
 506 width
 507 .UNINDENT
 508 .SS unmap \- Removing a shortcut
 509 .sp
 510 In addition to mapping or remaping custom key bindings it is possible to remove
 511 existing ones by using the \fB:unmap\fP command. The command is used in the
 512 following way (the explanation of the parameters is described in the \fBmap\fP
 513 section of this document
 514 .INDENT 0.0
 515 .INDENT 3.5
 516 .sp
 517 .nf
 518 .ft C
 519 unmap [mode] <binding>
 520 .ft P
 521 .fi
 522 .UNINDENT
 523 .UNINDENT
 524 .SH OPTIONS
 525 .SS girara
 526 .sp
 527 This section describes settings concerning the behaviour of girara and
 528 zathura. The settings described here can be changed with \fBset\fP\&.
 529 .SS n\-completion\-items
 530 .sp
 531 Defines the maximum number of displayed completion entries.
 532 .INDENT 0.0
 533 .IP \(bu 2
 534 Value type: Integer
 535 .IP \(bu 2
 536 Default value: 15
 537 .UNINDENT
 538 .SS completion\-bg
 539 .sp
 540 Defines the background color that is used for command line completion
 541 entries
 542 .INDENT 0.0
 543 .IP \(bu 2
 544 Value type: String
 545 .IP \(bu 2
 546 Default value: #232323
 547 .UNINDENT
 548 .SS completion\-fg
 549 .sp
 550 Defines the foreground color that is used for command line completion
 551 entries
 552 .INDENT 0.0
 553 .IP \(bu 2
 554 Value type: String
 555 .IP \(bu 2
 556 Default value: #DDDDDD
 557 .UNINDENT
 558 .SS completion\-group\-bg
 559 .sp
 560 Defines the background color that is used for command line completion
 561 group elements
 562 .INDENT 0.0
 563 .IP \(bu 2
 564 Value type: String
 565 .IP \(bu 2
 566 Default value: #000000
 567 .UNINDENT
 568 .SS completion\-group\-fg
 569 .sp
 570 Defines the foreground color that is used for command line completion
 571 group elements
 572 .INDENT 0.0
 573 .IP \(bu 2
 574 Value type: String
 575 .IP \(bu 2
 576 Default value: #DEDEDE
 577 .UNINDENT
 578 .SS completion\-highlight\-bg
 579 .sp
 580 Defines the background color that is used for the current command line
 581 completion element
 582 .INDENT 0.0
 583 .IP \(bu 2
 584 Value type: String
 585 .IP \(bu 2
 586 Default value: #9FBC00
 587 .UNINDENT
 588 .SS completion\-highlight\-fg
 589 .sp
 590 Defines the foreground color that is used for the current command line
 591 completion element
 592 .INDENT 0.0
 593 .IP \(bu 2
 594 Value type: String
 595 .IP \(bu 2
 596 Default value: #232323
 597 .UNINDENT
 598 .SS default\-fg
 599 .sp
 600 Defines the default foreground color
 601 .INDENT 0.0
 602 .IP \(bu 2
 603 Value type: String
 604 .IP \(bu 2
 605 Default value: #DDDDDD
 606 .UNINDENT
 607 .SS default\-bg
 608 .sp
 609 Defines the default background color
 610 .INDENT 0.0
 611 .IP \(bu 2
 612 Value type: String
 613 .IP \(bu 2
 614 Default value: #000000
 615 .UNINDENT
 616 .SS exec\-command
 617 .sp
 618 Defines a command the should be prepended to any command run with exec.
 619 .INDENT 0.0
 620 .IP \(bu 2
 621 Value type: String
 622 .IP \(bu 2
 623 Default value:
 624 .UNINDENT
 625 .SS font
 626 .sp
 627 Defines the font that will be used
 628 .INDENT 0.0
 629 .IP \(bu 2
 630 Value type: String
 631 .IP \(bu 2
 632 Default value: monospace normal 9
 633 .UNINDENT
 634 .SS guioptions
 635 .sp
 636 Shows or hides GUI elements.
 637 If it contains \(aqc\(aq, the command line is displayed.
 638 If it contains \(aqs\(aq, the statusbar is displayed.
 639 If it contains \(aqh\(aq, the horizontal scrollbar is displayed.
 640 If it contains \(aqv\(aq, the vertical scrollbar is displayed.
 641 .INDENT 0.0
 642 .IP \(bu 2
 643 Value type: String
 644 .IP \(bu 2
 645 Default value: s
 646 .UNINDENT
 647 .SS inputbar\-bg
 648 .sp
 649 Defines the background color for the inputbar
 650 .INDENT 0.0
 651 .IP \(bu 2
 652 Value type: String
 653 .IP \(bu 2
 654 Default value: #131313
 655 .UNINDENT
 656 .SS inputbar\-fg
 657 .sp
 658 Defines the foreground color for the inputbar
 659 .INDENT 0.0
 660 .IP \(bu 2
 661 Value type: String
 662 .IP \(bu 2
 663 Default value: #9FBC00
 664 .UNINDENT
 665 .SS notification\-bg
 666 .sp
 667 Defines the background color for a notification
 668 .INDENT 0.0
 669 .IP \(bu 2
 670 Value type: String
 671 .IP \(bu 2
 672 Default value: #FFFFFF
 673 .UNINDENT
 674 .SS notification\-fg
 675 .sp
 676 Defines the foreground color for a notification
 677 .INDENT 0.0
 678 .IP \(bu 2
 679 Value type: String
 680 .IP \(bu 2
 681 Default value: #000000
 682 .UNINDENT
 683 .SS notification\-error\-bg
 684 .sp
 685 Defines the background color for an error notification
 686 .INDENT 0.0
 687 .IP \(bu 2
 688 Value type: String
 689 .IP \(bu 2
 690 Default value: #FFFFFF
 691 .UNINDENT
 692 .SS notification\-error\-fg
 693 .sp
 694 Defines the foreground color for an error notification
 695 .INDENT 0.0
 696 .IP \(bu 2
 697 Value type: String
 698 .IP \(bu 2
 699 Default value: #FF1212
 700 .UNINDENT
 701 .SS notification\-warning\-bg
 702 .sp
 703 Defines the background color for a warning notification
 704 .INDENT 0.0
 705 .IP \(bu 2
 706 Value type: String
 707 .IP \(bu 2
 708 Default value: #FFFFFF
 709 .UNINDENT
 710 .SS notification\-warning\-fg
 711 .sp
 712 Defines the foreground color for a warning notification
 713 .INDENT 0.0
 714 .IP \(bu 2
 715 Value type: String
 716 .IP \(bu 2
 717 Default value: #FFF712
 718 .UNINDENT
 719 .SS tabbar\-fg
 720 .sp
 721 Defines the foreground color for a tab
 722 .INDENT 0.0
 723 .IP \(bu 2
 724 Value type: String
 725 .IP \(bu 2
 726 Default value: #FFFFFF
 727 .UNINDENT
 728 .SS tabbar\-bg
 729 .sp
 730 Defines the background color for a tab
 731 .INDENT 0.0
 732 .IP \(bu 2
 733 Value type: String
 734 .IP \(bu 2
 735 Default value: #000000
 736 .UNINDENT
 737 .SS tabbar\-focus\-fg
 738 .sp
 739 Defines the foreground color for the focused tab
 740 .INDENT 0.0
 741 .IP \(bu 2
 742 Value type: String
 743 .IP \(bu 2
 744 Default value: #9FBC00
 745 .UNINDENT
 746 .SS tabbar\-focus\-bg
 747 .sp
 748 Defines the background color for the focused tab
 749 .INDENT 0.0
 750 .IP \(bu 2
 751 Value type: String
 752 .IP \(bu 2
 753 Default value: #000000
 754 .UNINDENT
 755 .SS show\-scrollbars
 756 .sp
 757 Defines if both the horizontal and vertical scrollbars should be shown or not.
 758 Deprecated, use \(aqguioptions\(aq instead.
 759 .INDENT 0.0
 760 .IP \(bu 2
 761 Value type: Boolean
 762 .IP \(bu 2
 763 Default value: false
 764 .UNINDENT
 765 .SS show\-h\-scrollbar
 766 .sp
 767 Defines whether to show/hide the horizontal scrollbar. Deprecated, use
 768 \(aqguioptions\(aq instead.
 769 .INDENT 0.0
 770 .IP \(bu 2
 771 Value type: Boolean
 772 .IP \(bu 2
 773 Default value: false
 774 .UNINDENT
 775 .SS show\-v\-scrollbar
 776 .sp
 777 Defines whether to show/hide the vertical scrollbar. Deprecated, use
 778 \(aqguioptions\(aq instead.
 779 .INDENT 0.0
 780 .IP \(bu 2
 781 Value type: Boolean
 782 .IP \(bu 2
 783 Default value: false
 784 .UNINDENT
 785 .SS statusbar\-bg
 786 .sp
 787 Defines the background color of the statusbar
 788 .INDENT 0.0
 789 .IP \(bu 2
 790 Value type: String
 791 .IP \(bu 2
 792 Default value: #000000
 793 .UNINDENT
 794 .SS statusbar\-fg
 795 .sp
 796 Defines the foreground color of the statusbar
 797 .INDENT 0.0
 798 .IP \(bu 2
 799 Value type: String
 800 .IP \(bu 2
 801 Default value: #FFFFFF
 802 .UNINDENT
 803 .SS statusbar\-h\-padding
 804 .sp
 805 Defines the horizontal padding of the statusbar and notificationbar
 806 .INDENT 0.0
 807 .IP \(bu 2
 808 Value type: Integer
 809 .IP \(bu 2
 810 Default value: 8
 811 .UNINDENT
 812 .SS statusbar\-v\-padding
 813 .sp
 814 Defines the vertical padding of the statusbar and notificationbar
 815 .INDENT 0.0
 816 .IP \(bu 2
 817 Value type: Integer
 818 .IP \(bu 2
 819 Default value: 2
 820 .UNINDENT
 821 .SS window\-icon
 822 .sp
 823 Defines the path for a icon to be used as window icon.
 824 .INDENT 0.0
 825 .IP \(bu 2
 826 Value type: String
 827 .IP \(bu 2
 828 Default value:
 829 .UNINDENT
 830 .SS window\-height
 831 .sp
 832 Defines the window height on startup
 833 .INDENT 0.0
 834 .IP \(bu 2
 835 Value type: Integer
 836 .IP \(bu 2
 837 Default value: 600
 838 .UNINDENT
 839 .SS window\-width
 840 .sp
 841 Defines the window width on startup
 842 .INDENT 0.0
 843 .IP \(bu 2
 844 Value type: Integer
 845 .IP \(bu 2
 846 Default value: 800
 847 .UNINDENT
 848 .SS zathura
 849 .sp
 850 This section describes settings concerning the behaviour of zathura.
 851 .SS abort\-clear\-search
 852 .sp
 853 Defines if the search results should be cleared on abort.
 854 .INDENT 0.0
 855 .IP \(bu 2
 856 Value type: Boolean
 857 .IP \(bu 2
 858 Default value: true
 859 .UNINDENT
 860 .SS adjust\-open
 861 .sp
 862 Defines which auto adjustment mode should be used if a document is loaded.
 863 Possible options are "best\-fit" and "width".
 864 .INDENT 0.0
 865 .IP \(bu 2
 866 Value type: String
 867 .IP \(bu 2
 868 Default value: best\-fit
 869 .UNINDENT
 870 .SS advance\-pages\-per\-row
 871 .sp
 872 Defines if the number of pages per row should be honored when advancing a page.
 873 .INDENT 0.0
 874 .IP \(bu 2
 875 Value type: Boolean
 876 .IP \(bu 2
 877 Default value: false
 878 .UNINDENT
 879 .SS continuous\-hist\-save
 880 .sp
 881 Tells zathura whether to save document history at each page change or only when
 882 closing a document.
 883 .INDENT 0.0
 884 .IP \(bu 2
 885 Value type: Boolean
 886 .IP \(bu 2
 887 Default value: false
 888 .UNINDENT
 889 .SS database
 890 .sp
 891 Defines the database backend to use for bookmarks and input history. Possible
 892 values are "plain", "sqlite" (if built with sqlite support) and "null". If
 893 "null" is used, bookmarks and input history will not be stored.
 894 .INDENT 0.0
 895 .IP \(bu 2
 896 Value type: String
 897 .IP \(bu 2
 898 Default value: plain
 899 .UNINDENT
 900 .SS dbus\-service
 901 .sp
 902 En/Disables the D\-Bus service. If the services is disabled, SyncTeX forward
 903 synchronization is not available.
 904 .INDENT 0.0
 905 .IP \(bu 2
 906 Value type: Boolean
 907 .IP \(bu 2
 908 Default value: true
 909 .UNINDENT
 910 .SS filemonitor
 911 .sp
 912 Defines the file monitor backend used to check for changes in files. Possible
 913 values are "glib", "signal" (if signal handling is supported), and "noop". The
 914 "noop" file monitor does not trigger reloads.
 915 .INDENT 0.0
 916 .IP \(bu 2
 917 Value type: String
 918 .IP \(bu 2
 919 Default value: glib
 920 .UNINDENT
 921 .SS incremental\-search
 922 .sp
 923 En/Disables incremental search (search while typing).
 924 .INDENT 0.0
 925 .IP \(bu 2
 926 Value type: Boolean
 927 .IP \(bu 2
 928 Default value: true
 929 .UNINDENT
 930 .SS highlight\-color
 931 .sp
 932 Defines the color that is used for highlighting parts of the document (e.g.:
 933 show search results)
 934 .INDENT 0.0
 935 .IP \(bu 2
 936 Value type: String
 937 .IP \(bu 2
 938 Default value: #9FBC00
 939 .UNINDENT
 940 .SS highlight\-active\-color
 941 .sp
 942 Defines the color that is used to show the current selected highlighted element
 943 (e.g: current search result)
 944 .INDENT 0.0
 945 .IP \(bu 2
 946 Value type: String
 947 .IP \(bu 2
 948 Default value: #00BC00
 949 .UNINDENT
 950 .SS highlight\-transparency
 951 .sp
 952 Defines the opacity of a highlighted element
 953 .INDENT 0.0
 954 .IP \(bu 2
 955 Value type: Float
 956 .IP \(bu 2
 957 Default value: 0.5
 958 .UNINDENT
 959 .SS page\-padding
 960 .sp
 961 The page padding defines the gap in pixels between each rendered page.
 962 .INDENT 0.0
 963 .IP \(bu 2
 964 Value type: Integer
 965 .IP \(bu 2
 966 Default value: 1
 967 .UNINDENT
 968 .SS page\-cache\-size
 969 .sp
 970 Defines the maximum number of pages that could be kept in the page cache. When
 971 the cache is full and a new page that isn\(aqt cached becomes visible, the least
 972 recently viewed page in the cache will be evicted to make room for the new one.
 973 Large values for this variable are NOT recommended, because this will lead to
 974 consuming a significant portion of the system memory.
 975 .INDENT 0.0
 976 .IP \(bu 2
 977 Value type: Integer
 978 .IP \(bu 2
 979 Default value: 15
 980 .UNINDENT
 981 .SS page\-thumbnail\-size
 982 .sp
 983 Defines the maximum size in pixels of the thumbnail that could be kept in the
 984 thumbnail cache per page. The thumbnail is scaled for a quick preview during
 985 zooming before the page is rendered. When the page is rendered, the result is
 986 saved as the thumbnail only if the size is no more than this value. A larger
 987 value increases quality but introduces longer delay in zooming and uses more
 988 system memory.
 989 .INDENT 0.0
 990 .IP \(bu 2
 991 Value type: Integer
 992 .IP \(bu 2
 993 Default value: 4194304 (4M)
 994 .UNINDENT
 995 .SS pages\-per\-row
 996 .sp
 997 Defines the number of pages that are rendered next to each other in a row.
 998 .INDENT 0.0
 999 .IP \(bu 2
1000 Value type: Integer
1001 .IP \(bu 2
1002 Default value: 1
1003 .UNINDENT
1004 .SS first\-page\-column
1005 .sp
1006 Defines the column in which the first page will be displayed.
1007 This setting is stored separately for every value of pages\-per\-row according to
1008 the following pattern <1 page per row>:[<2 pages per row>[: ...]]. The last
1009 value in the list will be used for all other number of pages per row if not set
1010 explicitly.
1011 .sp
1012 Per default, the first column is set to 2 for double\-page layout, i.e. the faule
1013 is set to 1:2. A value of 1:1:3 would put the first page in dual\-page layour in
1014 the first column, and for layouts with more columns the first page would be put
1015 in the 3rd column.
1016 .INDENT 0.0
1017 .IP \(bu 2
1018 Value type: String
1019 .IP \(bu 2
1020 Default value: 1:2
1021 .UNINDENT
1022 .SS recolor
1023 .sp
1024 En/Disables recoloring
1025 .INDENT 0.0
1026 .IP \(bu 2
1027 Value type: Boolean
1028 .IP \(bu 2
1029 Default value: false
1030 .UNINDENT
1031 .SS recolor\-keephue
1032 .sp
1033 En/Disables keeping original hue when recoloring
1034 .INDENT 0.0
1035 .IP \(bu 2
1036 Value type: Boolean
1037 .IP \(bu 2
1038 Default value: false
1039 .UNINDENT
1040 .SS recolor\-darkcolor
1041 .sp
1042 Defines the color value that is used to represent dark colors in recoloring mode
1043 .INDENT 0.0
1044 .IP \(bu 2
1045 Value type: String
1046 .IP \(bu 2
1047 Default value: #FFFFFF
1048 .UNINDENT
1049 .SS recolor\-lightcolor
1050 .sp
1051 Defines the color value that is used to represent light colors in recoloring mode
1052 .INDENT 0.0
1053 .IP \(bu 2
1054 Value type: String
1055 .IP \(bu 2
1056 Default value: #000000
1057 .UNINDENT
1058 .SS recolor\-reverse\-video
1059 .sp
1060 Defines if original image colors should be kept while recoloring.
1061 .INDENT 0.0
1062 .IP \(bu 2
1063 Value type: Boolean
1064 .IP \(bu 2
1065 Default value: false
1066 .UNINDENT
1067 .SS render\-loading
1068 .sp
1069 Defines if the "Loading..." text should be displayed if a page is rendered.
1070 .INDENT 0.0
1071 .IP \(bu 2
1072 Value type: Boolean
1073 .IP \(bu 2
1074 Default value: true
1075 .UNINDENT
1076 .SS render\-loading\-bg
1077 .sp
1078 Defines the background color that is used for the "Loading..." text.
1079 .INDENT 0.0
1080 .IP \(bu 2
1081 Value type: String
1082 .IP \(bu 2
1083 Default value: #FFFFFF
1084 .UNINDENT
1085 .SS render\-loading\-fg
1086 .sp
1087 Defines the foreground color that is used for the "Loading..." text.
1088 .INDENT 0.0
1089 .IP \(bu 2
1090 Value type: String
1091 .IP \(bu 2
1092 Default value: #000000
1093 .UNINDENT
1094 .SS scroll\-hstep
1095 .sp
1096 Defines the horizontal step size of scrolling by calling the scroll command once
1097 .INDENT 0.0
1098 .IP \(bu 2
1099 Value type: Float
1100 .IP \(bu 2
1101 Default value: \-1
1102 .UNINDENT
1103 .SS scroll\-step
1104 .sp
1105 Defines the step size of scrolling by calling the scroll command once
1106 .INDENT 0.0
1107 .IP \(bu 2
1108 Value type: Float
1109 .IP \(bu 2
1110 Default value: 40
1111 .UNINDENT
1112 .SS scroll\-full\-overlap
1113 .sp
1114 Defines the proportion of the current viewing area that should be
1115 visible after scrolling a full page.
1116 .INDENT 0.0
1117 .IP \(bu 2
1118 Value type: Float
1119 .IP \(bu 2
1120 Default value: 0
1121 .UNINDENT
1122 .SS scroll\-wrap
1123 .sp
1124 Defines if the last/first page should be wrapped
1125 .INDENT 0.0
1126 .IP \(bu 2
1127 Value type: Boolean
1128 .IP \(bu 2
1129 Default value: false
1130 .UNINDENT
1131 .SS show\-directories
1132 .sp
1133 Defines if the directories should be displayed in completion.
1134 .INDENT 0.0
1135 .IP \(bu 2
1136 Value type: Boolean
1137 .IP \(bu 2
1138 Default value: true
1139 .UNINDENT
1140 .SS show\-hidden
1141 .sp
1142 Defines if hidden files and directories should be displayed in completion.
1143 .INDENT 0.0
1144 .IP \(bu 2
1145 Value type: Boolean
1146 .IP \(bu 2
1147 Default value: false
1148 .UNINDENT
1149 .SS show\-recent
1150 .sp
1151 Defines the number of recent files that should be displayed in completion.
1152 If the value is negative, no upper bounds are applied. If the value is 0, no
1153 recent files are shown.
1154 .INDENT 0.0
1155 .IP \(bu 2
1156 Value type: Integer
1157 .IP \(bu 2
1158 Default value: 10
1159 .UNINDENT
1160 .SS scroll\-page\-aware
1161 .sp
1162 Defines if scrolling by half or full pages stops at page boundaries.
1163 .INDENT 0.0
1164 .IP \(bu 2
1165 Value type: Boolean
1166 .IP \(bu 2
1167 Default value: false
1168 .UNINDENT
1169 .SS link\-zoom
1170 .sp
1171 En/Disables the ability of changing zoom when following links.
1172 .INDENT 0.0
1173 .IP \(bu 2
1174 Value type: Boolean
1175 .IP \(bu 2
1176 Default value: true
1177 .UNINDENT
1178 .SS link\-hadjust
1179 .sp
1180 En/Disables aligning to the left internal link targets, for example from the
1181 index.
1182 .INDENT 0.0
1183 .IP \(bu 2
1184 Value type: Boolean
1185 .IP \(bu 2
1186 Default value: true
1187 .UNINDENT
1188 .SS search\-hadjust
1189 .sp
1190 En/Disables horizontally centered search results.
1191 .INDENT 0.0
1192 .IP \(bu 2
1193 Value type: Boolean
1194 .IP \(bu 2
1195 Default value: true
1196 .UNINDENT
1197 .SS window\-title\-basename
1198 .sp
1199 Use basename of the file in the window title.
1200 .INDENT 0.0
1201 .IP \(bu 2
1202 Value type: Boolean
1203 .IP \(bu 2
1204 Default value: false
1205 .UNINDENT
1206 .SS window\-title\-home\-tilde
1207 .sp
1208 Display a short version of the file path, which replaces $HOME with ~, in the window title.
1209 .INDENT 0.0
1210 .IP \(bu 2
1211 Value type: Boolean
1212 .IP \(bu 2
1213 Default value: false
1214 .UNINDENT
1215 .SS window\-title\-page
1216 .sp
1217 Display the page number in the window title.
1218 .INDENT 0.0
1219 .IP \(bu 2
1220 Value type: Boolean
1221 .IP \(bu 2
1222 Default value: false
1223 .UNINDENT
1224 .SS statusbar\-basename
1225 .sp
1226 Use basename of the file in the statusbar.
1227 .INDENT 0.0
1228 .IP \(bu 2
1229 Value type: Boolean
1230 .IP \(bu 2
1231 Default value: false
1232 .UNINDENT
1233 .SS statusbar\-home\-tilde
1234 .sp
1235 Display a short version of the file path, which replaces $HOME with ~, in the statusbar.
1236 .INDENT 0.0
1237 .IP \(bu 2
1238 Value type: Boolean
1239 .IP \(bu 2
1240 Default value: false
1241 .UNINDENT
1242 .SS zoom\-center
1243 .sp
1244 En/Disables horizontally centered zooming.
1245 .INDENT 0.0
1246 .IP \(bu 2
1247 Value type: Boolean
1248 .IP \(bu 2
1249 Default value: false
1250 .UNINDENT
1251 .SS vertical\-center
1252 .sp
1253 Center the screen at the vertical midpoint of the page by default.
1254 .INDENT 0.0
1255 .IP \(bu 2
1256 Value type: Boolean
1257 .IP \(bu 2
1258 Default value: false
1259 .UNINDENT
1260 .SS zoom\-max
1261 .sp
1262 Defines the maximum percentage that the zoom level can be.
1263 .INDENT 0.0
1264 .IP \(bu 2
1265 Value type: Integer
1266 .IP \(bu 2
1267 Default value: 1000
1268 .UNINDENT
1269 .SS zoom\-min
1270 .sp
1271 Defines the minimum percentage that the zoom level can be.
1272 .INDENT 0.0
1273 .IP \(bu 2
1274 Value type: Integer
1275 .IP \(bu 2
1276 Default value: 10
1277 .UNINDENT
1278 .SS zoom\-step
1279 .sp
1280 Defines the amount of percent that is zoomed in or out on each command.
1281 .INDENT 0.0
1282 .IP \(bu 2
1283 Value type: Integer
1284 .IP \(bu 2
1285 Default value: 10
1286 .UNINDENT
1287 .SS selection\-clipboard
1288 .sp
1289 Defines the X clipboard into which mouse\-selected data will be written.  When it
1290 is "clipboard", selected data will be written to the CLIPBOARD clipboard, and
1291 can be pasted using the Ctrl+v key combination.  When it is "primary", selected
1292 data will be written to the PRIMARY clipboard, and can be pasted using the
1293 middle mouse button, or the Shift\-Insert key combination.
1294 .INDENT 0.0
1295 .IP \(bu 2
1296 Value type: String
1297 .IP \(bu 2
1298 Default value: primary
1299 .UNINDENT
1300 .SS selection\-notification
1301 .sp
1302 Defines if a notification should be displayed after selecting text.
1303 .INDENT 0.0
1304 .IP \(bu 2
1305 Value type: Boolean
1306 .IP \(bu 2
1307 Default value: true
1308 .UNINDENT
1309 .SS synctex
1310 .sp
1311 En/Disables SyncTeX backward synchronization support.
1312 .INDENT 0.0
1313 .IP \(bu 2
1314 Value type: Boolean
1315 .IP \(bu 2
1316 Default value: true
1317 .UNINDENT
1318 .SS synctex\-editor\-command
1319 .sp
1320 Defines the command executed for SyncTeX backward synchronization.
1321 .INDENT 0.0
1322 .IP \(bu 2
1323 Value type: String
1324 .IP \(bu 2
1325 Default value:
1326 .UNINDENT
1327 .SS index\-fg
1328 .sp
1329 Defines the foreground color of the index mode.
1330 .INDENT 0.0
1331 .IP \(bu 2
1332 Value type: String
1333 .IP \(bu 2
1334 Default value: #DDDDDD
1335 .UNINDENT
1336 .SS index\-bg
1337 .sp
1338 Define the background color of the index mode.
1339 .INDENT 0.0
1340 .IP \(bu 2
1341 Value type: String
1342 .IP \(bu 2
1343 Default value: #232323
1344 .UNINDENT
1345 .SS index\-active\-fg
1346 .sp
1347 Defines the foreground color of the selected element in index mode.
1348 .INDENT 0.0
1349 .IP \(bu 2
1350 Value type: String
1351 .IP \(bu 2
1352 Default value: #232323
1353 .UNINDENT
1354 .SS index\-active\-bg
1355 .sp
1356 Define the background color of the selected element in index mode.
1357 .INDENT 0.0
1358 .IP \(bu 2
1359 Value type: String
1360 .IP \(bu 2
1361 Default value: #9FBC00
1362 .UNINDENT
1363 .SS sandbox
1364 .sp
1365 Defines the sandbox mode to use for the seccomp syscall filter. Possible
1366 values are "none", "normal" and "strict". If "none" is used, the sandbox
1367 will be disabled. The use of "normal" will provide minimal protection and
1368 allow normal use of zathura with support for all features. The "strict" mode
1369 is a read only sandbox that is intended for viewing documents only.
1370 .INDENT 0.0
1371 .IP \(bu 2
1372 Value type: String
1373 .IP \(bu 2
1374 Default value: normal
1375 .UNINDENT
1376 .sp
1377 Some features are disabled when using strict sandbox mode:
1378 .INDENT 0.0
1379 .IP \(bu 2
1380 saving/writing files
1381 .IP \(bu 2
1382 use of input methods like ibus
1383 .IP \(bu 2
1384 printing
1385 .IP \(bu 2
1386 bookmarks and history
1387 .UNINDENT
1388 .sp
1389 No feature regressions are expected when using normal sandbox mode.
1390 .sp
1391 When running under WSL, the default is "none" since seccomp is not supported in
1392 that environment.
1393 .SS window\-icon\-document
1394 .sp
1395 Defines whether the window document should be updated based on the first page of
1396 a dcument.
1397 .INDENT 0.0
1398 .IP \(bu 2
1399 Value type: Boolean
1400 .IP \(bu 2
1401 Default value: false
1402 .UNINDENT
1403 .SS page\-right\-to\-left
1404 .sp
1405 Defines whether pages in multi\-column view should start from the right side.
1406 .INDENT 0.0
1407 .IP \(bu 2
1408 Value type: Boolean
1409 .IP \(bu 2
1410 Default value: false
1411 .UNINDENT
1412 .SH SEE ALSO
1413 .sp
1414 zathura(1)
1415 .SH AUTHOR
1416 pwmt.org
1417 .SH COPYRIGHT
1418 2009-2018, pwmt.org
1419 .\" Generated by docutils manpage writer.
1420 .