systemd/man/systemd-cryptsetup-generator.xml

	systemd-cryptsetup-generator.xml revision f220d83cbc63678c765dd0b80983f17b1d5e615b


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
d29201dd5328b88140ce050100693c501852657dChristian Maeder<?xml version="1.0"?>
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder<!--*-nxml-*-->
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc<!--
cacbb5e3100fb85d23d1614cace3a8662801f2e6Eugen Kuksa  This file is part of systemd.
98890889ffb2e8f6f722b00e265a211f13b5a861Corneliu-Claudiu Prodescu
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder  Copyright 2012 Lennart Poettering
cacbb5e3100fb85d23d1614cace3a8662801f2e6Eugen Kuksa
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder  systemd is free software; you can redistribute it and/or modify it
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder  under the terms of the GNU Lesser General Public License as published by
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder  the Free Software Foundation; either version 2.1 of the License, or
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc  (at your option) any later version.
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder  systemd is distributed in the hope that it will be useful, but
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder  WITHOUT ANY WARRANTY; without even the implied warranty of
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder  Lesser General Public License for more details.
e16b3696b2c173aac14200321868ed81b8f7dc69Christian Maeder
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc  You should have received a copy of the GNU Lesser General Public License
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder  along with systemd; If not, see <http://www.gnu.org/licenses/>.
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc-->
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc<refentry id="systemd-cryptsetup-generator">
6342ef8f9f785e79c91f217c30b3ba2b6fa0ad4fEugen Kuksa
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc        <refentryinfo>
de03ed90ff6efbbc4751301bcf6b50d9790c1afbKarl Luc                <title>systemd-cryptsetup-generator</title>
52c81e62d4a3797b926fb3392369b45a9fef336cSoeren D. Schulze                <productname>systemd</productname>
52c81e62d4a3797b926fb3392369b45a9fef336cSoeren D. Schulze
d386b61802c70e3d220d4520d9fcdefbd9c469f4Soeren D. Schulze                <authorgroup>
66977d201b3ff7ee9c1f992c0f3f701b69eac2c9Karl Luc                        <author>
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov                                <contrib>Developer</contrib>
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov                                <firstname>Lennart</firstname>
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov                                <surname>Poettering</surname>
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa                                <email>lennart@poettering.net</email>
a35bacbc16daf5c10f9accfdfadc4971e9d6f648Iulia Ignatov                        </author>
e16b3696b2c173aac14200321868ed81b8f7dc69Christian Maeder                </authorgroup>
e16b3696b2c173aac14200321868ed81b8f7dc69Christian Maeder        </refentryinfo>
e16b3696b2c173aac14200321868ed81b8f7dc69Christian Maeder
e16b3696b2c173aac14200321868ed81b8f7dc69Christian Maeder        <refmeta>
e16b3696b2c173aac14200321868ed81b8f7dc69Christian Maeder                <refentrytitle>systemd-cryptsetup-generator</refentrytitle>
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder                <manvolnum>8</manvolnum>
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder        </refmeta>
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder
3831cf8a3b0ea144a80d13fe0314cc2752e32107Christian Maeder        <refnamediv>
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder                <refname>systemd-cryptsetup-generator</refname>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                <refpurpose>Unit generator for <filename>/etc/crypttab</filename></refpurpose>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc        </refnamediv>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc        <refsynopsisdiv>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                <para><filename>/usr/lib/systemd/system-generators/systemd-cryptsetup-generator</filename></para>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc        </refsynopsisdiv>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc        <refsect1>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                <title>Description</title>
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc
1ea7fb6b0f66210bc0d3cb995f1b655277b33884Eugen Kuksa                <para><filename>systemd-cryptsetup-generator</filename>
d6ce032cac688f3698be7133d27f53d3967e6749Christian Maeder                is a generator that translates
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc                <filename>/etc/crypttab</filename> into native systemd
de03ed90ff6efbbc4751301bcf6b50d9790c1afbKarl Luc                units early at boot and when configuration of the
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                system manager is reloaded. This will create
551f1476dea3f969775527cb15fd512e86279307Karl Luc                <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
9e5811a3323b00d6ff8d3fe91a185de1ab31150bChristian Maeder                units as necessary.</para>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                <para><filename>systemd-cryptsetup-generator</filename>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                implements the <ulink
59ec6aa4da4c93d0d4ef53ed74fdf866d0654539Eugen Kuksa                url="http://www.freedesktop.org/wiki/Software/systemd/Generator">generator
59ec6aa4da4c93d0d4ef53ed74fdf866d0654539Eugen Kuksa                specification</ulink>.</para>
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc        </refsect1>
e16b3696b2c173aac14200321868ed81b8f7dc69Christian Maeder
e16b3696b2c173aac14200321868ed81b8f7dc69Christian Maeder        <refsect1>
e16b3696b2c173aac14200321868ed81b8f7dc69Christian Maeder                <title>Kernel Command Line</title>
e16b3696b2c173aac14200321868ed81b8f7dc69Christian Maeder
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc                <para><filename>systemd-cryptsetup-generator</filename> understands
c51d1f5ff88cce030fe543e271ca6b85625b70d8Karl Luc                the following kernel command line parameters:</para>
a65c6747c9acbbebc93baba7bae94d2e3d8cdafbTill Mossakowski
037be4e5b0e867dd148db2ea89640d8edf009053Eugen Kuksa                <variablelist>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                        <varlistentry>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                                <term><varname>luks=</varname></term>
0b282d1269b8f9a658f7ce9090575ba1b00e8d66Christian Maeder                                <term><varname>rd.luks=</varname></term>
d386b61802c70e3d220d4520d9fcdefbd9c469f4Soeren D. Schulze
0b282d1269b8f9a658f7ce9090575ba1b00e8d66Christian Maeder                                <listitem><para>Takes a boolean
0b282d1269b8f9a658f7ce9090575ba1b00e8d66Christian Maeder                                argument. Defaults to
52c81e62d4a3797b926fb3392369b45a9fef336cSoeren D. Schulze                                <literal>yes</literal>. If
52c81e62d4a3797b926fb3392369b45a9fef336cSoeren D. Schulze                                <literal>no</literal> disables the
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder                                generator
3831cf8a3b0ea144a80d13fe0314cc2752e32107Christian Maeder                                entirely. <varname>rd.luks=</varname>
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa                                is honoured only be initial RAM disk
c51d1f5ff88cce030fe543e271ca6b85625b70d8Karl Luc                                (initrd) while
1ea7fb6b0f66210bc0d3cb995f1b655277b33884Eugen Kuksa                                <varname>luks=</varname> is honoured
037be4e5b0e867dd148db2ea89640d8edf009053Eugen Kuksa                                by both the main system and the
2c10bceb28a74fc291959697e023f22a66753655Eugen Kuksa                                initrd.  </para></listitem>
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc                        </varlistentry>
d6ce032cac688f3698be7133d27f53d3967e6749Christian Maeder
de03ed90ff6efbbc4751301bcf6b50d9790c1afbKarl Luc                        <varlistentry>
de03ed90ff6efbbc4751301bcf6b50d9790c1afbKarl Luc                                <term><varname>luks.crypttab=</varname></term>
cacbb5e3100fb85d23d1614cace3a8662801f2e6Eugen Kuksa                                <term><varname>rd.luks.crypttab=</varname></term>
551f1476dea3f969775527cb15fd512e86279307Karl Luc
8d70fa3e2a60d7dec11acc917ecb0d76899d618aChristian Maeder                                <listitem><para>Takes a boolean
5e6915f767bd46767306abbfbb39ebcbc10a2a33Christian Maeder                                argument. Defaults to
7b1111ca3b126f71cce47e60ce4b56e6f92422e9Karl Luc                                <literal>yes</literal>. If
7b1111ca3b126f71cce47e60ce4b56e6f92422e9Karl Luc                                <literal>no</literal> causes the
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov                                generator to ignore any devices
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov                                configured in
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov                                <filename>/etc/crypttab</filename>
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov                                (<varname>luks.uuid=</varname> will
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov                                still work
0ac66bed6456d7900a657269e36107ca7bec4756Iulia Ignatov                                however). <varname>rd.luks.crypttab=</varname>
51846950b4b1f31342008cf17f667859a5f21949Christian Maeder                                is honoured only be initial RAM disk
3831cf8a3b0ea144a80d13fe0314cc2752e32107Christian Maeder                                (initrd) while
c51d1f5ff88cce030fe543e271ca6b85625b70d8Karl Luc                                <varname>luks.crypttab=</varname> is
1ea7fb6b0f66210bc0d3cb995f1b655277b33884Eugen Kuksa                                honoured by both the main system and
037be4e5b0e867dd148db2ea89640d8edf009053Eugen Kuksa                                the initrd.  </para></listitem>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                        </varlistentry>
de03ed90ff6efbbc4751301bcf6b50d9790c1afbKarl Luc
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc                        <varlistentry>
de03ed90ff6efbbc4751301bcf6b50d9790c1afbKarl Luc                                <term><varname>luks.uuid=</varname></term>
de03ed90ff6efbbc4751301bcf6b50d9790c1afbKarl Luc                                <term><varname>rd.luks.uuid=</varname></term>
7165a916d2fa1bf87c4741ec63b253413eebbf69Karl Luc
9e5811a3323b00d6ff8d3fe91a185de1ab31150bChristian Maeder                                <listitem><para>Takes a LUKS super
9e5811a3323b00d6ff8d3fe91a185de1ab31150bChristian Maeder                                block UUID as argument. This will
9e5811a3323b00d6ff8d3fe91a185de1ab31150bChristian Maeder                                activate the specified device as part
9e5811a3323b00d6ff8d3fe91a185de1ab31150bChristian Maeder                                of the boot process as if it was
9e5811a3323b00d6ff8d3fe91a185de1ab31150bChristian Maeder                                listed in
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                                <filename>/etc/fstab</filename>. This
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                                option may be specified more than once
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                                in order to set up multiple
c96c73387a0c41614ba325f737edad6abbf07e79Eugen Kuksa                                devices. <varname>rd.luks.uuid=</varname>
c96c73387a0c41614ba325f737edad6abbf07e79Eugen Kuksa                                is honoured only be initial RAM disk
9e5811a3323b00d6ff8d3fe91a185de1ab31150bChristian Maeder                                (initrd) while
1da120eb84c9d3ed16f64d6defd9bc30569dc45bChristian Maeder                                <varname>luks.uuid=</varname> is
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                                honoured by both the main system and
9e5811a3323b00d6ff8d3fe91a185de1ab31150bChristian Maeder                                the initrd.</para></listitem>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                        </varlistentry>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                </variablelist>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc        </refsect1>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc        <refsect1>
75067b1beba1380cde707c30e7fc050d86f6927fKarl Luc                <title>See Also</title>
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa                <para>
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa                        <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa                        <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa                        <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa                </para>
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa        </refsect1>
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa</refentry>
99a1bfbb82c875580410b4745617fea2297fdc2bEugen Kuksa