man: document tty-ask-password-agent

1 files changed, 166 insertions, 0 deletions

diff --git a/man/systemd-tty-ask-password-agent.xml b/man/systemd-tty-ask-password-agent.xml
new file mode 100644
index 000000000..2ada6475f
--- /dev/null
+++ b/man/systemd-tty-ask-password-agent.xml
@@ -0,0 +1,166 @@
+<?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 2010 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-tty-ask-password-agent">
+
+        <refentryinfo>
+                <title>systemd-tty-ask-password-agent</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-tty-ask-password-agent</refentrytitle>
+                <manvolnum>1</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>systemd-tty-ask-password-agent</refname>
+                <refpurpose>List or process pending systemd password requests</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <cmdsynopsis>
+                        <command>systemd-tty-ask-password-agent <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg></command>
+                </cmdsynopsis>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para><command>systemd-tty-ask-password-agent</command>
+                is a password agent that handles password
+                requests of the system, for example for hard disk
+                encryption passwords or SSL certificate passwords that
+                need to be queried at boot-time or during
+                runtime.</para>
+
+                <para><command>systemd-tty-ask-password-agent</command>
+                implements the <ulink
+                url="http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">Password
+                Agents Specification</ulink>.</para>
+
+        </refsect1>
+
+        <refsect1>
+                <title>Options</title>
+
+                <para>The following options are understood:</para>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><option>--h</option></term>
+                                <term><option>--help</option></term>
+
+                                <listitem><para>Prints a short help
+                                text and exits.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--version</option></term>
+
+                                <listitem><para>Prints a short version
+                                string and exits.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--list</option></term>
+
+                                <listitem><para>Lists all currently pending system password requests.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--query</option></term>
+
+                                <listitem><para>Process all currently
+                                pending system password requests by
+                                querying the user on the calling
+                                TTY.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--watch</option></term>
+
+                                <listitem><para>Continuously process
+                                password requests.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--wall</option></term>
+
+                                <listitem><para>Forward password
+                                requests to
+                                <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                                instead of querying the user on the
+                                calling TTY.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--plymouth</option></term>
+
+                                <listitem><para>Ask question with
+                                <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                                instead of querying the user on the
+                                calling TTY.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--console</option></term>
+
+                                <listitem><para>Ask question on
+                                <filename>/dev/console</filename>
+                                instead of querying the user on the
+                                calling TTY.  </para></listitem>
+                        </varlistentry>
+
+                </variablelist>
+
+        </refsect1>
+
+        <refsect1>
+                <title>Exit status</title>
+
+                <para>On success 0 is returned, a non-zero failure
+                code otherwise.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                </para>
+        </refsect1>
+
+</refentry>