New program to display messages and get answers.

[xtoys] / xmsg.1

diff --git a/xmsg.1 b/xmsg.1
new file mode 100644 (file)
index 0000000..57cb3e1
--- /dev/null
+++ b/xmsg.1
@@ -0,0 +1,83 @@
+.\" -*-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
+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.