]>
Commit | Line | Data |
---|---|---|
65232ea7 LP |
1 | <?xml version='1.0'?> <!--*-nxml-*--> |
2 | <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?> | |
3 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
798d3a52 | 4 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
65232ea7 LP |
5 | |
6 | <!-- | |
7 | This file is part of systemd. | |
8 | ||
9 | Copyright 2010 Lennart Poettering | |
10 | ||
11 | systemd is free software; you can redistribute it and/or modify it | |
5430f7f2 LP |
12 | under the terms of the GNU Lesser General Public License as published by |
13 | the Free Software Foundation; either version 2.1 of the License, or | |
65232ea7 LP |
14 | (at your option) any later version. |
15 | ||
16 | systemd is distributed in the hope that it will be useful, but | |
17 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
5430f7f2 | 19 | Lesser General Public License for more details. |
65232ea7 | 20 | |
5430f7f2 | 21 | You should have received a copy of the GNU Lesser General Public License |
65232ea7 LP |
22 | along with systemd; If not, see <http://www.gnu.org/licenses/>. |
23 | --> | |
24 | ||
25 | <refentry id="systemd.automount"> | |
798d3a52 ZJS |
26 | <refentryinfo> |
27 | <title>systemd.automount</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.automount</refentrytitle> | |
42 | <manvolnum>5</manvolnum> | |
43 | </refmeta> | |
44 | ||
45 | <refnamediv> | |
46 | <refname>systemd.automount</refname> | |
47 | <refpurpose>Automount unit configuration</refpurpose> | |
48 | </refnamediv> | |
49 | ||
50 | <refsynopsisdiv> | |
51 | <para><filename><replaceable>automount</replaceable>.automount</filename></para> | |
52 | </refsynopsisdiv> | |
53 | ||
54 | <refsect1> | |
55 | <title>Description</title> | |
56 | ||
57 | <para>A unit configuration file whose name ends in | |
58 | <literal>.automount</literal> encodes information about a file | |
59 | system automount point controlled and supervised by | |
60 | systemd.</para> | |
61 | ||
62 | <para>This man page lists the configuration options specific to | |
63 | this unit type. See | |
64 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
65 | for the common options of all unit configuration files. The common | |
66 | configuration items are configured in the generic [Unit] and | |
67 | [Install] sections. The automount specific configuration options | |
68 | are configured in the [Automount] section.</para> | |
69 | ||
70 | <para>Automount units must be named after the automount | |
71 | directories they control. Example: the automount point | |
72 | <filename noindex='true'>/home/lennart</filename> must be | |
73 | configured in a unit file | |
74 | <filename>home-lennart.automount</filename>. For details about the | |
75 | escaping logic used to convert a file system path to a unit name | |
76 | see | |
77 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> | |
78 | ||
79 | <para>For each automount unit file a matching mount unit file (see | |
80 | <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
81 | for details) must exist which is activated when the automount path | |
82 | is accessed. Example: if an automount unit | |
83 | <filename>home-lennart.automount</filename> is active and the user | |
84 | accesses <filename>/home/lennart</filename> the mount unit | |
85 | <filename>home-lennart.mount</filename> will be activated.</para> | |
86 | ||
87 | <para>Automount units may be used to implement on-demand mounting | |
88 | as well as parallelized mounting of file systems.</para> | |
89 | ||
90 | <para>If an automount point is beneath another mount point in the | |
91 | file system hierarchy, a dependency between both units is created | |
92 | automatically.</para> | |
93 | </refsect1> | |
94 | ||
95 | <refsect1> | |
96 | <title><filename>fstab</filename></title> | |
97 | ||
98 | <para>Automount units may either be configured via unit files, or | |
99 | via <filename>/etc/fstab</filename> (see | |
100 | <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
101 | for details).</para> | |
102 | ||
103 | <para>For details how systemd parses | |
104 | <filename>/etc/fstab</filename> see | |
105 | <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> | |
106 | ||
107 | <para>If an automount point is configured in both | |
108 | <filename>/etc/fstab</filename> and a unit file, the configuration | |
109 | in the latter takes precedence.</para> | |
110 | </refsect1> | |
111 | ||
112 | <refsect1> | |
113 | <title>Options</title> | |
114 | ||
115 | <para>Automount files must include an [Automount] section, which | |
116 | carries information about the file system automount points it | |
117 | supervises. The options specific to the [Automount] section of | |
118 | automount units are the following:</para> | |
119 | ||
120 | <variablelist class='unit-directives'> | |
121 | ||
122 | <varlistentry> | |
123 | <term><varname>Where=</varname></term> | |
124 | <listitem><para>Takes an absolute path of a directory of the | |
125 | automount point. If the automount point does not exist at time | |
126 | that the automount point is installed, it is created. This | |
127 | string must be reflected in the unit filename. (See above.) | |
128 | This option is mandatory.</para></listitem> | |
129 | </varlistentry> | |
130 | ||
131 | <varlistentry> | |
132 | <term><varname>DirectoryMode=</varname></term> | |
133 | <listitem><para>Directories of automount points (and any | |
134 | parent directories) are automatically created if needed. This | |
135 | option specifies the file system access mode used when | |
136 | creating these directories. Takes an access mode in octal | |
137 | notation. Defaults to 0755.</para></listitem> | |
138 | </varlistentry> | |
139 | </variablelist> | |
140 | </refsect1> | |
141 | ||
142 | <refsect1> | |
143 | <title>See Also</title> | |
144 | <para> | |
145 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
146 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
147 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
148 | <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
149 | <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
150 | <citerefentry><refentrytitle>automount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
151 | <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> | |
152 | </para> | |
153 | </refsect1> | |
65232ea7 LP |
154 | |
155 | </refentry> |