man/standard-options.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE variablelist 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 id='help-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=<replaceable>BOOL</replaceable></option></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='tldr'>
  66     <term><option>--tldr</option></term>
  67
  68     <listitem>
  69       <para>Copy the contents of config files to standard output. Only the "interesting" parts of the
  70       configuration files are printed, comments and empty lines are skipped. Before each file, the filename
  71       is printed as a comment.</para>
  72     </listitem>
  73   </varlistentry>
  74
  75   <varlistentry id='json'>
  76     <term><option>--json=<replaceable>MODE</replaceable></option></term>
  77
  78     <listitem><para>Shows output formatted as JSON. Expects one of <literal>short</literal> (for the
  79     shortest possible output without any redundant whitespace or line breaks), <literal>pretty</literal>
  80     (for a pretty version of the same, with indentation and line breaks) or <literal>off</literal> (to turn
  81     off JSON output, the default).</para></listitem>
  82   </varlistentry>
  83
  84   <varlistentry id='j'>
  85     <term><option>-j</option></term>
  86
  87     <listitem><para>Equivalent to <option>--json=pretty</option> if running on a terminal, and
  88     <option>--json=short</option> otherwise.</para></listitem>
  89   </varlistentry>
  90
  91   <varlistentry id='signal'>
  92     <term><option>-s</option></term>
  93     <term><option>--signal=</option></term>
  94
  95     <listitem>
  96       <para>When used with <command>kill</command>, choose which signal to send to selected processes. Must
  97       be one of the well-known signal specifiers such as <constant>SIGTERM</constant>,
  98       <constant>SIGINT</constant> or <constant>SIGSTOP</constant>. If omitted, defaults to
  99       <option>SIGTERM</option>.</para>
 100
 101       <para>The special value <literal>help</literal> will list the known values and the program will exit
 102       immediately, and the special value <literal>list</literal> will list known values along with the
 103       numerical signal numbers and the program will exit immediately.</para>
 104     </listitem>
 105   </varlistentry>
 106
 107   <varlistentry id='image-policy-open'>
 108     <term><option>--image-policy=<replaceable>policy</replaceable></option></term>
 109
 110     <listitem><para>Takes an image policy string as argument, as per
 111     <citerefentry><refentrytitle>systemd.image-policy</refentrytitle><manvolnum>7</manvolnum></citerefentry>. The
 112     policy is enforced when operating on the disk image specified via <option>--image=</option>, see
 113     above. If not specified defaults to the <literal>*</literal> policy, i.e. all recognized file systems
 114     in the image are used.</para></listitem>
 115   </varlistentry>
 116
 117   <varlistentry id='esp-path'>
 118     <term><option>--esp-path=</option></term>
 119
 120     <listitem>
 121       <para>Path to the EFI System Partition (ESP). If not specified, <filename>/efi/</filename>,
 122       <filename>/boot/</filename>, and <filename>/boot/efi/</filename> are checked in turn. It is
 123       recommended to mount the ESP to <filename>/efi/</filename>, if possible.</para>
 124     </listitem>
 125   </varlistentry>
 126
 127   <varlistentry id='boot-path'>
 128     <term><option>--boot-path=</option></term>
 129
 130     <listitem>
 131       <para>Path to the Extended Boot Loader partition, as defined in the
 132       <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink>.
 133       If not specified, <filename>/boot/</filename> is checked. It is recommended to mount the Extended Boot
 134       Loader partition to <filename>/boot/</filename>, if possible.</para>
 135     </listitem>
 136   </varlistentry>
 137
 138   <varlistentry id='option-P'>
 139     <term><option>-P</option></term>
 140
 141     <listitem>
 142       <para>Equivalent to <option>--value</option> <option>--property=</option>, i.e. shows the value of the
 143       property without the property name or <literal>=</literal>. Note that using <option>-P</option> once
 144       will also affect all properties listed with <option>-p</option>/<option>--property=</option>.</para>
 145     </listitem>
 146   </varlistentry>
 147 </variablelist>