All the fields you can change or edit are highlighted.
Below is the description of the dialog fields you can change:
ΓûÆΓûÆΓûÆΓûÆΓûÆΓûÆ Edit fields ΓûÆΓûÆΓûÆΓûÆΓûÆΓûÆ
#URL#
Address ~understood~@FTPURL@ by the FTP plugin.
The URL #may# contain: user name, user password, connection port and start directory.
The URL #must# contain: the address of the server to connect.
URL parts have #lower# priority than dialog fields.
#User#
The name of the user sent to the server during authorization.
When you first create a host record, you may fill only the #URL# field. If you leave the #User# field blank, the
plugin automatically fills it with the information from the URL when you confirm host changes.
The #User# field has a higher priority than the URL part specifying the user name, so changes in the URL user name
part #will not# take effect until the #User# dialog field is blank!
In other words, the plugin always uses data from the #User# field if it is not empty.
#Password#
User password sent to the server during authorization.
This field uses the same rules as the #User# field.
#Description#
Description of the host record. This field is only for your convenience, and you can enter arbitrary text here.
#Custom LIST command#
Command sent by the plugin to the server to retrieve the list of files in a directory if the #Custom LIST command#
checkbox is checked.
#I/O buffer size#
The size of the buffer used by the plugin for sending and receiving data when working with this server.
This value can be configured separately for each server and depends on connection speed, software and available
bandwidth of both the client and the server machine.
The optimum value for this parameter can be achieved by experimenting. Usually bigger values increase transfer speed
on fast (DSL, LAN) connections.
You can use #M# and #K# characters to specify the multiplier for the value. "M" is interpreted as 1,000,000, and "K"
as 1,000.
If a multiplier is used, you can also specify fractional digits in the value.
For example, #1.4K# will be interpreted as #1.4*1000#, and the I/O buffer size will be set to #1400# bytes.
Additional information on configuring the buffer size is given in the file #Notes.txt# in the plugin directory.
ΓûÆΓûÆΓûÆΓûÆΓûÆΓûÆ Options ΓûÆΓûÆΓûÆΓûÆΓûÆΓûÆ
#Ask password every time#
When this option is turned #ON#, the plugin shows a dialog prompting for the user name and password at every
connection. By default, the dialog is filled with the values of the #User# and #Password# fields from the host record.
#FTP command log window#
When this option is turned #ON#, the plugin shows a window displaying all the commands it executes. If this option is
off, only summary information on the connection progress is displayed.
This option is useful on very slow connections or with non-standard or partially implemented servers to monitor
"what's going on" on the fly.
This option can be also switched through the ~FTP Utils~@FTPUtils@ menu.
#ASCII mode#
Allows to choose between ASCII or BINARY mode for transferring files.
When this option is turned #ON#, the plugin uses ASCII transfer mode.
Keep in mind that binary files may be corrupted if they are transferred in ASCII mode.
This option can be also switched through the ~FTP Utils~@FTPUtils@ menu.
#Passive mode#
Switches "passive" FTP client mode.
The client mode determines how FTP data connections are established. In normal mode plugin asks the server to establish TCP connection with local
machine, and in passive mode the plugin establishes the data connection by itself. Normal mode can fail to work on some networks using NAT, firewall or
any other technology witch limits the ability to accept incoming TCP connections. Some FTP servers have limitations on passive mode access.
This option can be also switched through the ~FTP Utils~@FTPUtils@ menu.
#Custom LIST command#
Enables the use of a custom LIST command for retrieving the list of files in a folder.
Some servers produce a wrong (non-standard) or incomplete directory listing when answering on the standard LIST ftp
command. However, some other servers break the connection if you use the extended command. Thus, there is no way to
automatically determine which command should be used to receive the full directory listing, so you have a possibility
to specify the correct command for your server manually if the default command does not work.
This option can be switched on the fly using #FTPUtils# menu.
Additional information on using this command is given in the file #Notes.txt# in the plugin directory.
#Use firewall#
Switches the use of the firewall specified in the global ~plugin configuration~@Config@.
A firewall is only used to establish the connection, so this option can not be switched on the fly after the
connection is established.
#Decode commands text#
Switches the decoding of file names in the listing received from a server.
If this option is ON, the plugin will decode file names using the selected character tables, otherwise it
will process names as they were received from a server.
ΓûÆΓûÆΓûÆΓûÆΓûÆΓûÆ Buttons ΓûÆΓûÆΓûÆΓûÆΓûÆΓûÆ
#Select table#
Displays a menu from which you can select the default character table used to translate directory listings received
from the server to the OEM code page.
The list of displayed character tables is the list of tables already installed in FAR. Additional character tables can
be found in the "Addons\\Tables" subdirectory of the FAR installation folder.
Synopsis: Any text which is not a command and does not start with the plugin prefix will be sent to the currently connected server.
@WarnOldFmt
$ #Old host format warning#
The plugin has detected that you are trying to save a record in an obsolete format.
The old (obsolete) format saves the full URL of the server as a name of the parameters' group.
This leads to the following two limitations:
1. impossible to store more than one record with the same server URL;
2. operating system imposes certain limitations on symbols allowable in the name of a key;
On the other hand, old plugin versions can't handle new records format correctly.
Choose #Overwrite# to remove an old record and overwrite it using the new format,
or #Cancel# to cancel the save operation.
#Note:# Plugin can save data only in the format which is native to the current plugin version.
@FTPExtGlobal
$ #Extended global options#
#Dup FF in commands#
Default: OFF
If value is set duplicate all FF characters sent to server.
#UnDup FF from PWD#
Default: OFF
If value is set plugin will replace FF characters pair by single one.
#Show view/edit progress#
Default: OFF
If value is set display full progress dialog even on silent operations (before and after view or edit file).
#Use connection backup#
Default: ON
If this variable is set to nonzero value plugin allow you to use ftp lists (accessible through Utilities menu).
If value is OFF plugin will not use connections list.
#Send command line commands#
Default: TRUE
This value is default for "Process command line" setting for new hosts entries.
#Do not show window on error#
Default: FALSE
If this value set to TRUE (nonzero) plugin will not show error in expanded CMD window
#Ask login at login fail#
Default: TRUE
If TRUE plugin will ask user for name and password after login fail.
#Auto anonymous#
Default: TRUE
Automatically fill user name with "anonymous" if name field left blank.
#Close connection on \"..\"#
Default: TRUE
If set plugin closes server connection and back to hosts mode if you go up at the topmost directory level (f.i. by selecting ".." panel entry).
@FTPCommands
$ #Hi-level ftp commands available in plugin#
Hi-level FTP commands can be entered in connected state using #CMD# command line command (See command ~line commands~@FTPCommandLineHelp@).
Each command in the list contains command name (case insensitive) and optional parameter (or several parameters) delimited with one or more spaces.
~Syntax description
Parameters can be mandatory (enclosed with symbols '<' and '>') and optional (enclosed with symbols '[' and ']').
The text "..." is used then command can accept any number of parameters.
~Rules used to interpret command string
- You can use quotation (enclose with '"' characters) to combine several parameters in the single one or include spaces into parameters.
- The tab character (symbol with code 0x7 or \\t) is interpreted as space character and need to be quoted as regular space.
- To specify any character as regular you can use mask it with '\'.
For instance, text "text\ string" will be interpreted as "text string".
~Commands list
#ascii#
#image#
#binary#
Switch transfers in different modes.
#disconnect#
#close#
Terminates current connection and switch to hosts mode.
#quit#
#bye#
Finish current plugin work and close plugin panel.
#cd <path>#
Change directory.
#cdup#
Change directory to upper level. Analog of "cd .." command.
#ls [<path>]#
#dir [<path>]#
#nlist [<path>]#
Get files listing.
#size <file>#
Get size of file.
#send <local> [<remote>]#
#put <local> [<remote>]#
Upload <local> file to the server. If remote name omitted the name of local and current directory will be used.
#append <local> [<remote>]#
Resume uploading local file to remote file starting from remote file size.
#recv <remote> [<local>]#
#get <remote> [<local>]#
Download file from ftp. If local file name ommited the name of remote file will be used.
#reget <remote> [<local>]#
Resume downloading <remote> to <local> file starting from <local> file size.
#newer <remote> [<local>]#
Download only new files.
Unrealized!
#mkdir <dir>#
Create directory.
#modtime <file>#
Get last modification time of <file>.
#open <site> [<port> [<user> [<pwd>]]]#
Close current connection and connect to different server using specified connection parameters, but all other settings used from current connection.
#proxy <command> [<cmd params>]#
Execute command in proxy mode. Temporarily switch to use proxy, execute specified command and switch proxy usage OFF back. Meanfull only if proxy not used.
#sendport#
Switch. Toggles sending PORT command before any data connection.
#pwd#
Display current ftp directory
#rhelp [<command>]#
Request help on server commands
#rename <old name> <new name>#
Rename <old file> to <new name>. Can be used with directories.