swpackage.4 (2010 09)

ManualsBrandsHP ManualsSoftwareHP-UX Manpages

swpackage(4) swpackage(4)

NAME

swpackage - product speciﬁcation ﬁle (PSF) format

DESCRIPTION

Introduction

The

swpackage command packages software into:

• a distribution directory (which can be accessed directly or copied onto a CD-ROM),

• a distribution tape, such as DDS, nine-track or cartridge tapes.

Both directory and tape distributions use the same format. SD can read both

tar and cpio tape

depots. See sd(4) for details on tape format.

The software is organized into a four-level hierarchy of software objects: bundles, products, subpro-

ducts, and ﬁlesets. Bundles and subproducts are recursive: a bundle can contain other bundles, and a

subproduct can contain other subproducts. The ﬁles that make up a software package are contained in

ﬁlesets. Filesets are contained in subproducts and/or products. Currently, HP does not support customer

creation of software bundles to contain the entire application. The attribute tables that follow show the

attributes of each level of the software packaging hierarchy.

A Product Speciﬁcation File (PSF) deﬁnes how a product is structured and the attributes that apply to

it. This manual page describes the syntax and semantics of a PSF.

Layout Version

SD object and attribute syntax conforms to the layout_version 1.0 speciﬁcation of the IEEE POSIX 1387.2

Software Administration standard. The previous SD layout_version 0.8 is also supported. SD for HP-UX

version 10.10 and later can read or write either layout version. SD commands still accept the keyword

names associated with the older layout version, but you should use layout_version 0.8 only to create dis-

tributions readable by older versions of SD.

What layout_version the SD commands write is controlled by the

layout_version option for

swpackage, swmodify, swcopy, and swlist.

The version used by

swpackage can be also controlled by specifying the layout_version attribute in the

PSF. However, if the layout_version attribute in the PSF is 1.0, the is_locatable attribute defaults to true

in all cases, and must be explicitly set to false.

For a full description of the

swpackage command, see the swpackage (1M) manual page.

Layout version 1.0 adds signiﬁcant functionality not recognized by systems supporting only 0.8, including:

• Category class objects (formerly the

category and category_title

attributes within the

bundle or product class).

• Patch-handling attributes, including

applied_patches, is_patch, and patch_state.

• The ﬁleset

architecture attribute, which permits you to specify the architecture of the tar-

get system on which the product will run.

In addition to adding new attributes and objects, layout_version 1.0 changes the following preexisting 0.8

objects and attributes as follows:

• Replaces the depot

media_sequence_number with the media object with a

sequence_number attribute.

• Replaces the

vendor deﬁnition within products and bundles with a vendor_tag attribute and

a corresponding vendor object deﬁned outside the product or bundle.

• Pluralizes the

corequisite and prerequisite ﬁleset attributes (to corequisites and

prerequisites).

• Changes the

timestamp attribute to mod_time.

HP-UX 11i Version 3: September 2010 − 1 − Hewlett-Packard Company 1

Summary of content (26 pages)

PAGE 1
swpackage(4) swpackage(4) NAME swpackage - product specification file (PSF) format DESCRIPTION Introduction The swpackage command packages software into: • a distribution directory (which can be accessed directly or copied onto a CD-ROM), • a distribution tape, such as DDS, nine-track or cartridge tapes. Both directory and tape distributions use the same format. SD can read both tar and cpio tape depots. See sd(4) for details on tape format.
PAGE 2
swpackage(4) swpackage(4) PRODUCT SPECIFICATION FILE SYNTAX A PSF is structured as follows: [] [] [] [] ... [] [] [] [] ... [] [] ...
PAGE 3
swpackage(4) • swpackage(4) Use double quotes (") to define values that span multiple lines: "This is an example of a two-line value." • Double quotes (") are optional when defining a value that contains embedded whitespace. Attribute Table The following tables summarize the objects and attributes which can be defined in a PSF. These objects and attributes can appear in any order when defining a distribution, vendor, category, product, or bundle, except that the layout_version attribute must be first.
PAGE 4
swpackage(4) swpackage(4) Attribute Table (continued) Keyword product * tag * architecture category_tag contents copyright description directory is_locatable is_patch layout_version machine_type number os_name os_release os_version postkernel readme revision title * vendor_tag control_files end subproduct tag contents description title end A Type Size Example tag_string one_line_string 64 64 one_line_string repeatable list multi_line_string multi_line_string path_string boolean boolean revision_str
PAGE 5
swpackage(4) swpackage(4) Attribute Table (continued) Keyword fileset * tag ancestor Type Size Example 64 architecture tag_string repeatable list of product.fileset one_line_string category_tag corequisites description dynamic_module exrequisite is_kernel is_locatable is_patch is_reboot is_sparse machine_type tag_string software_spec multi_line_string one_line_string software_spec boolean boolean boolean boolean boolean uname_string commands product.oldfileset oldproduct.fileset HP-UX_B.11.
PAGE 6
swpackage(4) swpackage(4) The keyword is a filename character string. The value associated with a keyword is processed as an attribute_value. It can be continued across multiple input lines or can reference a file containing the value for the keyword. Vendor-defined attributes are noted during packaging or when modified with swmodify. These attributes can be listed with swlist. As always, use caution in constructing your Product Specification File.
PAGE 7
swpackage(4) swpackage(4) Examples: /mfg/sd/files/usr = /usr A value of the form: ‘‘source [=destination ]’’ where the source defines the directory in which subsequently defined files are located. The optional destination maps the source to a destination directory in which the files will actually be installed.
PAGE 8
swpackage(4) swpackage(4) [,fr revision ][,fa arch ] • location applies only to installed software and refers to software installed to a location other than the default product directory. • fr and fa apply only to filesets. • r , a , v , c , and l apply only to bundles and products. They are applied to the leftmost bundle or product in a software specification.
PAGE 9
swpackage(4) swpackage(4) end distribution or depot 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. layout_version 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. tag Defines the identifier (short name) for the distribution depot or tape.
PAGE 10
swpackage(4) swpackage(4) Category Specification The following is an example of a category specification. category tag title description revision end category Keyword that begins the category specification. tag Defines the identifier (short name) for the category. title Defines the full name (one line description) for the category. description A more detailed description of the category.
PAGE 11
swpackage(4) swpackage(4) Product Specifications The following are examples of a product specification: Products are assumed to be locatable unless they explicitly define the is_locatable attribute to false. Non-locatable products must define this attribute. product tag architecture category_tag contents copyright description directory is_locatable is_patch layout_version machine_type number os_name os_release os_version postkernel readme revision title vendor_tag SD HP-UX_B.11.
PAGE 12
swpackage(4) swpackage(4) ... end Each keyword defines an attribute of a product or bundle object. For each product specified, swpackage requires only the product and tag keywords, plus one or more contained fileset definitions. For each bundle specified, swpackage requires the bundle, tag, and contents keywords. product Required keyword that begins the product specification. tag Defines the identifier (short name) for the product or bundle.
PAGE 13
swpackage(4) swpackage(4) match to the output of the model command on the supported target machine(s). number Defines the part or order number for the product. os_name 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.
PAGE 14
swpackage(4) swpackage(4) contents 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.
PAGE 15
swpackage(4) swpackage(4) [ ] end Each keyword defines an attribute of a fileset object. For each fileset specified, swpackage requires the fileset and tag keywords, plus zero or more file specifications. You can define additional disk space requirements for the fileset using a space control_file. (See the Control Script Specification section for more information.) fileset Keyword that begins fileset specification. tag Defines the identifier (short name) for the fileset.
PAGE 16
swpackage(4) swpackage(4) is_reboot 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". is_sparse 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.
PAGE 17
swpackage(4) swpackage(4) The following is an example of a dependency specification: corequisites ... prerequisites ... exrequisites ... SD.data productA,r>=2.1 productB,r>=2.1 Each keyword/value defines a dependency relationship on another software object. The object can be within the same product as the dependent fileset, or it can be within another product. Multiple dependency specifications are allowed. You can use them to define AND relationships between the dependencies.
PAGE 18
swpackage(4) swpackage(4) control_file • scripts/script2=configure You can define the physical name of a control script in a depot. This lets you define a control file with a filename different than its tag, lets multiple control scripts point at the same file, and lets a single script contain steps for all scripts. (The SW_CONTROL_TAG environment variable tells the script which tag is being executed.
PAGE 19
swpackage(4) swpackage(4) space file A data file to define additional disk space requirements. See Space_Files for more information. unconfigure 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. unpostinstall Defines the installation pre-restore script executed by swinstall.
PAGE 20
swpackage(4) swpackage(4) Environment Variables for Scripts The following environment variables affect scripts: SW_CATALOG 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.
PAGE 21
swpackage(4) swpackage(4) 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. Explicit file specification For some or all of the files and directories in the fileset, the user can name each source file and destination location.
PAGE 22
swpackage(4) swpackage(4) 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. destination 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.
PAGE 23
swpackage(4) swpackage(4) Default Permission Specification By default, a destination file object will inherit the mode, owner, and group of the source file. The file_permissions keyword can be specified to set a default permission umask/mode, owner, and group for all the files being packaged into the fileset. This includes files specified by -t that do not exist before packaging. (See the EXAMPLES section for sample permission specifications.
PAGE 24
swpackage(4) swpackage(4) # Product definition: product tag SD revision B.01.00 architecture HP-UX_B.11.23_IA/PA vendor_tag HP title number category_tag HP Software Distributor B2001A system_mgt description copyright readme < data/descr.sd < data/copyr.sd < data/README.sd machine_type os_name os_release os_version * HP-UX ?.11.* ? directory is_locatable / false # Create a product script which executes during the swremove # analysis phase.
PAGE 25
swpackage(4) swpackage(4) ... end # commands ... # other filesets fileset tag title revision directory file ./man/man1m=/usr/man/man1m.Z * directory file ./man/man4=/usr/man/man4.Z * directory file ./man/man5=/usr/man/man5.Z * end end man Manual pages for the Software Distributor 2.05 # man # SD Example File Specifications The following examples illustrate the use of the directory and file keywords: Include all files under ./commands/, to be rooted under /usr/sbin/: directory .
PAGE 26
swpackage(4) swpackage(4) Set a read only 444 mode for all file objects (requires override for every executable file and directory): file_permissions -m 444 Set a read mode for non-executable files, and a read/execute mode for executable files and for directories: file_permissions -u 222 Set the same mode defaults, plus an owner and group: file_permissions -u 222 -o bin -g bin Set the same mode defaults, plus a uid and gid: file_permissions -u 222 -o 2 -g 2 Set the same mode defaults, plus