1YAD(1) User Commands YAD(1)
2
6 yad - display GTK+ dialogs from shell scripts or command-line
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 you
16 to present information, and ask for information from the user, from all
17 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 --app Display application selection dialog.
29 --calendar
31 Display calendar dialog.
32 --color
34 Display color selection dialog.
35 --dnd Display drag-and-drop box.
37 --entry
39 Display text entry dialog.
40 --icons
42 Display box with shortcut icons.
43 --file Display file selection dialog.
45 --font Display font selection dialog.
47 --form Display form dialog
49 --html Display HTML dialog
51 --list Display list dialog
53 --multi-progress
55 Display multi progress bars dialog.
56 --notebook
58 Display notebook dialog.
59 --notification
61 Display notification icon.
62 --print
64 Display print dialog.
65 --progress
67 Display progress indication dialog.
68 --text-info
70 Display text information dialog.
71 --scale
73 Display scale dialog.
74 General options
77 --title=TITLE
78 Set the dialog title.
79 --window-icon=ICON
81 Set the window icon.
82 --width=WIDTH
84 Set the dialog window width.
85 --height=HEIGHT
87 Set the dialog window height.
88 --posx=NUMBER
90 Set the X position of dialog window. NUMBER can be negative.
91 --posy=NUMBER
93 Set the Y position of dialog window. NUMBER can be negative.
94 --geometry=WIDTHxHEIGHT+X+Y
96 Use standard X Window geometry notation for placing dialog.
97 When this option is used, width, height, posx, posy, mouse and
98 center options are ignored.
99 --timeout=TIMEOUT
101 Set the dialog timeout in seconds.
102 --timeout-indicator=POSITION
104 Show timeout indicator in given position. Positions are top,
105 bottom, left or right. Style of indicator may be set through
106 the users CSS styles.
107 --kill-parent=[SIGNAL]
109 Send SIGNAL to parent process. Default value of SIGNAL is a
110 SIGTERM. SIGNAL may be specified by it's number or symbolic
111 name with or without SIG prefix. See signal(7) for details
112 about signals.
113 --print-xid=[FILENAME]
115 Output X Window ID of a yad's window to the specified file or
116 stderr.
117 --plug=KEY
119 Run dialog in plug mode for swallow as a notebook tab. See NOTE‐
120 BOOK section for more.
121 --tabnum=NUMBER
123 Set the tab number for plugged dialog. See NOTEBOOK section for
124 more.
125 --text=STRING
127 Set the dialog text.
128 --text-width=NUMBER
130 Set the maximum dialog text width in characters.
131 --text-align=TYPE
133 Set type of dialog text justification. TYPE may be left, right,
134 center or fill.
135 --image=IMAGE
137 Set the dialog image which appears on the left side of dialog.
138 IMAGE might be file name or icon name from current icon theme.
139 --icon-theme=THEME
141 Use specified GTK icon theme instead of default.
142 --keep-icon-size
144 Don't scale icons. This option affects icons outside icon theme.
145 --expander=[TEXT]
147 Hide main widget with expander. TEXT is an optional argument
148 with expander's label.
149 --button=BUTTON:ID
151 Add the dialog button. May be used multiple times. ID is an exit
152 code or a command. BUTTON may be a yad stock item name for pre‐
153 defined buttons (like yad-close or yad-ok) or text in a form
154 LABEL[!ICON[!TOOLTIP]] where `!' is an item separator. Full
155 list of stock items may be found in section STOCK ITEMS. If no
156 buttons specified OK and Cancel buttons used. See EXIT STATUS
157 section for more. If ID have a non-numeric value it treats as a
158 command and click on such button doesn't close the dialog.
159 --no-buttons
161 Don't show buttons.
162 --buttons-layout=TYPE
164 Set buttons layout type. Possible types are: spread, edge,
165 start, end or center. Default is end.
166 --no-markup
168 Don't use pango markup in dialog's text.
169 --no-escape
171 Don't close dialog if Escape was pressed.
172 --escape-ok
174 Escape acts like pressing OK button.
175 --always-print-result
177 Print result for any of the return codes. This option doesn't
178 work if timeout was reached or Escape was pressed.
179 --use-interp=[INTERP]
181 All commands runs unter specified interpreter. Default is bash
182 -c '%s'. This option can reduse quoting in commands. If %s is
183 specified, it will be replaced by the command. Otherwise com‐
184 mand will be appended to the end of command line.
185 --uri-handler=CMD
187 Use CMD as uri handler. By default yad uses open-command parame‐
188 ter from settings. URI replace %s in command string or adds as a
189 last part of command line.
190 --borders=NUM
192 Set dialog window borders.
193 --sticky
195 Make window visible on all desktops.
196 --fixed
198 Make window fixed width and height.
199 --center
201 Place window on center of screen.
202 --mouse
204 Place window under mouse position.
205 --on-top
207 Place window over other windows.
208 --undecorated
210 Make window undecorated (remove title and window borders).
211 --skip-taskbar
213 Don't show window in taskbar and pager.
214 --maximized
216 Run dialog window maximized.
217 --fullscreen
219 Run dialog in fullscreen mode. This option may not work on all
220 window managers.
221 --splash
223 Open window with "splashscreen" window hints. For details see
224 description of _NET_WM_WINDOW_TYPE_SPLASH in EWMH specification.
225 The behavior of dialog with this option is HIGHLY DEPENDS on
226 settings of your window manager.
227 --no-focus
229 Dialog window never take focus.
230 --close-on-unfocus
232 Close the dialog window when it loose the focus.
233 --selectable-labels
235 If set, user can select dialog's text and copy it to clipboard.
236 This option also affects on label fields in form dialog.
237 --image-path=PATH
239 Add specified path to the standard list of directories for look‐
240 ing for icons. This option can be used multiple times.
241 --rest=FILENAME
243 Read extra arguments from given file instead of command line.
244 Each line of a file treats as a single argument.
245 --response=NUMBER
247 Set default exit code to NUMBER instead of 0.
248 --css=STRING
250 Read and parse additional GTK+ CSS styles from given data. If
251 STRING is filename, the content of file is loaded. If not STRING
252 treats like CSS data.
253 --gtkrc=FILENAME
255 Read and parse additional GTK+ CSS styles from given file. This
256 option is deprecated. Use --css instead.
257 --hscroll-policy=TYPE
259 Set the policy type for horizontal scrollbars. TYPE can be one
260 of the auto, always or never. Default is auto.
261 --vscroll-policy=TYPE
263 Set the policy type for vertical scrollbars. TYPE can be one of
264 the auto, always or never. Default is auto.
265 --enable-spell
267 Enable spell checking in textview widgets
268 --spell-lang=LANGUAGE
270 Set spell checking language to LANGUAGE. By default language
271 guesses from current locale. Use option --show-langs for get
272 list of all possible languages.
273 --bool-fmt=TYPE
275 Set the output type of boolean values to TYPE. Possible types
276 are T, t, Y, y, O, o and 1.
277 T and t - for true/false pair in appropriate case.
278 Y and y - for yes/no pair in appropriate case.
279 O and o - for on/off pair in appropriate case.
280 1 - for 1/0 pair.
281 Application selection options
284 --enable-fallback
285 Show fallback applications.
286 --enable-other
288 Show other applications.
289 --enable-all
291 Show all available applications.
292 --extened
294 Shown extended information about choosen application. By default
295 only executable is shown. In extended form the output fields are
296 name, display name, description, icon and executable.
297 Additional argument for application dialog is a mime-type. If
299 mime-type is not specified text/plain will be used.
300 Calendar options
303 --day=NUMBER
304 Set the calendar day.
305 --month=NUMBER
307 Set the calendar month.
308 --year=NUMBER
310 Set the calendar year.
311 --date-format=PATTERN
313 Set the format for the returned date. By default is `%x'. See
314 strftime(3) for more details.
315 --show-weeks
317 Show the week numbers at the left side of calendar.
318 --details=FILENAME
320 Read days description from FILENAME.
321 File with days details must be in following format:
323 <date> <description>
325 date field is date in format, specified with --date-format option.
327 description is a string with date details, which may include Pango
328 markup.
329 Color selection options
332 --init-color=COLOR
333 Set initial color value.
334 --gtk-palette
336 Show system palette inside color dialog. For GTK+3 builds this
337 option shows palette instead of color editor.
338 --alpha
340 Add opacity to output color string.
341 --palette=[FILENAME]
343 Show palette and set predefined colors from given filename. By
344 default yad use file /etc/X11/rgb.txt.
345 --expand-palette
347 Expander for list of user-defined colors will be initially
348 opened.
349 --mode=MODE
351 Set output color mode. Possible values are hex or rgb. Default
352 is hex. HEX mode looks like #rrggbbaa, RGB mode - rgba(r, g, b,
353 a). In RGBA mode opacity have values from 0.0 to 1.0.
354 Drag-and-Drop box options
357 --tooltip
358 Use dialog text as a tooltip for Drag-and-Drop box.
359 --command=CMD
361 Run command when data received. Data strings pass to command as
362 an argument or replace %s modifier in a command. By default
363 data just prints to stdout.
364 --exit-on-drop=NUMBER
366 Exit after NUMBER of drops was reached. 0 means infinite number
367 of drops, this is the default.
368 Text entry options
371 --entry-label=STRING
372 Set the entry label text.
373 --entry-text=STRING
375 Set the initial entry text or default item in combo-box.
376 --hide-text
378 Hide the entry text.
379 --completion
381 Use completion instead of combo-box.
382 --complete=TYPE
384 Use specific type for extended completion. TYPE can be any for
385 match any of typed words, all for match all of typed words or
386 regex when typed text treats as regular expression.
387 --editable
389 Allow make changes to text in combo-box.
390 --numeric
392 Use spin button instead of text entry. Additional parameters in
393 command line treats as minimum and maximum values, step value
394 and precisions (in that order). All this values are optional.
395 Default range is from 0 to 65535 with step 1.
396 --float-precision=NUMBER
398 Set precision of floating point numbers. By default precision is
399 three digits after point.
400 --licon=IMAGE
402 Set an icon on a left side of entry.
403 --licon-action=CMD
405 Specify a command which will be run when the left icon clicked.
406 Output of command will be set as entry text.
407 --ricon=IMAGE
409 Set an icon on a right side of entry.
410 --ricon-action=CMD
412 Specify a command which will be run when the right icon clicked.
413 Output of command will be set as entry text.
414 --num-output
416 Output index of active element instead of text for combo-box
417 entry.
418 Any extra data specified in command line adds as an items of combo-box
420 entry, except of numeric mode.
421 If icon specified and icon action is not given, click on icon just
423 clear the entry. Numeric fields will ignore the icons.
424 Iconbox options
427 --read-dir=PATH
428 Read .desktop files from specified directory.
429 --monitor
431 Watch for changes in directory and automatically update content
432 of iconbox.
433 --generic
435 Use field GenericName instead of Name for shortcut label.
436 --sort-by-name
438 Use field Name instead of filename for sorting items.
439 --descend
441 Sort items in descending order. If data reads from stdin this
442 option is useless without --sort-by-name.
443 --listen
445 Read data from stdin. Data must be in order - Name, Tooltip,
446 Icon, Command, InTerm separated by newline. InTerm is a case
447 insensitive boolean constant (TRUE or FALSE). Sending FormFeed
448 character clears iconbox.
449 --item-width
451 Set items width.
452 --icon-size
454 Force using specified icon size. This option doesn't work in
455 compact mode.
456 --compact
458 Use compact mode. Icon and name of each item is placed in a sin‐
459 gle row.
460 --single-click
462 Activate items by single mouse click. This option may not works
463 properly in case of compact mode.
464 --term Pattern for terminal. By default use `xterm -e %s' where %s
466 replaced by the command.
467 If both directory and stdin specified, content of iconbox will be read
469 from directory.
470 File selection options
473 --filename=FILENAME
474 Set the filename.
475 --multiple
477 Allow selection of multiple filenames in file selection dialog.
478 --directory
480 Activate directory-only selection.
481 --save Activate save mode.
483 --separator=STRING
485 Specify separator character when returning multiple filenames.
486 --confirm-overwrite=[TEXT]
488 Confirm file selection if filename already exists. Optional
489 argument is a text for confirmation dialog.
490 --quoted-output
492 Output values will be shell-style quoted.
493 Font selection options
496 --fontname=FONTNAME
497 Set the initial font. FONTNAME is a string with font representa‐
498 tion in the form "[FAMILY-LIST] [STYLE-OPTIONS] [SIZE]".
499 --preview
501 Set the preview text.
502 --separate-output
504 Separate output of selected font description.
505 --separator=STRING
507 Set output separator character. Default is `|'.
508 --quoted-output
510 Output data will be in shell-style quotes.
511 Form options
514 --field=LABEL[!TOOLTIP][:TYPE]
515 Add field to form. Type may be H, RO, NUM, CHK, CB, CBE, CE, FL,
516 SFL, DIR, CDIR, FN, MFL, MDIR, DT, SCL, APP, CLR, BTN, FBTN, LBL
517 or TXT.
518 H - hidden field type. All characters are displayed as the
519 invisible char.
520 RO - field is in read-only mode.
521 NUM - field is a numeric. Initial value format for this field is
522 VALUE[!RANGE[!STEP![PREC]]], where RANGE must be in form
523 MIN..MAX. `!' is a default item separator. PREC is a precision
524 for decimals.
525 CHK - checkbox field. Initial value is a case insensitive bool‐
526 ean constant (TRUE or FALSE).
527 CB - combo-box field. Initial value is a list VAL1!VAL2!.... The
528 separator is the same as in NUM field. Value started with `^'
529 threats as default for combo-box.
530 CBE - editable combo-box field. Initial value same as for combo-
531 box.
532 CE - entry with completion. Initial value same as for combo-box.
533 FL - file selection button.
534 SFL - field for create file.
535 DIR - directory selection button.
536 CDIR - field for create folder.
537 FN - font selection button. Initial value same as in font dia‐
538 log.
539 MFL - select multiple files. Value of this field is a list of
540 files separated by item-separator.
541 MDIR - select multiple folders. Value of this field is a list of
542 folders separated by item-separator.
543 DT - date field.
544 SCL - scale field. Value of this field in a range 0..100.
545 APP - application selection button. Input value for this field
546 is mime-type. Output value - executable for selected applica‐
547 tion.
548 CLR - color selection button. Output values for this field gen‐
549 erates in the same manner as for color dialog.
550 BTN - button field. Label may be in form text in a form
551 LABEL[!ICON[!TOOLTIP]] where `!' is an item separator. LABEL is
552 a text of button label or yad stock id. ICON is a buttons icon
553 (stock id or file name). TOOLTIP is an optional text for popup
554 help string. Initial value is a command which is running when
555 button is clicked. A special sympols %N in command are replaced
556 by value of field N. If command starts with @, the output of
557 command will be parsed and lines started with number and colon
558 will be treats as a new field values. A quoting style for value
559 when sh -c is used - a single quotes around command and double
560 quotes around -c argument
561 FBTN - same as button field, but with full relief of a button.
562 LINK - link button field.
563 LBL - text label. If field name is empty, horizontal separator
564 line will be shown.
565 TXT - multiline text entry. This field is always occupy all of
566 form width.
567 Without type field will be a simple text entry.
569 --align=TYPE
571 Set alignment of field labels. Possible types are left, center
572 or right. Default is left.
573 --columns=NUMBER
575 Set number of columns in form. Fields will be placed from top to
576 bottom.
577 --separator=STRING
579 Set output separator character. Default is `|'.
580 --focus-field=NUMBER
582 Set focused field.
583 --cycle-read
585 Cycled reading of stdin data. Sending FormFeed character clears
586 the form. This symbol may be sent as echo -e '\f'.
587 --item-separator=STRING
589 Set separator character for combo-box or scale values. Default
590 is `!'.
591 --date-format=PATTERN
593 Set the format for the date fields (same as in calendar dialog).
594 --float-precision=NUMBER
596 Set precision of floating point numbers. By default precision is
597 three digits after point.
598 --complete=TYPE
600 Use specific type for extended completion. TYPE can be any for
601 match any of typed words, all for match all of typed words or
602 regex when typed text treats as regular expression.
603 --scroll
605 Make form scrollable.
606 --quoted-output
608 Output values will be in shell-style quotes.
609 --output-by-row
611 Output field values row by row if several columns is specified.
612 --num-output
614 Output index of active element instead of text for combo-box
615 fields.
616 Additional data in command line interprets as a default values for form
618 fields. A special value @disabled@ makes corresponding field inactive.
619 If no extra arguments specified in a command line, data will be readed
620 from stdin, one value per line. Cycled reading means that for N fields
621 N+1 value will replace the first field. Empty values are skipped when
622 reading from stdin.
623 HTML options
626 --uri=URI
627 Open specified location. URI can be a filename or internet
628 address. If URI is not an existing file and protocol is not
629 specified a prefix http:// will be added to URI.
630 --browser
632 Turn on browser mode. In this mode all clicked links will be
633 opened in html widget and command Open will be added to context
634 menu.
635 --print-uri
637 Print clicked links to standard output. By default clicked links
638 opens with xdg-open.
639 --mime=MIME
641 Set mime type of data passed to standard input to MIME. Default
642 is text/html.
643 --encodintg=ENCODING
645 Set encoding of data passed to standard input to ENCODING.
646 Default is UTF-8.
647 --uri-handler=CMD
649 Set external handler for clicked uri. %s will be replaced by
650 activated uri. Return code of the CMD must be 0 for keep work‐
651 ing, 1 for ignoring uri and 2 for downloading uri. This option
652 works only in browser mode. There are two environment variables
653 available in handler - YAD_HTML_BUTTON with value of pressed
654 mouse button and YAD_HTML_STATE with value of bitmask with the
655 the state of the modifier keys.
656 --user-agent=STRING
658 Set user agent string. Default is YAD-Webkit (@VERSION@)
659 --user-style=URI
661 Set path or uri to custom user styles. Path to local file can be
662 an absolute file name or uri with file:// prefix.
663 When dialog wors in browser mode additional data in command line inter‐
665 prets as URI.
666 List options
669 --column=STRING[:TYPE]
670 Set the column header. Types are TEXT, NUM, SZ, FLT, CHK, RD,
671 BAR, IMG, HD or TIP. TEXT type is default. Use NUM for integers
672 and FLT for double values. TIP is used for define tooltip col‐
673 umn. SZ size column type. Works exactly like NUM column but
674 shows human readable sizes instead of numbers. CHK (checkboxes)
675 and RD (radio toggle) are a boolean columns. BAR is a progress
676 bar column. Value must be between 0 and 100. If value is outside
677 is range it will be croped to neares legal value. HD type means
678 a hidden column. Such columns are not displayes in the list,
679 only in output. IMG may be path to image or icon name from cur‐
680 rnet GTK+ icon theme. Size of icons may be set in gtk config
681 file at GTK_ICON_SIZE_MENU position of gtk-icon-sizes. Image
682 field prints as empty value.
683 Special column names @fore@, @back@ and @font@ sets correspond‐
685 ing rows attributes. Values of those columns don't show in
686 results.
687 Column title can be specified in form name!tooltip and Pango
689 markup can be used in name and tooltip parts.
690 --tree Enbale tree mode. In this mode extra data in form ROW_ID[:PAR‐
692 ENT_ID] must be passed to yad before each row. See EXAMPLES for
693 details.
694 --checklist
696 Use check boxes for the first column. Output checked rows
697 instead of selected rows. Disable multiple selection.
698 --radiolist
700 Same as --checklist but with a radio toggle for the first col‐
701 umn.
702 --separator=STRING
704 Set output separator characters.
705 --multiple
707 Allow multiple rows to be selected.
708 --editable
710 Allow changes to text.
711 --editable-cols=LIST
713 Set the list of editable columns. LIST must be a string of num‐
714 bers separated by comma.
715 --no-headers
717 Do not show column headers.
718 --no-click
720 Disable sorting of column content by clicking on its header.
721 --no-rules-hint
723 Don't draw even and odd rows by a different colors. This option
724 depends on your current gtk theme and may not work.
725 --grid-lines=TYPE
727 Draw grid lines of type TYPE in list dialog. TYPE can be one of
728 the hor[izontal], vert[ical] of both.
729 --no-selection
731 Disable selection in list.
732 --print-all
734 Print all data from the list.
735 --print-column=NUMBER
737 Specify what column will be printed to standard output. 0 may be
738 used to print all columns (this is default).
739 --hide-column=NUMBER
741 Hide a specific column.
742 --expand-column=NUMBER
744 Set the column expandable by default. 0 sets all columns expand‐
745 able.
746 --search-column=NUMBER
748 Set the quick search column. 0 mean to disable searching. By
749 default search mades on first column.
750 --tooltip-column=NUMBER
752 Set the column with popup tooltips.
753 --sep-column=NUMBER
755 Set the row separator column. If the cell value from this column
756 equal to specified row separator value such row will be draw as
757 separator. Separator value must be set.
758 --sep-value=TEXT
760 Set the TEXT as a row separator value. This feature highly
761 depends on your current GTK+ theme and may not work properly.
762 --limit=NUMBER
764 Set the number of rows in list dialog. Will be shown only the
765 last NUMBER rows. This option will take effect only when data
766 reading from stdin.
767 --wrap-width=NUMBER
769 Set the width of column before wrapping to NUMBER.
770 --wrap-cols=LIST
772 Set the list of wrapped columns. LIST must be a string of num‐
773 bers separated by comma.
774 --ellipsize=TYPE
776 Set ellipsize mode for text columns. TYPE may be NONE, START,
777 MIDDLE or END.
778 --ellipsize-cols=LIST
780 Set the list of ellipsized columns. LIST must be a string of
781 numbers separated by comma.
782 --dclick-action=CMD
784 Set the CMD as a double-click command. When user double-clicked
785 on row, CMD will be launched with values of all columns as an
786 arguments. By default double-click selects row and act as OK
787 button for simple lists, set the checkbox if --checklist speci‐
788 fied and do nothing when list run with --multiple option. When
789 double-click specified Enter acts as a double-click and
790 Ctrl+Enter acts as an OK button. CMD may contain a special
791 character `%s' for setting a position for arguments. By default
792 arguments will be concatenated to the end of CMD. If CMD starts
793 with @, its output will replace values of current row. This
794 option doesn't work with --editable.
795 --select-action=CMD
797 Set the CMD as a action when selection is changed. CMD will be
798 launched with values of all columns as an arguments. CMD may
799 contain a special character `%s' for setting a position for
800 arguments. By default arguments will be concatenated to the end
801 of CMD. This option doesn't work with --multiple.
802 --row-action=CMD
804 Set the CMD as a action when the row is added, modified or
805 removed. First argument for the command is the name of action
806 (add, edit or del). The rest of command line is data from
807 selected row. Output of this command sets the new row values.
808 --tree-expanded
810 Expand all tree nodes at startup.
811 --regex-search
813 Use regular expressions in search for text fields.
814 --listen
816 Listen data from stdin even if command-line values was speci‐
817 fied.
818 --quoted-output
820 Output values will be shell-style quoted.
821 --float-precision=NUMBER
823 Set precision of floating point numbers. By default precision is
824 three digits after point.
825 --add-on-top
827 Add new records at the top of the list.
828 --tail Autoscroll to the end of the list when a new row will be added.
830 --iec-format
832 Use IEC (base 1024) units with for size values. With this option
833 values will have suffixes KiB, MiB, GiB.
834 Sending FormFeed character to list clears it. This symbol may be sent
836 as echo -e '\f'.
837 --simple-tips
839 Don't use markup in tooltips even if text has a valid markup.
840 --header-tips
842 Use header name as a fallback tooltip text.
843 Notebook options
846 --key=KEY
847 Set the key of the children.
848 --tab=TEXT
850 Add tab with specified label to notebook. TEXT may be in a form
851 LABEL[!ICON[!TOOLTIP]] where `!' is an item separator.
852 --tab-pos=TYPE
854 Set the tabs position. Value may be top, bottom, left, or right.
855 Default is top.
856 --tab-borders=NUMBER
858 Set the borders width around widget in tabs.
859 --active-tab=NUMBER
861 Set active tab.
862 --expand
864 Expand all tabs to full width of a dialog window.
865 See NOTEBOOK and PANED section for more about notebook dialog.
867 Notification options
870 --command=CMD
871 Set the command running when clicked on the icon. Default action
872 is quit if --listen not specified.
873 --listen
875 Listen for commands on stdin. See NOTIFICATION section.
876 --separator=STRING
878 Set separator character for menu values. Default is |.
879 --item-separator=STRING
881 Set separator character for menu items. Default is !.
882 --menu=STRING
884 Set initial menu for right-click.
885 --no-middle
887 Disable exit on middle click.
888 --hidden
890 Doesn't show icon at startup.
891 --icon-size=SIZE
893 Set notification icon size to SIZE. This option doesn't works
894 for themed icons.
895 See NOTIFICATION section for more about separators.
897 Paned options
900 --key=KEY
901 Set the key of the children.
902 --orient=TYPE
904 Set orientation of panes inside dialog. TYPE may be in hor[izon‐
905 tal] or vert[ical].
906 --splitter=POS
908 Set the initial splitter position.
909 See NOTEBOOK and PANED section for more about paned dialog.
911 Picture options
914 --size=VALUE
915 Set initial size of picture. Available values are fit for fit‐
916 ting image in window or orig for show picture in original size.
917 --inc=NUMBER
919 Set increment value for scaling image.
920 --filename=FILENAME
922 Set picture filename.
923 Some actions on a picture like scaling or rotating available from popup
925 menu. Those actions can be made only on static images.
926 Print options
929 --type=TYPE
930 Set source file type. TYPE may be a TEXT for text files, IMAGE
931 for image files or RAW for files in postscript or pdf formats.
932 --filename=FILENAME
934 Set name or path to the source file.
935 --headers
937 Add headers to the top of page with filename and page number.
938 This option doesn't work for RAW type.
939 --add-preview
941 Add Preview button to the print dialog. This option doesn't work
942 for RAW type.
943 --fontname=FONTNAME
945 Set the font for printing text. FONTNAME is a string with font
946 representation in the form "[FAMILY-LIST] [STYLE-OPTIONS]
947 [SIZE]". This option works only for TEXT type.
948 Progress options
951 When the --progress option is used, yad reads lines of progress data
952 from stdin. When the lines begin with # the text after # is displayed
953 in the progress bar label. Numeric values treats like a persents for
954 progress bar.
955 --bar=LABEL[:TYPE]
957 Add progress bar. LABEL is a text label for progress bar. TYPE
958 is a progress bar type. Types are: NORM for normal progress
959 bar, RTL for inverted progress bar and PULSE for pulsate
960 progress bar. If no bars specified, the progress dialog works
961 in single-bar mode.
962 --vertical
964 Set vertical orientation of progress bars.
965 --align=TYPE
967 Set alignment of bar labels. Possible types are left, center or
968 right. Default is left.
969 --progress-text=TEXT
971 Set the label of progress bar to TEXT. This option works only in
972 single-bar mode.
973 --hide-text
975 Hide text in progress bars.
976 --rtl Set Right-To-Left progress bar direction. This option works only
978 in single-bar mode.
979 --auto-close
981 Close dialog when 100% has been reached.
982 --auto-kill
984 Kill parent process if cancel button is pressed.
985 --pulsate
987 Pulsate progress bar. This option works only in single-bar mode.
988 --enable-log[=TEXT]
990 Show log window. This window gathers all of lines from stdin,
991 started from # instead of setting appropriate progress text.
992 Optional argument TEXT is a text label for window expander.
993 --log-on-top
995 Place log window above progress bars.
996 --log-expanded
998 Start with expanded log window.
999 --log-height
1001 Set the height of log window.
1002 Initial values for bars sets as an extra arguments. Each lines with
1004 progress data passed to stdin must be started from N: where N is a num‐
1005 ber of progress bar. In a single-bar mode N: is not needed.
1006 Text info options
1009 --filename=FILENAME
1010 Open specified file.
1011 --editable
1013 Allow changes to text.
1014 --wrap Enable text wrapping.
1016 --formatted
1018 Enable Pango markup. This option doesn't work with --editable
1019 option.
1020 --justify=TYPE
1022 Set justification. TYPE may be left, right, center or fill.
1023 Default is left.
1024 --margins=NUMBER
1026 Set text margins to NUMBER.
1027 --tail Autoscroll to end when new text appears. Works only when text is
1029 read from stdin.
1030 --show-cursor
1032 Show cursor in read-only mode.
1033 --show-uri
1035 Make links in text clickable. Links opens with xdg-open command.
1036 --fore=COLOR
1038 Set default color for text.
1039 --back=COLOR
1041 Set default color for background.
1042 --uri-color=COLOR
1044 Set color for links. Default is blue.
1045 --lang=LANGUAGE
1047 Highlight syntax for specified LANGUAGE. This option works only
1048 if yad builds with gtksourceview.
1049 --theme=THEME
1051 Set used theme to THEME. This option works only if yad builds
1052 with gtksourceview. Use option --show-themes for get list of all
1053 available themes.
1054 --listen
1056 Listen data from stdin even if filename was specified.
1057 If fontname option is specified for text dialog, the description
1059 of font must be in CSS style (not in a Pango style). Sending
1060 FormFeed character to text dialog clears it. This symbol may be
1061 sent as echo -e '\f'. Pressing Ctrl+S popups the search entry
1062 in text dialog.
1063 Scale options
1066 --value=VALUE
1067 Set initial value.
1068 --min-value=VALUE
1070 Set minimum value.
1071 --max-value=VALUE
1073 Set maximum value.
1074 --step=VALUE
1076 Set step size.
1077 --enforce-step
1079 Only allow values in step increments.
1080 --page=VALUE
1082 Set paging size. By default page value is STEP*10.
1083 --print-partial
1085 Print partial values.
1086 --hide-value
1088 Hide value.
1089 --vertical
1091 Show vertical scale.
1092 --invert
1094 Invert scale direction.
1095 --inc-buttons
1097 Show buttons on edges of a scale for increasing or decreasing
1098 scale value.
1099 --mark=[NAME]:VALUE
1101 Add a mark to scale. May be used multiple times. NAME is an
1102 optional arguments for set label to mark.
1103 File filters options
1106 --file-filter=NAME | PATTERN1 PATTERN2 ...
1107 Add a filename filter. NAME is a displayed filter name, PATTERN
1108 is a shell-style filename pattern (for example *.txt). This
1109 option may be used multiple times.
1110 --mime-filter=NAME | MIME1 MIME2 ...
1112 Add a mime-type filter. NAME is a displayed filter name, PATTERN
1113 is a name of mime type (for example text/plain). This option may
1114 be used multiple times.
1115 --image-filter=[NAME]
1117 Add filter for images supported by gdk-pixbuf library. NAME in
1118 as optional name for this filter.
1119 This options applies to all of yad's file chooser dialogs.
1121 File preview options
1124 --add-preview
1125 Add preview widget. Preview images loads from normal (default)
1126 or large thumbnails according to XDG Thumbnails specification
1127 v0.8.0 (http://standards.freedesktop.org/thumbnail-spec/latest/)
1128 or creates by yad for image files and saves as normal or large
1129 thumbnails.
1130 --large-preview
1132 Use large previews by default. This option can be permanently
1133 turned on through yad settings.
1134 This options applies to all of yad's file chooser dialogs.
1136 NOTE: YAD doesn't check mtime for thumbnailed images and doesn't
1138 updates preview if origial file was changed after thumbnail was cre‐
1139 ated.
1140 Miscellaneous options
1143 -?, --help
1144 Show summary of options.
1145 --about
1147 Display an about dialog.
1148 --version
1150 Show version of program.
1151 --show-langs
1153 Show list of possible languages for spell checking. Available
1154 only if yad builds with GtkSpell support.
1155 --show-themes
1157 Show list of possible GtkSourceView themes. Available only if
1158 yad builds with GtkSourceView support.
1159 Also the standard GTK+ options are accepted.
1162
1165 Notebook is a complex dialog which swallow other dialogs in his tabs.
1166 Dialogs identifies by unique key (integer) and must be runs in a spe‐
1167 cial plug mode (--plug option). Following example runs notebook dialog
1168 with two tabs, first has a simple text and second is an entry dialog.
1169 #! /bin/sh
1171 yad --plug=12345 --tabnum=1 --text="first tab with text" &> res1 &
1173 yad --plug=12345 --tabnum=2 --text="second tab" --entry &> res2 &
1174 yad --notebook --key=12345 --tab="Tab 1" --tab="Tab 2"
1175 NOTE: The order of output results for tabs is undefined!
1177 Paned works in a same manner as a notebook with one restriction - only
1179 first and secong plug dialogs will be swallowed to panes.
1180
1183 Allows commands to be sent to yad in the form command:args. Possible
1184 commands are icon, tooltip, visible, action, menu and quit.
1185 icon:ICONNAME
1187 Set notification icon to ICONNAME.
1188 tooltip:STRING
1190 Set notification tooltip.
1191 visible:[true|false|blink]
1193 Set notification icon to visible, invisible or blinking states.
1194 action:COMMAND
1196 Specify the command running when click on the icon. There are
1197 two special commands - menu for popup user defined menu and quit
1198 for exit the program.
1199 menu:STRING
1201 Set popup menu for notification icon. STRING must be in form
1202 name1[!action1[!icon1]]|name2[!action2[!icon2]].... Empty name
1203 add separator to menu. Separator character for values (e.g.
1204 `|') sets with --separator argument. Separator character for
1205 menu items (e.g. `!') sets with --item-separator argument.
1206 quit Exit the program. Middle click on icon also send quit command.
1208
1211 This is a list of predefined items available in yad.
1212 ID Label text Icon name
1215 ─────────────────────────────────────────────
1216 yad-about About help-about
1217 yad-add Add list-add
1218 yad-apply Apply gtk-apply
1219 yad-cancel Cancel gtk-cancel
1220 yad-clear Clear document-clear
1221 yad-close Close window-close
1222 yad-edit Edit gtk-edit
1223 yad-execute Execute system-run
1224 yad-no No gtk-no
1225 yad-ok OK gtk-ok
1226 yad-open Open document-open
1227 yad-print Print document-print
1228 yad-quit Quit application-exit
1229 yad-refresh Refresh view-refresh
1230 yad-remove Remove list-remove
1231 yad-save Save document-save
1232 yad-search Search system-search
1233 yad-settings Settings gtk-preferences
1234 yad-yes Yes gtk-yes
1235
1238 YAD_OPTIONS
1239 This variable can holds some default options for yad. All
1240 options in this variable may be redefined from command line.
1241 YAD_PID
1243 This variable sets to the value of current dialog's pid and
1244 accessible in all dialog children.
1245 YAD_XID
1247 This variable sets to the value of current dialog's X Window ID
1248 and accessible in all dialog children. This variable is not set
1249 in print and notification dialogs, and in a dialogs which acts
1250 as a notebook or paned children.
1251
1254 SIGUSR1
1255 Close dialog with 0 exit code.
1256 SIGUSR2
1258 Close dialog with 1 exit code.
1259
1262 0 The user has pressed OK button
1263 1 The user has pressed Cancel button
1265 70 The dialog has been closed because the timeout has been reached.
1267 252 The dialog has been closed by pressing Esc or used the window
1269 functions to close the dialog
1270 Exit codes for user-specified buttons must be specified in command
1272 line. Even exit code mean to print result, odd just return exit code.
1273
1276 The look and feel of yad's dialogs can be customized through gtkrc
1277 file. Here is the names of yad's widgets:
1278 Widget name Widget type Description
1281 ───────────────────────────────────────────────────────────────────────────────────
1282 yad-dialog-window GtkDialog Dialog window
1283 yad-dialog-image GtkImage Dialog image
1284 yad-dialog-label GtkLabel Dialog text
1285 yad-app-widget GtkAppChooserWidget Application selection widget
1286 yad-calendar-widget GtkCalendar Calendar widget
1287 yad-color-widget GtkColorChooser Color selection widget
1288 yad-color-palette GtkTreeView Predefined colors list
1289 yad-entry-label GtkLabel Entry label
1290 yad-entry-widget GtkEntry Entry widget
1291 yad-entry-spin GtkSpinButton Entry widget for numeric values
1292 yad-entry-combo GtkComboBox Entry widget with combo
1293 yad-entry-edit-combo GtkComboBoxEntry Entry widget with editable combo
1294 yad-file-widget GtkFileChooser File selection widget
1295 yad-font-widget GtkFontChooser Font selection widget
1296 yad-form-flabel GtkLabel Field label in form
1297 yad-form-button GtkButton Button field in form
1298 yad-form-entry GtkEntrfy Entry field in form
1299 yad-form-spin GtkSpinButton Numeric entry field in form
1300 yad-form-check GtkCheckButton Checkbox field in form
1301 yad-form-combo GtkComboBox Combo field in form
1302 yad-form-edit-combo GtkComboBoxEntry Editable combo field in form
1303 yad-form-link GtkLinkButton Link field in form
1304 yad-form-file GtkFileChooserButton File or directory field in form
1305 yad-form-font GtkFontChooserButton Font field in form
1306 yad-form-app GtkAppChooserButton Application field in form
1307 yad-form-color GtkColorChooserButton Color field in form
1308 yad-form-label GtkLabel Label field in form
1309 yad-form-scale GtkScale Scale widget in form
1310 yad-form-separator GtkSeparator Separator in form
1311 yad-form-text GtkTextView Multiline text field in form
1312 yad-icons-full GtkIconView Icons widget for normal mode
1313 yad-icons-compact GtkTreeView Icons widget for compact mode
1314 yad-list-widget GtkTreeView List widget
1315 yad-notebook-widget GtkNotebook Notebook widget
1316 yad-paned-widget GtkPaned Horizontal or vertical pane widget
1317 yad-progress-widget GtkProgressBar Progressbar widget
1318 yad-scale-widget GtkScale Scale widget
1319 yad-text-widget GtkTextView Text info widget
1320 yad-timeout-indicator GtkProgreeBar Timeout indicator
1321
1324 YAD keeps settings in gsettings database. Use gsettings list-keys
1325 yad.settings to get list of available settings. Settings values can be
1326 obtained by gsettings get yad.settings <key> and changed by gsettings
1327 set yad.settings <key> <new-value>
1328
1331 Display a file selector with the title Select a file to remove. The
1332 file selected is returned on standard output.
1333 yad --title="Select a file to remove" --file-selection
1335 Display a text entry dialog with the title Select Host and the text
1337 Select the host you would like to flood-ping. The entered text is
1338 returned on standard output.
1339 yad --title "Select Host" --entry --text "Select the host you
1341 would like to flood-ping"
1342 Display a dialog, asking Microsoft Windows has been found! Would you
1344 like to remove it?. The return code will be 0 (true in shell) if YES is
1345 selected, and 1 (false) if NO is selected.
1346 yad --image "dialog-question" --title "Alert" --button=gtk-
1348 yes:0 --button=gtk-no:1 --text "Microsoft Windows has been
1349 found! Would you like to remove it?"
1350 Show the search results in a list dialog with the title Search Results
1352 and the text Finding all header files....
1353 find . -name '*.h' | yad --list --title "Search Results" --text
1355 "Finding all header files.." --column "Files"
1356 Show an icon in the notification area
1358 yad --notification --image=update.png --text "System update nec‐
1360 essary!" --command "xterm -e apt-get upgrade"
1361 Display a weekly shopping list in a check list dialog with Apples and
1363 Oranges pre selected
1364 yad --list --checklist --column "Buy" --column "Item" TRUE
1366 Apples TRUE Oranges FALSE Pears FALSE Toothpaste
1367 Display a progress dialog while searching for all the postscript files
1369 in your home directory
1370 find $HOME -name '*.ps' | yad --progress --pulsate
1372 Display a box with all of the installed desktop applications
1374 yad --icons --read-dir=/usr/share/applications
1376 Display list in tree mode
1378 yad --list --tree --column "Items" f Fruits 1:f Apple 2:f Lemon
1380 v Vegetables 3:v Popato 4:v Onion
1381
1384 There are some developers features providing with YAD.
1385 YAD icon browser is a graphical tool for discover icons in current or
1387 user-specified GTK+ icon theme. Launch it as
1388 yad-icon-browser [theme]
1390 When using autoconf you may use special m4 macro AM_PATH_YAD for look‐
1392 ing for yad and check it version. Usage of this macro is
1393 AM_PATH_YAD([MINIMUM-VERSION],\ [ACTION-IF-FOUND],\ [ACTION-IF-
1395 NOT-FOUND])
1396
1398 Yad was written by Victor Ananjevsky <ananasik@gmail.com>. Yad icon
1399 created by Bogdan Lisovich.
1400
1403 gdialog(1), dialog(1), zenity(1)
1404yad April 27, 2020 YAD(1)