[xtoys] / xshutdown.1

.\" -*-nroff-*-
.TH xshutdown 1 "15 November 1998" "Edgeware tools"
.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 ]
.if n \{\
.br
\h'1i'
..
.RB [ \-t
.IR title ]
.RI [ \c
.IB atom : msg , msg \c
\&...]
.ll -5i
.SH DESCRIPTION
The
.B xshutdown
program pops up a pretty GTK confirmation box asking the user whether he
(or she) wants to shutdown the current session.  If so, it sends a
message to a waiting
.B xwait
process, by setting a named property on the X root window to a particular
value.
.SS OPTIONS
.TP 5
.BI "\-\-display " display
Attempt to connect to
.I display
rather than the display named in the usual environment variable.
.TP 5
.BI "\-a, \-\-atom " atom
Sets
.B xshutdown
to to set the property named
.IR atom .
This option is deprecated.
.TP 5
.BI "\-m, \-\-msg " message
Sets
.B xshutdown
to set the given property to
.IR message .
This option is deprecated.
.TP 5
.BI "\-p, \-\-prompt " prompt
Sets the prompt in the confirmation box to
.IR prompt .
.TP 5
.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
None currently known.
.SH SEE ALSO
.BR xwait (1),
and
.BR xtell (1).
Commit	Line	Data
b6eb57e6	1	.\" --nroff--
90b2c5d4	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
d72bdcdb	6	.ll +5i
90b2c5d4	7	.B xshutdown
	8	.RB [ \-\-display
	9	.IR display ]
	10	.RB [ \-a
	11	.IR atom ]
	12	.RB [ \-m
	13	.IR message ]
d72bdcdb	14	.if n \{\
	15	.br
	16	\h'1i'
	17	..
90b2c5d4	18	.RB [ \-t
90b2c5d4	19	.IR title ]
d72bdcdb	20	.RI [ \c
	21	.IB atom : msg , msg \c
	22	\&...]
	23	.ll -5i
90b2c5d4	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 .
d72bdcdb	45	This option is deprecated.
90b2c5d4	46	.TP 5
	47	.BI "\-m, \-\-msg " message
	48	Sets
	49	.B xshutdown
	50	to set the given property to
	51	.IR message .
d72bdcdb	52	This option is deprecated.
90b2c5d4	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 .
d72bdcdb	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 .
90b2c5d4	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).