~ubuntu-branches/ubuntu/hoary/zenity/hoary

« back to all changes in this revision

Viewing changes to data/zenity.1

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2005-03-07 17:03:31 UTC
  • Revision ID: james.westby@ubuntu.com-20050307170331-j0667q5o1ni6308d
Tags: upstream-2.10.0
ImportĀ upstreamĀ versionĀ 2.10.0

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 \-\-notification
 
47
Display notification icon
 
48
.TP
 
49
.B \-\-progress
 
50
Display progress indication dialog
 
51
.TP
 
52
.B \-\-question
 
53
Display question dialog
 
54
.TP
 
55
.B \-\-text-info
 
56
Display text information dialog
 
57
.TP
 
58
.B \-\-warning
 
59
Display warning dialog
 
60
 
 
61
.PP
 
62
General options
 
63
 
 
64
.TP
 
65
.B \-\-title=TITLE
 
66
Set the dialog title
 
67
.TP
 
68
.B \-\-window-icon=ICONPATH
 
69
Set the window icon
 
70
.TP
 
71
.B \-\-width=WIDTH
 
72
Set the dialog width
 
73
.TP
 
74
.B \-\-height=HEIGHT
 
75
Set the dialog height
 
76
.PP 
 
77
Calendar options
 
78
 
 
79
.TP
 
80
.B \-\-text=STRING
 
81
Set the dialog text
 
82
.TP
 
83
.B \-\-day=INT
 
84
Set the calendar day
 
85
.TP
 
86
.B \-\-month=INT
 
87
Set the calendar month
 
88
.TP
 
89
.B \-\-year=INT
 
90
Set the calendar year
 
91
.TP
 
92
.B \-\-date-format=STRING
 
93
Set the format for the returned date
 
94
 
 
95
.PP
 
96
Text entry options
 
97
 
 
98
.TP
 
99
.B \-\-text=STRING
 
100
Set the dialog text
 
101
.TP
 
102
.B \-\-entry-text=STRING
 
103
Set the entry text
 
104
.TP
 
105
.B \-\-hide-text
 
106
Hide the entry text
 
107
 
 
108
.PP
 
109
Error options
 
110
.TP
 
111
.B \-\-text=STRING
 
112
Set the dialog text
 
113
 
 
114
.PP
 
115
File selection options
 
116
.TP
 
117
.B \-\-filename=FILENAME
 
118
Set the filename
 
119
.TP
 
120
.B \-\-multiple
 
121
Allow selection of multiple filenames in file selection dialog
 
122
.TP
 
123
.B \-\-separator=SEPARATOR
 
124
Specify separator character when returning multiple filenames
 
125
 
 
126
.PP
 
127
Info options
 
128
.TP
 
129
.B \-\-text=STRING
 
130
Set the dialog text
 
131
 
 
132
.PP
 
133
List options
 
134
 
 
135
.TP
 
136
.B \-\-text=STRING
 
137
Set the dialog text
 
138
.TP
 
139
.B \-\-column=STRING
 
140
Set the column header
 
141
.TP
 
142
.B \-\-checklist
 
143
Use check boxes for first column
 
144
.TP
 
145
.B \-\-radiolist
 
146
Use radio buttons for first column
 
147
.TP
 
148
.B \-\-separator=STRING
 
149
Set output separator character
 
150
.TP
 
151
.B \-\-editable
 
152
Allow changes to text
 
153
.TP
 
154
.B \-\-print-column=STRING
 
155
Specify what column to print to standard output. The default is to return
 
156
the first column. 'ALL' may be used to print all columns.
 
157
 
 
158
.PP
 
159
Notification options
 
160
 
 
161
.TP
 
162
.B \-\-text=STRING
 
163
Set the notification text
 
164
 
 
165
.PP
 
166
Progress options
 
167
 
 
168
.TP
 
169
.B \-\-text=STRING
 
170
Set the dialog text
 
171
.TP
 
172
.B \-\-percentage=INT
 
173
Set initial percentage
 
174
.TP
 
175
.B \-\-auto\-close
 
176
Close dialog when 100% has been reached
 
177
.TP
 
178
.B \-\-pulsate
 
179
Pulsate progress bar
 
180
 
 
181
Question options
 
182
.TP
 
183
.B \-\-text=STRING
 
184
Set the dialog text
 
185
 
 
186
.PP
 
187
Text options
 
188
 
 
189
.TP
 
190
.B \-\-filename=FILENAME
 
191
Open file
 
192
.TP
 
193
.B \-\-editable
 
194
Allow changes to text
 
195
 
 
196
.PP
 
197
Warning options
 
198
 
 
199
.TP
 
200
.B \-\-text=STRING
 
201
Set the dialog text
 
202
 
 
203
.PP
 
204
Miscellaneous options
 
205
 
 
206
.TP
 
207
.B \-?, \-\-help
 
208
Show summary of options.
 
209
.TP
 
210
.B \-\-about
 
211
Display an about dialog.
 
212
.TP
 
213
.B \-\-version
 
214
Show version of program.
 
215
 
 
216
.PP
 
217
Also the standard GTK+ options are accepted.
 
218
 
 
219
.SH EXAMPLES
 
220
 
 
221
Display a file selector with the title \fISelect a file to
 
222
remove\fP. The file selected is returned on standard output.
 
223
.IP
 
224
zenity  --title="Select a file to remove" --file-selection
 
225
.PP
 
226
Display a text entry dialog with the title \fISelect Host\fP and the
 
227
text \fISelect the host you would like to flood-ping\fP. The entered
 
228
text is returned on standard output.
 
229
.IP
 
230
zenity  --title "Select Host" --entry --text "Select the host you would like to flood-ping"
 
231
.PP
 
232
Display a dialog, asking \fIMicrosoft Windows has been found! Would
 
233
you like to remove it?\fP. The return code will be 0 (true in shell)
 
234
if \fIOK\fP is selected, and 1 (false) if \fICancel\fP is selected.
 
235
.IP
 
236
zenity  --question --title "Alert"  --text "Microsoft Windows has been found! Would you like to remove it?"
 
237
.PP
 
238
Show the search results in a list dialog with the title \fISearch Results\fP
 
239
and the text \fIFinding all header files...\fP.
 
240
.IP
 
241
find . -name '*.h' | zenity --title "Search Results" --text "Finding all header files.." --column "Files"
 
242
.PP
 
243
Show an icon in the notification area
 
244
.IP
 
245
zenity --notification --window-icon=update.png --text "System update necessary!"
 
246
.PP
 
247
Display a weekly shopping list in a check list dialog with \fIApples\fP and \fIOranges\fP pre selected
 
248
.IP
 
249
zenity --list --checklist --column "Buy" --column "Item" TRUE Apples TRUE Oranges FALSE Pears FALSE Toothpaste
 
250
.PP
 
251
Display a progress dialog while searching for all the postscript files in your home directory
 
252
.P
 
253
find `echo $HOME` '*.ps' | zenity --progress --pulsate
 
254
.SH AUTHOR
 
255
\fBZenity\fP was written by Glynn Foster <glynn.foster@sun.com>.
 
256
.P
 
257
This manual page was written by Ross Burton <ross@burtonini.com>.
 
258
 
 
259
.SH SEE ALSO
 
260
\fBgdialog\fP(1), \fBdialog\fP(1)