From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Sun, 23 May 2021 07:52:56 +0000 (+0200)
Subject: tty-ask-password-agent: mention optional argument in help
X-Git-Tag: v249-rc1~126^2~3
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=af88c399c0f666abd929b2c906c283731e746458;p=thirdparty%2Fsystemd.git

tty-ask-password-agent: mention optional argument in help

0cf84693877f060254f04cf38120f52c2aa3059c added --console.
6af621248f2255f9ce50b0bafdde475305dc4e57 added an optional argument, but didn't
update the help texts.

Note that there is no ambiguity with the optional argument because no positional
arguments are allowed.
---

diff --git a/man/systemd-tty-ask-password-agent.xml b/man/systemd-tty-ask-password-agent.xml
index 995657683b6..5c0011ec435 100644
--- a/man/systemd-tty-ask-password-agent.xml
+++ b/man/systemd-tty-ask-password-agent.xml
@@ -92,11 +92,11 @@
       </varlistentry>
 
       <varlistentry>
-        <term><option>--console</option></term>
+        <term><option>--console</option><optional>=<replaceable>DEVICE</replaceable></optional></term>
 
-        <listitem><para>Ask question on
-        <filename>/dev/console</filename> instead of querying the user
-        on the calling TTY. </para></listitem>
+        <listitem><para>Ask question on TTY <replaceable>DEVICE</replaceable> instead of querying the user on
+        the calling TTY. If <replaceable>DEVICE</replaceable> is not specified,
+        <filename>/dev/console</filename> will be used.</para></listitem>
       </varlistentry>
 
       <xi:include href="standard-options.xml" xpointer="help" />
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 e056853f312..e7d3a5dbc9d 100644
--- a/src/tty-ask-password-agent/tty-ask-password-agent.c
+++ b/src/tty-ask-password-agent/tty-ask-password-agent.c
@@ -412,14 +412,15 @@ 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"
-               "     --wall     Continuously forward password requests to wall\n"
-               "     --plymouth Ask question with Plymouth instead of on TTY\n"
-               "     --console  Ask question on /dev/console instead of current TTY\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"
+               "     --wall              Continuously forward password requests to wall\n"
+               "     --plymouth          Ask question with Plymouth instead of on TTY\n"
+               "     --console[=DEVICE]  Ask question on /dev/console (or DEVICE if specified)\n"
+               "                         instead of the current TTY\n"
                "\nSee the %s for details.\n",
                program_invocation_short_name,
                link);