swlist(8)swlist(8)NAMEswlist - display information about software products
SYNOPSISswlist [-d| [-i] [-R] [-v] [-a attribute] [-C session_file] [-f soft‐
ware_file] [-l level] [-s source] [-S session_file] [-t tar‐
get_file] [-x option=value] [-X option_file]
[software_selections] [ target_selections]
STANDARDS
Interfaces documented on this reference page conform to industry stan‐
dards as follows:
POSIX 1387.2, XDSA
Refer to the standards(5) reference page for more information about
industry standards and associated tags.
DESCRIPTION
The swlist 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 software_spec to be used with software
selections.
· Display the readme 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).
Previewing Product and OS Update Information
To preview information about new software in the depot, you can use
swlist to view the readme file for each product, including OS update
information contained in the SWMGR (SW-DIST product) readme. For exam‐
ple, to display the latest OS update information:
swlist-d -a readme -l product SW-DIST hostA:/depot11
Options
When no options or operands are specified, swlist lists the software
bundles (and products which are not part of a bundle) that are
installed at the local host. swlist supports the following options:
-d (Optional) List software available from a depot (instead of
software installed on a root filesystem).
-i Invoke the swlist interactive user interface. The interac‐
tive interface lets you browse SWMGR software objects.
Invoking swlist-i -d lets you browse depot software.
-r (Optional) List products installed on an alternate root
filesystem (instead of software installed on /).
-R Shorthand for -l bundle -l product -l subproduct -l file‐
set.
-v If no -a options are specified, then list all the
attributes for an object, one attribute per line. The
attributes are listed in the format:
keyword value
If one or more -a options are specified, then list the
selected attributes in the above format.
-a attribute
Each object has its own set of attributes. These
attributes include such things as revision, description,
vendor information, size, and many others. The -a option
selects a specific attribute to display. You can specify
multiple -a options to display multiple attributes.
Note that the tag attribute (i.e. the identifier) is always
displayed for product, subproduct, and fileset objects.
The path attribute (i.e. the filename) is always displayed
for file objects.
The full set of attributes for a given software object can
be obtained using the -v option. See also the sd(4) man
page for details on these attributes.
-c catalog
Provides a means to list the full catalog structure. If the
-c option is specified, output from swlist is written to an
exported catalog structure instead of stdout. The -c option
specifies a directory below which the catalog information
for the specified objects and attributes is stored. The
exported catalog structure is used for distributions and
installed_software catalog information.
If -c catalog is specified, then -a attribute and -l level
do not apply; all attributes down to the file level and the
control scripts are written to the catalog.
-C session_file
Save the current options and operands to session_file. You
can enter a relative or absolute path with the file name.
The default directory for session files is /.sw/sessions/.
You can recall a session file with the -S option. (Note
that session management does not apply to the swlist inter‐
active user interface invoked by the -i option.)
-f software_file
Read the list of software_selections from software_file
instead of (or in addition to) the command line.
-l level
List all objects down to the specified level. Both the
specified level(s) and the depth of the specified soft‐
ware_selections control the depth of the swlist output.
-s source
Specifies the software source to list. This is an alter‐
nate way to list a source depot. Sources can also be spec‐
ified as target depots and listed using the -d option.
-S session_file
Execute swlist based on the options and operands saved from
a previous session, as defined in session_file. You can
save session information to a file with the -C option.
(Note that session management does not apply to the swlist
interactive user interface invoked by the -i option.)
-t target_file
Read the list of target_selections from target_file instead
of (or in addition to) the command line.
-x option=value
Set the session option to value and override the default
value (or a value in an alternate option_file specified
with the -X option). Multiple -x options can be specified.
-X option_file
Read the session options and behaviors from option_file.
Operands
swlist 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
The selections operands consist of
swlist supports the following syntax for each software_selection:
bundle[.product[.subproduct][.fileset]][,version]
product[.subproduct][.fileset][,version]
· The = (equals) relational operator lets you specify
selections with the following shell wildcard and pattern-
matching notations:
[ ], *, ?
· Bundles and subproducts are recursive. Bundles can con‐
tain other bundles and subproducts can contain other sub‐
products.
· The software specification selects all products. Use
this specification with caution.
The version component has the form:
[,r <op> revision][,a <op> arch][,v <op> vendor]
[,c <op> category][,l=location][,fr <op> revision]
[,fa <op> 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.
· The <op> (relational operator) component can be of the
form:
==, >=, <=, <, >, or !=
which performs individual comparisons on dot-separated
fields.
For example, r>=B.10.00 chooses all revisions greater
than or equal to B.10.00. 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 r=1[01].* returns any revi‐
sion in version 10 or version 11.
· All version components are repeatable within a single
specification (e.g. r>=A.12, r<A.20). If multiple com‐
ponents are used, the selection must match all compo‐
nents.
· Fully qualified software specs include the r=, a=, and v=
version components even if they contain empty strings.
For installed software, l= is also included.
· No space or tab characters are allowed in a software
selection.
· 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
integer that distinguishes versions of products and bun‐
dles with the same tag.
Target Selections
swlist supports this syntax for each target_selection.
[host][:][/directory]
The : (colon) is required if both a host and directory are specified.
EXTERNAL INFLUENCES
Default Options
In addition to the standard options, several SWMGR behaviors and policy
options can be changed by editing the default values found in:
/var/adm/sw/defaults the system-wide default values.
$HOME/.swdefaults the user-specific default values.
Values must be specified in the defaults file using this syntax:
[command_name.]option=value
The optional prefix denotes one of the SWMGR 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 -x
or -X options:
The following section lists all of the keywords supported by the swlist
commands. If a default value exists, it is listed after the "=".
The policy options that apply to swlist are:
agent_timeout_minutes=10000
Causes a target agent to exit if it has been inactive
for the specified time. This can be used to make tar‐
get agents more quickly detect lost network connec‐
tions 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 environ‐
ment. For command line invocation, a value between 10
minutes and 60 minutes is suitable. The default of
10000 is slightly less than 7 days.
distribution_target_directory=/var/spool/sw
Defines the default location of the target depot.
installed_software_catalog=products
Defines the directory path where the Installed Prod‐
ucts Database (IPD) is stored. When set to an absolute
path, this option defines the location of the IPD.
When this option contains a relative path, the SWMGR
controller appends the value to /var/adm/sw to deter‐
mine 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.
layout_version=1.0
Specifies the POSIX layout_version to which the SWMGR
commands conform when writing distributions and swlist
output. Supported values are "1.0" (default) and
"0.8".
SWMGR object and attribute syntax conforms to the
specification of the "IEEE POSIX 1387.2 Software
Administration" standard. SWMGR commands still accept
the keyword names associated with the older layout
version, but you should use layout_version=0.8 only to
create distributions readable by older versions of
SWMGR.
See the description of the layout_version option in
for more information.
level= Specify the level of the object to list.
The supported software levels are:
bundle Show all objects down to the bundle
level.
product Show all objects down to the product
level. Also use -l bundle -l product to
show bundles.
subproduct Show all objects down to the subproduct
level.
fileset Show all objects down to the fileset
level. Also use -l fileset -l subprod‐
uct to show subproducts.
file Show all objects down to the file
level.
control_file Show all objects down to the con‐
trol_file level.
category Show all categories of available
patches.
patch Show all applied patches.
The supported depot and root levels are:
depot Show only the depot level (i.e. depots
which exist at the specified target
hosts).
root List all alternate roots.
one_liner=revision title
Defines the attributes which will be
listed for each object when no -a or -v
options are specified. Each attribute
included in the one_liner definition is
separated by <tab> or <space>. Any
attributes may be included in the
one_liner definition. If a particular
attribute does not exist for an object,
that attribute is silently ignored.
For example, the description attribute
is valid for products, subproducts, and
filesets, but the architecture
attribute is only valid for products.
patch_one_liner=title patch_state
Specifies the attributes displayed for
each object listed when the -l patch
option is invoked and when no -a or -v
option is specified. The default dis‐
play attributes are title and
patch_state.
rpc_binding_info=ncacn_ip_tcp:[2121]
ncadg_ip_udp:[2121]
Defines the protocol sequence(s) and
endpoint(s) on which the daemon listens
and the other commands contact the dae‐
mon. If the connection fails for one
protocol sequence, the next is
attempted. SWMGR supports both the tcp
(ncacn_ip_tcp:[2121]) and udp
(ncadg_ip_udp:[2121]) protocol sequence
on most platforms. See the sd.5 man
page by typing man 5 sd for more infor‐
mation.
rpc_timeout=5. 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 swagentd. Each value
is approximately twice as long as the
preceding value. A value of 5 is about
30 seconds for the ncadg_ip_udp proto‐
col sequence. This option may not have
any noticeable impact when using the
ncacn_ip_tcp protocol sequence.
select_local=true
If no target_selections are specified,
select the default target_directory of
the local host as the target_selection
for the command.
software= Defines the default software_selec‐
tions. There is no supplied default.
If there is more than one software
selection, they must be separated by
spaces.
targets= Defines the default target_selections.
There is no supplied default (see
select_local above). If there is more
than one target selection, they must be
separated by spaces.
verbose=0 Controls how attribute values are dis‐
played. A value of
0 displays only the attribute value.
1 displays both the attribute keyword
and value. (See the -v option
above.)
Session File
Each invocation of swlist defines a task session. The command automat‐
ically saves options, source information, software selections, and tar‐
get selections before the task actually commences. This lets you re-
execute the command even if the session ends before the task is com‐
plete. You can also save session information from interactive or com‐
mand-line sessions.
Session information is saved to the file $HOME/.sw/ses‐
sions/swlist.last. 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 information into a
file at any time by selecting the Save Session or Save Session As
option from the File menu.
From a command-line session, you can save session information by exe‐
cuting the command with the -Csession__file option. You can specify an
absolute path for a session file. If you do not specify a directory,
the default location is $HOME/.sw/sessions/.
To re-execute a saved session from an interactive session, 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 -S 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 com‐
mand-line options and parameters take precedence over the values in the
session file.
Environment Variables
The environment variable that affects the swlist command is:
LANG Determines the language in which messages are dis‐
played. If LANG is not specified or is set to the
empty string, a default value of C is used. See
lang(5) for more information.
NOTE: The language in which the SWMGR agent and daemon
log messages are displayed is set by the system con‐
figuration variable script, /etc/rc.config.d/LANG.
For example,
/etc/rc.config.d/LANG, must be set to LANG=ja_JP.SJIS
or LANG=ja_JP.eucJP to make the agent and daemon log
messages display in Japanese.
LC_ALL Determines the locale to be used to override any val‐
ues for locale categories specified by the settings of
LANG or any environment variables beginning with LC_.
LC_CTYPE Determines the interpretation of sequences of bytes of
text data as characters (e.g., single-versus multibyte
characters in values for vendor-defined attributes).
LC_MESSAGES
Determines the language in which messages should be
written.
LC_TIME Determines the format of dates (create_date and
mod_date) when displayed by swlist. Used by all util‐
ities when displaying dates and times in stdout, log‐
ging.
TZ Determines the time zone for use when displaying dates
and times.
Signals
The swlist command catches the signals SIGQUIT and SIGINT. If these
signals are received, swlist 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 swlist 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 swlist to
be used as input to other commands. The one exception is the list that
contains files; file-level output is not accepted by other commands.
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 swlist is invoked with no software_selections and no target_selec‐
tions, a listing of all installed products on the local host is pro‐
duced. This listing contains one line for each product. The line
includes the product tag attributes and all other attributes selected
via the one_liner option.
If target_selections (i.e. target hosts) are specified, this same for‐
mat listing is produced for the installed software at each of the spec‐
ified hosts.
Software Listing
A listing of software objects is controlled by the specified soft‐
ware_selections, and also by the -l option ( swlist.level=). swlist
lists the contents of each software object specified in the soft‐
ware_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 -l 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 -l 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 -l product. If
you want to list specific fileset selections but not their contained
files, use -l fileset. The software_selection options only apply if
the level is bundle, product, subproduct, fileset, file, or patch.
Depot Listing
Another class of objects that swlist can display are software depots.
For example, the user can list all registered depots on a given host. A
combination of the -l depot option and target_selections operands can
produce a variety of depot listings.
Multiple Targets Listing
Multiple target_selections (i.e. 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 tar‐
get_selection, etc.
Verbose Listing
The -v option causes a verbose listing to be generated. A verbose
listing includes all attributes defined for an object. The swlist com‐
mand prints the keyword and value for each attribute. The attributes
are listed one per line. The user can post-process (filter) the output
with grep(1), awk(1), and/or sed(1) to get the fields of interest.
The depot's attributes are displayed if swlist is called with the -v
and -l depot options, and a specific depot target_selection.
Attributes for a particular software level (product/subproduct/file‐
set/file) are displayed based on the depth of the specified soft‐
ware_selections. For example, swlist-v product1.fileset1 will give
all fileset attributes for fileset1. If the -v option is used with the
-l option, the different listing are:
· To display attributes for all products, use swlist-v -l prod‐
uct
· To display attributes for all products and subproducts, use
swlist-v -l subproduct
· To display attributes for all products and filesets, use
swlist-v -l fileset
· To display attributes for all products, filesets, and files,
use
swlist-v -l file
RETURN VALUE
The swlist command returns:
0 The software_selections and/or target_selections were suc‐
cessfully listed.
1 The list operation failed on all target_selections.
2 The list operation failed on some target_selections.
DIAGNOSTICS
The swlist command writes to stdout, stderr, and to the agent logfile.
Standard Output
All listings are printed to stdout.
Standard Error
The swlist command writes messages for all WARNING and ERROR conditions
to stderr.
Logging
The swlist command does not log summary events. It logs events about
each read task to the swagent logfile associated with each tar‐
get_selection.
You can use the swlist interactive interface (swlist -i -d) to view the
swaudit.log file.
EXAMPLES
Run the swlist interactive interface:
swlist-i @ host1
Use interactive swlist to view a depot:
swlist-i -d @ /tmp/depot
List all of the products installed on the local host:
swlist
Generate a comprehensive listing that includes all filesets for the
product NETWORKING:
swlist-v -l fileset NETWORKING
List all the attributes for the ARPA-RUN fileset:
swlist-v NETWORKING.ARPA.ARPA-RUN
List the C product installed on several remote hosts:
swlist cc @ hostA hostB hostC
List the FRAME product relocated to directory /opt on host1:
swlist FRAME,1=/opt @ host1
List all the versions of the FRAME product installed on the toolserver
host:
swlist FRAME @ toolserver
List the contents of the local tape, /dev/ntape/tape0:
swlist-d @ /dev/ntape/tape0
or, alternatively:
swlist-s /dev/ntape/tape0
List the tag and revision attributes for all products on the local tape
/dev/ntape/tape0:
swlist-d -a revision @ /dev/ntape/tape0
or, alternatively:
swlist-a revision -s /dev/ntape/tape0 @
Display the README file for the FRAME product:
swlist-a readme FRAME
List the products stored in a remote depot:
swlist-d @ hostA:/depot
List all depots on a host:
swlist-l depot @ hostA
List the categories defined in the depot mounted at /CD.
swlist-d -l category @ /CD
Output:
critical_patch 1.0 Patches to fix system hangs or data corruption
S747_upgrade 2.0 Patches needed to upgrade to an S747
security_patch 2.0 Patches affecting system security
List a particular attribute of a category object identified by the tag
critical_patch.
swlist-a description -l category critical_patch
Use the swlist-l option and patch level to display the values of a
fileset's applied_patches attribute.
swlist-l patch BogusProduct
Output:
BogusProduct 1.0 This is a Bogus Product
BogusProduct.FakeFS Fake fileset
PHZX-0004.FakeFS Patch for defect X superseded
PHZX-3452.FakeFS Patch for defect Y applied
Another example showing just the patch:
swlist-l patch PHZX-0004
Output:
PHZX-0004 1.0 Patch product
PHZX-0004.FakeFS Patch for defect X superseded
FILES
$HOME/.swdefaults
Contains the user-specific default values for some or all SWMGR
options.
$HOME/.sw/sessions/
Contains session files automatically saved by the SWMGR com‐
mands, or explicitly saved by the user.
/usr/lib/sw/sys.defaults
Contains the master list of current SWMGR options (with their
default values).
/var/adm/sw/
The directory which contains all of the configurable (and non-
configurable) data for SWMGR. This directory is also the
default location of logfiles.
/var/adm/sw/defaults
Contains the active system-wide default values for some or all
SWMGR options.
/var/adm/sw/host_object
The file which stores the list of depots registered at the local
host.
/var/adm/sw/products/
The Installed Products Database (IPD), a catalog of all products
installed on a system.
/var/spool/sw/
The default location of a source and target software depot.
SEE ALSOsd(4), sd(5), swacl(8), swagentd(8), swask(8)swconfig(8), swget‐
tools(8), swinstall(8), swmodify(8), swpackage(8), swpackage(4),
swreg(8), swremove(8), swverify(8), and the Managing Tru64 UNIX Soft‐
ware With the SysMan Software Manager manual.
swlist(8)
