2 .TH xmsg 1 "20 December 2001" "Edgeware tools"
4 xmsg \- pops up a message box
18 program pops up a pretty GTK message box, containing the listed buttons
19 (shown right to left along the bottom). The button strings are listed,
20 one per argument, after the message. If no buttons are requested, an
22 button is provided anyway.
24 The user dismisses the message window by activating one of the buttons
25 or just closing the window using the window manager. The
27 program then writes a string to its standard output describing the
28 user's action and exits. The string written is, by default, the label
29 of the activated button, though this can be overridden: see below.
30 .SS "Message specifications"
33 argument is usually just a text string to be displayed. However, if the
37 then, instead, the message to display is read from standard input. If the
42 then that character is removed. (Hence, if you really wanted to show
47 Conscientious script authors will prefix strings appropriately.
49 Pango markup may be used in message and headline strings if the
52 .SS "Button specifications"
56 .RI [ opt \fB: opt \fB: ...] \c
61 is either a text string, or a GTK stock-id (e.g.,
63 Mnemonic characters in button labels may be marked by prefixing them
64 with underscores. Write two underscores if you really want a literal
69 may be one of the following.
72 This should be the default button, activated when the user presses the
79 This should be the cancel button, activated when the user presses the
81 key or simply dismisses the window.
84 If the user activates this button, output the
86 rather than the button's label.
88 If no button is marked as the default, then the rightmost (first
89 specified) is chosen automatically; similarly, if there is no specified
90 cancel button then the last is chosen. If several buttons are marked as
91 default or cancel buttons then the behaviour is unspecified.
93 Button options are usually processed while colons remain in the button
94 specification. Processing stops early if an exclamation mark
96 is reached. For example,
97 .B default:!cancel:button
98 is parsed has specifying the
100 option and a label text of
107 automatically provides an OK button (it actually uses the GTK
109 stock button) but produces no output.
112 .BR \-E ", " \-I ", " \-Q ", " \-W
113 Mark the message window as, respectively, reporting an error, providing
114 information, asking a question, or giving a warning.
116 .BR "\-d, \-\-headline " headline
119 above the main message, in larger and bolder text.
122 Enable the use of Pango XML-like markup in the message and headline
123 strings. See the Pango documentation for a description of the markup
126 .BI "\-t, \-\-title " title
127 Sets the title for the window. If you don't specify a title, the window
131 None currently known.
135 Mark Wooding (mdw@distorted.org.uk).