man: add some initial man page work

2 files changed, 334 insertions, 0 deletions

diff --git a/man/systemd.service.xml b/man/systemd.service.xml
new file mode 100644
index 0000000000..5285ce3d52
--- /dev/null
+++ b/man/systemd.service.xml
@@ -0,0 +1,213 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
+<!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 2010 Lennart Poettering
+
+  systemd is free software; you can redistribute it and/or modify it
+  under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 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
+  General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+
+<refentry id="systemd.service">
+        <refentryinfo>
+                <title>systemd.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.service</refentrytitle>
+                <manvolnum>5</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>systemd.service</refname>
+                <refpurpose>systemd service configuration files</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <para><filename>systemd.service</filename></para>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para>A configuration file ending in .service encodes
+                information about a process controlled and supervised
+                by systemd.</para>
+
+                <para>This man page lists the configuration options
+                specific to this unit type. See
+                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                for the common options of all unit configuration
+                files.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>Options</title>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><varname>Type=</varname></term>
+                                <listitem>
+                                        <para>One of
+                                        <literal>forking</literal>,
+                                        <literal>simple</literal>,
+                                        <literal>finish</literal>,
+                                        <literal>dbus</literal>.</para>
+
+                                        <para>If set to
+                                        <literal>forking</literal>
+                                        (the default) it is expected
+                                        that the process configured
+                                        with
+                                        <varname>ExecStart=</varname>
+                                        will start up and call
+                                        <function>fork()</function>. The
+                                        parent process is expected to
+                                        finish when start-up is
+                                        complete and all communication
+                                        channels set up. The child
+                                        continues to run as the main
+                                        daemon process. This is the
+                                        behaviour of traditional UNIX
+                                        daemons. If this setting is
+                                        used it is recommended to also
+                                        use the
+                                        <varname>PIDFile=</varname>
+                                        option, so that systemd can
+                                        identify the main process of
+                                        the daemon. systemd will start
+                                        follow-up units as soon as the
+                                        parent process exited.</para>
+
+                                        <para>If set to
+                                        <literal>simple</literal> (the
+                                        recommended value) it is
+                                        expected that the process
+                                        configured with
+                                        <varname>ExecStart=</varname>
+                                        is the main process of the
+                                        daemon. In this mode
+                                        communication channels must be
+                                        available before the daemon is
+                                        started up, as systemd will
+                                        immediately start follow-up
+                                        units.</para>
+
+                                        <para>Behaviour of
+                                        <literal>finish</literal> is
+                                        similar to
+                                        <literal>simple</literal>,
+                                        however it is expected that
+                                        the process has to exit before
+                                        systemd starts follow-up
+                                        units. <varname>ValidNoProcess=</varname>
+                                        is particularly useful for
+                                        this type of service.</para>
+
+                                        <para>Behaviour of
+                                        <literal>dbus</literal> is
+                                        similar to
+                                        <literal>simple</literal>,
+                                        however it is expected that
+                                        the daemon acquires a name on
+                                        the D-Bus bus, as configured
+                                        by
+                                        <varname>BusName=</varname>. Follow-up
+                                        units will be started after
+                                        the name has been
+                                        acquired.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><varname>ValidNoProcess=</varname></term>
+                                <listitem>
+                                        <para>Takes a boolean value
+                                        that specifies whether the service
+                                        shall be considered active
+                                        even when all its processes
+                                        exited. Defaults to <literal>no</literal>.</para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>PIDFile=</varname></term>
+                                <listitem>
+                                        <para>Takes an absolute file
+                                        name pointing to the PID file
+                                        of this daemon. Use of this
+                                        option is recommended for
+                                        services where
+                                        <varname>Type=</varname> is
+                                        set to
+                                        <literal>forking</literal>.</para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>BusName=</varname></term>
+                                <listitem>
+                                        <para>Takes a D-Bus bus name
+                                        that this service is reachable
+                                        as. This option is mandatory
+                                        for services where
+                                        <varname>Type=</varname> is
+                                        set to
+                                        <literal>dbus</literal>, but
+                                        its use is otherwise
+                                        recommended as well if the
+                                        process takes a name on the
+                                        D-Bus bus.</para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>ExecStart=</varname></term>
+                                <listitem>
+                                        <para>Takes a command line
+                                        that is executed when this
+                                        service shall be started
+                                        up. The first word of the
+                                        command line must be an
+                                        absolute file name. It is
+                                        mandatory to set this option
+                                        for all services.</para>
+                                </listitem>
+                        </varlistentry>
+
+                </variablelist>
+        </refsect1>
+
+        <refsect1>
+                  <title>See Also</title>
+                  <para>
+                          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                  </para>
+        </refsect1>
+
+</refentry>
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
new file mode 100644
index 0000000000..cfa1b09499
--- /dev/null
+++ b/man/systemd.unit.xml
@@ -0,0 +1,121 @@
+<?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 2010 Lennart Poettering
+
+  systemd is free software; you can redistribute it and/or modify it
+  under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 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
+  General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+
+<refentry id="systemd.unit">
+
+        <refentryinfo>
+                <title>systemd.unit</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.unit</refentrytitle>
+                <manvolnum>5</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>systemd.unit</refname>
+                <refpurpose>systemd unit configuration files</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <para><filename>systemd.service</filename></para>
+                <para><filename>systemd.socket</filename></para>
+                <para><filename>systemd.device</filename></para>
+                <para><filename>systemd.mount</filename></para>
+                <para><filename>systemd.automount</filename></para>
+                <para><filename>systemd.swap</filename></para>
+                <para><filename>systemd.target</filename></para>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para>A unit configuration file encodes information
+                about a service, a socket, a mount point, an automount
+                point, a swap file or patition, or a start-up target
+                controlled and supervised by systemd. The syntax is
+                inspired by XDG <filename>.desktop</filename> files,
+                which are in turn inspired by Windows
+                <filename>.ini</filename> files.</para>
+
+                <para>This man pages lists the common configuration
+                options of the various unit types.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>Options</title>
+
+                <variablelist>
+                        <varlistentry>
+                                <term>Names=</term>
+                                <listitem>
+                                        <para>Additional names for this unit. The names
+                                        listed here mus have the same suffix (i.e. type)
+                                        as the identifier name. This option may be
+                                        specified more than once.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term>Requires=</term>
+                                <listitem>
+                                        <para>Dependencies on other
+                                        units. If this units get
+                                        activated the units listed
+                                        here will be activated as
+                                        well. If one of the other
+                                        units gets deactivated or its
+                                        activation fails, this unit
+                                        will be deactivated. This
+                                        option may be specified more
+                                        than once.</para>
+                                </listitem>
+                        </varlistentry>
+                </variablelist>
+        </refsect1>
+
+        <refsect1>
+                  <title>See Also</title>
+                  <para>
+                          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                  </para>
+        </refsect1>
+
+</refentry>