.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-ADD 8

.Os

.Sh NAME

.Nm

.Op Fl IAfMq

.Ar <protocol>://<path>/<pkg-name> ...

.Sh DESCRIPTION

.Nm

installs packages from either a local source or a remote one.

.Sh OPTIONS

The following options are supported by

.Nm :

Mark the installed packages as orphan.

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

For more information please refer to

.Xr pkg-autoremove 8

Force the reinstallation of the package if already installed.

Force the installation of the package with missing dependencies.

Force quiet output.

.El

.Sh ENVIRONMENT

The following environment variables affect the execution of

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-AUDIT 8

.Os

.Sh NAME

.Sh SYNOPSIS

.Nm

.Op Fl Fq

.Ar pkg-name

.Sh DESCRIPTION

.Nm

.Sh OPTIONS

The following options are supported by

.Nm :

Use

as the local copy of the vulnerability database.

If used in combination with

.Fl F

download the vulnerability database to the named

before auditing installed ports against it.

Fetch the database before checking.

Be ``quiet''.

Prints only the requested information without

displaying many hints.

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-AUTOREMOVE 8

.Os

.Sh NAME

.Nd removes orphan packages

.Sh SYNOPSIS

.Nm

.Sh DESCRIPTION

.Nm

is used for removing orphan packages, which were installed

.Sh OPTIONS

The following options are supported by

.Nm :

Dry-run mode.

The list of changes to packages is always printed, but

no changes are actually made.

Force quiet output

.El

.Sh ENVIRONMENT

The following environment variables affect the execution of

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-BACKUP 8

.Os

.Sh NAME

.Nd backup and restore the local package database

.Sh SYNOPSIS

.Nm

.Nm

.Nm

is used for backing up and restoring of the local package database.

.Sh OPTIONS

The following options are supported by

.Nm :

Dumps the local package database to a file specified on the command-line.

If

.Ar -

is specified as the argument

.Nm

will use stdout for its output.

Uses

in order to restore the local package database.

Useful in case of a database

.El

.Sh ENVIRONMENT

The following environment variables affect the execution of

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-CHECK 8

.Os

.Sh NAME

.Sh SYNOPSIS

.Nm

.Op Fl Bdsr

.Op Fl a | Cgix Ar pattern

.Sh DESCRIPTION

.Nm

.Fl B

is used to reanalyse shared libraries of installed packages.

.Pp

.Nm

.Fl d

is used to check for and install missing dependencies.

.Pp

.Nm

.Fl r

is used to recompute sizes and checksums of installed packages.

.Pp

.Nm

.Fl s

is used to find invalid checksums for installed packages.

.Sh OPTIONS

The following options are supported by

.Nm :

Process all packages.

Make the standard or regular expression

.Fl ( x )

matching against

.Ar pattern

case sensitive.

Make the standard or regular expression

.Fl ( x )

matching against

.Ev CASE_SENSITIVE_MATCH 

to true in

.Pa pkg.conf .

Treat

.Ar pattern

as a regular expression.

This uses the "modern" or "extended" syntax described in

.Xr re_format 7

.El

.Sh ENVIRONMENT

The following environment variables affect the execution of

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-CLEAN 8

.Os

.Sh NAME

.Sh SYNOPSIS

.Nm

.Op Fl anqy

.Sh DESCRIPTION

.Nm

is used to cleanup the local cache of packages downloaded from remote

The following options are supported by

.Nm :

.Bl -tag -width F1

Delete all cached packages.

would be done instead.

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

even when used with

.Fl y .

Note: the package cache file permissions only permit root access.

Results will be disappointing for any other user.

Be quiet.

Suppress most output.

All output is suppressed if

.Fl y

is also used.

Assume a yes answer instead of asking for confirmation before deleting

any out-of-date or redundant packages from the cache.

.El

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-CONVERT 8

.Os

.Sh NAME

.Nm

.Op Fl d Ar pkg_dbdir

.Op Fl nr

.Sh DESCRIPTION

.Nm

.Sh OPTIONS

The following options are supported by

.Nm :

The location of the

.Xr pkg_add 1

dbdir.

Defaults to

.Fa /var/db/pkg .

Dry-run mode.

Do not actually convert anything.

Just show what would be done.

Revert conversion

.El

.Sh FILES

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-CREATE 8

.Os

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

.Op Fl r Ar rootdir

.Fl a

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

.Sh DESCRIPTION

.Nm

is used to create packages from binaries or other files installed on

The following options are supported by

.Nm :

.Bl -tag -width ".Fl m Ar metadatadir"

Create package tarballs from all packages installed on your system.

This option is incompatible with the

.Fl g , x

or

.Fl m Ar metadatadir

options.

Interpret

.Ar pkg-name

as a shell glob pattern and create package only for installed binaries whose

or

.Fl m Ar metadatadir

options.

Like

.Fl g ,

but interpret

or

.Fl m Ar metadatadir

options.

Set

.Ar format

as the package output format.

If an invalid or no format is specified

.Ar txz

is assumed.

Specify the directory containing the package manifest,

.Pa +MANIFEST

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

or

.Fl x

options.

Read all of the package metadata from the

.Ar manifest

file.

or

.Fl x

options.

Do not overwrite already existing packages

Set

.Ar outdir

as the output directory.

If this option is not given, all created packages will

be saved in the current directory.

Specify some package metadata using the legacy plist format from

.Xr pkg_add 1 ,

commonly found in

.Pa pkg-plist

files in the ports tree.

Metadata from the

file, if specified, will take precedence over any equivalents from

the

.Ar metadatadir .

See

.Sx "PLIST FORMAT"

for details

.Ar rootdir

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

filesystem hierarchy containing the package files.

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-DELETE 8

.Os

.Sh NAME

.Nm

.Op Fl Dnqy

.Fl a

.Sh DESCRIPTION

.Nm

is used for deleting installed packages from the system.

.Sh OPTIONS

The following options are supported by

.Nm :

Deletes all installed packages from the system and empties the database.

Make the standard or regular expression

.Fl ( x )

matching against

.Ar pkg-name

case sensitive.

If a deinstallation script exists for a given package, do not execute it.

Forces packages to be removed despite leaving unresolved dependencies.

Treat the package names as shell glob patterns.

Make the standard or regular expression

.Fl ( x )

matching against

.Ev CASE_SENSITIVE_MATCH

to true in

.Pa pkg.conf .

Dry run mode.

The list of packages to delete is always printed, but no packages are

actually deleted.

Force quiet output, except where

.Fl n

is also used, when

.Nm

will show the list of packages to be deleted.

Delete all packages that require the listed packages as well.

Treat the package names as regular expressions according to the

"modern" or "extended" syntax of

.Xr re_format 7 .

Assume yes when asked for confirmation before package deletion.

.El

.Sh ENVIRONMENT

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-FETCH 8

.Os

.Sh NAME

.Op Fl r Ar reponame

.Op Fl dqUy

.Fl u

.Sh DESCRIPTION

.Nm

is used to download binary packages from a remote repository.

.Sh OPTIONS

The following options are supported by

.Nm :

Fetch all packages.

Make the standard or the regular expression

.Fl ( x )

matching against

.Ar pkg-name

case sensitive.

Fetch the package and its dependencies as well.

Treat

.Ar pkg-name

as a shell glob pattern.

Make the standard or regular expression

.Fl ( x )

matching against

.Ev CASE_SENSITIVE_MATCH

to true in

.Pa pkg.conf .

Quiet mode.

Show less output.

Fetches packages from the given

.Ar reponame

if multiple repo support is enabled.

See

.Xr pkg.conf 5 .

Fetch all available updates for the currently installed packages.

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

from remote. 

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.

Treat

.Ar pkg-name

as a regular expression according to the "modern" or "extended" syntax

of

.Xr re_format 7 .

Assume yes when asked for confirmation before fetching packages.

.El

.Sh ENVIRONMENT

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-INFO 8

.Os

.Sh NAME

.Nm

.Fl a

.Nm

.Op Fl Cgix

.Ar pkg-name

.Nm

.Fl F Ar pkg-file

.Sh DESCRIPTION

.Nm

is used for displaying information for packages.

.Sh OPTIONS

The following options are supported by

.Nm :

Display all installed packages.

Display any annotations added to the package.

Make the standard or the regular expression

.Fl ( x )

matching against

.Ar pkg-name

case sensitive.

Display full information about the packages matching

.Ar pkg-name .

This is the default.

.Ar pkg-name .

If

.Ar pkg-name

is installed and registered in the database, return 0, otherwise return 1.

Useful for checking whether the package is installed.

Show the pkg-message for matching packages.

Treat

.Ar pkg-name

as a shell glob pattern.

Make the standard or the regular expression

.Fl ( x )

matching against

.Ev CASE_SENSITIVE_MATCH

to true in

.Pa pkg.conf .

Treat

.Ar pkg-name

as a regular expression according to the "modern" or "extended" syntax

of

.Xr re_format 7 .

Display the list of packages on which

.Ar pkg-name

depends.

Display the list of packages which require

.Ar pkg-name .

Show the locking status for

.Ar pkg-name .

When used in combination with

statuses will show as unlocked when information about a

.Ar pkg-file

is queried.

Display all files installed by

.Ar pkg-name .

Display all shared libraries provided by

.Ar pkg-name .

Display all shared libraries used by

.Ar pkg-name .

Display the total size of files installed by

.Ar pkg-name

Be

.Dq quiet .

Prints only the requested information without displaying many hints.

Search is done by the

.Ar pkg-name

origin.

Added only for Ports compatibility.

.Pp

Hides the full package output and only shows the package name.

This option is deprecated and exists only for Ports compatibility.

Display

.Ar pkg-name

origin.

Display the installation prefix for each package matching

.Ar pkg-name .

Displays information from the package archive

.Ar pkg-file .

.El

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-INSTALL 8

.Os

.Sh NAME

.Op Fl r Ar reponame

.Op Fl Cgix

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

.Sh DESCRIPTION

.Nm

is used for installation of packages from a package repository or

.Sh OPTIONS

The following options are supported by

.Nm :

Mark the installed packages as orphan.

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

For more information please refer to

.Xr pkg-autoremove 8

Make the standard or the regular expression

.Fl ( x )

matching against

.Ar pkg-name

case sensitive.

Force the reinstallation of the package if already installed.

Treat the package names as shell glob patterns.

If any installation scripts (pre-install or post-install) exist for a given

package, do not execute them.

When a package is updated, deinstallation

scripts (pre-deinstall or post-deinstall) are not run either.

Make the standard or the regular expression

.Fl ( x )

matching against

.Ev CASE_SENSITIVE_MATCH

to true in

.Pa pkg.conf .

Force the installation of the package with missing dependencies.

Dry-run mode.

The list of changes to packages is always printed, but

no changes are actually made.

Do not perform actual installation of packages, merely fetch packages

that should be upgraded and detect possible conflicts.

Force quiet output, except when

.Fl n

is used, where

.Nm

will always show packages to be installed, upgraded or deleted.

When used with

.Fl f ,

reinstalls any packages that require the given package.

Install packages from only the named repository,

irrespective of the configured

.Dq active

status from

.Pa repo.conf .

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

from remote. 

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.

Treat the package names as regular expressions according to the

"modern" or "extended" syntax of

.Xr re_format 7 .

Assume yes when asked for confirmation before package installation.

.El

.Sh ENVIRONMENT

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-LOCK 8

.Os

.Sh NAME

.Nd lock or unlock packages

.Sh SYNOPSIS

.Nm

.Nm

.Op Fl Cgix

.Ar pkg-name

.Nm "pkg unlock"

.Nm "pkg unlock"

.Op Fl Cgix

.Ar pkg-name

.Sh DESCRIPTION

.Nm

is used to lock packages against reinstallation,

.Sh OPTIONS

The following options are supported by

.Nm :

Lock or unlock all installed packages.

Make the standard or the regular expression

.Fl ( x )

matching against

.Ar pkg-name

case sensitive.

Treat

.Ar pkg-name

as a shell glob pattern.

Make the standard or the regular expression

.Fl ( x )

matching against

.Ev CASE_SENSITIVE_MATCH

to true in

.Pa pkg.conf .

Operate quietly: do not output anything other than confirmatory questions.

Treat

.Ar pkg-name

as a regular expression according to the "modern" or "extended" syntax

of

.Xr re_format 7 .

Assume "yes" as the answer to all questions.

.El

.Sh ENVIRONMENT

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-QUERY 8

.Os

.Sh NAME

.Sh SYNOPSIS

.Nm

.Ao query-format Ac Ao pkg-name Ac

.Nm

.Op Fl a

.Ao query-format Ac

.Nm

.Nm

.Fl e Ao evaluation-condition Ac Ao query-format Ac

.Nm

.Ao query-format Ac Ao pattern Ac Ao ... Ac

.Sh DESCRIPTION

.Nm

.Sh OPTIONS

The following options are supported by

.Nm :

Match all packages from the database

Make the standard or the regular expression

.Fl ( x )

matching against

.Ar pkg-name

case sensitive.

Match packages using the given

.Ar evaluation-condition.

See EVALUATION FORMAT for details.

Display information only for the package file

.Ar pkg-name

Make the standard or regular expression

.Fl ( x )

matching against

.Ev CASE_SENSITIVE_MATCH

to true in

.Pa pkg.conf .

Treat

.Ao pattern Ac

as a glob pattern.

Treat

.Ao pattern Ac

as a regular expression according to the "modern" or "extended" syntax

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-REGISTER 8

.Os

.Sh NAME

.Nm

.Op Fl dlOt

.Fl M Ar metadatafile

.Nm

.Op Cm --plist Ar plist-file

.Cm --metadata Ar metadatadir

.Cm --root Ar input-path

.Nm

.Cm --manifest Ar metadatafile

.Sh DESCRIPTION

.Nm

ports tree only.

This flag will be removed once

.Xr pkg_tools 8

Generates an old-style packing list on

.Pa stdout ,

without registering the port in the package database.

Annotates the package as having been relocated to

.Pa location ,

which is an alternate system root.

.Op Fl lq

.Op Fl o Ar output-dir

.Ao Ar repo-path Ac Op Ao Ar rsa-key Ac | signing_command: Ao Ar the command Ac

.Sh DESCRIPTION

.Nm

is used for creating a catalogue of the available

.Pp

The repository will be created in the package directory unless the

.Fl o Ar output-dir

is specified, in which case it will be created there.

.Pp

Optionally you may sign the repository catalogue by specifying the

.Sh OPTIONS

The following options are supported by

.Nm :

Force quiet output

Generate list of all files in repo as filesite.txz archive.

Create the repository in the specified directory instead of the package directory.

.El

.Sh FILES

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-RQUERY 8

.Os

.Sh NAME

.Op Fl r Ar reponame

.Sm Fl I |

.Ao query-format Ac Sm Ao pattern Ac Ao ... Ac

.Sh DESCRIPTION

.Nm

is used for displaying information about remote packages.

.Sh OPTIONS

The following options are supported by

.Nm :

Match all packages from the database

Make the standard or the regular expression

.Fl ( x )

matching against

.Ar pkg-name

case sensitive.

Match packages using the given

.Ar evaluation-condition.

See EVALUATION FORMAT for details.

Print out the corresponding line from the ports

.Pa INDEX

file for each matched package.

Only the first query format (including the

.Fl I

option) on the command line will be interpreted.

Query for data about packages from only the named repository,

irrespective of the configured

.Dq active

By default all repository catalogues marked

.Dq active

are queried.

Treat

.Ao pattern Ac

as a glob pattern.

Make the standard or regular expression

.Fl ( x )

matching against

.Ev CASE_SENSITIVE_MATCH

to true in

.Pa pkg.conf .

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

from remote.

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.

Treat

.Ao pattern Ac

as a regular expression according to the "modern" or "extended" syntax

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-SEARCH 8

.Os

.Sh NAME

.Op Fl Cegix

.Ar pattern

.Nm

.Op Fl r Ar reponame

.Ar pattern

.Sh DESCRIPTION

.Nm

.Sh OPTIONS

The following options are supported by

.Nm :

Make the exact

.Fl ( e )

or the regular expression

matching against

.Ar pkg-name

case sensitive.

Search for packages with comment text matching

.Ar pattern .

Equivalent to

.Fl "S comment" .

Search for packages with description text matching

.Ar pattern .

Equivalent to

.Fl "S description" .

Display the list of packages depended on by each matched package.

Equivalent to

.Fl "Q depends-on" .

.Ar pattern

should be an exact match against the search field.

Show ``full'' information about the package.

Equivalent to

.Fl "Q full" .

Treat

.Ar pattern

as a shell globbing expression.

The glob pattern must match the entire field being seached.

Make the exact

.Fl ( e )

or regular expression

.Ev CASE_SENSITIVE_MATCH

to true in

.Pa pkg.conf .

Select which identifying label is printed for each matched package,

unless

.Fl q

is set to the same as the value searched via the

.Fl S Ar search

option.

List packages by origin for each package matching

.Ar pattern .

Equivalent to

.Fl "L origin" .

Display the package installation prefix for each matched package.

Equivalent to

.Fl "Q prefix" .

Produce less output.

In particular do not show an identifying label field for each package.

Modify the query output by adding an additional field to the result.

Multiple fields can be added by using additional

.Fl Q Ar query-modifier

See the

.Qq Sx Output Modifier Options

section for details.

Search for packages from only the named repository,

irrespective of the configured

.Dq active

By default all repository catalogues marked

.Dq active

are searched.

Display the full manifest (raw) from the matching packages.

Specify the field to search the repository catalogue on.

If unspecified, searches on

.Ar pkg-name

See the

.Qq Sx Search and Label Options

sections for more details.

Display the installed size of matched packages.

Equivalent to

.Fl "Q size" .

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

from remote. 

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.

Treat

.Ar pattern

as a regular expression according to the "modern" or "extended"

.\"     @(#)pkg.8

.\" $FreeBSD$

.\"

.Dt PKG-SET 8

.Os

.Sh NAME

.Op Fl y

.Op Fl Cgix

.Ar pkg-name

.Sh DESCRIPTION

.Nm

is used to modify information concerning installed packages.

.Sh OPTIONS

The following options are supported by

.Nm :

Set automatic flag for the package: 0 is not automatic, 1 is automatic.

This affects the operation of

.Xr pkg-autoremove 8 .

Match all installed packages.

Make the standard or the regular expression

.Fl ( x )

matching against

.Ar pkg-name

case sensitive.

Match

.Ar pkg-name

as a globbing expression.

Make the standard or regular expression

.Fl ( x )

matching against

.Ev CASE_SENSITIVE_MATCH

to true in

.Pa pkg.conf .

Change the port origin of a given dependency from

.Ar oldorigin

to

.Xr pkg-updating 8

and

.Sx EXAMPLES .

Match

.Ar pkg-name

as a regular expression according to the "modern" or "extended" syntax of

.Xr re_format 7 .

Assume yes rather than asking for confirmation before package autoremoval.

.El

.Pp

.\"     @(#)pkg.8