Lines Matching +full:left +full:- +full:input +full:- +full:single +full:- +full:end
3 .\" Copyright 2005-2020,2021 Thomas E. Dickey
53 dialog \- display dialog boxes from shell scripts
55 \fB\*p \-\-clear\fP
57 .BI "\*p \-\-create\-rc " file
59 \fB\*p \-\-print\-maxsize\fP
62 \fIcommon-options\fP
63 \fIbox-options\fP
108 Use the "\fB\-\-and\-widget\fP" token to force \fB\*p\fP to proceed to the next
118 \*(``\fB\-\-output\-fd\fP\*('',
119 \*(``\fB\-\-stderr\fP\*('' and
120 \*(``\fB\-\-stdout\fP\*(''.
126 All options begin with \*(``\fB--\fP\*(''
130 A \*(``\fB--\fP\*('' by itself is used as an escape,
131 i.e., the next token on the command-line is not treated as an option.
133 .B \*p --title -- --Not an option
136 When a common (e.g., non-widget) option is repeated,
140 after the leading \*(``\fB--\fP\*(''.
141 For instance, \fB\-\-no-shadow\fP is documented here,
142 but \fB\-\-shadow\fP also is accepted.
144 The \*(``\fB\-\-args\fP\*('' option tells \fB\*p\fP to list the command-line
147 the \*(``\fB--\fP\*('' and \*(``\fB\-\-file\fP\*('',
148 since the command-line may be rewritten as these are expanded.
150 The \*(``\fB\-\-file\fP\*('' option tells \fB\*p\fP to read parameters from
153 .B \*p --file \fIparameterfile
156 Blanks not within double-quotes are discarded
157 (use backslashes to quote single characters).
158 The result is inserted into the command-line,
159 replacing \*(``\fB\-\-file\fP\*('' and its option value.
160 Interpretation of the command-line resumes from that point.
167 multi-line message \fIprompt\fP values:
181 .IP "\fB--ascii-lines
183 draw ASCII \*(``+\*('' and \*(``-\*('' in the same place.
184 See also \*(``\fB\-\-no\-lines\fR\*(''.
186 .IP "\fB--aspect \fIratio"
192 .IP "\fB--backtitle \fIbacktitle"
197 .IP "\fB--begin \fIy x"
198 Specify the position of the upper left corner of a dialog box on the screen.
200 .IP "\fB--cancel-label \fIstring"
203 .IP "\fB--clear"
206 with \*(``\fB\-\-and\-widget\fR\*('' to erase the
209 Understand this as the complement of \*(``\fB\-\-keep\-window\fR\*(''.
216 --begin 2 2 --yesno "" 0 0 \e
217 --and-widget --begin 4 4 --yesno "" 0 0 \e
218 --and-widget --begin 6 6 --yesno "" 0 0
222 Only the last widget is left visible:
225 --clear --begin 2 2 --yesno "" 0 0 \e
226 --and-widget --clear --begin 4 4 --yesno "" 0 0 \e
227 --and-widget --begin 6 6 --yesno "" 0 0
234 --keep-window --begin 2 2 --yesno "" 0 0 \e
235 --and-widget --keep-window --begin 4 4 --yesno "" 0 0 \e
236 --and-widget --begin 6 6 --yesno "" 0 0
243 --keep-window --begin 2 2 --yesno "" 0 0 \e
244 --and-widget --clear --begin 4 4 --yesno "" 0 0 \e
245 --and-widget --begin 6 6 --yesno "" 0 0
252 the lower left after the \fB\*p\fP program has exited, use the
253 \fB\-\-erase\-on\-exit\fR\ option.
255 .IP "\fB--colors"
283 .IP "\fB--column-separator \fIstring"
287 .IP "\fB--cr-wrap"
294 Without cr-wrap, the layout of your text may be formatted to look nice
298 The \fIcr\-wrap\fP feature is implemented subject to these conditions:
301 the string contains \*(``\en\*('' and the \fB\-\-no\-nl\-expand\fP option is
304 the \fB\-\-trim\fP option is used.
309 .IP "\fB--create-rc \fIfile"
312 supports run-time configuration,
317 .IP "\fB--cursor-off-label"
318 Place the terminal cursor at the end of a button instead of on the
321 interacts poorly with the button-label text colors.
323 .IP "\fB--date-format \fIformat"
326 the \fB\-\-calendar\fP widget.
329 .IP "\fB--defaultno"
337 If \*(``\fB\-\-no\-cancel\fP\*('' or \*(``\fB\-\-visit\-items\fP\*('' are given
342 .IP "\fB--default-button \fIstring"
358 together with the \*(``\fB\-\-no\-ok\fP\*(''
359 and \*(``\fB\-\-no\-cancel\fP\*('' options.
362 .IP "\fB--default-item \fIstring"
366 .IP "\fB--erase-on-exit"
369 at the lower left corner.
371 .IP "\fB--exit-label \fIstring"
374 .IP "\fB--extra-button"
377 .IP "\fB--extra-label \fIstring"
381 .IP "\fB--help"
386 .IP "\fB--help-button"
387 Show a help-button after \*(``OK\*('' and \*(``Cancel\*('' buttons
396 If "\fB\-\-item\-help\fR" is also given, the item-help text is written.
402 You can use the \fB\-\-help\-tags\fP option and/or set the DIALOG_ITEM_HELP
403 environment variable to modify these messages and exit-status.
409 the help-button is just an extra button.
411 .IP "\fB--help-label \fIstring"
414 .IP "\fB--help-status"
415 If the help-button is selected,
417 after the item-help \*(``HELP\*('' information.
421 .IP "\fB--help-tags"
422 Modify the messages written on exit for \fB\-\-help\-button\fP
426 .IP "\fB--hfile \fIfilename"
429 .IP "\fB--hline \fIstring"
432 .IP "\fB--ignore"
434 Some well-known ones such as \*(``\fB\-\-icon\fP\*('' are ignored anyway,
437 .IP "\fB--input-fd \fIfd"
438 Read keyboard input from the given file descriptor.
439 Most \fB\*p\fR scripts read from the standard input,
440 but the gauge widget reads a pipe (which is always standard input).
443 Use this option (with appropriate juggling of file-descriptors)
446 .IP "\fB--insecure"
450 .IP "\fB--iso-week"
451 Set the starting point for the week-number
452 shown in the \*(``\fB\-\-calendar\fP\*('' option
453 according to ISO-8601, which starts numbering
456 .IP "\fB--item-help"
461 .IP "\fB--keep-tite"
471 .IP "\fB--keep-window"
473 connected by \*(``\fB\-\-and\-widget\fR\*('',
478 marked with \*(``\fB\-\-keep\-window\fR\*('',
481 See the discussion of the \*(``\fB\-\-clear\fR\*('' option for examples.
483 .IP "\fB--last-key"
490 .IP "\fB--max-input \fIsize"
491 Limit input strings to the given size.
494 .IP "\fB--no-cancel"
498 .IP "\fB--no-collapse"
500 spaces to a single space for text which is displayed in a message boxes, etc.
503 subject to the \*(``\fB\-\-cr\-wrap\fR\*(''
504 and \*(``\fB\-\-trim\fR\*('' options.
506 The \fIno\-collapse\fP feature is implemented subject to these conditions:
509 the string contains \*(``\en\*('' and the \fB\-\-no\-nl\-expand\fP option is
512 the \fB\-\-trim\fP option is not used.
517 .IP "\fB\-\-no\-hot\-list"
528 .IP "\fB--no-items"
536 See also \fB\-\-no\-tags\fP.
539 .IP "\fB--no-kill"
548 .IP "\fB--no-label \fIstring"
551 .IP "\fB--no-lines
553 See also \*(``\fB\-\-ascii\-lines\fR\*(''.
555 .IP "\fB--no-mouse
558 .IP "\fB--no-nl-expand
562 The \fIno\-nl\-expand\fP feature is used only if
567 .IP "\fB--no-ok"
574 when the \fB\-\-no\-ok\fP option is used.
577 When \fB\-\-no\-ok\fP is not used,
584 when using \fB\-\-no\-ok\fP,
590 .IP "\fB--no-shadow"
593 .IP "\fB--no-tags"
597 The \fB\-\-no\-tags\fP option (from Xdialog) may be used to suppress the
599 Unlike the \fB\-\-no\-items\fP option,
606 by matching a single character to the first character of the tag.
607 When the \fB\-\-no\-tags\fP option is given, \fB\*p\fP matches against
611 .IP "\fB--ok-label \fIstring"
614 .IP "\fB--output-fd \fIfd"
619 .IP "\fB--separator \fIstring"
620 .IP "\fB--output-separator \fIstring"
622 checklists, rather than a newline (for \fB\-\-separate\-output\fP) or a space.
626 .IP "\fB--print-maxsize"
631 .IP "\fB--print-size"
635 .IP "\fB--print-text-only \fIstring [ height [ width ] ]"
642 .IP "\fB--print-text-size \fIstring [ height [ width ] ]"
653 .IP "\fB--print-version"
658 .IP "\fB--quoted"
660 as well as the item-help text.
662 (i.e., if the string contains whitespace or a single or double-quote character).
664 .IP "\fB--reorder"
666 list as for the input (left).
670 .IP "\fB--scrollbar"
672 draw a scrollbar on its right-margin.
675 .IP "\fB--separate-output"
680 .IP "\fB--separate-widget \fIstring"
687 .IP "\fB--single-quoted"
688 Use single-quoting as needed (and no quotes if unneeded) for the
689 output of checklist's as well as the item-help text.
695 Single quotes would be needed if
696 the string contains whitespace or a single or double-quote character.
698 .IP "\fB--size-err"
701 (This option is obsolete, since all new-window calls are checked).
703 .IP "\fB--sleep \fIsecs"
706 .IP "\fB--stderr"
711 .IP "\fB--stdout"
720 .IP "\fB--tab-correct"
722 (for the \fBtextbox\fP widget; otherwise to a single space).
724 The \fB\-\-no\-collapse\fP option disables tab expansion.
726 .IP "\fB--tab-len \fIn"
728 \*(``\fB\-\-tab\-correct\fP\*('' option is given.
732 .IP "\fB--time-format \fIformat"
735 the \fB\-\-timebox\fP widget.
738 .IP "\fB--timeout \fIsecs"
749 This option is ignored by the \*(``\fB\-\-pause\fP\*('' widget.
751 if the background \*(``\fB\-\-tailboxbg\fP\*('' option is used
754 .IP "\fB--title \fItitle"
759 .IP "\fB--trace \fIfilename"
760 logs the command-line parameters,
763 Piped input to the \fIgauge\fP widget is logged.
766 The \fB\*p\fR program handles some command-line parameters specially,
768 For example, if the first option is \fB\-\-trace\fP,
771 .IP "\fB--week-start \fIday"
773 used in the \*(``\fB\-\-calendar\fP\*('' option.
787 .IP "\fB--trim"
796 the \fB\-\-no\-nl\-expand\fP option is used.
802 See also the \*(``\fB\-\-cr\-wrap\fR\*(''
803 and \*(``\fB\-\-no\-collapse\fR\*('' options.
805 .IP "\fB--version"
807 See also \*(``\fB\-\-print\-version\fP\*(''.
809 .IP "\fB--visit-items"
810 Modify the tab-traversal of checklist, radiolist, menubox and inputmenu
819 .IP "\fB--yes-label \fIstring"
838 .IP "\fB\-\-buildlist \fItext height width list-height \fR[ \fItag item status \fR] \fI..."
839 A \fBbuildlist\fP dialog displays two lists, side-by-side.
840 The list on the left shows unselected items.
845 in the selected-window and exit.
846 The results are written using the order displayed in the selected-window.
851 The dialog behaves like a \fBmenu\fP, using the \fB\-\-visit\-items\fP
855 If \fB\-\-visit\-items\fP is not given,
856 tab-traversal uses two states (OK/Cancel).
858 If \fB\-\-visit\-items\fP is given,
859 tab-traversal uses four states (Left/Right/OK/Cancel).
862 Whether or not \fB\-\-visit\-items\fP is given,
864 the default \*(``^\*('' (left-column) and \*(``$\*('' (right-column) keys.
870 If the "\fB\-\-separate\-output\fP" option is not given,
873 By default, this uses double-quotes, as needed.
874 See the \*(``\fB\-\-single\-quoted\fP\*('' option,
877 .IP "\fB--calendar \fItext height width day month year"
883 left-, up-, right-, and down-arrows.
884 Use vi-style h, j, k and l for moving around the array of days in a month.
889 The format can be overridden using the \fB\-\-date\-format\fP option.
891 .IP "\fB\-\-checklist \fItext height width list-height \fR[ \fItag item status \fR] \fI..."
906 If the \*(``\fB\-\-separate\-output\fP\*('' option is not given,
909 By default, this uses double-quotes (as needed).
910 See the \*(``\fB\-\-single\-quoted\fP\*('' option,
913 .IP "\fB\-\-dselect \fIfilepath height width\fR"
914 The directory-selection dialog displays a text-entry window
921 will display the contents of the path and the text-entry window will contain
927 Use the space-bar to copy the current selection into the text-entry
930 Typing any printable characters switches focus to the text-entry window,
935 in the text-entry window and exit.
937 On exit, the contents of the text-entry window are written
940 .IP "\fB\-\-editbox \fIfilepath height width\fR"
941 The edit-box dialog displays a copy of the file.
946 Unlike the \fB\-\-inputbox\fP,
955 .IP "\fB\-\-form \fItext height width formheight \fR[ \fIlabel y x item y x flen ilen \fR] \fI..."
959 The field length \fIflen\fR and input-length \fIilen\fR tell how long
967 and the contents of the field determine the displayed-length.
970 and the negated value of \fIflen\fR is used as the displayed-length.
978 On exit, the contents of the form-fields are written to \fB\*p\fP's output,
980 The text used to fill non-editable fields
985 .IP "\fB\-\-fselect \fIfilepath height width\fR"
986 The \fBfselect\fP (file-selection) dialog displays a text-entry window
993 will display the contents of the path and the text-entry window will contain
999 Use the space-bar to copy the current selection into the text-entry
1002 Typing any printable characters switches focus to the text-entry window,
1011 in the text-entry window and exit.
1013 On exit, the contents of the text-entry window are written
1017 .IP "\fB\-\-gauge \fItext height width [percent]\fR"
1023 standard input, one integer per line.
1026 If the standard input reads the string \*(``XXX\*('',
1029 The gauge exits when EOF is reached on the standard input.
1035 The widget accepts no input, so the exit status is always OK.
1038 .IP "\fB--infobox \fItext height width"
1053 .IP "\fB--inputbox \fItext height width [init]"
1055 \fBinput\fP
1057 require the user to input a string as the answer.
1059 it is used to initialize the input string.
1063 If the input string is longer than
1064 can fit in the dialog box, the input field will be scrolled.
1066 On exit, the input string will be printed on \fB\*p\fP's output.
1069 .IP "\fB\-\-inputmenu \fItext height width menu-height \fR[ \fItag item \fR] \fI..."
1075 The entries are not automatically centered but left adjusted.
1091 .IP "\fB\-\-menu \fItext height width menu-height \fR[ \fItag item \fR] \fI..."
1104 as a hot-key, or the number keys \fI1\fP through \fI9\fP.
1105 There are \fImenu-height\fP
1111 If the \*(``\fB\-\-help\-button\fR\*('' option is given, the corresponding help
1115 .IP "\fB\-\-mixedform \fItext height width formheight \fR[ \fIlabel y x item y x flen ilen itype \f…
1118 much like the \fB\-\-form\fP dialog.
1119 It differs by adding a field-type parameter to each field's description.
1130 .IP "\fB\-\-mixedgauge \fItext height width percent \fR[ \fItag1 item1 \fR] \fI..."
1134 It also displays a list of the \fItag\/\fP- and \fIitem\/\fP-values at the
1141 No provision is made for reading data from the standard input as \fB\-\-gauge\fP
1145 The widget accepts no input, so the exit status is always OK.
1147 .IP "\fB--msgbox \fItext height width"
1150 box is that a \fBmessage\fP box has only a single \fBOK\fP button.
1161 Only an \*(``OK\*('' button is provided for input,
1164 .IP "\fB\-\-pause \fItext height width seconds\fR"
1168 The meter indicates how many seconds remain until the end of the pause.
1174 .IP "\fB--passwordbox \fItext height width [init]"
1175 A \fBpassword\fP box is similar to an input box,
1185 See \*(``\fB\-\-insecure\fP\*('' if you do not care about your password.
1187 On exit, the input string will be printed on \fB\*p\fP's output.
1191 .IP "\fB\-\-passwordform \fItext height width formheight \fR[ \fIlabel y x item y x flen ilen \fR] …
1193 This is identical to \fB\-\-form\fP except that all text fields are
1197 .IP "\fB--prgbox \fItext command height width"
1198 .IP "\fB--prgbox \fIcommand height width"
1212 .IP "\fB--programbox \fItext height width"
1213 .IP "\fB--programbox \fIheight width"
1228 .IP "\fB--progressbox \fItext height width"
1229 .IP "\fB--progressbox \fIheight width"
1237 b) it will exit when it reaches the end of the file
1246 .IP "\fB\-\-radiolist \fItext height width list-height \fR [ \fItag item status \fR] \fI..."
1256 .IP "\fB--rangebox \fItext height width min-value max-value default-value"
1265 left/right cursor movement to select a digit to modify
1267 +/-
1277 home/end
1285 .IP "\fB--tailbox \fIfile height width"
1287 as in a \*(``tail -f\*('' command.
1288 Scroll left/right using vi-style 'h' and 'l', or arrow-keys.
1292 Only an \*(``OK\*('' button is provided for input,
1296 .IP "\fB--tailboxbg \fIfile height width"
1298 as in a \*(``tail -f &\*('' command.
1299 Scroll left/right using vi-style 'h' and 'l', or arrow-keys.
1303 widgets (\fB\-\-and\-widget\fP) on the screen concurrently.
1309 Once the non-tailboxbg widgets are closed,
1311 and prints its process id if the \*(``\fB\-\-no\-kill\fP\*('' option
1315 Only an \*(``EXIT\*('' button is provided for input,
1326 .IP "\fB--textbox \fIfile height width"
1332 cursor, page-up, page-down
1333 and \fIHOME/END\fR keys available on most keyboards.
1335 the \fILEFT/RIGHT\fP
1337 You may also use vi-style keys h, j, k, and l in place of the cursor keys,
1338 and B or N in place of the page-up and page-down keys.
1339 Scroll up/down using vi-style 'k' and 'j', or arrow-keys.
1340 Scroll left/right using vi-style 'h' and 'l', or arrow-keys.
1341 A '0' resets the left/right scrolling.
1343 vi-style forward and backward searching functions are also provided.
1346 Only an \*(``EXIT\*('' button is provided for input,
1350 .IP "\fB--timebox \fItext height [width hour minute second]"
1355 left-, up-, right- and down-arrows.
1359 The format can be overridden using the \fB\-\-time\-format\fP option.
1362 .IP "\fB\-\-treeview \fItext height width list-height \fR[ \fItag item status depth \fR] \fI..."
1375 .IP "\fB--yesno \fItext height width"
1386 string can also contain the sub-string
1411 .IP "\fB--beep"
1416 .IP "\fB--beep-after"
1428 .B --trim
1434 and (unless \fB\-\-no\-nl\-expand\fP is set) will ignore the
1435 \fB\-\-no\-collapse\fP and \fB\-\-trim\fP options.
1437 After checking for \*(``\en\*('' and the \fB\-\-no\-nl\-expand\fP option,
1438 \fB\*l\fP handles the \fB\-\-trim\fP option.
1440 If the \fB\-\-trim\fP option takes effect,
1441 then \fB\*l\fP ignores \fB\-\-no\-collapse\fP.
1443 (and newlines unless \fB\-cr\-wrap\fP is set) to a single space.
1445 If neither the \*(``\en\*('' or \fB\-\-trim\fP cases apply,
1446 \fB\*l\fP checks \fB\-\-no\-collapse\fP to decide whether to reduce
1447 sequences of tabs and spaces to a single space.
1449 In this case, \fB\*l\fP ignores \fB\-\-cr\-wrap\fP and does not modify newlines.
1455 when the \fB\-\-no\-nl\-expand\fP option is not set.
1464 cr-/no-/no-/trim/Result
1465 wrap/collapse/nl-expand
1479 Convert multiple-space to single.
1484 Convert multiple-space to single.
1502 Convert multiple-space to single.
1519 Convert multiple-space to single.
1524 Convert multiple-space to single.
1542 Convert multiple-space to single.
1551 .SH "RUN-TIME CONFIGURATION"
1557 \*p \-\-create\-rc \fIfile\fP
1578 compile-time, i.e., \fI/etc/dialogrc\fP.
1593 \fB\*L\fP's \fBbindkey\fP command maps single keys to its internal coding.
1601 User-defined bindings override the built-in bindings.
1610 as well as C1-controls such as \*(``~A\*('' and \*(``~?\*(''.
1693 .SS Built-in Bindings
1696 If you have set the \fB\-\-trace\fP option,
1697 \fB\*p\fP writes the key-binding information for each widget
1702 That is, tab (and back-tab) traverse buttons
1712 for \*(``form\*('' (left/right/next/prev).
1732 As in the \*(``\fB\-\-file\fP\*('' option,
1733 double-quotes and backslashes are interpreted.
1735 The \*(``\fB\-\-file\fP\*('' option is not considered a common option
1762 error (\-1),
1770 Help with \fB\-\-item\-help\fP (2),
1777 Normally shell scripts cannot distinguish between \-1 and 255.
1782 that the \*(``\fB\-\-stdout\fP\*('' option was given.
1821 and the \fB\-\-item\-help\fP option is set
1825 While any of the exit-codes can be overridden using environment variables,
1834 \-1
1846 This interferes with \fB\*p\fP's \fB\-\-input\-fd\fP option,
1847 by preventing cursor-keys and similar escape sequences from being recognized.
1849 NetBSD 5.1 curses has incomplete support for wide-characters.
1869 \fB\-\-beep\-after\fP/ignored
1870 \fB\-\-guage\fP/mapped to \fB\-\-gauge\fP
1888 \fB\-\-allow\-close\fP/ignored
1889 \fB\-\-auto\-placement\fP/ignored
1890 \fB\-\-fixed\-font\fP/ignored
1891 \fB\-\-icon\fP/ignored
1892 \fB\-\-keep\-colors\fP/ignored
1893 \fB\-\-no\-close\fP/ignored
1894 \fB\-\-no\-cr\-wrap\fP/ignored
1895 \fB\-\-screen\-center\fP/ignored
1896 \fB\-\-separator\fP/mapped to \fB\-\-separate\-output\fP
1897 \fB\-\-smooth\fP/ignored
1898 \fB\-\-under\-mouse\fP/ignored
1899 \fB\-\-wmclass\fP/ignored
1915 will then have to add the \fB\-\-separate\-output\fP option before the
1916 \fB\-\-checklist\fP one.
1934 whiptail is designed to be drop-in compatible with \*p, but
1949 original mid-1990s dialog 0.4 program.
1956 \fB\-\-gauge\fP (from 0.5)
1958 \fB\-\-passwordbox\fP (from Debian changes in 1999),
1960 \fB\-\-default\-item\fP (from \fB\*p\fP 2000/02/22),
1962 \fB\-\-output\-fd\fP (from \fB\*p\fP 2002/08/14).
1966 of using a \*(``--\*('' as an escape was documented in \fB\*p\fP's manpage about
1982 \fB\-\-cancel\-button\fP/mapped to \fB\-\-cancel\-label\fP
1983 \fB\-\-fb\fP/ignored
1984 \fB\-\-fullbutton\fP/ignored
1985 \fB\-\-no\-button\fP/mapped to \fB\-\-no\-label\fP
1986 \fB\-\-nocancel\fP/mapped to \fB\-\-no\-cancel\fP
1987 \fB\-\-noitem\fP/mapped to \fB\-\-no\-items\fP
1988 \fB\-\-notags\fP/mapped to \fB\-\-no\-tags\fP
1989 \fB\-\-ok\-button\fP/mapped to \fB\-\-ok\-label\fP
1990 \fB\-\-scrolltext\fP/mapped to \fB\-\-scrollbar\fP
1991 \fB\-\-topleft\fP/mapped to \fB\-\-begin 0 0\fP
1992 \fB\-\-yes\-button\fP/mapped to \fB\-\-yes\-label\fP
1997 There are visual differences which are not addressed by command-line options:
2000 \fBwhiptail\fP typically puts lists against the left margin.