diff options
-rw-r--r-- | Makefile.am | 3 | ||||
-rw-r--r-- | man/systemd-ask-password-console.service.xml | 6 | ||||
-rw-r--r-- | man/systemd-tty-ask-password-agent.xml | 166 | ||||
-rw-r--r-- | src/tty-ask-password-agent/tty-ask-password-agent.c | 12 |
4 files changed, 185 insertions, 2 deletions
diff --git a/Makefile.am b/Makefile.am index 84e372f93f..eb36efdae6 100644 --- a/Makefile.am +++ b/Makefile.am @@ -496,7 +496,8 @@ MANPAGES = \ man/systemd-halt.service.8 \ man/systemd-fsck@.service.8 \ man/systemd-ask-password-console.service.8 \ - man/systemd-analyze.1 + man/systemd-analyze.1 \ + man/systemd-tty-ask-password-agent.1 MANPAGES_ALIAS = \ man/reboot.8 \ diff --git a/man/systemd-ask-password-console.service.xml b/man/systemd-ask-password-console.service.xml index 5a9e240f5b..7017c0d1ae 100644 --- a/man/systemd-ask-password-console.service.xml +++ b/man/systemd-ask-password-console.service.xml @@ -77,6 +77,12 @@ 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-ask-password-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry> + with the <command>--watch --console</command> + resp. <command>--watch --wall</command> command line + parameters.</para> </refsect1> <refsect1> diff --git a/man/systemd-tty-ask-password-agent.xml b/man/systemd-tty-ask-password-agent.xml new file mode 100644 index 0000000000..2ada6475f9 --- /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> diff --git a/src/tty-ask-password-agent/tty-ask-password-agent.c b/src/tty-ask-password-agent/tty-ask-password-agent.c index 0dec0629c0..2e74a25972 100644 --- a/src/tty-ask-password-agent/tty-ask-password-agent.c +++ b/src/tty-ask-password-agent/tty-ask-password-agent.c @@ -40,6 +40,7 @@ #include "socket-util.h" #include "ask-password-api.h" #include "strv.h" +#include "build.h" static enum { ACTION_LIST, @@ -638,6 +639,7 @@ static int help(void) { printf("%s [OPTIONS...]\n\n" "Process system password requests.\n\n" " -h --help Show this help\n" + " --version Show package version\n" " --list Show pending password requests\n" " --query Process pending password requests\n" " --watch Continuously process password requests\n" @@ -657,11 +659,13 @@ static int parse_argv(int argc, char *argv[]) { ARG_WATCH, ARG_WALL, ARG_PLYMOUTH, - ARG_CONSOLE + ARG_CONSOLE, + ARG_VERSION }; static const struct option options[] = { { "help", no_argument, NULL, 'h' }, + { "version", no_argument, NULL, ARG_VERSION }, { "list", no_argument, NULL, ARG_LIST }, { "query", no_argument, NULL, ARG_QUERY }, { "watch", no_argument, NULL, ARG_WATCH }, @@ -684,6 +688,12 @@ static int parse_argv(int argc, char *argv[]) { help(); return 0; + case ARG_VERSION: + puts(PACKAGE_STRING); + puts(DISTRIBUTION); + puts(SYSTEMD_FEATURES); + return 0; + case ARG_LIST: arg_action = ACTION_LIST; break; |