doc updates; $voffset
[monky] / doc / config_settings.xml
1 <variablelist>
2 <varlistentry>
3         <term><command><option>alignment</option></command></term>
4         <listitem>
5                 Aligned position on screen, may be top_left, top_right, bottom_left, bottom_right, or none
6         <para></para></listitem>
7 </varlistentry>
8
9 <varlistentry>
10         <term><command><option>background</option></command></term>
11         <listitem>
12                 Boolean value, if true, Conky will be forked to background when started
13         <para></para></listitem>
14 </varlistentry>
15
16 <varlistentry>
17         <term><command><option>on_bottom</option></command></term>
18         <listitem>
19                 Set conky on the bottom of all other applications
20         <para></para></listitem>
21 </varlistentry>
22
23 <varlistentry>
24         <term><command><option>border_margin</option></command></term>
25         <listitem>
26                 Border margin in pixels
27         <para></para></listitem>
28 </varlistentry>
29
30 <varlistentry>
31         <term><command><option>border_width</option></command></term>
32         <listitem>
33                 Border width in pixels
34         <para></para></listitem>
35 </varlistentry>
36
37 <varlistentry>
38         <term><command><option>cpu_avg_samples</option></command></term>
39         <listitem>
40                 The number of samples to average for CPU monitoring
41         <para></para></listitem>
42 </varlistentry>
43
44 <varlistentry>
45         <term><command><option>default_color</option></command></term>
46         <listitem>
47                 Default color and border color
48         <para></para></listitem>
49 </varlistentry>
50
51 <varlistentry>
52         <term><command><option>default_shade_color</option></command></term>
53         <listitem>
54                 Default shading color and border's shading color
55         <para></para></listitem>
56 </varlistentry>
57
58 <varlistentry>
59         <term><command><option>default_outline_color</option></command></term>
60         <listitem>
61                 Default outline color
62         <para></para></listitem>
63 </varlistentry>
64
65 <varlistentry>
66         <term><command><option>double_buffer</option></command></term>
67         <listitem>
68                 Use the Xdbe extension? (eliminates flicker) It is highly recommended to use own window with this one so double buffer won't be so big.
69         <para></para></listitem>
70 </varlistentry>
71
72 <varlistentry>
73         <term><command><option>draw_borders</option></command></term>
74         <listitem>
75                 Draw borders around text?
76         <para></para></listitem>
77 </varlistentry>
78
79 <varlistentry>
80         <term><command><option>draw_shades</option></command></term>
81         <listitem>
82                 Draw shades?
83         <para></para></listitem>
84 </varlistentry>
85
86 <varlistentry>
87         <term><command><option>draw_outline</option></command></term>
88         <listitem>
89                 Draw outlines?
90         <para></para></listitem>
91 </varlistentry>
92
93 <varlistentry>
94         <term><command><option>font</option></command></term>
95         <listitem>
96                 Font name in X, xfontsel can be used to get a nice font
97         <para></para></listitem>
98 </varlistentry>
99
100 <varlistentry>
101         <term><command><option>gap_x</option></command></term>
102         <listitem>
103                 Gap between right or left border of screen, same as passing -x at command line
104         <para></para></listitem>
105 </varlistentry>
106
107 <varlistentry>
108         <term><command><option>gap_y</option></command></term>
109         <listitem>
110                 Gap between top or bottom border of screen, same as passing -y at command line
111         <para></para></listitem>
112 </varlistentry>
113
114 <varlistentry>
115         <term><command><option>no_buffers</option></command></term>
116         <listitem>
117                 Substract (file system) buffers from used memory?
118         <para></para></listitem>
119 </varlistentry>
120
121 <varlistentry>
122         <term><command><option>mail_spool</option></command></term>
123         <listitem>
124                 Mail spool for mail checking
125         <para></para></listitem>
126 </varlistentry>
127
128 <varlistentry>
129         <term><command><option>metar_station</option></command></term>
130         <listitem>
131                 METAR station code for weather, see http://www.wrh.noaa.gov/ if you need to find your code.
132         <para></para></listitem>
133 </varlistentry>
134
135 <varlistentry>
136         <term><command><option>metar_server</option></command></term>
137         <listitem>
138                 Define a custom METAR ftp server
139         <para></para></listitem>
140 </varlistentry>
141
142 <varlistentry>
143         <term><command><option>metar_path</option></command></term>
144         <listitem>
145                 Path on server to use
146         <para></para></listitem>
147 </varlistentry>
148
149 <varlistentry>
150         <term><command><option>minimum_size</option></command></term>
151         <listitem>
152                 Minimum size of window
153         <para></para></listitem>
154 </varlistentry>
155
156 <varlistentry>
157         <term><command><option>mldonkey_hostname</option></command></term>
158         <listitem>
159                 Hostname for mldonkey stuff, defaults to localhost
160         <para></para></listitem>
161 </varlistentry>
162
163 <varlistentry>
164         <term><command><option>mldonkey_port</option></command></term>
165         <listitem>
166                 Mldonkey port, 4001 default
167         <para></para></listitem>
168 </varlistentry>
169
170 <varlistentry>
171         <term><command><option>mldonkey_login</option></command></term>
172         <listitem>
173                 Mldonkey login, default none
174         <para></para></listitem>
175 </varlistentry>
176
177 <varlistentry>
178         <term><command><option>mldonkey_password</option></command></term>
179         <listitem>
180                 Mldonkey password, default none
181         <para></para></listitem>
182 </varlistentry>
183
184 <varlistentry>
185         <term><command><option>mpd_host</option></command></term>
186         <listitem>
187                 Host of MPD server
188         <para></para></listitem>
189 </varlistentry>
190
191 <varlistentry>
192         <term><command><option>mpd_post</option></command></term>
193         <listitem>
194                 Port of MPD server
195         <para></para></listitem>
196 </varlistentry>
197
198 <varlistentry>
199         <term><command><option>mpd_password</option></command></term>
200         <listitem>
201                 MPD server password
202         <para></para></listitem>
203 </varlistentry>
204
205 <varlistentry>
206         <term><command><option>net_avg_samples</option></command></term>
207         <listitem>
208                 The number of samples to average for net data
209         <para></para></listitem>
210 </varlistentry>
211
212 <varlistentry>
213         <term><command><option>override_utf8_locale</option></command></term>
214         <listitem>
215                 Force UTF8? requires XFT
216         <para></para></listitem>
217 </varlistentry>
218
219 <varlistentry>
220         <term><command><option>own_window</option></command></term>
221         <listitem>
222                 Boolean, create own window to draw?
223         <para></para></listitem>
224 </varlistentry>
225
226 <varlistentry>
227         <term><command><option>pad_percents</option></command></term>
228         <listitem>
229                 Pad percentages to this many decimals (0 = no padding)
230         <para></para></listitem>
231 </varlistentry>
232
233 <varlistentry>
234         <term><command><option>stippled_borders</option></command></term>
235         <listitem>
236                 Border stippling (dashing) in pixels
237         <para></para></listitem>
238 </varlistentry>
239
240 <varlistentry>
241         <term><command><option>total_run_times</option></command></term>
242         <listitem>
243                 Total number of times for Conky to update before quitting. Zero makes Conky run forever
244         <para></para></listitem>
245 </varlistentry>
246
247 <varlistentry>
248         <term><command><option>update_interval</option></command></term>
249         <listitem>
250                 Update interval in seconds
251         <para></para></listitem>
252 </varlistentry>
253
254 <varlistentry>
255         <term><command><option>uppercase</option></command></term>
256         <listitem>
257                 Boolean value, if true, text is rendered in upper case
258         <para></para></listitem>
259 </varlistentry>
260
261 <varlistentry>
262         <term><command><option>use_spacer</option></command></term>
263         <listitem>
264                 Adds spaces after certain objects to stop them from moving other things around. Note that this only helps if you are using a mono font, such as Bitstream Vera Sans Mono.
265         <para></para></listitem>
266 </varlistentry>
267
268 <varlistentry>
269         <term><command><option>use_xft</option></command></term>
270         <listitem>
271                 Use Xft (anti-aliased font and stuff)
272         <para></para></listitem>
273 </varlistentry>
274
275 <varlistentry>
276         <term><command><option>text</option></command></term>
277         <listitem>
278                 After this begins text to be formatted on screen
279         <para></para></listitem>
280 </varlistentry>
281
282 </variablelist>