summaryrefslogtreecommitdiffstats
path: root/crypto
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2001-07-05 14:08:12 +0000
committerru <ru@FreeBSD.org>2001-07-05 14:08:12 +0000
commit9fe5b34c60e9d1cd8719ea07ca7fd53831545d47 (patch)
tree9aab6614318893d8f91a0512f4ea659b5e0da10b /crypto
parent30aad2eb2c08f8318e41b7b27ef2b1368e0dbf69 (diff)
downloadFreeBSD-src-9fe5b34c60e9d1cd8719ea07ca7fd53831545d47.zip
FreeBSD-src-9fe5b34c60e9d1cd8719ea07ca7fd53831545d47.tar.gz
mdoc(7) police: merge all fixes from non-crypto version.
Diffstat (limited to 'crypto')
-rw-r--r--crypto/telnet/telnet/telnet.1150
1 files changed, 92 insertions, 58 deletions
diff --git a/crypto/telnet/telnet/telnet.1 b/crypto/telnet/telnet/telnet.1
index d734247..96a03db 100644
--- a/crypto/telnet/telnet/telnet.1
+++ b/crypto/telnet/telnet/telnet.1
@@ -42,7 +42,7 @@
protocol
.Sh SYNOPSIS
.Nm
-.Op Fl u468EFKLNcdfry
+.Op Fl 468EFKLNcdfruy
.Op Fl S Ar tos
.Op Fl X Ar authtype
.Op Fl e Ar escapechar
@@ -52,7 +52,7 @@ protocol
.Op Fl s Ar src_addr
.Oo
.Ar host
-.Op port
+.Op Ar port
.Oc
.Sh DESCRIPTION
The
@@ -75,11 +75,6 @@ command with those arguments.
.Pp
Options:
.Bl -tag -width indent
-.It Fl u
-Forces
-.Nm
-to use
-AF_UNIX addresses only (e.g. unix domain sockets, accessed with a file path)
.It Fl 4
Forces
.Nm
@@ -105,7 +100,8 @@ have already been forwarded into the local environment.
Specifies no automatic login to the remote system.
.It Fl L
Specifies an 8-bit data path on output. This causes the
-BINARY option to be negotiated on output.
+.Dv BINARY
+option to be negotiated on output.
.It Fl N
Prevents IP address to name lookup when destination host is given
as an IP address.
@@ -115,7 +111,9 @@ connection to the value
.Ar tos ,
which can be a numeric TOS value
or, on systems that support it, a symbolic
-TOS name found in the /etc/iptos file.
+TOS name found in the
+.Pa /etc/iptos
+file.
.It Fl X Ar atype
Disables the
.Ar atype
@@ -143,15 +141,14 @@ command on this man page.)
Sets the initial value of the
.Ic debug
toggle to
-.Dv TRUE
-.It Fl e Ar escape char
+.Dv TRUE .
+.It Fl e Ar escapechar
Sets the initial
.Nm
-.Nm
escape character to
-.Ar escape char .
+.Ar escapechar .
If
-.Ar escape char
+.Ar escapechar
is omitted, then
there will be no escape character.
.It Fl f
@@ -161,9 +158,12 @@ option allows the local credentials to be forwarded to the remote system.
.It Fl k Ar realm
If Kerberos authentication is being used, the
.Fl k
-option requests that telnet obtain tickets for the remote host in
-realm realm instead of the remote host's realm, as determined
-by
+option requests that
+.Nm
+obtain tickets for the remote host in
+realm
+.Ar realm
+instead of the remote host's realm, as determined by
.Xr krb_realmofhost 3 .
.It Fl l Ar user
When connecting to the remote system, if the remote system
@@ -171,7 +171,8 @@ understands the
.Ev ENVIRON
option, then
.Ar user
-will be sent to the remote system as the value for the variable USER.
+will be sent to the remote system as the value for the variable
+.Ev USER .
This option implies the
.Fl a
option.
@@ -190,13 +191,23 @@ Specifies a user interface similar to
.Xr rlogin 1 .
In this
mode, the escape character is set to the tilde (~) character,
-unless modified by the -e option.
+unless modified by the
+.Fl e
+option.
.It Fl s Ar src_addr
Set the source IP address for the
.Nm
connection to
.Ar src_addr ,
which can be an IP address or a host name.
+.It Fl u
+Forces
+.Nm
+to use
+.Dv AF_UNIX
+addresses only (e.g.,
+.Ux
+domain sockets, accessed with a file path).
.It Fl x
Turns on encryption of the data stream if possible.
This is now the default, so this option is ignored.
@@ -204,9 +215,11 @@ This is now the default, so this option is ignored.
Suppresses encryption of the data stream.
.It Ar host
Indicates the official name, an alias, or the Internet address
-of a remote host. If
+of a remote host.
+If
.Ar host
-starts with a /,
+starts with a
+.Ql / ,
.Nm
establishes a connection to the corresponding named socket.
.It Ar port
@@ -217,9 +230,15 @@ port is used.
.El
.Pp
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.
+remote host; ~ is the
+.Nm
+escape character.
+Similarly, the line ~^Z suspends the
+.Nm
+session.
+The line ~^] escapes to the normal
+.Nm
+escape prompt.
.Pp
Once a connection has been opened,
.Nm
@@ -258,7 +277,7 @@ option is enabled, or if the
.Ic localchars
toggle is
.Dv TRUE
-(the default for \*(Lqold line by line\*(Lq; see below),
+(the default for \*(Lqold line by line\*(Rq; see below),
the user's
.Ic quit ,
.Ic intr ,
@@ -281,7 +300,7 @@ and
is sent as a
.Dv TELNET ABORT
instead of
-.Dv BREAK
+.Dv BREAK .
There are options (see
.Ic toggle
.Ic autoflush
@@ -325,7 +344,8 @@ commands).
The auth command manipulates the information sent through the
.Dv TELNET AUTHENTICATE
option. Valid arguments for the
-auth command are as follows:
+.Ic auth
+command are:
.Bl -tag -width "disable type"
.It Ic disable Ar type
Disables the specified type of authentication. To
@@ -360,7 +380,9 @@ Note: Because of export controls, the
.Dv TELNET ENCRYPT
option is not supported outside of the United States and Canada.
.Pp
-Valid arguments for the encrypt command are as follows:
+Valid arguments for the
+.Ic encrypt
+command are:
.Bl -tag -width Ar
.It Ic disable Ar type Xo
.Op Cm input | output
@@ -421,7 +443,7 @@ commands.
The
.Ic environ
command is used to manipulate the
-the variables that my be sent through the
+variables that may be sent through the
.Dv TELNET ENVIRON
option.
The initial set of variables is taken from the users
@@ -508,13 +530,13 @@ Disable the
.Dv TELNET LINEMODE
option, or, if the remote side does not understand the
.Dv LINEMODE
-option, then enter \*(Lqcharacter at a time\*(Lq mode.
+option, then enter \*(Lqcharacter at a time\*(Rq mode.
.It Ic line
Enable the
.Dv TELNET LINEMODE
option, or, if the remote side does not understand the
.Dv LINEMODE
-option, then attempt to enter \*(Lqold-line-by-line\*(Lq mode.
+option, then attempt to enter \*(Lqold-line-by-line\*(Rq mode.
.It Ic isig Pq Ic \-isig
Attempt to enable (disable) the
.Dv TRAPSIG
@@ -558,8 +580,8 @@ command.
.El
.It Xo
.Ic open Ar host
-.Op Op Fl l Ar user
-.Op Fl Ns Ar port
+.Op Fl l Ar user
+.Op Oo Fl Oc Ns Ar port
.Xc
Open a connection to the named host.
If no port number
@@ -574,7 +596,7 @@ an Internet address specified in the \*(Lqdot notation\*(Rq (see
.Xr inet 3 ) ,
or IPv6 host name or IPv6 coloned-hexadecimal addreess.
The
-.Op Fl l
+.Fl l
option may be used to specify the user name
to be passed to the remote system via the
.Ev ENVIRON
@@ -769,7 +791,7 @@ is enabled, and the status character is typed, a
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 \*(LqAre You There\*(Rq
character is the terminal's status character.
.It Ic echo
This is the value (initially \*(Lq^E\*(Rq) which, when in
@@ -843,7 +865,7 @@ character.
.It Ic forw1
.It Ic forw2
If
-.Tn TELNET
+.Nm
is operating in
.Dv LINEMODE ,
these are the
@@ -902,7 +924,7 @@ If
.Nm
is operating in
.Dv LINEMODE
-or \*(Lqold line by line\*(Lq mode, then this character is taken to
+or \*(Lqold line by line\*(Rq mode, then this character is taken to
be the terminal's
.Ic lnext
character.
@@ -937,7 +959,7 @@ If
.Nm
is operating in
.Dv LINEMODE
-or \*(Lqold line by line\*(Lq mode, then this character is taken to
+or \*(Lqold line by line\*(Rq mode, then this character is taken to
be the terminal's
.Ic reprint
character.
@@ -948,13 +970,17 @@ character.
.It Ic rlogin
This is the rlogin escape character.
If set, the normal
-.Tn TELNET
+.Nm
escape character is ignored unless it is
preceded by this character at the beginning of a line.
This character, at the beginning of a line followed by
a "." closes the connection; when followed by a ^Z it
-suspends the telnet command. The initial state is to
-disable the rlogin escape character.
+suspends the
+.Nm
+command. The initial state is to
+disable the
+.Nm rlogin
+escape character.
.It Ic start
If the
.Dv TELNET TOGGLE-FLOW-CONTROL
@@ -963,7 +989,7 @@ 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 initial value for the start character is taken to be
the terminal's
.Ic start
character.
@@ -975,7 +1001,7 @@ 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 initial value for the stop character is taken to be
the terminal's
.Ic stop
character.
@@ -1014,7 +1040,7 @@ If
.Nm
is operating in
.Dv LINEMODE
-or \*(Lqold line by line\*(Lq mode, then this character is taken to
+or \*(Lqold line by line\*(Rq mode, then this character is taken to
be the terminal's
.Ic worderase
character.
@@ -1028,7 +1054,7 @@ Displays the legal
.Pq Ic unset
commands.
.El
-.It Ic skey Ar sequence challenge
+.It Ic skey Ar sequence challenge
The
.Ic skey
command computes a response to the S/Key challenge.
@@ -1036,7 +1062,7 @@ command computes a response to the S/Key challenge.
The
.Ic slc
command (Set Local Characters) is used to set
-or change the state of the the special
+or change the state of the special
characters when the
.Dv TELNET LINEMODE
option has
@@ -1153,7 +1179,7 @@ option is not supported outside the United States and Canada.
If the remote side supports the
.Dv TELNET AUTHENTICATION
option
-.Tn TELNET
+.Nm
attempts to use it to perform automatic authentication. If the
.Dv AUTHENTICATION
option is not supported, the user's login
@@ -1161,7 +1187,7 @@ name are propagated through the
.Dv TELNET ENVIRON
option.
This command is the same as specifying
-.Ar a
+.Fl a
option on the
.Ic open
command.
@@ -1286,8 +1312,8 @@ and
are sent as
.Ic eof
and
-.Ic susp ,
-see
+.Ic susp
+(see
.Ic send
above).
.It Ic netdata
@@ -1312,12 +1338,12 @@ is enabled the output from the
command will be formatted in a more user readable format.
Spaces are put between each character in the output, and the
beginning of any
-.Tn TELNET
+.Nm
escape sequence is preceded by a '*' to aid in locating them.
.It Ic skiprc
When the skiprc toggle is
.Dv TRUE ,
-.Tn TELNET
+.Nm
skips the reading of the
.Pa \&.telnetrc
file in the users home
@@ -1333,13 +1359,13 @@ When the
.Ic verbose_encrypt
toggle is
.Dv TRUE ,
-.Tn TELNET
+.Nm
prints out a message each time encryption is enabled or
disabled. The initial value for this toggle is
.Dv FALSE .
Note: Because of export controls, data encryption
is not supported outside of the United States and Canada.
-.It Ic \&?
+.It Ic ?\&
Displays the legal
.Ic toggle
commands.
@@ -1352,19 +1378,21 @@ This command only works when the user is using the
.It Ic \&! Op Ar command
Execute a single command in a subshell on the local
system. If
-.Ic command
+.Ar command
is omitted, then an interactive
subshell is invoked.
.It Ic ?\& Op Ar command
Get help. With no arguments,
.Nm
prints a help summary.
-If a command is specified,
+If
+.Ar command
+is specified,
.Nm
will print the help information for just that command.
.El
.Sh ENVIRONMENT
-.Nm Telnet
+.Nm
uses at least the
.Ev HOME ,
.Ev SHELL ,
@@ -1376,6 +1404,12 @@ Other environment variables may be propagated
to the other side via the
.Dv TELNET ENVIRON
option.
+.Sh SEE ALSO
+.Xr rlogin 1 ,
+.Xr rsh 1 ,
+.Xr hosts 5 ,
+.Xr nologin 5 ,
+.Xr telnetd 8
.Sh FILES
.Bl -tag -width ~/.telnetrc -compact
.It Pa ~/.telnetrc
@@ -1383,7 +1417,7 @@ user customized telnet startup values
.El
.Sh HISTORY
The
-.Nm Telnet
+.Nm
command appeared in
.Bx 4.2 .
.Pp
OpenPOWER on IntegriCloud