]>
Commit | Line | Data |
---|---|---|
14228c0d | 1 | '\" t |
e3bff60a | 2 | .TH "SYSTEMD\-CRYPTSETUP\-GENERATOR" "8" "" "systemd 220" "systemd-cryptsetup-generator" |
14228c0d MB |
3 | .\" ----------------------------------------------------------------- |
4 | .\" * Define some portability stuff | |
5 | .\" ----------------------------------------------------------------- | |
6 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
7 | .\" http://bugs.debian.org/507673 | |
8 | .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html | |
9 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
10 | .ie \n(.g .ds Aq \(aq | |
11 | .el .ds Aq ' | |
12 | .\" ----------------------------------------------------------------- | |
13 | .\" * set default formatting | |
14 | .\" ----------------------------------------------------------------- | |
15 | .\" disable hyphenation | |
16 | .nh | |
17 | .\" disable justification (adjust text to left margin only) | |
18 | .ad l | |
19 | .\" ----------------------------------------------------------------- | |
20 | .\" * MAIN CONTENT STARTS HERE * | |
21 | .\" ----------------------------------------------------------------- | |
22 | .SH "NAME" | |
23 | systemd-cryptsetup-generator \- Unit generator for /etc/crypttab | |
24 | .SH "SYNOPSIS" | |
25 | .PP | |
26 | /usr/lib/systemd/system\-generators/systemd\-cryptsetup\-generator | |
27 | .SH "DESCRIPTION" | |
28 | .PP | |
29 | systemd\-cryptsetup\-generator | |
30 | is a generator that translates | |
31 | /etc/crypttab | |
32 | into native systemd units early at boot and when configuration of the system manager is reloaded\&. This will create | |
33 | \fBsystemd-cryptsetup@.service\fR(8) | |
34 | units as necessary\&. | |
35 | .PP | |
36 | systemd\-cryptsetup\-generator | |
e3bff60a MP |
37 | implements |
38 | \fBsystemd.generator\fR(7)\&. | |
14228c0d MB |
39 | .SH "KERNEL COMMAND LINE" |
40 | .PP | |
41 | systemd\-cryptsetup\-generator | |
42 | understands the following kernel command line parameters: | |
43 | .PP | |
44 | \fIluks=\fR, \fIrd\&.luks=\fR | |
45 | .RS 4 | |
46 | Takes a boolean argument\&. Defaults to | |
47 | "yes"\&. If | |
48 | "no", disables the generator entirely\&. | |
49 | \fIrd\&.luks=\fR | |
50 | is honored only by initial RAM disk (initrd) while | |
51 | \fIluks=\fR | |
52 | is honored by both the main system and the initrd\&. | |
53 | .RE | |
54 | .PP | |
55 | \fIluks\&.crypttab=\fR, \fIrd\&.luks\&.crypttab=\fR | |
56 | .RS 4 | |
57 | Takes a boolean argument\&. Defaults to | |
58 | "yes"\&. If | |
59 | "no", causes the generator to ignore any devices configured in | |
60 | /etc/crypttab | |
61 | (\fIluks\&.uuid=\fR | |
62 | will still work however)\&. | |
63 | \fIrd\&.luks\&.crypttab=\fR | |
64 | is honored only by initial RAM disk (initrd) while | |
65 | \fIluks\&.crypttab=\fR | |
66 | is honored by both the main system and the initrd\&. | |
67 | .RE | |
68 | .PP | |
69 | \fIluks\&.uuid=\fR, \fIrd\&.luks\&.uuid=\fR | |
70 | .RS 4 | |
60f067b4 | 71 | Takes a LUKS superblock UUID as argument\&. This will activate the specified device as part of the boot process as if it was listed in |
f47781d8 | 72 | /etc/crypttab\&. This option may be specified more than once in order to set up multiple devices\&. |
14228c0d MB |
73 | \fIrd\&.luks\&.uuid=\fR |
74 | is honored only by initial RAM disk (initrd) while | |
75 | \fIluks\&.uuid=\fR | |
76 | is honored by both the main system and the initrd\&. | |
77 | .sp | |
f47781d8 MP |
78 | If /etc/crypttab contains entries with the same UUID, then the name, keyfile and options specified there will be used\&. Otherwise the device will have the name |
79 | "luks\-UUID"\&. | |
14228c0d | 80 | .sp |
f47781d8 MP |
81 | If /etc/crypttab exists, only those UUIDs specified on the kernel command line will be activated in the initrd or the real root\&. |
82 | .RE | |
83 | .PP | |
84 | \fIluks\&.name=\fR, \fIrd\&.luks\&.name=\fR | |
85 | .RS 4 | |
e735f4d4 MP |
86 | Takes a LUKS super block UUID followed by an |
87 | "=" | |
88 | and a name\&. This implies | |
f47781d8 MP |
89 | \fIrd\&.luks\&.uuid=\fR |
90 | or | |
91 | \fIluks\&.uuid=\fR | |
92 | and will additionally make the LUKS device given by the UUID appear under the provided name\&. | |
93 | .sp | |
94 | \fIrd\&.luks\&.name=\fR | |
95 | is honored only by initial RAM disk (initrd) while | |
96 | \fIluks\&.name=\fR | |
97 | is honored by both the main system and the initrd\&. | |
14228c0d MB |
98 | .RE |
99 | .PP | |
100 | \fIluks\&.options=\fR, \fIrd\&.luks\&.options=\fR | |
101 | .RS 4 | |
e735f4d4 MP |
102 | Takes a LUKS super block UUID followed by an |
103 | "=" | |
104 | and a string of options separated by commas as argument\&. This will override the options for the given UUID\&. | |
14228c0d | 105 | .sp |
e735f4d4 MP |
106 | If only a list of options, without an UUID, is specified, they apply to any UUIDs not specified elsewhere, and without an entry in |
107 | /etc/crypttab\&. | |
14228c0d MB |
108 | .sp |
109 | \fIrd\&.luks\&.options=\fR | |
110 | is honored only by initial RAM disk (initrd) while | |
111 | \fIluks\&.options=\fR | |
112 | is honored by both the main system and the initrd\&. | |
113 | .RE | |
114 | .PP | |
115 | \fIluks\&.key=\fR, \fIrd\&.luks\&.key=\fR | |
116 | .RS 4 | |
e735f4d4 MP |
117 | Takes a password file name as argument or a LUKS super block UUID followed by a |
118 | "=" | |
119 | and a password file name\&. | |
14228c0d MB |
120 | .sp |
121 | For those entries specified with | |
122 | \fIrd\&.luks\&.uuid=\fR | |
123 | or | |
f47781d8 | 124 | \fIluks\&.uuid=\fR, the password file will be set to the one specified by |
14228c0d MB |
125 | \fIrd\&.luks\&.key=\fR |
126 | or | |
f47781d8 MP |
127 | \fIluks\&.key=\fR |
128 | of the corresponding UUID, or the password file that was specified without a UUID\&. | |
14228c0d MB |
129 | .sp |
130 | \fIrd\&.luks\&.key=\fR | |
131 | is honored only by initial RAM disk (initrd) while | |
132 | \fIluks\&.key=\fR | |
133 | is honored by both the main system and the initrd\&. | |
134 | .RE | |
135 | .SH "SEE ALSO" | |
136 | .PP | |
137 | \fBsystemd\fR(1), | |
138 | \fBcrypttab\fR(5), | |
139 | \fBsystemd-cryptsetup@.service\fR(8), | |
140 | \fBcryptsetup\fR(8), | |
141 | \fBsystemd-fstab-generator\fR(8) |