diff options
| -rw-r--r-- | Makefile.am | 9 | ||||
| -rw-r--r-- | man/systemd-cryptsetup@.service.xml | 79 | ||||
| -rw-r--r-- | man/systemd-fsck@.service.xml | 2 | ||||
| -rw-r--r-- | src/cryptsetup/cryptsetup-generator.c | 1 |
4 files changed, 90 insertions, 1 deletions
diff --git a/Makefile.am b/Makefile.am index eb36efdae6..3718fa871e 100644 --- a/Makefile.am +++ b/Makefile.am @@ -2608,6 +2608,15 @@ cryptsetup-install-data-hook: INSTALL_DATA_HOOKS += \ cryptsetup-install-data-hook + +MANPAGES += \ + man/systemd-cryptsetup@.service.8 + +MANPAGES_ALIAS += \ + man/systemd-cryptsetup.8 + +man/systemd-cryptsetup.8: man/systemd-cryptsetup@.service.8 + endif # ------------------------------------------------------------------------------ diff --git a/man/systemd-cryptsetup@.service.xml b/man/systemd-cryptsetup@.service.xml new file mode 100644 index 0000000000..6e021d85da --- /dev/null +++ b/man/systemd-cryptsetup@.service.xml @@ -0,0 +1,79 @@ +<?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@.service"> + + <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> + </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> + </refsect1> + +</refentry> diff --git a/man/systemd-fsck@.service.xml b/man/systemd-fsck@.service.xml index ad980a79a3..62f63110e1 100644 --- a/man/systemd-fsck@.service.xml +++ b/man/systemd-fsck@.service.xml @@ -60,7 +60,7 @@ service responsible for file system checks. It is instantiated for each device that requires a file system - check. <filename>systemd-fsck@.service</filename> is + check. <filename>systemd-fsck-root.service</filename> is responsible for file system checks on the root file system.</para> diff --git a/src/cryptsetup/cryptsetup-generator.c b/src/cryptsetup/cryptsetup-generator.c index b86521a712..4056d1ddd2 100644 --- a/src/cryptsetup/cryptsetup-generator.c +++ b/src/cryptsetup/cryptsetup-generator.c @@ -120,6 +120,7 @@ static int create_disk( "# Automatically generated by systemd-cryptsetup-generator\n\n" "[Unit]\n" "Description=Cryptography Setup for %%I\n" + "Documentation=man:systemd-cryptsetup@.service(8)\n" "SourcePath=/etc/crypttab\n" "Conflicts=umount.target\n" "DefaultDependencies=no\n" |