man: xinclude the generic text to talk about libsystemd pkgconfig

[thirdparty/systemd.git] / man / systemd-cryptsetup@.service.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">
<!--
  SPDX-License-Identifier: LGPL-2.1+

  This file is part of systemd.

  Copyright 2012 Lennart Poettering
-->
<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="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>