systemd-stable/man/systemd.unit.xml

<?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><varname>Names=</varname></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><varname>Requires=</varname></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>