| | 1 | .\" -*-nroff-*- |
| | 2 | .de hP |
| | 3 | .IP |
| | 4 | \h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c |
| | 5 | .. |
| | 6 | .ie t .ds o \(bu |
| | 7 | .el .ds o o |
| | 8 | . |
| | 9 | .TH xwait 1 "15 November 1998" "Edgeware tools" |
| | 10 | .SH NAME |
| | 11 | xwait \- wait until prodded by another X client |
| | 12 | .SH SYNOPSIS |
| | 13 | .ll +5i |
| | 14 | .B xwait |
| | 15 | .RB [ \-f ] |
| | 16 | .RB [ \-d |
| | 17 | .IR display ] |
| | 18 | .RB [ \-a |
| | 19 | .IR atom ] |
| | 20 | .RB [ \-m |
| | 21 | .IR msg ] |
| | 22 | .RI [ \c |
| | 23 | .IB atom : msg , msg \c |
| | 24 | \&...] |
| | 25 | .ll -5i |
| | 26 | .SH DESCRIPTION |
| | 27 | The |
| | 28 | .B xwait |
| | 29 | program waits until it notices that a particular property on the X root |
| | 30 | window has been assigned a particular value, at which point the program |
| | 31 | exits. The property can be set using the |
| | 32 | .BR xtell (1) |
| | 33 | and |
| | 34 | .BR xshutdown (1) |
| | 35 | programs. It's mostly useful for putting at the end of a user's |
| | 36 | .B .xinitrc |
| | 37 | file, so that it can be triggered to end the session. |
| | 38 | .PP |
| | 39 | The properties, and the values to listen for, can be configured at the |
| | 40 | command line. When |
| | 41 | .B xwait |
| | 42 | exits, it removes the properties from the root window. |
| | 43 | .SS Options |
| | 44 | .TP 5 |
| | 45 | .B \-f, \-\-force |
| | 46 | Force |
| | 47 | .B xwait |
| | 48 | to start up, even though there may be an existing process already |
| | 49 | listening for the particular atom in question. |
| | 50 | .TP 5 |
| | 51 | .BI "\-d, \-\-display " display |
| | 52 | Attempt to connect to |
| | 53 | .I display |
| | 54 | rather than the display named in the usual environment variable. |
| | 55 | .TP 5 |
| | 56 | .BI "\-a, \-\-atom " atom |
| | 57 | Sets |
| | 58 | .B xwait |
| | 59 | to listen for the property named |
| | 60 | .IR atom . |
| | 61 | Use of this option is deprecated. |
| | 62 | .TP 5 |
| | 63 | .BI "\-m, \-\-msg " msg |
| | 64 | Sets |
| | 65 | .B xwait |
| | 66 | to wait for the given property to be set to |
| | 67 | .IR msg . |
| | 68 | Use of this option is deprecated. |
| | 69 | .SS "Argument format" |
| | 70 | The |
| | 71 | .B \-a |
| | 72 | and |
| | 73 | .B \-m |
| | 74 | options are deprecated, though retained for compatibility reasons. |
| | 75 | It's recommended that you use the non-option specification instead. |
| | 76 | .PP |
| | 77 | Each argument specifies an atom name and a list of message strings to |
| | 78 | listen to. Multiple properties may be listened for, and multiple |
| | 79 | messages may be accepted for each property. If no messages are |
| | 80 | specified then all values are considered to be acceptable. The program |
| | 81 | exits when any property is set to an acceptable value. |
| | 82 | .PP |
| | 83 | If no atoms are given on the command line, |
| | 84 | .B xwait |
| | 85 | will wait for |
| | 86 | .B XWAIT_PROPERTY |
| | 87 | to be set to |
| | 88 | .BR XWAIT_MESSAGE . |
| | 89 | .SS "Output format" |
| | 90 | When a message is eventually received, |
| | 91 | .B xwait |
| | 92 | prints information about it to standard output: |
| | 93 | .hP \*o |
| | 94 | If more than one property (atom) was specified, the property name is |
| | 95 | printed. |
| | 96 | .hP \*o |
| | 97 | If more than one message is recognized for the property, the message |
| | 98 | string is printed; if a property name was printed, the two are separated |
| | 99 | by a colon and a single space character. |
| | 100 | .PP |
| | 101 | .B xwait |
| | 102 | then exits with return code 0. |
| | 103 | .SH AUTHOR |
| | 104 | Mark Wooding (mdw@nsict.org). |
| | 105 | .SH BUGS |
| | 106 | None currently known. |
| | 107 | .SH SEE ALSO |
| | 108 | .BR xtell (1), |
| | 109 | and |
| | 110 | .BR xshutdown (1). |
~mdw / xtoys / blame_incremental