CygTerm+ setup file

cygterm.cfg is a configuration file. It defines the command lines for the terminal emulator and shell, along with other parameters.

In normal mode, configuration files are read in the following order. Values read later override earlier values.

1. cygterm.cfg in the same folder as cygterm.exe
2. /etc/cygterm.conf
3. $APPDATA/teraterm5/cygterm.cfg
4. ~/.cygtermrc

$SHELL and $USER are set before the configuration files are read, and command-line options take precedence over all configuration files.
In portable mode, only cygterm.cfg in the same folder as cygterm.exe is read.
The character encoding of the configuration files is UTF-8. (Shift_JIS is used in Cygwin 1.5 environments.)

An example of cygterm.cfg

TERM = C:\program files\ttermpro\ttermpro.exe %s %d /KR=UTF8 /KT=UTF8
TERM_TYPE = vt100
PORT_START = 20000
PORT_RANGE = 40
SHELL = /bin/bash
ENV_1 = HOME=/home
  :         :

TERM

This is the command line to execute a terminal emulator. Specify the full path to the command if it isn't in Windows search path. This needs to be described `%s' and `%d' for the host and port number.

TERM_TYPE

This terminal type is adopted when the terminal emulator did not give a terminal type. (default: vt100) Then this value is set to the environment variable TERM on a shell.

PORT_START

This is the minimum TCP port number allowed for use. (default: 20000)

PORT_RANGE

This is the maximum number of TCP ports allowed for use. (default: 40)
cygterm.exe looks for an unused port number between PORT_START and PORT_START+PORT_RANGE, and therefore can be run concurrently as many as this number.

SHELL

This is the command line to execute a shell in Cygwin side (normally /bin/bash). (default: get from /etc/passwd) Specify the full path to the shell or keyword "AUTO".

ENV_X

This is the environment variable to be set when starting the shell. It should be of the form `name=value' (like putenv). It is possible to give as many environment variables as needed by beginning with "ENV_".

LOGIN_SHELL

If this parameter is set to yes, shell is invoked as a login shell. (default: no)

HOME_CHDIR

If this parameter is set to yes, current directory is changed to home directory before invoke a shell. (default: no)

SOCKET_TIMEOUT

Specifies how many seconds to wait for a telnet connection from the terminal emulator before the socket times out. (default: 5 seconds)

SSH_AGENT_PROXY

If this parameter is set to yes, SSH agent proxy support will be enabled. (default: no)