- Soften sentence breaks.

- Remove double whitespace.
- Sort sections.


git-svn-id: http://svn0.us-east.freebsd.org/base/head/contrib/telnet@140601 ccf9f872-aa2e-dd11-9fc8-001c23d0bc1f
This commit is contained in:
ru 2005-01-21 21:57:05 +00:00
parent 82ff960df9
commit 26fb67c648
2 changed files with 112 additions and 71 deletions

View File

@ -84,7 +84,8 @@ Forces
.Nm .Nm
to use IPv6 addresses only. to use IPv6 addresses only.
.It Fl 8 .It Fl 8
Specifies an 8-bit data path. This causes an attempt to Specifies an 8-bit data path.
This causes an attempt to
negotiate the negotiate the
.Dv TELNET BINARY .Dv TELNET BINARY
option on both input and output. option on both input and output.
@ -99,7 +100,8 @@ have already been forwarded into the local environment.
.It Fl K .It Fl K
Specifies no automatic login to the remote system. Specifies no automatic login to the remote system.
.It Fl L .It Fl L
Specifies an 8-bit data path on output. This causes the Specifies an 8-bit data path on output.
This causes the
.Dv BINARY .Dv BINARY
option to be negotiated on output. option to be negotiated on output.
.It Fl N .It Fl N
@ -134,7 +136,8 @@ otherwise it is the name associated with the user ID.
.It Fl c .It Fl c
Disables the reading of the user's Disables the reading of the user's
.Pa \&.telnetrc .Pa \&.telnetrc
file. (See the file.
(See the
.Ic toggle skiprc .Ic toggle skiprc
command on this man page.) command on this man page.)
.It Fl d .It Fl d
@ -223,13 +226,14 @@ starts with a
.Nm .Nm
establishes a connection to the corresponding named socket. establishes a connection to the corresponding named socket.
.It Ar port .It Ar port
Indicates a port number (address of an application). If a number is Indicates a port number (address of an application).
If a number is
not specified, the default not specified, the default
.Nm .Nm
port is used. port is used.
.El .El
.Pp .Pp
When in rlogin mode, a line of the form ~. disconnects from the When in rlogin mode, a line of the form ~. disconnects from the
remote host; ~ is the remote host; ~ is the
.Nm .Nm
escape character. escape character.
@ -255,9 +259,11 @@ depending on what the remote system supports.
When When
.Dv LINEMODE .Dv LINEMODE
is enabled, character processing is done on the is enabled, character processing is done on the
local system, under the control of the remote system. When input local system, under the control of the remote system.
When input
editing or character echoing is to be disabled, the remote system editing or character echoing is to be disabled, the remote system
will relay that information. The remote system will also relay will relay that information.
The remote system will also relay
changes to any special characters that happen on the remote changes to any special characters that happen on the remote
system, so that they can take effect on the local system. system, so that they can take effect on the local system.
.Pp .Pp
@ -279,7 +285,7 @@ toggle is
.Dv TRUE .Dv TRUE
(the default for \*(Lqold line by line\*(Rq; see below), (the default for \*(Lqold line by line\*(Rq; see below),
the user's the user's
.Ic quit , .Ic quit ,
.Ic intr , .Ic intr ,
and and
.Ic flush .Ic flush
@ -315,7 +321,7 @@ sequence) and flush previous terminal input
(in the case of (in the case of
.Ic quit .Ic quit
and and
.Ic intr ) . .Ic intr ) .
.Pp .Pp
While connected to a remote host, While connected to a remote host,
.Nm .Nm
@ -329,11 +335,11 @@ The following
commands are available. commands are available.
Only enough of each command to uniquely identify it need be typed Only enough of each command to uniquely identify it need be typed
(this is also true for arguments to the (this is also true for arguments to the
.Ic mode , .Ic mode ,
.Ic set , .Ic set ,
.Ic toggle , .Ic toggle ,
.Ic unset , .Ic unset ,
.Ic slc , .Ic slc ,
.Ic environ , .Ic environ ,
and and
.Ic display .Ic display
@ -343,17 +349,20 @@ commands).
.It Ic auth Ar argument ... .It Ic auth Ar argument ...
The auth command manipulates the information sent through the The auth command manipulates the information sent through the
.Dv TELNET AUTHENTICATE .Dv TELNET AUTHENTICATE
option. Valid arguments for the option.
Valid arguments for the
.Ic auth .Ic auth
command are: command are:
.Bl -tag -width "disable type" .Bl -tag -width "disable type"
.It Ic disable Ar type .It Ic disable Ar type
Disables the specified type of authentication. To Disables the specified type of authentication.
To
obtain a list of available types, use the obtain a list of available types, use the
.Ic auth disable ?\& .Ic auth disable ?\&
command. command.
.It Ic enable Ar type .It Ic enable Ar type
Enables the specified type of authentication. To Enables the specified type of authentication.
To
obtain a list of available types, use the obtain a list of available types, use the
.Ic auth enable ?\& .Ic auth enable ?\&
command. command.
@ -383,18 +392,22 @@ command are:
.It Ic disable Ar type Xo .It Ic disable Ar type Xo
.Op Cm input | output .Op Cm input | output
.Xc .Xc
Disables the specified type of encryption. If you Disables the specified type of encryption.
If you
omit the input and output, both input and output omit the input and output, both input and output
are disabled. To obtain a list of available are disabled.
To obtain a list of available
types, use the types, use the
.Ic encrypt disable ?\& .Ic encrypt disable ?\&
command. command.
.It Ic enable Ar type Xo .It Ic enable Ar type Xo
.Op Cm input | output .Op Cm input | output
.Xc .Xc
Enables the specified type of encryption. If you Enables the specified type of encryption.
If you
omit input and output, both input and output are omit input and output, both input and output are
enabled. To obtain a list of available types, use the enabled.
To obtain a list of available types, use the
.Ic encrypt enable ?\& .Ic encrypt enable ?\&
command. command.
.It Ic input .It Ic input
@ -414,18 +427,21 @@ This is the same as the
.Ic encrypt stop output .Ic encrypt stop output
command. command.
.It Ic start Op Cm input | output .It Ic start Op Cm input | output
Attempts to start encryption. If you omit Attempts to start encryption.
If you omit
.Ic input .Ic input
and and
.Ic output , .Ic output ,
both input and output are enabled. To both input and output are enabled.
To
obtain a list of available types, use the obtain a list of available types, use the
.Ic encrypt enable ?\& .Ic encrypt enable ?\&
command. command.
.It Ic status .It Ic status
Lists the current status of encryption. Lists the current status of encryption.
.It Ic stop Op Cm input | output .It Ic stop Op Cm input | output
Stops encryption. If you omit input and output, Stops encryption.
If you omit input and output,
encryption is on both input and output. encryption is on both input and output.
.It Ic type Ar type .It Ic type Ar type
Sets the default type of encryption to be used Sets the default type of encryption to be used
@ -587,7 +603,7 @@ will attempt to contact a
.Tn TELNET .Tn TELNET
server at the default port. server at the default port.
The host specification may be either a host name (see The host specification may be either a host name (see
.Xr hosts 5 ) , .Xr hosts 5 ) ,
an Internet address specified in the \*(Lqdot notation\*(Rq (see an Internet address specified in the \*(Lqdot notation\*(Rq (see
.Xr inet 3 ) , .Xr inet 3 ) ,
or IPv6 host name or IPv6 coloned-hexadecimal addreess. or IPv6 host name or IPv6 coloned-hexadecimal addreess.
@ -601,16 +617,22 @@ When connecting to a non-standard port,
.Nm .Nm
omits any automatic initiation of omits any automatic initiation of
.Tn TELNET .Tn TELNET
options. When the port number is preceded by a minus sign, options.
When the port number is preceded by a minus sign,
the initial option negotiation is done. the initial option negotiation is done.
After establishing a connection, the file After establishing a connection, the file
.Pa \&.telnetrc .Pa \&.telnetrc
in the in the
users home directory is opened. Lines beginning with a # are users home directory is opened.
comment lines. Blank lines are ignored. Lines that begin Lines beginning with a # are
without white space are the start of a machine entry. The comment lines.
Blank lines are ignored.
Lines that begin
without white space are the start of a machine entry.
The
first thing on the line is the name of the machine that is first thing on the line is the name of the machine that is
being connected to. The rest of the line, and successive being connected to.
The rest of the line, and successive
lines that begin with white space are assumed to be lines that begin with white space are assumed to be
.Nm .Nm
commands and are processed as if they had been typed commands and are processed as if they had been typed
@ -768,7 +790,8 @@ The values of variables may be interrogated with the
.Ic display .Ic display
command. command.
The variables which may be set or unset, but not toggled, are The variables which may be set or unset, but not toggled, are
listed here. In addition, any of the variables for the listed here.
In addition, any of the variables for the
.Ic toggle .Ic toggle
command may be explicitly set or unset using command may be explicitly set or unset using
the the
@ -787,7 +810,8 @@ is enabled, and the status character is typed, a
sequence (see sequence (see
.Ic send ayt .Ic send ayt
preceding) is sent to the preceding) is sent to the
remote host. The initial value for the \*(LqAre You There\*(Rq remote host.
The initial value for the \*(LqAre You There\*(Rq
character is the terminal's status character. character is the terminal's status character.
.It Ic echo .It Ic echo
This is the value (initially \*(Lq^E\*(Rq) which, when in This is the value (initially \*(Lq^E\*(Rq) which, when in
@ -866,7 +890,8 @@ is operating in
.Dv LINEMODE , .Dv LINEMODE ,
these are the these are the
characters that, when typed, cause partial lines to be characters that, when typed, cause partial lines to be
forwarded to the remote system. The initial value for forwarded to the remote system.
The initial value for
the forwarding characters are taken from the terminal's the forwarding characters are taken from the terminal's
eol and eol2 characters. eol and eol2 characters.
.It Ic interrupt .It Ic interrupt
@ -970,10 +995,11 @@ If set, the normal
escape character is ignored unless it is escape character is ignored unless it is
preceded by this character at the beginning of a line. preceded by this character at the beginning of a line.
This character, at the beginning of a line followed by This character, at the beginning of a line followed by
a "." closes the connection; when followed by a ^Z it a "." closes the connection; when followed by a ^Z it
suspends the suspends the
.Nm .Nm
command. The initial state is to command.
The initial state is to
disable the disable the
.Nm rlogin .Nm rlogin
escape character. escape character.
@ -1028,7 +1054,8 @@ or
.Ic option .Ic option
tracing being tracing being
.Dv TRUE , .Dv TRUE ,
will be written. If it is set to will be written.
If it is set to
.Dq Fl , .Dq Fl ,
then tracing information will be written to standard output (the default). then tracing information will be written to standard output (the default).
.It Ic worderase .It Ic worderase
@ -1062,17 +1089,18 @@ or change the state of the special
characters when the characters when the
.Dv TELNET LINEMODE .Dv TELNET LINEMODE
option has option has
been enabled. Special characters are characters that get been enabled.
Special characters are characters that get
mapped to mapped to
.Tn TELNET .Tn TELNET
commands sequences (like commands sequences (like
.Ic ip .Ic ip
or or
.Ic quit ) .Ic quit )
or line editing characters (like or line editing characters (like
.Ic erase .Ic erase
and and
.Ic kill ) . .Ic kill ) .
By default, the local special characters are exported. By default, the local special characters are exported.
.Bl -tag -width Fl .Bl -tag -width Fl
.It Ic check .It Ic check
@ -1081,7 +1109,8 @@ The remote side is requested to send all the current special
character settings, and if there are any discrepancies with character settings, and if there are any discrepancies with
the local side, the local side will switch to the remote value. the local side, the local side will switch to the remote value.
.It Ic export .It Ic export
Switch to the local defaults for the special characters. The Switch to the local defaults for the special characters.
The
local default characters are those of the local terminal at local default characters are those of the local terminal at
the time when the time when
.Nm .Nm
@ -1135,7 +1164,7 @@ and
are both are both
.Dv TRUE , .Dv TRUE ,
then when the then when the
.Ic ao , .Ic ao ,
or or
.Ic quit .Ic quit
characters are recognized (and transformed into characters are recognized (and transformed into
@ -1157,13 +1186,14 @@ if the terminal user had not
done an "stty noflsh", otherwise done an "stty noflsh", otherwise
.Dv FALSE .Dv FALSE
(see (see
.Xr stty 1 ) . .Xr stty 1 ) .
.It Ic autodecrypt .It Ic autodecrypt
When the When the
.Dv TELNET ENCRYPT .Dv TELNET ENCRYPT
option is negotiated, by option is negotiated, by
default the actual encryption (decryption) of the data default the actual encryption (decryption) of the data
stream does not start automatically. The autoencrypt stream does not start automatically.
The autoencrypt
(autodecrypt) command states that encryption of the (autodecrypt) command states that encryption of the
output (input) stream should be enabled as soon as output (input) stream should be enabled as soon as
possible. possible.
@ -1172,7 +1202,8 @@ If the remote side supports the
.Dv TELNET AUTHENTICATION .Dv TELNET AUTHENTICATION
option option
.Nm .Nm
attempts to use it to perform automatic authentication. If the attempts to use it to perform automatic authentication.
If the
.Dv AUTHENTICATION .Dv AUTHENTICATION
option is not supported, the user's login option is not supported, the user's login
name are propagated through the name are propagated through the
@ -1249,7 +1280,7 @@ The initial value for this toggle is
.Dv FALSE . .Dv FALSE .
.It Ic debug .It Ic debug
Toggles socket level debugging (useful only to the Toggles socket level debugging (useful only to the
.Ic super user ) . .Ic super user ) .
The initial value for this toggle is The initial value for this toggle is
.Dv FALSE . .Dv FALSE .
.It Ic encdebug .It Ic encdebug
@ -1258,9 +1289,9 @@ Turns on debugging information for the encryption code.
If this is If this is
.Dv TRUE , .Dv TRUE ,
then the then the
.Ic flush , .Ic flush ,
.Ic interrupt , .Ic interrupt ,
.Ic quit , .Ic quit ,
.Ic erase , .Ic erase ,
and and
.Ic kill .Ic kill
@ -1270,12 +1301,12 @@ above) are recognized locally, and transformed into (hopefully) appropriate
.Tn TELNET .Tn TELNET
control sequences control sequences
(respectively (respectively
.Ic ao , .Ic ao ,
.Ic ip , .Ic ip ,
.Ic brk , .Ic brk ,
.Ic ec , .Ic ec ,
and and
.Ic el ; .Ic el ;
see see
.Ic send .Ic send
above). above).
@ -1296,7 +1327,7 @@ If
has ever been enabled, then has ever been enabled, then
.Ic quit .Ic quit
is sent as is sent as
.Ic abort , .Ic abort ,
and and
.Ic eof .Ic eof
and and
@ -1339,7 +1370,8 @@ When the skiprc toggle is
skips the reading of the skips the reading of the
.Pa \&.telnetrc .Pa \&.telnetrc
file in the users home file in the users home
directory when connections are opened. The initial directory when connections are opened.
The initial
value for this toggle is value for this toggle is
.Dv FALSE . .Dv FALSE .
.It Ic termdata .It Ic termdata
@ -1353,7 +1385,8 @@ toggle is
.Dv TRUE , .Dv TRUE ,
.Nm .Nm
prints out a message each time encryption is enabled or prints out a message each time encryption is enabled or
disabled. The initial value for this toggle is disabled.
The initial value for this toggle is
.Dv FALSE . .Dv FALSE .
.It Ic ?\& .It Ic ?\&
Displays the legal Displays the legal
@ -1364,15 +1397,17 @@ commands.
Suspend Suspend
.Nm . .Nm .
This command only works when the user is using the This command only works when the user is using the
.Xr csh 1 . .Xr csh 1 .
.It Ic \&! Op Ar command .It Ic \&! Op Ar command
Execute a single command in a subshell on the local Execute a single command in a subshell on the local
system. If system.
If
.Ar command .Ar command
is omitted, then an interactive is omitted, then an interactive
subshell is invoked. subshell is invoked.
.It Ic ?\& Op Ar command .It Ic ?\& Op Ar command
Get help. With no arguments, Get help.
With no arguments,
.Nm .Nm
prints a help summary. prints a help summary.
If If
@ -1394,17 +1429,17 @@ Other environment variables may be propagated
to the other side via the to the other side via the
.Dv TELNET ENVIRON .Dv TELNET ENVIRON
option. option.
.Sh FILES
.Bl -tag -width ~/.telnetrc -compact
.It Pa ~/.telnetrc
user customized telnet startup values
.El
.Sh SEE ALSO .Sh SEE ALSO
.Xr rlogin 1 , .Xr rlogin 1 ,
.Xr rsh 1 , .Xr rsh 1 ,
.Xr hosts 5 , .Xr hosts 5 ,
.Xr nologin 5 , .Xr nologin 5 ,
.Xr telnetd 8 .Xr telnetd 8
.Sh FILES
.Bl -tag -width ~/.telnetrc -compact
.It Pa ~/.telnetrc
user customized telnet startup values
.El
.Sh HISTORY .Sh HISTORY
The The
.Nm .Nm

View File

@ -144,12 +144,14 @@ All user verification will happen through the
program. program.
.El .El
.It Fl B .It Fl B
Specify bftp server mode. In this mode, Specify bftp server mode.
In this mode,
.Nm .Nm
causes login to start a causes login to start a
.Xr bftp 1 .Xr bftp 1
session rather than the user's session rather than the user's
normal shell. In bftp daemon mode normal normal shell.
In bftp daemon mode normal
logins are not supported, and it must be used logins are not supported, and it must be used
on a port other than the normal on a port other than the normal
.Tn TELNET .Tn TELNET
@ -202,7 +204,8 @@ login has been completed.
This option is only useful if This option is only useful if
.Nm .Nm
has been compiled with both linemode and kludge linemode has been compiled with both linemode and kludge linemode
support. If the support.
If the
.Fl k .Fl k
option is specified, then if the remote client does not option is specified, then if the remote client does not
support the support the
@ -227,8 +230,8 @@ in response to a
.Dv DO TIMING-MARK ) .Dv DO TIMING-MARK )
for kludge linemode support. for kludge linemode support.
.It Fl l .It Fl l
Specify line mode. Try to force clients to use line- Specify line mode.
at-a-time mode. Try to force clients to use line-at-a-time mode.
If the If the
.Dv LINEMODE .Dv LINEMODE
option is not supported, it will go option is not supported, it will go
@ -236,7 +239,8 @@ into kludge linemode.
.It Fl n .It Fl n
Disable Disable
.Dv TCP .Dv TCP
keep-alives. Normally keep-alives.
Normally
.Nm .Nm
enables the enables the
.Tn TCP .Tn TCP
@ -248,7 +252,8 @@ be reached may be cleaned up.
.It Fl p Ar loginprog .It Fl p Ar loginprog
Specify an alternate Specify an alternate
.Xr login 1 .Xr login 1
command to run to complete the login. The alternate command must command to run to complete the login.
The alternate command must
understand the same command arguments as the standard login. understand the same command arguments as the standard login.
.It Fl S Ar tos .It Fl S Ar tos
Sets the IP type-of-service (TOS) option for the telnet Sets the IP type-of-service (TOS) option for the telnet
@ -498,7 +503,8 @@ and
capabilities from capabilities from
.Pa /etc/gettytab .Pa /etc/gettytab
and use that information (if present) to determine and use that information (if present) to determine
what to display before the login: prompt. You can what to display before the login: prompt.
You can
also use a System V style also use a System V style
.Pa /etc/issue .Pa /etc/issue
file by using the file by using the
@ -523,9 +529,9 @@ will be displayed to both console and remote logins.
.Sh "SEE ALSO" .Sh "SEE ALSO"
.Xr bftp 1 , .Xr bftp 1 ,
.Xr login 1 , .Xr login 1 ,
.Xr gettytab 5 ,
.Xr telnet 1 .Xr telnet 1
(if supported) (if supported),
.Xr gettytab 5
.Sh STANDARDS .Sh STANDARDS
.Bl -tag -compact -width RFC-1572 .Bl -tag -compact -width RFC-1572
.It Cm RFC-854 .It Cm RFC-854
@ -572,6 +578,8 @@ Telnet Environment Option Interoperability Issues
.It Cm RFC-1572 .It Cm RFC-1572
Telnet Environment Option Telnet Environment Option
.El .El
.Sh HISTORY
IPv6 support was added by WIDE/KAME project.
.Sh BUGS .Sh BUGS
Some Some
.Tn TELNET .Tn TELNET
@ -598,5 +606,3 @@ never sends
.Tn TELNET .Tn TELNET
.Dv IAC GA .Dv IAC GA
(go ahead) commands. (go ahead) commands.
.Sh HISTORY
IPv6 support was added by WIDE/KAME project.