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