]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/systemd-cryptsetup@.service.xml
man: suggest SYSTEMD_WANTS usage instead of RUN for long running processes
[thirdparty/systemd.git] / man / systemd-cryptsetup@.service.xml
index 6fa2e0cdd031b610b7df13d008b74f5c171bdb65..0324a6744097f77fe6d4e047019481368d69012b 100644 (file)
@@ -1,87 +1,59 @@
 <?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/>.
--->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
 <refentry id="systemd-cryptsetup@.service" conditional='HAVE_LIBCRYPTSETUP'>
 
-        <refentryinfo>
-                <title>systemd-cryptsetup@.service</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@.service</refentrytitle>
-                <manvolnum>8</manvolnum>
-        </refmeta>
-
-        <refnamediv>
-                <refname>systemd-cryptsetup@.service</refname>
-                <refname>systemd-cryptsetup</refname>
-                <refpurpose>Full disk decryption logic</refpurpose>
-        </refnamediv>
-
-        <refsynopsisdiv>
-                <para><filename>systemd-cryptsetup@.service</filename></para>
-                <para><filename>/usr/lib/systemd/systemd-cryptsetup</filename></para>
-        </refsynopsisdiv>
-
-        <refsect1>
-                <title>Description</title>
-
-                <para><filename>systemd-cryptsetup@.service</filename>
-                is a service responsible for setting up encrypted
-                block devices. It is instantiated for each device that
-                requires decryption for access.</para>
-
-                <para><filename>systemd-cryptsetup@.service</filename>
-                will ask for hard disk passwords via the <ulink
-                url="http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">
-                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>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>
+  <refentryinfo>
+    <title>systemd-cryptsetup@.service</title>
+    <productname>systemd</productname>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>systemd-cryptsetup@.service</refentrytitle>
+    <manvolnum>8</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>systemd-cryptsetup@.service</refname>
+    <refname>systemd-cryptsetup</refname>
+    <refpurpose>Full disk decryption logic</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <para><filename>systemd-cryptsetup@.service</filename></para>
+    <para><filename>/usr/lib/systemd/systemd-cryptsetup</filename></para>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para><filename>systemd-cryptsetup@.service</filename> is a
+    service responsible for setting up encrypted block devices. It is
+    instantiated for each device that requires decryption for
+    access.</para>
+
+    <para><filename>systemd-cryptsetup@.service</filename> will ask
+    for hard disk passwords via the <ulink
+    url="https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">
+    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, <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>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+      <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+     </para>
+  </refsect1>
 
 </refentry>