summaryrefslogtreecommitdiff
path: root/src/systemd-tty-ask-password-agent/systemd-ask-password-console.service.xml
blob: 479e5f2e5b37be67106da2e0673a6a226ab2115d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<?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 wall</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 project='man-pages'><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>

    <para>Note that these services invoke
    <citerefentry><refentrytitle>systemd-tty-ask-password-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry>
    with either the <command>--watch --console</command> or
    <command>--watch --wall</command> command line parameters.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd-tty-ask-password-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>