]>
Commit | Line | Data |
---|---|---|
8e129f51 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 | --> | |
56ba3c78 | 22 | <refentry id="systemd-cryptsetup-generator" conditional='HAVE_LIBCRYPTSETUP'> |
8e129f51 LP |
23 | |
24 | <refentryinfo> | |
25 | <title>systemd-cryptsetup-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-cryptsetup-generator</refentrytitle> | |
40 | <manvolnum>8</manvolnum> | |
41 | </refmeta> | |
42 | ||
43 | <refnamediv> | |
44 | <refname>systemd-cryptsetup-generator</refname> | |
f220d83c | 45 | <refpurpose>Unit generator for <filename>/etc/crypttab</filename></refpurpose> |
8e129f51 LP |
46 | </refnamediv> |
47 | ||
48 | <refsynopsisdiv> | |
f220d83c | 49 | <para><filename>/usr/lib/systemd/system-generators/systemd-cryptsetup-generator</filename></para> |
8e129f51 LP |
50 | </refsynopsisdiv> |
51 | ||
52 | <refsect1> | |
53 | <title>Description</title> | |
54 | ||
55 | <para><filename>systemd-cryptsetup-generator</filename> | |
56 | is a generator that translates | |
57 | <filename>/etc/crypttab</filename> into native systemd | |
58 | units early at boot and when configuration of the | |
59 | system manager is reloaded. This will create | |
60 | <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
61 | units as necessary.</para> | |
62 | ||
63 | <para><filename>systemd-cryptsetup-generator</filename> | |
64 | implements the <ulink | |
8fd1952f | 65 | url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator |
8e129f51 LP |
66 | specification</ulink>.</para> |
67 | </refsect1> | |
68 | ||
69 | <refsect1> | |
70 | <title>Kernel Command Line</title> | |
71 | ||
72 | <para><filename>systemd-cryptsetup-generator</filename> understands | |
73 | the following kernel command line parameters:</para> | |
74 | ||
ccc9a4f9 | 75 | <variablelist class='kernel-commandline-options'> |
8e129f51 LP |
76 | <varlistentry> |
77 | <term><varname>luks=</varname></term> | |
78 | <term><varname>rd.luks=</varname></term> | |
79 | ||
80 | <listitem><para>Takes a boolean | |
81 | argument. Defaults to | |
82 | <literal>yes</literal>. If | |
83 | <literal>no</literal> disables the | |
84 | generator | |
85 | entirely. <varname>rd.luks=</varname> | |
bb31a4ac | 86 | is honored only by initial RAM disk |
8e129f51 | 87 | (initrd) while |
bb31a4ac | 88 | <varname>luks=</varname> is honored |
8e129f51 LP |
89 | by both the main system and the |
90 | initrd. </para></listitem> | |
91 | </varlistentry> | |
92 | ||
93 | <varlistentry> | |
94 | <term><varname>luks.crypttab=</varname></term> | |
95 | <term><varname>rd.luks.crypttab=</varname></term> | |
96 | ||
97 | <listitem><para>Takes a boolean | |
98 | argument. Defaults to | |
99 | <literal>yes</literal>. If | |
100 | <literal>no</literal> causes the | |
101 | generator to ignore any devices | |
102 | configured in | |
103 | <filename>/etc/crypttab</filename> | |
104 | (<varname>luks.uuid=</varname> will | |
105 | still work | |
106 | however). <varname>rd.luks.crypttab=</varname> | |
bb31a4ac | 107 | is honored only by initial RAM disk |
8e129f51 LP |
108 | (initrd) while |
109 | <varname>luks.crypttab=</varname> is | |
bb31a4ac | 110 | honored by both the main system and |
8e129f51 LP |
111 | the initrd. </para></listitem> |
112 | </varlistentry> | |
113 | ||
114 | <varlistentry> | |
115 | <term><varname>luks.uuid=</varname></term> | |
116 | <term><varname>rd.luks.uuid=</varname></term> | |
117 | ||
118 | <listitem><para>Takes a LUKS super | |
119 | block UUID as argument. This will | |
120 | activate the specified device as part | |
121 | of the boot process as if it was | |
122 | listed in | |
123 | <filename>/etc/fstab</filename>. This | |
124 | option may be specified more than once | |
125 | in order to set up multiple | |
126 | devices. <varname>rd.luks.uuid=</varname> | |
bb31a4ac | 127 | is honored only by initial RAM disk |
8e129f51 LP |
128 | (initrd) while |
129 | <varname>luks.uuid=</varname> is | |
bb31a4ac | 130 | honored by both the main system and |
8e129f51 LP |
131 | the initrd.</para></listitem> |
132 | </varlistentry> | |
133 | </variablelist> | |
134 | </refsect1> | |
135 | ||
136 | <refsect1> | |
137 | <title>See Also</title> | |
138 | <para> | |
139 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
140 | <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
141 | <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
059b37cc LP |
142 | <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
143 | <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
8e129f51 LP |
144 | </para> |
145 | </refsect1> | |
146 | ||
147 | </refentry> |