summaryrefslogtreecommitdiff
path: root/man/systemd.unit.xml
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2010-05-15 23:06:41 +0200
committerLennart Poettering <lennart@poettering.net>2010-05-15 23:06:41 +0200
commitd1ab0ca07372649dad70a0348d75e394f254e1b6 (patch)
tree0a0ccc00d007014f890c380933c23266f2707e8e /man/systemd.unit.xml
parent843d2643849a1ec63034012c8fe50bfaad23190b (diff)
man: add some initial man page work
Diffstat (limited to 'man/systemd.unit.xml')
-rw-r--r--man/systemd.unit.xml121
1 files changed, 121 insertions, 0 deletions
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>