chiark / gitweb /
bus: mark sd_bus_message_at_end public
[elogind.git] / man / systemctl.xml
index 32bcf03f2fad8ffe1546fbeb28f16201c5d1b9f0..7f1e98f5c5472f84095b345514ffd417b03481d1 100644 (file)
@@ -63,6 +63,19 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     introspect and control the state of the
     <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
     system and service manager.</para>
+
+    <para>For unit commands, the <replaceable>NAME</replaceable> represents full name of the unit.
+    <programlisting>
+systemctl start foo.service
+    </programlisting>
+    For unit file commands, the <replaceable>NAME</replaceable> represents the full name of the unit file, or the absolute path to the unit file.
+    <programlisting>
+systemctl start /path/to/foo.service
+    </programlisting>
+    While working with services/service files, <command>systemctl</command> implicitly appends the ".service" suffix when it is missing.
+    <programlisting>
+systemctl start foo
+    </programlisting></para>
   </refsect1>
 
   <refsect1>
@@ -174,7 +187,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <term><option>--full</option></term>
 
         <listitem>
-          <para>Do not ellipsize unit names, cgroup members, and
+          <para>Do not ellipsize unit names, process tree entries, and
           truncate unit descriptions in the output of
           <command>list-units</command> and
           <command>list-jobs</command>.</para>
@@ -444,7 +457,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <term><option>--host</option></term>
 
         <listitem>
-          <para>Execute operation remotely. Specify a hostname, or
+          <para>Execute the operation remotely. Specify a hostname, or
           username and hostname separated by <literal>@</literal>, to connect to. This
           will use SSH to talk to the remote systemd
           instance.</para>
@@ -711,14 +724,14 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           <listitem>
             <para>Set the specified unit properties at runtime where
             this is supported. This allows changing configuration
-            parameter properties such as resource management controls at
+            parameter properties such as resource control settings at
             runtime. Not all properties may be changed at runtime, but
-            many resource management settings (primarily those in
-            <citerefentry><refentrytitle>systemd.cgroup</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
+            many resource control settings (primarily those in
+            <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
             may. The changes are applied instantly, and stored on disk
             for future boots, unless <option>--runtime</option> is
-            passed, in which case the settings only apply until the next
-            reboot. The syntax of the property assignment follows
+            passed, in which case the settings only apply until the
+            next reboot. The syntax of the property assignment follows
             closely the syntax of assignments in unit files.</para>
 
             <para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para>
@@ -831,7 +844,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 
             <para>Depending on whether <option>--system</option>,
             <option>--user</option>, <option>--runtime</option>,
-            or<option>--global</option>, is specified, this enables the unit
+            or <option>--global</option> is specified, this enables the unit
             for the system, for the calling user only, for only this boot of
             the system, or for all future logins of all users, or only this
             boot.  Note that in the last case, no systemd daemon
@@ -861,7 +874,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
             </para>
 
             <para>This command honors <option>--system</option>,
-            <option>--user</option>, <option>--runtime</option>,
+            <option>--user</option>, <option>--runtime</option> and
             <option>--global</option> in a similar way as
             <command>enable</command>.</para>
           </listitem>
@@ -921,7 +934,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
             <command>disable</command>, since it prohibits all kinds of
             activation of the unit, including manual activation. Use
             this option with care. This honors the
-            <option>--runtime</option> option, to only mask temporarily
+            <option>--runtime</option> option to only mask temporarily
             until the next reoobt of the system.</para>
           </listitem>
         </varlistentry>
@@ -1166,7 +1179,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><command>reboot</command></term>
+          <term><command>reboot <optional><replaceable>arg</replaceable></optional></command></term>
 
           <listitem>
             <para>Shut down and reboot the system. This is mostly
@@ -1179,6 +1192,16 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
             specified twice, the operation is immediately executed
             without terminating any processes or unmounting any file
             systems. This may result in data loss.</para>
+
+            <para>If the optional argument
+            <replaceable>arg</replaceable> is given, it will be passed
+            as the optional argument to the
+            <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+            system call. The value is architecture and firmware
+            specific. As an example, <literal>recovery</literal> might
+            be used to trigger system recovery, and
+            <literal>fota</literal> might be used to trigger a
+            <quote>firmware over the air</quote> update.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
@@ -1290,7 +1313,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
       <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>systemd.cgroup</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>systemd.resource-management</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>