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

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

unix.superglobalmegacorp.com

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