systemd/man/systemd-tty-ask-password-agent.xml

	systemd-tty-ask-password-agent.xml revision c52f663bfa4f420044e6cd25bf84cec3c26ebf6f
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering<?xml version='1.0'?> <!--*-nxml-*-->
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering<!--
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering  This file is part of systemd.
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering  Copyright 2010 Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering  systemd is free software; you can redistribute it and/or modify it
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering  under the terms of the GNU Lesser General Public License as published by
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering  the Free Software Foundation; either version 2.1 of the License, or
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering  (at your option) any later version.
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering  systemd is distributed in the hope that it will be useful, but
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering  WITHOUT ANY WARRANTY; without even the implied warranty of
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering  Lesser General Public License for more details.
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering  You should have received a copy of the GNU Lesser General Public License
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering  along with systemd; If not, see <http://www.gnu.org/licenses/>.
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering-->
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering<refentry id="systemd-tty-ask-password-agent">
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering        <refentryinfo>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <title>systemd-tty-ask-password-agent</title>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <productname>systemd</productname>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <authorgroup>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        <author>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <contrib>Developer</contrib>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <firstname>Lennart</firstname>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <surname>Poettering</surname>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <email>lennart@poettering.net</email>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        </author>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                </authorgroup>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering        </refentryinfo>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering        <refmeta>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <refentrytitle>systemd-tty-ask-password-agent</refentrytitle>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <manvolnum>1</manvolnum>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering        </refmeta>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering        <refnamediv>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <refname>systemd-tty-ask-password-agent</refname>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <refpurpose>List or process pending systemd password requests</refpurpose>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering        </refnamediv>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering        <refsynopsisdiv>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <cmdsynopsis>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        <command>systemd-tty-ask-password-agent <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg></command>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                </cmdsynopsis>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering        </refsynopsisdiv>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering        <refsect1>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <title>Description</title>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <para><command>systemd-tty-ask-password-agent</command>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                is a password agent that handles password
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                requests of the system, for example for hard disk
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                encryption passwords or SSL certificate passwords that
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                need to be queried at boot-time or during
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                runtime.</para>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <para><command>systemd-tty-ask-password-agent</command>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                implements the <ulink
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                url="http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">Password
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                Agents Specification</ulink>.</para>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering        </refsect1>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering        <refsect1>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <title>Options</title>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <para>The following options are understood:</para>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <variablelist>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        <varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <term><option>--h</option></term>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <term><option>--help</option></term>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <listitem><para>Prints a short help
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                text and exits.</para></listitem>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        </varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        <varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <term><option>--version</option></term>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <listitem><para>Prints a short version
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                string and exits.</para></listitem>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        </varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        <varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <term><option>--list</option></term>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <listitem><para>Lists all currently pending system password requests.</para></listitem>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        </varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        <varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <term><option>--query</option></term>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <listitem><para>Process all currently
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                pending system password requests by
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                querying the user on the calling
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                TTY.</para></listitem>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        </varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        <varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <term><option>--watch</option></term>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <listitem><para>Continuously process
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                password requests.</para></listitem>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        </varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        <varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <term><option>--wall</option></term>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <listitem><para>Forward password
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                requests to
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                instead of querying the user on the
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                calling TTY.</para></listitem>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        </varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        <varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <term><option>--plymouth</option></term>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <listitem><para>Ask question with
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                instead of querying the user on the
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                calling TTY.</para></listitem>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        </varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        <varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <term><option>--console</option></term>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <listitem><para>Ask question on
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                <filename>/dev/console</filename>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                instead of querying the user on the
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                                calling TTY.  </para></listitem>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                        </varlistentry>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                </variablelist>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering        </refsect1>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering        <refsect1>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <title>Exit status</title>
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering
3bb55eee6aecdab6bfdbb670299fa59801145cb6Lennart Poettering                <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>