]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/systemd.automount.xml
test-hostname-util: add assert_se's to make coverity happy
[thirdparty/systemd.git] / man / systemd.automount.xml
index 18c10d00f50575cb01d4d681ff78bfcbec9ec5cd..b0f5b193724151d849fc391b49e734cb7f7916f9 100644 (file)
@@ -1,11 +1,10 @@
 <?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" [
-<!ENTITY % entities SYSTEM "custom-entities.ent" >
-%entities;
-]>
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!--
+  SPDX-License-Identifier: LGPL-2.1+
+
   This file is part of systemd.
 
   Copyright 2010 Lennart Poettering
     [Install] sections. The automount specific configuration options
     are configured in the [Automount] section.</para>
 
-    <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
-    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
+    <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
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note that
+    automount units cannot be templated, nor is it possible to add multiple names to an automount unit by creating
+    additional symlinks to its unit file.</para>
 
     <para>For each automount unit file a matching mount unit file (see
     <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 
     <para>Automount units may be used to implement on-demand mounting
     as well as parallelized mounting of file systems.</para>
+  </refsect1>
+
+  <refsect1>
+    <title>Implicit Dependencies</title>
+
+    <para>The following dependencies are implicitly added:</para>
+
+    <itemizedlist>
+      <listitem><para>If an automount unit is beneath another mount unit in the
+      file system hierarchy, both a requirement and an ordering
+      dependency between both units are created automatically.</para></listitem>
+
+      <listitem><para>An implicit <varname>Before=</varname> dependency is created
+      between an automount unit and the mount unit it activates.</para></listitem>
+    </itemizedlist>
+  </refsect1>
+
+  <refsect1>
+    <title>Default Dependencies</title>
+
+    <para>The following dependencies are added unless <varname>DefaultDependencies=no</varname> is set:</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>
+    <itemizedlist>
+      <listitem><para>Automount units acquire automatic <varname>Before=</varname> and
+      <varname>Conflicts=</varname> on <filename>umount.target</filename> in order to be stopped during
+      shutdown.</para></listitem>
+    </itemizedlist>
   </refsect1>
 
   <refsect1>
       </varlistentry>
       <varlistentry>
         <term><varname>TimeoutIdleSec=</varname></term>
-        <listitem><para>Configures an idleness timeout. Once the mount has been
+        <listitem><para>Configures an idle timeout. Once the mount has been
         idle for the specified time, systemd will attempt to unmount. Takes a
         unit-less value in seconds, or a time span value such as "5min 20s".
         Pass 0 to disable the timeout logic. The timeout is disabled by