chiark / gitweb /
libudev: enumerate - do not try to match against an empty subsystem
[elogind.git] / man / systemd.automount.xml
index a09839a68d485ddcc7d9115355331f4dfb802bc6..adba75a71ad9074156cd419e09c090c46b491f12 100644 (file)
@@ -9,16 +9,16 @@
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
   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
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 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
   (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.
+  Lesser General Public License for more details.
 
 
-  You should have received a copy of the GNU General Public License
+  You should have received a copy of the GNU Lesser General Public License
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
 
         <refnamediv>
                 <refname>systemd.automount</refname>
 
         <refnamediv>
                 <refname>systemd.automount</refname>
-                <refpurpose>systemd automount configuration files</refpurpose>
+                <refpurpose>Automount unit configuration</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
         </refnamediv>
 
         <refsynopsisdiv>
-                <para><filename>systemd.automount</filename></para>
+                <para><filename><replaceable>automount</replaceable>.automount</filename></para>
         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 
                 <para>A unit configuration file whose name ends in
         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 
                 <para>A unit configuration file whose name ends in
-                <filename>.automount</filename> encodes information
+                <literal>.automount</literal> encodes information
                 about a file system automount point controlled and
                 supervised by systemd.</para>
 
                 about a file system automount point controlled and
                 supervised by systemd.</para>
 
                 automount specific configuration options are configured
                 in the [Automount] section.</para>
 
                 automount specific configuration options are configured
                 in the [Automount] section.</para>
 
-                <para>Automount units must be named after the file
-                paths they reflect. Example: the automount point
-                <filename>/home/lennart</filename> must be configured
-                in a unit file
+                <para>Automount units must be named after the
+                automount directories they control. Example: the
+                automount point <filename noindex='true'>/home/lennart</filename>
+                must be configured in a unit file
                 <filename>home-lennart.automount</filename>. For
                 details about the escaping logic used to convert a
                 file system path to a unit name see
                 <filename>home-lennart.automount</filename>. For
                 details about the escaping logic used to convert a
                 file system path to a unit name see
@@ -92,6 +92,9 @@
                 on-demand mounting as well as parallelized mounting of
                 file systems.</para>
 
                 on-demand mounting as well as parallelized mounting of
                 file systems.</para>
 
+                <para>If an automount point is beneath another mount
+                point in the file system hierarchy a dependency
+                between both units is created automatically.</para>
         </refsect1>
 
         <refsect1>
         </refsect1>
 
         <refsect1>
                 specific to the [Automount] section of automount units
                 are the following:</para>
 
                 specific to the [Automount] section of automount units
                 are the following:</para>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
 
                         <varlistentry>
                                 <term><varname>Where=</varname></term>
                                 <listitem><para>Takes an absolute path
                                 of a directory of the automount
                                 point. If the automount point is not
 
                         <varlistentry>
                                 <term><varname>Where=</varname></term>
                                 <listitem><para>Takes an absolute path
                                 of a directory of the automount
                                 point. If the automount point is not
-                                existing at time of the automount
+                                existing at time that the automount
                                 point is installed it is created. This
                                 string must be reflected in the unit
                                 point is installed it is created. This
                                 string must be reflected in the unit
-                                file name. (See above.) This option is
+                                filename. (See above.) This option is
                                 mandatory.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <term><varname>DirectoryMode=</varname></term>
                                 mandatory.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <term><varname>DirectoryMode=</varname></term>
-                                <listitem><para>Directories of automount
-                                points (and any parent directories)
-                                are automatically created if
-                                needed. This option specifies the file
-                                system access mode used when creating
-                                these directories. Defaults to
+                                <listitem><para>Directories of
+                                automount points (and any parent
+                                directories) are automatically created
+                                if needed. This option specifies the
+                                file system access mode used when
+                                creating these directories. Takes an
+                                access mode in octal
+                                notation. Defaults to
                                 0755.</para></listitem>
                         </varlistentry>
                 </variablelist>
                                 0755.</para></listitem>
                         </varlistentry>
                 </variablelist>
         <refsect1>
                   <title>See Also</title>
                   <para>
         <refsect1>
                   <title>See Also</title>
                   <para>
-                          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-                          <citerefentry><refentrytitle>automount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>automount</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                   </para>
         </refsect1>
 
                   </para>
         </refsect1>