summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2012-06-27 14:51:47 +0200
committerLennart Poettering <lennart@poettering.net>2012-06-27 14:51:47 +0200
commit8e129f5156569e1bc858b002ca54cd447c38f4f1 (patch)
tree8d0c8ef3e9701949ec9aa23c9080ed907cdfaf96 /man
parenta7480dbad22cfb3d34c9bef5af562d3ff9e0227e (diff)
man: document systemd-cryptsetup-generator
Diffstat (limited to 'man')
-rw-r--r--man/crypttab.xml5
-rw-r--r--man/systemd-cryptsetup-generator.xml146
-rw-r--r--man/systemd-cryptsetup@.service.xml14
3 files changed, 162 insertions, 3 deletions
diff --git a/man/crypttab.xml b/man/crypttab.xml
index d61ec95e4c..f3bde71b4f 100644
--- a/man/crypttab.xml
+++ b/man/crypttab.xml
@@ -255,6 +255,10 @@
</varlistentry>
</variablelist>
+ <para>At early boot and when the system manager
+ configuration is reloaded this file is translated into
+ native systemd units
+ by <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
</refsect1>
<refsect1>
@@ -275,6 +279,7 @@ swap /dev/sda7 /dev/urandom swap</programlisting>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>mkswap</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>mke2fs</refentrytitle><manvolnum>8</manvolnum></citerefentry>
diff --git a/man/systemd-cryptsetup-generator.xml b/man/systemd-cryptsetup-generator.xml
new file mode 100644
index 0000000000..17e0ed9a64
--- /dev/null
+++ b/man/systemd-cryptsetup-generator.xml
@@ -0,0 +1,146 @@
+<?xml version="1.0"?>
+<!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!--
+ This file is part of systemd.
+
+ Copyright 2012 Lennart Poettering
+
+ systemd is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
+ (at your option) any later version.
+
+ systemd is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+<refentry id="systemd-cryptsetup-generator">
+
+ <refentryinfo>
+ <title>systemd-cryptsetup-generator</title>
+ <productname>systemd</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Lennart</firstname>
+ <surname>Poettering</surname>
+ <email>lennart@poettering.net</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>systemd-cryptsetup-generator</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>systemd-cryptsetup-generator</refname>
+ <refpurpose>Unit generated for <filename>/etc/crypttab</filename></refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <para><filename>/usr/lib/systemd/systemd-cryptsetup</filename></para>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para><filename>systemd-cryptsetup-generator</filename>
+ is a generator that translates
+ <filename>/etc/crypttab</filename> into native systemd
+ units early at boot and when configuration of the
+ system manager is reloaded. This will create
+ <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ units as necessary.</para>
+
+ <para><filename>systemd-cryptsetup-generator</filename>
+ implements the <ulink
+ url="http://www.freedesktop.org/wiki/Software/systemd/Generator">generator
+ specification</ulink>.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Kernel Command Line</title>
+
+ <para><filename>systemd-cryptsetup-generator</filename> understands
+ the following kernel command line parameters:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><varname>luks=</varname></term>
+ <term><varname>rd.luks=</varname></term>
+
+ <listitem><para>Takes a boolean
+ argument. Defaults to
+ <literal>yes</literal>. If
+ <literal>no</literal> disables the
+ generator
+ entirely. <varname>rd.luks=</varname>
+ is honoured only be initial RAM disk
+ (initrd) while
+ <varname>luks=</varname> is honoured
+ by both the main system and the
+ initrd. </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>luks.crypttab=</varname></term>
+ <term><varname>rd.luks.crypttab=</varname></term>
+
+ <listitem><para>Takes a boolean
+ argument. Defaults to
+ <literal>yes</literal>. If
+ <literal>no</literal> causes the
+ generator to ignore any devices
+ configured in
+ <filename>/etc/crypttab</filename>
+ (<varname>luks.uuid=</varname> will
+ still work
+ however). <varname>rd.luks.crypttab=</varname>
+ is honoured only be initial RAM disk
+ (initrd) while
+ <varname>luks.crypttab=</varname> is
+ honoured by both the main system and
+ the initrd. </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>luks.uuid=</varname></term>
+ <term><varname>rd.luks.uuid=</varname></term>
+
+ <listitem><para>Takes a LUKS super
+ block UUID as argument. This will
+ activate the specified device as part
+ of the boot process as if it was
+ listed in
+ <filename>/etc/fstab</filename>. This
+ option may be specified more than once
+ in order to set up multiple
+ devices. <varname>rd.luks.uuid=</varname>
+ is honoured only be initial RAM disk
+ (initrd) while
+ <varname>luks.uuid=</varname> is
+ honoured by both the main system and
+ the initrd.</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
diff --git a/man/systemd-cryptsetup@.service.xml b/man/systemd-cryptsetup@.service.xml
index 6e021d85da..abbb9d78f2 100644
--- a/man/systemd-cryptsetup@.service.xml
+++ b/man/systemd-cryptsetup@.service.xml
@@ -65,15 +65,23 @@
password agent logic</ulink>, in order to query the
user for the password using the right mechanism at
boot and during runtime.</para>
+
+ <para>At early boot and when the system manager
+ configuration is reloaded this
+ <filename>/etc/crypttab</filename> is translated into
+ <filename>systemd-cryptsetup@.service</filename> units
+ by
+ <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
- </para>
+ <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ </para>
</refsect1>
</refentry>