1YAD(1) General Commands Manual YAD(1)
2
6 yad - display GTK+ dialogs
7
10 yad [options]
11
14 YAD is a program that will display GTK+ dialogs, and return (either in
15 the return code, or on standard output) the users input. This allows
16 you to present information, and ask for information from the user, from
17 all manner of shell scripts.
18 YAD is the fork of Zenity program.
20
23 This program follows the usual GNU command line syntax, with long
24 options starting with two dashes (`-').
25 Dialog options
28 --calendar
30 Display calendar dialog.
31 --color
33 Display color selection dialog.
34 --dnd Display drag-and-drop box.
36 --entry
38 Display text entry dialog.
39 --icons
41 Display box with shortcut icons.
42 --file Display file selection dialog.
44 --font Display font selection dialog.
46 --form Display form dialog
48 --list Display list dialog
50 --notification
52 Display notification icon.
53 --progress
55 Display progress indication dialog.
56 --text-info
58 Display text information dialog.
59 --scale
61 Display scale dialog.
62 General options
65 --title=TITLE
67 Set the dialog title.
68 --window-icon=ICONPATH
70 Set the window icon.
71 --width=WIDTH
73 Set the dialog width.
74 --height=HEIGHT
76 Set the dialog height.
77 --timeout=TIMEOUT
79 Set the dialog timeout in seconds.
80 --timeout-indicator=POSITION
82 Show timeout indicator in given position. Positions are top,
83 bottom, left or right. Style of indicator may be set through
84 the gtkrc file. See http://code.google.com/p/yad/wiki/Time‐
85 outIndicator for details.
86 --kill-parent
88 Send SIGTERM to parent process.
89 --text=STRING
91 Set the dialog text.
92 --image=IMAGE
94 Set the dialog image which appears on the left side of dialog.
95 IMAGE might be file name or icon name from current icon theme.
96 --image-on-top
98 Show image above main widget instead of left.
99 --icon-theme=THEME
101 Use specified GTK icon theme instead of default.
102 --expander=TEXT
104 Hide main widget with expander. TEXT is an optional argument
105 with expander's label.
106 --button=BUTTON:ID
108 Add the dialog button. May be used several times. ID is an exit
109 code. BUTTON may be gtk stock item name for predefined buttons
110 (like gtk-close or gtk-ok) or simple text label. Full list of
111 stock items may be found in gtk-demo program, in snippet called
112 "Stock Items and Icon Browser". If no buttons specified OK and
113 Cancel buttons used. See EXIT STATUS section for more.
114 --no-buttons
116 Don't show buttons.
117 --no-markup
119 Don't use pango markup in dialog's text.
120 --always-print-result
122 Always print result.
123 --dialog-sep
125 Show separator between dialog and buttons. Works only with
126 gtk+-2.0.
127 --borders=NUM
129 Set dialog window borders.
130 --sticky
132 Make window visible on all desktops.
133 --fixed
135 Make window fixed width and height.
136 --center
138 Place window on center of screen.
139 --mouse
141 Place window under mouse position.
142 --on-top
144 Place window over other windows.
145 --undecorated
147 Make window undecorated (remove title and window borders).
148 --skip-taskbar
150 Don't show window in taskbar and pager.
151 --geometry=WIDTHxHEIGHT+X+Y
153 Use standard X Window geometry notation for placing dialog.
154 When this option is used, width, height, mouse and center
155 options are ignored.
156 --selectable-labels
158 If set, user can select dialog's text and copy it to clipboard.
159 This option also affects on label fields in form dialog.
160 Calendar options
163 --day=INT
165 Set the calendar day.
166 --month=INT
168 Set the calendar month.
169 --year=INT
171 Set the calendar year.
172 --date-format=PATTERN
174 Set the format for the returned date. By default is `%x'. See
175 strftime(3) for more details.
176 --details=FILENAME
178 Read days description from IFILENAMEP.
179 File with days details must be in following format:
181 <date> <description>
183 date field is date in format, specified with --date-format option.
185 description is a string with date details, which may include Pango
186 markup.
187 Color selection options
190 --init-color=COLOR
192 Set initial color value.
193 --extra
195 Show extra information about color in returned string.
196 --palette[=FILENAME]
198 Show palette ans set predefined colors from given filename. By
199 default used /etc/X11/rgb.txt.
200 Drag-and-Drop box options
203 --command=CMD
205 Run command when data received. Data strings pass to command as
206 an agrument. By default data just prints to stdout.
207 Text entry options
210 --entry-label=STRING
212 Set the entry label text.
213 --entry-text=STRING
215 Set the initial entry text.
216 --hide-text
218 Hide the entry text.
219 --completion
221 Use completion instead of combo-box.
222 --editable
224 Allow changes to text in combo-box.
225 --numeric
227 Use spin button instead of text entry. Additional parameters in
228 command line treats as minimum and maximum values and step value
229 (in that order). All this values are optional. Default range is
230 from 0 to 65535 with step 1.
231 --licon
233 Set an icon on a left side of entry.
234 --licon-action
236 Specify a command which will be run when the left icon clicked.
237 Output of command will be set as entry text.
238 --ricon
240 Set an icon on a right side of entry.
241 --ricon-action
243 Specify a command which will be run when the right icon clicked.
244 Output of command will be set as entry text.
245 Any extra data specified in command line adds as an items of
247 combo-box entry, except of numeric mode.
248 If icon specified and icon action is not given, click on icon
250 just clear the entry. Icons are available only for entry field.
251 Numeric field or combo-boxes will ignore the icons.
252 Iconbox options
255 --read-dir=DIRECTORY
257 Read .desktop files from specified directory.
258 --generic
260 Use field GenericName instead of Name for shortcut label.
261 --sort-by-name
263 Use field Name instead of filename for sorting items.
264 --descend
266 Sort items in descending order. If data reads from stdin this
267 option is useless without --sort-by-name.
268 --stdin
270 Read data from stdin. Data must be in order - Name, Tooltip,
271 Icon, Command, InTerm separated by newline. InTerm is a case
272 insensitive boolean constant (TRUE or FALSE).
273 --item-width
275 Set items width.
276 --term Pattern for terminal. By default use `xterm -e %s' where %s
278 replaced by the command.
279 If both directory and stdin specified, content of iconbox will
281 be read from directory.
282 File selection options
285 --filename=FILENAME
287 Set the filename.
288 --multiple
290 Allow selection of multiple filenames in file selection dialog.
291 --directory
293 Activate directory-only selection.
294 --save Activate save mode.
296 --separator=STRING
298 Specify separator character when returning multiple filenames.
299 --confirm-overwrite[=TEXT]
301 Confirm file selection if filename already exists. Optional
302 argument is a text for confirmation dialog.
303 Font selection options
306 --fontname=FONTNAME
308 Set the initial font. FONTNAME is a string with font representa‐
309 tion in the form [FAMILY-LIST] [STYLE-OPTIONS] [SIZE].
310 --preview
312 Set the preview text.
313 Form options
316 --field=LABEL[:TYPE]
318 Add field to form. Type may be H, RO, NUM, CHK, CB, CBE, FL,
319 DIR, FN, MFL, DT, CLR,BTN or LBL. H - hidden field type. All
320 characters are displayed as the invisible char. RO - field is
321 in read-only mode. NUM - field is a numeric. Initial value for‐
322 mat for this field is VALUE[!RANGE[!STEP]], where RANGE must be
323 in form MIN..MAX. `!' is a default item separator. CHK - check‐
324 box field. Initial value is a case insensitive boolean constant
325 (TRUE or FALSE). CB - combo-box field. Initial value is a list
326 VAL1!VAL2!.... The separator is the same as in NUM field. CBE -
327 editable combo-box field. Initial value same as for combo-box.
328 FL - file selection button. DIR - directory selection button.
329 FN - font selection button. Initial value same as in font dia‐
330 log. MFL - select multiple files. Value of this field is a list
331 of files separated by item-separator. DT - date field. CLR -
332 color selection button. BTN - button field. Initial value is a
333 command runs when button is clicked. LBL - text label. If field
334 name is empty, horisontal separator line will be shown.
335 --align=TYPE
337 Set alignment of fields labels. Possible types are left, center
338 or right. Default is left.
339 --columns=NUMBER
341 Set number of columns in form. Fields will be placed from top to
342 bottom.
343 --separator=STRING
345 Set output separator character. Default is `|'.
346 --item-separator=STRING
348 Set separator character for combo-box or scale values. Default
349 is `!'.
350 --date-format=PATTERN
352 Set the format for the date fields (same as in calendar dialog).
353 Additional data in command line interprets as a default values for form
355 fields.
356 List options
359 --column=STRING[:TYPE]
361 Set the column header. Types are TEXT, NUM, FLT, CHK, IMG or
362 TIP. TEXT type is default. Use NUM for integers and FTL for
363 double values. TIP is used for define tooltip column. IMG may
364 be path to image or icon name from currnet GTK+ icon theme.
365 Size of icons may be set in config file. Image field prints as
366 empty value.
367 Special column names @fore@, @back@ and @font@ sets correspond‐
369 ing rows attributes. Values of those columns don't show in
370 results.
371 --checklist
373 Use check boxes for first column.
374 --separator=STRING
376 Set output separator characters.
377 --multiple
379 Allow multiple rows to be selected.
380 --editable
382 Allow changes to text.
383 --no-headers
385 Do not show column headers
386 --print-all
388 Print all data from the list.
389 --print-column=NUM
391 Specify what column will be printed to standard output. 0 may be
392 used to print all columns (this is default).
393 --hide-column=NUMBER
395 Hide a specific column.
396 --expand-column=NUMBER
398 Set the column expandable by default. 0 sets all columns expand‐
399 able.
400 --search-column=NUMBER
402 Set the quick search column. 0 mean to disable searching. By
403 default search mades on first column.
404 --limit=NUMBER
406 Set the number of rows in list dialog. Will be shown only the
407 last NUMBER rows. This option will take effect only when data
408 reading from stdin.
409 --ellipsize=TYPE
411 Set ellipsize mode for text columns. TYPE may be NONE, START,
412 MIDDLE or END.
413 --dclick-action=CMD
415 Set the CMD as a double-click command. When user double-clicked
416 on row, CMD will be launched with values of all columns as an
417 arguments. By default double-click selects row and act as OK
418 button for simple lists, set the checkbox if --checklist speci‐
419 fied and do nothing when list run with --multiple option. When
420 double-click specified Enter acts as a double-click and
421 Ctrl+Enter acts as an OK button. CMD may contain a special
422 character `%s' for setting a position for arguments. By default
423 arguments will be concatenated to the end of CMD.
424 --regex-search
426 Use regular expressions in search for text fields.
427 Notification options
430 --command=CMD
432 Set the command running when clicked on the icon.
433 --listen
435 Listen for commands on stdin. See NOTIFICATION section.
436 --separator=STRING
438 Set separator character for menu values. Default is `|'.
439 --item-separator=STRING
441 Set separator character for menu items. Default is `!'.
442 See NOTIFICATION section for more about separators.
444 Progress options
447 When the --progress option is used, yad reads lines of progress data
449 from stdin. When the lines begin with # the text after # is displayed
450 in the progress bar label. Numeric values treats like a persents for
451 progress bar.
452 --progress-text=STRING
454 Set text in progress bar to STRING.
455 --percentage=INT
457 Set initial percentage.
458 --rtl Set Right-To-Left progress bar direction.
460 --auto-close
462 Close dialog when 100% has been reached.
463 --auto-kill
465 Kill parent process if cancel button is pressed.
466 --pulsate
468 Pulsate progress bar.
469 Text options
472 --filename=FILENAME
474 Open specified file.
475 --editable
477 Allow changes to text.
478 --fore=COLOR
480 Set foreground color of text
481 --back=COLOR
483 Set background color of text
484 --fontname=FONT
486 Set text font. FONT must be in a Pango font description format.
487 --wrap Enable text wrapping.
489 --justify=TYPE
491 Set justification. TYPE may be left, right, center or fill.
492 Default is left.
493 --margins=SIZE
495 Set text margins to SIZE.
496 --tail Autoscroll to end when new text appears. Works only when text is
498 read from stdin.
499 --show-uri
501 Make URI in text clickable. Links opens with xdg-open command.
502 Scale options
505 --value=VALUE
507 Set initial value.
508 --min-value=VALUE
510 Set minimum value.
511 --max-value=VALUE
513 Set maximum value.
514 --step=VALUE
516 Set step size.
517 --page=VALUE
519 Set paging size. By default page value is STEP*10.
520 --print-partial
522 Print partial values.
523 --hide-value
525 Hide value.
526 --vertical
528 Show vertical scale.
529 --invert
531 Invert scale direction.
532 --mark=[NAME]:VALUE
534 Add a mark to scale. May be used multiply times. NAME is an
535 optional arguments for set label to mark.
536 Miscellaneous options
539 -?, --help
541 Show summary of options.
542 --about
544 Display an about dialog.
545 --version
547 Show version of program.
548 Also the standard GTK+ options are accepted.
551
554 Allows commands to be sent to yad in the form command:args. Possible
555 commands are icon, tooltip, visible, action, menu and quit.
556 icon:ICONNAME
558 Set notification icon to ICONNAME.
559 tooltip:STRING
561 Set notification tooltip.
562 visible:[true|false|blink]
564 Set notification icon to visible, invisible or blinking states.
565 action:COMMAND
567 Specify the command running when double-clicked on the icon.
568 Special string "quit" exit the program.
569 menu:STRING
571 Set popup menu for notification icon. STRING must be in form
572 name1!action1|name2!action2.... Empty name add separator to
573 menu. Separator character for values (e.g. `|') sets with
574 --separator argument. Separator character for menu items (e.g.
575 `!') sets with --item-separator argument.
576 quit Exit the program. Middle click on icon also send quit command.
578
581 SIGUSR1
582 Close dialog with 0 exit code.
583 SIGUSR2
585 Close dialog with 1 exit code.
586
589 0 The user has pressed OK button
590 1 The user has pressed Cancel button
592 70 The dialog has been closed because the timeout has been reached.
594 252 The dialog has been closed by pressing Esc or used the window
596 functions to close the dialog
597 Exit codes for user-specified buttons must be specified in command
599 line. Even exit code mean to print result, odd just return exit code.
600
603 The look and feel of yad's dialogs can be customized through gtkrc
604 file. Here is the names of yad's widgets:
605 Widget name Widget type Description
608 ─────────────────────────────────────────────────────────────────────────────────
609 yad-dialog-window GtkDialog Dialog window
610 yad-dialog-image GtkImage Dialog image
611 yad-dialog-label GtkLabel Dialog text
612 yad-calendar-widget GtkCalendar Calendar widget
613 yad-color-widget GtkColorChooser Color selection widget
614 yad-color-palette GtkTreeView Predefined colors list
615 yad-entry-label GtkLabel Entry label
616 yad-entry-widget GtkEntry Entry widget
617 yad-entry-spin GtkSpinButton Entry widget for numeric values
618 yad-entry-combo GtkComboBox Entry widget with combo
619 yad-entry-edit-combo GtkComboBoxEntry Entry widget with editable combo
620 yad-file-widget GtkFileChooser File selection widget
621 yad-font-widget GtkFontChooser Font selection widget
622 yad-form-flabel GtkLabel Field label in form
623 yad-form-button GtkButton Button field in form
624 yad-form-entry GtkEntrfy Entry field in form
625 yad-form-spin GtkSpinButton Numeric entry field in form
626 yad-form-check GtkCheckButton Checkbox field in form
627 yad-form-combo GtkComboBox Combo field in form
628 yad-form-edit-combo GtkComboBoxEntry Editable combo field in form
629 yad-form-file GtkFileChooserButton File or directory field in form
630 yad-form-font GtkFontChooserButton Font field in form
631 yad-form-color GtkColorChooserButton Color field in form
633 yad-form-label GtkLabel Label field in form
634 yad-form-separator GtkHSeparator Separator in form
635 yad-icons-full GtkIconView Icons widget for normal mode
636 yad-icons-compact GtkTreeView Icons widget for compact mode
637 yad-list-widget GtkTreeView List widget
638 yad-progress-widget GtkProgressBar Progressbar widget
639 yad-vscale-widget GtkScale Vertical scale widget
640 yad-hscale-widget GtkScale Horizontal scale widget
641 yad-text-widget GtkTextView Text info widget
642 yad-timeout-indicator GtkProgreeBar Timeout indicator
643
646 Display a file selector with the title Select a file to remove. The
647 file selected is returned on standard output.
648 yad --title="Select a file to remove" --file-selection
650 Display a text entry dialog with the title Select Host and the text
652 Select the host you would like to flood-ping. The entered text is
653 returned on standard output.
654 yad --title "Select Host" --entry --text "Select the host you
656 would like to flood-ping"
657 Display a dialog, asking Microsoft Windows has been found! Would you
659 like to remove it?. The return code will be 0 (true in shell) if YES is
660 selected, and 1 (false) if NO is selected.
661 yad --image "dialog-question" --title "Alert" --button=gtk-
663 yes:0 --button=gtk-no:1 --text "Microsoft Windows has been
664 found! Would you like to remove it?"
665 Show the search results in a list dialog with the title Search Results
667 and the text Finding all header files....
668 find . -name '*.h' | yad --list --title "Search Results" --text
670 "Finding all header files.." --column "Files"
671 Show an icon in the notification area
673 yad --notification --image=update.png --text "System update nec‐
675 essary!" --command "xterm -e apt-get upgrade"
676 Display a weekly shopping list in a check list dialog with Apples and
678 Oranges pre selected
679 yad --list --checklist --column "Buy" --column "Item" TRUE
681 Apples TRUE Oranges FALSE Pears FALSE Toothpaste
682 Display a progress dialog while searching for all the postscript files
684 in your home directory
685 find $HOME -name '*.ps' | yad --progress --pulsate
687 Display a box with all of the installed desktop applications
689 yad --icons --read-dir=/usr/share/applications
691
694 There are some developers features providing with YAD.
695 YAD icon browser is a graphical tool for discover icons in current or
697 user-specified GTK+ icon theme. Launch it as
698 yad-icon-browser [theme]
700 When using autoconf you may use special m4 macro AM_PATH_YAD for look‐
702 ing for yad and check it version. Usage of this macro is
703 AM_PATH_YAD([MIN-VERSION],[ACT-FOUND],[ACT-NOT-FOUND])
705
707 Yad was written by Victor Ananjevsky <ananasik@gmail.com>.
708
711 gdialog(1), dialog(1), zenity(1)
712 Marth 24, 2011 YAD(1)