.TH WTERM 1 "September 1999" "Debian Project"
.SH NAME
wterm \- RXVT based X console.
.SH SYNOPSIS
.B wterm 
[
.I options
]
.br
.SH "DESCRIPTION"
This manual page documents briefly the
.BR wterm
application.
Wterm is an X console based on RXVT, it has many features including
fast transparency, nice scrollbars and image backgrounds.
..
.SH OPTIONS
..
.B -Note-
.br
In most cases, \fI-option\fP turns the option on, \fI+option\fP will turn
it off. This may seem a little illogical, but such is life.
..
.TP
.B -C
Intercept console messages.
..
.TP
.B -bd \fIcolour\fP
Border colour.
..
.TP
.B -bg \fIcolour\fP
Set background colour.
..
.TP
.B -cr \fIcolour\fP
Cursor colour.
..
.TP
.B -display \fIstring\fP
X server to connect to.
..
.TP
.B -e \fIcommand\fP [arguments]
Open wterm and execute command.
..
.TP
.B -fb \fIfontname\fP
Use specified font for bold.
..
.TP
.B -fg \fIcolour\fP
Set foreground colour.
..
.TP
.B -fn \fIfontname\fP
Use specified font for normal text.
..
.TP
.B -gc \fIGC\fP
GC function types - The type of context use when creating the pixmap window.
..
.TP
.B \-geometry \fIgeometry\fP
Size (in characters) and position of window.
..
.TP
.B -/+hi
Turn on/off highlight.
..
.TP
.B -iconic
Start wterm as an icon.
..
.TP
.B -/+ls
Turn on/off login shell.
..
.TP
.B -n \fIstring\fP
Icon name for window.
..
.TP
.B -name \fIstring\fP
Client instance, icon and title strings.
..
.TP
.B -pixmap \fIfile\fP
Background pixmap
..
.TP
.B -pr \fIcolour\fP
Pointer colour.
..
.TP
.B -/+rv
Turn on/off reverse video.
..
.TP
.B -/+sb
Turn on/off scrollbar.
..
.TP
.B -/+sh
Turn on/off shaded transparency.
..
.TP
.B -/+si
Turn on/off scroll-on-tty-output.
..
.TP
.B -/+sk
Turn on/off scroll-on-keypress.
..
.TP
.B -sl \fInumber\fP
Number of scrolled lines to save.
..
.TP
.B -/+sr
Turn on/off scrollbar right.
..
.TP
.B -/+st
Turn on/off scrollbar without a trough.
..
.TP
.B -title \fIstring\fP
Title name for window.
..
.TP
.B \-tn \fIstring\fP
Value of the TERM environment variable
..
.TP
.B -/+tr
Turn on/off transparency.
..
.TP
.B -/+ut
Turn on/off utmp inhibit.
..
.TP
.B -/+vb
Turn on/off visual bell.
..
.TP
.B -/+wm
Turn on/off window maker menu.
..
.bp
.SH "SEE ALSO"
Docs can be found in \fI/usr/share/doc/wterm/\fP.
Also, take a look at
.I http://wm.current.nu/files.html#wterm
for more information on wterm.
..
.sp
GC function types, the type of context use when creating the pixmap window
is a complex feature, and cannot be explained here in any depth which would
be useful. I suggest the manpage
.BR XCreateGC (3x),
which is a part of the
.I xmanpages
package.
.sp
The following manpages may also be of use:
.sp
.BR xvt (1),
.BR rxvt (1).
..
.SH "UTMP SUPPORT"
.Pp
Wterm has support for UTMP. This means that a user who using a wterm, is
visible in the "who" command. In order for this to work, the wterm binary
(located in \fB/usr/bin/\fP) is set with a group "utmp" and is set gid
utmp.
.Pp
.sp
.Pp
If you find that UTMP support isn't working (your wterm's don't show up in a
who), check the permissions of \fB/var/run/utmp\fP. They should look something
like:
.sp
-rw-rw-r--    1 root     utmp         8448 May  6 21:47 /var/run/utmp
.sp
This can be set with the following commands (as the \fBroot\fP user):
.br
	\fBchown root.utmp /var/run/utmp
.br
	chmod 664 /var/run/utmp\fP
.Pp
.sp
.Pp
..
.SH "OTHER NOTES"
.Pp
You can change your font size on the fly in wterm with the following keyboard
combinations:
.sp
\fB	Key Combination			Function\fP
.sp
	shift & keypad "+"		\fIMake font larger\fP 
.br
	shift & keypad "-" 		\fIMake font smaller\fP
.sp
.bp
.Pp
It's also worth noting that the keyboard combination \fBshift & insert\fP
causes the current text selection to be inserted. Select a portion of text
using your mouse cursor, and press the combination in wterm.
.Pp
.sp
.SH "CREDITS"
.Pp
Author of xvt is John Bovey, authors of rxvt are Rob Nation, Mark Olesen,
Oezguer Kesim and Geoff Wing, and author of wterm is an anonymous coder.
.Pp
..
.sp
.Pp
This manual page was written by Mark Triggs <mrbump@debian.org>.
.Pp