chiark / gitweb /
service: rework logic when we consider a service running
[elogind.git] / man / systemd.unit.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <!--
6   This file is part of systemd.
7
8   Copyright 2010 Lennart Poettering
9
10   systemd is free software; you can redistribute it and/or modify it
11   under the terms of the GNU General Public License as published by
12   the Free Software Foundation; either version 2 of the License, or
13   (at your option) any later version.
14
15   systemd is distributed in the hope that it will be useful, but
16   WITHOUT ANY WARRANTY; without even the implied warranty of
17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18   General Public License for more details.
19
20   You should have received a copy of the GNU General Public License
21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 -->
23
24 <refentry id="systemd.unit">
25
26         <refentryinfo>
27                 <title>systemd.unit</title>
28                 <productname>systemd</productname>
29
30                 <authorgroup>
31                         <author>
32                                 <contrib>Developer</contrib>
33                                 <firstname>Lennart</firstname>
34                                 <surname>Poettering</surname>
35                                 <email>lennart@poettering.net</email>
36                         </author>
37                 </authorgroup>
38         </refentryinfo>
39
40         <refmeta>
41                 <refentrytitle>systemd.unit</refentrytitle>
42                 <manvolnum>5</manvolnum>
43         </refmeta>
44
45         <refnamediv>
46                 <refname>systemd.unit</refname>
47                 <refpurpose>systemd unit configuration files</refpurpose>
48         </refnamediv>
49
50         <refsynopsisdiv>
51                 <para><filename>systemd.service</filename></para>
52                 <para><filename>systemd.socket</filename></para>
53                 <para><filename>systemd.device</filename></para>
54                 <para><filename>systemd.mount</filename></para>
55                 <para><filename>systemd.automount</filename></para>
56                 <para><filename>systemd.swap</filename></para>
57                 <para><filename>systemd.target</filename></para>
58         </refsynopsisdiv>
59
60         <refsect1>
61                 <title>Description</title>
62
63                 <para>A unit configuration file encodes information
64                 about a service, a socket, a mount point, an automount
65                 point, a swap file or patition, or a start-up target
66                 controlled and supervised by systemd. The syntax is
67                 inspired by XDG <filename>.desktop</filename> files,
68                 which are in turn inspired by Windows
69                 <filename>.ini</filename> files.</para>
70
71                 <para>This man pages lists the common configuration
72                 options of the various unit types.</para>
73         </refsect1>
74
75         <refsect1>
76                 <title>Options</title>
77
78                 <variablelist>
79                         <varlistentry>
80                                 <term><varname>Names=</varname></term>
81                                 <listitem>
82                                         <para>Additional names for this unit. The names
83                                         listed here mus have the same suffix (i.e. type)
84                                         as the identifier name. This option may be
85                                         specified more than once.</para>
86                                 </listitem>
87                         </varlistentry>
88                         <varlistentry>
89                                 <term><varname>Requires=</varname></term>
90                                 <listitem>
91                                         <para>Dependencies on other
92                                         units. If this units get
93                                         activated the units listed
94                                         here will be activated as
95                                         well. If one of the other
96                                         units gets deactivated or its
97                                         activation fails, this unit
98                                         will be deactivated. This
99                                         option may be specified more
100                                         than once.</para>
101                                 </listitem>
102                         </varlistentry>
103                 </variablelist>
104         </refsect1>
105
106         <refsect1>
107                   <title>See Also</title>
108                   <para>
109                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
110                           <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
111                           <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>
112                           <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
113                           <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
114                           <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>
115                           <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
116                           <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
117                           <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>
118                           <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>
119                   </para>
120         </refsect1>
121
122 </refentry>