Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2025-01-29 18:18:39 +00:00
Code Issues Releases Activity

doc: add missing periods and other tweaks

Browse Source
This commit is contained in:
lasers 2018-12-31 06:36:59 -06:00
parent 3c1c74f541
commit e3469c25be
4 changed files with 251 additions and 254 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/command_options.xml
View File

@ -30,7 +30,7 @@
<option>FILE</option> <option>FILE</option>
</term> </term>
<listitem>Config file to load instead of <listitem>Config file to load instead of
$HOME/.config/conky/conky.conf ~/.config/conky/conky.conf.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -128,7 +128,7 @@
</command> </command>
<option>TEXT</option> <option>TEXT</option>
</term> </term>
<listitem>Text to render, remember single quotes, like -t ' $uptime ' <listitem>Text to render, remember single quotes, like -t ' $uptime '.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -169,7 +169,7 @@
</command> </command>
<option>X_COORDINATE</option> <option>X_COORDINATE</option>
</term> </term>
<listitem>X position <listitem>X position.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -179,7 +179,7 @@
</command> </command>
<option>X_COORDINATE</option> <option>X_COORDINATE</option>
</term> </term>
<listitem>X position <listitem>X position.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -200,7 +200,7 @@
</command> </command>
<option>Y_COORDINATE</option> <option>Y_COORDINATE</option>
</term> </term>
<listitem>Y position <listitem>Y position.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>

86
doc/config_settings.xml
View File

@ -96,7 +96,7 @@
</term> </term>
<listitem>A comma-separated list of strings to use as the bars of a <listitem>A comma-separated list of strings to use as the bars of a
graph output to console/shell. The first list item is used for the graph output to console/shell. The first list item is used for the
minimum bar height and the last item is used for the maximum. Example: minimum bar height and the last item is used for the maximum, e.g.
" ,_,=,#". " ,_,=,#".
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
@ -137,7 +137,7 @@
<option>default_color</option> <option>default_color</option>
</command> </command>
</term> </term>
<listitem>Default color and border color <listitem>Default color and border color.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -190,7 +190,7 @@
<option>default_outline_color</option> <option>default_outline_color</option>
</command> </command>
</term> </term>
<listitem>Default outline color <listitem>Default outline color.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -199,7 +199,7 @@
<option>default_shade_color</option> <option>default_shade_color</option>
</command> </command>
</term> </term>
<listitem>Default shading color and border's shading color <listitem>Default shading color and border's shading color.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -267,7 +267,7 @@
<option>draw_borders</option> <option>draw_borders</option>
</command> </command>
</term> </term>
<listitem>Draw borders around text? <listitem>Draw borders around text.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -276,7 +276,7 @@
<option>draw_graph_borders</option> <option>draw_graph_borders</option>
</command> </command>
</term> </term>
<listitem>Draw borders around graphs? <listitem>Draw borders around graphs.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -285,7 +285,7 @@
<option>draw_outline</option> <option>draw_outline</option>
</command> </command>
</term> </term>
<listitem>Draw outlines? <listitem>Draw outlines.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -294,7 +294,7 @@
<option>draw_shades</option> <option>draw_shades</option>
</command> </command>
</term> </term>
<listitem>Draw shades? <listitem>Draw shades.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -313,7 +313,7 @@
<option>font</option> <option>font</option>
</command> </command>
</term> </term>
<listitem>Font name in X, xfontsel can be used to get a nice font <listitem>Font name in X, xfontsel can be used to get a nice font.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -522,7 +522,7 @@
<option>mail_spool</option> <option>mail_spool</option>
</command> </command>
</term> </term>
<listitem>Mail spool for mail checking <listitem>Mail spool for mail checking.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -532,7 +532,7 @@
</command> </command>
</term> </term>
<listitem>Allow each port monitor to track at most this many <listitem>Allow each port monitor to track at most this many
connections (if 0 or not set, default is 256) connections (if 0 or not set, default is 256).
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -544,7 +544,7 @@
</term> </term>
<listitem>When a line in the output contains 'width' chars and the end <listitem>When a line in the output contains 'width' chars and the end
isn't reached, the next char will start on a new line. If you want to isn't reached, the next char will start on a new line. If you want to
make sure that lines don't get broken, set 'width' to 0 make sure that lines don't get broken, set 'width' to 0.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -555,7 +555,7 @@
<option>bytes</option> <option>bytes</option>
</term> </term>
<listitem>Maximum size of user text buffer, i.e. text inside <listitem>Maximum size of user text buffer, i.e. text inside
conky.text section in config file (default is 16384 bytes) conky.text section in config file (default is 16384 bytes).
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -565,7 +565,7 @@
</command> </command>
<option>pixels</option> <option>pixels</option>
</term> </term>
<listitem>Maximum width of window <listitem>Maximum width of window.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -575,7 +575,7 @@
</command> </command>
<option>height</option> <option>height</option>
</term> </term>
<listitem>Minimum height of the window <listitem>Minimum height of the window.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -585,7 +585,7 @@
</command> </command>
<option>width</option> <option>width</option>
</term> </term>
<listitem>Minimum width of window <listitem>Minimum width of window.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -594,7 +594,7 @@
<option>mpd_host</option> <option>mpd_host</option>
</command> </command>
</term> </term>
<listitem>Host of MPD server <listitem>Host of MPD server.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -603,7 +603,7 @@
<option>mpd_password</option> <option>mpd_password</option>
</command> </command>
</term> </term>
<listitem>MPD server password <listitem>MPD server password.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -612,7 +612,7 @@
<option>mpd_port</option> <option>mpd_port</option>
</command> </command>
</term> </term>
<listitem>Port of MPD server <listitem>Port of MPD server.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -621,7 +621,7 @@
<option>mysql_host</option> <option>mysql_host</option>
</command> </command>
</term> </term>
<listitem>Host of MySQL server. Defaults to localhost <listitem>Host of MySQL server. Defaults to localhost.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -630,7 +630,7 @@
<option>mysql_port</option> <option>mysql_port</option>
</command> </command>
</term> </term>
<listitem>Port of MySQL server. Defaults to the default mysql port <listitem>Port of MySQL server. Defaults to the default mysql port.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -640,7 +640,7 @@
</command> </command>
</term> </term>
<listitem>MySQL user name to use when connecting to the server. <listitem>MySQL user name to use when connecting to the server.
Defaults to your username Defaults to your username.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -650,7 +650,7 @@
</command> </command>
</term> </term>
<listitem>Password of the MySQL user. Place it between "-chars. When <listitem>Password of the MySQL user. Place it between "-chars. When
this is not set there is no password used this is not set there is no password used.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -659,7 +659,7 @@
<option>mysql_db</option> <option>mysql_db</option>
</command> </command>
</term> </term>
<listitem>MySQL database to use. Defaults to mysql <listitem>MySQL database to use. Defaults to mysql.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -669,7 +669,7 @@
</command> </command>
</term> </term>
<listitem>Music player thread update interval (defaults to Conky's <listitem>Music player thread update interval (defaults to Conky's
update interval) update interval).
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -678,7 +678,7 @@
<option>net_avg_samples</option> <option>net_avg_samples</option>
</command> </command>
</term> </term>
<listitem>The number of samples to average for net data <listitem>The number of samples to average for net data.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -687,7 +687,7 @@
<option>no_buffers</option> <option>no_buffers</option>
</command> </command>
</term> </term>
<listitem>Subtract (file system) buffers from used memory? <listitem>Subtract (file system) buffers from used memory.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -697,7 +697,7 @@
</command> </command>
</term> </term>
<listitem>The display that the nvidia variable will use (defaults to <listitem>The display that the nvidia variable will use (defaults to
the value of the display variable) the value of the display variable).
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -715,7 +715,7 @@
<option>out_to_http</option> <option>out_to_http</option>
</command> </command>
</term> </term>
<listitem>Let conky act as a small http-server serving it's text. <listitem>Let conky act as a small http-server serving its text.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -726,7 +726,7 @@
</term> </term>
<listitem>Print text in the console, but use ncurses so that conky can <listitem>Print text in the console, but use ncurses so that conky can
print the text of a new update over the old text. (In the future this print the text of a new update over the old text. (In the future this
will provide more useful things) will provide more useful things).
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -747,7 +747,7 @@
<listitem>When set to no, there will be no output in X (useful when <listitem>When set to no, there will be no output in X (useful when
you also use things like out_to_console). If you set it to no, make you also use things like out_to_console). If you set it to no, make
sure that it's placed before all other X-related setting (take the sure that it's placed before all other X-related setting (take the
first line of your configfile to be sure). Default value is yes first line of your configfile to be sure). Default value is yes.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -756,7 +756,7 @@
<option>override_utf8_locale</option> <option>override_utf8_locale</option>
</command> </command>
</term> </term>
<listitem>Force UTF8? requires XFT <listitem>Force UTF8. Requires XFT.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -774,7 +774,7 @@
<option>own_window</option> <option>own_window</option>
</command> </command>
</term> </term>
<listitem>Boolean, create own window to draw? <listitem>Boolean, create own window to draw.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -796,7 +796,7 @@
<listitem>If own_window_transparent no, set a specified background <listitem>If own_window_transparent no, set a specified background
colour (defaults to black). Takes either a hex value (e.g. '#ffffff'), colour (defaults to black). Takes either a hex value (e.g. '#ffffff'),
a shorthand hex value (e.g. '#fff'), or a valid RGB name (see a shorthand hex value (e.g. '#fff'), or a valid RGB name (see
/usr/lib/X11/rgb.txt) /usr/lib/X11/rgb.txt).
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -881,7 +881,7 @@
<option>pad_percents</option> <option>pad_percents</option>
</command> </command>
</term> </term>
<listitem>Pad percentages to this many decimals (0 = no padding) <listitem>Pad percentages to this many decimals (0 = no padding).
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -931,7 +931,7 @@
<option>stippled_borders</option> <option>stippled_borders</option>
</command> </command>
</term> </term>
<listitem>Border stippling (dashing) in pixels <listitem>Border stippling (dashing) in pixels.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -985,7 +985,7 @@
</command> </command>
</term> </term>
<listitem>If true, variables that output times output a number that <listitem>If true, variables that output times output a number that
represents seconds. This doesn't affect $time, $tztime and $utime represents seconds. This doesn't affect $time, $tztime and $utime.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1026,7 +1026,7 @@
</command> </command>
</term> </term>
<listitem>Total number of times for Conky to update before quitting. <listitem>Total number of times for Conky to update before quitting.
Zero makes Conky run forever Zero makes Conky run forever.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1036,7 +1036,7 @@
</command> </command>
<option>seconds</option> <option>seconds</option>
</term> </term>
<listitem>Update interval <listitem>Update interval.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1046,7 +1046,7 @@
</command> </command>
<option>seconds</option> <option>seconds</option>
</term> </term>
<listitem>Update interval when running on batterypower <listitem>Update interval when running on battery power.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1056,7 +1056,7 @@
</command> </command>
</term> </term>
<listitem>One or more batteries to check in order to use <listitem>One or more batteries to check in order to use
update_interval_on_battery (comma separated, BAT0 default) update_interval_on_battery (comma separated, BAT0 default).
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1065,7 +1065,7 @@
<option>uppercase</option> <option>uppercase</option>
</command> </command>
</term> </term>
<listitem>Boolean value, if true, text is rendered in upper case <listitem>Boolean value, if true, text is rendered in upper case.
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -1087,7 +1087,7 @@
<option>use_xft</option> <option>use_xft</option>
</command> </command>
</term> </term>
<listitem>Use Xft (anti-aliased font and stuff) <listitem>Use Xft (anti-aliased font and stuff).
<para /></listitem> <para /></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>

9
doc/docs.xml
View File

@ -180,24 +180,21 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>
<varname>conky</varname> <option>conky -t '${time %D %H:%M}' -o -u 30</option>
<option>-t '${time %D %H:%M}' -o -u 30</option>
</term> </term>
<listitem>Start Conky in its own window with date and clock as <listitem>Start Conky in its own window with date and clock as
text and 30 sec update interval.</listitem> text and 30 sec update interval.</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<varname>conky</varname> <option>conky -a top_left -x 5 -y 500 -d</option>
<option>-a top_left -x 5 -y 500 -d</option>
</term> </term>
<listitem>Start Conky to background at coordinates (5, <listitem>Start Conky to background at coordinates (5,
500).</listitem> 500).</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>
<varname>conky</varname> <option>conky -C &gt; ~/.config/conky/conky.conf</option>
<option>-C &gt; ~/.config/conky/conky.conf</option>
</term> </term>
<listitem>Do not start Conky, but have it output the builtin <listitem>Do not start Conky, but have it output the builtin
default config file to ~/.config/conky/conky.conf for later default config file to ~/.config/conky/conky.conf for later

400
doc/variables.xml
View File

File diff suppressed because it is too large Load Diff