New program to display messages and get answers.
[xtoys] / xmsg.1
CommitLineData
2b6e1eca 1.\" -*-nroff-*-
2.TH xmsg 1 "20 December 2001" "Edgeware tools"
3.SH NAME
4xmsg \- pops up a message box
5.SH SYNOPSIS
6.ll +5i
7.B xmsg
8.RB [ \-\-display
9.IR display ]
10.RB [ \-f ]
11.RB [ \-t
12.IR title ]
13.RB [ \-c | \-d
14.IR button ]
15.if n \{\
16.br
17\h'1i'
18..
19\}
20.I message
21.RI [ button ...]
22.ll -5i
23.SH DESCRIPTION
24The
25.B xmsg
26program pops up a pretty GTK message box, containing the listed buttons
27(shown right to left along the bottom). The button strings are listed,
28one per argument, after the message. If no buttons are requested, an
29.B OK
30button is provided anyway.
31.PP
32A button may be selected as being the default (i.e., may be chosen by
33pressing
34.IR enter ),
35using the
36.B \-d
37option: the argument must either match a button name, or be an index
38(zero-based) of the requested button. If you don't select a default,
39the first (rightmost) button becomes the default anyway.
40.PP
41Similarly, a button may be selected as being the `cancel' action (i.e.,
42may be chosen by closing the window or pressing
43.IR escape ),
44using
45the
46.B \-c
47option. Again, the argument must either match a button name or be an
48index of a button. If you don't select a cancel button, the last
49(leftmost) button because the cancel button.
50.PP
51If there is more than one button, the name of the selected button is
52printed on standard output when the program exits.
53.SS Options
54.TP 5
55.BI "\-\-display " display
56Attempt to connect to
57.I display
58rather than the display named in the usual environment variable.
59.TP 5
60.B "\-f, \-\-focus "
61Sets a magical property to ensure that the window acquires the focus
62under a customized
63.BR fvwm (3)
64version I don't use any more.
65.TP 5
66.BI "\-t, \-\-title " title
67Sets the title for the window. If you don't specify a title, the window
68is labelled
69.RB ` xmsg '.
70.TP 5
71.BI "\-c, \-\-cancel " button
72Selects the given
73.I button
74as being the cancel button.
75.TP 5
76.BI "\-d, \-\-default " button
77Selects the given
78.I button
79as being the default button.
80.SH AUTHOR
81Mark Wooding (mdw@nsict.org).
82.SH BUGS
83None currently known.