1<?xml version="1.0"?>
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
4<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
5
6<variablelist>
7  <varlistentry id='help'>
8    <term><option>-h</option></term>
9    <term><option>--help</option></term>
10
11    <listitem id='help-text'>
12      <para>Print a short help text and exit.
13    </para></listitem>
14  </varlistentry>
15
16  <varlistentry id='version'>
17    <term><option>--version</option></term>
18
19    <listitem id='version-text'>
20      <para>Print a short version string and exit.</para>
21    </listitem>
22  </varlistentry>
23
24  <varlistentry id='no-pager'>
25    <term><option>--no-pager</option></term>
26
27    <listitem>
28      <para>Do not pipe output into a pager.</para>
29    </listitem>
30  </varlistentry>
31
32  <varlistentry id='no-ask-password'>
33    <term><option>--no-ask-password</option></term>
34
35    <listitem><para>Do not query the user for authentication for privileged operations.</para></listitem>
36  </varlistentry>
37
38  <varlistentry id='legend'>
39    <term><option>--legend=</option><replaceable>BOOL</replaceable></term>
40
41    <listitem>
42      <para>Enable or disable printing of the legend, i.e. column headers and the footer with hints. The
43      legend is printed by default, unless disabled with <option>--quiet</option> or similar.</para>
44    </listitem>
45  </varlistentry>
46
47  <varlistentry id='no-legend'>
48    <term><option>--no-legend</option></term>
49
50    <listitem>
51      <para>Do not print the legend, i.e. column headers and the
52      footer with hints.</para>
53    </listitem>
54  </varlistentry>
55
56  <varlistentry id='cat-config'>
57    <term><option>--cat-config</option></term>
58
59    <listitem>
60      <para>Copy the contents of config files to standard output.
61      Before each file, the filename is printed as a comment.</para>
62    </listitem>
63  </varlistentry>
64
65  <varlistentry id='json'>
66    <term><option>--json=</option><replaceable>MODE</replaceable></term>
67
68    <listitem><para>Shows output formatted as JSON. Expects one of <literal>short</literal> (for the
69    shortest possible output without any redundant whitespace or line breaks), <literal>pretty</literal>
70    (for a pretty version of the same, with indentation and line breaks) or <literal>off</literal> (to turn
71    off JSON output, the default).</para></listitem>
72  </varlistentry>
73
74  <varlistentry id='signal'>
75    <term><option>-s</option></term>
76    <term><option>--signal=</option></term>
77
78    <listitem>
79      <para>When used with <command>kill</command>, choose which signal to send to selected processes. Must
80      be one of the well-known signal specifiers such as <constant>SIGTERM</constant>,
81      <constant>SIGINT</constant> or <constant>SIGSTOP</constant>. If omitted, defaults to
82      <option>SIGTERM</option>.</para>
83
84      <para>The special value <literal>help</literal> will list the known values and the program will exit
85      immediately, and the special value <literal>list</literal> will list known values along with the
86      numerical signal numbers and the program will exit immediately.</para>
87    </listitem>
88  </varlistentry>
89</variablelist>
90