[xtoys] / xmsg.1

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