swmodify(1M)swmodify(1M)NAMEswmodify - modify software products in a target root or depot
SYNOPSIS
attribute=[value]] catalog] session_file] software_file] pathname_file]
product_specification_file| session_file] option=value]
option_file] [software_selections] target_selection]
Remarks
For an overview of all SD commands, see the sd(5) man page by typing on
the command line.
DESCRIPTION
The command modifies the definitions of software objects installed into
a primary or alternate root, or available from a software depot. It
supports the following features:
· adding new objects - The user can add new bundles, products,
subproducts, filesets, control files, and files to existing
objects (which will contain them).
· deleting existing objects - The user can delete existing bun‐
dles, products, subproducts, filesets, control files, and
files from the objects which contain them.
· modifying attribute values - The user can add an attribute,
delete an attribute, or change the existing value of an
attribute for any existing object. When adding a new object,
the user can at the same time define attributes for it.
· committing software patches - The user can remove saved
backup files, committing the software patch.
With the exception of control files, does not manipulate the actual
files that make up a product (fileset). The command manipulates the
catalog information which describes the files. However, can replace
the contents of control files.
Common uses of include:
· adding file definitions to the existing list of file defini‐
tions in a fileset. Example: If a fileset's control scripts
add new files to the installed file system, the scripts can
call to "make a record" of those new files.
· changing the values of existing attributes. Example: If a
product provides a more complex configuration process (beyond
the SD configure script), that script can set the fileset's
state to CONFIGURED upon successful execution.
· defining new objects. Example: to "import" the definition of
an existing application that was not installed by SD, con‐
struct a simple PSF describing the product. Then invoke to
load the definition of the existing application into the IPD.
Options
supports the following options:
Perform modifications on a depot (not on a primary or alternate
root).
The given target_selection must be a depot.
Preview a modify session without modifying anything within the
target_selection.
Performs modifications on an alternate root directory, which
must be
specified in the option. (This option is not required
for alternate root operations but is maintained for
backward compatibility. See the heading in sd(5) for
more information.)
If no options are specified, then delete the given soft‐
ware_selections from within the given target_selec‐
tion. This action deletes the definitions of the
software objects from the depot catalog or installed
products database.
If options are specified, then delete these attribute
definitions from the given software_selections (from
within the given target_selection).
Turn on verbose output to stdout.
List the data model revisions that this command supports.
Add, modify, or delete the
value of the given attribute. If the option is speci‐
fied, then delete the attribute from the given soft‐
ware_selections (or delete the value from the set of
values currently defined for the attribute). Other‐
wise add/modify the attribute for each software_selec‐
tion by setting it to the given value.
Multiple options can be specified. Each attribute
modification will be applied to every software_selec‐
tion.
The and options are mutually exclusive; the option
cannot be specified when the option is specified.
Specifies the pathname of the catalog which will be added, modi‐
fied,
or used as input by
The and options are mutually exclusive, the option
cannot be specified when the option is specified.
Save the current options and operands only to the
session_file. You can enter a relative or absolute
path with the file name. The default directory for
session files is Without this option, by default, the
session file is saved only in the default directory
You can recall a session file with the option.
Read the list of
software_selections from software_file instead of (or
in addition to) the command line.
Specify a file containing the pathnames of files being added to
or
deleted from the IPD instead of having to specify them
individually on the command line.
The source
Product Specification File (PSF) describes the prod‐
uct, subproduct, fileset, and/or file definitions
which will be added, modified, or used as input by
The and options are mutually exclusive, the option
cannot be specified when the option is specified.
Execute based on the options and operands saved from a previ‐
ous session, as defined in session_file. You can save
session information to a file with the option.
Set the session
option to value and override the default value (or a
value in an alternate options_file specified with the
option). Multiple options can be specified.
Read the session options and behaviors from
options_file.
Operands
The command supports two types of operands: followed by These operands
are separated by the "at" character. This syntax implies that the com‐
mand operates on "software selections at targets".
Software Selections
If a product_specification_file is specified, will select the soft‐
ware_selections from the full set defined within the PSF. The software
selected from a PSF is then applied to the target_selection, with the
selected software objects either added to it or modified within it. If
a PSF is not specified, will select the software_selections from the
software defined in the given (or default) target_selection.
The command supports the following syntax for each software_selection:
· You can specify selections with the following shell wildcard
and pattern-matching notations:
· Bundles and subproducts are recursive. Bundles can contain
other bundles and subproducts can contain other subproducts.
· The software specification selects all products. Use this
specification with caution.
The component has the form:
· location applies only to installed software and refers to
software installed to a location other than the default prod‐
uct directory.
· and apply only to filesets.
· , , , , and apply only to bundles and products. They are
applied to the leftmost bundle or product in a software spec‐
ification.
· The <op> (relational operator) component can be of the form:
or
which performs individual comparisons on dot-separated
fields.
For example, chooses all revisions greater than or equal to
The system compares each dot-separated field to find matches.
· The (equals) relational operator lets you specify selections
with the shell wildcard and pattern-matching notations:
For example, the expression returns any revision in version
10 or version 11.
· All version components are repeatable within a single speci‐
fication (for example, If multiple components are used, the
selection must match all components.
· Fully qualified software specs include the and version compo‐
nents even if they contain empty strings. For installed
software, is also included.
· No space or tab characters are allowed in a software selec‐
tion.
· The software can take the place of the version component. It
has the form:
[instance_id]
within the context of an exported catalog, where is an inte‐
ger that distinguishes versions of products and bundles with
the same tag.
Target Selection
The command supports the specification of a single, local target_selec‐
tion, using the syntax:
When operating on the primary root, no target_selection needs to be
specified. (The target is assumed.) When operating on a software
depot, the target_selection specifies the path to that depot. If the
option is specified and no target_selection is specified, the default
is assumed (see below).
EXTERNAL INFLUENCES
Default Options
In addition to the standard options, several SD behaviors and policy
options can be changed by editing the default values found in:
the system-wide default values.
the user-specific default values.
Values must be specified in the defaults file using this syntax:
The optional prefix denotes one of the SD commands. Using the prefix
limits the change in the default value to that command. If you leave
the prefix off, the change applies to all commands.
You can also override default values from the command line with the or
options:
The following keywords are supported by If a default value exists, it
is listed after the The commands that this option applies to are also
specified. The policy options that apply to are:
The location for SD logfiles and the default par‐
ent directory for the
installed software catalog. The default
value is for normal SD operations. When
SD operates in nonprivileged mode (that
is, when the default option is set to
· The default value is forced to
· The path element is replaced with the
name of the invoking user, which SD
reads from the system password file.
· If you set the value of this option
to path, SD replaces with the invok‐
ing user's home directory (from the
system password file) and resolves
path relative to that directory. For
example, resolves to the directory in
your home directory.
· If you set the value of the default
option to a relative path, that path
is resolved relative to the value of
this option.
SD's nonprivileged mode is intended only
for managing applications that are spe‐
cially designed and packaged. This mode
cannot be used to manage the HP-UX oper‐
ating system or patches to it. For a
full explanation of nonprivileged SD,
see the available at the web site.
See also the and options.
Determines whether modification of files with a
size greater
than or equal to 2 gigabytes is allowed.
In the default state of this option
tells to not allow files with a size
greater than or equal to 2 gigabytes to
be modified.
When set to this option tells to permit
files with a size greater than or equal
to 2 gigabytes to be modified. If the
files are in a depot, then the depot can
only be used by the December 2005 OEUR
(HP-UX 11i v2) version of SD and newer
versions of SD on HP-UX 11i v1, HP-UX
11i v2, and future releases.
This version of SD supports a large file
up to 2 terabytes (2048 gigabytes)
Determines whether SD commands create compressed
INDEX and INFO
catalog files when writing to target
depots or roots. The default of does
not create compressed files. When set
to SD creates compressed and uncom‐
pressed INDEX and INFO files. The com‐
pressed files are named and and reside
in the same directories as the uncom‐
pressed files.
Compressed files can enhance performance
on slower networks, although they may
increase disk space usage due to a
larger Installed Products Database and
depot catalog. SD controllers and tar‐
get agents for HP-UX 11.01 and higher
automatically load the compressed INDEX
and INFO files from the source agent
when:
· The source agent supports this fea‐
ture.
· or exist on the source depot.
· or are not older than the correspond‐
ing uncompressed INDEX or INFO files.
The uncompressed INDEX or INFO file is
accessed by the source agent if any
problem occurs when accessing, transfer‐
ring, or uncompressing the or file.
When adding or deleting control file objects, this
option lists the
tags of those control files. There is
no supplied default. If there is more
than one tag, they must be separated by
white space and surrounded by quotes.
Defines the default distribution directory of the
target depot. The
target_selection operand overrides this
default.
When adding or deleting file objects, this option
lists the pathnames
of those file objects. There is no sup‐
plied default. If there is more than
one pathname, they must be separated by
white space.
Defines the directory path where the Installed
Products Database (IPD)
is stored. This information describes
installed software. When set to an
absolute path, this option defines the
location of the IPD. When this option
contains a relative path, the SD con‐
troller appends the value to the value
specified by the option to determine the
path to the IPD. For alternate roots,
this path is resolved relative to the
location of the alternate root. This
option does not affect where software is
installed, only the IPD location.
This option permits the simultaneous
installation and removal of multiple
software applications by multiple users
or multiple processes, with each appli‐
cation or group of applications using a
different IPD.
Caution: use a specific to manage a spe‐
cific application. SD does not support
multiple descriptions of the same appli‐
cation in multiple IPDs.
See also the and options, which control
SD's nonprivileged mode. (This mode is
intended only for managing applications
that are specially designed and pack‐
aged. This mode cannot be used to man‐
age the HP-UX operating system or
patches to it. For a full explanation
of nonprivileged SD, see the available
at the web site.)
Specifies the POSIX
to which the SD commands conform when
writing distributions and output. Sup‐
ported values are "1.0" (default) and
"0.8".
SD object and attribute syntax conforms
to the specification of the standard.
SD commands still accept the keyword
names associated with the older layout
version, but you should use only to cre‐
ate distributions readable by older ver‐
sions of SD.
See the description of the option in
sd(5) for more information.
Adds numeric identification numbers at the begin‐
ning of SD logfile
messages:
(default) No identifiers are attached to
messages.
Adds identifiers to ERROR messages only.
Adds identifiers to ERROR and WARNING
messages.
Adds identifiers to ERROR, WARNING, and
NOTE messages.
Adds identifiers to ERROR, WARNING,
NOTE, and certain other
informational messages.
The option controls the amount of detail
written to the log file. When set to
this option adds detailed task informa‐
tion (such as options specified,
progress statements, and additional sum‐
mary information) to the log file. This
information is in addition to log infor‐
mation controlled by the option.
Defines the default log file for
Controls the log level for the
events logged to the
logfile, the target agent
logfile, and the source
agent logfile. This
information is in addition
to the detail controlled
by the option. See for
more information.
A value of:
provides no information to
the log files.
enables verbose logging to
the log files.
enables very verbose log‐
ging to the log files.
To enable logging by com‐
mands invoked by control
files, add the following
line to the system
defaults file:
Controls the time in minutes to
cache and re-use the results of
hostname
or IP address resolution
lookups. A value of 0
disables the facility to
cache and re-use lookup
results. The maximum
value allowed is 10080
minutes, which is one
week.
A value of:
disables the lookup
caching mechanism.
is the maximum value
allowed.
Commits a patch by removing files
saved for patch rollback. When set
to
you cannot roll back
(remove) a patch unless
you remove the associated
base software that the
patch modified.
This option controls SD's nonprivi‐
leged mode. This option is ignored
(treated as true) when the
invoking user is super-
user.
When set to the default
value of true, SD opera‐
tions are performed nor‐
mally, with permissions
for operations either
granted to a local super-
user or set by SD ACLs.
(See swacl(1M) for details
on ACLs.)
When set to false and the
invoking user is local and
is not super-user, non‐
privileged mode is
invoked:
· Permissions for opera‐
tions are based on the
user's file system per‐
missions.
· SD ACLs are ignored.
· Files created by SD
have the uid and gid of
the invoking user, and
the mode of created
files is set according
to the invoking user's
umask.
SD's nonprivileged mode is
intended only for managing
applications that are spe‐
cially designed and pack‐
aged. This mode cannot be
used to manage the HP-UX
operating system or
patches to it. For a full
explanation of nonprivi‐
leged SD, see the avail‐
able at the web site.
See also the and options.
Defines the default
software_selections.
There is no supplied
default. If there is more
than one software selec‐
tion, they must be sepa‐
rated by spaces. Software
is usually specified in a
software input file, as
operands on the command
line, or in the GUI.
Defines the default location of the
source product specification file
(PSF). The syntax is not
allowed, only a valid can
be specified. The option
overrides this value.
Defines the default
target_selections. There
is no supplied default
(see above). If there is
more than one target
selection, they must be
separated by spaces. Tar‐
gets are usually specified
in a target input file, as
operands on the command
line, or in the GUI.
Controls the verbosity of a non-
interactive command's output:
disables output to stdout.
(Error and warning mes‐
sages
are always written to
stderr).
enables verbose messaging
to stdout.
for enables very verbose
messaging to stdout.
Session File
Each invocation of the command defines a
modify session. The invocation options,
source information, software selections,
and target hosts are saved before the
installation or copy task actually com‐
mences. This lets you re-execute the com‐
mand even if the session ends before proper
completion.
Each session is automatically saved to the
file This file is overwritten by each invo‐
cation of
You can also save session information to a
specific file by executing with the ses‐
sion_file option.
A session file uses the same syntax as the
defaults files. You can specify an abso‐
lute path for the session file. If you do
not specify a directory, the default loca‐
tion for a session file is
To re-execute a session file, specify the
session file as the argument for the ses‐
sion_file option of See the swpackage(4) by
typing for PSF syntax.
Note that when you re-execute a session
file, the values in the session file take
precedence over values in the system
defaults file. Likewise, any command line
options or parameters that you specify when
you invoke take precedence over the values
in the session file.
Environment Variables
The environment variable that affects is:
Determines the language in which
messages are displayed.
If is not specified or
is set to the empty
string, a default value
of is used. See the
lang(5) man page by
typing for more infor‐
mation.
NOTE: The language in
which the SD agent and
daemon log messages are
displayed is set by the
system configuration
variable script, For
example, must be set to
or to make the agent
and daemon log messages
display in Japanese.
Determines the locale to be used to
override any values for locale
categories specified by
the settings of or any
environment variables
beginning with
Determines the interpretation of
sequences of bytes of text data as
characters (for exam‐
ple, single versus
multibyte characters in
values for vendor-
defined attributes).
Determines the language in which
messages should be written.
Determines the format of dates
(create_date and
mod_date) when dis‐
played by Used by all
utilities when display‐
ing dates and times in
and
Determines the time zone for use
when displaying dates and times.
Signals
The command ignores SIGHUP, SIGTERM,
SIGUSR1, and SIGUSR2. The command catches
SIGINT and SIGQUIT. If these signals are
received, prints a message and then exits.
During the actual database modifications,
blocks these signals (to prevent any data
base corruption). All other signals result
in their default action being performed.
RETURN VALUES
The command returns:
The add, modify, or delete opera‐
tion(s) were successfully performed
on
the given software_selections.
An error occurred during the session
(for example, bad syntax in the PSF,
invalid software_selection,
etc.) Review stderr or the log‐
file for details.
DIAGNOSTICS
The command writes to stdout, stderr, and
to specific logfiles.
Standard Output
In verbose mode, the command writes mes‐
sages for significant events. These
include:
· a begin and end session message,
· selection, analysis, and execu‐
tion task messages.
Standard Error
The command also writes messages for all
WARNING and ERROR conditions to stderr.
Logfile
The command logs events to the command log‐
file and to the logfile associated with
each target_selection.
Command Log
The command logs all messages to the
the logfile (The user can specify a
different logfile by modifying the
option.)
Target Log
When modifying installed software,
logs messages to the file beneath
the root directory (for example, or
an alternate root directory). When
modifying available software (within
a depot), logs messages to the file
beneath the depot directory (for
example,
EXAMPLES
Add additional files to an existing file‐
set:
Replace the definitions of existing files
in an existing fileset (for example, to
update current values for the files'
attributes):
Delete control files from a fileset in an
existing depot:
Create a new fileset definition where the
description is contained in the PSF file
Delete an obsolete fileset definition:
Commit a patch (remove files saved for
patch rollback):
Create some new bundle definitions for
products in an existing depot:
Modify the values of some fileset's
attributes:
Modify the attributes of a depot:
WARNINGS
If the target_selection is a software depot
and you delete file definitions from the
given software_selections, the files' con‐
tents are not deleted from the depot.
FILES
Contains the user-specific default values
for some or all SD options.
Contains session files automatically saved
by the SD commands, or
explicitly saved by the user.
Contains the master list of current SD
options (with their default values).
The directory which contains all of the
configurable (and
non-configurable) data for SD. This
directory is also the default loca‐
tion of logfiles.
Contains the active system-wide default
values for some or all SD options.
The Installed Products Database (IPD), a
catalog of all products
installed on a system.
The default location of a target software
depot.
AUTHOR
was developed by the Hewlett-Packard Com‐
pany.
SEE ALSOinstall-sd(1M), swacl(1M), swagentd(1M),
swask(1M), swconfig(1M), swcopy(1M), swin‐
stall(1M), swjob(1M), swlist(1M), swpack‐
age(1M), swreg(1M), swremove(1M), swver‐
ify(1M), sd(4), swpackage(4), sd(5).
available at
SD customer web site at
swmodify(1M)
