Link with C++ linker
[oweals/cde.git] / cde / programs / dtterm / dtterm.1
1 .\" $XConsortium: dtterm.1 /main/4 1996/10/29 15:40:28 drk $
2 '\" t
3 .de LI
4 .\" simulate -mm .LIs by turning them into .TPs
5 .TP \\n()Jn
6 \\$1
7 ..
8 .TH dtterm 1 "21 Apr 1994"
9 .BH "21 Apr 1994"
10 .\" CDE Common Source Format, Version 1.0.0
11 .\" *************************************************************************
12 .\" **  (c) Copyright 1993, 1994 Hewlett-Packard Company
13 .\" **  (c) Copyright 1993, 1994 International Business Machines Corp.
14 .\" **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
15 .\" **  (c) Copyright 1993, 1994 Novell, Inc.
16 .\" *************************************************************************
17 .SH NAME
18 dtterm \(mi emulate a terminal window
19 .SH SYNOPSIS
20 .ft 3
21 .fi
22 .na
23 dtterm
24 [\(+-132]
25 [\(+-aw]
26 [\(mibackground\0\f2background_color\fP]
27 [\(mibd\0\f2border_color\fP]
28 [\(mibg\0\f2background_color\fP]
29 [\(mibordercolor\0\f2border_color\fP]
30 [\(miborderwidth\0\f2border_width\fP]
31 [\(+-bs]
32 [\(mibw\0\f2border_width\fP]
33 [\(miC]
34 [\(midisplay\0\f2display_name\fP]
35 [\(mie\0\f2program_argument\0...\fP]
36 [\(mifb\0\f2fontset\fP]
37 [\(mifg\0\f2foreground_color\fP]
38 [\(mifn\0\f2fontset\fP]
39 [\(mifont\0\f2fontset\fP]
40 [\(miforeground\0\f2foreground_color\fP]
41 [\(migeometry\0\f2geometry_string\fP]
42 [\(mihelp]
43 [\(+-iconic]
44 [\(+-j]
45 [\(+-kshMode]
46 [\(+-l]
47 [\(milf\0\f2file_name\fP]
48 [\(+-ls]
49 [\(+-map]
50 [\(+-mb]
51 [\(mims\0\f2pointer_color\fP]
52 [\(miname\0\f2prog_name\fP]
53 [\(minb\0\f2number\fP]
54 [\(+-rw]
55 [\(miS\0\f2ccn\fP]
56 [\(miS\0\f2c.n\fP]
57 [\(+-sb]
58 [\(+-sf]
59 [\(misl\0\f2screens\fP[s\|\|\(bv\|\|l]]
60 [\(miti\0\f2term_id\fP]
61 [\(mititle\0\f2title_string\fP]
62 [\(mitm\0\f2term_modes\fP]
63 [\(mitn\0\f2term_name\fP]
64 [\(miusage]
65 [\(+-vb]
66 [\(miw\0\f2border_width\fP]
67 [\(mixrm\0\f2resource_string\fP]
68 .PP
69 .fi
70 .SH DESCRIPTION
71 The
72 .BR dtterm 
73 utility provides runtime support of legacy applications
74 written for terminals conforming to \f3ANSI X3.64-1979\fP and
75 \f3ISO 6429:1992(E)\fP, such as the DEC VT220.
76 .SH OPTIONS
77 The following options are available:
78 .PP
79 .RS 3
80 .nr )J 6
81 .LI \f3\(mi132\fP
82 Recognize the
83 .BR \s-1DECCOLM\s+1
84 escape sequence and resize the window appropriately.
85 Normally,
86 .BR dtterm 
87 ignores the
88 .BR \s-1DECCOLM\s+1
89 escape sequence, which
90 switches between 80- and 132-column mode.
91 .LI \f3\+132\fP
92 Ignore the
93 .BR \s-1DECCOLM\s+1
94 escape sequence.
95 This is the default behavior.
96 .LI \f3\(miaw\fP
97 Allow auto-wraparound.
98 This option allows the cursor to automatically wrap to the beginning of the next
99 line when it is at the right-most position of a line and text is output.
100 This is the default behavior.
101 .LI \f3\+aw\fP
102 Do not allow auto-wraparound.
103 .LI "\f3\(mibackground\fP\0\f2background_color\fP"
104 .br
105 Specify the terminal window background
106 and the default background for the
107 scroll bar and the X11 pointer cursor.
108 This option defaults to either the primary colorset
109 background or select (default) pixel (see
110 .BR \(mibs ).
111 (When not running under HPVUE,
112 it defaults to
113 .B *background/*Background
114 with an ultimate fallback color of black.)
115 The
116 .I background_color
117 argument describes the background color.
118 .LI "\f3\(mibd\fP\0\f2border_color\fP"
119 .br
120 Specify the border color for all windows.
121 The shell widget's window border need not be visible
122 when re-parenting window managers, such as
123 .BR vuewm (1X),
124 and
125 .BR mwm (1X),
126 are used.
127 The default is the color black.
128 The
129 .I border_color
130 argument describes the border color.
131 .LI "\f3\(mibg\fP\0\f2background_color\fP"
132 .br
133 Equivalent to
134 .BR \(mibackground .
135 The
136 .I background_color
137 argument describes the background color.
138 .LI "\f3\(mibordercolor\fP\0\f2border_color\fP"
139 .br
140 Equivalent to
141 .BR \(mibd .
142 The
143 .I border_color
144 argument describes the border color.
145 .LI "\f3\(miborderwidth\fP\0\f2border_width\fP"
146 .br
147 Specify the border width of the shell widget's window.
148 This value may be overridden by re-parenting window managers.
149 The default is zero.
150 The
151 .I border_width
152 argument specifies the width of the window border in pixels.
153 .LI \f3\(mibs\fP
154 Use the Motif
155 select color instead of the background color for the terminal window's
156 background color.
157 This is the default behavior.
158 .LI \f3\+bs\fP
159 Do not use the Motif
160 select color instead of the background color for the terminal window's
161 background color.
162 .LI "\f3\(mibw\fP\0\f2border_width\fP"
163 .br
164 Equivalent to
165 .BR \(miborderwidth .
166 The
167 .I border_width
168 argument specifies the width of the window border in pixels.
169 .LI \f3\(miC\fP
170 Specify that output directed to
171 .B /dev/console
172 be directed instead to the terminal window.
173 It is provided as a way to prevent output,
174 which would normally be displayed on the
175 internal terminal emulator (ITE), from overwriting the X server's display.
176 It is not provided as a general purpose mechanism to direct the output from
177 an arbitrary system's
178 .B /dev/console
179 to an arbitrary X server.
180 Ownership of, and read-write permission for,
181 .B /dev/console
182 is required in order to redirect console output.
183 .LI "\f3\(midisplay\fP\0\f2display_name\fP"
184 .br
185 Specify the X11 display server.
186 This defaults to the
187 .I DISPLAY
188 environment variable.
189 The
190 .I display_name
191 argument specifies the X11 display to which
192 .BR dtterm 
193 connects.
194 .LI "\f3\(mie\fP\0\f2program_argument ...\fP"
195 .br
196 Specify an executable program and any command-line arguments
197 .BR dtterm 
198 invokes as a subprocess when
199 .BR dtterm 
200 is started.
201 It must be the last option on the command line.
202 The
203 .I program_argument
204 arguments specify the program
205 and any command-line arguments
206 to be invoked by
207 .BR dtterm .
208 .LI "\f3\(mifb\fP\0\f2fontset\fP"
209 .br
210 Specify an
211 .B XFontSet
212 used by
213 .BR dtterm 
214 when displaying bold terminal text.
215 The
216 .B XFontSet
217 should be specified as a Motif
218 .BR XmFontList (3X).
219 The terminal emulator supports only character or mono-spaced fonts.
220 When using proportional fonts, the behavior is undefined.
221 The terminal emulator generates a default bold font based on the
222 XLFD
223 name of the
224 .BR userFont .
225 If that font is not available,
226 the terminal emulator
227 generates bold text
228 by overstriking (with a one pixel offset) the
229 .BR userFont .
230 The
231 .I fontset
232 argument specifies the bold terminal
233 .B XFontSet
234 used by
235 .BR dtterm .
236 .LI "\f3\(mifg\fP\0\f2foreground_color\fP"
237 .br
238 Specify the foreground color of the terminal window as
239 well as the default foreground color
240 used by
241 .BR dtterm 
242 for the scroll bar and the
243 for the X11 pointer cursor.
244 This option defaults to either the primary colorset
245 foreground (default) or select pixel.
246 (When not running under HPVUE,
247 it defaults to
248 .B *foreground/*Foreground
249 with an ultimate fallback color of white.)
250 The
251 .I foreground_color
252 argument specifies the foreground color.
253 .LI "\f3\(mifn\fP\0\f2fontset\fP"
254 .br
255 Specify an
256 .B XFontSet
257 used by
258 .BR dtterm 
259 when displaying terminal text.
260 It should be specified as a Motif
261 .BR XmFontList (3X).
262 Only character or mono-spaced fonts are supported.
263 When using proportional fonts, the behavior is undefined.
264 This font is not used to display non-terminal text (such as menu bar, popup
265 menus or dialogs).
266 The default uses the
267 .B XmNtextFontList
268 value of the parent bulletin
269 board (see the XmBulletinBoard widget)
270 in the same manner as the XmText widget.
271 The
272 .I fontset
273 argument specifies the terminal
274 .BR XFontSet .
275 .LI "\f3\(mifont\fP\0\f2fontset\fP"
276 .br
277 Equivalent to
278 .BR \(mifn .
279 The
280 .I fontset
281 argument specifies the terminal
282 .BR XFontSet .
283 .LI "\f3\(miforeground\fP\0\f2foreground_color\fP"
284 .br
285 Equivalent to
286 .BR \(mifg .
287 The
288 .I foreground_color
289 argument specifies the foreground color
290 used by
291 .BR dtterm .
292 .LI "\f3\(migeometry\fP\0\f2geometry_string\fP"
293 .br
294 Specify the terminal window's preferred size and position.
295 Width and height are expressed in characters.
296 The default size is 24 lines of 80 characters each.
297 There is no default position.
298 The
299 .I geometry_string
300 argument specifies the terminal geometry
301 used by
302 .BR dtterm .
303 .LI \f3\(mihelp\fP
304 .br
305 Display a message summarizing
306 .BR dtterm 
307 usage.
308 .LI \f3\(miiconic\fP
309 .br
310 Display the terminal emulator initially in an iconified state.
311 .LI \f3\+iconic\fP
312 .br
313 Display the terminal emulator initially as a normal window.
314 This is the default behavior.
315 .LI \f3\(mij\fP
316 Use jump scrolling.
317 With jump scrolling, the screen may be scrolled more than one line at a time.
318 This provides for faster screen updates when multiple lines of text are sent
319 to the terminal.
320 The maximum number of lines that may be
321 jump scrolled is limited to the number of lines in the terminal window.
322 The
323 .BR dtterm 
324 terminal emulator guarantees that all lines are displayed.
325 This is the default behavior.
326 .LI \f3\+j\fP
327 Do not use jump scrolling.
328 .LI \f3\(mikshMode\fP
329 .br
330 Enable
331 .BR ksh 
332 mode.
333 In
334 .BR ksh 
335 mode, a key pressed with the extend modifier bit set generates an
336 escape character followed by the character generated by the un-extended
337 keystroke.
338 This option is provided for use with
339 .BR emacs (1)
340 and the emacs
341 command-line editor mode of
342 .BR ksh (1)
343 or
344 .BR ied (1).
345 This option is provided for use with
346 .BR emacs 
347 command-line editor mode of
348 .BR ksh (1).
349 It conflicts with the
350 normal meta key use for generating extended single byte
351 characters and for generating multi-byte Asian characters.
352 .LI \f3\+kshMode\fP
353 .br
354 Do not enable
355 .BR ksh (1)
356 mode.
357 This is the default behavior.
358 .LI \f3\(mil\fP
359 Enables output logging.
360 When
361 .BR dtterm 
362 enables logging, all output received from the subprocess is
363 logged either to a file or to a command pipeline (as specified via the
364 .B \(milf
365 option described in the following paragraph).
366 Since data are logged directly from the subprocess, the log file includes
367 all escape characters and carriage-return and newline pairs the terminal
368 line discipline sends.
369 The application may enable and disable logging via escape sequences.
370 .LI \f3\+l\fP
371 Disable output logging.
372 This is the default behavior.
373 .LI "\f3\(milf\fP\0\f2file_name\fP"
374 .br
375 Name the file to which
376 .BR dtterm 
377 writes the output log.
378 If the
379 .I file_name
380 argument begins with a pipe symbol
381 (\||\|),
382 .BR dtterm 
383 assumes the rest of the string to be a command
384 to be used as the endpoint of a pipe.
385 If the
386 .I file_name
387 argument ends in
388 .BR \s-1XXXXX\s+1 ,
389 the last five characters are replaced with
390 .BR dtterm 's
391 process ID.
392 The default file name is
393 .B DttermLogXXXXX
394 and is created in the directory
395 from which the subprocess was started.
396 The
397 .I file_name
398 argument specifies the log file name
399 used by
400 .BR dtterm 
401 for logging.
402 .LI \f3\(mils\fP
403 Start a login shell (the first character of
404 .IR argv [0]
405 is a dash), indicating
406 to the shell that it should read the system's
407 .B profile
408 and the user's
409 .B \&.profile
410 files
411 (for
412 .BR ksh (1)
413 and
414 .BR sh (1)),
415 or the system's
416 .B csh.login
417 and the user's
418 .B \&.login
419 (for
420 .BR csh (1)).
421 .LI \f3\+ls\fP
422 Start a normal (non-login) shell.
423 This is the default behavior.
424 .LI \f3\(mimap\fP
425 Map (de-iconify)
426 .BR dtterm 
427 upon subprocess output if
428 .BR dtterm 
429 is unmapped (iconified).
430 The user can specify, via the
431 .B mapOnOutputDelay
432 resource,
433 an initial period of time during which
434 .BR dtterm 
435 does not map itself upon
436 subprocess output.
437 .LI \f3\+map\fP
438 Indicate there is no special mapping behavior.
439 This is the default behavior.
440 .LI \f3\(mimb\fP
441 Ring a bell when
442 the user types at a specified distance from the right margin.
443 The distance from the
444 right margin is specified by the
445 .B \(minb
446 option.
447 .LI \f3\+mb\fP
448 Do not ring a bell when the user types near the right margin.
449 This is the default behavior.
450 .LI "\f3\(mims\fP\0\f2pointer_color\fP"
451 .br
452 Specify the foreground color
453 used by
454 .BR dtterm 
455 for the terminal
456 window's (X11) pointer cursor.
457 The default is the terminal
458 window's foreground color (see
459 .BR \(miforeground ).
460 The
461 .I pointer_color
462 argument specifies the pointer foreground color
463 used by
464 .BR dtterm .
465 .LI "\f3\(miname\fP\0\f2prog_name\fP"
466 .br
467 Specify the X11 name of the
468 .BR dtterm 
469 window.
470 The
471 .I prog_name
472 argument specifies the name to use.
473 .LI "\f3\(minb\fP\0\f2number\fP"
474 .br
475 Ring the bell this number of characters from the right
476 margin when enabled.
477 The default is 10.
478 The
479 .I number
480 argument specifies the number of characters.
481 .LI \f3\(mirw\fP
482 Enable reverse-wraparound.
483 .LI \f3\+rw\fP
484 Do not enable reverse-wraparound.
485 This is the default behavior.
486 .LI \f3\(miS\fP\f2ccn\fP
487 .br
488 Run the terminal emulator against a pre-opened
489 .B pty
490 or STREAMS
491 pseudo-terminal device.
492 The terminal emulator provides this option to use when the
493 pseudo-terminal device name is of the form
494 .B tty??
495 (that is, exactly two characters following the
496 .BR tty ).
497 This option is intended for use when
498 .BR dtterm 
499 is programmatically invoked from within another application.
500 The
501 .I cc
502 argument specifies the last two characters of the
503 pseudo-terminal device's slave name where the
504 pseudo-terminal device slave name is of the form
505 .BR tty?? .
506 This value is ignored, but must be exactly two characters in length.
507 The
508 .I n
509 argument specifies the file descriptor number that corresponds to the
510 pseudo-terminal device's already opened master side.
511 .LI \f3\(miS\fP\f2c.n\fP
512 .br
513 Equivalent to \f3\(miS\fP\f2ccn\fP,
514 but provided for systems with a larger
515 pseudo-terminal device name space.
516 The
517 .I c
518 argument specifies the last component of the
519 pseudo-terminal device slave name.
520 The terminal emulator ignores this value and the value may be empty.
521 The
522 .I n
523 argument specifies the number of the file descriptor that corresponds to the
524 pseudo-terminal device's already opened master side.
525 .LI \f3\(misb\fP
526 Display a scroll bar.
527 This is the default behavior.
528 .LI \f3\+sb\fP
529 Do not display a scroll bar.
530 .LI \f3\(misf\fP
531 Generate Sun Function Key escape sequences instead of
532 standard ANSI escape sequences
533 for the terminal's function keys.
534 .LI \f3\+sf\fP
535 Generate
536 standard ANSI escape sequences
537 instead of Sun Function Key escape sequences for the terminal's function keys.
538 This is the default behavior.
539 .LI "\f3\(misl\fP\0\f2screens\fP[\f3s|l\fP]"
540 .br
541 Specify the number of lines in the terminal buffer beyond the
542 length of the window.
543 The option value consists of a number followed by
544 an optional suffix.
545 If no suffix is included or the suffix is ``l'' (ell), the
546 total length of the terminal buffer is
547 .I screens
548 plus the length of
549 the terminal window.
550 If the suffix is ``s'' (ess) the total length of the
551 terminal buffer is (\c
552 .IR screens +1)
553 times the length of the terminal window.
554 The
555 .BR dtterm 
556 utility attempts to maintain the same buffer-to-window
557 ratio when the window is resized larger.
558 The default is
559 .BR 4s .
560 The
561 .I screens
562 argument specifies the number of screens or lines to save.
563 .LI "\f3\(miti\fP\0\f2term_id\fP"
564 .br
565 Specify the name used by
566 .BR dtterm 
567 to select the correct response to terminal ID queries.
568 Valid values are
569 .BR vt100 ,
570 .BR vt101 ,
571 .BR vt102 ,
572 and
573 .BR vt220 .
574 The default is
575 .BR vt220 .
576 The
577 .I term_id
578 argument specifies the terminal ID to use.
579 .LI "\f3\(mititle\fP\0\f2title_string\fP"
580 .br
581 Specify the window title.
582 When used with the
583 .B \(mie
584 option, the default is the last component of the program's path;
585 otherwise, the default is the last
586 component of the name used to execute
587 .BR dtterm 
588 (that is,
589 .IR argv [0]).
590 The
591 .I title_string
592 argument specifies the title
593 used by
594 .BR dterm .
595 .LI "\f3\(mitm\fP\0\f2term_modes\fP"
596 .br
597 Specify a string containing terminal-setting keywords
598 and the characters to which they can be bound.
599 Allowable keywords include:
600 .BR intr ,
601 .BR quit ,
602 .BR erase ,
603 .BR kill ,
604 .BR eof ,
605 .BR eol ,
606 .BR swtch ,
607 .BR start ,
608 .BR stop ,
609 .BR brk ,
610 .BR susp ,
611 .BR dsusp ,
612 .BR rprnt ,
613 .BR flush ,
614 .B weras
615 and
616 .BR lnext .
617 The terminal emulator
618 correctly parses and silently ignores keywords that do not apply
619 to a specific architecture.
620 Control characters can be specified as
621 .BI ^ char
622 (for example,
623 .B ^c
624 or
625 .BR ^u ),
626 and
627 .B ^?
628 can be used to indicate Delete.
629 This is useful for overriding the default
630 terminal settings without having to do an
631 .BR stty (1)
632 every time a DtTerm widget is created.
633 The default is
634 .BR \s-1NULL\s+1 .
635 The
636 .I term_modes
637 argument specifies the terminal mode string.
638 .LI "\f3\(mitn\fP\0\f2term_name\fP"
639 .br
640 Specify a name to which
641 .BR dtterm 
642 sets the
643 .I TERM
644 environment variable.
645 The default is
646 .BR dtterm .
647 The
648 .I term_name
649 argument specifies the terminal name
650 used by
651 .BR dtterm .
652 .LI \f3\(miusage\fP
653 .br
654 Display a usage message on the screen.
655 .LI \f3\(mivb\fP
656 Use a visual bell instead of an audible one.
657 Flash the window instead of ringing the
658 terminal bell whenever a <control>\(hyG is received.
659 .LI \f3\+vb\fP
660 Use an audio bell instead of a visual one.
661 This is the default behavior.
662 .LI "\f3\(miw\fP\0\f2border_width\fP"
663 .br
664 Equivalent to
665 .BR \(miborderwidth .
666 The
667 .I border_width
668 argument specifies the width of the window border in pixels.
669 .LI "\f3\(mixrm\fP\0\f2resource_string\fP"
670 .br
671 Allow the user to specify the X11 Resource Manager-style
672 resources on the command line.
673 The
674 .I resource_string
675 argument specifies an X11 resource string.
676 (See
677 .BR XrmParseCommand (3X)
678 and
679 .BR XGetDefault (3X)
680 for more information.)
681 .PP
682 .RE
683 .nr )J 0
684 .SH OPERANDS
685 None.
686 .SH STDIN
687 Not used.
688 .SH "INPUT FILES"
689 None.
690 .SH "ENVIRONMENT VARIABLES"
691 The following environment variables affect the execution of
692 .BR dtterm :
693 .PP
694 .RS 3
695 .nr )J 15
696 .LI \f2DISPLAY\fP
697 Specify the default X Windows display to connect to (see
698 .BR \(midisplay ).
699 The terminal emulator sets the subprocess's
700 .I DISPLAY
701 environment variable to the connected X11 display name.
702 .LI \f2HOME\fP
703 Determine the user's home directory,
704 the location of configuration files.
705 .LI \f2LANG\fP
706 Provide a default value for the internationalization variables
707 that are unset or null.
708 If
709 .I LANG
710 is unset or null, the corresponding value from the
711 implementation-specific default locale will be used.
712 If any of the internationalization variables contains an invalid setting, the
713 utility behaves as if none of the variables had been defined.
714 .LI \f2LC_ALL\fP
715 If set to a non-empty string value,
716 override the values of all the other internationalization variables.
717 .LI \f2LC_MESSAGES\fP
718 Determine the locale that is used to affect
719 the format and contents of diagnostic
720 messages written to standard error
721 and informative messages written to standard output.
722 .LI \f2NLSPATH\fP
723 Determine the location of message catalogues
724 for the processing of
725 .IR LC_MESSAGES .
726 .LI \f2SHELL\fP
727 Determine the default application to run.
728 .LI \f2XAPPLRESDIR\fP
729 Specify the name of a directory that contains application-specific resources.
730 If this environment variable
731 is defined, and is set to an existing directory, then it is searched (in
732 addition to the standard locations) for files containing
733 application-specific resource specifications.
734 .LI \f2XENVIRONMENT\fP
735 .br
736 Specify the name of a resource file with
737 user- or machine-specific resources.
738 If this variable is not defined,
739 .BR dtterm 
740 looks for a file named
741 .BR $HOME/.Xdefaults- \c
742 .I hostname
743 instead,
744 where
745 .I hostname
746 is the name of the host where the application is executing.
747 .LI \f2XFILESEARCHPATH\fP
748 .br
749 Define a language-dependent location of
750 .BR app-defaults .
751 .LI \f2XMODIFIER\fP
752 Specify which input method to use.
753 .LI \f2XUSERFILESEARCHPATH\fP
754 .br
755 Control where X applications look for their
756 .B app-defaults
757 resource files.
758 The default is located in the directory
759 .BR /usr/dt/app-defaults .
760 (Under Motif without CDE, the default is
761 .BR /usr/lib/X11/app-defaults ).
762 The user must set
763 .I XUSERFILESEARCHPATH
764 if the user's resource
765 files are not in this location.
766 .PP
767 .RE
768 .nr )J 0
769 .PP
770 The terminal emulator
771 creates the following variable when it invokes another process:
772 .PP
773 .RS 3
774 .nr )J 15
775 .LI \f2COLUMNS\fP
776 .br
777 The terminal emulator sets the subprocess's
778 .I COLUMNS
779 environment variable to the number of columns present in the terminal
780 window at creation.
781 If the size of the terminal window is subsequently
782 changed the terminal emulator uses the
783 .I TIOCSWINSZ
784 .BR ioctl (\|)
785 to inform the applications running against it of the new column count.
786 Under normal use, the user's shell updates
787 .I COLUMNS
788 with the updated value.
789 .LI \f2LINES\fP
790 .br
791 The terminal emulator sets the subprocess's
792 .I LINES
793 environment variable to the number of lines present in the terminal
794 window at creation.
795 If the size of the terminal window is subsequently
796 changed, the terminal emulator uses the
797 .BR \s-1TIOCSWINSZ\s+1
798 .BR ioctl (2)
799 to inform the applications running against it of the newline count.
800 Under normal use, the user's shell updates
801 .I LINES
802 with the updated value.
803 .LI \f2TERM\fP
804 The terminal emulator sets the subprocess's
805 .I TERM
806 environment variable to the
807 .B termName
808 resource value.
809 Applications use this variable to determine the type of escape sequences to use
810 when driving the terminal emulator.
811 .LI \f2TERMINAL_EMULATOR\fP
812 .br
813 The terminal emulator sets the subprocess's
814 .I TERMINAL_EMULATOR
815 environment variable to
816 .BR dtterm 
817 to indicate that the process is running from a
818 .BR dtterm 
819 terminal emulator.
820 .LI \f2WINDOWID\fP
821 The terminal emulator sets the subprocess's
822 .I WINDOWID
823 environment variable to the window number of the window in which text
824 is rendered.
825 .PP
826 .RE
827 .nr )J 0
828 .SH RESOURCES
829 The
830 .BR dtterm 
831 utility allows the user to specify behavior through X11 resources
832 as well as the command-line interface.
833 The following is a list of the defined resources:
834 .PP
835 .ne 10
836 .DS
837 .S -1
838 .TS
839 tab(@);
840 cf3 ssss
841 lf3 1 lf3 1 lf3 1 lf3 1
842 lf3 1 lf3 1 lf3 1 l   1 .
843 The dtterm Client Resource Set
844 _
845 Name@Class@Type@Default
846 _
847 allowSendEvents@AllowSendEvents@Boolean@False
848 appCursorDefault@AppCursorDefault@Boolean@False
849 appKeypadDefault@AppKeypadDefault@Boolean@False
850 autoWrap@AutoWrap@Boolean@True
851 background@Background@String
852 .\" !!!! version/config dependent string
853 .\" !!!! normal CDE string:
854 .\" backgroundIsSelect@BackgroundIsSelect@Boolean@False
855 .\" !!!! normal VUE string:
856 backgroundIsSelect@BackgroundIsSelect@Boolean@True
857 blinkRate@BlinkRate@int@250
858 borderColor@BorderColor@String@``black''
859 borderWidth@BorderWidth@int@0
860 c132@C132@Boolean@False
861 charCursorStyle@CharCursorStyle@String@``char_cursor_box''
862 consoleMode@ConsoleMode@Boolean@False
863 foreground@Foreground@String
864 geometry@Geometry@String@NULL
865 iconic@Iconic@Boolean@False
866 iconName@IconName@String@``dtterm''
867 jumpScroll@JumpScroll@Boolean@True
868 kshMode@KshMode@Boolean@False
869 logging@Logging@Boolean@False
870 logFile@LogFile@String@``DttermLogXXXXX''
871 logInhibit@LogInhibit@Boolean@False
872 loginShell@LoginShell@Boolean@False
873 mapOnOutput@AutoMap@Boolean@False
874 mapOnOutputDelay@MapDelay@int@0
875 marginBell@MarginBell@Boolean@False
876 menuBar@MenuBar@Boolean@True
877 menuPopup@MenuPopup@Boolean@True
878 nMarginBell@NMarginBell@int@10
879 pointerBlank@PointerBlank@Boolean@False
880 pointerBlankDelay@PointerBlankDelay@int@2
881 pointerColor@Foreground@String@foreground color
882 pointerColorBackground@Background@String@background color
883 pointerShape@PointerShape@String@``xterm''
884 reverseWrap@ReverseWrap@Boolean@False
885 saveLines@SaveLines@String@4s
886 scrollBar@ScrollBar@Boolean@True
887 sunFunctionKeys@SunFunctionKeys@Boolean@False
888 termId@TermId@String@``vt220''
889 termName@TermName@String@``dtterm''
890 title@Title@String@``dtterm''
891 ttyModes@TtyModes@String@NULL
892 userBoldFont@UserBoldFont@XmFontList@dynamic
893 userFont@UserFont@XmFontList@dynamic
894 visualBell@VisualBell@Boolean@False
895 .TE
896 .S +1
897 .DE
898 .PP
899 .PP
900 .RS 3
901 .nr )J 6
902 .LI \f3allowSendEvents\fP
903 .br
904 Specifies that the terminal emulator allow
905 synthetic events (generated and sent by another application).
906 Enabling this resource opens up a possible security hole.
907 .LI \f3appCursorDefault\fP
908 .br
909 If True,
910 the cursor keys are initially in application mode.
911 If False,
912 the cursor keys are initially in cursor mode.
913 .LI \f3appKeypadDefault\fP
914 .br
915 If True,
916 the keypad keys are initially in application mode.
917 If False,
918 the keypad keys are initially in numeric mode.
919 .LI \f3autoWrap\fP
920 .br
921 Specifies whether or not auto-wraparound is initially
922 enabled.
923 .LI \f3background\fP
924 .br
925 Specifies the
926 background color of the terminal window as well as the default background
927 color for the
928 scroll bar.
929 This resource defaults to either the primary
930 colorset background
931 or select
932 pixel (see
933 .BR backgroundIsSelect ).
934 (When not being run under HPVUE,
935 this resource defaults to black.)
936 .LI \f3backgroundIsSelect\fP
937 .br
938 Specifies that the terminal window should use the Motif
939 select color instead of the background color for the terminal window's
940 background color.
941 .LI \f3blinkRate\fP
942 .br
943 Specifies the number of milliseconds the cursor is in the
944 on and off states while blinking.
945 A value of 250 blinks the cursor two times per second.
946 A value of zero turns blinking off.
947 .LI \f3borderColor\fP
948 .br
949 Specifies the border color for the window.
950 The window border
951 need not be visible when re-parenting window managers are used.
952 .LI \f3borderWidth\fP
953 .br
954 Specifies the border width of the shell widget's window.
955 This value may be overridden by re-parenting window managers.
956 .LI \f3c132\fP
957 Specifies whether or not the
958 .BR \s-1DECCOLM\s+1
959 escape sequence, which
960 switches between a 132- and 80-column window, is honored.
961 .LI \f3charCursorStyle\fP
962 .br
963 This resource specifies the shape of the text cursor.
964 A
965 .BR char_cursor_box
966 value specifies a cursor the width and height of the base
967 font's bounding box.
968 A
969 .BR char_cursor_bar
970 value specifies a cursor the
971 width of the base font's bounding box, 2 pixels high, and drawn with its
972 top on the baseline.
973 .LI \f3consoleMode\fP
974 .br
975 Specifies that output directed at
976 .B /dev/console
977 be directed instead to the terminal window.
978 It is provided as a way to
979 prevent output, that would normally be displayed on the internal terminal emulator
980 (ITE), from overwriting the X server's display.
981 It is not provided as a general mechanism to
982 direct the output from an arbitrary system's
983 .B /dev/console
984 to an arbitrary X server.
985 Ownership of, and read-write permission for,
986 .B /dev/console
987 is required in order to redirect console output.
988 .LI \f3foreground\fP
989 .br
990 Specifies the foreground of the terminal window as well as
991 the default
992 used by
993 .BR dtterm 
994 for the scroll bar and the color used for the pointer cursor.
995 This resource defaults to the primary
996 colorset foreground pixel.
997 (When not running under HPVUE,
998 this resource defaults to white.)
999 .LI \f3geometry\fP
1000 .br
1001 Specifies the terminal window's preferred size and position.
1002 The default size is 24 lines of 80 characters each.
1003 There is no default position.
1004 .LI \f3iconGeometry\fP
1005 .br
1006 Specifies the preferred position of the terminal emulator's icon.
1007 Window managers may ignore this value.
1008 There is no default.
1009 .LI \f3iconic\fP
1010 .br
1011 Specifies whether or not the terminal emulator is initially
1012 displayed in an iconified state.
1013 .LI \f3iconName\fP
1014 .br
1015 Specifies the name for the icon.
1016 When used with the
1017 .B \(mie
1018 option, the default
1019 is the last component of the program's path;
1020 otherwise,
1021 the default is the last component of the name used to execute
1022 .BR dtterm 
1023 (that is,
1024 .IR argv [0]).
1025 .LI \f3jumpScroll\fP
1026 .br
1027 Specifies that
1028 .BR dtterm 
1029 use jump scrolling.
1030 With jump
1031 scrolling, the screen may be scrolled more than one line at a time.
1032 This provides for faster screen updates when multiple lines of text are
1033 sent to the terminal.
1034 The maximum number of lines that may be
1035 jump scrolled is limited to the number of lines in the terminal window.
1036 The
1037 .BR dtterm 
1038 terminal emulator guarantees that all lines are displayed.
1039 .LI \f3kshMode\fP
1040 .br
1041 Enables ksh mode.
1042 With ksh
1043 mode, a key pressed with the extend modifier bit set generates an
1044 escape character followed by the character generated by the un-extended
1045 keystroke.
1046 This option is provided for use with
1047 .BR emacs (1)
1048 and the emacs
1049 command-line editor mode of
1050 .BR ksh (1)
1051 or
1052 .BR ied (1).
1053 This option is provided for use with the
1054 .BR emacs 
1055 command-line editor mode of
1056 .BR ksh (1).
1057 It conflicts with the
1058 normal meta key use for generating extended single byte
1059 characters and for generating multi-byte Asian characters.
1060 .LI \f3logging\fP
1061 .br
1062 Enables output logging.
1063 When logging is enabled, all
1064 output received from the subprocess is logged either to a file or to a
1065 command pipeline (as specified via the
1066 .B logFile
1067 option).
1068 Since the data is logged directly from the subprocess, it includes all
1069 escape characters and
1070 carriage-returns and newline pairs
1071 the terminal line discipline sends.
1072 Logging may be enabled and disabled via escape sequences.
1073 .LI \f3logFile\fP
1074 .br
1075 Specifies the filename to which
1076 .BR dtterm 
1077 writes the output log.
1078 If the filename begins with a pipe symbol
1079 (\||\|),
1080 .BR dtterm 
1081 assumes
1082 the rest of the string is a command to be used as the
1083 endpoint of a pipe.
1084 If the filename ends in
1085 .BR \s-1XXXXX\s+1 ,
1086 the last five characters are replaced with
1087 .BR dtterm 's
1088 process ID.
1089 The default filename is
1090 .B DttermLogXXXXX
1091 and is created in the directory from which the subprocess
1092 was started.
1093 .LI \f3logInhibit\fP
1094 .br
1095 Indicates that
1096 .BR dtterm 
1097 inhibit device and file logging.
1098 .LI \f3loginShell\fP
1099 .br
1100 Indicates that the shell that is started be a login
1101 shell (that is, the first character of
1102 .IR argv [0]
1103 is a dash), indicating
1104 that the shell should read the system's
1105 .B profile
1106 and the user's
1107 .B \&.profile
1108 files
1109 (for
1110 .BR ksh (1)
1111 and
1112 .BR sh (1))
1113 or the system
1114 .B csh.login
1115 and the user's
1116 .B \&.login
1117 (for
1118 .BR csh (1)).
1119 .LI \f3mapOnOutput\fP
1120 .br
1121 Indicates that the terminal emulator map
1122 (de-iconify) itself upon subprocess output if it is unmapped (iconified).
1123 The user can specify, via the
1124 .B mapOnOutputDelay
1125 resource,
1126 an initial period of time during which
1127 .BR dtterm 
1128 does not map itself
1129 upon subprocess output.
1130 .LI \f3mapOnOutputDelay\fP
1131 .br
1132 Specifies the number of seconds after start-up that
1133 .BR dtterm 
1134 does not honor the
1135 .B mapOnOutput
1136 resource.
1137 This allows the application to send
1138 initial output (for example, shell prompts) to the terminal without
1139 auto mapping the window.
1140 The default is zero (no delay).
1141 .LI \f3marginBell\fP
1142 .br
1143 Specifies whether or not the bell rings when the user types near
1144 the right margin.
1145 The distance from the right margin is specified by
1146 the
1147 .B nMarginBell
1148 resource.
1149 .LI \f3menuBar\fP
1150 .br
1151 Indicates that
1152 .BR dtterm 
1153 displays a pulldown menu bar.
1154 The
1155 default is True.
1156 .LI \f3menuPopup\fP
1157 .br
1158 Indicates that
1159 .BR dtterm 
1160 displays a popup menu.
1161 The
1162 default is True.
1163 .LI \f3nMarginBell\fP
1164 .br
1165 Specifies the number of characters from the right margin at which the
1166 margin bell rings, when enabled.
1167 .LI \f3pointerBlank\fP
1168 .br
1169 Specifies that
1170 .BR dtterm 
1171 puts the pointer cursor into blanking mode.
1172 In this mode, the cursor turns on when the pointer
1173 is moved, and is blanked after a selectable number of
1174 seconds or after keyboard input.
1175 The
1176 .B pointerBlankDelay
1177 resource sets the delay.
1178 .LI \f3pointerBlankDelay\fP
1179 .br
1180 Specifies the number of seconds to wait after the pointer
1181 has stopped moving before blanking the pointer (see
1182 .BR pointerBlank ).
1183 A value of zero delays pointer blanking until a key is pressed.
1184 .LI \f3pointerColor\fP
1185 .br
1186 Specifies the foreground color
1187 used by
1188 .BR dtterm 
1189 for the terminal
1190 window's pointer (X11) cursor.
1191 The default is the terminal window's foreground color (see
1192 .BR foreground ).
1193 .LI \f3pointerColorBackground\fP
1194 .br
1195 Specifies the background color
1196 used by
1197 .BR dtterm 
1198 for the terminal
1199 window's pointer (X11) cursor.
1200 The default is the terminal window's background color (see
1201 .BR background ).
1202 .LI \f3pointerShape\fP
1203 .br
1204 Specifies the X cursor font character
1205 used by
1206 .BR dtterm 
1207 as the
1208 pointer cursor.
1209 The font character must be specified as a string from the
1210 .BR <X11/cursorfont.h> 
1211 header with the leading
1212 .B XC_
1213 removed.
1214 The default is
1215 .BR xterm (1X).
1216 .LI \f3reverseWrap\fP
1217 .br
1218 Specifies whether or not reverse-wraparound is
1219 enabled.
1220 .LI \f3saveLines\fP
1221 .br
1222 Specifies the number of lines in the terminal buffer beyond the
1223 length of the window.
1224 The option value consists of a number followed by
1225 an optional suffix.
1226 If no suffix is included or the suffix is ``l'' (ell), the
1227 total length of the terminal buffer is
1228 .I screens
1229 plus the length of
1230 the terminal window.
1231 If the suffix is ``s'' (ess) the total length of the
1232 terminal buffer is (\c
1233 .IR screens +1)
1234 times the length of the terminal window.
1235 The
1236 .BR dtterm 
1237 utility attempts to maintain the same buffer-to-window
1238 ratio when the window is resized larger.
1239 .LI \f3scrollBar\fP
1240 .br
1241 Specifies that
1242 .BR dtterm 
1243 displays a scroll bar.
1244 .LI \f3sunFunctionKeys\fP
1245 .br
1246 Specifies whether
1247 .BR dtterm 
1248 generates Sun Function Key escape sequences instead of
1249 standard ANSI escape sequences
1250 for the terminal's function keys.
1251 .LI \f3termId\fP
1252 .br
1253 Supplies the name used to select the correct response to
1254 terminal ID queries.
1255 Valid values are
1256 .BR vt100 ,
1257 .BR vt101 ,
1258 .BR vt102 ,
1259 and
1260 .BR vt220 .
1261 .LI \f3termName\fP
1262 .br
1263 Specifies a name to which
1264 .BR dtterm 
1265 sets the
1266 .I TERM
1267 environment variable.
1268 The default is
1269 .BR dtterm .
1270 .LI \f3title\fP
1271 .br
1272 Specifies the window title.
1273 When used with the
1274 .B \(mie
1275 option, the default
1276 is the last component of the program's path;
1277 otherwise,
1278 the default is the last component of the name
1279 used to execute
1280 .BR dtterm 
1281 (that is,
1282 .IR argv [0]).
1283 .LI \f3ttyModes\fP
1284 .br
1285 Specifies a string containing terminal-setting keywords
1286 and the characters to which they can be bound.
1287 Allowable keywords include:
1288 .BR intr ,
1289 .BR quit ,
1290 .BR erase ,
1291 .BR kill ,
1292 .BR eof ,
1293 .BR eol ,
1294 .BR swtch ,
1295 .BR start ,
1296 .BR stop ,
1297 .BR brk ,
1298 .BR susp ,
1299 .BR dsusp ,
1300 .BR rprnt ,
1301 .BR flush ,
1302 .B weras
1303 and
1304 .BR lnext .
1305 The terminal emulator
1306 correctly parses and silently ignores keywords that do not apply
1307 to a specific architecture.
1308 Control characters can be specified as
1309 .BI ^ char
1310 (for example,
1311 .B ^c
1312 or
1313 .BR ^u ),
1314 and
1315 .B ^?
1316 can be used to indicate Delete.
1317 This is useful for overriding the default
1318 terminal settings without having to do an
1319 .BR stty (1)
1320 every time a DtTerm widget is created.
1321 .LI \f3userBoldFont\fP
1322 .br
1323 Specifies an
1324 .B XFontSet
1325 used by
1326 .BR dtterm 
1327 when displaying bold
1328 terminal text.
1329 The
1330 .B XFontSet
1331 should be specified as a Motif
1332 .BR XmFontList (3X).
1333 The terminal emulator supports only character or mono-spaced fonts.
1334 When using proportional fonts, the behavior is undefined.
1335 The terminal emulator generates a default bold font based on the
1336 .B XLFD
1337 name of the
1338 .BR userFont .
1339 If that font is not available,
1340 .BR dtterm 
1341 generates bold text
1342 by overstriking (with a one pixel offset) the
1343 .BR userFont .
1344 .LI \f3userFont\fP
1345 .br
1346 Specifies an
1347 .B XFontSet
1348 used by
1349 .BR dtterm 
1350 when displaying terminal text.
1351 .B XFontSet
1352 should be specified as a Motif
1353 .BR XmFontList (3X).
1354 The terminal emulator supports only character or mono-spaced fonts.
1355 When using proportional fonts, the behavior is undefined.
1356 This font is not used
1357 to display non-terminal text (such as menu bar, popup menu and dialog).
1358 The default is the
1359 .B XmNtextFontList
1360 value of the parent bulletin board
1361 (see the XmBulletinBoard widget)
1362 in the same manner as the XmText widget.
1363 .LI \f3visualBell\fP
1364 .br
1365 Indicates that a visual bell is preferred over an audible one.
1366 Instead of ringing the terminal bell whenever a <control>\(hyG is
1367 received, the window is flashed.
1368 .PP
1369 .RE
1370 .nr )J 0
1371 .SS "Resource/Option Correspondence"
1372 Many of the preceding resources correspond to the command-line arguments.
1373 The following table describes the relationship between the two:
1374 .TS
1375 center;
1376 cf3     cf3
1377 lf3w(3c)        lf3w(3c) .
1378 Command-line option     Resource Setting
1379 _
1380 \(mi132 *c132: True
1381 \+132   *c132: False
1382 \(miaw  *autoWrap: True
1383 \+aw    *autoWrap: False
1384 \(mibackground \f2background_color\fP   *background: \f2background_color\fP
1385 \(mibd \f2border_color\fP       *borderColor: \f2border_color\fP
1386 \(mibg \f2background_color\fP   *background: \f2background_color\fP
1387 \(mibordercolor \f2border_color\fP      *borderColor: \f2border_color\fP
1388 \(miborderwidth \f2border_width\fP      .borderWidth: \f2border_width\fP
1389 \(mibs  *backgroundIsSelect: True
1390 \+bs    *backgroundIsSelect: False
1391 \(mibw \f2border_width\fP       .borderWidth: \f2border_width\fP
1392 \(miC   *consoleMode: True
1393 \(midisplay \f2display_name\fP  .display: \f2display_name\fP
1394 \(mie \f2program_argument...\fP
1395 \(mifb \f2fontset\fP    *userBoldFont: \f2fontset\fP
1396 \(mifg \f2foreground_color\fP   *foreground: \f2foreground_color\fP
1397 \(mifn \f2fontset\fP    *userFont: \f2fontset\fP
1398 \(mifont \f2fontset\fP  *userFont: \f2fontset\fP
1399 \(miforeground \f2foreground_color\fP   *foreground: \f2foreground_color\fP
1400 \(migeometry \f2geometry_string\fP      .geometry: \f2geometry_string\fP
1401 \(miiconic      .iconic: True
1402 \+iconic        .iconic: False
1403 \(mij   *jumpScroll: True
1404 \+j     *jumpScroll: False
1405 \(mikshMode     *kshMode: True
1406 \+kshMode       *kshMode: False
1407 \(mil   *logging: True
1408 \+l     *logging: False
1409 \(milf \f2file_name\fP  *logFile: \f2file_name\fP
1410 \(mils  *loginShell: True
1411 \+ls    *loginShell: False
1412 \(mimap *mapOnOutput: True
1413 \+map   *mapOnOutput: False
1414 \(mimb  *marginBell: True
1415 \+mb    *marginBell: False
1416 \(mims \f2pointer_color\fP      *pointerColor: \f2pointer_color\fP
1417 \(miname \f2prog_name\fP        .name: \f2prog_name\fP
1418 \(minb \f2number\fP     *nMarginBell: \f2number\fP
1419 \(mirw  *reverseWrap: True
1420 \+rw    *reverseWrap: False
1421 \(misb  *scrollBar: True
1422 \+sb    *scrollBar: False
1423 \(misf  *sunFunctionKeys: True
1424 \+sf    *sunFunctionKeys: False
1425 \(misl \f2screens\fPs   *saveLines: \f2screens\fP * lines/screen
1426 \(misl \f2lines\fP      *saveLines: \f2lines\fP
1427 \(miti \f2term_id\fP    *termId: \f2term_id\fP
1428 \(mititle \f2title_string\fP    .title: \f2title_string\fP
1429 \(mitm \f2term_modes\fP *ttyModes: \f2term_modes\fP
1430 \(mitn \f2term_name\fP  *termName: \f2term_name\fP
1431 \(mivb  *visualBell: True
1432 \+vb    *visualBell: False
1433 \(miw \f2border_width\fP        .borderWidth: \f2border_width\fP
1434 .TE
1435 .SH "ASYNCHRONOUS EVENTS"
1436 The
1437 .BR dtterm 
1438 utility takes the standard action for all signals.
1439 .SH STDOUT
1440 Not used.
1441 .SH STDERR
1442 Used only for diagnostic messages.
1443 .SH "OUTPUT FILES"
1444 None.
1445 .SH "EXTENDED DESCRIPTION"
1446 None.
1447 .SH "EXIT STATUS"
1448 .PP
1449 .RS 3
1450 .nr )J 4
1451 .LI \h"\w'>'u"0
1452 successful completion
1453 .LI >0
1454 an error occurred
1455 .PP
1456 .RE
1457 .nr )J 0
1458 .SH "CONSEQUENCES OF ERRORS"
1459 Default.
1460 .SH "APPLICATION USAGE"
1461 None.
1462 .SH EXAMPLES
1463 None.
1464 .SH "SEE ALSO"
1465 .na
1466 .BR stty (1),
1467 .BR X (1X),
1468 .BR XmFontList (3X),
1469 .BR XmText (3X),
1470 .BR pty (7),
1471 .BR tty (7).