man/systemd-fstab-generator.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!--
   5   This file is part of systemd.
   6
   7   Copyright 2012 Lennart Poettering
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 -->
  22 <refentry id="systemd-fstab-generator">
  23
  24         <refentryinfo>
  25                 <title>systemd-fstab-generator</title>
  26                 <productname>systemd</productname>
  27
  28                 <authorgroup>
  29                         <author>
  30                                 <contrib>Developer</contrib>
  31                                 <firstname>Lennart</firstname>
  32                                 <surname>Poettering</surname>
  33                                 <email>lennart@poettering.net</email>
  34                         </author>
  35                 </authorgroup>
  36         </refentryinfo>
  37
  38         <refmeta>
  39                 <refentrytitle>systemd-fstab-generator</refentrytitle>
  40                 <manvolnum>8</manvolnum>
  41         </refmeta>
  42
  43         <refnamediv>
  44                 <refname>systemd-fstab-generator</refname>
  45                 <refpurpose>Unit generator for /etc/fstab</refpurpose>
  46         </refnamediv>
  47
  48         <refsynopsisdiv>
  49                 <para><filename>/usr/lib/systemd/system-generators/systemd-fstab-generator</filename></para>
  50         </refsynopsisdiv>
  51
  52         <refsect1>
  53                 <title>Description</title>
  54
  55                 <para><filename>systemd-fstab-generator</filename> is
  56                 a generator that translates
  57                 <filename>/etc/fstab</filename> (see
  58                 <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  59                 for details) into native systemd units early at boot
  60                 and when configuration of the system manager is
  61                 reloaded. This will instantiate mount and swap units
  62                 as necessary.</para>
  63
  64                 <para>The <varname>passno</varname> field is treated
  65                 like a simple boolean, and the ordering information is
  66                 discarded. However, if the root file system is
  67                 checked, it is checked before all the other
  68                 file systems.</para>
  69
  70                 <para>See
  71                 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  72                 and
  73                 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  74                 for more information about special
  75                 <filename>/etc/fstab</filename> mount options this
  76                 generator understands.</para>
  77
  78                 <para><filename>systemd-fstab-generator</filename>
  79                 implements the <ulink
  80                 url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator
  81                 specification</ulink>.</para>
  82         </refsect1>
  83
  84         <refsect1>
  85                 <title>Kernel Command Line</title>
  86
  87                 <para><filename>systemd-fstab-generator</filename> understands
  88                 the following kernel command line parameters:</para>
  89
  90                 <variablelist class='kernel-commandline-options'>
  91
  92                         <varlistentry>
  93                                 <term><varname>fstab=</varname></term>
  94                                 <term><varname>rd.fstab=</varname></term>
  95
  96                                 <listitem><para>Takes a boolean
  97                                 argument. Defaults to
  98                                 <literal>yes</literal>. If
  99                                 <literal>no</literal>, causes the
 100                                 generator to ignore any mounts or swaps
 101                                 configured in
 102                                 <filename>/etc/fstab</filename>. <varname>rd.fstab=</varname>
 103                                 is honored only by initial RAM disk
 104                                 (initrd) while
 105                                 <varname>fstab=</varname> is
 106                                 honored by both the main system and
 107                                 the initrd.</para></listitem>
 108                         </varlistentry>
 109                         <varlistentry>
 110                                 <term><varname>root=</varname></term>
 111
 112                                 <listitem><para>Takes the root filesystem to mount
 113                                 in the initrd.
 114                                 <varname>root=</varname> is
 115                                 honored by the initrd.</para></listitem>
 116                         </varlistentry>
 117                         <varlistentry>
 118                                 <term><varname>rootfstype=</varname></term>
 119
 120                                 <listitem><para>Takes the root filesystem type that
 121                                 will be passed to the mount command.
 122                                 <varname>rootfstype=</varname> is
 123                                 honored by the initrd.</para></listitem>
 124                         </varlistentry>
 125                         <varlistentry>
 126                                 <term><varname>rootflags=</varname></term>
 127
 128                                 <listitem><para>Takes the root filesystem mount options
 129                                 to use. <varname>rootflags=</varname> is
 130                                 honored by the initrd.</para></listitem>
 131                         </varlistentry>
 132                         <varlistentry>
 133                                 <term><varname>mount.usr=</varname></term>
 134
 135                                 <listitem><para>Takes the <filename>/usr</filename>
 136                                 filesystem to be mounted by the initrd. If
 137                                 <varname>mount.usrfstype=</varname> or
 138                                 <varname>mount.usrflags=</varname> is set, then
 139                                 <varname>mount.usr=</varname> will default to the value set in
 140                                 <varname>root=</varname>.</para>
 141
 142                                 <para>Otherwise this parameter defaults to the
 143                                 <filename>/usr</filename> entry
 144                                 found in <filename>/etc/fstab</filename> on the root
 145                                 filesystem.</para>
 146
 147                                 <para><varname>mount.usr=</varname> is honored by the initrd.
 148                                 </para></listitem>
 149                         </varlistentry>
 150                         <varlistentry>
 151                                 <term><varname>mount.usrfstype=</varname></term>
 152
 153                                 <listitem><para>Takes the <filename>/usr</filename>
 154                                 filesystem type that will be passed to the mount
 155                                 command. If <varname>mount.usr=</varname> or
 156                                 <varname>mount.usrflags=</varname> is set, then
 157                                 <varname>mount.usrfstype=</varname> will default to the value set in
 158                                 <varname>rootfstype=</varname>.</para>
 159
 160                                 <para>Otherwise this value will be read from the
 161                                 <filename>/usr</filename> entry in
 162                                 <filename>/etc/fstab</filename> on the root filesystem.</para>
 163
 164                                 <para><varname>mount.usrfstype=</varname> is
 165                                 honored by the initrd.</para></listitem>
 166                         </varlistentry>
 167                         <varlistentry>
 168                                 <term><varname>mount.usrflags=</varname></term>
 169
 170                                 <listitem><para>Takes the <filename>/usr</filename>
 171                                 filesystem mount options to use. If
 172                                 <varname>mount.usr=</varname> or
 173                                 <varname>mount.usrfstype=</varname> is set, then
 174                                 <varname>mount.usrflages=</varname> will default to the value set in
 175                                 <varname>rootflags=</varname>.</para>
 176
 177                                 <para>Otherwise this value will be read from the
 178                                 <filename>/usr</filename> entry in
 179                                 <filename>/etc/fstab</filename> on the root filesystem.</para>
 180
 181                                 <para><varname>mount.usrflags=</varname> is
 182                                 honored by the initrd.</para></listitem>
 183                         </varlistentry>
 184                 </variablelist>
 185         </refsect1>
 186
 187         <refsect1>
 188                 <title>See Also</title>
 189                 <para>
 190                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 191                         <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 192                         <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 193                         <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 194                         <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 195                 </para>
 196         </refsect1>
 197
 198 </refentry>