man: document systemd-ask-password-console.service and friends

2012-06-27 01:32:15 +02:00 · 2012-06-27 01:32:15 +02:00 · 7df46b2af5
parent 743b8558f6
commit 7df46b2af5
6 changed files with 104 additions and 6 deletions
--- a/Makefile.am
+++ b/Makefile.am
@ -494,7 +494,8 @@ MANPAGES = \
 	man/systemd-shutdownd.service.8 \
 	man/systemd-suspend.service.8 \
 	man/systemd-halt.service.8 \
-	man/systemd-fsck@.service.8
+	man/systemd-fsck@.service.8 \
+	man/systemd-ask-password-console.service.8

 MANPAGES_ALIAS = \
 	man/reboot.8 \
@ -517,7 +518,10 @@ MANPAGES_ALIAS = \
 	man/systemd-poweroff.service.8 \
 	man/systemd-reboot.service.8 \
 	man/systemd-kexec.service.8 \
-	man/systemd-fsck-root.service.8
+	man/systemd-fsck-root.service.8 \
+	man/systemd-ask-password-console.path.8 \
+	man/systemd-ask-password-wall.service.8 \
+	man/systemd-ask-password-wall.path.8

 man/reboot.8: man/halt.8
 man/poweroff.8: man/halt.8
@ -540,6 +544,9 @@ man/systemd-poweroff.service.8: man/systemd-halt.service.8
 man/systemd-reboot.service.8: man/systemd-halt.service.8
 man/systemd-kexec.service.8: man/systemd-halt.service.8
 man/systemd-fsck-root.service.8: man/systemd-fsck@.service.8
+man/systemd-ask-password-console.path.8: man/systemd-ask-password-console.service.8
+man/systemd-ask-password-wall.service.8: man/systemd-ask-password-console.service.8
+man/systemd-ask-password-wall.path.8: man/systemd-ask-password-console.service.8

 XML_FILES = \
 	${patsubst %.1,%.xml,${patsubst %.3,%.xml,${patsubst %.5,%.xml,${patsubst %.7,%.xml,${patsubst %.8,%.xml,$(MANPAGES)}}}}}
--- a/man/systemd-ask-password-console.service.xml
+++ b/man/systemd-ask-password-console.service.xml
@ -0,0 +1,91 @@
+<?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-ask-password-console.service">
+
+        <refentryinfo>
+                <title>systemd-ask-password-console.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-ask-password-console.service</refentrytitle>
+                <manvolnum>8</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>systemd-ask-password-console.service</refname>
+                <refname>systemd-ask-password-console.path</refname>
+                <refname>systemd-ask-password-wall.service</refname>
+                <refname>systemd-ask-password-wall.path</refname>
+                <refpurpose>Query the user for system passwords on the
+                console and via
+                <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry></refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <para><filename>systemd-ask-password-console.service</filename></para>
+                <para><filename>systemd-ask-password-console.path</filename></para>
+                <para><filename>systemd-ask-password-wall.service</filename></para>
+                <para><filename>systemd-ask-password-wall.path</filename></para>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para><filename>systemd-ask-password-console.service</filename>
+                is a system service that queries the user for system
+                passwords (such as hard disk encryption keys and SSL
+                certificate passphrases) on the console. It is
+                intended to be used during boot to ensure proper
+                handling of passwords necessary for
+                boot. <filename>systemd-ask-password-wall.service</filename>
+                is a system service that informs all logged in users
+                for system passwords via
+                <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>. It
+                is intended to be used after boot to ensure that users
+                are properly notified.</para>
+
+                <para>See the <ulink
+                url="http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">
+                developer documentation</ulink> for more information
+                about the system password logic.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-ask-password-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                </para>
+        </refsect1>
+
+</refentry>
--- a/units/systemd-ask-password-console.path
+++ b/units/systemd-ask-password-console.path
@ -7,7 +7,7 @@

 [Unit]
 Description=Dispatch Password Requests to Console Directory Watch
-Documentation=http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents
+Documentation=man:systemd-ask-password-console.service(8)
 DefaultDependencies=no
 Conflicts=shutdown.target
 After=plymouth-start.service
--- a/units/systemd-ask-password-console.service.in
+++ b/units/systemd-ask-password-console.service.in
@ -7,7 +7,7 @@

 [Unit]
 Description=Dispatch Password Requests to Console
-Documentation=http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents
+Documentation=man:systemd-ask-password-console.service(8)
 DefaultDependencies=no
 Conflicts=shutdown.target
 After=plymouth-start.service
--- a/units/systemd-ask-password-wall.path
+++ b/units/systemd-ask-password-wall.path
@ -7,7 +7,7 @@

 [Unit]
 Description=Forward Password Requests to Wall Directory Watch
-Documentation=http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents
+Documentation=man:systemd-ask-password-console.service(8)
 DefaultDependencies=no
 Conflicts=shutdown.target
 Before=basic.target shutdown.target
--- a/units/systemd-ask-password-wall.service.in
+++ b/units/systemd-ask-password-wall.service.in
@ -7,7 +7,7 @@

 [Unit]
 Description=Forward Password Requests to Wall
-Documentation=http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents
+Documentation=man:systemd-ask-password-console.service(8)
 After=systemd-user-sessions.service

 [Service]