|
POLYCENTER Software Installation Utility Developer's
Guide
execute install...remove
The execute install...remove statement is a compound statement
that performs two distinct actions:
- The "install" portion specifies commands to execute when the
product is installed or reconfigured.
- The "remove" portion specifies commands to execute when the product
is removed, but not when the product is upgraded.
Note
The remove part of the statement is required syntax even if
there are no commands you want to execute when the product is removed.
To indicate no command, use
remove ""
.
|
Syntax
execute install (command,...) remove (command,...) [
interactive ] [ uses
(file,...)] ;
Parameter
(command,...)
Indicates the commands that the utility passes to the command
interpreter in the execution environment.
Option
interactive
Allows communication between the user and specified command or commands
executing in a subprocess.
uses (file,...)
Indicates the files required to execute the commands you specified in
the command parameter. Use a separate file statement
to specify required files that are permanently placed in the user's
destination directory tree; use the uses option to
specify required files that are placed in a temporary directory and
deleted after use. By default, this statement does not require files.
Description
The execute install...remove statement is a compound statement
consisting of an "install" portion and a "remove" portion.
The install portion specifies commands to execute when the product is
installed or reconfigured. These commands are run after all product
material has been placed on the target disk (that is, after all
directory, file, and module statements have
been processed).
The remove portion specifies commands to execute when the product is
removed. These commands are run before any product material is deleted
from the target disk. The execute ...remove statement has no
effect when the product is upgraded. To execute commands when the
product is upgraded by another version of the product, use the
execute upgrade statement.
Note
Previous versions of this manual incorrectly stated that execute
install...remove commands are also run when the product is
upgraded.
|
You specify the install and remove actions to perform by including one
or more DCL command lines in the execute install...remove
statement. These commands are passed for execution to the DCL
interpreter running in a subprocess. Enclose each action, whether
specified as a single DCL command or a command procedure, in double
quotes (" "). If more than one action is given, use parentheses to
enclose the list.
If you want your commands to prompt the user and accept the user's
input, specify the execute install...remove statement with the
interactive option. The interactive
option causes all output from DCL to be displayed, unless you prevent
it. In contrast, when the interactive option is not
specified, output generated by DCL commands is displayed only for lines
that are interpreted as DCL messages, that is, those beginning with a
percent sign (%) in column one.
If you need files for the execute install statement, specify
them in the uses option or in separate file
statements. However, if you need files for the execute remove
statement, you must provide them with file statements so that
they are available on the user's system for use when the product is
removed. Each file you specify with the uses option
must be present in the product material.
Note that the uses option will not cause the listed
files to be placed permanently in your file system. As soon as the
installation operation completes, the files listed with the
uses option are deleted. For this reason, you must use
the file statement for this execute operation, and any other
operation, in which you want your execute command procedures placed
permanently in your file system.
The execute install...remove statement causes the utility to
define logical names for use by the subprocess that executes the
specified commands. The commands should use these logical names to
reference files, as follows:
- PCSI$SOURCE is a subdirectory in the root format under the user's
login directory that points to the location of the files specified by
the uses option. This logical name is defined for the
subprocess in which product-supplied commands execute. It is not the
same PCSI$SOURCE logical name that can be defined by a user, in the
user's process, pointing to the location of a product kit.
Note
The PCSI$SOURCE logical name is available only for the execute
install operation. You cannot use it for an execute
remove operation.
|
- PCSI$DESTINATION is a root directory specification that points to
the root directory for the current scope where product material will be
placed.
- PCSI$SCRATCH is a subdirectory under the user's login directory
that can be used by commands for temporary working space. This
directory and any files placed in it are automatically deleted at the
end of the operation.
The execute install...remove statement is a utility directive
and does not specify a managed object.
See Also Section 6.1
file
Example
|
file [SYSUPD]UNLOAD_LOADABLE_IMAGE.COM ;
execute
install "@PCSI$SOURCE:[SYSUPD]LOAD_LOADABLE_IMAGE.COM"
remove "@PCSI$DESTINATION:[SYSUPD]UNLOAD_LOADABLE_IMAGE.COM"
uses ([SYSUPD]LOAD_LOADABLE_IMAGE.COM) ;
|
In this example, the execute install...remove statement sets
up command procedures to run when the product is installed and removed.
The uses option specifies the file name of the command
procedure for use on installation of the product. The file is deleted
after use. The file statement specifies the file name of the
command procedure for use on removal of the product. This file is
placed in the user's destination directory tree during installation and
executed during removal.
execute login
The execute login statement displays a message when the
product is installed or reconfigured, informing the installer that the
specified commands need to be added to the login command procedure of
every user of this product.
Syntax
execute login (command,...) ;
Parameter
(command,...)
Indicates the commands that the utility displays in a message to the
user.
Description
The execute login statement displays a message when the
product is installed or reconfigured, advising the installer that the
specified commands need to be added to the login command procedure of
every user of this product. The specified commands are not run during
the installation or reconfiguration operation. The message is displayed
after the operation has completed successfully.
The execute login statement is a utility directive and does
not specify a managed object.
See Also Section 6.1
Example
|
execute login "$ @USER_START" ;
|
In this example, the execute login statement displays the
following message to users:
|
Users of this product require the following lines in their login procedure:
$ @USER_START
|
execute postinstall
The execute postinstall statement specifies commands to
execute when the product is installed or reconfigured. These commands
are run after any commands from execute install... and
execute start... statements are run.
Syntax
execute postinstall (command,...) [
interactive ] [ uses
(file,...) ] ;
Parameter
(command,...)
Indicates the command that the utility passes to the command
interpreter in the execution environment.
Option
interactive
Allows communication between the user and specified command or command
procedure executing in a subprocess.
uses (file,...)
Indicates the files required to execute the commands you specified in
the command parameter. Use a separate file statement
to specify required files that are permanently placed in the user's
destination directory tree; use the uses option to
specify required files that are placed in a temporary directory and
deleted after use. By default, this statement does not require files.
Description
The execute postinstall statement specifies commands to
execute when the product is installed or reconfigured. These commands
are run after any commands from execute install... and
execute start... statements are run.
You specify actions to perform by including one or more DCL command
lines in the execute postinstall statement. These commands are
passed for execution to the DCL interpreter running in a subprocess.
Enclose each action, whether specified as a single DCL command or a
command procedure, in double
quotes (" "). If more than one action is given, use parentheses to
enclose the list.
If you want your commands to prompt the user and accept the user's
input, specify the execute postinstall statement with the
interactive option. The interactive
option causes all output from DCL to be displayed, unless you prevent
it. In contrast, when the interactive option is not
specified, output generated by DCL commands is displayed only for lines
that are interpreted as DCL messages, that is, those beginning with a
percent sign (%) in column one.
If you need files for the execute postinstall statement,
specify them in the uses option or in separate
file statements. Each file you specify with the
uses option must be present in the product material.
Note that the uses option will not cause the listed
files to be placed permanently in your file system. As soon as the
installation operation completes, the files listed with the
uses option are deleted. For this reason, you must use
the file statement for this execute operation, and any other
operation, in which you want your execute command procedures placed
permanently in your file system.
The execute postinstall statement causes the POLYCENTER
Software Installation utility to define logical names for use by the
subprocess that executes the specified commands. The commands should
use these logical names to reference files, as follows:
- PCSI$SOURCE is a subdirectory in the root format under the user's
login directory that points to the location of the files specified by
the uses option. This logical name is defined for the
subprocess in which product-supplied commands execute. It is not the
same PCSI$SOURCE logical name that can be defined by a user, in the
user's process, pointing to the location of a product kit.
- PCSI$DESTINATION is a root directory specification that points to
the root directory for the current scope where product material will be
placed.
- PCSI$SCRATCH is a subdirectory under the user's login directory
that can be used by commands for temporary working space. This
directory and any files placed in it are automatically deleted at the
end of the operation.
The execute postinstall statement is a utility directive and
does not specify a managed object.
See Also Section 6.1
file
Example
|
execute
postinstall "@pcsi$source:[sysupd]product_cleanup.com"
uses [sysupd]product_cleanup.com ;
|
In this example, the execute postinstall statement sets up a
command procedure to run after the product is installed. The
uses option specifies the file name of the command
procedure that is deleted after use.
execute preconfigure
The execute preconfigure statement specifies commands to
execute after the user has selected the product for installation or
reconfiguration, but before the user is asked to select options for the
product.
Syntax
execute preconfigure (command,...) [
interactive ] [ uses
(file,...) ] ;
Parameter
(command,...)
Indicates the commands that the utility passes to the command
interpreter in the preconfiguration environment.
Option
interactive
Allows communication between the user and specified command or commands
executing in a subprocess.
uses (file,...)
Indicates the files required to execute the commands you specified in
the command parameter. Files for the execute
preconfigure statement cannot be supplied by a separate
file statement because execute preconfigure is
processed before files are copied to the target disk.
Description
The execute preconfigure statement specifies commands to
execute after the user has selected the product for installation or
reconfiguration, but before the user is asked to select options for the
product. This statement is useful for automatically running a command
procedure in preparation for installing your product. This command
procedure is packaged in the kit and is run before the standard
configuration dialog with the user begins. The execute
preconfigure statement gives you the ability to do such things as
probe the system environment, ask the user questions, and define
logical names for use later in the processing of logical name
functions. The ability to conditionally provide product material, or to
perform other actions based on decisions made at the very start of the
operation, is a powerful and flexible mechanism.
Note
If you want to use logical name functions, the logical names
must be either defined by the action of execute preconfigure
statements, or by the user before the installation or reconfiguration
operation is initiated.
|
You specify actions to perform by including one or more DCL command
lines in the execute preconfigure statement. These commands
are passed for execution to the DCL interpreter running in a
subprocess. Enclose each action, whether specified as a single DCL
command or a command procedure, in double
quotes (" "). If more than one action is given, use parentheses to
enclose the list.
Enclosing the execute preconfigure statement in a scope group
(consisting of scope and end scope statements) has no
effect on the way execute preconfigure commands are processed.
If you want your commands to prompt the user and accept the user's
input, specify the execute preconfigure statement with the
interactive option. The interactive
option causes all output from DCL to be displayed, unless you prevent
it. In contrast, when the interactive option is not
specified, output generated by DCL commands is displayed only for lines
that are interpreted as DCL messages, that is, those beginning with a
percent sign (%) in column one.
If you need files for the execute preconfigure statement,
specify them in the uses option. Each file you specify
with the uses option must be present in the product
material.
Note that the uses option will not cause the listed
files to be placed permanently in your file system. As soon as the
installation operation completes, the files listed with the
uses option are deleted.
The execute preconfigure statement causes the POLYCENTER
Software Installation utility to define logical names for use by the
subprocess that executes the specified commands. The commands should
use these logical names to reference files, as follows:
- PCSI$SOURCE is a subdirectory in the root format under the user's
login directory that points to the location of the files specified by
the uses option. This logical name is defined for the
subprocess in which product-supplied commands execute. It is not the
same PCSI$SOURCE logical name that can be defined by a user, in the
user's process, pointing to the location of a product kit.
Note
The utility does not define the PCSI$DESTINATION logical name for use
by the execute preconfigure commands because the destination
is not finalized when the execute preconfigure statement is
processed. In certain situations, such as installing a patch kit or
re-installing the same version of a product, the actual destination is
determined later during the configuration phase.
|
- PCSI$SCRATCH is a subdirectory under the user's login directory
that commands can use for temporary working space. The utility
automatically deletes this directory and any files placed in it at the
end of the operation.
The execute preconfigure statement is a utility directive and
does not specify a managed object.
See Also Section 6.1
file
Example
|
execute preconfigure "@PCSI$SOURCE:[SYSUPD]EXEC_PREC.COM"
uses [SYSUPD]EXEC_PREC.COM ;
|
In this example, the execute preconfigure statement sets up a
command procedure to run before the product configuration begins. The
uses option specifies the file name of the command
procedure that is deleted after use.
execute release
The execute release statement specifies commands to execute
when the product is installed or reconfigured. These commands are run
after any commands from execute install... statements are run.
Note
Starting with OpenVMS V7.3, the execute release statement is
obsolete. To support existing product kits that may have used this
statment, the POLYCENTER Software Installation utility continues to
process this statement in a backward compatible manner. However, Compaq
recommends that you do not use the execute release statement
in new or revised product kits. Instead, use the execute
upgrade, execute install...remove, or the execute
postinstall statements, as appropriate. Documentation of the
execute release statement may be discontinued in a future
release of this manual.
|
Syntax
execute release (command,...) [ interactive ] [
uses (file,...) ] ;
Parameter
(command,...)
Indicates the commands the utility passes to the command interpreter in
the execution environment.
Option
interactive
Allows communication between the user and specified command or command
procedure executing in a subprocess.
uses (file,...)
Indicates the files required to execute the commands you specified in
the command parameter. Use a separate file statement
to specify required files that are permanently placed in the user's
destination directory tree; use the uses option to
specify required files that are placed in a temporary directory and
deleted after use. By default, this statement does not require files.
Description
The execute release statement specifies commands to execute
when the product is installed or reconfigured. These commands are run
after any commands from execute install... statements are run.
The name of this statement could imply that it only runs when a product
is upgraded or removed; however, this is not the case. The execute
release statement is run under the same situations that the
execute install... statement is run. Because of its misleading
name and duplicate functionality, execute release is now
obsolete.
Use the execute upgrade statement or the remove
portion of the execute install...remove statement to perform
actions when your product is upgraded or removed. To perform actions
when your product is installed or reconfigured, use either the
execute install... or execute postinstall statement.
You specify actions to perform by including one or more DCL command
lines in the execute release statement. These commands are
passed for execution to the DCL interpreter running in a subprocess.
Enclose each action, whether specified as a single DCL command or a
command procedure, in double quotes (" "). If more than one action is
given, use parentheses to enclose the list.
If you want your commands to prompt the user and accept the user's
input, specify the execute release statement with the
interactive option. The interactive
option causes all output from DCL to be displayed, unless you prevent
it. In contrast, when the interactive option is not
specified, output generated by DCL commands is displayed only for lines
that are interpreted as DCL messages, that is, those beginning with a
percent sign (%) in column one.
If you need files for the execute release statement, specify
them in the uses option or in separate file
statements. Each file you specify with the uses option
must be present in the product material.
Note that the uses option will not cause the listed
files to be placed permanently in your file system. As soon as the
installation operation completes, the files listed with the
uses option are deleted. For this reason, you must use
the file statement for this execute operation and any other
operation in which you want your execute command procedures placed
permanently in your file system.
The execute release statement causes the POLYCENTER Software
Installation utility to define logical names for use by the subprocess
that executes the specified commands. The commands should use these
logical names to reference files, as follows:
- PCSI$SOURCE is a subdirectory in the root format under the user's
login directory that points to the location of the files specified by
the uses option. This logical name is defined for the
subprocess in which product-supplied commands execute. It is not the
same PCSI$SOURCE logical name that can be defined by a user, in the
user's process, pointing to the location of a product kit.
- PCSI$DESTINATION is a root directory specification that points to
the root directory for the current scope where product material will be
placed.
- PCSI$SCRATCH is a subdirectory under the user's login directory
that can be used by commands for temporary working space. This
directory and any files placed in it are automatically deleted at the
end of the operation.
The execute release statement is a utility directive and does
not specify a managed object.
See Also Section 6.1
execute install.remove
execute postinstall
execute upgrade
file
Example
|
execute release "@pcsi$source:[sysupd]config.com" uses [sysupd]config.com ;
|
In this example, the execute release statement sets up a
command procedure to run when the product is installed or reconfigured.
The uses option specifies the file name of the command
procedure that is deleted after use.
|