summaryrefslogtreecommitdiff
path: root/data/zenity.1
blob: 83931dd9a6f83ac8f24846b4c3af7230603df5db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
.TH ZENITY 1 "February 1st, 2003"
.SH NAME
zenity \- display GTK+ dialogs
.SH SYNOPSIS
.B zenity
.RI [ options ]
.SH DESCRIPTION
\fBzenity\fP is a program that will display GTK+ dialogs, and return
(either in the return code, or on standard output) the users
input. This allows you to present information, and ask for information
from the user, from all manner of shell scripts.
.PP
For example, \fBzenity \-\-question\fP will return either 0 or 1,
depending on whether the user pressed \fIOK\fP or \fICancel\fP. \fBzenity
--entry\fP will output on standard output what the user typed into the
text entry field.
.PP
Comprehensive documentation is available in the GNOME Help Browser,
under \fIGNOME/Utilities\fP.
.SH OPTIONS
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').

.PP
Dialog options

.TP
.B \-\-calendar
Display calendar dialog
.TP
.B \-\-entry
Display text entry dialog
.TP
.B \-\-error
Display error dialog
.TP
.B \-\-file-selection
Display file selection dialog
.TP
.B \-\-info
Display info dialog
.TP
.B \-\-list
Display list dialog
.TP
.B \-\-notification
Display notification icon
.TP
.B \-\-progress
Display progress indication dialog
.TP
.B \-\-question
Display question dialog
.TP
.B \-\-text-info
Display text information dialog
.TP
.B \-\-warning
Display warning dialog

.PP
General options

.TP
.B \-\-title=TITLE
Set the dialog title
.TP
.B \-\-window-icon=ICONPATH
Set the window icon
.TP
.B \-\-width=WIDTH
Set the dialog width
.TP
.B \-\-height=HEIGHT
Set the dialog height
.PP 
Calendar options

.TP
.B \-\-text=STRING
Set the dialog text
.TP
.B \-\-day=INT
Set the calendar day
.TP
.B \-\-month=INT
Set the calendar month
.TP
.B \-\-year=INT
Set the calendar year
.TP
.B \-\-date-format=STRING
Set the format for the returned date

.PP
Text entry options

.TP
.B \-\-text=STRING
Set the dialog text
.TP
.B \-\-entry-text=STRING
Set the entry text
.TP
.B \-\-hide-text
Hide the entry text

.PP
Error options
.TP
.B \-\-text=STRING
Set the dialog text

.PP
File selection options
.TP
.B \-\-filename=FILENAME
Set the filename
.TP
.B \-\-multiple
Allow selection of multiple filenames in file selection dialog
.TP
.B \-\-separator=SEPARATOR
Specify separator character when returning multiple filenames

.PP
Info options
.TP
.B \-\-text=STRING
Set the dialog text

.PP
List options

.TP
.B \-\-text=STRING
Set the dialog text
.TP
.B \-\-column=STRING
Set the column header
.TP
.B \-\-checklist
Use check boxes for first column
.TP
.B \-\-radiolist
Use radio buttons for first column
.TP
.B \-\-separator=STRING
Set output separator character
.TP
.B \-\-editable
Allow changes to text
.TP
.B \-\-print-column=STRING
Specify what column to print to standard output. The default is to return
the first column. 'ALL' may be used to print all columns.

.PP
Notification options

.TP
.B \-\-text=STRING
Set the notification text

.PP
Progress options

.TP
.B \-\-text=STRING
Set the dialog text
.TP
.B \-\-percentage=INT
Set initial percentage
.TP
.B \-\-auto\-close
Close dialog when 100% has been reached
.TP
.B \-\-pulsate
Pulsate progress bar
 
Question options
.TP
.B \-\-text=STRING
Set the dialog text

.PP
Text options

.TP
.B \-\-filename=FILENAME
Open file
.TP
.B \-\-editable
Allow changes to text

.PP
Warning options

.TP
.B \-\-text=STRING
Set the dialog text

.PP
Miscellaneous options

.TP
.B \-?, \-\-help
Show summary of options.
.TP
.B \-\-about
Display an about dialog.
.TP
.B \-\-version
Show version of program.

.PP
Also the standard GTK+ options are accepted.

.SH EXAMPLES

Display a file selector with the title \fISelect a file to
remove\fP. The file selected is returned on standard output.
.IP
zenity  \-\-title="Select a file to remove" \-\-file-selection
.PP
Display a text entry dialog with the title \fISelect Host\fP and the
text \fISelect the host you would like to flood-ping\fP. The entered
text is returned on standard output.
.IP
zenity  \-\-title "Select Host" \-\-entry \-\-text "Select the host you would like to flood-ping"
.PP
Display a dialog, asking \fIMicrosoft Windows has been found! Would
you like to remove it?\fP. The return code will be 0 (true in shell)
if \fIOK\fP is selected, and 1 (false) if \fICancel\fP is selected.
.IP
zenity  \-\-question \-\-title "Alert"  \-\-text "Microsoft Windows has been found! Would you like to remove it?"
.PP
Show the search results in a list dialog with the title \fISearch Results\fP
and the text \fIFinding all header files...\fP.
.IP
find . \-name '*.h' | zenity \-\-list \-\-title "Search Results" \-\-text "Finding all header files.." \-\-column "Files"
.PP
Show an icon in the notification area
.IP
zenity \-\-notification \-\-window-icon=update.png \-\-text "System update necessary!"
.PP
Display a weekly shopping list in a check list dialog with \fIApples\fP and \fIOranges\fP pre selected
.IP
zenity \-\-list \-\-checklist \-\-column "Buy" \-\-column "Item" TRUE Apples TRUE Oranges FALSE Pears FALSE Toothpaste
.PP
Display a progress dialog while searching for all the postscript files in your home directory
.P
find $HOME \-name '*.ps' | zenity \-\-progress \-\-pulsate
.SH AUTHOR
\fBZenity\fP was written by Glynn Foster <glynn.foster@sun.com>.
.P
This manual page was written by Ross Burton <ross@burtonini.com>.

.SH SEE ALSO
\fBgdialog\fP(1), \fBdialog\fP(1)