The following sections describe the IPS commands used to set up a repository, publish packages to a repository, and retrieve the package contents from a repository. The image packaging system publication client, pkgsend, enables the publication of new packages and new package versions to an image packaging repository. Each publication is structured as a transaction. Transactions can contain actions as described in the section Actions in IPS.The pkgsend1 command supports the following options.Option Description s repo_uri Specify a different repository server. The default repository is http://localhost:10000. ? or -help Display usage message. The pkgsend1 command supports the following sub commands.Subcommand Description create-repository Creates a new repository at the specified location if it does not already exist. This subcommand is only supported for file:// repository locations for the OpenSolaris 2009.06 release. open Begins a transaction on the package specified by pkg_fmri. A transaction_id is printed to the screen when the command executes successfully.Syntax : pkgsend open en pkg_fmrie– Use this option to prepend export PKG_TRANS_ID= to the transaction_id. This option can be used by the shell to evaluate the output and set the environment variable PKG_TANS_ID. This environment variable can be used when executing future pkgsend commands within the same transaction. If the -n option is given, the transaction ID is displayed as a string; n Use this option to display the transaction ID as a string. add Adds an action to the current transaction. Syntax : pkgsend add actions pkg_fmri include Adds multiple actions present in each manifest file to the current transaction. Each line in the file should be the string representation of an action. Do not use this sub command with the add, open or close sub commands.Syntax : pkgsend include [d basedir] filename import bundlefile Adds each given bundlefile into the current transaction. An SVR4 package is an example of a bundlefile.Syntax : pkgsend import [T pattern] bundlefileUse the following shell matching rules with the pattern option to add the timestamp of the file to the action of that file, if the basename of the files in the bundle match the optional patterns.The basename refers to the last component of a path name. For example, in the path /usr/bin/ls, the basename is ls. * – Matches everything. ? – Matches any single character. [seq] – Matches any character in sequence. [!seq] — Matches any character not in sequence. When a timestamp is added to a file's actions, the file will be installed with precisely that timestamp, regardless of the actual time of installation. This is particularly useful in cases where the software requires a particular timestamp on the files it reads. For instance, python wants the executable files .py that are installed to have the same timestamp on the filesystem as is recorded in the compiled versions (.pyc) of those files. close Close the current transaction.Syntax : pkgsend close [-A]The A option abandons the current transaction. Use this option to remove all information of a transaction such as package and file information, from a server when a transaction is canceled before it is completed. Note the following limitations of using the pkgsend command:Use the pkgsend command only if one or two packages at a time are being published to the repository. The pkgsend command does not resolve dependencies. If more than one package is being published to the repository, you must manually resolve all package dependencies. When you are publishing a newer version of a package to the repository, specify the FMRI of the package correctly. The new version of the package will coexist with any prior version already in the repository. IPS manages software in units of packages. Packaging a product aids in easy distribution and installation of the software product.A package is a collection of files, directories, links, drivers, and dependencies in a defined format. This collection represents the installable objects of a package. In IPS terminology, this collection is referred to as actions.Actions are described in a package's manifest. Every action consists primarily of its name and a key attribute. Together, these attributes refer to a unique object and include a version history. Actions can have other attributes. Some of these attributes are interpreted directly by the packaging system, while others are useful only to the system administrator or the end user.If you have multiple actions in a manifest, the order in which they are placed does not matter. All actions are appropriately sorted before they are executed.The attributes of a package are different from the attributes of an action. To learn about the supported tags and attributes for a package, see Package Tags and Attributes section . Typically, only an action's key attribute is required, though some actions might work properly only with a more complete set of attributes. The following list provides an overview of the type of actions and their standard attributes that are available with IPS. For additional details, see the pkg5 man page.pkg5 refers to the image packaging system and is different from the pkg(1) command, which is the retrieval client and is used to create, install, and manage images on the system The following table shows a list of the actions and their key attributes. For a complete list, refer to the pkg(5) man page. Action Description and Key Attributes Directory The directory action represents a directory as a file system object.path – The file system path where the file is installed. File The file action represents an ordinary file as a file system object.path – The file system path where the file is installed. Link The link action represents a symbolic link.path – The file system path where the symlink is installed. Hardlink The hardlink action represents a physical link.path – The file system path where the link is installed. Driver The driver action represents a device driver. It does not reference a payload. the driver files must be installed as file actions.name – The name of the driver. This is usually, but not always, the file name of the driver binary. Depend The depend action represents a dependency between packages. A package might depend on another package to work or to install. Dependencies are optional.No key attribute is defined. License The license action represents a license or other information associated with the package contents. A package can deliver licenses or disclaimers to the package installer through the use of the license action. The payload of the license action is delivered into the image metadata directory associated with the package.license – The keyword identifying the license type, for use in filter and query operations. Legacy The legacy action represents package data used by a legacy packaging system. The attributes associated with this action are added to the legacy system's databases so that the tools querying those databases might operate as if the legacy package were actually installed.pkg – The abbreviation for the package being installed. The name of the package in the package FMRI is the default value. Set The set action represents a package-level attribute, such as the package description.No key attribute is defined. Group The group action defines a UNIX group as defined in group(4). No support is present for group passwords. Groups defined with this action initially have no user-list. Users can be added with the user action.No key attribute is defined. User The User action defines a UNIX user as defined in /etc/passwd, /etc/shadow, /etc/group, and /etc/ftpd/ftpusers files. Users defined with this attribute have entries added to the appropriate files.No key attribute is defined. You can set the attributes and tags of a package with the set action.Packages carry information about themselves in the form of metadata, which is also informally known as attributes and tags. Attributes refer to settings that apply to an entire package. Tags are the settings that affect individual files within a package. The developer who develops the package provides specific information about the package through the tags and attributes. The pkg attribute is the attribute that is common to all packages, regardless of any particular OS platforms that a specific package might target. The IPS packages can contain the following set of tags and attributes.Attribute Description Package Name : pkg.name Short, descriptive name of the package. Package Description : pkg.description A short paragraph describing the package. Package URL: pkg.detailed_url Provides links to sites with further information about the package. Tag Description Debug Information: pkg.debug Specifies if the package needs to be installed in a debug configuration. ISA Distinguishes between different x86 platforms. The opensolaris attribute is the attribute that is common to all OpenSolaris packages. In the following table, except for the ISA attribute, all attributes have opensolaris appended to them. For example, the attribute arc.url should be specified as opensolaris.arc_url. OpenSolaris Attribute Description arc_url One or more URLs associated with the ARC case(s) associated with the component(s) delivered by the package. maintainer A human—readable string describing the entity that provides the package. For an individual, this string is the individual's name, or name and email address. variant.arch Identifies actions particular to the architecture, x86 or SPARC. upstream A human—readable string describing the entity that creates the software. For an individual, this string is expected to be the individual's name, or name and email. upstream_url A URL associated with the entity that creates the software delivered within the package. source_url A URL to the source code bundle, if appropriate, for the package. repository_url A URL to the source code repository, if appropriate, for the package. repository_changeset A change-set ID for the version of the source code contained in opensolaris.repository_url attribute. gui.classification A list of labels classifying the package into the categories shared among pkg(5)graphical clients. The pkg1 command makes requests of the repository, also called the depot server, for catalogs and packages. The pkgsend1 command sends new versions of packages to the depot server. The depot server is typically run as a service on the system. Package and software developers can run private copies for various testing purposes. The pkg.depotd service is managed by the service management facility, smf(5), under the service identifier: svc:/application/pkg/server. Because the depot server expects to be run by a smf(5) restarter, it does not run as a daemon process. Error messages are generally sent to standard display, or to the syslogd1 system.The pkg.depotd(1M) command is also used with the SMF commands to set up a mirror repository. For an example of the pkg.depotd1M options and its usage with the SMF commands, see . The pkg.depotd server is usually configured through the smf1 properties associated with its service instance. The following properties are recognized.Property Description pkg/inst_root The file system path where this instance of the depot server should look for its repository data. The default value is /var/pkg/repo. pkg/port The port number on which this instance of the depot server should listen for incoming package requests. pkg/proxy_base This property is used to change the base URL for the depot server. This is useful when the depot server is running behind a web server in a reverse proxy configuration. pkg/socket_timeout The maximum number of seconds the server should wait for a response from a client before closing a connection. pkg/threads The number of threads that the depot server will initiate to serve requests from the client. The default value is 10. pkg/log_access The destination for any access—related information logged by the depot server. The destination could be one of the following:stdout stderr No destination. This is the default value. An absolute path name. pkg/log_errors The destination for any errors or other related information logged by the depot server. The destination could be one of the following :stdout stderr. This is the default value. No destination An absolute path name. pkg/mirror (boolean) This property indicates whether package mirror mode is used. When true, publishing and metadata operations are disabled and only a limited browser user interface is provided. This property may not be true when pkg/readonly is true . The default value is false. The pkg.depotd1M command has the following options to alter the default settings from the service instance.Option Description d repo_dir Specifies a different repository directory. Overrides pkg/inst_root with the value given by repo_dir. p port Specifies a different port number. Overrides pkg/port with the value given by port. sthreads Overrides pkg/threadswith the value given by threads. t socket_timeout Overrides pkg/socket_timeoutwith the value given by socket_timeout. -cfg-file cfg_file Overrides pkg/cfg_filewith the value given by cfg_file. -content-root root_dir Overrides pkg/content_rootwith the value given by root_dir. -debug features Overrides pkg/debugwith the value given by features. -log-access dest Overrides pkg/log_access with the value given by dest. -log-errors destination Overrides pkg/log_errors with the value given by destination. -proxy-base url Overrides pkg/proxy_base with the value given by url. -mirror Overrides pkg/mirror and sets the value to True. -readonly Disables modifying operations, such as those initiated by pkgsend1M. Retrieval operations are still available. -rebuild Destroys any existing repository catalog and then recreates on startup. -writable-root Overrides pkg/writable_root with the value given by path. -ssl-key-file Overrides pkg/ssl_key_file with the value given by source. -ssl-dialog Overrides pkg/ssl_dialog with the value given by type. -ssl-cert-file Overrides pkg/ssl_cert_file with the value given by source. For further information, see the pkg.depotd(1M) man page.Type the following command as root user to enable the depot server. In this example, application/pkg/server is the depot server.# svcadm enable application/pkg/server Type the following sequence of commands as root user to change the listening port of the depot server. This example sets the listening port of the depot server to 9999.# svccfg -s application/pkg/server set pkg/port = 9999 # svcadm refresh application/pkg/server # svcadm restart application/pkg/server The pkgrecv command enables the user to retrieve the manifest and contents of a package from a package repository. The contents can be retrieved in a format that enables the user to modify the package and republish it by using the pkgsend command. The pkgrecv command is complementary to the pkgsend command.The following options are supported with the pkgrecv command.s repo_url Specifies the url or address of the server from where you want to receive the package contents. k Keeps the individual package contents compressed. d directory The directory where the package contents should be placed. The default location is the current working directory. n Lists the most recent versions of the packages available at the specified server. The package contents are not downloaded.Example: List the most recent versions of the packages available at test-server.# pkgrecv —s http://test-server —n pkg:/SUNWlibC@0.5.11,5.11-0.79:20080221T125720Z pkg:/SUNWfreetype2@0.5.11,5.11-0.79:20080221T123955Z pkg:/SUNWlibm@0.5.11,5.11-0.79:20080221T125728Z pkg:/SUNWliboil@0.5.11,5.11-0.79:20080221T125730ZExample : Receives the SUNWlibC, SUNWfreetype, and SUNWlibm packages from the test server.# pkgrecv -s http://test SUNWlibC@0.5.11,5.11-0.79:20080221T125720Z SUNWfreetype2@0.5.11,5.11-0.79:20080221T123955Z SUNWlibm@0.5.11,5.11-0.79:20080221T125728Z $ ls -d SUNW* SUNWfreetype2 SUNWlibC SUNWlibm For further information, see the pkgrecv(1) man page.