Build separately from libraries.
[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 .ll +5i
7 .B xshutdown
8 .RB [ \-\-display
9 .IR display ]
10 .RB [ \-a
11 .IR atom ]
12 .RB [ \-m
13 .IR msg ]
14 .if n \{\
15 .br
16 \h'1i'
17 ..
18 .RB [ \-t
19 .IR title ]
20 .RI [ \c
21 .IB atom : msg \c
22 ]
23 .ll -5i
24 .SH DESCRIPTION
25 The
26 .B xshutdown
27 program pops up a pretty GTK confirmation box asking the user whether he
28 (or she) wants to shutdown the current session. If so, it sends a
29 message to a waiting
30 .B xwait
31 process, by setting a named property on the X root window to a particular
32 value.
33 .SS Options
34 .TP 5
35 .BI "\-\-display " display
36 Attempt to connect to
37 .I display
38 rather than the display named in the usual environment variable.
39 .TP 5
40 .BI "\-a, \-\-atom " atom
41 Sets
42 .B xshutdown
43 to to set the property named
44 .IR atom .
45 This option is deprecated.
46 .TP 5
47 .BI "\-m, \-\-msg " msg
48 Sets
49 .B xshutdown
50 to set the given property to
51 .IR msg .
52 This option is deprecated.
53 .TP 5
54 .BI "\-p, \-\-prompt " prompt
55 Sets the prompt in the confirmation box to
56 .IR prompt .
57 .TP 5
58 .BI "\-t, \-\-title " title
59 Sets the window title to be
60 .IR title .
61 .PP
62 The
63 .B \-a
64 and
65 .B \-m
66 options are deprecated, though retained for compatibility reasons. It's
67 recommended that you use the non-option specification instead.
68 .PP
69 The argument specifies an atom name and a message string to set. The
70 default, if no atom or message is given, is to set
71 .B XWAIT_PROPERTY
72 to the value
73 .BR XWAIT_MESSAGE .
74 .SH AUTHOR
75 Mark Wooding (mdw@nsict.org).
76 .SH BUGS
77 None currently known.
78 .SH SEE ALSO
79 .BR xwait (1),
80 and
81 .BR xtell (1).