Kill some spurious warnings. Track @msg@ interface change.

[xtoys] / xwait.1

diff --git a/xwait.1 b/xwait.1
index 4c09801..c66dcf2 100644 (file)
--- a/xwait.1
+++ b/xwait.1
@@ -1,4 +1,11 @@
 .\" -*-nroff-*-
 .\" -*-nroff-*-

+.de hP
+.IP
+\h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c
+..
+.ie t .ds o \(bu
+.el .ds o o
+.

 .TH xwait 1 "15 November 1998" "Edgeware tools"
 .SH NAME
 xwait \- wait until prodded by another X client
 .TH xwait 1 "15 November 1998" "Edgeware tools"
 .SH NAME
 xwait \- wait until prodded by another X client


@@ -11,7 +18,7 @@ xwait \- wait until prodded by another X client
 .RB [ \-a
 .IR atom ]
 .RB [ \-m
 .RB [ \-a
 .IR atom ]
 .RB [ \-m

-.IR message ]
+.IR msg ]

 .RI [ \c
 .IB atom : msg , msg \c
 \&...]
 .RI [ \c
 .IB atom : msg , msg \c
 \&...]


@@ -33,7 +40,7 @@ The properties, and the values to listen for, can be configured at the
 command line.  When
 .B xwait
 exits, it removes the properties from the root window.
 command line.  When
 .B xwait
 exits, it removes the properties from the root window.

-.SS OPTIONS
+.SS Options

 .TP 5
 .B \-f, \-\-force
 Force 
 .TP 5
 .B \-f, \-\-force
 Force 


@@ -53,11 +60,11 @@ to listen for the property named
 .IR atom .
 Use of this option is deprecated.
 .TP 5
 .IR atom .
 Use of this option is deprecated.
 .TP 5

-.BI "\-m, \-\-msg " message
+.BI "\-m, \-\-msg " msg

 Sets
 .B xwait
 to wait for the given property to be set to
 Sets
 .B xwait
 to wait for the given property to be set to

-.IR message .
+.IR msg .

 Use of this option is deprecated.
 .SS "Argument format"
 The
 Use of this option is deprecated.
 .SS "Argument format"
 The


@@ -79,6 +86,20 @@ will wait for
 .B XWAIT_PROPERTY
 to be set to
 .BR XWAIT_MESSAGE .
 .B XWAIT_PROPERTY
 to be set to
 .BR XWAIT_MESSAGE .

+.SS "Output format"
+When a message is eventually received,
+.B xwait
+prints information about it to standard output:
+.hP \*o
+If more than one property (atom) was specified, the property name is
+printed.
+.hP \*o
+If more than one message is recognized for the property, the message
+string is printed; if a property name was printed, the two are separated
+by a colon and a single space character.
+.PP
+.B xwait
+then exits with return code 0.

 .SH AUTHOR
 Mark Wooding (mdw@nsict.org).
 .SH BUGS
 .SH AUTHOR
 Mark Wooding (mdw@nsict.org).
 .SH BUGS