dee9ebb40b
2003-01-18 Glynn Foster <glynn.foster@sun.com> * help/C/zenity.xml: Update the docs a little. I have absolutely no clue how the doc people don't get tired of this.
290 lines
7.4 KiB
XML
290 lines
7.4 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>
|
|
</authorgroup>
|
|
|
|
<revhistory>
|
|
<revision>
|
|
<revnumber>1.0</revnumber>
|
|
<date>&date;</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; allows allows you to display simple dialogs from the
|
|
command line or from shell scripts.
|
|
</para>
|
|
|
|
<para>
|
|
The following list of dialogs are available with &app;:
|
|
</para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term><varname>--calendar</varname></term>
|
|
<listitem>
|
|
<para>Display a Calendar dialog</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--entry</varname></term>
|
|
<listitem>
|
|
<para>Display a Text Entry dialog</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--error</varname></term>
|
|
<listitem>
|
|
<para>Display an Error dialog</para>
|
|
</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 Slection 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>
|
|
|
|
<!-- ==== General Options ====== -->
|
|
|
|
<sect1 id="zenity-general-options">
|
|
<title>General Options</title>
|
|
|
|
<para>
|
|
Each dialog shares some general command line options. If these
|
|
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>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
<term><varname>--title</varname>=TITLE</term>
|
|
<listitem>
|
|
<para>Specify the title of a dialog</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><varname>--window-icon</varname>=ICON_PATH</term>
|
|
<listitem>
|
|
<para>Specify the icon that should appear in the window frame of the dialog</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</sect1>
|
|
|
|
<!-- ==== Calendar Options ======
|
|
|
|
Calendar options
|
|
--text=STRING Set the dialog text
|
|
--day=INT Set the calendar day
|
|
--month=INT Set the calendar month
|
|
--year=INT Set the calendar year
|
|
--date-format=STRING Set the format for the returned date
|
|
|
|
Text entry options
|
|
--text=STRING Set the dialog text
|
|
--entry-text=STRING Set the entry text
|
|
--hide-text Hide the entry text
|
|
|
|
Info options
|
|
--text=STRING Set the dialog text
|
|
|
|
Error options
|
|
--text=STRING Set the dialog text
|
|
|
|
File selection options
|
|
--filename=FILENAME Set the filename
|
|
|
|
List options
|
|
--column=STRING Set the column header
|
|
--checklist Use check boxes for first column
|
|
--radiolist Use radio buttons for first column
|
|
--separator=STRING Set output separator character
|
|
|
|
Progress options
|
|
--text=STRING Set the dialog text
|
|
--percentage=INT Set initial percentage
|
|
--pulsate Pulsate progress bar
|
|
|
|
Question options
|
|
--text=STRING Set the dialog text
|
|
|
|
Text options
|
|
--filename=FILENAME Open file
|
|
|
|
Warning options
|
|
--text=STRING Set the dialog text
|
|
|
|
Miscellaneous options
|
|
--about About zenity
|
|
--version Print version
|
|
|
|
Help options
|
|
-?, --help Show this help message
|
|
--usage Display brief usage message
|
|
|
|
-->
|
|
|
|
<!-- ================ 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>
|