chiark / gitweb /
service: add FailureAction= option
[elogind.git] / man / systemd-cryptsetup@.service.xml
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 -->
22 <refentry id="systemd-cryptsetup@.service" conditional='HAVE_LIBCRYPTSETUP'>
23
24         <refentryinfo>
25                 <title>systemd-cryptsetup@.service</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@.service</refentrytitle>
40                 <manvolnum>8</manvolnum>
41         </refmeta>
42
43         <refnamediv>
44                 <refname>systemd-cryptsetup@.service</refname>
45                 <refname>systemd-cryptsetup</refname>
46                 <refpurpose>Full disk decryption logic</refpurpose>
47         </refnamediv>
48
49         <refsynopsisdiv>
50                 <para><filename>systemd-cryptsetup@.service</filename></para>
51                 <para><filename>/usr/lib/systemd/systemd-cryptsetup</filename></para>
52         </refsynopsisdiv>
53
54         <refsect1>
55                 <title>Description</title>
56
57                 <para><filename>systemd-cryptsetup@.service</filename>
58                 is a service responsible for setting up encrypted
59                 block devices. It is instantiated for each device that
60                 requires decryption for access.</para>
61
62                 <para><filename>systemd-cryptsetup@.service</filename>
63                 will ask for hard disk passwords via the <ulink
64                 url="http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">
65                 password agent logic</ulink>, in order to query the
66                 user for the password using the right mechanism at
67                 boot and during runtime.</para>
68
69                 <para>At early boot and when the system manager
70                 configuration is reloaded this
71                 <filename>/etc/crypttab</filename> is translated into
72                 <filename>systemd-cryptsetup@.service</filename> units
73                 by
74                 <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
75         </refsect1>
76
77         <refsect1>
78                 <title>See Also</title>
79                 <para>
80                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
81                         <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
82                         <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
83                         <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
84                  </para>
85         </refsect1>
86
87 </refentry>