.\" $HeadURL$ $LastChangedRevision$
.\"
.pso ade-config --format=man
.so \*[ade_include_prefix]/ade.man
.pso bs-config --format=man
.TH BS 1 "ADE_APP_TOKEN_RELEASE_DATE_MAN"
.SH NAME
bs \- label an xterm
.br
.ne 5
.SH SYNOPSIS
.B bs
\*[ade_standard_synopsis_component]
[
.B \-w
|
.B \-\-window
|
.B \-i
|
.B \-\-icon
|
.B \-b
|
.B \-\-both
] [
.B \-F
|
.B \-\-force
]
.br
.ne 5
.SH DESCRIPTION
.B Bs
changes the title that appears on the titlebar of an
.B xterm\fR(1).
.br
.ne 5
.SH CONFIGURATION
None.
.br
.ne 5
.SH OPTIONS
\*[ade_standard_options_component]
.TP 
.B \-b\fR, \fB\-\-both
Change the title that appears on the
icon that appears when the window is minimized and on
the window. This is default behaviour.
.TP
.B \-F\fR, \fB\-\-force
Force 
.B bs
to perform the requested labelling, even if the 
.B TERM
environment variable seems to indicate that the terminal
is not labellable.
.TP
.B \-i\fR, \fB\-\-icon
Change the title that appears on the
icon that appears when the window is minimized, but not on
the window.
.TP
.B \-w\fR, \fB\-\-window
Change the title that appears on the window, but not that on the
icon that appears when the window is minimized.
.br
.ne 5
.SH EXIT STATUS
On success
.B bs
returns zero. On failure it returns non-zero and displays a diagnostic
message.
.br
.ne 5
.SH FILES
None.
.br
.ne 5
.SH ENVIRONMENT VARIABLES
.TP 25
TERM
This is used to detemine if the terminal can actually have its title
changed. See also the 
.B \-F
option.
.br
.ne 5
.SH EXAMPLES
The following command labels the terminal window "tests":
.IP
.nf
.fam C
.B bs tests
.fam T
.fi
.br
.ne 5
.SH CAVEATS
None.
.br
.ne 5
.SH STANDARDS
This manual page documents version ADE_APP_TOKEN_RELEASE_ID of
.B bs\fR.
.br
.ne 5
.SH SEE ALSO
bs-config(1), xterm(1), term(7)
.br
.ne 5
.SH AUTHOR
ADE_APP_TOKEN_AUTHOR_NAME <ADE_APP_TOKEN_AUTHOR_EMAIL>
.br
.ne 5
.SH COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 2003-ADE_APP_TOKEN_RELEASE_YEAR ADE_APP_TOKEN_AUTHOR_NAME
\*[ade_standard_copyright_component]