.TH ETERM 1 @DATE@ "X Version 11" "X Tools"
.SH NAME
Eterm \(em
an Enlightened terminal emulator for the X Window System
.SH SYNOPSIS
.B Eterm
.RI [ options ]

.SH DESCRIPTION
.PP
.B Eterm
\(em version
.B @VERSION@
\(em is a color vt102 terminal emulator intended as an
.IR xterm (1)
replacement for users who want a term program integrated with
Enlightenment, or
simply want a little more "eye candy".
.B Eterm
uses Imlib for advanced graphic abilities.  See below for details.
.SH OPTIONS
The
.B Eterm
options are listed below.
In keeping with the freedom-of-choice philosophy, options may be eliminated
or default values chosen at compile-time, so options and defaults listed
may not accurately reflect the version installed on your system.
.LP
.TP
.BI \-t " theme" ", \-\-theme " theme
Load specified
.I theme\.
Consult the FAQ for more details on what constitutes an Eterm
.I theme\.
.TP
.BI \-X " conffile" ", \-\-config-file " conffile
Use an alternative config file name.  Otherwise Eterm uses the default,
which is 
.I MAIN\.
.TP
.BR "\-h" , " \-\-help"
Print out a message describing available options.
.TP
.BR "\-r" , " \-\-reverse-video"
Reverse video, swaps the foreground and background colors.
.TP
.BI \-b " color" ", \-\-background-color " color
Set
.I color
as the background color.
.B NOTE:
this will actually be the foreground color if reverse video is also
selected.
.TP
.BI \-f " color" ", \-\-foreground-color " color
Set
.I color
as the foreground (text) color.
.B NOTE:
this will actually be the background color if reverse video is also
selected.
.TP
.BI \-\-color0 " color"
.TP
.BI ...
.TP
.BI \-\-color15 " color"
Use
.I color
as color X.
.TP
.BI \-\-colorBD " color"
Use
.I color
as the bold color.
.TP
.BI \-\-colorUL " color"
Use
.I color
as the underline color.
.TP
.BI \-\-menu-text-color " color"
Use
.I color
as the menu text color (only makes sense if menu is enabled).
.TP
.BI \-S " color" ", \-\-scrollbar-color " color
Use
.I color
as the scrollbar color (only makes sense if scrollbar is enabled).
.TP
.BI \-\-unfocused-scrollbar-color " color
Use
.I color
as the scrollbar color when window does not have focus 
(only makes sense if scrollbar is enabled).
.TP
.BI \-\-pointer-color " color"
Use
.I color
as the pointer color.
.TP
.BI \-c " color" ", \-\-cursor-color " color
Use
.I color
as the cursor color.
.TP
.BI \-\-cursor-text-color " color"
Use
.I color
as the cursor text color.
.TP
.BI \-d " displayname" ", \-\-display " displayname
Attempt to open a window on the named X display
.I displayname.
In the absence of this option, the display specified by the
.B DISPLAY
environment variable is used.
.TP
.BI \-g " geom" ", \-\-geometry " geom
Window geometry as Width x Height+X coord+Y coord, i.e 100x200+0+100
.TP
.BR "\-i" , "\-\-iconic"
Start in iconified state (only if the window manager supports
iconification).
.TP
.BI \-n " name" ", \-\-name " name
Sets name of current instance to
.I name.
This will affect the icon title and the window title string unless
they are otherwise explicitly set.
.TP
.BI \-T " title" ", \-\-title " title
Sets window's title text to
.I title.
.TP
.BI \-\-icon-name " text"
Sets the icon title text to
.I text.
.TP
.BI \-\-bold-font " font"
Sets the bold text font to
.I font.
.TP
.BI \-F " font" ", \-\-font " font
Sets the normal text font to
.I font.
.TP
.BI \-\-font1 " font"
.TP
.BI ...
.TP
.BI \-\-font4 " font"
Sets font X to
.I font.
.TP
.BI \-P " pic" ", \-\-background-pixmap " pic
Use
.I pic
as the background image.
.I pic
can be in any format that Imlib understands.  Currently this means just
about anything, including JPG, PNG, GIF, TIFF, PPM, etc.  The image is
tiled by default.  To scale the image, use the
.B --scale
option below.
.TP
.BI \-U " pic" ", \-\-up-arrow-pixmap " pic
As above, except the scrollbar's up-arrow is set.  
.B NOTE:
This is not currently implemented.
.TP
.BI \-D " pic" ", \-\-down-arrow-pixmap " pic
As above, except the scrollbar's down-arrow is set.
.B NOTE:
This is not currently implemented.
.TP
.BI \-B " pic" ", \-\-trough-pixmap " pic
As above, except the scrollbar's background (trough) is set.
.B NOTE:
This is not currently implemented.
.TP
.BI \-A " pic" ", \-\-anchor-pixmap " pic
As above, except the scrollbar's anchor image is set.
.B NOTE:
This is not currently implemented.
.TP
.BR "\-@" , " \-\-scale"
Scale the image rather than tile.  Only makes sense if the background pixmap
option is used (see above).
.TP
.BR \-\-watch-pixmap
Do not use this option.  You have been warned.  Don't ask what it does, just
don't use it.
.TP
.BR "\-W" , " \-\-watch-desktop"
In a pseudo-transparent Eterm, this will watch the desktop for changes to the
image, Eterm moving to a different desktop, etc.  Use with the transparency
options below.
.TP
.BR "\-O" , " \-\-trans"
This gives a pseudo-transparent Eterm.  The image is taken directly from the
root window, so any requests for changing the pixmap are ignored.  If you do
not use Enlightenment (http://www.enlightenment.org/) as your window manager,
you will need to use the
.I Esetroot
program in the
.B doc/
directory to set your root background image.
.TP
.BR \-\-shade
When used with the
.B -O
or
.B --trans
options, 
.B --shade
will darken the portion of the root window image contained within the Eterm
window, giving a sort of "smoked glass" effect.
.TP
.BI \-p " newpath" ", \-\-path " newpath
Sets the pic search path.  When the
.B --background-pixmap
or other pixmap options are used, this path will be used to find the image.
.TP
.BR "\-l", " \-\-login-shell"
Makes the new shell a login shell.
.TP
.BR "\-s", " \-\-scrollbar"
Enables the scrollbar. (Default)
.TP
.BR "\-u", " \-\-utmp-logging"
Tries to enable proper utmp logging.  For this to work, Eterm probably needs
to run setuid or setgid, usually setuid root.
.TP
.BR "\-v", " \-\-visual-bell"
Enables the "visual bell".  Means the window will flash or blink rather
than beep.
.TP
.BR "\-H", " \-\-home-on-echo"
Jump to bottom on output.
.TP
.BR "\-H", " \-\-home-on-input"
Jump to bottom on input.
.TP
.BR "\-E", " \-\-home-on-refresh"
Jump to bottom on refresh (^L)
.TP
.BR "\-\-scrollbar-right"
Display scrollbar on the right hand side.
.TP
.BR "\-\-scrollbar-floating"
Display the scrollbar without a trough.
.TP
.BR "\-x", " \-\-borderless"
This option forces Eterm to have no borders.  This also means that the
window can not be moved or resized.  Recommend using
.B --geometry
as well with this option.  Also, if your window manager supports borderless
windows itself, use that functionality rather than Eterm's.
.TP
.BR "\-m", " \-\-map-alert"
Un-iconify on beep.
.TP
.BR "\-8", " \-\-meta8"
Causes the Meta key to set the 8th bit in the char.
.TP
.BR "\-\-save-under"
If supported by the X server, tries to use backing store for faster
refreshes.
.TP
.BR "\-\-no-cursor"
Disables the text cursor.
.TP
.BI \-\-big-font-key " keysym
Specify a keysym to increase the font size.  Default is Shift and the +
key on the keypad.  Ctrl-> or Meta-> may also work (if you #define one
of the hotkeys in src/feature.h).
.TP
.BI \-\-small-font-key " keysym
Specify a keysym to decrease the font size.  Default is Shift and the -
key on the keypad.  Ctrl-< or Meta-< may also work (if you #define one
of the hotkeys in src/feature.h).
.TP
.BI \-L " num" ", \-\-save-lines " num
Set the number of lines in the scrollback buffer to
.I num.
.TP
.BI \-w " width" ", \-\-border-width " width
Set the window's border width to
.I width.
The border this controls is the gap between the edge of the X window and
the edge of the terminal window; this has nothing to do with the window
border's your window manager supplies.
.TP
.BI \-\-print-pipe " pipe"
The pipe for the PrintScreen function.
.TP
.BI \-\-cut-chars " separators"
The seperators for double-click selection.
.TP
.BI \-M " file" ", \-\-menu " file
Replace default menubar file with
.I file.
.TP
.BI \-\-term-name " TERM"
Use
.I TERM
for the value $TERM.
.TP
.BR "\-C", " \-\-console"
Grab console messages.  Depending on your system, Eterm may need to be
setuid root to do this.
.TP
.BI \-e " command" ", \-\-exec " command
Execute
.I command
rather than a shell.

.SH SPECIAL LANGUAGE FEATURES
The following are
.B *NOT*
compiled in by default.
.PP
.TP
.B Kanji (Japanese character) options
.TP
.BI \-K " font" ", \-\-kanji-font " font
Use
.I font
as the default kanji font.
.TP
.BI \-\-kanji-font1 " font"
.TP
.BI ...
.TP
.BI \-\-kanji-font4 " font"
Use
.I font
as kanji font X.
.TP
.BR "\-\-kanji-encoding"
Use Kanji encoding mode (eucj or sjis).
.TP
.B Greek options
.TP
.BR "\-\-greek-keyboard"
Use Greek keyboard mapping (iso or ibm).

.SH THEMES

Eterm is built on the philosophy of Freedom of Choice.  Each user should be able to choose
the environment in which he wishes to exist, and the tools he uses should support that.
In accordance with that philosophy, Eterm is extremely configurable.  Eterm supports a concept
called "themes," which should be familiar to users of Enlightenment, icewm, or Microsoft
Windows 95/98/NT.  The general concept of a theme is a collection of resources that change
as many aspects of a programs look and feel as possible.  For example, an Enlightenment theme
allows you to customize menus, window borders, desktops, icons, iconbars, and everything else
about how E looks and feels.

An Eterm theme consists of a primary configuration file, always called "MAIN", residing in a
directory bearing the same name as the theme. This directory must be a child of one of the
directories specified by CONFIG_SEARCH_PATH in src/feature.h, in the environment variable
defined by PATHENV in src/feature.h, or in the default PATH. The theme may also contain
additional configuration files referenced by the primary MAIN file, pixmaps, menu files,
documentation, etc., which are allowable as extensions to the minimum requirement of an Eterm
theme. 

By convention and default, Eterm themes should be stored under ~/.Eterm/themes/<theme_name>/ or
@THEMEDIR@/<theme_name>.

All command line options can be enabled/disabled in the theme file (the
default is @THEMEDIR@/Eterm/MAIN).  This file is split into sections: color,
attributes, pixmaps, toggles, keyboard, and misc.

.SH AUTHORS
Tuomo Venalainen (vendu@cc.hut.fi) and Michael Jennings (mej@tcserv.com).
Man page re-written for version 0.8 by Shaleh (shaleh@debian.org).

.SH URL(s)
Main Web Site -- <http://www.tcserv.com/Eterm/>
The Eterm FAQ -- <http://www.tcserv.com/Eterm/FAQ.html>
Project Resurrection -- <http://ganja.tky.hut.fi/Resurrection/>
.br