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 project='man-pages'><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
  75     <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
  76   </refsect1>
  77
  78   <refsect1>
  79     <title>Kernel Command Line</title>
  80
  81     <para><filename>systemd-fstab-generator</filename> understands the
  82     following kernel command line parameters:</para>
  83
  84     <variablelist class='kernel-commandline-options'>
  85
  86       <varlistentry>
  87         <term><varname>fstab=</varname></term>
  88         <term><varname>rd.fstab=</varname></term>
  89
  90         <listitem><para>Takes a boolean argument. Defaults to
  91         <literal>yes</literal>. If <literal>no</literal>, causes the
  92         generator to ignore any mounts or swaps configured in
  93         <filename>/etc/fstab</filename>. <varname>rd.fstab=</varname>
  94         is honored only by initial RAM disk (initrd) while
  95         <varname>fstab=</varname> is honored by both the main system
  96         and the initrd.</para></listitem>
  97       </varlistentry>
  98       <varlistentry>
  99         <term><varname>root=</varname></term>
 100
 101         <listitem><para>Takes the root filesystem to mount in the
 102         initrd. <varname>root=</varname> is honored by the
 103         initrd.</para></listitem>
 104       </varlistentry>
 105       <varlistentry>
 106         <term><varname>rootfstype=</varname></term>
 107
 108         <listitem><para>Takes the root filesystem type that will be
 109         passed to the mount command. <varname>rootfstype=</varname> is
 110         honored by the initrd.</para></listitem>
 111       </varlistentry>
 112       <varlistentry>
 113         <term><varname>rootflags=</varname></term>
 114
 115         <listitem><para>Takes the root filesystem mount options to
 116         use. <varname>rootflags=</varname> is honored by the
 117         initrd.</para></listitem>
 118       </varlistentry>
 119       <varlistentry>
 120         <term><varname>mount.usr=</varname></term>
 121
 122         <listitem><para>Takes the <filename>/usr</filename> filesystem
 123         to be mounted by the initrd. If
 124         <varname>mount.usrfstype=</varname> or
 125         <varname>mount.usrflags=</varname> is set, then
 126         <varname>mount.usr=</varname> will default to the value set in
 127         <varname>root=</varname>.</para>
 128
 129         <para>Otherwise, this parameter defaults to the
 130         <filename>/usr</filename> entry found in
 131         <filename>/etc/fstab</filename> on the root filesystem.</para>
 132
 133         <para><varname>mount.usr=</varname> is honored by the initrd.
 134         </para></listitem>
 135       </varlistentry>
 136       <varlistentry>
 137         <term><varname>mount.usrfstype=</varname></term>
 138
 139         <listitem><para>Takes the <filename>/usr</filename> filesystem
 140         type that will be passed to the mount command. If
 141         <varname>mount.usr=</varname> or
 142         <varname>mount.usrflags=</varname> is set, then
 143         <varname>mount.usrfstype=</varname> will default to the value
 144         set in <varname>rootfstype=</varname>.</para>
 145
 146         <para>Otherwise, this value will be read from the
 147         <filename>/usr</filename> entry in
 148         <filename>/etc/fstab</filename> on the root filesystem.</para>
 149
 150         <para><varname>mount.usrfstype=</varname> is honored by the
 151         initrd.</para></listitem>
 152       </varlistentry>
 153       <varlistentry>
 154         <term><varname>mount.usrflags=</varname></term>
 155
 156         <listitem><para>Takes the <filename>/usr</filename> filesystem
 157         mount options to use. If <varname>mount.usr=</varname> or
 158         <varname>mount.usrfstype=</varname> is set, then
 159         <varname>mount.usrflags=</varname> will default to the value
 160         set in <varname>rootflags=</varname>.</para>
 161
 162         <para>Otherwise, this value will be read from the
 163         <filename>/usr</filename> entry in
 164         <filename>/etc/fstab</filename> on the root filesystem.</para>
 165
 166         <para><varname>mount.usrflags=</varname> is honored by the
 167         initrd.</para></listitem>
 168       </varlistentry>
 169     </variablelist>
 170   </refsect1>
 171
 172   <refsect1>
 173     <title>See Also</title>
 174     <para>
 175       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 176       <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 177       <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 178       <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 179       <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 180     </para>
 181   </refsect1>
 182
 183 </refentry>