source: trunk/third/x3270/ibm_hosts.man @ 9081

'\\" t
.TH IBM_HOSTS 5 "10 July 1995"
.SH NAME
ibm_hosts \-
host database for
.B x3270
.SH SYNOPSIS
/usr/lib/X11/x3270/ibm_hosts
.SH DESCRIPTION
The
.B ibm_hosts
file contains information regarding IBM hosts on the network.
An
.I "IBM host"
is a host which can communicate with a 3270 terminal emulator such as
.B x3270
or
.B tn3270.
Each line defines a name in the following format
(optional fields are shown in brackets):
.nf

        \fIname type hostname\fP[/\fIport\fP] [\fIactions\fP]

.fi
Items are separated by any number of blanks and/or TAB characters.
A line beginning with `#' is taken as a comment (note that `#' anywhere
else on a line does
.I not
indicate a comment).
.LP
The
.I name
field is a mnemonic used to identify the host.
.LP
The
.I
type
field is a keyword that indicates the type of entry.
The value
.B primary
means that the
.I name
will be included in host-selection menus that may be displayed by a
3270 emulator.
The value
.B alias
means that the
.I name
will not be included in menus, but will still be accepted as valid input
when a host name is required.
.LP
The
.I hostname
field is the Internet hostname or dot-notation Internet address of the host.
.LP
The
.I hostname
can also optionally include a non-default
.I port
number, appended to the
.I hostname
with
a slash ``/'' character,
.IR e . g .,
.BR bluehost/97 .
.LP
The optional
.I actions
field specifies actions to be taken once the connection is made and a
data-entry field is defined.
If the text looks like an action,
.IR e . g .,
.BR PF(1) ,
it is unmodified; otherwise it is taken as the parameter to the
.B String()
action.
The
.I actions
are not intended for entering usernames and passwords; rather they provide an
automated way of specifying a front-end menu option.
.SH EXAMPLE
Given the following
.B ibm_hosts
file:
.nf

        mvs     primary mvs-host
        tso     alias   mvs-host
        mvs2    primary mvs-host/4012
        vm      primary vtam    Tab() String(3) Enter()

.fi
An 3270 emulator will display four names
.RB ( mvs ,
.BR mvs2 ,
.B afhost
and
.BR vm )
on its hosts menu.
The names
.B mvs
and
.B tso
will cause connections to the host
.BR mvs-host.
The name
.B mvs2
will also cause a connection to
.BR mvs-host ,
but to port 4012 rather than the emulator's default port (usually 23).
The name
.B vm
will cause the 3270 emulator to connect to the host
.B vtam
(presumably some sort of host-selection front-end),
enter the string ``3'' on the second data-entry field on the screen, and
send the ENTER AID sequence.
.SH FILES
/usr/lib/X11/x3270/ibm_hosts
.SH "SEE ALSO"
x3270(1)