Zenity

Zenity Desktop Application Manual V2.0

1. Introduction

Zenity enables you to create the following types of simple dialog:

  • Calendar

  • File selection

  • List

  • Notification icon

  • Message

    • Error
    • Information
    • Question
    • Warning
  • Progress

  • Text entry

  • Text information

2. Usage

When you write scripts, you can use Zenity to create simple dialogs that interact graphically with the user, as follows:

  • You can create a dialog to obtain information from the user. For example, you can prompt the user to select a date from a calendar dialog, or to select a file from a file selection dialog.
  • You can create a dialog to provide the user with information. For example, you can use a progress dialog to indicate the current status of an operation, or use a warning message dialog to alert the user.

When the user closes the dialog, Zenity prints the text produced by the dialog 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"
Do not use:
zenity --calendar --title=Holiday Planner

If you do not use quotation marks, you might get unexpected results.

2.1. Access Keys

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 dialog. Each access key is identified by an underlined letter on a menu or dialog option.

Some Zenity dialogs 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 dialog. The following example shows how to specify the letter 'C' as the access key:

"_Choose a name".

2.2. Exit Codes

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 dialog.
-1 An unexpected error has occurred.

2.3. General Options

All Zenity dialogs support the following general options:

--title=title

Specifies the title of a dialog.

--window-icon=icon_path

Specifies the icon that is displayed in the window frame of the dialog. There are 4 stock icons also available by providing the following keywords - 'info', 'warning', 'question' and 'error'.

--width=width

Specifies the width of the dialog.

--height=height

Specifies the height of the dialog.

2.4. Help Options

Zenity provides the following help options:

--help

Displays shortened help text.

--help-all

Displays full help text for all dialogs.

--help-general

Displays help text for general dialog options.

--help-calendar

Displays help text for calendar dialog options.

--help-entry

Displays help text for text entry dialog options.

--help-error

Displays help text for error dialog options.

--help-info

Displays help text for information dialog options.

--help-file-selection

Displays help text for file selection dialog options.

--help-list

Displays help text for list dialog options.

--help-notification

Displays help text for notification icon options.

--help-progress

Displays help text for progress dialog options.

--help-question

Displays help text for question dialog options.

--help-warning

Displays help text for warning dialog options.

--help-text-info

Displays help for text information dialog options.

--help-misc

Displays help for miscellaneous options.

--help-gtk

Displays help for GTK+ options.

2.5. Miscellaneous Options

Zenity also provides the following miscellaneous options:

--about

Displays the About Zenity dialog, which contains Zenity version information, copyright information, and developer information.

--version

Displays the version number of Zenity.

2.6. GTK+ Options

Zenity supports the standard GTK+ options. For more information about the GTK+ options, execute the zenity -? command.

3. Calendar Dialog

Use the --calendar option to create a calendar dialog. Zenity returns the selected date to standard error. If no date is specified on the command line, the dialog uses the current date.

The calendar dialog supports the following options:

--text=text

Specifies the text that is displayed in the calendar dialog.

--day=day

Specifies the day that is selected in the calendar dialog. day must be a number between 1 and 31 inclusive.

--month=month

Specifies the month that is selected in the calendar dialog. month must be a number between 1 and 12 inclusive.

--year=year

Specifies the year that is selected in the calendar dialog.

--date-format=format

Specifies the format that is returned from the calendar dialog 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 dialog:

        #!/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
      

Figure 1Calendar Dialog Example

4. File Selection Dialog

Use the --file-selection option to create a file selection dialog. Zenity returns the selected files or directories to standard error. The default mode of the file selection dialog is open.

The file selection dialog supports the following options:

--filename=filename

Specifies the file or directory that is selected in the file selection dialog when the dialog is first shown.

--multiple

Allows the selection of multiple filenames in the file selection dialog.

--directory

Allows only selection of directories in the file selection dialog.

--save

Set the file selection dialog into save mode.

--separator=separator

Specifies the string that is used to divide the returned list of filenames.

The following example script shows how to create a file selection dialog:

        #!/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
      

Figure 2File Selection Dialog Example

5. Notification Icon

--text=text

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!"
      

Figure 3Notification Icon Example

6. List Dialog

Use the --list option to create a list dialog. Zenity returns the entries in the first column of text of selected rows to standard error.

Data for the dialog must specified column by column, row by row. Data can be provided to the dialog 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 dialog supports the following options:

--column=column

Specifies the column headers that are displayed in the list dialog. You must specify a --column option for each column that you want to display in the dialog.

--checklist

Specifies that the first column in the list dialog contains check boxes.

--radiolist

Specifies that the first column in the list dialog contains radio boxes.

--editable

Allows the displayed items to be edited.

--separator=separator

Specifies what string is used when the list dialog returns the selected entries.

--print-column=column

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 dialog:

        #!/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"
      

Figure 4List Dialog Example

7. Message Dialogs

Zenity can create four types of message dialog:

  • Error
  • Information
  • Question
  • Warning

For each type, use the --text option to specify the text that is displayed in the dialog.

7.1. Error Dialog

Use the --error option to create an error dialog.

The following example script shows how to create an error dialog:

          #!/bin/bash

          zenity --error \
          --text="Could not find /var/log/syslog."
        

Figure 5Error Dialog Example

7.2. Information Dialog

Use the --info option to create an information dialog.

The following example script shows how to create an information dialog:

          #!/bin/bash

          zenity --info \
          --text="Merge complete. Updated 3 of 10 files."
        

Figure 6Information Dialog Example

7.3. Question Dialog

Use the --question option to create a question dialog.

The following example script shows how to create a question dialog:

          #!/bin/bash

          zenity --question \
          --text="Are you sure you wish to proceed?"
        

Figure 7Question Dialog Example

7.4. Warning Dialog

Use the --warning option to create a warning dialog.

The following example script shows how to create a warning dialog:

          #!/bin/bash
        
          zenity --warning \
          --text="Disconnect the power cable to avoid electrical shock."
        

Figure 8Warning Dialog Example

8. Progress Dialog

Use the --progress option to create a progress dialog.

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 dialog supports the following options:

--text=text

Specifies the text that is displayed in the progress dialog.

--percentage=percentage

Specifies the initial percentage that is set in the progress dialog.

--auto-close

Closes the progress dialog when 100% has been reached.

--pulsate

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 dialog:

        #!/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 canceled."
        fi

      

Figure 9Progress Dialog Example

9. Text Entry Dialog

Use the -entry option to create a text entry dialog. Zenity returns the contents of the text entry to standard error.

The text entry dialog supports the following options:

--text=text

Specifies the text that is displayed in the text entry dialog.

--entry-text=text

Specifies the text that is displayed in the entry field of the text entry dialog.

--hide-text

Hides the text in the entry field of the text entry dialog.

The following example script shows how to create a text entry dialog:

        #!/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
      

Figure 10Text Entry Dialog Example

10. Text Information Dialog

Use the --text-info option to create a text information dialog.

The text information dialog supports the following options:

--filename=filename

Specifies a file that is loaded in the text information dialog.

--editable

Allows the displayed text to be edited. The edited text is returned to standard error when the dialog is closed.

The following example script shows how to create a text information dialog:

        #!/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
      

Figure 11Text Information Dialog Example