add .Vx so tmac.andoc will call tmac.mdoc-old

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

.\" Copyright (c) 1983, 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" %sccs.include.redist.man%
.\"
.\"     @(#)telnet.1	6.14 (Berkeley) %G%
.\"
.Vx
.Vx
.Dd 
.Dt TELNET 1
.Os BSD 4.2
.Sh NAME
.Nm telnet
.Nd user interface to the 
.Li TELNET
protocol
.Sh SYNOPSIS
.Nm telnet
.Op Fl d
.Op Fl a
.Op Fl n Ar tracefile
.Ar host
.Op port
.Oe
.Sh DESCRIPTION
The
.Nm telnet
command
is used to communicate with another host using the 
.Li TELNET
protocol.
If
.Nm telnet
is invoked without the
.Ar host
argument, it enters command mode,
indicated by its prompt
.Pq Nm telnet\&> .
In this mode, it accepts and executes the commands listed below.
If it is invoked with arguments, it performs an
.Ic open
command with those arguments.
.Pp
Options:
.Tw Fl
.Tp Fl d
Sets the initial value of the
.Ic debug
toggle to
.Li TRUE
.Tp Fl a
Attempt automatic login.
Currently, this sends the user name via the USER variable
of the ENVIRON option if supported by the remote system.
The name used is that of the current user as returned by
.Xr getlogin 2
if it agrees with the current user ID,
otherwise it is the name associated with the user ID.
.Tp Cx Fl n
.Cx \&\ \&
.Ar tracefile
.Cx
Opens
.Ar tracefile
for recording trace information.
See the
.Ic set tracefile
command below.
.Tp Ar host
Indicates the official name, an alias, or the Internet address
of a remote host.
.Tp Ar port
Indicates a port number (address of an application).  If a number is
not specified, the default
.Nm telnet
port is used.
.Tp
.Pp
Once a connection has been opened,
.Nm telnet
will attempt to enable the
.Li TELNET LINEMODE
option.
If this fails, then
.Nm telnet
will revert to one of two input modes:
either \*(Lqcharacter at a time\*(Rq
or \*(Lqold line by line\*(Rq
depending on what the remote system supports.
.Pp
When 
.Li LINEMODE
is enabled, character processing is done on the
local system, under the control of the remote system.  When input
editing or character echoing is to be disabled, the remote system
will relay that information.  The remote system will also relay
changes to any special characters that happen on the remote
system, so that they can take effect on the local system.
.Pp
In \*(Lqcharacter at a time\*(Rq mode, most
text typed is immediately sent to the remote host for processing.
.Pp
In \*(Lqold line by line\*(Rq mode, all text is echoed locally,
and (normally) only completed lines are sent to the remote host.
The \*(Lqlocal echo character\*(Rq (initially \*(Lq^E\*(Rq) may be used
to turn off and on the local echo
(this would mostly be used to enter passwords
without the password being echoed).
.Pp
If the 
.Li LINEMODE
option is enabled, or if the
.Ic localchars
toggle is TRUE (the default for \*(Lqold line by line\*(Lq; see below),
the user's
.Ic quit  ,
.Ic intr ,
and
.Ic flush
characters are trapped locally, and sent as
.Li TELNET
protocol sequences to the remote side.
If 
.Li LINEMODE
has ever been enabled, then the user's
.Ic susp
and
.Ic eof
are also sent as
.Li TELNET
protocol sequences,
and
.Ic quit
is sent as a 
.Li TELNET ABORT
instead of 
.Li BREAK
There are options (see
.Ic toggle
.Ic autoflush
and
.Ic toggle
.Ic autosynch
below)
which cause this action to flush subsequent output to the terminal
(until the remote host acknowledges the
.Li TELNET
sequence) and flush previous terminal input
(in the case of
.Ic quit
and
.Ic intr  ) .
.Pp
While connected to a remote host,
.Nm telnet
command mode may be entered by typing the
.Nm telnet
\*(Lqescape character\*(Rq (initially \*(Lq^
\*(Rq).
When in command mode, the normal terminal editing conventions are available.
.Pp
The following .Nm telnet
commands are available.
Only enough of each command to uniquely identify it need be typed
(this is also true for arguments to the
.Ic mode  ,
.Ic set ,
.Ic toggle  ,
.Ic unset ,
.Ic slc  ,
and
.Ic display
commands).
.Pp
.Tw Ic
.Tp Ic close
Close a
.Li TELNET
session and return to command mode.
.Tp Cx Ic display
.Cx \&\ \&
.Ar argument ...
.Cx
Displays all, or some, of the
.Ic set
and
.Ic toggle
values (see below).
.Tp Cx Ic mode
.Cx \&\ \&
.Ar type
.Cx
.Ar Type
is one of several options, depending on the state of the
.Li TELNET
session.
The remote host is asked for permission to go into the requested mode.
If the remote host is capable of entering that mode, the requested
mode will be entered.
.Tw Ar
.Tp Ic character
Disable the
.Li TELNET LINEMODE
option, or, if the remote side does not understand the
.Li LINEMODE
option, then enter \*(Lqcharacter at a time\*(Lq mode.
.Tp Ic line
Enable the
.Li TELNET LINEMODE
option, or, if the remote side does not understand the
.Li LINEMODE
option, then attempt to enter \*(Lqold-line-by-line\*(Lq mode.
.Tp Cx Ic isig
.Cx \&\ \&
.Pq Ic \-isig
.Cx
Attempt to enable (disable) the 
.Li TRAPSIG
mode of the 
.Li LINEMODE
option.
This requires that the 
.Li LINEMODE
option be enabled.
.Tp Cx Ic edit
.Cx \&\ \&
.Pq Ic \-edit
.Cx
Attempt to enable (disable) the 
.Li EDIT
mode of the 
.Li LINEMODE
option.
This requires that the 
.Li LINEMODE
option be enabled.
.Tp Ic \&?
Prints out help information for the
.Ic mode
command.
.Tp
.Tp Cx Ic open
.Cx \&\ \&
.Ar host
.Cx \&\ \&
.Cx [
.Op Fl
.Cx \&\ \&
.Ar port
.Cx ]
.Cx
Open a connection to the named host.
If no port number
is specified,
.Nm telnet
will attempt to contact a
.Li TELNET
server at the default port.
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 ) .
When connecting to a non-standard port,
.Nm telnet
omits any automatic initiation of
.Li TELNET
options.  When the port number is preceeded by a minus sign,
the inital option negotiation is done.
After establishing a connection, the file
.Pa \&.telnetrc
in the
users home directory is opened.  Lines begining with a # are
comment lines.  Blank lines are ignored.  Lines that begin
without whitespace are the start of a machine entry.  The
first thing on the line is the name of the machine that is
being connected to.  The rest of the line, and successive
lines that begin with whitespace are assumed to be
.Nm telnet
commands and are processed as if they had been typed
in manually to the
.Nm telnet
command prompt.
.Tp Ic quit
Close any open
.Li TELNET
session and exit
.Nm telnet  .
An end of file (in command mode) will also close a session and exit.
.Tp Cx Ic send
.Cx \&\ \&
.Ar arguments
.Cx
Sends one or more special character sequences to the remote host.
The following are the arguments which may be specified
(more than one argument may be specified at a time):
.Pp
.Tw Ds
.Tp Ic abort
Sends the
.Li TELNET ABORT
(ABORT processes)
sequence.
.Tp Ic ao
Sends the
.Li TELNET AO
(Abort Output) sequence, which should cause the remote system to flush
all output
.Em from
the remote system
.Em to
the user's terminal.
.Tp Ic ayt
Sends the
.Li TELNET AYT
(Are You There)
sequence, to which the remote system may or may not choose to respond.
.Tp Ic brk
Sends the
.Li TELNET BRK
(Break) sequence, which may have significance to the remote
system.
.Tp Ic ec
Sends the
.Li TELNET EC
(Erase Character)
sequence, which should cause the remote system to erase the last character
entered.
.Tp Ic el
Sends the
.Li TELNET EL
(Erase Line)
sequence, which should cause the remote system to erase the line currently
being entered.
.Tp Ic eof
Sends the
.Li TELNET EOF
(End Of File)
sequence.
.Tp Ic eor
Sends the
.Li TELNET EOR
(End of Record)
sequence.
.Tp Ic escape
Sends the current
.Nm telnet
escape character (initially \*(Lq^\*(Rq).
.Tp Ic ga
Sends the
.Li TELNET GA
(Go Ahead)
sequence, which likely has no significance to the remote system.
.Tp Ic getstatus
If the remote side supports the
.Li TELNET STATUS
command,
.Ic getstatus
will send the subnegotiation to request that the server send
its current option status.
.Tp Ic ip
Sends the
.Li TELNET IP
(Interrupt Process) sequence, which should cause the remote
system to abort the currently running process.
.Tp Ic nop
Sends the
.Li TELNET NOP
(No OPeration)
sequence.
.Tp Ic susp
Sends the
.Li TELNET SUSP
(SUSPend process)
sequence.
.Tp Ic synch
Sends the
.Li TELNET SYNCH
sequence.
This sequence causes the remote system to discard all previously typed
(but not yet read) input.
This sequence is sent as TCP urgent
data (and may not work if the remote system is a 4.2 BSD system -- if
it doesn't work, a lower case \*(Lqr\*(Rq may be echoed on the terminal).
.Tp Ic \&?
Prints out help information for the
.Ic send
command.
.Tp
.Tp Cx Ic set
.Cx \&\ \&
.Ar argument value
.Cx
.Tp Cx Ic unset
.Cx \&\ \&
.Ar argument value
.Cx
The
.Ic set
command will set any one of a number of
.Nm telnet
variables to a specific value or to TRUE.
The special value
.Ic off
turns off the function associated with
the variable, this is equivalent to using the
.Ic unset
command.
The
.Ic unset
command will disable or set to FALSE any of the specified functions.
The values of variables may be interrogated with the
.Ic display
command.
The variables which may be set or unset, but not toggled, are
listed here.  In addition, any of the variables for the
.Ic toggle
command may be explicitly set or unset using
the
.Ic set
and
.Ic unset
commands.
.Tw Fl
.Tp Ic echo
This is the value (initially \*(Lq^E\*(Rq) which, when in
\*(Lqline by line\*(Rq mode, toggles between doing local echoing
of entered characters (for normal processing), and suppressing
echoing of entered characters (for entering, say, a password).
.Tp Ic eof
If
.Nm telnet
is operating in
.Li LINEMODE
or \*(Lqold line by line\*(Rq mode, entering this character
as the first character on a line will cause this character to be
sent to the remote system.
The initial value of the eof character is taken to be the terminal's
.Ic eof
character.
.Tp Ic erase
If
.Nm telnet
is in
.Ic localchars
mode (see
.Ic toggle
.Ic localchars
below),
.Sy and
if
.Nm telnet
is operating in \*(Lqcharacter at a time\*(Rq mode, then when this
character is typed, a
.Li TELNET EC
sequence (see
.Ic send
.Ic ec
above)
is sent to the remote system.
The initial value for the erase character is taken to be
the terminal's
.Ic erase
character.
.Tp Ic escape
This is the
.Nm telnet
escape character (initially \*(Lq^[\*(Rq) which causes entry
into
.Nm telnet
command mode (when connected to a remote system).
.Tp Ic flushoutput
If
.Nm telnet
is in
.Ic localchars
mode (see
.Ic toggle
.Ic localchars
below)
and the
.Ic flushoutput
character is typed, a
.Li TELNET AO
sequence (see
.Ic send
.Ic ao
above)
is sent to the remote host.
The initial value for the flush character is taken to be
the terminal's
.Ic flush
character.
.Tp Ic interrupt
If
.Nm telnet
is in
.Ic localchars
mode (see
.Ic toggle
.Ic localchars
below)
and the
.Ic interrupt
character is typed, a
.Li TELNET IP
sequence (see
.Ic send
.Ic ip
above)
is sent to the remote host.
The initial value for the interrupt character is taken to be
the terminal's
.Ic intr
character.
.Tp Ic kill
If
.Nm telnet
is in
.Ic localchars
mode (see
.Ic toggle
.Ic localchars
below),
.Ic and
if
.Nm telnet
is operating in \*(Lqcharacter at a time\*(Rq mode, then when this
character is typed, a
.Li TELNET EL
sequence (see
.Ic send
.Ic el
above)
is sent to the remote system.
The initial value for the kill character is taken to be
the terminal's
.Ic kill
character.
.Tp Ic lnext
If
.Nm telnet
is operating in
.Li LINEMODE
or \*(Lqold line by line\*(Lq mode, then this character is taken to
be the terminal's
.Ic lnext
character.
The initial value for the lnext character is taken to be
the terminal's
.Ic lnext
character.
.Tp Ic quit
If
.Nm telnet
is in
.Ic localchars
mode (see
.Ic toggle
.Ic localchars
below)
and the
.Ic quit
character is typed, a
.Li TELNET BRK
sequence (see
.Ic send
.Ic brk
above)
is sent to the remote host.
The initial value for the quit character is taken to be
the terminal's
.Ic quit
character.
.Tp Ic reprint
If
.Nm telnet
is operating in
.Li LINEMODE
or \*(Lqold line by line\*(Lq mode, then this character is taken to
be the terminal's
.Ic reprint
character.
The initial value for the reprint character is taken to be
the terminal's
.Ic reprint
character.
.Tp Ic start
If the
.Li TELNET TOGGLE-FLOW-CONTROL
option has been enabled,
then this character is taken to
be the terminal's
.Ic start
character.
The initial value for the kill character is taken to be
the terminal's
.Ic start
character.
.Tp Ic stop
If the
.Li TELNET TOGGLE-FLOW-CONTROL
option has been enabled,
then this character is taken to
be the terminal's
.Ic stop
character.
The initial value for the kill character is taken to be
the terminal's
.Ic stop
character.
.Tp Ic susp
If
.Nm telnet
is in
.Ic localchars
mode, or
.Li LINEMODE
is enabled, and the
.Ic suspend
character is typed, a
.Li TELNET SUSP
sequence (see
.Ic send
.Ic susp
above)
is sent to the remote host.
The initial value for the suspend character is taken to be
the terminal's
.Ic suspend
character.
.Tp Ic tracefile
Thi is the file to which the output, caused by
.Ic netdata
or
.Ic option
tracing being TRUE, will be written.  If it is set to
.Dq Fl ,
then tracing information will be written to standard output (the default).
.Tp Ic worderase
If
.Nm telnet
is operating in
.Li LINEMODE
or \*(Lqold line by line\*(Lq mode, then this character is taken to
be the terminal's
.Ic worderase
character.
The initial value for the worderase character is taken to be
the terminal's
.Ic worderase
character.
.Tp
.Tp Cx Ic slc
.Cx \&\ \&
.Ar state
.Cx
The
.Ic slc
command (Set Local Characters) is used to set
or change the state of the the special
characters when the 
.Li TELNET LINEMODE
option has
been enabled.  Special characters are characters that get
mapped to 
.Li TELNET
commands sequences (like
.Ic ip
or
.Ic quit  )
or line editing characters (like
.Ic erase
and
.Ic kill  ) .
By default, the local special characters are exported.
.Tw Fl
.Tp Ic export
Switch to the local defaults for the special characters.  The
local default characters are those of the local terminal at
the time when
.Nm telnet
was started.
.Tp Ic import
Switch to the remote defaults for the special characters.
The remote default characters are those of the remote system
at the time when the 
.Li TELNET
connection was established.
.Tp Ic check
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.
.Ic Ic \&?
Prints out help information for the
.Ic slc
command.
.Tp
.Tp Ic \&?
Displays the legal
.Ic set
.Pq Ic unset
commands.
.Tp Cx Ic toggle
.Cx \&\ \&
.Ar arguments ...
.Cx
Toggle (between
TRUE
and
FALSE)
various flags that control how
.Nm telnet
responds to events.
These flags may be set explicitly to TRUE or FALSE
using the
.Ic set
and
.Ic unset
commands listed above.
More than one argument may be specified.
The state of these flags may be interrogated with the
.Ic display
command.
Valid arguments are:
.Tw Ar
.Tp Ic autoflush
If
.Ic autoflush
and
.Ic localchars
are both
TRUE,
then when the
.Ic ao  ,
or
.Ic quit
characters are recognized (and transformed into
.Li TELNET
sequences; see
.Ic set
above for details),
.Nm telnet
refuses to display any data on the user's terminal
until the remote system acknowledges (via a
.Li TELNET TIMING MARK
option)
that it has processed those
.Li TELNET
sequences.
The initial value for this toggle is TRUE if the terminal user had not
done an "stty noflsh", otherwise FALSE (see
.Xr stty  1  ) .
.Tp Ic autosynch
If
.Ic autosynch
and
.Ic localchars
are both
TRUE,
then when either the
.Ic intr
or
.Ic quit
characters is typed (see
.Ic set
above for descriptions of the
.Ic intr
and
.Ic quit
characters), the resulting
.Li TELNET
sequence sent is followed by the
.Li TELNET SYNCH
sequence.
This procedure
.Ic should
cause the remote system to begin throwing away all previously
typed input until both of the
.Li TELNET
sequences have been read and acted upon.
The initial value of this toggle is FALSE.
.Tp Ic binary
Enable or disable the
.Li TELNET BINARY
option on both input and output.
.Tp Ic inbinary
Enable or disable the
.Li TELNET BINARY
option on input.
.Tp Ic outbinary
Enable or disable the
.Li TELNET BINARY
option on output.
.Tp Ic crlf
If this is TRUE, then carriage returns will be sent as <CR><LF>.
If this is FALSE, then carriage returns will be send as <CR><NUL>.
The initial value for this toggle is FALSE.
.Tp Ic crmod
Toggle carriage return mode.
When this mode is enabled, most carriage return characters received from
the remote host will be mapped into a carriage return followed by
a line feed.
This mode does not affect those characters typed by the user, only
those received from the remote host.
This mode is not very useful unless the remote host
only sends carriage return, but never line feed.
The initial value for this toggle is FALSE.
.Tp Ic debug
Toggles socket level debugging (useful only to the
.Ic super user  ) .
The initial value for this toggle is FALSE.
.Tp Ic localchars
If this is
TRUE,
then the
.Ic flush  ,
.Ic quit  ,
and
.Ic kill
characters (see
.Ic set
above) are recognized locally, and transformed into (hopefully) appropriate
.Li TELNET
control sequences
(respectively
.Ic ao  ,
.Ic brk  ,
and
.Ic el  ;
see
.Ic send
above).
The initial value for this toggle is TRUE in \*(Lqold line by line\*(Rq mode,
and FALSE in \*(Lqcharacter at a time\*(Rq mode.
When the
.Li LINEMODE
option is enabled, the value of
.Ic localchars
is ignored, and assumed to always be TRUE.
If
.Li LINEMODE
has ever been enabled, then
.Ic quit
is sent as
.Ic abort  ,
and
.Ic eof and
.B suspend
are sent as
.Ic eof and
see
.Ic send
above).
.Tp Ic netdata
Toggles the display of all network data (in hexadecimal format).
The initial value for this toggle is FALSE.
.Tp Ic options
Toggles the display of some internal
.Nm telnet
protocol processing (having to do with
.Li TELNET
options).
The initial value for this toggle is FALSE.
.Tp Ic prettydump
When the
.Ic netdata
toggle is enabled, if
.Ic prettydump
is enabled the output from the
.Ic netdata
command will be formated in a more user readable format.
Spaces are put between each character in the output, and the
begining of any
.Li TELNET
escape sequence is preceeded by a '*' to aid in locating them.
.Tp Ic \&?
Displays the legal
.Ic toggle
commands.
.Tp
.Tp Ic z
Suspend
.Nm telnet  .
This command only works when the user is using the
.Xr csh  1  .
.Tp Cx Ic \&!
.Cx \&\ \&
.Op Ar command
.Cx
Execute a single command in a subshell on the local
system.  If
.Ic command
is ommitted, then an interactive
subshell is invoked.
.Tp Ic status
Show the current status of
.Nm telnet  .
This includes the peer one is connected to, as well
as the current mode.
.Tp Cx Ic \&?
.Cx \&\ \&
.Op Ar command
.Cx
Get help.  With no arguments,
.Nm telnet
prints a help summary.
If a command is specified,
.Nm telnet
will print the help information for just that command.
.Sh ENVIRONMENT
.Nm Telnet
uses the
.Ev HOME ,
.Ev SHELL
and
.Ev TERM
environent variables.
.Sh FILES
.Dw ~/.telnetrc
.Di L
.Dp Pa ~/.telnetrc
user customized telnet startup values
.Dp
.Sh HISTORY
.Nm Telnet
appeared in 4.2 BSD.
.Sh NOTES
.Pp
On some remote systems, echo has to be turned off manually when in
\*(Lqold line by line\*(Rq mode.
.Pp
In \*(Lqold line by line\*(Rq mode or 
.Li LINEMODE
the terminal's
.Ic eof
character is only recognized (and sent to the remote system)
when it is the first character on a line.