pkgsrc-wip/pkg_summary-utils/files/pkg_src_summary.1
Aleksey Cheusov dac5de94de version -> 0.22.0
merge changes from 'deve' branche
  See files/NEWS file for details
2008-12-01 21:31:33 +00:00

112 lines
3.5 KiB
Groff

.\" $NetBSD: pkg_src_summary.1,v 1.18 2008/12/01 21:31:33 cheusov Exp $
.\"
.\" Copyright (c) 2008 by Aleksey Cheusov (vle@gmx.net)
.\" Absolutely no warranty.
.\"
.\" ------------------------------------------------------------------
.de VB \" Verbatim Begin
.ft CW
.nf
.ne \\$1
..
.de VE \" Verbatim End
.ft R
.fi
..
.\" ------------------------------------------------------------------
.TH PKG_SRC_SUMMARY 1 "Jan 29, 2008" "" ""
.SH NAME
pkg_src_summary \- build summary information for source packages
.SH SYNOPSIS
.BI pkg_src_summary " [OPTIONS] [pkgpath1 ...]"
.br
.BI pkg_src_summary " -s [OPTIONS]"
.SH DESCRIPTION
.B pkg_src_summary
builds summary information about source packages specified in
arguments or read from stdin (one package per line). Format of this
summary information is the same as used in pkg_summary(5) built from
binary packages. List of fields (PKGNAME, PKGPATH, DEPENDS etc.) is
very similar but not fully the same.
.SH OPTIONS
.TP
.B "-h|--help"
display help message
.TP
.BI "-f|--fields" " fields"
A list of fields (separated by space character or comma) to be generated. By
default the following fields are generated: PKGNAME, PKGPATH, DEPENDS,
BUILD_DEPENDS, CONFLICTS, HOMEPAGE, COMMENT, LICENSE, ONLYFOR, NOTFOR,
MAINTAINER, CATEGORIES, NO_BIN_ON_FTP, NO_SRC_ON_FTP,
NO_BIN_ON_CDROM, NO_SRC_ON_CDROM, ALLSRCFILES
DESCRIPTION (multiline), PLIST(multiline).
The following fields are NOT generated by default: CVS_CHECKSUM.
.TP
.BI "-a|--add-fields" " fields"
Add the specified fields to the list of fields generated by default
.TP
.BI "-r|--rem-fields" " fields"
Remove the specified fields from the list of fields generated by default
.TP
.B "-p"
use 'bmake plist' for obtaining PLIST
.TP
.B "-d"
generate summary for specified packages and their dependancies (DEPENDS)
.TP
.B "-D"
generate summary for specified packages and their dependancies (BUILD_DEPENDS)
.TP
.B "-A"
generate summary for specified packages and all their dependancies, that is,
implies -d and -D
.TP
.B "-m|--multi"
generate summary for all variants of multi-variant packages
(Python {22,23,24,25}, PHP {4,5}, Apache {1.3,2,2.2} etc.)
.TP
.B "-M|--MULTI"
implies -m and moves/adds ASSIGNMENTS field to PKGPATH
.SH ENVIRONMENT
.TP
.B PKGSRCDIR
pkgsrc root directory, defaults to /usr/pkgsrc
.TP
.B BMAKE
path to pkgsrc friendly make utility, defaults to make
.TP
.B PSS_SLAVES
Space separated list of remote hosts or +<Number> for distributed
summary generation. If case of +<Number>, <Number> local processes
are run, this is useful for SMP machines.
.TP
.B PSS_TRANSPORT
Transport program like ssh or rsh to communicate with remote/slave hosts.
.TP
.B PSS_PPERS
A number of packages per slave that are built at once, defaults to 10.
.TP
.B PSS_OPTIONS
This variable specifies default options to be placed in front of
any explicit options.
.SH EXAMPLES
.VB
pkg_src_summary wip/dict-server wip/dict-mueller7 wip/dict-client
printf 'wip/dict-server\\nwip/dict-client\\n' | pkg_src_summary
env BMAKE=/usr/pkg/bin/bmake \\
PSS_SLAVES='host1 host2' \\
PSS_TRANSPORT=/usr/bin/ssh \\
/usr/pkg/bin/pkg_src_summary \\
-f 'PKGNAME PKGPATH DEPENDS BUILD_DEPENDS' \\
< /tmp/packages.txt \\
pkg_list_all_pkgs | env PSS_SLAVES='+6' pkg_src_summary
env PSS_OPTIONS=-p pkg_update_src_summary /path/to/pkg_src_summary.txt
pkg_src_summary -a CVS_CHECKSUM x11/xxkb wip/distbb
pkg_src_summary -r LICENSE,PLIST,DESCR x11/xxkb wip/distbb
pkg_src_summary -m lang/lua www/php-apc www/ap2-python
.VE
.SH SEE ALSO
.BR pkg_summary-utils(7) ,
.B pkg_summary(5)
.SH AUTHOR
Aleksey Cheusov <vle@gmx.net>