Zenity enables you to create the following types of simple dialogue:
Calendar
File selection
List
Notification icon
Message
Progress
Text entry
Text information
When you write scripts, you can use Zenity to create simple dialogues that interact graphically with the user, as follows:
When the user closes the dialogue, Zenity prints the text produced by the dialogue to standard error.
When you write Zenity commands, ensure that you place quotation marks around each argument.
For example, use:
zenity --calendar --title="Holiday Planner"zenity --calendar --title=Holiday PlannerIf you do not use quotation marks, you might get unexpected results.
An access key is a key that enables you to perform an action from the keyboard rather than use the mouse to choose a command from a menu or dialogue. Each access key is identified by an underlined letter on a menu or dialogue option.
Some Zenity dialogues support the use of access keys. To specify the character to use as the access key, place an underscore before that character in the text of the dialogue. The following example shows how to specify the letter 'C' as the access key:
"_Choose a name".Zenity returns the following exit codes:
| Exit Code | Description |
|---|---|
| 0 | The user has pressed either OK or Close. |
| 1 | The user has either pressed Cancel, or used the window functions to close the dialogue. |
| -1 | An unexpected error has occurred. |
All Zenity dialogues support the following general options:
Specifies the title of a dialogue.
Specifies the icon that is displayed in the window frame of the dialogue. There are 4 stock icons also available by providing the following keywords - 'info', 'warning', 'question' and 'error'.
Specifies the width of the dialogue.
Specifies the height of the dialogue.
Zenity provides the following help options:
Displays shortened help text.
Displays full help text for all dialogues.
Displays help text for general dialogue options.
Displays help text for calendar dialogue options.
Displays help text for text entry dialogue options.
Displays help text for error dialogue options.
Displays help text for information dialogue options.
Displays help text for file selection dialogue options.
Displays help text for list dialogue options.
Displays help text for notification icon options.
Displays help text for progress dialogue options.
Displays help text for question dialogue options.
Displays help text for warning dialogue options.
Displays help for text information dialogue options.
Displays help for miscellaneous options.
Displays help for GTK+ options.
Use the --calendar option to create a calendar dialogue. Zenity returns the selected date to standard error. If no date is specified on the command line, the dialogue uses the current date.
The calendar dialogue supports the following options:
Specifies the text that is displayed in the calendar dialogue.
Specifies the day that is selected in the calendar dialogue. day must be a number between 1 and 31 inclusive.
Specifies the month that is selected in the calendar dialogue. month must be a number between 1 and 12 inclusive.
Specifies the year that is selected in the calendar dialogue.
Specifies the format that is returned from the calendar dialogue after date selection. The default format depends on your locale. format must be a format that is acceptable to the strftime function, for example %A %d/%m/%y.
The following example script shows how to create a calendar dialogue:
#!/bin/sh
if zenity --calendar \
--title="Select a Date" \
--text="Click on a date to select that date." \
--day=10 --month=8 --year=2004
then echo $?
else echo "No date selected"
fi
Use the --file-selection option to create a file selection dialogue. Zenity returns the selected files or directories to standard error. The default mode of the file selection dialogue is open.
The file selection dialogue supports the following options:
Specifies the file or directory that is selected in the file selection dialogue when the dialogue is first shown.
Allows the selection of multiple filenames in the file selection dialogue.
Allows only selection of directories in the file selection dialogue.
Set the file selection dialogue into save mode.
Specifies the string that is used to divide the returned list of filenames.
The following example script shows how to create a file selection dialogue:
#!/bin/sh
FILE=`zenity --file-selection --title="Select a File"`
case $? in
0)
echo "\"$FILE\" selected.";;
1)
echo "No file selected.";;
-1)
echo "No file selected.";;
esac
Specifies the text that is displayed in the notification area.
The following example script shows how to create a notification icon:
#!/bin/sh
zenity --notification\
--window-icon="info" \
--text="There are system updates necessary!"
Use the --list option to create a list dialogue. Zenity returns the entries in the first column of text of selected rows to standard error.
Data for the dialogue must specified column by column, row by row. Data can be provided to the dialogue through standard input. Each entry must be separated by a newline character.
If you use the --checklist or --radiolist options, each row must start with either 'TRUE' or 'FALSE'.
The list dialogue supports the following options:
Specifies the column headers that are displayed in the list dialogue. You must specify a --column option for each column that you want to display in the dialogue.
Specifies that the first column in the list dialogue contains check boxes.
Specifies that the first column in the list dialogue contains radio boxes.
Allows the displayed items to be edited.
Specifies what string is used when the list dialogue returns the selected entries.
Specifies what column should be printed out upon selection. The default column is '1'. 'ALL' can be used to print out all columns in the list.
The following example script shows how to create a list dialogue:
#!/bin/sh
zenity --list \
--title="Choose the Bugs You Wish to View" \
--column="Bug Number" --column="Severity" --column="Description" \
992383 Normal "GtkTreeView crashes on multiple selections" \
293823 High "GNOME Dictionary does not handle proxy" \
393823 Critical "Menu editing does not work in GNOME 2.0"
Zenity can create four types of message dialogue:
For each type, use the --text option to specify the text that is displayed in the dialogue.
Use the --error option to create an error dialogue.
The following example script shows how to create an error dialogue:
#!/bin/bash
zenity --error \
--text="Could not find /var/log/syslog."
Use the --info option to create an information dialogue.
The following example script shows how to create an information dialogue:
#!/bin/bash
zenity --info \
--text="Merge complete. Updated 3 of 10 files."
Use the --progress option to create a progress dialogue.
Zenity reads data from standard input line by line. If a line is prefixed with #, the text is updated with the text on that line. If a line contains only a number, the percentage is updated with that number.
The progress dialogue supports the following options:
Specifies the text that is displayed in the progress dialogue.
Specifies the initial percentage that is set in the progress dialogue.
Closes the progress dialogue when 100% has been reached.
Specifies that the progress bar pulsates until an EOF character is read from standard input.
The following example script shows how to create a progress dialogue:
#!/bin/sh
(
echo "10" ; sleep 1
echo "# Updating mail logs" ; sleep 1
echo "20" ; sleep 1
echo "# Resetting cron jobs" ; sleep 1
echo "50" ; sleep 1
echo "This line will just be ignored" ; sleep 1
echo "75" ; sleep 1
echo "# Rebooting system" ; sleep 1
echo "100" ; sleep 1
) |
zenity --progress \
--title="Update System Logs" \
--text="Scanning mail logs..." \
--percentage=0
if [ "$?" = -1 ] ; then
zenity --error \
--text="Update cancelled."
fi
Use the -entry option to create a text entry dialogue. Zenity returns the contents of the text entry to standard error.
The text entry dialogue supports the following options:
Specifies the text that is displayed in the text entry dialogue.
Specifies the text that is displayed in the entry field of the text entry dialogue.
Hides the text in the entry field of the text entry dialogue.
The following example script shows how to create a text entry dialogue:
#!/bin/sh
if zenity --entry \
--title="Add an Entry" \
--text="Enter your _password:" \
--entry-text "password" \
--hide-text
then echo $?
else echo "No password entered"
fi
Use the --text-info option to create a text information dialogue.
The text information dialogue supports the following options:
Specifies a file that is loaded in the text information dialogue.
Allows the displayed text to be edited. The edited text is returned to standard error when the dialogue is closed.
The following example script shows how to create a text information dialogue:
#!/bin/sh
FILE=`zenity --file-selection \
--title="Select a File"`
case $? in
0)
zenity --text-info \
--title=$FILE \
--filename=$FILE \
--editable 2>/tmp/tmp.txt;;
1)
echo "No file selected.";;
-1)
echo "No file selected.";;
esac