POLYCENTER Software Installation Utility Developer's Guide

Updated: 11 December 1998

POLYCENTER Software Installation Utility Developer's Guide

Contents

Index

patch image (VAX only)

The patch image statement updates an executable image.

Syntax

patch image name with source ;

Parameters

name
Indicates the relative file specification of the executable image you want to update.
with source
Indicates the file specification of the file containing the update commands. The file that contains the update commands should contain OpenVMS VAX Image File Patch Utility (PATCH) commands.

Description

The patch image statement updates an executable image. Use this statement when it is inconvenient to provide a new image.
You must supply the file containing the update commands as part of the product material.
The patch image statement specifies a maintenance managed object that has the following characteristics:

Its name is the same as the name parameter of the product group in which the statement is lexically contained; it is a multicomponent name qualified by the relative file specification of the file that is being updated. It must be unique with respect to all maintenance managed objects in all scopes.
It has assembly lifetime, and its scope is the same as that of the file being updated.
Managed object conflict is unrecoverable.

Example


patch image [SYS$LDR]SYS.EXE with [SYSUPD]VERSION_PATCH.PAT ;

This statement provides a file, [SYSUPD]VERSION_PATCH.PAT, to patch the image [SYS$LDR]SYS.EXE.

patch text

The patch text statement updates a text file.

Syntax

patch text name with source ;

Parameters

name
Indicates the relative file specification of the text file you want to update.
with source
Indicates the file specification of the file containing the update commands (as a single quoted or unquoted string). The file that contains the update commands should contain SUMSLP commands.

Description

The patch text statement updates a text file. Use this statement when it is inconvenient to provide a new file.
You must supply the file containing the update commands as part of the product material. You must also supply the file that you want to update, but this file is not propagated to the reference copy. The POLYCENTER Software Installation utility uses it to calculate the input and output checksum values.
The patch text statement creates a temporary directory, identified by the logical name PCSI$SCRATCH, to compute a checksum value. The PCSI$SCRATCH directory is created as a subdirectory of SYS$SCRATCH.
The patch text statement specifies a maintenance managed object that has the following characteristics:

Its name is the same as the name parameter of the product group in which the statement is lexically contained; it is a multicomponent name qualified by the relative file specification of the file that is being updated. It must be unique with respect to all maintenance managed objects in all scopes.
It has assembly lifetime, and its scope is the same as that of the file being updated.
Managed object conflict is unrecoverable.

Example


patch text [SYSUPD]VMSINSTAL.COM with [SYSUPD]VMSINSTAL.SLP ;

This statement provides a file, [SYSUPD]VMSINSTAL.SLP, to patch the text file [SYSUPD]VMSINSTAL.COM.

process parameter

The process parameter statement displays a message to users about process parameter requirements.

Note
The utility does not adjust process parameters.

Syntax

process parameter name
{ { consume | require } value |
maximum value |
minimum value |
minimum value maximum value } ;

Parameter

name
Indicates the process parameter name. The name you specify must be valid on the system where the product executes.

Options

consume value
Indicates that the process parameter must be increased by the specified value. Use this option when the product consumes a resource that is controlled by the process parameter. The value must be a single unquoted string that specifies an unsigned integer value. You cannot use this option with either the maximum, minimum, or require options.
maximum value
Indicates that the process parameter must have a value less than or equal to the specified value. The value must be a single unquoted string that specifies an integer value.
minimum value
Indicates that the process parameter must have a value greater than or equal to the specified value. The value must be a single unquoted string that specifies an integer value.
require value
Indicates that the process parameter must have the specified value. The value must be a single string that specifies a value of the parameter's type. This option is valid for any parameter data type. You cannot use this option with either the maximum, minimum, or consume options.

Description

The process parameter statement displays a message to users after the installation about process parameter requirements. Note that the utility does not adjust process parameters.

Example


process parameter ASTLM minimum 6; process parameter BYTLM require 32768; process parameter PRCLM consume 2; process parameter FILLM maximum 40;

These statements display a message to users that a process that executes the product must have the following process parameters:

ASTLM greater than or equal to 6
BYTLM set to 32768
PRCLM increased by 2
FILLM less than or equal to 40

process privilege

The process privilege statement displays a message to users about process privilege requirements.

Note
The utility does not adjust process privileges.

Syntax

process privilege (name [,...]) ;

Parameter

name
Indicates the process privilege names as a list. The privileges you specify must be valid on the system where the product executes.

Description

The process privilege statement displays a message to users after the installation about process privilege requirements. Note that the utility does not adjust process privileges.

Example


process privilege (group, oper, tmpmbx, sysnam) ;

The statement in this example displays a message to the user that processes using the product must have the GROUP, OPER, TMPMBX, and SYSNAM privileges.

product

The product statement specifies product identification and other descriptive information about the product. The product and end product statements form the product group.

Syntax

product producer base name version type ;

[ PDL-statements ]

end product ;

Parameters

producer
Indicates the legal owner of the software product. This parameter must be a single quoted or unquoted string.
base
Indicates the base hardware/software system on which the product is intended to be installed. This parameter must be a single quoted or unquoted string. By convention, the string AXPVMS denotes an OpenVMS Alpha product, VAXVMS denotes an OpenVMS VAX product, and VMS denotes a product applicable for either OpenVMS Alpha or VAX.
Although any base system name can be used when you package a product, Compaq recommends that you use the names AXPVMS, VAXVMS, and VMS when developing products for use on OpenVMS.
name
Indicates the name of the product. This parameter must be a single quoted or unquoted string. The combination of producer, base, and name parameters must be unique among products installed on the system.
version
Indicates the version of the product. This parameter must be a single quoted or unquoted string.
type
Indicates the kit type of the product through use of one of the following keywords or keyword phrases:

full. A complete description of a layered product (application software) that can be used to install or upgrade the product.
operating system. A complete description of an operating system that can be used to install or upgrade the product. Only one product of operating system type can be installed on the system.
partial. A partial (incomplete) description of a product that can be used only to upgrade an existing version of the same product. Installation of a partial kit changes the version number of the product and can upgrade a product of type: full, operating system, or platform. A partial kit must contain an upgrade statement and have the same producer-base-name identification string as the product it upgrades.
patch. A partial (incomplete) description of a product that can be used only to update an existing version of a product. Installation of a patch kit does not change the version number of the product and can update a product of type: full, operating system, or platform. A patch kit must contain an apply to statement and have a different producer-base-name identification string than the product it updates.
platform. A complete description of a suite of products that can be used to install or upgrade the entire set of products.
transition. A complete or incomplete description of a product that was installed on the system by another installation method such as VMSINSTAL. A transition kit is used only to register a previously installed product; it does not contain any product material. Registration using a transition kit defines the name of a product and its managed objects in the POLYCENTER Software Installation product database. After a product is registered, the utility can use this information to satisfy software dependency requirements that other products may have on the availability of this product.
The keyword transition used alone denotes a layered product; the keyword phrase transition operating system denotes an operating system.
mandatory update. This is functionally identical to a patch kit. Its type implies that the patch must be applied to the product it updates. See Section 3.5 for a more detailed description of kit types and example PDFs.

Option

PDL-statements
Any product description language statement or a group of statements described in this reference section, except the product and end product statements.

Required Terminator end product ;

Description

The product statement is a utility directive that specifies the product identification and other descriptive information about the product. It does not specify a managed object. There can be only one product...end product statement for a given product description file.

See Also apply to
software
upgrade

Examples

#1
product DEC VAXVMS FMS V2.4 full ; file [sysmsg]fdvshr.exe image library ; file [sysmsg]fmsmsg.exe ; file [sysexe]fmsfed.exe ; file [sysexe]fmsfaa.exe ; file [sysexe]fmsfte.exe ; directory [systest.fms] ; file [systest.fms]ivp.exe ; file [systest.fms]samp.flb ; end product ;

product DEC VAXVMS FMS V2.4 full ; 
    file [sysmsg]fdvshr.exe image library ; 
    file [sysmsg]fmsmsg.exe ; 
    file [sysexe]fmsfed.exe ; 
    file [sysexe]fmsfaa.exe ; 
    file [sysexe]fmsfte.exe ; 
    directory [systest.fms] ; 
    file [systest.fms]ivp.exe ; 
    file [systest.fms]samp.flb ; 
end product ;

The product statement in this example identifies the product as FMS version 2.4 that is intended to be installed on an OpenVMS VAX system.

#2
product DEC AXPVMS INTERNET_PRODUCTS V1.1 platform ;

The product statement in this example identifies INTERNET_PRODUCTS version 1.1 as a suite of products (that is, a platform) for installation on an OpenVMS Alpha system.

register module

The register module statement registers in the product database one or more existing modules in a command, help, macro, object, or text library file.

Syntax

register module type type module (module _name,...)
[ [no] generation generation ]
[ library library ] ;

Parameters

type type
Indicates the library type. Table 7-5 lists the keywords you can use with this parameter.

Table 7-5 Library Types for Register Module Statement
Keyword Library Type Default Library File

Command Command definition library [SYSLIB]DCLTABLES.EXE

Help Help library [SYSHLP]HELPLIB.HLB

Macro Macro library [SYSLIB]STARLET.MLB

Object Object library [SYSLIB]STARLET.OLB

Text Text library [SYSLIB]STARLETSD.TLB

module module_name
Indicates the names of the modules contained within the library.

**Table 7-5 Library Types for Register Module Statement**
Keyword	Library Type	Default Library File
Command	Command definition library	[SYSLIB]DCLTABLES.EXE
Help	Help library	[SYSHLP]HELPLIB.HLB
Macro	Macro library	[SYSLIB]STARLET.MLB
Object	Object library	[SYSLIB]STARLET.OLB
Text	Text library	[SYSLIB]STARLETSD.TLB

Options

[no] generation generation
Indicates that the module has an explicit generation number. Enter the number as an unsigned integer in the range of 0 through 4294967295. Refer to the Description section of the module statement for the meaning of this value. By default, the module does not have an explicit generation number (no generation), which is equivalent to zero.
library library
The file specification of the library. The file you use must be a library of the type you specified with the type parameter.

Description

The register module statement registers in the product database one or more existing modules in a command, help, macro, object, or text library file. Typically, register module statements are used when a product provides a library file with a file statement that is already populated with modules. Registering these modules in the product database allows the utility to detect conflicts with other modules. In contrast, module statements automatically register their modules. When you populate a library using module statements, you do not need to use register module statements to register the information.

Examples

#1
register module type HELP module (":=","=","@",ACCOUNTING,ALLOCATE,ANALYZE,APPEND,...) ;

In this example, the register module statement registers several help modules in [SYSHLP]HELPLIB.HLB.

#2
register module type OBJECT generation 1 module (BAS$$CB,BAS$$COPY_FD,BAS$$DISPATCH_T,...) ;

In this example, the register module statement registers several object modules. The generation option allows the utility to perform conflict resolution with these object modules.

remove

The remove statement removes managed objects from the product database and the system. The remove and end remove statements form a remove group.

Note
You cannot use the remove statement in a transition PDF.

Syntax

remove ;

[ PDL-statements ]

end remove ;

Option

PDL-statements
Any product description language statement or a group of statements described in this reference section, except the product and end product statements.

Required Terminator end remove ;

Description

The remove statement allows you to remove managed objects from the product database and from the system. Statements that normally provide managed objects (for example, the file statement) remove managed objects when contained within remove, end remove.
By using the remove statement in a partial, patch, or mandatory update kit, you can eliminate obsolete files from a previous version of your product. By using the remove statement in a full kit, you can eliminate objects provided by a previous installation mechanism (for example, VMSINSTAL).
Statements that do not provide managed objects function normally within remove, end remove.
You can nest remove, end remove within scope, end scope, if necessary.

Examples

#1
remove ; directory [SYSHLP.EXAMPLES.FOO] ; file [SYSHLP.EXAMPLES.FOO]SMLUS.COM ; file [SYSHLP.EXAMPLES.FOO]SMLUT.COM ; file [SYSHLP.EXAMPLES.FOO]SMLUU.COM ; end remove ;

The statements in this example remove some files and a directory (if they exist) from the product database and the running system.

#2
scope bootstrap ; remove ; file [SYSEXE]PROD_PROC.EXE ; end remove ; file [SYSEXE]PROD_PROC_V2.EXE ; end scope ;

The statements in this example remove a file in the bootstrap scope and then provide a new file.

rights identifier

The rights identifier statement uses a command procedure to create a rights identifier.

Syntax

rights identifier name with (parameters,...) ;

Parameters

name
Indicates the name of the rights identifier. The rights identifier name is passed to the command procedure as P1.
with (parameters,...)
Indicates the list of parameters that are passed to the command procedure that creates the rights identifier. Each parameter must be a single quoted string that specifies P2 and P3, in order. Refer to the Description section for the meaning of the parameters.

Description

The rights identifier statement invokes a command procedure (SYS$UPDATE:PCSI$CREATE_RIGHTS_IDENTIFIER.COM) to create rights identifiers. This command procedure runs the AUTHORIZE utility to perform the function. The utility passes the following parameters to the command procedure:

P1 specifies the name of the rights identifier (using the name parameter).
P2 specifies the optional qualifiers to use with the AUTHORIZE command ADD/IDENTIFIER.
P3 specifies the /VALUE qualifier to use with the AUTHORIZE command ADD/IDENTIFIER. You can specify this parameter only if the identifier does not already exist on the system.

When you remove a product that created rights identifiers, the POLYCENTER Software Installation utility uses a command procedure (SYS$UPDATE:PCSI$DELETE_RIGHTS_IDENTIFIER.COM) to delete rights identifiers associated with your product.

Note
In a future version, the utility may create and delete these managed objects directly without the use of command procedures. If this is the case, these statements will continue to function, but the command procedures may not be maintained or shipped with future versions of the utility.

The rights identifier statement specifies a rights identifier managed object that has the following characteristics:

Its name is the value of the name parameter. The name must be unique with respect to all rights identifier names in the operating scope.
It has operating lifetime.
Managed object conflict is not recoverable.

Example


rights identifier PCSI_TEST with ("/attributes=DYNAMIC", "/value=IDENTIFIER:14600926") ;

In this example, the rights identifier statement creates a rights identifier named PCSI_TEST with a value of 14600926.

Contents

Index

Legal

 
5952PRO_011.HTML

POLYCENTER Software Installation Utility Developer's Guide

patch image (VAX only)

Syntax

patch image name with source ;

Parameters

name

with source

Description

Example

patch text

Syntax

patch text name with source ;

Parameters

name

with source

Description

Example

process parameter

Syntax

process parameter name { { consume | require } value | maximum value | minimum value | minimum value maximum value } ;

Parameter

name

Options

consume value

maximum value

minimum value

require value

Description

Example

process privilege

Syntax

process privilege (name [,...]) ;

Parameter

name

Description

Example

product

Syntax

product producer base name version type ;

[ PDL-statements ]

end product ;

Parameters

producer

base

name

version

type

Option

PDL-statements

Description

Examples

register module

Syntax

register module type type module (module _name,...) [ [no] generation generation ] [ library library ] ;

Parameters

type type

module module_name

Options

[no] generation generation

library library

Description

Examples

remove

Syntax

remove ;

[ PDL-statements ]

end remove ;

Option

PDL-statements

Description

Examples

rights identifier

Syntax

rights identifier name with (parameters,...) ;

Parameters

name

with (parameters,...)

Description

Example

process parameter name
{ { consume | require } value |
maximum value |
minimum value |
minimum value maximum value } ;

register module type type module (module _name,...)
[ [no] generation generation ]
[ library library ] ;