SET Parameter Reference
The following parameters are for use with the SET command. Settings are site-specific unless otherwise stated.
| SET Parameter | Values | Description |
|---|---|---|
| ABORT-ON-ERROR | YES | NO (Default: YES) |
Specifies whether execution of a script stops whenever an error occurs in response to a command. See ABORT_ON_ERROR Script Sample for an example. |
| ACCOUNT | <string> (there is no default value) |
Specifies the name of the account to log into on an FTP server. This setting does not apply to SFTP connections. |
| ANONYMOUS | YES | NO (Default: NO) |
When set to YES, the client performs an anonymous login, using the user name "anonymous." |
| ASCII-CLIENT-TYPE | <value> (Default: WINDOWS) |
When TRANSLATE-FILES and/or TRANSLATE-DIRECTORY-LISTING is YES, specifies the character set to use on the client PC during ASCII file transfers. Possible values are: PC-ENGLISH (IBM PC extended characters), PC-SLAVIC (DOS 852 code page), WINDOWS, WINDOWS-ANSI, WINDOWS-LATIN-2, WINDOWS-CYRILLIC, WINDOWS-GREEK, YUASCII. This setting does not apply to SFTP connections. |
| ASCII-SERVER-TYPE | <value> (Default: DEC Supplemental) |
When TRANSLATE-FILES and/or TRANSLATE-DIRECTORY-LISTING is YES, specifies the FTP server character set to use during ASCII file transfers. Possible values. This setting does not apply to SFTP connections. |
| AUTO-SERVER- UPDATE | YES | NO (Default: YES) |
This global parameter specifies whether the server directory listing shown in the right pane is updated when you perform any operation that adds or deletes files or directories on the server. |
| CLIENT-HOME- DIRECTORY | <string> |
Specifies the path to a home (default) directory for the local PC. If this setting is not set, the global Default local home directory setting is used. |
| CONFIRM-DELETE | YES | NO (Default: YES) |
This global parameter specifies whether the client should prompt for confirmation before deleting a file. |
| CREATE-SERVER- UPPER | YES | NO (Default: NO) |
Specifies whether all files transferred to the server are given uppercase file names. |
| CREATE-8.3-FILENAMES | YES | NO (Default: NO) |
Specifies whether files transferred to the client use the 8.3 file naming convention. |
| CTRL-Z-EOF | YES | NO (Default: NO) |
Applies to ASCII file transfers to a server. When this parameter is set to YES, file transfer uses Ctrl-Z as the end-of-file marker and strips it from the file being sent. When set to NO; the character count in the file directory entry is used to determine the file length. This setting does not apply to SFTP connections. |
| DELETE- TRAILING-SPACES | YES | NO (Default: NO) |
Specifies whether to delete trailing spaces during ASCII file transfers from the server. This setting does not apply to SFTP connections. |
| EMAIL-ADDRESS | <string> (there is no default value) |
This global parameter specifies your Internet email address. When opening a connection, most anonymous FTP sites ask you to supply your email address, which is used as the password for your guest login. Anonymous connections are not available for SFTP sessions. |
| FULL-TO-HALF-FROM- SERVER | YES | NO (Default: NO) |
Applies to ASCII file transfers from the server. If you want messages and files with DEC Kanji or JIS Kanji characters to be converted from full- to half-width Katakana when received from the server, set this value to YES. The ASCII-SERVER-TYPE parameter determines which Kanji character set is used during the conversion. |
| HALF-TO-FULL- TO-SERVER | YES | NO (Default: NO) |
Applies to ASCII file transfers to the server. If you want files with DEC Kanji or JIS Kanji characters to be converted from half- to full-width Katakana when sent to the server, set this value to YES. The ASCII-SERVER-TYPE parameter determines which Kanji character set is used during the conversion. |
| ISO7-TO-ROMAN8 | YES | NO (Default: NO |
Applies to ASCII file transfers from the server when TRANSLATE-FILES is YES. If you want files with ISO-7 characters to be converted to files with Roman 8 characters when received on the PC, set this value to YES. The NATIONAL-REPLACEMENT-SET parameter determines the character conversion. |
| KANJI-AUTO-DETECT | YES | NO (Default: NO) |
Specifies whether the client should automatically try to detect the type of Kanji character set (JIS, EUC, or DEC) used in any ASCII file and or message received from the server and then use the detected Kanji set for character translations. |
| MCS-TO-NRC | YES | NO (Default: NO) |
Determines character set translation during ASCII file transfers to the server when TRANSLATE-FILES is YES. When set to YES, characters are translated from the DEC Multinational character set to the current national replacement character set. The NATIONAL-REPLACEMENT-SET value determines the character conversion. |
| NATIONAL- REPLACEMENT- SET | <value> (Default: USASCII) |
Relevant when TRANSLATE-FILES and/or TRANSLATE-DIRECTORY-LISTING is YES. If necessary, set this parameter to match the set used by your host. Character translations occur between the client and the server when a PC file is sent to the server, and when characters sent from the server are written to local files, to the screen, or both. Possible values. This setting does not apply to SFTP connections. |
| NRC-TO-MCS | YES | NO (Default: NO) |
Determines character set translation during ASCII file transfers from the FTP server to the PC when TRANSLATE-FILES and/or TRANSLATE-DIRECTORY-LISTING is YES. When set to YES, characters are translated from the current national replacement character set to the DEC Multinational Character set. The NATIONAL-REPLACEMENT-SET value determines the character conversion. This setting does not apply to SFTP connections. |
| PASSIVE | YES | NO (Default: YES) |
Specifies whether the client will send a PASV command to communicate with the server in passive mode (sometimes called PASV mode). Setting PASSIVE to YES causes the FTP Client to initiate a separate data connection for directory listings and file transfers. Passive mode is required for connections through some firewalls. This setting does not apply to SFTP connections. |
| PASSTHROUGH- AUTHENTICATION | YES | NO (Default: NO) |
You must be connected to a site to change this global passthrough server property. Set PASSTHROUGH-AUTHENTICATION to YES if your passthrough server requires you to provide a user name and password to log into the passthrough server. This setting is ignored if USE-PASSTHROUGH-SERVER is set to NO or if PASSTHROUGH-SERVER-STYLE is set to SITE-SERVERNAME. |
| PASSTHROUGH- PASSWORD | <string> (there is no default value) |
You must be connected to a site to change this global passthrough server property. This setting specifies your password on the passthrough server on your local network. For case-sensitive servers, you must use the appropriate case when you enter this value. |
| PASSTHROUGH- SERVER-STYLE | <value> (Default: SITE-SERVERNAME) |
You must be connected to a site to change this global passthrough server property. The FTP Client sends different commands to log into the passthrough server and connect to an FTP server, based on the style of server you specify. |
| PASSTHROUGH- SERVERNAME | <string> (there is no default value) |
You must be connected to a site to change this global passthrough server property. This setting specifies the name of the passthrough server on the local network that you use to log on to an FTP server. |
| PASSTHROUGH- USERNAME | <string> (there is no default value) |
You must be connected to a site to change this global passthrough server property. Use this setting to specify a valid user name registered on the passthrough server for your local network. For case-sensitive servers, you must use the appropriate case when entering the PASSTHROUGH-USERNAME value. |
| PASSWORD | <string> (there is no default value) |
Specifies your password on the current FTP server. |
| PORT-NUMBER | 0 - 65535 (Default: 0) | Specifies a non-standard TCP service port number or socket for FTP. The default value 0 (zero) directs the FTP Client to use the standard service port for FTP, which is 21. This setting does not apply to SFTP connections. |
| PRESERVE-FILE- DATE | YES | NO (Default: NO) |
Specifies whether files that are downloaded from the server should retain the original date stamps associated with the files. If you want files transferred from the server to be date stamped with the time and date when they were transferred, set this parameter to NO. |
| PROXY-SERVER | <value> |
This is a read-only parameter that indicates whether the FTP Client connects to this site using a passthrough server or SOCKS proxy server. The possible values are PROXY SERVER and SOCKS PROXY. |
| QUIET-STATUS | YES | NO (Default: NO) |
This global parameter suppresses dialog box display, including Connection progress, Transfer progress, and Error notification. |
| RESUME-PARTIAL- TRANSFERS | ALWAYS | NEVER | ASKUSER (Default: ASKUSER) |
This session-specific parameter is relevant for downloading files from the server in BINARY format. When you GET a server file, the FTP Client detects whether a prior incomplete download operation occurred for that file. This parameter allows you to control whether the Client prompts for input when it detects that a prior partial download occurred. Auto resume compares the size of the source file to the size of the incomplete target file to determine at what point in the source file it should resume the transfer. Using the binary method ensures that the file created on the local machine matches the size of the source file. |
| ROMAN8-TO-ISO7 | YES | NO (Default: NO) |
Applies to ASCII file transfers to the server when TRANSLATE-FILES is YES. If you want files with Roman 8 characters to be converted to files with ISO-7 characters when transferred to the server, set this value to YES. This setting does not apply to SFTP connections. |
| SAVE-PASSWORD | YES | NO (Default: NO) |
Specifies whether the site password is saved. |
| SAVE-PASSTHROUGH- PASSWORD | YES | NO (Default: NO) |
You must be connected to a site to change this global passthrough server property. When set to NO, the passthrough password is not saved. |
| SERVER-HOME- DIRECTORY | <string> |
Specifies the path to a home (default) directory for the FTP or SFTP site to which you are currently connected. When a connection to the FTP or SFTP site is opened, the server working directory is set automatically to the specified home path. If no value is specified, the user home directory is used. |
| SERVERNAME | <string> (there is no default value) |
Specifies the name of the server that you want to log into. The server name is resolved via the Hosts file or a domain name server. If you have no domain name server on the local network and don't use a Hosts file, you must specify the full IP address. The value you specify is used the next time you open a connection during the current session. |
| SMART-ASCII- TYPES | This global parameter specifies all the file extensions used to identify files that should be transferred using the ASCII transfer method when TRANSFER-METHOD is set to SMART. To specify a list of file extensions, separate each extension with a comma. For example: SET SMART-ASCII-TYPES txt,bat,htm,html,ini |
|
| SMART-BINARY- TYPES | <string> (DEFAULT: exe,gif,jpg,wav) |
This global parameter specifies all the file extensions used to identify files that should be transferred using the Binary transfer method when TRANSFER-METHOD is set to SMART. To specify a list of file extensions, separate each extension with a comma. For example: SET SMART-BINARY-TYPES exe,gif,jpg,wav |
| SMART-TENEX- TYPES | <string> (there is no default value) |
This global parameter specifies all the file extensions used to identify files that should be transferred using the Tenex (Local 8) transfer method when TRANSFER-METHOD is set to SMART. To specify a list of file extensions, separate each extension with a comma. For example: SET SMART-TENEX-TYPES edd,gol,mmd,lad |
| SMART-TYPE- DEFAULT | ASCII | BINARY | TENEX | ASK USER (Default: ASK USER |
This global parameter specifies a default transfer method to use when TRANSFER-METHOD is set to SMART and the source file has an extension that has not been defined as either SMART-ASCII-TYPE, SMART-BINARY-TYPE, or SMART-TENEX-TYPE. During file transfers, if the source file uses an extension that has not been associated with a file transfer method, Smart File Transfer uses the transfer method specified for SMART-TYPE-DEFAULT. |
| SPACES-PER-TAB | 1-20 (Default: 8) | Applies to ASCII file transfers. Specifies the number of consecutive spaces that are converted to a single tab character (for SPACES-TO-TABS) or the number of spaces that a single tab character is converted into (for TABS-TO-SPACES). This setting does not apply to SFTP connections. |
| SPACES-TO- TABS | YES | NO (Default: NO) |
Applies to ASCII file transfers from the host. When receiving ASCII files, you can replace consecutive spaces with tabs by setting this parameter to YES. The number of spaces that are converted to a single tab is controlled by the SPACES-PER-TAB parameter. This setting does not apply to SFTP connections. |
| TABS-TO- SPACES | YES | NO (Default: YES) |
When set to YES, tab characters in local files are converted to space characters in server files during ASCII transfers to the server. The FTP Client replaces each tab character with the number of spaces necessary to fill out to the next tab stop, as specified by the SPACES-PER-TAB parameter. This setting does not apply to SFTP connections. |
| TIME-LOGGED-IN | (Read-only) | This is a read-only parameter that indicates the time when you logged into the server. The current time format specified in the International dialog box in the Windows Control Panel determines how time data displays. |
| TIME-SINCE- LOGIN | (Read-only) | This is a read-only parameter that indicates how long you have been logged into the server. The current time format specified in the International dialog box in the Windows Control Panel determines how time data displays. |
| TIMEOUT-CONNECT | 0 - 65535 (Default: 120) | Specifies how long (in seconds) the client should continue trying to establish a server connection before it gives up. Setting this parameter to 0 (zero) prevents the FTP Client from ever timing out on a connection attempt. This setting does not apply to SFTP connections. |
| TIMEOUT- SESSION | 0 - 65535 (Default: 120) | Specifies the maximum number of seconds to wait for data packets being transferred to or from the host. If nothing is received within the period specified, a timeout error displays and the transfer is aborted. Setting this parameter to 0 (zero) prevents the FTP Client from ever timing out when waiting for a response. This setting does not apply to SFTP connections. |
| TRANSFER-8.3- CASE | LOWER | UPPER | PRESERVE (Default: LOWER) |
Specifies how case is handled in the names of files sent to the host, when the source file name conforms to the DOS 8.3 file naming convention. This setting is ignored when CREATE-SERVER-UPPER is set to yes. |
| TRANSFER- DISPOSITION | <value> (Default: OVERWRITE) |
This global parameter specifies a file transfer mode that tells the client what to do if the client or server file being transferred already exists at the destination. The possible values are APPEND, PROMPT, CANCEL, OVERWRITE, SKIP, UPDATE, UNIQUE. UPDATE directs the client to overwrite the destination file only if the file being transferred is newer than the destination file. UNIQUE directs the client to create a new unique name. |
| TRANSFER- ELAPSED-TIME | (Read-only) | This is a read-only parameter that indicates how long the last completed file transfer took to complete. The current time format specified in the International dialog box in the Windows Control Panel determines how time data displays. |
| TRANSFER-METHOD | <value> (Default: SMART) |
This global parameter specifies the file transfer method for the client. The possible values are ASCII, BINARY, TENEX, SMART. |
| TRANSFER- SPEED | (Read-only) | This is a read-only parameter that indicates the speed of the last completed file transfer. This value represents the number of kilobytes transferred per second. |
| TRANSLATE- DIRECTORY- LISTING | YES | NO (Default: NO) |
Specifies whether to enable translation when characters sent from the server are written to the screen. Use this setting to translate file names in server directory listings that display in the FTP Client user interface. Setting this parameter to YES enables the following SET parameters: SET ASCII-CLIENT-TYPE, SET ASCII-SERVER-TYPE, SET NATIONAL-REPLACEMENT, ISO7-TO-ROMAN8, and SET NRC-TO-MCS. This setting does not apply to SFTP connections. |
| TRANSLATE- FILES | YES | NO (Default: NO) |
Specifies whether to enable translation of ASCII files. When set to YES, character translations occur between the client and the server when a PC file is sent to the server, and when characters sent from the server are written to a client file. Setting this parameter to YES enables the following SET parameters: SET ASCII-CLIENT-TYPE, SET ASCII-SERVER-TYPE, SET NATIONAL-REPLACEMENT, SET ISO7-TO-ROMAN8, SET ROMAN8-TO-ISO7, SET NRC-TO-MCS, and SET MCS-TO-NRC. This setting does not apply to SFTP connections. |
| USE-PASSTHROUGH- SERVER | YES | NO (Default: NO) |
Specifies whether to connect through a passthrough server when opening connections to the current FTP site. When set to YES, the FTP Client uses the following global settings to make the connection to the passthrough server: PASSTHROUGH-SERVER-STYLE, PASSTHROUGH-SERVERNAME, PASSTHROUGH-USERNAME, PASSTHROUGH-PASSWORD, and PASSTHROUGH-AUTHENTICATION. |
| USE-SOCKS | YES | NO (Default: NO) |
Specifies whether you want to use a SOCKS proxy server for connections made to the current site. When set to YES, the FTP Client uses a SOCKS proxy server. |
| USERNAME | <string> (there is no default value) |
Specifies a valid user name registered on the current server. For case-sensitive servers, you must use the appropriate case when entering the USERNAME value. |
| WRITE-CTRLZ | YES | NO (Default: NO) |
Applies to ASCII file transfers from the server. When set to YES, the FTP Client automatically adds an end-of-file marker (^Z) at the end of a received ASCII file. |