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

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