chiark / gitweb /
update TODO
[elogind.git] / man / systemctl.xml
index 10e0f82441368eb8460b260e7692fbbb96963bd5..c21ed855659d1ed88abcc239438b566d1515f777 100644 (file)
@@ -44,7 +44,7 @@
 
         <refnamediv>
                 <refname>systemctl</refname>
 
         <refnamediv>
                 <refname>systemctl</refname>
-                <refpurpose>Control the systemd system and session manager</refpurpose>
+                <refpurpose>Control the systemd system and service manager</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
         </refnamediv>
 
         <refsynopsisdiv>
@@ -59,7 +59,7 @@
                 <para><command>systemctl</command> may be used to
                 introspect and control the state of the
                 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 <para><command>systemctl</command> may be used to
                 introspect and control the state of the
                 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-                system and session manager.</para>
+                system and service manager.</para>
         </refsect1>
 
         <refsect1>
         </refsect1>
 
         <refsect1>
                                 <listitem><para>Suppress output to
                                 STDOUT in
                                 <command>snapshot</command>,
                                 <listitem><para>Suppress output to
                                 STDOUT in
                                 <command>snapshot</command>,
-                                <command>check</command>,
+                                <command>is-active</command>,
                                 <command>enable</command> and
                                 <command>disable</command>.</para></listitem>
                         </varlistentry>
                                 <command>enable</command> and
                                 <command>disable</command>.</para></listitem>
                         </varlistentry>
                                 argument it is only verified and
                                 enqueued.</para></listitem> </varlistentry>
 
                                 argument it is only verified and
                                 enqueued.</para></listitem> </varlistentry>
 
+                        <varlistentry>
+                                <term><option>--no-pager</option></term>
+
+                               <listitem><para>Do not pipe output into a
+                               pager.</para></listitem>
+                       </varlistentry>
+
                         <varlistentry>
                                 <term><option>--system</option></term>
 
                         <varlistentry>
                                 <term><option>--system</option></term>
 
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--session</option></term>
+                                <term><option>--user</option></term>
 
                                 <listitem><para>Talk to the systemd
 
                                 <listitem><para>Talk to the systemd
-                                session manager of the calling user.</para></listitem>
+                                manager of the calling user.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>
                                 <listitem><para>When used with
                                 <command>enable</command> and
                                 <command>disable</command>, operate on the
                                 <listitem><para>When used with
                                 <command>enable</command> and
                                 <command>disable</command>, operate on the
-                                global session configuĊ•ation
+                                global user configuration
                                 directory, thus enabling or disabling
                                 a unit file globally for all future
                                 directory, thus enabling or disabling
                                 a unit file globally for all future
-                                sessions of all users.</para></listitem>
+                                logins of all users.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>
                                 <command>systemctl</command> will
                                 query the user on the terminal for the
                                 necessary secrets. Use this option to
                                 <command>systemctl</command> will
                                 query the user on the terminal for the
                                 necessary secrets. Use this option to
-                                switch this behaviour off. In this
+                                switch this behavior off. In this
                                 case the password must be supplied by
                                 some other means (for example
                                 graphical password agents) or the
                                 case the password must be supplied by
                                 some other means (for example
                                 graphical password agents) or the
                                 <option>process</option> to select
                                 whether to kill the entire control
                                 group, the process group or only the
                                 <option>process</option> to select
                                 whether to kill the entire control
                                 group, the process group or only the
-                                selected process itself. If ommitted
+                                selected process itself. If omitted
                                 defaults to
                                 <option>control-group</option> if
                                 <option>--kill-who=all</option> is
                                 defaults to
                                 <option>control-group</option> if
                                 <option>--kill-who=all</option> is
                                 <option>all</option> to select whether
                                 to kill only the main process of the
                                 unit, the control process or all
                                 <option>all</option> to select whether
                                 to kill only the main process of the
                                 unit, the control process or all
-                                processes of the unit. If ommitted
+                                processes of the unit. If omitted
                                 defaults to
                                 <option>all</option>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 defaults to
                                 <option>all</option>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>---signal=</option></term>
+                                <term><option>--signal=</option></term>
                                 <term><option>-s</option></term>
 
                                 <listitem><para>When used with
                                 <command>kill</command>, choose which
                                 signal to send to selected
                                 processes. Must be one of the well
                                 <term><option>-s</option></term>
 
                                 <listitem><para>When used with
                                 <command>kill</command>, choose which
                                 signal to send to selected
                                 processes. Must be one of the well
-                                know signal specifiers such as
+                                known signal specifiers such as
                                 SIGTERM, SIGINT or SIGSTOP. If
                                 SIGTERM, SIGINT or SIGSTOP. If
-                                ommitted defaults to
+                                omitted defaults to
                                 <option>SIGTERM</option>.</para></listitem>
                         </varlistentry>
 
                                 <option>SIGTERM</option>.</para></listitem>
                         </varlistentry>
 
                                 units specified on the command
                                 line. If the units are not running yet
                                 the operation will
                                 units specified on the command
                                 line. If the units are not running yet
                                 the operation will
-                                fail.</para></listitem>
+                                fail. Note that for compatibility
+                                with Red Hat init scripts
+                                <command>condrestart</command> is
+                                equivalent to this command.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>reload-or-restart [NAME...]</command></term>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>reload-or-restart [NAME...]</command></term>
+
+                                <listitem><para>Reload one or more
+                                units if they support it. If not,
+                                restart them instead. If the units
+                                are not running yet they will be
+                                started.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
                                 <term><command>reload-or-try-restart [NAME...]</command></term>
 
                                 <listitem><para>Reload one or more
                                 units if they support it. If not,
                                 <term><command>reload-or-try-restart [NAME...]</command></term>
 
                                 <listitem><para>Reload one or more
                                 units if they support it. If not,
-                                restart them instead. Note that for
-                                compatibility with SysV and Red Hat
-                                init scripts
-                                <command>force-reload</command> and
-                                <command>condrestart</command> may be
-                                used as equivalent commands to
-                                <command>reload-or-try-restart</command>.</para></listitem>
+                                restart them instead. If the units
+                                are not running yet the operation
+                                will fail. Note that for
+                                compatibility with SysV init scripts
+                                <command>force-reload</command> is
+                                equivalent to this command.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>isolate [NAME]</command></term>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>isolate [NAME]</command></term>
                                 <term><command>is-active [NAME...]</command></term>
 
                                 <listitem><para>Check whether any of
                                 <term><command>is-active [NAME...]</command></term>
 
                                 <listitem><para>Check whether any of
-                                the specified units is active
+                                the specified units are active
                                 (i.e. running). Returns an exit code
                                 0 if at least one is active, non-zero
                                 otherwise. Unless
                                 (i.e. running). Returns an exit code
                                 0 if at least one is active, non-zero
                                 otherwise. Unless
                                 administrator is free to make
                                 additional changes manually, by
                                 placing or removing symlinks in the
                                 administrator is free to make
                                 additional changes manually, by
                                 placing or removing symlinks in the
-                                directory. This is particular useful
+                                directory. This is particularly useful
                                 to create configurations that deviate
                                 from the suggested default
                                 installation. In this case the
                                 to create configurations that deviate
                                 from the suggested default
                                 installation. In this case the
 
                                 <para>Depending on whether
                                 <option>--system</option>,
 
                                 <para>Depending on whether
                                 <option>--system</option>,
-                                <option>--session</option> or
+                                <option>--user</option> or
                                 <option>--global</option> is specified
                                 this enables the unit for the system,
                                 <option>--global</option> is specified
                                 this enables the unit for the system,
-                                for sessions of the calling user only
-                                or for all future session of all
+                                for the calling user only
+                                or for all future logins of all
                                 users. Note that in the latter case no
                                 systemd daemon configuration is
                                 reloaded.</para>
                                 users. Note that in the latter case no
                                 systemd daemon configuration is
                                 reloaded.</para>
                                 <option>--quiet</option>.</para>
                                 </listitem>
 
                                 <option>--quiet</option>.</para>
                                 </listitem>
 
-                                <para>This command honours
+                                <para>This command honors
                                 <option>--system</option>,
                                 <option>--system</option>,
-                                <option>--session</option>,
+                                <option>--user</option>,
                                 <option>--global</option> in a similar
                                 way as
                                 <command>enable</command>.</para>
                                 <option>--global</option> in a similar
                                 way as
                                 <command>enable</command>.</para>
                                 <listitem><para>Cancel one or more
                                 jobs specified on the command line by
                                 their numeric job
                                 <listitem><para>Cancel one or more
                                 jobs specified on the command line by
                                 their numeric job
-                                IDs. If not job id is specified cancels all jobs that are pending.</para></listitem>
+                                IDs. If no job id is specified, cancel all pending jobs.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>monitor</command></term>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>monitor</command></term>
 
                                 <para>A snapshot refers to a saved
                                 state of the systemd manager. It is
 
                                 <para>A snapshot refers to a saved
                                 state of the systemd manager. It is
-                                implemented itself as unit that is
+                                implemented itself as unit that is
                                 generated dynamically with this
                                 command and has dependencies on all
                                 units active at the time. At a later
                                 generated dynamically with this
                                 command and has dependencies on all
                                 units active at the time. At a later
                                 users.  If
                                 combined with <option>--force</option>
                                 shutdown of all running services is
                                 users.  If
                                 combined with <option>--force</option>
                                 shutdown of all running services is
-                                skipped, however all processes killed
-                                and all file systems unmounted or
+                                skipped, however all processes are killed
+                                and all file systems are unmounted or
                                 mounted read-only, immediately
                                 followed by the
                                 system halt.</para></listitem>
                                 mounted read-only, immediately
                                 followed by the
                                 system halt.</para></listitem>
                                 users. If
                                 combined with <option>--force</option>
                                 shutdown of all running services is
                                 users. If
                                 combined with <option>--force</option>
                                 shutdown of all running services is
-                                skipped, however all processes killed
-                                and all file systems unmounted or
+                                skipped, however all processes are killed
+                                and all file systems are unmounted or
                                 mounted read-only, immediately
                                 followed by the
                                 powering off.</para></listitem>
                                 mounted read-only, immediately
                                 followed by the
                                 powering off.</para></listitem>
                                 users. If
                                 combined with <option>--force</option>
                                 shutdown of all running services is
                                 users. If
                                 combined with <option>--force</option>
                                 shutdown of all running services is
-                                skipped, however all processes killed
-                                and all file systems unmounted or
+                                skipped, however all processes are killed
+                                and all file systems are unmounted or
                                 mounted read-only, immediately
                                 followed by the
                                 reboot.</para></listitem>
                                 mounted read-only, immediately
                                 followed by the
                                 reboot.</para></listitem>
                                 a wall message to all users. If
                                 combined with <option>--force</option>
                                 shutdown of all running services is
                                 a wall message to all users. If
                                 combined with <option>--force</option>
                                 shutdown of all running services is
-                                skipped, however all processes killed
-                                and all file systems unmounted or
+                                skipped, however all processes are killed
+                                and all file systems are unmounted or
                                 mounted read-only, immediately
                                 followed by the
                                 reboot.</para></listitem>
                                 mounted read-only, immediately
                                 followed by the
                                 reboot.</para></listitem>
 
                                 <listitem><para>Ask the systemd
                                 manager to quit. This is only
 
                                 <listitem><para>Ask the systemd
                                 manager to quit. This is only
-                                supported for session managers
+                                supported for user service managers
                                 (i.e. in conjunction with the
                                 (i.e. in conjunction with the
-                                <option>--session</option> option) and
+                                <option>--user</option> option) and
                                 will fail otherwise.</para></listitem>
                         </varlistentry>
                 </variablelist>
                                 will fail otherwise.</para></listitem>
                         </varlistentry>
                 </variablelist>