$NetBSD: README,v 1.7 2009/06/09 08:40:27 joerg Exp $
= Introduction =
A package flavor is a packaging system that is supported by pkgsrc.
Currently, there is only one (the native pkgsrc tools), but maybe we can
support RPM, dpkg or the Solaris native packages someday. It can also be
used to test new variants of the packaging tools.
= Interface =
== Variables usable at load-time ==
A package system flavor must define the following variables so that they
can be used when loading Makefiles. (That is, no references to undefined
variables.)
=== Legacy ===
* PKG_DBDIR (TODO: Make the other parts of pkgsrc independent of that
variable; this should go away.)
=== Packaging commands ===
The following variables all refer to shell commands, which must accept
some command line options that are detailed in the respective man pages.
(TODO: Find out which command line options are really used and which
ones are useful. Document them.)
* PKG_ADD
* PKG_ADMIN
* PKG_CREATE
* PKG_DELETE
* PKG_INFO
* PKG_VIEW
* LINKFARM
* PKG_BEST_EXISTS
The following variables must be defined so that they can be used in
shell commands. They may contain references to all other variables.
* PKG_FILELIST_CMD
XXX: Why isn't this variable in the previous list?
== Make targets ==
The following make targets must be implemented:
* _flavor-check-vulnerable
* _flavor-deinstall
* _flavor-show-depends
* _flavor-install-dependencies
* bootstrap-depends
* _flavor-register
* tarup (XXX: This doesn't sound like a target that should be defined
here.)
* tarup-pkg
* package-install
* _flavor-replace
* _flavor-destdir-replace
* _flavor-undo-replace
= Bugs =
The name "flavor" is badly chosen, especially since flavor is such a
broad term that OpenBSD ports collection has chosen to implement
something entirely different using the same name. (This has happended
before pkgsrc has chosen to use this word, though, so no blame on them.)
