NAME

SYNOPSIS

DESCRIPTION

 

 

-A arches

Register a list of architectures for which this package should install. arches is a comma-separated list of architectures. Use ‘*’ to mean any architecture (e.g., arch-independent packages).

 

 

-B pkg-destdir

Set pkg-destdir as the prefix to prepend to any file to select for the package.

 

 

-D name[

=value

]

Define name to value (or just define it) for substitution and fragment inclusion purposes. Some specific names have extra meaning, see bsd.port.mk(5) for details:

CDROM

Set to the port's Makefile PERMIT_PACKAGE_CDROM.

COMMENT

Set package “one line description” (mandatory).

FTP

Set to the port's Makefile PERMIT_PACKAGE_FTP.

FULLPKGPATH

Strongly recommended, otherwise updates won't work.

HOMEPAGE

If defined, appended to the description.

MAINTAINER

If defined, appended to the description.

USE_GROFF

Set to 1 to have groff format manpages behind the scenes during package creation.

 

 

-d [-]desc

Fetch long description for package from file desc or, if preceded by ‘-’, the argument itself.

 

 

-f packinglist

Fetch “packing-list” for package from the file packinglist. Several packing-lists can be mentioned, in which case they will be concatenated together.

 

 

-L localbase

Record localbase as the localbase used in the package. By default, /usr/local. Packages built with another localbase can only be installed by using the same localbase in pkg_add(1), to prevent errors.

 

 

-M displayfile

Display the file (using more(1)) after installing the package. Useful for things like legal notices on almost-free software, etc.

 

 

-m

Causes pkg_create to always display the progress meter in cases it would not do so by default.

 

 

-n

Don't actually create a package.

 

 

-P pkg-dependency

Specify a @depend dependency on the command line.

 

 

-p prefix

Set prefix as the initial directory “base” to start from in selecting files for the package, and to record as the base for installing the package.

 

 

-Q

Print out the files in the actual packing-list of the package being generated, with explicit typing (e.g. @file, @lib, ...).

 

 

-q

Print out the actual packing-list of the package being generated (query mode). Most often used in combination with -n.

 

 

-s x509 -s cert -s privkey

Specify signature parameters for signed packages. For now, the only supported use involves three -s options: x509 to indicate X.509-style signatures, cert the path to the signer's certificate and privkey the path to the signer's private key. The signer's certificate and the signer's private key should be generated using standard openssl x509 commands. This assumes the existence of a certificate authority (or several), whose public information is recorded as a /etc/ssl/pkgca.pem file.

 

 

-U undisplayfile

Display the file (using more(1)) when deinstalling the package. Useful for reminders about stuff to clean up.

 

 

-v

Turn on verbose output.

 

 

-W wantedlib

Specify a @wantlib requirement on the command line.

 

 

-x

Disable progress meter.

pkg_create -f /var/db/pkg/kdelibs-3.4.3/+CONTENTS

PACKING-LIST DETAILS

@ask-update pkgspec message

Mechanism to prevent unwanted updates. If the new package is installed as part of an update matching pkgspec, the message will be displayed to the user. In non-interactive mode, the update will abort. Otherwise, the user will have a chance to proceed. Automated updates can be done by using -D update_stem, with stem the stem of the pkgspec. Classical use case for postgresql:

@ask-update postgresql-server-<8 Make sure your existing database is backed up
    

Use very sparingly. Most cases that seem to require manual updates just require a bit more thought.

@arch arches

List of architectures for which this package is intended.

@bin filename

Describe the file as an OpenBSD binary executable (not a script).

@comment string

Place a comment in the packing-list. Useful in trying to document some particularly hairy sequence that may trip someone up later. Can also be used to comment out elements that update-plist (see bsd.port.mk(5)) will insist in inserting in a packing-list.

The special comment @comment no checksum can be used to tag the next file as special: even though its characteristics will be recorded in the package, it can be altered after installation, and pkg_delete(1) will still delete it.

@conflict pkgspec

Declare a conflict with packages matching pkgspec (see packages-specs(7)). The pkgname package can not be installed if a package matching pkgspec has been installed because they install the same files and thus conflict.

@cwd pathname

Set the package current directory. All subsequent filenames will be assumed relative to pathname.

@depend pkgpath:pkgspec:default

Declare a dependency on a package matching pkgspec (see packages-specs(7)). An appropriate package must be installed before this package may be installed, and that package must be deinstalled before this package is deinstalled. The dependency also contains a pkgpath (see pkgpath(7)) and a default package name, in case there is no listing of available packages.

@dir directoryname

Create directory directoryname at pkg_add(1) time, taking @mode, @group, and @owner into account, and remove it during pkg_delete(1). Directories to remove can be shared between packages. If name does not begin with an @, same as

name/

@display name

Declare name as the file to be displayed at install time (see -M above).

@endfake

Mark end of packing-list for pkg_add(1) -Q option.

@exec command

Execute command during pkg_add(1). Note that @exec commands are executed relative to their location in the packing-list, so they can rely on any data that have already been extracted, but not on anything that is listed after them. Some special elements, such as new users and new groups, are always created first, so that @exec can rely on them. 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.

 

 

%B

Expands to the “basename” of the fully qualified filename, that is the current directory prefix, plus the last filespec, minus the trailing filename. In the example case, that would be /usr/local/bin.

 

 

%D

Expands to the current directory prefix, as set with @cwd; in the example case /usr/local.

 

 

%F

Expands to the last filename extracted (as specified); in the example case, bin/emacs.

 

 

%f

Expands to the “filename” part of the fully qualified name, or the converse of %B; in the example case, emacs.

@exec-always command

Synonym of @exec.

@exec-add command

Similar to @exec, except it only gets executed during new installations, and not during updates.

@exec-update command

Similar to @exec, except it only gets executed during updates, and not during new installations.

@extra filename

Declare extra file filename to be deleted at deinstall time, if user sets the -c option. Those files are extra configuration files that are normally not deleted. filename can be an absolute path. If filename ends with a slash, it is a directory.

@extraunexec command

Extra command to execute when removing extra files.

@file filename

Default annotation, to use if filename begins with @. filename is always a relative path, relative to the current @cwd.

@fontdir directoryname

Specialized version of @dir, to handle font directories: create font.alias from font.alias-* fragments, execute mkfontdir(1), mkfontscale(1) and fc-cache(1) when needed. Delete extra files at pkg_delete(1) time.

@group group

Set default group ownership for all subsequently extracted files to group. Use without an arg to set back to default (extraction) group ownership.

@ignore

Was used internally to tell extraction to ignore the next file. No longer needed.

@info filename

Specialized version of @file, to handle GNU info files. Automatically grab filename-* chapter files, run install-info(1) as needed.

@lib filename

Specialized version of @file, to handle shared libraries. Satisfy LIB_DEPENDS and WANTLIB, run ldconfig(8) as needed. See ‘VARIABLE SUBSTITUTION AND FRAGMENT INCLUSION’ for some details.

@link name

Added after a file entry by pkg_create to record that the entry is actually a hard link.

@localbase base

Used internally to record the settings of -L option.

@man filename

Specialized version of @file, to handle manual pages.

@mandir directoryname

Specialized version of @dir, to handle manual directories: instruct user to add/remove the directory to man.conf(5), remove apropos(1) database when needed.

@md5

Added after a file entry by pkg_create to record the files's cryptographic checksum. Replaced by @sha since OpenBSD 4.5.

@mode mode

Set default permission for all subsequently extracted files to mode. Format is the same as that used by the chmod(1) command. Use without an arg to set back to default (extraction) permissions.

@name pkgname

Set the name of the package. This name is potentially different than the name of the file it came in, and is used when keeping track of the package for later deinstallation. Note that pkg_create will derive this field from the package name and add it automatically if none is given.

@newgroup name:gid

During pkg_add(1), create a new group, using groupadd(8). Happens before file and user creations. gid can be prefixed with a ‘!’ to ensure group has the correct GID. During pkg_delete(1), groups will be deleted if extra clean-up has been requested, and if other installed packages don't list the same group.

@newuser name:uid:group:loginclass:comment:home:shell

During pkg_add(1), create a new user. Happens before any file creation. All fields correspond to useradd(8) parameters. Some fields are optional and can be left empty. If the user already exists, no action is taken. Individual fields can be prefixed by a ‘!’ to make sure an existing user matches. For instance, the directive @newuser foo:!42 will make sure user foo has UID 42. During pkg_delete(1), users will be deleted if extra clean-up has been requested, and if other installed packages don't list the same user.

@option name

Effects vary depending on name. Some options are not documented yet.

 

 

always-update

By default, pkg_add(1) uses some simplified information to decide whether an installed package needs updating. With this option, the package is updated whenever anything changes. To be used sparingly, as this is more expensive.

 

 

explicit-update

packages tagged with this option, either in the installed version or in an update candidate, won't be considered during a global update. User has to explicitly ask to update them. Typical use is for firmware packages, whose updates are usually tied to kernel changes.

 

 

no-default-conflict

By default, a package conflicts with other versions of the same package. With this option, the older package version will still be noticed, but the installation will proceed anyway.

@owner user

Set default ownership for all subsequently extracted files to user. Use without an arg to set back to default (extraction) ownership.

@pkgcfl pkgcflname

Declare a conflict to the pkgcflname package. The pkgcflname package must not be installed if pkgname package gets installed because they install the same files and thus conflict. pkgcflname may use fnmatch(3) wildcards. Deprecated, use @conflict instead.

@pkgpath pkgpath

Declare a secondary pkgpath for the package. This is used for updates: pkg_add -u normally checks that the pkgpath embedded in the package corresponds to the old package, to solve ambiguities when packages with similar names are involved. When ports get renamed, or flavors change, extra @pkgpath annotations can help pkg_add get a sense of continuity. Note that these pkgpath can take extra optional components, to allow the matching of several flavors at once, and are order independent. For instance,

@pkgpath some/dir,f1,f2
    

and

@pkgpath some/dir,f2,f2,f1
    

are equivalent.

@pkgpath some/dir,f1[,f2,f3][,f4]
    

will match all pkgpaths to some/dir with flavor f1, and optionally f4, and optionally both f2 and f3, e.g., some/dir,f1,f4, some/dir,f1,f2,f3, some/dir,f1,f2,f3,f4, some/dir,f1 would match, but some/dir,f1,f5, some/dir,f2,f3, some/dir,f1,f2,f4 would not.

Each binary package contains a set of pkgpaths: the primary pkgpath that was used to build the package, recorded as @comment pkgpath=some/path, and secondary pkgpaths as recorded through @pkgpath.

In order for two packages to match, their primary pkgpaths must match, or a secondary pkgpath must match the other package's primary pkgpath.

@rcscript filename

Script for the /etc/rc.d framework. Contrary to @file, absolute paths are okay, e.g.,

@rcscript ${RCDIR}/ballsd
    

In this case, performs an implicit @cwd to ${RCDIR}.

@sample filename

Last preceding @file item is a sample configuration file, to be copied to filename at pkg_add(1) time and to be removed at pkg_delete(1) time. During installation, existing configuration files are untouched. During deinstallation, configuration files are only removed if unchanged. filename can be an absolute path. If filename ends with a slash, it refers to a configuration directory instead.

@sha

Added after a file entry by pkg_create to record the files's cryptographic checksum, as a sha256 digest encoded in base64.

@shell filename

Specialized version of @file, to handle shells. See shells(5).

@size

Added after a file entry by pkg_create to record a file size.

@symlink name

Added after a file entry by pkg_create to record that the entry is actually a symbolic link.

@sysctl var=val

 

@sysctl var≥val

During pkg_add(1), check that sysctl(8) variable var is set to exactly/at least a given value val. Adjust it otherwise.

@unexec command

Execute command during pkg_delete(1). Expansion of special % sequences is the same as for @exec. Note that @unexec commands are executed relative to their location in the packing-list, so they cannot rely on any data that has already been deleted, thus they should occur before the files they need to function. Some special elements, such as new users and new groups, are always deleted last, so that @unexec can rely on them.

@unexec-always command

Synonym of @unexec.

@unexec-delete command

Similar to @unexec, except it only gets executed during true deletions and not while removing an old package during updates.

@unexec-update command

Similar to @unexec, except it only gets executed while removing an old package during updates, and not during true deletions.

@url

Original location of the package, automatically recorded in installed packages by pkg_add(1).

@wantlib libspec

Package needs a shared library to work. libspec is ‘name.major.minor’ or ‘path/name.major.minor’. The package won't be installed unless a library with the same name, the exact same major number and at least the same minor number can be located. A library without path is searched through dependent packages under the same localbase, then in the system libraries under /usr/lib and /usr/X11R6/lib. A library with a path is only searched through dependent packages, that path being relative to localbase.

VARIABLE SUBSTITUTION AND FRAGMENT INCLUSION

ENVIRONMENT

 

 

PKG_DESTDIR

Default value for pkg-destdir, if no -B option is specified.

SEE ALSO

HISTORY

AUTHORS

Jordan Hubbard

initial design

Marc Espie

complete rewrite.