Tera Term command line
TTERMPRO [ <host>[[:]<TCP port#>] | telnet://<host>[:<TCP port#>][/] | \\<server>\pipe\<pipe name>]
[/B] [/BAUD=<speed>] [/C=<serial port#>] [/DS] [/E] [/ES]
[/F=<setup file>] [/FD=<file transfer directory>]
[/H] [/I] [/K=<keyboard setup file>]
[/KR=<kanji code (receive)>] [/KT=<kanji code (transmit)>]
[/L=<log file>] [/LA=<language>] [/M=<macro file>] [/NOLOG]
[/P=<TCP port#>] [/R=<replay file>] [/SPEED=<speed>] [/T=<telnet flag>]
[/TEKICON=<icon name>] [/TIMEOUT=<connecting timeout value>]
[/V] [/VTICON=<icon name>] [/W="<window title>"] [/WAITCOM]
[/X=<window pos (x)>] [/Y=<window pos (y)>] [/PIPE]
[/AUTOWINCLOSE=<flag>] [/OSC52=<operations to permit>]
[;<comment>]
Options
- <host>
- Host name or IP address.
- <host>:<TCP port#>
- <host> with a TCP port number.
":" is placed between <host> and <TCP port#>.
- <host> <TCP port#>
- <host> with a TCP port number.
Space character(s) between <host> and <TCP port#>.
Number just after <host> is interpreted as a port number.
- telnet://<host>[:<TCP port#>][/]
- URL style - for telnet handler
TCP port number and "/" at the end are optional.
If TCP port number is omitted, use 23. (TCPPort setting in setup file is ignored.)
- \\<server>\pipe\<pipe name>
- Pipe name.
Connects to a named pipe <pipe name> on the <server>.
Connects to local named pipe by specifying \\.\pipe\<pipe name>.
- /B
- Telnet binary option.
- /BAUD=<speed>
-
speed of serial port. Same as the /SPEED= option.
Actually, the serial port driver may not reflect your speed.
- /C=<serial port#>
- Serial port
- /C=1 COM1
- /C=2 COM2
- /C=3 COM3
- :
- /C=256 COM256
By default, maximum serial port number is 256. It is configurable in MaxComPort setting.
- /CDATABIT=<value>
- Data bit of serial port
- /CDATABIT=7 7bit
- /CDATABIT=8 8bit
- /CPARITY=<value>
- Parity of serial port
- /CPARITY=none none
- /CPARITY=odd odd
- /CPARITY=even even
- /CPARITY=mark mark
- /CPARITY=space space
- /CSTOPBIT=<value>
- Stop bit of serial port
- /CSTOPBIT=1 1bit
- /CSTOPBIT=1.5 1.5bit
- /CSTOPBIT=2 2bit
- /CFLOWCTRL=<value>
- Flow control of serial port
- /CFLOWCTRL=x Xon/Xoff
- /CFLOWCTRL=hard RTS/CTS
- /CFLOWCTRL=rtscts RTS/CTS
- /CFLOWCTRL=none none
- /CFLOWCTRL=dsrdtr DSR/DTR
- /CDELAYPERCHAR=<value>
- Transmission delay time per character of serial port(msec)
- /CDELAYPERCHAR=n n millisecond
- /CDELAYPERLINE=<value>
- Transmission delay time per line of serial port(msec)
- /CDELAYPERLINE=n nmillisecond
- /DS
- Disable displaying the "New connection" dialog on startup
- /E
- Disable TCPLocalEcho and TCPCRSend option
- /ES
- Enable displaying the "New connection" dialog on startup
When the port type is TCP/IP, "New connection" dialog is shown basically.
However, the dialog can be not shown when HostDialogOnStartup is off.
The /ES option can be forced to show the "New connection" dialog regardless of the setting.
When the port type is Serial, the "New connection" dialog does not be shown. Also, the /ES option can not be effected.
- /F=<setup file>
- Setup file
/F=TERATERM.INI (default)
If this value is not a full path, it is understood as a relative path from ttermpro.exe.
- /FD=<file transfer directory>
- File transfer directory
- /H
- Hide title bar.
- /I
- Iconify Tera Term window.
NOTICE: This mode can also be used with Windows task scheduler when a user is not logged in.
- /K=<keyboard setup file>
- Keyboard setup file
/K=KEYBOARD.CNF (default)
If this value is not a full path, it is understood as a relative path from ttermpro.exe.
- /KR=<kanji code (receive)>
- Note: Japanese, Korean and UTF-8 mode only
- /KR=SJIS
- /KR=EUC
- /KR=JIS
- /KR=UTF8 UTF-8(Normalization Form C: Windows, Linux)
- /KR=UTF8m UTF-8(Normalization Form D: Mac OS X)
- /KR=KS5601 for Korean mode
- /KT=<kanji code (transmit)>
- Note: Japanese and Korean mode only
- /KT=SJIS
- /KT=EUC
- /KT=JIS
- /KT=UTF8
- /KT=KS5601 for Korean mode
- /L=<log file>
- Start Tera Term with logging.
File name can include formats of Tera Term and strftime.
If this value is not a full path, file name is converted to fullpath before open.
- /LA=<language>
- Language mode.
- /LA=E English
- /LA=J Japanese
- /LA=K Korean
- /LA=R Russian
- /LA=U UTF-8
- /M=<macro file>
- Start Tera Term with macro.
If this value is not a full path, it is understood as a relative path from ttermpro.exe.
- /MN=<multicastname>
- Multicast name for sendmulticast macro command.
- /NOLOG
- Start Tera Term without logging.
- /OSC52=<operations to permit>
-
operations to permit for clipboard access from remote host.
- /OCS52=off deny read and write access.
- /OCS52=read permits read access only
- /OCS52=write permits write access only
- /OCS52=readwrite permits read and write access
- /P=<TCP port#>
- TCP port number
- /R=<replay file>
- Replay file
- /SPEED=<speed>
-
speed of serial port. Same as the /BAUD= option.
Actually, the serial port driver may not reflect your speed.
- /T=<telnet flag>
- /T=1 Enable telnet
- /T=0 Disable telnet
- /TEKICON=<icon name>
- TEK window icon.
Could be specified the same value of TEKIcon of setup file.
- /TIMEOUT=<connecting timeout value>
- Could be specified per seconds.
- /V
- Start Tera Term in hidden (invisible) state.
- /VTICON=<icon name>
- VT window icon.
Could be specified the same value of VTIcon of setup file.
- /W=<window title>
- Window title
- /WAITCOM
- When serial port is specified with with /C= option and the port does not exist, Tera Term will wait for port connection.
- /X=<window position (x)>
- Windows position (horizontal)
- /Y=<window position (y)>
- Windows position (vertical)
- /PIPE
- Connects to a named pipe. The host name(pipe name) is ccomplemented by these rules:
- If the host name begins with a \, the name is not changed.
- If the host name does not include a \, the \\.\pipe\ is added at the beginning.
- If the host name includes a \ anywhere but first, before that is treated as server name and after that is treated as pipe name.
- /AUTOWINCLOSE=<flag>
- AutoWinClose
- /AUTOWINCLOSE=on Automatically close the window on disconnection.
- /AUTOWINCLOSE=off Do not close the window on disconnection.
- Comment. Should be last in the command line.
Examples
TTERMPRO
TTERMPRO myhost.example.com
TTERMPRO myhost.example.com:23
TTERMPRO myhost.example.com 23
TTERMPRO 192.0.2.1
TTERMPRO myhost.example.com /T=0 /P=7
TTERMPRO \\.\pipe\vmware-serial-port
TTERMPRO /C=1
TTERMPRO /F=TELNET.INI
TTERMPRO foohost.example.org /F=FOOHOST.INI
TTERMPRO /C=2 /SPEED=9600 /F=MYSETUP.INI
TTERMPRO /K=MYKEY.CNF /W="My host"
TTERMPRO /R=README.TXT ; replay a file
TTERMPRO myhost /B /X=100 /Y=50
TTERMPRO /PIPE pipename ; same as \\.\pipe\pipename
Default values
Following default values are stored in the Tera Term setup file:
<TCP port#>
/B
<speed>
<serial port#>
<file transfer directory>
/H
<kanji code (receive)>
<kanji code (transmit)>
<language>
<macro file>
<telnet flag>
<icon name>
<window title>
<window pos (x)>
<window pos (y)>
Note
[1] Only if <telnet flag> is 1 (on) and <TCP port#> is 23, Tera Term starts spontaneously sending telnet commands to the host for the option negotiation when the TCP/IP connection is established. In any cases, Tera Term can respond to telnet commands sent by the host.
[2] If the parameter value can include the space character and semicolon, a user should put the value in quotations by using `"' character.
If the value includes the `"' character, the user should write the `"' character two times.(version 4.63 or later)
/F="C:\Document and Settings\user\My Documents\teraterm\server1.INI"
/W="Tera Term"
/W="""Tera Term"""
/W="Tera;Term"
See also
Telnet port number / Terminal setup for non-telnet connection