chiark / gitweb /
man: mention XDG_CONFIG_HOME in systemd.unit
[elogind.git] / man / systemd-cgls.xml
index b280b87e6d3340a0d92ee53f014bacc657f1653e..230957ba2df453507c374a82fb436a8e9b0a05cd 100644 (file)
@@ -21,7 +21,8 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="systemd-cgls">
+<refentry id="systemd-cgls"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
         <refentryinfo>
                 <title>systemd-cgls</title>
@@ -49,7 +50,9 @@
 
         <refsynopsisdiv>
                 <cmdsynopsis>
-                        <command>systemd-cgls <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">CGROUP</arg></command>
+                        <command>systemd-cgls</command>
+                        <arg choice="opt" rep="repeat">OPTIONS</arg>
+                        <arg choice="opt" rep="repeat">CGROUP</arg>
                 </cmdsynopsis>
         </refsynopsisdiv>
 
 
                 <para><command>systemd-cgls</command> recursively
                 shows the contents of the selected Linux control group
-                hierarchy in a tree. If arguments are specified shows
+                hierarchy in a tree. If arguments are specified, shows
                 all member processes of the specified control groups
                 plus all their subgroups and their members. The
                 control groups may either be specified by their full
                 file paths or are assumed in the systemd control group
                 hierarchy. If no argument is specified and the current
                 working directory is beneath the control group mount
-                point <filename>/sys/fs/cgroup</filename> shows the contents
+                point <filename>/sys/fs/cgroup</filename>, shows the contents
                 of the control group the working directory refers
-                to. Otherwise the full systemd control group hierarchy
+                to. Otherwise, the full systemd control group hierarchy
                 is shown.</para>
 
-                <para>By default empty control groups are not
+                <para>By default, empty control groups are not
                 shown.</para>
         </refsect1>
 
                 <para>The following options are understood:</para>
 
                 <variablelist>
-                        <varlistentry>
-                                <term><option>-h</option></term>
-                                <term><option>--help</option></term>
-
-                                <listitem><para>Prints a short help
-                                text and exits.</para></listitem>
-                        </varlistentry>
-
-                        <varlistentry>
-                                <term><option>--version</option></term>
-
-                                <listitem><para>Prints a short version
-                                string and exits.</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>--all</option></term>
 
-                                <listitem><para>Don't hide empty
+                                <listitem><para>Do not hide empty
                                 control groups in the
                                 output.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
+                                <term><option>-l</option></term>
                                 <term><option>--full</option></term>
 
-                                <listitem><para>Do not ellipsize cgroup
-                                members.</para>
+                                <listitem><para>Do not ellipsize
+                                process tree members.</para>
                                 </listitem>
                         </varlistentry>
 
                                 threads in output.</para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><option>-M <replaceable>MACHINE</replaceable></option></term>
+                                <term><option>--machine=<replaceable>MACHINE</replaceable></option></term>
+
+                                <listitem><para>Limit control groups shown to
+                                the part corresponding to the
+                                container <replaceable>MACHINE</replaceable>.
+                                </para></listitem>
+                        </varlistentry>
+
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />
+                        <xi:include href="standard-options.xml" xpointer="no-pager" />
                 </variablelist>
 
         </refsect1>
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>
 
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd-cgtop</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 </para>
         </refsect1>