New command line syntax, and new atom protocol. Wait for multiple

[xtoys] / xwait.1

diff --git a/xwait.1 b/xwait.1
index 336c595..4c09801 100644 (file)
--- a/xwait.1
+++ b/xwait.1
@@ -3,6 +3,7 @@
 .SH NAME
 xwait \- wait until prodded by another X client
 .SH SYNOPSIS
+.ll +5i
 .B xwait
 .RB [ \-f ]
 .RB [ \-d
@@ -11,6 +12,10 @@ xwait \- wait until prodded by another X client
 .IR atom ]
 .RB [ \-m
 .IR message ]
+.RI [ \c
+.IB atom : msg , msg \c
+\&...]
+.ll -5i
 .SH DESCRIPTION
 The
 .B xwait
@@ -24,10 +29,10 @@ 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.
+exits, it removes the properties from the root window.
 .SS OPTIONS
 .TP 5
 .B \-f, \-\-force
@@ -46,15 +51,33 @@ 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, \-\-msg " message
 Sets
 .B xwait
 to wait for the given property to be set to
 .IR message .
-The default message to wait for is
+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 .
 .SH AUTHOR
 Mark Wooding (mdw@nsict.org).