summaryrefslogtreecommitdiff
path: root/office/zathura/man/zathurarc.5
blob: 93b42be0a809b5f2f4ed5a2577037288aafc6952 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
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
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
.\" Man page generated from reStructuredText.
.
.TH "ZATHURARC" "5" "2017-01-11" "0.2.7" "zathura"
.SH NAME
zathurarc \- zathura configuration file
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
/etc/zathurarc, $XDG_CONFIG_HOME/zathura/zathurarc
.SH DESCRIPTION
.sp
The \fIzathurarc\fP file is a simple plain text file that can be populated with
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.
.SH COMMANDS
.SS set \- Changing options
.sp
In addition to the built\-in \fB:set\fP command zathura offers more options to be
changed and makes those changes permanent. To overwrite an option you just have
to add a line structured like the following
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set <option> <new value>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBoption\fP field has to be replaced with the name of the option that should be
changed and the \fBnew value\fP field has to be replaced with the new value the
option should get. The type of the value can be one of the following:
.INDENT 0.0
.IP \(bu 2
INT \- An integer number
.IP \(bu 2
FLOAT \- A floating point number
.IP \(bu 2
STRING \- A character string
.IP \(bu 2
BOOL \- A boolean value ("true" for true, "false" for false)
.UNINDENT
.sp
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.
.sp
The following example should give some deeper insight of how the \fBset\fP command
can be used
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set option1 5
set option2 2.0
set option3 hello
set option4 hello\e world
set option5 "hello world"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you want to use \fBcolor codes\fP for some options, make sure to quote them
accordingly or to escape the hash symbol.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set default\-fg "#CCBBCC"
set default\-fg \e#CCBBCC
.ft P
.fi
.UNINDENT
.UNINDENT
.SS map \- Mapping a shortcut
.sp
It is possible to map or remap new key bindings to shortcut functions which
allows a high level of customization. The \fB:map\fP command can also be used in
the \fIzathurarc\fP file to make those changes permanent:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
map [mode] <binding> <shortcut function> <argument>
.ft P
.fi
.UNINDENT
.UNINDENT
.SS include \- Including another config file
.sp
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.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
include another\-config
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Mode
.sp
The \fBmap\fP command expects several arguments where only the \fBbinding\fP as well as
the \fBshortcut\-function\fP argument is required. Since zathura uses several modes
it is possible to map bindings only for a specific mode by passing the \fBmode\fP
argument which can take one of the following values:
.INDENT 0.0
.IP \(bu 2
normal (default)
.IP \(bu 2
fullscreen
.IP \(bu 2
index
.UNINDENT
.sp
The brackets around the value are mandatory.
.SS Single key binding
.sp
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:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
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
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Using modifiers
.sp
It is also possible to use modifiers like the Control or Alt button on the
keyboard. It is possible to use the following modifiers:
.INDENT 0.0
.IP \(bu 2
A \- Alt
.IP \(bu 2
C \- Control
.IP \(bu 2
S \- Shift
.UNINDENT
.sp
Now it is required to define the \fBbinding\fP with the following structure:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
map <A\-a> shortcut_function
map <C\-a> shortcut_function
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Special keys
.sp
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:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
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
Super      Windows key
Tab        Tab
Print      Print key
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
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:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
map <Space> shortcut_function
map <C\-Space> shortcut_function
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Mouse buttons
.sp
It is also possible to map mouse buttons to shortcuts by using the following
special keys:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Identifier Description

Button1    Mouse button 1
Button2    Mouse button 2
Button3    Mouse button 3
Button4    Mouse button 4
Button5    Mouse button 5
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
They can also be combined with modifiers:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
map <Button1> shortcut_function
map <C\-Button1> shortcut_function
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Buffer commands
.sp
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:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
map abc quit
map test quit
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Shortcut functions
.sp
The following shortcut functions can be mapped:
.INDENT 0.0
.IP \(bu 2
\fBabort\fP
.sp
Switch back to normal mode.
.IP \(bu 2
\fBadjust_window\fP
.sp
Adjust page width. Possible arguments are \fBbest\-fit\fP and \fBwidth\fP\&.
.IP \(bu 2
\fBchange_mode\fP
.sp
Change current mode. Pass the desired mode as argument.
.IP \(bu 2
\fBdisplay_link\fP:
.sp
Display link target.
.IP \(bu 2
\fBfocus_inputbar\fP
.sp
Focus inputbar.
.IP \(bu 2
\fBfollow\fP
.sp
Follow a link.
.IP \(bu 2
\fBgoto\fP
.sp
Go to a certain page.
.IP \(bu 2
\fBjumplist\fP
.sp
Move forwards/backwards in the jumplist.
.IP \(bu 2
\fBnavigate\fP
.sp
Navigate to the next/previous page.
.IP \(bu 2
\fBnavigate_index\fP
.sp
Navigate through the index.
.IP \(bu 2
\fBprint\fP
.sp
Show the print dialog.
.IP \(bu 2
\fBquit\fP
.sp
Quit zathura.
.IP \(bu 2
\fBrecolor\fP
.sp
Recolor pages.
.IP \(bu 2
\fBreload\fP
.sp
Reload the document.
.IP \(bu 2
\fBrotate\fP
.sp
Rotate the page. Pass \fBrotate\-ccw\fP as argument for counterclockwise rotation
and \fBrotate\-cw\fP for clockwise rotation.
.IP \(bu 2
\fBscroll\fP
.sp
Scroll.
.IP \(bu 2
\fBsearch\fP
.sp
Search next/previous item. Pass \fBforward\fP as argument to search for the next
hit and \fBbackward\fP to search for the previous hit.
.IP \(bu 2
\fBset\fP
.sp
Set an option.
.IP \(bu 2
\fBtoggle_fullscreen\fP
.sp
Toggle fullscreen.
.IP \(bu 2
\fBtoggle_index\fP
.sp
Show or hide index.
.IP \(bu 2
\fBtoggle_inputbar\fP
.sp
Show or hide inputbar.
.IP \(bu 2
\fBtoggle_page_mode\fP
.sp
Toggle between one and multiple pages per row.
.IP \(bu 2
\fBtoggle_statusbar\fP
.sp
Show or hide statusbar.
.IP \(bu 2
\fBzoom\fP
.sp
Zoom in or out.
.IP \(bu 2
\fBmark_add\fP
Set a quickmark.
.IP \(bu 2
\fBmark_evaluate\fP
Go to a quickmark.
.UNINDENT
.SS Pass arguments
.sp
Some shortcut function require or have optional arguments which influence the
behaviour of them. Those can be passed as the last argument:
.INDENT 0.0
.INDENT 3.5
map <C\-i> zoom in
map <C\-o> zoom out
.UNINDENT
.UNINDENT
.sp
Possible arguments are:
.INDENT 0.0
.IP \(bu 2
best\-fit
.IP \(bu 2
bottom
.IP \(bu 2
collapse
.IP \(bu 2
collapse\-all
.IP \(bu 2
default
.IP \(bu 2
down
.IP \(bu 2
expand
.IP \(bu 2
expand\-all
.IP \(bu 2
full\-down
.IP \(bu 2
full\-up
.IP \(bu 2
half\-down
.IP \(bu 2
half\-up
.IP \(bu 2
in
.IP \(bu 2
left
.IP \(bu 2
next
.IP \(bu 2
out
.IP \(bu 2
page\-bottom
.IP \(bu 2
page\-top
.IP \(bu 2
previous
.IP \(bu 2
right
.IP \(bu 2
rotate\-ccw
.IP \(bu 2
rotate\-cw
.IP \(bu 2
select
.IP \(bu 2
specific
.IP \(bu 2
toggle
.IP \(bu 2
top
.IP \(bu 2
up
.IP \(bu 2
width
.UNINDENT
.SS unmap \- Removing a shortcut
.sp
In addition to mapping or remaping custom key bindings it is possible to remove
existing ones by using the \fB:unmap\fP command. The command is used in the
following way (the explanation of the parameters is described in the \fBmap\fP
section of this document
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
unmap [mode] <binding>
.ft P
.fi
.UNINDENT
.UNINDENT
.SH OPTIONS
.SS girara
.sp
This section describes settings concerning the behaviour of libgirara and
zathura. The settings described here can be changed with \fBset\fP\&.
.SS n\-completion\-items
.sp
Defines the maximum number of displayed completion entries.
.INDENT 0.0
.IP \(bu 2
Value type: Integer
.IP \(bu 2
Default value: 15
.UNINDENT
.SS completion\-bg
.sp
Defines the background color that is used for command line completion
entries
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #232323
.UNINDENT
.SS completion\-fg
.sp
Defines the foreground color that is used for command line completion
entries
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #DDDDDD
.UNINDENT
.SS completion\-group\-bg
.sp
Defines the background color that is used for command line completion
group elements
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #000000
.UNINDENT
.SS completion\-group\-fg
.sp
Defines the foreground color that is used for command line completion
group elements
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #DEDEDE
.UNINDENT
.SS completion\-highlight\-bg
.sp
Defines the background color that is used for the current command line
completion element
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #9FBC00
.UNINDENT
.SS completion\-highlight\-fg
.sp
Defines the foreground color that is used for the current command line
completion element
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #232323
.UNINDENT
.SS default\-fg
.sp
Defines the default foreground color
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #DDDDDD
.UNINDENT
.SS default\-bg
.sp
Defines the default background color
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #000000
.UNINDENT
.SS exec\-command
.sp
Defines a command the should be prepanded to any command run with exec.
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value:
.UNINDENT
.SS font
.sp
Defines the font that will be used
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: monospace normal 9
.UNINDENT
.SS guioptions
.sp
Shows or hides GUI elements.
If it contains \(aqc\(aq, the command line is displayed.
If it contains \(aqs\(aq, the statusbar is displayed.
If it contains \(aqh\(aq, the horizontal scrollbar is displayed.
If it contains \(aqv\(aq, the vertical scrollbar is displayed.
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: s
.UNINDENT
.SS inputbar\-bg
.sp
Defines the background color for the inputbar
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #131313
.UNINDENT
.SS inputbar\-fg
.sp
Defines the foreground color for the inputbar
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #9FBC00
.UNINDENT
.SS notification\-bg
.sp
Defines the background color for a notification
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #FFFFFF
.UNINDENT
.SS notification\-fg
.sp
Defines the foreground color for a notification
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #000000
.UNINDENT
.SS notification\-error\-bg
.sp
Defines the background color for an error notification
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #FFFFFF
.UNINDENT
.SS notification\-error\-fg
.sp
Defines the foreground color for an error notification
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #FF1212
.UNINDENT
.SS notification\-warning\-bg
.sp
Defines the background color for a warning notification
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #FFFFFF
.UNINDENT
.SS notification\-warning\-fg
.sp
Defines the foreground color for a warning notification
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #FFF712
.UNINDENT
.SS tabbar\-fg
.sp
Defines the foreground color for a tab
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #FFFFFF
.UNINDENT
.SS tabbar\-bg
.sp
Defines the background color for a tab
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #000000
.UNINDENT
.SS tabbar\-focus\-fg
.sp
Defines the foreground color for the focused tab
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #9FBC00
.UNINDENT
.SS tabbar\-focus\-bg
.sp
Defines the background color for the focused tab
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #000000
.UNINDENT
.SS show\-scrollbars
.sp
Defines if both the horizontal and vertical scrollbars should be shown or not.
Deprecated, use \(aqguioptions\(aq instead.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS show\-h\-scrollbar
.sp
Defines whether to show/hide the horizontal scrollbar. Deprecated, use
\(aqguioptions\(aq instead.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS show\-v\-scrollbar
.sp
Defines whether to show/hide the vertical scrollbar. Deprecated, use
\(aqguioptions\(aq instead.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS statusbar\-bg
.sp
Defines the background color of the statusbar
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #000000
.UNINDENT
.SS statusbar\-fg
.sp
Defines the foreground color of the statusbar
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #FFFFFF
.UNINDENT
.SS statusbar\-h\-padding
.sp
Defines the horizontal padding of the statusbar and notificationbar
.INDENT 0.0
.IP \(bu 2
Value type: Integer
.IP \(bu 2
Default value: 8
.UNINDENT
.SS statusbar\-v\-padding
.sp
Defines the vertical padding of the statusbar and notificationbar
.INDENT 0.0
.IP \(bu 2
Value type: Integer
.IP \(bu 2
Default value: 2
.UNINDENT
.SS window\-icon
.sp
Defines the path for a icon to be used as window icon.
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value:
.UNINDENT
.SS window\-height
.sp
Defines the window height on startup
.INDENT 0.0
.IP \(bu 2
Value type: Integer
.IP \(bu 2
Default value: 600
.UNINDENT
.SS window\-width
.sp
Defines the window width on startup
.INDENT 0.0
.IP \(bu 2
Value type: Integer
.IP \(bu 2
Default value: 800
.UNINDENT
.SS zathura
.sp
This section describes settings concerning the behaviour of zathura.
.SS abort\-clear\-search
.sp
Defines if the search results should be cleared on abort.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: true
.UNINDENT
.SS adjust\-open
.sp
Defines which auto adjustment mode should be used if a document is loaded.
Possible options are "best\-fit" and "width".
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: best\-fit
.UNINDENT
.SS advance\-pages\-per\-row
.sp
Defines if the number of pages per row should be honored when advancing a page.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS database
.sp
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.
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: plain
.UNINDENT
.SS dbus\-service
.sp
En/Disables the D\-Bus service. If the services is disabled, SyncTeX forward
synchronization is not available.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: true
.UNINDENT
.SS filemonitor
.sp
Defines the filemonitor backend. Possible values are "glib" and "signal" (if
signal handling is supported).
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: glib
.UNINDENT
.SS incremental\-search
.sp
En/Disables incremental search (search while typing).
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: true
.UNINDENT
.SS highlight\-color
.sp
Defines the color that is used for highlighting parts of the document (e.g.:
show search results)
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #9FBC00
.UNINDENT
.SS highlight\-active\-color
.sp
Defines the color that is used to show the current selected highlighted element
(e.g: current search result)
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #00BC00
.UNINDENT
.SS highlight\-transparency
.sp
Defines the opacity of a highlighted element
.INDENT 0.0
.IP \(bu 2
Value type: Float
.IP \(bu 2
Default value: 0.5
.UNINDENT
.SS page\-padding
.sp
The page padding defines the gap in pixels between each rendered page.
.INDENT 0.0
.IP \(bu 2
Value type: Integer
.IP \(bu 2
Default value: 1
.UNINDENT
.SS page\-cache\-size
.sp
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\(aqt 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.
.INDENT 0.0
.IP \(bu 2
Value type: Integer
.IP \(bu 2
Default value: 15
.UNINDENT
.SS page\-thumbnail\-size
.sp
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.
.INDENT 0.0
.IP \(bu 2
Value type: Integer
.IP \(bu 2
Default value: 4194304 (4M)
.UNINDENT
.SS pages\-per\-row
.sp
Defines the number of pages that are rendered next to each other in a row.
.INDENT 0.0
.IP \(bu 2
Value type: Integer
.IP \(bu 2
Default value: 1
.UNINDENT
.SS first\-page\-column
.sp
Defines the column in which the first page will be displayed.
This setting is stored separately for every value of pages\-per\-row according to
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
explicitly.
.sp
Per default, the first column is set to 2 for double\-page layout.
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: 1:2
.UNINDENT
.SS recolor
.sp
En/Disables recoloring
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS recolor\-keephue
.sp
En/Disables keeping original hue when recoloring
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS recolor\-darkcolor
.sp
Defines the color value that is used to represent dark colors in recoloring mode
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #FFFFFF
.UNINDENT
.SS recolor\-lightcolor
.sp
Defines the color value that is used to represent light colors in recoloring mode
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #000000
.UNINDENT
.SS recolor\-reverse\-video
.sp
Defines if original image colors should be kept while recoloring.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS render\-loading
.sp
Defines if the "Loading..." text should be displayed if a page is rendered.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: true
.UNINDENT
.SS render\-loading\-bg
.sp
Defines the background color that is used for the "Loading..." text.
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #FFFFFF
.UNINDENT
.SS render\-loading\-fg
.sp
Defines the foreground color that is used for the "Loading..." text.
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #000000
.UNINDENT
.SS scroll\-hstep
.sp
Defines the horizontal step size of scrolling by calling the scroll command once
.INDENT 0.0
.IP \(bu 2
Value type: Float
.IP \(bu 2
Default value: \-1
.UNINDENT
.SS scroll\-step
.sp
Defines the step size of scrolling by calling the scroll command once
.INDENT 0.0
.IP \(bu 2
Value type: Float
.IP \(bu 2
Default value: 40
.UNINDENT
.SS scroll\-full\-overlap
.sp
Defines the proportion of the current viewing area that should be
visible after scrolling a full page.
.INDENT 0.0
.IP \(bu 2
Value type: Float
.IP \(bu 2
Default value: 0
.UNINDENT
.SS scroll\-wrap
.sp
Defines if the last/first page should be wrapped
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS show\-directories
.sp
Defines if the directories should be displayed in completion.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: true
.UNINDENT
.SS show\-hidden
.sp
Defines if hidden files and directories should be displayed in completion.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS show\-recent
.sp
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.
.INDENT 0.0
.IP \(bu 2
Value type: Integer
.IP \(bu 2
Default value: 10
.UNINDENT
.SS scroll\-page\-aware
.sp
Defines if scrolling by half or full pages stops at page boundaries.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS smooth\-scroll
.sp
Defines if scrolling via touchpad should be smooth(only available with gtk >= 3.4).
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS link\-zoom
.sp
En/Disables the ability of changing zoom when following links.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: true
.UNINDENT
.SS link\-hadjust
.sp
En/Disables aligning to the left internal link targets, for example from the
index.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: true
.UNINDENT
.SS search\-hadjust
.sp
En/Disables horizontally centered search results.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: true
.UNINDENT
.SS window\-title\-basename
.sp
Use basename of the file in the window title.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS window\-title\-home\-tilde
.sp
Display a short version of the file path, which replaces $HOME with ~, in the window title.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS window\-title\-page
.sp
Display the page number in the window title.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS statusbar\-basename
.sp
Use basename of the file in the statusbar.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS statusbar\-home\-tilde
.sp
Display a short version of the file path, which replaces $HOME with ~, in the statusbar.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS zoom\-center
.sp
En/Disables horizontally centered zooming.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: false
.UNINDENT
.SS zoom\-max
.sp
Defines the maximum percentage that the zoom level can be.
.INDENT 0.0
.IP \(bu 2
Value type: Integer
.IP \(bu 2
Default value: 1000
.UNINDENT
.SS zoom\-min
.sp
Defines the minimum percentage that the zoom level can be.
.INDENT 0.0
.IP \(bu 2
Value type: Integer
.IP \(bu 2
Default value: 10
.UNINDENT
.SS zoom\-step
.sp
Defines the amount of percent that is zoomed in or out on each command.
.INDENT 0.0
.IP \(bu 2
Value type: Integer
.IP \(bu 2
Default value: 10
.UNINDENT
.SS selection\-clipboard
.sp
Defines the X clipboard into which mouse\-selected data will be written.  When it
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.
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: primary
.UNINDENT
.SS selection\-notification
.sp
Defines if a notification should be displayed after selecting text.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: true
.UNINDENT
.SS synctex
.sp
En/Disables SyncTeX backward synchronization support.
.INDENT 0.0
.IP \(bu 2
Value type: Boolean
.IP \(bu 2
Default value: true
.UNINDENT
.SS synctex\-editor\-command
.sp
Defines the command executed for SyncTeX backward synchronization.
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value:
.UNINDENT
.SS index\-fg
.sp
Defines the foreground color of the index mode.
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #DDDDDD
.UNINDENT
.SS index\-bg
.sp
Define the background color of the index mode.
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #232323
.UNINDENT
.SS index\-active\-fg
.sp
Defines the foreground color of the selected element in index mode.
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #232323
.UNINDENT
.SS index\-active\-bg
.sp
Define the background color of the selected element in index mode.
.INDENT 0.0
.IP \(bu 2
Value type: String
.IP \(bu 2
Default value: #9FBC00
.UNINDENT
.SH SEE ALSO
.sp
zathura(1)
.SH AUTHOR
pwmt.org
.SH COPYRIGHT
2009-2015, pwmt.org
.\" Generated by docutils manpage writer.
.