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

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