List command options definition file
Format
[option-string-1]
[option-string-2]
...
[option-string-n] |
Function
Specifies the option strings, which form the arguments of the list commands (LIST and NLST commands) executed by the FTP client, on each line. You can specify multiple option strings, however, only one option string is applied to each command.
The following are the differences in the execution format of the list commands when the list command options definition file is not defined and when the file is defined.
indicates a single one-byte space.
- When the list command options definition file is not defined
The execution format of the list commands is as follows:
LIST[ path]
NLST[ path] |
In such cases, all the information specified in the list command arguments is interpreted as the path information.
- When the list command options definition file is defined
By defining option-string in the list command options definition file, you can execute the list commands by specifying option-string as follows:
The FTP reception separates the information specified in the list command arguments into option-string and path, as defined in the list command options definition file, and executes the information.
File storage location
The path where the list command options definition file is stored and the file name are optional.
However, the storage location of the list command options definition file must be specified with the absolute path in the urecp-ftp.list-command-option.filepath property of the FTP reception configuration file. If you do not specify the storage location, the definition of the list command options definition file becomes invalid.
Specifiable properties
option-string ~ <Character string>
Specifies the option strings that can be specified in the list command arguments.
You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive. You cannot specify one-byte spaces and tab characters at the beginning and at the end.
The available one-byte symbols are as follows:
- Exclamation mark (!)
- Double quotation mark (")
- Hash mark (#)
- Dollar sign ($)
- Percent sign (%)
- Ampersand (&)
- Apostrophe mark (')
- Left parenthesis (()
- Right parenthesis ())
- Asterisk (*)
- Plus sign (+)
- Comma (,)
- Hyphen (-)
- Period (.)
- Forward slash (/)
- Colon (:)
- Semicolon (;)
- Left angle bracket (<)
- Right angle bracket (>)
- Equal sign (=)
- Question mark (?)
- At mark (@)
- Left square bracket ([)
- Right square bracket (])
- Yen sign (\)
- Caret (^)
- Underscore (_)
- Grave accent mark (`)
- Left curly bracket ({)
- Right curly bracket (})
- Vertical bar (|)
- Swung dash (~)
Example of coding
To be able to specify both the options, -al and -la, specify the option strings in both the formats, as follows:
To be able to specify both the options, -l and -L, specify the option strings in both the formats, as follows:
Notes
- If you change the information specified in the list command options definition file and you want to enable the specified values, restart the FTP reception that is using that list command options definition file.
- You cannot specify one-byte spaces at the beginning and at the end of the option string.
- If the beginning of the specified option string is \, \ is interpreted as an escape character, and the rest of the string is considered as the option string.
Note that \ specified within an option string is treated as a normal character string \ and not as an escape character.
To define an option string beginning with # or \, add an escape character \ before the option string.
- You cannot specify one-byte spaces or tab characters immediately after the escape character \, or define a line containing escape characters \ only. If you specify such characters, an error occurs.
- The string up to the linefeed is a value. However, the one-byte spaces and tab characters at the beginning and at the end of the string are ignored.
- If the non-null character (characters that are neither one-byte spaces nor tab characters) at the beginning of the specified string is #, that line is considered as a comment.