mk/bulk/printindex.1

   1 .\"     $NetBSD: printindex.1,v 1.7 2006/11/26 08:39:52 rillig Exp $
   2 .\"
   3 .\" Copyright (c) 2005 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Roland Illig <rillig@NetBSD.org>.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgement:
  19 .\"        This product includes software developed by the NetBSD
  20 .\"        Foundation, Inc. and its contributors.
  21 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  22 .\"    contributors may be used to endorse or promote products derived
  23 .\"    from this software without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  26 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  27 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  28 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  29 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35 .\" POSSIBILITY OF SUCH DAMAGE.
  36 .\"
  37 .Dd November 26, 2006
  38 .Dt PRINTINDEX 1
  39 .Os
  40 .Sh NAME
  41 .Nm printindex
  42 .Nd generate a PKGPATH to PKGNAME mapping database file
  43 .Sh SYNOPSIS
  44 .Nm
  45 .Op Ar brokenfile Op Ar bulkfilesdir
  46 .Sh DESCRIPTION
  47 Generates a mapping from pkgsrc directories to the current package
  48 version and prints it on stdout.
  49 It also checks whether the package can be built on this system at all
  50 and marks those that cannot be built as broken.
  51 .Pp
  52 Each line of the output has two fields:
  53 the package directory (in the form
  54 .Ql category/package )
  55 and the package version (in the form
  56 .Ql package-1.456nb3 ) .
  57 .Pp
  58 If
  59 .Ar brokenfile
  60 is given, package-specific errors are logged to
  61 .Ar bulkfilesdir Ns / Ns
  62 .Va ${pkgdir} Ns / Ns
  63 .Ar brokenfile .
  64 Otherwise no additional logging takes place.
  65 .Pp
  66 The default for
  67 .Ar bulkfilesdir
  68 is the pkgsrc directory itself.
  69 If
  70 .Ar bulkfilesdir
  71 differs from the pkgsrc directory, all directories that are needed for
  72 the log files are created automatically.
  73 .Sh LIMITATIONS
  74 .Nm
  75 must be called from a pkgsrc root directory.
  76 .Sh EXIT STATUS
  77 Non-zero if writing to a log file fails, zero otherwise.
  78 .Sh ENVIRONMENT
  79 .Bl -tag -width XXXXXX
  80 .It Ev BMAKE Pq mandatory
  81 The
  82 .Xr make 1
  83 program used to build packages.
  84 .It Ev PKGLIST Pq optional
  85 The list of packages from which to build an index.
  86 .El
  87 .\" .Sh EXAMPLES
  88 .Sh DIAGNOSTICS
  89 Diagnostics have one of the two forms
  90 .Ql printindex: error: ...
  91 or
  92 .Ql [printindex] ... .
  93 The latter may span multiple lines.
  94 .Sh SEE ALSO
  95 .Xr printdepends 1
  96 .\" .Sh STANDARDS
  97 .Sh HISTORY
  98 .Nm
  99 appeared in 2001 as part of the bulk build framework.
 100 .Sh AUTHORS
 101 Many (see the CVS ChangeLog).
 102 .\" .Sh CAVEATS
 103 .\" .Sh BUGS
 104 .\" .Sh SECURITY CONSIDERATIONS