1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-26 12:27:52 +00:00
conky/doc/command_options.xml
Nelis Oostens ebbf28c79b Update command options documentation (#247)
- Removed deprecated option (-s)
 - Added info (build flag)
 - Sorted alphabetically

This fixes issue #203
2016-05-06 07:25:06 -04:00

202 lines
5.9 KiB
XML

<variablelist>
<varlistentry>
<term>
<command>
<option>-a | --alignment=</option>
</command>
<option>ALIGNMENT</option>
</term>
<listitem>Text alignment on screen,
{top,bottom,middle}_{left,right,middle} or none. Can also
be abbreviated with first chars of position, ie. tr for
top_right. Only available with build flag BUILD_X11 enabled.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-b | --double-buffer</option>
</command>
</term>
<listitem>Use double buffering (eliminates "flicker"). Only available with build flag BUILD_X11 enabled.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-c | --config=</option>
</command>
<option>FILE</option>
</term>
<listitem>Config file to load instead of $HOME/.config/conky/conky.conf
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-C | --print-config</option>
</command>
</term>
<listitem>Print builtin default config to stdout. See also
the section EXAMPLES for more information. Only available with build flag BUILD_BUILTIN_CONFIG enabled.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-d | --daemonize</option>
</command>
</term>
<listitem>Daemonize Conky, aka fork to background.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-D | --debug</option>
</command>
</term>
<listitem>Increase debugging output, ie. -DD for more
debugging.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-f | --font=</option>
</command>
<option>FONT</option>
</term>
<listitem>Font to use. Only available with build flag BUILD_X11 enabled.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-h | --help</option>
</command>
</term>
<listitem>Prints command line help and exits.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-i</option>
</command>
<option>COUNT</option>
</term>
<listitem>Number of times to update Conky (and quit).
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-o | --own-window</option>
</command>
</term>
<listitem>Create own window to draw. Only available with build flag BUILD_X11 enabled.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-p | --pause=</option>
</command>
<option>SECONDS</option>
</term>
<listitem>Time to pause/wait before actually starting Conky.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-q | --quiet</option>
</command>
</term>
<listitem>Run Conky in 'quiet mode' (ie. no output).
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-t | --text=</option>
</command>
<option>TEXT</option>
</term>
<listitem>Text to render, remember single quotes, like -t '
$uptime '
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-u | --interval=</option>
</command>
<option>SECONDS</option>
</term>
<listitem>Update interval.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-v | -V | --version</option>
</command>
</term>
<listitem>Prints version, build information and general info.
Exits after printing.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-w | --window-id=</option>
</command>
<option>WIN_ID</option>
</term>
<listitem>Window id to draw. Only available with build flag BUILD_X11 enabled.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-x</option>
</command>
<option>X_COORDINATE</option>
</term>
<listitem>X position
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-x</option>
</command>
<option>X_COORDINATE</option>
</term>
<listitem>X position
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-X | --display=</option>
</command>
<option>DISPLAY</option>
</term>
<listitem>X11 display to use. Only available with build flag BUILD_X11 enabled.
<para></para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>
<option>-y</option>
</command>
<option>Y_COORDINATE</option>
</term>
<listitem>Y position
<para></para></listitem>
</varlistentry>
</variablelist>