b6eb57e6 |
1 | .\" -*-nroff-*- |
90b2c5d4 |
2 | .TH xwait 1 "15 November 1998" "Edgeware tools" |
3 | .SH NAME |
4 | xwait \- wait until prodded by another X client |
5 | .SH SYNOPSIS |
25c93171 |
6 | .ll +5i |
90b2c5d4 |
7 | .B xwait |
162913e9 |
8 | .RB [ \-f ] |
90b2c5d4 |
9 | .RB [ \-d |
10 | .IR display ] |
11 | .RB [ \-a |
12 | .IR atom ] |
13 | .RB [ \-m |
14 | .IR message ] |
25c93171 |
15 | .RI [ \c |
16 | .IB atom : msg , msg \c |
17 | \&...] |
18 | .ll -5i |
90b2c5d4 |
19 | .SH DESCRIPTION |
20 | The |
21 | .B xwait |
22 | program waits until it notices that a particular property on the X root |
23 | window has been assigned a particular value, at which point the program |
24 | exits. The property can be set using the |
25 | .BR xtell (1) |
26 | and |
27 | .BR xshutdown (1) |
28 | programs. It's mostly useful for putting at the end of a user's |
29 | .B .xinitrc |
30 | file, so that it can be triggered to end the session. |
31 | .PP |
25c93171 |
32 | The properties, and the values to listen for, can be configured at the |
33 | command line. When |
90b2c5d4 |
34 | .B xwait |
25c93171 |
35 | exits, it removes the properties from the root window. |
90b2c5d4 |
36 | .SS OPTIONS |
37 | .TP 5 |
f3b35b6b |
38 | .B \-f, \-\-force |
90b2c5d4 |
39 | Force |
40 | .B xwait |
41 | to start up, even though there may be an existing process already |
42 | listening for the particular atom in question. |
43 | .TP 5 |
f3b35b6b |
44 | .BI "\-d, \-\-display " display |
90b2c5d4 |
45 | Attempt to connect to |
46 | .I display |
47 | rather than the display named in the usual environment variable. |
48 | .TP 5 |
f3b35b6b |
49 | .BI "\-a, \-\-atom " atom |
90b2c5d4 |
50 | Sets |
51 | .B xwait |
52 | to listen for the property named |
53 | .IR atom . |
25c93171 |
54 | Use of this option is deprecated. |
90b2c5d4 |
55 | .TP 5 |
f3b35b6b |
56 | .BI "\-m, \-\-msg " message |
90b2c5d4 |
57 | Sets |
58 | .B xwait |
59 | to wait for the given property to be set to |
60 | .IR message . |
25c93171 |
61 | Use of this option is deprecated. |
62 | .SS "Argument format" |
63 | The |
64 | .B \-a |
65 | and |
66 | .B \-m |
67 | options are deprecated, though retained for compatibility reasons. |
68 | It's recommended that you use the non-option specification instead. |
69 | .PP |
70 | Each argument specifies an atom name and a list of message strings to |
71 | listen to. Multiple properties may be listened for, and multiple |
72 | messages may be accepted for each property. If no messages are |
73 | specified then all values are considered to be acceptable. The program |
74 | exits when any property is set to an acceptable value. |
75 | .PP |
76 | If no atoms are given on the command line, |
77 | .B xwait |
78 | will wait for |
79 | .B XWAIT_PROPERTY |
80 | to be set to |
90b2c5d4 |
81 | .BR XWAIT_MESSAGE . |
82 | .SH AUTHOR |
83 | Mark Wooding (mdw@nsict.org). |
84 | .SH BUGS |
85 | None currently known. |
86 | .SH SEE ALSO |
87 | .BR xtell (1), |
88 | and |
89 | .BR xshutdown (1). |