[thirdparty/systemd.git] / man / systemd-cryptsetup-generator.xml

<?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" conditional='HAVE_LIBCRYPTSETUP'>

        <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 generator for <filename>/etc/crypttab</filename></refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <para><filename>/usr/lib/systemd/system-generators/systemd-cryptsetup-generator</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/Generators">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 class='kernel-commandline-options'>
                        <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 honored only by initial RAM disk
                                (initrd) while
                                <varname>luks=</varname> is honored
                                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 honored only by initial RAM disk
                                (initrd) while
                                <varname>luks.crypttab=</varname> is
                                honored 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 superblock
                                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 honored only by initial RAM disk
                                (initrd) while
                                <varname>luks.uuid=</varname> is
                                honored by both the main system and
                                the initrd.</para>
                                <para>If /etc/crypttab contains entries with
                                the same UUID, then the options for this entry
                                will be used.</para>
                                <para>If /etc/crypttab exists, only those UUID
                                specified on the kernel command line
                                will be activated in the initrd or the real root.</para>
                                </listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>luks.options=</varname></term>
                                <term><varname>rd.luks.options=</varname></term>

                                <listitem><para>Takes a LUKS super
                                block UUID followed by an '=' and a string
                                of options separated by commas as argument.
                                This will override the options for the given
                                UUID.</para>
                                <para>If only a list of options, without an
                                UUID, is specified, they apply to any UUIDs not
                                specified elsewhere, and without an entry in
                                /etc/crypttab.</para><para>
                                <varname>rd.luks.options=</varname>
                                is honored only by initial RAM disk
                                (initrd) while
                                <varname>luks.options=</varname> is
                                honored by both the main system and
                                the initrd.</para>
                                </listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>luks.key=</varname></term>
                                <term><varname>rd.luks.key=</varname></term>

                                <listitem><para>Takes a password file as argument.</para>
                                <para>For those entries specified with
                                <varname>rd.luks.uuid=</varname> or <varname>luks.uuid=</varname>,
                                the password file will be set to the password file specified by
                                <varname>rd.luks.key=</varname> or <varname>luks.key</varname></para>
                                <para><varname>rd.luks.key=</varname>
                                is honored only by initial RAM disk
                                (initrd) while
                                <varname>luks.key=</varname> is
                                honored 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>,
                        <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>
Commit	Line	Data
8e129f51 LP	1	<?xml version="1.0"?>
	2	<!---nxml--->
	3	<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
	4	<!--
	5	This file is part of systemd.
	6
	7	Copyright 2012 Lennart Poettering
	8
	9	systemd is free software; you can redistribute it and/or modify it
	10	under the terms of the GNU Lesser General Public License as published by
	11	the Free Software Foundation; either version 2.1 of the License, or
	12	(at your option) any later version.
	13
	14	systemd is distributed in the hope that it will be useful, but
	15	WITHOUT ANY WARRANTY; without even the implied warranty of
	16	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	Lesser General Public License for more details.
	18
	19	You should have received a copy of the GNU Lesser General Public License
	20	along with systemd; If not, see <http://www.gnu.org/licenses/>.
	21	-->
56ba3c78	22	<refentry id="systemd-cryptsetup-generator" conditional='HAVE_LIBCRYPTSETUP'>
8e129f51 LP	23
	24	<refentryinfo>
	25	<title>systemd-cryptsetup-generator</title>
	26	<productname>systemd</productname>
	27
	28	<authorgroup>
	29	<author>
	30	<contrib>Developer</contrib>
	31	<firstname>Lennart</firstname>
	32	<surname>Poettering</surname>
	33	<email>lennart@poettering.net</email>
	34	</author>
	35	</authorgroup>
	36	</refentryinfo>
	37
	38	<refmeta>
	39	<refentrytitle>systemd-cryptsetup-generator</refentrytitle>
	40	<manvolnum>8</manvolnum>
	41	</refmeta>
	42
	43	<refnamediv>
	44	<refname>systemd-cryptsetup-generator</refname>
f220d83c	45	<refpurpose>Unit generator for <filename>/etc/crypttab</filename></refpurpose>
8e129f51 LP	46	</refnamediv>
	47
	48	<refsynopsisdiv>
f220d83c	49	<para><filename>/usr/lib/systemd/system-generators/systemd-cryptsetup-generator</filename></para>
8e129f51 LP	50	</refsynopsisdiv>
	51
	52	<refsect1>
	53	<title>Description</title>
	54
	55	<para><filename>systemd-cryptsetup-generator</filename>
	56	is a generator that translates
	57	<filename>/etc/crypttab</filename> into native systemd
	58	units early at boot and when configuration of the
	59	system manager is reloaded. This will create
	60	<citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
	61	units as necessary.</para>
	62
	63	<para><filename>systemd-cryptsetup-generator</filename>
	64	implements the <ulink
8fd1952f	65	url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator
8e129f51 LP	66	specification</ulink>.</para>
	67	</refsect1>
	68
	69	<refsect1>
	70	<title>Kernel Command Line</title>
	71
	72	<para><filename>systemd-cryptsetup-generator</filename> understands
	73	the following kernel command line parameters:</para>
	74
ccc9a4f9	75	<variablelist class='kernel-commandline-options'>
8e129f51 LP	76	<varlistentry>
	77	<term><varname>luks=</varname></term>
	78	<term><varname>rd.luks=</varname></term>
	79
	80	<listitem><para>Takes a boolean
	81	argument. Defaults to
	82	<literal>yes</literal>. If
79640424	83	<literal>no</literal>, disables the
8e129f51 LP	84	generator
8e129f51 LP	85	entirely. <varname>rd.luks=</varname>
bb31a4ac	86	is honored only by initial RAM disk
8e129f51	87	(initrd) while
bb31a4ac	88	<varname>luks=</varname> is honored
8e129f51 LP	89	by both the main system and the
	90	initrd. </para></listitem>
	91	</varlistentry>
	92
	93	<varlistentry>
	94	<term><varname>luks.crypttab=</varname></term>
	95	<term><varname>rd.luks.crypttab=</varname></term>
	96
	97	<listitem><para>Takes a boolean
	98	argument. Defaults to
	99	<literal>yes</literal>. If
79640424	100	<literal>no</literal>, causes the
8e129f51 LP	101	generator to ignore any devices
	102	configured in
	103	<filename>/etc/crypttab</filename>
	104	(<varname>luks.uuid=</varname> will
	105	still work
	106	however). <varname>rd.luks.crypttab=</varname>
bb31a4ac	107	is honored only by initial RAM disk
8e129f51 LP	108	(initrd) while
8e129f51 LP	109	<varname>luks.crypttab=</varname> is
bb31a4ac	110	honored by both the main system and
8e129f51 LP	111	the initrd. </para></listitem>
	112	</varlistentry>
	113
	114	<varlistentry>
	115	<term><varname>luks.uuid=</varname></term>
	116	<term><varname>rd.luks.uuid=</varname></term>
	117
72f4d966 JE	118	<listitem><para>Takes a LUKS superblock
72f4d966 JE	119	UUID as argument. This will
8e129f51 LP	120	activate the specified device as part
	121	of the boot process as if it was
	122	listed in
	123	<filename>/etc/fstab</filename>. This
	124	option may be specified more than once
	125	in order to set up multiple
	126	devices. <varname>rd.luks.uuid=</varname>
bb31a4ac	127	is honored only by initial RAM disk
8e129f51 LP	128	(initrd) while
8e129f51 LP	129	<varname>luks.uuid=</varname> is
bb31a4ac	130	honored by both the main system and
951657bd HH	131	the initrd.</para>
	132	<para>If /etc/crypttab contains entries with
	133	the same UUID, then the options for this entry
	134	will be used.</para>
	135	<para>If /etc/crypttab exists, only those UUID
	136	specified on the kernel command line
	137	will be activated in the initrd or the real root.</para>
	138	</listitem>
	139	</varlistentry>
7ab064a6 TG	140
	141	<varlistentry>
	142	<term><varname>luks.options=</varname></term>
	143	<term><varname>rd.luks.options=</varname></term>
	144
	145	<listitem><para>Takes a LUKS super
	146	block UUID followed by an '=' and a string
	147	of options separated by commas as argument.
	148	This will override the options for the given
	149	UUID.</para>
	150	<para>If only a list of options, without an
	151	UUID, is specified, they apply to any UUIDs not
	152	specified elsewhere, and without an entry in
	153	/etc/crypttab.</para><para>
	154	<varname>rd.luks.options=</varname>
	155	is honored only by initial RAM disk
	156	(initrd) while
	157	<varname>luks.options=</varname> is
	158	honored by both the main system and
	159	the initrd.</para>
	160	</listitem>
	161	</varlistentry>
	162
951657bd HH	163	<varlistentry>
	164	<term><varname>luks.key=</varname></term>
	165	<term><varname>rd.luks.key=</varname></term>
	166
	167	<listitem><para>Takes a password file as argument.</para>
	168	<para>For those entries specified with
	169	<varname>rd.luks.uuid=</varname> or <varname>luks.uuid=</varname>,
	170	the password file will be set to the password file specified by
	171	<varname>rd.luks.key=</varname> or <varname>luks.key</varname></para>
	172	<para><varname>rd.luks.key=</varname>
	173	is honored only by initial RAM disk
	174	(initrd) while
	175	<varname>luks.key=</varname> is
	176	honored by both the main system and
	177	the initrd.</para>
	178	</listitem>
8e129f51 LP	179	</varlistentry>
	180	</variablelist>
	181	</refsect1>
	182
	183	<refsect1>
	184	<title>See Also</title>
	185	<para>
	186	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
	187	<citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	188	<citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
059b37cc LP	189	<citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
059b37cc LP	190	<citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
8e129f51 LP	191	</para>
	192	</refsect1>
	193
	194	</refentry>