[xtoys] / xwait.1

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