systemd-tty-ask-password-agent.xml revision dfdebb1b925332352966804303b2516a6506a429
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering This file is part of systemd.
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering Copyright 2010 Lennart Poettering
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering systemd is free software; you can redistribute it and/or modify it
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering under the terms of the GNU Lesser General Public License as published by
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering the Free Software Foundation; either version 2.1 of the License, or
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering (at your option) any later version.
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering systemd is distributed in the hope that it will be useful, but
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering WITHOUT ANY WARRANTY; without even the implied warranty of
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering Lesser General Public License for more details.
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering You should have received a copy of the GNU Lesser General Public License
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering along with systemd; If not, see <http://www.gnu.org/licenses/>.
dfdebb1b925332352966804303b2516a6506a429Zbigniew Jędrzejewski-Szmek<refentry id="systemd-tty-ask-password-agent"
dfdebb1b925332352966804303b2516a6506a429Zbigniew Jędrzejewski-Szmek xmlns:xi="http://www.w3.org/2001/XInclude">
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <refentryinfo>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <title>systemd-tty-ask-password-agent</title>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering </authorgroup>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering </refentryinfo>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <refentrytitle>systemd-tty-ask-password-agent</refentrytitle>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <refname>systemd-tty-ask-password-agent</refname>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <refpurpose>List or process pending systemd password requests</refpurpose>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <refsynopsisdiv>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <command>systemd-tty-ask-password-agent <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg></command>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering </cmdsynopsis>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering </refsynopsisdiv>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <para><command>systemd-tty-ask-password-agent</command>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering is a password agent that handles password
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering requests of the system, for example for hard disk
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering encryption passwords or SSL certificate passwords that
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering need to be queried at boot-time or during
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering runtime.</para>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <para><command>systemd-tty-ask-password-agent</command>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering implements the <ulink
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering url="http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">Password
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <para>The following options are understood:</para>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <variablelist>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <varlistentry>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <listitem><para>Lists all currently pending system password requests.</para></listitem>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering </varlistentry>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <varlistentry>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering pending system password requests by
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering querying the user on the calling
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering </varlistentry>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <varlistentry>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering </varlistentry>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <varlistentry>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering instead of querying the user on the
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering </varlistentry>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <varlistentry>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering instead of querying the user on the
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering </varlistentry>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <varlistentry>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering instead of querying the user on the
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering </varlistentry>
dfdebb1b925332352966804303b2516a6506a429Zbigniew Jędrzejewski-Szmek <xi:include href="standard-options.xml" xpointer="help" />
dfdebb1b925332352966804303b2516a6506a429Zbigniew Jędrzejewski-Szmek <xi:include href="standard-options.xml" xpointer="version" />
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering </variablelist>
b040723ea412209e0edf54647fa5aa4287411507Jan Engelhardt <para>On success, 0 is returned, a non-zero failure
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering code otherwise.</para>
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
c52f663bfa4f420044e6cd25bf84cec3c26ebf6fLennart Poettering <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>