.YODLTAGSTART. label versioninfo.yo .YODLTAGEND. .YODLTAGSTART. label masonyodl.yo .YODLTAGEND. .YODLTAGSTART. documenttype article .YODLTAGEND.1 .YODLTAGSTART. title 1 .YODLTAGEND. .YODLTAGSTART. bodytagopt .YODLTAGEND.

1

X Version 11

06 September 01

NAME

aterm (Afterstep XVT) - a VT102 emulator for the X window system


SYNOPSIS


aterm [options] [-e command [ args ]]


DESCRIPTION


aterm, version 0.4.2, is a colour vt102 terminal emulator, based on rxvt 2.4.8 with Alfredo Kojima's additions of fast transparency, intended as an xterm(1) replacement for users who do not require features such as Tektronix 4014 emulation and toolkit-style configurability. As a result, aterm uses much less swap space -- a significant advantage on a machine serving many X sessions.


It was created with AfterStep Window Manger users in mind, but is not tied to any libraries, and can be used anywhere.



.YODLTAGSTART. label aterm-options.yo .YODLTAGEND.

OPTIONS


The aterm options (mostly a subset of xterm's) are listed below. In keeping with the smaller-is-better 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.


Note that aterm permits the resource name to be used as a long-option (--/++ option) so the potential command-line options are far greater than those listed. For example: `aterm --loginShell --color1 Orange'.


.YODLTAGSTART. label aterm-resources.yo .YODLTAGEND.

RESOURCES (available also as long-options)


aterm accepts application defaults set in XAPPLOADDIR/aterm (compile-time defined: usually /usr/lib/X11/app-defaults/aterm) and resources set in ~/.Xdefaults or ~/.Xresources. Note that when reading X resources, aterm recognizes two class names: XTerm and Aterm. The class name XTerm allows resources common to both aterm and xterm to be easily configured, while the class name Aterm allows resources unique to aterm, notably colours and key-handling, to be shared between different aterm configurations. If no resources are specified, suitable defaults will be used. Command-line arguments can be used to override resource settings. The following resources are allowed:


.YODLTAGSTART. label aterm-scrollbar.yo .YODLTAGEND.

THE SCROLLBAR


Lines of text that scroll off the top of the aterm window (resource: saveLines) and can be scrolled back using the scrollbar or by keystrokes. The normal aterm scrollbar has arrows and its behaviour is fairly intuitive. The xterm-scrollbar is without arrows and its behaviour mimics that of xterm. When build with --enable-next-scroll aterm will have NeXT-ish scrollbars. They look nicer and easier in use, but have slightly larger size. Their look and size can be tweaked at compile time by modifying parameters in rxvt.h.


Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with Button2. .YODLTAGSTART. label rxvt-mousereporting.yo .YODLTAGEND.

MOUSE REPORTING


To temporarily override mouse reporting, for either the scrollbar or the normal text selection/insertion, hold either the Shift or the Meta (Alt) key while performing the desired mouse action.


If mouse reporting mode is active, the normal scrollbar actions are disabled -- on the assumption that we are using a fullscreen application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down arrows sends ESC[A (Up) and ESC[B (Down), respectively. .YODLTAGSTART. label aterm-textselection.yo .YODLTAGEND.

TEXT SELECTION AND INSERTION


The behaviour of text selection and insertion mechanism is similar to xterm(1).


.YODLTAGSTART. label rxvt-fonts.yo .YODLTAGEND.

CHANGING FONTS


You can change fonts on-the-fly, which is to say cycle through the default font and others of various sizes, by using Shift-KP_Add and Shift-KP_Subtract. Or, alternatively (if enabled) with Alt-> and Alt-<, where the actual key can be selected using resources smallfont_key/bigfont_key. .YODLTAGSTART. label aterm-login.yo .YODLTAGEND.

LOGIN STAMP


aterm tries to write an entry into the utmp(5) file so that it can be seen via the who(1) command, and can accept messages. To allow this feature, aterm must be installed setuid root on some systems. .YODLTAGSTART. label aterm-colours.yo .YODLTAGEND.

COLORS AND GRAPHICS


If graphics support was enabled at compile-time, aterm can be queried with ANSI escape sequences and can address individual pixels instead of text characters. Note the graphics support is still considered beta code.


In addition to the default foreground and background colours, aterm can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink versions of the same). Here is a list of the colours with their rgb.txt names.


color0 (black) = Black
color1 (red) = Red3
color2 (green) = Green3
color3 (yellow) = Yellow3
color4 (blue) = Blue3
color5 (magenta) = Magenta3
color6 (cyan) = Cyan3
color7 (white) = AntiqueWhite
color8 (bright black) = Grey25
color9 (bright red) = Red
color10 (bright green) = Green
color11 (bright yellow) = Yellow
color12 (bright blue) = Blue
color13 (bright magenta) = Magenta
color14 (bright cyan) = Cyan
color15 (bright white) = White
foreground = Black
background = White


It is also possible to specify the colour values of foreground, background, cursorColor, cursorColor2, colorBD, colorUL as a number 0-15, as a convenient shorthand to reference the colour name of color0-color15.


Note that -rv ("reverseVideo: True") simulates reverse video by always swapping the foreground/background colours. This is in contrast to xterm(1) where the colours are only swapped if they have not otherwise been specified. For example,


.YODLTAGSTART. label aterm-environment.yo .YODLTAGEND.

ENVIRONMENT


aterm sets the environment variables TERM, COLORTERM and COLORFGBG. The environment variable WINDOWID is set to the X window id number of the aterm window and it also uses and sets the environment variable DISPLAY to specify which display terminal to use. aterm uses the environment variables ATERMPATH, then RXVTPATH and finally PATH to find XPM files. .YODLTAGSTART. label rxvt-files.yo .YODLTAGEND.

FILES



SEE ALSO


xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)


See rxvtRef.html rxvtRef.txt for detailed information on recognized escape sequences and menuBar syntax, etc.


BUGS


Check the BUGS file for an up-to-date list.


Cursor change support is not yet implemented.


Click-and-drag doesn't work with X11 mouse report overriding.


Graphics support is fairly crude.


FTP LOCATION


aterm-0.4.2.tar.gz can be found at the following ftp sites ftp://ftp.afterstep.org/apps/aterm


CURRENT PROJECT COORDINATOR



AUTHORS