systemd-cryptsetup-generator.xml revision 56ba3c78ae35065064c4289a0c8e22a81256af20
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering<!--*-nxml-*-->
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering This file is part of systemd.
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering Copyright 2012 Lennart Poettering
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering systemd is free software; you can redistribute it and/or modify it
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering under the terms of the GNU Lesser General Public License as published by
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering the Free Software Foundation; either version 2.1 of the License, or
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering (at your option) any later version.
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering systemd is distributed in the hope that it will be useful, but
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering WITHOUT ANY WARRANTY; without even the implied warranty of
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering Lesser General Public License for more details.
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering You should have received a copy of the GNU Lesser General Public License
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering along with systemd; If not, see <http://www.gnu.org/licenses/>.
56ba3c78ae35065064c4289a0c8e22a81256af20Zbigniew Jędrzejewski-Szmek<refentry id="systemd-cryptsetup-generator" conditional='HAVE_LIBCRYPTSETUP'>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <refentryinfo>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <title>systemd-cryptsetup-generator</title>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering </authorgroup>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering </refentryinfo>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <refentrytitle>systemd-cryptsetup-generator</refentrytitle>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <refname>systemd-cryptsetup-generator</refname>
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering <refpurpose>Unit generator for <filename>/etc/crypttab</filename></refpurpose>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <refsynopsisdiv>
f220d83cbc63678c765dd0b80983f17b1d5e615bLennart Poettering <para><filename>/usr/lib/systemd/system-generators/systemd-cryptsetup-generator</filename></para>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering </refsynopsisdiv>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <para><filename>systemd-cryptsetup-generator</filename>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering is a generator that translates
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <filename>/etc/crypttab</filename> into native systemd
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering units early at boot and when configuration of the
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering system manager is reloaded. This will create
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering units as necessary.</para>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <para><filename>systemd-cryptsetup-generator</filename>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering implements the <ulink
8fd1952fbec85a1b85a1e7e0ca5623f4933b137cDave Reisner url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <para><filename>systemd-cryptsetup-generator</filename> understands
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering the following kernel command line parameters:</para>
ccc9a4f9ffdab069b0b785627c48962fdadf6d46Zbigniew Jędrzejewski-Szmek <variablelist class='kernel-commandline-options'>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <varlistentry>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering argument. Defaults to
bb31a4ac1997c189a344caf554f34c6aabc71aa7Thomas Hindoe Paaboel Andersen is honored only by initial RAM disk
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering (initrd) while
bb31a4ac1997c189a344caf554f34c6aabc71aa7Thomas Hindoe Paaboel Andersen <varname>luks=</varname> is honored
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering by both the main system and the
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering </varlistentry>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <varlistentry>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <term><varname>luks.crypttab=</varname></term>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <term><varname>rd.luks.crypttab=</varname></term>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering argument. Defaults to
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering generator to ignore any devices
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering however). <varname>rd.luks.crypttab=</varname>
bb31a4ac1997c189a344caf554f34c6aabc71aa7Thomas Hindoe Paaboel Andersen is honored only by initial RAM disk
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering (initrd) while
bb31a4ac1997c189a344caf554f34c6aabc71aa7Thomas Hindoe Paaboel Andersen honored by both the main system and
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering </varlistentry>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <varlistentry>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <term><varname>luks.uuid=</varname></term>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <term><varname>rd.luks.uuid=</varname></term>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering block UUID as argument. This will
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering activate the specified device as part
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering of the boot process as if it was
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering option may be specified more than once
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering in order to set up multiple
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering devices. <varname>rd.luks.uuid=</varname>
bb31a4ac1997c189a344caf554f34c6aabc71aa7Thomas Hindoe Paaboel Andersen is honored only by initial RAM disk
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering (initrd) while
bb31a4ac1997c189a344caf554f34c6aabc71aa7Thomas Hindoe Paaboel Andersen honored by both the main system and
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering </varlistentry>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering </variablelist>
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
8e129f5156569e1bc858b002ca54cd447c38f4f1Lennart Poettering <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
059b37cc288ab529c6b5033af1f8118914f0329fLennart Poettering <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
059b37cc288ab529c6b5033af1f8118914f0329fLennart Poettering <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>