chiark / gitweb /
man: document machinectl and systemd-machined
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Sun, 7 Jul 2013 02:22:05 +0000 (22:22 -0400)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Sun, 7 Jul 2013 02:23:31 +0000 (22:23 -0400)
Makefile-man.am
man/loginctl.xml
man/machinectl.xml [new file with mode: 0644]
man/systemctl.xml
man/systemd-logind.service.xml
man/systemd-machined.service.xml [new file with mode: 0644]
src/machine/machinectl.c

index ba34d1e..fef69be 100644 (file)
@@ -654,6 +654,7 @@ endif
 
 if ENABLE_LOGIND
 MANPAGES += \
+       man/loginctl.1 \
        man/logind.conf.5 \
        man/systemd-logind.service.8
 MANPAGES_ALIAS += \
@@ -664,6 +665,18 @@ man/systemd-logind.html: man/systemd-logind.service.html
 
 endif
 
+if ENABLE_MACHINED
+MANPAGES += \
+       man/machinectl.1 \
+       man/systemd-machined.service.8
+MANPAGES_ALIAS += \
+       man/systemd-machined.8
+man/systemd-machined.8: man/systemd-machined.service.8
+man/systemd-machined.html: man/systemd-machined.service.html
+       $(html-alias)
+
+endif
+
 if ENABLE_QUOTACHECK
 MANPAGES += \
        man/systemd-quotacheck.service.8
@@ -790,7 +803,6 @@ endif
 
 if HAVE_PAM
 MANPAGES += \
-       man/loginctl.1 \
        man/pam_systemd.8 \
        man/sd-login.3 \
        man/sd_get_seats.3 \
index b9db475..e129d1b 100644 (file)
@@ -21,7 +21,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="loginctl" conditional='HAVE_PAM'>
+<refentry id="loginctl" conditional='ENABLE_LOGIND'>
 
         <refentryinfo>
                 <title>loginctl</title>
 
         <refsynopsisdiv>
                 <cmdsynopsis>
-                        <command>loginctl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">NAME</arg></command>
+                        <command>loginctl</command>
+                        <arg choice="opt" rep="repeat">OPTIONS</arg>
+                        <arg choice="req">COMMAND</arg>
+                        <arg choice="opt" rep="repeat">NAME</arg>
                 </cmdsynopsis>
         </refsynopsisdiv>
 
                                 itself. If no argument is specified,
                                 properties of the manager will be
                                 shown. If a session ID is specified,
-                                properties of the session is shown. By
+                                properties of the session are shown. By
                                 default, empty properties are
                                 suppressed. Use <option>--all</option>
                                 to show those too. To select specific
diff --git a/man/machinectl.xml b/man/machinectl.xml
new file mode 100644 (file)
index 0000000..2606180
--- /dev/null
@@ -0,0 +1,301 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<!--
+  This file is part of systemd.
+
+  Copyright 2013 Zbigniew Jędrzejewski-Szmek
+
+  systemd is free software; you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or
+  (at your option) any later version.
+
+  systemd is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+
+<refentry id="machinectl" conditional='ENABLE_MACHINED'>
+
+        <refentryinfo>
+                <title>machinectl</title>
+                <productname>systemd</productname>
+
+                <authorgroup>
+                        <author>
+                                <contrib>Developer</contrib>
+                                <firstname>Lennart</firstname>
+                                <surname>Poettering</surname>
+                                <email>lennart@poettering.net</email>
+                        </author>
+                </authorgroup>
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>machinectl</refentrytitle>
+                <manvolnum>1</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>machinectl</refname>
+                <refpurpose>Control the systemd machine manager</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <cmdsynopsis>
+                        <command>machinectl</command>
+                        <arg choice="opt" rep="repeat">OPTIONS</arg>
+                        <arg choice="req">COMMAND</arg>
+                        <arg choice="opt" rep="repeat">NAME</arg>
+                </cmdsynopsis>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para><command>machinectl</command> may be used to
+                introspect and control the state of the
+                <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                virtual machine and container registration manager <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>Options</title>
+
+                <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>-p</option></term>
+                                <term><option>--property=</option></term>
+
+                                <listitem><para>When showing
+                                session/user properties, limit
+                                display to certain properties as
+                                specified as argument. If not
+                                specified, all set properties are
+                                shown. The argument should be a
+                                property name, such as
+                                <literal>Name</literal>. If
+                                specified more than once, all
+                                properties with the specified names
+                                are shown.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-a</option></term>
+                                <term><option>--all</option></term>
+
+                                <listitem><para>When showing
+                                unit/job/manager properties, show all
+                                properties regardless whether they are
+                                set or not.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-l</option></term>
+                                <term><option>--full</option></term>
+
+                                <listitem><para>Do not ellipsize cgroup
+                                members.</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>--no-ask-password</option></term>
+
+                                <listitem><para>Do not query the user
+                                for authentication for privileged
+                                operations.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--kill-who=</option></term>
+
+                                <listitem><para>When used with
+                                <command>kill-session</command>,
+                                choose which processes to kill. Must
+                                be one of <option>leader</option>, or
+                                <option>all</option> to select whether
+                                to kill only the leader process of the
+                                session or all processes of the
+                                session. If omitted, defaults to
+                                <option>all</option>.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-s</option></term>
+                                <term><option>--signal=</option></term>
+
+                                <listitem><para>When used with
+                                <command>kill-session</command> or
+                                <command>kill-user</command>, choose
+                                which signal to send to selected
+                                processes. Must be one of the well
+                                known signal specifiers, such as
+                                <constant>SIGTERM</constant>,
+                                <constant>SIGINT</constant> or
+                                <constant>SIGSTOP</constant>. If
+                                omitted, defaults to
+                                <constant>SIGTERM</constant>.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-H</option></term>
+                                <term><option>--host</option></term>
+
+                                <listitem><para>Execute 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 machine manager
+                                instance.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-P</option></term>
+                                <term><option>--privileged</option></term>
+
+                                <listitem><para>Acquire privileges via
+                                PolicyKit before executing the
+                                operation.</para></listitem>
+                        </varlistentry>
+                </variablelist>
+
+                <para>The following commands are understood:</para>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><command>list</command></term>
+
+                                <listitem><para>List currently running
+                                virtual machines and containers.
+                                </para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>status [ID...]</command></term>
+
+                                <listitem><para>Show terse runtime
+                                status information about one or more
+                                virtual machines and containers. This
+                                function is intended to generate
+                                human-readable output. If you are
+                                looking for computer-parsable output,
+                                use <command>show</command> instead.
+                                </para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>show [ID...]</command></term>
+
+                                <listitem><para>Show properties of one
+                                or more registered virtual machines or
+                                containers or the manager itself. If
+                                no argument is specified, properties
+                                of the manager will be shown. If a an
+                                ID is specified, properties of this
+                                virtual machine or container 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 used
+                                whenever computer-parsable output is
+                                required. Use
+                                <command>status</command> if you are
+                                looking for formatted human-readable
+                                output.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>terminate [ID...]</command></term>
+
+                                <listitem><para>Terminates a virtual
+                                machine or container. This kills all
+                                processes of the virtual machine or
+                                container and deallocates all
+                                resources attached to that
+                                instance.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>kill [ID...]</command></term>
+
+                                <listitem><para>Send a signal to one
+                                or more processes of the virtual
+                                machine or container. This means
+                                processes as seen by the host, not the
+                                processes inside the virtual machine
+                                or container.
+                                Use <option>--kill-who=</option> to
+                                select which process to kill. Use
+                                <option>--signal=</option> to select
+                                the signal to send.</para></listitem>
+                        </varlistentry>
+                </variablelist>
+
+        </refsect1>
+
+        <refsect1>
+                <title>Exit status</title>
+
+                <para>On success, 0 is returned, a non-zero failure
+                code otherwise.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>Environment</title>
+
+                <variablelist class='environment-variables'>
+                        <varlistentry>
+                                <term><varname>$SYSTEMD_PAGER</varname></term>
+                                <listitem><para>Pager to use when
+                                <option>--no-pager</option> is not given;
+                                overrides <varname>$PAGER</varname>.  Setting
+                                this to an empty string or the value
+                                <literal>cat</literal> is equivalent to passing
+                                <option>--no-pager</option>.</para></listitem>
+                        </varlistentry>
+                </variablelist>
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                </para>
+        </refsect1>
+
+</refentry>
index 632a26d..07e7363 100644 (file)
@@ -819,9 +819,8 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 
         <listitem>
           <para>Show manual pages for one or more units, if
-          available. If a PID is passed the manual pages for the unit
-          the process of the PID belongs to is
-          shown.</para>
+          available. If a PID is given the manual pages for the unit
+          the process belongs to are shown.</para>
         </listitem>
       </varlistentry>
 
@@ -859,13 +858,13 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
           created the systemd configuration is reloaded (in a way that
           is equivalent to <command>daemon-reload</command>) to ensure
           the changes are taken into account immediately. Note that
-          this does not have the effect that any of the units enabled
-          are also started at the same time. If this is desired a
-          separate <command>start</command> command must be invoked
-          for the unit. Also note that in case of instance enablement,
-          symlinks named same as instances are created in install
-          location, however they all point to the same template unit
-          file.</para>
+          this does <emphasis>not</emphasis> have the effect of also
+          starting starting any of the units beeing enabled. If this
+          is desired a separate <command>start</command> command must
+          be invoked for the unit. Also note that in case of instance
+          enablement, symlinks named same as instances are created in
+          install location, however they all point to the same
+          template unit file.</para>
 
           <para>This command will print the actions executed. This
           output may be suppressed by passing <option>--quiet</option>.
index 09bcfac..c0c3d1a 100644 (file)
         <refsect1>
                 <title>Description</title>
 
-                <para><filename>systemd-logind</filename> is a system
+                <para><command>systemd-logind</command> is a system
                 service that manages user logins. It is responsible
                 for:</para>
 
                 <itemizedlist>
-                        <listitem><para>Keeping track of users and sessions, their
-                        processes and their idle state</para></listitem>
-
-                        <listitem><para>Creating control groups for
-                        user processes</para></listitem>
+                        <listitem><para>Keeping track of users and
+                        sessions, their processes and their idle
+                        state</para></listitem>
 
                         <listitem><para>Providing PolicyKit-based access
                         for users to operations such as system
diff --git a/man/systemd-machined.service.xml b/man/systemd-machined.service.xml
new file mode 100644 (file)
index 0000000..3094315
--- /dev/null
@@ -0,0 +1,76 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<!--
+  This file is part of systemd.
+
+  Copyright 2013 Zbigniew Jędrzejewski-Szmek
+
+  systemd is free software; you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or
+  (at your option) any later version.
+
+  systemd is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+
+<refentry id="systemd-machined.service" conditional='ENABLE_MACHINED'>
+
+        <refentryinfo>
+                <title>systemd-machined.service</title>
+                <productname>systemd</productname>
+
+                <authorgroup>
+                        <author>
+                                <contrib>Developer</contrib>
+                                <firstname>Lennart</firstname>
+                                <surname>Poettering</surname>
+                                <email>lennart@poettering.net</email>
+                        </author>
+                </authorgroup>
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>systemd-machined.service</refentrytitle>
+                <manvolnum>8</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>systemd-machined.service</refname>
+                <refname>systemd-machined</refname>
+                <refpurpose>Virtual machine and container registartion manager</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <para><filename>systemd-machined.service</filename></para>
+                <para><filename>/usr/lib/systemd/systemd-machined</filename></para>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para><command>systemd-machined</command> is a
+                system service that keeps track of virtual machines
+                and containers, and processes belonging to
+                them.</para>
+
+                <para>See <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> for some examples how to
+                start a container the systemd way.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
+                </para>
+        </refsect1>
+
+</refentry>
index 5d107f3..34bbe36 100644 (file)
@@ -514,7 +514,7 @@ static int help(void) {
                "Commands:\n"
                "  list                   List running VMs and containers\n"
                "  status [NAME...]       Show VM/container status\n"
-               "  show[NAME...]          Show properties of one or more VMs/containers\n"
+               "  show [NAME...]         Show properties of one or more VMs/containers\n"
                "  terminate [NAME...]    Terminate one or more VMs/containers\n"
                "  kill [NAME...]         Send signal to processes of a VM/container\n",
                program_invocation_short_name);