From c52f663bfa4f420044e6cd25bf84cec3c26ebf6f Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Wed, 27 Jun 2012 02:12:39 +0200 Subject: man: document tty-ask-password-agent --- Makefile.am | 3 +- man/systemd-ask-password-console.service.xml | 6 + man/systemd-tty-ask-password-agent.xml | 166 +++++++++++++++++++++ .../tty-ask-password-agent.c | 12 +- 4 files changed, 185 insertions(+), 2 deletions(-) create mode 100644 man/systemd-tty-ask-password-agent.xml 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 for more information about the system password logic. + + Note that these services invoke + systemd-ask-password-agent1 + with the --watch --console + resp. --watch --wall command line + parameters. 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 @@ + + + + + + + + + systemd-tty-ask-password-agent + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd-tty-ask-password-agent + 1 + + + + systemd-tty-ask-password-agent + List or process pending systemd password requests + + + + + systemd-tty-ask-password-agent OPTIONS VARIABLE=VALUE + + + + + Description + + systemd-tty-ask-password-agent + 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. + + systemd-tty-ask-password-agent + implements the Password + Agents Specification. + + + + + Options + + The following options are understood: + + + + + + + Prints a short help + text and exits. + + + + + + Prints a short version + string and exits. + + + + + + Lists all currently pending system password requests. + + + + + + Process all currently + pending system password requests by + querying the user on the calling + TTY. + + + + + + Continuously process + password requests. + + + + + + Forward password + requests to + wall1 + instead of querying the user on the + calling TTY. + + + + + + Ask question with + plymouth8 + instead of querying the user on the + calling TTY. + + + + + + Ask question on + /dev/console + instead of querying the user on the + calling TTY. + + + + + + + + Exit status + + On success 0 is returned, a non-zero failure + code otherwise. + + + + See Also + + systemd1, + systemctl1, + systemd-ask-password-console.service8, + wall1, + plymouth8 + + + + 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; -- cgit v1.2.1