HP OpenVMS Systems Documentation

Displays information about how to enter FTP commands. Provides help for both DCL and UNIX commands, as follows:

• HELP --- Displays all DCL FTP commands
• HELP ftp_command --- Displays DCL help information for the specified command
• ? --- Displays all the UNIX FTP commands
• ? command --- Displays help for the specified UNIX command

DCL Format

HELP [ /REMOTE ] [ command ]

UNIX Format

help [ command ]

? [ command ]

Parameters

command

Optional.

FTP command about which you would like information.

Qualifiers

/REMOTE

Optional. Default: local host.

The remote host displays FTP help information. If the remote host is a UNIX host, the FTP help is all UNIX style. If you want to display information about a specific command, the /REMOTE qualifier must follow the HELP command and precede the name of any command for which you want information, as shown in example 2.

Examples

FTP> HELP
  Information available:

  APPEND     CONNECT    CREATE     DELETE     DIRECTORY  DISABLE
  DISCONNECT ENABLE     EXIT       GET        HELP       LOGIN      PUT
  QUOTE      RENAME     SET        SHOW       SPAWN      VIEW

Topic?
      

The local system displays all DCL FTP commands.

FTP> HELP/REMOTE
214-The following commands are recognized (* =>'s unimplemented)

USER   PORT    STOR    MSAM*   RNTO    NLST    MKD     CDUP    LPSV
PASS   PASV    APPE    MRSQ*   ABOR    SITE    XMKD    XCUP    EPRT
ACCT*  TYPE    MLFL*   MRCP*   DELE    SYST    RMD     STOU    EPSV
SMNT*  STRU    MAIL    ALLO    CWD     STAT    XRMD    SIZE
REIN*  MODE    MSND*   REST*   XCWD    HELP    PWD     MDTM
QUIT   RETR    MSOM*   RNFR    LIST    NOOP    XPWD    LPRT

214 End of help
FTP>
      

The remote host, a UNIX system, displays the FTP commands you can use in your FTP session with this system.

FTP> HELP/REMOTE USER
214 Syntax: USER <sp> username
FTP>
      

The remote host displays information about the FTP command USER.

FTP> ?
Commands may be abbreviated.  Commands are:

append          disconnect      mkdir           remotehelp      view
ascii           form            mls             rename          view/p
bell            get             mode            reset           view/pa
binary          glob            mput            rmdir           view/pag
bye             hash            open            rstatus         view/page
case            image           prompt          send            vms
cd              lcd             sendport        status          ?
cdup            ls              put             struct          !
close           lpwd            pwd             sunique
delete          mdelete         quit            type
debug           mdir            quote           user
dir             mget            recv            verbose
FTP>
      

Displays FTP HELP about UNIX commands.

Initiates the login process and completes it if no password is required. If a password is required, enter it at the password prompt.

Use this command if the connection is active but the login procedure fails when you request a connection.

DCL Format

LOGIN user_name

UNIX Format

user user_name

Parameters

user_name

Required.

Your account on the connected remote host.

Example

$ FTP
FTP> open bygnet
220 bygnet.band2.stat.com FTP server (UNIX Version 5.60) ready
Connected to bygnet.
Name (bygnet:vana): evt
331 Password required for evt.
Password:
530 Login incorrect.
%TCPIP-E-FTP_LOGREJ, login request rejected
FTP> LOGIN "evt"
331 Password required for evt.
Password:
230 User evt logged in.
FTP>
      

While trying to connect and log in to remote UNIX host bygnet , user evt enters an incorrect passsword. Although host bygnet completes the connection, bygnet rejects the login request. The LOGIN command successfully completes the login to the remote host.

The PUT command does the following:

• Copies local files to a remote host.
• Copies files to a DECnet node.

File names are copied in lowercase without version numbers.

To use this command, you must have an FTP session with a remote host. For information about file version numbers, see Section 2.8.4.

DCL Format

PUT [ /CONFIRM | /CONVERT | /FDL | /[NO]LOWERCASE | /RAW]

(local_file [ remote_file ] )

UNIX Format

put local_file [ remote_file ]

send local_file [ remote_file ]

mput local_files

Parameters

local_file

Required.

Name of the local file to copy.

• To specify multiple files, separate the names with commas.
• To use wildcards, first enable parsing (see the ENABLE PARSE command).

  put file_name.ext --- Copies the latest version
  put file_name.ext;* --- Copies all versions

• To copy a file to a remote DECnet node, use the full specification:
  node name, device, directory, and file name.

remote_file

Optional. Default: same name, same case, no version number on UNIX systems.

Name of the new file on the remote host. You cannot use wildcards.

Qualifiers

/CONFIRM

Optional. Default: immediate execution. The /CONFIRM qualifier must immediately follow the PUT command, without a preceding space.

This qualifier asks you for confirmation before copying the file.

/CONVERT

Optional.

Translates the internal file-formatting characters of Variable Forms Control (VFC) files. The /CONVERT qualifier must immediately follow the PUT command, without a preceding space.

/FDL

Optional. Default: no secondary file created. The /FDL qualifier must immediately follow the PUT command, without a preceding space.

Creates a secondary file with the file's OpenVMS record attributes. The SET TYPE command determines the type of file.

• Specifying ASCII results in a sequential file with variable-length records. Select this type when transferring ASCII text files.
• Specifying IMAGE results in a sequential file with fixed-length records of 512 bytes. Select this type when transferring non-ASCII files, such as executable image files.

/[NO]LOWERCASE

Optional. Default: /LOWERCASE

Forces a file name to lowercase at the destination. Use the /NOLOWERCASE qualifier to make sure the file name is preserved in the existing case.

/RAW

Optional.

Maintains block mode of files regardless of the TCPIP$FTP_RAW_BINARY logical name definition. The /RAW qualifier must immediately follow the PUT command, without a preceding space.

Examples

FTP> PUT SALES.LIS;*
200 PORT command successful
150 Opening ASCII mode data connection for sales.lis.2 (130.180.4.8,1028)
226 Transfer complete
local: DISK3$:[TRANS]SALES.LIS;2  remote:  sales.lis.2
3634 bytes sent in 00:00:00.01 seconds (394.31 Kbytes/s)
200 PORT command successful
150 Opening ASCII mode data connection for sales.lis.1 (130.180.4.8,1029)
226 Transfer complete
local: DISK3$:[TRANS]SALES.LIS;1  remote:  sales.lis.1
3634 bytes sent in 00:00:00:01 seconds (394.31 Kbytes/s)
FTP>

      

Copies all versions of the local file SALES.LIS to the remote UNIX host.

• File names are copied in lowercase.
• OpenVMS file version numbers become the last element of the copied files.
• Semicolons are converted to periods.
• If the Store Unique feature is toggled on ( sunique ), when you copy a file to an OpenVMS host, the host FTP server gives the file a new, unique version number. When you specify the version number of a file to be copied (PUT) to a remote UNIX host, the file retains the version number on the remote host, with the semicolon (;) replaced by a period (.). The UNIX host adds another version number to the file name as well. For example, if you copy (PUT) file BASES.TMP;2 to a UNIX host, the file name on the UNIX host will be bases.tmp.2.1 .

FTP> PUT/FDL STAT.BCK "cygnet.bck"
200 PORT command successful
150 Opening data connection for cygnet.bckfdl (130.180.4.8,1028)
226 Transfer complete
local: cygnet.bckfdl  remote: cygnet.bckfdl
21700 bytes sent in 00:00:00.03 seconds (662.23 Kbytes/s)
200 TYPE set to IMAGE
200 PORT command successful
150 Opening data connection for cygnet.bck (130.180.4.8,1029)
226 Transfer complete
local: STAT.BCK  remote: cygnet.bck
8152 bytes sent in 00:00:00.12 seconds
FTP>
      

Copies the local file STAT.BCK to a UNIX host, giving the copy the name cygnet.bck . Also creates a secondary file with the RMS record attributes of file cygnet.bckfdl .

Sends your input directly to the remote host. Lets you use FTP commands that are implemented by the remote host but not known to the local host.

To use the QUOTE command, you must have an FTP session with a remote host. The QUOTE command is not valid for file transfer.

For a list of commands implemented by the remote host, enter:

FTP> HELP/REMOTE

DCL Format

QUOTE command_line

UNIX Format

quote command_line

Parameters

command_line

Required.

Remote command you want to execute.

Example

FTP> QUOTE CDUP
250 CWD command successful.
FTP>
      

FTP sends the cdup command to the UNIX host to change the remote directory up one level.

Renames a remote file. To use this command, you must have an FTP session with a remote host.

DCL Format

RENAME old_name new_name

UNIX Format

rename old_name new_name

Parameters

old_name

Required.

File name on the remote host to rename.

new_name

Required.

New name for the remote file.

Examples

FTP> rename STUDENTS.LIS TEST_STUDENTS.LIS
350 File exists, ready for destination name
250 RNTO command successful.
FTP>
      

Renames a file on a UNIX system.

FTP> RENAME STUDENT.LIS TEST_STUDENT.LIS
350 File WORK1$:[VANA[STUDENT.LIS; will be renamed.
250 File WORK1$:[VANA]STUDENT.LIS;1 renamed to WORK1$:[VANA]TEST_STUDENT.LIS;1
FTP>
      

Renames a file on an OpenVMS system.

Sets your default directory on either the remote host or the local host. To set the default directory on a remote host, you must have an FTP session with a remote host.

DCL Format

SET DEFAULT [ /LOCAL ] directory

UNIX Formats

cd directory

lcd directory

Parameters

directory

Required.

Name of the directory to which to change the default.

Qualifiers

/LOCAL

Optional. Default: remote.

Changes the working directory on the local host.

Examples

FTP> SET DEFAULT "/USR/USERS/ROLLINGS"
250 CWD command successful.
      

Changes the remote working directory to /usr/users/rollings .

FTP> SET DEFAULT ~
250 CWD command successful.
250 New default directory is /USR/USERS

      

Changes the remote working directory back to the default login directory.

FTP> SET DEFAULT /LOCAL USER$1:[PRESS.CHECK]
Local Directory now USER$1:[PRESS.CHECK]

      

Changes your local working directory to USER$1:[PRESS.CHECK].

Sets maximum tolerance level for errors:

• ERROR --- FTP tolerates errors and warnings and does not exit when running in batch mode.
• SUCCESS --- The default. FTP does not tolerate errors and exits when running in batch mode.
• WARNING --- FTP tolerates warnings and does not exit when running in batch mode.

DCL Format

SET ERROR_LEVEL error_level

UNIX Format

There is no UNIX equivalent for the SET ERROR_LEVEL command.

Parameters

error_level

Required.

Severity of errors tolerated. Specify ERROR, SUCCESS, or WARNING. The default is SUCCESS.

Example

FTP> SET ERROR_LEVEL ERROR
Error level is ERROR.
      

Sets the error level tolerance to ERROR.

Controls whether the FTP client or server initiates data connections.

DCL Format

SET PASSIVE keyword

UNIX Format

passive keyword

Parameters

keyword

The FTP client program starts with the value AUTO. All keyword comparisons are done without regard for typographical case (case-blind).

• ALL
  Does nothing.
• AUTO
  The FTP client uses the version of network protocol in use on the control connection to determine how the data connection is initiated. If the network protocol is IPv4, FTP client behaves as though SET PASSIVE OFF had been specified. If the network protocol is IPv6, FTP client behaves as though SET PASSIVE ON had been specified.
• OFF
  The FTP server initiates the data connection.
• ON
  The FTP client initiates the data connection. This is often useful when a network firewall exists on the path between the client and the server and prevents the FTP server from making outbound connections.

Example

FTP> SET PASSIVE ON
Passive is ON

      

Sets passive mode to ON. The FTP client always initiates the data connection.

FTP> PASSIVE AUTO
Passive is AUTO (IPv4: OFF, IPv6: ON).

      

Sets passive mode back to AUTO.

Defines the data representation type:

• ASCII --- Appropriate for text files (default).
• IMAGE --- Appropriate for transferring binary files, such as executable images.

DCL Format

SET TYPE type

UNIX Format

type type

Parameters

type

Required.

Data representation type. Specify ASCII or IMAGE. If you do not use the SET TYPE command, the default is SET TYPE ASCII.

Example

FTP> SET TYPE IMAGE
200 Type set to I.
      

Sets the data representation type to IMAGE for files you transfer during the current FTP session.

Displays the name of the working directory on the remote host or the local host. To use the SHOW DEFAULT command to display the working directory on the remote host, you must have an FTP session with a remote host.

DCL Format

SHOW DEFAULT [ /LOCAL ]

UNIX Format

pwd

Qualifiers

/LOCAL

Optional. Default: remote directory.

Displays the local working directory.

Examples

FTP> SHOW DEFAULT
257 "/usr/staff/hurry/items" is current directory.
      

Displays the name of the working directory on the connected remote host.

FTP> SHOW DEFAULT /LOCAL
Local directory is WORKS$:[CROWE].
      

Displays the name of the working directory on the local host.

Displays the current setting of the FTP client passive parameter.

Format

SHOW PASSIVE

Examples

FTP> SHOW PASSIVE
Passive is AUTO (IPv4: OFF, IPv6: ON).

      

Shows that passive mode is on for IPv6.

Displays the current FTP parameter settings and, if you have an open connection, the name of the connected host and parameter settings relative to the connection.

DCL Format

SHOW STATUS

STATUS

UNIX Format

status

rstatus

Examples

FTP> SHOW STATUS
211-FTP Server Status.
211-SITE set to +VMS+.
211-TYPE set to ASCII.
211-STRU set to FILE.
211-MODE set to STREAM.
211 Multiline responses are enabled.
Connected to: HANKS.ABC.UCB.EDU
VMS Plus mode enabled
Mode = stream, Type = ascii, Form = non_print, Structure = file
Error level is SUCCESS
Passive is AUTO (IPv4: OFF, IPv6: ON)

      

Displays the status of the connection with remote OpenVMS host HANKS. By default, FTP sets VMS Plus Mode for rapid file transfers between two OpenVMS systems running TCP/IP Services for OpenVMS.

FTP> status

211-FTP Server Status.
211-SITE set to +VMS+.
211-TYPE set to ASCII.
211-STRU set to FILE.
211-MODE set to STREAM.
211 Multiline responses are enabled.
Local client's status:
Connected to:HANKS.ABC.UCB.EDU
VMS Plus mode enabled
Mode = stream, Type = ascii, Form = non_print, Structure = file
Error level is SUCCESS
Passive is AUTO (IPv4: OFF, IPv6: ON)
Reply display is on
Parsing is on
Prompting is off
Port command is on
Case: MPUT will preserve typographical case in destination filenames, if
possible

      

Is a superset of the SHOW STATUS command. The output is consistent with running the status command on other platforms.

FTP> show status
211-eagle.store1.equip.com FTP server status:
     Version 5.60
     Connected to eagle.store1.equip.com
     Logged in as jones
     TYPE: Image; STRUcture: File; transfer MODE: Stream
   211- No data connection
211 End of status
Connected to: eagle
VMS Plus mode disabled
Mode = stream , Type = image, Form = non_print, Structure = file
Error level is SUCCESS
Passive is AUTO (IPv4: OFF, IPv6: ON)

      

Displays the current FTP parameters, which control data transfers with the connected UNIX host eagle .