Your Browser is not longer supported

Please use Google Chrome, Mozilla Firefox or Microsoft Edge to view the page correctly
Loading...

{{viewport.spaceProperty.prod}}

ftshw

&pagelevel(3)&pagelevel

Note on usage

Function: Display the attributes of one or more remote files

User group: FT user

Functional description

With ftshw you can display the attributes of a file or files in a directory in the remote system.

There are three options for displaying the attributes:

  • List the names of the files in a directory

  • Display a default selection of file attributes

  • Display all attributes of a file or of files in a directory, as requested from the partner system

A precise description of default output and detailed output can be found in the section “Description of file attribute display”.

Output is written to standard output.

Format

ftshw

-h |
[ -d ]
[ -c ]
<partner 1..200>![<file name 1..512>]
[ <transfer admission 8..67> | @n | @d |
<user ID 1..67>[,[<account 1..64>][,[<password 1..64>]]] ]
[ -fnc=t | -fnc=c ]
[ -sif=n | -sif=l | -sif=m ]
[ -p=[<management password 1..64>] ]
[ -s | -l ][ -csv ]

Description

-h

Displays the command syntax on the screen. Entries after the -h are ignored.

-d

Specifies that the attributes of the files in a remote directory are to be displayed.

-d not specified

The attributes of the file file name specified in the command are displayed.

-c

specifies that the file(s) and/or directory list attributes are to be encrypted during transfer. If the partner system doesn’t support encryption, the request is rejected.

-c not specified

The file(s) and/or directory list attributes are not encrypted during transfer.

partner![file name]

specifies the system and the file(s) of which the attributes have to be displayed.

partner

partner is the name of the partner system in the partner list or the address of the partner system. For details on address specifications, see section “Specifying partner addresses”.

file name

file name can be either absolute or relative to the remote login authorization. If the file name in the remote system has been predefined in an admission profile, it must not be specified here.

If the -d option is specified, file name indicates a directory in the remote system.

If the partner system is running openFT (BS2000), elements from PLAM libraries may also be specified here (Syntax: Libname/Element type/Element name).

If openFT (z/OS) is running on the partner system, members from PO libraries can also be output here(syntax: library name/library member).

transfer admission | @n | @d |
user ID [,[account][,[password]]]

To enable you to execute file management requests in the remote system, you must furnish the remote system with proof of identity. For this purpose, you will need login authorization in the syntax valid for the remote system. You can specify this transfer admission

  • as an FTAC transfer admission if FTAC is used in the remote system,

  • or as a login/LOGON authorization in the syntax used by the remote system (user ID, possibly together with account or password).

For details, see section “Entering the authorization data for the partner system”.

@n for transfer admission

By entering @n you specify that the remote system requires no login authorization.

@d for transfer admission

Specifying @d (blanked) causes openFT to query the transfer admission on the screen after the command is entered. Your entry is not displayed to prevent unauthorized persons from seeing the transfer admission.

A binary password and binary transfer admission must be specified in hexadecimal format, see section “Entering commands”.

password not specified

Omitting the password necessary for admission causes openFT to query the password on the screen after the command is entered. Your entry is not displayed to prevent unauthorized persons from seeing the password.

Nevertheless, you have to specify the commas, e.g.:

ftshw partner!file user-id,,

or

ftshw partner!file user-id,account,

neither transfer admission nor user ID specified

causes the same as @d, i.e. openFT queries the transfer admission on the screen after the command is entered. Your (blanked) entry is always interpreted as transfer admission and not as user ID.

-fnc=t | -fnc=c (file name coding)

specifies the encoding mode for the remote file names and directory names.

t (transparent, default value)

Specification of the remote file name and directory name in transparent mode (compatible to the previous versions). The file names of the partner system to be displayed are shown as before in older openFT versions. File names in Unix directories are interpreted here on a byte-by-byte basis as ISO8859-1 characters. Only those files that correspond to the ANSI character set in Windows systems are output in Windows systems.

c (character)

Specification of the remote file name and directory name in character mode. I.e., the file and directory name and the file names of the partner system to be displayed are interpreted according to the character code of the remote system, i.e. for Unix partners according to the openFT operating parameter option (ftmodo -fnccs) that has been set there.

If the encoding mode on a Unix partner is set to UTF-8 via operating parameter (ftmodo -fnccs=utf8), file names that do not correspond to UTF-8 coding are omitted. The file names of the partner system to be displayed are then converted from this character code to the transfer code UTF-8 and then to the output character code, which results on Unix from the setting of the LOCALE and LANG environment variables. File names that cannot be represented in the appropriate output character code are suppressed by default. This can be controlled via the -sif option.

-fnc=c is only permitted for partners as of openFT V12.1.

-sif=n | -sif=l | -sif=m (show improper file names)

Specifies whether non-mappable file names are output (i.e. file names which can not displayed correctly). -sif is only permitted together with -d, see also examples in section “Output of attributes in directories”.

n (no, default value)

Only mappable file names are output. The output of non-mappable file names is suppressed without feedback.

l (list)

The number of suppressed file names is output in one or more lines at the end of the file list.

m (message)

The number of suppressed file names is output in one or more messages on stderr.

The option -sif is ignored for partners with openFT < V12.1 and for FTP partners.

-p=[management password]

If the file in the remote system is protected by a password, you must enter this password here.

A binary password must be entered in hexadecimal format, see section “Entering commands”. This is of relevance for links to openFT (BS2000), because BS2000 supports the definition of hexadecimal passwords.

management password not specified

Specifying -p= causes openFT to query the password on the screen after the command is entered. Your entry is not displayed to prevent unauthorized persons from seeing the password.

-s

Only the file name or the names of the files in the directory are output (short).

-l

All information available on the remote file in the partner system is requested. However, only attribute values returned by the partner system can be displayed (long).

neither -s nor -l specified:

A standard scope of information should be displayed.

A precise description of standard output and of detailed output can be found in the following section.

-csv

Specifying -csv indicates that the attributes of files on remote systems are to be output in the CSV format. The values in the output are separated by semicolons. If you specify -csv, output is always in the long form (analogous to -l) regardless of whether you also specify -l or -s.

-csv not specified

The attributes of files on remote systems are output in the standard format.