]> git.proxmox.com Git - systemd.git/blame - man/systemd-cryptsetup-generator.html
Imported Upstream version 208
[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>·
21 <a href="../libudev/index.html">libudev </a>·
14228c0d 22 <a href="../libudev/index.html">gudev </a><span style="float:right">systemd 208</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="idm274700993088"></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>
663996b3
MS
23 is a generator that translates
24 <code class="filename">/etc/crypttab</code> into native systemd
25 units early at boot and when configuration of the
26 system manager is reloaded. This will create
27 <a href="systemd-cryptsetup@.service.html"><span class="citerefentry"><span class="refentrytitle">systemd-cryptsetup@.service</span>(8)</span></a>
28 units as necessary.</p><p><code class="filename">systemd-cryptsetup-generator</code>
29 implements the <a class="ulink" href="http://www.freedesktop.org/wiki/Software/systemd/Generators" target="_top">generator
14228c0d 30 specification</a>.</p></div><div class="refsect1"><a name="idm274703119120"></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> understands
663996b3
MS
31 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
32 argument. Defaults to
14228c0d
MB
33 "<code class="literal">yes</code>". If
34 "<code class="literal">no</code>", disables the
663996b3
MS
35 generator
36 entirely. <code class="varname">rd.luks=</code>
37 is honored only by initial RAM disk
38 (initrd) while
39 <code class="varname">luks=</code> is honored
40 by both the main system and the
41 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
42 argument. Defaults to
14228c0d
MB
43 "<code class="literal">yes</code>". If
44 "<code class="literal">no</code>", causes the
663996b3
MS
45 generator to ignore any devices
46 configured in
47 <code class="filename">/etc/crypttab</code>
48 (<code class="varname">luks.uuid=</code> will
49 still work
50 however). <code class="varname">rd.luks.crypttab=</code>
51 is honored only by initial RAM disk
52 (initrd) while
53 <code class="varname">luks.crypttab=</code> is
54 honored by both the main system and
55 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 super
56 block UUID as argument. This will
57 activate the specified device as part
58 of the boot process as if it was
59 listed in
60 <code class="filename">/etc/fstab</code>. This
61 option may be specified more than once
62 in order to set up multiple
63 devices. <code class="varname">rd.luks.uuid=</code>
64 is honored only by initial RAM disk
65 (initrd) while
66 <code class="varname">luks.uuid=</code> is
67 honored by both the main system and
68 the initrd.</p><p>If /etc/crypttab contains entries with
69 the same UUID, then the options for this entry
70 will be used.</p><p>If /etc/crypttab exists, only those UUID
71 specified on the kernel command line
14228c0d
MB
72 will be activated in the initrd or the real root.</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
73 block UUID followed by an '=' and a string
74 of options separated by commas as argument.
75 This will override the options for the given
76 UUID.</p><p>If only a list of options, without an
77 UUID, is specified, they apply to any UUIDs not
78 specified elsewhere, and without an entry in
79 /etc/crypttab.</p><p>
80 <code class="varname">rd.luks.options=</code>
81 is honored only by initial RAM disk
82 (initrd) while
83 <code class="varname">luks.options=</code> is
84 honored by both the main system and
85 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 as argument.</p><p>For those entries specified with
663996b3
MS
86 <code class="varname">rd.luks.uuid=</code> or <code class="varname">luks.uuid=</code>,
87 the password file will be set to the password file specified by
88 <code class="varname">rd.luks.key=</code> or <code class="varname">luks.key</code></p><p><code class="varname">rd.luks.key=</code>
89 is honored only by initial RAM disk
90 (initrd) while
91 <code class="varname">luks.key=</code> is
92 honored by both the main system and
14228c0d 93 the initrd.</p></dd></dl></div></div><div class="refsect1"><a name="idm274703381568"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p>
663996b3
MS
94 <a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>,
95 <a href="crypttab.html"><span class="citerefentry"><span class="refentrytitle">crypttab</span>(5)</span></a>,
96 <a href="systemd-cryptsetup@.service.html"><span class="citerefentry"><span class="refentrytitle">systemd-cryptsetup@.service</span>(8)</span></a>,
97 <a href="cryptsetup.html"><span class="citerefentry"><span class="refentrytitle">cryptsetup</span>(8)</span></a>,
98 <a href="systemd-fstab-generator.html"><span class="citerefentry"><span class="refentrytitle">systemd-fstab-generator</span>(8)</span></a>
99 </p></div></div></body></html>