DragonFly On-Line Manual Pages

Search: Section:  


PKG(8)		       DragonFly System Manager's Manual		PKG(8)

NAME

pkg, pkg-static -- manipulate packages

SYNOPSIS

pkg [-v] [-d] [-l] [-N] [-j <chroot path> | -r <root directory>] [-C <configuration file>] [-R <repository configuration directory>] [-4 | -6] <command> <flags> pkg [--version] [--debug] [--list] [-N] [--jail <jail name or id> | --chroot <chroot path> | --rootdir <root directory>] [--config <configuration file>] [--repo-conf-dir <repository configuration directory>] [-4 | -6] <command> <flags>

DESCRIPTION

pkg provides an interface for manipulating packages: registering, adding, removing and upgrading packages. pkg-static is a statically linked vari- ant of pkg typically only used for the initial installation of pkg. There are some differences in functionality. See pkg.conf(5) for details.

OPTIONS

The following options are supported by pkg: -v, --version Display the current version of pkg. -d, --debug Show debug information. -l, --list List all the available command names, and exit without performing any other action. The -v option takes precedence over -l but -l will override any other command line arguments. -o <option=value>, --option <option=value> Set configuration option for pkg from the command line. Options that are set from the environment are redefined. It is permitted to specify this option multiple times. -N Activation status check mode. Prevent pkg from automatically creating or initializing the SQLite database in /var/db/pkg/local.sqlite if it does not already exist. Prevent pkg from performing any actions if no packages are cur- rently installed, on the basis that a correctly initialised sys- tem using pkg will always have at least the pkg package itself registered. If used without any other arguments, pkg -N will run the sanity tests and if successful print out a short message showing how many packages are currently installed. The exit status should be a reliable indication of whether a system is configured to use pkg as its package management system or not. Example usage: if pkg -N >/dev/null 2>&1; then # pkgng-specifics else # pkg_install-specifics fi The -N flag was first released in the /usr/sbin/pkg bootstrapper in FreeBSD 8.4, but was missing from FreeBSD 9.1. It may not be enough to just call pkg -N, as the bootstrapper may be invoked, or an error returned from pkg. The following script is the safest way to detect if pkg is installed and activated: if TMPDIR=/dev/null ASSUME_ALWAYS_YES=yes \ PACKAGESITE=file:///nonexistent \ pkg info -x 'pkg(-devel)?$' >/dev/null 2>&1; then # pkgng-specifics else # pkg_install-specifics fi -c <chroot path>, --chroot <chroot path> pkg will chroot in the <chroot path> environment. -r <root directory>, --rootdir <root directory> pkg will install all packages within the specified <root directory>. -C <configuration file>, --config <configuration file> pkg will use the specified file as a configuration file. -R <repo conf dir>, --repo-conf-dir <repo conf dir> pkg will search the directory for per-repository configuration files. This overrides any value of REPOS_DIR specified in the main configuration file. -4 pkg will use IPv4 for fetching repository and packages. -6 pkg will use IPv6 for fetching repository and packages.

COMMANDS

The following commands (or their unambiguous abbreviations) are supported by pkg: help command Display usage information of the specified command. add Install a package from either a local source or a remote one. When installing from remote source you need to specify the proto- col to use when fetching the package. Currently supported protocols are FTP, HTTP and HTTPS. annotate Add, modify or delete tag-value style annotations on packages. alias List the command line aliases. audit Audit installed packages against known vulnerabilities. autoremove Delete packages which were automatically installed as dependen- cies and are not required any more. backup Dump the local package database to a file specified on the com- mand-line. bootstrap This is for compatibility with the pkg(7) bootstrapper. If pkg is already installed, nothing is done. If invoked with the -f flag an attempt will be made to reinstall pkg from remote repository. check Sanity checks installed packages. clean Clean the local cache of fetched remote packages. convert Convert to and from the old pkg_add(1) format. create Create a package. delete Delete a package from the database and the system. fetch Fetch packages from a remote repository. info Display information about installed packages. install Install a package from a remote package repository. If a package is found in more than one remote repository, then installation happens from the first one. Downloading a package is tried from each package repository in turn, until the package is success- fully fetched. lock Prevent modification or deletion of a package. plugins List the available plugins. query Query information about installed packages. register Register a package in the database. repo Create a local package repository for remote usage. rquery Query information for remote repositories. search Search for the given pattern in the remote package repositories. set Modify information in the installed database. shell Open a SQLite shell to the local or remote database. Extreme care should be taken when using this command. shlib Displays which packages link to a specific shared library. stats Display package database statistics. unlock Unlocks packages, allowing them to be modified or deleted. update Update the available remote repositories as listed in pkg.conf(5). updating Display UPDATING entries of installed packages. upgrade Upgrade a package to a newer version. version Summarize installed versions of packages. which Query the database for package(s) that installed a specific file.

ENVIRONMENT

All configuration options from pkg.conf(5) can be passed as environment variables. Extra environment variables are: INSTALL_AS_USER Allow to do all manipulation as a regular user instead of checking for root credentials when appropriate. It is expected that the user will ensure that every file and directory manipulated by pkg are readable (or writable where appropriate) by the user.

FILES

See pkg.conf(5).

EXAMPLES

Search for a package: $ pkg search perl Install a package: Installing must specify a unique origin or version otherwise it will try installing all matches. % pkg install perl-5.14 List installed packages: $ pkg info Upgrade from remote repository: % pkg upgrade Change the origin for an installed package: % pkg set -o lang/perl5.12:lang/perl5.14 % pkg install -Rf lang/perl5.14 List non-automatic packages: $ pkg query -e '%a = 0' %o List automatic packages: $ pkg query -e '%a = 1' %o Delete an installed package: % pkg delete perl-5.14 Remove unneeded dependencies: % pkg autoremove Change a package from automatic to non-automatic, which will prevent autoremove from removing it: % pkg set -A 0 perl-5.14 Change a package from non-automatic to automatic, which will make autoremove allow it be removed once nothing depends on it: % pkg set -A 1 perl-5.14 Create package file from an installed package: % pkg create -o /usr/dports/packages/All perl-5.14 Determine which package installed a file: $ pkg which /usr/local/bin/perl Audit installed packages for security advisories: $ pkg audit Check installed packages for checksum mismatches: # pkg check -s -a Check for missing dependencies: # pkg check -d -a

SEE ALSO

SBUF(9), elf(3), fetch(3), libarchive(3), pkg_printf(3), pkg_repos(3), pkg-repository(5), pkg.conf(5), pkg-add(8), pkg-annotate(8), pkg-audit(8), pkg-autoremove(8), pkg-backup(8), pkg-check(8), pkg-clean(8), pkg-config(8), pkg-convert(8), pkg-create(8), pkg-delete(8), pkg-fetch(8), pkg-info(8), pkg-install(8), pkg-lock(8), pkg-query(8), pkg-register(8), pkg-repo(8), pkg-rquery(8), pkg-search(8), pkg-set(8), pkg-shell(8), pkg-shlib(8), pkg-ssh(8), pkg-stats(8), pkg-update(8), pkg-updating(8), pkg-upgrade(8), pkg-version(8), pkg-which(8) To build your own package set for one or multiple servers see ports-mgmt/poudriere

HISTORY

The pkg command first appeared in FreeBSD 9.1.

AUTHORS AND CONTRIBUTORS

Baptiste Daroussin <bapt@FreeBSD.org>, Julien Laffaye <jlaffaye@FreeBSD.org>, Philippe Pepiot <phil@philpep.org>, Will Andrews <will@FreeBSD.org>, Marin Atanasov Nikolov <dnaeon@gmail.com>, Yuri Pankov <yuri.pankov@gmail.com>, Alberto Villa <avilla@FreeBSD.org>, Brad Davis <brd@FreeBSD.org>, Matthew Seaman <matthew@FreeBSD.org>, Bryan Drewery <bryan@shatow.net>, Eitan Adler <eadler@FreeBSD.org>, Romain Tarti`ere <romain@FreeBSD.org>, Vsevolod Stakhov <vsevolod@FreeBSD.org>, Alexandre Perrin <alex@kaworu.ch>

BUGS

See the issue tracker at https://github.com/freebsd/pkg/issues Please direct questions and issues to the pkg@FreeBSD.org mailing list. DragonFly 5.5 October 31, 2015 DragonFly 5.5 PKG-CREATE(8) DragonFly System Manager's Manual PKG-CREATE(8)

NAME

pkg create -- a utility for creating software package distributions

SYNOPSIS

pkg create [-nqv] [-f format] [-o outdir] [-p plist] [-r rootdir] -m metadatadir pkg create [-nqv] [-f format] [-o outdir] [-r rootdir] -M manifest pkg create [-gnqvx] [-f format] [-o outdir] [-r rootdir] pkg-name ... pkg create [-nqv] [-f format] [-o outdir] [-r rootdir] -a pkg create [--no-clobber] [--quiet] [--verbose] [--format format] [--out-dir outdir] [--plist plist] [--root-dir rootdir] --metadata metadatadir pkg create [--no-clobber] [--quiet] [--verbose] [--format format] [--out-dir outdir] [--root-dir rootdir] --manifest manifest pkg create [--{glob,no-clobber,regex}] [--quiet] [--verbose] [--format format] [--out-dir outdir] [--root-dir rootdir] pkg-name ... pkg create [--no-clobber] [--quiet] [--verbose] [--format format] [--out-dir outdir] [--root-dir rootdir] --all

DESCRIPTION

pkg create is used to create packages from binaries or other files installed on your computer. Package tarballs can be created from the files of a previously installed package using metadata from the local package database. Any number of packages may be created in one invoca- tion of this style. Alternatively, a single package can be created from an arbitrary selec- tion of files on your system, but this requires a metadatadir and option- ally plist to be supplied. The package name will be derived from the +MANIFEST file which must be contained within the metadatadir, or passed as the argument to -M. Packages thus created can be distributed and subsequently installed on other machines using the pkg add command.

OPTIONS

The following options are supported by pkg create: -a, --all Create package tarballs from all packages installed on your system. This option is incompatible with the -g, -x or -m metadatadir options. -g, --glob Interpret pkg-name as a shell glob pattern and create package only for installed binaries whose name match this pattern. This option is incompatible with the -a, -x or -m metadatadir options. -x, --regex Like -g, but interpret pkg-name as a regular expression using the "modern" or "extended" syntax described in re_format(7). This option is incompatible with the -a, -g or -m metadatadir options. -f format, --format format Set format as the package output format. It can be one of txz, tbz, tgz or tar which are currently the only sup- ported formats. If an invalid or no format is specified txz is assumed. -m metadatadir, --metadata metadatadir Specify the directory containing the package manifest, +MANIFEST and optionally three other files; one contain- ing a message to be displayed on package installation, +DISPLAY. Another containing the description for the package, +DESC. If specified, only a single package will be created. +DISPLAY and +DESC are not required; the +MANIFEST file can contain all the required information needed to build a package. This option is incompatible with the -M, -a, -g or -x options. -M manifest, --manifest manifest Read all of the package metadata from the manifest file. This is exactly the same format as +MANIFEST mentioned above, but any file name can be used, and no other file will be used to read package metadata from. If speci- fied, only a single package will be created. This option is incompatible with the -m, -a, -g or -x options. -n, --no-clobber Do not overwrite already existing packages. -o outdir, --out-dir outdir Set outdir as the output directory. If this option is not given, all created packages will be saved in the cur- rent directory. -p plist, --plist plist Specify some package metadata using the legacy plist for- mat from pkg_add(1), commonly found in pkg-plist files in the ports tree. Metadata from the plist file, if speci- fied, will take precedence over any equivalents from the metadatadir. Only has any effect when used with metadatadir. See PLIST FORMAT for details. -q, --quiet Force quiet output. This is the default, unless PKG_CREATE_VERBOSE is set to yes in pkg.conf. -v, --verbose Force verbose output, the opposite of --quiet. -r rootdir, --root-dir rootdir rootdir specifies the top-level directory to be treated as the root of the filesystem hierarchy containing the package files. File paths in generated packages will be relative to rootdir. This allows a package to be gener- ated from content offset from its intended final loca- tion, which allows a package building without disturbing similar content already on the system. If unspecified, the default is effectively /, the actual root directory.

MANIFEST FILE DETAILS

name pkg-name This entry sets the package's name to pkg-name. Among other things, this name is used - with the version and the origin of the concerned package - to identify a dependency. version pkg-version This entry sets the package's version to pkg-version. origin pkg-origin This entry sets the package's origin to pkg-origin. This is a string of the form category/port-dir which designates the port this package was built from. comment comment-string comment-string is a one-line description of this package. It is the equivalent of the COMMENT variable for a port, not a way to put com- ments in a +MANIFEST file. desc description description is a longer description of the package. It is the equivalent of the pkg-descr file for a port. It may be one to a few paragraphs. For example: desc = <<EOD This is a longer description of the package. It can span multiple lines. It can also span multiple paragraphs. EOD arch cpu-type The architecture of the machine the package was built on. cpu-type takes values like x86, amd64... www url The software's official website. maintainer mail-address The maintainer's mail address. prefix path-prefix The path where the files contained in this package are installed (usually /usr/local). flatsize size The size that the files contained in this package will occupy on your system once uncompressed. This value does not take into account files stored in the package database. deps dep-name dep-origin dep-version Associative array of package dependencies, keyed on dep-name and with values version dep-version and origin dep-origin. For example: "deps" : { "pstree" : { "version" : "2.36", "origin" : "sysutils/pstree" }, "cdiff" : { "version" : "0.9.6.20140711,1", "origin" : "textproc/cdiff" }, }, conflict pkg-glob Flag this package as incompatible with the one designated by pkg-glob. Conflicting packages cannot be installed on the same sys- tem as they may contain references to the sames files. option option-name option-value Set the option option-name to the value option-value. file sha256-hash path file entries list files included in the package. If the file is a regular one, such an entry contains its sha256 digest along with its path. If a packaged file is a link, you must use this entry's other form, as described below. file - path Same as above but for file links. The sha256 hash is replaced with a - (dash). dir path Mimics the file entry but for directories.

PLIST FORMAT

The following describes the plist format: The plist is a sequential list of lines which can have keywords prepended. A keyword starts with an `@'. Lines not starting with a key- word are considered as paths to a file. If started with a `/' then it is considered an absolute path. Otherwise the file is considered as rela- tive to PREFIX. Keyword lines are formed as follows: @keyword line Available keywords are the following: @cwd [directory] Set the internal directory pointer to point to directory. All subsequent filenames will be assumed relative to this directory. @preexec Command Execute command as part of the pre-install scripts. @preunexec command Execute command as part of the pre-deinstall scripts. @postexec command Execute command as part of the post-install scripts. @postunexec command Execute command as part of the post-deinstall scripts. @exec command (deprecated) Execute command as part of the unpacking process. If command contains any of the following sequences somewhere in it, they will be expanded inline. For the following examples, assume that @cwd is set to /usr/local and the last extracted file was bin/emacs. %F Expands to the last filename extracted (as specified), in the example case bin/emacs %D Expand to the current directory prefix, as set with @cwd, in the example case /usr/local. %B Expand to the ``basename'' of the fully qualified file- name, that is the current directory prefix, plus the last filespec, minus the trailing filename. In the example case, that would be /usr/local/bin. %f Expand to the filename part of the fully qualified name, or the converse of %B, being in the example case, emacs. @unexec command (deprecated) Execute command as part of the deinstallation process. Expansion of special % sequences is the same as for @exec. This command is not executed during the package add, as @exec is, but rather when the package is deleted. This is useful for deleting links and other ancillary files that were created as a result of adding the package, but not directly known to the package's table of con- tents (and hence not automatically removable). @mode mode Set default permission for all subsequently extracted files to mode. Format is the same as that used by the chmod command. Use without an arg to set back to default (mode of the file while being packed) permissions. @owner user Set default ownership for all subsequent files to user. Use without an arg to set back to default (root) ownership. @group group Set default group ownership for all subsequent files to group. Use without an arg to set back to default (wheel) group owner- ship. @comment string The line will be ignored when packing. @dir name Declare directory name to be deleted at deinstall time. By default, most directories created by a package installation are deleted automatically when the package is deinstalled, so this directive is only needed for empty directories or directories outside of PREFIX. These directives should appear at the end of the package list. If the directory is not empty a warning will be printed, and the directory will not be removed. (Subdirecto- ries should be listed before parent directories.)

ENVIRONMENT

The following environment variables affect the execution of pkg create. See pkg.conf(5) for further description. PKG_DBDIR PLIST_KEYWORDS_DIR PORTSDIR

FILES

See pkg.conf(5).

EXAMPLES

Create package files for installed packages: % pkg create -a -o /usr/dports/packages/All Create package file for pkg: % pkg create -o /usr/dports/packages/All pkg

SEE ALSO

pkg_printf(3), pkg_repos(3), pkg-repository(5), pkg.conf(5), pkg(8), pkg-add(8), pkg-annotate(8), pkg-audit(8), pkg-autoremove(8), pkg-backup(8), pkg-check(8), pkg-clean(8), pkg-config(8), pkg-convert(8), pkg-delete(8), pkg-fetch(8), pkg-info(8), pkg-install(8), pkg-lock(8), pkg-query(8), pkg-register(8), pkg-repo(8), pkg-rquery(8), pkg-search(8), pkg-set(8), pkg-shell(8), pkg-shlib(8), pkg-ssh(8), pkg-stats(8), pkg-update(8), pkg-updating(8), pkg-upgrade(8), pkg-version(8), pkg-which(8) DragonFly 5.5 September 26, 2015 DragonFly 5.5

Search: Section: