[xtoys] / xshutdown.1

.\" -*-nroff-*-
.TH xshutdown 1 "15 November 1998" "Straylight/Edgeware" "xtoys"
.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 msg ]
.if n \{\
.br
\h'1i'
..
\}
.RB [ \-t
.IR title ]
.RI [ \c
.IB atom : 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 " msg
Sets
.B xshutdown
to set the given property to
.IR msg .
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--
307aa55f	2	.TH xshutdown 1 "15 November 1998" "Straylight/Edgeware" "xtoys"
90b2c5d4	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
e571b0f1	13	.IR msg ]
d72bdcdb	14	.if n \{\
	15	.br
	16	\h'1i'
	17	..
307aa55f	18	\}
90b2c5d4	19	.RB [ \-t
90b2c5d4	20	.IR title ]
d72bdcdb	21	.RI [ \c
e571b0f1	22	.IB atom : msg \c
e571b0f1	23	]
d72bdcdb	24	.ll -5i
90b2c5d4	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.
e571b0f1	34	.SS Options
90b2c5d4	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 .
d72bdcdb	46	This option is deprecated.
90b2c5d4	47	.TP 5
e571b0f1	48	.BI "\-m, \-\-msg " msg
90b2c5d4	49	Sets
	50	.B xshutdown
	51	to set the given property to
e571b0f1	52	.IR msg .
d72bdcdb	53	This option is deprecated.
90b2c5d4	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 .
d72bdcdb	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 .
90b2c5d4	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).