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 a generator
  56     that translates <filename>/etc/fstab</filename> (see
  57     <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  58     for details) into native systemd units early at boot and when
  59     configuration of the system manager is reloaded. This will
  60     instantiate mount and swap units as necessary.</para>
  61
  62     <para>The <varname>passno</varname> field is treated like a simple
  63     boolean, and the ordering information is discarded. However, if
  64     the root file system is checked, it is checked before all the
  65     other file systems.</para>
  66
  67     <para>See
  68     <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  69     and
  70     <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  71     for more information about special <filename>/etc/fstab</filename>
  72     mount options this generator understands.</para>
  73
  74     <para><filename>systemd-fstab-generator</filename> implements the
  75     <ulink
  76     url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator
  77     specification</ulink>.</para>
  78   </refsect1>
  79
  80   <refsect1>
  81     <title>Kernel Command Line</title>
  82
  83     <para><filename>systemd-fstab-generator</filename> understands the
  84     following kernel command line parameters:</para>
  85
  86     <variablelist class='kernel-commandline-options'>
  87
  88       <varlistentry>
  89         <term><varname>fstab=</varname></term>
  90         <term><varname>rd.fstab=</varname></term>
  91
  92         <listitem><para>Takes a boolean argument. Defaults to
  93         <literal>yes</literal>. If <literal>no</literal>, causes the
  94         generator to ignore any mounts or swaps configured in
  95         <filename>/etc/fstab</filename>. <varname>rd.fstab=</varname>
  96         is honored only by initial RAM disk (initrd) while
  97         <varname>fstab=</varname> is honored by both the main system
  98         and the initrd.</para></listitem>
  99       </varlistentry>
 100       <varlistentry>
 101         <term><varname>root=</varname></term>
 102
 103         <listitem><para>Takes the root filesystem to mount in the
 104         initrd. <varname>root=</varname> is honored by the
 105         initrd.</para></listitem>
 106       </varlistentry>
 107       <varlistentry>
 108         <term><varname>rootfstype=</varname></term>
 109
 110         <listitem><para>Takes the root filesystem type that will be
 111         passed to the mount command. <varname>rootfstype=</varname> is
 112         honored by the initrd.</para></listitem>
 113       </varlistentry>
 114       <varlistentry>
 115         <term><varname>rootflags=</varname></term>
 116
 117         <listitem><para>Takes the root filesystem mount options to
 118         use. <varname>rootflags=</varname> is honored by the
 119         initrd.</para></listitem>
 120       </varlistentry>
 121       <varlistentry>
 122         <term><varname>mount.usr=</varname></term>
 123
 124         <listitem><para>Takes the <filename>/usr</filename> filesystem
 125         to be mounted by the initrd. If
 126         <varname>mount.usrfstype=</varname> or
 127         <varname>mount.usrflags=</varname> is set, then
 128         <varname>mount.usr=</varname> will default to the value set in
 129         <varname>root=</varname>.</para>
 130
 131         <para>Otherwise this parameter defaults to the
 132         <filename>/usr</filename> entry found in
 133         <filename>/etc/fstab</filename> on the root filesystem.</para>
 134
 135         <para><varname>mount.usr=</varname> is honored by the initrd.
 136         </para></listitem>
 137       </varlistentry>
 138       <varlistentry>
 139         <term><varname>mount.usrfstype=</varname></term>
 140
 141         <listitem><para>Takes the <filename>/usr</filename> filesystem
 142         type that will be passed to the mount command. If
 143         <varname>mount.usr=</varname> or
 144         <varname>mount.usrflags=</varname> is set, then
 145         <varname>mount.usrfstype=</varname> will default to the value
 146         set in <varname>rootfstype=</varname>.</para>
 147
 148         <para>Otherwise this value will be read from the
 149         <filename>/usr</filename> entry in
 150         <filename>/etc/fstab</filename> on the root filesystem.</para>
 151
 152         <para><varname>mount.usrfstype=</varname> is honored by the
 153         initrd.</para></listitem>
 154       </varlistentry>
 155       <varlistentry>
 156         <term><varname>mount.usrflags=</varname></term>
 157
 158         <listitem><para>Takes the <filename>/usr</filename> filesystem
 159         mount options to use. If <varname>mount.usr=</varname> or
 160         <varname>mount.usrfstype=</varname> is set, then
 161         <varname>mount.usrflages=</varname> will default to the value
 162         set in <varname>rootflags=</varname>.</para>
 163
 164         <para>Otherwise this value will be read from the
 165         <filename>/usr</filename> entry in
 166         <filename>/etc/fstab</filename> on the root filesystem.</para>
 167
 168         <para><varname>mount.usrflags=</varname> is honored by the
 169         initrd.</para></listitem>
 170       </varlistentry>
 171     </variablelist>
 172   </refsect1>
 173
 174   <refsect1>
 175     <title>See Also</title>
 176     <para>
 177       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 178       <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 179       <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 180       <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 181       <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 182     </para>
 183   </refsect1>
 184
 185 </refentry>