printindex.1

.\"	$NetBSD: printindex.1,v 1.8 2006/12/23 08:11:30 wiz Exp $
.\"
.\" Copyright (c) 2005 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Roland Illig <rillig@NetBSD.org>.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"        This product includes software developed by the NetBSD
.\"        Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\"    contributors may be used to endorse or promote products derived
.\"    from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd November 26, 2006
.Dt PRINTINDEX 1
.Os
.Sh NAME
.Nm printindex
.Nd generate a PKGPATH to PKGNAME mapping database file
.Sh SYNOPSIS
.Nm
.Op Ar brokenfile Op Ar bulkfilesdir
.Sh DESCRIPTION
Generates a mapping from pkgsrc directories to the current package
version and prints it on stdout.
It also checks whether the package can be built on this system at all
and marks those that cannot be built as broken.
.Pp
Each line of the output has two fields:
the package directory (in the form
.Ql category/package )
and the package version (in the form
.Ql package-1.456nb3 ) .
.Pp
If
.Ar brokenfile
is given, package-specific errors are logged to
.Ar bulkfilesdir Ns / Ns
.Va ${pkgdir} Ns / Ns
.Ar brokenfile .
Otherwise no additional logging takes place.
.Pp
The default for
.Ar bulkfilesdir
is the pkgsrc directory itself.
If
.Ar bulkfilesdir
differs from the pkgsrc directory, all directories that are needed for
the log files are created automatically.
.Sh LIMITATIONS
.Nm
must be called from a pkgsrc root directory.
.Sh EXIT STATUS
Non-zero if writing to a log file fails, zero otherwise.
.Sh ENVIRONMENT
.Bl -tag -width XXXXXX
.It Ev BMAKE Pq mandatory
The
.Xr make 1
program used to build packages.
.It Ev PKGLIST Pq optional
The list of packages from which to build an index.
.El
.\" .Sh EXAMPLES
.Sh DIAGNOSTICS
Diagnostics have one of the two forms
.Ql printindex: error: ...
or
.Ql [printindex] ... .
The latter may span multiple lines.
.Sh SEE ALSO
.Xr printdepends 1
.\" .Sh STANDARDS
.Sh HISTORY
.Nm
appeared in 2001 as part of the bulk build framework.
.Sh AUTHORS
Many (see the CVS ChangeLog).
.\" .Sh CAVEATS
.\" .Sh BUGS
.\" .Sh SECURITY CONSIDERATIONS