diff options
Diffstat (limited to 'ask.1')
| -rw-r--r-- | ask.1 | 34 |
1 files changed, 25 insertions, 9 deletions
@@ -5,16 +5,23 @@ ask \- A tiny command line tool for getting user input .SH SYNOPSIS .B ask -[\fI-hPqvyn\fR] -[\fI-q\fR |\fI--query=initial\fR] -[[\fI-p\fR |\fI--prompt=\fR]\fIprompt \fR -[\fIoptions...\fR]] +[\fI-Q\fR|\fI--quickpick\fR] +[\fI-P\fR|\fI--password\fR] +[\fI-0\fR|\fI--read0\fR] +[\fI-y\fR|\fI--yes\fR] +[\fI-n\fR|\fI--no\fR] +[(\fI-H \fR|\fI--history=\fR) name] +[\fI-h\fR|\fI--help\fR] +[\fI-v\fR|\fI--version\fR] +[(\fI-q\fR |\fI--query=\fR) initial] +[(\fI-p\fR |\fI--prompt=\fR) prompt] +[\fIoptions...\fR] .SH DESCRIPTION \fBask\fR is a tiny console application that displays a prompt, gets user input (with line editing and fuzzy finding functionality), and prints the result to standard output .SH OPTIONS -.B \-q +.B \-Q .B \--quickpick When used with fuzzy finding, as soon as exactly one match is found, exit and print it. @@ -23,6 +30,10 @@ print it. .B \--password Use password mode, which does not print user input as it's being typed. +.B \-0 +.B \--read0 +Read input delineated by NULL bytes instead of newlines. + .B \-v .B \--version Print \fBask\fR's version and exit. @@ -31,16 +42,21 @@ Print \fBask\fR's version and exit. .B \--help Print \fBask\fR's usage and exit. -.B \-q -.B \--query= +.B \-q <query> +.B \--query=<query> If given, pre-populate the user input with this value. -.B \-p -.B \--prompt= +.B \-p <prompt> +.B \--prompt=<prompt> If provided, display the given prompt in bold. If the \fI-p\fR and \fI--prompt=\fR flags are not used, the first positional argument is used as the prompt, or \fB"> "\fR if there are no positional arguments. +.B \-H <file> +.B \--history=<file> +Use the given file as a history file. With a history file, you can browse +previously selected values with the up/down arrow keys. + .B \-y .B \--yes Quickpick between "y" and "n" with "[Y/n]" appended to the prompt, exiting with |