| <?xml version="1.0"?> |
| <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
| "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> |
| <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
| |
| <variablelist> |
| <varlistentry id='help'> |
| <term><option>-h</option></term> |
| <term><option>--help</option></term> |
| |
| <listitem id='help-text'> |
| <para>Print a short help text and exit. |
| </para></listitem> |
| </varlistentry> |
| |
| <varlistentry id='version'> |
| <term><option>--version</option></term> |
| |
| <listitem id='version-text'> |
| <para>Print a short version string and exit.</para> |
| </listitem> |
| </varlistentry> |
| |
| <varlistentry id='no-pager'> |
| <term><option>--no-pager</option></term> |
| |
| <listitem> |
| <para>Do not pipe output into a pager.</para> |
| </listitem> |
| </varlistentry> |
| |
| <varlistentry id='no-ask-password'> |
| <term><option>--no-ask-password</option></term> |
| |
| <listitem><para>Do not query the user for authentication for privileged operations.</para></listitem> |
| </varlistentry> |
| |
| <varlistentry id='legend'> |
| <term><option>--legend=</option><replaceable>BOOL</replaceable></term> |
| |
| <listitem> |
| <para>Enable or disable printing of the legend, i.e. column headers and the footer with hints. The |
| legend is printed by default, unless disabled with <option>--quiet</option> or similar.</para> |
| </listitem> |
| </varlistentry> |
| |
| <varlistentry id='no-legend'> |
| <term><option>--no-legend</option></term> |
| |
| <listitem> |
| <para>Do not print the legend, i.e. column headers and the |
| footer with hints.</para> |
| </listitem> |
| </varlistentry> |
| |
| <varlistentry id='cat-config'> |
| <term><option>--cat-config</option></term> |
| |
| <listitem> |
| <para>Copy the contents of config files to standard output. |
| Before each file, the filename is printed as a comment.</para> |
| </listitem> |
| </varlistentry> |
| |
| <varlistentry id='json'> |
| <term><option>--json=</option><replaceable>MODE</replaceable></term> |
| |
| <listitem><para>Shows output formatted as JSON. Expects one of <literal>short</literal> (for the |
| shortest possible output without any redundant whitespace or line breaks), <literal>pretty</literal> |
| (for a pretty version of the same, with indentation and line breaks) or <literal>off</literal> (to turn |
| off JSON output, the default).</para></listitem> |
| </varlistentry> |
| |
| <varlistentry id='signal'> |
| <term><option>-s</option></term> |
| <term><option>--signal=</option></term> |
| |
| <listitem> |
| <para>When used with <command>kill</command>, choose which signal to send to selected processes. Must |
| be one of the well-known signal specifiers such as <constant>SIGTERM</constant>, |
| <constant>SIGINT</constant> or <constant>SIGSTOP</constant>. If omitted, defaults to |
| <option>SIGTERM</option>.</para> |
| |
| <para>The special value <literal>help</literal> will list the known values and the program will exit |
| immediately, and the special value <literal>list</literal> will list known values along with the |
| numerical signal numbers and the program will exit immediately.</para> |
| </listitem> |
| </varlistentry> |
| </variablelist> |