02955ce70f
2004-04-29 Glynn Foster <glynn.foster@sun.com> * src/main.c, src/tree.c: Fix the list dialog not being able to handle --text to change the text. It was also intentional but must have fallen through the gaps. * data/zenity.1: Update * help/C/zenity.xml: Update.
918 lines
24 KiB
XML
918 lines
24 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
|
<!ENTITY legal SYSTEM "legal.xml">
|
|
<!ENTITY version "1.0">
|
|
<!ENTITY app "<application>Zenity</application>">
|
|
]>
|
|
|
|
<!-- ================ Document Header ================= -->
|
|
|
|
<article id="index" lang="en">
|
|
|
|
<articleinfo>
|
|
<title>Zenity Manual</title>
|
|
<copyright>
|
|
<year>2003</year>
|
|
<holder>Sun Microsystems</holder>
|
|
</copyright>
|
|
|
|
<!-- Translators: uncomment this
|
|
<copyright>
|
|
<year>2003</year>
|
|
<holder>ME_THE_TRANSLATOR</holder>
|
|
</copyright>
|
|
-->
|
|
|
|
<publisher>
|
|
<publishername>GNOME Documentation Project</publishername>
|
|
</publisher>
|
|
|
|
<releaseinfo>Version 1.0 of Zenity Manual</releaseinfo>
|
|
|
|
<legalnotice id="feedback">
|
|
<title>Feedback Information</title>
|
|
<para>
|
|
To report a bug or make a suggestion regarding this
|
|
application or this documentation, please see the
|
|
<ulink type="help" url="ghelp:gnome-feedback">
|
|
GNOME Feedback Page
|
|
</ulink>
|
|
</para>
|
|
</legalnotice>
|
|
|
|
<authorgroup>
|
|
<author>
|
|
<firstname>Glynn</firstname>
|
|
<surname>Foster</surname>
|
|
<affiliation>
|
|
<orgname>GNOME Documentation Project</orgname>
|
|
</affiliation>
|
|
</author>
|
|
<editor>
|
|
<firstname>Nicholas</firstname>
|
|
<surname>Curran</surname>
|
|
<affiliation>
|
|
<orgname>GNOME Documentation Project</orgname>
|
|
</affiliation>
|
|
</editor>
|
|
</authorgroup>
|
|
|
|
<revhistory>
|
|
<revision>
|
|
<revnumber>1.0</revnumber>
|
|
<date>18-01-2003</date>
|
|
<revdescription>
|
|
<para role="author">Glynn Foster</para>
|
|
<para role="publisher">
|
|
GNOME Documentation Project
|
|
</para>
|
|
</revdescription>
|
|
</revision>
|
|
</revhistory>
|
|
</articleinfo>
|
|
|
|
<!-- ================ Document Body ================= -->
|
|
|
|
<!-- ==== Introduction ====== -->
|
|
|
|
<sect1 id="zenity-introduction">
|
|
<title>Introduction</title>
|
|
|
|
<para>
|
|
&app; displays simple GNOME dialogs.
|
|
</para>
|
|
|
|
<para>
|
|
&app; can display the following dialogs:
|
|
</para>
|
|
|
|
<itemizedlist>
|
|
<listitem><para>
|
|
<link linkend="zenity-calendar-options">Calendar dialog.</link>
|
|
</para></listitem>
|
|
<listitem><para>
|
|
<link linkend="zenity-text-entry-options">Text entry dialog.</link>
|
|
</para></listitem>
|
|
<listitem><para>Various message dialogs including:</para>
|
|
<itemizedlist>
|
|
<listitem><para>
|
|
<link linkend="zenity-error-dialog">Error dialog.</link>
|
|
</para></listitem>
|
|
<listitem><para>
|
|
<link linkend="zenity-info-dialog">Information dialog.</link>
|
|
</para></listitem>
|
|
<listitem><para>
|
|
<link linkend="zenity-question-dialog">Question dialog.</link>
|
|
</para></listitem>
|
|
<listitem><para>
|
|
<link linkend="zenity-warning-dialog">Warning dialog.</link>
|
|
</para></listitem>
|
|
</itemizedlist>
|
|
</listitem>
|
|
<listitem><para>
|
|
<link linkend="zenity-file-selection-options">File selection dialog.</link>
|
|
</para></listitem>
|
|
<listitem><para>
|
|
<link linkend="zenity-list-options">List options dialog.</link>
|
|
</para></listitem>
|
|
<listitem><para>
|
|
<link linkend="zenity-progress-options">Progress dialog.</link>
|
|
</para></listitem>
|
|
<listitem><para>
|
|
<link linkend="zenity-text-options">Text dialog.</link>
|
|
</para></listitem>
|
|
</itemizedlist>
|
|
|
|
</sect1>
|
|
|
|
<!-- ==== General Options ====== -->
|
|
<sect1 id="zenity-basic-use">
|
|
<title>Basic Use</title>
|
|
|
|
<para>
|
|
&app; creates simple dialogs. You can use &app; to create a script that
|
|
interacts graphically with the user.
|
|
</para>
|
|
|
|
<para>
|
|
When the user closes the dialog,
|
|
&app; prints text produced by the dialog to standard error.
|
|
</para>
|
|
|
|
<para>
|
|
Ensure that all arguments to &app; are surrounded by quotes. For example, use
|
|
<command>zenity --calendar --title="Holiday Planner"</command> instead of
|
|
<command>zenity --calendar --title=Holiday Planner</command>.
|
|
If you do not use quotes, you can get unexpected results.
|
|
</para>
|
|
|
|
<note>
|
|
<title>NOTE</title>
|
|
<para>
|
|
Some dialogs support the use of keyboard mnemonics. To specify the character to use as
|
|
the mnemonic, place an underscore before that character in the text of the dialog. For
|
|
example, to specify the 'P' as the keyboard mnemonic in the following sentence, use
|
|
"_Please choose a name".
|
|
</para>
|
|
</note>
|
|
|
|
<para>
|
|
&app; returns the following exit codes:
|
|
</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term><varname>0</varname></term>
|
|
<listitem>
|
|
<para>The user has pressed either 'OK' or 'Close'.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>1</varname></term>
|
|
<listitem>
|
|
<para>The user has pressed either 'Cancel' or closed the dialog through the window functions.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>-1</varname></term>
|
|
<listitem>
|
|
<para>An unexpected error has occurred.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect1>
|
|
|
|
<!-- ==== General Options ====== -->
|
|
|
|
<sect1 id="zenity-general-options">
|
|
<title>General Options</title>
|
|
|
|
<para>
|
|
All dialogs have the following general options:
|
|
</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term><varname>--title</varname>=TITLE</term>
|
|
<listitem>
|
|
<para>Specifies the title of a dialog.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--window-icon</varname>=ICON_PATH</term>
|
|
<listitem>
|
|
<para>Specifies the icon that should appear in the window frame of the dialog.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--width</varname>=WIDTH</term>
|
|
<listitem>
|
|
<para>Specifies the width of the dialog.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--height</varname>=HEIGHT</term>
|
|
<listitem>
|
|
<para>Specifies the height of the dialog.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect1>
|
|
|
|
<!-- ==== Calendar Options ====== -->
|
|
|
|
<sect1 id="zenity-calendar-options">
|
|
<title>Calendar Dialog</title>
|
|
|
|
<para>
|
|
Use <command>--calendar</command> to create a Calendar dialog. &app; returns the
|
|
date selected to standad error. The current date will be used by the dialog if
|
|
no date is given on the command line.
|
|
</para>
|
|
<para>
|
|
The Calendar dialog has the following options:
|
|
</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term><varname>--text</varname>=TEXT</term>
|
|
<listitem>
|
|
<para>Specifies the text to appear in the Calendar dialog.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--day</varname>=DAY</term>
|
|
<listitem>
|
|
<para>Specifies the day to be pre-selected in the Calendar dialog. The day
|
|
ust be a number between 1 and 31.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--month</varname>=MONTH</term>
|
|
<listitem>
|
|
<para>Specifies the day to be pre-selected in the Calendar dialog. The day must be
|
|
a number between 1 and 12.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--year</varname>=YEAR</term>
|
|
<listitem>
|
|
<para>Specifies the year to be pre-selected in the Calendar dialog.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--date-format</varname>=FORMAT</term>
|
|
<listitem>
|
|
<para>Specifies the format to be returned from the Calendar dialog after
|
|
the selection has been made. The default format depends
|
|
on your locale. The format must be of <command>strftime</command>
|
|
style, for example "%A %d/%m%y".
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
<para>
|
|
The following script is an example of how to use the Calendar dialog:
|
|
|
|
<programlisting>
|
|
#!/bin/sh
|
|
|
|
if zenity --calendar --title="Calendar selection" --text="Select a date from below" --day=18 --month=1 --year=2003
|
|
then echo $?
|
|
else echo "No date selected"
|
|
fi
|
|
</programlisting>
|
|
</para>
|
|
|
|
<figure id="zenity-calendar-screenshot">
|
|
<title>Calendar dialog example</title>
|
|
<screenshot>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="figures/zenity-calendar-screenshot.png" format="PNG"/>
|
|
</imageobject>
|
|
<textobject>
|
|
<phrase>&app; Calendar dialog example</phrase>
|
|
</textobject>
|
|
</mediaobject>
|
|
</screenshot>
|
|
</figure>
|
|
|
|
</sect1>
|
|
|
|
<!-- ==== Text Entry Options ====== -->
|
|
|
|
<sect1 id="zenity-text-entry-options">
|
|
<title>Text Entry Dialog</title>
|
|
|
|
<para>
|
|
Use <command>--text-entry</command> to create a Text Entry dialog.
|
|
&app; returns the
|
|
contents of the text entry to standard error.
|
|
</para>
|
|
<para>
|
|
The Text Entry dialog has the following options:
|
|
</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term><varname>--text</varname>=TEXT</term>
|
|
<listitem>
|
|
<para>Specifies the text to appear in the Text Entry dialog.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--entry-text</varname>=TEXT</term>
|
|
<listitem>
|
|
<para>Specifies the text to appear in the entry field of the Text Entry dialog.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--hide-text</varname></term>
|
|
<listitem>
|
|
<para>Specifies that the text in the entry field of the Text Entry dialog be hidden.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
<para>
|
|
The following script is an example of how to use the Text Entry dialog:
|
|
|
|
<programlisting>
|
|
#!/bin/sh
|
|
|
|
if zenity --entry --title="Add a new entry" --text="Enter your _Password" --hide-text
|
|
then echo $?
|
|
else echo "No password entered"
|
|
fi
|
|
</programlisting>
|
|
</para>
|
|
|
|
<figure id="zenity-entry-screenshot">
|
|
<title>Text Entry dialog example</title>
|
|
<screenshot>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="figures/zenity-entry-screenshot.png" format="PNG"/>
|
|
</imageobject>
|
|
<textobject>
|
|
<phrase>&app; Text Entry dialog example</phrase>
|
|
</textobject>
|
|
</mediaobject>
|
|
</screenshot>
|
|
</figure>
|
|
</sect1>
|
|
|
|
<!-- ==== Message Options ====== -->
|
|
|
|
<sect1 id="zenity-message-options">
|
|
<title>Message Dialogs</title>
|
|
|
|
<para>
|
|
&app; can create four types of message dialog.
|
|
Use the <command>--text</command> option to set the text shown in the
|
|
dialog.
|
|
</para>
|
|
<sect2 id="zenity-warning-dialog">
|
|
<title>Warning Dialog</title>
|
|
|
|
<para>
|
|
Use <command>--warning</command> to create a Warning dialog.
|
|
</para>
|
|
|
|
<para>
|
|
The following script is an example of how to use the Warning message dialog:
|
|
|
|
<programlisting>
|
|
#!/bin/bash
|
|
|
|
FILE_TYPE=$(file -b $NAUTILUS_SCRIPT_SELECTED_FILE_PATHS|awk '{ print $1}')
|
|
|
|
if [ "$FILE_TYPE" != "PNG" ]; then
|
|
zenity --warning --text="Could not rotate image :" --hide-text
|
|
fi
|
|
</programlisting>
|
|
</para>
|
|
|
|
<figure id="zenity-warning-screenshot">
|
|
<title>Warning dialog example</title>
|
|
<screenshot>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="figures/zenity-warning-screenshot.png" format="PNG"/>
|
|
</imageobject>
|
|
<textobject>
|
|
<phrase>&app; Warning dialog example</phrase>
|
|
</textobject>
|
|
</mediaobject>
|
|
</screenshot>
|
|
</figure>
|
|
</sect2>
|
|
|
|
<sect2 id="zenity-error-dialog">
|
|
<title>Error Dialog</title>
|
|
|
|
<para>
|
|
Use <command>--error</command> to create an Error dialog.
|
|
</para>
|
|
|
|
<figure id="zenity-error-screenshot">
|
|
<title>Error dialog example</title>
|
|
<screenshot>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="figures/zenity-error-screenshot.png" format="PNG"/>
|
|
</imageobject>
|
|
<textobject>
|
|
<phrase>&app; Error dialog example</phrase>
|
|
</textobject>
|
|
</mediaobject>
|
|
</screenshot>
|
|
</figure>
|
|
</sect2>
|
|
|
|
<sect2 id="zenity-info-dialog">
|
|
<title>Information Dialog</title>
|
|
|
|
<para>
|
|
Use <command>--info</command> to create an Information dialog.
|
|
</para>
|
|
|
|
<figure id="zenity-information-screenshot">
|
|
<title>Informational dialog example</title>
|
|
<screenshot>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="figures/zenity-information-screenshot.png" format="PNG"/>
|
|
</imageobject>
|
|
<textobject>
|
|
<phrase>&app; Informational dialog example</phrase>
|
|
</textobject>
|
|
</mediaobject>
|
|
</screenshot>
|
|
</figure>
|
|
</sect2>
|
|
|
|
<sect2 id="zenity-question-dialog">
|
|
<title>Question Dialog</title>
|
|
|
|
<para>
|
|
Use <command>--question</command> to create a Question dialog.
|
|
</para>
|
|
|
|
<figure id="zenity-question-screenshot">
|
|
<title>Question dialog example</title>
|
|
<screenshot>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="figures/zenity-question-screenshot.png" format="PNG"/>
|
|
</imageobject>
|
|
<textobject>
|
|
<phrase>&app; Question dialog example</phrase>
|
|
</textobject>
|
|
</mediaobject>
|
|
</screenshot>
|
|
</figure>
|
|
</sect2>
|
|
|
|
</sect1>
|
|
|
|
<!-- ==== File Selection Options ====== -->
|
|
|
|
<sect1 id="zenity-file-selection-options">
|
|
<title>File Selection Dialog</title>
|
|
|
|
<para>
|
|
Use <command>--file-selection</command> to create a file selection
|
|
dialog. &app; returns
|
|
the files or directories selected to standard error.
|
|
</para>
|
|
<para>
|
|
The File Selection dialog has the following options:
|
|
</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term><varname>--filename</varname>=FILENAME</term>
|
|
<listitem>
|
|
<para>Specifies the file or directory to be selected in the File Selection dialog
|
|
when the dialog is first shown.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--multiple</varname></term>
|
|
<listitem>
|
|
<para>Allows selection of multiple filenames in the File Selection dialog.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--separator</varname>=SEPARATOR</term>
|
|
<listitem>
|
|
<para>Specifies the string used to divide the returned list of filenames.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
<para>
|
|
The following script is an example of how to use the File Selection dialog:
|
|
|
|
<programlisting>
|
|
#!/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
|
|
</programlisting>
|
|
</para>
|
|
|
|
<figure id="zenity-fileselection-screenshot">
|
|
<title>File Selection dialog example</title>
|
|
<screenshot>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="figures/zenity-fileselection-screenshot.png" format="PNG"/>
|
|
</imageobject>
|
|
<textobject>
|
|
<phrase>&app; File Selection dialog example</phrase>
|
|
</textobject>
|
|
</mediaobject>
|
|
</screenshot>
|
|
</figure>
|
|
|
|
</sect1>
|
|
|
|
<!-- ==== List Options ====== -->
|
|
|
|
<sect1 id="zenity-list-options">
|
|
<title>List Dialog</title>
|
|
|
|
<para>
|
|
Use <command>--list</command> to create a list dialog. &app; returns the entries in
|
|
the first column of text of selected rows to standard error.
|
|
</para>
|
|
|
|
<para>
|
|
Every column must be specified by the <command>--column</command> option. 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.
|
|
</para>
|
|
|
|
<para>
|
|
If you use the <command>--checklist</command> or <command>--radiolist</command>
|
|
options, each row must start with either 'TRUE' or 'FALSE'.
|
|
</para>
|
|
|
|
<para>
|
|
The List dialog has the following options:
|
|
</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term><varname>--text</varname>=TEXT</term>
|
|
<listitem>
|
|
<para>Specifies the text to appear in the List dialog.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--column</varname>=COLUMN</term>
|
|
<listitem>
|
|
<para>Specifies the column headers to appear in the List dialog.
|
|
You must call the <command>--column</command> option for
|
|
each column you want to appear in the dialog.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--checklist</varname></term>
|
|
<listitem>
|
|
<para>Specifies that the first column should contain check boxes in the List dialog.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--radiolist</varname></term>
|
|
<listitem>
|
|
<para>Specifies that the first column should contain radio boxes in the List dialog.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--editable</varname></term>
|
|
<listitem>
|
|
<para>Allows the displayed items to be edited.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--seperator</varname>=SEPERATOR</term>
|
|
<listitem>
|
|
<para>Specifies what string should be used when the List dialog returns the selected entries.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
<para>
|
|
The following commandline is an example of how to use the List dialog:
|
|
<programlisting>
|
|
zenity --list --title="Choose bugs you wish to view" \
|
|
--text="Select items from the list below." \
|
|
--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"
|
|
</programlisting>
|
|
</para>
|
|
|
|
<figure id="zenity-list-screenshot">
|
|
<title>List Selection dialog example</title>
|
|
<screenshot>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="figures/zenity-list-screenshot.png" format="PNG"/>
|
|
</imageobject>
|
|
<textobject>
|
|
<phrase>&app; List dialog example</phrase>
|
|
</textobject>
|
|
</mediaobject>
|
|
</screenshot>
|
|
</figure>
|
|
|
|
</sect1>
|
|
|
|
<!-- ==== Progress Options ====== -->
|
|
|
|
<sect1 id="zenity-progress-options">
|
|
<title>Progress Dialog</title>
|
|
|
|
<para>
|
|
Use <command>--progress</command> to create a Progress dialog.
|
|
</para>
|
|
|
|
<para>
|
|
&app; reads data from
|
|
standard input line by line. If a line is prefixed with a hash (#), the text is
|
|
updated with the text on that line. If a line contains only a number, the percentage
|
|
is updated with that number.
|
|
</para>
|
|
|
|
<para>
|
|
The Progress dialog has the following options:
|
|
</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term><varname>--text</varname>=TEXT</term>
|
|
<listitem>
|
|
<para>Specifies the text to appear in the Progress dialog.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--percentage</varname>=PERCENTAGE</term>
|
|
<listitem>
|
|
<para>Specifies the initial percentage that should be set in the Progress dialog.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--auto-close</varname></term>
|
|
<listitem>
|
|
<para>Closes the progress dialog when 100% has been reached.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--pulsate</varname></term>
|
|
<listitem>
|
|
<para>Specifies that the Progress dialog should pulsate until an EOF character is read
|
|
from standard input.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
<para>
|
|
The following script is an example of how to use the Progress dialog:
|
|
<programlisting>
|
|
#!/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
|
|
</programlisting>
|
|
</para>
|
|
|
|
<figure id="zenity-progress-screenshot">
|
|
<title>Progress dialog example</title>
|
|
<screenshot>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="figures/zenity-progress-screenshot.png" format="PNG"/>
|
|
</imageobject>
|
|
<textobject>
|
|
<phrase>&app; Progress dialog example</phrase>
|
|
</textobject>
|
|
</mediaobject>
|
|
</screenshot>
|
|
</figure>
|
|
|
|
</sect1>
|
|
|
|
<!-- ==== Text Information Options ====== -->
|
|
|
|
<sect1 id="zenity-text-options">
|
|
<title>Text Information Dialog</title>
|
|
|
|
<para>
|
|
Use <command>--text-info</command> to create a Text Information dialog.
|
|
</para>
|
|
|
|
<para>
|
|
The Text Information dialog has the following options:
|
|
</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term><varname>--filename</varname>=FILENAME</term>
|
|
<listitem>
|
|
<para>Specifies a file to be loaded in the Text Information dialog.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--editable</varname></term>
|
|
<listitem>
|
|
<para>Allows the displayed text to be edited. The edited text is
|
|
returned to standard error when the dialog is closed.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
<para>
|
|
The following script is an example of how to use the Text Infomation dialog:
|
|
<programlisting>
|
|
#!/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
|
|
</programlisting>
|
|
</para>
|
|
|
|
<figure id="zenity-text-screenshot">
|
|
<title>Text Information dialog example</title>
|
|
<screenshot>
|
|
<mediaobject>
|
|
<imageobject>
|
|
<imagedata fileref="figures/zenity-text-screenshot.png" format="PNG"/>
|
|
</imageobject>
|
|
<textobject>
|
|
<phrase>&app; Text Information dialog example</phrase>
|
|
</textobject>
|
|
</mediaobject>
|
|
</screenshot>
|
|
</figure>
|
|
|
|
</sect1>
|
|
|
|
<!-- ==== Miscellaneous Options ====== -->
|
|
|
|
<sect1 id="zenity-miscellaneous-options">
|
|
<title>Miscellaneous Options</title>
|
|
|
|
<para>
|
|
&app; has the following miscellaneous options:
|
|
</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term><varname>--about</varname></term>
|
|
<listitem>
|
|
<para>Displays some information about &app;.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--version</varname></term>
|
|
<listitem>
|
|
<para>Prints the version number of &app;.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect1>
|
|
|
|
<!-- ================ Application License ================= -->
|
|
<sect1 id="license">
|
|
<title>License</title>
|
|
<para>
|
|
This program is free software; you can redistribute
|
|
it and/or modify it under the terms of the
|
|
<ulink type="help" url="gnome-help:gpl">
|
|
<citetitle>GNU General Public License</citetitle>
|
|
</ulink>
|
|
as published by the Free Software Foundation; either
|
|
version 2 of the License, of (at your option) any later
|
|
version.
|
|
</para>
|
|
<para>
|
|
This program is distributed in the hope that it will be
|
|
useful, but WITHOUT ANY WARRANTY; without even the
|
|
implied warranty of MERCHANTABILITY or FITNESS FOR A
|
|
PARTICULAR PURPOSE. See the
|
|
<citetitle>GNU General Public License</citetitle>
|
|
for more details.
|
|
</para>
|
|
<para>
|
|
A copy of the
|
|
<citetitle>GNU General Public License</citetitle>
|
|
is included as an appendix to the
|
|
<citetitle>GNOME Users Guide</citetitle>
|
|
. You may also obtain a copy of the
|
|
<citetitle>GNU General Public License</citetitle>
|
|
from the Free Software Foundation by visiting
|
|
<ulink type="http" url="http://www.fsf.org">
|
|
their Web site
|
|
</ulink>
|
|
or by writing to
|
|
<address>Free Software Foundation, Inc.
|
|
<street>59 Temple Place</street> - Suite 330
|
|
<city>Boston</city>,
|
|
<state>MA</state>
|
|
<postcode>02111-1307</postcode>
|
|
<country>USA</country>
|
|
</address>
|
|
</para>
|
|
</sect1>
|
|
|
|
</article>
|