]> git.proxmox.com Git - systemd.git/blame - man/systemd-cryptsetup-generator.html
Imported Upstream version 221
[systemd.git] / man / systemd-cryptsetup-generator.html
CommitLineData
663996b3
MS
1<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>systemd-cryptsetup-generator</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><style>
2 a.headerlink {
3 color: #c60f0f;
4 font-size: 0.8em;
5 padding: 0 4px 0 4px;
6 text-decoration: none;
7 visibility: hidden;
8 }
9
10 a.headerlink:hover {
11 background-color: #c60f0f;
12 color: white;
13 }
14
15 h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, dt:hover > a.headerlink {
16 visibility: visible;
17 }
18 </style><a href="index.html">Index </a>·
19 <a href="systemd.directives.html">Directives </a>·
20 <a href="../python-systemd/index.html">Python </a>·
86f210e9
MP
21
22 <span style="float:right">systemd 221</span><hr><div class="refentry"><a name="systemd-cryptsetup-generator"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>systemd-cryptsetup-generator — Unit generator for <code class="filename">/etc/crypttab</code></p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><p><code class="filename">/usr/lib/systemd/system-generators/systemd-cryptsetup-generator</code></p></div><div class="refsect1"><a name="idm47693542829984"></a><h2 id="Description">Description<a class="headerlink" title="Permalink to this headline" href="#Description">¶</a></h2><p><code class="filename">systemd-cryptsetup-generator</code> is a
e735f4d4
MP
23 generator that translates <code class="filename">/etc/crypttab</code> into
24 native systemd units early at boot and when configuration of the
25 system manager is reloaded. This will create
26 <a href="systemd-cryptsetup@.service.html"><span class="citerefentry"><span class="refentrytitle">systemd-cryptsetup@.service</span>(8)</span></a>
e3bff60a 27 units as necessary.</p><p><code class="filename">systemd-cryptsetup-generator</code> implements
86f210e9 28 <a href="systemd.generator.html"><span class="citerefentry"><span class="refentrytitle">systemd.generator</span>(7)</span></a>.</p></div><div class="refsect1"><a name="idm47693537927504"></a><h2 id="Kernel Command Line">Kernel Command Line<a class="headerlink" title="Permalink to this headline" href="#Kernel%20Command%20Line">¶</a></h2><p><code class="filename">systemd-cryptsetup-generator</code>
e735f4d4
MP
29 understands the following kernel command line parameters:</p><div class="variablelist"><dl class="variablelist"><dt id="luks="><span class="term"><code class="varname">luks=</code>, </span><span class="term"><code class="varname">rd.luks=</code></span><a class="headerlink" title="Permalink to this term" href="#luks=">¶</a></dt><dd><p>Takes a boolean argument. Defaults to
30 "<code class="literal">yes</code>". If "<code class="literal">no</code>", disables the
31 generator entirely. <code class="varname">rd.luks=</code> is honored
32 only by initial RAM disk (initrd) while
33 <code class="varname">luks=</code> is honored by both the main system
34 and the initrd. </p></dd><dt id="luks.crypttab="><span class="term"><code class="varname">luks.crypttab=</code>, </span><span class="term"><code class="varname">rd.luks.crypttab=</code></span><a class="headerlink" title="Permalink to this term" href="#luks.crypttab=">¶</a></dt><dd><p>Takes a boolean argument. Defaults to
35 "<code class="literal">yes</code>". If "<code class="literal">no</code>", causes the
36 generator to ignore any devices configured in
37 <code class="filename">/etc/crypttab</code>
38 (<code class="varname">luks.uuid=</code> will still work however).
39 <code class="varname">rd.luks.crypttab=</code> is honored only by
40 initial RAM disk (initrd) while
41 <code class="varname">luks.crypttab=</code> is honored by both the main
42 system and the initrd. </p></dd><dt id="luks.uuid="><span class="term"><code class="varname">luks.uuid=</code>, </span><span class="term"><code class="varname">rd.luks.uuid=</code></span><a class="headerlink" title="Permalink to this term" href="#luks.uuid=">¶</a></dt><dd><p>Takes a LUKS superblock UUID as argument. This
43 will activate the specified device as part of the boot process
44 as if it was listed in <code class="filename">/etc/crypttab</code>.
45 This option may be specified more than once in order to set up
46 multiple devices. <code class="varname">rd.luks.uuid=</code> is honored
47 only by initial RAM disk (initrd) while
48 <code class="varname">luks.uuid=</code> is honored by both the main
49 system and the initrd.</p><p>If /etc/crypttab contains entries with the same UUID,
50 then the name, keyfile and options specified there will be
51 used. Otherwise the device will have the name
52 "<code class="literal">luks-UUID</code>".</p><p>If /etc/crypttab exists, only those UUIDs
53 specified on the kernel command line
54 will be activated in the initrd or the real root.</p></dd><dt id="luks.name="><span class="term"><code class="varname">luks.name=</code>, </span><span class="term"><code class="varname">rd.luks.name=</code></span><a class="headerlink" title="Permalink to this term" href="#luks.name=">¶</a></dt><dd><p>Takes a LUKS super block UUID followed by an
55 "<code class="literal">=</code>" and a name. This implies
56 <code class="varname">rd.luks.uuid=</code> or
57 <code class="varname">luks.uuid=</code> and will additionally make the
58 LUKS device given by the UUID appear under the provided
59 name.</p><p><code class="varname">rd.luks.name=</code> is honored only by
60 initial RAM disk (initrd) while <code class="varname">luks.name=</code>
61 is honored by both the main system and the initrd.</p></dd><dt id="luks.options="><span class="term"><code class="varname">luks.options=</code>, </span><span class="term"><code class="varname">rd.luks.options=</code></span><a class="headerlink" title="Permalink to this term" href="#luks.options=">¶</a></dt><dd><p>Takes a LUKS super block UUID followed by an
62 "<code class="literal">=</code>" and a string of options separated by
63 commas as argument. This will override the options for the
64 given UUID.</p><p>If only a list of options, without an UUID, is
65 specified, they apply to any UUIDs not specified elsewhere,
66 and without an entry in
67 <code class="filename">/etc/crypttab</code>.</p><p>
68 <code class="varname">rd.luks.options=</code> is honored only by initial
69 RAM disk (initrd) while <code class="varname">luks.options=</code> is
70 honored by both the main system and the initrd.</p></dd><dt id="luks.key="><span class="term"><code class="varname">luks.key=</code>, </span><span class="term"><code class="varname">rd.luks.key=</code></span><a class="headerlink" title="Permalink to this term" href="#luks.key=">¶</a></dt><dd><p>Takes a password file name as argument or a
71 LUKS super block UUID followed by a "<code class="literal">=</code>" and a
72 password file name.</p><p>For those entries specified with
73 <code class="varname">rd.luks.uuid=</code> or
74 <code class="varname">luks.uuid=</code>, the password file will be set
75 to the one specified by <code class="varname">rd.luks.key=</code> or
76 <code class="varname">luks.key=</code> of the corresponding UUID, or the
77 password file that was specified without a UUID.</p><p><code class="varname">rd.luks.key=</code>
78 is honored only by initial RAM disk
79 (initrd) while
80 <code class="varname">luks.key=</code> is
81 honored by both the main system and
86f210e9 82 the initrd.</p></dd></dl></div></div><div class="refsect1"><a name="idm47693537894864"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p>
e735f4d4
MP
83 <a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>,
84 <a href="crypttab.html"><span class="citerefentry"><span class="refentrytitle">crypttab</span>(5)</span></a>,
85 <a href="systemd-cryptsetup@.service.html"><span class="citerefentry"><span class="refentrytitle">systemd-cryptsetup@.service</span>(8)</span></a>,
e3bff60a 86 <a href="http://linux.die.net/man/8/cryptsetup"><span class="citerefentry"><span class="refentrytitle">cryptsetup</span>(8)</span></a>,
e735f4d4
MP
87 <a href="systemd-fstab-generator.html"><span class="citerefentry"><span class="refentrytitle">systemd-fstab-generator</span>(8)</span></a>
88 </p></div></div></body></html>