XTERM(1x) COMMAND REFERENCE XTERM(1x) NAME xterm - X window system terminal emulator For 4310, 4320, and 4330 series UTek products only. SYNOPSIS xterm [ option ] ... DESCRIPTION The program xterm is the X window system terminal emulator that emulates a DEC VT102 terminal, providing a standard terminal type for programs not aware of the window system directly. Under UTek 2.3.1, UNIX 4.3BSD, Ultrix 1.2, and other systems with the capability, xterm supports the terminal resizing facilities built into the system. In addition, xterm provides a Tektronix graphics mode that emulates a Tektronix 4015 terminal in a separate (auxiliary) window, visible when Tek graphics mode is enabled. To maintain the correct aspect ratio (height/width), Tektronix graphics are restricted to the largest box with a 4015's aspect ratio that fits in the window; this box is located in the upper left area of the window. Both windows may be displayed at the same time, although only one window and mode is active at a time. Input is displayed in the active window even if the mouse is in the other window. Switching between the active modes is possible under manual (menu) and program (escape sequence) control. OPTIONS If the option begins with a plus sign ( + ) instead of a minus sign ( - ) the option is restored to its default value. These options override those set in the .Xdefaults file (see the X DEFAULTS section in this document). -132 Normally, the VT102 DECCOLM escape sequence that switches between 80 and 132 column mode is ignored. This option recognizes the DECCOLM escape sequence; xterm windows resize appropriately. -ai Enable miniature active icon. -ar Turn on the auto-raise mode of xterm, automatically raising the window when the mouse cursor enters the window. -b border Maintain an inner border (distance between characters and the window's border) of one pixel. The -b option Printed 5/19/88 1
XTERM(1x) COMMAND REFERENCE XTERM(1x) allows you to set the size of this border to border. -bd color On color displays, determine the color of the (highlighted) border. -bg color On color displays, determine the color of the window background. -bw borderwidth Specify the width of the window border in pixels. -cr color On color displays, determine the (highlighted) color of the text cursor; default is the text foreground color. -cu Several programs using the curses(3t) cursor motion package have some difficulties with VT102-compatible terminals. The bug fixed with this option occurs with more(1) on a file containing a line that is exactly the width of the window and which is followed by a line beginning with a tab. Normally, the leading tabs disappear, but this option causes them to display correctly. -dw When the xterm icon is deiconified, this option moves the mouse to the window center. -e command arguments The specified command is executed in the window, rather than starting a shell. The command and the optional arguments must appear last on the xterm command line. -fb font Use the specified font instead of the default bold font (vtbold). The specified font must be the same height and width as the normal font. If only one of the normal or bold fonts is specified, it is used as the normal font and the bold font is produced by overstriking this font. -fg color On color displays, determine the color of the text foreground. -fi font Specify the default font for the Printed 5/19/88 2
XTERM(1x) COMMAND REFERENCE XTERM(1x) miniature icon windows. The usual value for the icon font is nil2; see the -ai option. -fn font Use the specified font instead of the default font (vtsingle). Any fixed- width font may be used, but fixed-width fonts work best. -ft font Use the specified font in the title bar instead of the default font (vtsingle). -i At startup, display the icon rather than the normal window. -ib file The file, assumed to be in bitmap(1px) format, is read and the resulting bitmap is used in the icon when in VT102 mode. If only one bitmap file is specified, it is used for both modes. If both bitmap file names are null, no bitmap is used. -it file The file, assumed to be in bitmap(1px) format, is read and the resulting bitmap is used in the icon when in Tektronix 4015 mode. If only one bitmap file is specified, it is used for both modes. If both bitmap file names are null, no bitmap is used. -j Jump scroll when xterm falls behind scrolling the screen; it will move multiple lines up at once. The VT100 escape sequences for smooth scroll can be used to enable/disable this feature from a program, or the Mode menu can be used to set it interactively. -l Turn on logging; all input from the pseudo tty is appended to the logfile. -lf file Write the log to file, rather than the default XtermLog.XXXXX where XXXXX is the process id of xterm (the file is created in the directory where xterm is started, or the home directory for a login xterm). If file begins with a bar or pipe ( | ) the remainder of the string is assumed to be a command executed by the shell, and a pipe is opened to the process. Printed 5/19/88 3
XTERM(1x) COMMAND REFERENCE XTERM(1x) -ls Use the shell run under xterm as a login shell (the user's .login file is read and the initial directory is the home directory). -mb Turn on the right margin bell. -ms color On color displays, determine the color of the mouse cursor; default is the text cursor color. -n windowname Set the name of the window for use by a window manager. (This name is then displayed in the title bar.) -nb number Ring the right margin bell at number distance. (The default is 10 spaces from the [hard] right margin.) -po number Specify new page overlap. In page scroll mode, a page is defined as the number of lines in the scrolling region minus the page overlap; default is one. -ps Turn on page scroll mode. After a page of lines is displayed, xterm stops displaying any more lines and the text cursor disappears. Typing a carriage return scrolls one more line (the return is discarded). Pressing the space bar (or any other printable character) scrolls another page (the character is discarded). Typing a control character scrolls another page, but the control character is sent (e.g., the interrupt character). -r For non-color systems, display white characters on a black background, rather than the default black on white. For color systems, invert the background and foreground colors. (This becomes the normal video mode, which is reversed by turning on the reverse video mode using the -rv option.) -rv Reverse video. See the -r option. -rw Turn on reverse wraparound mode: the cursor wraps around from the leftmost column to the rightmost column of the previous line. (This is very useful in Printed 5/19/88 4
XTERM(1x) COMMAND REFERENCE XTERM(1x) the shell to allow erasure backwards across the previous line.) -s Do not scroll synchronously with the display. The xterm program no longer keeps the screen completely up to date while scrolling, but will run faster when network latencies are very high. (This is typically useful when using xterm across a very large internet or during many hops.) -sb Display the scroll bar during startup, saving lines scrolled off the top of the window. -si Disable repositioning on input. When using the scroll bar to review previous lines of text, the window is normally repositioned automatically at the bottom of the scroll region when input has arrived. -sk Automatically reposition the window at the bottom of the scroll region when a key is pressed. -sl number Save number of lines that were scrolled off the top of the window; default is 64 lines. -sn Set normal video (the status line is still enclosed in a box). -st Display status line upon startup. -t Set the initial xterm window to a Tektronix window, rather than the normal VT102 window. -tb Enable title bar display on startup. -ti Display normally in the icon; the window name is to the right of the bitmap. This option displays the text under the icon. -vb Turn on the visual bell mode, flashing the window on receipt of a control G (Ctrl G). =geometry Specify =widthxheight[+-xoff[+-yoff]] Printed 5/19/88 5
XTERM(1x) COMMAND REFERENCE XTERM(1x) for the VT1O2 window. See X(1x) for details of this specification. %geometry Give the geometry specification %widthxheight[+-xoff[+-yoff]] for the Tektronix window. #geometry Give the geometry specification #[+- xoff[+-yoff]] for the icon position (the width and height information are optional and are otherwise ignored). host:display Specify the host name and display number. The host specifies which machine to create the window on, and the display argument specifies the display number. For example, orpheus:1 creates a shell window on display one on the machine orpheus. X DEFAULTS You can preset defaults in the customization file .Xdefaults in your home directory. The format of the file is programname.keyword:string For example: xterm.AutoRaise:on If the program name is missing, the default keyword is set to the value for all programs. You must include a colon after the keyword, otherwise the command will not execute. (See X(1x) for more details on keywords and strings.) Case is not significant in keywords and white space before the string is ignored. Any global defaults must precede program defaults in the file. Options referenced by each keyword are listed as the last part in the keyword description; the keywords have no meaning if the corresponding options are not set. Keywords recognized by xterm are listed here. ActiveIcon If off, xterm window icons are static bitmaps rather than miniature windows. (Option -ai.) AllowIconInput If on, keyboard input is permitted when xterm windows are in their iconified state and the icon is a miniature window. Keyboard input Printed 5/19/88 6
XTERM(1x) COMMAND REFERENCE XTERM(1x) is always disabled when static bitmap icons are used. (Option -ai.) AutoRaise If on, xterm windows are automatically raised when the mouse enters them. (Option -ar.) Background Set background color. (Option -bg.) BodyFont Set default font. (Option -fn.) BoldFont Specify a default bold font. (Option -fb.) Border Set border color. (Option -bd.) BorderWidth Set border width of the window. (Option -bw.) C132 If on, allow the DECCOLM escape sequence to switch between 80 and 132 column mode. (Option -132.) Curses If on, enable the curses(3t) fix. (Option -cu.) Cursor Set text cursor color. (Option -cr.) DeiconifyWarp If on, move (warp) the mouse to the center of the window after deiconification. Option -dw.) Foreground Set text color. (Option -fg.) IconBitmap Specify the bitmap(1px) file used as the bitmap for the ANSI mode icon. (Option -ib.) IconFont Specify the default font for miniature window icons. The usual value is nil2. (Option -fi.) IconStartup If on, initially display the icon rather than the normal window. (Option -i.) InternalBorder Set the space between the text and window border. This is called padding above. (Option -b.) Printed 5/19/88 7
XTERM(1x) COMMAND REFERENCE XTERM(1x) JumpScroll If on, jump scroll is enabled. (Option -j.) LogFile Specifies the log file or command to pipe to when logging is activated. (Option -lf.) Logging If on, turn logging on initially. (Option -l.) LogInhibit If on, inhibit logging program. LoginShell If on, execute the shell as a login shell. (Option -ls.) MarginBell If on, turn on the margin bell. (Option -mb.) MenuBorder Specify the border width for the menus. The default is 2. (Option -bw.) MenuPad Specify the extra padding above and below the menu title. The default is 3. MenuFont Specify the font used within the menus. The default is the same font used for the title bar. Mouse Set the mouse cursor color. (Option -ms.) NMarginBell Set the right margin bell to ring at distance. (Option -nb.) PageOverlap Set page overlap in page scroll mode. (Option -po.) PageScroll Turn on page scroll mode. (Option -ps.) ReverseVideo Reverse the definition of foreground and background color. (Option -r.) ReverseWrap Turn on reverse wraparound mode. (Option -rw.) SaveLines Save lines when scrolled off the top of the window. (Option -sl.) Printed 5/19/88 8
XTERM(1x) COMMAND REFERENCE XTERM(1x) ScrollBar Show the scroll bar initially. (Option -sb.) ScrollInput Disable (turn off) repositioning the scroll region at the bottom if new input has arrived. (Option -si.) ScrollKey Reposition the scroll region at the bottom if a key is pressed. (Option -sk.) SignalInhibit Inhibit the sending of signals from the xterm menu. StatusLine Show the status line on startup. (Option -st.) StatusNormal Make the status line normal video. (Option -st.) TekIconBitmap Specifies the bitmap(1px) file as the bitmap for the Tektronix mode icon. (Option -it.) TekInhibit Inhibit going into Tektronix mode. TextUnderIcon Place the icon text under the bitmap icon. (Option -ti.) TitleBar Don't show (turn off) the title bar on startup. (Option -tb.) TitleFont Set the font of the title bar text. (Option -ft.) VisualBell If on, turn on visual bell mode at startup. (Option -vb.) EMULATIONS The VT102 emulation is fairly complete, but does not support the blinking character attribute nor the double-wide and double-size character sets; termcap(5) entries that work with xterm include xterms, xterm, vt102, vt100 and ansi; xterm automatically searches the termcap file in this order for these entries and then sets the TERM and the TERMCAP environment variables. NOTE: The ansi mode references of xterm are the same as the ansi modes of tterm(1x); use the xterm ansi modes listed here for both xterm and tterm emulations. Printed 5/19/88 9
XTERM(1x) COMMAND REFERENCE XTERM(1x) Many of the special xterm features (like the scroll bar and logging) may be modified under program control through a set of escape sequences different from the standard VT102 escape sequences. Also, many of the Sun tty escape sequences for resizing and moving the window are also understood. (See the Xterm Control Sequences section in the X Window System Reference manual.) The Tektronix 4015 emulation offers four different font sizes and five different line types. The Tektronix text and graphics commands are recorded internally by xterm and may be written to a file by sending the COPY escape sequence (or through the Tektronix menu, discussed later). The name of the file is COPYyy-MM-dd.hh:mm:ss where yy, MM, dd, hh, mm, and ss are the year, month, day, hour, minute and second when the COPY was performed (the file is created in the directory where xterm was started, or the home directory for a login xterm). MOUSE USAGE Creating a VT102 Window: When using the mouse to create the VT102 window, a cursor and a rubber banding box outline the area on the display where the window will be created. If the left mouse button is pressed, a HEIGHT x WIDTH (default 24 x 80) size window is created at the position where the button is released. If the right mouse button is pressed, a window the HEIGHT of the display and WIDTH (default 80) characters wide is created. If the center mouse button is pressed and held down, the upper left hand corner of the window is defined at this position. An outline of the minimum size window is shown, and a popup window in the upper left hand corner of the display shows the size in characters of the window. Moving the mouse (while still holding the button down) enlarges the window; the sizes in the pop up window update accordingly. Releasing the button defines the lower right hand corner of the window. Saving and Restoring Text: Once the VT102 window is created, xterm allows you to save and restore text within the same or other windows. The button functions are enabled when holding down the Shift key. The left mouse button takes the text from the cursor (at button release) through the end of the line (including the new line), saves it in the global cut buffer, and immediately retypes the line, inserting it as keyboard input; this provides a history mechanism. The selected text is highlighted while the button is pressed. Moving off the initial line cancels the selection. If there is no text beyond the initial cursor point, xterm sounds the bell, indicating an error. Cutting and Pasting Text: The shifted center mouse button is used to save text into the cut buffer. Move the cursor Printed 5/19/88 10
XTERM(1x) COMMAND REFERENCE XTERM(1x) to the beginning of the text, then hold the button down while moving the cursor to the end of the region, and release the button. The selected text is highlighted and is saved in the global cut buffer when the button is released. The shifted right mouse button types (pastes) the text from the cut buffer, inserting it as keyboard input. 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. (The cut buffer is globally shared among different applications.) The terminal emulator and other text programs should treat the cut buffer as if it were a text file, i.e. the text is delimited by new lines. Scroll Bar: The scroll bar is comprised of three parts: the scroll direction icon at the top, the recorder icon in the middle, and the scroll region at the bottom. Pressing the middle mouse button in any part of the scroll region displays the scroll bar menu; see the MENUS section in this document. The scroll region displays the position and amount of text currently 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. Clicking the mouse with the left or right button in the scroll region positions the top of the display window at the mouse position. The recorder icon represents the state of saving lines scrolled off the top of the window. The icon of a tape running reel to reel indicates on, while the icon of a tape hanging indicates off. Clicking the left or right mouse buttons in the recorder icon toggles the state of recording. The scroll direction icon moves the window up and down within the saved text. The left mouse button moves the window position up (the text scrolls downward), while the right mouse button moves the window position down (the text scrolls upward). The amount of scrolling is modified by the Shift and control ( Ctrl ) keys. If you don't use the Shift or Ctrl keys the window scrolls a single line at a time. Holding the left or right mouse button down continuously scrolls the text a line at a time. The Shift key scrolls text a window-full at a time (actually it is one line less than a full window). The Ctrl key positions the text at the extremes, top or bottom. Printed 5/19/88 11
XTERM(1x) COMMAND REFERENCE XTERM(1x) Creating a Tektronix 4015 Window: When using the mouse to create the Tektronix window, a cursor and a rubber banding box outline where the window will be created on the display. If the left mouse button is pressed, a default size window (750 pixels wide by 565 pixel high) is created at the origin. If the right mouse button is pressed, a default size window is created at the mouse position. If the center mouse button is pressed and held down, the upper left hand corner of the window is defined at this position. An outline of the minimum size window is shown, and a pop up window in the upper left hand corner of the display appears, indicating Tektronix mode. Moving the mouse (while still holding the button down) enlarges the window. Releasing the button defines the lower right hand corner of the window. Unlike the VT102 window, the Tektronix window does not allow the copying of text. It does allow Tektronix GIN (graphics input) mode, and in this mode the cursor changes from an arrow to a cross. Pressing any key sends that key and the current coordinate of the cross cursor. Pressing the left, middle or right mouse button returns the letters l, m, and r, respectively. If the Shift key is pressed when a mouse button is pressed, the corresponding uppercase letter is sent. To distinguish a mouse button from a key, the high bit of the character is set (but this bit is normally stripped unless the terminal mode is RAW; see tty(4) for details). MENUS The terminal emulator xterm has five different menus: xterm, Modes, Tektronix, Scrollbar, and Windows. Each menu pops up under the correct combinations of key and button presses. Most menus are divided into two sections, separated by a horizontal line. The top portion contains various alterable modes. 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 shows command entries; selecting one of these entries performs the indicated function. xterm Menu: The xterm menu pops up when the Ctrl key and the left mouse button are pressed in a window. The menu title gives the version number of xterm. The top portion (modes section) of the xterm menu contains items that apply to both the VT102 and Tektronix 4015 windows. Entries in the bottom portion (command section) of the xterm menu are Continue, Suspend, Interrupt, Hangup, Terminate, and Kill which send the SIGCONT, SIGTSTP, SIGINT, SIGHUP, SIGTERM and SIGKILL signals, respectively, to the process group of the process running under xterm (usually the shell). The Continue Printed 5/19/88 12
XTERM(1x) COMMAND REFERENCE XTERM(1x) function is especially useful if you accidentally typed control Z (Ctrl Z), suspending a process. Modes Menu: The Modes menu sets various modes in the VT102 emulation, and it is popped up with the Ctrl and middle mouse button combination in the VT102 window. In the command section of this menu, the Soft Reset entry resets 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 clears the screen, resets tabs to every eight columns, and resets the terminal modes (such as Wrap and Smooth Scroll) to their initial states just after xterm has finished processing the command line options. The following menu items are available in the Modes menu. Jump Scroll toggles the Jump Scroll attribute for the ansi window Reverse Video toggles the Reverse Video attribute for the ansi window Auto Wraparound toggles the Auto Wraparound attribute for the ansi window Reverse Wraparound toggles the Reverse Wraparound attribute for the ansi window Application Cursors toggles the Application Cursors attribute for the ansi window Application Pad toggles the Application Pad attribute for both the tek and ansi windows Scroll Bar toggles the Scroll Bar attribute for the ansi window Page Scroll toggles the Page Scroll attributes for the ansi window[ Status Line toggles the Status Line attribute for the ansi window Reverse Status Line toggles the Reverse Status Line attribute for the ansi window 80 <-> 132 Column this option is ignored Printed 5/19/88 13
XTERM(1x) COMMAND REFERENCE XTERM(1x) Cursor Emulation toggles the Cursor Emulation attribute for the ansi window 4107 Setup Mode enters Setup mode; works for both the ansi and tek windows Alternate Screen this option is ignored The following entries are available in the command portion of the Modes menu. Soft Reset processed only if in ansi mode Full Reset processed only if in ansi mode Toggle tek/ansi Mode toggles between tek and ansi modes Hide VT window this option is ignored Tektronix Menu: The Tektronix menu sets various modes in the Tektronix emulation, and it is popped up with the Ctrl and middle mouse button combination in the Tektronix window. The Tektronix menu includes these modes: Large Characters current font size is checked in the modes section of the menu #2 Size Characters #3 Size Characters Small Characters VT Window Showing In the command portion of the Tektronix menu these commands are available: PAGE clears the tek window RESET COPY Select VT Mode Hide Tek Windows Printed 5/19/88 14
XTERM(1x) COMMAND REFERENCE XTERM(1x) Note: The computer aided drafting program TekniCAD can be invoked either in the tek window or in the ansi window, however, TekniCAD always switches to the tek window. Key F3 erases the display. Scrollbar Menu: The Scrollbar menu is popped up when the middle mouse button is pressed within the scroll bar region. This menu allows several settable modes particular to the scroll bar. Windows Menu: The Windows menu is not normally compiled into xterm as it duplicates functions that properly belong to window managers. It may, however, be enabled at the discretion of your system manager. If enabled, the Windows menu is a special menu that is popped up when the Ctrl key and right mouse button are pressed. Listed in order of bottommost to topmost are the visible windows on the display that are named. The checked entry is the current window. By selecting an entry, the corresponding window is raised to the top. This is very useful when a particular window of interest is obscured by many other windows. OTHER FEATURES The terminal emulator xterm automatically highlights the window border, text cursor, and title bar when the mouse enters the window (selected) and stops highlighting the items when the mouse leaves the window (not selected). If the window is the focus window, the window is highlighted no matter where the mouse is located. The title bar displays the name of the window in the center; stripes appear on both sides when the window is selected (highlighted). If two windows are showing, only the active window's title bar is highlighted. If the left, middle or right mouse button is pressed in the striped section of the title bar, the corresponding menu is popped up, without the need to hold down the Ctrl key. Pressing the mouse button in the center title of the title bar automatically iconifies the window. Pressing a mouse button in the icon deiconifies it, returning the window to its former state. In addition, if input occurs while xterm is iconified and the icon is a static bitmap, a box is drawn around the icon title. 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 Printed 5/19/88 15
XTERM(1x) COMMAND REFERENCE XTERM(1x) current screen is saved and replaced with the alternate screen. Saving of lines scrolled off the top of the window and Page Scroll mode are disabled until the normal screen is restored. The termcap(5) entry for xterm allows the visual editor vi(1) to switch to the alternate screen for editing, and restores the screen upon exit. In either VT102 or Tektronix 4015 mode, there are escape sequences to change the title in the title bar (which also changes the name of the windows and icons); also available are escape sequences to specify a new log file name. By default, a miniature version of the VT102 or Tektronix 4015 window is displayed when xterm is iconified. The choice of which miniature to display is made when the full window(s) are iconified; if the Tek window is chosen in the iconify operation, the icon is a miniature Tek window; if the VT102 window is chosen, the icon is a miniature VT102 window. This choice is independent of the current mode (Tektronix/VT102). As an option, the miniature window may be disabled and a bitmap of a small VT102 window with title bar and scroll bar can be displayed in the icon when in VT102 mode, and a bitmap of a Tektronix window with title bar is displayed in Tektronix mode. These bitmaps may be user-defined (see OPTIONS in this document). ENVIRONMENT Properly setting the environment variables TERM and TERMCAP for the size window you have created, xterm also uses and sets the environment variable DISPLAY to specify which bitmap display terminal to use. The environment variable WINDOWID is set to the X window id number of the xterm window. CAVEATS When the mouse cursor enters an xterm window while another window is the keyboard focus, the xterm window is highlighted; the xterm window highlighting cannot be turned off in this state. SEE ALSO resize(1px), X(1x), pty(4), tterm(1x), tty(4). See the section Xterm Control Sequences in the X Window System Reference manual. Printed 5/19/88 16
%%index%% na:288,151; sy:439,166; de:605,1389; op:1994,1434;3788,2980;7128,3237;10725,3122;14207,2811;17378,2960;20698,4026;25084,3966;29410,4260;34030,4128;38518,2804;41682,3668;45710,3898;49968,3569;53897,3117;57374,2182; ca:59556,437; se:59993,369; %%index%%000000000275