New source file for manipulating atom-valued window properties.
[xtoys] / xwait.1
... / ...
CommitLineData
1.\" -*-nroff-*-
2.TH xwait 1 "15 November 1998" "Edgeware tools"
3.SH NAME
4xwait \- wait until prodded by another X client
5.SH SYNOPSIS
6.B xwait
7.RB [ \-f ]
8.RB [ \-d
9.IR display ]
10.RB [ \-a
11.IR atom ]
12.RB [ \-m
13.IR message ]
14.SH DESCRIPTION
15The
16.B xwait
17program waits until it notices that a particular property on the X root
18window has been assigned a particular value, at which point the program
19exits. The property can be set using the
20.BR xtell (1)
21and
22.BR xshutdown (1)
23programs. It's mostly useful for putting at the end of a user's
24.B .xinitrc
25file, so that it can be triggered to end the session.
26.PP
27The property, and the value to listen for, can be configured at
28the command line. When
29.B xwait
30exits, it removes the property from the root window.
31.SS OPTIONS
32.TP 5
33.B \-f, \-\-force
34Force
35.B xwait
36to start up, even though there may be an existing process already
37listening for the particular atom in question.
38.TP 5
39.BI "\-d, \-\-display " display
40Attempt to connect to
41.I display
42rather than the display named in the usual environment variable.
43.TP 5
44.BI "\-a, \-\-atom " atom
45Sets
46.B xwait
47to listen for the property named
48.IR atom .
49The default property to listen to is
50.BR XWAIT_PROPERTY .
51.TP 5
52.BI "\-m, \-\-msg " message
53Sets
54.B xwait
55to wait for the given property to be set to
56.IR message .
57The default message to wait for is
58.BR XWAIT_MESSAGE .
59.SH AUTHOR
60Mark Wooding (mdw@nsict.org).
61.SH BUGS
62None currently known.
63.SH SEE ALSO
64.BR xtell (1),
65and
66.BR xshutdown (1).