swlist(1M)swlist(1M)NAMEswlist - display information about software products
SYNOPSIS
attribute] session_file] software_file] level] source] session_file]
target_file] option=value] option_file]
[software_selections] target_selections]
Remarks
· This command supports operation on remote systems. See
below.
· supports an interactive user interface that can be invoked by
the command. See below.
· For an overview of all SD commands, see the sd(5) man page by
typing on the command line.
DESCRIPTION
The command displays information about software products installed at
or available from the specified target_selections. It supports these
features:
· Specify bundles, products, subproducts, and/or filesets to
list.
· Display the files contained in each fileset.
· Display a table of contents from a software source.
· Specify the attributes to display for each software object.
· Display all attributes for bundles, products, subproducts,
filesets and/or files.
· Display the full to be used with software selections.
· Display the file for products.
· Display the depots on a specified host.
· Create a list of products, subproducts, and/or filesets to
use as input to the other commands.
· List the categories of available or applied patches.
· List applied patches and their state (applied or committed).
Operations on Remote Systems
supports operations on remote systems. By default, any user can list
depots available or software installed on a remote target.
The command may be used to change Access Control Lists (ACLs) to pre‐
vent a system from being accessed remotely. For example, entering both
of the following commands:
replaces the default ACL that protects the root filesystem with one
that only allows local users to list software installed.
Interactive Operation
supports an optional graphical user interface (GUI). (If your terminal
or display cannot support the GUI, the command also provides a terminal
user interface, in which screen navigation is done with the keyboard
and no mouse.)
To invoke the GUI, type:
or add the option with any other command-line options when you
invoke the
Previewing Product and OS Update Information
To preview information about new software in the depot, you can use to
view the file for each product, including OS update information con‐
tained in the SD (SW-DIST product) For example, to display the latest
OS update information:
Options
When no options or operands are specified, lists the software bundles
(and products which are not part of a bundle) that are installed at the
local host. supports the following options:
List software available from a depot (instead of software
installed on
a root filesystem).
Invoke the
interactive user interface. The interactive interface
lets you browse SD software objects. Invoking lets
you browse depot software. See the and headings above
for additional details.
Operates 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 compat‐
ibility. See the heading in sd(5) for more informa‐
tion.)
Shorthand for
-l bundle -l product -l subproduct -l fileset.
List all the attributes for an object if no
options are specified. (Vendor-defined attributes are
not included. See the option.) The output lists one
attribute per line in the format:
(See sd(4) for details on all SD attributes.)
Display a specific
attribute, such as revision, description, vendor
information, size, vendor-defined attributes, or oth‐
ers. (See sd(4) for details on all SD attributes.)
The output lists one attribute per line in the format:
To display multiple attributes, specify multiple
options.
To list the full set of attributes for a software
object, use the option.
Note that the attribute (that is, the identifier) is
always displayed for product, subproduct, and fileset
objects. The attribute (that is, the filename) is
always displayed for file objects.
Write full catalog structure information into the directory
specified
by the catalog modifier. You can use this exported
catalog structure for distributions and to list
installed software catalog information.
If you use the option, the and do not apply. All
attributes down to the file level and the control
scripts are written to the catalog.
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. (Note
that session management does not apply to the interac‐
tive user interface invoked by the option.)
Read the list of
software_selections from software_file instead of (or
in addition to) the command line.
List all objects down to the specified
level. Both the specified level(s) and the depth of
the specified software_selections control the depth of
the output.
Specify the software source to list. This is an alternate way
to list
a source depot. Sources can also be specified as tar‐
get depots and listed using the option.
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. (Note
that session management does not apply to the interac‐
tive user interface invoked by the option.)
Read the list of
target_selections from target_file instead of (or in
addition to) the command line.
Set the session
option to value and override the default value (or a
value in an alternate option_file specified with the
option). Multiple options can be specified.
Read the session options and behaviors from
option_file.
Operands
supports two types of operands: followed by These operands are sepa‐
rated by the "at" character. This syntax implies that the command
operates on "software selections at targets".
Software Selections
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 specification.
· 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 Selections
supports this syntax for each target_selection.
A host may be specified by its host name, domain name, or Internet
address. If host is specified, the directory must be an absolute path.
To specify a relative path when no host is specified, the relative path
must start with or otherwise, the specified name is considered as a
host.
Target Selections with IPv6 Address
The command supports specifying the host as an IPv6 address on HP-UX
Release 11i v3, as shown below.
If both the hostname and the path are specified, then the first occur‐
rence of a slash is treated as the separator.
The IPv6 address can optionally be enclosed in a pair of square brack‐
ets and
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 section lists all of the keywords supported by the com‐
mands. If a default value exists, it is listed after the
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.
Causes a target agent to exit if it has been inac‐
tive for the
specified time. This can be used to
make target agents more quickly detect
lost network connections since RPC can
take as long as 130 minutes to detect a
lost connection. The recommended value
is the longest period of inactivity
expected in your environment. For com‐
mand line invocation, a value between 10
minutes and 60 minutes is suitable. A
value of 60 minutes or more is recom‐
mended when the GUI will be used. The
default of 10000 is slightly less than 7
days.
Provides the "codeword" needed to unlock protected
HP CD-ROM software.
Some HP software products are shipped on
CD-ROM as "protected" products. That
is, they cannot be installed or copied
unless a "codeword" and "customer ID"
are provided. The codeword is found on
the CD-ROM certificate which you
received from HP. You may use this
default specification on the command
line or the SD-UX interactive user
interface to enter the codeword.
This default stores the codeword for
future reference; it needs to be entered
only once. If a new HP product is pur‐
chased and a previous codeword has
already been entered for that CD-ROM,
just enter the new codeword as usual and
the codewords will be merged internally.
NOTE: For HP-UX B.10.10 and later sys‐
tems, SD searches the file on the server
that is providing protected software to
other hosts. It looks for valid cus‐
tomer_id/codeword pairs. In doing so,
SD eliminates the need to enter code‐
words and customer_ids on every host
that is "pulling" the software.
To properly store the customer_id/code‐
word for a CD-ROM, run or on the host
serving the CD-ROM. After the codeword
has been stored, clients installing or
copying software using that host and CD-
ROM as a source will no longer require a
codeword or customer_id.
For cumulative source depots, this option allows
consistent software
selections over time by and The default
of zero includes all bundles, products,
subproducts, and filesets in the source
depot as candidates for selection (and
autoselection of dependencies and
patches), based on the software selec‐
tions and other options. When set to a
time (specified as seconds from epoch),
only those bundles, products, and file‐
sets (and the subproducts in the prod‐
uct) with a less than or equal to the
specified value are available for selec‐
tion (or autoselection). To list the of
bundles, products and filesets, use:
This number, also printed on the Software Certifi‐
cate,
is used to "unlock" protected software
and restrict its installation to a spe‐
cific site or owner. It is entered
using the customer_id= option or by
using the interactive user interface.
The customer_id can be used on any HP-UX
10.X or later system.
Defines the default location of the target depot.
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.
Specify the
level of the object to list.
The supported software levels are:
Show all objects down to the bundle
level.
Show all objects down to the product
level. Also use
to show bundles.
Show all objects down to the subproduct
level.
Show all objects down to the fileset
level. Also use
to show subproducts.
Show all objects down to the file level.
Show all objects down to the con‐
trol_file level.
Show all categories of available
patches.
Show all applied patches.
The supported depot and root levels are:
Show only the depot level (that is,
depots which exist
at the specified tar‐
get hosts).
List all alternate roots.
List all registered shared roots (HP-UX
10.X only).
List all registered private roots (HP-UX
10.X only).
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.
Defines the attributes which will be listed for
each object when no
or options are specified. Each
attribute included in the definition is
separated by <tab> or <space>. Any
attributes may be included in the defi‐
nition. If a particular attribute does
not exist for an object, that attribute
is silently ignored. For example, the
attribute is valid for products, sub‐
products, and filesets, but the
attribute is only valid for products.
Specifies the attributes displayed for each object
listed when the
option is invoked and when no or option
is specified. The default display
attributes are and
This option controls the exit code returned by
SD's controller commands.
This option is applicable only for a
single target operation, and ignored
when multiple targets are used.
When set to the default value of swlist
returns:
0 If there were no errors, with or
without warnings.
1 If there were errors.
When set to swlist returns :
0 If there were no warnings and no
errors.
1 If there were errors.
2 If there were warnings but no errors.
Defines the protocol sequence(s) and endpoint(s)
on which the daemon
listens and the other commands contact
the daemon. If the connection fails for
one protocol sequence, the next is
attempted. SD supports both the tcp and
udp protocol sequence on most platforms.
See the sd(5) man page by typing for
more information.
Relative length of the communications timeout.
This is a value in the
range from 0 to 9 and is interpreted by
the DCE RPC. Higher values mean longer
times; you may need a higher value for a
slow or busy network. Lower values will
give faster recognition on attempts to
contact hosts that are not up or not
running Each value is approximately
twice as long as the preceding value. A
value of 5 is about 30 seconds for the
protocol sequence. This option may not
have any noticeable impact when using
the protocol sequence.
This option controls SD's nonprivileged mode.
This option is ignored
(treated as true) when the invoking user
is super-user.
When set to the default value of true,
SD operations are performed normally,
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, nonpriv‐
ileged mode is invoked:
· Permissions for operations are based
on the user's file system permis‐
sions.
· 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 accord‐
ing to the invoking user's umask.
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.
Displays or hides superseded patches in
command line output. In the default
state of will not display superseded
patches even if you perform a command on
the superseded patch. Setting this
option to permits display of superseded
patches. This option applies to command
line only. In an interactive session,
always shows superseded patches regard‐
less of the value of this option.
If no target_selections are specified, select
the default of the local host as the
target_selection for the command.
Defines the default
software_selections. There is no sup‐
plied default. If there is more than
one software selection, they must be
separated by spaces.
Indicates the software view to be used as the
default level for
the software listing in the GUI. It can
be set to or a bundle category tag (to
indicate to show only bundles of that
category).
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.
Controls how attribute values are displayed.
A value of:
displays only the attribute value.
displays both the attribute keyword and
value.
(See the option above.)
Session File
Each invocation of defines a task session. The command
automatically saves options, source information, software
selections, and target selections before the task actu‐
ally commences. This lets you re-execute the command
even if the session ends before the task is complete.
You can also save session information from interactive or
command-line sessions.
Session information is saved to the file This file is
overwritten by each invocation of the command. The file
uses the same syntax as the defaults files.
From an interactive session, you can save session infor‐
mation into a file at any time by selecting the Save Ses‐
sion or Save Session As option from the File menu.
From a command-line session, you can save session infor‐
mation by executing the command with the option. You can
specify an absolute path for a session file. If you do
not specify a directory, the default location is
To re-execute a saved session from an interactive ses‐
sion, use the Recall Session option from the File menu.
To re-execute a session from a command-line, specify the
session file as the argument for the option.
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 and
parameters take precedence over the values in the session
file.
Environment Variables
The environment variables that affect the command are:
Determines the language in which messages are dis‐
played.
If is not specified or is set to the
empty string, a default value of is
used. See lang(5) for more informa‐
tion.
NOTE: The language in which the SD
agent and daemon log messages are
displayed is set by the system con‐
figuration variable script, For exam‐
ple,
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 example, single ver‐
sus 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
displaying dates and times in and
Determines the time zone for use when displaying
dates and times.
Signals
The command catches the signals SIGQUIT and SIGINT. If
these signals are received, prints a message, sends a
Remote Procedure Call (RPC) to the agents to wrap up, and
then exits.
Each agent will complete the list task (if the execution
phase has already started) before it wraps up.
OPERATION
The output from follows this rule with all options: only
the lowest level listed (product, subproduct, fileset or
file) will be uncommented. Among other things, this
allows the output from to be used as input to other com‐
mands. The one exception is the list that contains
files; file-level output is not accepted by other com‐
mands.
The types of listings that can be selected are given
below. Some of these listings are not exclusive choices,
but rather ways to view the objects while controlling the
amount of output.
· Default Listing
· Software Listing
· Root Listing
· Depot Listing
· Multiple Targets Listing
· Verbose Listing
Default Listing
If is invoked with no software_selections and no tar‐
get_selections, a listing of all installed products on
the local host is produced. This listing contains one
line for each product. The line includes the product tag
attributes and all other attributes selected via the
option.
If target_selections (that is, target hosts) are speci‐
fied, this same format listing is produced for the
installed software at each of the specified hosts.
Software Listing
A listing of software objects is controlled by the speci‐
fied software_selections, and also by the option lists
the contents of each software object specified in the
software_selections. For example, if you specify product
selections, the subproducts and/or filesets contained
immediately below each product will be listed. If you
specify fileset selections, the files contained in each
fileset will be listed.
The depth of objects listed is controlled with the
option. This option can expand or restrict the depth in
concert with the specified software selections. By
default, the contents of a specified software selection
are always listed (as described above). The option can
defeat this listing by specifying a level equivalent to
the level of objects in the software_selections. For
example, if you want to list specific product selections
but not their contents, use If you want to list specific
fileset selections but not their contained files, use The
software_selection options only apply if the level is
bundle, product, subproduct, fileset, file, or patch.
Depot Listing
Another class of objects that can display are software
depots. For example, the user can list all registered
depots on a given host. A combination of the option and
target_selections operands can produce a variety of depot
listings.
Multiple Targets Listing
Multiple target_selections (that is, root filesystems,
alternate roots, or depots) are listed sequentially: list
all the requested objects and attributes from the first
target_selection, followed by the second target_selec‐
tion, etc.
Verbose Listing
The option causes a verbose listing to be generated. A
verbose listing includes all attributes defined for an
object. The command prints the keyword and value for
each attribute. The attributes are listed one per line.
The user can post-process (filter) the output with and/or
to get the fields of interest.
The depot's attributes are displayed if is called with
the and options, and a specific depot target_selection.
Attributes for a particular software level are displayed
based on the depth of the specified software_selections.
For example, swlist-v product1.fileset1 will give all
fileset attributes for fileset1. If the option is used
with the the different listing are:
· To display attributes for all products, use
· To display attributes for all products and sub‐
products, use
· To display attributes for all products and
filesets, use
· To display attributes for all products, file‐
sets, and files, use
RETURN VALUE
The command returns:
The software_selections and/or target_selections
were successfully listed.
The list operation failed on
all target_selections.
The list operation failed on
some target_selections.
DIAGNOSTICS
The command writes to stdout, stderr, and to the agent
logfile.
Standard Output
All listings are printed to stdout.
Standard Error
The command writes messages for all WARNING and ERROR
conditions to stderr.
Logging
The command does not log summary events. It logs events
about each read task to the logfile associated with each
target_selection.
You can use the interactive interface to view the file.
swagentd Disabled
If the daemon has been disabled on the host, it can be
enabled by the host's system administrator by setting the
entry in to and executing
EXAMPLES
Run the interactive interface:
Use interactive to view a depot:
List all of the products installed on the local host:
Generate a comprehensive listing that includes all file‐
sets for the product NETWORKING:
List all the attributes for the ARPA-RUN fileset:
List the C product installed on several remote hosts:
List the FRAME product relocated to directory on host1:
List all the versions of the FRAME product installed on
the toolserver host:
List the contents of a local depot while in the directory
List the contents of the local tape,
or, alternatively:
List the tag and revision attributes for all products on
the local tape
or, alternatively:
Display the README file for the FRAME product:
List the products stored in a remote depot:
List all depots on a host:
List the categories defined in the depot mounted at
Output:
List a particular attribute of a category object identi‐
fied by the tag
List all the installed patches and their current state.
Use the option and level to display the values of a file‐
set's applied_patches attribute.
Output:
Another example showing just the patch:
Output:
FILES
Contains the user-specific default values for some or all
SD options.
Contains session files automatically saved by the SD com‐
mands, 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 location of logfiles.
Contains the active system-wide default values for some
or all SD options.
The file which stores the list of depots registered at
the local host.
The Installed Products Database (IPD), a catalog of all
products
installed on a system.
The default location of a source and target software
depot.
AUTHOR
was developed by the Hewlett-Packard Company and Mark H.
Colburn (see pax(1)).
SEE ALSOinstall-sd(1M), swacl(1M), swagentd(1M), swask(1M),
swconfig(1M), swcopy(1M), swinstall(1M), swjob(1M),
swmodify(1M), swpackage(1M), swreg(1M), swremove(1M),
swverify(1M), sd(4), swpackage(4), sd(5).
available at
SD customer web site at
swlist(1M)
