man/systemd.automount.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
   5
   6 <refentry id="systemd.automount">
   7   <refentryinfo>
   8     <title>systemd.automount</title>
   9     <productname>systemd</productname>
  10   </refentryinfo>
  11
  12   <refmeta>
  13     <refentrytitle>systemd.automount</refentrytitle>
  14     <manvolnum>5</manvolnum>
  15   </refmeta>
  16
  17   <refnamediv>
  18     <refname>systemd.automount</refname>
  19     <refpurpose>Automount unit configuration</refpurpose>
  20   </refnamediv>
  21
  22   <refsynopsisdiv>
  23     <para><filename><replaceable>automount</replaceable>.automount</filename></para>
  24   </refsynopsisdiv>
  25
  26   <refsect1>
  27     <title>Description</title>
  28
  29     <para>A unit configuration file whose name ends in
  30     <literal>.automount</literal> encodes information about a file
  31     system automount point controlled and supervised by
  32     systemd.</para>
  33
  34     <para>This man page lists the configuration options specific to
  35     this unit type. See
  36     <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  37     for the common options of all unit configuration files. The common
  38     configuration items are configured in the generic <literal>[Unit]</literal> and
  39     <literal>[Install]</literal> sections. The automount specific configuration options
  40     are configured in the <literal>[Automount]</literal> section.</para>
  41
  42     <para>Automount units must be named after the automount directories they control. Example: the automount point
  43     <filename noindex='true'>/home/lennart</filename> must be configured in a unit file
  44     <filename>home-lennart.automount</filename>. For details about the escaping logic used to convert a file system
  45     path to a unit name see
  46     <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note that
  47     automount units cannot be templated, nor is it possible to add multiple names to an automount unit by creating
  48     additional symlinks to its unit file.</para>
  49
  50     <para>For each automount unit file a matching mount unit file (see
  51     <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  52     for details) must exist which is activated when the automount path
  53     is accessed. Example: if an automount unit
  54     <filename>home-lennart.automount</filename> is active and the user
  55     accesses <filename>/home/lennart</filename> the mount unit
  56     <filename>home-lennart.mount</filename> will be activated.</para>
  57
  58     <para>Automount units may be used to implement on-demand mounting
  59     as well as parallelized mounting of file systems.</para>
  60   </refsect1>
  61
  62   <refsect1>
  63     <title>Automatic Dependencies</title>
  64
  65     <refsect2>
  66       <title>Implicit Dependencies</title>
  67
  68       <para>The following dependencies are implicitly added:</para>
  69
  70       <itemizedlist>
  71         <listitem><para>If an automount unit is beneath another mount unit in the
  72         file system hierarchy, both a requirement and an ordering
  73         dependency between both units are created automatically.</para></listitem>
  74
  75         <listitem><para>An implicit <varname>Before=</varname> dependency is created
  76         between an automount unit and the mount unit it activates.</para></listitem>
  77       </itemizedlist>
  78     </refsect2>
  79
  80     <refsect2>
  81       <title>Default Dependencies</title>
  82
  83       <para>The following dependencies are added unless <varname>DefaultDependencies=no</varname> is set:</para>
  84
  85       <itemizedlist>
  86         <listitem><para>Automount units acquire automatic <varname>Before=</varname> and
  87         <varname>Conflicts=</varname> on <filename>umount.target</filename> in order to be stopped during
  88         shutdown.</para></listitem>
  89       </itemizedlist>
  90     </refsect2>
  91   </refsect1>
  92
  93   <refsect1>
  94     <title><filename>fstab</filename></title>
  95
  96     <para>Automount units may either be configured via unit files, or
  97     via <filename>/etc/fstab</filename> (see
  98     <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  99     for details).</para>
 100
 101     <para>For details how systemd parses
 102     <filename>/etc/fstab</filename> see
 103     <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
 104
 105     <para>If an automount point is configured in both
 106     <filename>/etc/fstab</filename> and a unit file, the configuration
 107     in the latter takes precedence.</para>
 108   </refsect1>
 109
 110   <refsect1>
 111     <title>Options</title>
 112
 113     <para>Automount files must include an [Automount] section, which
 114     carries information about the file system automount points it
 115     supervises. The options specific to the [Automount] section of
 116     automount units are the following:</para>
 117
 118     <variablelist class='unit-directives'>
 119
 120       <varlistentry>
 121         <term><varname>Where=</varname></term>
 122         <listitem><para>Takes an absolute path of a directory of the
 123         automount point. If the automount point does not exist at time
 124         that the automount point is installed, it is created. This
 125         string must be reflected in the unit filename. (See above.)
 126         This option is mandatory.</para></listitem>
 127       </varlistentry>
 128
 129       <varlistentry>
 130         <term><varname>DirectoryMode=</varname></term>
 131         <listitem><para>Directories of automount points (and any
 132         parent directories) are automatically created if needed. This
 133         option specifies the file system access mode used when
 134         creating these directories. Takes an access mode in octal
 135         notation. Defaults to 0755.</para></listitem>
 136       </varlistentry>
 137       <varlistentry>
 138         <term><varname>TimeoutIdleSec=</varname></term>
 139         <listitem><para>Configures an idle timeout. Once the mount has been
 140         idle for the specified time, systemd will attempt to unmount. Takes a
 141         unit-less value in seconds, or a time span value such as "5min 20s".
 142         Pass 0 to disable the timeout logic. The timeout is disabled by
 143         default.</para></listitem>
 144       </varlistentry>
 145     </variablelist>
 146   </refsect1>
 147
 148   <refsect1>
 149       <title>See Also</title>
 150       <para>
 151         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 152         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 153         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 154         <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 155         <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 156         <citerefentry project='die-net'><refentrytitle>automount</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 157         <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 158       </para>
 159   </refsect1>
 160
 161 </refentry>