mirror of
https://github.com/systemd/systemd.git
synced 2025-01-09 01:18:19 +03:00
man: document systemd-cryptsetup-generator
This commit is contained in:
Lennart Poettering
parent
a7480dbad2
commit
8e129f5156
@ -2611,6 +2611,7 @@ INSTALL_DATA_HOOKS += \
|
||||
|
||||
MANPAGES += \
|
||||
man/systemd-cryptsetup@.service.8 \
|
||||
man/systemd-cryptsetup-generator.8 \
|
||||
man/crypttab.5
|
||||
|
||||
MANPAGES_ALIAS += \
|
||||
|
||||
@ -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>
|
||||
|
||||
146
man/systemd-cryptsetup-generator.xml
Normal file
146
man/systemd-cryptsetup-generator.xml
Normal file
@ -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>
|
||||
@ -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>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user