fixed up some stuff in the docs
[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>maximum_width</option></command>
130                 <option>pixels</option>
131         </term>
132         <listitem>
133                 Maximum width of window
134                 <para></para></listitem>
135 </varlistentry>
136
137 <varlistentry>
138         <term><command><option>minimum_size</option></command>
139         <option>width (height)</option>
140         </term>
141         <listitem>
142                 Minimum size of window
143         <para></para></listitem>
144 </varlistentry>
145
146 <varlistentry>
147         <term><command><option>mldonkey_hostname</option></command></term>
148         <listitem>
149                 Hostname for mldonkey stuff, defaults to localhost
150         <para></para></listitem>
151 </varlistentry>
152
153 <varlistentry>
154         <term><command><option>mldonkey_port</option></command></term>
155         <listitem>
156                 Mldonkey port, 4001 default
157         <para></para></listitem>
158 </varlistentry>
159
160 <varlistentry>
161         <term><command><option>mldonkey_login</option></command></term>
162         <listitem>
163                 Mldonkey login, default none
164         <para></para></listitem>
165 </varlistentry>
166
167 <varlistentry>
168         <term><command><option>mldonkey_password</option></command></term>
169         <listitem>
170                 Mldonkey password, default none
171         <para></para></listitem>
172 </varlistentry>
173
174 <varlistentry>
175         <term><command><option>mpd_host</option></command></term>
176         <listitem>
177                 Host of MPD server
178         <para></para></listitem>
179 </varlistentry>
180
181 <varlistentry>
182         <term><command><option>mpd_port</option></command></term>
183         <listitem>
184                 Port of MPD server
185         <para></para></listitem>
186 </varlistentry>
187
188 <varlistentry>
189         <term><command><option>mpd_password</option></command></term>
190         <listitem>
191                 MPD server password
192         <para></para></listitem>
193 </varlistentry>
194
195 <varlistentry>
196         <term><command><option>net_avg_samples</option></command></term>
197         <listitem>
198                 The number of samples to average for net data
199         <para></para></listitem>
200 </varlistentry>
201
202 <varlistentry>
203         <term><command><option>override_utf8_locale</option></command></term>
204         <listitem>
205                 Force UTF8? requires XFT
206         <para></para></listitem>
207 </varlistentry>
208
209 <varlistentry>
210         <term><command><option>own_window</option></command></term>
211         <listitem>
212                 Boolean, create own window to draw?
213         <para></para></listitem>
214 </varlistentry>
215
216 <varlistentry>
217         <term><command><option>own_window_transparent</option></command></term>
218         <listitem>
219                 Boolean, set pseudo-transparency?
220                 <para></para></listitem>
221 </varlistentry>
222
223 <varlistentry>
224         <term><command><option>own_window_colour</option></command>
225                 <option>colour</option>
226         </term>
227         <listitem>
228                 If own_window_transparent no, set a specified background colour (defaults to black).  Takes either a hex value (#ffffff) or a valid RGB name (see /usr/lib/X11/rgb.txt)
229                 <para></para></listitem>
230 </varlistentry>
231
232 <varlistentry>
233         <term><command><option>pad_percents</option></command></term>
234         <listitem>
235                 Pad percentages to this many decimals (0 = no padding)
236         <para></para></listitem>
237 </varlistentry>
238
239 <varlistentry>
240         <term><command><option>stippled_borders</option></command></term>
241         <listitem>
242                 Border stippling (dashing) in pixels
243         <para></para></listitem>
244 </varlistentry>
245
246 <varlistentry>
247         <term><command><option>total_run_times</option></command></term>
248         <listitem>
249                 Total number of times for Conky to update before quitting. Zero makes Conky run forever
250         <para></para></listitem>
251 </varlistentry>
252
253 <varlistentry>
254         <term><command><option>update_interval</option></command></term>
255         <listitem>
256                 Update interval in seconds
257         <para></para></listitem>
258 </varlistentry>
259
260 <varlistentry>
261         <term><command><option>uppercase</option></command></term>
262         <listitem>
263                 Boolean value, if true, text is rendered in upper case
264         <para></para></listitem>
265 </varlistentry>
266
267 <varlistentry>
268         <term><command><option>use_spacer</option></command></term>
269         <listitem>
270                 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.
271         <para></para></listitem>
272 </varlistentry>
273
274 <varlistentry>
275         <term><command><option>use_xft</option></command></term>
276         <listitem>
277                 Use Xft (anti-aliased font and stuff)
278         <para></para></listitem>
279 </varlistentry>
280
281 <varlistentry>
282         <term><command><option>TEXT</option></command></term>
283         <listitem>
284                 After this begins text to be formatted on screen
285         <para></para></listitem>
286 </varlistentry>
287
288 </variablelist>