minecraft-pi-reborn/zenity
Archived
1
0
Fork 0
Code Pull Requests Activity

Documentation updates from Nicholas Curran. Add Nicholas.

Browse Source 
2003-09-01  Glynn Foster  <glynn.foster@sun.com>

	* help/C/zenity.xml: Documentation updates from Nicholas Curran.
	* THANKS, src/about.c: Add Nicholas.
This commit is contained in:
Glynn Foster 2003-09-01 08:27:59 +00:00 committed by Glynn Foster
parent c7e13aff2a
commit 751d9a7bec
4 changed files with 328 additions and 332 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
2003-09-01 Glynn Foster <glynn.foster@sun.com>
* help/C/zenity.xml: Documentation updates from Nicholas Curran.
* THANKS, src/about.c: Add Nicholas.
2003-08-27 Glynn Foster <glynn.foster@sun.com> 2003-08-27 Glynn Foster <glynn.foster@sun.com>
* src/tree.c: Put horizontal scrolling on automatic, otherwise * src/tree.c: Put horizontal scrolling on automatic, otherwise

1
THANKS
View File

@ -2,6 +2,7 @@ These are all the people that I've taken code from:
Jonathan Blandford <jrb@redhat.com> Jonathan Blandford <jrb@redhat.com>
Ross Burton <ross@burtonini.com> Ross Burton <ross@burtonini.com>
Anders Carlsson <andersca@codefactory.se> Anders Carlsson <andersca@codefactory.se>
Nicholas Curran <quasar@austar.net.au>
John Fleck <jfleck@inkstain.net> John Fleck <jfleck@inkstain.net>
James Henstridge <james@daa.com.au> James Henstridge <james@daa.com.au>
Mihai T. Lazarescu <mihai@email.it> Mihai T. Lazarescu <mihai@email.it>

623
help/C/zenity.xml
View File

@ -3,7 +3,7 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY legal SYSTEM "legal.xml"> <!ENTITY legal SYSTEM "legal.xml">
<!ENTITY version "1.0"> <!ENTITY version "1.0">
<!ENTITY app "<application>zenity</application>"> <!ENTITY app "<application>Zenity</application>">
]> ]>
<!-- ================ Document Header ================= --> <!-- ================ Document Header ================= -->
@ -49,6 +49,13 @@
<orgname>GNOME Documentation Project</orgname> <orgname>GNOME Documentation Project</orgname>
</affiliation> </affiliation>
</author> </author>
<editor>
<firstname>Nicholas</firstname>
<surname>Curran</surname>
<affiliation>
<orgname>GNOME Documentation Project</orgname>
</affiliation>
</editor>
</authorgroup> </authorgroup>
<revhistory> <revhistory>
@ -73,87 +80,49 @@
<title>Introduction</title> <title>Introduction</title>
<para> <para>
&app; allows allows you to display simple dialogs from the &app; displays simple GNOME dialogs.
command line or from shell scripts.
</para> </para>
<para> <para>
The following list of dialogs are available with &app;: &app; can display the following dialogs:
</para> </para>
<variablelist> <itemizedlist>
<listitem><para>
<varlistentry> <link linkend="zenity-calendar-options">Calender dialog.</link>
<term><varname>--calendar</varname></term> </para></listitem>
<listitem> <listitem><para>
<para>Display a Calendar dialog.</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>
</varlistentry> <listitem><para>
<link linkend="zenity-file-selection-options">File selection dialog.</link>
<varlistentry> </para></listitem>
<term><varname>--entry</varname></term> <listitem><para>
<listitem> <link linkend="zenity-list-options">List options dialog.</link>
<para>Display a Text Entry dialog.</para> </para></listitem>
</listitem> <listitem><para>
</varlistentry> <link linkend="zenity-progress-options">Progress dialog.</link>
</para></listitem>
<varlistentry> <listitem><para>
<term><varname>--error</varname></term> <link linkend="zenity-text-options">Text dialog.</link>
<listitem> </para></listitem>
<para>Display an Error dialog.</para> </itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--info</varname></term>
<listitem>
<para>Display an Informational dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--file-selection</varname></term>
<listitem>
<para>Display a File Selection dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--list</varname></term>
<listitem>
<para>Display a List dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--progress</varname></term>
<listitem>
<para>Display a Progress dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--question</varname></term>
<listitem>
<para>Display a Question dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--text-info</varname></term>
<listitem>
<para>Display a Text Information dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>--warning</varname></term>
<listitem>
<para>Display a Warning dialog.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1> </sect1>
@ -162,28 +131,34 @@
<title>Basic Use</title> <title>Basic Use</title>
<para> <para>
&app; can only be used to create relatively simple dialogs, but is especially useful &app; creates simple dialogs. You can use &app; to create a script that
when used in scripts. When a user has completed an action requested of them, and the interacts graphically with the user.
dialog closes, &app; prints any text specific to the dialog to standard error and
an exit code is returned. Information about what text is printed to standard error will be
detailed in the individual dialog sections.
</para> </para>
<para> <para>
When using &app;, make sure that any arguments to the command line options are surrounded by When the user closes the dialog,
a set of quotes ' ' or " " as in <command>&app; --calendar --title="Holiday Planner" &app; prints text produced by the dialog to standard error.
</command>, for example. If you do not use quotes, then it is likely that you will get
unexpected results.
</para> </para>
<para> <para>
For some of the dialogs, &app; supports the use of keyboard mnemonics. This allows you to Ensure that all arguments to &app; are surrounded by quotes. For example, use
use an '_' before the letter you want the mnemonic for, as in "_Please choose a name:", for <command>zenity --calender --title="Holiday Planner"</command> instead of
example. <command>zenity --calender --title=Holiday Planner</command>.
If you do not use quotes, you can get unexpected results.
</para> </para>
<note>
<title>NOTE</title>
<para> <para>
The following exit codes are observed by &app;: 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> </para>
<variablelist> <variablelist>
@ -219,13 +194,7 @@
<title>General Options</title> <title>General Options</title>
<para> <para>
Each dialog shares some general command line options. If these All dialogs have the following general options:
are not provided, there are some default values that depend on
the type of dialog being displayed.
</para>
<para>
The following list of general options are available:
</para> </para>
<variablelist> <variablelist>
@ -233,28 +202,28 @@
<varlistentry> <varlistentry>
<term><varname>--title</varname>=TITLE</term> <term><varname>--title</varname>=TITLE</term>
<listitem> <listitem>
<para>Specify the title of a dialog.</para> <para>Specifies the title of a dialog.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>--window-icon</varname>=ICON_PATH</term> <term><varname>--window-icon</varname>=ICON_PATH</term>
<listitem> <listitem>
<para>Specify the icon that should appear in the window frame of the dialog.</para> <para>Specifies the icon that should appear in the window frame of the dialog.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>--width</varname>=WIDTH</term> <term><varname>--width</varname>=WIDTH</term>
<listitem> <listitem>
<para>Specify the width of the dialog.</para> <para>Specifies the width of the dialog.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>--height</varname>=HEIGHT</term> <term><varname>--height</varname>=HEIGHT</term>
<listitem> <listitem>
<para>Specify the height of the dialog.</para> <para>Specifies the height of the dialog.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -265,15 +234,15 @@
<!-- ==== Calendar Options ====== --> <!-- ==== Calendar Options ====== -->
<sect1 id="zenity-calendar-options"> <sect1 id="zenity-calendar-options">
<title>Calendar</title> <title>Calendar Dialog</title>
<para> <para>
To create a Calendar dialog, use <command>--calendar</command>. &app; will return the Use <command>--calender</command> to create a Calender dialog. &app; returns the
date selected to standard error. If the day, month and year are not specified at the date selected to standad error. The current date will be used by the dialog if
command line, &app; will pre-select the current date in the Calendar dialog. no date is given on the command line.
</para> </para>
<para> <para>
The following list of options are available for the Calendar dialog: The Calender dialog has the following options:
</para> </para>
<variablelist> <variablelist>
@ -281,15 +250,15 @@
<varlistentry> <varlistentry>
<term><varname>--text</varname>=TEXT</term> <term><varname>--text</varname>=TEXT</term>
<listitem> <listitem>
<para>Specify the text to appear in the Calendar dialog.</para> <para>Specifies the text to appear in the Calendar dialog.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>--day</varname>=DAY</term> <term><varname>--day</varname>=DAY</term>
<listitem> <listitem>
<para>Specify the day to be pre-selected in the Calendar dialog. This must be a <para>Specifies the day to be pre-selected in the Calendar dialog. The day
number between 1 and 31. ust be a number between 1 and 31.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -297,7 +266,7 @@
<varlistentry> <varlistentry>
<term><varname>--month</varname>=MONTH</term> <term><varname>--month</varname>=MONTH</term>
<listitem> <listitem>
<para>Specify the day to be pre-selected in the Calendar dialog. This must be <para>Specifies the day to be pre-selected in the Calendar dialog. The day must be
a number between 1 and 12. a number between 1 and 12.
</para> </para>
</listitem> </listitem>
@ -306,22 +275,36 @@
<varlistentry> <varlistentry>
<term><varname>--year</varname>=YEAR</term> <term><varname>--year</varname>=YEAR</term>
<listitem> <listitem>
<para>Specify the year to be pre-selected in the Calendar dialog.</para> <para>Specifies the year to be pre-selected in the Calendar dialog.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>--date-format</varname>=FORMAT</term> <term><varname>--date-format</varname>=FORMAT</term>
<listitem> <listitem>
<para>Specify the format to be returned from the Calendar dialog after <para>Specifies the format to be returned from the Calendar dialog after
the selection has been made. This defaults to a format depending the selection has been made. The default format depends
on your locale. The format must be of <command>strftime</command> on your locale. The format must be of <command>strftime</command>
style eg. "%A %d/%m%y"</para> style, for example "%A %d/%m%y".
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </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"> <figure id="zenity-calendar-screenshot">
<title>Calendar dialog example</title> <title>Calendar dialog example</title>
<screenshot> <screenshot>
@ -336,33 +319,20 @@
</screenshot> </screenshot>
</figure> </figure>
<para>
The following script shows 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>
</sect1> </sect1>
<!-- ==== Text Entry Options ====== --> <!-- ==== Text Entry Options ====== -->
<sect1 id="zenity-text-entry-options"> <sect1 id="zenity-text-entry-options">
<title>Text Entry</title> <title>Text Entry Dialog</title>
<para> <para>
To create a Text Entry dialog, use <command>--text-entry</command>. &app; returns the Use <command>--text-entry</command> to create a Text Entry dialog.
&app; returns the
contents of the text entry to standard error. contents of the text entry to standard error.
</para> </para>
<para> <para>
The following list of options are available for the Text Entry dialog: The Text Entry dialog has the following options:
</para> </para>
<variablelist> <variablelist>
@ -370,26 +340,39 @@
<varlistentry> <varlistentry>
<term><varname>--text</varname>=TEXT</term> <term><varname>--text</varname>=TEXT</term>
<listitem> <listitem>
<para>Specify the text to appear in the Text Entry dialog.</para> <para>Specifies the text to appear in the Text Entry dialog.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>--entry-text</varname>=TEXT</term> <term><varname>--entry-text</varname>=TEXT</term>
<listitem> <listitem>
<para>Specify the text to appear in the entry field of the Text Entry dialog.</para> <para>Specifies the text to appear in the entry field of the Text Entry dialog.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>--hide-text</varname></term> <term><varname>--hide-text</varname></term>
<listitem> <listitem>
<para>Specify that the text in the entry field of the Text Entry dialog be hidden.</para> <para>Specifies that the text in the entry field of the Text Entry dialog be hidden.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </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"> <figure id="zenity-entry-screenshot">
<title>Text Entry dialog example</title> <title>Text Entry dialog example</title>
<screenshot> <screenshot>
@ -403,89 +386,38 @@
</mediaobject> </mediaobject>
</screenshot> </screenshot>
</figure> </figure>
<para>
The following script shows 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>
</sect1> </sect1>
<!-- ==== Message Options ====== --> <!-- ==== Message Options ====== -->
<sect1 id="zenity-message-options"> <sect1 id="zenity-message-options">
<title>Messages</title> <title>Message Dialogs</title>
<para> <para>
There are 4 types of message dialogs in &app; - Error, Informational, Question and Warning. To &app; can create four types of message dialog.
create an Error dialog, use <command>--error</command>. To create an Informational dialog, use Use the <command>--text</command> option to set the text shown in the
<command>--info</command>. To create a Question dialog, use <command>--question</command>. To dialog.
create a Warning dialog, use <command>--question</command>.
</para> </para>
<sect2 id="zenity-warning-dialog">
<title>Warning Dialog</title>
<para> <para>
The following list of options are available for the message dialogs. Use <command>--warning</command> to create a Warning dialog.
</para> </para>
<variablelist> <para>
The following script is an example of how to use the Warning message dialog:
<varlistentry> <programlisting>
<term><varname>--text</varname>=TEXT</term> #!/bin/bash
<listitem>
<para>Specify the text to appear in the message dialog.</para>
</listitem>
</varlistentry>
</variablelist> FILE_TYPE=$(file -b $NAUTILUS_SCRIPT_SELECTED_FILE_PATHS|awk '{ print $1}')
<figure id="zenity-error-screenshot"> if [ "$FILE_TYPE" != "PNG" ]; then
<title>Error dialog example</title> zenity --warning --text="Could not rotate image :" --hide-text
<screenshot> fi
<mediaobject> </programlisting>
<imageobject> </para>
<imagedata fileref="figures/zenity-error-screenshot.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&app; Error dialog example</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<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>
<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>
<figure id="zenity-warning-screenshot"> <figure id="zenity-warning-screenshot">
<title>Warning dialog example</title> <title>Warning dialog example</title>
@ -500,34 +432,88 @@
</mediaobject> </mediaobject>
</screenshot> </screenshot>
</figure> </figure>
</sect2>
<sect2 id="zenity-error-dialog">
<title>Error Dialog</title>
<para> <para>
The following script shows an example of how to use the Warning message dialog: Use <command>--error</command> to create an Error 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> </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> </sect1>
<!-- ==== File Selection Options ====== --> <!-- ==== File Selection Options ====== -->
<sect1 id="zenity-file-selection-options"> <sect1 id="zenity-file-selection-options">
<title>File Selection</title> <title>File Selection Dialog</title>
<para> <para>
To create a File Selection dialog, use <command>--file-selection</command>. &app; returns Use <command>--file-selection</command> to create a file selection
the file or directory selected to standard error. dialog. &app; returns
the files or directories selected to standard error.
</para> </para>
<para> <para>
The following list of options are available for the File Selection dialog: The File Selection dialog has the following options:
</para> </para>
<variablelist> <variablelist>
@ -535,43 +521,29 @@
<varlistentry> <varlistentry>
<term><varname>--filename</varname>=FILENAME</term> <term><varname>--filename</varname>=FILENAME</term>
<listitem> <listitem>
<para>Specify the file or directory to be pre-selected in the File Selection dialog.</para> <para>Specifies the file or directory to be selected in the File Selection dialog
when the dialog is first shown.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>--multiple</varname></term> <term><varname>--multiple</varname></term>
<listitem> <listitem>
<para>Allow selection of mulitple filename in the File Selection dialog.</para> <para>Allows selection of multiple filenames in the File Selection dialog.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>--separator</varname>=SEPARATOR</term> <term><varname>--separator</varname>=SEPARATOR</term>
<listitem> <listitem>
<para>Specify the character(s) which will divide between entries in the returned list of file names. The <para>Specifies the string used to divide the returned list of filenames.</para>
default character is '|'. If you want to specify a newline, use '\n'.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<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>
<para> <para>
The following script shows an example of how to use the File Selection dialog: The following script is an example of how to use the File Selection dialog:
<programlisting> <programlisting>
#!/bin/sh #!/bin/sh
@ -589,34 +561,45 @@
</programlisting> </programlisting>
</para> </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> </sect1>
<!-- ==== List Options ====== --> <!-- ==== List Options ====== -->
<sect1 id="zenity-list-options"> <sect1 id="zenity-list-options">
<title>Lists</title> <title>List Dialog</title>
<para> <para>
To create a List dialog, use <command>--list</command>. &app; returns the entries of Use <command>--list</command> to create a list dialog. &app; returns the entries in
the first columns selected to standard error. If <command>--checklist</command> or the first column of text of selected rows to standard error.
<command>--radiolist</command> is used, then &app; will return the entries of the
second columns selected to standard error.
</para> </para>
<para> <para>
Every column must be specified by the <command>--column</command> option. Data for
With the List dialog, you must specify the number of columns to be displayed by the dialog must specified column by column, row by row. Data can be provided to
specifying the column headers. To fill data into this dialog, you may specify the dialog through standard input. Each entry must be separated by a newline.
entries column by column, row by row. If you are using a checklist or a radiolist
then your first pieces of data for each row must be either 'TRUE' or 'FALSE'. See
examples below for how to fill data into this dialog. The List dialog may also be
filled by providing data from standard input, column by column, row by row, each
seperated by a newline, however the column headers must appear with the
<command>--column</command> option.
</para> </para>
<para> <para>
The following list of options are available for the List dialog: 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> </para>
<variablelist> <variablelist>
@ -624,8 +607,9 @@
<varlistentry> <varlistentry>
<term><varname>--column</varname>=COLUMN</term> <term><varname>--column</varname>=COLUMN</term>
<listitem> <listitem>
<para>Specify the column headers to appear in the List dialog. This option must be <para>Specifies the column headers to appear in the List dialog.
called for each column that you want to appear in the dialog. You must call the <command>--column</command> option for
each column you want to appear in the dialog.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -633,7 +617,7 @@
<varlistentry> <varlistentry>
<term><varname>--checklist</varname></term> <term><varname>--checklist</varname></term>
<listitem> <listitem>
<para>Specify if the first column should contain check boxes in the List dialog. <para>Specifies that the first column should contain check boxes in the List dialog.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -641,7 +625,7 @@
<varlistentry> <varlistentry>
<term><varname>--radiolist</varname></term> <term><varname>--radiolist</varname></term>
<listitem> <listitem>
<para>Specify if the first column should contain radio boxes in the List dialog. <para>Specifies that the first column should contain radio boxes in the List dialog.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -649,7 +633,7 @@
<varlistentry> <varlistentry>
<term><varname>--editable</varname></term> <term><varname>--editable</varname></term>
<listitem> <listitem>
<para>Allow the displayed items to be edited. <para>Allows the displayed items to be edited.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -657,14 +641,25 @@
<varlistentry> <varlistentry>
<term><varname>--seperator</varname>=SEPERATOR</term> <term><varname>--seperator</varname>=SEPERATOR</term>
<listitem> <listitem>
<para>Specify what seperator character(s) should be used when the List dialog returns the selected entries. The <para>Specifies what string should be used when the List dialog returns the selected entries.
default character is '|'. If you want to specify a newline, use '\n'.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </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"> <figure id="zenity-list-screenshot">
<title>List Selection dialog example</title> <title>List Selection dialog example</title>
<screenshot> <screenshot>
@ -679,33 +674,26 @@
</screenshot> </screenshot>
</figure> </figure>
<para>
The following commandline shows 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>
</sect1> </sect1>
<!-- ==== Progress Options ====== --> <!-- ==== Progress Options ====== -->
<sect1 id="zenity-progress-options"> <sect1 id="zenity-progress-options">
<title>Progress</title> <title>Progress Dialog</title>
<para> <para>
To create a Progress dialog, use <command>--progress</command>. Zenity reads data from Use <command>--progress</command> to create a Progress dialog.
standard input line by line, determining whether it should update the text (if the
line is prefixed with a '#') or the percentage (if the line is a digit).
</para> </para>
<para> <para>
The following list of options are available for the Progress dialog: &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> </para>
<variablelist> <variablelist>
@ -713,14 +701,14 @@
<varlistentry> <varlistentry>
<term><varname>--text</varname>=TEXT</term> <term><varname>--text</varname>=TEXT</term>
<listitem> <listitem>
<para>Specify the text to appear in the Progress dialog.</para> <para>Specifies the text to appear in the Progress dialog.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>--percentage</varname>=PERCENTAGE</term> <term><varname>--percentage</varname>=PERCENTAGE</term>
<listitem> <listitem>
<para>Specify the initial percentage that should be set in the Progress dialog.</para> <para>Specifies the initial percentage that should be set in the Progress dialog.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -734,29 +722,15 @@
<varlistentry> <varlistentry>
<term><varname>--pulsate</varname></term> <term><varname>--pulsate</varname></term>
<listitem> <listitem>
<para>Specify if the Progress dialog should pulsate until an EOF character is read <para>Specifies that the Progress dialog should pulsate until an EOF character is read
from standard input.</para> from standard input.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<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>
<para> <para>
The following script shows an example of how to use the Progress dialog: The following script is an example of how to use the Progress dialog:
<programlisting> <programlisting>
#!/bin/sh #!/bin/sh
( (
@ -778,19 +752,33 @@
</programlisting> </programlisting>
</para> </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> </sect1>
<!-- ==== Text Information Options ====== --> <!-- ==== Text Information Options ====== -->
<sect1 id="zenity-text-options"> <sect1 id="zenity-text-options">
<title>Text Information</title> <title>Text Information Dialog</title>
<para> <para>
To create a Text Information dialog, use <command>--text-info</command>. Use <command>--text-info</command> to create a Text Information dialog.
</para> </para>
<para> <para>
The following list of options are available for the Text Information dialog: The Text Information dialog has the following options:
</para> </para>
<variablelist> <variablelist>
@ -798,35 +786,22 @@
<varlistentry> <varlistentry>
<term><varname>--filename</varname>=FILENAME</term> <term><varname>--filename</varname>=FILENAME</term>
<listitem> <listitem>
<para>Specify the file to be loaded in the Text Information dialog.</para> <para>Specifies a file to be loaded in the Text Information dialog.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>--editable</varname></term> <term><varname>--editable</varname></term>
<listitem> <listitem>
<para>Allow the displayed text to be edited and returned to standard error when the dialog is closed.</para> <para>Allows the displayed text to be edited. The edited text is
returned to standard error when the dialog is closed.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<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>
<para> <para>
The following script shows an example of how to use the Text Infomation dialog: The following script is an example of how to use the Text Infomation dialog:
<programlisting> <programlisting>
#!/bin/sh #!/bin/sh
@ -844,15 +819,29 @@
</programlisting> </programlisting>
</para> </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> </sect1>
<!-- ==== Miscellaneous Options ====== --> <!-- ==== Miscellaneous Options ====== -->
<sect1 id="zenity-miscellaneous-options"> <sect1 id="zenity-miscellaneous-options">
<title>Miscellaneous</title> <title>Miscellaneous Options</title>
<para> <para>
The following list of options are also available for &app;: &app; has the following miscellaneous options:
</para> </para>
<variablelist> <variablelist>
@ -860,14 +849,14 @@
<varlistentry> <varlistentry>
<term><varname>--about</varname></term> <term><varname>--about</varname></term>
<listitem> <listitem>
<para>Display some information about &app;.</para> <para>Displays some information about &app;.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>--version</varname></term> <term><varname>--version</varname></term>
<listitem> <listitem>
<para>Print the version number of &app;.</para> <para>Prints the version number of &app;.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>

1
src/about.c
View File

@ -53,6 +53,7 @@ static const gchar *author_credits[] = {
"Jonathan Blandford <jrb@redhat.com>", "Jonathan Blandford <jrb@redhat.com>",
"Ross Burton <ross@burtonini.com>", "Ross Burton <ross@burtonini.com>",
"Anders Carlsson <andersca@codefactory.se>", "Anders Carlsson <andersca@codefactory.se>",
"Nicholas Curran <quasar@austar.net.au>",
"John Fleck <jfleck@inkstain.net>", "John Fleck <jfleck@inkstain.net>",
"James Henstridge <james@daa.com.au>", "James Henstridge <james@daa.com.au>",
"Mihai T. Lazarescu <mihai@email.it>", "Mihai T. Lazarescu <mihai@email.it>",