chiark / gitweb /
man: fix spacing issue in various man pages
[elogind.git] / man / systemd.mount.xml
index bcaae33418002c90210bb7338a507b614fa00e33..21177a26232605da1a99d318d62ff412d842786e 100644 (file)
@@ -48,7 +48,7 @@
         </refnamediv>
 
         <refsynopsisdiv>
-                <para><filename>systemd.mount</filename></para>
+                <para><filename><replaceable>mount</replaceable>.mount</filename></para>
         </refsynopsisdiv>
 
         <refsect1>
                 binary is executed in, and in
                 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 which define the way the processes are
-                terminated.</para>
+                terminated. Note that the User= and Group= options are
+                not particularly useful for mount units specifying a
+                <literal>Type=</literal> option or using configuration
+                not specified in <filename>/etc/fstab</filename>;
+                <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                will refuse options that aren't listed in
+                <filename>/etc/fstab</filename> if it is not run as
+                UID 0.</para>
 
                 <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
                 mounting. See
                 <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
 
-                <para>If an mount point is beneath another mount point
+                <para>If a mount point is beneath another mount point
                 in the file system hierarchy, a dependency between both
                 units is created automatically.</para>
 
-                <para>Mount points created at runtime independent on
-                unit files or <filename>/etc/fstab</filename> will be
+                <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
+                userspace-to-userpace interfaces. Some of them may not
+                be changed via mount units, and cannot be disabled.
+                For a longer discussion see <ulink
+                url="http://www.freedesktop.org/wiki/Software/systemd/APIFileSystems">API
+                File Systems</ulink>.</para>
         </refsect1>
 
         <refsect1>
                 should wait for a device to show up before giving up
                 on an entry from
                 <filename>/etc/fstab</filename>. Specify a time in
-                seconds or explicitly specifiy a unit as
+                seconds or explicitly specify a unit as
                 <literal>s</literal>, <literal>min</literal>,
                 <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>
                                 <term><varname>Where=</varname></term>
                                 <listitem><para>Takes an absolute path
                                 of a directory of the mount point. If
-                                the mount point is not existing at
+                                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
                 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>