man/standard-options.xml

   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     xmlns:xi="http://www.w3.org/2001/XInclude">
   8
   9   <varlistentry id='help'>
  10     <term><option>-h</option></term>
  11     <term><option>--help</option></term>
  12
  13     <listitem id='help-text'>
  14       <para>Print a short help text and exit.
  15     </para></listitem>
  16   </varlistentry>
  17
  18   <varlistentry id='version'>
  19     <term><option>--version</option></term>
  20
  21     <listitem id='version-text'>
  22       <para>Print a short version string and exit.</para>
  23     </listitem>
  24   </varlistentry>
  25
  26   <varlistentry id='no-pager'>
  27     <term><option>--no-pager</option></term>
  28
  29     <listitem>
  30       <para>Do not pipe output into a pager.</para>
  31     </listitem>
  32   </varlistentry>
  33
  34   <varlistentry id='no-pager-255'>
  35     <term><option>--no-pager</option></term>
  36
  37     <listitem>
  38       <para>Do not pipe output into a pager.</para>
  39
  40       <xi:include href="version-info.xml" xpointer="v255"/>
  41     </listitem>
  42   </varlistentry>
  43
  44   <varlistentry id='no-ask-password'>
  45     <term><option>--no-ask-password</option></term>
  46
  47     <listitem><para>Do not query the user for authentication for privileged operations.</para></listitem>
  48   </varlistentry>
  49
  50   <varlistentry id='legend'>
  51     <term><option>--legend=</option><replaceable>BOOL</replaceable></term>
  52
  53     <listitem>
  54       <para>Enable or disable printing of the legend, i.e. column headers and the footer with hints. The
  55       legend is printed by default, unless disabled with <option>--quiet</option> or similar.</para>
  56     </listitem>
  57   </varlistentry>
  58
  59   <varlistentry id='no-legend'>
  60     <term><option>--no-legend</option></term>
  61
  62     <listitem>
  63       <para>Do not print the legend, i.e. column headers and the
  64       footer with hints.</para>
  65     </listitem>
  66   </varlistentry>
  67
  68   <varlistentry id='cat-config'>
  69     <term><option>--cat-config</option></term>
  70
  71     <listitem>
  72       <para>Copy the contents of config files to standard output.
  73       Before each file, the filename is printed as a comment.</para>
  74     </listitem>
  75   </varlistentry>
  76
  77   <varlistentry id='tldr'>
  78     <term><option>--tldr</option></term>
  79
  80     <listitem>
  81       <para>Copy the contents of config files to standard output. Only the "interesting" parts of the
  82       configuration files are printed, comments and empty lines are skipped. Before each file, the filename
  83       is printed as a comment.</para>
  84     </listitem>
  85   </varlistentry>
  86
  87   <varlistentry id='json'>
  88     <term><option>--json=</option><replaceable>MODE</replaceable></term>
  89
  90     <listitem><para>Shows output formatted as JSON. Expects one of <literal>short</literal> (for the
  91     shortest possible output without any redundant whitespace or line breaks), <literal>pretty</literal>
  92     (for a pretty version of the same, with indentation and line breaks) or <literal>off</literal> (to turn
  93     off JSON output, the default).</para></listitem>
  94   </varlistentry>
  95
  96   <varlistentry id='signal'>
  97     <term><option>-s</option></term>
  98     <term><option>--signal=</option></term>
  99
 100     <listitem>
 101       <para>When used with <command>kill</command>, choose which signal to send to selected processes. Must
 102       be one of the well-known signal specifiers such as <constant>SIGTERM</constant>,
 103       <constant>SIGINT</constant> or <constant>SIGSTOP</constant>. If omitted, defaults to
 104       <option>SIGTERM</option>.</para>
 105
 106       <para>The special value <literal>help</literal> will list the known values and the program will exit
 107       immediately, and the special value <literal>list</literal> will list known values along with the
 108       numerical signal numbers and the program will exit immediately.</para>
 109     </listitem>
 110   </varlistentry>
 111
 112   <varlistentry id='image-policy-open'>
 113     <term><option>--image-policy=<replaceable>policy</replaceable></option></term>
 114
 115     <listitem><para>Takes an image policy string as argument, as per
 116     <citerefentry><refentrytitle>systemd.image-policy</refentrytitle><manvolnum>7</manvolnum></citerefentry>. The
 117     policy is enforced when operating on the disk image specified via <option>--image=</option>, see
 118     above. If not specified defaults to the <literal>*</literal> policy, i.e. all recognized file systems
 119     in the image are used.</para></listitem>
 120   </varlistentry>
 121
 122   <varlistentry id='esp-path'>
 123     <term><option>--esp-path=</option></term>
 124
 125     <listitem>
 126       <para>Path to the EFI System Partition (ESP). If not specified, <filename>/efi/</filename>,
 127       <filename>/boot/</filename>, and <filename>/boot/efi/</filename> are checked in turn. It is
 128       recommended to mount the ESP to <filename>/efi/</filename>, if possible.</para>
 129     </listitem>
 130   </varlistentry>
 131
 132   <varlistentry id='boot-path'>
 133     <term><option>--boot-path=</option></term>
 134
 135     <listitem>
 136       <para>Path to the Extended Boot Loader partition, as defined in the
 137       <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink>.
 138       If not specified, <filename>/boot/</filename> is checked. It is recommended to mount the Extended Boot
 139       Loader partition to <filename>/boot/</filename>, if possible.</para>
 140     </listitem>
 141   </varlistentry>
 142
 143 </variablelist>