pkgtools/createbuildlink/files/createbuildlink.8

   1 .\"     $NetBSD: createbuildlink.8,v 1.10 2004/09/26 23:48:09 rh Exp $
   2 .\"
   3 .\" Copyright (c) 2002,2004 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Rene Hexel.
   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 September 27, 2004
  38 .Dt CREATEBUILDLINK 8
  39 .Os
  40 .Sh NAME
  41 .Nm createbuildlink
  42 .Nd automatic pkgsrc buildlink3.mk generator
  43 .Sh SYNOPSIS
  44 .Nm
  45 .Op Fl p
  46 .Sh DESCRIPTION
  47 .Nm
  48 reads in the
  49 .Pa Makefile
  50 and
  51 .Pa PLIST
  52 of a package and creates
  53 an initial
  54 .Pa buildlink3.mk
  55 file on stdout.
  56 .Pp
  57 The following options are available:
  58 .Bl -tag -width indent
  59 .It Fl p
  60 Create PRINT_PLIST_AWK substitution patterns for directories created
  61 and removed by this package.
  62 This is useful for base packages that create a directory structure
  63 for a number of dependent packages.
  64 .El
  65 .Pp
  66 While
  67 .Nm
  68 is supposed to help starting create a buildlink file
  69 for a package, it is not intended to fly on autopilot.
  70 That means that while the script makes some simplistic attempts
  71 to interpret some elements of the
  72 .Pa Makefile
  73 and the
  74 .Pa PLIST
  75 such as the contents of the include and lib subdirectories or
  76 package config scripts, the results should not be put into a
  77 package directory without some scrutiny.
  78 .Pp
  79 Using
  80 .Nm
  81 helps maneuver through the initial process of creating a buildlink
  82 file for a package to be included by depending packages.
  83 Using
  84 .Nm
  85 is less error-prone than copying an existing buildlink file
  86 as a template and renaming the entries in there.
  87 .Sh SEE ALSO
  88 .Xr packages 7 ,
  89 .Xr url2pkg 8
  90 .Sh AUTHORS
  91 .Nm
  92 was written by
  93 .An Rene Hexel Aq rh@netbsd.org .