Annotation of 43BSDTahoe/new/X/xterm/xterm.1, revision 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 \-ai
        !            74: This option causes the icon to be a miniature representation of the window,
        !            75: rather than the standard icon.
        !            76: .TP
        !            77: .B \-ar
        !            78: This option turns on the auto-raise mode of
        !            79: .IR xterm ,
        !            80: which automatically raises the window when the mouse cursor enters the
        !            81: window.
        !            82: .TP
        !            83: .BI \-b " border"
        !            84: .I Xterm
        !            85: maintains an inner border (distance between characters and the window's
        !            86: border) of one pixel.
        !            87: The
        !            88: .B \-b
        !            89: option allows you to set the size of this border to 
        !            90: .I border.
        !            91: .TP
        !            92: .BI \-bd " color"
        !            93: On color displays, determines the color of the (highlighted) border.
        !            94: .TP
        !            95: .BI \-bg " color"
        !            96: On color displays, determines the color of the background.
        !            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 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, this option
        !           289: causes the window to be repositioned automatically at the
        !           290: bottom of the scroll region when input has arrived.
        !           291: .TP
        !           292: .B \-sk
        !           293: When using the scrollbar to review pass lines of text, this option
        !           294: causes the window to be repositioned automatically in the normal postion at the
        !           295: bottom of the scroll region when a key is pressed.
        !           296: .TP
        !           297: .BI \-sl " number"
        !           298: The
        !           299: .I number
        !           300: specifies the maximum number of lines to save that are scrolled off the top
        !           301: of the window.
        !           302: The default is 64 lines.
        !           303: .TP
        !           304: .B \-sn
        !           305: By default, the status line is in revere-video (relative to the rest of the
        !           306: window).
        !           307: This option causes the status line to be in normal video (the status line
        !           308: is still enclosed in a box).
        !           309: .TP
        !           310: .B \-st
        !           311: This option causes the status line to be displayed on startup.
        !           312: .TP
        !           313: .B \-t
        !           314: This option causes the initial
        !           315: .I xterm
        !           316: window to be the Tektronix window, rather than the normal VT102 window.
        !           317: .TP
        !           318: .B \-tb
        !           319: This option causes the title bar to be displayed on startup.
        !           320: .TP
        !           321: .B \-ti
        !           322: Normally in the icon, the window name is to the right of the bitmap.
        !           323: This option causes the text to be under the icon.
        !           324: .TP
        !           325: .B \-vb
        !           326: This option turns on the visual bell mode, which flashes the window on
        !           327: receipt of a CTRL-G.
        !           328: .TP
        !           329: .B \-w
        !           330: Same as
        !           331: .BR \-bw .
        !           332: .TP
        !           333: .BI = geometry
        !           334: .I Xterm
        !           335: will take a normal X geometry specification for the VT102 window.
        !           336: This takes the form of ``\fB=\fIwidth\fBx\fIheight\fB+\fIxoff\fB+\fIyoff\fR''.
        !           337: See
        !           338: .IR X (1)
        !           339: for details of this specification.
        !           340: .TP
        !           341: .BI % geometry
        !           342: This geometry specification applies to the Tektronix window.
        !           343: .TP
        !           344: .BI # geometry
        !           345: This geometry specification applies to the icon position (the width and
        !           346: height information are optional and otherwise ignored).
        !           347: .TP
        !           348: .IB host : display
        !           349: Normally,
        !           350: .I xterm
        !           351: gets the host and display number to use from the environment
        !           352: variable ``DISPLAY''.
        !           353: One can, however specify them explicitly.
        !           354: The
        !           355: .I host
        !           356: specifies which machine to create the window on, and
        !           357: the
        !           358: .I display
        !           359: argument specifies the display number.
        !           360: For example,
        !           361: ``orpheus:1'' creates a shell window on display one on the machine
        !           362: orpheus.
        !           363: .SH "X DEFAULTS"
        !           364: .I Xterm
        !           365: allows you to preset defaults in a customization file in your home
        !           366: directory, called
        !           367: .BR .Xdefaults .
        !           368: The format of the file is ``programname.keyword:string''.
        !           369: See
        !           370: .IR X (1)
        !           371: for more details.
        !           372: .I Xterm
        !           373: obeys the convention for `MakeWindow' defaults.
        !           374: Keywords recognized by
        !           375: .I xterm
        !           376: are listed below.
        !           377: .TP 15
        !           378: .B ActiveIcon
        !           379: If ``on'',
        !           380: .I xterm
        !           381: window icons(s) are miniature windows rather than static bitmaps.
        !           382: .TP
        !           383: .B AllowIconInput
        !           384: If ``on'', then keyboard input is permitted when
        !           385: .I xterm
        !           386: windows are in their iconified state and the icon is a miniature window.
        !           387: Keyboard input is always disabled when static bitmap icons are used.
        !           388: .TP
        !           389: .B AutoRaise
        !           390: If ``on'',
        !           391: .I xterm
        !           392: window(s) are automatically raised when the mouse enters them.
        !           393: .TP
        !           394: .B Background
        !           395: Set the background color.
        !           396: .TP
        !           397: .B BodyFont
        !           398: Set the default font.
        !           399: .TP
        !           400: .B BoldFont
        !           401: Specify a default bold font.
        !           402: .TP
        !           403: .B Border
        !           404: Set the border color.
        !           405: .TP
        !           406: .B BorderWidth
        !           407: Set the border width of the window.
        !           408: .TP
        !           409: .B C132
        !           410: If ``on'', allow the DECCOLM escape sequence to switch between 80 and 132
        !           411: column mode.
        !           412: .TP
        !           413: .B Curses
        !           414: If ``on'', enable the
        !           415: .IR curses (3x)
        !           416: fix.
        !           417: .TP
        !           418: .B Cursor
        !           419: Set the text cursor color.
        !           420: .TP
        !           421: .B DeiconifyWarp
        !           422: If ``on'', warp the mouse to the center of the window after deiconification.
        !           423: .TP
        !           424: .B Foreground
        !           425: Set the text color.
        !           426: .TP
        !           427: .B IconBitmap
        !           428: Specifies the
        !           429: .IR bitmap (1)
        !           430: file to be used as the bitmap for VT102 mode icon.
        !           431: .TP
        !           432: .B IconFont
        !           433: Specify the default font for miniature window icons.  The usual value is
        !           434: ``nil2''.
        !           435: .TP
        !           436: .B IconStartup
        !           437: If ``on'', initially display the icon rather than the normal window.
        !           438: .TP
        !           439: .B InternalBorder
        !           440: Set the space between the text and window border.
        !           441: This is called padding above.
        !           442: .TP
        !           443: .B JumpScroll
        !           444: If ``on'', jump scroll is enabled.
        !           445: .\"TP
        !           446: .\"B KeyBoard
        !           447: .TP
        !           448: .B LogFile
        !           449: Specifies the log file or command to pipe to when logging is activated.
        !           450: .TP
        !           451: .B Logging
        !           452: If ``on'', turn logging on initially.
        !           453: .TP
        !           454: .B LogInhibit
        !           455: If ``on'', totally inhibit logging from being turned on.
        !           456: .TP
        !           457: .B LoginShell
        !           458: If ``on'', make the shell executed a login shell.
        !           459: .TP
        !           460: .B MarginBell
        !           461: If ``on'', turn on the margin bell.
        !           462: .TP
        !           463: .B MenuBorder
        !           464: specifies the border width for the menus. The default is 2.
        !           465: .TP
        !           466: .B MenuPad
        !           467: specifies the extra padding above and below the menu title.  The default is 3.
        !           468: .TP
        !           469: .B MenuFont
        !           470: specifies the font to be used within the menus.  The default is the same
        !           471: font used for the titlebar.
        !           472: .TP
        !           473: .B Mouse
        !           474: Set the mouse cursor color.
        !           475: .TP
        !           476: .B NMarginBell
        !           477: Set the margin bell right margin distance.
        !           478: .TP
        !           479: .B PageOverlap
        !           480: Set the page overlap in page scroll mode.
        !           481: .TP
        !           482: .B PageScroll
        !           483: If ``on'', turn on page scroll mode. 
        !           484: .TP
        !           485: .B ReverseVideo
        !           486: If ``on'', reverse the definition of foreground and background color.
        !           487: .TP
        !           488: .B ReverseWrap
        !           489: If ``on'', turn on the reverse wraparound mode.
        !           490: .TP
        !           491: .B SaveLines
        !           492: Set the number of lines to save when scrolled of the top of the window.
        !           493: .TP
        !           494: .B ScrollBar
        !           495: If ``on'', show the scrollbar initially.
        !           496: .TP
        !           497: .B ScrollInput
        !           498: If ``on'', reposition the scroll region at the bottom if
        !           499: new input has arrived.
        !           500: .TP
        !           501: .B ScrollKey
        !           502: If ``on'', reposition the scroll region at the bottom if
        !           503: a key is pressed.
        !           504: .TP
        !           505: .B SignalInhibit
        !           506: If ``on'', totally inhibit the sending of signals from the
        !           507: .B xterm
        !           508: menu.
        !           509: .TP
        !           510: .B StatusLine
        !           511: If ``on'', show the status line on startup.
        !           512: .TP
        !           513: .B StatusNormal
        !           514: If ``on'', make the status line normal video.
        !           515: .TP
        !           516: .B TekIconBitmap
        !           517: Specifies the
        !           518: .IR bitmap (1)
        !           519: file to be used as the bitmap for Tektronix mode icon.
        !           520: .TP
        !           521: .B TekInhibit
        !           522: If ``on'', totally inhibit going into Tektronix mode.
        !           523: .TP
        !           524: .B TextUnderIcon
        !           525: If ``on'', place the icon text under the bitmap icon.
        !           526: .TP
        !           527: .B TitleBar
        !           528: If ``on'', show the title bar on startup.
        !           529: .TP
        !           530: .B TitleFont
        !           531: Set the font of the title bar text.
        !           532: .TP
        !           533: .B VisualBell
        !           534: If ``on'', turn on visual bell mode at startup.
        !           535: .SH EMULATIONS
        !           536: The VT102 emulation is fairly complete, but does not support the blinking
        !           537: character attribute nor the double-wide and double-size character sets.
        !           538: .IR Termcap (5)
        !           539: entries that work with
        !           540: .I xterm
        !           541: include ``xterms'', ``xterm'', ``vt102'', ``vt100'' and ``ansi'', and
        !           542: .I xterm
        !           543: automatically searches the termcap file in this order for these entries and then
        !           544: sets the ``TERM'' and the ``TERMCAP'' environment variables.
        !           545: .PP
        !           546: Many of the special
        !           547: .I xterm
        !           548: features (like the scrollbar and logging) may be modified under program control
        !           549: through a set of escape sequences different from the standard VT102 escape
        !           550: sequences.
        !           551: Also, many of the Sun tty escape sequences for resizing and moving
        !           552: the window are also understood.
        !           553: (See the
        !           554: .I ``Xterm Control Sequences''
        !           555: document.)
        !           556: .PP
        !           557: The Tektronix 4015 emulation is also fairly good.
        !           558: Four different font sizes and five different lines types are supported.
        !           559: The Tektronix text and graphics commands are recorded internally by
        !           560: .I xterm
        !           561: and may be written to a file by sending the COPY escape sequence (or through
        !           562: the
        !           563: .B Tektronix
        !           564: menu; see below).
        !           565: The name of the file will be
        !           566: ``\fBCOPY\fIyy\fB\-\fIMM\fB\-\fIdd\fB.\fIhh\fB:\fImm\fB:\fIss\fR'', where
        !           567: .IR yy ,
        !           568: .IR MM ,
        !           569: .IR dd ,
        !           570: .IR hh ,
        !           571: .I mm
        !           572: and
        !           573: .I ss
        !           574: are the year, month, day, hour, minute and second when the COPY was performed
        !           575: (the file is created in the directory
        !           576: .I xterm
        !           577: is started in, or the home directory for a login
        !           578: .IR xterm ).
        !           579: .SH "MOUSE USAGE"
        !           580: .PP
        !           581: When using the mouse to create the VT102 window, a cursor and
        !           582: a rubber banding box will outline where the window will be created on
        !           583: the display.
        !           584: If the left button is pressed, a HEIGHTxWIDTH (default 24x80)
        !           585: size window will be created at the position where the button is released.
        !           586: If the right button is pressed, a window the height of the display and
        !           587: WIDTH (default 80) characters wide will be created.
        !           588: If the center button is pressed and held down, the upper left hand corner
        !           589: of the window is defined at this position.
        !           590: An outline of the minimum size window is shown, and a popup window in
        !           591: the upper left hand corner of the display will show the size in characters
        !           592: of the window.
        !           593: Moving the mouse (while still holding the button down) will enlarge the
        !           594: window and the sizes in the pop up window will update accordingly.
        !           595: Releasing the button will define the lower right hand corner
        !           596: of the window.
        !           597: .PP
        !           598: Once the VT102 window is created,
        !           599: .I xterm
        !           600: allows you to save text and restore it within the same or other windows.
        !           601: The button functions are enabled when holding down the ``shift'' key.
        !           602: The left hand button takes the text from the cursor (at button release)
        !           603: through the end of line (including the new line), saves it in the global cut
        !           604: buffer, and immediately `retypes' the line, inserting it as keyboard input.
        !           605: This provides a history mechanism.
        !           606: The selected text is highlighted while the button is pressed.
        !           607: Moving off the initial line will cancel the selection.
        !           608: If there is no text beyond the initial cursor point,
        !           609: .I xterm
        !           610: will sound the bell, indicating an error.
        !           611: .PP
        !           612: The shifted center button is used to save text into the cut buffer.
        !           613: Move the cursor to beginning of the text,
        !           614: and then hold the button down while moving the cursor to the end of the region
        !           615: and releasing the button.
        !           616: The selected text is highlighted and is saved in the global cut buffer when
        !           617: the button is released.
        !           618: .PP
        !           619: The shifted right hand button `types' (pastes) the text from the cut buffer,
        !           620: inserting it as keyboard input.
        !           621: By cutting and pasting pieces of text without trailing new lines,
        !           622: you can take text from several places in different windows and form a command
        !           623: to the shell, for example, or take output from a program and insert it into
        !           624: your favorite editor.
        !           625: Since the cut buffer is globally shared among different applications,
        !           626: you should regard it as a `file' whose contents you know.
        !           627: The terminal emulator and other text programs should be treating it as if it
        !           628: were a text file, i.e. the text is delimited by new lines.
        !           629: .PP
        !           630: The scrollbar is composed of three parts, the scroll button at the top, the
        !           631: recorder button in the middle and the scroll region at the bottom.
        !           632: Pressing the middle button in any part of the scrollbar will display the
        !           633: scrollbar menu; see the
        !           634: .B MENUS
        !           635: section below.
        !           636: .PP
        !           637: The scroll region displays the position and amount of text currently showing
        !           638: in the window (highlighted) relative to the amount of text actually saved.
        !           639: As more text is saved (up to the maximum), the size of the highlighted area
        !           640: decreases.
        !           641: Clicking the mouse with the left of right button in the scroll region will
        !           642: position the top of the display window at the mouse position.
        !           643: .PP
        !           644: The recorder button shows the state of saving lines scrolled off the top
        !           645: of the window.
        !           646: Tape running reel to reel indicates on, while the tape hanging indicates off.
        !           647: Clicking the left or right button in the recorder button toggles the state of
        !           648: recording.
        !           649: .PP
        !           650: The scroll button causes the window to scroll up and down within the saved text.
        !           651: The left button moves the window position up (the text scrolls downward), while
        !           652: the right button moves the window position down (the text scrolls upward).
        !           653: The amount of scrolling is modified by the ``shift'' and ``control'' keys.
        !           654: Without either, the window scrolls a single line at a time.
        !           655: Continuing to hold the button down will causes the text to continuously
        !           656: scroll a line at a time.
        !           657: .PP
        !           658: The ``shift'' key causes the text to scroll a window full at a time (actually
        !           659: it is one line less than a full window).
        !           660: And the ``control'' key causes the text to be positioned at the extremes,
        !           661: top or bottom.
        !           662: .PP
        !           663: When using the mouse to create the Tektronix window, a cursor and
        !           664: a rubber banding box will outline where the window will be created on
        !           665: the display.
        !           666: If the left button is pressed, a default size window (750 pixels wide by
        !           667: 565 pixel high) is created at the origin.
        !           668: If the right button is pressed, a default size window is created
        !           669: at the mouse position.
        !           670: If the center button is pressed and held down, the upper left hand corner
        !           671: of the window is defined at this position.
        !           672: An outline of the minimum size window is shown, and a popup window in
        !           673: the upper left hand corner of the display will appear, indicating Tektronix
        !           674: mode.
        !           675: Moving the mouse (while still holding the button down) will enlarge the
        !           676: window.
        !           677: Releasing the button will define the lower right hand corner
        !           678: of the window.
        !           679: .PP
        !           680: Unlike the VT102 window, the Tektronix window dows not allow the copying of
        !           681: text.
        !           682: It does allow Tektronix GIN mode, and in this mode
        !           683: the cursor will change from an arrow to a cross.
        !           684: Pressing any key will send that key and the current coordinate of the
        !           685: cross cursor.
        !           686: Pressing the left, middle or right button will return the letters `l', `m', and
        !           687: `r', respectively.
        !           688: If the `shift' key is pressed when a mouse buton is pressed, the corresponding
        !           689: upper case letter is sent.
        !           690: To distinquish a mouse button from a key, the high bit of the character is
        !           691: set (but this is bit is normally stripped unless the terminal mode is RAW;
        !           692: see
        !           693: .IR tty (4)
        !           694: for details).
        !           695: .SH MENUS
        !           696: .I Xterm
        !           697: has five different menus, named
        !           698: .BR xterm ,
        !           699: .BR Modes ,
        !           700: .BR Tektronix ,
        !           701: .B Scrollbar
        !           702: and
        !           703: .BR Windows .
        !           704: Each menu pops up under the correct combinations of key and button presses.
        !           705: Most menus are divided into two section, separated by a horizontal line.
        !           706: The top portion contains various modes that can be altered.
        !           707: A check mark appears next to a mode that is currently active.
        !           708: Selecting one of these modes toggles its state.
        !           709: The bottom portion of the menu are command entries; selecting one of these
        !           710: performs the indicated function.
        !           711: .PP
        !           712: The
        !           713: .B xterm
        !           714: menu pops up when the ``control'' key and the left button is pressed in a
        !           715: window.
        !           716: The menu title gives the version number of
        !           717: .IR xterm .
        !           718: The modes section contains items that apply to both the VT102 and Tektronix
        !           719: windows.
        !           720: Notable entries in the command section of the menu are the
        !           721: .BR Continue ,
        !           722: .BR Suspend ,
        !           723: .BR Interrupt ,
        !           724: .BR Hangup ,
        !           725: .B Terminate
        !           726: and
        !           727: .B Kill
        !           728: which sends the SIGCONT, SIGTSTP, SIGINT, SIGHUP, SIGTERM and
        !           729: SIGKILL signals, respectively, to the process group of the process running
        !           730: under
        !           731: .I xterm
        !           732: (usually the shell).
        !           733: The
        !           734: .B Continue
        !           735: function is especially useful if the user has accidentally typed CTRL-Z,
        !           736: suspending the process.
        !           737: .PP
        !           738: The
        !           739: .B Modes
        !           740: menu sets various modes in the VT102 emulation, and is popped up with the
        !           741: ``control'' and middle button combination in the VT102 window.
        !           742: In the command section of this menu, the soft reset entry will reset
        !           743: scroll regions.
        !           744: This can be convenient when some program has left the scroll regions
        !           745: set incorrectly (often a problem when using VMS or TOPS-20).
        !           746: The full reset entry will clear the screen, reset tabs to every
        !           747: eight columns, and reset the terminal modes (such as wrap and smooth scroll)
        !           748: to there initial states just after
        !           749: .I xterm
        !           750: has finish processing the command line options.
        !           751: The
        !           752: .B Tektronix
        !           753: menu sets various modes in the Tektronix emulation, and is popped up with the
        !           754: ``control'' and middle button combination in the Tektronix window.
        !           755: The current font size is checked in the modes section of the menu.
        !           756: The
        !           757: .B PAGE
        !           758: entry in the command section clears the Tektronix window.
        !           759: .PP
        !           760: The
        !           761: .B Scrollbar
        !           762: menu is popped up when the middle button is pressed within the scrollbar.
        !           763: This menu allows several modes particular to the scrollbar to be set.
        !           764: .PP
        !           765: The
        !           766: .B Windows
        !           767: menu is not normally compiled into
        !           768: .I xterm
        !           769: as it duplicates functions that properly belong to window managers.  It
        !           770: may, however, be enabled at the discretion of your system builder.
        !           771: .PP
        !           772: If enabled, the
        !           773: .B Windows
        !           774: menu is a special menu that is popped up when the ``control'' key and
        !           775: right button are pressed.
        !           776: Listed in order of bottommost to topmost are the visible windows on the
        !           777: display that are named.
        !           778: The checked entry is the current window.
        !           779: By selecting an entry, the corresponding window is raised to the top.
        !           780: This is very useful when a particular window of interest
        !           781: is obscured by many other windows.
        !           782: .SH "OTHER FEATURES"
        !           783: .I Xterm
        !           784: automatically highlights the window border, text cursor and titlebar when the
        !           785: mouse enters the window (selected) and unhighlights them when the mouse
        !           786: leaves the window (unselected).
        !           787: If the window is the focus window, then the window is highlighted no matter
        !           788: where the mouse is.
        !           789: .PP
        !           790: The titlebar displays the name of the window in the center and on both
        !           791: sides stripes appear when the window is selected (highlighted).
        !           792: If both windows are showing, only the active window's titlebar is highlighted.
        !           793: If the left, middle or right button is pressed in the stripped section of
        !           794: the titlebar, the corresponding menu is popped up, without the need to
        !           795: hold down the ``control'' key.
        !           796: Pressing the mouse button in the center title of the titlebar causes
        !           797: the window to automatically iconify.
        !           798: Pressing a button in the icon deiconifies it.
        !           799: In addition, if input comes in while
        !           800: .I xterm
        !           801: is iconified and the icon is a static bitmap,
        !           802: a box is drawn around the icon title.
        !           803: .PP
        !           804: In VT102 mode, there are escape sequences to activate and deactivate
        !           805: an alternate screen buffer, which is the same size as the display area
        !           806: of the window.
        !           807: When activated, the current screen is saved and replace with the alternate
        !           808: screen.
        !           809: Saving of lines scrolled off the top of the window and page scroll mode
        !           810: are disabled, until the normal screen is restored.
        !           811: The
        !           812: .IR termcap (5)
        !           813: entry for
        !           814: .I xterm
        !           815: allows the visual editor
        !           816: .IR vi (1)
        !           817: to switch to the alternate screen for editing, and restore the screen
        !           818: on exit.
        !           819: .PP
        !           820: In either VT102 or Tektronix mode, there are escape sequences to change the
        !           821: title in the title bar (which will also change the name of the windows and
        !           822: icons) and to specify a new log file name.
        !           823: .PP
        !           824: By default, a miniature version of the VT102 or Tektronix window is
        !           825: displayed when
        !           826: .I xterm
        !           827: is iconified.  The choice of which miniature to display is made when
        !           828: the full window(s) are iconified; if the Tek window is chosen in the
        !           829: iconify operation, then the icon will be a miniature Tek window and if
        !           830: the VT102 window is chosen, the icon will be a miniature VT102 window.
        !           831: This choice is independent of the current mode (Tektronix/VT102).
        !           832: .PP
        !           833: As an option, the miniature window may be disabled and a bitmap of a
        !           834: small VT102 window with titlebar and scrollbar can be
        !           835: displayed in the icon when in VT102 mode, and a bitmap of a Tektronix
        !           836: window with titlebar is displayed in Tektronix mode.
        !           837: these bitmaps may be user-defined (see options above).
        !           838: .SH ENVIRONMENT
        !           839: .I Xterm
        !           840: sets the environment variables ``TERM'' and ``TERMCAP'' properly for the
        !           841: size window you have created.
        !           842: It also uses and sets the environment
        !           843: variable ``DISPLAY'' to specify which bit map display terminal to use.
        !           844: The environment variable ``WINDOWID'' is set to the X window id number
        !           845: of the
        !           846: .I xterm
        !           847: window.
        !           848: .SH "SEE ALSO"
        !           849: resize(1), X(1), pty(4), tty(4)
        !           850: .br
        !           851: .I ``Xterm Control Sequences''
        !           852: .SH BUGS
        !           853: There is currently no way for a
        !           854: .I xterm
        !           855: window not to highlight itself when the mouse cursor enter it
        !           856: while another window is the keyboard focus.
        !           857: There needs to be a dialog box to allow entry of log file name
        !           858: and the COPY file name.
        !           859: Many of the options are not resettable after
        !           860: .I xterm
        !           861: starts.
        !           862: .SH AUTHORS
        !           863: Edward Moy (Berkeley), Ralph R. Swick (MIT-Athena),
        !           864: Mark Vandevoorde (MIT-Athena), Bob McNamara (DEC-MAD),
        !           865: Jim Gettys (MIT-Athena), Bob Scheifler (MIT-LCS), Doug Mink (SAO).
        !           866: .sp
        !           867: VMS and TOPS-20 are trademarks of Digital Equipment Corporation.
        !           868: .sp
        !           869: Copyright (c) 1984, 1985, 1986 by Massachusetts Institute of Technology.
        !           870: .br
        !           871: See
        !           872: .IR X (1)
        !           873: 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.