XTERM(1) USER COMMANDS XTERM(1) NAME xterm - terminal emulator for X SYNOPSIS xterm [-_t_o_o_l_k_i_t_o_p_t_i_o_n ...] [-option ...] DESCRIPTION The _x_t_e_r_m 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 ter- minal resizing capabilities (for example, the SIGWINCH sig- nal in systems derived from 4.3bsd), _x_t_e_r_m will use the facilities to notify programs running in the window whenever it is resized. 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 res- tricted 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. 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 when- ever the pointer is in either window. The active window can be chosen through escape sequences, the ``Modes'' menu in the VT102 window, and the ``Tektronix'' menu in the 4014 window. OPTIONS The _x_t_e_r_m terminal emulator accepts all of the standard X Toolkit command line options as well as the following (if the option begins with a `+' instead of a `-', the option is restored to its default value): -help This causes _x_t_e_r_m to print out a verbose message describing its options. -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 _x_t_e_r_m window will resize appropriately. -ah This option indicates that _x_t_e_r_m should always highlight the text cursor and borders. By default, _x_t_e_r_m will display a hollow text cursor whenever the focus is lost or the pointer leaves the window. X Version 11 Last change: Release 4 1 XTERM(1) USER COMMANDS XTERM(1) +ah This option indicates that _x_t_e_r_m should do text cur- sor highlighting. -b _n_u_m_b_e_r This option specifies the size of the inner border (the distance between the outer edge of the charac- ters and the window border) in pixels. The default is 2. -cc _c_h_a_r_a_c_t_e_r_c_l_a_s_s_r_a_n_g_e:_v_a_l_u_e[,...] This sets classes indicated by the given ranges for using in selecting by words. See the section speci- fying character classes. -cn This option indicates that newlines should not be cut in line-mode selections. +cn This option indicates that newlines should be cut in line-mode selections. -cr _c_o_l_o_r This option specifies the color to use for text cur- sor. The default is to use the same foreground color that is used for text. -cu This option indicates that _x_t_e_r_m should work around a bug in the _c_u_r_s_e_s(3x) cursor motion package that causes the _m_o_r_e(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). +cu This option indicates that that _x_t_e_r_m should not work around the _c_u_r_s_e_s(3x) bug mentioned above. -e _p_r_o_g_r_a_m [_a_r_g_u_m_e_n_t_s ...] This option specifies the program (and its command line arguments) to be run in the _x_t_e_r_m window. It also sets the window title and icon name to be the basename of the program being executed if neither -_T nor -_n are given on the command line. This must be the last option on the command line. -fb _f_o_n_t 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. X Version 11 Last change: Release 4 2 XTERM(1) USER COMMANDS XTERM(1) -j This option indicates that _x_t_e_r_m should do jump scrolling. Normally, text is scrolled one line at a time; this option allows _x_t_e_r_m to move multiple lines at a time so that it doesn't fall as far behind. Its use is strongly recommended since it make _x_t_e_r_m 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. +j This option indicates that _x_t_e_r_m should not do jump scrolling. -l This option indicates that _x_t_e_r_m 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. +l This option indicates that _x_t_e_r_m should not do log- ging. -lf _f_i_l_e_n_a_m_e This option specifies the name of the file to which the output log described above is written. If _f_i_l_e 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 ``XtermLog._X_X_X_X_X'' (where _X_X_X_X_X is the process id of _x_t_e_r_m) and is created in the directory from which _x_t_e_r_m was started (or the user's home directory in the case of a login window). -ls This option indicates that the shell that is started in the _x_t_e_r_m 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). +ls This option indicates that the shell that is started should not be a login shell (i.e. it will be a nor- mal ``subshell''). -mb This option indicates that _x_t_e_r_m should ring a mar- gin bell when the user types near the right end of a line. This option can be turned on and off from the ``Modes'' menu. +mb This option indicates that margin bell should not be rung. -mc milliseconds X Version 11 Last change: Release 4 3 XTERM(1) USER COMMANDS XTERM(1) This option specifies the maximum time between multi-click selections. -ms _c_o_l_o_r This option specifies the color to be used for the pointer cursor. The default is to use the fore- ground color. -nb _n_u_m_b_e_r 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. -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. +rw This option indicates that reverse-wraparound should not be allowed. -s This option indicates that _x_t_e_r_m may scroll asyn- chronously, meaning that the screen does not have to be kept completely up to date while scrolling. This allows _x_t_e_r_m to run faster when network latencies are very high and is typically useful when running across a very large internet or many gateways. +s This option indicates that _x_t_e_r_m should scroll syn- chronously. -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. +sb This option indicates that a scrollbar should not be displayed. -sf This option indicates that Sun Function Key escape codes should be generated for function keys. +sf This option indicates that the standard escape codes should be generated for function keys. -si This option indicates that output to a window should not automatically reposition the screen to the bot- tom of the scrolling region. This option can be X Version 11 Last change: Release 4 4 XTERM(1) USER COMMANDS XTERM(1) turned on and off from the ``Modes'' menu. +si This option indicates that output to a window should cause it to scroll to the bottom. -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 automati- cally in the normal position at the bottom of the scroll region. +sk This option indicates that pressing a key while using the scrollbar should not cause the window to be repositioned. -sl _n_u_m_b_e_r This option specifies the number of lines to save that have been scrolled off the top of the screen. The default is 64. -t This option indicates that _x_t_e_r_m should start in Tektronix mode, rather than in VT102 mode. Switch- ing between the two windows is done using the ``Modes'' menus. +t This option indicates that _x_t_e_r_m should start in VT102 mode. -tm _s_t_r_i_n_g This option specifies a series of terminal setting keywords followed by the characters that should be bound to those functions, similar to the _s_t_t_y pro- gram. Allowable keywords include: intr, quit, erase, kill, eof, eol, swtch, start, stop, brk, susp, dsusp, rprnt, flush, weras, and lnext. Con- trol characters may be specified as ^char (e.g. ^c or ^u) and ^? may be used to indicate delete. -tn _n_a_m_e This option specifies the name of the terminal type to be set in the TERM environment variable. This terminal type must exist in the _t_e_r_m_c_a_p(_5) database and should have _l_i# and _c_o# entries. -ut This option indicates that _x_t_e_r_m shouldn't write a record into the the system log file /_e_t_c/_u_t_m_p. +ut This option indicates that _x_t_e_r_m should write a record into the system log file /_e_t_c/_u_t_m_p. -vb This option indicates that a visual bell is pre- ferred over an audible one. Instead of ringing the X Version 11 Last change: Release 4 5 XTERM(1) USER COMMANDS XTERM(1) terminal bell whenever a Control-G is received, the window will be flashed. +vb This option indicates that a visual bell should not be used. -wf This option indicates that _x_t_e_r_m 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. +wf This option indicates that _x_t_e_r_m show not wait before starting the subprocess. -C This option indicates that this window should receive console output. This is not supported on all systems. -S_c_c_n This option specifies the last two letters of the name of a pseudoterminal to use in slave mode, plus the number of the inherited file descriptor. The option is parsed "%c%c%d". This allows _x_t_e_r_m to be used as an input and output channel for an existing program and is sometimes used in specialized appli- cations. The following command line arguments are provided for compa- tibility with older versions. They may not be supported in the next release as the X Toolkit provides standard options that accomplish the same task. %_g_e_o_m This option specifies the preferred size and posi- tion of the Tektronix window. It is shorthand for specifying the "*_t_e_k_G_e_o_m_e_t_r_y" resource. #_g_e_o_m This option specifies the preferred position of the icon window. It is shorthand for specifying the "*_i_c_o_n_G_e_o_m_e_t_r_y" resource. -T _s_t_r_i_n_g This option specifies the title for _x_t_e_r_m's windows. It is equivalent to -title. -n _s_t_r_i_n_g This option specifies the icon name for _x_t_e_r_m's win- dows. It is shorthand for specifying the "*_i_c_o_n_- _N_a_m_e" resource. Note that this is not the same as the toolkit option -name (see below). The default icon name is the application name. X Version 11 Last change: Release 4 6 XTERM(1) USER COMMANDS XTERM(1) -r This option indicates that reverse video should be simulated by swapping the foreground and background colors. It is equivalent to -reversevideo or -rv. -w _n_u_m_b_e_r This option specifies the width in pixels of the border surrounding the window. It is equivalent to -borderwidth or -bw. The following standard X Toolkit command line arguments are commonly used with _x_t_e_r_m: -bg _c_o_l_o_r This option specifies the color to use for the back- ground of the window. The default is ``white.'' -bd _c_o_l_o_r This option specifies the color to use for the border of the window. The default is ``black.'' -bw _n_u_m_b_e_r This option specifies the width in pixels of the border surrounding the window. -fg _c_o_l_o_r This option specifies the color to use for display- ing text. The default is ``black''. -fn _f_o_n_t This option specifies the font to be used for displaying normal text. The default is _f_i_x_e_d. -name _n_a_m_e This option specifies the application name under which resources are to be obtained, rather than the default executable file name. _N_a_m_e should not con- tain ``.'' or ``*'' characters. -title _s_t_r_i_n_g 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 -e option, if any, otherwise the application name. -rv This option indicates that reverse video should be simulated by swapping the foreground and background colors. -geometry _g_e_o_m_e_t_r_y This option specifies the preferred size and posi- tion of the VT102 window; see _X(_1). X Version 11 Last change: Release 4 7 XTERM(1) USER COMMANDS XTERM(1) -display _d_i_s_p_l_a_y This option specifies the X server to contact; see _X(_1). -xrm _r_e_s_o_u_r_c_e_s_t_r_i_n_g This option specifies a resource string to be used. This is especially useful for setting resources that do not have separate command line options. -iconic This option indicates that _x_t_e_r_m should ask the win- dow manager to start it as an icon rather than as the normal window. RESOURCES The program understands all of the core X Toolkit resource names and classes as well as: iconGeometry (class IconGeometry) Specifies the preferred size and position of the application when iconified. It is not necessarily obeyed by all window managers. termName (class TermName) Specifies the terminal type name to be set in the TERM environment variable. title (class Title) Specifies a string that may be used by the window manager when displaying this application. ttyModes (class TtyModes) Specifies a string containing terminal setting key- words 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 _s_t_t_y every time an _x_t_e_r_m is started. utmpInhibit (class UtmpInhibit) Specifies whether or not _x_t_e_r_m should try to record the user's terminal in /_e_t_c/_u_t_m_p. sunFunctionKeys (class SunFunctionKeys) Specifies whether or not Sun Function Key escape codes should be generated for function keys instead of standard escape sequences. X Version 11 Last change: Release 4 8 XTERM(1) USER COMMANDS XTERM(1) The following resources are specified as part of the _v_t_1_0_0 widget (class _V_T_1_0_0): allowSendEvents (class 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. alwaysHighlight (class AlwaysHighlight) Specifies whether or not _x_t_e_r_m 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. boldFont (class Font) Specifies the name of the bold font to use instead of overstriking. c132 (class C132) Specifies whether or not the VT102 DECCOLM escape sequence should be honored. The default is ``false.'' charClass (class CharClass) Specifies comma-separated lists of character class bindings of the form [_l_o_w-]_h_i_g_h:_v_a_l_u_e. 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. curses (class Curses) Specifies whether or not the last column bug in _c_u_r_s_e_s(3x) should be worked around. The default is ``false.'' background (class Background) Specifies the color to use for the background of the window. The default is ``white.'' foreground (class 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.'' cursorColor (class Foreground) X Version 11 Last change: Release 4 9 XTERM(1) USER COMMANDS XTERM(1) Specifies the color to use for the text cursor. The default is ``black.'' eightBitInput (class EightBitInput) Specifies whether or not eight-bit characters should be accepted. The default is ``true.'' font (class Font) Specifies the name of the normal font. The default is ``vtsingle.'' font1 (class Font1) Specifies the name of the first alternate font. font2 (class Font2) Specifies the name of the second alternate font. font3 (class Font3) Specifies the name of the third alternate font. font4 (class Font4) Specifies the name of the fourth alternate font. geometry (class Geometry) Specifies the preferred size and position of the VT102 window. internalBorder (class BorderWidth) Specifies the number of pixels between the charac- ters and the window border. The default is 2. jumpScroll (class JumpScroll) Specifies whether or not jump scroll should be used. The default is ``true''. logFile (class Logfile) Specifies the name of the file to which a terminal session is logged. The default is ``XtermLog._X_X_X_X_X'' (where _X_X_X_X_X is the process id of _x_t_e_r_m). logging (class Logging) Specifies whether or not a terminal session should be logged. The default is ``false.'' logInhibit (class LogInhibit) Specifies whether or not terminal session logging should be inhibited. The default is ``false.'' loginShell (class LoginShell) Specifies whether or not the shell to be run in the window should be started as a login shell. The X Version 11 Last change: Release 4 10 XTERM(1) USER COMMANDS XTERM(1) default is ``false.'' marginBell (class MarginBell) Specifies whether or not the bell should be run when the user types near the right margin. The default is ``false.'' multiScroll (class MultiScroll) Specifies whether or not asynchronous scrolling is allowed. The default is ``false.'' multiClickTime (class MultiClickTime) Specifies the maximum time in milliseconds between multi-clock select events. The default is 250 mil- liseconds. multiScroll (class MultiScroll) Specifies whether or not scrolling should be done asynchronously. The default is ``false.'' nMarginBell (class Column) Specifies the number of characters from the right margin at which the margin bell should be run, when enabled. pointerColor (class Foreground) Specifies the foreground color of the pointer. The default is ``XtDefaultForeground.'' pointerColorBackground (class Background) Specifies the background color of the pointer. The default is ``XtDefaultBackground.'' pointerShape (class Cursor) Specifies the name of the shape of the pointer. The default is ``xterm.'' reverseVideo (class ReverseVideo) Specifies whether or not reverse video should be simulated. The default is ``false.'' reverseWrap (class ReverseWrap) Specifies whether or not reverse-wraparound should be enabled. The default is ``false.'' saveLines (class SaveLines) Specifies the number of lines to save beyond the top of the screen when a scrollbar is turned on. The default is 64. scrollBar (class ScrollBar) Specifies whether or not the scrollbar should be X Version 11 Last change: Release 4 11 XTERM(1) USER COMMANDS XTERM(1) displayed. The default is ``false.'' scrollInput (class 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.'' scrollKey (class ScrollCond) Specifies whether or not pressing a key should automatically cause the scrollbar to go to the bot- tom of the scrolling region. The default is ``false.'' scrollLines (class ScrollLines) Specifies the number of lines that the _s_c_r_o_l_l-_b_a_c_k and _s_c_r_o_l_l-_f_o_r_w actions should use as a default. The default value is 1. signalInhibit (class SignalInhibit) Specifies whether or not the entries in the ``xterm X11'' menu for sending signals to _x_t_e_r_m should be disallowed. The default is ``false.'' tekGeometry (class Geometry) Specifies the preferred size and position of the Tektronix window. tekInhibit (class TekInhibit) Specifies whether or not Tektronix mode should be disallowed. The default is ``false.'' tekSmall (class 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 _x_t_e_r_m on displays with small screens. The default is ``false.'' tekStartup (class TekStartup) Specifies whether or not _x_t_e_r_m should start up in Tektronix mode. The default is ``false.'' titeInhibit (class TiteInhibit) Specifies whether or not _x_t_e_r_m should remove remove _t_i or _t_e termcap entries (used to switch between alternate screens on startup of many screen-oriented programs) from the TERMCAP string. translations (class Translations) Specifies the key and button bindings for menus, selections, ``programmed strings'', etc. See X Version 11 Last change: Release 4 12 XTERM(1) USER COMMANDS XTERM(1) ACTIONS below. visualBell (class VisualBell) Specifies whether or not a visible bell (i.e. flash- ing) should be used instead of an audible bell when Control-G is received. The default is ``false.'' waitForMap (class WaitForMap) Specifies whether or not _x_t_e_r_m should wait for the initial window map before starting the subprocess. The default is ``false.'' The following resources are specified as part of the _t_e_k_4_0_1_4 widget (class _T_e_k_4_0_1_4): width (class Width) Specifies the width of the Tektronix window in pix- els. height (class Height) Specifies the height of the Tektronix window in pix- els. fontLarge (class Font) Specifies the large font to use in the Tektronix window. font2 (class Font) Specifies font number 2 to use in the Tektronix win- dow. font3 (class Font) Specifies font number 2 font to use in the Tektronix window. fontSmall (class Font) Specifies the small font to use in the Tektronix window. The resources that may be specified for the various menus are described in the documentation for the Athena SimpleMenu widget. The name and classes of the entries in each of the menus are listed below. The _m_a_i_n_M_e_n_u has the following entries: securekbd (class SmeBSB) This entry invokes the secure() action. allowsends (class SmeBSB) X Version 11 Last change: Release 4 13 XTERM(1) USER COMMANDS XTERM(1) This entry invokes the allow-send-events(toggle) action. logging (class SmeBSB) This entry invokes the set-logging(toggle) action. redraw (class SmeBSB) This entry invokes the redraw() action. line1 (class SmeLine) This is a separator. suspend (class SmeBSB) This entry invokes the send-signal(suspend) action on systems that support job control. continue (class SmeBSB) This entry invokes the send-signal(cont) action on systems that support job control. interrupt (class SmeBSB) This entry invokes the send-signal(int) action. hangup (class SmeBSB) This entry invokes the send-signal(hup) action. terminate (class SmeBSB) This entry invokes the send-signal(term) action. kill (class SmeBSB) This entry invokes the send-signal(kill) action. line2 (class SmeLine) This is a separator. quit (class SmeBSB) This entry invokes the quit() action. The _v_t_M_e_n_u has the following entries: scrollbar (class SmeBSB) This entry invokes the set-scrollbar(toggle) action. jumpscroll (class SmeBSB) This entry invokes the set-jumpscroll(toggle) action. reversevideo (class SmeBSB) This entry invokes the set-reverse-video(toggle) action. X Version 11 Last change: Release 4 14 XTERM(1) USER COMMANDS XTERM(1) autowrap (class SmeBSB) This entry invokes the set-autowrap(toggle) action. reversewrap (class SmeBSB) This entry invokes the set-reversewrap(toggle) action. autolinefeed (class SmeBSB) This entry invokes the set-autolinefeed(toggle) action. appcursor (class SmeBSB) This entry invokes the set-appcursor(toggle) action. appkeypad (class SmeBSB) This entry invokes the set-appkeypad(toggle) action. scrollkey (class SmeBSB) This entry invokes the set-scroll-on-key(toggle) action. scrollttyoutput (class SmeBSB) This entry invokes the set-scroll-on-tty- output(toggle) action. allow132 (class SmeBSB) This entry invokes the set-allow132(toggle) action. cursesemul (class SmeBSB) This entry invokes the set-cursesemul(toggle) action. visualbell (class SmeBSB) This entry invokes the set-visualbell(toggle) action. marginbell (class SmeBSB) This entry invokes the set-marginbell(toggle) action. altscreen (class SmeBSB) This entry is currently disabled. line1 (class SmeLine) This is a separator. softreset (class SmeBSB) This entry invokes the soft-reset() action. hardreset (class SmeBSB) This entry invokes the hard-reset() action. X Version 11 Last change: Release 4 15 XTERM(1) USER COMMANDS XTERM(1) line2 (class SmeLine) This is a separator. tekshow (class SmeBSB) This entry invokes the set-visibility(tek,toggle) action. tekmode (class SmeBSB) This entry invokes the set-terminal-type(tek) action. vthide (class SmeBSB) This entry invokes the set-visibility(vt,off) action. The _f_o_n_t_M_e_n_u has the following entries: fontdefault (class SmeBSB) This entry invokes the set-vt-font(d) action. font1 (class SmeBSB) This entry invokes the set-vt-font(1) action. font2 (class SmeBSB) This entry invokes the set-vt-font(2) action. font3 (class SmeBSB) This entry invokes the set-vt-font(3) action. font4 (class SmeBSB) This entry invokes the set-vt-font(4) action. fontescape (class SmeBSB) This entry invokes the set-vt-font(e) action. fontsel (class SmeBSB) This entry invokes the set-vt-font(s) action. The _t_e_k_M_e_n_u has the following entries: tektextlarge (class SmeBSB) This entry invokes the set-tek-text(l) action. tektext2 (class SmeBSB) This entry invokes the set-tek-text(2) action. tektext3 (class SmeBSB) This entry invokes the set-tek-text(3) action. tektextsmall (class SmeBSB) X Version 11 Last change: Release 4 16 XTERM(1) USER COMMANDS XTERM(1) This entry invokes the set-tek-text(s) action. line1 (class SmeLine) This is a separator. tekpage (class SmeBSB) This entry invokes the tek-page() action. tekreset (class SmeBSB) This entry invokes the tek-reset() action. tekcopy (class SmeBSB) This entry invokes the tek-copy() action. line2 (class SmeLine) This is a separator. vtshow (class SmeBSB) This entry invokes the set-visibility(vt,toggle) action. vtmode (class SmeBSB) This entry invokes the set-terminal-type(vt) action. tekhide (class SmeBSB) This entry invokes the set-visibility(tek,toggle) action. The following resources are useful when specified for the Athena Scrollbar widget: thickness (class Thickness) Specifies the width in pixels of the scrollbar. background (class Background) Specifies the color to use for the background of the scrollbar. foreground (class Foreground) Specifies the color to use for the foreground of the scrollbar. The ``thumb'' of the scrollbar is a sim- ple checkerboard pattern alternating pixels for foreground and background color. EMULATIONS The VT102 emulation is fairly complete, but does not support the blinking character attribute nor the double-wide and double-size character sets. _T_e_r_m_c_a_p(5) entries that work with _x_t_e_r_m include ``xterm'', ``vt102'', ``vt100'' and ``ansi'', and _x_t_e_r_m automatically searches the termcap file in this order for these entries and then sets the ``TERM'' X Version 11 Last change: Release 4 17 XTERM(1) USER COMMANDS XTERM(1) and the ``TERMCAP'' environment variables. Many of the special _x_t_e_r_m features (like logging) may be modified under program control through a set of escape sequences different from the standard VT102 escape sequences. (See the ``_X_t_e_r_m _C_o_n_t_r_o_l _S_e_q_u_e_n_c_e_s'' document.) The Tektronix 4014 emulation is also fairly good. Four dif- ferent font sizes and five different lines types are sup- ported. The Tektronix text and graphics commands are recorded internally by _x_t_e_r_m and may be written to a file by sending the COPY escape sequence (or through the Tektronix menu; see below). The name of the file will be ``COPY_y_y-_M_M-_d_d._h_h:_m_m:_s_s'', where _y_y, _M_M, _d_d, _h_h, _m_m and _s_s are the year, month, day, hour, minute and second when the COPY was performed (the file is created in the directory _x_t_e_r_m is started in, or the home directory for a login _x_t_e_r_m). macro-string(_m_a_c_r_o-_s_t_r_i_n_g) Rebinds the key or key sequence to the macro-string value. When this action is executed, the macro string is processed, which normally inserts a string into the input stream. This capability is useful for emulating the wide variety of character sequences that are produced by a button press on various terminals. For more details, see the section "MACRO STRINGS" below. Once the VT102 window is created, _x_t_e_r_m allows you to select text and copy it within the same or other windows. 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 ACTIONS below. 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, _x_t_e_r_m will leave the selected text highlighted for as long as it is the selection owner. 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. X Version 11 Last change: Release 4 18 XTERM(1) USER COMMANDS XTERM(1) 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, _x_t_e_r_m 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. 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 dif- ferent 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. 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. Clicking button one with the pointer in the scroll region moves the adjacent line to the top of the display window. Clicking button three moves the top line of the display win- dow down to the pointer position. Clicking button two moves the display to a position in the saved text that corresponds to the pointer's position in the scrollbar. 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', respec- tively. If the `shift' key is pressed when a pointer button is pressed, the corresponding upper case letter is sent. To distinguish 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 _t_t_y(4) for details). X Version 11 Last change: Release 4 19 XTERM(1) USER COMMANDS XTERM(1) MENUS _X_t_e_r_m has four menus, named _m_a_i_n_M_e_n_u, _v_t_M_e_n_u, _f_o_n_t_M_e_n_u, and _t_e_k_M_e_n_u. 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 per- forms the indicated function. The xterm menu pops up when the ``control'' key and pointer button one are pressed in a window. The _m_a_i_n_M_e_n_u contains items that apply to both the VT102 and Tektronix windows. The Secure Keyboard mode is be used when typing in passwords or other sensitive data in an unsecure environment; see SECURITY below. Notable entries in the command section of the menu are the Continue, Suspend, Interrupt, Hangup, Ter- minate and Kill which sends the SIGCONT, SIGTSTP, SIGINT, SIGHUP, SIGTERM and SIGKILL signals, respectively, to the process group of the process running under _x_t_e_r_m (usually the shell). The Continue function is especially useful if the user has accidentally typed CTRL-Z, suspending the pro- cess. The _v_t_M_e_n_u 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 _x_t_e_r_m has finished processing the command line options. The _f_o_n_t_M_e_n_u sets the font used in the VT102 window. The _t_e_k_M_e_n_u 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 PAGE entry in the command section clears the Tektronix window. SECURITY X environments differ in their security consciousness. MIT servers, run under _x_d_m, are capable of using a ``magic cookie'' authorization scheme that can provide a reasonable level of security for many people. If your server is only using a host-based mechanism to control access to the server (see _x_h_o_s_t(_1)), then if you enable access for a host and X Version 11 Last change: Release 4 20 XTERM(1) USER COMMANDS XTERM(1) other users are also permitted to run clients on that same host, there is every possibility that someone can run an application that will use the basic services of the X proto- col to snoop on your activities, potentially capturing 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 to use a better authorization mechanism that host-based con- trol, but a simple mechanism exists for protecting keyboard input in _x_t_e_r_m. The xterm menu (see MENUS above) contains a Secure Keyboard entry which, when enabled, ensures that all keyboard input is directed _o_n_l_y to _x_t_e_r_m (using the GrabKeyboard protocol request). When an application prompts you for a password (or other sensitive data), you can enable Secure Keyboard using the menu, type in the data, and then disable Secure Keyboard using the menu again. Only one X client at a time can secure the keyboard, so when you attempt to enable Secure Keyboard it may fail. In this case, the bell will sound. If the Secure Keyboard succeeds, the foreground and background colors will be exchanged (as if you selected the Reverse Video entry in the Modes menu); they will be exchanged again when you exit secure mode. If the colors do _n_o_t switch, then you should be _v_e_r_y 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 _b_e_f_o_r_e 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. Secure Keyboard 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 Secure Keyboard 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. 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 _c_h_a_r_C_l_a_s_s (class _C_h_a_r_C_l_a_s_s) resource. X Version 11 Last change: Release 4 21 XTERM(1) USER COMMANDS XTERM(1) This resource is simply a list of _r_a_n_g_e:_v_a_l_u_e pairs where the range is either a single number or _l_o_w-_h_i_g_h in the range of 0 to 127, corresponding to the ASCII code for the charac- ter or characters to be set. The _v_a_l_u_e is arbitrary, although the default table uses the character number of the first character occurring in the set. The default table is: 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}; For example, the string ``33:48,37:48,45-47:48,64:48'' indi- cates 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 cut- ting and pasting electronic mailing addresses and filenames. ACTIONS It is possible to rebind keys (or sequences of keys) to arbitrary strings for input, by changing the translations X Version 11 Last change: Release 4 22 XTERM(1) USER COMMANDS XTERM(1) 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. The following actions are provided for using within the _v_t_1_0_0 or _t_e_k_4_0_1_4 translations resources: bell([_p_e_r_c_e_n_t]) This action rings the keyboard bell at the specified percentage above or below the base volume. ignore() This action ignores the event but checks for special pointer position escape sequences. insert() This action is a synonym for insert-seven-bit() insert-seven-bit() This action inserts the 7-bit USASCII character or string associated with the keysym that was pressed. insert-eight-bit() This action inserts the 8-bit ISO Latin-1 character or string associated with the keysym that was pressed. insert-selection(_s_o_u_r_c_e_n_a_m_e [, ...]) This action inserts the string found in the selec- tion or cutbuffer indicated by _s_o_u_r_c_e_n_a_m_e. Sources are checked in the order given (case is significant) until one is found. Commonly-used selections include: _P_R_I_M_A_R_Y, _S_E_C_O_N_D_A_R_Y, and _C_L_I_P_B_O_A_R_D. Cut buffers are typically named _C_U_T__B_U_F_F_E_R_0 through _C_U_T__B_U_F_F_E_R_7. keymap(_n_a_m_e) This action dynamically defines a new translation table whose resource name is _n_a_m_e with the suffix _K_e_y_m_a_p (case is significant). The name _N_o_n_e restores the original translation table. popup-menu(_m_e_n_u_n_a_m_e) This action displays the specified popup menu. Valid names (case is significant) include: _m_a_i_n_- _M_e_n_u, _v_t_M_e_n_u, _f_o_n_t_M_e_n_u, and _t_e_k_M_e_n_u. secure() This action toggles the _S_e_c_u_r_e _K_e_y_b_o_a_r_d mode described in the section named SECURITY, and is invoked from the securekbd entry in _m_a_i_n_M_e_n_u. select-start() X Version 11 Last change: Release 4 23 XTERM(1) USER COMMANDS XTERM(1) This action begins text selection at the current pointer location. See the section on POINTER USAGE for information on making selections. select-extend() This action tracks the pointer and extends the selection. It should only be bound to Motion events. select-end(_d_e_s_t_n_a_m_e [, ...]) This action puts the currently selected text into all of the selections or cutbuffers specified by _d_e_s_t_n_a_m_e. select-cursor-start() This action is similar to select-start except that it begins the selection at the current text cursor position. select-cursor-end(_d_e_s_t_n_a_m_e [, ...]) This action is similar to select-end except that it should be used with select-cursor-start. set-vt-font(_d/_1/_2/_3/_4/_e/_s [,_n_o_r_m_a_l_f_o_n_t [, _b_o_l_d_f_o_n_t]]) This action sets the font or fonts currently being used in the VT102 window. The first argument is a single character that specifies the font to be used: _d or _D indicate the default font (the font initially used when _x_t_e_r_m was started), _1 through _4 indicate the fonts specified by the _f_o_n_t_1 through _f_o_n_t_4 resources, _e or _E indicate the normal and bold fonts that may be set through escape codes (or specified as the second and third action arguments, respec- tively), and _i or _I indicate the font selection (as made by programs such as _x_f_o_n_t_s_e_l(_1)) indicated by the second action argument. start-extend() This action is similar to select-start except that the selection is extended to the current pointer location. start-cursor-extend() This action is similar to select-extend except that the selection is extended to the current text cursor position. string(_s_t_r_i_n_g) This action inserts the specified text string as if it had been typed. Quotation is necessary if the string contains whitespace or non-alphanumeric char- acters. If the string argument begins with the X Version 11 Last change: Release 4 24 XTERM(1) USER COMMANDS XTERM(1) characters ``0x'', it is interpreted as a hex char- acter constant. scroll-back(_c_o_u_n_t [,_u_n_i_t_s]) This action scrolls the text window backward so that text that had previously scrolled off the top of the screen is now visible. The _c_o_u_n_t argument indicates the number of _u_n_i_t_s (which may be _p_a_g_e, _h_a_l_f_p_a_g_e, _p_i_x_e_l, or _l_i_n_e) by which to scroll. scroll-forw(_c_o_u_n_t [,_u_n_i_t_s]) This action scrolls is similar to scroll-back except that it scrolls the other direction. allow-send-events(_o_n/_o_f_f/_t_o_g_g_l_e) This action set or toggles the allowSendEvents resource and is also invoked by the allowsends entry in _m_a_i_n_M_e_n_u. set-logging(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles the logging resource and is also invoked by the logging entry in _m_a_i_n_M_e_n_u. redraw() This action redraws the window and is also invoked by the _r_e_d_r_a_w entry in _m_a_i_n_M_e_n_u. send-signal(_s_i_g_n_a_m_e) This action sends the signal named by _s_i_g_n_a_m_e (which may also be a number) to the _x_t_e_r_m subprocess (the shell or program specified with the -_e command line option) and is also invoked by the suspend, con- tinue, interrupt, hangup, terminate, and _k_i_l_l entries in _m_a_i_n_M_e_n_u. Allowable signal names are (case is not significant): _s_u_s_p_e_n_d, _t_s_t_p (if sup- ported by the operating system), _c_o_n_t (if supported by the operating system), _i_n_t, _h_u_p, _t_e_r_m, and _k_i_l_l. quit() This action sends a SIGHUP to the subprogram and exits. It is also invoked by the quit entry in _m_a_i_n_M_e_n_u. set-scrollbar(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles the scrollbar resource and is also invoked by the scrollbar entry in _v_t_M_e_n_u. set-jumpscroll(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles the jumpscroll resource and is also invoked by the jumpscroll entry in _v_t_M_e_n_u. set-reverse-video(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles the _r_e_v_e_r_s_e_V_i_d_e_o resource and is X Version 11 Last change: Release 4 25 XTERM(1) USER COMMANDS XTERM(1) also invoked by the reversevideo entry in _v_t_M_e_n_u. set-autowrap(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles automatic wrapping of long lines and is also invoked by the autowrap entry in _v_t_M_e_n_u. set-reversewrap(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles the reverseWrap resource and is also invoked by the reversewrap entry in _v_t_M_e_n_u. set-autolinefeed(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles automatic insertion of linefeeds and is also invoked by the autolinefeed entry in _v_t_M_e_n_u. set-appcursor(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles the handling Application Cursor Key mode and is also invoked by the Bappcursor entry in _v_t_M_e_n_u. set-appkeypad(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles the handling of Application Keypad mode and is also invoked by the appkeypad entry in _v_t_M_e_n_u. set-scroll-on-key(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles the scrollKey resource and is also invoked from the scrollkey entry in _v_t_M_e_n_u. set-scroll-on-tty-output(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles the scrollTtyOutput resource and is also invoked from the scrollttyoutput entry in _v_t_M_e_n_u. set-allow132(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles the c132 resource and is also invoked from the allow132 entry in _v_t_M_e_n_u. set-cursesemul(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles the curses resource and is also invoked from the cursesemul entry in _v_t_M_e_n_u. set-visual-bell(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles the visualBell resource and is also invoked by the visualbell entry in _v_t_M_e_n_u. set-marginbell(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles the marginBell resource and is also invoked from the marginbell entry in _v_t_M_e_n_u. set-altscreen(_o_n/_o_f_f/_t_o_g_g_l_e) This action toggles between the alternative and X Version 11 Last change: Release 4 26 XTERM(1) USER COMMANDS XTERM(1) current screens. soft-reset() This action resets the scrolling region and is also invoked from the softreset entry in _v_t_M_e_n_u. hard-reset() This action resets the scrolling region, tabs, win- dow size, and cursor keys and clears the screen. It is also invoked from the hardreset entry in _v_t_M_e_n_u. set-terminal-type(_t_y_p_e) This action directs output to either the _v_t or _t_e_k windows, according to the _t_y_p_e string. It is also invoked by the tekmode entry in _v_t_M_e_n_u and the vtmode entry in _t_e_k_M_e_n_u. set-visibility(_v_t/_t_e_k,_o_n/_o_f_f/_t_o_g_g_l_e) This action controls whether or not the _v_t or _t_e_k windows are visible. It is also invoked from the tekshow and vthide entries in _v_t_M_e_n_u and the vtshow and tekhide entries in _t_e_k_M_e_n_u. set-tek-text(_l_a_r_g_e/_2/_3/_s_m_a_l_l) This action sets font used in the Tektronix window to the value of the resources tektextlarge, tek- text2, tektext3, and tektextsmall according to the argument. It is also by the entries of the same names as the resources in _t_e_k_M_e_n_u. tek-page() This action clears the Tektronix window and is also invoked by the tekpage entry in _t_e_k_M_e_n_u. tek-reset() This action resets the Tektronix window and is also invoked by the _t_e_k_r_e_s_e_t entry in _t_e_k_M_e_n_u. tek-copy() This action copies the escape codes used to generate the current window contents to a file in the current directory beginning with the name COPY. It is also invoked from the _t_e_k_c_o_p_y entry in _t_e_k_M_e_n_u. The Tektronix window also has the following action: gin-press(_l/_L/_m/_M/_r/_R) This action send the indicated graphics input code. The default bindings in the VT102 window are: Shift Prior: scroll-back(1,halfpage) \n\ X Version 11 Last change: Release 4 27 XTERM(1) USER COMMANDS XTERM(1) Shift Next: scroll-forw(1,halfpage) \n\ Shift Select: select-cursor-start() \ select-cursor-end(PRIMARY, CUT_BUFFER0) \n\ Shift Insert: insert-selection(PRIMARY, CUT_BUFFER0) \n\ ~Meta: insert-seven-bit() \n\ Meta: insert-eight-bit() \n\ Ctrl ~Meta: popup-menu(mainMenu) \n\ ~Meta : select-start() \n\ ~Meta : select-extend() \n\ Ctrl ~Meta : popup-menu(vtMenu) \n\ ~Ctrl ~Meta : ignore() \n\ ~Ctrl ~Meta : insert-selection(PRIMARY, CUT_BUFFER0) \n\ Ctrl ~Meta : popup-menu(fontMenu) \n\ ~Ctrl ~Meta : start-extend() \n\ ~Meta : select-extend() \n\ ~Ctrl ~Meta : select-end(PRIMARY, CUT_BUFFER0) \n\ : bell(0) The default bindings in the Tektronix window are: ~Meta: insert-seven-bit() \n\ Meta: insert-eight-bit()\n\ Ctrl ~Meta: popup-menu(mainMenu) \n\ Ctrl ~Meta : popup-menu(tekMenu) \n\ Shift ~Meta: gin-press(L) \n\ ~Meta: gin-press(l) \n\ Shift ~Meta: gin-press(M) \n\ ~Meta: gin-press(m) \n\ Shift ~Meta: gin-press(R) \n\ ~Meta: gin-press(r) Below is a sample how of the keymap() action is used to add special keys for entering commonly-typed works: *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) MACRO STRINGS Xterm includes a fairly general macro-string processing capability intended to allow emulation of the button-press sequences of just about any terminal type. The macro-string processor is a simple stack machine which interprets a macro string. The macro string can contain commands which access state information (such as the X and Y location of the X Version 11 Last change: Release 4 28 XTERM(1) USER COMMANDS XTERM(1) mouse), manipulate the stack (such as doing arithmetic operations), and insert text into the terminal input buffer (which is the desired end result of the macro string). There are rudimentary programming commands (conditional exe- cution, subroutine calls), built-in primitives and macro strings, and user-definable macro strings. A macro string is interpreted one token at a time. Opera- tions are expressed in RPN, i.e. operands first (which are placed onto the stack) followed by operation (which operates on the stack). White space in a macro string is ignored. If there is an error in processing a macro string, the Bell() function is called. There are two data types: integer and string. Boolean operations result in an integer where FALSE is represented by 0 and TRUE is represented by 1. When interpreting an integer as a Boolean, 0 is considered FALSE and anything else is considered TRUE. When interpreting a string as a Boolean, NULL or the empty string is considered FALSE and anything else is considered TRUE. In the descriptions below, the term TOS represents the value of the top item on the stack, TOS-1 is the next-to-top, etc. The macro-string commands are as follows: 'string' Single-quoted string. Pushes the quoted string onto the stack. The string can con- tain any character except NULL and single quote. There is no backslash notation and no provision for including a single quote within a single-quoted string. You can use a double-quoted string if you need to include a single quote in your string. Note also that the various parsers used to load this string (i.e. the C compiler if it is a built-in macro string, or the resource manager if it is from a resource or default file) can han- dle backslash notation, so you can include control characters in a quoted string. "string" Double-quoted string. Pushes the quoted string onto the stack. This behaves in exactly the same way as a single-quoted string, except that when using a double- quoted string you can include single quotes in the string but not double quotes. printf formatting You can convert TOS to a string using stan- dard printf formatting commands. For X Version 11 Last change: Release 4 29 XTERM(1) USER COMMANDS XTERM(1) example, if TOS is the integer 123, then the command "%04d" would replace TOS with the string "0123", and the command "%X" would replace TOS with the string "7B". The for- matting string is only a single "%" sequence, and only converts the top item on the stack to a string. + Add or catenate. If TOS and TOS-1 are both integers, replaces TOS and TOS-1 with (TOS-1 + TOS). If TOS and TOS-1 are both strings, replaces TOS and TOS-1 with the catenation of TOS-1 and TOS. - Subtract. Replaces TOS and TOS-1 with (TOS-1 - TOS). TOS and TOS-1 must both be integers. * Multiply. Replaces TOS and TOS-1 with (TOS-1 * TOS). TOS and TOS-1 must both be integers. / Integer divide. Replaces TOS and TOS-1 with (TOS-1 / TOS). TOS and TOS-1 must both be integers. << Left shift. Replaces TOS and TOS-1 with (TOS-1 << TOS). TOS and TOS-1 must both be integers. >> Right shift. Replaces TOS and TOS-1 with (TOS-1 >> TOS). TOS and TOS-1 must both be integers. | Bitwise OR. Replaces TOS and TOS-1 with (TOS-1 | TOS). TOS and TOS-1 must both be integers. || Logical OR. Replaces TOS and TOS-1 with (TOS-1 || TOS). TOS and TOS-1 are indepen- dently considered as Booleans. & Bitwise AND. Replaces TOS and TOS-1 with (TOS-1 & TOS). TOS and TOS-1 must both be integers. && Logical AND. Replaces TOS and TOS-1 with (TOS-1 && TOS). TOS and TOS-1 are indepen- dently considered as Booleans. ^ Bitwise XOR. Replaces TOS and TOS-1 with (TOS-1 ^ TOS). TOS and TOS-1 must both be integers. X Version 11 Last change: Release 4 30 XTERM(1) USER COMMANDS XTERM(1) ^^ Logical XOR. Replaces TOS and TOS-1 with (TOS-1 ^^ TOS). TOS and TOS-1 are indepen- dently considered as Booleans. ! Logical NOT. Replaces TOS by the logical inverse of TOS when considered as a Boolean. ~ Bitwise invert. Replaces TOS by the bitwise inversion of TOS. TOS must be an integer. number Numbers can be entered in decimal, octal or hexadecimal radix. A simple string of digits, not starting with a 0, pushes a decimal value onto the stack. If the first digit in the string is 0 and the remainder of digits are between 0 and 7, the number is input as an octal number and pushed onto the stack. If the first digit in the string is 0 and it is immediately followed by x or X, the number is input as a hexadecimal number and pushed onto the stack. b Pushes the button field from a button event onto the stack. c Pushes the cursor column from a key or button event onto the stack. The leftmost column is column 0. C Pushes the column width of the screen onto the stack. h Pushes the pixel height of a character onto the stack. H Pushes the pixel height of the screen onto the stack. i Places TOS (must be a string) into the termi- nal input buffer and pops it off the stack. k Pushes the keycode field from a key event onto the stack. l Puts the results of XLookupString on a key event onto the stack. If XLookupString returns an error or no string, an empty string is pushed onto the stack. M Pop TOS (which must be a string) and inter- pret the macro of that name. The macro may be either a primitive or built-in (both X Version 11 Last change: Release 4 31 XTERM(1) USER COMMANDS XTERM(1) compiled into xterm) or a user-defined macro. User defined macros override built-in macros, but not primitives. The list of primitives and built-in macros is given below. r Pushes the cursor row from a key or button event onto the stack. The topmost row is 0. R Pushes the row height of the screen onto the stack. s Pushes the state field from a key or button event onto the stack. w Pushes the pixel width of a character onto the stack. W Pushes the pixel width of the screen onto the stack. x Pushes the x pixel value from a key or button event onto the stack. X Pushes to x_root pixel value from a key or button event onto the stack. y Pushes the y pixel value from a key or button event onto the stack. Y Pushes the y_root pixel value from a key or button event onto the stack. Z Conditionally returns from (terminates) a macro. Pops TOS and interprets it as a Bool; if TRUE, returns from the macro, else does nothing. Primitive functions are compiled into Xterm and can not be overridden. The primitives are: error Generates an error; calls Bell() and aborts all macro string processing. This is typi- cally used with an "if" statement to abort a macro if an error condition occurs. exch Exchanges TOS with TOS-1. if Examines TOS-1 as a Boolean; if TRUE, exe- cutes the macro named at TOS, else does noth- ing. In either case, the two values are popped off the stack before the test is per- formed. X Version 11 Last change: Release 4 32 XTERM(1) USER COMMANDS XTERM(1) ifElse Examines TOS-2 as a Boolean; if TRUE, exe- cutes the macro named at TOS-1, else executes the macro named at TOS. In either case, the three values are popped off the stack before the test is performed. limit Limits TOS-2 to be between TOS-1 and TOS. If TOS-2 is less than TOS-1, replaces it with TOS-1. If TOS-2 is greater than TOS, replaces it with TOS. All three items must be integers. Pops two items off the stack, leaving only the limited number. ord Converts a one-character string at TOS to an integer with the equivalent integer value (essentially a "scanf %c"). pop Pops one item off the stack and discards it. push Pushes the top item onto the stack again, duplicating it. tekScale Pushes the tekScale field of the screen onto the stack. Useful for emulating the Tek- tronix mode buttons. toBool Converts TOS to a Boolean (integer 0 or 1). There are a number of built-in macros, which are simply macro strings which are compiled into xterm. These built- ins can be overridden by a user defined macro. The built- ins are listed below, with the definitions of some given as examples. SeikoButton Generates the character sequence for button presses on a Seiko terminal. There are a number of associated built-ins that are a part of this package: SeikoGetX, SeikoGetY, SeikoSub1, SeikoEnd. To set up your xterm so that it generates Seiko character sequences for the buttons when the shift key is held down, you could add the following lines to your resource file: *VT100.translations: #override \n\ Shift : macro- string("'SeikoButton'M") \n\ Shift : ignore() X10Button Generates the character sequence that the X10 xterm generated for button pushes. This X Version 11 Last change: Release 4 33 XTERM(1) USER COMMANDS XTERM(1) macro is implemented with this string: '\033[M'i31b+%ci33c+%ci33r+%ci VT200ButtonPress Generates the character sequence for a VT200 button press. This macro is implemented with this string: '\033['iM31'VT200KeyState'M+b+%ci33c+%ci33r+%ci VT200KeyState Called by the VT200ButtonPress macro. This macro is implemented with this string: s5&s8&2>>+ TekButton Generates the character sequence for a Tek- tronix button press. Associated macros are TekGetBchar, TekGetlbchar, TekUcase, and Tek- Sub1. TestConst Generates a character string with a number of screen-dependent values, implemented with this string: 'h='ih%di' w='iw%di' H='iH%di' W='iW%di' R='iR%di' C='iC%di'\n'i TestButton Generates a character string with a number of position-dependent values, suitable for bind- ing to a button, implemented with this string: 'x='ix%di' y='iy%di' X='iX%di' Y='iY%di\ ' r='ir%di' c='ic%di' b='ib%di' s='is%xi'\n'i TestKey Generates a character string with a number of position-dependent values, suitable for bind- ing to a key, implemented with this string: 'x='ix%di' y='iy%di' X='iX%di' Y='iY%di\ ' r='ir%di' c='ic%di' k='ik%di' s='is%xi' l=\"'ili'\"\n'i You could add the following bindings to execute the test macros to see how the values look: *VT100.translations: #override \n\ F5 : macro- string("'TestConst'M") \n\ F6 : macro- string("'TestKey'M") X Version 11 Last change: Release 4 34 XTERM(1) USER COMMANDS XTERM(1) User defined macros can be specified in your resource or Xdefaults file. Macros are searched for as subresources of the xterm widget, where the subobject name is "macroString" and the subresource name is the macro name. For example, to define a macro named foo that prints out the string "button" and the button number, you could put this line in your resource file: *VT100.macroString.foo: 'button 'i b%di You could then bind this macro to a key with a line like: *VT100.translations: #override \n\ F7 : macro- string("'foo'M") OTHER FEATURES _X_t_e_r_m 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. 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 _t_e_r_m_c_a_p(5) entry for _x_t_e_r_m allows the visual editor _v_i(1) to switch to the alternate screen for editing, and restore the screen on exit. 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. ENVIRONMENT _X_t_e_r_m 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 _x_t_e_r_m window. SEE ALSO resize(1), X(1), pty(4), tty(4) _X_t_e_r_m _C_o_n_t_r_o_l _S_e_q_u_e_n_c_e_s BUGS The _X_t_e_r_m _C_o_n_t_r_o_l _S_e_q_u_e_n_c_e_s document has yet to be converted from X10. The old version, along with a first stab at an update, are available in the sources. X Version 11 Last change: Release 4 35 XTERM(1) USER COMMANDS XTERM(1) The class name is _X_T_e_r_m instead of _X_t_e_r_m. Xterm will hang forever if you try to paste too much text at one time. It is both producer and consumer for the pty and can deadlock. Variable-width fonts are not handled. 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. 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. There needs to be a dialog box to allow entry of log file name and the COPY file name. Many of the options are not resettable after _x_t_e_r_m starts. The Tek widget does not support key/button re-binding. COPYRIGHT Copyright 1989, Massachusetts Institute of Technology. See _X(_1) for a full statement of rights and permissions. AUTHORS Far too many people, including: Loretta Guarino Reid (DEC-UEG-WSL), Joel McCormack (DEC- UEG-WSL), Terry Weissman (DEC-UEG-WSL), Edward Moy (Berke- ley), 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) X Version 11 Last change: Release 4 36