.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-AUDIT 8

.Os

.Sh NAME

.Nm "pkg audit"

.Sh SYNOPSIS

.Nm

.Op Fl Fqr

Prints only the requested information without

displaying many hints.

.It Fl r , Cm --recursive

potentially vulnerable as well.

.El

.Sh ENVIRONMENT

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-CHECK 8

.Os

.Sh NAME

.Ar pattern

case insensitive.

This is the default, unless modified by setting

to true in

.Pa pkg.conf .

.It Fl n , Cm --dry-run

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-CLEAN 8

.Os

.Sh NAME

.Nm "pkg clean"

.Sh SYNOPSIS

.Nm

.Op Fl anqy

.It Fl a , Cm --all

Delete all cached packages.

.It Fl n , Cm --dry-run

would be done instead.

Forces the preview of the packages that would be deleted to be shown,

even when used with

is also used.

.It Fl y , Cm --yes

Assume a yes answer instead of asking for confirmation before deleting

.El

.Sh ENVIRONMENT

The following environment variables affect the execution of

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-CREATE 8

.Os

.\" ---------------------------------------------------------------------------

.Ar txz , tbz , tgz

or

.Ar tar

If an invalid or no format is specified

.Ar txz

is assumed.

and optionally three other files; one containing a message to be

displayed on package installation,

.Pa +DISPLAY .

.Pa +DESC .

The last containing an mtree specification,

.Pa +MTREE_DIRS ,

.Fl x

options.

.It Fl n , Cm --no-clobber

.It Fl o Ar outdir , Cm --out-dir Ar outdir

Set

.Ar outdir

.Ar metadatadir .

See

.Sx "PLIST FORMAT"

.It Fl r Ar rootdir , Cm --root-dir Ar rootdir

.Ar rootdir

specifies the top-level directory to be treated as the root of the

.Ar pkg-origin .

This is a string of the form

.Pa category/port-dir

.It Cm comment Ar comment-string

.Ar comment-string

is a one-line description of this package.

Use without an arg to set back to default (wheel)

group ownership.

.It Cm @comment Ar string

.It Cm @dirrm Ar name

.Pa name

to be deleted at deinstall time.

By default, directories created by a package installation are not

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-FETCH 8

.Os

.Sh NAME

.Nm "pkg fetch"

.Sh SYNOPSIS

.Nm

.Op Fl r Ar reponame

Fetch all available updates for the currently installed packages.

.It Fl U , Cm --no-repo-update

Suppress the automatic update of the local copy of the repository catalogue

Automatic repository catalogue updates are only attempted when the

effective UID of the process has write access to the package database.

Otherwise they are silently ignored.

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-INFO 8

.Os

.Sh NAME

.Nm "pkg info"

.Sh SYNOPSIS

.Nm

.Ar pkg-name

Display the full manifest (raw) for the packages matching

.Ar pkg-name .

.It Fl -raw-format Ar format

json, json-conpact, yaml (default).

.It Fl e , Cm --exists

If

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-INSTALL 8

.Os

.Sh NAME

.Nm "pkg install"

.Sh SYNOPSIS

.Nm

.Op Fl AfIMnFqRUy

.Ar <pkg-origin|pkg-name|pkg-name-version> ...

.Sh DESCRIPTION

.Nm

local archives.

Multiple package names can be specified on the command line, either

explicitly or by matching against package names (or origins) in the repository

catalogues using shell globbing or regular expressions.

.Pp

.Nm

.Cm REPO_AUTOUPDATE

has been set to

.Sy NO

is run by a user ID with write access to the package database,

unless disabled by the

.Fl U

.Cm REPO_AUTOUPDATE

to

.Sy NO

Mark the installed packages as orphan.

Will be automatically removed if no other packages depend on them.

For more information please refer to

.It Fl C , Cm --case-sensitive

Make the standard or the regular expression

.Fl ( x )

.Pa repo.conf .

.It Fl U , Cm --no-repo-update

Suppress the automatic update of the local copy of the repository catalogue

Automatic repository catalogue updates are only attempted when the

effective UID of the process has write access to the package database.

Otherwise they are silently ignored.

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-QUERY 8

.Os

.Sh NAME

.Xr re_format 7 .

.El

.Sh QUERY FORMAT

one. Only one type of multiline pattern is accepted for a given query.

.Ss Normal patterns:

.Bl -tag -width F1

.It Cm \&%w

Home page of the matched package

.It Cm \&%l

.It Cm \&%s Ns Op bh

.Cm b

is in bytes, and

.Cm h

.It Cm \&%a

Returns 1 if the matched package is an orphan package and can be pkg-autoremove(1)'d, 0 otherwise

.It Cm \&%q

.It Cm \&%t

Timestamp that the package was installed

.It Cm \&%R

available, or

.Dq unknown-repository

.It Cm \&%? Ns Op drCFODLUGBbA

Returns 0 if the list is empty and 1 if the list has information to display

.Bl -tag -width indent

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-REGISTER 8

.Os

.Sh NAME

.Nm "pkg register"

.Sh SYNOPSIS

.Nm

.Op Fl dlOt

is used for registering a package into the local package database.

.Pp

.Nm

This is one of the final steps when installing software from ports:

the package files are installed into the filesystem, and then

.Nm

is called to record what was installed into the package database.

.Pp

.Nm

.Bl -bullet

.It

The package manifest

.Pp

The package manifest is a

.Cm UCL

but the more usual approach is to provide selected items via the

manifest, and fill in the rest, either from legacy files such as

.Fa pkg-plist ,

command.

.Pp

Reading in a complete and comprehensive manifest from one file is a

assembled beforehand.

.Pp

Direct analysis of the installed files can be suppressed by use of

The following options are supported by

.Nm :

.Bl -tag -width metadata

Mark the package to be automatically removed if no other packages

depend on it.

For more information please refer to

.Xr pkg-autoremove 8

Enable debugging output.

.It Fl f Ar plist-file , Cm --plist Ar plist-file

Specifies a

.Fa pkg-plist

.It Fl i Ar input-path , Cm --root Ar input-path

Specifies the package input path or staging directory.

.It Fl l , Cm --legacy

.It  Fl M Ar manifest , Cm --manifest Ar manifest

Specifies the package manifest file.

Use of this option means that the only file which will be used as a

.Ar manifest

file.

The

option is mutually exclusive with

.Fl m .

.It  Fl m Ar metadatadir , Cm --metadata Ar metadatadir

This directory will hold the package manifest, and optionally may contain

a number of other old-style metadata input files.

The

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-REPO 8

.Os

.Sh NAME

.Nm "pkg repo"

.Sh SYNOPSIS

.Nm

.Op Fl lqL

.Nm :

.Bl -tag -width quiet

.It Fl q , Cm --quiet

.It Fl L , Cm --legacy

.It Fl m Ar meta-file , Cm --meta-file Ar meta-file

Use the specified file as repository meta file instead of the default settings.

.It Fl l , Cm --list-files

.\"     @(#)pkg-repository.5

.\" $FreeBSD$

.\"

.Dt PKG-REPOSITORY 5

.Os

.Sh NAME

.Nm "package repository"

.Nd format and operation of package repositories used by

.Sh DESCRIPTION

.Nm "Package repositories"

used by the

will actually result in

.Pa example-1.0.1

being installed.

select the repository with the appropriate version:

.Bd -literal -offset indent

pkg install -r repo-a example-1.0.0

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-RQUERY 8

.Os

.Sh NAME

is run by a user ID with write access to the package database,

unless disabled by the

.Fl U

.Cm REPO_AUTOUPDATE

to

.Sy NO

.Nm :

.Bl -tag -width repository

.It Fl a , Cm --all

.It Fl C , Cm --case-sensitive

Make the standard or the regular expression

.Fl ( x )

.Xr re_format 7 .

.El

.Sh QUERY FORMAT

one. Only one type of multiline pattern is accepted for a given query.

.Ss Normal patterns:

.Bl -tag -width F1

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-SEARCH 8

.Os

.Sh NAME

.Nm

is used for searching package repository catalogues.

Packages available for installation can be matched by name, by name

descriptions.

The output defaults to displaying the field matched by the search

term, but any of the searchable fields may be displayed.

is run by a user ID with write access to the package database,

unless disabled by the

.Fl U

.Cm REPO_AUTOUPDATE

to

.Sy NO

Package repositories are defined in the

.Fa pkg.conf

file or by creating repository definitions in

.Xr pkg.conf 5

for details.

.Sh OPTIONS

.Qq Sx Search and Label Options

sections for more details.

.It Fl -raw-format Ar format

json, json-conpact, yaml (default).

.It Fl s , Cm --size

Display the installed size of matched packages.

.Fl "Q size" .

.It Fl U, Cm --no-repo-update

Suppress the automatic update of the local copy of the repository catalogue

Automatic repository catalogue updates are only attempted when the

effective UID of the process has write access to the package database.

Otherwise they are silently ignored.

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-SHLIB 8

.Os

.Sh NAME

.Nm "pkg shlib"

.Pp

.Ar library

including the ABI version number.

Only exact matches are handled.

.Sh SYNOPSIS

.Nm :

.Bl -tag -width provides

.It Fl P , Cm --provides

.Ar library .

.It Fl R , Cm --requires

Show only the installed packages which require

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-SSH 8

.Os

.Sh NAME

.Nm

.Sh DESCRIPTION

.Nm

.Pp

This command is not meant to be used by the user.

.Xr pkg 8

.Xr ssh 1

when the ssh:// scheme is specified in the repository configuration.

.Sh OPTIONS

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-STATS 8

.Os

.Sh NAME

.Nm "pkg stats"

.Sh SYNOPSIS

.Nm

.Op Fl qlrb

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-UPDATE 8

.Os

.Sh NAME

.Nm "pkg update"

.Sh SYNOPSIS

.Nm

.Op Fl fq

.Op Cm --repository Ar reponame

.Sh DESCRIPTION

.Nm

Updates to catalogues are normally downloaded only when the master

copy on the remote package repository is newer than the local copy.

.Pp

.Nm :

.Bl -tag -width quiet

.It Fl q , Cm --quiet

.It Fl f , Cm --force

Force a full download of the repository catalogue without regard to the

.It Fl r Ar reponame , Cm --repository Ar reponame

Download the catalogue for the named repository only.

This will update only the named repository, irrespective of the configured

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-UPDATING 8

.Os

.Sh NAME

.Nm "pkg updating"

.Sh SYNOPSIS

.Nm

.Op Fl d Ar date

The following options are supported by

.Nm :

.Bl -tag -width file

UPDATING entries for the named packages are displayed.

.It Fl d Ar date , Cm --date Ar date

Only entries newer than

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-UPGRADE 8

.Os

.Sh NAME

.Nm "pkg upgrade"

.Sh SYNOPSIS

.Nm

.Op Fl fInFqUy

.Nm

compares the versions of all or specific packages installed on the system

to what is available in the configured package repositories.

.Xr pkg-install 8

is that

.Nm

tries to upgrade dependencies of packages matched as well while

.Xr pkg-install 8

.Nm

cannot install new packages, so a caller should ensure that patterns specified

as arguments have installed candidates for matching.

Dry-run mode: show what packages have updates available, but do not perform

any upgrades.

Repository catalogues will be updated as usual unless the

option is also given.

.It Fl q , Cm --quiet

Force quiet output, except when

.Pa repo.conf .

.It Fl U , Cm --no-repo-update

Suppress the automatic update of the local copy of the repository catalogue

Automatic repository catalogue updates are only attempted when the

effective UID of the process has write access to the package database.

Otherwise they are silently ignored.

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-VERSION 8

.Os

.Sh NAME

.Pp

When

.Fl R

package repository catalogues will be automatically updated whenever

.Nm

is run by a user ID with write access to the package database,

The installed version of the package is older than the current version.

.It Li \&>

The installed version of the package is newer than the current version.

testing new ports.

.It Li \&?

The installed package does not appear in the index.

case sensitive.

.It Fl h , Cm --help

Displays usage information

.It Cm --index Op Ar index

Use

.Pa index

Be verbose.

.It Fl l Ar limchar , Cm --like Ar limchar

Display only the packages which status flag matches the one specified by

.It Fl L Ar limchar , Cm --not-like Ar limchar

Does the opposite of

.Fl l

Only display the packages that exactly match the string.

.It Fl O Ar origin , Cm --match-origin Ar origin

Display only the packages which origin matches

.It Fl t Ar version1 Ar version2 , Cm --test-version Ar version1 Ar version2

Test a pair of version number strings and exit.

The output consists of one of the single characters

or if that is not set,

.Ev PORTSDIR .

.Ev INDEXFILE

.Pa index

relative to that directory.

If

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-WHICH 8

.Os

.Sh NAME

.Nm "pkg which"

.Sh SYNOPSIS

.Nm

.Op Fl gopq

.Ao file Ac

as a glob pattern.

.It Fl o , Cm --origin

.It Fl p , Cm --path-search

Search for the filename in PATH.

.It Fl q , Cm --quiet

.El

.Sh ENVIRONMENT

The following environment variables affect the execution of

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG 8

.Os

.\" ---------------------------------------------------------------------------

.Sh NAME

.Nm pkg ,

.Nm pkg-static

.\" ---------------------------------------------------------------------------

.Sh SYNOPSIS

.Nm

.Ao command Ac Ao Ar flags Ac

.\" ---------------------------------------------------------------------------

.Sh DESCRIPTION

.Nm pkg-static

is a statically linked variant of

.Nm

.Nm :

.Bl -tag -width indent

.It Fl v , Cm --version

.It Fl d , Cm --debug

.It Fl l , Cm --list

List all the available command names, and exit without performing any

other action.

.It Fl o Ao option=value Ac , Cm --option Ao option=value Ac

Set configuration option for

.Nm

.It Fl N

Activation status check mode.

Prevent

.Nm

will chroot in the

.Ao chroot path Ac

.It Fl C Ao configuration file Ac , Cm --config Ao configuration file Ac

.Nm

.It Fl R Ao repo conf dir Ac , Cm --repo-conf-dir Ao repo conf dir Ac

.Nm

will search the directory for per-repository configuration files.

.It Ic annotate

Add, modify or delete tag-value style annotations on packages.

.It Ic audit

.It Ic autoremove

Delete packages which were automatically installed as dependencies and are not required any more.

.It Ic backup

.It Ic check

Sanity checks installed packages.

.It Ic clean

.It Ic convert

Convert to and from the old

.Xr pkg_add 1

format.

.It Ic create

.It Ic delete

Delete a package from the database and the system.

.It Ic fetch

.It Ic info

Display information about installed packages.

.It Ic install

.It Ic set

Modify information in the installed database.

.It Ic shell

Extreme care should be taken when using this command.

.It Ic shlib

Displays which packages link to a specific shared library.

.It Ic stats

Display package database statistics.

.It Ic unlock

.It Ic update

Update the available remote repositories as listed in

.Xr pkg.conf 5 .

.It Ic updating

.It Ic upgrade

Upgrade a package to a newer version.

.It Ic version

.\"     @(#)pkg.1

.\" $FreeBSD$

.\"

.Dt PKG.CONF 5

.Os

.Sh NAME

.Nm "pkg.conf"

.Xr pkg 1

.Sh DESCRIPTION

.Nm

.Nm :

.Bl -tag -width ".Cm ABI: string"

.It Cm ABI: string

Default: derived from the ABI of the /bin/sh binary.

.It Cm ALIAS: key/value list

Define local aliases for various

the

.Fl y

flag was specified.

.It Cm CUDF_SOLVER: string

Experimental: tells pkg to use an external CUDF solver.

Default: not set.

.It Cm CASE_SENSITIVE_MATCH: boolean

Match package names or regular expressions given on the command line

against values in the database in a case sensitive way.

.It Cm DEBUG_LEVEL: integer

Incremental values from 1 to 4 produce successively more verbose

debugging output.

Default: 0.

.It Cm DEBUG_SCRIPTS: boolean

Activate debug mode for scripts (aka set -x)

.It Cm DEVELOPER_MODE: boolean

Makes certain errors immediately fatal.

Adds various warnings and

.Xr pkg 1

as an aide to port maintainers, including indicating when the port

might be marked as architecture independent.

.It Cm EVENT_PIPE: string

Send all event messages to the specified fifo or Unix socket.

Events messages should be formatted as JSON.

.It Cm FETCH_TIMEOUT: integer

Maximum number of seconds to wait for any one file to download from the

network, either by SSH or any of the protocols supported by

functions.

Default: 30.

.It Cm HANDLE_RC_SCRIPTS: boolean

services during package installation and deinstallation.

Services are only started on installation if they are enabled in

.Pa /etc/rc.conf .

.It Cm INDEXDIR: string

If set, the directory to search for

.Cm INDEXFILE

resolution, overriding the system defaults in

.Pa /etc/resolv.conf .

When given as a hostname, will be converted to a list of IPv4 or IPv6

.Xr getaddrinfo 3 .

.It Cm PERMISSIVE: boolean

.It Cm PKG_CACHEDIR: string

Specifies the cache directory for packages.

.Pa /var/cache/pkg

.It Cm PKG_DBDIR: string

Specifies the directory to use for storing the package

.Pa /var/db/pkg

.It Cm PKG_ENABLE_PLUGINS: boolean

When set to

activate plugin support.

.It Cm PKG_ENV: Key/Value list

This tells

.Xr pkg 8

Directory containing definitions of plist keywords.

Default: not set.

.It Cm PLIST_ACCEPT_DIRECTORIES: boolean

.It Cm PLUGINS: array

.Xr pkg 8

should load.

Default: not set.

.Pa /usr/ports

.It Cm READ_LOCK: boolean

Use read locking for query database.

.It Cm REPOS_DIR: array

List of directories to search for repository configuration files.

Default:

.Nm pkg upgrade ,

or

.Nm pkg version -R .

.It Cm RUN_SCRIPTS: boolean

Run pre-/post-installation action scripts.

.It Cm SAT_SOLVER: string

Experimental: tells pkg to use and external SAT solver.

Default: not set.

.It Cm SQLITE_PROFILE: boolean

Profile sqlite queries.

.It Cm SSH_RESTRICT_DIR: string

Directory which the ssh subsystem will be restricted to.

Default: not set.

.It Cm SYSLOG: boolean

Log all the installation/deinstallation/upgrade operation via

.Xr syslog 3 .

.It Cm UNSET_TIMESTAMP: boolean

.Xr tar 1

archive.

Normally, timestamps are copied from the staging directory the

package is created from.

.It Cm VULNXML_SITE: string

Specifies the URL to fetch the

.Pa vuln.xml

Default:

.Pa http://www.vuxml.org/freebsd/vuln.xml.bz2 .

.It Cm WORKERS_COUNT: integer

.Va hw.ncpu

is used.

Default: 0.

.It Cm URL: string

URL for this repository only.

.It Cm ENABLED: boolean

.It Cm MIRROR_TYPE: string

Any of

.Dv HTTP

or

Earlier files take precedence, meaning that packages will be downloaded

from them preferentially where the same package is available from several

repositories.

.Sy repository

annotation to the installed package.

See

.Xr pkg-repository 8

.Pp

It is possible to specify more than one repository per file.

.Sh ENVIRONMENT

.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

.\" SUCH DAMAGE.

.\"

.Dt PKG_PRINTF 3

.Os

.Sh NAME

Effective format modifiers:

.Bl -tag -width ".So \  Sc" -offset indent

.It Cm \&?

of elements within it

.It Cm #

.El

.Ss STRING VALUES

Effective format modifiers:

.It Cm \-

Left align

.It Cm \&?

.It Cm #

.It Cm 0

Zero pad

.It So "\ " Sc

Effective format modifiers:

.Bl -tag -width ".Cm #" -offset indent

.It Cm \&?

.It Cm #

.It Cm \-

Left align

.El

Left align

.El

.Pp

or alternate form 1), these additional modifiers take effect:

.Bl -tag -width ".So \  Sc" -offset indent

.It Cm \&?

.It Cm 0

Zero pad

.El

Effective format modifiers:

.Bl -tag -width ".Cm #" -offset indent

.It Cm \&?

.It Cm #

.It Cm \-

Left align

.El

Left align

.El

.Pp

.Xr strftime 3

format codes enclosed in

.Cm %{

the following format modifiers are also effective:

.Bl -tag -width ".So \  Sc" -offset indent

.It Cm \&?

.It Cm #

.It Cm 0

Zero pad

.It So "\ " Sc

.Dt PKG_REPOS 3

.Os

.Sh NAME

.Fn pkg_repo_find_name "const char *name";

.Sh DESCRIPTION

.Fn pkg_repos

.Pp

.Fn pkg_repos_total_count

returns the total number of defined repositories.

.Pp

.Fn pkg_repo_key

takes a pointer to a repository as argument and returns the path to

.Pp

.Fn pkg_repo_fingerprints

takes a pointer to a repository as argument and returns the path to

.Qq FINGERPRINT

method, NULL will be returned.

.Pp

signature it uses.

.Bl -tag -width SIG_FINGERPRINT

.It Cm SIG_NONE

.It Cm SIG_PUBKEY

The repository is signed using the PUBKEY method

.It Cm SIG_FINGERPRINT

.Fn pkg_repo_find_name

Take a repository

.Qq name