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