- BINARY
- indicates that the hierarchical file system copy utility should
install the element into a UNIX file
system in binary mode. This means that the element is installed
in its entirety as a data stream, with no breaks for logical records.
Note: - BINARY is mutually exclusive with TEXT.
- When BINARY is specified on the element MCS, SMP/E sets the BINARY
mode indicator in the hierarchical file system element entry. When
TEXT is specified on the element MCS, SMP/E sets the TEXT mode indicator
in the hierarchical file system element entry.
If neither BINARY
nor TEXT is specified on the element MCS, SMP/E uses the mode indicator
in the hierarchical file system element entry to tell the HFS copy
utility how to install the element.
If neither BINARY nor TEXT
is specified on the element MCS and there is no mode indicator in
the hierarchical file system element entry, the HFS copy utility determines
how to install the element.
- SMP/E recommends the appropriate value BINARY or TEXT
be specified to ensure that the HFS copy utility uses the correct
mode. If no value is specified, the HFS copy utility chooses either
binary or text mode based on the RECFM of the element to be copied,
and it might choose incorrectly.
- DELETE
- specifies that the hierarchical file system element and all of
its link names and symbolic link names are to be removed from the "target
library" (UNIX file
system) and the distribution library.
Note: - DELETE is mutually exclusive with all other operands except DISTLIB
and VERSION.
- If the element statement is in a base function, you may want to
use the DELETE operand on the ++VER MCS to delete the previous release,
rather than on the element statement to delete a specific element.
- Specification of the DELETE operand results in all link names
and symbolic link names of the element being deleted along with the
element identified.
- DISTLIB
- specifies the ddname of the distribution library for the specified
hierarchical file system element. During ACCEPT processing, SMP/E
installs the hierarchical file system element into the distribution
library as a member. (The distribution library must be a PDS or PDSE;
it cannot be part of a UNIX file
system.)
Note: - DISTLIB must be specified when the hierarchical
file system element is first installed.
- If an element entry already exists in the target zone or distribution
zone and the value currently in that entry does not match that specified
in the DISTLIB operand, the SYSMOD is not applied or accepted.
- element
- specifies the type of element. Table 1 shows the MCSs used for
the various hierarchical file system element types.
- FROMDS
- identifies the partitioned data set that contains this element.
Note: The
FROMDS operand and its DSN, NUMBER, VOL, and UNIT suboperands are
included in the MCS generated by the BUILDMCS command. IBM® does not intend the FROMDS operand to be
used in manually coded MCS.
- DSN
- specifies the dsname of the FROMDS data set. The specified data
set name must conform to standard data set naming conventions and
cannot contain parentheses. The maximum length of the entire name
is 44 characters (including the periods).
- NUMBER
- specifies a number that SMP/E is to use when assigning a name
to the SMPTLIB data set associated with this FROMDS data set. (This
is similar to the way the relative file number is used in RELFILE
processing.)
- VOL
- specifies, for an uncataloged data set, the volume serial number
of the volume containing the FROMDS data set. If specified, this volume
identifier must be from 1 to 6 alphanumeric characters.
VOL may
be omitted for a cataloged data set.
- UNIT
- specifies, for an uncataloged data set, the UNIT type containing
the FROMDS data set. If specified, the UNIT value must be from 1 to
8 characters and must conform to standard UNIT naming conventions.
SMP/E accepts any nonblank characters specified between the open and
close parentheses, up to a maximum length of 8.
UNIT may be omitted
for a cataloged data set.
Note: FROMDS is mutually exclusive with
DELETE, RELFILE, and TXLIB.
- LINK
- specifies the alternative names by which this hierarchical file
system element can be known in a UNIX file
system. The full name is produced by concatenating the specified linkname
with the UNIX file
system directory identified by the SYSLIB subentry. Each linkname
is passed to the HFS copy utility as an execution parameter.
Note: - The linkname can be from 1 to 1023 characters.
- A linkname can be enclosed in single apostrophes ('). A linkname must be
enclosed in single apostrophes if any of the following is true:
- The linkname contains lowercase alphabetic characters.
- The linkname contains a character that is not uppercase alphabetic,
numeric, national ($, #, @), slash (/), plus (+), hyphen, period,
or ampersand (&).
- The linkname spans more than one line in the control statement.
The single apostrophes used to enclose a linkname (the delimiters)
do not count as part of the 1023-character limit.
- Any apostrophes specified as part of a linkname (not the delimiters)
must be doubled.
Double apostrophes count as two characters in
the 1023-character limit.
- The linkname can include characters X'40' through X'FE'.
- LINK values are saved and passed to the HFS copy utility as follows:
- name
- specifies the name of the hierarchical file system element member.
The name can contain any uppercase alphabetic, numeric, or national
($, #, @) character and can be 1 to 8 characters long.
- PARM
- specifies a character string that is to be passed to the hierarchical
file system copy utility as an execution-time parameter. (The values
that can be specified on the PARM operand, such as PATHMODE, are those
accepted by the BPXCOPY utility. See z/OS UNIX System Services Command Reference for
a description of BPXCOPY and the values it accepts.) The maximum length
of this character string is 300 bytes of nonblank data. If any blanks
are specified in the PARM value, they are deleted by SMP/E during
processing and do not count toward the 300-byte maximum.
Note: - PARM is an optional operand.
- The character string can be entered free-form, without regard
to blanks (which are compressed out of the string), and can span multiple
80-byte records.
- If parentheses are specified in the PARM value, there must always
be a pair (left and right); otherwise, the results are unpredictable.
- PARM values are saved and passed to the HFS copy utility as follows:
- If the UTILITY entry for the HFS copy utility specifies a PARM
value, those parameters are passed to the utility in addition to any
parameters saved in the hierarchical file system element entry.
- RELFILE
- identifies which relative file associated with the SYSMOD contains
this element. This operand is required if
you provide the element in RELFILE format, rather than inline or in
a TXLIB data set.
Note: - The RELFILE value must be a decimal number from 1 to 9999.
- RELFILE is mutually exclusive with FROMDS and TXLIB.
- RMID
- specifies the last SYSMOD that replaced this element. This
operand can be used only in a service-updated function, and the specified
PTF must be integrated into the function.
- SHSCRIPT
- specifies a UNIX shell script, scriptname,
to be invoked when the element is installed in (or deleted from) a
directory of a UNIX file
system. scriptname can contain any uppercase alphabetic,
numeric, or national ($, #, @) character and can be 1 to 8 characters
long.
A shell script is commonly used to complete the installation
of an element. For example, if the hierarchical file system element
is a TAR or PAX file, you can provide a shell script that performs
the necessary steps to restore the file.
scriptname must
be the first value to follow the SHSCRIPT operand.
You define
the shell script to SMP/E through a ++SHELLSCR statement, which
can be within the same SYSMOD as the hierarchical file system element,
or within a SYSMOD that was processed previously. When the element
is itself a SHELLSCR type, the SHSCRIPT operand must match the name
of the element.
You cannot define more than one shell script
for an element.
You can follow
scriptname with
either of two optional values, PRE and POST, to specify the point
in SMP/E processing when the shell script is to be invoked. The following
examples show how you can use the PRE and POST values:
- To run the shell script before the element is copied to a UNIX file system directory,
specify:
SHSCRIPT(scriptname,PRE)
- To run the shell script after the element is copied to a UNIX file system directory,
specify:
SHSCRIPT(scriptname,POST)
or
specify no value after scriptname to use POST by
default.
- To run the shell script both before and after the element is copied
to a UNIX file system
directory, specify:
SHSCRIPT(scriptname,PRE,POST)
If you do not specify a PRE or POST value for the shell script,
SMP/E invokes the shell script after the element is installed in the
directory.
When the element is a shell script, PRE is not valid.
Also, you cannot specify the SHSCRIPT operand with the DELETE
operand.
- SYMLINK
- specifies a list of one or more symbolic links, which are file
names that can be used as alternate names for referring to this element
in a UNIX file system.
Each linkname listed here is associated with a pathname listed in
the SYMPATH operand. For more information about how the linknames
and pathnames are associated, see the description of the SYMPATH operand
and Example 3: Packaging a SYSMOD with a symbolic link.
The SYMLINK value specified
should be a relative path value (that is, it does not start with a
slash ["/"]). When the symbolic link is created, it is created relative
to the pathname of the element's SYSLIB ddname.
SYMLINK must
be specified if the SYMPATH operand is specified, otherwise
it must be omitted.
A symbolic linkname can be from
one to 1023 characters. Any characters in the range X'40' through
X'FE' may be specified.
The value may be enclosed in single
apostrophes. It
must be enclosed in single apostrophes if:
- it is continued to the next line in the MCS, or
- it contains a character that is not uppercase alphabetic, numeric,
national ($, #, @), slash (/), plus (+), hyphen, period, or ampersand
(&).
If an apostrophe is a part of the symbolic linkname and
is not a delimiter, then it must be doubled. These two apostrophes
count as two characters against the 1023 character limit for a symbolic
linkname. The single apostrophes used to enclose a symbolic linkname
do not count against the 1023 character limit.
- SYMPATH
- specifies a list of one or more pathnames that are associated
with symbolic links identified by the SYMLINK operand. The first pathname
in the SYMPATH operand is associated with the first symbolic link
in the SYMLINK operand, the second pathname with the second symbolic
link, and so on. If there are more symbolic links listed than there
are pathnames, then the last listed pathname is used for the remaining
symbolic links. If more pathnames are specified than symbolic linknames,
then the excess pathnames (at the end of the list) are ignored.
The
SYMPATH value specified should be a relative path value. When the
symbolic link is accessed, the system assumes the destination of that
link (the SYMPATH value) is relative to that symbolic link (the SYMLINK
value). For more information about how the pathnames and linknames
are associated, see Example 3: Packaging a SYSMOD with a symbolic link.
SYMPATH must
be specified if the SYMLINK operand is specified, otherwise
it must be omitted.
A symbolic pathname can be one
to 1023 characters. Any characters in the range X'40' through X'FE'
may be specified.
The value may be enclosed in single apostrophes.
It
must be enclosed in single apostrophes, if:
- it is continued to the next line in the MCS, or
- it contains a character that is not uppercase alphabetic, numeric,
national ($, #, @), slash (/), plus (+), hyphen, period, or ampersand
(&).
If an apostrophe is a part of the symbolic pathname and
is not a delimiter, then it must be doubled. These two apostrophes
count as two characters against the 1023 character limit for a symbolic
pathname. The single apostrophes used to enclose a symbolic linkname
do not count against the 1023 character limit.
- SYSLIB
- specifies the ddname of the "target library" within the UNIX file system for the element.
During
APPLY processing, the HFS copy utility installs the hierarchical file
system element into a UNIX file
system. During RESTORE processing, the HFS copy utility copies the
hierarchical file system element from the distribution library member
into a UNIX file system.
Note: SYSLIB must
be specified when the hierarchical file system element is first installed.
- TEXT
- indicates that the hierarchical file system copy utility should
install the element into a UNIX file
system in text mode. This means that the element is installed
with breakpoints for logical records.
Note: - TEXT is mutually exclusive with BINARY.
- When TEXT is specified on the element MCS, SMP/E sets the TEXT
mode indicator in the hierarchical file system element entry. When
BINARY is specified on the element MCS, SMP/E sets the BINARY mode
indicator in the hierarchical file system element entry.
If neither
BINARY nor TEXT is specified on the element MCS, SMP/E uses the mode
indicator in the hierarchical file system element entry to tell the
HFS copy utility how to install the element.
If neither BINARY
nor TEXT is specified on the element MCS and there is no mode indicator
in the hierarchical file system element entry, the HFS copy utility
determines how to install the element.
- SMP/E recommends the appropriate value BINARY or TEXT
be specified to ensure that the HFS copy utility uses the correct
mode. If no value is specified, the HFS copy utility chooses either
binary or text mode based on the RECFM of the element to be copied,
and it might choose incorrectly.
- TXLIB
- is the ddname of the partitioned data set containing the hierarchical
file system element. This operand is required
if the hierarchical file system element is provided in a data set
that the users have access to, rather than inline or in RELFILE format.
Note: - SMPTLIB cannot be used as a value on the TXLIB operand.
- TXLIB is mutually exclusive with FROMDS and RELFILE.
- VERSION
- specifies one or more function SYSMODs that currently contain
the element. The function containing the element MCS takes over ownership
of the element from the specified functions.
When VERSION is
specified on an element statement, it overrides any VERSION operand
values that might be specified on the ++VER MCS.