.TH XTERM 1 "25 October 1988" "X Version 11" .de Ds .nf .\\$1D \\$2 \\$1 .ft 1 .ps \\n(PS .\".if \\n(VS>=40 .vs \\n(VSu .\".if \\n(VS<=39 .vs \\n(VSp .. .de De .ce 0 .if \\n(BD .DF .nr BD 0 .in \\n(OIu .if \\n(TM .ls 2 .sp \\n(DDu .fi .. .SH NAME xterm \- terminal emulator for X .SH SYNOPSIS .B xterm [-\fItoolkitoption\fP ...] [-option ...] .SH DESCRIPTION The \fIxterm\fP program is a terminal emulator for the X Window System. It provides DEC VT102 and Tektronix 4014 compatible terminals for programs that can't use the window system directly. If the underlying operating system supports terminal resizing capabilities (for example, the SIGWINCH signal in systems derived from 4.3bsd), \fIxterm\fP will use the facilities to notify programs running in the window whenever it is resized. .PP The VT102 and Tektronix 4014 terminals each have their own window so that you can edit text in one and look at graphics in the other at the same time. To maintain the correct aspect ratio (height/width), Tektronix graphics will be restricted to the largest box with a 4014's aspect ratio that will fit in the window. This box is located in the upper left area of the window. .PP Although both windows may be displayed at the same time, one of them is considered the ``active'' window for receiving keyboard input and terminal output. This is the window that contains the text cursor and whose border highlights whenever the pointer is in either window. The active window can be choosen through escape sequences, the ``Modes'' menu in the VT102 window, and the ``Tektronix'' menu in the 4014 window. .SH OPTIONS The \fIxterm\fP terminal emulator accepts all of the standard X Toolkit command line options along with the additional options listed below (if the option begins with a .RB ` + ' instead of a .RB ` \- ', the option is restored to its default value): .TP 8 .B \-help This causes \fIxterm\fP to print out a verbose message describing its options. .TP 8 .B \-132 Normally, the VT102 DECCOLM escape sequence that switches between 80 and 132 column mode is ignored. This option causes the DECCOLM escape sequence to be recognized, and the .I xterm window will resize appropriately. .TP 8 .B \-ah This option indicates that .I xterm should always highlight the text cursor and borders. By default, .I xterm will display a hollow text cursor whenever the focus is lost or the pointer leaves the window. .TP 8 .B \+ah This option indicates that .I xterm should do text cursor highlighting. .TP 8 .BI \-b " number" This option specifies the size of the inner border (the distance between the outer edge of the characters and the window border) in pixels. The default is 2. .TP 8 .B "\-cc \fIcharacterclassrange\fP:\fIvalue\fP[,...]" This sets classes indicated by the given ranges for using in selecting by words. See the section specifying character classes. .TP 8 .BI \-cr " color" This option specifies the color to use for text cursor. The default is to use the same foreground color that is used for text. .TP 8 .B \-cu This option indicates that \fIxterm\fP should work around a bug in the .IR curses (3x) cursor motion package that causes the .IR more (1) program to display lines that are exactly the width of the window and are followed by a line beginning with a tab to be displayed incorrectly (the leading tabs are not displayed). .TP 8 .B \+cu This option indicates that that \fIxterm\fP should not work around the .IR curses (3x) bug mentioned above. .TP 8 .BI \-e " program \[arguments \.\.\.\]" This option specifies the program (and its command line arguments) to be run in the \fIxterm\fP window. It also sets the window title and icon name to be the basename of the program being executed if neither \fI-T\fP nor \fI-n\fP are given on the command line. \fBThis must be the last option on the command line.\fP .TP 8 .BI \-fb " font" This option specifies a font to be used when displaying bold text. This font must be the same height and width as the normal font. If only one of the normal or bold fonts is specified, it will be used as the normal font and the bold font will be produced by overstriking this font. The default is to do overstriking of the normal font. .TP 8 .B \-j This option indicates that \fIxterm\fP should do jump scrolling. Normally, text is scrolled one line at a time; this option allows \fIxterm\fP to move multiple lines at a time so that it doesn't fall as far behind. Its use is strongly recommended since it make \fIxterm\fP much faster when scanning through large amounts of text. The VT100 escape sequences for enabling and disabling smooth scroll as well as the ``Modes'' menu can be used to turn this feature on or off. .TP 8 .B \+j This option indicates that \fIxterm\fP should not do jump scrolling. .TP 8 .B \-l This option indicates that \fIxterm\fP should send all terminal output to a log file as well as to the screen. This option can be enabled or disabled using the ``xterm X11'' menu. .TP 8 .B \+l This option indicates that \fIxterm\fP should not do logging. .TP 8 .BI \-lf " filename" This option specifies the name of the file to which the output log described above is written. If \fIfile\fP begins with a pipe symbol (|), the rest of the string is assumed to be a command to be used as the endpoint of a pipe. The default filename is ``\fBXtermLog.\fIXXXXX\fR'' (where \fIXXXXX\fP is the process id of \fIxterm\fP) and is created in the directory from which \fIxterm\fP was started (or the user's home directory in the case of a login window). .TP 8 .B \-ls This option indicates that the shell that is started in the \fIxterm\fP window be a login shell (i.e. the first character of argv[0] will be a dash, indicating to the shell that it should read the user's .login or .profile). .TP 8 .B \+ls This option indicates that the shell that is started should not be a login shell (i.e. it will be a normal ``subshell''). .TP 8 .B \-mb This option indicates that \fIxterm\fP should ring a margin bell when the user types near the right end of a line. This option can be turned on and off from the ``Modes'' menu. .TP 8 .B \+mb This option indicates that margin bell should not be rung. .TP 8 .BI \-ms " color" This option specifies the color to be used for the pointer cursor. The default is to use the foreground color. .TP 8 .BI \-nb " number" This option specifies the number of characters from the right end of a line at which the margin bell, if enabled, will ring. The default is 10. .TP 8 .B \-rw This option indicates that reverse-wraparound should be allowed. This allows the cursor to back up from the leftmost column of one line to the rightmost column of the previous line. This is very useful for editing long shell command lines and is encouraged. This option can be turned on and off from the ``Modes'' menu. .TP 8 .B \+rw This option indicates that reverse-wraparound should not be allowed. .TP 8 .B \-s This option indicates that \fIxterm\fP may scroll asynchronously, meaning that the screen does not have to be kept completely up to date while scrolling. This allows \fIxterm\fP to run faster when network latencies are very high and is typically useful when running across a very large internet or many gateways. .TP 8 .B \+s This option indicates that \fIxterm\fP should scroll synchronously. .TP 8 .B \-sb This option indicates that some number of lines that are scrolled off the top of the window should be saved and that a scrollbar should be displayed so that those lines can be viewed. This option may be turned on and off from the ``Modes'' menu. .TP 8 .B \+sb This option indicates that a scrollbar should not be displayed. .TP 8 .B \-sf This option indicates that Sun Function Key escape codes should be generated for function keys. .TP 8 .B \+sf This option indicates that the standard escape codes should be generated for function keys. .TP 8 .B \-si This option indicates that output to a window should not automatically reposition the screen to the bottom of the scrolling region. This option can be turned on and off from the ``Modes'' menu. .TP 8 .B \+si This option indicates that output to a window should cause it to scroll to the bottom. .TP 8 .B \-sk This option indicates that pressing a key while using the scrollbar to review previous lines of text should cause the window to be repositioned automatically in the normal postion at the bottom of the scroll region. .TP 8 .B \+sk This option indicates that pressing a key while using the scrollbar should not cause the window to be repositioned. .TP 8 .BI \-sl " number" This option specifies the number of lines to save that have been scrolled off the top of the screen. The default is 64. .TP 8 .B \-t This option indicates that \fIxterm\fP should start in Tektronix mode, rather than in VT102 mode. Switching between the two windows is done using the ``Modes'' menus. .TP 8 .B \+t This option indicates that \fIxterm\fP should start in VT102 mode. .TP 8 .BI \-tm " string" This option specifies a series of terminal setting keywords followed by the characters that should be bound to those functions, similar to the \fIstty\fP program. Allowable keywords include: intr, quit, erase, kill, eof, eol, swtch, start, stop, brk, susp, dsusp, rprnt, flush, weras, and lnext. Control characters may be specified as ^char (e.g. ^c or ^u) and ^? may be used to indicate delete. .TP 8 .BI \-tn " name" This option specifies the name of the terminal type to be set in the TERM environment variable. This terminal type must exist in the \fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries. .TP 8 .B \-ut This option indicates that \fIxterm\fP shouldn't write a record into the the system log file \fI/etc/utmp\fP. .TP 8 .B \+ut This option indicates that \fIxterm\fP should write a record into the system log file \fI/etc/utmp\fP. .TP 8 .B \-vb This option indicates that a visual bell is prefered over an audible one. Instead of ringing the terminal bell whenever a Control-G is received, the window will be flashed. .TP 8 .B \+vb This option indicates that a visual bell should not be used. .TP 8 .B \-wf This option indicates that \fIxterm\fP should wait for the window to be mapped the first time before starting the subprocess so that the initial terminal size settings and environment variables are correct. It the application's responsibility to catch subsequent terminal size changes. .TP 8 .B \+wf This option indicates that \fIxterm\fP show not wait before starting the subprocess. .TP 8 .B \-C This option indicates that this window should receive console output. This is not supported on all systems. .TP 8 .B \-S\fIccn\fP This option specifies the last two letters of the name of a pseudoterminal to use in slave mode. This allows \fIxterm\fP to be used as an input and output channel for an existing program and is sometimes used in specialized applications. .PP The following command line arguments are provided for compatibility with older versions. They may not be supported in the next release as the X Toolkit provides standard options that accomplish the same task. .TP 8 .B "%geom" This option specifies the prefered size and position of the Tektronix window. It is shorthand for specifying the "\fI*tekGeometry\fP" resource. .TP 8 .B \#geom This option specifies the prefered position of the icon window. It is shorthand for specifying the "\fI*iconGeometry\fP" resource. .TP 8 .BI \-T " string" This option specifies the title for \fIxterm\fP's windows. It is equivalent to \fB-title\fP. .TP 8 .BI \-n " string" This option specifies the icon name for \fIxterm\fP's windows. It is shorthand for specifying the "\fI*iconName\fP" resource. Note that this is not the same as the toolkit option \fB-name\fP (see below). The default icon name is the application name. .TP 8 .B \-r This option indicates that reverse video should be simulated by swapping the foreground and background colors. It is equivalent to \fB-reversevideo\fP or \fB-rv\fP. .TP 8 .BI \-w " number" This option specifies the width in pixels of the border surrounding the window. It is equivalent to \fB-borderwidth\fP or \fB-bw\fP. .PP The following standard X Toolkit command line arguments are commonly used with \fIxterm\fP: .TP 8 .B \-bg \fIcolor\fP This option specifies the color to use for the background of the window. The default is ``white.'' .TP 8 .B \-bd \fIcolor\fP This option specifies the color to use for the border of the window. The default is ``black.'' .TP 8 .B \-bw \fInumber\fP This option specifies the width in pixels of the border surrounding the window. .TP 8 .B \-fg \fIcolor\fP This option specifies the color to use for displaying text. The default is ``black''. .TP 8 .B \-fn \fIfont\fP This option specifies the font to be used for displaying normal text. The default is \fIfixed\fP. .TP 8 .B \-name \fIname\fP This option specifies the application name under which resources are to be obtained, rather than the default executable file name. \fIName\fP should not contain ``.'' or ``*'' characters. .TP 8 .B \-title \fIstring\fP This option specifies the window title string, which may be displayed by window managers if the user so chooses. The default title is the command line specified after the \fB-e\fP option, if any, otherwise the application name. .TP 8 .B \-rv This option indicates that reverse video should be simulated by swapping the foreground and background colors. .TP 8 .B \-geometry \fIgeometry\fP This option specifies the prefered size and position of the VT102 window; see \fIX(1)\fP. .TP 8 .B \-display \fIdisplay\fP This option specifies the X server to contact; see \fIX(1)\fP. .TP 8 .B \-xrm \fIresourcestring\fP This option specifies a resource string to be used. This is especially useful for setting resources that do not have separate command line options. .TP 8 .B \-iconic This option indicates that \fIxterm\fP should ask the window manager to start it as an icon rather than as the normal window. .SH "X DEFAULTS" The program understands all of the core X Toolkit resource names and classes as well as: .TP 8 .B "iconGeometry (\fPclass\fB IconGeometry)" Specifies the prefered size and position of the application when iconified. It is not necessarily obeyed by all window managers. .TP 8 .B "termName (\fPclass\fB TermName)" Specifies the terminal type name to be set in the TERM environment variable. .TP 8 .B "title (\fPclass\fB Title)" Specifies a string that may be used by the window manager when displaying this application. .TP 8 .B "ttyModes (\fPclass\fB TtyModes)" Specifies a string containing terminal setting keywords and the characters to which they may be bound. Allowable keywords include: intr, quit, erase, kill, eof, eol, swtch, start, stop, brk, susp, dsusp, rprnt, flush, weras, and lnext. Control characters may be specified as ^char (e.g. ^c or ^u) and ^? may be used to indicate delete. This is very useful for overriding the default terminal settings without having to do an \fIstty\fP every time an \fIxterm\fP is started. .TP 8 .B "utmpInhibit (\fPclass\fB UtmpInhibit)" Specifies whether or not \fIxterm\fP should try to record the user's terminal in \fI/etc/utmp\fP. .TP 8 .B "sunFunctionKeys (\fPclass\fB SunFunctionKeys)" Specifies whether or not Sun Function Key escape codes should be generated for function keys instead of standard escape sequences. .sp .PP The following resources are specified as part of the ``vt100'' widget (class ``VT100''): .TP 8 .B "allowSendEvents (\fPclass\fB AllowSendEvents)" Specifies whether or not synthetic key and button events (generated using the X protocol SendEvent request) should be interpreted or discarded. The default is ``false'' meaning they are discarded. Note that allowing such events creates a very large security hole. .sp .TP 8 .B "alwaysHighlight (\fPclass\fB AlwaysHighlight)" Specifies whether or not \fIxterm\fP should always display a highlighted text cursor. By default, a hollow text cursor is displayed whenever the pointer moves out of the window or the window loses the input focus. .TP 8 .B "font (\fPclass\fB Font)" Specifies the name of the normal font. The default is ``vtsingle.'' .TP 8 .B "boldFont (\fPclass\fB Font)" Specifies the name of the bold font to use instead of overstriking. .TP 8 .B "c132 (\fPclass\fB C132)" Specifies whether or not the VT102 DECCOLM escape sequence should be honored. The default is ``false.'' .TP 8 .B "charClass (\fPclass\fB CharClass)" Specifies comma-separated lists of character class bindings of the form \[\fIlow\fP-\]\fIhigh\fP:\fIvalue\fP. These are used in determining which sets of characters should be treated the same when doing cut and paste. See the section on specifying character classes. .TP 8 .B "curses (\fPclass\fB Curses)" Specifies whether or not the last column bug in .IR curses (3x) should be worked around. The default is ``false.'' .TP 8 .B "background (\fPclass\fB Background)" Specifies the color to use for the background of the window. The default is ``white.'' .TP 8 .B "foreground (\fPclass\fB Foreground)" Specifies the color to use for displaying text in the window. Setting the class name instead of the instance name is an easy way to have everything that would normally appear in the "text" color change color. The default is ``black.'' .TP 8 .B "cursorColor (\fPclass\fB Foreground)" Specifies the color to use for the text cursor. The default is ``black.'' .TP 8 .B "geometry (\fPclass\fB Geometry)" Specifies the prefered size and position of the VT102 window. .TP 8 .B "tekGeometry (\fPclass\fB Geometry)" Specifies the prefered size and position of the Tektronix window. .TP 8 .B "internalBorder (\fPclass\fB BorderWidth)" Specifies the number of pixels between the characters and the window border. The default is 2. .TP 8 .B "jumpScroll (\fPclass\fB JumpScroll)" Specifies whether or not jump scroll should be used. The default is ``false''. .TP 8 .B "logFile (\fPclass\fB Logfile)" Specifies the name of the file to which a terminal session is logged. The default is ``\fBXtermLog.\fIXXXXX\fR'' (where \fIXXXXX\fP is the process id of \fIxterm\fP). .TP 8 .B "logging (\fPclass\fB Logging)" Specifies whether or not a terminal session should be logged. The default is ``false.'' .TP 8 .B "logInhibit (\fPclass\fB LogInhibit)" Specifies whether or not terminal session logging should be inhibited. The default is ``false.'' .TP 8 .B "loginShell (\fPclass\fB LoginShell)" Specifies whether or not the shell to be run in the window should be started as a login shell. The default is ``false.'' .TP 8 .B "marginBell (\fPclass\fB MarginBell)" Specifies whether or not the bell should be run when the user types near the right margin. The default is ``false.'' .TP 8 .B "multiScroll (\fPclass\fB MultiScroll)" Specifies whether or not asynchronous scrolling is allowed. The default is ``false.'' .TP 8 .B "nMarginBell (\fPclass\fB Column)" Specifies the number of characters from the right margin at which the margin bell should be run, when enabled. .TP 8 .B "pointerColor (\fPclass\fB Foreground)" Specifies the color of the pointer. The default is ``black.'' .TP 8 .B "pointerShape (\fPclass\fB Cursor)" Specifies the name of the shape of the pointer. The default is ``xterm.'' .TP 8 .B "reverseVideo (\fPclass\fB ReverseVideo)" Specifies whether or not reverse video should be simulated. The default is ``false.'' .TP 8 .B "reverseWrap (\fPclass\fB ReverseWrap)" Specifies whether or not reverse-wraparound should be enabled. The default is ``false.'' .TP 8 .B "saveLines (\fPclass\fB SaveLines)" Specifies the number of lines to save beyond the top of the screen when a scrollbar is turned on. The default is 64. .TP 8 .B "scrollBar (\fPclass\fB ScrollBar)" Specifies whether or not the scrollbar should be displayed. The default is ``false.'' .TP 8 .B "scrollInput (\fPclass\fB ScrollCond)" Specifies whether or not output to the terminal should automatically cause the scrollbar to go to the bottom of the scrolling region. The default is ``true.'' .TP 8 .B "scrollKey (\fPclass\fB ScrollCond)" Specifies whether or not pressing a key should automatically cause the scrollbar to go to the bottom of the scrolling region. The default is ``false.'' .TP 8 .B "scrollLines (\fPclass\fB ScrollLines)" Specifies the number of lines that the \fIscroll-back\fP and \fIscroll-forw\fP actions should use as a default. The default value is 1. .TP 8 .B "signalInhibit (\fPclass\fB SignalInhibit)" Specifies whether or not the entries in the ``xterm X11'' menu for sending signals to \fIxterm\fP should be disallowed. The default is ``false.'' .TP 8 .B "tekInhibit (\fPclass\fB TekInhibit)" Specifies whether or not Tektronix mode should be disallowed. The default is ``false.'' .TP 8 .B "tekSmall (\fPclass\fB TekSmall)" Specifies whether or not the Tektronix mode window should start in its smallest size if no explicit geometry is given. This is useful when running \fIxterm\fP on displays with small screens. The default is ``false.'' .TP 8 .B "tekStartup (\fPclass\fB TekStartup)" Specifies whether or not \fIxterm\fP should start up in Tektronix mode. The default is ``false.'' .TP 8 .B "titeInhibit (\fPclass\fB TiteInhibit)" Specifies whether or not \fIxterm\fP should remove remove \fIti\fP or \fIte\fP termcap entries (used to switch between alternate screens on startup of many screen-oriented programs) from the TERMCAP string. .TP 8 .B "translations (\fPclass\fB Translations)" Specifies the key and button bindings for menus, selections, ``programmed strings'', etc. See \fBKEY/BUTTON BINDINGS\fP below. .TP 8 .B "visualBell (\fPclass\fB VisualBell)" Specifies whether or not a visible bell (i.e. flashing) should be used instead of an audible bell when Control-G is received. The default is ``false.'' .TP 8 .B "waitForMap (\fPclass\fB WaitForMap)" Specifies whether or not \fIxterm\fP should wait for the initial window map before starting the subprocess. The default is ``false.'' .sp .PP The following resources are specified as part of the ``tek4014'' widget (class ``Tek4014''): .TP 8 .B "width (\fPclass\fB Width)" Specifies the width of the Tektronix window in pixels. .TP 8 .B "height (\fPclass\fB Height)" Specifies the height of the Tektronix window in pixels. .sp .PP The following resources are specified as part of the ``menu'' widget: .TP 8 .B "menuBorder (\fPclass\fB MenuBorder)" Specifies the size in pixels of the border surrounding menus. The default is 2. .TP 8 .B "menuFont (\fPclass\fB Font)" Specifies the name of the font to use for displaying menu items. .TP 8 .B "menuPad (\fPclass\fB MenuPad)" Specifies the number of pixels between menu items and the menu border. The default is 3. .sp .PP The following resources are useful when specified for the Athena Scrollbar widget: .TP 8 .B "thickness (\fPclass\fB Thickness)" Specifies the width in pixels of the scrollbar. .TP 8 .B "background (\fPclass\fB Background)" Specifies the color to use for the background of the scrollbar. .TP 8 .B "foreground (\fPclass\fB Foreground)" Specifies the color to use for the foreground of the scrollbar. The ``thumb'' of the scrollbar is a simple checkerboard pattern alternating pixels for foreground and background color. .SH EMULATIONS The VT102 emulation is fairly complete, but does not support the blinking character attribute nor the double-wide and double-size character sets. .IR Termcap (5) entries that work with .I xterm include ``xterm'', ``vt102'', ``vt100'' and ``ansi'', and .I xterm automatically searches the termcap file in this order for these entries and then sets the ``TERM'' and the ``TERMCAP'' environment variables. .PP Many of the special .I xterm features (like logging) may be modified under program control through a set of escape sequences different from the standard VT102 escape sequences. (See the .I ``Xterm Control Sequences'' document.) .PP The Tektronix 4014 emulation is also fairly good. Four different font sizes and five different lines types are supported. The Tektronix text and graphics commands are recorded internally by .I xterm and may be written to a file by sending the COPY escape sequence (or through the .B Tektronix menu; see below). The name of the file will be ``\fBCOPY\fIyy\fB\-\fIMM\fB\-\fIdd\fB.\fIhh\fB:\fImm\fB:\fIss\fR'', where .IR yy , .IR MM , .IR dd , .IR hh , .I mm and .I ss are the year, month, day, hour, minute and second when the COPY was performed (the file is created in the directory .I xterm is started in, or the home directory for a login .IR xterm ). .SH "POINTER USAGE" .PP Once the VT102 window is created, .I xterm allows you to select text and copy it within the same or other windows. .PP The selection functions are invoked when the pointer buttons are used with no modifiers, and when they are used with the ``shift'' key. The assignment of the functions described below to keys and buttons may be changed through the resource database; see \fBKEY/BUTTON BINDINGS\fP below. .PP Pointer button one (usually left) is used to save text into the cut buffer. Move the cursor to beginning of the text, and then hold the button down while moving the cursor to the end of the region and releasing the button. The selected text is highlighted and is saved in the global cut buffer and made the PRIMARY selection when the button is released. Double-clicking selects by words. Triple-clicking selects by lines. Quadruple-clicking goes back to characters, etc. Multiple-click is determined by the time from button up to button down, so you can change the selection unit in the middle of a selection. If the key/button bindings specify that an X selection is to be made, \fIxterm\fP will leave the selected text highlighted for as long as it is the selection owner. .PP Pointer button two (usually middle) `types' (pastes) the text from the PRIMARY selection, if any, otherwise from the cut buffer, inserting it as keyboard input. .PP Pointer button three (usually right) extends the current selection. (Without loss of generality, that is you can swap ``right'' and ``left'' everywhere in the rest of this paragraph...) If pressed while closer to the right edge of the selection than the left, it extends/contracts the right edge of the selection. If you contract the selection past the left edge of the selection, .I xterm assumes you really meant the left edge, restores the original selection, then extends/contracts the left edge of the selection. Extension starts in the selection unit mode that the last selection or extension was performed in; you can multiple-click to cycle through them. .PP By cutting and pasting pieces of text without trailing new lines, you can take text from several places in different windows and form a command to the shell, for example, or take output from a program and insert it into your favorite editor. Since the cut buffer is globally shared among different applications, you should regard it as a `file' whose contents you know. The terminal emulator and other text programs should be treating it as if it were a text file, i.e. the text is delimited by new lines. .PP The scroll region displays the position and amount of text currently showing in the window (highlighted) relative to the amount of text actually saved. As more text is saved (up to the maximum), the size of the highlighted area decreases. .PP Clicking button one with the pointer in the scroll region moves the adjacent line to the top of the display window. .PP Clicking button three moves the top line of the display window down to the pointer position. .PP Clicking button two moves the display to a position in the saved text that corresponds to the pointer's position in the scrollbar. .PP .PP Unlike the VT102 window, the Tektronix window dows not allow the copying of text. It does allow Tektronix GIN mode, and in this mode the cursor will change from an arrow to a cross. Pressing any key will send that key and the current coordinate of the cross cursor. Pressing button one, two, or three will return the letters `l', `m', and `r', respectively. If the `shift' key is pressed when a pointer buton is pressed, the corresponding upper case letter is sent. To distinquish a pointer button from a key, the high bit of the character is set (but this is bit is normally stripped unless the terminal mode is RAW; see .IR tty (4) for details). .SH MENUS .PP .I Xterm has three different menus, named .BR xterm , .BR Modes , and .BR Tektronix. Each menu pops up under the correct combinations of key and button presses. Most menus are divided into two section, separated by a horizontal line. The top portion contains various modes that can be altered. A check mark appears next to a mode that is currently active. Selecting one of these modes toggles its state. The bottom portion of the menu are command entries; selecting one of these performs the indicated function. .PP The .B xterm menu pops up when the ``control'' key and pointer button one are pressed in a window. The modes section contains items that apply to both the VT102 and Tektronix windows. The .B Secure Keyboard mode should be used when typing in passwords or other sensitive data; see \fBSECURITY\fP below. Notable entries in the command section of the menu are the .BR Continue , .BR Suspend , .BR Interrupt , .BR Hangup , .B Terminate and .B Kill which sends the SIGCONT, SIGTSTP, SIGINT, SIGHUP, SIGTERM and SIGKILL signals, respectively, to the process group of the process running under .I xterm (usually the shell). The .B Continue function is especially useful if the user has accidentally typed CTRL-Z, suspending the process. .PP The .B Modes menu sets various modes in the VT102 emulation, and is popped up when the ``control'' key and pointer button two are pressed in the VT102 window. In the command section of this menu, the soft reset entry will reset scroll regions. This can be convenient when some program has left the scroll regions set incorrectly (often a problem when using VMS or TOPS-20). The full reset entry will clear the screen, reset tabs to every eight columns, and reset the terminal modes (such as wrap and smooth scroll) to their initial states just after .I xterm has finished processing the command line options. The .B Tektronix menu sets various modes in the Tektronix emulation, and is popped up when the ``control'' key and pointer button two are pressed in the Tektronix window. The current font size is checked in the modes section of the menu. The .B PAGE entry in the command section clears the Tektronix window. .SH SECURITY .PP X environments differ in their security conciousness. The servers provided by MIT use a host-based mechanism to control access to the server (see \fIxhost(1)\fP). If you enable access for a host, and other users are also permitted to run clients on that host, there is the possibility that someone will run an application that will attempt to use the basic services of the X protocol to snoop on your activities, and potentially capture a transcript of everything you type at the keyboard. This is of particular concern when you want to type in a password or other sensitive data. The best solution to this problem is for the industry to choose a standard authorization mechanism, with the necessary operating system support, and to incorporate this into the X protocol (which is already designed to handle such a mechanism). In the mean time, since passwords are most commonly typed to something running in an \fIxterm\fP window, a simple mechanism exists for protecting keyboard input in \fIxterm\fP. .PP The \fBxterm\fP menu (see \fBMENUS\fP above) contains a \fBSecure Keyboard\fP entry which, when enabled, ensures that all keyboard input is directed \fIonly\fP to \fIxterm\fP (using the GrabKeyboard protocol request). When an application prompts you for a password (or other sensitive data), you can enable \fBSecure Keyboard\fP using the menu, type in the data, and then disable \fBSecure Keyboard\fP using the menu again. Only one X client at a time can secure the keyboard, so when you attempt to enable \fBSecure Keyboard\fP it may fail. In this case, the bell will sound. If the \fBSecure Keyboard\fP succeeds, the foreground and background colors will be exchanged (as if you selected the \fBReverse Video\fP entry in the \fBModes\fP menu); they will be exchanged again when you exit secure mode. If the colors do \fInot\fP switch, then you should be \fIvery\fP suspicious that you are being spoofed. If the application you are running displays a prompt before asking for the password, it is safest to enter secure mode \fIbefore\fP the prompt gets displayed, and to make sure that the prompt gets displayed correctly (in the new colors), to minimize the probability of spoofing. You can also bring up the menu again and make sure that a check mark appears next to the entry. .PP \fBSecure Keyboard\fP mode will be disabled automatically if your xterm window becomes iconified (or otherwise unmapped), or if you start up a reparenting window manager (that places a title bar or other decoration around the window) while in \fBSecure Keyboard\fP mode. (This is a feature of the X protocol not easily overcome.) When this happens, the foreground and background colors will be switched back and the bell will sound in warning. .SH "CHARACTER CLASSES" Clicking the middle mouse button twice in rapid succession will cause all characters of the same class (e.g. letters, white space, punctuation) to be selected. Since different people have different preferences for what should be selected (for example, should filenames be selected as a whole or only the separate subnames), the default mapping can be overridden through the use of the \fIcharClass\fP (class \fICharClass\fP) resource. .PP This resource is simply a list of \fIrange\fP:\fIvalue\fP pairs where the range is either a single number or \fIlow\fP-\fIhigh\fP in the range of 0 to 127, corresponding to the ASCII code for the character or characters to be set. The \fIvalue\fP is arbitrary, although the default table uses the character number of the first character occurring in the set. .PP The default table is: .sp .in +10 .nf static int charClass[128] = { /* NUL SOH STX ETX EOT ENQ ACK BEL */ 32, 1, 1, 1, 1, 1, 1, 1, /* BS HT NL VT NP CR SO SI */ 1, 32, 1, 1, 1, 1, 1, 1, /* DLE DC1 DC2 DC3 DC4 NAK SYN ETB */ 1, 1, 1, 1, 1, 1, 1, 1, /* CAN EM SUB ESC FS GS RS US */ 1, 1, 1, 1, 1, 1, 1, 1, /* SP ! " # $ % & ' */ 32, 33, 34, 35, 36, 37, 38, 39, /* ( ) * + , - . / */ 40, 41, 42, 43, 44, 45, 46, 47, /* 0 1 2 3 4 5 6 7 */ 48, 48, 48, 48, 48, 48, 48, 48, /* 8 9 : ; < = > ? */ 48, 48, 58, 59, 60, 61, 62, 63, /* @ A B C D E F G */ 64, 48, 48, 48, 48, 48, 48, 48, /* H I J K L M N O */ 48, 48, 48, 48, 48, 48, 48, 48, /* P Q R S T U V W */ 48, 48, 48, 48, 48, 48, 48, 48, /* X Y Z [ \\ ] ^ _ */ 48, 48, 48, 91, 92, 93, 94, 48, /* ` a b c d e f g */ 96, 48, 48, 48, 48, 48, 48, 48, /* h i j k l m n o */ 48, 48, 48, 48, 48, 48, 48, 48, /* p q r s t u v w */ 48, 48, 48, 48, 48, 48, 48, 48, /* x y z { | } ~ DEL */ 48, 48, 48, 123, 124, 125, 126, 1}; .fi .sp .in -10 For example, the string ``33:48,37:48,45-47:48,64:48'' indicates that the exclamation mark, percent sign, dash, period, slash, and ampersand characters should be treated the same way as characters and numbers. This is very useful for cutting and pasting electronic mailing addresses and Unix filenames. .SH "KEY TRANSLATIONS" .PP It is possible to rebind keys (or sequences of keys) to arbitrary strings for input, by changing the translations for the vt100 or tek4014 widgets. Changing the translations for events other than key and button events is not expected, and will cause unpredictable behavior. .PP The actions available for key translations are: .TP 15 .B secure() Toggles the \fBSecure Keyboard\fP mode; see \fBSECURITY\fP. .TP 15 .B insert-seven-bit() Processes the key in the normal way; i.e. inserts the ISO Latin 1 character code corresponding to the keysym found in the keyboard mapping table into the input stream. .TP 15 .B insert-eight-bit() Processes the key the same as \fBinsert-seven-bit()\fP but forces the eighth bit to be set. .TP 15 .B string(\fIstring\fB) Rebinds the key or key sequence to the string value; that is, inserts the string argument into the input stream. Quotation is necessary if the string contains whitespace or non-alphanumeric characters. If the string argument begins with the characters ``0x'', it is interpreted as a hex character constant and the corresponding character is sent in the normal way. .TP 15 .B keymap(\fIname\fB) The \fBkeymap\fP action takes a single string argument naming a resource to be used to dynamically define a new translation table; the name of the resource is obtained by appending the string ``Keymap'' to \fIname\fP. The keymap name \fBNone\fP restores the original translation table (the very first one; a stack is not maintained). Upper/lower case is significant. .TP 15 .B insert-selection(\fIname\fP[,\fIname\fP]...\fB) Retrieves the value of the first (left-most) named selection that exists or cut buffer that is non-empty and inserts the value into the input stream. \fIName\fP is the name of any selection, for example, \fBPRIMARY\fP or \fBSECONDARY\fP, or the name of a cut buffer: \fBCUT_BUFFER0\fP, ..., \fBCUT_BUFFER7\fP. Upper/lower case is significant. .PP For example, a debugging session might benefit from the following bindings: .sp .in +4 .Ds .TA .5i .ta .5i *VT100.Translations: #override F13: keymap(dbx) *VT100.dbxKeymap.translations: \\ F14: keymap(None) \\n\\ F17: string("next") string(0x0d) \\n\\ F18: string("step") string(0x0d) \\n\\ F19: string("continue") string(0x0d) \\n\\ F20: string("print ") insert-selection(PRIMARY, CUT_BUFFER0) .De .sp .in -4 .SH KEY/BUTTON BINDINGS Within the VT100 widget the key and button bindings for selecting text, pasting text, and activating the menus are controlled by the translation bindings. In addition to the actions listed above under \fBKEY TRANSLATIONS\fP, the following actions are available: .TP 15 .B mode-menu() Posts one of the two mode menus, depending on which button is pressed. .TP 15 .B select-start() Unselects any previously selected text and begins selecting new text. .TP 15 .B select-extend() Continues selecting text from the previous starting position. .TP 15 .B start-extend() Begins extending the selection from the farthest (left or right) edge. .TP 15 .B select-end(\fIname\fP[,\fIname\fP]...\fB) Ends the text selection. \fIName\fP is the name of a selection, or the name of a cut buffer into which the text is to be copied. \fIXterm\fP will assert ownership of all the selections named and will copy the text into each of the cut buffers. Upper/lower case is significant. .TP 15 .B select-cursor-start() Like \fBselect-start\fP, but uses the text cursor position instead of the pointer position. .TP 15 .B start-cursor-extend() Like \fBstart-extend\fP, but uses the text cursor position instead of the pointer position. .TP 15 .B select-cursor-end(\fIname\fP[,\fIname\fP]...\fB) Like \fBselect-end\fP, but uses the text cursor position instead of the pointer position. .TP 15 .B ignore() Quietly discards the key or button event. .TP 15 .B bell(\fP[\fIvolume\fP]\fB) Rings the bell at the specified volume increment above/below the base volume. .TP 15 .B scroll-back(\fP[\fInumber\fP,[\fIunits\fP]]) Scrolls the window backwards the indicated number of units (\fIpages\fP, \fIhalfpages\fP, \fIlines\fP, or \fIpixels\fP). If \fIunits\fP are not specified, \fIlines\fP are assumed. If no \fInumber\fP is specified, the value of the \fIscrollLines\fP resource (which defaults to 1) is used. .TP 15 .B scroll-forw(\fP[\fInumber\fP,[\fIunits\fP]]) Scrolls the window forward. The arguments are the same as for \fIscroll-back\fP. .PP The default bindings are: .sp .in +4 .Ds .TA .5i 1i 2i .ta .5i 1i 2i Shift Prior: scroll-back(1,halfpage) \\n\\ Shift Next: scroll-forw(1,halfpage) \\n\\ Shift Select: select-start() \\n\\ Shift Insert: insert-selection(PRIMARY, CUT_BUFFER0) \\n\\ ~Meta : insert-seven-bit() \\n\\ Meta : mode-menu() \\n\\ ~Meta : select-start() \\n\\ ~Meta : select-extend() \\n\\ Ctrl ~Meta : mode-menu() \\n\\ ~Ctrl ~Meta : ignore() \\n\\ ~Ctrl ~Meta : insert-selection(PRIMARY, CUT_BUFFER0) \\n\\ ~Ctrl ~Meta : start-extend() \\n\\ ~Meta : select-extend() \\n\\ ~Ctrl ~Meta : select-end(PRIMARY, CUT_BUFFER0) \\n\\ : bell(0) .De .sp .in -4 .SH "OTHER FEATURES" .I Xterm automatically highlights the window border and text cursor when the pointer enters the window (selected) and unhighlights them when the pointer leaves the window (unselected). If the window is the focus window, then the window is highlighted no matter where the pointer is. .PP In VT102 mode, there are escape sequences to activate and deactivate an alternate screen buffer, which is the same size as the display area of the window. When activated, the current screen is saved and replace with the alternate screen. Saving of lines scrolled off the top of the window is disabled until the normal screen is restored. The .IR termcap (5) entry for .I xterm allows the visual editor .IR vi (1) to switch to the alternate screen for editing, and restore the screen on exit. .PP In either VT102 or Tektronix mode, there are escape sequences to change the name of the windows and to specify a new log file name. .SH ENVIRONMENT .I Xterm sets the environment variables ``TERM'' and ``TERMCAP'' properly for the size window you have created. It also uses and sets the environment variable ``DISPLAY'' to specify which bit map display terminal to use. The environment variable ``WINDOWID'' is set to the X window id number of the .I xterm window. .SH "SEE ALSO" resize(1), X(1), pty(4), tty(4) .br .I \fIXterm Control Sequences\fP .SH BUGS .PP The \fIXterm Control Sequences\fP document has yet to be converted from X10. .PP The class name is \fIXTerm\fP instead of \fIXterm\fP. .PP \fBXterm will hang forever if you try to paste too much text at one time.\fP It is both producer and consumer for the pty and can deadlock. .PP Variable-width fonts are not handled reasonably. .PP This program still needs to be rewritten. It should be split into very modular sections, with the various emulators being completely separate widgets that don't know about each other. Ideally, you'd like to be able to pick and choose emulator widgets and stick them into a single control widget. .PP The focus is considered lost if some other client (e.g., the window manager) grabs the pointer; it is difficult to do better without an addition to the protocol. .PP There needs to be a dialog box to allow entry of log file name and the COPY file name. .PP Many of the options are not resettable after .I xterm starts. .PP The Tek widget does not support key/button re-binding. .PP This manual page is too long. There should be a separate users manual defining all of the non-standard escape sequences. .PP All programs should be written to use X directly; then we could eliminate this program. .SH COPYRIGHT Copyright 1989, Massachusetts Institute of Technology. .br See \fIX(1)\fP for a full statement of rights and permissions. .SH AUTHORS Far too many people, including: .sp Loretta Guarino Reid (DEC-UEG-WSL), Joel McCormack (DEC-UEG-WSL), Terry Weissman (DEC-UEG-WSL), Edward Moy (Berkeley), Ralph R. Swick (MIT-Athena), Mark Vandevoorde (MIT-Athena), Bob McNamara (DEC-MAD), Jim Gettys (MIT-Athena), Bob Scheifler (MIT X Consortium), Doug Mink (SAO), Steve Pitschke (Stellar), Ron Newman (MIT-Athena), Jim Fulton (MIT X Consortium), Dave Serisky (HP)