src/usr.bin/telnet/telnet.1 - diff

Return to telnet.1 CVS log

Up to [local] / src / usr.bin / telnet

Diff for /src/usr.bin/telnet/telnet.1 between version 1.21 and 1.22

version 1.21, 2000/03/04 22:19:26

version 1.22, 2000/03/11 21:40:04

Line 68

.Oc

.Sh DESCRIPTION

The

.Nm telnet

.Nm

command

is used to communicate with another host using the

.Tn TELNET

protocol.

.Nm telnet

.Nm

is invoked without the

.Ar host

argument, it enters command mode,

Line 88

The options are as follows:

.Bl -tag -width indent

.It Fl 8

Specifies an 8-bit data path. This causes an attempt to

Specifies an 8-bit data path.

negotiate the

This causes an attempt to negotiate the

.Dv TELNET BINARY

option on both input and output.

.It Fl E

Line 103

.It Fl K

Specifies no automatic login to the remote system.

.It Fl L

Specifies an 8-bit data path on output. This causes the

Specifies an 8-bit data path on output.

BINARY option to be negotiated on output.

This causes the BINARY option to be negotiated on output.

.It Fl S Ar tos

Sets the IP type-of-service (TOS) option for the telnet

connection to the value

Line 144

.It Fl c

Disables the reading of the user's

.Pa \&.telnetrc

file. (See the

file.

(See the

.Ic toggle skiprc

command on this man page.)

.It Fl d

Line 169

Line 170

If Kerberos authentication is being used, the

.Fl k

option requests that

.Nm telnet

.Nm

obtain tickets for the remote host in

realm

.Ar realm

Line 210

Line 211

Indicates the official name, an alias, or the Internet address

of a remote host.

.It Ar port

Indicates a port number (address of an application). If a number is

Indicates a port number (address of an application).

not specified, the default

If a number is not specified, the default

.Nm telnet

.Nm

port is used.

.El

.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 telnet escape character.

Similarly, the line ~^Z suspends the telnet session.

The line ~^] escapes to the normal telnet escape prompt.

.Pp

Once a connection has been opened,

.Nm telnet

.Nm

will attempt to enable the

.Dv TELNET LINEMODE

option.

If this fails,

.Nm telnet

.Nm

will revert to one of two input modes:

either ``character at a time''

or ``old line by line''

Line 236

Line 238

When

.Dv LINEMODE

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

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

system, so that they can take effect on the local system.

.Pp

Line 296

Line 300

(in the case of

.Ic quit

and

.Ic intr ) .

.Pp

While connected to a remote host,

.Nm telnet

.Nm

command mode may be entered by typing the

.Nm telnet

.Nm

``escape character'' (initially ``^]'').

When in command mode, the normal terminal editing conventions are available.

Note that the escape character will return to the command mode of the initial

invocation of

.Nm telnet

.Nm

that has the controlling terminal. Use the

.Cm send escape

command to switch to command mode in subsequent

.Nm telnet

.Nm

processes on remote hosts.

.Pp

The following

.Nm telnet

.Nm

commands are available.

Only enough of each command to uniquely identify it need be typed

(this is also true for arguments to the

Line 333

Line 337

.Ic auth

command manipulates the information sent through the

.Dv TELNET AUTHENTICATE

option. Valid arguments for the

option.

auth command are as follows:

Valid arguments for the

.Ic auth

command are as follows:

.Bl -tag -width "disable type"

.It Ic disable Ar type

Disables the specified

.Ar type

of authentication. To

of authentication.

obtain a list of available types, use the

To obtain a list of available types, use the

.Ic auth disable \&?

command.

.It Ic enable Ar type

Enables the specified

.Ar type

of authentication. To

of authentication.

obtain a list of available types, use the

To obtain a list of available types, use the

.Ic auth enable \&?

command.

.It Ic status

Line 376

Line 382

.It Ic disable Ar type Ic [input|output]

Disables the specified

.Ar type

of encryption. If you

of encryption.

omit

If you omit

.Ic input

and

.Ic output ,

both input and output

are disabled. To obtain a list of available

are disabled.

types, use the

To obtain a list of available types, use the

.Ic encrypt disable \&?

command.

.It Ic enable Ar type Ic [input|output]

Enables the specified

.Ar type

of encryption. If you

of encryption.

omit

If you omit

.Ic input

and

.Ic 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 \&?

command.

.It Ic input

Line 415

Line 422

.Ic encrypt stop output

command.

.It Ic start Ic [input|output]

Attempts to start encryption. If you omit

Attempts to start encryption.

If you omit

.Ic input

and

.Ic output,

both input and output are enabled. To

both input and output are enabled.

obtain a list of available types, use the

To obtain a list of available types, use the

.Ic encrypt enable \&?

command.

.It Ic status

Lists the current status of encryption.

.It Ic stop Ic [input|output]

Stops encryption. If you omit

Stops encryption.

If you omit

.Ic input

and

.Ic output ,

Line 587

Line 596

Open a connection to the named host.

If no port number

is specified,

.Nm telnet

.Nm

will attempt to contact a

.Tn TELNET

server at the default port.

Line 602

Line 611

.Ev ENVIRON

option.

When connecting to a non-standard port,

.Nm telnet

.Nm

omits any automatic initiation of

.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.

After establishing a connection, the file

.Pa \&.telnetrc

in the

user's home directory is opened. Lines beginning with a ``#'' are

user's home directory is opened.

comment lines. Blank lines are ignored. Lines that begin

Lines beginning with a ``#'' are

without whitespace are the start of a machine entry. The

comment lines.

first thing on the line is the name of the machine that is

Blank lines are ignored.

being connected to. The rest of the line, and successive

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

.Nm

commands and are processed as if they had been typed

in manually to the

.Nm telnet

.Nm

command prompt.

.It Ic quit

Close any open

Line 681

Line 695

sequence.

.It Ic escape

Sends the current

.Nm telnet

.Nm

escape character (initially ``^]'').

.It Ic ga

Sends the

Line 801

Line 815

The

.Ic set

command will set any one of a number of

.Nm telnet

.Nm

variables to a specific value or to

.Dv TRUE .

The special value

Line 819

Line 833

.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

listed here.

In addition, any of the variables for the

.Ic toggle

command may be explicitly set or unset using

the

Line 840

Line 855

sequence (see

.Ic send ayt

preceding) is sent to the

remote host. The initial value for the "Are You There"

remote host.

The initial value for the "Are You There"

character is the terminal's status character.

.It Ic echo

This is the value (initially ``^E'') which, when in

Line 849

Line 865

echoing of entered characters (for entering, say, a password).

.It Ic eof

.Nm telnet

.Nm

is operating in

.Dv LINEMODE

or ``old line by line'' mode, entering this character

Line 862

Line 878

character.

.It Ic erase

.Nm telnet

.Nm

is in

.Ic localchars

mode (see

Line 870

Line 886

.Ic localchars

below),

and if

.Nm telnet

.Nm

is operating in ``character at a time'' mode, then when this

character is typed, a

.Dv TELNET EC

Line 887

Line 903

character.

.It Ic escape

This is the

.Nm telnet

.Nm

escape character (initially ``^['') which causes entry

into

.Nm telnet

.Nm

command mode (when connected to a remote system).

.It Ic flushoutput

.Nm telnet

.Nm

is in

.Ic localchars

mode (see

Line 924

Line 940

.Dv LINEMODE ,

these are the

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

eol and eol2 characters.

.It Ic interrupt

.Nm telnet

.Nm

is in

.Ic localchars

mode (see

Line 953

Line 970

character.

.It Ic kill

.Nm telnet

.Nm

is in

.Ic localchars

mode (see

Line 961

Line 978

.Ic localchars

below),

and if

.Nm telnet

.Nm

is operating in ``character at a time'' mode, then when this

character is typed, a

.Dv TELNET EL

Line 978

Line 995

character.

.It Ic lnext

.Nm telnet

.Nm

is operating in

.Dv LINEMODE

or ``old line by line'' mode, then this character is taken to

Line 993

Line 1010

character.

.It Ic quit

.Nm telnet

.Nm

is in

.Ic localchars

mode (see

Line 1017

Line 1034

character.

.It Ic reprint

.Nm telnet

.Nm

is operating in

.Dv LINEMODE

or old line by line'' mode, then this character is taken to

Line 1039

Line 1056

This character, at the beginning of a line, followed by

a "." closes the connection; when followed by a ^Z it

suspends the

.Nm telnet

.Nm

command. The initial state is to

command.

The initial state is to

disable the

.Ic rlogin

escape character.

Line 1074

Line 1092

character.

.It Ic susp

.Nm telnet

.Nm

is in

.Ic localchars

mode, or

Line 1101

Line 1119

.Ic option

tracing being

.Dv TRUE ,

will be written. If it is set to

will be written.

If it is set to

.Dq Fl ,

then tracing information will be written to standard output (the default).

.It Ic worderase

.Nm telnet

.Nm

is operating in

.Dv LINEMODE

or ``old line by line'' mode, then this character is taken to

Line 1139

Line 1158

characters when the

.Dv TELNET LINEMODE

option has

been enabled. Special characters are characters that get

been enabled.

mapped to

Special characters are characters that get mapped to

.Tn TELNET

commands sequences (like

.Ic ip

.Ic quit )

or line editing characters (like

.Ic erase

and

.Ic kill ) .

By default, the local special characters are exported.

.Bl -tag -width Fl

.It Ic check

Line 1158

Line 1177

character settings, and if there are any discrepancies with

the local side, the local side will switch to the remote value.

.It Ic export

Switch to the local defaults for the special characters. The

Switch to the local defaults for the special characters.

local default characters are those of the local terminal at

The local default characters are those of the local terminal at

the time when

.Nm telnet

.Nm

was started.

.It Ic import

Switch to the remote defaults for the special characters.

Line 1185

Line 1204

and

.Dv FALSE )

various flags that control how

.Nm telnet

.Nm

responds to events.

These flags may be set explicitly to

.Dv TRUE

Line 1220

Line 1239

sequences; see

.Ic set

above for details),

.Nm telnet

.Nm

refuses to display any data on the user's terminal

until the remote system acknowledges (via a

.Dv TELNET TIMING MARK

Line 1234

Line 1253

done an "stty noflsh", otherwise

.Dv FALSE

(see

.Xr stty 1 ) .

.It Ic autodecrypt

When the

.Dv TELNET ENCRYPT

option is negotiated, by

default the actual encryption (decryption) of the data

stream does not start automatically. The

stream does not start automatically.

The

.Ic autoencrypt

.Pq Ic autodecrypt

command states that encryption of the

Line 1252

Line 1272

.Dv TELNET AUTHENTICATION

option

.Tn TELNET

attempts to use it to perform automatic authentication. If the

attempts to use it to perform automatic authentication.

If the

.Dv AUTHENTICATION

option is not supported, the user's login

name are propagated through the

Line 1354

Line 1375

.Ic brk ,

.Ic ec ,

and

.Ic el ;

see

.Ic send

above).

Line 1393

Line 1414

.Dv FALSE .

.It Ic options

Toggles the display of some internal

.Nm telnet

.Nm

protocol processing (having to do with

.Tn TELNET

options).

Line 1418

Line 1439

skips the reading of the

.Pa \&.telnetrc

file in the user's home

directory when connections are opened. The initial

directory when connections are opened.

value for this toggle is

The initial value for this toggle is

.Dv FALSE .

.It Ic termdata

Toggles the display of all terminal data (in hexadecimal format).

Line 1430

Line 1451

.Ic verbose_encrypt

toggle is

.Dv TRUE ,

.Nm telnet

.Nm

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 .

.It Ic \&?

Displays the legal

Line 1446

Line 1468

.Xr csh 1 .

.It Ic \&! Op Ar command

Execute a single command in a subshell on the local

system. If

system.

.Ar command

is omitted, then an interactive

subshell is invoked.

.It Ic \&? Op Ar command

Get help. With no arguments,

Get help.

.Nm telnet

With no arguments,

.Nm

prints a help summary.

If a command is specified,

.Nm telnet

.Nm

will print the help information for just that command.

.El

.Sh ENVIRONMENT

.Nm telnet

.Nm

uses at least the

.Ev HOME ,

.Ev SHELL ,

Line 1478

Line 1502

.El

.Sh HISTORY

The

.Nm telnet

.Nm

command appeared in

.Bx 4.2 .

.Sh NOTES