[BACK]Return to telnet.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / telnet

Annotation of src/usr.bin/telnet/telnet.1, Revision 1.45

1.45    ! jmc         1: .\"    $OpenBSD: telnet.1,v 1.44 2012/03/01 04:51:16 lum Exp $
1.2       niklas      2: .\"    $NetBSD: telnet.1,v 1.5 1996/02/28 21:04:12 thorpej Exp $
                      3: .\"
1.1       deraadt     4: .\" Copyright (c) 1983, 1990, 1993
                      5: .\"    The Regents of the University of California.  All rights reserved.
                      6: .\"
                      7: .\" Redistribution and use in source and binary forms, with or without
                      8: .\" modification, are permitted provided that the following conditions
                      9: .\" are met:
                     10: .\" 1. Redistributions of source code must retain the above copyright
                     11: .\"    notice, this list of conditions and the following disclaimer.
                     12: .\" 2. Redistributions in binary form must reproduce the above copyright
                     13: .\"    notice, this list of conditions and the following disclaimer in the
                     14: .\"    documentation and/or other materials provided with the distribution.
1.32      millert    15: .\" 3. Neither the name of the University nor the names of its contributors
1.1       deraadt    16: .\"    may be used to endorse or promote products derived from this software
                     17: .\"    without specific prior written permission.
                     18: .\"
                     19: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     20: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     21: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     22: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     23: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     24: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     25: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     26: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     27: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     28: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     29: .\" SUCH DAMAGE.
                     30: .\"
                     31: .\"    from: @(#)telnet.1      8.4 (Berkeley) 2/3/94
                     32: .\"
1.45    ! jmc        33: .Dd $Mdocdate: March 1 2012 $
1.1       deraadt    34: .Dt TELNET 1
1.16      aaron      35: .Os
1.1       deraadt    36: .Sh NAME
                     37: .Nm telnet
1.16      aaron      38: .Nd user interface to the
1.1       deraadt    39: .Tn TELNET
                     40: protocol
                     41: .Sh SYNOPSIS
                     42: .Nm telnet
1.31      deraadt    43: .Bk -words
1.38      jmc        44: .Op Fl 468acdEFfKLrx
1.3       niklas     45: .Op Fl b Ar hostalias
1.1       deraadt    46: .Op Fl e Ar escapechar
                     47: .Op Fl k Ar realm
                     48: .Op Fl l Ar user
                     49: .Op Fl n Ar tracefile
1.43      guenther   50: .Op Fl V Ar rtable
1.38      jmc        51: .Op Fl X Ar authtype
1.1       deraadt    52: .Oo
                     53: .Ar host
1.9       deraadt    54: .Op Ar port
1.1       deraadt    55: .Oc
1.31      deraadt    56: .Ek
1.1       deraadt    57: .Sh DESCRIPTION
                     58: The
1.22      aaron      59: .Nm
1.1       deraadt    60: command
1.16      aaron      61: is used to communicate with another host using the
1.1       deraadt    62: .Tn TELNET
                     63: protocol.
                     64: If
1.22      aaron      65: .Nm
1.1       deraadt    66: is invoked without the
                     67: .Ar host
                     68: argument, it enters command mode,
                     69: indicated by its prompt
                     70: .Pq Nm telnet\&> .
                     71: In this mode, it accepts and executes the commands listed below.
                     72: If it is invoked with arguments, it performs an
                     73: .Ic open
                     74: command with those arguments.
                     75: .Pp
1.19      aaron      76: The options are as follows:
1.27      aaron      77: .Bl -tag -width Ds
1.37      otto       78: .It Fl 4
                     79: Forces
                     80: .Nm
                     81: to use IPv4 addresses only.
                     82: .It Fl 6
                     83: Forces
                     84: .Nm
                     85: to use IPv6 addresses only.
1.1       deraadt    86: .It Fl 8
1.22      aaron      87: Specifies an 8-bit data path.
                     88: This causes an attempt to negotiate the
1.1       deraadt    89: .Dv TELNET BINARY
                     90: option on both input and output.
                     91: .It Fl a
                     92: Attempt automatic login.
                     93: Currently, this sends the user name via the
                     94: .Ev USER
                     95: variable
                     96: of the
                     97: .Ev ENVIRON
                     98: option if supported by the remote system.
                     99: The name used is that of the current user as returned by
                    100: .Xr getlogin 2
                    101: if it agrees with the current user ID,
                    102: otherwise it is the name associated with the user ID.
1.3       niklas    103: .It Fl b Ar hostalias
                    104: Uses
                    105: .Xr bind 2
1.12      aaron     106: on the local socket to bind it to an aliased address (see
1.3       niklas    107: .Xr ifconfig 8
1.12      aaron     108: and the ``alias'' specifier) or to the address of
1.3       niklas    109: another interface than the one naturally chosen by
                    110: .Xr connect 2 .
1.12      aaron     111: This can be useful when connecting to services which use IP addresses
1.3       niklas    112: for authentication and reconfiguration of the server is undesirable (or
                    113: impossible).
1.1       deraadt   114: .It Fl c
                    115: Disables the reading of the user's
                    116: .Pa \&.telnetrc
1.22      aaron     117: file.
                    118: (See the
1.1       deraadt   119: .Ic toggle skiprc
                    120: command on this man page.)
                    121: .It Fl d
                    122: Sets the initial value of the
                    123: .Ic debug
                    124: toggle to
1.12      aaron     125: .Dv TRUE .
1.38      jmc       126: .It Fl E
                    127: Stops any character from being recognized as an escape character.
1.16      aaron     128: .It Fl e Ar escapechar
1.1       deraadt   129: Sets the initial
                    130: .Nm
                    131: escape character to
1.33      jmc       132: .Ar escapechar .
1.1       deraadt   133: If
1.8       deraadt   134: .Ar escapechar
1.1       deraadt   135: is omitted, then
                    136: there will be no escape character.
1.38      jmc       137: .It Fl F
                    138: If Kerberos authentication is being used, the
                    139: .Fl F
                    140: option allows the local credentials to be forwarded
                    141: to the remote system, including any credentials that
                    142: have already been forwarded into the local environment.
1.1       deraadt   143: .It Fl f
1.34      jmc       144: If Kerberos authentication is being used, the
1.1       deraadt   145: .Fl f
                    146: option allows the local credentials to be forwarded to the remote system.
1.38      jmc       147: .It Fl K
                    148: Specifies no automatic login to the remote system.
1.1       deraadt   149: .It Fl k Ar realm
                    150: If Kerberos authentication is being used, the
                    151: .Fl k
1.12      aaron     152: option requests that
1.22      aaron     153: .Nm
1.12      aaron     154: obtain tickets for the remote host in
1.8       deraadt   155: realm
                    156: .Ar realm
1.34      jmc       157: instead of the remote host's realm.
1.38      jmc       158: .It Fl L
                    159: Specifies an 8-bit data path on output.
                    160: This causes the BINARY option to be negotiated on output.
1.16      aaron     161: .It Fl l Ar user
1.1       deraadt   162: When connecting to the remote system, if the remote system
                    163: understands the
                    164: .Ev ENVIRON
                    165: option, then
                    166: .Ar user
                    167: will be sent to the remote system as the value for the variable USER.
                    168: This option implies the
                    169: .Fl a
                    170: option.
                    171: This option may also be used with the
                    172: .Ic open
                    173: command.
1.16      aaron     174: .It Fl n Ar tracefile
1.1       deraadt   175: Opens
                    176: .Ar tracefile
                    177: for recording trace information.
                    178: See the
                    179: .Ic set tracefile
                    180: command below.
                    181: .It Fl r
                    182: Specifies a user interface similar to
1.30      millert   183: .Nm rlogin .
1.1       deraadt   184: In this
                    185: mode, the escape character is set to the tilde (~) character,
1.8       deraadt   186: unless modified by the
                    187: .Fl e
                    188: option.
1.43      guenther  189: .It Fl V Ar rtable
                    190: Set the routing table to be used.
1.42      jmc       191: The default is 0.
1.38      jmc       192: .It Fl X Ar authtype
                    193: Disables the
                    194: .Ar authtype
                    195: type of authentication.
1.1       deraadt   196: .It Fl x
1.33      jmc       197: Turn on encryption of the data stream.
                    198: When this option is turned on,
1.29      hin       199: .Nm
                    200: will exit with an error if authentication cannot be negotiated or if
                    201: encryption cannot be turned on.
1.1       deraadt   202: .It Ar host
                    203: Indicates the official name, an alias, or the Internet address
                    204: of a remote host.
                    205: .It Ar port
1.22      aaron     206: Indicates a port number (address of an application).
                    207: If a number is not specified, the default
                    208: .Nm
1.1       deraadt   209: port is used.
                    210: .El
                    211: .Pp
1.36      jmc       212: When in rlogin mode, a line of the form ~.\&
1.22      aaron     213: disconnects from the
1.1       deraadt   214: remote host; ~ is the telnet escape character.
                    215: Similarly, the line ~^Z suspends the telnet session.
                    216: The line ~^] escapes to the normal telnet escape prompt.
                    217: .Pp
                    218: Once a connection has been opened,
1.22      aaron     219: .Nm
1.1       deraadt   220: will attempt to enable the
                    221: .Dv TELNET LINEMODE
                    222: option.
1.12      aaron     223: If this fails,
1.22      aaron     224: .Nm
1.1       deraadt   225: will revert to one of two input modes:
1.12      aaron     226: either ``character at a time''
                    227: or ``old line by line''
1.1       deraadt   228: depending on what the remote system supports.
                    229: .Pp
1.16      aaron     230: When
1.1       deraadt   231: .Dv LINEMODE
                    232: is enabled, character processing is done on the
1.22      aaron     233: local system, under the control of the remote system.
                    234: When input
1.1       deraadt   235: editing or character echoing is to be disabled, the remote system
1.22      aaron     236: will relay that information.
                    237: The remote system will also relay
1.1       deraadt   238: changes to any special characters that happen on the remote
                    239: system, so that they can take effect on the local system.
                    240: .Pp
1.12      aaron     241: In ``character at a time'' mode, most
1.1       deraadt   242: text typed is immediately sent to the remote host for processing.
                    243: .Pp
1.12      aaron     244: In ``old line by line'' mode, all text is echoed locally,
1.1       deraadt   245: and (normally) only completed lines are sent to the remote host.
1.12      aaron     246: The ``local echo character'' (initially ``^E'') may be used
1.1       deraadt   247: to turn off and on the local echo
                    248: (this would mostly be used to enter passwords
                    249: without the password being echoed).
                    250: .Pp
1.16      aaron     251: If the
1.1       deraadt   252: .Dv LINEMODE
                    253: option is enabled, or if the
                    254: .Ic localchars
                    255: toggle is
                    256: .Dv TRUE
1.12      aaron     257: (the default for ``old line by line''; see below),
1.1       deraadt   258: the user's
1.12      aaron     259: .Ic quit ,
1.1       deraadt   260: .Ic intr ,
                    261: and
                    262: .Ic flush
                    263: characters are trapped locally, and sent as
                    264: .Tn TELNET
                    265: protocol sequences to the remote side.
1.16      aaron     266: If
1.1       deraadt   267: .Dv LINEMODE
                    268: has ever been enabled, then the user's
                    269: .Ic susp
                    270: and
                    271: .Ic eof
                    272: are also sent as
                    273: .Tn TELNET
                    274: protocol sequences,
                    275: and
                    276: .Ic quit
1.16      aaron     277: is sent as a
1.1       deraadt   278: .Dv TELNET ABORT
1.16      aaron     279: instead of
1.8       deraadt   280: .Dv BREAK .
1.1       deraadt   281: There are options (see
                    282: .Ic toggle
                    283: .Ic autoflush
                    284: and
                    285: .Ic toggle
                    286: .Ic autosynch
                    287: below)
                    288: which cause this action to flush subsequent output to the terminal
                    289: (until the remote host acknowledges the
                    290: .Tn TELNET
                    291: sequence) and flush previous terminal input
                    292: (in the case of
                    293: .Ic quit
                    294: and
1.22      aaron     295: .Ic intr ) .
1.1       deraadt   296: .Pp
                    297: While connected to a remote host,
1.22      aaron     298: .Nm
1.1       deraadt   299: command mode may be entered by typing the
1.22      aaron     300: .Nm
1.12      aaron     301: ``escape character'' (initially ``^]'').
1.1       deraadt   302: When in command mode, the normal terminal editing conventions are available.
1.15      aaron     303: Note that the escape character will return to the command mode of the initial
1.18      alex      304: invocation of
1.22      aaron     305: .Nm
1.23      aaron     306: that has the controlling terminal.
                    307: Use the
1.15      aaron     308: .Cm send escape
                    309: command to switch to command mode in subsequent
1.22      aaron     310: .Nm
1.15      aaron     311: processes on remote hosts.
1.1       deraadt   312: .Pp
                    313: The following
1.22      aaron     314: .Nm
1.1       deraadt   315: commands are available.
                    316: Only enough of each command to uniquely identify it need be typed
                    317: (this is also true for arguments to the
1.12      aaron     318: .Ic mode ,
1.1       deraadt   319: .Ic set ,
1.12      aaron     320: .Ic toggle ,
1.1       deraadt   321: .Ic unset ,
1.12      aaron     322: .Ic slc ,
1.1       deraadt   323: .Ic environ ,
                    324: and
                    325: .Ic display
                    326: commands).
                    327: .Bl -tag -width "mode type"
1.40      sobrado   328: .It Ic auth Ar argument ...
1.12      aaron     329: The
                    330: .Ic auth
                    331: command manipulates the information sent through the
1.1       deraadt   332: .Dv TELNET AUTHENTICATE
1.22      aaron     333: option.
                    334: Valid arguments for the
                    335: .Ic auth
                    336: command are as follows:
1.1       deraadt   337: .Bl -tag -width "disable type"
                    338: .It Ic disable Ar type
1.12      aaron     339: Disables the specified
                    340: .Ar type
1.22      aaron     341: of authentication.
                    342: To obtain a list of available types, use the
1.35      jmc       343: .Ic auth disable ?\&
1.1       deraadt   344: command.
                    345: .It Ic enable Ar type
1.12      aaron     346: Enables the specified
                    347: .Ar type
1.22      aaron     348: of authentication.
                    349: To obtain a list of available types, use the
1.35      jmc       350: .Ic auth enable ?\&
1.1       deraadt   351: command.
                    352: .It Ic status
                    353: Lists the current status of the various types of
                    354: authentication.
                    355: .El
                    356: .It Ic close
                    357: Close a
                    358: .Tn TELNET
                    359: session and return to command mode.
1.40      sobrado   360: .It Ic display Ar argument ...
1.1       deraadt   361: Displays all, or some, of the
                    362: .Ic set
                    363: and
                    364: .Ic toggle
                    365: values (see below).
1.40      sobrado   366: .It Ic encrypt Ar argument ...
1.12      aaron     367: The
                    368: .Ic encrypt
                    369: command manipulates the information sent through the
1.1       deraadt   370: .Dv TELNET ENCRYPT
1.28      hin       371: option that's available when Kerberos is used.
1.14      aaron     372: .Pp
1.1       deraadt   373: Valid arguments for the encrypt command are as follows:
                    374: .Bl -tag -width Ar
                    375: .It Ic disable Ar type Ic [input|output]
1.12      aaron     376: Disables the specified
                    377: .Ar type
1.22      aaron     378: of encryption.
                    379: If you omit
1.12      aaron     380: .Ic input
                    381: and
                    382: .Ic output ,
                    383: both input and output
1.22      aaron     384: are disabled.
                    385: To obtain a list of available types, use the
1.35      jmc       386: .Ic encrypt disable ?\&
1.1       deraadt   387: command.
                    388: .It Ic enable Ar type Ic [input|output]
1.12      aaron     389: Enables the specified
                    390: .Ar type
1.22      aaron     391: of encryption.
                    392: If you omit
1.12      aaron     393: .Ic input
                    394: and
                    395: .Ic output ,
                    396: both input and output are
1.22      aaron     397: enabled.
                    398: To obtain a list of available types, use the
1.35      jmc       399: .Ic encrypt enable ?\&
1.1       deraadt   400: command.
                    401: .It Ic input
                    402: This is the same as the
                    403: .Ic encrypt start input
                    404: command.
                    405: .It Ic -input
                    406: This is the same as the
                    407: .Ic encrypt stop input
                    408: command.
                    409: .It Ic output
                    410: This is the same as the
                    411: .Ic encrypt start output
                    412: command.
                    413: .It Ic -output
                    414: This is the same as the
                    415: .Ic encrypt stop output
                    416: command.
                    417: .It Ic start Ic [input|output]
1.22      aaron     418: Attempts to start encryption.
                    419: If you omit
1.1       deraadt   420: .Ic input
                    421: and
1.24      aaron     422: .Ic output ,
1.22      aaron     423: both input and output are enabled.
                    424: To obtain a list of available types, use the
1.35      jmc       425: .Ic encrypt enable ?\&
1.1       deraadt   426: command.
                    427: .It Ic status
                    428: Lists the current status of encryption.
                    429: .It Ic stop Ic [input|output]
1.22      aaron     430: Stops encryption.
                    431: If you omit
1.12      aaron     432: .Ic input
                    433: and
                    434: .Ic output ,
1.1       deraadt   435: encryption is on both input and output.
                    436: .It Ic type Ar type
                    437: Sets the default type of encryption to be used
                    438: with later
                    439: .Ic encrypt start
                    440: or
                    441: .Ic encrypt stop
                    442: commands.
                    443: .El
1.40      sobrado   444: .It Ic environ Ar argument ...
1.1       deraadt   445: The
                    446: .Ic environ
                    447: command is used to manipulate the
1.11      deraadt   448: variables that may be sent through the
1.1       deraadt   449: .Dv TELNET ENVIRON
                    450: option.
                    451: The initial set of variables is taken from the users
                    452: environment, with only the
                    453: .Ev DISPLAY
                    454: and
                    455: .Ev PRINTER
                    456: variables being exported by default.
                    457: The
                    458: .Ev USER
                    459: variable is also exported if the
                    460: .Fl a
                    461: or
                    462: .Fl l
                    463: options are used.
1.38      jmc       464: .Pp
1.1       deraadt   465: Valid arguments for the
                    466: .Ic environ
                    467: command are:
                    468: .Bl -tag -width Fl
1.16      aaron     469: .It Ic define Ar variable value
1.1       deraadt   470: Define the variable
                    471: .Ar variable
                    472: to have a value of
1.12      aaron     473: .Ar value .
1.1       deraadt   474: Any variables defined by this command are automatically exported.
                    475: The
                    476: .Ar value
                    477: may be enclosed in single or double quotes so
                    478: that tabs and spaces may be included.
1.16      aaron     479: .It Ic undefine Ar variable
1.1       deraadt   480: Remove
                    481: .Ar variable
                    482: from the list of environment variables.
1.16      aaron     483: .It Ic export Ar variable
1.1       deraadt   484: Mark the variable
                    485: .Ar variable
                    486: to be exported to the remote side.
1.16      aaron     487: .It Ic unexport Ar variable
1.1       deraadt   488: Mark the variable
                    489: .Ar variable
                    490: to not be exported unless
                    491: explicitly asked for by the remote side.
                    492: .It Ic list
                    493: List the current set of environment variables.
                    494: Those marked with a
                    495: .Cm *
                    496: will be sent automatically,
                    497: other variables will only be sent if explicitly requested.
                    498: .It Ic \&?
                    499: Prints out help information for the
                    500: .Ic environ
                    501: command.
                    502: .El
                    503: .It Ic logout
                    504: Sends the
                    505: .Dv TELNET LOGOUT
                    506: option to the remote side.
                    507: This command is similar to a
                    508: .Ic close
                    509: command; however, if the remote side does not support the
                    510: .Dv LOGOUT
                    511: option, nothing happens.
                    512: If, however, the remote side does support the
                    513: .Dv LOGOUT
                    514: option, this command should cause the remote side to close the
                    515: .Tn TELNET
                    516: connection.
                    517: If the remote side also supports the concept of
                    518: suspending a user's session for later reattachment,
                    519: the logout argument indicates that you
                    520: should terminate the session immediately.
1.16      aaron     521: .It Ic mode Ar type
1.12      aaron     522: .Ar type
1.1       deraadt   523: is one of several options, depending on the state of the
                    524: .Tn TELNET
                    525: session.
                    526: The remote host is asked for permission to go into the requested mode.
                    527: If the remote host is capable of entering that mode, the requested
                    528: mode will be entered.
                    529: .Bl -tag -width Ar
                    530: .It Ic character
                    531: Disable the
                    532: .Dv TELNET LINEMODE
                    533: option, or, if the remote side does not understand the
                    534: .Dv LINEMODE
1.12      aaron     535: option, then enter ``character at a time'' mode.
1.1       deraadt   536: .It Ic line
                    537: Enable the
                    538: .Dv TELNET LINEMODE
                    539: option, or, if the remote side does not understand the
                    540: .Dv LINEMODE
1.12      aaron     541: option, then attempt to enter ``old-line-by-line'' mode.
1.16      aaron     542: .It Ic isig Pq Ic \-isig
                    543: Attempt to enable (disable) the
1.1       deraadt   544: .Dv TRAPSIG
1.16      aaron     545: mode of the
1.1       deraadt   546: .Dv LINEMODE
                    547: option.
1.16      aaron     548: This requires that the
1.1       deraadt   549: .Dv LINEMODE
                    550: option be enabled.
1.16      aaron     551: .It Ic edit Pq Ic \-edit
                    552: Attempt to enable (disable) the
1.1       deraadt   553: .Dv EDIT
1.16      aaron     554: mode of the
1.1       deraadt   555: .Dv LINEMODE
                    556: option.
1.16      aaron     557: This requires that the
1.1       deraadt   558: .Dv LINEMODE
                    559: option be enabled.
1.16      aaron     560: .It Ic softtabs Pq Ic \-softtabs
                    561: Attempt to enable (disable) the
1.1       deraadt   562: .Dv SOFT_TAB
1.16      aaron     563: mode of the
1.1       deraadt   564: .Dv LINEMODE
                    565: option.
1.16      aaron     566: This requires that the
1.1       deraadt   567: .Dv LINEMODE
                    568: option be enabled.
1.16      aaron     569: .It Ic litecho Pq Ic \-litecho
                    570: Attempt to enable (disable) the
1.1       deraadt   571: .Dv LIT_ECHO
1.16      aaron     572: mode of the
1.1       deraadt   573: .Dv LINEMODE
                    574: option.
1.16      aaron     575: This requires that the
1.1       deraadt   576: .Dv LINEMODE
                    577: option be enabled.
                    578: .It Ic \&?
                    579: Prints out help information for the
                    580: .Ic mode
                    581: command.
                    582: .El
                    583: .It Xo
                    584: .Ic open Ar host
1.5       deraadt   585: .Op Fl l Ar user
                    586: .Oo Op Fl
1.1       deraadt   587: .Ar port Oc
                    588: .Xc
                    589: Open a connection to the named host.
                    590: If no port number
                    591: is specified,
1.22      aaron     592: .Nm
1.1       deraadt   593: will attempt to contact a
                    594: .Tn TELNET
                    595: server at the default port.
                    596: The host specification may be either a host name (see
1.7       deraadt   597: .Xr hosts 5 )
1.12      aaron     598: or an Internet address specified in the ``dot notation'' (see
1.1       deraadt   599: .Xr inet 3 ) .
                    600: The
1.5       deraadt   601: .Fl l
1.1       deraadt   602: option may be used to specify the user name
                    603: to be passed to the remote system via the
                    604: .Ev ENVIRON
                    605: option.
                    606: When connecting to a non-standard port,
1.22      aaron     607: .Nm
1.1       deraadt   608: omits any automatic initiation of
                    609: .Tn TELNET
1.22      aaron     610: options.
                    611: When the port number is preceded by a minus sign,
1.1       deraadt   612: the initial option negotiation is done.
                    613: After establishing a connection, the file
                    614: .Pa \&.telnetrc
                    615: in the
1.22      aaron     616: user's home directory is opened.
                    617: Lines beginning with a ``#'' are
                    618: comment lines.
                    619: Blank lines are ignored.
                    620: Lines that begin
                    621: without whitespace are the start of a machine entry.
                    622: The first thing on the line is the name of the machine that is
                    623: being connected to.
                    624: The rest of the line, and successive
1.21      aaron     625: lines that begin with whitespace are assumed to be
1.22      aaron     626: .Nm
1.1       deraadt   627: commands and are processed as if they had been typed
                    628: in manually to the
1.22      aaron     629: .Nm
1.1       deraadt   630: command prompt.
                    631: .It Ic quit
                    632: Close any open
                    633: .Tn TELNET
                    634: session and exit
1.12      aaron     635: .Nm telnet .
                    636: An end-of-file (in command mode) will also close a session and exit.
1.40      sobrado   637: .It Ic send Ar argument ...
1.1       deraadt   638: Sends one or more special character sequences to the remote host.
                    639: The following are the arguments which may be specified
                    640: (more than one argument may be specified at a time):
                    641: .Bl -tag -width escape
                    642: .It Ic abort
                    643: Sends the
                    644: .Dv TELNET ABORT
                    645: (Abort
                    646: processes)
                    647: sequence.
                    648: .It Ic ao
                    649: Sends the
                    650: .Dv TELNET AO
                    651: (Abort Output) sequence, which should cause the remote system to flush
                    652: all output
                    653: .Em from
                    654: the remote system
                    655: .Em to
                    656: the user's terminal.
                    657: .It Ic ayt
                    658: Sends the
                    659: .Dv TELNET AYT
                    660: (Are You There)
                    661: sequence, to which the remote system may or may not choose to respond.
                    662: .It Ic brk
                    663: Sends the
                    664: .Dv TELNET BRK
                    665: (Break) sequence, which may have significance to the remote
                    666: system.
                    667: .It Ic ec
                    668: Sends the
                    669: .Dv TELNET EC
                    670: (Erase Character)
                    671: sequence, which should cause the remote system to erase the last character
                    672: entered.
                    673: .It Ic el
                    674: Sends the
                    675: .Dv TELNET EL
                    676: (Erase Line)
                    677: sequence, which should cause the remote system to erase the line currently
                    678: being entered.
                    679: .It Ic eof
                    680: Sends the
                    681: .Dv TELNET EOF
                    682: (End Of File)
                    683: sequence.
                    684: .It Ic eor
                    685: Sends the
                    686: .Dv TELNET EOR
                    687: (End of Record)
                    688: sequence.
                    689: .It Ic escape
                    690: Sends the current
1.22      aaron     691: .Nm
1.12      aaron     692: escape character (initially ``^]'').
1.1       deraadt   693: .It Ic ga
                    694: Sends the
                    695: .Dv TELNET GA
                    696: (Go Ahead)
                    697: sequence, which likely has no significance to the remote system.
                    698: .It Ic getstatus
                    699: If the remote side supports the
                    700: .Dv TELNET STATUS
                    701: command,
                    702: .Ic getstatus
                    703: will send the subnegotiation to request that the server send
                    704: its current option status.
                    705: .It Ic ip
                    706: Sends the
                    707: .Dv TELNET IP
                    708: (Interrupt Process) sequence, which should cause the remote
                    709: system to abort the currently running process.
                    710: .It Ic nop
                    711: Sends the
                    712: .Dv TELNET NOP
                    713: (No OPeration)
                    714: sequence.
                    715: .It Ic susp
                    716: Sends the
                    717: .Dv TELNET SUSP
                    718: (SUSPend process)
                    719: sequence.
                    720: .It Ic synch
                    721: Sends the
                    722: .Dv TELNET SYNCH
                    723: sequence.
                    724: This sequence causes the remote system to discard all previously typed
                    725: (but not yet read) input.
                    726: This sequence is sent as
                    727: .Tn TCP
                    728: urgent
                    729: data (and may not work if the remote system is a
                    730: .Bx 4.2
                    731: system -- if
1.12      aaron     732: it doesn't work, a lower case ``r'' may be echoed on the terminal).
1.1       deraadt   733: .It Ic do Ar cmd
1.12      aaron     734: Sends the
                    735: .Dv TELNET DO
                    736: .Ar cmd
                    737: sequence.
                    738: .Ar cmd
                    739: can be either a decimal number between 0 and 255,
                    740: or a symbolic name for a specific
                    741: .Dv TELNET
                    742: command.
                    743: .Ar cmd
                    744: can also be either
                    745: .Ic help
                    746: or
1.35      jmc       747: .Ic ?\&
1.12      aaron     748: to print out help information, including
                    749: a list of known symbolic names.
1.1       deraadt   750: .It Ic dont Ar cmd
1.12      aaron     751: Sends the
                    752: .Dv TELNET DONT
                    753: .Ar cmd
                    754: sequence.
                    755: .Ar cmd
                    756: can be either a decimal number between 0 and 255,
                    757: or a symbolic name for a specific
                    758: .Dv TELNET
                    759: command.
                    760: .Ar cmd
                    761: can also be either
                    762: .Ic help
                    763: or
1.35      jmc       764: .Ic ?\&
1.12      aaron     765: to print out help information, including
                    766: a list of known symbolic names.
1.1       deraadt   767: .It Ic will Ar cmd
1.12      aaron     768: Sends the
                    769: .Dv TELNET WILL
                    770: .Ar cmd
                    771: sequence.
                    772: .Ar cmd
                    773: can be either a decimal number between 0 and 255,
                    774: or a symbolic name for a specific
                    775: .Dv TELNET
                    776: command.
                    777: .Ar cmd
                    778: can also be either
                    779: .Ic help
                    780: or
1.35      jmc       781: .Ic ?\&
1.12      aaron     782: to print out help information, including
                    783: a list of known symbolic names.
1.1       deraadt   784: .It Ic wont Ar cmd
                    785: Sends the
1.12      aaron     786: .Dv TELNET WONT
1.1       deraadt   787: .Ar cmd
                    788: sequence.
1.12      aaron     789: .Ar cmd
1.1       deraadt   790: can be either a decimal number between 0 and 255,
                    791: or a symbolic name for a specific
                    792: .Dv TELNET
                    793: command.
1.12      aaron     794: .Ar cmd
1.1       deraadt   795: can also be either
                    796: .Ic help
                    797: or
1.35      jmc       798: .Ic ?\&
1.1       deraadt   799: to print out help information, including
                    800: a list of known symbolic names.
                    801: .It Ic \&?
                    802: Prints out help information for the
                    803: .Ic send
                    804: command.
                    805: .El
1.16      aaron     806: .It Ic set Ar argument value
                    807: .It Ic unset Ar argument value
1.1       deraadt   808: The
                    809: .Ic set
                    810: command will set any one of a number of
1.22      aaron     811: .Nm
1.1       deraadt   812: variables to a specific value or to
                    813: .Dv TRUE .
                    814: The special value
                    815: .Ic off
                    816: turns off the function associated with
1.12      aaron     817: the variable; this is equivalent to using the
1.1       deraadt   818: .Ic unset
                    819: command.
                    820: The
                    821: .Ic unset
                    822: command will disable or set to
                    823: .Dv FALSE
                    824: any of the specified functions.
                    825: The values of variables may be interrogated with the
                    826: .Ic display
                    827: command.
                    828: The variables which may be set or unset, but not toggled, are
1.22      aaron     829: listed here.
                    830: In addition, any of the variables for the
1.1       deraadt   831: .Ic toggle
                    832: command may be explicitly set or unset using
                    833: the
                    834: .Ic set
                    835: and
                    836: .Ic unset
                    837: commands.
                    838: .Bl -tag -width escape
                    839: .It Ic ayt
                    840: If
                    841: .Tn TELNET
1.12      aaron     842: is in
                    843: .Ic localchars
                    844: mode, or
1.1       deraadt   845: .Dv LINEMODE
                    846: is enabled, and the status character is typed, a
                    847: .Dv TELNET AYT
                    848: sequence (see
                    849: .Ic send ayt
                    850: preceding) is sent to the
1.22      aaron     851: remote host.
                    852: The initial value for the "Are You There"
1.1       deraadt   853: character is the terminal's status character.
                    854: .It Ic echo
1.12      aaron     855: This is the value (initially ``^E'') which, when in
                    856: ``line by line'' mode, toggles between doing local echoing
1.1       deraadt   857: of entered characters (for normal processing), and suppressing
                    858: echoing of entered characters (for entering, say, a password).
                    859: .It Ic eof
                    860: If
1.22      aaron     861: .Nm
1.1       deraadt   862: is operating in
                    863: .Dv LINEMODE
1.12      aaron     864: or ``old line by line'' mode, entering this character
1.1       deraadt   865: as the first character on a line will cause this character to be
                    866: sent to the remote system.
1.12      aaron     867: The initial value of the
                    868: .Ic eof
                    869: character is taken to be the terminal's
1.1       deraadt   870: .Ic eof
                    871: character.
                    872: .It Ic erase
                    873: If
1.22      aaron     874: .Nm
1.1       deraadt   875: is in
                    876: .Ic localchars
                    877: mode (see
                    878: .Ic toggle
                    879: .Ic localchars
                    880: below),
1.12      aaron     881: and if
1.22      aaron     882: .Nm
1.12      aaron     883: is operating in ``character at a time'' mode, then when this
1.1       deraadt   884: character is typed, a
                    885: .Dv TELNET EC
                    886: sequence (see
                    887: .Ic send
                    888: .Ic ec
                    889: above)
                    890: is sent to the remote system.
1.12      aaron     891: The initial value for the
                    892: .Ic erase
                    893: character is taken to be
1.1       deraadt   894: the terminal's
                    895: .Ic erase
                    896: character.
                    897: .It Ic escape
                    898: This is the
1.22      aaron     899: .Nm
1.12      aaron     900: escape character (initially ``^['') which causes entry
1.1       deraadt   901: into
1.22      aaron     902: .Nm
1.1       deraadt   903: command mode (when connected to a remote system).
                    904: .It Ic flushoutput
                    905: If
1.22      aaron     906: .Nm
1.1       deraadt   907: is in
                    908: .Ic localchars
                    909: mode (see
                    910: .Ic toggle
                    911: .Ic localchars
                    912: below)
                    913: and the
                    914: .Ic flushoutput
                    915: character is typed, a
                    916: .Dv TELNET AO
                    917: sequence (see
                    918: .Ic send
                    919: .Ic ao
                    920: above)
                    921: is sent to the remote host.
1.12      aaron     922: The initial value for the
                    923: .Ic flush
                    924: character is taken to be
1.1       deraadt   925: the terminal's
                    926: .Ic flush
                    927: character.
                    928: .It Ic forw1
                    929: .It Ic forw2
                    930: If
                    931: .Tn TELNET
                    932: is operating in
                    933: .Dv LINEMODE ,
                    934: these are the
                    935: characters that, when typed, cause partial lines to be
1.22      aaron     936: forwarded to the remote system.
                    937: The initial value for
1.1       deraadt   938: the forwarding characters are taken from the terminal's
                    939: eol and eol2 characters.
                    940: .It Ic interrupt
                    941: If
1.22      aaron     942: .Nm
1.1       deraadt   943: is in
                    944: .Ic localchars
                    945: mode (see
                    946: .Ic toggle
                    947: .Ic localchars
                    948: below)
                    949: and the
                    950: .Ic interrupt
                    951: character is typed, a
                    952: .Dv TELNET IP
                    953: sequence (see
                    954: .Ic send
                    955: .Ic ip
                    956: above)
                    957: is sent to the remote host.
1.12      aaron     958: The initial value for the
                    959: .Ic interrupt
                    960: character is taken to be
1.1       deraadt   961: the terminal's
                    962: .Ic intr
                    963: character.
                    964: .It Ic kill
                    965: If
1.22      aaron     966: .Nm
1.1       deraadt   967: is in
                    968: .Ic localchars
                    969: mode (see
                    970: .Ic toggle
                    971: .Ic localchars
                    972: below),
1.12      aaron     973: and if
1.22      aaron     974: .Nm
1.12      aaron     975: is operating in ``character at a time'' mode, then when this
1.1       deraadt   976: character is typed, a
                    977: .Dv TELNET EL
                    978: sequence (see
                    979: .Ic send
                    980: .Ic el
                    981: above)
                    982: is sent to the remote system.
1.12      aaron     983: The initial value for the
                    984: .Ic kill
                    985: character is taken to be
1.1       deraadt   986: the terminal's
                    987: .Ic kill
                    988: character.
                    989: .It Ic lnext
                    990: If
1.22      aaron     991: .Nm
1.1       deraadt   992: is operating in
                    993: .Dv LINEMODE
1.12      aaron     994: or ``old line by line'' mode, then this character is taken to
1.1       deraadt   995: be the terminal's
                    996: .Ic lnext
                    997: character.
1.12      aaron     998: The initial value for the
                    999: .Ic lnext
                   1000: character is taken to be
1.1       deraadt  1001: the terminal's
                   1002: .Ic lnext
                   1003: character.
                   1004: .It Ic quit
                   1005: If
1.22      aaron    1006: .Nm
1.1       deraadt  1007: is in
                   1008: .Ic localchars
                   1009: mode (see
                   1010: .Ic toggle
                   1011: .Ic localchars
                   1012: below)
                   1013: and the
                   1014: .Ic quit
                   1015: character is typed, a
                   1016: .Dv TELNET BRK
                   1017: sequence (see
                   1018: .Ic send
                   1019: .Ic brk
                   1020: above)
                   1021: is sent to the remote host.
1.12      aaron    1022: The initial value for the
                   1023: .Ic quit
                   1024: character is taken to be
1.1       deraadt  1025: the terminal's
                   1026: .Ic quit
                   1027: character.
                   1028: .It Ic reprint
                   1029: If
1.22      aaron    1030: .Nm
1.1       deraadt  1031: is operating in
                   1032: .Dv LINEMODE
1.31      deraadt  1033: or ``old line by line'' mode, then this character is taken to
1.1       deraadt  1034: be the terminal's
                   1035: .Ic reprint
                   1036: character.
1.12      aaron    1037: The initial value for the
                   1038: .Ic reprint
                   1039: character is taken to be
1.1       deraadt  1040: the terminal's
                   1041: .Ic reprint
                   1042: character.
                   1043: .It Ic rlogin
                   1044: This is the rlogin escape character.
                   1045: If set, the normal
                   1046: .Tn TELNET
                   1047: escape character is ignored unless it is
                   1048: preceded by this character at the beginning of a line.
1.12      aaron    1049: This character, at the beginning of a line, followed by
                   1050: a "." closes the connection; when followed by a ^Z it
1.5       deraadt  1051: suspends the
1.22      aaron    1052: .Nm
                   1053: command.
                   1054: The initial state is to
1.12      aaron    1055: disable the
                   1056: .Ic rlogin
                   1057: escape character.
1.1       deraadt  1058: .It Ic start
                   1059: If the
                   1060: .Dv TELNET TOGGLE-FLOW-CONTROL
                   1061: option has been enabled,
                   1062: then this character is taken to
                   1063: be the terminal's
                   1064: .Ic start
                   1065: character.
1.12      aaron    1066: The initial value for the
                   1067: .Ic start
                   1068: character is taken to be
1.1       deraadt  1069: the terminal's
                   1070: .Ic start
                   1071: character.
                   1072: .It Ic stop
                   1073: If the
                   1074: .Dv TELNET TOGGLE-FLOW-CONTROL
                   1075: option has been enabled,
                   1076: then this character is taken to
                   1077: be the terminal's
                   1078: .Ic stop
                   1079: character.
1.12      aaron    1080: The initial value for the
                   1081: .Ic stop
                   1082: character is taken to be
1.1       deraadt  1083: the terminal's
                   1084: .Ic stop
                   1085: character.
                   1086: .It Ic susp
                   1087: If
1.22      aaron    1088: .Nm
1.1       deraadt  1089: is in
                   1090: .Ic localchars
                   1091: mode, or
                   1092: .Dv LINEMODE
                   1093: is enabled, and the
                   1094: .Ic suspend
                   1095: character is typed, a
                   1096: .Dv TELNET SUSP
                   1097: sequence (see
                   1098: .Ic send
                   1099: .Ic susp
                   1100: above)
                   1101: is sent to the remote host.
1.12      aaron    1102: The initial value for the
                   1103: .Ic suspend
                   1104: character is taken to be
1.1       deraadt  1105: the terminal's
                   1106: .Ic suspend
                   1107: character.
                   1108: .It Ic tracefile
                   1109: This is the file to which the output, caused by
                   1110: .Ic netdata
                   1111: or
                   1112: .Ic option
                   1113: tracing being
                   1114: .Dv TRUE ,
1.22      aaron    1115: will be written.
                   1116: If it is set to
1.1       deraadt  1117: .Dq Fl ,
                   1118: then tracing information will be written to standard output (the default).
                   1119: .It Ic worderase
                   1120: If
1.22      aaron    1121: .Nm
1.1       deraadt  1122: is operating in
                   1123: .Dv LINEMODE
1.12      aaron    1124: or ``old line by line'' mode, then this character is taken to
1.1       deraadt  1125: be the terminal's
                   1126: .Ic worderase
                   1127: character.
1.12      aaron    1128: The initial value for the
                   1129: .Ic worderase
                   1130: character is taken to be
1.1       deraadt  1131: the terminal's
                   1132: .Ic worderase
                   1133: character.
                   1134: .It Ic \&?
                   1135: Displays the legal
                   1136: .Ic set
                   1137: .Pq Ic unset
                   1138: commands.
                   1139: .El
1.17      aaron    1140: .It Ic skey Ar sequence challenge
                   1141: The
                   1142: .Ic skey
1.23      aaron    1143: command computes a response to the S/Key challenge.
                   1144: See
1.17      aaron    1145: .Xr skey 1
                   1146: for more information on the S/Key system.
1.16      aaron    1147: .It Ic slc Ar state
1.1       deraadt  1148: The
                   1149: .Ic slc
                   1150: command (Set Local Characters) is used to set
1.4       deraadt  1151: or change the state of the special
1.16      aaron    1152: characters when the
1.1       deraadt  1153: .Dv TELNET LINEMODE
                   1154: option has
1.22      aaron    1155: been enabled.
                   1156: Special characters are characters that get mapped to
1.1       deraadt  1157: .Tn TELNET
                   1158: commands sequences (like
                   1159: .Ic ip
                   1160: or
1.22      aaron    1161: .Ic quit )
1.1       deraadt  1162: or line editing characters (like
                   1163: .Ic erase
                   1164: and
1.22      aaron    1165: .Ic kill ) .
1.1       deraadt  1166: By default, the local special characters are exported.
                   1167: .Bl -tag -width Fl
                   1168: .It Ic check
                   1169: Verify the current settings for the current special characters.
                   1170: The remote side is requested to send all the current special
                   1171: character settings, and if there are any discrepancies with
                   1172: the local side, the local side will switch to the remote value.
                   1173: .It Ic export
1.22      aaron    1174: Switch to the local defaults for the special characters.
                   1175: The local default characters are those of the local terminal at
1.1       deraadt  1176: the time when
1.22      aaron    1177: .Nm
1.1       deraadt  1178: was started.
                   1179: .It Ic import
                   1180: Switch to the remote defaults for the special characters.
                   1181: The remote default characters are those of the remote system
1.16      aaron    1182: at the time when the
1.1       deraadt  1183: .Tn TELNET
                   1184: connection was established.
                   1185: .It Ic \&?
                   1186: Prints out help information for the
                   1187: .Ic slc
                   1188: command.
                   1189: .El
                   1190: .It Ic status
                   1191: Show the current status of
1.12      aaron    1192: .Nm telnet .
1.1       deraadt  1193: This includes the peer one is connected to, as well
                   1194: as the current mode.
1.40      sobrado  1195: .It Ic toggle Ar argument ...
1.1       deraadt  1196: Toggle (between
                   1197: .Dv TRUE
                   1198: and
                   1199: .Dv FALSE )
                   1200: various flags that control how
1.22      aaron    1201: .Nm
1.1       deraadt  1202: responds to events.
                   1203: These flags may be set explicitly to
                   1204: .Dv TRUE
                   1205: or
                   1206: .Dv FALSE
                   1207: using the
                   1208: .Ic set
                   1209: and
                   1210: .Ic unset
                   1211: commands listed above.
                   1212: More than one argument may be specified.
                   1213: The state of these flags may be interrogated with the
                   1214: .Ic display
                   1215: command.
                   1216: Valid arguments are:
                   1217: .Bl -tag -width Ar
                   1218: .It Ic authdebug
                   1219: Turns on debugging information for the authentication code.
                   1220: .It Ic autoflush
                   1221: If
                   1222: .Ic autoflush
                   1223: and
                   1224: .Ic localchars
                   1225: are both
                   1226: .Dv TRUE ,
                   1227: then when the
1.12      aaron    1228: .Ic ao
1.1       deraadt  1229: or
                   1230: .Ic quit
                   1231: characters are recognized (and transformed into
                   1232: .Tn TELNET
                   1233: sequences; see
                   1234: .Ic set
                   1235: above for details),
1.22      aaron    1236: .Nm
1.1       deraadt  1237: refuses to display any data on the user's terminal
                   1238: until the remote system acknowledges (via a
                   1239: .Dv TELNET TIMING MARK
                   1240: option)
                   1241: that it has processed those
                   1242: .Tn TELNET
                   1243: sequences.
                   1244: The initial value for this toggle is
                   1245: .Dv TRUE
                   1246: if the terminal user had not
                   1247: done an "stty noflsh", otherwise
                   1248: .Dv FALSE
                   1249: (see
1.22      aaron    1250: .Xr stty 1 ) .
1.1       deraadt  1251: .It Ic autodecrypt
                   1252: When the
                   1253: .Dv TELNET ENCRYPT
                   1254: option is negotiated, by
                   1255: default the actual encryption (decryption) of the data
1.22      aaron    1256: stream does not start automatically.
                   1257: The
1.12      aaron    1258: .Ic autoencrypt
                   1259: .Pq Ic autodecrypt
                   1260: command states that encryption of the
1.1       deraadt  1261: output (input) stream should be enabled as soon as
                   1262: possible.
                   1263: .It Ic autologin
                   1264: If the remote side supports the
                   1265: .Dv TELNET AUTHENTICATION
                   1266: option
                   1267: .Tn TELNET
1.22      aaron    1268: attempts to use it to perform automatic authentication.
                   1269: If the
1.1       deraadt  1270: .Dv AUTHENTICATION
                   1271: option is not supported, the user's login
1.31      deraadt  1272: name is propagated through the
1.1       deraadt  1273: .Dv TELNET ENVIRON
                   1274: option.
                   1275: This command is the same as specifying
                   1276: .Ar a
                   1277: option on the
                   1278: .Ic open
                   1279: command.
                   1280: .It Ic autosynch
                   1281: If
                   1282: .Ic autosynch
                   1283: and
                   1284: .Ic localchars
                   1285: are both
                   1286: .Dv TRUE ,
                   1287: then when either the
                   1288: .Ic intr
                   1289: or
                   1290: .Ic quit
1.12      aaron    1291: character is typed (see
1.1       deraadt  1292: .Ic set
                   1293: above for descriptions of the
                   1294: .Ic intr
                   1295: and
                   1296: .Ic quit
                   1297: characters), the resulting
                   1298: .Tn TELNET
                   1299: sequence sent is followed by the
                   1300: .Dv TELNET SYNCH
                   1301: sequence.
                   1302: This procedure
1.12      aaron    1303: .Em should
1.1       deraadt  1304: cause the remote system to begin throwing away all previously
                   1305: typed input until both of the
                   1306: .Tn TELNET
                   1307: sequences have been read and acted upon.
                   1308: The initial value of this toggle is
                   1309: .Dv FALSE .
                   1310: .It Ic binary
                   1311: Enable or disable the
                   1312: .Dv TELNET BINARY
                   1313: option on both input and output.
                   1314: .It Ic inbinary
                   1315: Enable or disable the
                   1316: .Dv TELNET BINARY
                   1317: option on input.
                   1318: .It Ic outbinary
                   1319: Enable or disable the
                   1320: .Dv TELNET BINARY
                   1321: option on output.
                   1322: .It Ic crlf
                   1323: If this is
                   1324: .Dv TRUE ,
                   1325: then carriage returns will be sent as
                   1326: .Li <CR><LF> .
                   1327: If this is
                   1328: .Dv FALSE ,
1.31      deraadt  1329: then carriage returns will be sent as
1.1       deraadt  1330: .Li <CR><NUL> .
                   1331: The initial value for this toggle is
                   1332: .Dv FALSE .
                   1333: .It Ic crmod
                   1334: Toggle carriage return mode.
                   1335: When this mode is enabled, most carriage return characters received from
                   1336: the remote host will be mapped into a carriage return followed by
                   1337: a line feed.
                   1338: This mode does not affect those characters typed by the user, only
                   1339: those received from the remote host.
                   1340: This mode is not very useful unless the remote host
1.12      aaron    1341: only sends carriage return, but never line feeds.
1.1       deraadt  1342: The initial value for this toggle is
                   1343: .Dv FALSE .
                   1344: .It Ic debug
1.25      aaron    1345: Toggles socket level debugging (useful only to the superuser).
1.1       deraadt  1346: The initial value for this toggle is
                   1347: .Dv FALSE .
                   1348: .It Ic encdebug
                   1349: Turns on debugging information for the encryption code.
                   1350: .It Ic localchars
                   1351: If this is
                   1352: .Dv TRUE ,
                   1353: then the
1.12      aaron    1354: .Ic flush ,
1.1       deraadt  1355: .Ic interrupt ,
1.12      aaron    1356: .Ic quit ,
1.1       deraadt  1357: .Ic erase ,
                   1358: and
                   1359: .Ic kill
                   1360: characters (see
                   1361: .Ic set
                   1362: above) are recognized locally, and transformed into (hopefully) appropriate
                   1363: .Tn TELNET
                   1364: control sequences
                   1365: (respectively
1.12      aaron    1366: .Ic ao ,
1.1       deraadt  1367: .Ic ip ,
1.12      aaron    1368: .Ic brk ,
1.1       deraadt  1369: .Ic ec ,
                   1370: and
1.22      aaron    1371: .Ic el ;
1.1       deraadt  1372: see
                   1373: .Ic send
                   1374: above).
                   1375: The initial value for this toggle is
                   1376: .Dv TRUE
1.12      aaron    1377: in ``old line by line'' mode,
1.1       deraadt  1378: and
                   1379: .Dv FALSE
1.12      aaron    1380: in ``character at a time'' mode.
1.1       deraadt  1381: When the
                   1382: .Dv LINEMODE
                   1383: option is enabled, the value of
                   1384: .Ic localchars
                   1385: is ignored, and assumed to always be
                   1386: .Dv TRUE .
                   1387: If
                   1388: .Dv LINEMODE
                   1389: has ever been enabled, then
                   1390: .Ic quit
                   1391: is sent as
1.12      aaron    1392: .Ic abort ,
                   1393: and
                   1394: .Ic eof
1.1       deraadt  1395: and
1.5       deraadt  1396: .Ic suspend
1.1       deraadt  1397: are sent as
1.12      aaron    1398: .Ic eof
                   1399: and
1.5       deraadt  1400: .Ic susp
                   1401: (see
1.1       deraadt  1402: .Ic send
                   1403: above).
                   1404: .It Ic netdata
                   1405: Toggles the display of all network data (in hexadecimal format).
                   1406: The initial value for this toggle is
                   1407: .Dv FALSE .
                   1408: .It Ic options
                   1409: Toggles the display of some internal
1.22      aaron    1410: .Nm
1.1       deraadt  1411: protocol processing (having to do with
                   1412: .Tn TELNET
                   1413: options).
                   1414: The initial value for this toggle is
                   1415: .Dv FALSE .
                   1416: .It Ic prettydump
                   1417: When the
                   1418: .Ic netdata
                   1419: toggle is enabled, if
                   1420: .Ic prettydump
                   1421: is enabled the output from the
                   1422: .Ic netdata
                   1423: command will be formatted in a more user readable format.
                   1424: Spaces are put between each character in the output, and the
                   1425: beginning of any
                   1426: .Tn TELNET
                   1427: escape sequence is preceded by a '*' to aid in locating them.
                   1428: .It Ic skiprc
                   1429: When the skiprc toggle is
                   1430: .Dv TRUE ,
                   1431: .Tn TELNET
                   1432: skips the reading of the
                   1433: .Pa \&.telnetrc
1.12      aaron    1434: file in the user's home
1.22      aaron    1435: directory when connections are opened.
                   1436: The initial value for this toggle is
1.13      aaron    1437: .Dv FALSE .
1.1       deraadt  1438: .It Ic termdata
                   1439: Toggles the display of all terminal data (in hexadecimal format).
                   1440: The initial value for this toggle is
                   1441: .Dv FALSE .
                   1442: .It Ic verbose_encrypt
                   1443: When the
                   1444: .Ic verbose_encrypt
                   1445: toggle is
                   1446: .Dv TRUE ,
1.22      aaron    1447: .Nm
1.1       deraadt  1448: prints out a message each time encryption is enabled or
1.22      aaron    1449: disabled.
                   1450: The initial value for this toggle is
1.13      aaron    1451: .Dv FALSE .
1.1       deraadt  1452: .It Ic \&?
                   1453: Displays the legal
                   1454: .Ic toggle
                   1455: commands.
                   1456: .El
                   1457: .It Ic z
                   1458: Suspend
1.12      aaron    1459: .Nm telnet .
1.1       deraadt  1460: This command only works when the user is using the
1.12      aaron    1461: .Xr csh 1 .
1.16      aaron    1462: .It Ic \&! Op Ar command
1.1       deraadt  1463: Execute a single command in a subshell on the local
1.22      aaron    1464: system.
                   1465: If
1.5       deraadt  1466: .Ar command
1.1       deraadt  1467: is omitted, then an interactive
                   1468: subshell is invoked.
1.16      aaron    1469: .It Ic \&? Op Ar command
1.22      aaron    1470: Get help.
                   1471: With no arguments,
                   1472: .Nm
1.1       deraadt  1473: prints a help summary.
                   1474: If a command is specified,
1.22      aaron    1475: .Nm
1.1       deraadt  1476: will print the help information for just that command.
                   1477: .El
                   1478: .Sh ENVIRONMENT
1.22      aaron    1479: .Nm
1.1       deraadt  1480: uses at least the
                   1481: .Ev HOME ,
                   1482: .Ev SHELL ,
                   1483: .Ev DISPLAY ,
                   1484: and
                   1485: .Ev TERM
                   1486: environment variables.
                   1487: Other environment variables may be propagated
                   1488: to the other side via the
                   1489: .Dv TELNET ENVIRON
                   1490: option.
                   1491: .Sh FILES
                   1492: .Bl -tag -width ~/.telnetrc -compact
                   1493: .It Pa ~/.telnetrc
                   1494: user customized telnet startup values
                   1495: .El
1.44      lum      1496: .Sh SEE ALSO
                   1497: .Xr ssh 1
1.1       deraadt  1498: .Sh HISTORY
                   1499: The
1.22      aaron    1500: .Nm
1.1       deraadt  1501: command appeared in
                   1502: .Bx 4.2 .
                   1503: .Sh NOTES
                   1504: On some remote systems, echo has to be turned off manually when in
1.12      aaron    1505: ``old line by line'' mode.
1.1       deraadt  1506: .Pp
1.16      aaron    1507: In ``old line by line'' mode or
1.1       deraadt  1508: .Dv LINEMODE
                   1509: the terminal's
                   1510: .Ic eof
                   1511: character is only recognized (and sent to the remote system)
                   1512: when it is the first character on a line.
1.20      itojun   1513: .Pp
                   1514: Source routing is not supported yet for IPv6.