Differences between version 2 and predecessor to the previous major change of gdialog(1).
Other diffs: Previous Revision, Previous Author, or view the Annotated Edit History
| Newer page: | version 2 | Last edited on Sunday, November 17, 2002 5:36:50 pm | by CraigBox | Revert |
| Older page: | version 1 | Last edited on Tuesday, June 4, 2002 12:22:04 am | by perry | Revert |
@@ -1,316 +1,96 @@
-gdialog
!!!gdialog
-NAME
-SYNOPSIS
-DESCRIPTION
-OPTIONS
-RUN-TIME CONFIGURATION
-ENVIROMENT
-FILES
-DIAGNOSTICS
-BUGS
-AUTHOR
-SEE ALSO
+
----
!!NAME
-
-
gdialog - display dialog boxes from shell scripts
+
!!SYNOPSIS
+__gdialog --clear %%%
+gdialog --create-rc__ ''file''__ %%%
+gdialog__ [[ __--title__ ''title'' ] [[ %%% __--backtitle__ ''backtitle'' ] [[ __--clear__ ] [[__--separate-output__ ] __box-options__
-__gdialog --clear
-gdialog --create-rc__ ''file''__
-gdialog__ [[ __--title__ ''title'' ] [[
-__--backtitle__ ''backtitle'' ] [[ __--clear__ ] [[
-__--separate-output__ ] __box-options__
!!DESCRIPTION
+__Gdialog__ is a program that will let you to present a variety of questions or display messages using dialog boxes from a shell script. Currently, these types of dialog boxes are implemented:
-__Gdialog__ is a program that will let you to present a
-variety of questions or display messages using dialog boxes
-from a shell script. Currently, these types of dialog boxes
-are implemented:
-
-
-
-
+__yes/no__ box, __menu__ box, __input__ box, __message__ box, __text__ box, __info__ box, __checklist__ box, __radiolist__ box __gauge__ box,
and __password__ box.
-This program is much like the dialog program, but along with
-
-
-
-
+This program is much like the dialog program, but along with displaying textual dialog boxes if the environment variable DISPLAY is unset, if the environment variable is set it will instead display graphical dialog boxes using gtk/gnome.
+
!!OPTIONS
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+;
__--clear__ :
The screen will be cleared to the __screen attribute__ on exit.
+;
__--create-rc__ ''file'' :
Since __gdialog__ supports run-time configuration, this can be used to dump a sample configuration file to the file specified by ''file''.
+;
__--separate-output__ :
For checklist widgets, output result one line at a time, with no quoting. This facilitates parsing by another program.
+;
__--title__ ''title'' :
Specifies a ''title'' string to be displayed at the top of the dialog box.
+;
__--backtitle__ ''backtitle'' :
Specifies a ''backtitle'' string to be displayed on the backdrop, at the top of the screen.
__Box Options__
-__--yesno__ ''text height width''
+;
__--yesno__ ''text height width'' : A __yes/no__ dialog box of size ''height'' rows by ''width'' columns will be displayed. The string specified by ''text'' is displayed inside the dialog box. If this string is too long to be fitted in one line, it will be automatically divided into multiple lines at appropriate places. The ''text'' string may also contain the sub-string '''' or newline characters ''`n'' to control line breaking explicitly. This dialog box is useful for asking questions that require the user to answer either yes or no. The dialog box has a __Yes__ button and a __No__ button, in which the user can switch between by pressing the ''TAB'' key.
+; __--msgbox__ ''text height width'' : A __message__ box is very similar to a __yes/no__ box. The only difference between a __message__ box and a
+__yes/no__ box is that a __message__ box has only a single __OK__ button. You can use this dialog box to display any message you like. After reading the message, the user can press the ''ENTER'' key so that __dialog__ will exit and the calling shell script can continue its operation.
-A
__yes/no
__ dialog box of size
''height'' rows by
-''
width'' columns will be displayed. The string specified
-by ''text''
is displayed inside the dialog
box. If
this
-string is too long to be fitted in one line
, it
will be
-automatically divided into multiple lines at appropriate
-places. The ''text'' string may also contain
the
-sub-string '''' or newline characters
-''`n''
to control line breaking explicitly. This dialog
-box is useful for asking questions that require
the user to
-answer either yes or no
. The dialog box has a
__Yes
__
-button and a __No__ button
, in which
the user can switch
-between by pressing the ''TAB'' key
.
+;
__--infobox
__ ''text
height width'' : An __info__ box
is basically a __message__
box. However, in
this case
, __dialog__
will exit immediately
+after displaying
the message
to the user. The screen is not cleared when
__dialog
__ exits
, so that the message will remain on the screen until the calling shell script clears it later. This is useful when you want to inform
the user
+that some operations are carrying on that may require some time to finish
.
+; __--inputbox__ ''text height width [[init]'' : An __input__ box is useful when you want to ask questions that require the user to input a string as the answer. If init is supplied it is used to initialize the input string. When inputing the string, the ''BACKSPACE'' key can be used to correct typing errors. If the input string is longer than can be fitted in the dialog box, the input field will be scrolled. On exit, the input string will be printed on ''stderr''.
-__--msgbox
__ ''text height width''
+;
__--passwordbox
__ ''text height width [[init]'' : A __password__ box is similar to an input box, except the text the user enters is not displayed. This is useful when prompting for passwords or other sensitive information. Be aware that if anything is passed in ''... somethings missing here
''
+; __--textbox__ ''file height width'' : A __text__ box lets you display the contents of a text file in a dialog box. It is like a simple text file viewer. The user can move through the file by using the ''UP/DOWN'', ''PGUP/PGDN'' and ''HOME/END'' keys available on most keyboards. If the lines are too long to be displayed in the box, the ''LEFT/RIGHT'' keys can be used to scroll the text region horizontally. For more convenience, forward and backward searching functions are also provided.
-A
__message
__ box is very similar to a __yes/no__ box
.
-The only difference between
a __message
__ box and
a
-__yes/no__
box is
that a __message__ box has only
a
-single __OK__ button
. You can use this dialog box
to
-display any message you like
. After reading
the message,
the
-press
the ''ENTER
'' key so
that __dialog__
-will exit and
the calling shell script can continue its
-operation
.
+;
__--menu
__ ''text height width menu-height'' [[ ''tag item'' ] ''
...'' : As its name suggests,
a __menu
__ box is
a dialog
box that can be used to present
a list of choices in the form of
a menu for the user to choose
. Each menu entry consists of a ''tag'' string and an ''item'' string. The ''tag'' gives the entry a name
to distinguish it from the other entries in the menu
. The ''item'' is a short description of
the option that
the entry represents. The
user can move between the menu entries by pressing
the ''UP/DOWN
'' keys, the first letter of the ''tag'' as a hot-
key, or the number keys ''1-9''. There are ''menu-height'' entries displayed in the menu at one time, but the menu will be scrolled if there are more entries than
that. When
__dialog__ exits,
the ''tag'' of the chosen menu entry will be printed on ''stderr''
.
-
-__--infobox__ ''text height width''
-
-
-An __info__ box is basically a __message__ box.
-However, in this case, __dialog__ will exit immediately
-after displaying the message to the user. The screen is not
-cleared when __dialog__ exits, so that the message will
-remain on the screen until the calling shell script clears
-it later. This is useful when you want to inform the user
-that some operations are carrying on that may require some
-time to finish.
-
-
-__--inputbox__ ''text height width
-[[init]''
-
-
-An __input__ box is useful when you want to ask questions
-that require the user to input a string as the answer. If
-init is supplied it is used to initialize the input string.
-When inputing the string, the ''BACKSPACE'' key can be
-used to correct typing errors. If the input string is longer
-than can be fitted in the dialog box, the input field will
-be scrolled. On exit, the input string will be printed on
-''stderr''.
-
-
-__--passwordbox__ ''text height width
-[[init]''
-
-
-A __password__ box is similar to an input box, except the
-text the user enters is not displayed. This is useful when
-prompting for passwords or other sensitive information. Be
-aware that if anything is passed in
-__
-
-
-__--textbox__ ''file height width''
-
-
-A __text__ box lets you display the contents of a text
-file in a dialog box. It is like a simple text file viewer.
-The user can move through the file by using the
-''UP/DOWN'', ''PGUP/PGDN'' and ''HOME/END'' keys
-available on most keyboards. If the lines are too long to be
-displayed in the box, the ''LEFT/RIGHT'' keys can be used
-to scroll the text region horizontally. For more
-convenience, forward and backward searching functions are
-also provided.
-
-
-__--menu__ ''text height width menu-height'' [[ ''tag
-item'' ] ''...''
-
-
-As its name suggests, a __menu__ box is a dialog box that
-can be used to present a list of choices in the form of a
-menu for the user to choose. Each menu entry consists of a
-''tag'' string and an ''item'' string. The ''tag''
-gives the entry a name to distinguish it from the other
-entries in the menu. The ''item'' is a short description
-of the option that the entry represents. The user can move
-between the menu entries by pressing the ''UP/DOWN''
-keys, the first letter of the ''tag'' as a hot-key, or
-the number keys ''1-9''. There are ''menu-height''
-entries displayed in the menu at one time, but the menu will
-be scrolled if there are more entries than that. When
-__dialog__ exits, the ''tag'' of the chosen menu entry
-will be printed on ''stderr''.
-
-
-
-
-
-
-
-that there are multiple entries presented in the form of a
-
-
-
-
+;
__--checklist__ ''text height width list-height'' [[''tag item status'' ] ''...'' :
A __checklist__ box is similar to a __menu__ box in
+that there are multiple entries presented in the form of a menu. Instead of choosing one entry among the entries, each entry can be turned on or off by the user. The initial on/off state of each entry is specified by ''status''. On exit, a list of the ''tag'' strings of those entries that
are turned on will be printed on ''stderr''.
+; __--radiolist__ ''text height width list-height'' [[ ''tag item status'' ] ''...'' : A __radiolist__ box is similar to a __menu__ box. The
+only difference is that you can indicate which entry is currently selected, by setting its ''status'' to ''on''.
-__--radiolist
__ ''text height width list-height
'' [[
-''tag item status'' ] ''...''
-
-
-radiolist
__ box is similar to
a __menu__
box. The
-only difference
is that you can indicate which entry
is
-currently selected
, by setting its ''status''
to
-''
on''
.
-
-
-__--gauge__ ''text height width percent''
-
+;
__--gauge
__ ''text height width percent
'' :
A __gauge
__ box displays
a meter along the bottom of the
box. The meter indicates the percentage. New percentages are read from standard input, one integer per line. The meter
is updated to reflect each new percentage. If stdin
is XXX
, then subsequent lines up
to another XXX are used for a new prompt. The gauge exits when EOF is reached
on stdin
.
-A __gauge__ box displays a meter along the bottom of the
-box. The meter indicates the percentage. New percentages are
-read from standard input, one integer per line. The meter is
-updated to reflect each new percentage. If stdin is XXX,
-then subsequent lines up to another XXX are used for a new
-prompt. The gauge exits when EOF is reached on
-stdin.
!!RUN-TIME CONFIGURATION
+1. Create a sample configuration file by typing:
+2. At start, __dialog__ determines the settings to use as follows:
+a) if environment variable __DIALOGRC__ is set, it's value determines the name of the configuration file.
+b) if the file in (a) can't be found, use the file ''$HOME/.dialogrc'' as the configuration file.
+c) if the file in (b) can't be found, use compiled in defaults.
+3. Edit the sample configuration file and copy it to some place that __dialog__ can find, as stated in step 2 above.
-1.
-
-
-Create a sample configuration file by typing:
-
-
-
-
-2.
-
-
-At start, __dialog__ determines the settings to use as
-follows:
-
-
-a)
-
-
-if environment variable __DIALOGRC__ is set, it's value
-determines the name of the configuration file.
-
-
-b)
-
-
-if the file in (a) can't be found, use the file
-''$HOME/.dialogrc'' as the configuration
-file.
-
-
-c)
-
-
-if the file in (b) can't be found, use compiled in
-defaults.
-
-
-3.
-
-
-Edit the sample configuration file and copy it to some place
-that __dialog__ can find, as stated in step 2
-above.
!!ENVIROMENT
+; __DIALOGRC__ : Define this variable if you want to specify the name of the configuration file to use.
-__DIALOGRC__
-
-
-Define this variable if you want to specify the name of the
-configuration file to use.
!!FILES
+; ''$HOME/.dialogrc'' : default configuration file
-''$HOME/.dialogrc''
-
-
-default configuration file
!!DIAGNOSTICS
+Exit status is 0 if __dialog__ is exited by pressing the __Yes__ or __OK__ button, and 1 if the __No__ or __Cancel__ button is pressed. Otherwise, if errors occur inside __dialog__ or __dialog__ is exited by pressing the ''ESC'' key, the exit status is -1.
-Exit status is 0 if __dialog__ is exited by pressing the
-__Yes__ or __OK__ button, and 1 if the __No__ or
-__Cancel__ button is pressed. Otherwise, if errors occur
-inside __dialog__ or __dialog__ is exited by pressing
-the ''ESC'' key, the exit status is -1.
!!BUGS
+Text files containing ''tab'' characters may cause problems with __text__ box. ''Tab'' characters in text files must first be expanded to spaces before being displayed by __text__ box.
-Text files containing ''tab'' characters may cause
-problems with __text__ box. ''Tab'' characters in text
-files must first be expanded to spaces before being
-displayed by __text__ box
.
+Screen update is too slow
.
-
-Screen update is too slow.
!!AUTHOR
-
Savio Lam (lam836@cs.cuhk.hk) - version 0.3
+Stuart Herbert (S.Herbert@sheffield.ac.uk) - patch for version 0.4
-
-Stuart Herbert (S.Herbert@sheffield.ac.uk) - patch for
-version 0.4
!!SEE ALSO
-
-__
whiptail (1)__
-----
+dialog(1), whiptail(1)
