MAN page from Other AfterStep-1.4-1.i386.rpm

XITERM

Section: X Tools (1)
Updated: September, 1st 1997
Index

NAME

xiterm --- VT102 emulator for the X window system

SYNOPSIS

xiterm[options][-ecommand[args]]

DESCRIPTION

xiterm--- version1.4--- is a color vt102 terminal emulator intended as anxterm(1)replacement for users who do not require features such as Tektronix 4014emulation and toolkit-style configurability.As a result,xitermuses much less swap space --- a significant advantage on a machine servingmany X sessions.

OPTIONS

Thexitermoptions(mostly a subset ofxterm's)are listed below.In keeping with the smaller-is-better philosophy, options may be eliminatedor default values chosen at compile-time, so options and defaults listedmay not accurately reflect the version installed on your system.

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

-help,--help: Print out a message describing available options.
-display displayname: Attempt to open a window on the named X display(-dstill respected).In the absence of this option, the display specified by theDISPLAYenvironment variable is used.
-geometry geom: Window geometry(-gstill respected); resourcegeometry.
-rv|+rv: Turn on/off simulated reverse video; resourcereverseVideo.
-bg color: Window background color; resourcebackground.
-fg color: Window foreground color; resourceforeground.
-pixmap: file[;geom]: Specify XPM file for the background and also optionally specify itsscaling with a geometry string; resourcebackgroundPixmap.
-cr color: The cursor color; resourcecursorColor.
-fn fontname: Main normal text font; resourcefont.
-fb fontname: Main bold text font; resourceboldFont.
-fk fontname: Main Kanji font; resourcekfont.
-km mode: Kanji encoding mode;eucj:EUC Japanese encoding.sjis:Shift JIS encoding; resourcekanji_encoding.
-grk mode: Greek keyboard translation;iso:ISO-8859 mapping.ibm:IBM-437 mapping; resourcegreek_keyboard.
-name name: Specify the application name under which resources are to be obtained,rather than the default executable file name.Name should not contain `.' or `*' characters.Also sets the icon and title name.
-ls|+ls: Start as a login-shell/sub-shell; resourceloginShell.
-ut|+ut: Inhibit/enable writing a utmp entry; resourceutmpInhibit.
-vb|+vb: Turn on/off visual bell on receipt of a bell character; resourcevisualBell.
-sb|+sb: Turn on/off scrollbar; resourcescrollBar.
-iconic: Start iconified, if the window manager supports that option.
-sl number: Savenumberlines in the scrollback buffer; resourcesaveLines.
-e command [arguments]: Run the command with its command-line arguments in thexitermwindow.If this option is used, it must be the last on the command-line.If there is no-eoption then the default is to run the program specified by theSHELLenvironment variable or, failing that,sh(1).
-title text: Window title(-Tstill respected); resourcetitle.
-n text: Icon name; resourceiconName.
-C: Capture system console messages.

RESOURCES (available also as long-options)

xitermaccepts application defaults set in XAPPLOADDIR/Xiterm (compile-time defined:usually/usr/lib/X11/app-defaults/Xiterm)and resources set in~/.Xdefaultsor~/.Xresources.Note that when reading X resources,xitermrecognizes two class names:XTermandXiterm.The class nameXTermallows resources common to bothxitermandxtermto be easily configured, while the class nameXitermallows resources unique toxiterm,notably colors and key-handling, to be shared between differentxitermconfigurations.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:

geometry: geom

Create the window with the specified X window geometry [default 80x24]; option-geometry.

background: color

Use the specified color as the window's background color[default White];option-bg.

foreground: color

Use the specified color as the window's foreground color[default Black];option-fg.

colorn: color

Use the specified color for the color valuen,where 0-7 corresponds to low-intensity (normal) colors and 8-15corresponds to high-intensity (bold = bright foreground, blink = brightbackground) colors.The canonical names are as follows:0=black,1=red,2=green,3=yellow,4=blue,5=magenta,6=cyan,7=white,but the actual color names used are listed in theCOLORS AND GRAPHICSsection.

colorBD: color

Use the specified color to display bold characters when the foreground coloris the default.

colorUL: color

Use the specified color to display underlined characters when the foregroundcolor is the default.

cursorColor: color

Use the specified color for the cursor.The default is to use the foreground color; option-cr.

cursorColor2: color

Use the specified color for the color of the cursor text.For this to take effect,cursorColormust also be specified.The default is to use the background color.

reverseVideo: boolean

True:simulate reverse video by foreground and background colors; option-rv,False:regular screen colors [default]; option+rv.See note inCOLORS AND GRAPHICSsection.

scrollColor: color

Use the specified color for the scrollbar [default #B2B2B2].

backgroundPixmap: file[;geom]

Use the specified XPM file (note the `.xpm' extension is optional) forthe background and also optionally specify its scaling with a geometrystringWxH+X+Y,in whichW/Hspecify the horizontal/vertical scale (percent) andX/Ylocate the image centre (percent).A scale of 0 displays the image with tiling.A scale of 1 displays the image without any scaling.A scale of 2 to 9 specifies the number of images in that direction.No image will be magnified beyond 10 times its original size.The maximum permitted scale is 1000.[default 100x100+50+50]

path: path

Specify the colon-delimited search path for finding XPM files, inaddition to the paths specified by theXITERMPATHandPATHenvironment variables.

font: fontname

Select the main text font used [default 7x14]; option-fn.

fontn: fontname

Specify the alternative fontn.The default font values:

font:	7x14font1:	6x10font2:	6x13font3:	8x13font4:	9x15

boldFont: fontname

Specify the name of the bold font to use ifcolorBDhas not been specified and it is not possible to map the default foregroundcolor to color 8-15 [default NONE].This font must be the same height and width as the normal font;option-fb.

kfont: fontname

Select the main Kanji text font used [default k14]; option-fk.

kfontn: fontname

Specify the alternative Kanji fontn.If compiled for Kanji, the Roman and Kanji font sizes should match.The default font values:

font:	7x14font1:	8x16font2:	9x18font3:	12x24font4:	13x26kfont:	k14kfont1:	jiskan16kfont2:	jiskan18kfont3:	jiskan24kfont4:	jiskan26

kanji_encoding: mode

Set the Kanji encoding mode to be used;eucj:EUC Japanese encoding [default].sjis:Shift JIS encoding; option-km.

greek_keyboard: mode

Set the Greek keyboard translation mode to be used;iso:ISO-8859 mapping (elot-928) [default].ibm:IBM-437 mapping (DOS codepage 737); option-grk.UseMode_switchto toggle keyboard input.For more details, see the distributed fileREADME.greek.

title: text

Set window title string, the default title is the command-line specifiedafter the-eoption, if any, otherwise the application name; option-title.

iconName: text

Set the name used to label the window's icon or displayed in an icon managerwindow, it also sets the window's title unless it is explicitly set;option-n.

mapAlert: boolean

True:de-iconify (map) on receipt of a bell character.False:no de-iconify (map) on receipt of a bell character [default].

visualBell: boolean

True:use visual bell on receipt of a bell character; option-vb.False:no visual bell [default]; option+vb.

loginShell: boolean

True:start as a login shell by prepending a `-' toargv[0]of the shell; option-ls.False:start as a normal sub-shell [default]; option+ls.

utmpInhibit: boolean

True:inhibit writing record into the system log fileutmp;option-ut.False:write record into the system log fileutmp[default]; option+ut.

print-pipe: string

Specify a command pipe for vt100 printer [defaultlpr(1)].UsePrintto initiate a screen dump to the printer andCtrl-PrintorShift-Printto include the scrollback as well.

scrollBar: boolean

True:enable the scrollbar [default]; option-sb.False:disable the scrollbar; option+sb.Note that the scrollbar position (left/right) and its type (with/withoutarrows) is compile-time selected.

smallfont_key: keysym

If enabled, useAlt-keysymto toggle to a smaller font [defaultAlt-<].

bigfont_key: keysym

If enabled, useAlt-keysymto toggle to a bigger font [defaultAlt->].

saveLines: number

Savenumberlines in the scrollback buffer [default 64]; option-sl.

meta8: boolean

True:handle Meta (Alt) + keypress to set the 8th bit.False:handle Meta (Alt) + keypress as an escape prefix [default].

cutchars: string

The characters used as delimiters for double-click word selection.The built-in default:
TAB SPACE BACKSLASH `'&()*,;<=>?@[]{|}

keysym.sym: string

Associatestringwith keysymsym(0xFF00-0xFFFF).It may contain escape values (\a: bell, \b: backspace, \e, \E:escape, \n: newline, \r: return, \t: tab, \000: octal number) orcontrol characters (^?: delete, ^@: null, ^A ...) and may enclosedwith double quotes so that it can start or end with whitespace.The intervening resource namekeysym.cannot be omitted.This resource is only available when compiled withFAKE_RESOURCES.

THE SCROLLBAR

Lines of text that scroll off the top of thexitermwindow (resource:saveLines)and can be scrolled back using the scrollbar or by keystrokes.The normalxitermscrollbar has arrows and its behaviour is fairly intuitive.Thexterm-scrollbaris without arrows and its behaviour mimics that ofxterm.

Scroll down withButton1(xterm-scrollbar)orShift-Next.
Scroll up withButton3(xterm-scrollbar)orShift-Prior.
Continuous scroll withButton2.

MOUSE REPORTING

To temporarily override mouse reporting, for either the scrollbar or thenormal text selection/insertion, hold either the Shift or the Meta (Alt) keywhile 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 sendsESC[6~ (Next)andESC[5~ (Prior),respectively.Similarly, clicking on the up and down arrows sendsESC[A (Up) andESC[B (Down),respectively.

TEXT SELECTION AND INSERTION

The behaviour of text selection and insertion mechanism is similar toxterm.

Selection:: Left click at the beginning of the region,drag to the end of the region and release;Right click to extend the marked region;Left double-click to select a word;Left triple-click to select the entire line.
Insertion:: Pressing and releasing the Middle mouse button (orShift-Insert)in anxitermwindow causes the current text selection to be inserted as if it hadbeen typed on the keyboard.

CHANGING FONTS

You can change fonts on-the-fly, which is to say cycle through thedefault font and others of various sizes, by usingShift-KP_Add and Shift-KP_Subtract.Or, alternatively (if enabled) withAlt-> andAlt-<,where the actual key can be selected using resourcessmallfont_key/bigfont_key.

LOGIN STAMP

xitermtries to write an entry into theutmpfile (usually/etc/utmp),so that it can be seen via thewho(1)command, and can accept messages.To allow this feature,xitermmust be installed setuid root.

COLORS AND GRAPHICS

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

In addition to the default foreground and background colors,xitermcan display up to 16 colors (8 ANSI colors plus high-intensity bold/blinkversions of the same).Here is a list of the colors with theirrgb.txtnames.

color0	(black)	= Blackcolor1	(red)	= Red3color2	(green)	= Green3color3	(yellow)	= Yellow3color4	(blue)	= Blue3color5	(magenta)	= Magenta3color6	(cyan)	= Cyan3color7	(white)	= AntiqueWhitecolor8	(bright black)	= Grey25color9	(bright red)	= Redcolor10	(bright green)	= Greencolor11	(bright yellow)	= Yellowcolor12	(bright blue)	= Bluecolor13	(bright magenta)	= Magentacolor14	(bright cyan)	= Cyancolor15	(bright white)	= Whiteforeground	= Blackbackground	= White

It is also possible to specify the color values offoreground,background,cursorColor,cursorColor2,colorBD,colorULas a number 0-15, as a convenient shorthand to reference the color name ofcolor0-color15.

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

xiterm -fg Black -bg White -rv: would yield White on Black, while onxtermit would yield Black on White.

ENVIRONMENT

xitermsets the environment variablesTERM,COLORTERMandCOLORFGBG.The environment variableWINDOWIDis set to the X window id number of thexitermwindow and it also uses and sets the environment variableDISPLAYto specify which display terminal to use.xitermuses the environment variablesXITERMPATHandPATHto find XPM files.

FILES

/etc/utmp: System file for login records.
/usr/lib/X11/rgb.txt: Color names.

BUGS

Selecting/pasting very large chunks of text is a problem.But as is the case forxterm,it is a bug of the pseudo terminal driver of those systems.

xiterm 1.0 has the utmp support cleaned-up and supportsutmpx(i.e. Solaris 2.x) but there are still some problems.Please inform the maintainer of the correct solutions to utmp problemssince he doesn't have root access of his own to test utmp.

Cursor change support is not yet implemented.

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

Graphics support is fairly crude.

For some fonts there are problems with pixel-droppings being left behindwhen simulated bold (overstrike) precedes a space character.Fixingxitermto handle these cases requires a lot of energy.So the easiest course by far is to specify a boldFont, specify colorBD or,if it was compiled without NO_BRIGHTCOLOR, to select a foreground color thatmatches the pixel values of color 0-7 so that overstrike bold won't be used.

Likexterm,xitermhandles mono-space fonts only.

AUTHOR

John Bovey, University of Kent, 1992.

Very very very heavily modified by Rob Nation<nationAATTrocket.sanders.lockheed.com>

Greek keyboard input: Angelo Haritsis <ahAATTdoc.ic.ac.uk>

Utmpx addition (Solaris 2.x) and extensive reworking of pseudo-tty handlingand addition of BSD sgtty terminal handling support by Raul Garcia Garcia<rggAATTtid.es> 16/10/95.

mj olesen <olesenAATTme.QueensU.CA> (changes.txt 2.11 to 2.20)

CURRENT MAINTAINER

"Guylhem Aznar <guylhemAATTdanmark.linux.eu.org>"

LOCATION

<www.linux-france.com>

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
RESOURCES (available also as long-options)
THE SCROLLBAR
MOUSE REPORTING
TEXT SELECTION AND INSERTION
CHANGING FONTS
LOGIN STAMP
COLORS AND GRAPHICS
ENVIRONMENT
FILES
SEE ALSO
BUGS
AUTHOR
CURRENT MAINTAINER
LOCATION

This document was created byman2html,using the manual pages.