All rights reserved.
Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
@(#)telnet.1 6.7 (Berkeley) 08/22/89
Once a connection has been opened, telnet will attempt to enable the \s-1TELNET LINEMODE\s+1 option. If this fails, then telnet will revert to one of two input modes: either \*(lqcharacter at a time\*(rq or \*(lqold line by line\*(rq depending on what the remote system supports.
When \s-1LINEMODE\s+1 is enabled, character processing is done on the local system, under the control of the remote system. When input editing or character echoing is to be disabled, the remote system will relay that information. The remote system will also relay changes to any special characters that happen on the remote system, so that they can take effect on the local system.
In \*(lqcharacter at a time\*(rq mode, most text typed is immediately sent to the remote host for processing.
In \*(lqold line by line\*(rq mode, all text is echoed locally, and (normally) only completed lines are sent to the remote host. The \*(lqlocal echo character\*(rq (initially \*(lq^E\*(rq) 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 \s-1LINEMODE\s+1 option is enabled, or if the localchars toggle is TRUE (the default for \*(lqold line by line\*(lq; see below), the user's quit , intr , and flush characters are trapped locally, and sent as \s-1TELNET\s+1 protocol sequences to the remote side. If \s-1LINEMODE\s+1 has ever been enabled, then the user's susp and eof are also sent as \s-1TELNET\s+1 protocol sequences, and quit is sent as a \s-1TELNET ABORT\s+1 instead of \s-1BREAK\s+1. There are options (see toggle autoflush and toggle autosynch below) which cause this action to flush subsequent output to the terminal (until the remote host acknowledges the \s-1TELNET\s+1 sequence) and flush previous terminal input (in the case of quit and intr ).
While connected to a remote host, telnet command mode may be entered by typing the telnet \*(lqescape character\*(rq (initially \*(lq^]\*(rq). When in command mode, the normal terminal editing conventions are available.
Options:
8 -d Sets the initial value of the debug toggle to \s-1TRUE\s+1.
-n tracefile Opens tracefile for recording trace information. See the set tracefile command below.
host Indicates the official name, an alias, or the Internet address of a remote host.
port Indicates a port number (address of an application). If a number is not specified, the default telnet port is used.
The following telnet commands are available. Only enough of each command to uniquely identify it need be typed (this is also true for arguments to the mode , set , toggle , unset , slc , and display commands).
10 close
Close a \s-1TELNET\s+1 session and return to command mode.
display [ argument... ]
Displays all, or some, of the set and toggle values (see below).
mode type
Type is one of several options, depending on the state of the \s-1TELNET\s+1 session. The remote host is asked for permission to go into the requested mode. If the remote host is capable of entering that mode, the requested mode will be entered.
character
Disable the \s-1TELNET LINEMODE\s+1 option, or, if the remote side does not understand the \s-1LINEMODE\s+1 option, then enter \*(lqcharacter at a time\*(lq mode.
line
Enable the \s-1TELNET LINEMODE\s+1 option, or, if the remote side does not understand the \s-1LINEMODE\s+1 option, then attempt to enter \*(lqold-line-by-line\*(lq mode.
isig (-isig)
Attempt to enable (disable) the \s-1TRAPSIG\s+1 mode of the \s-1LINEMODE\s+1 option. This requires that the \s-1LINEMODE\s+1 option be enabled.
edit (-edit)
Attempt to enable (disable) the \s-1EDIT\s+1 mode of the \s-1LINEMODE\s+1 option. This requires that the \s-1LINEMODE\s+1 option be enabled.
?
Prints out help information for the mode command.
open host [ [-]port ]
Open a connection to the named host. If no port number is specified, telnet will attempt to contact a \s-1TELNET\s+1 server at the default port. The host specification may be either a host name (see hosts (5)) or an Internet address specified in the \*(lqdot notation\*(rq (see inet (3N)). When connecting to a non-standard port, telnet omits any automatic initiation of \s-1TELNET\s+1 options. When the port number is preceeded by a minus sign, the inital option negotiation is done. After establishing a connection, the .telnetrc in the users home directory is opened. Lines begining with a # are comment lines. Blank lines are ignored. Lines that begin without whitespace 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 whitespace are assumed to be telnet commands and are processed as if they had been typed in manually to the telnet command prompt.
quit
Close any open \s-1TELNET\s+1 session and exit telnet . An end of file (in command mode) will also close a session and exit.
send arguments
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):
abort
Sends the \s-1TELNET ABORT\s+1 (ABORT processes) sequence.
ao
Sends the \s-1TELNET AO\s+1 (Abort Output) sequence, which should cause the remote system to flush all output from the remote system to the user's terminal.
ayt
Sends the \s-1TELNET AYT\s+1 (Are You There) sequence, to which the remote system may or may not choose to respond.
brk
Sends the \s-1TELNET BRK\s+1 (Break) sequence, which may have significance to the remote system.
ec
Sends the \s-1TELNET EC\s+1 (Erase Character) sequence, which should cause the remote system to erase the last character entered.
el
Sends the \s-1TELNET EL\s+1 (Erase Line) sequence, which should cause the remote system to erase the line currently being entered.
eof
Sends the \s-1TELNET EOF\s+1 (End Of File) sequence.
eor
Sends the \s-1TELNET EOR\s+1 (End of Record) sequence.
escape
Sends the current telnet escape character (initially \*(lq^]\*(rq).
ga
Sends the \s-1TELNET GA\s+1 (Go Ahead) sequence, which likely has no significance to the remote system.
ip
Sends the \s-1TELNET IP\s+1 (Interrupt Process) sequence, which should cause the remote system to abort the currently running process.
nop
Sends the \s-1TELNET NOP\s+1 (No OPeration) sequence.
susp
Sends the \s-1TELNET SUSP\s+1 (SUSPend process) sequence.
synch
Sends the \s-1TELNET SYNCH\s+1 sequence. This sequence causes the remote system to discard all previously typed (but not yet read) input. This sequence is sent as TCP urgent data (and may not work if the remote system is a 4.2 BSD system -- if it doesn't work, a lower case \*(lqr\*(rq may be echoed on the terminal).
?
Prints out help information for the send command.
set argument value
unset arguments...
The set command will set any one of a number of telnet variables to a specific value or to TRUE. The special value off turns off the function associated with the variable, this is equivalent to using the unset command. The unset command will disable or set to FALSE any of the specified functions. The values of variables may be interrogated with the display command. The variables which may be set or unset, but not toggled, are listed here. In addition, any of the variables for the toggle command may be explicitly set or unset using the set and unset commands.
echo
This is the value (initially \*(lq^E\*(rq) which, when in \*(lqline by line\*(rq mode, toggles between doing local echoing of entered characters (for normal processing), and suppressing echoing of entered characters (for entering, say, a password).
eof
If telnet is operating in \s-1LINEMODE\s+1 or \*(lqold line by line\*(rq 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 eof character.
erase
If telnet is in localchars mode (see toggle localchars below), and if telnet is operating in \*(lqcharacter at a time\*(rq mode, then when this character is typed, a \s-1TELNET EC\s+1 sequence (see send ec above) is sent to the remote system. The initial value for the erase character is taken to be the terminal's erase character.
escape
This is the telnet escape character (initially \*(lq^[\*(rq) which causes entry into telnet command mode (when connected to a remote system).
flushoutput
If telnet is in localchars mode (see toggle localchars below) and the flushoutput character is typed, a \s-1TELNET AO\s+1 sequence (see send ao above) is sent to the remote host. The initial value for the flush character is taken to be the terminal's flush character.
interrupt
If telnet is in localchars mode (see toggle localchars below) and the interrupt character is typed, a \s-1TELNET IP\s+1 sequence (see send ip above) is sent to the remote host. The initial value for the interrupt character is taken to be the terminal's intr character.
kill
If telnet is in localchars mode (see toggle localchars below), and if telnet is operating in \*(lqcharacter at a time\*(rq mode, then when this character is typed, a \s-1TELNET EL\s+1 sequence (see send el above) is sent to the remote system. The initial value for the kill character is taken to be the terminal's kill character.
lnext If telnet is operating in \s-1LINEMODE\s+1 or \*(lqold line by line\*(lq mode, then this character is taken to be the terminal's lnext character. The initial value for the lnext character is taken to be the terminal's lnext character.
quit
If telnet is in localchars mode (see toggle localchars below) and the quit character is typed, a \s-1TELNET BRK\s+1 sequence (see send brk above) is sent to the remote host. The initial value for the quit character is taken to be the terminal's quit character.
reprint
If telnet is operating in \s-1LINEMODE\s+1 or \*(lqold line by line\*(lq mode, then this character is taken to be the terminal's reprint character. The initial value for the reprint character is taken to be the terminal's reprint character.
start
If the \s-1TELNET TOGGLE-FLOW-CONTROL\s+1 option has been enabled, then this character is taken to be the terminal's start character. The initial value for the kill character is taken to be the terminal's start character.
stop
If the \s-1TELNET TOGGLE-FLOW-CONTROL\s+1 option has been enabled, then this character is taken to be the terminal's stop character. The initial value for the kill character is taken to be the terminal's stop character.
susp
If telnet is in localchars mode, or \s-1LINEMODE\s+1 is enabled, and the suspend character is typed, a \s-1TELNET SUSP\s+1 sequence (see send susp above) is sent to the remote host. The initial value for the suspend character is taken to be the terminal's suspend character.
tracefile This is the file to which the output, caused by netdata or option tracing being TRUE, will be written. If it is set to '-', then tracing information will be written to standard output (the default).
worderase
If telnet is operating in \s-1LINEMODE\s+1 or \*(lqold line by line\*(lq mode, then this character is taken to be the terminal's worderase character. The initial value for the worderase character is taken to be the terminal's worderase character.
slc state
The slc command (Set Local Characters) is used to set or change the state of the the special characters when the \s-1TELNET LINEMODE\s+1 option has been enabled. Special characters are characters that get mapped to \s-1TELNET\s+1 commands sequences (like ip or quit ) or line editing characters (like erase and kill ). By default, the local special characters are exported.
export
Switch to the local defaults for the special characters. The local default characters are those of the local terminal at the time when telnet was started.
import
Switch to the remote defaults for the special characters. The remote default characters are those of the remote system at the time when the \s-1TELNET\s+1 connection was established.
check
Verify the current settings for the current special characters. The remote side is requested to send all the current special character settings, and if there are any discrepencies with the local side, the local side will switch to the remote value.
?
Prints out help information for the slc command.
?
Displays the legal set (unset) commands.
toggle arguments...
Toggle (between TRUE and FALSE) various flags that control how telnet responds to events. These flags may be set explicitly to TRUE or FALSE using the set and unset commands listed above. More than one argument may be specified. The state of these flags may be interrogated with the display command. Valid arguments are:
autoflush
If autoflush and localchars are both TRUE, then when the ao , intr , or quit characters are recognized (and transformed into \s-1TELNET\s+1 sequences; see set above for details), telnet refuses to display any data on the user's terminal until the remote system acknowledges (via a \s-1TELNET TIMING MARK\s+1 option) that it has processed those \s-1TELNET\s+1 sequences. The initial value for this toggle is TRUE if the terminal user had not done an "stty noflsh", otherwise FALSE (see stty (1)).
autosynch If autosynch and localchars are both TRUE, then when either the intr or quit characters is typed (see set above for descriptions of the intr and quit characters), the resulting \s-1TELNET\s+1 sequence sent is followed by the \s-1TELNET SYNCH\s+1 sequence. This procedure should cause the remote system to begin throwing away all previously typed input until both of the \s-1TELNET\s+1 sequences have been read and acted upon. The initial value of this toggle is FALSE.
binary
Enable or disable the \s-1TELNET BINARY\s+1 option.
crlf
If this is TRUE, then carriage returns will be sent as <CR><LF>. If this is FALSE, then carriage returns will be send as <CR><NUL>. The initial value for this toggle is FALSE.
crmod
Toggle carriage return mode. When this mode is enabled, most carriage return characters received 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 never line feed. The initial value for this toggle is FALSE.
debug
Toggles socket level debugging (useful only to the super user ). The initial value for this toggle is FALSE.
localchars
If this is TRUE, then the flush , interrupt , quit , erase , and kill characters (see set above) are recognized locally, and transformed into (hopefully) appropriate \s-1TELNET\s+1 control sequences (respectively ao , ip , brk , ec , and el ; see send above). The initial value for this toggle is TRUE in \*(lqold line by line\*(rq mode, and FALSE in \*(lqcharacter at a time\*(rq mode. When the \s-1LINEMODE\s+1 option is enabled, the value of localchars is ignored, and assumed to always be TRUE. If \s-1LINEMODE\s+1 has ever been enabled, then quit is sent as abort , and eof and suspend are sent as eof and susp , see send above).
netdata
Toggles the display of all network data (in hexadecimal format). The initial value for this toggle is FALSE.
options
Toggles the display of some internal telnet protocol processing (having to do with \s-1TELNET\s+1 options). The initial value for this toggle is FALSE.
prettydump
When the netdata toggle is enabled, if prettydump is enabled the output from the netdata command will be formated in a more user readable format. Spaces are put between each character in the output, and the begining of any \s-1TELNET\s+1 escape sequence is preceeded by a '*' to aid in locating them.
?
Displays the legal toggle commands.
z
Suspend telnet . This command only works when the user is using the csh (1).
! [ command ]
Execute a single command in a subshell on the local system. If command is ommitted, then an interactive subshell is invoked.
status
Show the current status of telnet . This includes the peer one is connected to, as well as the current mode.
? [ command ]
Get help. With no arguments, telnet prints a help summary. If a command is specified, telnet will print the help information for just that command.
~/.telnetrc
On some remote systems, echo has to be turned off manually when in \*(lqold line by line\*(rq mode.
In \*(lqold line by line\*(rq mode or \s-1LINEMODE\s+1 the terminal's eof character is only recognized (and sent to the remote system) when it is the first character on a line.