external/bsd/pkg_install/dist/lib/pkg_summary.5

   1 .\"     $NetBSD: pkg_summary.5,v 1.4 2012/02/19 17:49:09 tron 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_CKSUM
  70 (optional) A checksum type supported by
  71 .Xr digest 1
  72 and checksum separated by space character.
  73 .It Ev FILE_NAME
  74 (optional) The name of the binary package file.
  75 If not given,
  76 .Pa PKGNAME.tgz
  77 can be assumed.
  78 .It Ev FILE_SIZE
  79 (optional) The size of the binary package file, in bytes.
  80 .It Ev HOMEPAGE
  81 (optional) A URL where more information about the package can be found.
  82 .It Ev LICENSE
  83 (optional) The type of license this package is distributed under.
  84 If empty or missing, it is OSI-approved.
  85 .It Ev MACHINE_ARCH
  86 (required) The architecture on which the package was compiled.
  87 .It Ev OPSYS
  88 (required) The operating system on which the package was compiled.
  89 .It Ev OS_VERSION
  90 (required) The version of the operating system on which the package
  91 was compiled.
  92 .It Ev PKG_OPTIONS
  93 (optional) Any options selected to compile this package.
  94 If missing, the package does not support options.
  95 .It Ev PKGNAME
  96 (required) The name of the package.
  97 .It Ev PKGPATH
  98 (required) The path of the package directory within pkgsrc.
  99 .It Ev PKGTOOLS_VERSION
 100 (required) The version of the package tools used to create the package.
 101 .It Ev PREV_PKGPATH
 102 (optional) The previous path of the package directory within pkgsrc when
 103 a package was moved.
 104 (See
 105 .Ev SUPERSEDES
 106 below for a renamed package.)
 107 .It Ev PROVIDES
 108 (optional) A list of shared libraries provided by the package,
 109 including major version number, one per line.
 110 If missing, this package does not provide shared libraries.
 111 .It Ev REQUIRES
 112 (optional) A list of shared libraries needed by the package, including
 113 major version number, one per line.
 114 If missing, this package does not require shared libraries.
 115 .It Ev SIZE_PKG
 116 (required) The size of the package when installed, in bytes.
 117 .It Ev SUPERSEDES
 118 (optional) A list of dewey patterns of previous packages this
 119 package replaces, one per line.
 120 This is used for package renaming.
 121 .El
 122 .Pp
 123 The
 124 .Nm pkg_summary
 125 file can be generated using the
 126 .Xr pkg_info 1
 127 .Fl X
 128 option.
 129 For example, the following will list this data for all installed packages:
 130 .Pp
 131 .Dl "pkg_info -X -a"
 132 .Sh SEE ALSO
 133 .Xr digest 1 ,
 134 .Xr pkg_info 1
 135 .Sh HISTORY
 136 The
 137 .Nm pkg_summary
 138 format was first officially documented in April 2006.