![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to xterm.1 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [CSRG BSD Unix] / 43BSDReno / share / doc / ucs / X|
Return to xterm.1 CVS log | Up to [CSRG BSD Unix] / 43BSDReno / share / doc / ucs / X |
1.1 root 1: .TH XTERM 1 "1 January 1985" "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 (not yet completely implemented)
13: to provide a standard terminal type for programs not aware of the window
14: system directly.
15: Under 4.3BSD and Ultrix 1.2,
16: .I xterm
17: supports the terminal resizing facilities built into the system.
18: .PP
19: When started,
20: .I xterm
21: pops a small window onto the upper left corner,
22: with the size in characters and rows of the window as you size it.
23: Once the window is created, a pseudo terminal is allocated and a shell
24: is started on the slave side of the pty pair.
25: .PP
26: .I Xterm
27: understands the following options:
28: .TP 8
29: .B \-j
30: .I Xterm
31: will `jump scroll'; when
32: .I xterm
33: falls behind scrolling
34: the screen, it will move multiple lines up at once.
35: This option is disabled by Tektronix mode.
36: The VT100 escape sequences for smooth scroll can be used to enable/disable
37: this feature from a program,
38: or the `Mode Menu' can be used to set it interactively.
39: .TP 8
40: .B \-fn \fIfont\fP
41: The specified
42: .I font
43: will be used instead of the default font (which is vtsingle).
44: Any fixed width font may be used.
45: .PP
46: .TP 8
47: .B \-fb \fIfont\fP
48: The specified
49: .I font
50: will be used instead of the default bold font (which is vtbold).
51: This font must be the same height and width as the normal font.
52: .PP
53: .TP 8
54: .B =\fIgeometry\fP
55: \fIXterm\fP will take a normal X geometry specification.
56: This takes the form of ``=\fIwidth\fPx\fIheight\fP+\fIxoff\fP+\fIyoff\fP''.
57: See \fIX(1)\fP for details of this specification.
58: .PP
59: .TP 8
60: .B \fIhost\fP:\fIdisplay\fP
61: Normally,
62: .I xterm
63: gets the host and display number to use from the environment
64: variable ``DISPLAY''. One can, however specify them explicitly.
65: The
66: .I host
67: specifies which machine to create the window on, and
68: the
69: .I display
70: argument specifies the display number.
71: For example,
72: ``orpheus:1'' creates a shell window on display one on the machine
73: orpheus.
74: .PP
75: .TP 8
76: .B \-n \fIwindowname\fP
77: Allows you to set the name of the window for use by a window manager.
78: .PP
79: .TP 8
80: .B \-bw \fIborderwidth\fP
81: Allows you to specify the width of the window border in pixels.
82: .TP 8
83: .B \-b \fIborder\fP
84: .I Xterm
85: maintains an inner border (distance between characters and the window's
86: border) of one pixel. The \fB-b\fP option allows you to set the size of this
87: border to
88: .I border.
89: .PP
90: .TP 8
91: .B \-rv
92: The screen will be displayed with white characters on a black background,
93: rather than the default black on white.
94: .PP
95: .TP 8
96: .B \-fg \fIcolor\fP
97: On color displays, determines the color of the text.
98: .PP
99: .TP 8
100: .B \-bg \fIcolor\fP
101: On color displays, determines the color of the background.
102: .PP
103: .TP 8
104: .B \-bd \fIcolor\fP
105: On color displays, determines the color of the border.
106: .PP
107: .TP 8
108: .B \-cr \fIcolor\fP
109: On color displays, determines the color of the text cursor; default is the
110: text color.
111: .PP
112: .TP 8
113: .B \-ms \fIcolor\fP
114: On color displays, determines the color of the mouse cursor; default is the
115: text cursor color.
116: .PP
117: .TP 8
118: .B \-i
119: asks
120: .I xterm
121: to maintain a bitmap icon, rather than relying on a window manager for
122: an icon (see \fIxwm(1)\fP).
123: .PP
124: .TP 8
125: .B \-t
126: selects
127: .I Tektronix 4010
128: emulation in addition to normal vt102 emulation. In this mode, the
129: default font is 6x10 and the default window size is 39x85. If a key is
130: hit during Tektronix graphics output, the display may become garbled
131: (just like a real Tektronix). The default screen size using the default
132: font is one-fourth the resolution of a Tektronix 4010; therefore, some
133: graphics may have discontinuities or may be suppressed entirely.
134: Furthermore, the font initially selected approximately represents the
135: standard Tektronix font, at best. If the window is subsequently enlarged
136: or reduced, the font appears to shrink or grow, respectively. Resizing
137: the window also affects resolution, and if the aspect ratio
138: (height/width) is altered, Tektronix graphics will be restricted to the
139: largest box with a 4010's aspect ratio that will fit in the window.
140: This box is located in the upper left area of the window. Text which
141: is part of Tektronix graphics output may not be cut (see MOUSE USAGE).
142: .PP
143: .TP 8
144: .B \-e command arguments
145: The specified
146: .I command
147: will be executed in the window, rather than
148: starting a shell.
149: The command and and optional arguments must appear last on the xterm command
150: line.
151: .PP
152: .TP 8
153: .B \-s
154: When this option is specified, xterm no longer scrolls synchronously
155: with the display.
156: \fIXterm\fP no longer attempts to keep the screen completely up to date while
157: scrolling, but can then run faster when network latencies are very high.
158: This is typically useful when using \fIxterm\fP across a very large internet
159: or many hops.
160: .PP
161: .TP 8
162: .B \-L
163: indicates that
164: .I xterm
165: is being called by \fIinit(8)\fP, and should presume that its file descriptors
166: are already open on a slave pseudo-tty, and that \fIgetty\fP should be
167: run rather than the user's shell. This option should only be used by \fIinit\fP.
168: .SH "MOUSE USAGE"
169: When using the mouse to create the window, a cursor and
170: a rubber banding box will outline where the window will be created on
171: the display.
172: If the left button is pressed, a HEIGHTxWIDTH (default 24x80)
173: size window will be created.
174: If the right button is pressed, a window the height of the display and
175: WIDTH (default 80) characters wide will be created.
176: If the center button is pressed and held down, the upper left hand
177: corner of the window will be set to that point on the display, and
178: (while continuing to depress the center button) an outline of the window
179: will be displayed and the pop up window in the upper left corner of the
180: screen will display the size in characters of the window.
181: .PP
182: Once the window is created,
183: .I xterm
184: allows you to save text and restore it within the same or other windows.
185: The button functions are enabled when holding down the ``shift'' key.
186: The left hand button takes the text from the cursor (at button release)
187: through the end of line (including the new line), saves it in the global cut
188: buffer, and immediately `retypes' the line, inserting it as keyboard input.
189: This provides a history mechanism.
190: The center button is used to save text into the cut buffer.
191: Move the cursor to beginning of the text,
192: and then hold the button down while moving the cursor to the end of the region
193: and releasing the button. The saved text will not include the character
194: pointed by the mouse. Furthermore, it is not possible to cut text which
195: was part of Tektronix graphics output.
196: The right hand button `types' the text from the cut buffer, inserting it
197: as keyboard input.
198: By cutting and pasting pieces of text without trailing new lines,
199: you can take text from several places in different windows and form a command
200: to the shell, for example, or take output from a program and insert it into
201: your favorite editor.
202: Since the cut buffer is globally shared among different applications,
203: you should regard it as a `file' whose contents you know.
204: The terminal emulator and other text programs should be treating it as if it
205: were a text file, i.e. the text is delimited by new lines.
206: .SH X DEFAULTS
207: .PP
208: .I Xterm
209: allows you to preset defaults in a customization file in your home
210: directory, called \fI.Xdefaults\fP.
211: The format of the file is ``programname.keyword:string''.
212: See \fIX(1)\fP for more details.
213: .I Xterm
214: obeys the convention for `MakeWindow' defaults.
215: Keywords recognized by
216: .I xterm
217: are listed below.
218: .PP
219: .TP 8
220: .B JumpScroll
221: If ``on'' jump scroll is enabled.
222: .PP
223: .TP 8
224: .B BodyFont
225: Set the default font.
226: .PP
227: .TP 8
228: .B InternalBorder
229: Set the space between the text and window border.
230: This is called padding above.
231: .PP
232: .TP 8
233: .B BorderWidth
234: Set the border width of the window.
235: .PP
236: .TP 8
237: .B ReverseVideo
238: If `on', reverse the definition of foreground and background color.
239: .PP
240: .TP 8
241: .B Foreground
242: Set the text color.
243: .PP
244: .TP 8
245: .B Background
246: Set the background color.
247: .PP
248: .TP 8
249: .B Border
250: Set the border color.
251: .PP
252: .TP 8
253: .B Cursor
254: Set the text cursor color.
255: .PP
256: .TP 8
257: .B Mouse
258: Set the mouse cursor color.
259: .PP
260: .TP 8
261: .B BitmapIcon
262: If `on', use a bitmap icon for this window.
263: .PP
264: .TP 8
265: .B BoldFont
266: Specify a default bold font.
267: .SH "MODE MENU"
268: .I Xterm
269: has a menu for changing the modes of the terminal.
270: The appearance of the menu is controlled by the defaults defined
271: in the \fIXMenu(3x)\fP manual page.
272: If you hold the ``control'' key down and press the middle mouse button,
273: a pop-up menu appears.
274: When you let up on the mouse button, the operation will be invoked.
275: You can set the following modes of the emulator:
276: ``Smooth Scroll'' vs. ``Jump Scroll'',
277: ``Reverse Video'' vs. ``Normal Video'',
278: ``no wrap'' vs. ``auto wrap'',
279: ``auto linefeed'' vs. ``normal linefeed'',
280: ``application cursors'' vs. ``normal cursors'',
281: ``application pad'' vs. ``numeric pad'',
282: and you can either ``soft reset'' or ``hard reset'' the emulator.
283: .PP
284: The scroll entry lets you control the scrolling behavior of the
285: emulator as defined above.
286: The video entry lets you change from normal to reverse video and back.
287: The wrap entry lets you change to wrap at end of line or truncate at end
288: of line.
289: The linefeed entry lets you determine whether the emulator should
290: provide a linefeed when the line wraps.
291: The cursors entry lets you determine which escape sequences are generated
292: by the cursor keys.
293: The pad entry lets you determine if the numeric keypad should generate
294: escape sequences or if it should generate numbers.
295: The soft reset entry will reset scroll regions.
296: This can be convenient when some program has left the scroll regions
297: set incorrectly (often a problem when using VMS or TOPS-20).
298: The full reset entry will clear the screen, reset tabs to every
299: eight columns, and reset the terminal modes to wrap and smooth scroll.
300: .SH ENVIRONMENT
301: .I Xterm
302: sets the environment variables ``TERM'' and ``TERMCAP'' properly for the
303: size window you have created. It also uses and sets the environment
304: variable ``DISPLAY'' to specify which bit map display terminal to use.
305: .SH "SEE ALSO"
306: resize(1), xwm(1), X(1), pty(4), XMenu(3x)
307: .SH DIAGNOSTICS
308: The
309: .B \-d
310: flag turns on reporting of not understood escape sequences.
311: .SH BUGS
312: Does not perfectly emulate a VT102 (though it is pretty close).
313: While the 4010 emulation is as complete as we wish to make it,
314: the Tektronix 4014 emulation is incomplete.
315: Many applications will run.
316: The display list for the Tektronix emulator needs more work.
317: .SH AUTHORS
318: Mark Vandevoorde (MIT-Athena), Bob McNamara (DEC-MAD),
319: Jim Gettys (MIT-Athena), Bob Scheifler (MIT-LCS), Doug Mink (SAO),
320: Jordan Hubbard (Berkeley).
321: .sp
322: VMS and TOPS-20 are trademarks of Digital Equipment Corporation.
323: .sp
324: Copyright (c) 1984, 1985, 1986 by Massachusetts Institute of Technology.
325: .br
326: See \fIX(1)\fP for a full copyright notice.
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.