BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.bin / tn3270 / tn3270.1

diff --git a/usr/src/usr.bin/tn3270/tn3270.1 b/usr/src/usr.bin/tn3270/tn3270.1
index 28a554d..51873d2 100644 (file)
--- a/usr/src/usr.bin/tn3270/tn3270.1
+++ b/usr/src/usr.bin/tn3270/tn3270.1
@@ -1,28 +1,43 @@
 .\" Copyright (c) 1986, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1986, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"     @(#)tn3270.1   4.3 (Berkeley) 6/11/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.Dd June 11, 1990
+.\"    @(#)tn3270.1    4.6 (Berkeley) 7/27/91
+.\"
+.Dd July 27, 1991

 .Dt TN3270 1
 .Os BSD 4.3
 .Sh NAME
 .Nm tn3270
 .Dt TN3270 1
 .Os BSD 4.3
 .Sh NAME
 .Nm tn3270

-.Nd full-screen remote login to IBM VM/CMS
+.Nd full-screen remote login to
+.Tn IBM VM/CMS

 .Sh SYNOPSIS
 .Nm tn3270
 .Op Fl d
 .Sh SYNOPSIS
 .Nm tn3270
 .Op Fl d


@@ -32,20 +47,29 @@
 .Sh DESCRIPTION
 .Nm Tn3270
 permits a full-screen, full-duplex connection
 .Sh DESCRIPTION
 .Nm Tn3270
 permits a full-screen, full-duplex connection

-from a UNIX
+from a
+.Tn UNIX

 machine
 machine

-to an IBM (or compatible) machine.
+to an
+.Tn IBM
+(or compatible) machine.

 .Nm Tn3270
 gives the appearance of being logged in
 to the remote machine
 .Nm Tn3270
 gives the appearance of being logged in
 to the remote machine

-from an IBM 3270 terminal.
+from an
+.Tn IBM
+3270 terminal.

 Of course, you must have an account on the machine
 to which you connect in order to log in.
 .Nm Tn3270
 looks to the user in many respects
 Of course, you must have an account on the machine
 to which you connect in order to log in.
 .Nm Tn3270
 looks to the user in many respects

-like the Yale ASCII Terminal Communication System II.
+like the Yale
+.Tn ASCII
+Terminal Communication System II.

 .Nm Tn3270
 .Nm Tn3270

-is actually a modification of the Arpanet TELNET user interface (see
+is actually a modification of the Arpanet
+.Tn TELNET
+user interface (see

 .Xr telnet  1  )
 which will, in certain circumstances, interpret and generate
 raw 3270 control streams.
 .Xr telnet  1  )
 which will, in certain circumstances, interpret and generate
 raw 3270 control streams.


@@ -53,36 +77,39 @@ raw 3270 control streams.
 The flags to
 .Nm tn3270
 are as follows:
 The flags to
 .Nm tn3270
 are as follows:

-.Tw Fl
-.Tp Fl d
+.Bl -tag -width Fl
+.It Fl d

 Turn on socket-level tracing (for super-user only)
 Turn on socket-level tracing (for super-user only)

-.Ct Fl n
-.Ar filename
-.Cx
+.Fl n Ns Ar filename

 Specify a file to receive network trace data
 output (from commands "toggle netdata" and
 "toggle options", see
 .Xr telnet 1 ) ;
 the default is for output
 to be directed to the standard error file.
 Specify a file to receive network trace data
 output (from commands "toggle netdata" and
 "toggle options", see
 .Xr telnet 1 ) ;
 the default is for output
 to be directed to the standard error file.

-.Ct Fl t
-.Ar commandname
-.Cx
-Specify a UNIX
-command to process IBM 4994 style transparent mode
-data received from the remote IBM machine.
-.Tp Ar sysname
+.Fl t Ns Ar commandname
+Specify a
+.Tn UNIX
+command to process
+.Tn IBM
+4994 style transparent mode
+data received from the remote
+.Tn IBM
+machine.
+.It Ar sysname

 The name of the remote system.  If the remote name
 is NOT specified, the user will be prompted for a
 command (see below).
 The name of the remote system.  If the remote name
 is NOT specified, the user will be prompted for a
 command (see below).

-.Tp Ar port
+.It Ar port

 The port to connect to on the remote system.
 Normally,
 .Nm tn3270
 attempts to connect to the
 The port to connect to on the remote system.
 Normally,
 .Nm tn3270
 attempts to connect to the

-standard TELNET port (port
+standard
+.Tn TELNET
+port (port

 23) on the remote machine.
 23) on the remote machine.

-.Tp
+.El

 .Pp
 When
 .Nm tn3270
 .Pp
 When
 .Nm tn3270


@@ -110,20 +137,20 @@ If the terminal does have at least 80 columns and at least 24 lines,
 the following table describes the emulation:
 .Pp
 .ne 7v
 the following table describes the emulation:
 .Pp
 .ne 7v

-.Ds C
-.Cw (rows*columns)
-.Cl minimum_size       emulated
-.Cl (rows*columns)     terminal
-.Cl --------------     ------------
-.Cl 27*132     3278 model 5
-.Cl 43*80      3278 model 4
-.Cl 32*80      3278 model 3
-.Cl 24*80      3278 model 2.
-.Cw
-.De
-.Pp
+.Bd -filled -offset center
+.Bl -column (rows*columns)
+.It minimum_size       emulated
+.It (rows*columns)     terminal
+.It --------------     ------------
+.It 27*132     3278 model 5
+.It 43*80      3278 model 4
+.It 32*80      3278 model 3
+.It 24*80      3278 model 2.
+.El
+.Ed

 .Pp
 .Pp

-Emulation of the 3270 terminal is done in the UNIX
+Emulation of the 3270 terminal is done in the
+.Tn UNIX

 process.
 This emulation involves mapping
 3270-style commands from the host
 process.
 This emulation involves mapping
 3270-style commands from the host


@@ -137,7 +164,9 @@ file to do this.
 The emulation also involves simulating the special 3270 keyboard keys
 (program function keys, etc.)
 by mapping sequences of keystrokes
 The emulation also involves simulating the special 3270 keyboard keys
 (program function keys, etc.)
 by mapping sequences of keystrokes

-from the ASCII keyboard into appropriate 3270 control strings.
+from the
+.Tn ASCII
+keyboard into appropriate 3270 control strings.

 This mapping is terminal dependent and is specified
 in a description file,
 .Pa /usr/share/misc/map3270 ,
 This mapping is terminal dependent and is specified
 in a description file,
 .Pa /usr/share/misc/map3270 ,


@@ -150,7 +179,9 @@ or in an environment variable
 .Ev MAP3270B ,
 and so on - see
 .Xr mset  1  ) .
 .Ev MAP3270B ,
 and so on - see
 .Xr mset  1  ) .

-Any special function keys on the ASCII keyboard are used whenever possible.
+Any special function keys on the
+.Tn ASCII
+keyboard are used whenever possible.

 If an entry for the user's terminal
 is not found,
 .Nm tn3270
 If an entry for the user's terminal
 is not found,
 .Nm tn3270


@@ -163,13 +194,25 @@ uses a default keyboard mapping
 .Xr map3270  5  ) .
 .Pp
 The first character of each special keyboard mapping sequence
 .Xr map3270  5  ) .
 .Pp
 The first character of each special keyboard mapping sequence

-is either an ASCII escape (ESC),
-a control character, or an ASCII delete (DEL).
+is either an
+.Tn ASCII
+escape
+.Pq Tn ESC ,
+a control character, or an
+.Tn ASCII
+delete
+.Pq Tn DEL .

 If the user types an unrecognized function key sequence,
 .Nm tn3270
 If the user types an unrecognized function key sequence,
 .Nm tn3270

-sends an ASCII bell (BEL), or a visual bell if
+sends an
+.Tn ASCII
+bell
+.Pq Tn BEL ,
+or a visual bell if

 defined in the user's termcap entry, to the user's terminal
 defined in the user's termcap entry, to the user's terminal

-and nothing is sent to the IBM host.
+and nothing is sent to the
+.Tn IBM
+host.

 .Pp
 If
 .Nm tn3270
 .Pp
 If
 .Nm tn3270


@@ -184,11 +227,14 @@ all the commands of
 .Xr telnet  1  ,
 plus one additional command:
 .Pp
 .Xr telnet  1  ,
 plus one additional command:
 .Pp

-.Tw Ar
-.Tp Ic transcom
-Specify UNIX
-command for IBM 4994 style transparent mode processing.
-.Tp
+.Bl -tag -width Ar
+.It Ic transcom
+Specify
+.Tn UNIX
+command for
+.Tn IBM
+4994 style transparent mode processing.
+.El

 .Pp
 .Nm Tn3270
 command mode may also be entered, after connecting to a host, by typing
 .Pp
 .Nm Tn3270
 command mode may also be entered, after connecting to a host, by typing


@@ -209,36 +255,48 @@ While in command mode, any host login session is still alive
 but temporarily suspended.
 The host login session may be resumed by entering an empty line
 (press the
 but temporarily suspended.
 The host login session may be resumed by entering an empty line
 (press the

-.Li RETURN
+.Tn RETURN

 key)
 in response to the command prompt.
 A session may be terminated by logging off the foreign host,
 or by typing ``quit'' or ``close'' while in local command mode.
 .Sh FILES
 key)
 in response to the command prompt.
 A session may be terminated by logging off the foreign host,
 or by typing ``quit'' or ``close'' while in local command mode.
 .Sh FILES

-.Dw /usr/share/misc/termcap
-.Di L
-.Dp Pa /usr/share/misc/termcap
-.br
-.Dp Pa /usr/share/misc/map3270
-.Dp
-.Sh AUTHOR
-Greg Minshall
+.Bl -tag -width /usr/share/misc/termcap -compact
+.It Pa /usr/share/misc/termcap
+.It Pa /usr/share/misc/map3270
+.El
+.\" .Sh AUTHOR
+.\" Greg Minshall

 .Sh NOTES
 .Sh NOTES

-The IBM 4994 style transparent mode command is invoked when
+The
+.Tn IBM
+4994 style transparent mode command is invoked when

 .Nm tn3270
 .Nm tn3270

-receives IBM 4994 style transparent output from the remote host.
+receives
+.Tn IBM
+4994 style transparent output from the remote host.

 Output and input pipes are created for communication between the two
 processes.
 The pipes are closed when a 3270 clear command is received from the remote
 hosts, signalling the end of transparent mode output.
 Output and input pipes are created for communication between the two
 processes.
 The pipes are closed when a 3270 clear command is received from the remote
 hosts, signalling the end of transparent mode output.

-Transparent mode is necessary for sending ASCII control characters over the
-3270 terminal connection; ASCII graphics terminal support is accomplished this
+Transparent mode is necessary for sending
+.Tn ASCII
+control characters over the
+3270 terminal connection;
+.Tn ASCII
+graphics terminal support is accomplished this

 way.
 Developers of
 .Ic transcom
 commands should note that the
 .Ic transcom
 way.
 Developers of
 .Ic transcom
 commands should note that the
 .Ic transcom

-stdin pipe end will be in CBREAK mode, with ECHO and CRMOD turned off.
+stdin pipe end will be in
+.Dv CBREAK
+mode, with
+.Dv ECHO
+and
+.Dv CRMOD
+turned off.

 .Sh ENVIRONMENT
 .Nm Tn3270
 checks the following environment variables:
 .Sh ENVIRONMENT
 .Nm Tn3270
 checks the following environment variables:


@@ -260,13 +318,16 @@ and
 .Xr termcap 3 ,
 .Xr termcap 5 ,
 .Xr map3270 5 ,
 .Xr termcap 3 ,
 .Xr termcap 5 ,
 .Xr map3270 5 ,

-.br
-.Em Yale ASCII Terminal Communication
-.Em System II Program Description/Operator's Manual
-.Pq IBM SB30-1911
+.Rs
+.%T "Yale ASCII Terminal Communication"
+.%B "System II Program Description/Operator's Manual"
+.%R IBM SB30-1911
+.Re

 .Sh HISTORY
 .Sh HISTORY

-.Nm
-appeared in 4.3 BSD.
+The
+.Nm tn3270
+command appeared in
+.Bx 4.3 .

 .Sh BUGS
 Tn3270 is slow and uses system resources prodigiously.
 .Pp
 .Sh BUGS
 Tn3270 is slow and uses system resources prodigiously.
 .Pp