diff options
Diffstat (limited to 'help/en_GB')
| -rw-r--r-- | help/en_GB/calendar.page | 65 | ||||
| -rw-r--r-- | help/en_GB/color-selection.page | 54 | ||||
| -rw-r--r-- | help/en_GB/en_GB.stamp | 0 | ||||
| -rw-r--r-- | help/en_GB/entry.page | 54 | ||||
| -rw-r--r-- | help/en_GB/error.page | 29 | ||||
| -rw-r--r-- | help/en_GB/file-selection.page | 67 | ||||
| -rw-r--r-- | help/en_GB/forms.page | 82 | ||||
| -rw-r--r-- | help/en_GB/index.page | 28 | ||||
| -rw-r--r-- | help/en_GB/info.page | 29 | ||||
| -rw-r--r-- | help/en_GB/intro.page | 33 | ||||
| -rw-r--r-- | help/en_GB/legal.xml | 63 | ||||
| -rw-r--r-- | help/en_GB/list.page | 75 | ||||
| -rw-r--r-- | help/en_GB/message.page | 17 | ||||
| -rw-r--r-- | help/en_GB/notification.page | 53 | ||||
| -rw-r--r-- | help/en_GB/password.page | 49 | ||||
| -rw-r--r-- | help/en_GB/progress.page | 76 | ||||
| -rw-r--r-- | help/en_GB/question.page | 29 | ||||
| -rw-r--r-- | help/en_GB/scale.page | 79 | ||||
| -rw-r--r-- | help/en_GB/text.page | 82 | ||||
| -rw-r--r-- | help/en_GB/usage.page | 280 | ||||
| -rw-r--r-- | help/en_GB/warning.page | 28 |
21 files changed, 1272 insertions, 0 deletions
diff --git a/help/en_GB/calendar.page b/help/en_GB/calendar.page new file mode 100644 index 00000000..e8764203 --- /dev/null +++ b/help/en_GB/calendar.page @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="calendar" xml:lang="en-GB"> + <info> + <link type="guide" xref="index#dialogs"/> + <desc>Use the <cmd>--calendar</cmd> option.</desc> + </info> + <title>Calendar Dialogue</title> + <p> + Use the <cmd>--calendar</cmd> option to create a calendar dialog. Zenity returns the selected date to standard output. If no date is specified on the command line, the dialog uses the current date. + </p> + <p>The calendar dialogue supports the following options:</p> + + <terms> + + <item> + <title><cmd>--text</cmd>=<var>text</var></title> + <p>Specifies the text that is displayed in the calendar dialogue.</p> + </item> + + <item> + <title><cmd>--day</cmd>=<var>day</var></title> + <p>Specifies the day that is selected in the calendar dialog. day must be a number between 1 and 31 inclusive.</p> + </item> + + <item> + <title><cmd>--month</cmd>=<var>month</var></title> + <p>Specifies the month that is selected in the calendar dialog. month must be a number between 1 and 12 inclusive.</p> + </item> + + <item> + <title><cmd>--year</cmd>=<var>year</var></title> + <p>Specifies the year that is selected in the calendar dialogue.</p> + </item> + + <item> + <title><cmd>--date-format</cmd>=<var>format</var></title> + <p>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 <cmd>strftime</cmd> function, for example <var>%A %d/%m/%y</var>.</p> + </item> + + </terms> + + <p> + The following example script shows how to create a calendar dialog: + </p> + +<code> +#!/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 +</code> + + + <figure> + <title>Calendar Dialogue Example</title> + <desc>Zenity calendar dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-calendar-screenshot.png"/> + </figure> +</page> diff --git a/help/en_GB/color-selection.page b/help/en_GB/color-selection.page new file mode 100644 index 00000000..f2669764 --- /dev/null +++ b/help/en_GB/color-selection.page @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="color-selection" xml:lang="en-GB"> + <info> + <link type="guide" xref="index#dialogs"/> + <desc>Use the <cmd>--color-selection</cmd> option.</desc> + </info> + <title>Color Selection Dialog</title> + <p> + Use the <cmd>--color-selection</cmd> option to create a color selection dialog. + </p> + <p> + The color selection dialog supports the following options: + </p> + + <terms> + + <item> + <title><cmd>--color</cmd>=<var>VALUE</var></title> + <p>Set the initial color.(ex: #FF0000)</p> + </item> + + <item> + <title><cmd>--show-palette</cmd></title> + <p>Show the palette.</p> + </item> + + </terms> + + <p> + The following example script shows how to create a color selection dialog: + </p> + +<code> +#!/bin/sh + +COLOR=`zenity --color-selection --show-palette` + +case $? in + 0) + echo "You selected $COLOR.";; + 1) + echo "No color selected.";; + -1) + echo "An unexpected error has occurred.";; +esac +</code> + + <figure> + <title>Color Selection Dialog Example</title> + <desc><app>Zenity</app> color selection dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-colorselection-screenshot.png"/> + </figure> + +</page> diff --git a/help/en_GB/en_GB.stamp b/help/en_GB/en_GB.stamp new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/help/en_GB/en_GB.stamp diff --git a/help/en_GB/entry.page b/help/en_GB/entry.page new file mode 100644 index 00000000..c7414f22 --- /dev/null +++ b/help/en_GB/entry.page @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="entry" xml:lang="en-GB"> + <info> + <link type="guide" xref="index#dialogs"/> + <desc>Use the <cmd>--entry</cmd> option.</desc> + </info> + <title>Text Entry Dialogue</title> + <p> + Use the <cmd>--entry</cmd> option to create a text entry dialog. <app>Zenity</app> returns the contents of the text entry to standard output. + </p> + <p>The text entry dialogue supports the following options:</p> + + <terms> + + <item> + <title><cmd>--text</cmd>=<var>text</var></title> + <p>Specifies the text that is displayed in the text entry dialogue.</p> + </item> + + <item> + <title><cmd>--entry-text</cmd>=<var>text</var></title> + <p>Specifies the text that is displayed in the entry field of the text entry dialogue.</p> + </item> + + <item> + <title><cmd>--hide-text</cmd></title> + <p>Hides the text in the entry field of the text entry dialogue.</p> + </item> + + </terms> + + <p> + The following example script shows how to create a text entry dialog: + </p> + +<code> +#!/bin/sh + +if zenity --entry \ +--title="Add new profile" \ +--text="Enter name of new profile:" \ +--entry-text "NewProfile" + then echo $? + else echo "No name entered" +fi +</code> + + + <figure> + <title>Text Entry Dialogue Example</title> + <desc><app>Zenity</app> text entry dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-entry-screenshot.png"/> + </figure> +</page> diff --git a/help/en_GB/error.page b/help/en_GB/error.page new file mode 100644 index 00000000..06f3e71d --- /dev/null +++ b/help/en_GB/error.page @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="error" xml:lang="en-GB"> + <info> + <link type="guide" xref="message"/> + <desc>Use the <cmd>--error</cmd> option.</desc> + </info> + <title>Error Dialogue</title> + <p> + Use the <cmd>--error</cmd> option to create an error dialog. + </p> + + <p> + The following example script shows how to create an error dialog: + </p> + +<code> +#!/bin/bash + +zenity --error \ +--text="Could not find /var/log/syslog." +</code> + + + <figure> + <title>Error Dialogue Example</title> + <desc><app>Zenity</app> error dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-error-screenshot.png"/> + </figure> +</page> diff --git a/help/en_GB/file-selection.page b/help/en_GB/file-selection.page new file mode 100644 index 00000000..e9454ef7 --- /dev/null +++ b/help/en_GB/file-selection.page @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="file-selection" xml:lang="en-GB"> + <info> + <link type="guide" xref="index#dialogs"/> + <desc>Use the <cmd>--file-selection</cmd> option.</desc> + </info> + <title>File Selection Dialogue</title> + <p> + Use the <cmd>--file-selection</cmd> option to create a file selection dialog. <app>Zenity</app> returns the selected files or directories to standard + output. The default mode of the file selection dialog is open. + </p> + <p>The file selection dialogue supports the following options:</p> + + <terms> + + <item> + <title><cmd>--filename</cmd>=<var>filename</var></title> + <p>Specifies the file or directory that is selected in the file selection dialogue when the dialogue is first shown.</p> + </item> + + <item> + <title><cmd>--multiple</cmd></title> + <p>Allows the selection of multiple filenames in the file selection dialogue.</p> + </item> + + <item> + <title><cmd>--directory</cmd></title> + <p>Allows only selection of directories in the file selection dialogue.</p> + </item> + + <item> + <title><cmd>--save</cmd></title> + <p>Set the file selection dialogue into save mode.</p> + </item> + + <item> + <title><cmd>--separator</cmd>=<var>separator</var></title> + <p>Specifies the string that is used to divide the returned list of filenames.</p> + </item> + + </terms> + + <p> + The following example script shows how to create a file selection dialog: + </p> + +<code> +#!/bin/sh + +FILE=`zenity --file-selection --title="Select a File"` + +case $? in + 0) + echo "\"$FILE\" selected.";; + 1) + echo "No file selected.";; + -1) + echo "An unexpected error has occurred.";; +esac +</code> + + <figure> + <title>File Selection Dialogue Example</title> + <desc><app>Zenity</app> file selection dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-fileselection-screenshot.png"/> + </figure> +</page> diff --git a/help/en_GB/forms.page b/help/en_GB/forms.page new file mode 100644 index 00000000..5d1702e2 --- /dev/null +++ b/help/en_GB/forms.page @@ -0,0 +1,82 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="forms" xml:lang="en-GB"> + <info> + <link type="guide" xref="index#dialogs"/> + <desc>Use the <cmd>--forms</cmd> option.</desc> + </info> + <title>Forms Dialog</title> + <p> + Use the <cmd>--forms</cmd> option to create a forms dialog. + </p> + + <p> + The forms dialog supports the following options: + </p> + + <terms> + + <item> + <title><cmd>--add-entry</cmd>=<var>FieldName</var></title> + <p>Add a new Entry in forms dialog.</p> + </item> + + <item> + <title>--add-password<cmd/>=<var>FieldName</var></title> + <p>Add a new Password Entry in forms dialog. (Hide text)</p> + </item> + + <item> + <title><cmd>--add-calendar</cmd>=<var>FieldName</var></title> + <p>Add a new Calendar in forms dialog.</p> + </item> + + <item> + <title><cmd>--text</cmd>=<var>TEXT</var></title> + <p>Set the dialog text.</p> + </item> + + <item> + <title><cmd>--separator</cmd>=<var>SEPARATOR</var></title> + <p>Set output separator character. (Default: | )</p> + </item> + + <item> + <title><cmd>--forms-date-format</cmd>=<var>PATTERN</var></title> + <p>Set the format for the returned date. The default format depends on your locale. format must be a Format that is acceptable to the <cmd>strftime</cmd> function, for example <var>%A %d/%m/%y</var>.</p> + </item> + + </terms> + + <p> + The following example script shows how to create a forms dialog: + </p> + +<code> +#!/bin/sh + +zenity --forms --title="Add Friend" \ + --text="Enter information about your friend." \ + --separator="," \ + --add-entry="First Name" \ + --add-entry="Family Name" \ + --add-entry="Email" \ + --add-calendar="Birthday" >> addr.csv + +case $? in + 0) + echo "Friend added.";; + 1) + echo "No friend added." + ;; + -1) + echo "An unexpected error has occurred." + ;; +esac +</code> + + <figure> + <title>Forms Dialog Example</title> + <desc><app>Zenity</app> forms dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-forms-screenshot.png"/> + </figure> +</page> diff --git a/help/en_GB/index.page b/help/en_GB/index.page new file mode 100644 index 00000000..193ca2ed --- /dev/null +++ b/help/en_GB/index.page @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="guide" id="index" xml:lang="en-GB"> +<info> + <credit type="author"> + <name>Sun Java Desktop System Documentation Team</name> + </credit> + <credit type="author"> + <name>Glynn Foster</name> + </credit> + <credit type="editor"> + <name>Nicholas Curran</name> + <email/> + </credit> + <credit type="editor"> + <name>Yasumichi Akahoshi</name> + <email>yasumichi@vinelinux.org</email> + </credit> + <license> + <p>GNU Free Documentation License (GFDL)</p> + </license> + <include xmlns="http://www.w3.org/2001/XInclude" href="legal.xml"/> +</info> +<title>Zenity Manual</title> +<!--links type="topic" groups="dialogs" /--> +<section id="dialogs" style="2column"> + <title>Dialogs</title> +</section> +</page> diff --git a/help/en_GB/info.page b/help/en_GB/info.page new file mode 100644 index 00000000..bb13b48e --- /dev/null +++ b/help/en_GB/info.page @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="info" xml:lang="en-GB"> + <info> + <link type="guide" xref="message"/> + <desc>Use the <cmd>--info</cmd> option.</desc> + </info> + <title>Info Dialog</title> + <p> + Use the <cmd>--info</cmd> option to create an information dialog. + </p> + + <p> + The following example script shows how to create an information dialog: + </p> + +<code> +#!/bin/bash + +zenity --info \ +--text="Merge complete. Updated 3 of 10 files." +</code> + + + <figure> + <title>Information Dialogue Example</title> + <desc><app>Zenity</app> information dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-information-screenshot.png"/> + </figure> +</page> diff --git a/help/en_GB/intro.page b/help/en_GB/intro.page new file mode 100644 index 00000000..ef072821 --- /dev/null +++ b/help/en_GB/intro.page @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="intro" xml:lang="en-GB"> +<info> + <link type="guide" xref="index"/> + <desc><app>Zenity</app> enables you to create the various types of simple dialog.</desc> +</info> +<title>Introduction</title> +<p> + <app>Zenity</app> enables you to create the following types of simple dialog: +</p> + +<list> + <item><p>Calendar</p></item> + <item><p>File selection</p></item> + <item><p>Forms</p></item> + <item><p>List</p></item> + <item><p>Notification icon</p></item> + <item><p>Message</p> + <list> + <item><p>Error</p></item> + <item><p>Information</p></item> + <item><p>Question</p></item> + <item><p>Warning</p></item> + </list> + </item> + <item><p>Password entry</p></item> + <item><p>Progress</p></item> + <item><p>Text entry</p></item> + <item><p>Text information</p></item> + <item><p>Scale</p></item> + <item><p>Color selection</p></item> +</list> +</page> diff --git a/help/en_GB/legal.xml b/help/en_GB/legal.xml new file mode 100644 index 00000000..6e71bb8e --- /dev/null +++ b/help/en_GB/legal.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="utf-8"?> +<legalnotice id="legalnotice"> + <para> + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation + License (GFDL), Version 1.1 or any later version published + by the Free Software Foundation with no Invariant Sections, + no Front-Cover Texts, and no Back-Cover Texts. You can find + a copy of the GFDL at this <ulink type="help" url="help:fdl">link</ulink> or in the file COPYING-DOCS + distributed with this manual. + </para> + <para>This manual is part of a collection of GNOME manuals distributed under the GFDL. If you want to distribute this manual separately from the collection, you can do so by adding a copy of the license to the manual, as described in section 6 of the licence.</para> + + <para>Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any GNOME documentation, and the members of the GNOME Documentation Project are made aware of those trademarks, then the names are in capital letters or initial capital letters.</para> + + <para> + DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED + UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE + WITH THE FURTHER UNDERSTANDING THAT: + + <orderedlist> + <listitem> + <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS, + WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR + IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES + THAT THE DOCUMENT OR MODIFIED VERSION OF THE + DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR + A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE + RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE + OF THE DOCUMENT OR MODIFIED VERSION OF THE + DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR + MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, + YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY + CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY + SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER + OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS + LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED + VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER + EXCEPT UNDER THIS DISCLAIMER; AND + </para> + </listitem> + <listitem> + <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL + THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), + CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, + INITIAL WRITER, ANY CONTRIBUTOR, OR ANY + DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION + OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH + PARTIES, BE LIABLE TO ANY PERSON FOR ANY + DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR + CONSEQUENTIAL DAMAGES OF ANY CHARACTER + INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS + OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR + MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR + LOSSES ARISING OUT OF OR RELATING TO USE OF THE + DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, + EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF + THE POSSIBILITY OF SUCH DAMAGES. + </para> + </listitem> + </orderedlist> + </para> + </legalnotice> diff --git a/help/en_GB/list.page b/help/en_GB/list.page new file mode 100644 index 00000000..44f8f3ec --- /dev/null +++ b/help/en_GB/list.page @@ -0,0 +1,75 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="list" xml:lang="en-GB"> + <info> + <link type="guide" xref="index#dialogs"/> + <desc>Use the <cmd>--list</cmd> option.</desc> + </info> + <title>List Dialogue</title> + <p> + Use the <cmd>--list</cmd> option to create a list dialog. <app>Zenity</app> returns the entries in the first column of text of selected rows to standard output. + </p> + + <p>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.</p> + + <p> + If you use the <cmd>--checklist</cmd> or <cmd>--radiolist</cmd> options, each row must start with either 'TRUE' or 'FALSE'. + </p> + + <p>The list dialogue supports the following options:</p> + + <terms> + + <item> + <title><cmd>--column</cmd>=<var>column</var></title> + <p>Specifies the column headers that are displayed in the list dialog. You must specify a <cmd>--column</cmd> option for each column that you want to display in the dialog. + </p> + </item> + + <item> + <title><cmd>--checklist</cmd></title> + <p>Specifies that the first column in the list dialogue contains check boxes.</p> + </item> + + <item> + <title><cmd>--radiolist</cmd></title> + <p>Specifies that the first column in the list dialogue contains radio boxes.</p> + </item> + + <item> + <title><cmd>--editable</cmd></title> + <p>Allows the displayed items to be edited.</p> + </item> + + <item> + <title><cmd>--separator</cmd>=<var>separator</var></title> + <p>Specifies what string is used when the list dialogue returns the selected entries.</p> + </item> + + <item> + <title><cmd>--print-column</cmd>=<var>column</var></title> + <p>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.</p> + </item> + + </terms> + + <p> + The following example script shows how to create a list dialog: + </p> +<code> +#!/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" +</code> + + + <figure> + <title>List Dialogue Example</title> + <desc><app>Zenity</app> list dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-list-screenshot.png"/> + </figure> +</page> diff --git a/help/en_GB/message.page b/help/en_GB/message.page new file mode 100644 index 00000000..76dc35e3 --- /dev/null +++ b/help/en_GB/message.page @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="guide" id="message" xml:lang="en-GB"> + <info> + <link type="guide" xref="index#dialogs" group="message"/> + <desc> + <link xref="error">Error</link>, + <link xref="info">Info</link>, + <link xref="question">Question</link>, + <link xref="warning">Warning</link> + </desc> + </info> + <title>Message Dialog</title> + <p> +For each type, use the <cmd>--text</cmd> option to specify the text that is displayed in the dialog. + </p> + <links type="topic" style="2column"/> +</page> diff --git a/help/en_GB/notification.page b/help/en_GB/notification.page new file mode 100644 index 00000000..ff58d686 --- /dev/null +++ b/help/en_GB/notification.page @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="notification" xml:lang="en-GB"> + <info> + <link type="guide" xref="index#dialogs"/> + <desc>Use the <cmd>--notification</cmd> option.</desc> + </info> + <title>Notification Icon</title> + <p>Use the <cmd>--notification</cmd> option to create a notification icon.</p> + + <terms> + <item> + <title><cmd>--text</cmd>=<var>text</var></title> + <p>Specifies the text that is displayed in the notification area.</p> + </item> + <item> + <title><cmd>--listen</cmd>=icon: '<var>text</var>', message: '<var>text</var>', tooltip: '<var>text</var>', visible: '<var>text</var>',</title> + <p>Listens for commands at standard input. At least one command must be specified. Commands are comma separated. A command must be followed by a colon and a value. </p> + <note style="tip"> + <p>The <cmd>icon</cmd> command also accepts four stock icon values such as <var>error</var>, <var>info</var>, <var>question</var> and <var>warning</var>.</p> + </note> + </item> + </terms> + + <p>The following example script shows how to create a notification icon:</p> + <code> + #!/bin/sh + + zenity --notification\ + --window-icon="info" \ + --text="There are system updates necessary!" + </code> + + <figure> + <title>Notification Icon Example</title> + <desc><app>Zenity</app> notification icon example</desc> + <media type="image" mime="image/png" src="figures/zenity-notification-screenshot.png"/> + </figure> + + <p>The following example script shows how to create a notification icon along with <cmd>--listen</cmd>:</p> + <code> + #!/bin/sh + cat <<EOH| zenity --notification --listen + message: this is the message text + EOH + </code> + + <figure> + <title>Notification Icon with <cmd>--listen</cmd> Example</title> + <desc><app>Zenity</app> notification with <cmd>--listen</cmd> example</desc> + <media type="image" mime="image/png" src="figures/zenity-notification-listen-screenshot.png"/> + </figure> + +</page> diff --git a/help/en_GB/password.page b/help/en_GB/password.page new file mode 100644 index 00000000..1befbdc3 --- /dev/null +++ b/help/en_GB/password.page @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="password" xml:lang="en-GB"> + <info> + <link type="guide" xref="index#dialogs"/> + <desc>Use the <cmd>--password</cmd> option.</desc> + </info> + <title>Password Dialog</title> + <p> + Use the <cmd>--password</cmd> option to create a password entry dialog. + </p> + <p> + The password entry dialog supports the following options: + </p> + + <terms> + <item> + <title><cmd>--username</cmd></title> + <p>Display the username field.</p> + </item> + </terms> + + <p> + The following example script shows how to create a password entry dialog: + </p> + +<code> +#!/bin/sh + +ENTRY=`zenity --password --username` + +case $? in + 0) + echo "User Name: `echo $ENTRY | cut -d'|' -f1`" + echo "Password : `echo $ENTRY | cut -d'|' -f2`" + ;; + 1) + echo "Stop login.";; + -1) + echo "An unexpected error has occurred.";; +esac +</code> + + <figure> + <title>Password Entry Dialog Example</title> + <desc><app>Zenity</app> password entry dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-password-screenshot.png"/> + </figure> + +</page> diff --git a/help/en_GB/progress.page b/help/en_GB/progress.page new file mode 100644 index 00000000..1db90862 --- /dev/null +++ b/help/en_GB/progress.page @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="progress" xml:lang="en-GB"> + <info> + <link type="guide" xref="index#dialogs"/> + <desc>Use the <cmd>--progress</cmd> option.</desc> + </info> + <title>Progress Dialogue</title> + <p> + Use the <cmd>--progress</cmd> option to create a progress dialog. + </p> + + <p> + <app>Zenity</app> 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. + </p> + + <p>The progress dialogue supports the following options:</p> + + <terms> + + <item> + <title><cmd>--text</cmd>=<var>text</var></title> + <p>Specifies the text that is displayed in the progress dialogue.</p> + </item> + + <item> + <title><cmd>--percentage</cmd>=<var>percentage</var></title> + <p>Specifies the initial percentage that is set in the progress dialogue.</p> + </item> + + <item> + <title><cmd>--auto-close</cmd></title> + <p>Closes the progress dialogue when 100% has been reached.</p> + </item> + + <item> + <title><cmd>--pulsate</cmd></title> + <p>Specifies that the progress bar pulsates until an EOF character is read from standard input.</p> + </item> + + </terms> + + <p> + The following example script shows how to create a progress dialog: + </p> + +<code> +#!/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 +</code> + + + <figure> + <title>Progress Dialogue Example</title> + <desc><app>Zenity</app> progress dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-progress-screenshot.png"/> + </figure> +</page> diff --git a/help/en_GB/question.page b/help/en_GB/question.page new file mode 100644 index 00000000..df2fb6ed --- /dev/null +++ b/help/en_GB/question.page @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="question" xml:lang="en-GB"> + <info> + <link type="guide" xref="message"/> + <desc>Use the <cmd>--question</cmd> option.</desc> + </info> + <title>Question Dialogue</title> + <p> + Use the <cmd>--question</cmd> option to create a question dialog. + </p> + + <p> + The following example script shows how to create a question dialog: + </p> + +<code> +#!/bin/bash + +zenity --question \ +--text="Are you sure you wish to proceed?" +</code> + + + <figure> + <title>Question Dialogue Example</title> + <desc><app>Zenity</app> question dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-question-screenshot.png"/> + </figure> +</page> diff --git a/help/en_GB/scale.page b/help/en_GB/scale.page new file mode 100644 index 00000000..f517df64 --- /dev/null +++ b/help/en_GB/scale.page @@ -0,0 +1,79 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="scale" xml:lang="en-GB"> + <info> + <link type="guide" xref="index#dialogs"/> + <desc>Use the <cmd>--scale</cmd> option.</desc> + </info> + <title>Scale Dialog</title> + <p> + Use the <cmd>--scale</cmd> option to create a scale dialog. + </p> + <p> + The scale dialog supports the following options: + </p> + + <terms> + + <item> + <title><cmd>--text</cmd>=<var>TEXT</var></title> + <p>Set the dialog text. (Default: Adjust the scale value)</p> + </item> + + <item> + <title><cmd>--value</cmd>=<var>VALUE</var></title> + <p>Set initial value. (Default: 0) You must specify value between minimum value to maximum value.</p> + </item> + + <item> + <title><cmd>--min-value</cmd>=<var>VALUE</var></title> + <p>Set minimum value. (Default: 0)</p> + </item> + + <item> + <title><cmd>--max-value</cmd>=<var>VALUE</var></title> + <p>Set maximum value. (Default: 100)</p> + </item> + + <item> + <title><cmd>--step</cmd>=<var>VALUE</var></title> + <p>Set step size. (Default: 1)</p> + </item> + + <item> + <title><cmd>--print-partial</cmd></title> + <p>Print value to standard output, whenever a value is changed. </p> + </item> + + <item> + <title><cmd>--hide-value</cmd></title> + <p>Hide value on dialog.</p> + </item> + + </terms> + + <p> + The following example script shows how to create a scale dialog: + </p> + +<code> +#!/bin/sh + +VALUE=`zenity --scale --text="Select window transparency." --value=50` + +case $? in + 0) + echo "You selected $VALUE%.";; + 1) + echo "No value selected.";; + -1) + echo "An unexpected error has occurred.";; +esac +</code> + + <figure> + <title>Scale Dialog Example</title> + <desc><app>Zenity</app> scale dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-scale-screenshot.png"/> + </figure> + +</page> diff --git a/help/en_GB/text.page b/help/en_GB/text.page new file mode 100644 index 00000000..511c1e3b --- /dev/null +++ b/help/en_GB/text.page @@ -0,0 +1,82 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="text" xml:lang="en-GB"> + <info> + <link type="guide" xref="index#dialogs"/> + <desc>Use the <cmd>--text-info</cmd> option.</desc> + </info> + <title>Text Information Dialogue</title> + <p> + Use the <cmd>--text-info</cmd> option to create a text information dialog. + </p> + + <p>The text information dialogue supports the following options:</p> + + <terms> + + <item> + <title><cmd>--filename</cmd>=<var>filename</var></title> + <p>Specifies a file that is loaded in the text information dialogue.</p> + </item> + + <item> + <title><cmd>--editable</cmd></title> + <p>Allows the displayed text to be edited. The edited text is returned to standard output when the dialog is closed.</p> + </item> + + <item> + <title><cmd>--font</cmd>=<var>FONT</var></title> + <p>Specifies the text font.</p> + </item> + + <item> + <title><cmd>--checkbox</cmd>=<var>TEXT</var></title> + <p>Enable a checkbox for use like a 'I read and accept the terms.'</p> + </item> + + <item> + <title><cmd>--html</cmd></title> + <p>Enable html support.</p> + </item> + + <item> + <title><cmd>--url</cmd>=<var>URL</var></title> + <p>Sets an url instead of a file. Only works if you use --html option.</p> + </item> + + </terms> + + <p> + The following example script shows how to create a text information dialog: + </p> + +<code> +#!/bin/sh + +# You must place file "COPYING" in same folder of this script. +FILE=`dirname $0`/COPYING + +zenity --text-info \ + --title="License" \ + --filename=$FILE \ + --checkbox="I read and accept the terms." + +case $? in + 0) + echo "Start installation!" + # next step + ;; + 1) + echo "Stop installation!" + ;; + -1) + echo "An unexpected error has occurred." + ;; +esac +</code> + + <figure> + <title>Text Information Dialogue Example</title> + <desc><app>Zenity</app> text information dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-text-screenshot.png"/> + </figure> +</page> diff --git a/help/en_GB/usage.page b/help/en_GB/usage.page new file mode 100644 index 00000000..8332deaf --- /dev/null +++ b/help/en_GB/usage.page @@ -0,0 +1,280 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="usage" xml:lang="en-GB"> +<info> + <link type="guide" xref="index"/> + <desc>You can use <app>Zenity</app> to create simple dialogs that interact graphically with the user.</desc> +</info> +<title>Usage</title> + <p> + When you write scripts, you can use <app>Zenity</app> to create simple dialogs that interact graphically with the user, as follows: + </p> + <list> + <item> + <p>You can create a dialogue to obtain information from the user. For example, you can prompt the user to select a date from a calendar dialogue, or to select a file from a file selection dialogue.</p> + </item> + <item> + <p>You can create a dialogue to provide the user with information. For example, you can use a progress dialogue to indicate the current status of an operation, or use a warning message dialogue to alert the user.</p> + </item> + </list> + <p> + When the user closes the dialog, <app>Zenity</app> prints the text produced by the dialog to standard output. + </p> + + <note> + <p> + When you write <app>Zenity</app> commands, ensure that you place quotation marks around each argument. + </p> + <p>For example, use:</p> + <screen>zenity --calendar --title="Holiday Planner"</screen> + <p>Do not use:</p> + <screen>zenity --calendar --title=Holiday Planner</screen> + <p>If you do not use quotation marks, you might get unexpected results.</p> + </note> + + <section id="zenity-usage-mnemonics"> + <title>Access Keys</title> + <p>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.</p> + <p> + Some <app>Zenity</app> 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: + </p> + <screen><input>"_Choose a name".</input></screen> + </section> + + <section id="zenity-usage-exitcodes"> + <title>Exit Codes</title> + <p> + Zenity returns the following exit codes: + </p> + + <table frame="all" rules="all"> + <thead> + <tr> + <td> + <p>Exit Code</p></td> + <td> + <p>Description</p></td> + </tr> + </thead> + <tbody> + <tr> + <td> + <p><var>0</var></p> + </td> + <td> + <p>The user has pressed either <gui style="button">OK</gui> or <gui style="button">Close</gui>.</p> + </td> + </tr> + <tr> + <td> + <p><var>1</var></p> + </td> + <td> + <p>The user has either pressed <gui style="button">Cancel</gui>, or used the window functions to close the dialog.</p> + </td> + </tr> + <tr> + <td> + <p><var>-1</var></p> + </td> + <td> + <p>An unexpected error has occurred.</p> + </td> + </tr> + <tr> + <td> + <p><var>5</var></p> + </td> + <td> + <p>The dialogue has been closed because the timeout has been reached.</p> + </td> + </tr> + </tbody> + </table> + + </section> + + + <!-- ==== General Options ====== --> + + <section id="zenity-usage-general-options"> + <title>General Options</title> + + <p> + All Zenity dialogs support the following general options: + </p> + + <terms> + + <item> + <title><cmd>--title</cmd>=<var>title</var></title> + <p>Specifies the title of a dialogue.</p> + </item> + + <item> + <title><cmd>--window-icon</cmd>=<var>icon_path</var></title> + <p>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'.</p> + </item> + + <item> + <title><cmd>--width</cmd>=<var>width</var></title> + <p>Specifies the width of the dialogue.</p> + </item> + + <item> + <title><cmd>--height</cmd>=<var>height</var></title> + <p>Specifies the height of the dialogue.</p> + </item> + + <item> + <title><cmd>--timeout</cmd>=<var>timeout</var></title> + <p>Specifies the timeout in seconds after which the dialogue is closed.</p> + </item> + + </terms> + + </section> + +<!-- ==== Miscellaneous Options ====== --> + + <section id="zenity-help-options"> + <title>Help Options</title> + + <p> + Zenity provides the following help options: + </p> + + <terms> + + <item> + <title><cmd>--help</cmd></title> + <p>Displays shortened help text.</p> + </item> + + <item> + <title><cmd>--help-all</cmd></title> + <p>Displays full help text for all dialogues.</p> + </item> + + <item> + <title><cmd>--help-general</cmd></title> + <p>Displays help text for general dialogue options.</p> + </item> + + <item> + <title><cmd>--help-calendar</cmd></title> + <p>Displays help text for calendar dialogue options.</p> + </item> + + <item> + <title><cmd>--help-entry</cmd></title> + <p>Displays help text for text entry dialogue options.</p> + </item> + + <item> + <title><cmd>--help-error</cmd></title> + <p>Displays help text for error dialogue options.</p> + </item> + + <item> + <title><cmd>--help-info</cmd></title> + <p>Displays help text for information dialogue options.</p> + </item> + + <item> + <title><cmd>--help-file-selection</cmd></title> + <p>Displays help text for file selection dialogue options.</p> + </item> + + <item> + <title><cmd>--help-list</cmd></title> + <p>Displays help text for list dialogue options.</p> + </item> + + <item> + <title><cmd>--help-notification</cmd></title> + <p>Displays help text for notification icon options.</p> + </item> + + <item> + <title><cmd>--help-progress</cmd></title> + <p>Displays help text for progress dialogue options.</p> + </item> + + <item> + <title><cmd>--help-question</cmd></title> + <p>Displays help text for question dialogue options.</p> + </item> + + <item> + <title><cmd>--help-warning</cmd></title> + <p>Displays help text for warning dialogue options.</p> + </item> + + <item> + <title><cmd>--help-text-info</cmd></title> + <p>Displays help for text information dialogue options.</p> + </item> + + <item> + <title><cmd>--help-misc</cmd></title> + <p>Displays help for miscellaneous options.</p> + </item> + + <item> + <title><cmd>--help-gtk</cmd></title> + <p>Displays help for GTK+ options.</p> + </item> + + </terms> + + </section> + +<!-- ==== Miscellaneous Options ====== --> + + <section id="zenity-miscellaneous-options"> + <title>Miscellaneous Options</title> + + <p> + Zenity also provides the following miscellaneous options: + </p> + + <terms> + + <item> + <title><cmd>--about</cmd></title> + <p>Displays the <gui>About Zenity</gui> dialog, which contains Zenity version information, copyright information, and developer information.</p> + </item> + + <item> + <title><cmd>--version</cmd></title> + <p>Displays the version number of Zenity.</p> + </item> + + </terms> + + </section> + +<!-- ==== GTK+ Options ====== --> + + <section id="zenity-gtk-options"> + <title>GTK+ Options</title> + + <p> + Zenity supports the standard GTK+ options. For more information about the GTK+ options, execute the <cmd>zenity --help-gtk</cmd> command. + </p> + + </section> + +<!-- ==== Environment variables ==== --> + + <section id="zenity-environment-variables"> + <title>Environment Variables</title> + + <p> + Normally, Zenity detects the terminal window from which it was launched + and keeps itself above that window. This behavior can be disabled by + unsetting the <var>WINDOWID</var> environment variable. + </p> + + </section> +</page> diff --git a/help/en_GB/warning.page b/help/en_GB/warning.page new file mode 100644 index 00000000..b7102711 --- /dev/null +++ b/help/en_GB/warning.page @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" type="topic" id="warning" xml:lang="en-GB"> + <info> + <link type="guide" xref="message"/> + <desc>Use the <cmd>--warning</cmd> option.</desc> + </info> + <title>Warning Dialogue</title> + <p> + Use the <cmd>--warning</cmd> option to create a warning dialog. + </p> + + <p> + The following example script shows how to create a warning dialog: + </p> + +<code> +#!/bin/bash + +zenity --warning \ +--text="Disconnect the power cable to avoid electrical shock." +</code> + + <figure> + <title>Warning Dialogue Example</title> + <desc><app>Zenity</app> warning dialog example</desc> + <media type="image" mime="image/png" src="figures/zenity-warning-screenshot.png"/> + </figure> +</page> |