X-Git-Url: https://git.distorted.org.uk/~mdw/xtoys/blobdiff_plain/90b2c5d453c6e561a00913baa7aa8b9c213f0173..4954eef226519a87cd932f72f2119d1866153619:/xwait.1

diff --git a/xwait.1 b/xwait.1
index f9b9ccb..5a18e78 100644
--- a/xwait.1
+++ b/xwait.1
@@ -1,15 +1,28 @@
-.TH xwait 1 "15 November 1998" "Edgeware tools"
+.\" -*-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" "Straylight/Edgeware" "xtoys"
 .SH NAME
 xwait \- wait until prodded by another X client
 .SH SYNOPSIS
+.ll +5i
 .B xwait
-.RI [ \-f ]
+.RB [ \-f ]
 .RB [ \-d
 .IR display ]
 .RB [ \-a
 .IR atom ]
 .RB [ \-m
-.IR message ]
+.IR msg ]
+.RI [ \c
+.IB atom : msg , msg \c
+\&...]
+.ll -5i
 .SH DESCRIPTION
 The
 .B xwait
@@ -23,38 +36,70 @@ programs.  It's mostly useful for putting at the end of a user's
 .B .xinitrc
 file, so that it can be triggered to end the session.
 .PP
-The property, and the value to listen for, can be configured at
-the command line.  When
+The properties, and the values to listen for, can be configured at the
+command line.  When
 .B xwait
-exits, it removes the property from the root window.
-.SS OPTIONS
+exits, it removes the properties from the root window.
+.SS Options
 .TP 5
-.B \-f
+.B \-f, \-\-force
 Force 
 .B xwait
 to start up, even though there may be an existing process already
 listening for the particular atom in question.
 .TP 5
-.BI "\-d " display
+.BI "\-d, \-\-display " display
 Attempt to connect to
 .I display
 rather than the display named in the usual environment variable.
 .TP 5
-.BI "\-a " atom
+.BI "\-a, \-\-atom " atom
 Sets
 .B xwait
 to listen for the property named
 .IR atom .
-The default property to listen to is
-.BR XWAIT_PROPERTY .
+Use of this option is deprecated.
 .TP 5
-.BI "\-m " message
+.BI "\-m, \-\-msg " msg
 Sets
 .B xwait
 to wait for the given property to be set to
-.IR message .
-The default message to wait for is
+.IR msg .
+Use of this option is deprecated.
+.SS "Argument format"
+The
+.B \-a
+and
+.B \-m
+options are deprecated, though retained for compatibility reasons.
+It's recommended that you use the non-option specification instead.
+.PP
+Each argument specifies an atom name and a list of message strings to
+listen to.  Multiple properties may be listened for, and multiple
+messages may be accepted for each property.  If no messages are
+specified then all values are considered to be acceptable.  The program
+exits when any property is set to an acceptable value.
+.PP
+If no atoms are given on the command line,
+.B xwait
+will wait for
+.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