~ubuntu-branches/ubuntu/warty/zenity/warty

« back to all changes in this revision

Viewing changes to data/zenity.1

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2004-10-12 01:48:22 UTC
  • Revision ID: james.westby@ubuntu.com-20041012014822-89rmdkuj434ynu0n
Tags: upstream-2.8.1
ImportĀ upstreamĀ versionĀ 2.8.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH ZENITY 1 "February 1st, 2003"
 
2
.SH NAME
 
3
zenity \- display GTK+ dialogs
 
4
.SH SYNOPSIS
 
5
.B zenity
 
6
.RI [ options ]
 
7
.SH DESCRIPTION
 
8
\fBzenity\fP is a program that will display GTK+ dialogs, and return
 
9
(either in the return code, or on standard output) the users
 
10
input. This allows you to present information, and ask for information
 
11
from the user, from all manner of shell scripts.
 
12
.PP
 
13
For example, \fBzenity --question\fP will return either 0 or 1,
 
14
depending on whether the user pressed \fIOK\fP or \fICancel\fP. \fBzenity
 
15
--entry\fP will output on standard output what the user typed into the
 
16
text entry field.
 
17
.PP
 
18
Comprehensive documentation is available in the GNOME Help Browser,
 
19
under \fIGNOME/Utilities\fP.
 
20
.SH OPTIONS
 
21
This program follows the usual GNU command line syntax, with long
 
22
options starting with two dashes (`-').
 
23
 
 
24
.PP
 
25
Dialog options
 
26
 
 
27
.TP
 
28
.B \-\-calendar
 
29
Display calendar dialog
 
30
.TP
 
31
.B \-\-entry
 
32
Display text entry dialog
 
33
.TP
 
34
.B \-\-error
 
35
Display error dialog
 
36
.TP
 
37
.B \-\-file-selection
 
38
Display file selection dialog
 
39
.TP
 
40
.B \-\-info
 
41
Display info dialog
 
42
.TP
 
43
.B \-\-list
 
44
Display list dialog
 
45
.TP
 
46
.B \-\-progress
 
47
Display progress indication dialog
 
48
.TP
 
49
.B \-\-question
 
50
Display question dialog
 
51
.TP
 
52
.B \-\-text-info
 
53
Display text information dialog
 
54
.TP
 
55
.B \-\-warning
 
56
Display warning dialog
 
57
 
 
58
.PP
 
59
General options
 
60
 
 
61
.TP
 
62
.B \-\-title=TITLE
 
63
Set the dialog title
 
64
.TP
 
65
.B \-\-window-icon=ICONPATH
 
66
Set the window icon
 
67
.TP
 
68
.B \-\-width=WIDTH
 
69
Set the dialog width
 
70
.TP
 
71
.B \-\-height=HEIGHT
 
72
Set the dialog height
 
73
.PP 
 
74
Calendar options
 
75
 
 
76
.TP
 
77
.B \-\-text=STRING
 
78
Set the dialog text
 
79
.TP
 
80
.B \-\-day=INT
 
81
Set the calendar day
 
82
.TP
 
83
.B \-\-month=INT
 
84
Set the calendar month
 
85
.TP
 
86
.B \-\-year=INT
 
87
Set the calendar year
 
88
.TP
 
89
.B \-\-date-format=STRING
 
90
Set the format for the returned date
 
91
 
 
92
.PP
 
93
Text entry options
 
94
 
 
95
.TP
 
96
.B \-\-text=STRING
 
97
Set the dialog text
 
98
.TP
 
99
.B \-\-entry-text=STRING
 
100
Set the entry text
 
101
.TP
 
102
.B \-\-hide-text
 
103
Hide the entry text
 
104
 
 
105
.PP
 
106
Error options
 
107
.TP
 
108
.B \-\-text=STRING
 
109
Set the dialog text
 
110
 
 
111
.PP
 
112
File selection options
 
113
.TP
 
114
.B \-\-filename=FILENAME
 
115
Set the filename
 
116
.TP
 
117
.B \-\-multiple
 
118
Allow selection of multiple filenames in file selection dialog
 
119
.TP
 
120
.B \-\-separator=SEPARATOR
 
121
Specify separator character when returning multiple filenames
 
122
 
 
123
.PP
 
124
Info options
 
125
.TP
 
126
.B \-\-text=STRING
 
127
Set the dialog text
 
128
 
 
129
.PP
 
130
List options
 
131
 
 
132
.TP
 
133
.B \-\-text=STRING
 
134
Set the dialog text
 
135
.TP
 
136
.B \-\-column=STRING
 
137
Set the column header
 
138
.TP
 
139
.B \-\-checklist
 
140
Use check boxes for first column
 
141
.TP
 
142
.B \-\-radiolist
 
143
Use radio buttons for first column
 
144
.TP
 
145
.B \-\-separator=STRING
 
146
Set output separator character
 
147
.TP
 
148
.B \-\-editable
 
149
Allow changes to text
 
150
.TP
 
151
.B \-\-print-column=STRING
 
152
Specify what column to print to standard output. The default is to return
 
153
the first column. 'ALL' may be used to print all columns.
 
154
 
 
155
.PP
 
156
Progress options
 
157
 
 
158
.TP
 
159
.B \-\-text=STRING
 
160
Set the dialog text
 
161
.TP
 
162
.B \-\-percentage=INT
 
163
Set initial percentage
 
164
.TP
 
165
.B \-\-auto\-close
 
166
Close dialog when 100% has been reached
 
167
.TP
 
168
.B \-\-pulsate
 
169
Pulsate progress bar
 
170
 
 
171
Question options
 
172
.TP
 
173
.B \-\-text=STRING
 
174
Set the dialog text
 
175
 
 
176
.PP
 
177
Text options
 
178
 
 
179
.TP
 
180
.B \-\-filename=FILENAME
 
181
Open file
 
182
.TP
 
183
.B \-\-editable
 
184
Allow changes to text
 
185
 
 
186
.PP
 
187
Warning options
 
188
 
 
189
.TP
 
190
.B \-\-text=STRING
 
191
Set the dialog text
 
192
 
 
193
.PP
 
194
Miscellaneous options
 
195
 
 
196
.TP
 
197
.B \-?, \-\-help
 
198
Show summary of options.
 
199
.TP
 
200
.B \-\-about
 
201
Display an about dialog.
 
202
.TP
 
203
.B \-\-version
 
204
Show version of program.
 
205
 
 
206
.PP
 
207
Also the standard GTK+ options are accepted.
 
208
 
 
209
.SH EXAMPLES
 
210
 
 
211
Display a file selector with the title \fISelect a file to
 
212
remove\fP. The file selected is returned on standard output.
 
213
.IP
 
214
zenity  --title="Select a file to remove" --file-selection
 
215
.PP
 
216
Display a text entry dialog with the title \fISelect Host\fP and the
 
217
text \fISelect the host you would like to flood-ping\fP. The entered
 
218
text is returned on standard output.
 
219
.IP
 
220
zenity  --title "Select Host" --entry --text "Select the host you would like to flood-ping"
 
221
.PP
 
222
Display a dialog, asking \fIMicrosoft Windows has been found! Would
 
223
you like to remove it?\fP. The return code will be 0 (true in shell)
 
224
if \fIOK\fP is selected, and 1 (false) if \fICancel\fP is selected.
 
225
.IP
 
226
zenity  --question --title "Alert"  --text "Microsoft Windows has been found! Would you like to remove it?"
 
227
.PP
 
228
Show the search results in a list dialog with the title \fISearch Results\fP
 
229
and the text \fIFinding all header files...\fP.
 
230
.IP
 
231
find . -name '*.h' | zenity --title "Search Results" --text "Finding all header files.." --column "Files"
 
232
.PP
 
233
Display a weekly shopping list in a check list dialog with \fIApples\fP and \fIOranges\fP pre selected
 
234
.IP
 
235
zenity --list --checklist --column "Buy" --column "Item" TRUE Apples TRUE Oranges FALSE Pears FALSE Toothpaste
 
236
.PP
 
237
Display a progress dialog while searching for all the postscript files in your home directory
 
238
.P
 
239
find `echo $HOME` '*.ps' | zenity --progress --pulsate
 
240
.SH AUTHOR
 
241
\fBZenity\fP was written by Glynn Foster <glynn.foster@sun.com>.
 
242
.P
 
243
This manual page was written by Ross Burton <ross@burtonini.com>.
 
244
 
 
245
.SH SEE ALSO
 
246
\fBgdialog\fP(1), \fBdialog\fP(1)