.\" $HeadURL$ $LastChangedRevision$
#spp comment vim: set filetype=nroff: #
#spp include SPPSYM_MODROOT/bldcfg/paths.spp
.TH LX 1 "SPPSYM_RELEASE_DATE_MAN"
.SH NAME
lx \- Label an xterm
.br
.ne 5
.SH SYNOPSIS
.B lx
[
.B \-V
|
.B \-\-version
] [
.B \-v
|
.B \-\-verbose
|
.B \-d
.I level
|
.B \-\-debug=\fIlevel\fR 
] [
.B \-h
|
.B \-\-help
] [
.B \-p
|
.B \-\-list\-paths
] 
[
.B \-w
|
.B \-i
|
.B \-b
] [
.B \-f
]
.br
.ne 5
.SH DESCRIPTION
This manual page documents version SPPSYM_RELEASE_ID of 
.B lx\fR.
.PP 
.B Lx
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
.TP 25
.B \-b
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 \-d \fIlevel\fR, \fB\-\-debug=\fIlevel\fR
Determines how verbose
.B lx
will be. The message types displayed for the different values of 
.I level
are as follows:
.RS 25
.TP 5
.B 0
internal errors only
.TP
.B 1
internal errors and normal errors 
.TP
.B 2
internal errors, normal errors and warnings
.TP 
.B 3
internal errors, normal errors, warnings and informational messages
.TP 
.B >3
all the above plus application-specific debug messages.
.RE
.TP
.B \-f
Force 
.B lx
to perform the requested labelling, even if the 
.B TERM
environment variable seems to indicate that the terminal
is not labellable.
.TP
.B \-h\fR, \fB\-\-help
Displays a brief usage message.
.TP
.B \-i
Change the title that appears on the
icon that appears when the window is minimized, but not on
the window.
.TP
.B \-p\fR, \fB\-\-list\-paths
List the compiled-in paths of various files and directories that
.B lx
uses.
.TP 
.B \-v\fR, \fB\-\-verbose
Equivalent to
.B \-d 3\fR.
.TP
.B \-V\fR, \fB\-\-version
Print the program's version number and exit.
.TP
.B \-w
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 lx
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 does nothing:
.IP
.nf
.fam C
.B lx
.fam T
.fi
.br
.ne 5
.SH CAVEATS
None.
.br
.ne 5
.SH SEE ALSO
xterm(1)
.br
.ne 5
.SH AUTHOR
SPPSYM_AUTHOR_NAME <SPPSYM_AUTHOR_EMAIL>
.br
.ne 5
.SH COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 2003-SPPSYM_RELEASE_YEAR SPPSYM_AUTHOR_NAME
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.