Allow xmsg to read from stdin.
[xtoys] / xshutdown.1
index 3033180..4b3c8a5 100644 (file)
@@ -1,17 +1,27 @@
 .\" -*-nroff-*-
-.TH xshutdown 1 "15 November 1998" "Edgeware tools"
+.TH xshutdown 1 "15 November 1998" "Straylight/Edgeware" "xtoys"
 .SH NAME
 xshutdown \- asks for user confirmation before waking an xwait process
 .SH SYNOPSIS
+.ll +5i
 .B xshutdown
 .RB [ \-\-display
 .IR display ]
 .RB [ \-a
 .IR atom ]
 .RB [ \-m
-.IR message ]
+.IR msg ]
+.if n \{\
+.br
+\h'1i'
+..
+\}
 .RB [ \-t
 .IR title ]
+.RI [ \c
+.IB atom : msg \c
+]
+.ll -5i
 .SH DESCRIPTION
 The
 .B xshutdown
@@ -21,7 +31,7 @@ message to a waiting
 .B xwait
 process, by setting a named property on the X root window to a particular
 value.
-.SS OPTIONS
+.SS Options
 .TP 5
 .BI "\-\-display " display
 Attempt to connect to
@@ -33,16 +43,14 @@ Sets
 .B xshutdown
 to to set the property named
 .IR atom .
-The default property to set is
-.BR XWAIT_PROPERTY .
+This option is deprecated.
 .TP 5
-.BI "\-m, \-\-msg " message
+.BI "\-m, \-\-msg " msg
 Sets
 .B xshutdown
 to set the given property to
-.IR message .
-The default message to set is
-.BR XWAIT_MESSAGE .
+.IR msg .
+This option is deprecated.
 .TP 5
 .BI "\-p, \-\-prompt " prompt
 Sets the prompt in the confirmation box to
@@ -51,6 +59,19 @@ Sets the prompt in the confirmation box to
 .BI "\-t, \-\-title " title
 Sets the window title to be
 .IR title .
+.PP
+The
+.B \-a
+and
+.B \-m
+options are deprecated, though retained for compatibility reasons.  It's
+recommended that you use the non-option specification instead.
+.PP
+The argument specifies an atom name and a message string to set.  The
+default, if no atom or message is given, is to set
+.B XWAIT_PROPERTY
+to the value
+.BR XWAIT_MESSAGE .
 .SH AUTHOR
 Mark Wooding (mdw@nsict.org).
 .SH BUGS