Appendix B. FTP Command Reference

 

The MultiNet FTP utility uses the Internet-standard FTP (File Transfer Protocol) to transfer files between the local host and a remote host. This appendix lists the commands you can use during an FTP session.

 

Command Summary

The below table lists the MultiNet FTP commands:

Command

Description

ACCOUNT

Sends an account name to the remote FTP server.

AGET

Appends a remote file to a file on the local host.

APPEND GET

Appends remote_file from the remote host to local_file on the local host.

APPEND PUT

Appends local_file on the local host to remote_file on the remote host.

APPEND RECEIVE

Appends remote_file from the remote host to local_file on the local host.

APPEND SEND

Appends local_file on the local host to remote_file on the remote host.

APUT

Appends local_file on the local host to remote_file on the remote host.

ASCII

Sets the transfer type to ASCII for transferring text files.

ATTACH

Detaches the terminal from the calling process and reattaches it to another process.

AUTHENTICATE

Requests the FTP server to enter into TLS authentication mode as defined in RFC 4217. This can be done after connecting to the remote server and before sending the USER command.

BELL

Turns on, off, or toggles the sounding of a bell when a file transfer completes.

BINARY

Sets the transfer type for transferring binary files.

BLOCK

Reads files of TYPE I, STRUCTURE FILE using block I/O.

BYE

Closes the current FTP connection, but remains in the FTP command interpreter.

BYTE

Sets the transfer byte size to size.

CCC

Changes an encrypted command connection back to clear text. This command is provided so that an encrypted command connection can be put in clear text mode allowing firewalls and NAT devices to recognize and process PORT/PASV commands and their responses.  The file transfer protection level should be established before setting the command channel to clear text mode.

CD

Changes the current working directory on the remote host to dir.

CDUP

Changes the current working directory on the remote host by moving up one level in the directory system.

CLOSE

Closes the current FTP connection, but remains in the FTP command interpreter.

CONFIRM

Turns on, off, or toggles (the default) interactive confirmation of each command in a MULTIPLE command.

CONNECT

Establishes a connection to the FTP server on host.

CPATH

Changes the current working directory on the remote host to dir.

CREATE-DIRECTORY

Creates the directory dir on the remote host.

CWD

Changes the current working directory on the remote host to dir.

DELETE

Deletes a file on the remote host.

DIRECTORY

Obtains an annotated listing of the files on the remote host.

DISCONNECT

Closes the current FTP connection without waiting for a confirming response from the remote host,   but remains in the FTP command interpreter.

EXIT

Closes the current FTP connection and exits FTP.

EXIT-ON-ERROR

Turns on, off, or toggles (the default) whether or not FTP automatically exits when an error occurs.

GET

Copies remote_file from the remote host to local_file on the local host.

HASH

Turns on, off, or toggles (the default) the display of hash marks (#) for each data buffer transferred.

HELP

Displays FTP help information.

LCD

Changes the current working directory on the local host to dir.

LDIR

Displays the contents of your local working directory. LDIR is the same as LOCAL-DIRECTORY.

LIST

Displays automatic login information for host.

LOCAL-CD

Changes the current working directory on the local host to dir.

LOCAL-DIRECTORY

Displays the contents of your local working directory.

LOCAL-PWD

Displays the current working directory on the local host.

LOGIN

Identifies you to a remote FTP server.

LPWD

Displays the current working directory on the local host.

LS

Displays a names-only listing of files on the remote host.

MDELETE

Deletes multiple files on the remote host.

MGET

Copies multiple files from the remote host to the local host.

MKDIR

Creates the directory dir on the remote host.

MPUT

Copies multiple files from the local host to the remote host.

MULTIPLE DELETE

Deletes multiple files on the remote host.

MULTIPLE GET

Copies multiple files from the remote host to the local host.

MULTIPLE PUT

Copies multiple files from the local host to the remote host.  MULTIPLE PUT is a synonym for MULTIPLE SEND. See MULTIPLE SEND for more information.

MULTIPLE RECEIVE

Copies multiple files from the remote host to the local host.

MULTIPLE SEND

Copies multiple files from the local host to the remote host.

OPEN

Establishes a connection to a host system.

PASSIVE

Enables or disables "passive" mode for file transfers with FTP servers on the opposite side of "firewall" gateways.

PASSWORD

Sends a password to the remote FTP server explicitly, which normally happens automatically during login.

PORT

Specifies a TCP port number to use for the FTP control connection.

PROMPT-FOR-MISSING-ARGUMENTS

Turns on, off, or toggles (the default) whether or not FTP prompts for missing command arguments automatically.

PROMPT-ON-CONNECT

Turns on, off, or toggles (the default) whether or not FTP prompts for a user name and password after making a connection automatically.

PROTECTION

Sets the protection level for data transfers as specified in RFC 4217. Use CLEAR to transfer files over a clear text connection.  This is the default after specifying the username and password to an authenticated connection. Use PRIVATE to transfer files over an encrypted connection with data integrity checking.

PUSH

Starts and attaches a DCL subprocess.

PUT

Copies local_file on the local host to remote_file on the remote host.

PWD

Displays the current working directory on the remote host.

QUIT

Closes the current FTP connection and exits FTP.

QUOTE

Sends a string to the FTP server verbatim.

RECEIVE

Copies remote-file from the remote host to local-file on the local host.

RECORD-SIZE

Sets or displays the record size for IMAGE mode transfers.

REMOTE-HELP

Displays information about commands available on the FTP server.

REMOVE-DIRECTORY

Deletes a directory on the remote host. REMOVE-DIRECTORY is the same as RMDIR.

RENAME

Renames files on the remote host.

RETAIN

Turns on, off, or toggles (the default) the retention of OpenVMS version numbers in file transfers.

RM

Deletes a file on the remote host.

RMDIR

Deletes a directory on the remote host.

SEND

Copies local_file on the local host to remote_file on the remote host.

SET

Sets automatic login information for host.

SHOW-DIRECTORY

Displays the current working directory on the remote host. SHOW DIRECTORY is the same as PWD.

SITE

Specifies commands that are interpreted by the MultiNet FTP server for use on the server host.

SPAWN

Executes a single DCL command, or if entered without options, starts a subprocess with the same effect as PUSH.

STATISTICS

Turns on, off, or toggles (the default) STATISTICS mode.

STATUS

Displays the status of the FTP server.

STREAM

Turns on, off, or toggles (the default) the creation of binary output files as Stream_LF files.

STRUCTURE

Sets the transfer structure to structure.

TAKE

Interprets FTP commands in a file.

TENEX

Changes the byte size for transferring binary files to or from a TOPS-20 system.

TYPE

Sets the transfer type to type.

USER

Identifies you to the remote FTP server.

VERBOSE

Turns on, off, or toggles (the default) VERBOSE mode.

VERSION

Prints information about the FTP program version.

 

ACCOUNT

Sends an account name to the remote FTP server. Use this command when connecting to hosts that require account specifications in addition to a user name.

 

FORMAT

ACCOUNT account

 

PARAMETERS

account

Specifies the name of the account to be sent to the remote FTP server.

 

RESTRICTIONS

Use this command only when connected to a remote host.

 

EXAMPLE

EXAMPLE.COM> account sales
<Account “sales" accepted
EXAMPLE.COM>

AGET

Appends a remote file to a file on the local host. AGET is a synonym for APPEND GET.

 

FORMAT

AGET remote_file [local_file]

APPEND GET

Appends remote_file from the remote host to local_file on the local host. APPEND uses the current settings for type, mode, and structure during file transfers. APPEND GET is the same as AGET and APPEND RECEIVE.

 

FORMAT

APPEND GET remote-file [local-file]

 

PARAMETERS

remote_file

Specifies the name of the file on the remote host from which to copy.

local_file

Specifies the name of a file on the local host to which the file is to be appended.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the GET command.

·         You cannot use the APPEND GET command in STRUCTURE VMS mode. If you try to do this, FTP toggles temporarily into STRUCTURE FILE mode for the transfer.

 

EXAMPLE

This example shows how to append a remote file to a file on the local host.

EXAMPLE.COM> append get login.com
To local file: RETURN
<ASCII retrieve of USERS:[HOLMES]LOGIN.COM;1 started.
<Transfer completed.  2498 (8) bytes transferred.
EXAMPLE.COM>

APPEND PUT

Appends local_file on the local host to remote_file on the remote host. APPEND PUT is a synonym for APPEND SEND.

 

FORMAT

APPEND PUT local_file remote_file

APPEND RECEIVE

Appends remote_file from the remote host to local_file on the local host. APPEND RECEIVE is a synonym for APPEND GET.

 

FORMAT

APPEND RECEIVE remote_file [local_file]

APPEND SEND

Appends local_file on the local host to remote_file on the remote host. APPEND SEND uses the current settings for type, mode, and structure during file transfers. APPEND SEND is the same as APUT and APPEND PUT.

 

FORMAT

APPEND SEND local_file remote_file

 

PARAMETERS

local_file

Specifies the name of the file on the local host to be copied.

remote_file

Specifies the destination file name on the remote host.

 

Restrictions

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the APPEND SEND command.

·         The MultiNet FTP Server cannot APPEND to a file in STRUCTURE VMS mode.

 

EXAMPLE

This example shows how to append the LOGIN.COM file to the remote file FOO.COM.

EXAMPLE.COM>append send login.com foo.com
<ASCII Store of ST_ROOT:[TMP]FOO.COM;12 started.
<Transfer completed. 2498 (8) bytes transferred.
EXAMPLE.COM>

APUT

Appends local_file on the local host to remote_file on the remote host. APUT is a synonym for APPEND PUT and APPEND SEND.

 

FORMAT

APUT local_file remote_file

ASCII

Sets the transfer type to ASCII for transferring text files. ASCII is a synonym for TYPE.

 

FORMAT

ASCII

ATTACH

Detaches the terminal from the calling process and reattaches it to another process. Use the SPAWN SHOW PROCESS /SUBPROCESSES command to list the names of subprocesses. Use the DCL LOGOUT command to return to the original process. If the MULTINET_DISABLE_SPAWN logical is enabled, ATTACH does not work.

 

FORMAT

ATTACH process-name

 

PARAMETERS

process_name

Specifies the name of a process to which you want your terminal attached. (Not all subprocesses can be attached; some testing may be required.)

BELL

Turns on, off, or toggles the sounding of a bell when a file transfer completes.

 

FORMAT

BELL mode

 

PARAMETERS

mode

Specifies a value of ON, OFF, or TOGGLE.

 

EXAMPLE

This example shows how to toggle the bell feature.

FTP>bell
[Bell will now ring when operations complete]
FTP>

BINARY

Sets the transfer type for transferring binary files. BINARY is a synonym for TYPE.

 

FORMAT

BINARY

BLOCK

Reads files of TYPE I, STRUCTURE FILE using block I/O.

 

FORMAT

BLOCK

 

Restrictions

Use this command only when connected to a remote host.

BYE

Closes the current FTP connection, but remains in the FTP command interpreter.

 

FORMAT

BYE

 

Restrictions

Use this command only when connected to a remote host.

 

EXAMPLE

This example shows how to disconnect an FTP connection.

EXAMPLE.COM>bye
<QUIT command received. Goodbye.
FTP

BYTE

Sets the transfer byte size to size.

 

FORMAT

BYTE size

 

PARAMETERS

size

Specifies the size to which to set the transfer byte size. The only permitted value is 8 bits.

 

EXAMPLE

This example shows how to set the transfer byte size to 8 bits.

EXAMPLE.COM>byte
Type: Logical-Byte (Byte Size 8), Structure: VMS, Mode: Stream
EXAMPLE.COM>

CD

Changes the current working directory on the remote host to dir. CD is the same as CPATH and CWD.

 

FORMAT

CD dir

 

PARAMETERS

dir

Specifies the name of the directory to use as the current working directory.

 

Restrictions

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the CD command.

 

EXAMPLE

This example shows how to change the default directory on the remote host to USERS:[ANONYMOUS].

EXAMPLE.COM>cd [anonymous]
<Connected to USERS:[ANONYMOUS].
EXAMPLE.COM>

CDUP

Changes the current working directory on the remote host by moving up one level in the directory system.

 

 FORMAT

CDUP

 

Restrictions

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the CDUP command.

 

EXAMPLE

This example shows how to move up one directory on the remote host.

EXAMPLE.COM>cdup
<Connected to USERS:[000000].
EXAMPLE.COM>

CLOSE

Closes the current FTP connection, but remains in the FTP command interpreter. CLOSE is a synonym for BYE.

 

FORMAT

CLOSE

CONFIRM

Turns on, off, or toggles (the default) interactive confirmation of each command in a MULTIPLE command.

 

FORMAT

CONFIRM mode

 

PARAMETERS

mode

Specifies a value of ON, OFF, or TOGGLE.

 

EXAMPLE

This example shows how to enable CONFIRM mode and use it with MGET to prompt for each file name.

EXAMPLE.COM>confirm
[You will be asked to confirm each transaction in a multiple transaction]
EXAMPLE.COM>mget *.com
<List started.
<Transfer completed.
GET copy.com? [YES] n
GET login.com? [YES] y
<VMS retrieve of USERS:[HOLMES]LOGIN.COM;1 started.
<Transfer completed. 2498 (8) bytes transferred.
EXAMPLE.COM>

CONNECT

Establishes a connection to the FTP server on host. CONNECT is the same as OPEN.

 

FORMAT

CONNECT host

 

PARAMETERS

host

Specifies the name of the host to which to establish a connection. host is specified as either a symbolic host name or as a dotted Internet address.

 

RESTRICTIONS

Do not use this command when connected to a remote host.

 

EXAMPLE

This example shows how to connect to the EXAMPLE.COM host.

FTP>connect example.com
Connection opened (Assuming 8-bit connections)
<EXAMPLE.COM MultiNet FTP Server Process
<5.5 (nnn) at Fri 9-Apr-2016 7:42am-PST
EXAMPLE.COM>

CPATH

Changes the current working directory on the remote host to dir. CPATH is a synonym for CD.

 

FORMAT

CPATH dir

CREATE-DIRECTORY

Creates the directory dir on the remote host. CREATE DIRECTORY is the same as MKDIR.

 

FORMAT

CREATE-DIRECTORY dir

 

PARAMETERS

dir

Specifies the name of the directory to create.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the CREATE-DIRECTORY command.

 

EXAMPLE

This example shows how to create the subdirectory "test".

EXAMPLE.COM>create-dir test
<“USERS:[HOLMES.TEST]” Directory created
EXAMPLE.COM>

CWD

Changes the current working directory on the remote host to dir. CWD is a synonym for CD.

 

FORMAT

CWD dir

DELETE

Deletes a file on the remote host. DELETE is the same as RM.

 

FORMAT

DELETE file

 

PARAMETERS

file

Specifies the name of the file to delete.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the DELETE command.

 

EXAMPLE

This example shows how to delete the file FOO.BAR from the remote host.

EXAMPLE.COM>del foo.bar
<File deleted ok, file USERS:[HOLMES]FOO.BAR;1.
EXAMPLE.COM>

DIRECTORY

Obtains an annotated listing of the files on the remote host.

 

FORMAT

DIRECTORY [file_spec] [output_file]

 

PARAMETERS

file_spec

Specifies the file specification to use in the directory lookup on the remote host. If you do not specify file_spec, the current working directory on the remote host is used. Any wildcards you specify are interpreted in the context of the remote host operating system.

output_file

Specifies the name of the file to which to write the directory listing. If you do not specify output_file, the list is directed to SYS$OUTPUT:.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the DIRECTORY command.

 

EXAMPLE

This example shows how to retrieve list of files that match the wildcard *.COM.

EXAMPLE.COM>dir *.com
<List started.
USERS: [HOLMES]
COPY.COM;4    2     1-APR-2015 08:49 [HOLMES] (RWD,RWD,R,R)
LOGIN.COM;1   5     1-APR-2015 01:25 [HOLMES] (RWD,RWD,R,R)
Total of 7 blocks in 2 files.
<Transfer completed.
EXAMPLE.COM>

DISCONNECT

Closes the current FTP connection without waiting for a confirming response from the remote host, but remains in the FTP command interpreter.

 

FORMAT

DISCONNECT

 

RESTRICTIONS

Use this command only when connected to a remote host.

 

EXAMPLE

EXAMPLE.COM>disc
FTP>

EXIT

Closes the current FTP connection and exits FTP. QUIT is the same as EXIT.

 

FORMAT

EXIT

 

EXAMPLE

EXAMPLE.COM>exit
<QUIT command received. Goodbye.
$

EXIT-ON-ERROR

Turns on, off, or toggles (the default) whether or not FTP exits automatically when an error occurs.

If EXIT-ON-ERROR is enabled, FTP exits automatically if an error occurs. After exiting, the DCL symbol $STATUS contains the status code of the last error to occur. If the last error was reported by the FTP server, it contains the value %X1000002C + (%X10000 * ftp_error_code).

 

FORMAT

EXIT-ON-ERROR mode

 

PARAMETERS

mode

Specifies a value of ON, OFF, or TOGGLE.

 

EXAMPLE

This example shows how to use EXIT-ON-ERROR to exit automatically when an error occurs. Here the error was not an FTP error.

FTP>exit-on-error
[Will exit when an error occurs]
FTP>connect 1.2.3.4
1.2.3.4: %MULTINET-F-ETIMEDOUT, Connection timed out
$ sho symbol $status
$STATUS == "%X100081E4"

This example shows how EXIT-ON-ERROR exits when an error occurs automatically. Here the FTP server responded as follows to the command user unknown password:

FTP>exit-on-error
[Will exit when an error occurs]
FTP>connect somehost
Connection opened (Assuming 8-bit connections)
<Somehost MultiNet FTP Server Process V5.5(15) at Thu 4-Mar-15 2:37PM-PDT
SOMEHOST>user unknown password
<%SYSTEM-F-INVLOGIN, login information invalid at remote node
$ show symbol $status
$STATUS == "%X1212002C"
$ write sys$output ($status-%X1000002C)/%X10000
530

530 %SYSTEM-F-INVLOGIN, login information invalid at remote node

FACT

Sets or displays the file facts that will be set to match the facts of the source file after transfer. The only fact currently supported is the file modification time.

 

FORMAT

FACT [MFMT]

 

PARAMETERS

MFMT

File modification time will be set after transferring files provided the FTP server supports the necessary commands.

 

EXAMPLE

FTP>FACT MFMT
FTP>PUT FILE.EXE

GET

Copies remote_file from the remote host to local_file on the local host. The current settings for type, mode, and structure are used during file transfers. GET is the same as RECEIVE.

 

FORMAT

GET remote-file [local-file]

 

PARAMETERS

remote-file

Specifies the name of the file on the remote host.

local-file

Specifies the name of the file on the local host.

 

QUALIFIERS

/FDL

Obtains a file previously saved with the PUT /FDL command. When you create a file with the PUT /FDL qualifier, a file description language (FDL) file is created at the same time as the original file. The output file is converted to raw block format. When you retrieve a file with GET /FDL, the original format is restored using the attributes stored in the FDL file. If you don't use the /FDL qualifier with the GET command, the new raw block format is retained. In any case, the FDL file is retained and must be deleted independently. The /FDL qualifier provides compatibility with HP TCP/IP Services for OpenVMS (formerly UCX). The FDL file has the same name except the string FDL is appended to the end.

/RESTART

For STREAM mode transfers restart the transfer where it was interrupted. The client verifies that the server supports the RFC 3659 SIZE and REST commands, and ignores the qualifier if it does not.

This does NOT work for VMS mode transfers (STRU VMS), and if the remote system is a VMS system it is recommended that a STRU FILE be done before the transfer command and to include
 /NOVMS on the command line when starting FTP.

GET/RESTART is not supported in ASCII mode to systems that support VMS mode transfers due to problems with properly concatenating a possibly broken line of text. It is recommended that the file be ZIPped and then transfer the .ZIP file in binary mode.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the GET command.

 

EXAMPLE

This example shows how to transfer a file to the local host.

EXAMPLE.COM>get login.com
To local file: RETURN
<VMS retrieve of USERS:[HOLMES]LOGIN.COM;1 started.
<Transfer completed. 2498 (8) bytes transferred.
EXAMPLE.COM>

HASH

 Turns on, off, or toggles (the default) the display of hash marks (#) for each data buffer transferred.

 

FORMAT

HASH mode

 

PARAMETERS

mode

Specifies a value of ON, OFF, or TOGGLE.

 

EXAMPLE

This example shows how to display hash marks during a GET file transfer.

EXAMPLE.COM>hash
[Hash marks will be printed during transfers]
EXAMPLE.COM>get login.com login.com
<VMS retrieve of USERS:[HOLMES]LOGIN.COM;1 started.
###
Transfer completed. 2498 (8) bytes transferred.

HELP

Displays FTP help information. Type HELP ? to see a list of HELP topics. Type HELP without an argument to display general help information.

 

FORMAT

HELP [command]

 

PARAMETERS

command

Specifies the name of the command about which you want help.

 

EXAMPLE

FTP>help

The HELP command prints on-line help for the FTP user program. The argument to HELP selects the particular FTP command about which help is desired. In addition to the FTP commands, several control characters can be typed while file transfers are in progress:

 Control-A shows the progress of a data transfer.
 Control-G aborts the file transfer and returns to FTP command level.
 Control-P spawns a new command interpreter.
FTP>

LCD

Changes the current working directory on the local host to dir. LCD is a synonym for LOCAL-CD.

 

FORMAT

LCD dir

LDIR

Displays the contents of your local working directory. LDIR is the same as LOCAL-DIRECTORY.

 

FORMAT

LDIR

 

EXAMPLE

FTP>ldir *.com
USERS:[EXAMPLE.DOC.V32]
DOC.COM;2     1   1-APR-2004 01:36 FLOWERS_FILES (RWED,RWED,,)
LOGIN.COM;3   5   1-APR-2004 19:07 FLOWERS_FILES (RWED,RWED,,)
LOGIN.COM;2   5   1-APR-2004 19:04 FLOWERS_FILES (RWED,RWED,,)
LOGIN.COM;1   5   1-APR-2004 18:49 FLOWERS_FILES (RWED,RWED,,)
Total of 16 blocks in 4 files.
FTP>

LIST

Displays automatic login information for host. See the SET command for information about setting automatic login information for a host.

 

FORMAT

LIST [host]

 

PARAMETERS

host

Specifies the host whose automatic login information you are trying to display. If you do not specify host, LIST displays automatic login information for all hosts for which login information has been set.

 

RESTRICTIONS

Do not use this command when connected to a remote host.

 

EXAMPLE

This example shows how to set and list information for the DS.INTERNIC.NET host.

FTP>set ds.internic.net  /user=anonymous /pass=guest
FTP>list
DS.INTERNIC.NET
    User: anonymous
    Password: guest
FTP>

LOCAL-CD

Changes the current working directory on the local host to dir. LOCAL-CD is the same as LCD.

 

FORMAT

LOCAL-CD dir

 

PARAMETERS

dir

Specifies the name of the directory to which to change the current working directory.

 

EXAMPLE

FTP>lcd [-]
Connected to USERS:[EXAMPLE.DOC].
FTP>

LOCAL-DIRECTORY

Displays the contents of your local working directory. LOCAL-DIRECTORY is a synonym for LDIR.

 

FORMAT

LOCAL-DIRECTORY

LOCAL-PWD

Displays the current working directory on the local host. LOCAL-PWD is a synonym for LPWD.

 

FORMAT

LOCAL-PWD

LOGIN

Identifies you to a remote FTP server. LOGIN is the same as USER.

 

FORMAT

LOGIN user [password]

 

PARAMETERS

user

Specifies your user name on the remote server.

password

Specifies your password on the remote server. If you do not specify password and the remote site requires one, you are prompted for it. In either case, the password is not echoed.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts do not allow you to use LOGIN once you have already logged in.

 

EXAMPLE

This example shows how to connect to a remote host and log in.

$ ftp example.com
Connection opened (Assuming 8-bit connections)
<EXAMPLE.COM MultiNet FTP Server Process 5.5(nn) at Fri 9-Apr-2015 7:42 am PST
EXAMPLE.COM>login HOLMES password
<User HOLMES logged into U1:[HOLMES] at Fri 9-Apr-2004, 19:13, job 433.
EXAMPLE.COM>

LPWD

Displays the current working directory on the local host. LPWD is the same as LOCAL-PWD.

 

FORMAT

LPWD

 

EXAMPLE

FTP>lpwd
Connected to USERS:[EXAMPLE.DOC].
FTP>

LS

Displays a names-only listing of files on the remote host. You can use wildcard specifications.

 

FORMAT

LS [file_spec] [output_file]

 

PARAMETERS

file_spec

Specifies the file specification to use in the directory lookup on the remote host. If you do not specify file_spec, the current working directory on the remote host is used. Any wildcards used are interpreted in the context of the remote host operating system.

output_file

Specifies the name of the file to which to write the directory listing. If output_file is not specified,   the list is directed to SYS$OUTPUT:.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the LS command.

 

EXAMPLE

This example shows how to retrieve the directory listing of the files matching the wildcard character *.

EXAMPLE.COM>ls *.
<List started.
$mailinterface.
mymail.
todo.
<Transfer completed.
EXAMPLE.COM>

MDELETE

Deletes multiple files on the remote host. MDELETE is a synonym for MULTIPLE DELETE.

 

FORMAT

MDELETE files

MGET

Copies multiple files from the remote host to the local host. MGET is a synonym for MULTIPLE GET.

 

FORMAT

MGET files

MKDIR

Creates the directory dir on the remote host. MKDIR is a synonym for CREATE-DIRECTORY.

 

FORMAT

MKDIR dir

MODE

Sets the transfer mode to COMPRESSED or STREAM (the default).

 

FORMAT

MODE mode

 

PARAMETERS

mode

Specifies one of two values: COMPRESSED or STREAM (the default).

 

RESTRICTIONS

·         The MODE command can only be used when connected to a remote host.

·         Not all modes are supported by all remote hosts.

 

EXAMPLE

This example shows how to enable COMPRESSED mode.

EXAMPLE.COM>mode c
Type: Ascii (Non-Print), Structure: VMS, Mode: Compression
EXAMPLE.COM>

MPUT

Copies multiple files from the local host to the remote host. MPUT is a synonym for MULTIPLE-SEND.

 

FORMAT

MPUT files

MULTIPLE DELETE

Deletes multiple files on the remote host. If you have turned on CONFIRM, (to confirm multiple transactions interactively), you are asked to confirm the deletion of each file. MULTIPLE DELETE is the same as MDELETE.

 

FORMAT

MULTIPLE DELETE files

 

PARAMETERS

files

Specifies which files to delete. Wildcard characters in files are expanded on the remote host.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the MULTIPLE DELETE command.

 

EXAMPLE

This example shows how to delete all files matching the remote wildcard * character.

EXAMPLE.COM>multiple delete *.com;*
< List started
<Transfer completed.
<File deleted ok, file USERS:[EXAMPLE.DOC.V32]LOGIN.COM;3.
<File deleted ok, file USERS:[EXAMPLE.DOC.V32]LOGIN.COM;2.
<File deleted ok, file USERS:[EXAMPLE.DOC.V32]LOGIN.COM;1.

MULTIPLE GET

Copies multiple files from the remote host to the local host. If you have turned on CONFIRM (to confirm multiple transactions interactively), you are asked to confirm the transfer of each file. MULTIPLE GET is the same as MGET and MULTIPLE RECEIVE.

 

FORMAT

MULTIPLE GET files

 

PARAMETERS

files

Specifies the names of the files to be copied. Wildcard characters are expanded on the remote host.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the MULTIPLE GET command.

 

EXAMPLE

This example shows how to transfer all files matching the * wildcard character.

EXAMPLE.COM>multiple get *.com
<List started.
<Transfer completed.
<VMS retrieve of USERS:[HOLMES]COPY.COM;4 started.
<Transfer completed. 732 (8) bytes transferred.
<VMS retrieve of USERS:[HOLMES]LOGIN.COM;1 started.
<Transfer completed. 2498 (8) bytes transferred.

MULTIPLE PUT

Copies multiple files from the local host to the remote host. MULTIPLE PUT is a synonym for MULTIPLE SEND.

 

FORMAT

MULTIPLE PUT files

MULTIPLE RECEIVE

Copies multiple files from the remote host to the local host. MULTIPLE RECEIVE is a synonym for MULTIPLE GET.

 

FORMAT

MULTIPLE RECEIVE files

MULTIPLE SEND

Copies multiple files from the local host to the remote host. If you have turned on CONFIRM (to confirm multiple transactions interactively), you are asked to confirm the transfer of each file. MULTIPLE SEND is the same as MULTIPLE PUT and MPUT.

 

FORMAT

MULTIPLE SEND files

 

PARAMETERS

files

Specifies which files to copy. Wildcard characters in files are expanded on the local host.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the MULTIPLE SEND command.

 

EXAMPLE

This example shows how to transfer the files which match the "*.COM" wildcard.

EXAMPLE.COM>multiple send *.com
<VMS Store of ST_ROOT:[TMP]COPY.COM;4 started.
<Transfer completed. 732 (8) bytes transferred.
<VMS Store of ST_ROOT:[TMP]FIX.COM;3 started.
<Transfer completed. 496 (8) bytes transferred.
<VMS Store of ST_ROOT:[TMP]FOO.COM;11 started.
<Transfer completed. 436 (8) bytes transferred.
<VMS Store of ST_ROOT:[TMP]LOGIN.COM;4 started.
<Transfer completed. 2498 (8) bytes transferred.
EXAMPLE.COM>

OPEN

Establishes a connection to a host system. OPEN is a synonym for CONNECT.

 

FORMAT

OPEN host

PASSIVE

Enables or disables "passive" mode for file transfers with FTP servers on the opposite side of "firewall" gateways.

 

FORMAT

PASSIVE [state] [negotiate]

 

PARAMETERS

state

Specifies a value of ON, OFF, or TOGGLE.

 

DESCRIPTION

Typically, when an FTP client requests data from an FTP server, the server attempts to establish a     connection with the client over which it transfers the data. If a "firewall" gateway separates the FTP     client and server, the gateway may prohibit incoming connections. The solution is to enable "passive" mode transfers, in which the FTP server asks the FTP client to initiate the connection.

Note! Not all FTP servers support passive mode transfers.

The PASSIVE command lets you enable or disable passive mode explicitly. When you do not specify a state, the current state is toggled.

 

EXAMPLE

This example uses PASSIVE to allow the server to transfer a directory listing across a connection        established by the FTP client rather than the server.

FTP>connect ftp.example.com
Connection opened (Assuming 8-bit connections)
<HQ.EXAMPLE.COM MultiNet FTP Server Process 5.5(14) at Wed 8-Mar-15 10:57 AM- PST
HQ.EXAMPLE.COM>user anonymous
<anonymous user ok. Send real ident as password.
Password:********************
<Welcome to ABC's Anonymous FTP directory
<Guest User WHORFIN@EXAMPLE.COM logged into USERS:[ANONYMOUS.ABC] at Wed 8-Mar-03 11:15AM-PST, job 208040a2.
<Directory and access restrictions apply
HQ.EXAMPLE.COM>passive on
[Passive mode is ON for transfers]
HQ.EXAMPLE.COM>dir
<List started.
FTP_ANON:[000000]
.INDEX;32      3   6-APR-2004 00:00 [WEBMASTER] R,RWED,RWED,R)
.WELCOME;4     2  16-MAR-2004 17:19 [WEBMASTER] R,RWED,RWED,R)
ABOUT.TXT;8         5  27-MAR-2004 14:54 [WEBMASTER] R,RWED,RWED,R)
COMPANY_INFORMATION.DIR;1|
                    1   3-JAN-2004 13:54 [WEBMASTER] (R,RWED,RWED,R)
CUSTOMER_SUPPORT.DIR;1
                    1   3-JAN-2004 13:55 [WEBMASTER] R,RWED,RWED,R)
                  544  27-MAR-2004 10:29 [WEBMASTER] R,RWED,RWED,R)
NFSACL.PS;1        72  27-MAR-2004 10:29 [WEBMASTER] R,RWED,RWED,R)
NFSACL.TXT;1       13  27-MAR-2004 10:29 [WEBMASTER] R,RWED,RWED,R)
PRODUCTS_AND_SERVICES.DIR;1
                   1    3-JAN-2004 13:58 [WEBMASTER] (R,RWED,RWED,R)
SERVER_MAP.TXT;54 60    6-APR-2004 00:04 [WEBMASTER] (RWED,RWED,RWED,R)
SET2048.MAR;2      5   27-MAR-2004 10:29 [WEBMASTER] (R,RWED,RWED,R)
THIRD_PARTY_TOOLS.DIR;1
                   1    3-JAN-2004 13:58 [WEBMASTER] (R,RWED,RWED,R)
UNZIP.EXE;3      155   27-MAR-2004 10:29 [WEBMASTER] R,RWED,RWED,R)
UNZIP_ALPHA.EXE;1 163  27-MAR-2004 10:29 [WEBMASTER] (R,RWED,RWED,R)
VMSIO.H;12         7   27-MAR-2004 10:29 [WEBMASTER] (R,RWED,RWED,R)
WHATS_NEW.TXT;1    1    5-MAR-2004 16:31 [WEBMASTER] (R,RWED,RWED,R)
Total of 1033 blocks in 15 files.
<Transfer completed.
HQ.EXAMPLE.COM>

PASSWORD

Sends a password to the remote FTP server explicitly, which happens automatically during login.

 

FORMAT

PASSWORD password

 

PARAMETERS

password

Specifies the password to send to the remote server. The password is not echoed when typed.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that the password be sent as part of the login procedure only.

 

EXAMPLE

This example shows how to send a password to the remote host.

EXAMPLE.COM>pass airplane
<Password accepted, thank you.
EXAMPLE.COM>

PORT

Specifies a TCP port number to use for the FTP control connection. Use this command only when connecting to an FTP server that provides a nonstandard FTP control connection port number.

 

FORMAT

PORT port

 

PARAMETERS

port

Specifies the port to use when establishing the FTP control connection with the remote server system.

 

EXAMPLE

This example shows how to explicitly specify a port number for the FTP control connection with the remote host.

EXAMPLE.COM>port 1099
EXAMPLE.COM>

PROMPT-FOR-MISSING-ARGUMENTS

Turns on, off, or toggles (the default) whether or not FTP prompts for missing command arguments automatically.

 

FORMAT

PROMPT-FOR-MISSING-ARGUMENTS mode

 

PARAMETERS

mode

Specifies a value of ON, OFF, or TOGGLE.

 

EXAMPLE

This example shows how to use the PROMPT-FOR-MISSING-ARGUMENTS command.

FTP>prompt-for-missing-arguments
{Will NOT prompt for missing arguments];
SALES.EXAMPLE.COM>get
?Missing remote filename
SALES.EXAMPLE.COM>

PROMPT-ON-CONNECT

Turns on, off, or toggles (the default) whether or not FTP prompts for a user name and password automatically after making a connection.

 

FORMAT

PROMPT-ON-CONNECT mode

 

PARAMETERS

mode

Specifies a value of ON, OFF, or TOGGLE.

 

EXAMPLE

This example shows how to use PROMPT-ON-CONNECT to automatically prompt for a user name and password when a connection is made.

FTP>prompt-on-connect
[Will automatically prompt for username and password]
FTP>connect ftp.example.com
Connection opened (Assuming 8-bit connections)
<FTP.EXAMPLE.COM MultiNet FTP Server Process 5.5(nn) at Fri 9-Apr-2015 7:42am PST
Username: HOLMES
Password:
<User HOLMES logged into USERS:[HOLMES] at Fri 9-Apr-2015 14:42, job 2060011f.
FTP.EXAMPLE.COM>

PUSH

Starts and attaches a DCL subprocess. If a parent process exists, attach to it. To return from DCL, use the ATTACH or the LOGOUT command. To switch back from a DCL subprocess, use the ATTACH command.  If the MULTINET_DISABLE_SPAWN logical is set, PUSH does not work.

 

FORMAT

PUSH

PUT

Copies local_file on the local host to remote_file on the remote host. The current settings for type, mode, and structure are used during file transfers. PUT is the same as SEND.

 

FORMAT

PUT local_file remote_file

 

PARAMETERS

local-file

Specifies the name of the file on the local host.

remote-file

Specifies the name of the file on the remote host.

 

QUALIFIERS

/FDL

Puts a file in FDL format. When you create a file with the PUT /FDL qualifier, a file description     language (FDL) file is created at the same time as the original file. The output file is converted to raw block format. When you retrieve a file with GET /FDL, the original format is restored using the attributes stored in the FDL file. If you do not use the /FDL qualifier with the GET command, the new raw block format is retained. In any case, the FDL file is retained and must be deleted independently. The /FDL qualifier provides compatibility with HP TCP/IP Services. The FDL file has the same name except the string FDL is appended to the end of the file name.

/RESTART

For STREAM mode transfers restart the transfer where it was interrupted. The client verifies that the server supports the RFC 3659 SIZE and REST commands, and ignores the qualifier if it does not.

This does NOT work for VMS mode transfers (STRU VMS), and if the remote system is a VMS system it is recommended that a STRU FILE be done before the transfer command and to include
/NOVMS on the command line when starting FTP.

GET/RESTART is not supported in ASCII mode to systems that support VMS mode transfers due to problems with properly concatenating a possibly broken line of text. It is recommended that the file be ZIPped and then transfer the .ZIP file in binary mode.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the PUT command.

 

EXAMPLES

This example copies the file LOGIN.COM to the remote file FOO.COM.

EXAMPLE.COM>put login.com foo.com
<VMS Store of ST_ROOT:[TMP]FOO.COM;12 started.
<Transfer completed. 2498 (8) bytes transferred.
EXAMPLE.COM>

This example copies AFILE.TXT to BFILE.TXT and creates the additional BFILE.TXTFDL file. The BFILE.TXTFDL file is in ASCII format and is an appropriate FDL description of AFILE.TXT.

EXAMPLE.COM>PUT /FDL AFILE.TXT BFILE.TXT
<ASCII Store of USERS:[HOLMES]BFILE.TXTFDL;1 started.
<Transfer completed. 888 (8) bytes transferred.
<IMAGE Store of USERS:[HOLMES]BFILE.TXT;1 started.
<Transfer completed. 6 (8) bytes transferred.
EXAMPLE.COM>

PWD

Displays the current working directory on the remote host. PWD is a synonym for SHOW_DIRECTORY.

 

FORMAT

PWD

QUIT

Closes the current FTP connection and exits FTP. QUIT is a synonym for EXIT.

 

FORMAT

QUIT

QUOTE

Sends a string to the FTP server verbatim. You can use QUOTE to access non-standard commands on the FTP server.

 

FORMAT

QUOTE string

 

PARAMETERS

string

Specifies a string to send to the server.

 

RESTRICTIONS

Use this command only when connected to a remote host.

 

EXAMPLE

This example shows how to send a NOOP command to the remote host.

EXAMPLE.COM>quote noop
<NOOP command successful.
EXAMPLE.COM>

RECEIVE

Copies remote-file from the remote host to local-file on the local host. The current settings for type,  mode, and structure are used during file transfers. RECEIVE is a synonym for GET.

 

FORMAT

RECEIVE remote-file [local-file]

 

PARAMETERS

remote-file

Specifies the name of the file on the remote host.

local-file

Specifies the name of the file on the local host.

 

QUALIFIERS

/FDL

Gets a file previously saved with the PUT /FDL command. When you create a file with the PUT      /FDL qualifier, a file description language (FDL) file is created at the same time as the original file. The output file is converted to raw block format. When you retrieve a file with RECEIVE /FDL, the original format is restored using the attributes stored in the FDL file. If you do not use the /FDL qualifier with the RECEIVE command, the new raw block format is retained. In any case, the FDL file is retained and must be deleted independently. The /FDL qualifier provides compatibility with HP TCP/IP Services. The FDL file has the same name except the string FDL is appended to the end of the file name.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the GET command.

 

EXAMPLE

This example shows how to transfer a file to the local host.

EXAMPLE.COM>receive login.com
To local file: RETURN
<VMS retrieve of USERS:[HOLMES]LOGIN.COM;1 started.
<Transfer completed. 2498 (8) bytes transferred.
EXAMPLE.COM>

RECORD-SIZE

Sets or displays the record size for IMAGE mode transfers.

 

FORMAT

RECORD-SIZE [size]

 

PARAMETERS

size

Specifies the record size for IMAGE mode transfers. Values range from 1 to 32767. When omitted, the current setting is displayed. The default record size is 512 bytes.

 

EXAMPLE

$ ftp ftp.yod.com
FTP.YOD.COM MultiNet FTP user process 5.5(nnn)
Connection opened (Assuming 8-bit connections)
<FTP.YOD.COM MultiNet FTP Server Process 5.5(nnn) at Fri 9-Apr-2015 7:42am-PST
FTP>record 1024
FTP>record
Record size for IMAGE files: 1024
FTP>

REMOTE-HELP

Displays information about commands available on the FTP server.

 

FORMAT

REMOTE-HELP

 

RESTRICTIONS

Use this command only when connected to a remote host.

 

EXAMPLE

This example shows how to retrieve help from a remote host.

UNIX.EXAMPLE.COM>remote-help
<The following commands are recognized (* =>'s unimplemented).
< USER    PORT   STOR    MSAM*   RNTO    NLST    MKD    CDUP
< PASS    PASV   APPE    MRSQ*   ABOR    SITE    XMKD   XCUP
< ACCT*   TYPE   MLFL*   MRCP*   DELE    SYST    RMD    STOU
< SMNT*   STRU   MAIL*   ALLO    CWD     STAT    XRMD   SIZE
< REIN*   MODE   MSND*   REST    XCWD    HELP    PWD    MDTM
< QUIT    RETR   MSOM*   RNFR    LIST    NOOP    XPWD
<Direct comments to ftp-bugs@ucbarpa.Berkeley.EDU.
UNIX.EXAMPLE.COM>

REMOVE-DIRECTORY

Deletes a directory on the remote host. REMOVE-DIRECTORY is the same as RMDIR.

 

FORMAT

REMOVE-DIRECTORY dir

 

PARAMETERS

dir

Specifies the name of the directory to be removed.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you be logged in before using the REMOVE-DIRECTORY command.

 

EXAMPLE

This example shows how to delete the "test" subdirectory from the remote host.

EXAMPLE.COM>remove-directory test
<“USERS:[HOLMES.TEST]” Directory deleted
EXAMPLE.COM>

RENAME

Renames files on the remote host.

 

FORMAT

RENAME file1 file2

 

PARAMETERS

file1

Specifies the name of the file to be renamed.

file2

Specifies the new name of file1.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the RENAME command.

 

EXAMPLE

This example shows how to rename COPY.COM to NEWCOPY.COM on the remote host.

EXAMPLE.COM>rename copy.com newcopy.com
<Old FILE renamed to USERS:[HOLMES]NEWCOPY.COM;1.
EXAMPLE.COM>

RETAIN

Turns on, off, or toggles (the default) the retention of OpenVMS version numbers in file transfers. By default, version numbers are stripped from OpenVMS file names before they are sent over the network.

 

FORMAT

RETAIN mode

 

PARAMETERS

mode

Specifies a value of ON, OFF, or TOGGLE.

 

EXAMPLE

This example shows how to enable retention of OpenVMS version numbers.

FTP>retain
[Transferred files will retain their version numbers]
FTP>

RM

Deletes a file on the remote host. RM is a synonym for DELETE.

 

FORMAT

RM file

RMDIR

Deletes a directory on the remote host. RMDIR is a synonym for REMOVE-DIRECTORY.

 

FORMAT

RMDIR dir

SEND

Copies local_file on the local host to remote_file on the remote host. The current settings for type, mode, and structure are used during file transfers. SEND is the same as PUT.

 

FORMAT

SEND local_file remote_file

 

PARAMETERS

local_file

Specifies the name of the file on the local host to be copied.

remote_file

Specifies the destination file name on the remote host.

 

QUALIFIERS

/FDL

Sends a file in FDL format. When you create a file with the SEND /FDL qualifier, a file description      language (FDL) file is created at the same time as the original file. The output file is converted to raw block format. When you retrieve a file with GET /FDL, the original format is restored using the     attributes stored in the FDL file. If you do not use the /FDL qualifier with the GET command, the new raw block format is retained. In any case, the FDL file is retained and must be deleted independently. The /FDL qualifier provides compatibility with HP TCP/IP Services. The FDL file has the same name except the string FDL is appended to the end of the file name.

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the SEND command.

 

EXAMPLE

This example shows how to transfer the file LOGIN.COM to the remote file FOO.COM.

EXAMPLE.COM>send login.com foo.com
<VMS Store of ST_ROOT:[TMP]FOO.COM;12 started.
<Transfer completed.  2498 (8) bytes transferred.

SET

Sets automatic login information for host.

 

FORMAT

SET host

 

PARAMETERS

host

Specifies the host for which you want to set automatic login information.

 

QUALIFIERS

/USER:username

Specifies the user name sent when a connection is made to host.

/PASSWORD:password

Specifies the password sent when a connection is made to host.

/ACCOUNT:account

Specifies the account is sent when a connection is made to host.

 

DESCRIPTION

When a connection to host is made, FTP uses the information set to automatically log in. This command is usually used in the FTP.INIT file to specify a list of hosts and their login information. If FTP.INIT contains passwords in clear text, it is imperative that you protect the file from access by other users.  If you specify /USER but not /PASSWORD, an automatic login is attempted and, if necessary, a password prompt displayed.

 

RESTRICTIONS

Do not use this command when connected to a remote host.

 

USAGE NOTE

If you do not specify any qualifiers, any automatic login information is cleared.

 

EXAMPLE

This example sets the user name and password for the host DS.INTERNIC.NET.

FTP>SET HOST ds.internic.net  /user:anonymous /pass:guest

SHOW-DIRECTORY

Displays the current working directory on the remote host. SHOW DIRECTORY is the same as PWD.

 

FORMAT

SHOW-DIRECTORY

 

RESTRICTIONS

·         Use this command only when connected to a remote host.

·         Most remote hosts require that you log in before using the SHOW-DIRECTORY command.

 

EXAMPLE

This example shows how to retrieve the remote default directory.

EXAMPLE.COM>show
<“ST_ROOT: [TMP]” is current directory.
EXAMPLE.COM>

SITE

Specifies commands that are interpreted by the MultiNet FTP server for use on the server host.

 

FORMAT

SITE command

 

PARAMETERS

command

Selects a command from the following:

RMS RECSIZE n

Indicates a non-default record size for files transferred in IMAGE mode to the FTP server. Record size values can range from 1 to 32767; the default is 512 bytes.

SPAWN

Allows users to execute commands on the server host. The command must not require a terminal device, and must exit on completion. You cannot use this command during an anonymous FTP session.

 

SPAWN

Executes a single DCL command, or if entered without options, starts a subprocess with the same effect as PUSH. To return from DCL, use the LOGOUT command. If the MULTINET_DISABLE_SPAWN logical is set, SPAWN does not work.

 

FORMAT

SPAWN [command]

 

PARAMETERS

command

Specifies a command to execute. If you omit command, a DCL command line subprocess is created.

 

QUALIFIERS

/INPUT=file-spec

Specifies an input file to the command you enter with SPAWN.

/LOGICAL_NAMES                                                                                                                                       /NOLOGICAL_NAMES

Specifies that logical names and logical name tables are not copied to the subprocess.

/SYMBOLS                                                                                                                                                        /NOSYMBOLS

Specifies that global and local names are not passed to the subprocess.

/WAIT                                                                                                                                                                  /NOWAIT

Returns control without waiting for the command to complete. Do not use this qualifier with commands that have prompts or screen displays.

/OUTPUT=file-spec

Specifies a file that retains the output of the command invoked with SPAWN. This qualifier only works when a single command is entered without creating a DCL subprocess. In addition, this qualifier is positional; you must enter it immediately after SPAWN or other qualifiers.

STATISTICS

Turns on, off, or toggles (the default) STATISTICS mode. In STATISTICS mode, FTP displays, upon completion of file transfers, timing statistics about the transfer.

If the logical MULTINET_FTP_STATISTICS_IN_HHMMSS is defined with either 1, T, or Y, then the elapsed time displays in HH:MM:SS format if statistics are requested using the STATISTICS mode.

 

FORMAT

STATISTICS mode

 

PARAMETERS

mode

Specifies a value of ON, OFF, or TOGGLE.

 

EXAMPLE

This example shows how to enable STATISTICS mode.

FTP>statistics
[Transfer statistics printing is ON]
FTP>

STATUS

Displays the status of the FTP server.

 

FORMAT

STATUS [data]

 

PARAMETERS

data

Sends this command data to the FTP server; data depends on the implementation of the FTP server. This parameter is optional.

 

RESTRICTIONS

Use this command only when connected to a remote host.

 

EXAMPLE

EXAMPLE.COM>status
<EXAMPLE.COM MultiNet FTP Server Process 5.5(nnn)
<User HOLMES is logged into directory ST_ROOT:[TMP]
<The current transfer parameters are:
<    MODE S
<    Stru O VMS
<    TYPE A N
<A connection is open to host EXAMPLE.COM
<The data connection is CLOSED.
EXAMPLE.COM

STREAM

Turns on, off, or toggles (the default) the creation of binary output files as Stream_LF files.

 

FORMAT

STREAM mode

 

PARAMETERS

mode

Specifies ON, OFF, or TOGGLE.

 

EXAMPLE

EXAMPLE.COM>stream
[ IMAGE files will be written as Stream_LF format]
EXAMPLE.COM>

STRUCTURE

Sets the transfer structure to structure.

 

FORMAT

STRUCTURE structure

 

PARAMETERS

structure

Specifies a value of FILE, RECORD, or VMS.

·         Use FILE (the default) when connecting to systems that do not support VMS structure negotiation.

·         Use RECORD to transfer files when you want to preserve the record boundaries.

·         Use VMS to transfer files with arbitrary RMS attributes transparently. Transparent transfer is negotiated automatically between systems that support it. RMS semantics are passed along with the data.

 

RESTRICTIONS

Use this command only when connected to a remote host.

 

EXAMPLE

EXAMPLE.COM>stru r
Type:Ascii (Non-Print), Structure: Record, Mode: Stream
EXAMPLE.COM>

TAKE

Interprets FTP commands in a file. When the end of the file is encountered, the FTP command interpreter returns to its previous input source. You can nest TAKE commands up to ten levels deep.

 

FORMAT

TAKE file

 

PARAMETERS

file

Specifies the name of the file that contains commands to be interpreted.

 

EXAMPLE

This example shows how to take commands from the file FTP.COMMANDS.

FTP>take ftp.commands

TENEX

Changes the byte size for transferring binary files to or from a TOPS-20 system.

 

FORMAT

TENEX

 

RESTRICTIONS

Use this command only when connected to a remote host.

 

EXAMPLE

This example shows how to set the transfer type to TENEX.

EXAMPLE.COM>tenex
Type: Logical-Byte (Byte Size 8), Structure: File, Mode: Stream
EXAMPLE.COM>

TYPE

Sets the transfer type to type.

 

FORMAT

TYPE type

 

PARAMETERS

type

Specifies a value of ASCII, BACKUP, BINARY, IMAGE, or LOGICAL-BYTE.

·         Use TYPE ASCII (the default) for transferring text files.

·         Use TYPE BACKUP to set the transfer type to IMAGE and write the local file with 2048-byte fixed length records. Use this command to transfer VMS BACKUP save sets.

·         Use TYPE BINARY to transfer binary files (same as TYPE IMAGE).

·         Use TYPE IMAGE to transfer binary files (for example, .EXE).

·         Use TYPE LOGICAL-BYTE to transfer binary files to or from a TOPS-20 machine.

 

RESTRICTIONS

Use this command only when connected to a remote host.

 

EXAMPLE

This example shows how to set the type to transfer an image file.

EXAMPLE.COM>type i
Type: Image, Structure: File, Mode: Stream
EXAMPLE.COM>

USER

Identifies you to the remote FTP server. USER is a synonym for 5.

 

FORMAT

USER user [password]

VERBOSE

Turns on, off, or toggles (the default) VERBOSE mode. VERBOSE mode causes FTP to display all responses from the remote FTP server as they are received.

 

FORMAT

VERBOSE mode

 

PARAMETERS

mode

Specifies a value of ON, OFF, or TOGGLE.

 

EXAMPLE

This example shows how to enable VERBOSE mode.

FTP>verbose
[Verbose reply printing is ON]
FTP>

VERSION

Prints information about the FTP program version.

 

FORMAT

VERSION

 

EXAMPLE

This example shows how to print the FTP program version number.

EXAMPLE.COM>version
EXAMPLE.COM MultiNet FTP user process 5.5(nnn)
EXAMPLE.COM>

WINDOW-SIZE

Displays or sets the TCP window size to be used on data transfers.

 

FORMAT

WINDOW-SIZE [size]

 

PARAMETER

size

Integer value to use for TCP window size.

 

EXAMPLE

This example shows how to display the current TCP window size.

EXAMPLE.COM>window-size
TCP window size: 32768
EXAMPLE.COM>