BSD 4_4 release

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

diff --git a/usr/src/usr.bin/telnet/telnet.1 b/usr/src/usr.bin/telnet/telnet.1
index 6d1d92a..8152be6 100644 (file)
--- a/usr/src/usr.bin/telnet/telnet.1
+++ b/usr/src/usr.bin/telnet/telnet.1
@@ -1,11 +1,37 @@
-.\" Copyright (c) 1983, 1990 The Regents of the University of California.
-.\" All rights reserved.
+.\" Copyright (c) 1983, 1990, 1993
+.\"    The Regents of the University of California.  All rights reserved.

 .\"
 .\"

-.\" %sccs.include.redist.roff%
+.\" 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.

 .\"
 .\"

-.\"    @(#)telnet.1    6.16 (Berkeley) %G%
+.\" 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 
+.\"    @(#)telnet.1    8.1 (Berkeley) 6/6/93
+.\"
+.Dd June 6, 1993

 .Dt TELNET 1
 .Os BSD 4.2
 .Sh NAME
 .Dt TELNET 1
 .Os BSD 4.2
 .Sh NAME


@@ -18,6 +44,9 @@ protocol
 .Op Fl d
 .Op Fl a
 .Op Fl n Ar tracefile
 .Op Fl d
 .Op Fl a
 .Op Fl n Ar tracefile

+.Op Fl e Ar escapechar
+.Oo
+.Op Fl l Ar user

 .Ar host
 .Op port
 .Oc
 .Ar host
 .Op port
 .Oc


@@ -66,6 +95,29 @@ for recording trace information.
 See the
 .Ic set tracefile
 command below.
 See the
 .Ic set tracefile
 command below.

+.It Fl l Ar user 
+When connecting to the remote system, if the remote system
+understands the
+.Ev ENVIRON
+option, then
+.Ar user
+will be sent to the remote system as the value for the variable USER.
+This option implies the
+.Fl a
+option.
+This option may also be used with the
+.Ic open
+command.
+.It Fl e Ar escape char 
+Sets the initial
+.Nm
+.Nm telnet
+escape character to
+.Ar escape char.
+If
+.Ar escape char
+is ommitted, then
+there will be no escape character.

 .It Ar host
 Indicates the official name, an alias, or the Internet address
 of a remote host.
 .It Ar host
 Indicates the official name, an alias, or the Internet address
 of a remote host.


@@ -170,6 +222,7 @@ Only enough of each command to uniquely identify it need be typed
 .Ic toggle  ,
 .Ic unset ,
 .Ic slc  ,
 .Ic toggle  ,
 .Ic unset ,
 .Ic slc  ,

+.Ic environ ,

 and
 .Ic display
 commands).
 and
 .Ic display
 commands).


@@ -224,10 +277,33 @@ option.
 This requires that the 
 .Dv LINEMODE
 option be enabled.
 This requires that the 
 .Dv LINEMODE
 option be enabled.

+.It Ic softtabs Pq Ic \-softtabs 
+Attempt to enable (disable) the 
+.Dv SOFT_TAB
+mode of the 
+.Dv LINEMODE
+option.
+This requires that the 
+.Dv LINEMODE
+option be enabled.
+.It Ic litecho Pq Ic \-litecho 
+Attempt to enable (disable) the 
+.Dv LIT_ECHO
+mode of the 
+.Dv LINEMODE
+option.
+This requires that the 
+.Dv LINEMODE
+option be enabled.

 .It Ic \&?
 Prints out help information for the
 .Ic mode
 command.
 .It Ic \&?
 Prints out help information for the
 .Ic mode
 command.

+.El
+.It Xo
+.Ic open Ar host
+.Oo Op Fl l
+.Ar user

 .Oc Ns Oo Fl
 .Ar port Oc
 .Xc
 .Oc Ns Oo Fl
 .Ar port Oc
 .Xc


@@ -242,6 +318,12 @@ The host specification may be either a host name (see
 .Xr hosts  5  )
 or an Internet address specified in the \*(Lqdot notation\*(Rq (see
 .Xr inet 3 ) .
 .Xr hosts  5  )
 or an Internet address specified in the \*(Lqdot notation\*(Rq (see
 .Xr inet 3 ) .

+The
+.Op Fl l
+option may be used to specify the user name
+to be passed to the remote system via the
+.Ev ENVIRON
+option.

 When connecting to a non-standard port,
 .Nm telnet
 omits any automatic initiation of
 When connecting to a non-standard port,
 .Nm telnet
 omits any automatic initiation of


@@ -632,6 +714,11 @@ The initial value for the worderase character is taken to be
 the terminal's
 .Ic worderase
 character.
 the terminal's
 .Ic worderase
 character.

+.It Ic \&?
+Displays the legal
+.Ic set
+.Pq Ic unset
+commands.

 .El
 .It Ic slc Ar state 
 The
 .El
 .It Ic slc Ar state 
 The


@@ -671,11 +758,69 @@ Verify the current settings for the current special characters.
 The remote side is requested to send all the current special
 character settings, and if there are any discrepencies with
 the local side, the local side will switch to the remote value.
 The remote side is requested to send all the current special
 character settings, and if there are any discrepencies with
 the local side, the local side will switch to the remote value.

-.Ic Ic \&?
+.It Ic \&?

 Prints out help information for the
 .Ic slc
 command.
 Prints out help information for the
 .Ic slc
 command.

+.El
+.It Ic environ Ar arguments... 
+The
+.Ic environ
+command is used to manipulate the
+the variables that my be sent through the
+.Dv TELNET ENVIRON
+option.
+The initial set of variables is taken from the users
+environment, with only the
+.Ev DISPLAY
+and
+.Ev PRINTER
+variables being exported by default.
+The
+.Ev USER
+variable is also exported if the
+.Fl a
+or
+.Fl l
+options are used.
+.br
+Valid arguments for the
+.Ic environ
+command are:
+.Bl -tag -width Fl
+.It Ic define Ar variable value 
+Define the variable
+.Ar variable
+to have a value of
+.Ar value.
+Any variables defined by this command are automatically exported.
+The
+.Ar value
+may be enclosed in single or double quotes so
+that tabs and spaces may be included.
+.It Ic undefine Ar variable 
+Remove
+.Ar variable
+from the list of environment variables.
+.It Ic export Ar variable 
+Mark the variable
+.Ar variable
+to be exported to the remote side.
+.It Ic unexport Ar variable 
+Mark the variable
+.Ar variable
+to not be exported unless
+explicitly asked for by the remote side.
+.It Ic list
+List the current set of environment variables.
+Those marked with a
+.Cm *
+will be sent automatically,
+other variables will only be sent if explicitly requested.

 .It Ic \&?
 .It Ic \&?

+Prints out help information for the
+.Ic environ
+command.

 .El
 .It Ic toggle Ar arguments ... 
 Toggle (between
 .El
 .It Ic toggle Ar arguments ... 
 Toggle (between


@@ -805,7 +950,9 @@ If this is
 .Dv TRUE ,
 then the
 .Ic flush  ,
 .Dv TRUE ,
 then the
 .Ic flush  ,

+.Ic interrupt ,

 .Ic quit  ,
 .Ic quit  ,

+.Ic erase ,

 and
 .Ic kill
 characters (see
 and
 .Ic kill
 characters (see


@@ -815,7 +962,9 @@ above) are recognized locally, and transformed into (hopefully) appropriate
 control sequences
 (respectively
 .Ic ao  ,
 control sequences
 (respectively
 .Ic ao  ,

+.Ic ip ,

 .Ic brk  ,
 .Ic brk  ,

+.Ic ec ,

 and
 .Ic el  ;
 see
 and
 .Ic el  ;
 see


@@ -844,6 +993,7 @@ and
 .B suspend
 are sent as
 .Ic eof and
 .B suspend
 are sent as
 .Ic eof and

+.Ic susp ,

 see
 .Ic send
 above).
 see
 .Ic send
 above).


@@ -902,12 +1052,17 @@ will print the help information for just that command.
 .El
 .Sh ENVIRONMENT
 .Nm Telnet
 .El
 .Sh ENVIRONMENT
 .Nm Telnet

-uses the
+uses at least the

 .Ev HOME ,
 .Ev HOME ,

-.Ev SHELL
+.Ev SHELL ,
+.Ev DISPLAY ,

 and
 .Ev TERM
 environent variables.
 and
 .Ev TERM
 environent variables.

+Other envirnoment variables may be propogated
+to the other side via the
+.Dv TELNET ENVIRON
+option.

 .Sh FILES
 .Bl -tag -width ~/.telnetrc -compact
 .It Pa ~/.telnetrc
 .Sh FILES
 .Bl -tag -width ~/.telnetrc -compact
 .It Pa ~/.telnetrc