Minor tidying and typo correction.
[xtoys] / xshutdown.1
1 .\" -*-nroff-*-
2 .TH xshutdown 1 "15 November 1998" "Edgeware tools"
3 .SH NAME
4 xshutdown \- asks for user confirmation before waking an xwait process
5 .SH SYNOPSIS
6 .B xshutdown
7 .RB [ \-\-display
8 .IR display ]
9 .RB [ \-a
10 .IR atom ]
11 .RB [ \-m
12 .IR message ]
13 .RB [ \-t
14 .IR title ]
15 .SH DESCRIPTION
16 The
17 .B xshutdown
18 program pops up a pretty GTK confirmation box asking the user whether he
19 (or she) wants to shutdown the current session. If so, it sends a
20 message to a waiting
21 .B xwait
22 process, by setting a named property on the X root window to a particular
23 value.
24 .SS OPTIONS
25 .TP 5
26 .BI "\-\-display " display
27 Attempt to connect to
28 .I display
29 rather than the display named in the usual environment variable.
30 .TP 5
31 .BI "\-a, \-\-atom " atom
32 Sets
33 .B xshutdown
34 to to set the property named
35 .IR atom .
36 The default property to set is
37 .BR XWAIT_PROPERTY .
38 .TP 5
39 .BI "\-m, \-\-msg " message
40 Sets
41 .B xshutdown
42 to set the given property to
43 .IR message .
44 The default message to set is
45 .BR XWAIT_MESSAGE .
46 .TP 5
47 .BI "\-p, \-\-prompt " prompt
48 Sets the prompt in the confirmation box to
49 .IR prompt .
50 .TP 5
51 .BI "\-t, \-\-title " title
52 Sets the window title to be
53 .IR title .
54 .SH AUTHOR
55 Mark Wooding (mdw@nsict.org).
56 .SH BUGS
57 None currently known.
58 .SH SEE ALSO
59 .BR xwait (1),
60 and
61 .BR xtell (1).