aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeremy Brubaker <jbru362@gmail.com>2022-06-03 13:43:52 -0400
committerJeremy Brubaker <jbru362@gmail.com>2022-06-03 13:43:52 -0400
commitd56946fce920c738a29ef854708bf9a6632f4ef9 (patch)
tree001c387fca5f3b523a2d013fed4f34cde7d491d9
parent0ae91ebe6e50d78f06b27eb6dfaf7648d97b9db4 (diff)
downloadanypinentry-d56946fce920c738a29ef854708bf9a6632f4ef9.tar.gz
anypinentry-d56946fce920c738a29ef854708bf9a6632f4ef9.zip
Update 'help' output
- Includes standard `pinentry` options - Provides basic documentation on custom `anypinentry` options
-rwxr-xr-xanypinentry38
1 files changed, 38 insertions, 0 deletions
diff --git a/anypinentry b/anypinentry
index beb8df0..d281873 100755
--- a/anypinentry
+++ b/anypinentry
@@ -111,6 +111,44 @@ interpret_command() {
help() {
echo "Usage: $0 [-D DISPLAY] [--prompt script] [--confirm script] [-hv]";
+
+cat <<END
+$0 (pinentry) $VERSION
+Copyright (C) 2020 Akshay Nair
+This software is released under the MIT License <https://www.mit-license.org/>
+
+END
+
+printf "Usage: %s [options] (-h for help)\n" "$0" >&2
+
+cat <<END
+Ask securely for a secret and print it to stdout.
+Options:
+ --prompt CMD How to ask for the secret
+ --confirm CMD How to confirm the secret
+ --error-command CMD What to do if secret is not confirmed
+
+CMD will be executed by bash(1). The defaults are:
+
+prompt ='dmenu -P -p "$prompt_string"';
+confirm ='echo -e "$AP_YES\n$AP_NO" | dmenu -p "$prompt_string"';
+error-command ='notify-send -a "Pinentry" "$error__password_mismatch"';
+
+Standard pinentry options
+ -d, --debug Turn on debugging output
+ -D, --display DISPLAY Set the X display
+ -T, --ttyname FILE Set the tty terminal node name
+ -N, --ttytype NAME Set the tty terminal type
+ -C, --lc-ctype STRING Set the tty LC_CTYPE value
+ -M, --lc-messages STRING Set the tty LC_MESSAGES value
+ -o, --timeout SECS Timeout waiting for input after this many seconds
+ -g, --no-global-grab Grab keyboard only while window is focused
+ -W, --parent-wid Parent window ID (for positioning)
+ -c, --colors STRING Set custom colors for ncurses
+ -a, --ttyalert STRING Set the alert mode (none, beep or flash)
+
+Please report bugs to <https://github.com/phenax/any-pinentry/issues>.
+END
}
parse_cliargs() {