.TH xwait 1 "15 November 1998" "Edgeware tools"
.SH NAME
xwait \- wait until prodded by another X client
.SH SYNOPSIS
.B xwait
.RB [ \-f ]
.RB [ \-d
.IR display ]
.RB [ \-a
.IR atom ]
.RB [ \-m
.IR message ]
.SH DESCRIPTION
The
.B xwait
program waits until it notices that a particular property on the X root
window has been assigned a particular value, at which point the program
exits.  The property can be set using the
.BR xtell (1)
and
.BR xshutdown (1)
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
.B xwait
exits, it removes the property from the root window.
.SS OPTIONS
.TP 5
.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 " display
Attempt to connect to
.I display
rather than the display named in the usual environment variable.
.TP 5
.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 .
.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
.BR XWAIT_MESSAGE .
.SH AUTHOR
Mark Wooding (mdw@nsict.org).
.SH BUGS
None currently known.
.SH SEE ALSO
.BR xtell (1),
and
.BR xshutdown (1).