Add heimdal-0.6.3

[dragonfly.git] / crypto / heimdal-0.6.3 / appl / telnet / telnet / telnet.cat1

TELNET(1)                    UNIX Reference Manual                   TELNET(1)

N\bNA\bAM\bME\bE
     t\bte\bel\bln\bne\bet\bt - user interface to the TELNET protocol

S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
     t\bte\bel\bln\bne\bet\bt [-\b-7\b78\b8E\bEF\bFK\bKL\bLa\bac\bcd\bdf\bfr\brx\bx] [-\b-S\bS _\bt_\bo_\bs] [-\b-X\bX _\ba_\bu_\bt_\bh_\bt_\by_\bp_\be] [-\b-e\be _\be_\bs_\bc_\ba_\bp_\be_\bc_\bh_\ba_\br] [-\b-k\bk _\br_\be_\ba_\bl_\bm]
            [-\b-l\bl _\bu_\bs_\be_\br] [-\b-n\bn _\bt_\br_\ba_\bc_\be_\bf_\bi_\bl_\be] [_\bh_\bo_\bs_\bt [port]]

D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
     The t\bte\bel\bln\bne\bet\bt command is used to communicate with another host using the
     TELNET protocol.  If t\bte\bel\bln\bne\bet\bt is invoked without the _\bh_\bo_\bs_\bt argument, it en-
     ters command mode, indicated by its prompt (t\bte\bel\bln\bne\bet\bt>\b>). In this mode, it
     accepts and executes the commands listed below.  If it is invoked with
     arguments, it performs an o\bop\bpe\ben\bn command with those arguments.

     Options:

     -\b-8\b8      Specifies an 8-bit data path.  This causes an attempt to negoti-
             ate the TELNET BINARY option on both input and output.

     -\b-7\b7      Do not try to negotiate TELNET BINARY option.

     -\b-E\bE      Stops any character from being recognized as an escape character.

     -\b-F\bF      If Kerberos V5 authentication is being used, the -\b-F\bF option allows
             the local credentials to be forwarded to the remote system, in-
             cluding any credentials that have already been forwarded into the
             local environment.

     -\b-K\bK      Specifies no automatic login to the remote system.

     -\b-L\bL      Specifies an 8-bit data path on output.  This causes the BINARY
             option to be negotiated on output.

     -\b-S\bS _\bt_\bo_\bs  Sets the IP type-of-service (TOS) option for the telnet connec-
             tion to the value _\bt_\bo_\bs, which can be a numeric TOS value or, on
             systems that support it, a symbolic TOS name found in the
             /etc/iptos file.

     -\b-X\bX _\ba_\bt_\by_\bp_\be
             Disables the _\ba_\bt_\by_\bp_\be type of authentication.

     -\b-a\ba      Attempt automatic login.  Currently, this sends the user name via
             the USER variable of the ENVIRON option if supported by the re-
             mote system.  The name used is that of the current user as re-
             turned by getlogin(2) if it agrees with the current user ID, oth-
             erwise it is the name associated with the user ID.

     -\b-c\bc      Disables the reading of the user's _\b._\bt_\be_\bl_\bn_\be_\bt_\br_\bc file.  (See the
             t\bto\bog\bgg\bgl\ble\be s\bsk\bki\bip\bpr\brc\bc command on this man page.)

     -\b-d\bd      Sets the initial value of the d\bde\beb\bbu\bug\bg toggle to TRUE

     -\b-e\be _\be_\bs_\bc_\ba_\bp_\be _\bc_\bh_\ba_\br
             Sets the initial t\bte\bel\bln\bne\bet\bt t\bte\bel\bln\bne\bet\bt escape character to _\be_\bs_\bc_\ba_\bp_\be _\bc_\bh_\ba_\br.
             If _\be_\bs_\bc_\ba_\bp_\be _\bc_\bh_\ba_\br is omitted, then there will be no escape charac-
             ter.

     -\b-f\bf      If Kerberos V5 authentication is being used, the -\b-f\bf option allows
             the local credentials to be forwarded to the remote system.

     -\b-k\bk _\br_\be_\ba_\bl_\bm
             If Kerberos authentication is being used, the -\b-k\bk option requests
             that telnet obtain tickets for the remote host in realm realm in-
             stead of the remote host's realm, as determined by
             krb_realmofhost(3).

     -\b-l\bl _\bu_\bs_\be_\br
             When connecting to the remote system, if the remote system under-
             stands the ENVIRON option, then _\bu_\bs_\be_\br will be sent to the remote
             system as the value for the variable USER.  This option implies
             the -\b-a\ba option.  This option may also be used with the o\bop\bpe\ben\bn com-
             mand.

     -\b-n\bn _\bt_\br_\ba_\bc_\be_\bf_\bi_\bl_\be
             Opens _\bt_\br_\ba_\bc_\be_\bf_\bi_\bl_\be for recording trace information.  See the s\bse\bet\bt
             t\btr\bra\bac\bce\bef\bfi\bil\ble\be command below.

     -\b-r\br      Specifies a user interface similar to rlogin(1).  In this mode,
             the escape character is set to the tilde (~) character, unless
             modified by the -e option.

     -\b-x\bx      Turn on encryption of the data stream.  When this option is
             turned on, will exit with an error if authentication cannot be
             negotiated or if encryption cannot be turned on.

     _\bh_\bo_\bs_\bt    Indicates the official name, an alias, or the Internet address of
             a remote host.

     _\bp_\bo_\br_\bt    Indicates a port number (address of an application).  If a number
             is not specified, the default t\bte\bel\bln\bne\bet\bt port is used.

     When in rlogin mode, a line of the form ~.  disconnects from the remote
     host; ~ is the telnet escape character.  Similarly, the line ~^Z suspends
     the telnet session.  The line ~^] escapes to the normal telnet escape
     prompt.

     Once a connection has been opened, t\bte\bel\bln\bne\bet\bt will attempt to enable the
     TELNET LINEMODE option.  If this fails, then t\bte\bel\bln\bne\bet\bt will revert to one of
     two input modes: either ``character at a time'' or ``old line by line''
     depending on what the remote system supports.

     When LINEMODE is enabled, character processing is done on the local sys-
     tem, under the control of the remote system.  When input editing or char-
     acter echoing is to be disabled, the remote system will relay that infor-
     mation.  The remote system will also relay changes to any special charac-
     ters that happen on the remote system, so that they can take effect on
     the local system.

     In ``character at a time'' mode, most text typed is immediately sent to
     the remote host for processing.

     In ``old line by line'' mode, all text is echoed locally, and (normally)
     only completed lines are sent to the remote host.  The ``local echo char-
     acter'' (initially ``^E'') may be used to turn off and on the local echo
     (this would mostly be used to enter passwords without the password being
     echoed).

     If the LINEMODE option is enabled, or if the l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs toggle is TRUE
     (the default for ``old line by line``; see below), the user's q\bqu\bui\bit\bt, i\bin\bnt\btr\br,
     and f\bfl\blu\bus\bsh\bh characters are trapped locally, and sent as TELNET protocol se-
     quences to the remote side.  If LINEMODE has ever been enabled, then the
     user's s\bsu\bus\bsp\bp and e\beo\bof\bf are also sent as TELNET protocol sequences, and q\bqu\bui\bit\bt
     is sent as a TELNET ABORT instead of BREAK There are options (see t\bto\bog\bgg\bgl\ble\be
     a\bau\but\bto\bof\bfl\blu\bus\bsh\bh and t\bto\bog\bgg\bgl\ble\be a\bau\but\bto\bos\bsy\byn\bnc\bch\bh below) which cause this action to flush
     subsequent output to the terminal (until the remote host acknowledges the
     TELNET sequence) and flush previous terminal input (in the case of q\bqu\bui\bit\bt
     and i\bin\bnt\btr\br).


     While connected to a remote host, t\bte\bel\bln\bne\bet\bt command mode may be entered by
     typing the t\bte\bel\bln\bne\bet\bt ``escape character'' (initially ``^]'').  When in com-
     mand mode, the normal terminal editing conventions are available.

     The following t\bte\bel\bln\bne\bet\bt commands are available.  Only enough of each command
     to uniquely identify it need be typed (this is also true for arguments to
     the m\bmo\bod\bde\be, s\bse\bet\bt, t\bto\bog\bgg\bgl\ble\be, u\bun\bns\bse\bet\bt, s\bsl\blc\bc, e\ben\bnv\bvi\bir\bro\bon\bn, and d\bdi\bis\bsp\bpl\bla\bay\by commands).

     a\bau\but\bth\bh _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt _\b._\b._\b.
                The auth command manipulates the information sent through the
                TELNET AUTHENTICATE option.  Valid arguments for the auth com-
                mand are as follows:

                d\bdi\bis\bsa\bab\bbl\ble\be _\bt_\by_\bp_\be  Disables the specified type of authentication.
                              To obtain a list of available types, use the
                              a\bau\but\bth\bh d\bdi\bis\bsa\bab\bbl\ble\be ?\b? command.

                e\ben\bna\bab\bbl\ble\be _\bt_\by_\bp_\be   Enables the specified type of authentication.
                              To obtain a list of available types, use the
                              a\bau\but\bth\bh e\ben\bna\bab\bbl\ble\be ?\b? command.

                s\bst\bta\bat\btu\bus\bs        Lists the current status of the various types of
                              authentication.

     c\bcl\blo\bos\bse\be      Close a TELNET session and return to command mode.

     d\bdi\bis\bsp\bpl\bla\bay\by _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt _\b._\b._\b.
                Displays all, or some, of the s\bse\bet\bt and t\bto\bog\bgg\bgl\ble\be values (see be-
                low).

     e\ben\bnc\bcr\bry\byp\bpt\bt _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt _\b._\b._\b.
                The encrypt command manipulates the information sent through
                the TELNET ENCRYPT option.

                Note:  Because of export controls, the TELNET ENCRYPT option
                is not supported outside of the United States and Canada.

                Valid arguments for the encrypt command are as follows:

                d\bdi\bis\bsa\bab\bbl\ble\be _\bt_\by_\bp_\be [i\bin\bnp\bpu\but\bt | o\bou\but\btp\bpu\but\bt]
                              Disables the specified type of encryption.  If
                              you omit the input and output, both input and
                              output are disabled.  To obtain a list of avail-
                              able types, use the e\ben\bnc\bcr\bry\byp\bpt\bt d\bdi\bis\bsa\bab\bbl\ble\be ?\b? command.

                e\ben\bna\bab\bbl\ble\be _\bt_\by_\bp_\be [i\bin\bnp\bpu\but\bt | o\bou\but\btp\bpu\but\bt]
                              Enables the specified type of encryption.  If
                              you omit input and output, both input and output
                              are enabled.  To obtain a list of available
                              types, use the e\ben\bnc\bcr\bry\byp\bpt\bt e\ben\bna\bab\bbl\ble\be ?\b? command.

                i\bin\bnp\bpu\but\bt         This is the same as the e\ben\bnc\bcr\bry\byp\bpt\bt s\bst\bta\bar\brt\bt i\bin\bnp\bpu\but\bt com-
                              mand.

                -\b-i\bin\bnp\bpu\but\bt        This is the same as the e\ben\bnc\bcr\bry\byp\bpt\bt s\bst\bto\bop\bp i\bin\bnp\bpu\but\bt com-
                              mand.

                o\bou\but\btp\bpu\but\bt        This is the same as the e\ben\bnc\bcr\bry\byp\bpt\bt s\bst\bta\bar\brt\bt o\bou\but\btp\bpu\but\bt
                              command.

                -\b-o\bou\but\btp\bpu\but\bt       This is the same as the e\ben\bnc\bcr\bry\byp\bpt\bt s\bst\bto\bop\bp o\bou\but\btp\bpu\but\bt com-
                              mand.

                s\bst\bta\bar\brt\bt [i\bin\bnp\bpu\but\bt | o\bou\but\btp\bpu\but\bt]
                              Attempts to start encryption.  If you omit i\bin\bnp\bpu\but\bt
                              and o\bou\but\btp\bpu\but\bt, both input and output are enabled.
                              To obtain a list of available types, use the
                              e\ben\bnc\bcr\bry\byp\bpt\bt e\ben\bna\bab\bbl\ble\be ?\b? command.

                s\bst\bta\bat\btu\bus\bs        Lists the current status of encryption.

                s\bst\bto\bop\bp [i\bin\bnp\bpu\but\bt | o\bou\but\btp\bpu\but\bt]
                              Stops encryption.  If you omit input and output,
                              encryption is on both input and output.

                t\bty\byp\bpe\be _\bt_\by_\bp_\be     Sets the default type of encryption to be used
                              with later e\ben\bnc\bcr\bry\byp\bpt\bt s\bst\bta\bar\brt\bt or e\ben\bnc\bcr\bry\byp\bpt\bt s\bst\bto\bop\bp com-
                              mands.

     e\ben\bnv\bvi\bir\bro\bon\bn _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt_\bs _\b._\b._\b.
                The e\ben\bnv\bvi\bir\bro\bon\bn command is used to manipulate the the variables
                that my be sent through the TELNET ENVIRON option.  The ini-
                tial set of variables is taken from the users environment,
                with only the DISPLAY and PRINTER variables being exported by
                default.  The USER variable is also exported if the -\b-a\ba or -\b-l\bl
                options are used.

                Valid arguments for the e\ben\bnv\bvi\bir\bro\bon\bn command are:

                d\bde\bef\bfi\bin\bne\be _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be _\bv_\ba_\bl_\bu_\be
                            Define the variable _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be to have a value of
                            _\bv_\ba_\bl_\bu_\be. Any variables defined by this command are
                            automatically exported.  The _\bv_\ba_\bl_\bu_\be may be enclosed
                            in single or double quotes so that tabs and spaces
                            may be included.

                u\bun\bnd\bde\bef\bfi\bin\bne\be _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be
                            Remove _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be from the list of environment vari-
                            ables.

                e\bex\bxp\bpo\bor\brt\bt _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be
                            Mark the variable _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be to be exported to the
                            remote side.

                u\bun\bne\bex\bxp\bpo\bor\brt\bt _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be
                            Mark the variable _\bv_\ba_\br_\bi_\ba_\bb_\bl_\be to not be exported un-
                            less explicitly asked for by the remote side.

                l\bli\bis\bst\bt        List the current set of environment variables.
                            Those marked with a *\b* will be sent automatically,
                            other variables will only be sent if explicitly
                            requested.

                ?\b?           Prints out help information for the e\ben\bnv\bvi\bir\bro\bon\bn com-
                            mand.

     l\blo\bog\bgo\bou\but\bt     Sends the TELNET LOGOUT option to the remote side.  This com-
                mand is similar to a c\bcl\blo\bos\bse\be command; however, if the remote
                side does not support the LOGOUT option, nothing happens.  If,
                however, the remote side does support the LOGOUT option, this
                command should cause the remote side to close the TELNET con-
                nection.  If the remote side also supports the concept of sus-
                pending a user's session for later reattachment, the logout
                argument indicates that you should terminate the session imme-
                diately.

     m\bmo\bod\bde\be _\bt_\by_\bp_\be  _\bT_\by_\bp_\be is one of several options, depending on the state of the
                TELNET session.  The remote host is asked for permission to go
                into the requested mode.  If the remote host is capable of en-


                tering that mode, the requested mode will be entered.

                c\bch\bha\bar\bra\bac\bct\bte\ber\br     Disable the TELNET LINEMODE option, or, if the
                              remote side does not understand the LINEMODE op-
                              tion, then enter ``character at a time`` mode.

                l\bli\bin\bne\be          Enable the TELNET LINEMODE option, or, if the
                              remote side does not understand the LINEMODE op-
                              tion, then attempt to enter ``old-line-by-line``
                              mode.

                i\bis\bsi\big\bg (-\b-i\bis\bsi\big\bg)  Attempt to enable (disable) the TRAPSIG mode of
                              the LINEMODE option.  This requires that the
                              LINEMODE option be enabled.

                e\bed\bdi\bit\bt (-\b-e\bed\bdi\bit\bt)  Attempt to enable (disable) the EDIT mode of the
                              LINEMODE option.  This requires that the
                              LINEMODE option be enabled.

                s\bso\bof\bft\btt\bta\bab\bbs\bs (-\b-s\bso\bof\bft\btt\bta\bab\bbs\bs)
                              Attempt to enable (disable) the SOFT_TAB mode of
                              the LINEMODE option.  This requires that the
                              LINEMODE option be enabled.

                l\bli\bit\bte\bec\bch\bho\bo (-\b-l\bli\bit\bte\bec\bch\bho\bo)
                              Attempt to enable (disable) the LIT_ECHO mode of
                              the LINEMODE option.  This requires that the
                              LINEMODE option be enabled.

                ?\b?             Prints out help information for the m\bmo\bod\bde\be com-
                              mand.

     o\bop\bpe\ben\bn _\bh_\bo_\bs_\bt [-\b-l\bl _\bu_\bs_\be_\br] [[-\b-]_\bp_\bo_\br_\bt]
                Open a connection to the named host.  If no port number is
                specified, t\bte\bel\bln\bne\bet\bt will attempt to contact a TELNET server at
                the default port.  The host specification may be either a host
                name (see hosts(5))  or an Internet address specified in the
                ``dot notation'' (see inet(3)).  The [-\b-l\bl] option may be used
                to specify the user name to be passed to the remote system via
                the ENVIRON option.  When connecting to a non-standard port,
                t\bte\bel\bln\bne\bet\bt omits any automatic initiation of TELNET options.  When
                the port number is preceded by a minus sign, the initial op-
                tion negotiation is done.  After establishing a connection,
                the file _\b._\bt_\be_\bl_\bn_\be_\bt_\br_\bc in the users home directory is opened.
                Lines beginning with a # are comment lines.  Blank lines are
                ignored.  Lines that begin without white space are the start
                of a machine entry.  The first thing on the line is the name
                of the machine that is being connected to.  The rest of the
                line, and successive lines that begin with white space are as-
                sumed to be t\bte\bel\bln\bne\bet\bt commands and are processed as if they had
                been typed in manually to the t\bte\bel\bln\bne\bet\bt command prompt.

     q\bqu\bui\bit\bt       Close any open TELNET session and exit t\bte\bel\bln\bne\bet\bt. An end of file
                (in command mode) will also close a session and exit.

     s\bse\ben\bnd\bd _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt_\bs
                Sends one or more special character sequences to the remote
                host.  The following are the arguments which may be specified
                (more than one argument may be specified at a time):

                a\bab\bbo\bor\brt\bt   Sends the TELNET ABORT (Abort processes) sequence.

                a\bao\bo      Sends the TELNET AO (Abort Output) sequence, which
                        should cause the remote system to flush all output


                        _\bf_\br_\bo_\bm the remote system _\bt_\bo the user's terminal.

                a\bay\byt\bt     Sends the TELNET AYT (Are You There) sequence, to
                        which the remote system may or may not choose to re-
                        spond.

                b\bbr\brk\bk     Sends the TELNET BRK (Break) sequence, which may have
                        significance to the remote system.

                e\bec\bc      Sends the TELNET EC (Erase Character) sequence, which
                        should cause the remote system to erase the last char-
                        acter entered.

                e\bel\bl      Sends the TELNET EL (Erase Line) sequence, which
                        should cause the remote system to erase the line cur-
                        rently being entered.

                e\beo\bof\bf     Sends the TELNET EOF (End Of File) sequence.

                e\beo\bor\br     Sends the TELNET EOR (End of Record) sequence.

                e\bes\bsc\bca\bap\bpe\be  Sends the current t\bte\bel\bln\bne\bet\bt escape character (initially
                        ``^'').

                g\bga\ba      Sends the TELNET GA (Go Ahead) sequence, which likely
                        has no significance to the remote system.

                g\bge\bet\bts\bst\bta\bat\btu\bus\bs
                        If the remote side supports the TELNET STATUS command,
                        g\bge\bet\bts\bst\bta\bat\btu\bus\bs will send the subnegotiation to request that
                        the server send its current option status.

                i\bip\bp      Sends the TELNET IP (Interrupt Process) sequence,
                        which should cause the remote system to abort the cur-
                        rently running process.

                n\bno\bop\bp     Sends the TELNET NOP (No OPeration) sequence.

                s\bsu\bus\bsp\bp    Sends the TELNET SUSP (SUSPend process) sequence.

                s\bsy\byn\bnc\bch\bh   Sends the TELNET SYNCH sequence.  This sequence causes
                        the remote system to discard all previously typed (but
                        not yet read) input.  This sequence is sent as TCP ur-
                        gent data (and may not work if the remote system is a
                        4.2BSD system -- if it doesn't work, a lower case
                        ``r'' may be echoed on the terminal).

                d\bdo\bo _\bc_\bm_\bd

                d\bdo\bon\bnt\bt _\bc_\bm_\bd

                w\bwi\bil\bll\bl _\bc_\bm_\bd

                w\bwo\bon\bnt\bt _\bc_\bm_\bd
                        Sends the TELNET DO _\bc_\bm_\bd sequence.  _\bC_\bm_\bd can be either a
                        decimal number between 0 and 255, or a symbolic name
                        for a specific TELNET command.  _\bC_\bm_\bd can also be either
                        h\bhe\bel\blp\bp or ?\b? to print out help information, including a
                        list of known symbolic names.

                ?\b?       Prints out help information for the s\bse\ben\bnd\bd command.

     s\bse\bet\bt _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt _\bv_\ba_\bl_\bu_\be

     u\bun\bns\bse\bet\bt _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt _\bv_\ba_\bl_\bu_\be
                The s\bse\bet\bt command will set any one of a number of t\bte\bel\bln\bne\bet\bt vari-
                ables to a specific value or to TRUE. The special value o\bof\bff\bf
                turns off the function associated with the variable, this is
                equivalent to using the u\bun\bns\bse\bet\bt command.  The u\bun\bns\bse\bet\bt command will
                disable or set to FALSE any of the specified functions.  The
                values of variables may be interrogated with the d\bdi\bis\bsp\bpl\bla\bay\by com-
                mand.  The variables which may be set or unset, but not tog-
                gled, are listed here.  In addition, any of the variables for
                the t\bto\bog\bgg\bgl\ble\be command may be explicitly set or unset using the
                s\bse\bet\bt and u\bun\bns\bse\bet\bt commands.

                a\bay\byt\bt     If TELNET is in localchars mode, or LINEMODE is en-
                        abled, and the status character is typed, a TELNET AYT
                        sequence (see s\bse\ben\bnd\bd a\bay\byt\bt preceding) is sent to the re-
                        mote host.  The initial value for the "Are You There"
                        character is the terminal's status character.

                e\bec\bch\bho\bo    This is the value (initially ``^E'') which, when in
                        ``line by line'' mode, toggles between doing local
                        echoing of entered characters (for normal processing),
                        and suppressing echoing of entered characters (for en-
                        tering, say, a password).

                e\beo\bof\bf     If t\bte\bel\bln\bne\bet\bt is operating in LINEMODE or ``old line by
                        line'' mode, entering this character as the first
                        character on a line will cause this character to be
                        sent to the remote system.  The initial value of the
                        eof character is taken to be the terminal's e\beo\bof\bf char-
                        acter.

                e\ber\bra\bas\bse\be   If t\bte\bel\bln\bne\bet\bt is in l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs mode (see t\bto\bog\bgg\bgl\ble\be l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs
                        below), a\ban\bnd\bd if t\bte\bel\bln\bne\bet\bt is operating in ``character at a
                        time'' mode, then when this character is typed, a
                        TELNET EC sequence (see s\bse\ben\bnd\bd e\bec\bc above) is sent to the
                        remote system.  The initial value for the erase char-
                        acter is taken to be the terminal's e\ber\bra\bas\bse\be character.

                e\bes\bsc\bca\bap\bpe\be  This is the t\bte\bel\bln\bne\bet\bt escape character (initially ``^['')
                        which causes entry into t\bte\bel\bln\bne\bet\bt command mode (when con-
                        nected to a remote system).

                f\bfl\blu\bus\bsh\bho\bou\but\btp\bpu\but\bt
                        If t\bte\bel\bln\bne\bet\bt is in l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs mode (see t\bto\bog\bgg\bgl\ble\be l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs
                        below) and the f\bfl\blu\bus\bsh\bho\bou\but\btp\bpu\but\bt character is typed, a
                        TELNET AO sequence (see s\bse\ben\bnd\bd a\bao\bo above) is sent to the
                        remote host.  The initial value for the flush charac-
                        ter is taken to be the terminal's f\bfl\blu\bus\bsh\bh character.

                f\bfo\bor\brw\bw1\b1

                f\bfo\bor\brw\bw2\b2   If TELNET is operating in LINEMODE, these are the
                        characters that, when typed, cause partial lines to be
                        forwarded to the remote system.  The initial value for
                        the forwarding characters are taken from the termi-
                        nal's eol and eol2 characters.

                i\bin\bnt\bte\ber\brr\bru\bup\bpt\bt
                        If t\bte\bel\bln\bne\bet\bt is in l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs mode (see t\bto\bog\bgg\bgl\ble\be l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs
                        below) and the i\bin\bnt\bte\ber\brr\bru\bup\bpt\bt character is typed, a TELNET
                        IP sequence (see s\bse\ben\bnd\bd i\bip\bp above) is sent to the remote
                        host.  The initial value for the interrupt character
                        is taken to be the terminal's i\bin\bnt\btr\br character.

                k\bki\bil\bll\bl    If t\bte\bel\bln\bne\bet\bt is in l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs mode (see t\bto\bog\bgg\bgl\ble\be l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs
                        below), a\ban\bnd\bd if t\bte\bel\bln\bne\bet\bt is operating in ``character at a
                        time'' mode, then when this character is typed, a
                        TELNET EL sequence (see s\bse\ben\bnd\bd e\bel\bl above) is sent to the
                        remote system.  The initial value for the kill charac-
                        ter is taken to be the terminal's k\bki\bil\bll\bl character.

                l\bln\bne\bex\bxt\bt   If t\bte\bel\bln\bne\bet\bt is operating in LINEMODE or ``old line by
                        line`` mode, then this character is taken to be the
                        terminal's l\bln\bne\bex\bxt\bt character.  The initial value for the
                        lnext character is taken to be the terminal's l\bln\bne\bex\bxt\bt
                        character.

                q\bqu\bui\bit\bt    If t\bte\bel\bln\bne\bet\bt is in l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs mode (see t\bto\bog\bgg\bgl\ble\be l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs
                        below) and the q\bqu\bui\bit\bt character is typed, a TELNET BRK
                        sequence (see s\bse\ben\bnd\bd b\bbr\brk\bk above) is sent to the remote
                        host.  The initial value for the quit character is
                        taken to be the terminal's q\bqu\bui\bit\bt character.

                r\bre\bep\bpr\bri\bin\bnt\bt
                        If t\bte\bel\bln\bne\bet\bt is operating in LINEMODE or ``old line by
                        line`` mode, then this character is taken to be the
                        terminal's r\bre\bep\bpr\bri\bin\bnt\bt character.  The initial value for
                        the reprint character is taken to be the terminal's
                        r\bre\bep\bpr\bri\bin\bnt\bt character.

                r\brl\blo\bog\bgi\bin\bn  This is the rlogin escape character.  If set, the nor-
                        mal TELNET escape character is ignored unless it is
                        preceded by this character at the beginning of a line.
                        This character, at the beginning of a line followed by
                        a "."  closes the connection; when followed by a ^Z it
                        suspends the telnet command.  The initial state is to
                        disable the rlogin escape character.

                s\bst\bta\bar\brt\bt   If the TELNET TOGGLE-FLOW-CONTROL option has been en-
                        abled, then this character is taken to be the termi-
                        nal's s\bst\bta\bar\brt\bt character.  The initial value for the kill
                        character is taken to be the terminal's s\bst\bta\bar\brt\bt charac-
                        ter.

                s\bst\bto\bop\bp    If the TELNET TOGGLE-FLOW-CONTROL option has been en-
                        abled, then this character is taken to be the termi-
                        nal's s\bst\bto\bop\bp character.  The initial value for the kill
                        character is taken to be the terminal's s\bst\bto\bop\bp charac-
                        ter.

                s\bsu\bus\bsp\bp    If t\bte\bel\bln\bne\bet\bt is in l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs mode, or LINEMODE is en-
                        abled, and the s\bsu\bus\bsp\bpe\ben\bnd\bd character is typed, a TELNET
                        SUSP sequence (see s\bse\ben\bnd\bd s\bsu\bus\bsp\bp above) is sent to the re-
                        mote host.  The initial value for the suspend charac-
                        ter is taken to be the terminal's s\bsu\bus\bsp\bpe\ben\bnd\bd character.

                t\btr\bra\bac\bce\bef\bfi\bil\ble\be
                        This is the file to which the output, caused by
                        n\bne\bet\btd\bda\bat\bta\ba or o\bop\bpt\bti\bio\bon\bn tracing being TRUE, will be written.
                        If it is set to ``-\b-'', then tracing information will
                        be written to standard output (the default).

                w\bwo\bor\brd\bde\ber\bra\bas\bse\be
                        If t\bte\bel\bln\bne\bet\bt is operating in LINEMODE or ``old line by
                        line`` mode, then this character is taken to be the
                        terminal's w\bwo\bor\brd\bde\ber\bra\bas\bse\be character.  The initial value for
                        the worderase character is taken to be the terminal's
                        w\bwo\bor\brd\bde\ber\bra\bas\bse\be character.

                ?\b?       Displays the legal s\bse\bet\bt (u\bun\bns\bse\bet\bt) commands.

     s\bsl\blc\bc _\bs_\bt_\ba_\bt_\be  The s\bsl\blc\bc command (Set Local Characters) is used to set or
                change the state of the the special characters when the TELNET
                LINEMODE option has been enabled.  Special characters are
                characters that get mapped to TELNET commands sequences (like
                i\bip\bp or q\bqu\bui\bit\bt) or line editing characters (like e\ber\bra\bas\bse\be and k\bki\bil\bll\bl).
                By default, the local special characters are exported.

                c\bch\bhe\bec\bck\bk       Verify the current settings for the current spe-
                            cial characters.  The remote side is requested to
                            send all the current special character settings,
                            and if there are any discrepancies with the local
                            side, the local side will switch to the remote
                            value.

                e\bex\bxp\bpo\bor\brt\bt      Switch to the local defaults for the special char-
                            acters.  The local default characters are those of
                            the local terminal at the time when t\bte\bel\bln\bne\bet\bt was
                            started.

                i\bim\bmp\bpo\bor\brt\bt      Switch to the remote defaults for the special
                            characters.  The remote default characters are
                            those of the remote system at the time when the
                            TELNET connection was established.

                ?\b?           Prints out help information for the s\bsl\blc\bc command.

     s\bst\bta\bat\btu\bus\bs     Show the current status of t\bte\bel\bln\bne\bet\bt. This includes the peer one
                is connected to, as well as the current mode.

     t\bto\bog\bgg\bgl\ble\be _\ba_\br_\bg_\bu_\bm_\be_\bn_\bt_\bs _\b._\b._\b.
                Toggle (between TRUE and FALSE) various flags that control how
                t\bte\bel\bln\bne\bet\bt responds to events.  These flags may be set explicitly
                to TRUE or FALSE using the s\bse\bet\bt and u\bun\bns\bse\bet\bt commands listed
                above.  More than one argument may be specified.  The state of
                these flags may be interrogated with the d\bdi\bis\bsp\bpl\bla\bay\by command.
                Valid arguments are:

                a\bau\but\bth\bhd\bde\beb\bbu\bug\bg     Turns on debugging information for the authenti-
                              cation code.

                a\bau\but\bto\bof\bfl\blu\bus\bsh\bh     If a\bau\but\bto\bof\bfl\blu\bus\bsh\bh and l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs are both TRUE, then
                              when the a\bao\bo, or q\bqu\bui\bit\bt characters are recognized
                              (and transformed into TELNET sequences; see s\bse\bet\bt
                              above for details), t\bte\bel\bln\bne\bet\bt refuses to display
                              any data on the user's terminal until the remote
                              system acknowledges (via a TELNET TIMING MARK
                              option) that it has processed those TELNET se-
                              quences.  The initial value for this toggle is
                              TRUE if the terminal user had not done an "stty
                              noflsh", otherwise FALSE (see stty(1)).

                a\bau\but\bto\bod\bde\bec\bcr\bry\byp\bpt\bt   When the TELNET ENCRYPT option is negotiated, by
                              default the actual encryption (decryption) of
                              the data stream does not start automatically.
                              The autoencrypt (autodecrypt) command states
                              that encryption of the output (input) stream
                              should be enabled as soon as possible.

                              Note:  Because of export controls, the TELNET
                              ENCRYPT option is not supported outside the
                              United States and Canada.

                a\bau\but\bto\bol\blo\bog\bgi\bin\bn     If the remote side supports the TELNET
                              AUTHENTICATION option TELNET attempts to use it
                              to perform automatic authentication.  If the
                              AUTHENTICATION option is not supported, the us-
                              er's login name are propagated through the
                              TELNET ENVIRON option.  This command is the same

                              as specifying _\ba option on the o\bop\bpe\ben\bn command.

                a\bau\but\bto\bos\bsy\byn\bnc\bch\bh     If a\bau\but\bto\bos\bsy\byn\bnc\bch\bh and l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs are both TRUE, then
                              when either the i\bin\bnt\btr\br or q\bqu\bui\bit\bt characters is typed
                              (see s\bse\bet\bt above for descriptions of the i\bin\bnt\btr\br and
                              q\bqu\bui\bit\bt characters), the resulting TELNET sequence
                              sent is followed by the TELNET SYNCH sequence.
                              This procedure s\bsh\bho\bou\bul\bld\bd cause the remote system to
                              begin throwing away all previously typed input
                              until both of the TELNET sequences have been
                              read and acted upon.  The initial value of this
                              toggle is FALSE.

                b\bbi\bin\bna\bar\bry\by        Enable or disable the TELNET BINARY option on
                              both input and output.

                i\bin\bnb\bbi\bin\bna\bar\bry\by      Enable or disable the TELNET BINARY option on
                              input.

                o\bou\but\btb\bbi\bin\bna\bar\bry\by     Enable or disable the TELNET BINARY option on
                              output.

                c\bcr\brl\blf\bf          If this is TRUE, then carriage returns will be
                              sent as <CR><LF>. If this is FALSE, then car-
                              riage returns will be send as <CR><NUL>. The
                              initial value for this toggle is FALSE.

                c\bcr\brm\bmo\bod\bd         Toggle carriage return mode.  When this mode is
                              enabled, most carriage return characters re-
                              ceived from the remote host will be mapped into
                              a carriage return followed by a line feed.  This
                              mode does not affect those characters typed by
                              the user, only those received from the remote
                              host.  This mode is not very useful unless the
                              remote host only sends carriage return, but nev-
                              er line feed.  The initial value for this toggle
                              is FALSE.

                d\bde\beb\bbu\bug\bg         Toggles socket level debugging (useful only to
                              the s\bsu\bup\bpe\ber\br u\bus\bse\ber\br). The initial value for this tog-
                              gle is FALSE.

                e\ben\bnc\bcd\bde\beb\bbu\bug\bg      Turns on debugging information for the encryp-
                              tion code.

                l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs    If this is TRUE, then the f\bfl\blu\bus\bsh\bh, i\bin\bnt\bte\ber\brr\bru\bup\bpt\bt,
                              q\bqu\bui\bit\bt, e\ber\bra\bas\bse\be, and k\bki\bil\bll\bl characters (see s\bse\bet\bt above)
                              are recognized locally, and transformed into
                              (hopefully) appropriate TELNET control sequences
                              (respectively a\bao\bo, i\bip\bp, b\bbr\brk\bk, e\bec\bc, and e\bel\bl; see s\bse\ben\bnd\bd
                              above).  The initial value for this toggle is
                              TRUE in ``old line by line'' mode, and FALSE in
                              ``character at a time'' mode.  When the LINEMODE
                              option is enabled, the value of l\blo\boc\bca\bal\blc\bch\bha\bar\brs\bs is
                              ignored, and assumed to always be TRUE. If
                              LINEMODE has ever been enabled, then q\bqu\bui\bit\bt is
                              sent as a\bab\bbo\bor\brt\bt, and e\beo\bof\bf and s\bsu\bus\bsp\bpe\ben\bnd\bd are sent as
                              e\beo\bof\bf and s\bsu\bus\bsp\bp, see s\bse\ben\bnd\bd above).

                n\bne\bet\btd\bda\bat\bta\ba       Toggles the display of all network data (in hex-
                              adecimal format).  The initial value for this
                              toggle is FALSE.

                o\bop\bpt\bti\bio\bon\bns\bs       Toggles the display of some internal t\bte\bel\bln\bne\bet\bt pro-
                              tocol processing (having to do with TELNET op-
                              tions).  The initial value for this toggle is

                              FALSE.

                p\bpr\bre\bet\btt\bty\byd\bdu\bum\bmp\bp    When the n\bne\bet\btd\bda\bat\bta\ba toggle is enabled, if
                              p\bpr\bre\bet\btt\bty\byd\bdu\bum\bmp\bp is enabled the output from the
                              n\bne\bet\btd\bda\bat\bta\ba command will be formatted in a more user
                              readable format.  Spaces are put between each
                              character in the output, and the beginning of
                              any TELNET escape sequence is preceded by a '*'
                              to aid in locating them.

                s\bsk\bki\bip\bpr\brc\bc        When the skiprc toggle is TRUE, TELNET skips the
                              reading of the _\b._\bt_\be_\bl_\bn_\be_\bt_\br_\bc file in the users home
                              directory when connections are opened.  The ini-
                              tial value for this toggle is FALSE.

                t\bte\ber\brm\bmd\bda\bat\bta\ba      Toggles the display of all terminal data (in
                              hexadecimal format).  The initial value for this
                              toggle is FALSE.

                v\bve\ber\brb\bbo\bos\bse\be_\b_e\ben\bnc\bcr\bry\byp\bpt\bt
                              When the v\bve\ber\brb\bbo\bos\bse\be_\b_e\ben\bnc\bcr\bry\byp\bpt\bt toggle is TRUE, TELNET
                              prints out a message each time encryption is en-
                              abled or disabled.  The initial value for this
                              toggle is FALSE. Note:  Because of export con-
                              trols, data encryption is not supported outside
                              of the United States and Canada.

                ?\b?             Displays the legal t\bto\bog\bgg\bgl\ble\be commands.

     z\bz          Suspend t\bte\bel\bln\bne\bet\bt. This command only works when the user is using
                the csh(1).

     !\b! [_\bc_\bo_\bm_\bm_\ba_\bn_\bd]
                Execute a single command in a subshell on the local system.
                If c\bco\bom\bmm\bma\ban\bnd\bd is omitted, then an interactive subshell is in-
                voked.

     ?\b? [_\bc_\bo_\bm_\bm_\ba_\bn_\bd]
                Get help.  With no arguments, t\bte\bel\bln\bne\bet\bt prints a help summary.
                If a command is specified, t\bte\bel\bln\bne\bet\bt will print the help informa-
                tion for just that command.

E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
     T\bTe\bel\bln\bne\bet\bt uses at least the HOME, SHELL, DISPLAY, and TERM environment vari-
     ables.  Other environment variables may be propagated to the other side
     via the TELNET ENVIRON option.

F\bFI\bIL\bLE\bES\bS
     ~/.telnetrc  user customized telnet startup values

H\bHI\bIS\bST\bTO\bOR\bRY\bY
     The T\bTe\bel\bln\bne\bet\bt command appeared in 4.2BSD.

N\bNO\bOT\bTE\bES\bS
     On some remote systems, echo has to be turned off manually when in ``old
     line by line'' mode.

     In ``old line by line'' mode or LINEMODE the terminal's e\beo\bof\bf character is
     only recognized (and sent to the remote system) when it is the first
     character on a line.

4.2 Berkeley Distribution        June 1, 1994                               11