Annotation of 43BSDTahoe/new/X/man/man1/xterm.1, revision 1.1.1.1

1.1       root        1: .TH XTERM 1 "1 Nov 1986" "X Version 10"
                      2: .SH NAME
                      3: xterm \- X window system terminal emulator
                      4: .SH SYNOPSIS
                      5: .B xterm
                      6: [ option ] ...
                      7: .SH DESCRIPTION
                      8: .I Xterm
                      9: is the
                     10: .I X
                     11: window system terminal emulator.
                     12: It attempts to emulate a DEC VT102 terminal
                     13: to provide a standard terminal type for programs not aware of the window
                     14: system directly.
                     15: Under 4.3BSD, Ultrix 1.2 and other systems with the capability,
                     16: .I xterm
                     17: supports the terminal resizing facilities built into the system.
                     18: .PP
                     19: In addition,
                     20: .I xterm
                     21: emulates the Tektronix 4015 in a separate window.
                     22: To maintain the correct aspect ratio (height/width), Tektronix graphics will
                     23: be restricted to the
                     24: largest box with a 4015's aspect ratio that will fit in the window.
                     25: This box is located in the upper left area of the window.
                     26: .PP
                     27: Both windows may be displayed at the same time, though only one window and
                     28: mode is active at a time.
                     29: Input will be displayed in the active window even if the mouse is in the other
                     30: window.
                     31: Switching between the active modes is possible under manual (menu) and program
                     32: (escape sequence) control.
                     33: .PP
                     34: .I Xterm
                     35: understands the following options.
                     36: If the option begins with a
                     37: .RB ` + '
                     38: instead of a
                     39: .RB ` \- ',
                     40: the option is restored to its default value.
                     41: These options override those set in the ``.Xdefaults'' file (see the
                     42: .B "X DEFAULTS"
                     43: section).
                     44: .TP 12
                     45: .B \-132
                     46: Normally, the VT102 DECCOLM escape sequence that switches between 80 and
                     47: 132 column mode is ignored.
                     48: This option causes the DECCOLM escape sequence to be recognized, and the
                     49: .I xterm
                     50: window will resize appropriately.
                     51: .TP
                     52: .B \-C
                     53: When 
                     54: .I xterm
                     55: is run on a Sun, this option causes messages normally destined for the
                     56: console device, to be displayed in the
                     57: .I xterm
                     58: window.
                     59: .TP
                     60: .B \-L
                     61: indicates that
                     62: .I xterm
                     63: is being called by
                     64: .IR init (8),
                     65: and should presume that its file descriptors
                     66: are already open on a slave pseudo-tty, and that
                     67: .IR getty (8)
                     68: should be
                     69: run rather than the user's shell.
                     70: This option should only be used by
                     71: .IR init (8)
                     72: .TP
                     73: .B \-ar
                     74: This option turns on the auto-raise mode of
                     75: .IR xterm ,
                     76: which automatically raises the window when the mouse cursor enters the
                     77: window.
                     78: .TP
                     79: .BI \-b " border"
                     80: .I Xterm
                     81: maintains an inner border (distance between characters and the window's
                     82: border) of one pixel.
                     83: The
                     84: .B \-b
                     85: option allows you to set the size of this border to 
                     86: .I border.
                     87: .TP
                     88: .BI \-bd " color"
                     89: On color displays, determines the color of the (highlighted) border.
                     90: .TP
                     91: .BI \-bg " color"
                     92: On color displays, determines the color of the background.
                     93: .TP
                     94: .B \-bi
                     95: This option forces the icon to be a static bitmap rather than the default
                     96: miniature window.
                     97: .TP
                     98: .BI \-bw " borderwidth"
                     99: Allows you to specify the width of the window border in pixels.
                    100: .TP
                    101: .BI \-cr " color"
                    102: On color displays, determines the (highlighted) color of the text cursor;
                    103: default is the text (foreground) color.
                    104: .TP
                    105: .B \-cu
                    106: Several programs that use the
                    107: .IR curses (3x)
                    108: cursor motion package have some difficulties with VT102-compatible terminals.
                    109: The bug fixed with this option occurs with
                    110: .IR more (1)
                    111: on a file containing a line that is exactly the width of the window and
                    112: which is followed by line beginning with a tab.
                    113: Normally, the leading tabs disappear, but this option causes them to be
                    114: displayed correctly.
                    115: .TP
                    116: .B \-dw
                    117: When the
                    118: .I xterm
                    119: icon is deiconified, this option warps the mouse to the center of the window.
                    120: .TP
                    121: .BI \-e " command arguments"
                    122: The specified 
                    123: .I command
                    124: will be executed in the window, rather than
                    125: starting a shell.
                    126: The command and the optional arguments must appear last on the
                    127: .I xterm
                    128: command line.
                    129: .TP
                    130: .BI \-fb " font"
                    131: The specified
                    132: .I font
                    133: will be used instead of the default bold font (which is ``vtbold'').
                    134: This font must be the same height and width as the normal font.
                    135: If only one of the normal or bold fonts is specified, it will be used as the
                    136: normal font and the bold font will be produced by overstriking this font.
                    137: .TP
                    138: .BI \-fg " color"
                    139: On color displays, determines the color of the text (foreground).
                    140: .TP
                    141: .BI \-fi " font"
                    142: Specifies the default font to be used for the miniature icon windows.
                    143: The usual value for the icon font is ``nil2''.
                    144: .TP
                    145: .BI \-fn " font"
                    146: The specified
                    147: .I font
                    148: will be used instead of the default font (which is ``vtsingle'').
                    149: Any fixed width font may be used.
                    150: .TP
                    151: .BI \-ft " font"
                    152: The specified
                    153: .I font
                    154: will be used in the title bar instead of the default font (which is
                    155: ``vtsingle'').
                    156: .TP
                    157: .B \-i
                    158: This option causes
                    159: .I xterm
                    160: to startup displaying the icon rather than the normal window.
                    161: .TP
                    162: .BI \-ib " file"
                    163: The
                    164: .IR file ,
                    165: which is assumed to be in
                    166: .IR bitmap (1)
                    167: format, is read and the resulting bitmap is used in the icon when
                    168: in VT102 mode.
                    169: If only one bitmap file is specified, it is used for both modes.
                    170: If both the bitmap file names are null, no bitmap is used.
                    171: .TP
                    172: .BI \-it " file"
                    173: The
                    174: .IR file ,
                    175: which is assumed to be in
                    176: .IR bitmap (1)
                    177: format, is read and the resulting bitmap is used in the icon when
                    178: in Tektronix mode.
                    179: If only one bitmap file is specified, it is used for both modes.
                    180: If both the bitmap file names are null, no bitmap is used.
                    181: .TP
                    182: .B \-j
                    183: .I Xterm
                    184: will `jump scroll'; when
                    185: .I xterm
                    186: falls behind scrolling
                    187: the screen, it will move multiple lines up at once.
                    188: The VT100 escape sequences for smooth scroll can be used to enable/disable
                    189: this feature from a program,
                    190: or the `Mode Menu' can be used to set it interactively.
                    191: .\"TP
                    192: .\"B \-k
                    193: .TP
                    194: .B \-l
                    195: Logging is turned on; all input from the pseudo tty is appended to the
                    196: logfile.
                    197: .TP
                    198: .BI \-lf " file"
                    199: This
                    200: .I file
                    201: specifies the file in which the log is written to, rather than the default
                    202: ``\fBXtermLog.\fIXXXXX\fR'' where
                    203: .I XXXXX
                    204: is the process id of
                    205: .I xterm
                    206: (the file is created in the directory
                    207: .I xterm
                    208: is started in, or the home directory for a login
                    209: .IR xterm ).
                    210: If
                    211: .I file
                    212: begins with a ``|'' then the rest of the string is assumed to be a command
                    213: to be executed by the shell, and a pipe is opened to the process.
                    214: .TP
                    215: .B \-ls
                    216: This option causes the shell run under
                    217: .I xterm
                    218: to be a login shell (the user's .login file is read and the initial directory
                    219: will be the home directory).
                    220: .TP
                    221: .B \-mb
                    222: This option turns on the right margin bell.
                    223: .TP
                    224: .BI \-ms " color"
                    225: On color displays, determines the color of the mouse cursor; default is the
                    226: text cursor color.
                    227: .TP
                    228: .BI \-n " windowname"
                    229: Allows you to set the name of the window for use by a window manager.
                    230: This name is displayed in the title bar, also.
                    231: .TP
                    232: .BI \-nb " number"
                    233: This
                    234: .I number
                    235: is used as the right margin distance in which the margin bell will ring
                    236: (the default is 10).
                    237: .TP
                    238: .BI \-po " number"
                    239: Normally, in page scroll mode, a ``page'' is defined to be the number of
                    240: lines in the scrolling region minus the page overlap, which is one by default.
                    241: .I Number
                    242: specifies a new page overlap.
                    243: .TP
                    244: .B \-ps
                    245: Page scroll mode is initially turned on.
                    246: After a ``page'' of lines is displayed,
                    247: .I xterm
                    248: will stop displaying any more lines and the text cursor will disappear.
                    249: Typing a carriage return will allow one more line to be scrolled (the
                    250: return is discarded).
                    251: Pressing the space bar (or any other printable character) allows another
                    252: page to be scrolled (the character is discarded).
                    253: Typing a control character allows another page to be scrolled, but the
                    254: control character is sent (e.g., the interrupt character).
                    255: .TP
                    256: .B \-r
                    257: The screen will be displayed with white characters on a black background,
                    258: rather than the default black on white.
                    259: This becomes the normal video mode, which is reversed by turning on the
                    260: reverse video mode.
                    261: .TP
                    262: .B \-rv
                    263: Same as
                    264: .BR \-r .
                    265: .TP
                    266: .B \-rw
                    267: This options turns on reverse-wraparound mode, that allows the cursor to
                    268: wraparound from the leftmost column to the rightmost column of the previous
                    269: line.
                    270: This is very useful in the shell to allow erasure backwards across the
                    271: previous line.
                    272: .TP
                    273: .B \-s
                    274: When this option is specified, xterm no longer scrolls synchronously
                    275: with the display.
                    276: .I Xterm
                    277: no longer attempts to keep the screen completely up to date while
                    278: scrolling, but can then run faster when network latencies are very high.
                    279: This is typically useful when using
                    280: .I xterm
                    281: across a very large internet or many hops.
                    282: .TP
                    283: .B \-sb
                    284: This option causes the scrollbar to be displayed during startup, with the
                    285: saving of lines scrolled off the top of the window being turned on.
                    286: .TP
                    287: .B \-si
                    288: When using the scrollbar to review previous lines of text, the window is
                    289: normally repositioned automatically at the
                    290: bottom of the scroll region when input has arrived.  This option disables
                    291: repositioning on input.
                    292: .TP
                    293: .B \-sk
                    294: When using the scrollbar to review pass lines of text, this option
                    295: causes the window to be repositioned automatically in the normal postion at the
                    296: bottom of the scroll region when a key is pressed.
                    297: .TP
                    298: .BI \-sl " number"
                    299: The
                    300: .I number
                    301: specifies the maximum number of lines to save that are scrolled off the top
                    302: of the window.
                    303: The default is 64 lines.
                    304: .TP
                    305: .B \-sn
                    306: By default, the status line is in revere-video (relative to the rest of the
                    307: window).
                    308: This option causes the status line to be in normal video (the status line
                    309: is still enclosed in a box).
                    310: .TP
                    311: .B \-st
                    312: This option causes the status line to be displayed on startup.
                    313: .TP
                    314: .B \-t
                    315: This option causes the initial
                    316: .I xterm
                    317: window to be the Tektronix window, rather than the normal VT102 window.
                    318: .TP
                    319: .B \-tb
                    320: This option disables the title bar from being displayed on startup.
                    321: .TP
                    322: .B \-ti
                    323: Normally in the icon, the window name is to the right of the bitmap.
                    324: This option causes the text to be under the icon.
                    325: .TP
                    326: .B \-vb
                    327: This option turns on the visual bell mode, which flashes the window on
                    328: receipt of a CTRL-G.
                    329: .TP
                    330: .B \-w
                    331: Same as
                    332: .BR \-bw .
                    333: .TP
                    334: .BI = geometry
                    335: .I Xterm
                    336: will take a normal X geometry specification for the VT102 window.
                    337: This takes the form of ``\fB=\fIwidth\fBx\fIheight\fB+\fIxoff\fB+\fIyoff\fR''.
                    338: See
                    339: .IR X (1)
                    340: for details of this specification.
                    341: .TP
                    342: .BI % geometry
                    343: This geometry specification applies to the Tektronix window.
                    344: .TP
                    345: .BI # geometry
                    346: This geometry specification applies to the icon position (the width and
                    347: height information are optional and otherwise ignored).
                    348: .TP
                    349: .IB host : display
                    350: Normally,
                    351: .I xterm
                    352: gets the host and display number to use from the environment
                    353: variable ``DISPLAY''.
                    354: One can, however specify them explicitly.
                    355: The
                    356: .I host
                    357: specifies which machine to create the window on, and
                    358: the
                    359: .I display
                    360: argument specifies the display number.
                    361: For example,
                    362: ``orpheus:1'' creates a shell window on display one on the machine
                    363: orpheus.
                    364: .SH "X DEFAULTS"
                    365: .I Xterm
                    366: allows you to preset defaults in a customization file in your home
                    367: directory, called
                    368: .BR .Xdefaults .
                    369: The format of the file is ``programname.keyword:string''.
                    370: See
                    371: .IR X (1)
                    372: for more details.
                    373: .I Xterm
                    374: obeys the convention for `MakeWindow' defaults.
                    375: Keywords recognized by
                    376: .I xterm
                    377: are listed below.
                    378: .TP 15
                    379: .B ActiveIcon
                    380: If ``off'',
                    381: .I xterm
                    382: window icons(s) are static bitmaps rather than miniature windows.
                    383: .TP
                    384: .B AllowIconInput
                    385: If ``on'', then keyboard input is permitted when
                    386: .I xterm
                    387: windows are in their iconified state and the icon is a miniature window.
                    388: Keyboard input is always disabled when static bitmap icons are used.
                    389: .TP
                    390: .B AutoRaise
                    391: If ``on'',
                    392: .I xterm
                    393: window(s) are automatically raised when the mouse enters them.
                    394: .TP
                    395: .B Background
                    396: Set the background color.
                    397: .TP
                    398: .B BodyFont
                    399: Set the default font.
                    400: .TP
                    401: .B BoldFont
                    402: Specify a default bold font.
                    403: .TP
                    404: .B Border
                    405: Set the border color.
                    406: .TP
                    407: .B BorderWidth
                    408: Set the border width of the window.
                    409: .TP
                    410: .B C132
                    411: If ``on'', allow the DECCOLM escape sequence to switch between 80 and 132
                    412: column mode.
                    413: .TP
                    414: .B Curses
                    415: If ``on'', enable the
                    416: .IR curses (3x)
                    417: fix.
                    418: .TP
                    419: .B Cursor
                    420: Set the text cursor color.
                    421: .TP
                    422: .B DeiconifyWarp
                    423: If ``on'', warp the mouse to the center of the window after deiconification.
                    424: .TP
                    425: .B Foreground
                    426: Set the text color.
                    427: .TP
                    428: .B IconBitmap
                    429: Specifies the
                    430: .IR bitmap (1)
                    431: file to be used as the bitmap for VT102 mode icon.
                    432: .TP
                    433: .B IconFont
                    434: Specify the default font for miniature window icons.  The usual value is
                    435: ``nil2''.
                    436: .TP
                    437: .B IconStartup
                    438: If ``on'', initially display the icon rather than the normal window.
                    439: .TP
                    440: .B InternalBorder
                    441: Set the space between the text and window border.
                    442: This is called padding above.
                    443: .TP
                    444: .B JumpScroll
                    445: If ``on'', jump scroll is enabled.
                    446: .\"TP
                    447: .\"B KeyBoard
                    448: .TP
                    449: .B LogFile
                    450: Specifies the log file or command to pipe to when logging is activated.
                    451: .TP
                    452: .B Logging
                    453: If ``on'', turn logging on initially.
                    454: .TP
                    455: .B LogInhibit
                    456: If ``on'', totally inhibit logging from being turned on.
                    457: .TP
                    458: .B LoginShell
                    459: If ``on'', make the shell executed a login shell.
                    460: .TP
                    461: .B MarginBell
                    462: If ``on'', turn on the margin bell.
                    463: .TP
                    464: .B MenuBorder
                    465: specifies the border width for the menus. The default is 2.
                    466: .TP
                    467: .B MenuPad
                    468: specifies the extra padding above and below the menu title.  The default is 3.
                    469: .TP
                    470: .B MenuFont
                    471: specifies the font to be used within the menus.  The default is the same
                    472: font used for the titlebar.
                    473: .TP
                    474: .B Mouse
                    475: Set the mouse cursor color.
                    476: .TP
                    477: .B NMarginBell
                    478: Set the margin bell right margin distance.
                    479: .TP
                    480: .B PageOverlap
                    481: Set the page overlap in page scroll mode.
                    482: .TP
                    483: .B PageScroll
                    484: If ``on'', turn on page scroll mode. 
                    485: .TP
                    486: .B ReverseVideo
                    487: If ``on'', reverse the definition of foreground and background color.
                    488: .TP
                    489: .B ReverseWrap
                    490: If ``on'', turn on the reverse wraparound mode.
                    491: .TP
                    492: .B SaveLines
                    493: Set the number of lines to save when scrolled of the top of the window.
                    494: .TP
                    495: .B ScrollBar
                    496: If ``on'', show the scrollbar initially.
                    497: .TP
                    498: .B ScrollInput
                    499: If ``off'', disable repositioning the scroll region at the bottom if
                    500: new input has arrived.
                    501: .TP
                    502: .B ScrollKey
                    503: If ``on'', reposition the scroll region at the bottom if
                    504: a key is pressed.
                    505: .TP
                    506: .B SignalInhibit
                    507: If ``on'', totally inhibit the sending of signals from the
                    508: .B xterm
                    509: menu.
                    510: .TP
                    511: .B StatusLine
                    512: If ``on'', show the status line on startup.
                    513: .TP
                    514: .B StatusNormal
                    515: If ``on'', make the status line normal video.
                    516: .TP
                    517: .B TekIconBitmap
                    518: Specifies the
                    519: .IR bitmap (1)
                    520: file to be used as the bitmap for Tektronix mode icon.
                    521: .TP
                    522: .B TekInhibit
                    523: If ``on'', totally inhibit going into Tektronix mode.
                    524: .TP
                    525: .B TextUnderIcon
                    526: If ``on'', place the icon text under the bitmap icon.
                    527: .TP
                    528: .B TitleBar
                    529: If ``off'', don't show the title bar on startup.
                    530: .TP
                    531: .B TitleFont
                    532: Set the font of the title bar text.
                    533: .TP
                    534: .B VisualBell
                    535: If ``on'', turn on visual bell mode at startup.
                    536: .SH EMULATIONS
                    537: The VT102 emulation is fairly complete, but does not support the blinking
                    538: character attribute nor the double-wide and double-size character sets.
                    539: .IR Termcap (5)
                    540: entries that work with
                    541: .I xterm
                    542: include ``xterms'', ``xterm'', ``vt102'', ``vt100'' and ``ansi'', and
                    543: .I xterm
                    544: automatically searches the termcap file in this order for these entries and then
                    545: sets the ``TERM'' and the ``TERMCAP'' environment variables.
                    546: .PP
                    547: Many of the special
                    548: .I xterm
                    549: features (like the scrollbar and logging) may be modified under program control
                    550: through a set of escape sequences different from the standard VT102 escape
                    551: sequences.
                    552: Also, many of the Sun tty escape sequences for resizing and moving
                    553: the window are also understood.
                    554: (See the
                    555: .I ``Xterm Control Sequences''
                    556: document.)
                    557: .PP
                    558: The Tektronix 4015 emulation is also fairly good.
                    559: Four different font sizes and five different lines types are supported.
                    560: The Tektronix text and graphics commands are recorded internally by
                    561: .I xterm
                    562: and may be written to a file by sending the COPY escape sequence (or through
                    563: the
                    564: .B Tektronix
                    565: menu; see below).
                    566: The name of the file will be
                    567: ``\fBCOPY\fIyy\fB\-\fIMM\fB\-\fIdd\fB.\fIhh\fB:\fImm\fB:\fIss\fR'', where
                    568: .IR yy ,
                    569: .IR MM ,
                    570: .IR dd ,
                    571: .IR hh ,
                    572: .I mm
                    573: and
                    574: .I ss
                    575: are the year, month, day, hour, minute and second when the COPY was performed
                    576: (the file is created in the directory
                    577: .I xterm
                    578: is started in, or the home directory for a login
                    579: .IR xterm ).
                    580: .SH "MOUSE USAGE"
                    581: .PP
                    582: When using the mouse to create the VT102 window, a cursor and
                    583: a rubber banding box will outline where the window will be created on
                    584: the display.
                    585: If the left button is pressed, a HEIGHTxWIDTH (default 24x80)
                    586: size window will be created at the position where the button is released.
                    587: If the right button is pressed, a window the height of the display and
                    588: WIDTH (default 80) characters wide will be created.
                    589: If the center button is pressed and held down, the upper left hand corner
                    590: of the window is defined at this position.
                    591: An outline of the minimum size window is shown, and a popup window in
                    592: the upper left hand corner of the display will show the size in characters
                    593: of the window.
                    594: Moving the mouse (while still holding the button down) will enlarge the
                    595: window and the sizes in the pop up window will update accordingly.
                    596: Releasing the button will define the lower right hand corner
                    597: of the window.
                    598: .PP
                    599: Once the VT102 window is created,
                    600: .I xterm
                    601: allows you to save text and restore it within the same or other windows.
                    602: The button functions are enabled when holding down the ``shift'' key.
                    603: The left hand button takes the text from the cursor (at button release)
                    604: through the end of line (including the new line), saves it in the global cut
                    605: buffer, and immediately `retypes' the line, inserting it as keyboard input.
                    606: This provides a history mechanism.
                    607: The selected text is highlighted while the button is pressed.
                    608: Moving off the initial line will cancel the selection.
                    609: If there is no text beyond the initial cursor point,
                    610: .I xterm
                    611: will sound the bell, indicating an error.
                    612: .PP
                    613: The shifted center button is used to save text into the cut buffer.
                    614: Move the cursor to beginning of the text,
                    615: and then hold the button down while moving the cursor to the end of the region
                    616: and releasing the button.
                    617: The selected text is highlighted and is saved in the global cut buffer when
                    618: the button is released.
                    619: .PP
                    620: The shifted right hand button `types' (pastes) the text from the cut buffer,
                    621: inserting it as keyboard input.
                    622: By cutting and pasting pieces of text without trailing new lines,
                    623: you can take text from several places in different windows and form a command
                    624: to the shell, for example, or take output from a program and insert it into
                    625: your favorite editor.
                    626: Since the cut buffer is globally shared among different applications,
                    627: you should regard it as a `file' whose contents you know.
                    628: The terminal emulator and other text programs should be treating it as if it
                    629: were a text file, i.e. the text is delimited by new lines.
                    630: .PP
                    631: The scrollbar is composed of three parts, the scroll button at the top, the
                    632: recorder button in the middle and the scroll region at the bottom.
                    633: Pressing the middle button in any part of the scrollbar will display the
                    634: scrollbar menu; see the
                    635: .B MENUS
                    636: section below.
                    637: .PP
                    638: The scroll region displays the position and amount of text currently showing
                    639: in the window (highlighted) relative to the amount of text actually saved.
                    640: As more text is saved (up to the maximum), the size of the highlighted area
                    641: decreases.
                    642: Clicking the mouse with the left of right button in the scroll region will
                    643: position the top of the display window at the mouse position.
                    644: .PP
                    645: The recorder button shows the state of saving lines scrolled off the top
                    646: of the window.
                    647: Tape running reel to reel indicates on, while the tape hanging indicates off.
                    648: Clicking the left or right button in the recorder button toggles the state of
                    649: recording.
                    650: .PP
                    651: The scroll button causes the window to scroll up and down within the saved text.
                    652: The left button moves the window position up (the text scrolls downward), while
                    653: the right button moves the window position down (the text scrolls upward).
                    654: The amount of scrolling is modified by the ``shift'' and ``control'' keys.
                    655: Without either, the window scrolls a single line at a time.
                    656: Continuing to hold the button down will causes the text to continuously
                    657: scroll a line at a time.
                    658: .PP
                    659: The ``shift'' key causes the text to scroll a window full at a time (actually
                    660: it is one line less than a full window).
                    661: And the ``control'' key causes the text to be positioned at the extremes,
                    662: top or bottom.
                    663: .PP
                    664: When using the mouse to create the Tektronix window, a cursor and
                    665: a rubber banding box will outline where the window will be created on
                    666: the display.
                    667: If the left button is pressed, a default size window (750 pixels wide by
                    668: 565 pixel high) is created at the origin.
                    669: If the right button is pressed, a default size window is created
                    670: at the mouse position.
                    671: If the center button is pressed and held down, the upper left hand corner
                    672: of the window is defined at this position.
                    673: An outline of the minimum size window is shown, and a popup window in
                    674: the upper left hand corner of the display will appear, indicating Tektronix
                    675: mode.
                    676: Moving the mouse (while still holding the button down) will enlarge the
                    677: window.
                    678: Releasing the button will define the lower right hand corner
                    679: of the window.
                    680: .PP
                    681: Unlike the VT102 window, the Tektronix window dows not allow the copying of
                    682: text.
                    683: It does allow Tektronix GIN mode, and in this mode
                    684: the cursor will change from an arrow to a cross.
                    685: Pressing any key will send that key and the current coordinate of the
                    686: cross cursor.
                    687: Pressing the left, middle or right button will return the letters `l', `m', and
                    688: `r', respectively.
                    689: If the `shift' key is pressed when a mouse buton is pressed, the corresponding
                    690: upper case letter is sent.
                    691: To distinquish a mouse button from a key, the high bit of the character is
                    692: set (but this is bit is normally stripped unless the terminal mode is RAW;
                    693: see
                    694: .IR tty (4)
                    695: for details).
                    696: .SH MENUS
                    697: .I Xterm
                    698: has five different menus, named
                    699: .BR xterm ,
                    700: .BR Modes ,
                    701: .BR Tektronix ,
                    702: .B Scrollbar
                    703: and
                    704: .BR Windows .
                    705: Each menu pops up under the correct combinations of key and button presses.
                    706: Most menus are divided into two section, separated by a horizontal line.
                    707: The top portion contains various modes that can be altered.
                    708: A check mark appears next to a mode that is currently active.
                    709: Selecting one of these modes toggles its state.
                    710: The bottom portion of the menu are command entries; selecting one of these
                    711: performs the indicated function.
                    712: .PP
                    713: The
                    714: .B xterm
                    715: menu pops up when the ``control'' key and the left button is pressed in a
                    716: window.
                    717: The menu title gives the version number of
                    718: .IR xterm .
                    719: The modes section contains items that apply to both the VT102 and Tektronix
                    720: windows.
                    721: Notable entries in the command section of the menu are the
                    722: .BR Continue ,
                    723: .BR Suspend ,
                    724: .BR Interrupt ,
                    725: .BR Hangup ,
                    726: .B Terminate
                    727: and
                    728: .B Kill
                    729: which sends the SIGCONT, SIGTSTP, SIGINT, SIGHUP, SIGTERM and
                    730: SIGKILL signals, respectively, to the process group of the process running
                    731: under
                    732: .I xterm
                    733: (usually the shell).
                    734: The
                    735: .B Continue
                    736: function is especially useful if the user has accidentally typed CTRL-Z,
                    737: suspending the process.
                    738: .PP
                    739: The
                    740: .B Modes
                    741: menu sets various modes in the VT102 emulation, and is popped up with the
                    742: ``control'' and middle button combination in the VT102 window.
                    743: In the command section of this menu, the soft reset entry will reset
                    744: scroll regions.
                    745: This can be convenient when some program has left the scroll regions
                    746: set incorrectly (often a problem when using VMS or TOPS-20).
                    747: The full reset entry will clear the screen, reset tabs to every
                    748: eight columns, and reset the terminal modes (such as wrap and smooth scroll)
                    749: to there initial states just after
                    750: .I xterm
                    751: has finish processing the command line options.
                    752: The
                    753: .B Tektronix
                    754: menu sets various modes in the Tektronix emulation, and is popped up with the
                    755: ``control'' and middle button combination in the Tektronix window.
                    756: The current font size is checked in the modes section of the menu.
                    757: The
                    758: .B PAGE
                    759: entry in the command section clears the Tektronix window.
                    760: .PP
                    761: The
                    762: .B Scrollbar
                    763: menu is popped up when the middle button is pressed within the scrollbar.
                    764: This menu allows several modes particular to the scrollbar to be set.
                    765: .PP
                    766: The
                    767: .B Windows
                    768: menu is not normally compiled into
                    769: .I xterm
                    770: as it duplicates functions that properly belong to window managers.  It
                    771: may, however, be enabled at the discretion of your system builder.
                    772: .PP
                    773: If enabled, the
                    774: .B Windows
                    775: menu is a special menu that is popped up when the ``control'' key and
                    776: right button are pressed.
                    777: Listed in order of bottommost to topmost are the visible windows on the
                    778: display that are named.
                    779: The checked entry is the current window.
                    780: By selecting an entry, the corresponding window is raised to the top.
                    781: This is very useful when a particular window of interest
                    782: is obscured by many other windows.
                    783: .SH "OTHER FEATURES"
                    784: .I Xterm
                    785: automatically highlights the window border, text cursor and titlebar when the
                    786: mouse enters the window (selected) and unhighlights them when the mouse
                    787: leaves the window (unselected).
                    788: If the window is the focus window, then the window is highlighted no matter
                    789: where the mouse is.
                    790: .PP
                    791: The titlebar displays the name of the window in the center and on both
                    792: sides stripes appear when the window is selected (highlighted).
                    793: If both windows are showing, only the active window's titlebar is highlighted.
                    794: If the left, middle or right button is pressed in the stripped section of
                    795: the titlebar, the corresponding menu is popped up, without the need to
                    796: hold down the ``control'' key.
                    797: Pressing the mouse button in the center title of the titlebar causes
                    798: the window to automatically iconify.
                    799: Pressing a button in the icon deiconifies it.
                    800: In addition, if input comes in while
                    801: .I xterm
                    802: is iconified and the icon is a static bitmap,
                    803: a box is drawn around the icon title.
                    804: .PP
                    805: In VT102 mode, there are escape sequences to activate and deactivate
                    806: an alternate screen buffer, which is the same size as the display area
                    807: of the window.
                    808: When activated, the current screen is saved and replace with the alternate
                    809: screen.
                    810: Saving of lines scrolled off the top of the window and page scroll mode
                    811: are disabled, until the normal screen is restored.
                    812: The
                    813: .IR termcap (5)
                    814: entry for
                    815: .I xterm
                    816: allows the visual editor
                    817: .IR vi (1)
                    818: to switch to the alternate screen for editing, and restore the screen
                    819: on exit.
                    820: .PP
                    821: In either VT102 or Tektronix mode, there are escape sequences to change the
                    822: title in the title bar (which will also change the name of the windows and
                    823: icons) and to specify a new log file name.
                    824: .PP
                    825: By default, a miniature version of the VT102 or Tektronix window is
                    826: displayed when
                    827: .I xterm
                    828: is iconified.  The choice of which miniature to display is made when
                    829: the full window(s) are iconified; if the Tek window is chosen in the
                    830: iconify operation, then the icon will be a miniature Tek window and if
                    831: the VT102 window is chosen, the icon will be a miniature VT102 window.
                    832: This choice is independent of the current mode (Tektronix/VT102).
                    833: .PP
                    834: As an option, the miniature window may be disabled and a bitmap of a
                    835: small VT102 window with titlebar and scrollbar can be
                    836: displayed in the icon when in VT102 mode, and a bitmap of a Tektronix
                    837: window with titlebar is displayed in Tektronix mode.
                    838: these bitmaps may be user-defined (see options above).
                    839: .SH ENVIRONMENT
                    840: .I Xterm
                    841: sets the environment variables ``TERM'' and ``TERMCAP'' properly for the
                    842: size window you have created.
                    843: It also uses and sets the environment
                    844: variable ``DISPLAY'' to specify which bit map display terminal to use.
                    845: The environment variable ``WINDOWID'' is set to the X window id number
                    846: of the
                    847: .I xterm
                    848: window.
                    849: .SH "SEE ALSO"
                    850: resize(1), X(1), pty(4), tty(4)
                    851: .br
                    852: .I ``Xterm Control Sequences''
                    853: .SH BUGS
                    854: There is currently no way for a
                    855: .I xterm
                    856: window not to highlight itself when the mouse cursor enter it
                    857: while another window is the keyboard focus.
                    858: There needs to be a dialog box to allow entry of log file name
                    859: and the COPY file name.
                    860: Many of the options are not resettable after
                    861: .I xterm
                    862: starts.
                    863: .SH AUTHORS
                    864: Edward Moy (Berkeley), Ralph R. Swick (MIT-Athena),
                    865: Mark Vandevoorde (MIT-Athena), Bob McNamara (DEC-MAD),
                    866: Jim Gettys (MIT-Athena), Bob Scheifler (MIT-LCS), Doug Mink (SAO).
                    867: .sp
                    868: VMS and TOPS-20 are trademarks of Digital Equipment Corporation.
                    869: .sp
                    870: Copyright (c) 1984, 1985, 1986 by Massachusetts Institute of Technology.
                    871: .br
                    872: See
                    873: .IR X (1)
                    874: for a full copyright notice.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.