chiark / gitweb /
man: use <literal> not <filename> for suffixes
[elogind.git] / man / systemd.mount.xml
index d194083..c57f613 100644 (file)
         </refnamediv>
 
         <refsynopsisdiv>
-                <para><filename>systemd.mount</filename></para>
+                <para><filename><replaceable>mount</replaceable>.mount</filename></para>
         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 
                 <para>A unit configuration file whose name ends in
-                <filename>.mount</filename> encodes information about
+                <literal>.mount</literal> encodes information about
                 a file system mount point controlled and supervised by
                 systemd.</para>
 
@@ -86,7 +86,7 @@
 
                 <para>Mount units must be named after the mount point
                 directories they control. Example: the mount point
-                <filename>/home/lennart</filename> must be configured
+                <filename noindex='true'>/home/lennart</filename> must be configured
                 in a unit file
                 <filename>home-lennart.mount</filename>. For details
                 about the escaping logic used to convert a file system
                 <para>Mount points created at runtime (independently of
                 unit files or <filename>/etc/fstab</filename>) will be
                 monitored by systemd and appear like any other mount
-                unit in systemd.</para>
+                unit in systemd.
+                See <filename>/proc/self/mountinfo</filename> description
+                in <citerefentry><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+                </para>
 
                 <para>Some file systems have special semantics as API
                 file systems for kernel-to-userspace and
                 <literal>h</literal>, <literal>ms</literal>.</para>
 
                 <para>If a mount point is configured in both
-                <filename>/etc/fstab</filename> and a unit file, the
-                configuration in the latter takes precedence.</para>
+                <filename>/etc/fstab</filename> and a unit file that
+                is stored below <filename>/usr</filename> the former
+                will take precedence. If the unit file is stored below
+                <filename>/etc</filename> it will take
+                precedence. This means: native unit files take
+                precedence over traditional configuration files, but
+                this is superseded by the rule that configuration in
+                <filename>/etc</filename> will always take precedence
+                over configuration in
+                <filename>/usr</filename>.</para>
         </refsect1>
 
         <refsect1>
                 options specific to the [Mount] section of mount
                 units are the following:</para>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
 
                         <varlistentry>
                                 <term><varname>What=</varname></term>
                                 the mount point does not exist at the
                                 time of mounting, 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>Type=</varname></term>
                                 <listitem><para>Takes a string for the
-                                filesystem type. See
+                                file system type. See
                                 <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                                 for details. This setting is
                                 optional.</para></listitem>
                                 <term><varname>Options=</varname></term>
 
                                 <listitem><para>Mount options to use
-                                when mounting. This takes a comma
-                                separated list of options. This
+                                when mounting. This takes a
+                                comma-separated list of options. This
                                 setting is optional.</para></listitem>
                         </varlistentry>
 
                                 <listitem><para>Configures the time to
                                 wait for the mount command to
                                 finish. If a command does not exit
-                                within the configured time the mount
+                                within the configured time, the mount
                                 will be considered failed and be shut
                                 down again. All commands still running
                                 will be terminated forcibly via
-                                SIGTERM, and after another delay of
-                                this time with SIGKILL. (See
+                                <constant>SIGTERM</constant>, and after another delay of
+                                this time with <constant>SIGKILL</constant>. (See
                                 <option>KillMode=</option> in
                                 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.)
                                 Takes a unit-less value in seconds, or
                 for compatibility reasons and should not be used in
                 newly written mount files.</para>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
                         <varlistentry>
                                 <term><varname>FsckPassNo=</varname></term>
 
                           <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-                          <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                   </para>
         </refsect1>