pkgsrc/pkgtools/createbuildlink/files/createbuildlink.8
maya 6c25dec844 Remove clauses 3,4 from TNF-only copyright blocks.
This is based on the decision The NetBSD Foundation made in 2008 to
do so, which was already applied to src.

This change has been applied to code which is likely not in other
repositories.

ok board@, reviewed by riastradh@
2018-08-22 20:48:36 +00:00

86 lines
2.9 KiB
Groff

.\" $NetBSD: createbuildlink.8,v 1.13 2018/08/22 20:48:37 maya Exp $
.\"
.\" Copyright (c) 2002,2004 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Rene Hexel.
.\"
.\" 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.
.\"
.\" 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 September 27, 2004
.Dt CREATEBUILDLINK 8
.Os
.Sh NAME
.Nm createbuildlink
.Nd automatic pkgsrc buildlink3.mk generator
.Sh SYNOPSIS
.Nm
.Op Fl p
.Sh DESCRIPTION
.Nm
reads in the
.Pa Makefile
and
.Pa PLIST
of a package and creates
an initial
.Pa buildlink3.mk
file on stdout.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl p
Create PRINT_PLIST_AWK substitution patterns for directories created
and removed by this package.
This is useful for base packages that create a directory structure
for a number of dependent packages.
.El
.Pp
While
.Nm
is supposed to help starting create a buildlink file
for a package, it is not intended to fly on autopilot.
That means that while the script makes some simplistic attempts
to interpret some elements of the
.Pa Makefile
and the
.Pa PLIST
such as the contents of the include and lib subdirectories or
package config scripts, the results should not be put into a
package directory without some scrutiny.
.Pp
Using
.Nm
helps maneuver through the initial process of creating a buildlink
file for a package to be included by depending packages.
Using
.Nm
is less error-prone than copying an existing buildlink file
as a template and renaming the entries in there.
.Sh SEE ALSO
.Xr packages 7 ,
.Xr url2pkg 8
.Sh AUTHORS
.Nm
was written by
.An Rene Hexel Aq Mt rh@netbsd.org .