[thirdparty/systemd.git] / man / systemd-fstab-generator.xml

<?xml version="1.0"?>
<!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
  This file is part of systemd.

  Copyright 2012 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="systemd-fstab-generator">

        <refentryinfo>
                <title>systemd-fstab-generator</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>systemd-fstab-generator</refentrytitle>
                <manvolnum>8</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>systemd-fstab-generator</refname>
                <refpurpose>Unit generator for /etc/fstab</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <para><filename>/usr/lib/systemd/system-generators/systemd-fstab-generator</filename></para>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><filename>systemd-fstab-generator</filename> is
                a generator that translates
                <filename>/etc/fstab</filename> (see
                <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                for details) into native systemd units early at boot
                and when configuration of the system manager is
                reloaded. This will instantiate mount and swap units
                as necessary.</para>

                <para>The <varname>passno</varname> field is treated
                like a simple boolean, and the ordering information is
                discarded. However, if the root file system is
                checked, it is checked before all the other
                file systems.</para>

                <para>See
                <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                and
                <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                for more information about special
                <filename>/etc/fstab</filename> mount options this
                generator understands.</para>

                <para><filename>systemd-fstab-generator</filename>
                implements the <ulink
                url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator
                specification</ulink>.</para>
        </refsect1>

        <refsect1>
                <title>Kernel Command Line</title>

                <para><filename>systemd-fstab-generator</filename> understands
                the following kernel command line parameters:</para>

                <variablelist class='kernel-commandline-options'>

                        <varlistentry>
                                <term><varname>fstab=</varname></term>
                                <term><varname>rd.fstab=</varname></term>

                                <listitem><para>Takes a boolean
                                argument. Defaults to
                                <literal>yes</literal>. If
                                <literal>no</literal>, causes the
                                generator to ignore any mounts or swaps
                                configured in
                                <filename>/etc/fstab</filename>. <varname>rd.fstab=</varname>
                                is honored only by initial RAM disk
                                (initrd) while
                                <varname>fstab=</varname> is
                                honored by both the main system and
                                the initrd.</para></listitem>
                        </varlistentry>
                        <varlistentry>
                                <term><varname>root=</varname></term>

                                <listitem><para>Takes the root filesystem to mount
                                in the initrd.
                                <varname>root=</varname> is
                                honored by the initrd.</para></listitem>
                        </varlistentry>
                        <varlistentry>
                                <term><varname>rootfstype=</varname></term>

                                <listitem><para>Takes the root filesystem type that
                                will be passed to the mount command.
                                <varname>rootfstype=</varname> is
                                honored by the initrd.</para></listitem>
                        </varlistentry>
                        <varlistentry>
                                <term><varname>rootflags=</varname></term>

                                <listitem><para>Takes the root filesystem mount options
                                to use. <varname>rootflags=</varname> is
                                honored by the initrd.</para></listitem>
                        </varlistentry>
                        <varlistentry>
                                <term><varname>mount.usr=</varname></term>

                                <listitem><para>Takes the <filename>/usr</filename>
                                filesystem to be mounted by the initrd. If
                                <varname>mount.usrfstype=</varname> or
                                <varname>mount.usrflags=</varname> is set, then
                                <varname>mount.usr=</varname> will default to the value set in
                                <varname>root=</varname>.</para>

                                <para>Otherwise this parameter defaults to the
                                <filename>/usr</filename> entry
                                found in <filename>/etc/fstab</filename> on the root
                                filesystem.</para>

                                <para><varname>mount.usr=</varname> is honored by the initrd.
                                </para></listitem>
                        </varlistentry>
                        <varlistentry>
                                <term><varname>mount.usrfstype=</varname></term>

                                <listitem><para>Takes the <filename>/usr</filename>
                                filesystem type that will be passed to the mount
                                command. If <varname>mount.usr=</varname> or
                                <varname>mount.usrflags=</varname> is set, then
                                <varname>mount.usrfstype=</varname> will default to the value set in
                                <varname>rootfstype=</varname>.</para>

                                <para>Otherwise this value will be read from the
                                <filename>/usr</filename> entry in
                                <filename>/etc/fstab</filename> on the root filesystem.</para>

                                <para><varname>mount.usrfstype=</varname> is
                                honored by the initrd.</para></listitem>
                        </varlistentry>
                        <varlistentry>
                                <term><varname>mount.usrflags=</varname></term>

                                <listitem><para>Takes the <filename>/usr</filename>
                                filesystem mount options to use. If
                                <varname>mount.usr=</varname> or
                                <varname>mount.usrfstype=</varname> is set, then
                                <varname>mount.usrflages=</varname> will default to the value set in
                                <varname>rootflags=</varname>.</para>

                                <para>Otherwise this value will be read from the
                                <filename>/usr</filename> entry in
                                <filename>/etc/fstab</filename> on the root filesystem.</para>

                                <para><varname>mount.usrflags=</varname> is
                                honored by the initrd.</para></listitem>
                        </varlistentry>
                </variablelist>
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>
Commit	Line	Data
059b37cc LP	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>
34511ca7	45	<refpurpose>Unit generator for /etc/fstab</refpurpose>
059b37cc LP	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
bb31a4ac	62	as necessary.</para>
059b37cc	63
72ebbf34 ZJS	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>
64e70e4b	69
059b37cc LP	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
8fd1952f	80	url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator
059b37cc LP	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
ccc9a4f9	90	<variablelist class='kernel-commandline-options'>
059b37cc LP	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
79640424	99	<literal>no</literal>, causes the
059b37cc LP	100	generator to ignore any mounts or swaps
	101	configured in
	102	<filename>/etc/fstab</filename>. <varname>rd.fstab=</varname>
bb31a4ac	103	is honored only by initial RAM disk
059b37cc	104	(initrd) while
c8be47e8	105	<varname>fstab=</varname> is
bb31a4ac	106	honored by both the main system and
9f103625	107	the initrd.</para></listitem>
059b37cc	108	</varlistentry>
9f103625 TH	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>
059b37cc	176
9f103625 TH	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>
059b37cc LP	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>