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

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