systemd/man/systemd-cryptsetup-generator.html
2015-02-17 11:22:16 +01:00

90 lines
8.5 KiB
HTML

<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>
a.headerlink {
color: #c60f0f;
font-size: 0.8em;
padding: 0 4px 0 4px;
text-decoration: none;
visibility: hidden;
}
a.headerlink:hover {
background-color: #c60f0f;
color: white;
}
h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, dt:hover > a.headerlink {
visibility: visible;
}
</style><a href="index.html">Index </a>·
<a href="systemd.directives.html">Directives </a>·
<a href="../python-systemd/index.html">Python </a>·
<a href="../libudev/index.html">libudev </a>·
<a href="../libudev/index.html">gudev </a><span style="float:right">systemd 219</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="idm140379210259168"></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
generator that translates <code class="filename">/etc/crypttab</code> into
native systemd units early at boot and when configuration of the
system manager is reloaded. This will create
<a href="systemd-cryptsetup@.service.html"><span class="citerefentry"><span class="refentrytitle">systemd-cryptsetup@.service</span>(8)</span></a>
units as necessary.</p><p><code class="filename">systemd-cryptsetup-generator</code>
implements the <a class="ulink" href="http://www.freedesktop.org/wiki/Software/systemd/Generators" target="_top">generator
specification</a>.</p></div><div class="refsect1"><a name="idm140379210254000"></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 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
"<code class="literal">yes</code>". If "<code class="literal">no</code>", disables the
generator entirely. <code class="varname">rd.luks=</code> is honored
only by initial RAM disk (initrd) while
<code class="varname">luks=</code> is honored by both the main system
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
"<code class="literal">yes</code>". If "<code class="literal">no</code>", causes the
generator to ignore any devices configured in
<code class="filename">/etc/crypttab</code>
(<code class="varname">luks.uuid=</code> will still work however).
<code class="varname">rd.luks.crypttab=</code> is honored only by
initial RAM disk (initrd) while
<code class="varname">luks.crypttab=</code> is honored by both the main
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
will activate the specified device as part of the boot process
as if it was listed in <code class="filename">/etc/crypttab</code>.
This option may be specified more than once in order to set up
multiple devices. <code class="varname">rd.luks.uuid=</code> is honored
only by initial RAM disk (initrd) while
<code class="varname">luks.uuid=</code> is honored by both the main
system and the initrd.</p><p>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
"<code class="literal">luks-UUID</code>".</p><p>If /etc/crypttab exists, only those UUIDs
specified on the kernel command line
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
"<code class="literal">=</code>" and a name. This implies
<code class="varname">rd.luks.uuid=</code> or
<code class="varname">luks.uuid=</code> and will additionally make the
LUKS device given by the UUID appear under the provided
name.</p><p><code class="varname">rd.luks.name=</code> is honored only by
initial RAM disk (initrd) while <code class="varname">luks.name=</code>
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
"<code class="literal">=</code>" and a string of options separated by
commas as argument. This will override the options for the
given UUID.</p><p>If only a list of options, without an UUID, is
specified, they apply to any UUIDs not specified elsewhere,
and without an entry in
<code class="filename">/etc/crypttab</code>.</p><p>
<code class="varname">rd.luks.options=</code> is honored only by initial
RAM disk (initrd) while <code class="varname">luks.options=</code> is
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
LUKS super block UUID followed by a "<code class="literal">=</code>" and a
password file name.</p><p>For those entries specified with
<code class="varname">rd.luks.uuid=</code> or
<code class="varname">luks.uuid=</code>, the password file will be set
to the one specified by <code class="varname">rd.luks.key=</code> or
<code class="varname">luks.key=</code> of the corresponding UUID, or the
password file that was specified without a UUID.</p><p><code class="varname">rd.luks.key=</code>
is honored only by initial RAM disk
(initrd) while
<code class="varname">luks.key=</code> is
honored by both the main system and
the initrd.</p></dd></dl></div></div><div class="refsect1"><a name="idm140379214166384"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also"></a></h2><p>
<a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>,
<a href="crypttab.html"><span class="citerefentry"><span class="refentrytitle">crypttab</span>(5)</span></a>,
<a href="systemd-cryptsetup@.service.html"><span class="citerefentry"><span class="refentrytitle">systemd-cryptsetup@.service</span>(8)</span></a>,
<a href="cryptsetup.html"><span class="citerefentry"><span class="refentrytitle">cryptsetup</span>(8)</span></a>,
<a href="systemd-fstab-generator.html"><span class="citerefentry"><span class="refentrytitle">systemd-fstab-generator</span>(8)</span></a>
</p></div></div></body></html>