Command Line Options
The command line options allow you to use TurboFTP in an automated process controlled by a batch file, script, macro, etc.
Usage:
(a) turboftp [options] <source> <destination>
(b) turboftp [options] <session file>
Elements in square brackets [] are optional. Elements in angle
brackets <> are mandatory.
A. Usage (a)
source and destination contain the local pathname and remote path
name, respectively. A remote pathname is in the form of:
ftp://[user:password@][:port]/[pathname/][filename]
If user or password is not specified, TurboFTP will look for account info for host in the Site Address Book. It is recommended to store the account information in the Address Book and omit it in the pathname. If you are making a connection to a secure FTP server (e.g., with SSL support) or an SSH/SFTP server, this is the only way to work.
You can use wildcard mask in [filename]. Wildcard masks used here are treated as case insensitive. Subfolders under [pathname] will NOT be transferred even if they match the [filename] pattern.
source or destination containing space, either in password, pathname
or filename, must be enclosed in double quotes("").
B. Usage (b)
is the pathname of a session file. You can save the queue into a session file (.tbx file) by using menu [Session | Save as]. TurboFTP loads the session file, restores a list of queued files and starts transferring them.
C. Available options:
If there is a matching option in TurboFTP's Options
dialog, the one specified in the command line takes precedence. For
example, the speed limit options -sd and -su. Command line options,
however, do not change the global configurations stored in the registry,
which will remain the same the next time you start TurboFTP without
command line options.
-sd Throttle download bandwidth to KBytes.
-su Throttle upload bandwidth to KBytes.
-min Minimized to system tray at startup.
-log[:LogFilePath] Enable logging. Optional log file path (must
include the log file name) can follow after a colon. If no log file path
is specified (i.e. only -log), the program will use the log file path
specified in [Options | General]. Use double quotes if there is space
in the file path and the whole option, including '-log:' must be placed
in the double quotes. For example:
-log:"c:\my log files\turboftp.log".
-s Synchronize source and destination. When used, the profile of
the remote server in the command line must have been stored in Address
Book, and the synchronization options defined in this site profile will
be used, including synchronization direction (thus it doesn't care
which one is source or destination in the command line). Options -w,
-d, -u will also be ignored.
-w Overwrite without asking for confirmation. Overwrite files without
showing a File Exist dialog for the user to choose among actions like
overwrite, skip, resume, etc.
-d Only download newer files. The local file will be overwritten only
if it is older than the remote source file.
-u Only upload newer files. The remote file will be overwritten only
if it is older than the local source file.
-e[1-6] Specify action to perform upon transfer complete. Available
actions (1-6) are listed in [Options | Events | On Transfer
Complete].
e1: Disconnect from site
e2: Hang up (also disconnect)
e3: Close TurboFTP
e4: Hang up and close TurboFTP
e5: Log off Windows
e6: Shutdown computer
-ma and -mb Set transfer mode to ASCII (-ma) and binary (-mb).
-rm Specify receiver email address to send notification email to
after the command line execution completes.
Note: only one action can be specified.
D. Limitation
In Usage (a), you can only transfer multiple files using a wildcard mask but cannot specify a sequence of files to move. To do so, you need to create a session file and utilize the usage (b) approach.
Usage (a) doesn't support recursive transfer, i.e., subfolders under [pathname] will be ignored even if they match the [filename] pattern. To include subfolders in transfer, you can use usage (b). When TurboFTP sees a queued entry that represents a folder, it will transfer items under that folder recursively.
You usually don't use the global filters (i.e., clear all filters in the File Filtering dialog) when you do automated transfers.
E. Examples
(Note that in the command line, either you execute turboftp.exe within its install folder or you must specify a valid path to turboftp.exe)
Download newer files with extension zip to c:\download. The program is minimized to the system tray while running, and the maximum transfer speed is set to 4KB/s. (Profile of host.com is already stored in Address Book).
turboftp -sd 4 -min -d ftp://host.com/archive/*.zip c:\download
Upload txt file in c:\My Documents to a path named "April 2022" on server host.com. Using john as the username and 5jd944K as the password. Note that both the local and remote pathnames contain a space; therefore, double quotes are used.
turboftp -min "c:\My Documents\*.txt" "ftp://john:5jd944K@host.com/April 2022"
Load and launch session file test.tbx at startup and overwrite files with no user confirmation (-w). Enable logging. Upon transfer complete, hang up the modem automatically (-e2).
turboftp -w -log -e2 "c:\My Documents\test.tbx"
Synchronize ftp://host.com/archive and c:\download, the synchronization direction and scheme depend on the options in [Advanced Settings | Synchronization] of host.com (should already be stored in Address Book). Write log to mylog.log, which is stored in the current working directory.
turboftp -s -log:mylog.log -min ftp://host.com/archive c:\download