mk/pkgformat/README

   1 $NetBSD: README,v 1.7 2009/06/09 08:40:27 joerg Exp $
   2
   3 = Introduction =
   4
   5 A package format is a packaging system that is supported by pkgsrc.
   6 Currently, there is only one (the native pkgsrc tools), but maybe we can
   7 support RPM, dpkg or the Solaris native packages someday. It can also be
   8 used to test new variants of the packaging tools.
   9
  10 NOTE: The Google Summer of Code 2011 project includes rpm and debian
  11 http://addpackageforma.sourceforge.net/
  12
  13 The PKG_FORMAT variable is used to select the format. The default
  14 format is ``pkg''.
  15
  16 = Interface =
  17
  18 == Variables usable at load-time ==
  19
  20 A package system format must define the following variables so that they
  21 can be used when loading Makefiles. (That is, no references to undefined
  22 variables.)
  23
  24 === Legacy ===
  25
  26 * PKG_DBDIR (TODO: Make the other parts of pkgsrc independent of that
  27   variable; this should go away.)
  28
  29 === Packaging commands ===
  30
  31 The following variables all refer to shell commands, which must accept
  32 some command line options that are detailed in the respective man pages.
  33 (TODO: Find out which command line options are really used and which
  34 ones are useful. Document them.)
  35
  36 * PKG_ADD
  37 * PKG_ADMIN
  38 * PKG_CREATE
  39 * PKG_DELETE
  40 * PKG_INFO
  41 * PKG_VIEW
  42 * LINKFARM
  43 * PKG_BEST_EXISTS
  44
  45 The following variables must be defined so that they can be used in
  46 shell commands. They may contain references to all other variables.
  47
  48 * PKG_FILELIST_CMD
  49
  50 XXX: Why isn't this variable in the previous list?
  51
  52 == Make targets ==
  53
  54 The following make targets must be implemented:
  55
  56 * _pkgformat-check-vulnerable
  57 * _pkgformat-deinstall
  58 * _pkgformat-show-depends
  59 * _pkgformat-install-dependencies
  60 * bootstrap-depends
  61 * _pkgformat-register
  62 * tarup (XXX: This doesn't sound like a target that should be defined
  63   here.)
  64 * tarup-pkg
  65 * package-install
  66 * _pkgformat-replace
  67 * _pkgformat-destdir-replace
  68 * _pkgformat-undo-replace
  69