New command line syntax, and new atom protocol.
[xtoys] / xshutdown.1
index 3033180..24c71cc 100644 (file)
@@ -3,6 +3,7 @@
 .SH NAME
 xshutdown \- asks for user confirmation before waking an xwait process
 .SH SYNOPSIS
+.ll +5i
 .B xshutdown
 .RB [ \-\-display
 .IR display ]
@@ -10,8 +11,16 @@ xshutdown \- asks for user confirmation before waking an xwait process
 .IR atom ]
 .RB [ \-m
 .IR message ]
+.if n \{\
+.br
+\h'1i'
+..
 .RB [ \-t
 .IR title ]
+.RI [ \c
+.IB atom : msg , msg \c
+\&...]
+.ll -5i
 .SH DESCRIPTION
 The
 .B xshutdown
@@ -33,16 +42,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
 Sets
 .B xshutdown
 to set the given property to
 .IR message .
-The default message to set is
-.BR XWAIT_MESSAGE .
+This option is deprecated.
 .TP 5
 .BI "\-p, \-\-prompt " prompt
 Sets the prompt in the confirmation box to
@@ -51,6 +58,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