chiark / gitweb /
include <poll.h> instead of <sys/poll.h>
[elogind.git] / man / systemd-ask-password-console.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-ask-password-console.service">
23
24   <refentryinfo>
25     <title>systemd-ask-password-console.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-ask-password-console.service</refentrytitle>
40     <manvolnum>8</manvolnum>
41   </refmeta>
42
43   <refnamediv>
44     <refname>systemd-ask-password-console.service</refname>
45     <refname>systemd-ask-password-console.path</refname>
46     <refname>systemd-ask-password-wall.service</refname>
47     <refname>systemd-ask-password-wall.path</refname>
48     <refpurpose>Query the user for system passwords on the
49     console and via wall</refpurpose>
50   </refnamediv>
51
52   <refsynopsisdiv>
53     <para><filename>systemd-ask-password-console.service</filename></para>
54     <para><filename>systemd-ask-password-console.path</filename></para>
55     <para><filename>systemd-ask-password-wall.service</filename></para>
56     <para><filename>systemd-ask-password-wall.path</filename></para>
57   </refsynopsisdiv>
58
59   <refsect1>
60     <title>Description</title>
61
62     <para><filename>systemd-ask-password-console.service</filename> is
63     a system service that queries the user for system passwords (such
64     as hard disk encryption keys and SSL certificate passphrases) on
65     the console. It is intended to be used during boot to ensure
66     proper handling of passwords necessary for boot.
67     <filename>systemd-ask-password-wall.service</filename> is a system
68     service that informs all logged in users for system passwords via
69     <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
70     It is intended to be used after boot to ensure that users are
71     properly notified.</para>
72
73     <para>See the <ulink
74     url="http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">
75     developer documentation</ulink> for more information about the
76     system password logic.</para>
77
78     <para>Note that these services invoke
79     <citerefentry><refentrytitle>systemd-tty-ask-password-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry>
80     with either the <command>--watch --console</command> or
81     <command>--watch --wall</command> command line parameters.</para>
82   </refsect1>
83
84   <refsect1>
85     <title>See Also</title>
86     <para>
87       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
88       <citerefentry><refentrytitle>systemd-tty-ask-password-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
89       <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
90     </para>
91   </refsect1>
92
93 </refentry>