chiark / gitweb /
man: do not use <term> in <para>
[elogind.git] / 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
65                 is treated like a simple boolean, and the ordering information
66                 is discarded. However, the root filesystem is checked
67                 before all the other filesystems.</para>
68
69                 <para>See
70                 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
71                 and
72                 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>
73                 for more information about special
74                 <filename>/etc/fstab</filename> mount options this
75                 generator understands.</para>
76
77                 <para><filename>systemd-fstab-generator</filename>
78                 implements the <ulink
79                 url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator
80                 specification</ulink>.</para>
81         </refsect1>
82
83         <refsect1>
84                 <title>Kernel Command Line</title>
85
86                 <para><filename>systemd-fstab-generator</filename> understands
87                 the following kernel command line parameters:</para>
88
89                 <variablelist class='kernel-commandline-options'>
90
91                         <varlistentry>
92                                 <term><varname>fstab=</varname></term>
93                                 <term><varname>rd.fstab=</varname></term>
94
95                                 <listitem><para>Takes a boolean
96                                 argument. Defaults to
97                                 <literal>yes</literal>. If
98                                 <literal>no</literal>, causes the
99                                 generator to ignore any mounts or swaps
100                                 configured in
101                                 <filename>/etc/fstab</filename>. <varname>rd.fstab=</varname>
102                                 is honored only by initial RAM disk
103                                 (initrd) while
104                                 <varname>fstab=</varname> is
105                                 honored by both the main system and
106                                 the initrd.  </para></listitem>
107                         </varlistentry>
108
109                 </variablelist>
110         </refsect1>
111
112         <refsect1>
113                 <title>See Also</title>
114                 <para>
115                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
116                         <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
117                         <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
118                         <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
119                         <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
120                 </para>
121         </refsect1>
122
123 </refentry>