swpackage(4)

Keyword that begins the distribution specification. Each keyword defines an attribute of the distribution depot or tape itself. All keywords are optional, even if a distribution specification is included in a PSF.

Defines the semantics to use when parsing the PSF. To ensure IEEE Standard 1387.2 semantics, define a layout_version of 1.0, as the first attribute.

Defines the identifier (short name) for the distribution depot or tape.

Defines the copyright information for the distribution depot or tape; the value is either the text itself (within double-quotes) or a pointer to the filename containing the text.

Defines the multi-paragraph description of the distribution depot or tape; the value is either the text itself (within double-quotes) or a pointer to the filename containing the text.

If a distribution specification is included in the PSF, swpackage requires only the keyword plus one or more contained product definitions. The depot keyword can also be used in place of distribution.

Defines the part or manufacturing number of the distribution depot (e.g. CD-ROM) or tape.

Defines the full name (one-line description) of the distribution depot or tape.

Ends the distribution specification. This keyword is optional.

Keyword that begins the vendor specification.

Defines the identifier (short name) for the vendor.

Defines the full name (one-line description) for the vendor.

Defines the multi-paragraph description of the vendor; the value is either the text itself (within double-quotes) or a pointer to the filename containing the text.

Ends the vendor specification. This keyword is optional.

Keyword that begins the category specification.

Defines the identifier (short name) for the category.

Defines the full name (one line description) for the category.

A more detailed description of the category.

Determines which category object definition to maintain in a depot when a definition being installed or copied does not match a definition already in the depot with the same category_tag.

Ends the category specification. This keyword is optional.

Required keyword that begins the product specification.

Defines the identifier (short name) for the product or bundle.

Describes the target system(s) on which the product or bundle will run. Provides a human-readable summary of the four uname(1) attributes which define the exact target system(s) the product supports.

Required keyword that begins the bundle specification.

A repeatable tag-based attribute identifying a set of categories of which the software object is a member. This is used as a selection mechanism and can be used independent of patches. The default value is an empty list or patch if the is_patch attribute is set to true.

Like vendor_tag, this attribute can be used as a pointer to a category object that contains additional information about the category (for example, a one-line title definition and a description of the category).

Note that the category tag patch is reserved. When is_patch is set to true, a built-in category_tag attribute of value patch is automatically included.

NOTE: You can only change the patch value by performing a swpackage operation or by using swmodify to change the value of the is_patch attribute.

The list of fully qualified software_specs (all version-distinguishing attributes included) for the bundle contents. The contents should also be at the fileset level and include all dependencies. More general software_specs are also supported, including bundles containing other bundles, but the bundle contents might vary between invocations.

Defines the copyright information for the product or bundle; the value is either the text itself (within double-quotes) or a pointer to the filename containing the text.

Defines the multi-paragraph description of the product or bundle; the value is either the text itself (within double-quotes) or a pointer to the filename containing the text.

Defines the default, absolute pathname to the directory in which the product's files will be installed (i.e. the root directory of the product). If this attribute is not specified, swpackage assigns a value of "/".

Defines whether the product or bundle can be installed into any directory, or whether it must be installed into a specific directory. If this attribute is not specified, swpackage assigns a value of "true".

Identifies a software object as a patch. The default value is false. When set to true, a built-in category_tag attribute of value patch is automatically included.

The version of the IEEE Standard 1387.2 to which the HP-specific data_model_revision conforms. Possible values are 1.0 (the default value) or 0.8.

Defines the machine(s) on which the product will run. (If not specified, swpackage assigns a value of "*", meaning the product runs on all machines.) If there are multiple machine platforms, use wildcards or use the '|' character to separate them. This attribute should pattern match to the output of the model command on the supported target machine(s).

Defines the part or order number for the product.

Defines the operating system(s) on which the product will run. (If not specified, swpackage assigns a value of "*", meaning the product runs on all operating systems.) If there are multiple operating systems, use wildcards or use the '|' character to separate them. This attribute should pattern match to the value of

on the supported target system(s).

Defines the operating system release(s) on which the product will run. (If not specified, swpackage assigns a value of "*", meaning the product runs on all releases.) If there are multiple operating system releases, use wildcards or use the '|' character to separate them. This attribute should pattern match to the value of uname -r on the supported target system(s).

Defines the operating system version(s) on which the product will run. (If not specified, swpackage assigns a value of "*", meaning the product runs on all versions.) If there are multiple operating system versions, use wildcards or use the '|' character to separate them. This attribute should pattern match to the value of uname -v on the supported target system(s).

Defines a kernel build script to be executed when kernel filesets are loaded. (Kernel filesets have the is_kernel attribute set to true .) The default kernel script is /usr/sbin/mk_kernel. (See mk_kernel(1M) for more information.) The default script executes when the postkernel attribute is not specified. Only one kernel build script is allowed per product, and the script executes only once, even if defined for multiple filesets.

Defines the README information for the product or bundle; the value must be a pointer to the filename containing the text.

Defines the revision (release number, version number) of the product or bundle.

Defines the full name (one-line description) of the product or bundle.

Associates this product or bundle with the last defined vendor object, if that object has a matching tag attribute.

Ends the product or bundle specification. This keyword is optional.

Keyword that begins the subproduct specification.

Defines the identifier (short name) for the subproduct.

Defines the filesets or subproducts that make up a subproduct. (Subproducts can contain other subproducts.) The value is a whitespace separated list of fileset or subproduct tag values. In the PSF, fileset definitions are not contained within subproduct definitions. The contents keyword is used to assign filesets to subproducts.

Defines the multi-paragraph description of the subproduct; the value is either the text itself (within double-quotes) or a pointer to the filename containing the text.

Defines the full name (one-line description) of the subproduct.

Ends the subproduct specification. This keyword is optional.

Keyword that begins fileset specification.

Defines the identifier (short name) for the fileset.

Describes the target system(s) on which the fileset will run if filesets for multiple architecture are included in a single product. Provides a human-readable summary of the four uname(1) attributes which define the exact target system(s) the product supports. Many filesets do not include an architecture; only a product architecture need be defined.

A list of filesets that will match the current fileset when installed on a target system, if the match_target installation option is specified. Also determines the base to which a patch is applied.

A repeatable tag-based attribute identifying a set of categories of which the software object is a member. This is used as a selection mechanism and can be used independent of patches. The default value is an empty list or patch if the is_patch attribute is set to true.

Like vendor_tag, this attribute can be used as a pointer to a category object that contains additional information about the category (for example, a one-line title definition and a description of the category).

Note that the category tag patch is reserved. When is_patch is set to true, a built-in category_tag attribute of value patch is automatically included.

NOTE: You can only change the patch value by performing a swpackage operation or by using swmodify to change the value of the is_patch attribute.

Defines the multi-paragraph description of the fileset; the value is either the text itself (within double-quotes) or a pointer to the filename containing the text.

A space-separated list of strings specifies the list of dynamic_modules (DLKMs) packaged into the fileset. The dynamic modules themselves must be delivered to /stand/mod/. If the dynamic_module attribute is ommitted, no DLKMs may be delivered in the fileset.

When a dynamic module is packaged, it is customary to include a call to the control_util mod_systemfile in a postinstall script to link the module to the kernel. If a state of static is specified in the mod_sytemfile call, the attributes is_kernel and is_reboot must also be set to true. In addition, if a system reboot is needed to activate the module, the is_reboot attribute must be set to true.

A value of "true" defines the fileset as being a contributor to the operating system kernel; the target system(s) kernel build process will be invoked after the fileset is installed. If this attribute is not specified, swpackage assumes a default value of "false".

Defines whether the fileset can be installed into any directory, or whether it must be installed into a specific directory. If this attribute is not specified, swpackage assigns a value of true.

Identifies a software object as a patch. The default value is false. When set to true, a built-in category_tag attribute of value patch is automatically included.

A value of "true" declares that the fileset requires a system reboot after installation. If this attribute is not specified, swpackage assumes a default value of "false".

Indicates that a fileset contains only a subset of files in the base (ancestor) fileset and that the contents are to be merged with the base fileset. The default value is false. If the is_patch attribute is true, is_sparse is also set to true for the fileset, although it can be forced to false.

Defines the machine(s) on which the files will run if a fileset architecture has been defined. (If not specified, swpackage assigns a value of "*", meaning the files run on all machines.) If there are multiple machine platforms, use wildcards or use the '|' character to separate them. This attribute should pattern match the output of the model command on the supported target machine(s).

Defines the operating system(s) on which the files will run if a fileset architecture has been defined. (If not specified, swpackage assigns a value of "*", meaning the files run on all operating systems.) If there are multiple operating systems, use wildcards or use the '|' character to separate them. This attribute should pattern match to the value of

on the supported target system(s).

Defines the operating system release(s) on which the files will run. (If not specified, swpackage assigns a value of "*", meaning the files run on all releases.) If there are multiple operating system releases, use wildcards or use the '|' character to separate them. This attribute should pattern match to the value of uname -r on the supported target system(s).

Defines the operating system version(s) on which the files will run. (If not specified, swpackage assigns a value of "*", meaning the files runs on all versions.) If there are multiple operating system versions, use wildcards or use the '|' character to separate them. This attribute should pattern match to the value of uname -v on the supported target system(s).

Defines the revision (release number, version number) of the fileset.

Used when a patch is replaced by (or merged into) a later patch. The attribute indicates which previous patches are replaced by the patch being installed or copied. This attribute value is a list of software specifications of other patches that this patch "supersedes".

Defines the full name (one-line description) of the fileset.

Ends the fileset specification. This keyword is optional.

A list of software that must be installed before the current fileset can be installed.

A list of software that can be installed at the same time as the current fileset but must be present before the current fileset can be run.

A list of software that may not be installed before or at the same time the current fileset is installed.

Defines the installation check script executed by swinstall. This script is executed during the analysis of each target, and it checks that the installation can be attempted. If the product or fileset check script returns 1 (ERROR), the product or fileset (respectively) will not be installed. If it returns 11 (GLOBAL_ERROR), no products will be installed.

Defines the remove check script executed by swremove. This script is executed during the analysis of each target, and it checks that the remove can be attempted. If the check script returns 1 (ERROR), the product or fileset will not be removed.

Defines an arbitrary control file to be included with the product or fileset and stored alongside the named control files. It is used to include a subscript called by the named scripts or a data file read by these scripts. If the optional tag component of the value is not specified, swpackage uses the basename(1) of the source filename as the tag for the control file. Otherwise, the tag value is used.

Defines the configuration script executed by swinstall and swconfig. This script configures the target host for the product or fileset (and the product or fileset for any required information about the target host).

Defines the fix script run by swverify to correct and report problems on installed software. The fix script can create missing directories, correct file modifications (mode, owner, group, major, and minor), and recreate symbolic links.

Defines the installation post-load script executed by swinstall. A fileset script is executed immediately after the fileset files are loaded. A product script is executed after all filesets for that product have been installed.

Defines the post-remove script executed by swremove. A fileset script is executed immediately after the fileset files are removed. A product script is executed after all filesets for that product have been removed.

Defines the installation pre-load script executed by swinstall. A fileset script is executed immediately before the fileset files are loaded. A product script is executed before any filesets for that product have been installed.

Defines the pre-remove script executed by swremove. A fileset script is executed immediately before the fileset files are removed. A product script is executed before any filesets for that product have been removed.

The only script that may be interactive. This script may be run by swask, swinstall, or swconfig after selection and before the analysis phase in order to request information from the administrator that will be needed for the configure_script when that script is run later. The request_script writes all information into the response_file, which the scripts can then use.

A data file to define additional disk space requirements. See Space_Files for more information.

Defines the un-configuration script executed by swremove and swconfig. This script unconfigures the target host for the product or fileset, undoing the configuration performed by the configure script.

Defines the installation pre-restore script executed by swinstall. A fileset script is executed immediately before the fileset files are restored if there is an error and the autorecover_product option is set to true. Note that unpostinstall scripts are supported for filesets only. It should undo the steps taken by the postinstall script.

Defines the installation post-restore script executed by swinstall. A fileset script is executed immediately after the fileset files are restored if there is an error and the autorecover_product option is set to true. A product script is executed after all filesets for that product have been restored. It should undo the steps taken by the preinstall scripts.

Defines the verification script executed by swverify. This script verifies the configuration performed by the configure script.

Holds the path to the Installed Products Database (IPD), relative to the path in the SW_ROOT_DIRECTORY environment variable. Note that you can specify a path for the IPD using the installed_software_catalog default option.

Defines the current directory of the script being executed, either a temporary catalog directory, or a directory within in the Installed Products Database (IPD). This variable tells scripts where other control scripts for the software are located (e.g. subscripts).

Holds the tag name of the control_file being executed. When packaging software, you can define a physical name and path for a control file in a depot. This lets you define the control_file with a name other than its tag and lets you use multiple control file definitions to point to the same file. A control_file can query the SW_CONTROL_TAG variable to determine which tag is being executed.

Defines the location of the product, which may have been changed from the default product directory. When combined with the SW_ROOT_DIRECTORY, this variable tells scripts where the product files are located.

A PATH variable which defines a minimum set of commands available for use in a control script (e.g. /sbin:/usr/bin).

Defines the root directory in which the session is operating, either / or an alternate root directory. This variable tells control scripts the root directory in which the products are installed. A script must use this directory as a prefix to SW_LOCATION to locate the product's installed files. The configure script is only run when SW_ROOT_DIRECTORY is /.

Contains the pathname of a file containing the value of every option for a particular command, including software and target selections. This lets scripts retrieve any command options and values other than the ones provided explicitly by other environment variables. For example, when the file pointed to by SW_SESSIONS_OPTIONS is made available to a request script, the targets option contains a list of software_collection_specs for all targets specified for the command. When the file pointed to by SW_SESSIONS_OPTIONS is made available to other scripts, the targets option contains the single software_collection_spec for the targets on which the script is being executed.

This variable contains the fully qualified software specification of the current product or fileset. The software specification allows the product or fileset to be uniquely identified.

For some or all of the files and directories in the fileset, the user can define a default set of permissions.

The user can point swpackage at a source directory in which the fileset's files are located. In addition, the user can map this source directory to the appropriate (destination) directory in which this subset of the product's files will be located.

For some or all of the files and directories in the fileset, the user can name each source file and destination location.

If a directory mapping is active, the user can tell swpackage to include all files and directories in the fileset (recursively) below the specified directory.

Specifies an existing file or directory (perhaps within the currently active source directory) to include in the fileset.

Defines the relative or absolute path to the source file.

If this is a relative path, swpackage will search for it relative to the source directory set by the directory keyword. If no source directory is active, swpackage will search for it relative to the current working directory in which the command was invoked.

All attributes for the destination file object are taken from the source file, unless a file_permissions keyword is active, or the -m, -o, or -g, options are also included in the file specification.

Defines the destination path at which the file will be installed. If destination is a relative path, the active destination directory set by the directory keyword will be prefixed to it. If it is a relative path, and no destination directory is active, swpackage generates an error. If the destination is not specified, the source is used as the destination, with the appropriate mapping done with the active destination directory (if any).

Defines the (octal) mode of a file or directory.

Defines the destination file's owner name and/or or uid. If only the owner is specified, the owner and uid attributes are set for the destination file object, based on the packaging host's /etc/passwd. If only the uid is specified, it is set as the uid attribute for the destination object and no owner name is assigned. If both are specified, each sets the corresponding attribute for the file object. During an installation, the owner attribute is used to set the owner name and uid, unless the owner name is not defined in the target system's /etc/passwd. In this case, the uid attribute is used to set the uid.

Defines the destination file's group name and/or or gid. If only the group is specified, the group and gid attributes are set for the destination file object, based on the packaging host's /etc/group. If only the group is specified, and it contains digits only, it is interpreted as the gid, and is set as the gid attribute for the destination object; no group name is assigned to the object. If both are specified, each sets the corresponding attribute for the file object. During an installation, the group attribute is used to set the group name and gid, unless the group name is not defined in the target system's /etc/group. In this case, the gid attribute is used to set the gid.

Defines a file of type d (directory), h (hard link), or s (symbolic link). Caution, some releases of swpackage do not work correctly with -t type, see WARNINGS section for details.

Marks the file as volatile, meaning it can be modified (i.e. deleted) after installed without impacting the fileset.

Applies only to the fileset it is defined in. Multiple file_permissions can be specified, later definitions simply replace previous definitions.

Defines a default (octal) mode for all file objects.

Instead of specifying an octal mode as the default, the user can specify an octal umask(1) value which gets "subtracted" from an existing source file's mode to generate the mode of the destination file.

By specifying a umask, the user can set a default mode for executable files, non-executable files, and directories. (A specific mode can be set for any file, as described above.)

Defines the destination file's owner name and/or or uid (as defined above).

Defines the destination file's group name and/or or gid (as defined above).

Defines the destination file's type (as defined above). Caution, some releases of swpackage do not work correctly with -t type, see WARNINGS section for details.