man/man5/pkg_summary.5

   1 .\"     $NetBSD: pkg_summary.5,v 1.9 2009/05/02 16:14:37 reed Exp $
   2 .\"
   3 .\" Copyright (c) 2006 The NetBSD Foundation
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. Neither the name of the NetBSD Foundation nor the names of its
  14 .\"    contributors may be used to endorse or promote products derived from
  15 .\"    this software without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION AND ITS CONTRIBUTORS
  18 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
  19 .\" NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20 .\" FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT
  21 .\" SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  22 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .Dd April 11, 2009
  31 .Dt PKG_SUMMARY 5
  32 .Os
  33 .Sh NAME
  34 .Nm pkg_summary
  35 .Nd summary of binary package repository
  36 .Sh DESCRIPTION
  37 The file
  38 .Nm
  39 contains information about each package in a binary package
  40 repository as a list of variable-value pairs.
  41 The variables describing different packages are separated by one empty
  42 line.
  43 Each line has the format
  44 .Ev VARIABLE=VALUE .
  45 If the value consists of more than one line, each line is prefixed with
  46 .Ev VARIABLE= .
  47 Multi-line variables are guaranteed to be in consecutive lines.
  48 .Pp
  49 The following variables are used:
  50 .Bl -tag -width indent
  51 .It Ev BUILD_DATE
  52 (required) The date and time when the package was built.
  53 .It Ev CATEGORIES
  54 (required) A list of categories which this package fits in, separated by
  55 space.
  56 .It Ev COMMENT
  57 (required) A one-line description of the package.
  58 .It Ev CONFLICTS
  59 (optional) A list of dewey patterns of packages the package conflicts
  60 with, one per line.
  61 If missing, this package has no conflicts.
  62 .It Ev DEPENDS
  63 (optional) A list of dewey patterns of packages the package depends
  64 on, one per line.
  65 If missing, this package has no dependencies.
  66 .It Ev DESCRIPTION
  67 (required) A more detailed description of the package.
  68 .\" DIGEST
  69 .It Ev FILE_NAME
  70 (optional) The name of the binary package file.
  71 If not given,
  72 .Pa PKGNAME.tgz
  73 can be assumed.
  74 .It Ev FILE_SIZE
  75 (optional) The size of the binary package file, in bytes.
  76 .It Ev HOMEPAGE
  77 (optional) A URL where more information about the package can be found.
  78 .It Ev LICENSE
  79 (optional) The type of license this package is distributed under.
  80 If empty or missing, it is OSI-approved.
  81 .It Ev MACHINE_ARCH
  82 (required) The architecture on which the package was compiled.
  83 .It Ev OPSYS
  84 (required) The operating system on which the package was compiled.
  85 .It Ev OS_VERSION
  86 (required) The version of the operating system on which the package
  87 was compiled.
  88 .It Ev PKG_OPTIONS
  89 (optional) Any options selected to compile this package.
  90 If missing, the package does not support options.
  91 .It Ev PKGNAME
  92 (required) The name of the package.
  93 .It Ev PKGPATH
  94 (required) The path of the package directory within pkgsrc.
  95 .It Ev PKGTOOLS_VERSION
  96 (required) The version of the package tools used to create the package.
  97 .It Ev PREV_PKGPATH
  98 (optional) The previous path of the package directory within pkgsrc when
  99 a package was moved.
 100 (See
 101 .Ev SUPERSEDES
 102 below for a renamed package.)
 103 .It Ev PROVIDES
 104 (optional) A list of shared libraries provided by the package,
 105 including major version number, one per line.
 106 If missing, this package does not provide shared libraries.
 107 .It Ev REQUIRES
 108 (optional) A list of shared libraries needed by the package, including
 109 major version number, one per line.
 110 If missing, this package does not require shared libraries.
 111 .It Ev SIZE_PKG
 112 (required) The size of the package when installed, in bytes.
 113 .It Ev SUPERSEDES
 114 (optional) A list of dewey patterns of previous packages this
 115 package replaces, one per line.
 116 This is used for package renaming.
 117 .El
 118 .Pp
 119 The
 120 .Nm pkg_summary
 121 file can be generated using the
 122 .Xr pkg_info 1
 123 .Fl X
 124 option.
 125 For example, the following will list this data for all installed packages:
 126 .Pp
 127 .Dl "pkg_info -X -a"
 128 .Sh SEE ALSO
 129 .Xr pkg_info 1
 130 .Sh HISTORY
 131 The
 132 .Nm pkg_summary
 133 format was first officially documented in April 2006.