1Configuration options
2=====================
3
4General settings
5----------------
6
7.. describe:: abort-clear-search
8
9  Defines if the search results should be cleared on abort.
10
11   :type: Boolean
12   :default: True
13
14.. describe:: adjust-open
15
16  Defines which auto adjustment mode should be used if a document is
17  loaded. Possible options are "best-fit" and "width".
18
19   :type: String
20   :default: best-fit
21
22.. describe:: advance-ds-per-row
23
24  Defines if the number of pages per row should be honored when advancing
25  a page.
26
27   :type: Boolean
28   :default: true
29
30.. describe:: database
31
32  Defines the used database backend. Possible options are 'plain' and
33  'sqlite'
34
35   :type: String
36   :default: plain
37
38.. describe:: highlight-color
39
40  Defines the color that is used for highlighting parts of the document
41  (e.g.: show search results)
42
43   :type: String
44   :default: #9FBC00
45
46.. describe:: highlight-active-color
47
48  Defines the color that is used to show the current selected highlighted
49  element (e.g: current search result)
50
51   :type: String
52   :default: #00BC00
53
54.. describe:: highlight-transparency
55
56  Defines the opacity of a highlighted element
57
58   :type: Float
59   :default: 0.5
60
61.. describe:: page-padding
62
63  The page padding defines the gap in pixels between each rendered page.
64
65   :type: Integer
66   :default: 1
67
68.. describe:: page-store-threshold
69
70  Pages that are not visible get unloaded after some time. Every page that
71  has not been visible for page-store-treshold seconds will be unloaded.
72
73   :type: Integer
74   :default: 30
75
76.. describe:: page-store-interval
77
78  Defines the amount of seconds between the check to unload invisible
79  pages.
80
81   :type: Integer
82   :default: 30
83
84.. describe:: pages-per-row
85
86  Defines the number of pages that are rendered next to each other in a
87  row.
88
89   :type: Integer
90   :default: 1
91
92.. describe:: recolor
93
94  En/Disables recoloring
95
96   :type: Boolean
97   :default: false
98
99.. describe:: recolor-darkcolor
100
101  Defines the color value that is used to represent dark colors in
102  recoloring mode
103
104   :type: String
105   :default: #FFFFFF
106
107.. describe:: recolor-lightcolor
108
109  Defines the color value that is used to represent light colors in
110  recoloring mode
111
112   :type: String
113   :default: #000000
114
115.. describe:: render-loading
116
117  Defines if the "Loading..." text should be displayed if a page is
118  rendered.
119
120   :type: Boolean
121   :default: true
122
123.. describe:: scroll-step
124
125  Defines the step size of scrolling by calling the scroll command once
126
127   :type: Float
128   :default: 40
129
130.. describe:: scroll-wrap
131
132  Defines if the last/first page should be wrapped
133
134   :type: Boolean
135   :default: false
136
137.. describe:: zoom-max
138
139  Defines the maximum percentage that the zoom level can be
140
141   :type: Integer
142   :default: 1000
143
144.. describe:: zoom-min
145
146  Defines the minimum percentage that the zoom level can be
147
148   :type: Integer
149   :default: 10
150
151.. describe:: zoom-step
152
153  Defines the amount of percent that is zoomed in or out on each comand.
154
155   :type: Integer
156   :default: 10
157
158Girara settings
159---------------
160
161Most of the options affecting the appearance of zathura are derived from
162the options that are offered by our user interface library called girara
163and can be found in its `documentation </projects/girara/options>`_.
164Those values can also be set via the *zathurarc* file.
165