This
page lists the HDSterm manual page.
HDSterm Manual Page
This note contains a printed copy of the HDSterm manual page. This
page is available on the HDSware tape as an nroff file, labeled
hdsterm.1 in the ./hds-fx/man directory. This means that you can add
this nroff file to your other man pages and have help for the HDSterm
client available with your normal man utility. If you want to see the
file as text output, you can use the command: nroff -man
hdsterm.1
The HDSterm man page contains all the command line
arguments and resources for HDSterm.
NAME
HDSterm - MOTIF based VT320 compatible
terminal emulator for X
SYNOPSIS
hdsterm [-toolkitoption ...]
[-option ...]
DESCRIPTION
The HDSterm program is a MOTIF based terminal emulator for the
X Window System. It provides DEC VT320 compatible terminals for
programs that can't use the window system directly.
OPTIONS
The HDSterm terminal emulator accepts all of the standard Goatlike
command line options as well as the following (if the option begins
with a `+' instead of a `-', the option is restored to its default
value):
-help
This causes HDSterm to print out a verbose message describing its
options.
-cfg
color
This option specifies the foreground color to use
for text cursor. The default is to use the same foreground color that
is used for text.
-cbg color
This option specifies the
background color to use for text cursor. The default is to use the
same foreground color that is used for text.
-e program [arguments ...]
This option specifies the program (and its command line arguments)
to be run in the HDSterm window. This must be the last option on the
command line.
-fb font
This option specifies a font to be used when displaying bold text.
This font must be the same height and width as the normal font. If only
one of the normal or bold fonts is specified, it will be used as the
normal font and the bold font.
-fs font
This option specifies a font to be designated as the small
font, which is selected via the "Customize Window" menu.
-fm font
This option specifies a font to be designated as the medium
font, which is selected via the "Customize Window" menu.
-fl font
This option specifies a font to be designated as the large
font, which is selected via the "Customize Window" menu.
-fsb font
This option specifies a font to be designated as the small bold
font, which is used for bold text when the small font is selected via
the "Customize Window" menu. This font must be the same height and width
as the normal small font.
-fmb font
This option specifies a font to be designated as the medium
bold font, which is used for bold text when the medium font is selected
via the "Customize Window" menu. This font must be the same height
and width as the normal medium font.
-flb font
This option specifies a font to be designated as the large bold
font, which is used for bold text when the large font is selected via
the "Customize Window" menu. This font must be the same height and
width as the normal large font.
-mclick milliseconds
This option specifies the maximum time between multi-click
selections.
-pcol color
This option specifies the color to be used for the pointer
cursor. The default is to use the foreground color.
-pcur cursor
This option specifies the cursor shape to be used for the
pointer cursor. The default is the "xterm'"text cursor.
-vsbar
This option indicates that a scrollbar should be displayed so that
the lines which are saved after scrolling off the top can be viewed.
This option may be turned on and off from the "Customize Window" menu.
+vsbar
This option indicates that a vertical scrollbar should not be
displayed.
-nostatus
This option indicates that the info/status area at the bottom of
the main window should not be displayed.
-sl number
This option specifies the number of lines to save that have been
scrolled off the top of the screen. The default is 64.
-T string
This option specifies the title for HDSterm's window. It is
equivalent to -title.
-n string
This option specifies the icon name for HDSterm's window. It
is shorthand for specifying the "*icon-Name" resource. Note that this
is not the same as the tool kit option -name (see below). The
default icon name is hdsterm.
-mw number
This option specifies the number of pixels between the
characters and the left and right window borders.
-mh number
This option specifies the number of pixels between the
characters and the top and bottom window borders.
-ul number
This option specifies the width in pixels of the underline
for characters written with the underline attribute.
-ch number
This option specifies the height of the text cursor in pixels.
-cw number
This option specifies the width of the text cursor in pixels.
-cbl
This option indicates that the text cursor should not blink.
+cbl
This option indicates that the text cursor should blink.
-cbival number
This option specifies the text cursor blink interval, in
milliseconds. The default is 400 ms.
-tbival number
This option specifies the blink interval for text written with
the blinking attribute. The default is 500 ms.
-bfocus
This option indicates that the text cursor should stop blinking
when the HDSterm window loses input focus. This is the default.
+bfocus
This option indicates that the text cursor should continue to
blink when the HDSterm window loses input focus.
-wrap
This option indicates that text should wrap to column one
of the next line after reaching the last column of the previous line.
This is the default.
+wrap
This option disables wrapping of text
after reaching the last column of the previous line. Additional
characters overwrite the character in the last column.
-insert
This option turns off insert mode, and enables replace
mode. This is the default.
+insert
This option turns on insert mode, and disables replace
mode.
-bell number
This option specifies the bell volume, as a percentage from 0 to
100.
-tab number
This option specifies that tabstops should be evenly placed at
every number character positions. The default is 8.
-VT
This option turns on IBM->VT keyboard emulation mode. This is
useful when using an IBM style keyboard with applications which use PFx
function keys and/ or ``editing'' keys. This option causes function keys
F1-F4 to generate the strings normally generated by the PF1-PF4 keys on
a VT320 terminal keyboard, and remaps the editing keys to their DEC
keyboard equivalents based on position rather than the legends printed
on the keytops.
X Toolkit Command Line Arguments
The following standard X Toolkit command line arguments are
commonly used with HDSterm:
-bg color
This option specifies the color to use for the background of
the window. The default is ``lightsteelblue.''
-bd color
This option specifies the color to use for the border of the
window. The default is ``black.''
-fg color
This option specifies the color to use for displaying text. The
default is ``black''.
-fn font
This option specifies the font to be used for displaying
normal text. The default is 9x15.
-name name
This option specifies the application name under which
resources are to be obtained, rather than the default HDSTerm. Name
should not contain ``.'' or ``*'' characters.
-title string
This option specifies the window title string, which may be
displayed by window managers if the user so chooses. The default title
is hdsterm.
-rv
This option indicates that reverse video should be simulated by
swapping the foreground and background colors.
-geometry geometry
This option specifies the preferred size and position of the
window.
-display display
This option specifies the X server to contact; see X(1).
-xrm resourcestring
This option specifies
a resource string to be used. This is especially useful for setting
resources that do not have separate command line options.
-iconic
This option indicates that HDSterm should ask the window manager
to start it as an icon rather than as the normal window.
RESOURCES
The program understands all of the core X Toolkit resource
names and classes. Note that the client name is HDSTerm (note uppercase
"T"). In addition, the following Application Resources are defined:
title (class Title)
Specifies a string that may be used by the window manager
when displaying this application.
iconName (class IconName)
This option specifies the icon name for HDSTerm's window.
vertScrollBar (class VertScrollBar)
Setting this option True indicates that a scrollbar should
be displayed so that the lines which are saved after scrolling off
the top can be viewed. This option may be turned on and off from
the ``Customize Window'' menu.
statusLine (class StatusLine)
Setting this option True indicates that the info/status area
should be displayed at the bottom of the main window. This option may
be turned on and off from the "Customize Window" menu.
smallFont (class SmallFont)
This option specifies a font to be designated as the small
font, which is selected via the ``Customize Window'' menu.
mediumFont (class MediumFont)
This option specifies a font to be designated as the medium
font, which is selected via the ``Customize Window'' menu.
largeFont (class LargeFont)
This option specifies a font to be designated as the large
font, which is selected via the ``Customize Window'' menu.
smallBoldFont (class SmallBoldFont)
This option specifies a font to be designated as the small
bold font, which is used for bold text when the small font is
selected via the ``Customize Window'' menu. This font must be the
same height and width as the normal small font.
mediumBoldFont (class MediumBoldFont)
This option specifies a font to be designated as the medium
bold font, which is used for bold text when the medium font is
selected via the ``Customize Window'' menu. This font must be the
same height and width as the normal medium font.
largeBoldFont (class LargeBoldFont)
This option specifies a font to be designated as the large
bold font, which is used for bold text when the large font is
selected via the ``Customize Window'' menu. This font must be the
same height and width as the normal large font.
vtEmulation (class VtEmulation)
Setting this option True turns on IBM->VT keyboard emulation
mode. See the ``- VT'' command line option above for a description.
HDSterm creates a MOTIF MainWindow widget (``top''),
consisting of a MenuBar widget (``MenuBar''), a vertical
ScrollBar widget (``vsb''), a message area consisting of a TextField
status widget (``status''), and some informational Label widgets. The
WorkArea of the MainWindow widget is a custom widget (``term'')
which is a subclass of the MOTIF Frame widget. The term widget in turn
manages a single custom widget (``screen''), which is a subclass of
the Xt Core widget. Most of the MOTIF resources applying to
MainWindow, ScrollBar, TextField, Label, Frame, PushButton,
CascadeButton, and other MOTIF widgets used may be modified by the
user. For example, setting the *top.scrollBarPlacement resource
to bottom_right or top_right will move the vertical scroll bar to the
right side of the window.
The following resources are specified as part of the term
widget (class Term):
command (class Command)
Specifies the command to be run in the HDSTerm window. The
default is the local shell (/bin/sh).
termType (class TermType)
Specifies the terminal emulation to be used. Currently
only vt320 is supported.
marginWidth (class MarginWidth)
This option specifies the number of pixels between the
characters and the left and right window borders.
marginHeight (class MarginHeight)
This option specifies the number of pixels between the
characters and the top and bottom window borders.
The following resources are specified as part of the screen
widget (class TermCanvas):
background (class Background)
Specifies the color to use for the background of the window.
The default is ``light steelblue.''
foreground (class Foreground)
Specifies the color to use for displaying text in the
window. The default is ``black.''
cursorFg (class CursorFg)
Specifies the color to use for the text cursor. The default is
``black.''
cursorBg (class CursorBg)
Specifies the color to use for the text cursor background. The
default is ``white.''
reverseVideo (class ReverseVideo)
Specifies whether or not reverse video should be simulated.
The default is ``false.''
underlineWidth (class UnderlineWidth)
Specifies the width in pixels of the underline for characters
written with the underline attribute.
lines (class Lines)
Specifies the number of lines of text in the displayed
window. This resource also sets the initial scrolling region to
include all visible lines.
columns (class Columns)
Specifies the number of text columns in the displayed
window.
cursorHeight (class CursorHeight)
Specifies the height of the text cursor in pixels.
cursorWidth (class CursorWidth)
Specifies the width of the text cursor in pixels.
cursorBlinking (class CursorBlinking)
Specifies that the text cursor should blink. The default is
True.
blinkInterval (class BlinkInterval)
Specifies the interval in milliseconds for the blinking
text cursor.
blinkWOFocus (class BlinkWOFocus)
Specifies that the text cursor should continue to blink
when the window loses input focus. The default is False.
textBlinkInterval (class TextBlinkInterval)
Specifies the interval in milliseconds for blinking text.
wrapAround (class WrapAround)
Specifies that text should wrap to the next line after
reaching the last column in the previous line. The default is True.
insertMode (class InsertMode)
Specifies that text should be inserted, causing characters
to the right of the insert point to be shifted right. The default
is False.
bellVolume (class BellVolume)
Specifies the bell volume as a percentage from 0 to 100.
defTabWidth (class DefTabWidth)
Specifies the default spacing of initial tabstops.
multiClickTime (class MultiClickTime)
Specifies the maximum time in milliseconds between
multi-click select events. The default is 300 milliseconds.
pointerColor (class PointerColor)
Specifies the foreground color of the pointer.
pointerShape (class PointerShape)
Specifies the name of the shape of the pointer. The default is
``xterm.''
saveLines (class SaveLines)
Specifies the number of lines to save beyond the top of the
screen. The default is the number of text lines or 64, whichever is
greater.
lineMode (class LineMode)
When set True, specifies that LF, VT, and FF control characters
received should cause the cursor to move to the leftmost column of the
next line, and scroll if necessary. Also, pressing the "Enter" key will
transmit both CR and LF to the program running in the HDSterm window.
The default is False, which specifies that LF, VT, and FF cause the
cursor to move to the current column of the next line, and press ing
"Enter" will transmit only a CR character.
printDevice (class PrintDevice)
Specifies the device driver for local printing. The default is
"/dev/pp0" (the parallel port). Serial ports 1 and 2 use drivers
"/dev/tty1" and "/dev/tty2" respectively.
ansiFg_n (class AnsiFg_n)
Specifies the color to be used as the text foreground when the
ANSI escape sequence to change foreground color is received. The digit
``n'', which must be in the range 0-7, corresponds to the ANSI SGR
sequence ``ESC [ 3n m''. The ANSI sequence to clear all attributes,
``ESC [ 0 m'', will reset both the text foreground and background
colors to their original values specified by the screen widget's
foreground and background resources.
ansiBg_n (class AnsiBg_n)
Specifies the color to be used as the text background when the
ANSI escape sequence to change background color is received. The digit
``n'', which must be in the range 0-7, corresponds to the ANSI SGR
sequence ``ESC [ 4n m''. The ANSI sequence to clear all attributes,
``ESC [ 0 m'', will reset both the text foreground and background
colors to their original values specified by the screen widget's
foreground and background resources.
EMULATIONS
The VT320 emulation is fairly complete, but does not support the
host-writable status line. Termcap(5) entries that work with HDSterm
include ``vt320'', ``xterm'', ``vt220'', ``vt102'', ``vt100'' and
``ansi''.
POINTER USAGE
Once the HDSterm window is created, HDSterm allows you to
select text and copy it within the same or other windows.
The selection functions are invoked when the pointer buttons
are used with no modifiers. The assignment of the functions described
below to keys and buttons may be changed through the resource
database; see ACTIONS below.
Pointer button one (usually left) is used to save text into
the cut buffer. Move the cursor to the beginning of the text, and
then hold the button down while moving the cursor to the end of the
region and releasing the button. The selected text is highlighted and
is saved in the global cut buffer and made the PRIMARY selection
when the button is released. Double-clicking selects by words.
Triple-clicking selects by lines. Multiple-click is determined by
the time from button up to button down, so you can change the
selection unit in the middle of a selection.
If the
key/button bindings specify that an X selection is to be made, HDSterm
will leave the selected text highlighted for as long as it is the
selection owner.
Pointer button two (usually middle) `types' (pastes) the
text from the PRIMARY selection, if any, otherwise from the cut buffer,
inserting it as keyboard input.
Pointer button three (usually right) extends the current
selection. The original selection starting point is retained, and the
endpoint is moved to correspond to the new pointer selection. When
button three is released, the newly extended selection is saved.
By cutting and pasting pieces of text without trailing new
lines, you can take text from several places in different windows
and form a command to the shell, for example, or take output from
a program and insert it into your favorite editor. Since the cut buffer
is globally shared among different applications, you should regard it
as a `file' whose contents you know. The terminal emulator and
other text programs should be treating it as if it were a text file,
i.e. the text is delimited by new lines.
The scroll bar position and length corresponds to the
position and amount of text currently showing in the window,
relative to the amount of text actually saved. As more text is saved
(up to the maximum), the length of the scrollbar thumb decreases.
CUSTOMIZING HDSTERM
Once you have created an HDSterm window, you can choose the
operating features you want the terminal to have by using the HDSterm
Customize menu.
The Window... menu item pops up a dialog box which
allows you to modify the size and appearance of the terminal window.
The current settings are indicated by shaded buttons. Use the Apply
button to view your changes without closing the dialog box. The OK
button will apply your changes and close the dialog. The Window dialog
will allow you to enable or disable the vertical scroll bar, change
fonts, and change the number of rows and/or columns in the displayed
window.
The Display... menu item pops up a dialog box which
allows you to modify various VT320 emulation features which affect the
way text is displayed, including Auto Wrap, Cursor Blink, Cursor
Type, and Normal/Reverse video.
The General... menu item pops up a dialog box which
allows you to modify internal settings of the VT320 emulation,
including Linefeed/Newline mode, keyboard autorepeat, keyboard
emulation, and the ascii codes generated by numeric keypad keys and
cursor keys.
ACTIONS
It is possible to rebind keys (or sequences of keys) to
arbitrary strings for input, by changing the translations for the
screen widget. Changing the translations for events other than key
and button events is not expected, and will cause unpredictable
behavior. The following actions are provided for using within the
screen translations resource:
key-input()
Without arguments, this action inserts the 8-bit ISO Latin-1
character or string associated with the keysym that was pressed.
If the Mod1 modifier is pressed with the key event, the high-order
bit will be set. If a single parameter is supplied, this string
will be inserted instead.
insert-selection (sourcename [, ...])
This action inserts the string found in the selection or
cutbuffer indicated by sourcename. Sources are checked in the order
given (case is significant) until one is found. Commonly-used
selections include: PRIMARY, SECONDARY, and CLIPBOARD. Cut buffers
are typically named CUT_BUFFER0 through CUT_ BUFFER7.
select-start()
This action begins text
selection at the current pointer location. See the section on
POINTER USAGE for information on making selections.
select-extend()
This action tracks the
pointer and extends the selection.
select-end(destname [, ...])
This action puts the currently selected text into all of
the selections or cut buffers specified by destname.focus-in()
This action modifies the text cursor to be a solid block
or solid underline, showing that the window has keyboard focus. If
blinking cursor is enabled, the cursor will begin blinking.
focus-out()
This action modifies the text cursor to be an outline
block or underline, show ing that the window does not have keyboard
focus. If blinking cursor is enabled, but blinkWOFocus is False, the
cursor stops blinking and becomes solid.
call-parser(opcode, buffer, [register, int_val], ...)
This action calls the reverse parser directly. Currently
this function is for internal use only.
call-canvas(opcode, buffer, [register, int_val], ...)
This action calls the canvas widget function
dispatcher directly. Currently this function is for internal use
only. The default bindings in the VT320 window are:<FocusIn>:
focus-in() \n\
<FocusOut>: focus-out() \n\
Shift <Key>
osfPageUp: call-canvas(46, ``'', a, 200, b, 1) \n\
Shift <Key>
osfPageDown: call-canvas(46, ``'', a, -200, b, 1) \n\
Shift <Key>
osfUp: call-canvas(46, ``'', a, 1, b, 1) \n\
Shift <Key>
osfDown: call-canvas(46, ``'', a, -1, b, 1) \n\
<Btn1Down>:
select-start() \n\
<Btn1Motion>: select-extend() \n\
<Btn2Up>:
insert-selection(PRIMARY, CUT_ BUFFER0)\n\
<Btn3Down>:
select-extend() \n\
<Btn3Motion>: select-extend() \n\
<Btn1Up>:
select-end(PRIMARY, CUT_BUFFER0) \n\
<Btn3Up>:
select-end(PRIMARY, CUT_BUFFER0) \n\
<Key>: key-input()
ENVIRONMENT
HDSterm sets the environment variable ``TERM'' to vt320 when
the command resource is set to telnet, or when starting HDSterm
from Setup's Telnet Terminal Window menu button.
SEE ALSO
Xterm(1), X(1)
BUGS
Please report all bugs to HDS Network Systems, Inc. at
support@hds.com.
COPYRIGHT
Copyright 1992, HDS Network Systems, Inc. Portions
adapted from emu, copyright 1990, PCS Computer Systeme GmbH.
AUTHORS
Edward Parks, Michael Hartman, Bill Bredbenner (HDS
Network Systems). Thanks to Jordan Hubbard, Michael Elbel, Terry Jones,
and Thomas Bagli (PCS Computer Systeme GmbH) for donating the emu
source to the MIT Consortium, and to all those far too many people who
developed Xterm.
Return to Section Heading Page
Return to the Home Page
If you need more information than is available here, you can reach
HDS via email at info@hds.com, or
call us at 1.800.HDS.1551 in the USA, or at +610.277.8300 from outside
the US. For questions or problems regarding the HDS WWW page, contact
webmaster@hds.com.
© 1996 by HDS Network Systems
Inc.