mdw@git.distorted.org.uk Git - xtoys/blob - xwait.1

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