xref: /freebsd/contrib/bsddialog/utility/bsddialog.1 (revision 079f60541fdb363215beb98583e76f8c0729449d)
161ba55bcSBaptiste Daroussin.\"
2a6d8be45SAlfonso S. Siciliano.\" Copyright (c) 2021-2024 Alfonso Sabato Siciliano
361ba55bcSBaptiste Daroussin.\"
461ba55bcSBaptiste Daroussin.\" Redistribution and use in source and binary forms, with or without
561ba55bcSBaptiste Daroussin.\" modification, are permitted provided that the following conditions
661ba55bcSBaptiste Daroussin.\" are met:
761ba55bcSBaptiste Daroussin.\" 1. Redistributions of source code must retain the above copyright
861ba55bcSBaptiste Daroussin.\"    notice, this list of conditions and the following disclaimer.
961ba55bcSBaptiste Daroussin.\" 2. Redistributions in binary form must reproduce the above copyright
1061ba55bcSBaptiste Daroussin.\"    notice, this list of conditions and the following disclaimer in the
1161ba55bcSBaptiste Daroussin.\"    documentation and/or other materials provided with the distribution.
1261ba55bcSBaptiste Daroussin.\"
1361ba55bcSBaptiste Daroussin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1461ba55bcSBaptiste Daroussin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1561ba55bcSBaptiste Daroussin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1661ba55bcSBaptiste Daroussin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1761ba55bcSBaptiste Daroussin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1861ba55bcSBaptiste Daroussin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
1961ba55bcSBaptiste Daroussin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2061ba55bcSBaptiste Daroussin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2161ba55bcSBaptiste Daroussin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2261ba55bcSBaptiste Daroussin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2361ba55bcSBaptiste Daroussin.\" SUCH DAMAGE.
2461ba55bcSBaptiste Daroussin.\"
25*079f6054SAlfonso S. Siciliano.Dd May 25, 2024
2661ba55bcSBaptiste Daroussin.Dt BSDDIALOG 1
2761ba55bcSBaptiste Daroussin.Os
2861ba55bcSBaptiste Daroussin.Sh NAME
2961ba55bcSBaptiste Daroussin.Nm bsddialog
3061ba55bcSBaptiste Daroussin.Nd TUI dialogs
3161ba55bcSBaptiste Daroussin.Sh SYNOPSIS
3261ba55bcSBaptiste Daroussin.Nm
3361ba55bcSBaptiste Daroussin.Fl Fl help | Fl Fl version
3461ba55bcSBaptiste Daroussin.Nm
3561ba55bcSBaptiste Daroussin.Op Fl Fl option
3661ba55bcSBaptiste Daroussin.Fl Fl dialog
3761ba55bcSBaptiste Daroussin.Ar text
3861ba55bcSBaptiste Daroussin.Ar rows
3961ba55bcSBaptiste Daroussin.Ar cols
4061ba55bcSBaptiste Daroussin.Op Ar dialog-argument
4161ba55bcSBaptiste Daroussin.Op Fl Fl option
4261ba55bcSBaptiste Daroussin.Nm
4361ba55bcSBaptiste Daroussin\&...
4461ba55bcSBaptiste Daroussin.Fl Fl dialog1
4561ba55bcSBaptiste Daroussin.Ar ...
4661ba55bcSBaptiste Daroussin.Oo Fl Fl and-dialog
4761ba55bcSBaptiste Daroussin.Fl Fl dialog2
4861ba55bcSBaptiste Daroussin.Ar ...
4961ba55bcSBaptiste Daroussin.Oc ...
5061ba55bcSBaptiste Daroussin.Sh DESCRIPTION
5161ba55bcSBaptiste DaroussinThe
5261ba55bcSBaptiste Daroussin.Nm bsddialog
5361ba55bcSBaptiste Daroussinutility builds Text User Interface dialogs and widgets.
5461ba55bcSBaptiste Daroussin.Pp
5561ba55bcSBaptiste DaroussinThe option
5661ba55bcSBaptiste Daroussin.Fl Fl help
5761ba55bcSBaptiste Daroussinprints a brief list of features and exits.
5861ba55bcSBaptiste DaroussinThe option
5961ba55bcSBaptiste Daroussin.Fl Fl version
6061ba55bcSBaptiste Daroussinprints the version and exits.
6161ba55bcSBaptiste DaroussinThe option
6261ba55bcSBaptiste Daroussin.Fl Fl and-dialog
6361ba55bcSBaptiste Daroussinbuilds another dialog unless the previous one returns Error, ESC or Cancel.
6461ba55bcSBaptiste Daroussin.Pp
6561ba55bcSBaptiste DaroussinEach dialog accepts
6661ba55bcSBaptiste Daroussin.Ar text
6761ba55bcSBaptiste Daroussinto print a message inside,
6861ba55bcSBaptiste Daroussin.Ar rows
6961ba55bcSBaptiste Daroussinand
7061ba55bcSBaptiste Daroussin.Ar cols
7161ba55bcSBaptiste Daroussinto set height and width,
7261ba55bcSBaptiste Daroussin.Dv 0
7361ba55bcSBaptiste Daroussinfor autosize and
7461ba55bcSBaptiste Daroussin.Dv -1
7561ba55bcSBaptiste Daroussinfor fullscreen.
7661ba55bcSBaptiste Daroussin.Pp
7761ba55bcSBaptiste DaroussinThe possible input from the user interface is printed to standard error at exit.
7861ba55bcSBaptiste Daroussin.Ss Options
7961ba55bcSBaptiste DaroussinThe following options can change the default behavior of the utility and are
8061ba55bcSBaptiste Daroussincommon to some dialog.
8161ba55bcSBaptiste Daroussin.Bl -tag -width Ds
8261ba55bcSBaptiste Daroussin.It Fl Fl alternate-screen
8361ba55bcSBaptiste DaroussinIf available set alternate screen mode, see
8461ba55bcSBaptiste Daroussin.Xr terminfo 5 .
8561ba55bcSBaptiste Daroussin.It Fl Fl ascii-lines
8661ba55bcSBaptiste DaroussinAscii characters to draw lines.
8761ba55bcSBaptiste Daroussin.It Fl Fl backtitle Ar backtitle
8861ba55bcSBaptiste DaroussinScreen title.
8961ba55bcSBaptiste Daroussin.It Fl Fl begin-x Ar x
9061ba55bcSBaptiste DaroussinSet dialog horizontal position,
9161ba55bcSBaptiste Daroussin.Dv -1
9261ba55bcSBaptiste Daroussincenter,
9361ba55bcSBaptiste Daroussin.Dv 0
9461ba55bcSBaptiste Daroussinleft screen.
9561ba55bcSBaptiste Daroussin.It Fl Fl begin-y Ar y
9661ba55bcSBaptiste DaroussinSet dialog vertical position,
9761ba55bcSBaptiste Daroussin.Dv -1
9861ba55bcSBaptiste Daroussincenter,
9961ba55bcSBaptiste Daroussin.Dv 0
10061ba55bcSBaptiste Daroussintop screen.
10161ba55bcSBaptiste Daroussin.It Fl Fl bikeshed
10261ba55bcSBaptiste DaroussinRandom settings.
10361ba55bcSBaptiste DaroussinColors, title delimiter, button delimiter; see theme features.
10461ba55bcSBaptiste DaroussinTitle margin.
10561ba55bcSBaptiste DaroussinButtons always active or TAB to switch focus with other components, see
10661ba55bcSBaptiste Daroussin.Fl Fl switch-buttons .
10761ba55bcSBaptiste DaroussinZero padding with time output; see
10861ba55bcSBaptiste Daroussin.Fl Fl time-format .
10961ba55bcSBaptiste DaroussinZero padding with date output; see
11061ba55bcSBaptiste Daroussin.Fl Fl date-format .
11161ba55bcSBaptiste DaroussinUser Interface date format for
11261ba55bcSBaptiste Daroussin.Fl Fl datebox ;
11361ba55bcSBaptiste Daroussinsee
11461ba55bcSBaptiste Daroussin.Fl Fl datebox-format .
11561ba55bcSBaptiste Daroussin.It Fl Fl cancel-exit-code Ar retval
11661ba55bcSBaptiste DaroussinSet an exit code value for the
11761ba55bcSBaptiste Daroussin.Dq Cancel
11861ba55bcSBaptiste Daroussinbutton.
11961ba55bcSBaptiste Daroussin.It Fl Fl cancel-label Ar label
12061ba55bcSBaptiste DaroussinLabel for the
12161ba55bcSBaptiste Daroussin.Dq Cancel
12261ba55bcSBaptiste Daroussinbutton.
12361ba55bcSBaptiste Daroussin.It Fl Fl clear-dialog
12461ba55bcSBaptiste DaroussinHide the dialog at exit.
12561ba55bcSBaptiste Daroussin.It Fl Fl clear-screen
12661ba55bcSBaptiste DaroussinClear the screen, wait a dialog if built.
12761ba55bcSBaptiste Daroussin.It Fl Fl columns-per-row Ar columns
12861ba55bcSBaptiste DaroussinTry to set the number of columns for a row of text with autosizing; default
12961ba55bcSBaptiste Daroussin.Dv 10 .
13061ba55bcSBaptiste Daroussin.It Fl Fl cr-wrap
13161ba55bcSBaptiste DaroussinKeep new line in
13261ba55bcSBaptiste Daroussin.Ar text
13361ba55bcSBaptiste Daroussinalso if it constains a
13461ba55bcSBaptiste Daroussin.Dq \en ,
13561ba55bcSBaptiste Daroussinsee
13661ba55bcSBaptiste Daroussin.Fl Fl text-unchanged .
13761ba55bcSBaptiste Daroussin.It Fl Fl datebox-format Ar format
13861ba55bcSBaptiste DaroussinString to customize
13961ba55bcSBaptiste Daroussin.Fl Fl datebox
14061ba55bcSBaptiste Daroussininterface, possible values:
14161ba55bcSBaptiste Daroussin.Dq d/m/y ,
14261ba55bcSBaptiste Daroussin.Dq m/y/d ,
14361ba55bcSBaptiste Daroussin.Dq y/m/d .
14461ba55bcSBaptiste Daroussin.It Fl Fl date-format Ar format
14561ba55bcSBaptiste DaroussinString accepted by
14661ba55bcSBaptiste Daroussin.Xr strftime 3
14761ba55bcSBaptiste Daroussinto customize the output of
14861ba55bcSBaptiste Daroussin.Fl Fl datebox
14961ba55bcSBaptiste Daroussinand
15061ba55bcSBaptiste Daroussin.Fl Fl calendar .
15161ba55bcSBaptiste Daroussin.It Fl Fl default-button Ar label
15261ba55bcSBaptiste DaroussinFocus on the button with
15361ba55bcSBaptiste Daroussin.Ar label
15461ba55bcSBaptiste Daroussinon startup.
15561ba55bcSBaptiste Daroussin.It Fl Fl default-item Ar name
15661ba55bcSBaptiste DaroussinFocus on the item with
15761ba55bcSBaptiste Daroussin.Ar name ,
15861ba55bcSBaptiste Daroussinfor Checklist, Menu, Radiolist and Treeview.
15961ba55bcSBaptiste Daroussin.It Fl Fl default-no
16061ba55bcSBaptiste DaroussinFocus on
16161ba55bcSBaptiste Daroussin.Dq Cancel
16261ba55bcSBaptiste Daroussinor
16361ba55bcSBaptiste Daroussin.Dq \&No
16461ba55bcSBaptiste Daroussinbutton on startup.
16561ba55bcSBaptiste Daroussin.It Fl Fl disable-esc
16661ba55bcSBaptiste DaroussinDisable ESC key to quit.
16761ba55bcSBaptiste Daroussin.It Fl Fl error-exit-code Ar retval
16861ba55bcSBaptiste DaroussinSet an exit code value for the
16961ba55bcSBaptiste Daroussin.Nm
17061ba55bcSBaptiste Daroussinerrors.
17161ba55bcSBaptiste Daroussin.It Fl Fl esc-exit-code Ar retval
17261ba55bcSBaptiste DaroussinSet an exit code value for the
17361ba55bcSBaptiste Daroussin.Dv ESC
17461ba55bcSBaptiste Daroussinkey.
17561ba55bcSBaptiste Daroussin.It Fl Fl extra-button
17661ba55bcSBaptiste DaroussinAdd a button with
17761ba55bcSBaptiste Daroussin.Dq Extra
17861ba55bcSBaptiste Daroussinlabel.
17961ba55bcSBaptiste Daroussin.It Fl Fl extra-exit-code Ar retval
18061ba55bcSBaptiste DaroussinSet an exit code value for the
18161ba55bcSBaptiste Daroussin.Dq Extra
18261ba55bcSBaptiste Daroussinbutton.
18361ba55bcSBaptiste Daroussin.It Fl Fl extra-label Ar label
18461ba55bcSBaptiste DaroussinSet
18561ba55bcSBaptiste Daroussin.Ar label
18661ba55bcSBaptiste Daroussinfor the
18761ba55bcSBaptiste Daroussin.Dq Extra
18861ba55bcSBaptiste Daroussinbutton.
18961ba55bcSBaptiste Daroussin.It Fl Fl left1-button Ar label
19061ba55bcSBaptiste DaroussinAdd a button with
19161ba55bcSBaptiste Daroussin.Ar label .
19261ba55bcSBaptiste Daroussin.It Fl Fl left1-exit-code Ar retval
19361ba55bcSBaptiste DaroussinSet an exit code for
19461ba55bcSBaptiste Daroussin.Fl Fl left1-button .
19561ba55bcSBaptiste Daroussin.It Fl Fl left2-button Ar label
19661ba55bcSBaptiste DaroussinAdd a button with
19761ba55bcSBaptiste Daroussin.Ar label .
19861ba55bcSBaptiste Daroussin.It Fl Fl left2-exit-code Ar retval
19961ba55bcSBaptiste DaroussinSet an exit code for
20061ba55bcSBaptiste Daroussin.Fl Fl left2-button .
20161ba55bcSBaptiste Daroussin.It Fl Fl left3-button Ar label
20261ba55bcSBaptiste DaroussinAdd a button with
20361ba55bcSBaptiste Daroussin.Ar label .
20461ba55bcSBaptiste Daroussin.It Fl Fl left3-exit-code Ar retval
20561ba55bcSBaptiste DaroussinSet an exit code for
20661ba55bcSBaptiste Daroussin.Fl Fl left3-button .
20761ba55bcSBaptiste Daroussin.It Fl Fl help-button
20861ba55bcSBaptiste DaroussinAdd a button with
20961ba55bcSBaptiste Daroussin.Dq Help
21061ba55bcSBaptiste Daroussinlabel.
21161ba55bcSBaptiste Daroussin.It Fl Fl help-exit-code Ar retval
21261ba55bcSBaptiste DaroussinSet an exit code value for the
21361ba55bcSBaptiste Daroussin.Dq Help
21461ba55bcSBaptiste Daroussinbutton.
21561ba55bcSBaptiste Daroussin.It Fl Fl help-label Ar label
21661ba55bcSBaptiste DaroussinSet
21761ba55bcSBaptiste Daroussin.Ar label
21861ba55bcSBaptiste Daroussinfor
21961ba55bcSBaptiste Daroussin.Dq Help
22061ba55bcSBaptiste Daroussinbutton.
22161ba55bcSBaptiste Daroussin.It Fl Fl help-print-items
22261ba55bcSBaptiste DaroussinPrint also the selected items or form values if the
22361ba55bcSBaptiste Daroussin.Dq Help
22461ba55bcSBaptiste Daroussinbutton is pressed.
22561ba55bcSBaptiste Daroussin.It Fl Fl help-print-name
22661ba55bcSBaptiste DaroussinPrint the name of the focused item if the
22761ba55bcSBaptiste Daroussin.Dq Help
22861ba55bcSBaptiste Daroussinbutton is pressed also
22961ba55bcSBaptiste Daroussinwith
23061ba55bcSBaptiste Daroussin.Fl Fl item-bottom-desc .
23161ba55bcSBaptiste Daroussin.It Fl Fl hfile Ar filename
23261ba55bcSBaptiste DaroussinOpen
23361ba55bcSBaptiste Daroussin.Ar filename
23461ba55bcSBaptiste Daroussinin a Textbox if F1 key is pressed.
23561ba55bcSBaptiste Daroussin.It Fl Fl hline Ar string
23661ba55bcSBaptiste DaroussinDialog subtitle.
23761ba55bcSBaptiste Daroussin.It Fl Fl hmsg Ar string
23861ba55bcSBaptiste DaroussinOpen a Msgbox with
23961ba55bcSBaptiste Daroussin.Ar string
24061ba55bcSBaptiste Daroussinif the F1 key is pressed.
24161ba55bcSBaptiste Daroussin.It Fl Fl ignore
24261ba55bcSBaptiste DaroussinDo not exit with unknown options.
24361ba55bcSBaptiste Daroussin.It Fl Fl insecure
24461ba55bcSBaptiste DaroussinPrint
24561ba55bcSBaptiste Daroussin.Sq *
24661ba55bcSBaptiste Daroussinto hide passwords while typing, white space otherwise.
24761ba55bcSBaptiste Daroussin.It Fl Fl item-bottom-desc
24861ba55bcSBaptiste DaroussinSet a help string for each item of a Checklist, Form, Menu, Mixedform,
24961ba55bcSBaptiste DaroussinPasswordform, Radiolist and Treeview to display at the bottom screen side.
25061ba55bcSBaptiste Daroussin.It Fl Fl item-depth
25161ba55bcSBaptiste DaroussinSpecify a margin for items, available for Checklist, Menu and Radiolist.
25261ba55bcSBaptiste Daroussin.It Fl Fl item-prefix
25361ba55bcSBaptiste DaroussinSet a string to prefix each item of a Checklist, Menu, Radiolist or Treeview.
25461ba55bcSBaptiste Daroussin.It Fl Fl load-theme Ar file
25561ba55bcSBaptiste DaroussinLoad theme from
25661ba55bcSBaptiste Daroussin.Ar file .
25761ba55bcSBaptiste Daroussin.It Fl Fl max-input Ar size
25861ba55bcSBaptiste DaroussinMaximum length of the input for
25961ba55bcSBaptiste Daroussin.Fl Fl inputbox
26061ba55bcSBaptiste Daroussinand
26161ba55bcSBaptiste Daroussin.Fl Fl passwordbox ,
26261ba55bcSBaptiste Daroussindefault 2048.
26361ba55bcSBaptiste Daroussin.It Fl Fl no-cancel
26461ba55bcSBaptiste DaroussinDo not show
26561ba55bcSBaptiste Daroussin.Dq Cancel
26661ba55bcSBaptiste Daroussinbutton.
26761ba55bcSBaptiste Daroussin.It Fl Fl no-descriptions
26861ba55bcSBaptiste DaroussinDo not display items desciption, for Checklist, Menu, Radiolist or Treeview;
26961ba55bcSBaptiste Daroussinmutually exclusive with
27061ba55bcSBaptiste Daroussin.Fl Fl no-names .
27161ba55bcSBaptiste Daroussin.It Fl Fl no-lines
27261ba55bcSBaptiste DaroussinDo not draw borders and lines.
27361ba55bcSBaptiste Daroussin.It Fl Fl no-names
27461ba55bcSBaptiste DaroussinDo not display items name, for Checklist, Menu and Radiolist; mutually exclusive
27561ba55bcSBaptiste Daroussinwith
27661ba55bcSBaptiste Daroussin.Fl Fl no-descriptions .
27761ba55bcSBaptiste Daroussin.It Fl Fl no-ok
27861ba55bcSBaptiste DaroussinDo not draw
27961ba55bcSBaptiste Daroussin.Dq OK
28061ba55bcSBaptiste Daroussinbutton.
28161ba55bcSBaptiste Daroussin.It Fl Fl no-shadow
28261ba55bcSBaptiste DaroussinNo not draw the shadow of the dialog.
28361ba55bcSBaptiste Daroussin.It Fl Fl ok-label Ar label
28461ba55bcSBaptiste DaroussinSet
28561ba55bcSBaptiste Daroussin.Ar label
28661ba55bcSBaptiste Daroussinfor
28761ba55bcSBaptiste Daroussin.Dq OK
28861ba55bcSBaptiste Daroussinbutton.
28961ba55bcSBaptiste Daroussin.It Fl Fl ok-exit-code Ar retval
29061ba55bcSBaptiste DaroussinSet an exit code value for the
29161ba55bcSBaptiste Daroussin.Dq Ok
29261ba55bcSBaptiste Daroussinbutton.
29361ba55bcSBaptiste Daroussin.It Fl Fl normal-screen
29461ba55bcSBaptiste DaroussinIf available set normal screen mode, see
29561ba55bcSBaptiste Daroussin.Xr terminfo 5 .
29661ba55bcSBaptiste Daroussin.It Fl Fl output-fd Ar fd
29761ba55bcSBaptiste DaroussinPrint input from user interface to the specified file descriptor.
29861ba55bcSBaptiste Daroussin.It Fl Fl output-separator Ar sep
29961ba55bcSBaptiste DaroussinSet a sepator for the items in output, default white space.
30061ba55bcSBaptiste Daroussin.It Fl Fl print-maxsize
30161ba55bcSBaptiste DaroussinScreen size.
30261ba55bcSBaptiste DaroussinThis option can be used without a dialog.
30361ba55bcSBaptiste Daroussin.It Fl Fl print-size
30461ba55bcSBaptiste DaroussinPrint dialog height and width at exit.
30561ba55bcSBaptiste Daroussin.It Fl Fl print-version
30661ba55bcSBaptiste DaroussinPrint version.
30761ba55bcSBaptiste DaroussinThis option can be used without a dialog.
30861ba55bcSBaptiste Daroussin.It Fl Fl quoted
30961ba55bcSBaptiste DaroussinQuote items in output, default only when necessary.
31061ba55bcSBaptiste Daroussin.It Fl Fl right1-button Ar label
31161ba55bcSBaptiste DaroussinAdd a button with
31261ba55bcSBaptiste Daroussin.Ar label .
31361ba55bcSBaptiste Daroussin.It Fl Fl right1-exit-code Ar retval
31461ba55bcSBaptiste DaroussinSet an exit code for
31561ba55bcSBaptiste Daroussin.Fl Fl right1-button .
31661ba55bcSBaptiste Daroussin.It Fl Fl right2-button Ar label
31761ba55bcSBaptiste DaroussinAdd a button with
31861ba55bcSBaptiste Daroussin.Ar label .
31961ba55bcSBaptiste Daroussin.It Fl Fl right2-exit-code Ar retval
32061ba55bcSBaptiste DaroussinSet an exit code for
32161ba55bcSBaptiste Daroussin.Fl Fl right2-button .
32261ba55bcSBaptiste Daroussin.It Fl Fl right3-button Ar label
32361ba55bcSBaptiste DaroussinAdd a button with
32461ba55bcSBaptiste Daroussin.Ar label .
32561ba55bcSBaptiste Daroussin.It Fl Fl right3-exit-code Ar retval
32661ba55bcSBaptiste DaroussinSet an exit code for
32761ba55bcSBaptiste Daroussin.Fl Fl right3-button .
32861ba55bcSBaptiste Daroussin.It Fl Fl save-theme Ar file
32961ba55bcSBaptiste DaroussinSave the current theme.
33061ba55bcSBaptiste DaroussinThis option can be used without a dialog.
33161ba55bcSBaptiste Daroussin.It Fl Fl separate-output
33261ba55bcSBaptiste DaroussinPrint selected items separated by a new line and avoid to quote.
33361ba55bcSBaptiste Daroussin.It Fl Fl shadow
33461ba55bcSBaptiste DaroussinShow a shadow for the dialog, enabled by default.
33561ba55bcSBaptiste Daroussin.It Fl Fl single-quoted
33661ba55bcSBaptiste DaroussinUse single quote for items in output.
33761ba55bcSBaptiste Daroussin.It Fl Fl sleep Ar secs
33861ba55bcSBaptiste DaroussinWait
33961ba55bcSBaptiste Daroussin.Ar secs
34061ba55bcSBaptiste Daroussinseconds to close the dialog.
34161ba55bcSBaptiste Daroussin.It Fl Fl stderr
34261ba55bcSBaptiste DaroussinPrint input from user interface to standand error, default.
34361ba55bcSBaptiste Daroussin.It Fl Fl stdout
34461ba55bcSBaptiste DaroussinPrint input from user interface to standard output.
34561ba55bcSBaptiste Daroussin.It Fl Fl switch-buttons
34661ba55bcSBaptiste DaroussinEnable focus switching between buttons and input components pressing TAB,
34761ba55bcSBaptiste Daroussinotherwise buttons are always active and ENTER key closes the dialog.
34861ba55bcSBaptiste DaroussinSuitable for:
34961ba55bcSBaptiste Daroussin.Fl Fl form ,
35061ba55bcSBaptiste Daroussin.Fl Fl inputbox ,
35161ba55bcSBaptiste Daroussin.Fl Fl mixedform ,
35261ba55bcSBaptiste Daroussin.Fl Fl passwordbox ,
35361ba55bcSBaptiste Daroussin.Fl Fl passwordform ,
35461ba55bcSBaptiste Daroussin.Fl Fl timebox ,
35561ba55bcSBaptiste Daroussin.Fl Fl calendar
35661ba55bcSBaptiste Daroussinand
35761ba55bcSBaptiste Daroussin.Fl Fl datebox .
35861ba55bcSBaptiste Daroussin.It Fl Fl tab-escape
35961ba55bcSBaptiste DaroussinReplace
36061ba55bcSBaptiste Daroussin.Dq \et
36161ba55bcSBaptiste Daroussinwith a tab in
36261ba55bcSBaptiste Daroussin.Ar text .
36361ba55bcSBaptiste Daroussin.It Fl Fl tab-len Ar spaces
36461ba55bcSBaptiste DaroussinNumber of spaces to print a TAB in
36561ba55bcSBaptiste Daroussin.Ar text .
36661ba55bcSBaptiste Daroussin.It Fl Fl text-escape
36761ba55bcSBaptiste DaroussinEnable escapes in
36861ba55bcSBaptiste Daroussin.Ar text :
36961ba55bcSBaptiste Daroussin.Bl -column -compact
37061ba55bcSBaptiste Daroussin.It Dq \eZ0
37161ba55bcSBaptiste Daroussinblack.
37261ba55bcSBaptiste Daroussin.It Dq \eZ1
37361ba55bcSBaptiste Daroussinred.
37461ba55bcSBaptiste Daroussin.It Dq \eZ2
37561ba55bcSBaptiste Daroussingreen.
37661ba55bcSBaptiste Daroussin.It Dq \eZ3
37761ba55bcSBaptiste Daroussinyellow.
37861ba55bcSBaptiste Daroussin.It Dq \eZ4
37961ba55bcSBaptiste Daroussinblue.
38061ba55bcSBaptiste Daroussin.It Dq \eZ5
38161ba55bcSBaptiste Daroussinmagenta.
38261ba55bcSBaptiste Daroussin.It Dq \eZ6
38361ba55bcSBaptiste Daroussincyan.
38461ba55bcSBaptiste Daroussin.It Dq \eZ7
38561ba55bcSBaptiste Daroussinwhite.
38661ba55bcSBaptiste Daroussin.It Dq \eZb
38761ba55bcSBaptiste Daroussinbold.
38861ba55bcSBaptiste Daroussin.It Dq \eZB
38961ba55bcSBaptiste Daroussindisable bold.
39061ba55bcSBaptiste Daroussin.It Dq \eZd
39161ba55bcSBaptiste DaroussinHalf bright.
39261ba55bcSBaptiste Daroussin.It Dq \eZD
39361ba55bcSBaptiste Daroussindisable half bright.
39461ba55bcSBaptiste Daroussin.It Dq \eZk
39561ba55bcSBaptiste DaroussinBlink.
39661ba55bcSBaptiste Daroussin.It Dq \eZK
39761ba55bcSBaptiste Daroussindisable blinking.
39861ba55bcSBaptiste Daroussin.It Dq \eZr
39961ba55bcSBaptiste Daroussinreverse foreground and background.
40061ba55bcSBaptiste Daroussin.It Dq \eZR
40161ba55bcSBaptiste Daroussindisable reverse.
40261ba55bcSBaptiste Daroussin.It Dq \eZs
40361ba55bcSBaptiste DaroussinHighlight.
40461ba55bcSBaptiste Daroussin.It Dq \eZS
40561ba55bcSBaptiste Daroussindisable highlighting.
40661ba55bcSBaptiste Daroussin.It Dq \eZu
40761ba55bcSBaptiste Daroussinunderline.
40861ba55bcSBaptiste Daroussin.It Dq \eZU
40961ba55bcSBaptiste Daroussindisable underline.
41061ba55bcSBaptiste Daroussin.It Dq \eZn
41161ba55bcSBaptiste Daroussindisable each customization.
41261ba55bcSBaptiste Daroussin.El
41361ba55bcSBaptiste Daroussin.It Fl Fl text-unchanged
41461ba55bcSBaptiste DaroussinDisable
41561ba55bcSBaptiste Daroussin.Ar text
41661ba55bcSBaptiste Daroussinmodification.
41761ba55bcSBaptiste DaroussinBy default
41861ba55bcSBaptiste Daroussin.Ar text
41961ba55bcSBaptiste Daroussinis changed before to be printed in the dialog.
42061ba55bcSBaptiste DaroussinIf it contains at least a
42161ba55bcSBaptiste Daroussin.Dq \en
42261ba55bcSBaptiste Daroussineach new line and TAB is converted to a space, subsequent spaces are merged.
42361ba55bcSBaptiste DaroussinOtherwise new line characters are preserved and a TAB becomes a space.
42461ba55bcSBaptiste Daroussin.It Fl Fl theme Ar theme
42561ba55bcSBaptiste DaroussinSet theme, possible values:
42661ba55bcSBaptiste Daroussin.Dq 3d ,
42761ba55bcSBaptiste Daroussin.Dq blackwhite ,
42861ba55bcSBaptiste Daroussin.Dq flat .
42961ba55bcSBaptiste Daroussin.It Fl Fl time-format Ar format
43061ba55bcSBaptiste DaroussinString accepted by
43161ba55bcSBaptiste Daroussin.Xr strftime 3
43261ba55bcSBaptiste Daroussinto customize the output of
43361ba55bcSBaptiste Daroussin.Fl Fl timebox .
43461ba55bcSBaptiste Daroussin.It Fl Fl timeout-exit-code Ar retval
43561ba55bcSBaptiste DaroussinSet an exit code value for the
43661ba55bcSBaptiste Daroussin.Fl Fl pause
43761ba55bcSBaptiste Daroussintimeout.
43861ba55bcSBaptiste Daroussin.It Fl Fl title Ar title
43961ba55bcSBaptiste DaroussinDialog title.
44061ba55bcSBaptiste Daroussin.El
441a6d8be45SAlfonso S. Siciliano.Ss Keys
442a6d8be45SAlfonso S. SicilianoThe following keys are available at runtime:
443a6d8be45SAlfonso S. Siciliano.Bl -tag -width Ds
444a6d8be45SAlfonso S. Siciliano.It Ctrl-l
445a6d8be45SAlfonso S. SicilianoRedraw the dialog.
446a6d8be45SAlfonso S. Siciliano.It F1
447a6d8be45SAlfonso S. SicilianoSee
448a6d8be45SAlfonso S. Siciliano.Fl Fl hfile
449a6d8be45SAlfonso S. Sicilianoand
450a6d8be45SAlfonso S. Siciliano.Fl Fl hmsg .
451a6d8be45SAlfonso S. Siciliano.It SPACE
452a6d8be45SAlfonso S. SicilianoSelect menu item.
453a6d8be45SAlfonso S. Siciliano.It UP DOWN LEFT RIGHT - + HOME END PAGEUP PAGEDOWN Ctrl-p Ctrl-n TAB
454a6d8be45SAlfonso S. SicilianoNavigate elements and set value, depending on the dialog.
455a6d8be45SAlfonso S. Siciliano.El
45661ba55bcSBaptiste Daroussin.Ss Dialogs
45761ba55bcSBaptiste DaroussinThe following dialogs are available:
45861ba55bcSBaptiste Daroussin.Bl -tag -width Ds
45961ba55bcSBaptiste Daroussin.It Fl Fl calendar Ar text Ar rows Ar cols Op Ar day Ar month Ar year
46061ba55bcSBaptiste DaroussinDialog to select a date.
46161ba55bcSBaptiste Daroussin.It Fl Fl checklist Ar text Ar rows Ar cols Ar menurows Oo Ar name Ar desc \
46261ba55bcSBaptiste DaroussinAr status Oc ...
46361ba55bcSBaptiste DaroussinChecklist to select some item from a list via the SPACE key.
46461ba55bcSBaptiste DaroussinAn item has a
46561ba55bcSBaptiste Daroussin.Ar name ,
46661ba55bcSBaptiste Daroussin.Ar desc
46761ba55bcSBaptiste Daroussinand a default
46861ba55bcSBaptiste Daroussin.Ar status
46961ba55bcSBaptiste Daroussinspecified by
47061ba55bcSBaptiste Daroussin.Dq on
47161ba55bcSBaptiste Daroussinor
47261ba55bcSBaptiste Daroussin.Dq off .
47361ba55bcSBaptiste DaroussinThe names of the selected items are printed to standard error.
47461ba55bcSBaptiste Daroussin.Ar menurows
47561ba55bcSBaptiste Daroussinis the graphical height of the list, 0 for autosize.
47661ba55bcSBaptiste Daroussin.It Fl Fl datebox Ar text Ar rows Ar cols Op Ar day Ar month Ar year
47761ba55bcSBaptiste DaroussinDialog to select a date.
47861ba55bcSBaptiste Daroussin.It Fl Fl form Ar text Ar rows Ar cols Ar formrows Oo Ar label Ar ylabel \
47961ba55bcSBaptiste DaroussinAr xlabel Ar init Ar yfield Ar xfield Ar fieldlen Ar maxletters Oc ...
48061ba55bcSBaptiste DaroussinDialog to get a list of strings via forms.
48161ba55bcSBaptiste DaroussinA form has a
48261ba55bcSBaptiste Daroussin.Ar label
48361ba55bcSBaptiste Daroussinat the position
48461ba55bcSBaptiste Daroussin.Ar ylabel
48561ba55bcSBaptiste Daroussinand
48661ba55bcSBaptiste Daroussin.Ar xlabel ,
48761ba55bcSBaptiste Daroussina field to get the input at the position
48861ba55bcSBaptiste Daroussin.Ar yfield
48961ba55bcSBaptiste Daroussinand
490a6d8be45SAlfonso S. Siciliano.Ar xfield .
49161ba55bcSBaptiste Daroussin.Ar fieldlen
492a6d8be45SAlfonso S. Sicilianois the field width, if negative is readonly and the width is the absolute value,
493a6d8be45SAlfonso S. Sicilianoif
494a6d8be45SAlfonso S. Siciliano.Dv 0
495a6d8be45SAlfonso S. Sicilianothe field becomes readonly and its value is the
496a6d8be45SAlfonso S. Siciliano.Ar init
497a6d8be45SAlfonso S. Sicilianowidth.
498*079f6054SAlfonso S. SicilianoThe field input is not printed to output if it is readonly.
49961ba55bcSBaptiste Daroussin.Ar maxletters
500a6d8be45SAlfonso S. Sicilianois the maximum input length, if is
501a6d8be45SAlfonso S. Siciliano.Dv 0
502a6d8be45SAlfonso S. Sicilianoits value is
50361ba55bcSBaptiste Daroussin.Ar fieldlen .
50461ba55bcSBaptiste Daroussin.Ar init
505a6d8be45SAlfonso S. Sicilianois the default value in the field.
50661ba55bcSBaptiste Daroussin.Ar formrows
50761ba55bcSBaptiste Daroussinis the graphical height of the list,
50861ba55bcSBaptiste Daroussin.Dv 0
50961ba55bcSBaptiste Daroussinfor autosize.
51061ba55bcSBaptiste Daroussin.It Fl Fl gauge Ar text Ar rows Ar cols Op Ar percentage
51161ba55bcSBaptiste DaroussinDialog with a bar to shows
51261ba55bcSBaptiste Daroussin.Ar percentage ,
51361ba55bcSBaptiste Daroussinthen it waits to read
51461ba55bcSBaptiste Daroussin.Dq XXX
51561ba55bcSBaptiste Daroussinfrom the standard input, then the first string replaces percentage and the
51661ba55bcSBaptiste Daroussinfollowing strings replace
51761ba55bcSBaptiste Daroussin.Ar text
51861ba55bcSBaptiste Daroussinuntil the next
51961ba55bcSBaptiste Daroussin.Dq XXX ,
52061ba55bcSBaptiste Daroussinthe loop ends reading
52161ba55bcSBaptiste Daroussin.Dq EOF .
52261ba55bcSBaptiste Daroussin.It Fl Fl infobox Ar text Ar rows Ar cols
52361ba55bcSBaptiste DaroussinDialog without buttons to display a message and to exit immediately.
52461ba55bcSBaptiste Daroussin.It Fl Fl inputbox Ar text Ar rows Ar cols Op Ar init
52561ba55bcSBaptiste DaroussinDialog to get a string in input,
52661ba55bcSBaptiste Daroussin.Ar init
52761ba55bcSBaptiste Daroussinis the default value.
52861ba55bcSBaptiste Daroussin.It Fl Fl menu Ar text Ar rows Ar cols Ar menurows Oo Ar name desc Oc ...
529a6d8be45SAlfonso S. SicilianoBuilds a menu to select an item from a list, SPACE key is equivalent to ENTER.
53061ba55bcSBaptiste DaroussinAn item has a
53161ba55bcSBaptiste Daroussin.Ar name
53261ba55bcSBaptiste Daroussinand a
53361ba55bcSBaptiste Daroussin.Ar desc .
53461ba55bcSBaptiste DaroussinThe name of the selected item is printed to standard error.
53561ba55bcSBaptiste Daroussin.Ar menurows
53661ba55bcSBaptiste Daroussinis the graphical height of the list, 0 for autosize.
53761ba55bcSBaptiste Daroussin.It Fl Fl mixedform Ar text Ar rows Ar cols Ar formrows Oo Ar label Ar ylabel \
53861ba55bcSBaptiste DaroussinAr xlabel Ar init Ar yfield Ar xfield Ar fieldlen Ar maxletters Ar flag Oc ...
53961ba55bcSBaptiste DaroussinDialog to get a list of strings via forms.
54061ba55bcSBaptiste DaroussinA form has a
54161ba55bcSBaptiste Daroussin.Ar label
54261ba55bcSBaptiste Daroussinat the position
54361ba55bcSBaptiste Daroussin.Ar ylabel
54461ba55bcSBaptiste Daroussinand
54561ba55bcSBaptiste Daroussin.Ar xlabel ,
546a6d8be45SAlfonso S. Sicilianoa field to get the input at the position
54761ba55bcSBaptiste Daroussin.Ar yfield
54861ba55bcSBaptiste Daroussinand
549a6d8be45SAlfonso S. Siciliano.Ar xfield .
550a6d8be45SAlfonso S. Siciliano.Ar fieldlen
551a6d8be45SAlfonso S. Sicilianois the field width, if negative is readonly and the width is the absolute value,
552a6d8be45SAlfonso S. Sicilianoif
553a6d8be45SAlfonso S. Siciliano.Dv 0
554a6d8be45SAlfonso S. Sicilianothe field becomes readonly and its value is the
55561ba55bcSBaptiste Daroussin.Ar init
556a6d8be45SAlfonso S. Sicilianowidth.
557*079f6054SAlfonso S. SicilianoThe field input is not printed to output if
558*079f6054SAlfonso S. Siciliano.Ar fieldlen
559*079f6054SAlfonso S. Sicilianois less than or equal to
560*079f6054SAlfonso S. Siciliano.Dv 0 .
561a6d8be45SAlfonso S. Siciliano.Ar maxletters
562a6d8be45SAlfonso S. Sicilianois the maximum input length, if is
563a6d8be45SAlfonso S. Siciliano.Dv 0
564a6d8be45SAlfonso S. Sicilianoits value is
565a6d8be45SAlfonso S. Siciliano.Ar fieldlen .
566a6d8be45SAlfonso S. Siciliano.Ar init
567a6d8be45SAlfonso S. Sicilianois the default value in the field.
56861ba55bcSBaptiste Daroussin.Ar flag
569a6d8be45SAlfonso S. Sicilianocan customize
570a6d8be45SAlfonso S. Siciliano.Ar field :
571a6d8be45SAlfonso S. Siciliano.Dv 0
572a6d8be45SAlfonso S. Sicilianonormal,
573a6d8be45SAlfonso S. Siciliano.Dv 1
574a6d8be45SAlfonso S. Sicilianohide typed characters,
575a6d8be45SAlfonso S. Siciliano.Dv 2
576a6d8be45SAlfonso S. Sicilianoreadonly.
57761ba55bcSBaptiste Daroussin.Ar formrows
57861ba55bcSBaptiste Daroussinis the graphical height of the list,
57961ba55bcSBaptiste Daroussin.Dv 0
58061ba55bcSBaptiste Daroussinfor autosize.
58161ba55bcSBaptiste Daroussin.It Fl Fl mixedgauge Ar text Ar rows Ar cols Ar mainperc Oo Ar minilabel \
58261ba55bcSBaptiste DaroussinAr miniperc Oc ...
58361ba55bcSBaptiste DaroussinDialog to show a main bar to represent
58461ba55bcSBaptiste Daroussin.Ar mainperc
58561ba55bcSBaptiste Daroussinfrom 0 to 100.
58661ba55bcSBaptiste DaroussinSome mini bar with a
58761ba55bcSBaptiste Daroussin.Ar minilabel
58861ba55bcSBaptiste Daroussinstring and a
58961ba55bcSBaptiste Daroussin.Ar miniperc
59061ba55bcSBaptiste Daroussinwith a value from 0 and 100 or negative to print a descriptive string: -1
59161ba55bcSBaptiste Daroussin.Dq Succeeded ,
59261ba55bcSBaptiste Daroussin-2
59361ba55bcSBaptiste Daroussin.Dq Failed ,
59461ba55bcSBaptiste Daroussin-3
59561ba55bcSBaptiste Daroussin.Dq Passed ,
59661ba55bcSBaptiste Daroussin-4
59761ba55bcSBaptiste Daroussin.Dq Completed ,
59861ba55bcSBaptiste Daroussin-5
59961ba55bcSBaptiste Daroussin.Dq Checked ,
60061ba55bcSBaptiste Daroussin-6
60161ba55bcSBaptiste Daroussin.Dq Done ,
60261ba55bcSBaptiste Daroussin-7
60361ba55bcSBaptiste Daroussin.Dq Skipped ,
60461ba55bcSBaptiste Daroussin-8
60561ba55bcSBaptiste Daroussin.Dq \&In Progress ,
60661ba55bcSBaptiste Daroussin-9
60761ba55bcSBaptiste Daroussinto hide
60861ba55bcSBaptiste Daroussin.Fa miniperc ,
60961ba55bcSBaptiste Daroussin-10
61061ba55bcSBaptiste Daroussin.Dq N/A ,
61161ba55bcSBaptiste Daroussin-11
61261ba55bcSBaptiste Daroussin.Dq Pending ,
61361ba55bcSBaptiste Daroussinotherwise
61461ba55bcSBaptiste Daroussin.Dq UNKNOWN .
61561ba55bcSBaptiste Daroussin.It Fl Fl msgbox Ar text Ar rows Ar cols
61661ba55bcSBaptiste DaroussinDialog to diplay a message without the
61761ba55bcSBaptiste Daroussin.Dq Cancel
61861ba55bcSBaptiste Daroussinbutton.
61961ba55bcSBaptiste Daroussin.It Fl Fl passwordbox Ar text Ar rows Ar cols Op Ar init
62061ba55bcSBaptiste DaroussinDialog to get a password,
62161ba55bcSBaptiste Daroussin.Ar init
62261ba55bcSBaptiste Daroussinis the default value.
62361ba55bcSBaptiste Daroussin.It Fl Fl passwordform Ar text Ar rows Ar cols Ar formrows Oo Ar label \
62461ba55bcSBaptiste DaroussinAr ylabel Ar xlabel Ar init Ar yfield Ar xfield  Ar fieldlen Ar maxletters \
62561ba55bcSBaptiste DaroussinOc ...
62661ba55bcSBaptiste DaroussinDialog to get a list of passwords, equivalent to
62761ba55bcSBaptiste Daroussin.Fl Fl form
62861ba55bcSBaptiste Daroussinexcept typed characters are hidden.
62961ba55bcSBaptiste Daroussin.It Fl Fl pause Ar text Ar rows Ar cols Ar seconds
63061ba55bcSBaptiste DaroussinDialog runs until
63161ba55bcSBaptiste Daroussin.Ar seconds
63261ba55bcSBaptiste Daroussintimeout expires or a button is pressed.
63361ba55bcSBaptiste Daroussin.It Fl Fl radiolist Ar text Ar rows Ar cols Ar menurows Oo Ar name Ar desc \
63461ba55bcSBaptiste DaroussinAr status Oc ...
63561ba55bcSBaptiste DaroussinRadiolist to select at most an item from a list via the SPACE key.
63661ba55bcSBaptiste DaroussinAn item has a
63761ba55bcSBaptiste Daroussin.Ar name ,
63861ba55bcSBaptiste Daroussin.Ar desc
63961ba55bcSBaptiste Daroussinand a default
64061ba55bcSBaptiste Daroussin.Ar status
64161ba55bcSBaptiste Daroussinspecified by
64261ba55bcSBaptiste Daroussin.Dq on
64361ba55bcSBaptiste Daroussinor
64461ba55bcSBaptiste Daroussin.Dq off .
64561ba55bcSBaptiste DaroussinThe name of the selected item is printed to standard error.
64661ba55bcSBaptiste Daroussin.Ar menurows
64761ba55bcSBaptiste Daroussinis the graphical height of the list, 0 for autosize.
64861ba55bcSBaptiste Daroussin.It Fl Fl rangebox Ar text Ar rows Ar cols Ar min Ar max Op Ar init
64961ba55bcSBaptiste DaroussinDialog to select a value between
65061ba55bcSBaptiste Daroussin.Ar min
65161ba55bcSBaptiste Daroussinand
65261ba55bcSBaptiste Daroussin.Ar max ,
65361ba55bcSBaptiste Daroussin.Ar init
654a6d8be45SAlfonso S. Sicilianois the default value.
65561ba55bcSBaptiste Daroussin.It Fl Fl textbox Ar file Ar rows Ar cols
65661ba55bcSBaptiste DaroussinOpens and prints
65761ba55bcSBaptiste Daroussin.Ar file .
658a6d8be45SAlfonso S. SicilianoTAB changes button.
659a6d8be45SAlfonso S. SicilianoExtra keys 0, h, l, k, j are available to navigate the text.
66061ba55bcSBaptiste Daroussin.Dq OK
66161ba55bcSBaptiste Daroussinbutton is renamed
66261ba55bcSBaptiste Daroussin.Dq EXIT .
66361ba55bcSBaptiste Daroussin.It Fl Fl timebox Ar text Ar rows Ar cols Op Ar hour Ar min Ar sec
66461ba55bcSBaptiste DaroussinDialog to select a time.
66561ba55bcSBaptiste Daroussin.It Fl Fl treeview Ar text Ar rows Ar cols Ar menurows Oo Ar depth Ar name \
66661ba55bcSBaptiste DaroussinAr desc Ar status Oc ...
66761ba55bcSBaptiste DaroussinEquivalent to Radiolist with
66861ba55bcSBaptiste Daroussin.Fl Fl  item-depth
66961ba55bcSBaptiste Daroussinand
67061ba55bcSBaptiste Daroussin.Fl Fl no-name .
67161ba55bcSBaptiste Daroussin.It Fl Fl yesno Ar text Ar rows Ar cols
67261ba55bcSBaptiste Daroussin.Dq Yes-No Question ,
67361ba55bcSBaptiste Daroussin.Dq OK
67461ba55bcSBaptiste Daroussinand
67561ba55bcSBaptiste Daroussin.Dq Cancel
67661ba55bcSBaptiste Daroussinbuttons are renamed
67761ba55bcSBaptiste Daroussin.Dq Yes
67861ba55bcSBaptiste Daroussinand
67961ba55bcSBaptiste Daroussin.Dq \&No .
68061ba55bcSBaptiste Daroussin.El
68161ba55bcSBaptiste Daroussin.Sh ENVIRONMENT
68261ba55bcSBaptiste DaroussinThe following environment variables take effect only on startup, other options
68361ba55bcSBaptiste Daroussincan override their setting.
68461ba55bcSBaptiste Daroussin.Bl -tag -width indent
68561ba55bcSBaptiste Daroussin.It Ev NO_COLOR
68661ba55bcSBaptiste DaroussinIf present and not an empty string (regardless of its value) equivalent to
68761ba55bcSBaptiste Daroussin.Fl Fl theme Ar blackwhite .
68861ba55bcSBaptiste Daroussin.It Ev BSDDIALOG_ERROR , Ev BSDDIALOG_OK , Ev BSDDIALOG_CANCEL , \
68961ba55bcSBaptiste DaroussinEv BSDDIALOG_HELP , Ev BSDDIALOG_EXTRA , Ev BSDDIALOG_TIMEOUT , \
69061ba55bcSBaptiste DaroussinEv BSDDIALOG_ESC , Ev BSDDIALOG_LEFT1 , Ev BSDDIALOG_LEFT2 , \
69161ba55bcSBaptiste DaroussinEv BSDDIALOG_LEFT3 , Ev BSDDIALOG_RIGHT1 , Ev BSDDIALOG_RIGHT2 , \
69261ba55bcSBaptiste DaroussinEv BSDDIALOG_RIGHT3
69361ba55bcSBaptiste DaroussinSet exit codes.
69461ba55bcSBaptiste Daroussin.It Ev BSDDIALOG_THEMEFILE Ar file
69561ba55bcSBaptiste DaroussinEquivalent to
69661ba55bcSBaptiste Daroussin.Fl Fl load-theme Ar file .
69761ba55bcSBaptiste Daroussin.El
69861ba55bcSBaptiste Daroussin.Sh FILES
69961ba55bcSBaptiste DaroussinThe theme file
70061ba55bcSBaptiste Daroussin.Pa $HOME/.bsddialog.conf
70161ba55bcSBaptiste Daroussinis read on startup if exists.
70261ba55bcSBaptiste Daroussin.Sh EXIT STATUS
70361ba55bcSBaptiste DaroussinThe
70461ba55bcSBaptiste Daroussin.Nm
70561ba55bcSBaptiste Daroussinutility exits 255 on unsuccessful, otherwise depending on the button or key
70661ba55bcSBaptiste Daroussinpressed the following values can be returned:
70761ba55bcSBaptiste Daroussin.Bl -column -compact
70861ba55bcSBaptiste Daroussin.It 0
70961ba55bcSBaptiste Daroussin.Dq OK ,
71061ba55bcSBaptiste Daroussin.Dq Yes
71161ba55bcSBaptiste Daroussinor
71261ba55bcSBaptiste Daroussin.Dq Exit
71361ba55bcSBaptiste Daroussinbutton.
71461ba55bcSBaptiste Daroussin.It 1
71561ba55bcSBaptiste Daroussin.Dq Cancel
71661ba55bcSBaptiste Daroussinor
71761ba55bcSBaptiste Daroussin.Dq \&No
71861ba55bcSBaptiste Daroussinbutton.
71961ba55bcSBaptiste Daroussin.It 2
72061ba55bcSBaptiste Daroussin.Dq Help
72161ba55bcSBaptiste Daroussinbutton.
72261ba55bcSBaptiste Daroussin.It 3
72361ba55bcSBaptiste Daroussin.Dq Extra
72461ba55bcSBaptiste Daroussinbutton.
72561ba55bcSBaptiste Daroussin.It 4
72661ba55bcSBaptiste DaroussinTimeout.
72761ba55bcSBaptiste Daroussin.It 5
72861ba55bcSBaptiste DaroussinESC key.
72961ba55bcSBaptiste Daroussin.It 6
73061ba55bcSBaptiste DaroussinLeft1 generic button.
73161ba55bcSBaptiste Daroussin.It 7
73261ba55bcSBaptiste DaroussinLeft2 generic button.
73361ba55bcSBaptiste Daroussin.It 8
73461ba55bcSBaptiste DaroussinLeft3 generic button.
73561ba55bcSBaptiste Daroussin.It 9
73661ba55bcSBaptiste DaroussinRight1 generic button.
73761ba55bcSBaptiste Daroussin.It 10
73861ba55bcSBaptiste DaroussinRight2 generic button.
73961ba55bcSBaptiste Daroussin.It 11
74061ba55bcSBaptiste DaroussinRight2 generic button.
74161ba55bcSBaptiste Daroussin.El
74261ba55bcSBaptiste Daroussin.Sh EXAMPLES
74361ba55bcSBaptiste DaroussinBacktitle, title and message:
74461ba55bcSBaptiste Daroussin.Dl bsddialog --backtitle MESSAGE --title Msgbox --msgbox Message 0 0
74561ba55bcSBaptiste Daroussin.Pp
74661ba55bcSBaptiste DaroussinYes-No Question and theme:
74761ba55bcSBaptiste Daroussin.Dl bsddialog --theme blackwhite --yesno Question 10 30
74861ba55bcSBaptiste Daroussin.Pp
74961ba55bcSBaptiste DaroussinSave a custom theme:
75061ba55bcSBaptiste Daroussin.Dl bsddialog --save-theme mytheme.txt --infobox \*qSaving theme...\*q 0 0
75161ba55bcSBaptiste Daroussin.Pp
75261ba55bcSBaptiste DaroussinLoad a custom theme:
75361ba55bcSBaptiste Daroussin.Dl bsddialog --load-theme mytheme.txt --infobox \*qCustom theme\*q 0 0
75461ba55bcSBaptiste Daroussin.Pp
75561ba55bcSBaptiste DaroussinChecklist:
75661ba55bcSBaptiste Daroussin.Dl bsddialog --checklist Checklist 0 0 3 N1 \&D1 off N2 D2 on N3 D3 off
75761ba55bcSBaptiste Daroussin.Pp
75861ba55bcSBaptiste DaroussinForm:
75961ba55bcSBaptiste Daroussin.Dl bsddialog --form Form 0 0 0 L1: 0 0 X 0 4 20 25 L2: 1 0 Y 1 4 20 25
76061ba55bcSBaptiste Daroussin.Pp
76161ba55bcSBaptiste DaroussinMulti-dialog:
76261ba55bcSBaptiste Daroussin.Dl bsddialog --normal-screen --begin-y 1 --yesno Continue? 0 0  \e \
76361ba55bcSBaptiste Daroussin--and-dialog --begin-y 10 --infobox Yes 0 0
76461ba55bcSBaptiste Daroussin.Pp
76561ba55bcSBaptiste DaroussinBikeshed:
76661ba55bcSBaptiste Daroussin.Dl bsddialog --bikeshed --inputbox Example 0 0
76761ba55bcSBaptiste Daroussin.Dl bsddialog --bikeshed --datebox Example 0 0
76861ba55bcSBaptiste Daroussin.Pp
76961ba55bcSBaptiste DaroussinMixedgauge:
77061ba55bcSBaptiste Daroussin.Dl bsddialog --sleep 3 --mixedgauge Example 10 30 60 L1 \*q -1\*q L2 30
77161ba55bcSBaptiste Daroussin.Pp
77261ba55bcSBaptiste DaroussinMixedgauge script:
77361ba55bcSBaptiste Daroussin.Bd -literal -offset indent -compact
77461ba55bcSBaptiste Daroussinperc=0
77561ba55bcSBaptiste Daroussinwhile [ $perc -le 100 ]
77661ba55bcSBaptiste Daroussindo
77761ba55bcSBaptiste Daroussin	bsddialog --sleep 1 --title Mixedgauge          \e
77861ba55bcSBaptiste Daroussin		--mixedgauge "\enExample...\en" 0 0 $perc \e
77961ba55bcSBaptiste Daroussin		"Hidden"   " -9"                        \e
78061ba55bcSBaptiste Daroussin		"Label 1"  " -4"                        \e
78161ba55bcSBaptiste Daroussin		"Label 2"  " -4"                        \e
78261ba55bcSBaptiste Daroussin		"Label 3"  $perc
78361ba55bcSBaptiste Daroussin
78461ba55bcSBaptiste Daroussin	perc=`expr $perc + 20`
78561ba55bcSBaptiste Daroussindone
78661ba55bcSBaptiste Daroussin.Ed
78761ba55bcSBaptiste Daroussin.Pp
78861ba55bcSBaptiste DaroussinGauge script:
78961ba55bcSBaptiste Daroussin.Bd -literal -offset indent -compact
79061ba55bcSBaptiste Daroussini=1
79161ba55bcSBaptiste Daroussinfor c in A B C D E F G H
79261ba55bcSBaptiste Daroussindo
79361ba55bcSBaptiste Daroussin	sleep 1
79461ba55bcSBaptiste Daroussin	echo XXX
79561ba55bcSBaptiste Daroussin	echo "$(expr $(expr $i "*" 100) "/" 8)"
79661ba55bcSBaptiste Daroussin	echo "[$i/8] Char: $c"
79761ba55bcSBaptiste Daroussin	echo XXX
79861ba55bcSBaptiste Daroussin	if [ $i -eq 8 ]
79961ba55bcSBaptiste Daroussin	then
80061ba55bcSBaptiste Daroussin		sleep 1
80161ba55bcSBaptiste Daroussin		echo EOF
80261ba55bcSBaptiste Daroussin	fi
80361ba55bcSBaptiste Daroussin	i=`expr $i + 1`
80461ba55bcSBaptiste Daroussindone | bsddialog --title Gauge --gauge "Starting..." 10 70
80561ba55bcSBaptiste Daroussin.Ed
80661ba55bcSBaptiste Daroussin.Sh COMPATIBILITY
80761ba55bcSBaptiste DaroussinOutdated options are retained for compatibility, properly equivalent options are
80861ba55bcSBaptiste Daroussinused:
80961ba55bcSBaptiste Daroussin.Bd -literal -offset indent -compact
81061ba55bcSBaptiste DaroussinObsolete                     Equivalent
81161ba55bcSBaptiste Daroussin--and-widget                 --and-dialog
81261ba55bcSBaptiste Daroussin--calendar <text> 2 <cols>   --calendar <text> 0 <cols>
81361ba55bcSBaptiste Daroussin--clear                      --clear-screen
81461ba55bcSBaptiste Daroussin--colors                     --text-escape
81561ba55bcSBaptiste Daroussin--defaultno                  --default-no
81661ba55bcSBaptiste Daroussin--exit-label                 --ok-label
81761ba55bcSBaptiste Daroussin--help-status                --help-print-items
81861ba55bcSBaptiste Daroussin--help-tags                  --help-print-name
81961ba55bcSBaptiste Daroussin--item-help                  --item-bottom-desc
82061ba55bcSBaptiste Daroussin--keep-tite                  --alternate-screen
82161ba55bcSBaptiste Daroussin--no-items                   --no-descriptions
82261ba55bcSBaptiste Daroussin--no-label                   --cancel-label
82361ba55bcSBaptiste Daroussin--no-tags                    --no-names
82461ba55bcSBaptiste Daroussin--nocancel                   --no-cancel
82561ba55bcSBaptiste Daroussin--nook                       --no-ok
82661ba55bcSBaptiste Daroussin--separator                  --output-separator
82761ba55bcSBaptiste Daroussin--yes-label                  --ok-label
82861ba55bcSBaptiste Daroussin.Ed
82961ba55bcSBaptiste Daroussin.Sh SEE ALSO
83061ba55bcSBaptiste Daroussin.Xr bsddialog 3 ,
83161ba55bcSBaptiste Daroussin.Xr strftime 3 ,
83261ba55bcSBaptiste Daroussin.Xr terminfo 5
83361ba55bcSBaptiste Daroussin.Sh HISTORY
83461ba55bcSBaptiste DaroussinThe
83561ba55bcSBaptiste Daroussin.Nm bsddialog
83661ba55bcSBaptiste Daroussinutility first appeared in
83761ba55bcSBaptiste Daroussin.Fx 14.0 .
83861ba55bcSBaptiste Daroussin.Sh AUTHORS
83961ba55bcSBaptiste Daroussin.Nm bsddialog
84061ba55bcSBaptiste Daroussinwas written by
84161ba55bcSBaptiste Daroussin.An Alfonso Sabato Siciliano
84261ba55bcSBaptiste Daroussin.Aq Mt asiciliano@FreeBSD.org .
84361ba55bcSBaptiste Daroussin.Pp
84461ba55bcSBaptiste Daroussin.Nm bsddialog
84561ba55bcSBaptiste Daroussinprovides also a subset of the functionality described in the
84661ba55bcSBaptiste Daroussin.Nm dialog
84761ba55bcSBaptiste Daroussinmanual.
84861ba55bcSBaptiste DaroussinThe following features were reimplemented:
84961ba55bcSBaptiste Daroussin.Pp
85061ba55bcSBaptiste DaroussinOptions:
85161ba55bcSBaptiste Daroussin.Fl Fl and-widget ,
85261ba55bcSBaptiste Daroussin.Fl Fl ascii-lines ,
85361ba55bcSBaptiste Daroussin.Fl Fl backtitle ,
85461ba55bcSBaptiste Daroussin.Fl Fl cancel-label ,
85561ba55bcSBaptiste Daroussin.Fl Fl clear ,
85661ba55bcSBaptiste Daroussin.Fl Fl colors ,
85761ba55bcSBaptiste Daroussin.Fl Fl cr-wrap ,
85861ba55bcSBaptiste Daroussin.Fl Fl date-format ,
85961ba55bcSBaptiste Daroussin.Fl Fl defaultno ,
86061ba55bcSBaptiste Daroussin.Fl Fl default-button ,
86161ba55bcSBaptiste Daroussin.Fl Fl default-no ,
86261ba55bcSBaptiste Daroussin.Fl Fl default-item ,
86361ba55bcSBaptiste Daroussin.Fl Fl exit-label ,
86461ba55bcSBaptiste Daroussin.Fl Fl extra-button ,
86561ba55bcSBaptiste Daroussin.Fl Fl extra-label ,
86661ba55bcSBaptiste Daroussin.Fl Fl help ,
86761ba55bcSBaptiste Daroussin.Fl Fl help-button ,
86861ba55bcSBaptiste Daroussin.Fl Fl help-label ,
86961ba55bcSBaptiste Daroussin.Fl Fl help-status ,
87061ba55bcSBaptiste Daroussin.Fl Fl help-tags ,
87161ba55bcSBaptiste Daroussin.Fl Fl hfile ,
87261ba55bcSBaptiste Daroussin.Fl Fl hline ,
87361ba55bcSBaptiste Daroussin.Fl Fl ignore ,
87461ba55bcSBaptiste Daroussin.Fl Fl insecure ,
87561ba55bcSBaptiste Daroussin.Fl Fl item-help ,
87661ba55bcSBaptiste Daroussin.Fl Fl keep-tite ,
87761ba55bcSBaptiste Daroussin.Fl Fl max-input ,
87861ba55bcSBaptiste Daroussin.Fl Fl no-cancel ,
87961ba55bcSBaptiste Daroussin.Fl Fl nocancel ,
88061ba55bcSBaptiste Daroussin.Fl Fl no-items ,
88161ba55bcSBaptiste Daroussin.Fl Fl no-label ,
88261ba55bcSBaptiste Daroussin.Fl Fl no-lines ,
88361ba55bcSBaptiste Daroussin.Fl Fl no-ok ,
88461ba55bcSBaptiste Daroussin.Fl Fl nook ,
88561ba55bcSBaptiste Daroussin.Fl Fl no-shadow ,
88661ba55bcSBaptiste Daroussin.Fl Fl no-tags ,
88761ba55bcSBaptiste Daroussin.Fl Fl ok-label ,
88861ba55bcSBaptiste Daroussin.Fl Fl output-fd ,
88961ba55bcSBaptiste Daroussin.Fl Fl output-separator ,
89061ba55bcSBaptiste Daroussin.Fl Fl print-maxsize ,
89161ba55bcSBaptiste Daroussin.Fl Fl print-size ,
89261ba55bcSBaptiste Daroussin.Fl Fl print-version ,
89361ba55bcSBaptiste Daroussin.Fl Fl quoted ,
89461ba55bcSBaptiste Daroussin.Fl Fl separate-output ,
89561ba55bcSBaptiste Daroussin.Fl Fl separator ,
89661ba55bcSBaptiste Daroussin.Fl Fl shadow ,
89761ba55bcSBaptiste Daroussin.Fl Fl single-quoted ,
89861ba55bcSBaptiste Daroussin.Fl Fl sleep ,
89961ba55bcSBaptiste Daroussin.Fl Fl stderr ,
90061ba55bcSBaptiste Daroussin.Fl Fl stdout ,
90161ba55bcSBaptiste Daroussin.Fl Fl tab-len ,
90261ba55bcSBaptiste Daroussin.Fl Fl time-format ,
90361ba55bcSBaptiste Daroussin.Fl Fl title ,
90461ba55bcSBaptiste Daroussin.Fl Fl version ,
90561ba55bcSBaptiste Daroussin.Fl Fl yes-label .
90661ba55bcSBaptiste Daroussin.Pp
907a6d8be45SAlfonso S. SicilianoKeys: Ctrl-l, F1.
908a6d8be45SAlfonso S. Siciliano.Pp
90961ba55bcSBaptiste DaroussinDialogs:
91061ba55bcSBaptiste Daroussin.Fl Fl calendar ,
91161ba55bcSBaptiste Daroussin.Fl Fl checklist ,
91261ba55bcSBaptiste Daroussin.Fl Fl form ,
91361ba55bcSBaptiste Daroussin.Fl Fl gauge ,
91461ba55bcSBaptiste Daroussin.Fl Fl infobox ,
91561ba55bcSBaptiste Daroussin.Fl Fl inputbox ,
91661ba55bcSBaptiste Daroussin.Fl Fl menu ,
91761ba55bcSBaptiste Daroussin.Fl Fl mixedform ,
91861ba55bcSBaptiste Daroussin.Fl Fl mixedgauge ,
91961ba55bcSBaptiste Daroussin.Fl Fl msgbox ,
92061ba55bcSBaptiste Daroussin.Fl Fl passwordbox ,
92161ba55bcSBaptiste Daroussin.Fl Fl passwordform ,
92261ba55bcSBaptiste Daroussin.Fl Fl pause ,
92361ba55bcSBaptiste Daroussin.Fl Fl radiolist ,
92461ba55bcSBaptiste Daroussin.Fl Fl rangebox ,
92561ba55bcSBaptiste Daroussin.Fl Fl textbox ,
92661ba55bcSBaptiste Daroussin.Fl Fl timebox ,
92761ba55bcSBaptiste Daroussin.Fl Fl treeview ,
92861ba55bcSBaptiste Daroussin.Fl Fl yesno .
92961ba55bcSBaptiste Daroussin.Pp
93061ba55bcSBaptiste DaroussinSome feature differs in input, output, or behavior.
93161ba55bcSBaptiste DaroussinCompatibility is not a priority for future development.
93261ba55bcSBaptiste Daroussin.Sh THANKS TO
93361ba55bcSBaptiste Daroussin.An Baptiste Daroussin
93461ba55bcSBaptiste Daroussin.Aq Mt bapt@FreeBSD.org ,
93561ba55bcSBaptiste Daroussin.An \&Ed Maste
93661ba55bcSBaptiste Daroussin.Aq Mt emaste@FreeBSD.org ,
93761ba55bcSBaptiste Daroussin.An Juraj Lutter
93861ba55bcSBaptiste Daroussin.Aq Mt otis@FreeBSD.org
93961ba55bcSBaptiste Daroussinand
94061ba55bcSBaptiste Daroussin.An Trenton Schulz
94161ba55bcSBaptiste Daroussinfor suggestions, help, and testing.
942