cmdr
Artifact Content
Not logged in

Artifact dc918011b26e79aa12921b2c5cdeab126bd2e74d:


'\"
'\" Generated from file 'cmdr_ask\&.man' by tcllib/doctools with format 'nroff'
'\" Copyright (c) 2013-2016 Andreas Kupries
'\" Copyright (c) 2013-2016 Documentation, Andreas Kupries
'\"
.TH "cmdr::ask" n 1 doc "Cmdr, a framework for command line parsing and dispatch"
.\" The -*- nroff -*- definitions below are for supplemental macros used
.\" in Tcl/Tk manual entries.
.\"
.\" .AP type name in/out ?indent?
.\"	Start paragraph describing an argument to a library procedure.
.\"	type is type of argument (int, etc.), in/out is either "in", "out",
.\"	or "in/out" to describe whether procedure reads or modifies arg,
.\"	and indent is equivalent to second arg of .IP (shouldn't ever be
.\"	needed;  use .AS below instead)
.\"
.\" .AS ?type? ?name?
.\"	Give maximum sizes of arguments for setting tab stops.  Type and
.\"	name are examples of largest possible arguments that will be passed
.\"	to .AP later.  If args are omitted, default tab stops are used.
.\"
.\" .BS
.\"	Start box enclosure.  From here until next .BE, everything will be
.\"	enclosed in one large box.
.\"
.\" .BE
.\"	End of box enclosure.
.\"
.\" .CS
.\"	Begin code excerpt.
.\"
.\" .CE
.\"	End code excerpt.
.\"
.\" .VS ?version? ?br?
.\"	Begin vertical sidebar, for use in marking newly-changed parts
.\"	of man pages.  The first argument is ignored and used for recording
.\"	the version when the .VS was added, so that the sidebars can be
.\"	found and removed when they reach a certain age.  If another argument
.\"	is present, then a line break is forced before starting the sidebar.
.\"
.\" .VE
.\"	End of vertical sidebar.
.\"
.\" .DS
.\"	Begin an indented unfilled display.
.\"
.\" .DE
.\"	End of indented unfilled display.
.\"
.\" .SO ?manpage?
.\"	Start of list of standard options for a Tk widget. The manpage
.\"	argument defines where to look up the standard options; if
.\"	omitted, defaults to "options". The options follow on successive
.\"	lines, in three columns separated by tabs.
.\"
.\" .SE
.\"	End of list of standard options for a Tk widget.
.\"
.\" .OP cmdName dbName dbClass
.\"	Start of description of a specific option.  cmdName gives the
.\"	option's name as specified in the class command, dbName gives
.\"	the option's name in the option database, and dbClass gives
.\"	the option's class in the option database.
.\"
.\" .UL arg1 arg2
.\"	Print arg1 underlined, then print arg2 normally.
.\"
.\" .QW arg1 ?arg2?
.\"	Print arg1 in quotes, then arg2 normally (for trailing punctuation).
.\"
.\" .PQ arg1 ?arg2?
.\"	Print an open parenthesis, arg1 in quotes, then arg2 normally
.\"	(for trailing punctuation) and then a closing parenthesis.
.\"
.\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
.\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1 \\fI\\$2\\fP (\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
.\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
.\"	# BS - start boxed text
.\"	# ^y = starting y location
.\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
.\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
.\"	# VS - start vertical sidebar
.\"	# ^Y = starting y location
.\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
.\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
.\"	# Special macro to handle page bottom:  finish off current
.\"	# box/sidebar if in box/sidebar mode, then invoked standard
.\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
.\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
.\"	# DE - end display
.de DE
.fi
.RE
.sp
..
.\"	# SO - start of list of standard options
.de SO
'ie '\\$1'' .ds So \\fBoptions\\fR
'el .ds So \\fB\\$1\\fR
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
.\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\*(So manual entry for details on the standard options.
..
.\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
.\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
.\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.\"	# UL - underline word
.de UL
\\$1\l'|0\(ul'\\$2
..
.\"	# QW - apply quotation marks to word
.de QW
.ie '\\*(lq'"' ``\\$1''\\$2
.\"" fix emacs highlighting
.el \\*(lq\\$1\\*(rq\\$2
..
.\"	# PQ - apply parens and quotation marks to word
.de PQ
.ie '\\*(lq'"' (``\\$1''\\$2)\\$3
.\"" fix emacs highlighting
.el (\\*(lq\\$1\\*(rq\\$2)\\$3
..
.\"	# QR - quoted range
.de QR
.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
.\"" fix emacs highlighting
.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
..
.\"	# MT - "empty" string
.de MT
.QW ""
..
.BS
.SH NAME
cmdr::ask \- Cmdr - Terminal-based simple user interactions
.SH SYNOPSIS
package require \fBcmdr::color \fR
.sp
package require \fBlinenoise \fR
.sp
package require \fBstruct::matrix \fR
.sp
package require \fBtextutil::adjust \fR
.sp
package require \fBtry \fR
.sp
package require \fBcmdr::ask \fR
.sp
\fB::cmdr::ask\fR \fBstring\fR \fIquery\fR ?\fIdefault\fR?
.sp
\fB::cmdr::ask\fR \fBstring/extended\fR \fIquery\fR ?options\&.\&.\&.?
.sp
\fB::cmdr::ask\fR \fBstring*\fR \fIquery\fR
.sp
\fB::cmdr::ask\fR \fByn\fR \fIquery\fR ?\fIdefault\fR?
.sp
\fB::cmdr::ask\fR \fBchoose\fR \fIquery\fR \fIchoices\fR ?\fIdefault\fR?
.sp
\fB::cmdr::ask\fR \fBmenu\fR \fIheader\fR \fIprompt\fR \fIchoices\fR ?\fIdefault\fR?
.sp
.BE
.SH DESCRIPTION
.PP
Welcome to the Cmdr project, written by Andreas Kupries\&.
.PP
For availability please read \fICmdr - How To Get The Sources\fR\&.
.PP
This package provides a few utility commands implementing a few simple
terminal-based interactions with the user\&.
.SH API
.TP
\fB::cmdr::ask\fR \fBstring\fR \fIquery\fR ?\fIdefault\fR?
When invoked this command prompts the user with \fIquery\fR for a string\&.
If the \fIdefault\fR is specified and not the empty string it is also
shown as part of the prompt\&. Note that \fIdefault\fR defaults to the
empty string\&.
.sp
The interactively entered string is returned as the result of the
command\&. The \fIdefault\fR is returned as the result if the user entered
an empty string and the \fIdefault\fR is not empty\&.
.RS
.TP
string \fIquery\fR
The prompt to show to the user before interaction begins\&.
.TP
string \fIdefault\fR
The default to return if the user enters nothing\&.
.RE
.TP
\fB::cmdr::ask\fR \fBstring/extended\fR \fIquery\fR ?options\&.\&.\&.?
This command is similar to \fB::cmdr::ask string\fR, except it allows for
more customization of the interaction through options\&.
.sp
The accepted options are
.RS
.TP
\fB-history\fR boolean
If \fBtrue\fR, save user input into \fBlinenoise\fR's in-memory history\&. Default is \fBfalse\fR\&.
.TP
\fB-hidden\fR boolean
If \fBtrue\fR, input is hidden\&. Default is \fBfalse\fR, visible echo\&.
.TP
\fB-complete\fR cmdprefix
If not empty, installed as completion callback\&.
.TP
\fB-default\fR string
If not empty the string to return if the user enters the empty string\&.
.RE
.RS
.TP
string \fIquery\fR
The prompt to show to the user before interaction begins\&.
.RE
.TP
\fB::cmdr::ask\fR \fBstring*\fR \fIquery\fR
Behaves like \fB::cmdr::ask string\fR without a default, except that the user's
input is not echoed back to the terminal\&. This command is for the entry of hidden
strings, i\&.e\&. passwords, and the like\&.
.RS
.TP
string \fIquery\fR
The prompt to show to the user before interaction begins\&.
.RE
.TP
\fB::cmdr::ask\fR \fByn\fR \fIquery\fR ?\fIdefault\fR?
When invoked this command prompts the user with \fIquery\fR for a \fIboolean\fR
value/string\&. If the \fIdefault\fR is specified and not the empty string it is
also shown as part of the prompt\&. Note that \fIdefault\fR defaults to the empty
string\&.
.sp
The interactively entered boolean is returned as the result of the command\&.
The \fIdefault\fR boolean is returned as the result if the user entered an empty
string and the \fIdefault\fR is not empty\&.
.sp
Note that the command will not return until the user entered a valid
boolean value\&. Entering a non-boolean string causes the command to loop internally
and re-prompt\&.
.RS
.TP
string \fIquery\fR
The prompt to show to the user before interaction begins\&.
.TP
string \fIdefault\fR
The default boolean to return if the user enters nothing\&.
.RE
.TP
\fB::cmdr::ask\fR \fBchoose\fR \fIquery\fR \fIchoices\fR ?\fIdefault\fR?
When invoked this command prompts the user with \fIquery\fR for one of the
\fIchoices\fR, entered as string\&. Prompt and input happen on a single line\&.
.sp
The interactively entered choice is returned as the result of the command\&.
The \fIdefault\fR choice is returned as the result if the user entered an empty
string and the \fIdefault\fR is not empty\&.
.sp
Note that the command will not return until the user entered a valid
choice\&. Entering a non-choice causes the command to loop internally and re-prompt\&.
The user is supported in entry by an internal completion callback\&.
.RS
.TP
string \fIquery\fR
The prompt to show to the user before interaction begins\&.
.TP
string \fIdefault\fR
The default boolean to return if the user enters nothing\&.
.RE
.TP
\fB::cmdr::ask\fR \fBmenu\fR \fIheader\fR \fIprompt\fR \fIchoices\fR ?\fIdefault\fR?
Similar to \fB::cmdr::ask choose\fR, except that the \fIchoices\fR are shown
as an enumerated menu, one per line, with a leading \fIheader\fR\&.
Furthermore the command accepts not only the choices as input, but also their
numeric indices in the menu\&. The result however is always the relevant chosen string\&.
.PP
.SH "BUGS, IDEAS, FEEDBACK"
Both the package(s) and this documentation will undoubtedly contain
bugs and other problems\&.
Please report such at
\fICmdr Tickets\fR [https:/core\&.tcl\&.tk/akupries/cmdr]\&.
.PP
Please also report any ideas you may have for enhancements of
either package(s) and/or documentation\&.
.SH KEYWORDS
arguments, command hierarchy, command line completion, command line handling, command tree, editing command line, help for command line, hierarchy of commands, interactive command shell, optional arguments, options, parameters, processing command line, tree of commands
.SH COPYRIGHT
.nf
Copyright (c) 2013-2016 Andreas Kupries
Copyright (c) 2013-2016 Documentation, Andreas Kupries

.fi