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

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