]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/systemctl.xml
man: use unicode ellipsis in more places
[thirdparty/systemd.git] / man / systemctl.xml
index 3b883ea754ec8e95ed0d1a797818f86c48565b0c..68c8546189fe6bd835c960775c95321c02d91ea3 100644 (file)
           <varname>RequiresMountsFor=</varname>). Both explicitly
           and implicitly introduced dependencies are shown with
           <command>list-dependencies</command>.</para>
+
+          <para>When passed to the <command>list-jobs</command> command, for each printed job show which other jobs are
+          waiting for it. May be combined with <option>--before</option> to show both the jobs waiting for each job as
+          well as all jobs each job is waiting for.</para>
         </listitem>
       </varlistentry>
 
           units that are ordered after the specified unit. In other
           words, recursively list units following the
           <varname>Before=</varname> dependency.</para>
+
+          <para>When passed to the <command>list-jobs</command> command, for each printed job show which other jobs it
+          is waiting for. May be combined with <option>--after</option> to show both the jobs waiting for each job as
+          well as all jobs each job is waiting for.</para>
         </listitem>
       </varlistentry>
 
           of <command>status</command>, <command>list-units</command>,
           <command>list-jobs</command>, and
           <command>list-timers</command>.</para>
+          <para>Also, show installation targets in the output of
+          <command>is-enabled</command>.</para>
         </listitem>
       </varlistentry>
 
         <para><literal>ignore-requirements</literal> is similar to
         <literal>ignore-dependencies</literal>, but only causes the
         requirement dependencies to be ignored, the ordering
-        dependencies will still be honoured.</para>
+        dependencies will still be honored.</para>
         </listitem>
 
       </varlistentry>
         <listitem>
           <para>When used with
           <command>enable</command>/<command>disable</command>/<command>is-enabled</command>
-          (and related commands), use an alternate root path when
-          looking for unit files.</para>
+          (and related commands), use the specified root path when looking for unit
+          files. If this option is present, <command>systemctl</command> will operate on
+          the file system directly, instead of communicating with the <command>systemd</command>
+          daemon to carry out changes.</para>
         </listitem>
 
       </varlistentry>
 
       <variablelist>
         <varlistentry>
-          <term><command>list-units <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
+          <term><command>list-units <optional><replaceable>PATTERN</replaceable></optional></command></term>
 
           <listitem>
             <para>List units that <command>systemd</command> currently has in memory. This includes units that are
         </varlistentry>
 
         <varlistentry>
-          <term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
+          <term><command>list-sockets <optional><replaceable>PATTERN</replaceable></optional></command></term>
 
           <listitem>
             <para>List socket units currently in memory, ordered by listening address.  If one or more
             <programlisting>
 LISTEN           UNIT                        ACTIVATES
 /dev/initctl     systemd-initctl.socket      systemd-initctl.service
-...
+…
 [::]:22          sshd.socket                 sshd.service
 kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 
@@ -691,7 +703,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
-          <term><command>list-timers <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
+          <term><command>list-timers <optional><replaceable>PATTERN</replaceable></optional></command></term>
 
           <listitem>
             <para>List timer units currently in memory, ordered by the time they elapse next. If one or more
@@ -703,7 +715,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
-          <term><command>start <replaceable>PATTERN</replaceable>...</command></term>
+          <term><command>start <replaceable>PATTERN</replaceable></command></term>
 
           <listitem>
             <para>Start (activate) one or more units specified on the
@@ -717,7 +729,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>stop <replaceable>PATTERN</replaceable>...</command></term>
+          <term><command>stop <replaceable>PATTERN</replaceable></command></term>
 
           <listitem>
             <para>Stop (deactivate) one or more units specified on the
@@ -725,7 +737,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>reload <replaceable>PATTERN</replaceable>...</command></term>
+          <term><command>reload <replaceable>PATTERN</replaceable></command></term>
 
           <listitem>
             <para>Asks all units listed on the command line to reload
@@ -745,7 +757,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 
         </varlistentry>
         <varlistentry>
-          <term><command>restart <replaceable>PATTERN</replaceable>...</command></term>
+          <term><command>restart <replaceable>PATTERN</replaceable></command></term>
 
           <listitem>
             <para>Restart one or more units specified on the command
@@ -754,7 +766,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>try-restart <replaceable>PATTERN</replaceable>...</command></term>
+          <term><command>try-restart <replaceable>PATTERN</replaceable></command></term>
 
           <listitem>
             <para>Restart one or more units specified on the command
@@ -765,7 +777,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>reload-or-restart <replaceable>PATTERN</replaceable>...</command></term>
+          <term><command>reload-or-restart <replaceable>PATTERN</replaceable></command></term>
 
           <listitem>
             <para>Reload one or more units if they support it. If not,
@@ -774,7 +786,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>try-reload-or-restart <replaceable>PATTERN</replaceable>...</command></term>
+          <term><command>try-reload-or-restart <replaceable>PATTERN</replaceable></command></term>
 
           <listitem>
             <para>Reload one or more units if they support it. If not,
@@ -806,7 +818,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>kill <replaceable>PATTERN</replaceable>...</command></term>
+          <term><command>kill <replaceable>PATTERN</replaceable></command></term>
 
           <listitem>
             <para>Send a signal to one or more processes of the
@@ -816,7 +828,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>is-active <replaceable>PATTERN</replaceable>...</command></term>
+          <term><command>is-active <replaceable>PATTERN</replaceable></command></term>
 
           <listitem>
             <para>Check whether any of the specified units are active
@@ -828,7 +840,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>is-failed <replaceable>PATTERN</replaceable>...</command></term>
+          <term><command>is-failed <replaceable>PATTERN</replaceable></command></term>
 
           <listitem>
             <para>Check whether any of the specified units are in a
@@ -840,7 +852,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>status</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...]</optional></term>
+          <term><command>status</command> <optional><replaceable>PATTERN</replaceable>…|<replaceable>PID</replaceable>…]</optional></term>
 
           <listitem>
             <para>Show terse runtime status information about one or
@@ -867,14 +879,14 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>show</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>JOB</replaceable>...</optional></term>
+          <term><command>show</command> <optional><replaceable>PATTERN</replaceable>…|<replaceable>JOB</replaceable>…</optional></term>
 
           <listitem>
             <para>Show properties of one or more units, jobs, or the
             manager itself. If no argument is specified, properties of
             the manager will be shown. If a unit name is specified,
-            properties of the unit is shown, and if a job ID is
-            specified, properties of the job is shown. By default, empty
+            properties of the unit are shown, and if a job ID is
+            specified, properties of the job are shown. By default, empty
             properties are suppressed. Use <option>--all</option> to
             show those too. To select specific properties to show, use
             <option>--property=</option>. This command is intended to be
@@ -884,17 +896,21 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>cat <replaceable>PATTERN</replaceable>...</command></term>
+          <term><command>cat <replaceable>PATTERN</replaceable></command></term>
 
           <listitem>
             <para>Show backing files of one or more units. Prints the
             "fragment" and "drop-ins" (source files) of units. Each
             file is preceded by a comment which includes the file
-            name.</para>
+            name. Note that this shows the contents of the backing files
+            on disk, which may not match the system manager's
+            understanding of these units if any unit files were
+            updated on disk and the <command>daemon-reload</command>
+            command wasn't issued since.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>set-property <replaceable>NAME</replaceable> <replaceable>ASSIGNMENT</replaceable>...</command></term>
+          <term><command>set-property <replaceable>NAME</replaceable> <replaceable>ASSIGNMENT</replaceable></command></term>
 
           <listitem>
             <para>Set the specified unit properties at runtime where
@@ -925,7 +941,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
-          <term><command>help <replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...</command></term>
+          <term><command>help <replaceable>PATTERN</replaceable>…|<replaceable>PID</replaceable>…</command></term>
 
           <listitem>
             <para>Show manual pages for one or more units, if
@@ -935,7 +951,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
-          <term><command>reset-failed [<replaceable>PATTERN</replaceable>...]</command></term>
+          <term><command>reset-failed [<replaceable>PATTERN</replaceable>]</command></term>
 
           <listitem>
             <para>Reset the <literal>failed</literal> state of the
@@ -983,7 +999,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 
       <variablelist>
         <varlistentry>
-          <term><command>list-unit-files <optional><replaceable>PATTERN...</replaceable></optional></command></term>
+          <term><command>list-unit-files <optional><replaceable>PATTERN</replaceable></optional></command></term>
 
           <listitem>
             <para>List unit files installed on the system, in combination with their enablement state (as reported by
@@ -994,8 +1010,8 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
-          <term><command>enable <replaceable>NAME</replaceable>...</command></term>
-          <term><command>enable <replaceable>PATH</replaceable>...</command></term>
+          <term><command>enable <replaceable>NAME</replaceable></command></term>
+          <term><command>enable <replaceable>PATH</replaceable></command></term>
 
           <listitem>
             <para>Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the
@@ -1006,7 +1022,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
             desired, combine this command with the <option>--now</option> switch, or invoke <command>start</command>
             with appropriate arguments later. Note that in case of unit instance enablement (i.e. enablement of units of
             the form <filename>foo@bar.service</filename>), symlinks named the same as instances are created in the
-            unit configuration diectory, however they point to the single template unit file they are instantiated
+            unit configuration directory, however they point to the single template unit file they are instantiated
             from.</para>
 
             <para>This command expects either valid unit names (in which case various unit file directories are
@@ -1045,7 +1061,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
-          <term><command>disable <replaceable>NAME</replaceable>...</command></term>
+          <term><command>disable <replaceable>NAME</replaceable></command></term>
 
           <listitem>
             <para>Disables one or more units. This removes all symlinks to the unit files backing the specified units
@@ -1077,7 +1093,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
-          <term><command>reenable <replaceable>NAME</replaceable>...</command></term>
+          <term><command>reenable <replaceable>NAME</replaceable></command></term>
 
           <listitem>
             <para>Reenable one or more units, as specified on the command line. This is a combination of
@@ -1088,7 +1104,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
-          <term><command>preset <replaceable>NAME</replaceable>...</command></term>
+          <term><command>preset <replaceable>NAME</replaceable></command></term>
 
           <listitem>
             <para>Reset the enable/disable status one or more unit files, as specified on
@@ -1126,7 +1142,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
-          <term><command>is-enabled <replaceable>NAME</replaceable>...</command></term>
+          <term><command>is-enabled <replaceable>NAME</replaceable></command></term>
 
           <listitem>
             <para>Checks whether any of the specified unit files are
@@ -1134,6 +1150,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
             exit code of 0 if at least one is enabled, non-zero
             otherwise. Prints the current enable status (see table).
             To suppress this output, use <option>--quiet</option>.
+            To show installation targets, use <option>--full</option>.
             </para>
 
             <table>
@@ -1212,7 +1229,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
-          <term><command>mask <replaceable>NAME</replaceable>...</command></term>
+          <term><command>mask <replaceable>NAME</replaceable></command></term>
 
           <listitem>
             <para>Mask one or more units, as specified on the command line. This will link these unit files to
@@ -1226,7 +1243,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
-          <term><command>unmask <replaceable>NAME</replaceable>...</command></term>
+          <term><command>unmask <replaceable>NAME</replaceable></command></term>
 
           <listitem>
             <para>Unmask one or more unit files, as specified on the command line. This will undo the effect of
@@ -1236,7 +1253,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
-          <term><command>link <replaceable>PATH</replaceable>...</command></term>
+          <term><command>link <replaceable>PATH</replaceable></command></term>
 
           <listitem>
             <para>Link a unit file that is not in the unit file search paths into the unit file search path. This
@@ -1247,7 +1264,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
-          <term><command>revert <replaceable>NAME</replaceable>...</command></term>
+          <term><command>revert <replaceable>NAME</replaceable></command></term>
 
           <listitem>
             <para>Revert one or more unit files to their vendor versions. This command removes drop-in configuration
@@ -1256,7 +1273,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
             <literal>foo.service.d/</literal> with all their contained files are removed, both below the persistent and
             runtime configuration directories (i.e. below <filename>/etc/systemd/system</filename> and
             <filename>/run/systemd/system</filename>); if the unit file has a vendor-supplied version (i.e. a unit file
-            located below <filename>/usr</filename>) any matching peristent or runtime unit file that overrides it is
+            located below <filename>/usr</filename>) any matching persistent or runtime unit file that overrides it is
             removed, too. Note that if a unit file has no vendor-supplied version (i.e. is only defined below
             <filename>/etc/systemd/system</filename> or <filename>/run/systemd/system</filename>, but not in a unit
             file stored below <filename>/usr</filename>), then it is not removed. Also, if a unit is masked, it is
@@ -1270,9 +1287,9 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 
         <varlistentry>
           <term><command>add-wants <replaceable>TARGET</replaceable>
-          <replaceable>NAME</replaceable>...</command></term>
+          <replaceable>NAME</replaceable></command></term>
           <term><command>add-requires <replaceable>TARGET</replaceable>
-          <replaceable>NAME</replaceable>...</command></term>
+          <replaceable>NAME</replaceable></command></term>
 
           <listitem>
             <para>Adds <literal>Wants=</literal> or <literal>Requires=</literal>
@@ -1288,7 +1305,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         </varlistentry>
 
         <varlistentry>
-          <term><command>edit <replaceable>NAME</replaceable>...</command></term>
+          <term><command>edit <replaceable>NAME</replaceable></command></term>
 
           <listitem>
             <para>Edit a drop-in snippet or a whole replacement file if
@@ -1355,7 +1372,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 
       <variablelist>
         <varlistentry>
-          <term><command>list-machines <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
+          <term><command>list-machines <optional><replaceable>PATTERN</replaceable></optional></command></term>
 
           <listitem>
             <para>List the host and all running local containers with
@@ -1373,16 +1390,20 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 
       <variablelist>
         <varlistentry>
-          <term><command>list-jobs <optional><replaceable>PATTERN...</replaceable></optional></command></term>
+          <term><command>list-jobs <optional><replaceable>PATTERN</replaceable></optional></command></term>
 
           <listitem>
             <para>List jobs that are in progress. If one or more
             <replaceable>PATTERN</replaceable>s are specified, only
             jobs for units matching one of them are shown.</para>
+
+            <para>When combined with <option>--after</option> or <option>--before</option> the list is augmented with
+            information on which other job each job is waiting for, and which other jobs are waiting for it, see
+            above.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>cancel <replaceable>JOB</replaceable>...</command></term>
+          <term><command>cancel <replaceable>JOB</replaceable></command></term>
 
           <listitem>
             <para>Cancel one or more jobs specified on the command line
@@ -1409,7 +1430,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>...</command></term>
+          <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable></command></term>
 
           <listitem>
             <para>Set one or more systemd manager environment variables,
@@ -1417,7 +1438,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>unset-environment <replaceable>VARIABLE</replaceable>...</command></term>
+          <term><command>unset-environment <replaceable>VARIABLE</replaceable></command></term>
 
           <listitem>
             <para>Unset one or more systemd manager environment
@@ -1430,7 +1451,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
         <varlistentry>
           <term>
             <command>import-environment</command>
-            <optional><replaceable>VARIABLE...</replaceable></optional>
+            <optional><replaceable>VARIABLE</replaceable></optional>
           </term>
 
           <listitem>
@@ -1738,7 +1759,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
       <title>Parameter Syntax</title>
 
       <para>Unit commands listed above take either a single unit name (designated as <replaceable>NAME</replaceable>),
-      or multiple unit specifications (designated as <replaceable>PATTERN</replaceable>...). In the first case, the
+      or multiple unit specifications (designated as <replaceable>PATTERN</replaceable>). In the first case, the
       unit name with or without a suffix must be given. If the suffix is not specified (unit name is "abbreviated"),
       systemctl will append a suitable suffix, <literal>.service</literal> by default, and a type-specific suffix in
       case of commands which operate only on specific unit types. For example,