2006-05-28 22:41:22 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
< html >
2004-10-21 16:44:39 +02:00
< head >
2006-05-28 22:41:22 +02:00
< meta http-equiv = "Content-Type" content = "text/html; charset=ISO-8859-1" >
< title > The pkgsrc guide< / title >
< link rel = "stylesheet" href = "/NetBSD.css" type = "text/css" >
< meta name = "generator" content = "DocBook XSL Stylesheets VX.X.X" >
< meta name = "description" content = "pkgsrc is a centralized package management system for
Unix-like operating systems. This guide provides information for
users and developers of pkgsrc. It covers installation of binary
and source packages, creation of binary and source packages and
a high-level overview about the infrastructure.">
< / head >
< body bgcolor = "white" text = "black" link = "#0000FF" vlink = "#840084" alink = "#0000FF" > < div class = "book" lang = "en" >
< div class = "titlepage" >
< div >
< div > < h1 class = "title" >
< a name = "the-pkgsrc-guide" > < / a > The pkgsrc guide< / h1 > < / div >
< div > < h2 class = "subtitle" > Documentation on the NetBSD packages system< / h2 > < / div >
< div > < div class = "authorgroup" >
< div class = "author" >
< h3 class = "author" >
< span class = "firstname" > Alistair< / span > < span class = "surname" > Crooks< / span >
< / h3 >
< div class = "affiliation" > < div class = "address" > < p > < code class = "email" > < < a href = "mailto:agc@NetBSD.org" > agc@NetBSD.org< / a > > < / code > < / p > < / div > < / div >
< / div >
< div class = "author" >
< h3 class = "author" >
< span class = "firstname" > Hubert< / span > < span class = "surname" > Feyrer< / span >
< / h3 >
< div class = "affiliation" > < div class = "address" > < p > < code class = "email" > < < a href = "mailto:hubertf@NetBSD.org" > hubertf@NetBSD.org< / a > > < / code > < / p > < / div > < / div >
< / div >
< h3 class = "corpauthor" >
The pkgsrc Developers
< / h3 >
< / div > < / div >
< div > < p class = "copyright" > Copyright <20> 1994-2006 The NetBSD Foundation, Inc< / p > < / div >
2006-06-01 11:36:55 +02:00
< div > < p class = "pubdate" > $NetBSD: pkgsrc.xml,v 1.19 2006/06/01 08:39:03 rillig Exp $< / p > < / div >
2006-05-29 10:55:59 +02:00
< div > < div class = "abstract" >
2006-05-28 22:41:22 +02:00
< p class = "title" > < b > Abstract< / b > < / p >
< p > pkgsrc is a centralized package management system for
Unix-like operating systems. This guide provides information for
users and developers of pkgsrc. It covers installation of binary
and source packages, creation of binary and source packages and
a high-level overview about the infrastructure.< / p >
< / div > < / div >
< / div >
< hr >
< / div >
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
< dt > < span class = "chapter" > < a href = "#introduction" > 1. What is pkgsrc?< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#introduction-section" > 1.1. Introduction< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#overview" > 1.2. Overview< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#terminology" > 1.3. Terminology< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#term.people" > 1.3.1. People involved in pkgsrc< / a > < / span > < / dt > < / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#typography" > 1.4. Typography< / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "part" > < a href = "#users-guide" > I. The pkgsrc user's guide< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "chapter" > < a href = "#getting" > 2. Where to get pkgsrc and how to keep it up-to-date< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#getting-first" > 2.1. Getting pkgsrc for the first time< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#getting-via-tar" > 2.1.1. As tar file< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#getting-via-sup" > 2.1.2. Via SUP< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#getting-via-cvs" > 2.1.3. Via CVS< / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#uptodate" > 2.2. Keeping pkgsrc up-to-date< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#uptodate-tar" > 2.2.1. Via tar files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#uptodate-cvs" > 2.2.2. Via CVS< / a > < / span > < / dt >
< / dl > < / dd >
< / dl > < / dd >
< dt > < span class = "chapter" > < a href = "#platforms" > 3. Using pkgsrc on systems other than NetBSD< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#bootstrapping-pkgsrc" > 3.1. Bootstrapping pkgsrc< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#platform-specific-notes" > 3.2. Platform-specific notes< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#darwin" > 3.2.1. Darwin (Mac OS X)< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#freebsd" > 3.2.2. FreeBSD< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#interix" > 3.2.3. Interix< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#irix" > 3.2.4. IRIX< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#linux" > 3.2.5. Linux< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#openbsd" > 3.2.6. OpenBSD< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#solaris" > 3.2.7. Solaris< / a > < / span > < / dt >
< / dl > < / dd >
< / dl > < / dd >
< dt > < span class = "chapter" > < a href = "#using" > 4. Using pkgsrc< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#using-pkg" > 4.1. Using binary packages< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#finding-binary-packages" > 4.1.1. Finding binary packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#installing-binary-packages" > 4.1.2. Installing binary packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#a-word-of-warning" > 4.1.3. A word of warning< / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#building-packages-from-source" > 4.2. Building packages from source< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#requirements" > 4.2.1. Requirements< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#fetching-distfiles" > 4.2.2. Fetching distfiles< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#how-to-build-and-install" > 4.2.3. How to build and install< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#selecting-the-compiler" > 4.2.4. Selecting the compiler< / a > < / span > < / dt >
< / dl > < / dd >
< / dl > < / dd >
< dt > < span class = "chapter" > < a href = "#configuring" > 5. Configuring pkgsrc< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#general-configuration" > 5.1. General configuration< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#variables-affecting-build" > 5.2. Variables affecting the build process< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#developer-advanced-settings" > 5.3. Developer/advanced settings< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#selecting-build-options" > 5.4. Selecting Build Options< / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "chapter" > < a href = "#binary" > 6. Creating binary packages< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#building-a-single-binary-package" > 6.1. Building a single binary package< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#settings-for-creationg-of-binary-packages" > 6.2. Settings for creation of binary packages< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#bulkbuild" > 6.3. Doing a bulk build of all packages< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#binary.configuration" > 6.3.1. Configuration< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#other-environmental-considerations" > 6.3.2. Other environmental considerations< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#operation" > 6.3.3. Operation< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#what-it-does" > 6.3.4. What it does< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#disk-space-requirements" > 6.3.5. Disk space requirements< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#setting-up-a-sandbox" > 6.3.6. Setting up a sandbox for chrooted builds< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#building-a-partial-set" > 6.3.7. Building a partial set of packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#bulk-upload" > 6.3.8. Uploading results of a bulk build< / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#creating-cdroms" > 6.4. Creating a multiple CD-ROM packages collection< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#cdpack-example" > 6.4.1. Example of cdpack< / a > < / span > < / dt > < / dl > < / dd >
< / dl > < / dd >
< dt > < span class = "chapter" > < a href = "#faq" > 7. Frequently Asked Questions< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#mailing-list-pointers" > 7.1. Are there any mailing lists for pkg-related discussion?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#pkgviews-docs" > 7.2. Where's the pkgviews documentation?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#faq-pkgtools" > 7.3. Utilities for package management (pkgtools)< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#non-root-pkgsrc" > 7.4. How to use pkgsrc as non-root< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#resume-transfers" > 7.5. How to resume transfers when fetching distfiles?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#XFree86-from-pkgsrc" > 7.6. How can I install/use XFree86 from pkgsrc?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#x.org-from-pkgsrc" > 7.7. How can I install/use X.org from pkgsrc?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#fetch-behind-firewall" > 7.8. How to fetch files from behind a firewall< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#passive-ftp" > 7.9. How do I tell < span > < strong class = "command" > make fetch< / strong > < / span > to do passive FTP?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#fetching-all-distfiles" > 7.10. How to fetch all distfiles at once< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#tmac.andoc-missing" > 7.11. What does “ < span class = "quote" > Don't know how to make
/usr/share/tmac/tmac.andoc< / span > ” mean?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#bsd.own.mk-missing" > 7.12. What does “ < span class = "quote" > Could not find bsd.own.mk< / span > ” mean?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#using-sudo-with-pkgsrc" > 7.13. Using 'sudo' with pkgsrc< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#faq.conf" > 7.14. How do I change the location of configuration files?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#audit-packages" > 7.15. Automated security checks< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#ufaq-cflags" > 7.16. Why do some packages ignore my < code class = "varname" > CFLAGS< / code > ?< / a > < / span > < / dt >
< / dl > < / dd >
< / dl > < / dd >
< dt > < span class = "part" > < a href = "#developers-guide" > II. The pkgsrc developer's guide< / a > < / span > < / dt >
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#creating" > 8. Creating a new pkgsrc package from scratch< / a > < / span > < / dt >
< dt > < span class = "chapter" > < a href = "#components" > 9. Package components - files, directories and contents< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#components.Makefile" > 9.1. < code class = "filename" > Makefile< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#components.distinfo" > 9.2. < code class = "filename" > distinfo< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#components.patches" > 9.3. patches/*< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#other-mandatory-files" > 9.4. Other mandatory files< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#components.optional" > 9.5. Optional files< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#work-dir" > 9.6. < code class = "filename" > work*< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#files-dir" > 9.7. < code class = "filename" > files/*< / code > < / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#makefile" > 10. Programming in < code class = "filename" > Makefile< / code > s< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#makefile.variables" > 10.1. < code class = "filename" > Makefile< / code > variables< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#makefile.variables.names" > 10.1.1. Naming conventions< / a > < / span > < / dt > < / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#makefile.code" > 10.2. Code snippets< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#adding-to-list" > 10.2.1. Adding things to a list< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#converting-internal-to-external" > 10.2.2. Converting an internal list into an external list< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#passing-variable-to-shell" > 10.2.3. Passing variables to a shell command< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#quoting-guideline" > 10.2.4. Quoting guideline< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#bsd-make-bug-workaround" > 10.2.5. Workaround for a bug in BSD Make< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#plist" > 11. PLIST issues< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#rcs-id" > 11.1. RCS ID< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#automatic-plist-generation" > 11.2. Semi-automatic < code class = "filename" > PLIST< / code > generation< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#print-PLIST" > 11.3. Tweaking output of < span > < strong class = "command" > make print-PLIST< / strong > < / span > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#plist.misc" > 11.4. Variable substitution in PLIST< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#manpage-compression" > 11.5. Man page compression< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#using-PLIST_SRC" > 11.6. Changing PLIST source with < code class = "varname" > PLIST_SRC< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#platform-specific-plist" > 11.7. Platform-specific and differing PLISTs< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#faq.common-dirs" > 11.8. Sharing directories between packages< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#buildlink" > 12. Buildlink methodology< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#converting-to-buildlink3" > 12.1. Converting packages to use buildlink3< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#creating-buildlink3.mk" > 12.2. Writing < code class = "filename" > buildlink3.mk< / code > files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#anatomy-of-bl3" > 12.2.1. Anatomy of a buildlink3.mk file< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#updating-buildlink-depends" > 12.2.2. Updating < code class = "varname" > BUILDLINK_API_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code > in < code class = "filename" > buildlink3.mk< / code > files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#writing-builtin.mk" > 12.3. Writing < code class = "filename" > builtin.mk< / code > files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#anatomy-of-builtin.mk" > 12.3.1. Anatomy of a < code class = "filename" > builtin.mk< / code > file< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#native-or-pkgsrc-preference" > 12.3.2. Global preferences for native or pkgsrc software< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#pkginstall" > 13. The pkginstall framework< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#files-and-dirs-outside-prefix" > 13.1. Files and directories outside the installation prefix< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#dirs-outside-prefix" > 13.1.1. Directory manipulation< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#files-outside-prefix" > 13.1.2. File manipulation< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#conf-files" > 13.2. Configuration files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#conf-files-sysconfdir" > 13.2.1. How < code class = "varname" > PKG_SYSCONFDIR< / code > is set< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#conf-files-configure" > 13.2.2. Telling the software where configuration files are< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#conf-files-patching" > 13.2.3. Patching installations< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#conf-files-disable" > 13.2.4. Disabling handling of configuration files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#rcd-scripts" > 13.3. System startup scripts< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#rcd-scripts-disable" > 13.3.1. Disabling handling of system startup scripts< / a > < / span > < / dt > < / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#users-and-groups" > 13.4. System users and groups< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#shells" > 13.5. System shells< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#shells-disable" > 13.5.1. Disabling shell registration< / a > < / span > < / dt > < / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#fonts" > 13.6. Fonts< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#fonts-disable" > 13.6.1. Disabling automatic update of the fonts databases< / a > < / span > < / dt > < / dl > < / dd >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#options" > 14. Options handling< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#global-default-options" > 14.1. Global default options< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#converting-to-options" > 14.2. Converting packages to use < code class = "filename" > bsd.options.mk< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#option-names" > 14.3. Option Names< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#build" > 15. The build process< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#build.intro" > 15.1. Introduction< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.prefix" > 15.2. Program location< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.builddirs" > 15.3. Directories used during the build process< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.running" > 15.4. Running a phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.fetch" > 15.5. The < span class = "emphasis" > < em > fetch< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.checksum" > 15.6. The < span class = "emphasis" > < em > checksum< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.extract" > 15.7. The < span class = "emphasis" > < em > extract< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.patch" > 15.8. The < span class = "emphasis" > < em > patch< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.tools" > 15.9. The < span class = "emphasis" > < em > tools< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.wrapper" > 15.10. The < span class = "emphasis" > < em > wrapper< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.configure" > 15.11. The < span class = "emphasis" > < em > configure< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.build" > 15.12. The < span class = "emphasis" > < em > build< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.test" > 15.13. The < span class = "emphasis" > < em > test< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.install" > 15.14. The < span class = "emphasis" > < em > install< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.package" > 15.15. The < span class = "emphasis" > < em > package< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.helpful-targets" > 15.16. Other helpful targets< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#tools" > 16. Tools needed for building or running< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#pkgsrc-tools" > 16.1. Tools for pkgsrc builds< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#package-tools" > 16.2. Tools needed by packages< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#platform-tools" > 16.3. Tools provided by platforms< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#fixes" > 17. Making your package work< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#general-operation" > 17.1. General operation< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#pulling-vars-from-etc-mk.conf" > 17.1.1. How to pull in variables from /etc/mk.conf< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#where-to-install-documentation" > 17.1.2. Where to install documentation< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#restricted-packages" > 17.1.3. Restricted packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#dependencies" > 17.1.4. Handling dependencies< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#conflicts" > 17.1.5. Handling conflicts with other packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#not-building-packages" > 17.1.6. Packages that cannot or should not be built< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#undeletable-packages" > 17.1.7. Packages which should not be deleted, once installed< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#security-handling" > 17.1.8. Handling packages with security problems< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#compiler-bugs" > 17.1.9. How to handle compiler bugs< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#bumping-pkgrevision" > 17.1.10. How to handle incrementing versions when fixing an existing package< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#portability-of-packages" > 17.1.11. Portability of packages< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#fixes.fetch" > 17.2. Fixing problems in the < span class = "emphasis" > < em > fetch< / em > < / span > phase< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#no-plain-download" > 17.2.1. Packages whose distfiles aren't available for plain downloading< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#modified-distfiles-same-name" > 17.2.2. How to handle modified distfiles with the 'old' name< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#fixes.configure" > 17.3. Fixing problems in the < span class = "emphasis" > < em > configure< / em > < / span > phase< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#fixes.libtool" > 17.3.1. Shared libraries - libtool< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#using-libtool" > 17.3.2. Using libtool on GNU packages that already support libtool< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#autoconf-automake" > 17.3.3. GNU Autoconf/Automake< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#fixes.build" > 17.4. Fixing problems in the < span class = "emphasis" > < em > build< / em > < / span > phase< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#fixes.build.cpp" > 17.4.1. Compiling C and C++ code conditionally< / a > < / span > < / dt > < / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#package-specific-actions" > 17.5. Package specific actions< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#user-interaction" > 17.5.1. User interaction< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#handling-licenses" > 17.5.2. Handling licenses< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#fixes.install" > 17.6. Fixing problems in the < span class = "emphasis" > < em > install< / em > < / span > phase< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#installing-score-files" > 17.6.1. Installing score files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#perl-scripts" > 17.6.2. Packages containing perl scripts< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#hardcoded-paths" > 17.6.3. Packages with hardcoded paths to other interpreters< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#perl-modules" > 17.6.4. Packages installing perl modules< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#faq.info-files" > 17.6.5. Packages installing info files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#manpages" > 17.6.6. Packages installing man pages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#gconf2-data-files" > 17.6.7. Packages installing GConf2 data files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#scrollkeeper-data-files" > 17.6.8. Packages installing scrollkeeper data files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#x11-fonts" > 17.6.9. Packages installing X11 fonts< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#gtk2-modules" > 17.6.10. Packages installing GTK2 modules< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#sgml-xml-data" > 17.6.11. Packages installing SGML or XML data< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#mime-database" > 17.6.12. Packages installing extensions to the MIME database< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#intltool" > 17.6.13. Packages using intltool< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#startup-scripts" > 17.6.14. Packages installing startup scripts< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#tex-packages" > 17.6.15. Packages installing TeX modules< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#feedback-to-author" > 17.7. Feedback to the author< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#debug" > 18. Debugging< / a > < / span > < / dt >
< dt > < span class = "chapter" > < a href = "#submit" > 19. Submitting and Committing< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#submitting-binary-packages" > 19.1. Submitting binary packages< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#submitting-your-package" > 19.2. Submitting source packages (for non-NetBSD-developers)< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#general-notes-for-changes" > 19.3. General notes when adding, updating, or removing packages< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#committing-importing" > 19.4. Committing: Importing a package into CVS< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#updating-package" > 19.5. Updating a package to a newer version< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#moving-package" > 19.6. Moving a package in pkgsrc< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#devfaq" > 20. Frequently Asked Questions< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< dt > < span class = "part" > < a href = "#infrastructure" > III. The pkgsrc infrastructure internals< / a > < / span > < / dt >
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#infr.design" > 21. Design of the pkgsrc infrastructure< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#infr.var" > 21.1. Variable evaluation< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#infr.var.load" > 21.1.1. At load time< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#infr.var.run" > 21.1.2. At runtime< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#infr.design.intf" > 21.2. Designing interfaces for Makefile fragments< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#infr.design.intf.proc" > 21.2.1. Procedures with parameters< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#infr.design.intf.action" > 21.2.2. Actions taken on behalf of parameters< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#regression" > 22. Regression tests< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#regression.descr" > 22.1. The regression tests framework< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#regression.run" > 22.2. Running the regression tests< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#regression.new" > 22.3. Adding a new regression test< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#regression.fun.override" > 22.3.1. Overridable functions< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#regression.fun.helper" > 22.3.2. Helper functions< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#porting" > 23. Porting pkgsrc< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#porting.opsys" > 23.1. Porting pkgsrc to a new operating system< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#porting.compiler" > 23.2. Adding support for a new compiler< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< / dl > < / dd >
< dt > < span class = "appendix" > < a href = "#examples" > A. A simple example package: bison< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#example-files" > A.1. files< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#example-Makefile" > A.1.1. Makefile< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#example-descr" > A.1.2. DESCR< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#example-plist" > A.1.3. PLIST< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#checking-package-with-pkglint" > A.1.4. Checking a package with < span > < strong class = "command" > pkglint< / strong > < / span > < / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#steps-for-b-i-p" > A.2. Steps for building, installing, packaging< / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "appendix" > < a href = "#logs" > B. Build logs< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#logs.building" > B.1. Building figlet< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#logs.package" > B.2. Packaging figlet< / a > < / span > < / dt >
< / dl > < / dd >
2006-05-29 10:55:59 +02:00
< dt > < span class = "appendix" > < a href = "#ftp-layout" > C. Directory layout of the pkgsrc FTP server< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#ftp-bootstrap" > C.1. < code class = "filename" > bootstrap-pkgsrc< / code > : Bootstrap kits< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#ftp-distfiles" > C.2. < code class = "filename" > distfiles< / code > : The distributed source files< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#ftp-iso" > C.3. < code class = "filename" > iso< / code > : Currently empty< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#ftp-misc" > C.4. < code class = "filename" > misc< / code > : Miscellaneous things< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#ftp-packages" > C.5. < code class = "filename" > packages*< / code > : Binary packages< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#ftp-source" > C.6. < code class = "filename" > current< / code > ,
< code class = "filename" > 200< em class = "replaceable" > < code > x< / code > < / em > Q< em class = "replaceable" > < code > y< / code > < / em > < / code > :
source packages< / a > < / span > < / dt >
< / dl > < / dd >
2006-05-28 22:41:22 +02:00
< dt > < span class = "appendix" > < a href = "#editing" > D. Editing guidelines for the pkgsrc guide< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#targets" > D.1. Targets< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#procedure" > D.2. Procedure< / a > < / span > < / dt >
< / dl > < / dd >
< / dl >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
< a name = "introduction" > < / a > Chapter<EFBFBD> 1.<2E> What is pkgsrc?< / h2 > < / div > < / div > < / div >
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
< dt > < span class = "sect1" > < a href = "#introduction-section" > 1.1. Introduction< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#overview" > 1.2. Overview< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#terminology" > 1.3. Terminology< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#term.people" > 1.3.1. People involved in pkgsrc< / a > < / span > < / dt > < / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#typography" > 1.4. Typography< / a > < / span > < / dt >
< / dl >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "introduction-section" > < / a > 1.1.<2E> Introduction< / h2 > < / div > < / div > < / div >
< p > There is a lot of software freely available for Unix-based
systems, which usually runs on NetBSD and other Unix-flavoured
systems, too, sometimes with some modifications. The NetBSD
Packages Collection (pkgsrc) incorporates any such changes
necessary to make that software run, and makes the installation
(and de-installation) of the software package easy by means of a
single command. < / p >
< p > Once the software
has been built, it is manipulated with the < span > < strong class = "command" > pkg_*< / strong > < / span > tools
so that installation
and de-installation, printing of an inventory of all installed packages and
retrieval of one-line comments or more verbose descriptions are all
simple.< / p >
< p > pkgsrc currently contains several thousand packages,
including:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/www/apache/README.html" target = "_top" > < code class = "filename" > www/apache< / code > < / a > - The Apache
2006-05-28 22:41:22 +02:00
web server< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/www/mozilla/README.html" target = "_top" > < code class = "filename" > www/mozilla< / code > < / a > - The Mozilla
2006-05-28 22:41:22 +02:00
web browser< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/meta-pkgs/gnome/README.html" target = "_top" > < code class = "filename" > meta-pkgs/gnome< / code > < / a > - The GNOME
2006-05-28 22:41:22 +02:00
Desktop Environment< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/meta-pkgs/kde3/README.html" target = "_top" > < code class = "filename" > meta-pkgs/kde3< / code > < / a > - The K
2006-05-28 22:41:22 +02:00
Desktop Environment< / p > < / li >
< / ul > < / div >
< p > ...just to name a few.< / p >
< p > pkgsrc has built-in support for handling varying dependencies,
such as pthreads and X11, and extended features such as IPv6 support on
a range of platforms.< / p >
< p > pkgsrc was derived from FreeBSD's ports system, and
initially developed for NetBSD only. Since then, pkgsrc has
grown a lot, and now supports the following platforms:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < a href = "http://developer.apple.com/darwin/" target = "_top" > Darwin< / a >
(< a href = "http://www.apple.com/macosx/" target = "_top" > Mac OS X< / a > )< / p > < / li >
< li > < p > < a href = "http://www.DragonFlyBSD.org/" target = "_top" > DragonFly BSD< / a > < / p > < / li >
< li > < p > < a href = "http://www.FreeBSD.org/" target = "_top" > FreeBSD< / a > < / p > < / li >
< li > < p > Microsoft Windows, via < a href = "http://www.microsoft.com/windows/sfu/" target = "_top" > Interix< / a > < / p > < / li >
< li > < p > < a href = "http://www.sgi.com/software/irix6.5/" target = "_top" > IRIX< / a > < / p > < / li >
< li > < p > < a href = "http://www.linux.org/" target = "_top" > Linux< / a > < / p > < / li >
< li > < p > < a href = "http://www.NetBSD.org/" target = "_top" > NetBSD< / a > (of
course)< / p > < / li >
< li > < p > < a href = "http://h30097.www3.hp.com/" target = "_top" > Tru64< / a >
(Digital UNIX, OSF1)< / p > < / li >
< li > < p > < a href = "http://www.openbsd.org/" target = "_top" > OpenBSD< / a > < / p > < / li >
< li > < p > < a href = "http://www.sun.com/solaris/" target = "_top" > Solaris< / a > < / p > < / li >
< / ul > < / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "overview" > < / a > 1.2.<2E> Overview< / h2 > < / div > < / div > < / div >
< p > This document is divided into three parts. The first,
< a href = "#users-guide" title = "Part<72> I.<2E> The pkgsrc user's guide" > The pkgsrc user's guide< / a > ,
describes how one can use one of the packages in the Package
Collection, either by installing a precompiled binary package,
or by building one's own copy using the NetBSD package system.
The second part, < a href = "#developers-guide" title = "Part<72> II.<2E> The pkgsrc developer's guide" > The pkgsrc developer's guide< / a > , explains how to prepare a
package so it can be easily built by other NetBSD users without
knowing about the package's building details. The third part,
< a href = "#infrastructure" title = "Part<72> III.<2E> The pkgsrc infrastructure internals" > The pkgsrc infrastructure internals< / a >
is intended for those who want to understand how pkgsrc is
implemented.< / p >
< p > This document is available in various formats:
< span class = "simplelist" > < a href = "index.html" target = "_top" > HTML< / a > , < a href = "pkgsrc.pdf" target = "_top" > PDF< / a > , < a href = "pkgsrc.ps" target = "_top" > PS< / a > , < a href = "pkgsrc.txt" target = "_top" > TXT< / a > < / span > .< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "terminology" > < / a > 1.3.<2E> Terminology< / h2 > < / div > < / div > < / div >
< p > There has been a lot of talk about “ < span class = "quote" > ports< / span > ” ,
“ < span class = "quote" > packages< / span > ” , etc. so far. Here is a description of all the
terminology used within this document.< / p >
< div class = "variablelist" > < dl >
< dt > < span class = "term" > Package< / span > < / dt >
< dd > < p > A set of files and building instructions
that describe what's necessary
to build a certain piece of software using
pkgsrc. Packages are traditionally stored under
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkgsrc< / code > .< / p > < / dd >
2006-05-28 22:41:22 +02:00
< dt > < span class = "term" > The NetBSD package system< / span > < / dt >
< dd > < p >
This is the former name of “ < span class = "quote" > pkgsrc< / span > ” . It is
part of the NetBSD operating system and can be bootstrapped to
run on non-NetBSD operating systems as well. It handles
building (compiling), installing, and removing of
packages.
< / p > < / dd >
< dt > < span class = "term" > Distfile< / span > < / dt >
< dd > < p > This term describes the file or files that are
provided by the author of the piece of software to
distribute his work. All the changes necessary to build on
NetBSD are reflected in the corresponding package. Usually
the distfile is in the form of a compressed tar-archive,
but other types are possible, too. Distfiles are usually
stored below
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkgsrc/distfiles< / code > .< / p > < / dd >
2006-05-28 22:41:22 +02:00
< dt > < span class = "term" > Port< / span > < / dt >
< dd > < p > This is the term used by FreeBSD and OpenBSD people
for what we call a package.
In NetBSD terminology, “ < span class = "quote" > port< / span > ” refers to a different
architecture.< / p > < / dd >
< dt > < span class = "term" > Precompiled/binary package< / span > < / dt >
< dd >
< p > A set of binaries built with pkgsrc from a distfile
2006-05-29 10:55:59 +02:00
and stuffed together in a single < code class = "filename" > .tgz< / code >
2006-05-28 22:41:22 +02:00
file so it can be installed on machines of the same
machine architecture without the need to
recompile. Packages are usually generated in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkgsrc/packages< / code > ; there is also
2006-05-28 22:41:22 +02:00
an archive on < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target = "_top" > ftp.NetBSD.org< / a > .< / p >
< p > Sometimes, this is referred to by the term “ < span class = "quote" > package< / span > ” too,
especially in the context of precompiled packages.< / p >
< / dd >
< dt > < span class = "term" > Program< / span > < / dt >
< dd > < p > The piece of software to be installed which will be constructed from
all the files in the distfile by the actions defined in the
corresponding package.< / p > < / dd >
< / dl > < / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "term.people" > < / a > 1.3.1.<2E> People involved in pkgsrc< / h3 > < / div > < / div > < / div >
< div class = "variablelist" > < dl >
< dt > < span class = "term" > pkgsrc users< / span > < / dt >
< dd >
< p > The
pkgsrc users are people who use the packages provided by pkgsrc.
Typically they are system administrators. The people using the
software that is inside the packages (maybe called “ < span class = "quote" > end
users< / span > ” ) are not covered by the pkgsrc guide.< / p >
< p > There are two kinds of pkgsrc users: Some only want to
install pre-built binary packages. Others build the pkgsrc
packages from source, either for installing them directly or for
building binary packages themselves. For pkgsrc users < a href = "#users-guide" title = "Part<72> I.<2E> The pkgsrc user's guide" > Part<EFBFBD> I, “ The pkgsrc user's guide” < / a > should provide all necessary
documentation.< / p >
< / dd >
< dt > < span class = "term" > package maintainers< / span > < / dt >
< dd > < p > A
package maintainer creates packages as described in < a href = "#developers-guide" title = "Part<72> II.<2E> The pkgsrc developer's guide" > Part<EFBFBD> II, “ The pkgsrc developer's guide” < / a > .< / p > < / dd >
< dt > < span class = "term" > infrastructure developers< / span > < / dt >
< dd > < p > These people are involved in all those files
2006-05-29 10:55:59 +02:00
that live in the < code class = "filename" > mk/< / code > directory and below.
2006-05-28 22:41:22 +02:00
Only these people should need to read through < a href = "#infrastructure" title = "Part<72> III.<2E> The pkgsrc infrastructure internals" > Part<EFBFBD> III, “ The pkgsrc infrastructure internals” < / a > , though others might be curious,
too.< / p > < / dd >
< / dl > < / div >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "typography" > < / a > 1.4.<2E> Typography< / h2 > < / div > < / div > < / div >
< p > When giving examples for commands, shell prompts are used to
show if the command should/can be issued as root, or if
“ < span class = "quote" > normal< / span > ” user privileges are sufficient. We use a
< code class = "prompt" > #< / code > for root's shell prompt, and a < code class = "prompt" > %< / code > for users'
shell prompt, assuming they use the C-shell or tcsh.< / p >
< / div >
< / div >
< div class = "part" lang = "en" >
< div class = "titlepage" > < div > < div > < h1 class = "title" >
< a name = "users-guide" > < / a > Part<EFBFBD> I.<2E> The pkgsrc user's guide< / h1 > < / div > < / div > < / div >
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
< dt > < span class = "chapter" > < a href = "#getting" > 2. Where to get pkgsrc and how to keep it up-to-date< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#getting-first" > 2.1. Getting pkgsrc for the first time< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#getting-via-tar" > 2.1.1. As tar file< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#getting-via-sup" > 2.1.2. Via SUP< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#getting-via-cvs" > 2.1.3. Via CVS< / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#uptodate" > 2.2. Keeping pkgsrc up-to-date< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#uptodate-tar" > 2.2.1. Via tar files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#uptodate-cvs" > 2.2.2. Via CVS< / a > < / span > < / dt >
< / dl > < / dd >
< / dl > < / dd >
< dt > < span class = "chapter" > < a href = "#platforms" > 3. Using pkgsrc on systems other than NetBSD< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#bootstrapping-pkgsrc" > 3.1. Bootstrapping pkgsrc< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#platform-specific-notes" > 3.2. Platform-specific notes< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#darwin" > 3.2.1. Darwin (Mac OS X)< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#freebsd" > 3.2.2. FreeBSD< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#interix" > 3.2.3. Interix< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#irix" > 3.2.4. IRIX< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#linux" > 3.2.5. Linux< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#openbsd" > 3.2.6. OpenBSD< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#solaris" > 3.2.7. Solaris< / a > < / span > < / dt >
< / dl > < / dd >
< / dl > < / dd >
< dt > < span class = "chapter" > < a href = "#using" > 4. Using pkgsrc< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#using-pkg" > 4.1. Using binary packages< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#finding-binary-packages" > 4.1.1. Finding binary packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#installing-binary-packages" > 4.1.2. Installing binary packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#a-word-of-warning" > 4.1.3. A word of warning< / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#building-packages-from-source" > 4.2. Building packages from source< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#requirements" > 4.2.1. Requirements< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#fetching-distfiles" > 4.2.2. Fetching distfiles< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#how-to-build-and-install" > 4.2.3. How to build and install< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#selecting-the-compiler" > 4.2.4. Selecting the compiler< / a > < / span > < / dt >
< / dl > < / dd >
< / dl > < / dd >
< dt > < span class = "chapter" > < a href = "#configuring" > 5. Configuring pkgsrc< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#general-configuration" > 5.1. General configuration< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#variables-affecting-build" > 5.2. Variables affecting the build process< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#developer-advanced-settings" > 5.3. Developer/advanced settings< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#selecting-build-options" > 5.4. Selecting Build Options< / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "chapter" > < a href = "#binary" > 6. Creating binary packages< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#building-a-single-binary-package" > 6.1. Building a single binary package< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#settings-for-creationg-of-binary-packages" > 6.2. Settings for creation of binary packages< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#bulkbuild" > 6.3. Doing a bulk build of all packages< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#binary.configuration" > 6.3.1. Configuration< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#other-environmental-considerations" > 6.3.2. Other environmental considerations< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#operation" > 6.3.3. Operation< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#what-it-does" > 6.3.4. What it does< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#disk-space-requirements" > 6.3.5. Disk space requirements< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#setting-up-a-sandbox" > 6.3.6. Setting up a sandbox for chrooted builds< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#building-a-partial-set" > 6.3.7. Building a partial set of packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#bulk-upload" > 6.3.8. Uploading results of a bulk build< / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#creating-cdroms" > 6.4. Creating a multiple CD-ROM packages collection< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#cdpack-example" > 6.4.1. Example of cdpack< / a > < / span > < / dt > < / dl > < / dd >
< / dl > < / dd >
< dt > < span class = "chapter" > < a href = "#faq" > 7. Frequently Asked Questions< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect1" > < a href = "#mailing-list-pointers" > 7.1. Are there any mailing lists for pkg-related discussion?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#pkgviews-docs" > 7.2. Where's the pkgviews documentation?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#faq-pkgtools" > 7.3. Utilities for package management (pkgtools)< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#non-root-pkgsrc" > 7.4. How to use pkgsrc as non-root< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#resume-transfers" > 7.5. How to resume transfers when fetching distfiles?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#XFree86-from-pkgsrc" > 7.6. How can I install/use XFree86 from pkgsrc?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#x.org-from-pkgsrc" > 7.7. How can I install/use X.org from pkgsrc?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#fetch-behind-firewall" > 7.8. How to fetch files from behind a firewall< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#passive-ftp" > 7.9. How do I tell < span > < strong class = "command" > make fetch< / strong > < / span > to do passive FTP?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#fetching-all-distfiles" > 7.10. How to fetch all distfiles at once< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#tmac.andoc-missing" > 7.11. What does “ < span class = "quote" > Don't know how to make
/usr/share/tmac/tmac.andoc< / span > ” mean?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#bsd.own.mk-missing" > 7.12. What does “ < span class = "quote" > Could not find bsd.own.mk< / span > ” mean?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#using-sudo-with-pkgsrc" > 7.13. Using 'sudo' with pkgsrc< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#faq.conf" > 7.14. How do I change the location of configuration files?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#audit-packages" > 7.15. Automated security checks< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#ufaq-cflags" > 7.16. Why do some packages ignore my < code class = "varname" > CFLAGS< / code > ?< / a > < / span > < / dt >
< / dl > < / dd >
< / dl >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
< a name = "getting" > < / a > Chapter<EFBFBD> 2.<2E> Where to get pkgsrc and how to keep it up-to-date< / h2 > < / div > < / div > < / div >
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
< dt > < span class = "sect1" > < a href = "#getting-first" > 2.1. Getting pkgsrc for the first time< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#getting-via-tar" > 2.1.1. As tar file< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#getting-via-sup" > 2.1.2. Via SUP< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#getting-via-cvs" > 2.1.3. Via CVS< / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#uptodate" > 2.2. Keeping pkgsrc up-to-date< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#uptodate-tar" > 2.2.1. Via tar files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#uptodate-cvs" > 2.2.2. Via CVS< / a > < / span > < / dt >
< / dl > < / dd >
< / dl >
< / div >
< p > The most common location where pkgsrc is installed is
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkgsrc< / code > for the “ < span class = "quote" > package
sources< / span > ” and < code class = "filename" > /usr/pkg< / code > for the
2006-05-28 22:41:22 +02:00
installed binary packages. You are though free to install the
sources and binary packages wherever you want in your
filesystem, provided that both paths do not contain white-space
or other characters that are interpreted specially by the shell
and some other programs. A safe bet is to use only letters,
digits, underscores and dashes in the names.< / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "getting-first" > < / a > 2.1.<2E> Getting pkgsrc for the first time< / h2 > < / div > < / div > < / div >
< p > Before you download any pkgsrc files, you should decide
whether you want the < span class = "emphasis" > < em > current< / em > < / span > branch or the
< span class = "emphasis" > < em > stable< / em > < / span > branch. The latter is forked on a
quarterly basis from the current branch and only gets modified
for security updates. The names of the stable branches are built
from the year and the quarter, for example
< code class = "literal" > 2006Q1< / code > .< / p >
< p > The second step is to decide < span class = "emphasis" > < em > how< / em > < / span > you
want to download pkgsrc. You can get it as a tar file, via SUP,
or via CVS. All three ways are described here.< / p >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "getting-via-tar" > < / a > 2.1.1.<2E> As tar file< / h3 > < / div > < / div > < / div >
< p > The primary download location for all pkgsrc files is
< a href = "ftp://ftp.NetBSD.org/pub/pkgsrc/" target = "_top" > ftp://ftp.NetBSD.org/pub/pkgsrc/< / a > . There are a
number of subdirectories for different purposes, which are
2006-05-29 10:55:59 +02:00
described in detail in < a href = "#ftp-layout" title = "Appendix<69> C.<2E> Directory layout of the pkgsrc FTP server" > Appendix<EFBFBD> C, < i > Directory layout of the pkgsrc FTP server< / i > < / a > .< / p >
2006-05-28 22:41:22 +02:00
< p > The tar file for the current branch is in the directory
2006-05-29 10:55:59 +02:00
< code class = "filename" > current< / code > and is called < a href = "ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target = "_top" > < code class = "filename" > pkgsrc.tar.gz< / code > < / a > .
2006-05-28 22:41:22 +02:00
It is autogenerated daily.< / p >
< p > The tar file for the stable branch 2006Q1 is in the
2006-05-29 10:55:59 +02:00
directory < code class = "filename" > 2006Q1< / code > and is also called < a href = "ftp://ftp.NetBSD.org/pub/pkgsrc/2006Q1/pkgsrc.tar.gz" target = "_top" > < code class = "filename" > pkgsrc.tar.gz< / code > < / a > .< / p >
2006-05-28 22:41:22 +02:00
< p > After downloading the tar file, change to the directory
where you want to have pkgsrc. This is usually
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr< / code > . Then, run < span > < strong class = "command" > tar xfz
2006-05-28 22:41:22 +02:00
pkgsrc.tar.gz< / strong > < / span > to extract the files.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "getting-via-sup" > < / a > 2.1.2.<2E> Via SUP< / h3 > < / div > < / div > < / div >
< p > As an alternative to the tar file, you can get pkgsrc via
the Software Update Protocol, SUP. To do so, make sure your
supfile has a line
< / p >
< pre class = "programlisting" >
release=pkgsrc
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p >
in it, see the examples in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/share/examples/supfiles< / code > , and that the
< code class = "filename" > /usr/pkgsrc< / code > directory exists. Then, simply
2006-05-28 22:41:22 +02:00
run < span > < strong class = "command" > sup -v
< em class = "replaceable" > < code > /path/to/your/supfile< / code > < / em > < / strong > < / span > .< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "getting-via-cvs" > < / a > 2.1.3.<2E> Via CVS< / h3 > < / div > < / div > < / div >
< p > To get pkgsrc via CVS, make sure you have < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?cvs+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > cvs< / span > (1)< / span > < / a >
installed. To do an initial (full) checkout of pkgsrc, you first
have to set some environment variables. For the C-Shell,
type:< / p >
< pre class = "screen" >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot< / code > < / strong >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > setenv CVS_RSH ssh< / code > < / strong >
< / pre >
< p > Or, the same for the bourne shell:< / p >
< pre class = "screen" >
< code class = "prompt" > $< / code > < strong class = "userinput" > < code > CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"< / code > < / strong >
< code class = "prompt" > $< / code > < strong class = "userinput" > < code > CVS_RSH="ssh"< / code > < / strong >
< code class = "prompt" > $< / code > < strong class = "userinput" > < code > export CVSROOT CVS_RSH< / code > < / strong >
< / pre >
< p > Then, you change to the directory where you want to have
your copy of pkgsrc. In most cases this is
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr< / code > . In that directory you run the
2006-05-28 22:41:22 +02:00
checkout command, which is < span > < strong class = "command" > cvs -q checkout -P
pkgsrc< / strong > < / span > for the current branch and < span > < strong class = "command" > cvs -q
checkout -rpkgsrc-2006Q1 -P pkgsrc< / strong > < / span > for the stable
branch. This command will create a directory called
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc< / code > with all the pkgsrc files in
2006-05-28 22:41:22 +02:00
it.< / p >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "uptodate" > < / a > 2.2.<2E> Keeping pkgsrc up-to-date< / h2 > < / div > < / div > < / div >
< p > The preferred way to keep pkgsrc up-to-date is via CVS
(which also works if you have first installed it via a tar
file). It saves bandwidth and hard disk activity, compared to
downloading the tar file again.< / p >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "uptodate-tar" > < / a > 2.2.1.<2E> Via tar files< / h3 > < / div > < / div > < / div >
< div class = "warning" style = "margin-left: 0.5in; margin-right: 0.5in;" >
< h3 class = "title" > Warning< / h3 >
2006-06-01 11:36:55 +02:00
< p > When updating from a tar file, you first need to
completely remove the old pkgsrc directory. Otherwise those
files that have been removed from pkgsrc in the mean time will
not be removed on your local disk, resulting in inconsistencies.
When removing the old files, any changes that you have done to
the pkgsrc files will be lost after updating. Therefore updating
via CVS is strongly recommended.< / p >
2006-05-28 22:41:22 +02:00
< / div >
< p > To update pkgsrc from a tar file, download the tar file as
explained above. Then, make sure that you have not made any
changes to the files in the pkgsrc directory. Remove the pkgsrc
directory and extract the new tar file. Done.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "uptodate-cvs" > < / a > 2.2.2.<2E> Via CVS< / h3 > < / div > < / div > < / div >
< p > To update pkgsrc via CVS, make sure the environment
variable < code class = "varname" > CVS_RSH< / code > is set as above. Then,
change to the pkgsrc directory and run < span > < strong class = "command" > cvs -q update
2006-06-01 11:36:55 +02:00
-dP< / strong > < / span > .< / p >
2006-05-28 22:41:22 +02:00
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
< a name = "uptodate-cvs-switch" > < / a > 2.2.2.1.<2E> Switching between different pkgsrc branches< / h4 > < / div > < / div > < / div >
< p > When updating pkgsrc, the CVS program keeps track of the
branch you selected. But if you, for whatever reason, want to
switch from the stable branch to the current one, you can do it
by adding the option “ < span class = "quote" > -A< / span > ” after the
“ < span class = "quote" > update< / span > ” keyword. To switch from the current branch
back to the stable branch, add the
“ < span class = "quote" > -rpkgsrc-2006Q1< / span > ” option.< / p >
< / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
< a name = "uptodate-cvs-changes" > < / a > 2.2.2.2.<2E> What happens to my changes when updating?< / h4 > < / div > < / div > < / div >
< p > When you update pkgsrc, the CVS program will only touch
those files that are registered in the CVS repository. That
means that any packages that you created on your own will stay
unmodified. If you change files that are managed by CVS, later
updates will try to merge your changes with those that have been
done by others. See the CVS manual, chapter
“ < span class = "quote" > update< / span > ” for details.< / p >
< / div >
< / div >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
< a name = "platforms" > < / a > Chapter<EFBFBD> 3.<2E> Using pkgsrc on systems other than NetBSD< / h2 > < / div > < / div > < / div >
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
< dt > < span class = "sect1" > < a href = "#bootstrapping-pkgsrc" > 3.1. Bootstrapping pkgsrc< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#platform-specific-notes" > 3.2. Platform-specific notes< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#darwin" > 3.2.1. Darwin (Mac OS X)< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#freebsd" > 3.2.2. FreeBSD< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#interix" > 3.2.3. Interix< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#irix" > 3.2.4. IRIX< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#linux" > 3.2.5. Linux< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#openbsd" > 3.2.6. OpenBSD< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#solaris" > 3.2.7. Solaris< / a > < / span > < / dt >
< / dl > < / dd >
< / dl >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "bootstrapping-pkgsrc" > < / a > 3.1.<2E> Bootstrapping pkgsrc< / h2 > < / div > < / div > < / div >
< p > For operating systems other than NetBSD, we provide a bootstrap kit to
build the required tools to use pkgsrc on your platform. Besides
support for native NetBSD, pkgsrc and the bootstrap kit have support for
the following operating systems:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > Darwin (Mac OS X)< / p > < / li >
< li > < p > DragonFly BSD< / p > < / li >
< li > < p > FreeBSD< / p > < / li >
< li > < p > Interix (Windows 2000, XP, 2003)< / p > < / li >
< li > < p > IRIX< / p > < / li >
< li > < p > Linux< / p > < / li >
< li > < p > OpenBSD< / p > < / li >
< li > < p > Solaris< / p > < / li >
< li > < p > Tru64 (Digital UNIX/OSF1)< / p > < / li >
< / ul > < / div >
< p > Support for other platforms is under development.< / p >
< p > Installing the bootstrap kit should be as simple as:< / p >
< pre class = "screen" >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > cd pkgsrc/bootstrap< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > ./bootstrap< / code > < / strong > < / pre >
< p > See < a href = "#getting" title = "Chapter<65> 2.<2E> Where to get pkgsrc and how to keep it up-to-date" > Chapter<EFBFBD> 2, < i > Where to get pkgsrc and how to keep it up-to-date< / i > < / a > for other ways to get
pkgsrc before bootstrapping. The given
< span > < strong class = "command" > bootstrap< / strong > < / span > command will use the defaults of
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkg< / code > for the
2006-05-28 22:41:22 +02:00
< span class = "emphasis" > < em > prefix< / em > < / span > where programs will be installed in,
2006-05-29 10:55:59 +02:00
and < code class = "filename" > /var/db/pkg< / code > for the package database
2006-05-28 22:41:22 +02:00
directory where pkgsrc will do its internal bookkeeping.
However, these can also be set using command-line
arguments.< / p >
< p > Binary packages for the pkgsrc tools and an initial set of packages is
available for supported platforms. An up-to-date list of these can be
found on < a href = "http://www.pkgsrc.org/" target = "_top" > www.pkgsrc.org< / a > .
Note that this only works for privileged builds that install
2006-05-29 10:55:59 +02:00
into < code class = "filename" > /usr/pkg< / code > .< / p >
2006-05-28 22:41:22 +02:00
< div class = "note" style = "margin-left: 0.5in; margin-right: 0.5in;" >
< h3 class = "title" > Note< / h3 >
< p > The bootstrap installs a < span > < strong class = "command" > bmake< / strong > < / span > tool.
Use this < span > < strong class = "command" > bmake< / strong > < / span > when building via pkgsrc.
For examples in this guide, use < span > < strong class = "command" > bmake< / strong > < / span >
instead of “ < span class = "quote" > make< / span > ” .< / p >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "platform-specific-notes" > < / a > 3.2.<2E> Platform-specific notes< / h2 > < / div > < / div > < / div >
< p > Here are some platform-specific notes you should be aware of.< / p >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "darwin" > < / a > 3.2.1.<2E> Darwin (Mac OS X)< / h3 > < / div > < / div > < / div >
< p > Darwin 5.x and 6.x are supported. There are two methods of using
pkgsrc on Mac OS X, by using a < a href = "#platform.osx-image" title = "3.2.1.1.<2E> Using a disk image" > disk
image< / a > , or a < a href = "#platform.osx-ufs" title = "3.2.1.2.<2E> Using a UFS partition" > UFS
partition< / a > .< / p >
< p > Before you start, you will need to download and install the Mac OS X Developer
Tools from Apple's Developer Connection. See < a href = "http://developer.apple.com/macosx/" target = "_top" > http://developer.apple.com/macosx/< / a >
for details. Also, make sure you install X11 for Mac OS X and the X11 SDK
from < a href = "http://www.apple.com/macosx/x11/download/" target = "_top" > http://www.apple.com/macosx/x11/download/< / a >
if you intend to build packages that use the X11 Window System.< / p >
< p > If you already have a UFS partition, or have a spare partition
that you can format as UFS, it is recommended to use that instead of
the disk image. It'll be somewhat faster and will mount automatically
at boot time, where you must manually mount a disk image.< / p >
< div class = "note" style = "margin-left: 0.5in; margin-right: 0.5in;" >
< h3 class = "title" > Note< / h3 >
< p > You cannot use a HFS+ file system for pkgsrc, because pkgsrc currently
requires the file system to be case-sensitive, and HFS+ is not.< / p >
< / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
< a name = "platform.osx-image" > < / a > 3.2.1.1.<2E> Using a disk image< / h4 > < / div > < / div > < / div >
< p > Create the disk image:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > cd pkgsrc/bootstrap< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > ./ufsdiskimage create ~/Documents/NetBSD 512< / code > < / strong > # megabytes - season to taste
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > ./ufsdiskimage mount ~/Documents/NetBSD< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > sudo chown `id -u`:`id -g` /Volumes/NetBSD< / code > < / strong > < / pre >
< p > That's it!< / p >
< / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
< a name = "platform.osx-ufs" > < / a > 3.2.1.2.<2E> Using a UFS partition< / h4 > < / div > < / div > < / div >
2006-05-29 10:55:59 +02:00
< p > By default, < code class = "filename" > /usr< / code > will be on your root file
2006-05-28 22:41:22 +02:00
system, normally HFS+. It is possible to use the default
2006-05-29 10:55:59 +02:00
< span class = "emphasis" > < em > prefix< / em > < / span > of < code class = "filename" > /usr/pkg< / code >
by symlinking < code class = "filename" > /usr/pkg< / code > to a directory on a UFS
2006-05-28 22:41:22 +02:00
file system. Obviously, another symlink is required if you want to
place the package database directory outside the
< span class = "emphasis" > < em > prefix< / em > < / span > . e.g.< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > ./bootstrap --pkgdbdir /usr/pkg/pkgdb< / code > < / strong > < / pre >
< p > If you created your partitions at the time of installing Mac OS X
and formatted the target partition as UFS, it should automatically
2006-05-29 10:55:59 +02:00
mount on < code class = "filename" > /Volumes/< volume name> < / code > when the
2006-05-28 22:41:22 +02:00
machine boots. If you are (re)formatting a partition as UFS, you need
to ensure that the partition map correctly reflects
“ < span class = "quote" > Apple_UFS< / span > ” and not “ < span class = "quote" > Apple_HFS< / span > ” .< / p >
< p > The problem is that none of the disk tools will let you touch a
disk that is booted from. You can unmount the partition, but even if
you newfs it, the partition type will be incorrect and the
automounter won't mount it. It can be mounted manually, but it won't
appear in Finder.< / p >
< p > You'll need to boot off of the OS X Installation (User) CD. When
the Installation program starts, go up to the menu and select Disk
Utility. Now, you will be able to select the partition you want
to be UFS, and Format it Apple UFS. Quit the Disk Utility, quit the
installer which will reboot your machine. The new UFS file system
will appear in Finder.< / p >
< p > Be aware that the permissions on the new file system will be writable
by root only.< / p >
< p > This note is as of 10.2 (Jaguar) and applies to earlier versions.
Hopefully Apple will fix Disk Utility in 10.3 (Panther).< / p >
< / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "freebsd" > < / a > 3.2.2.<2E> FreeBSD< / h3 > < / div > < / div > < / div >
< p >
FreeBSD 4.7 and 5.0 have been tested and are supported, other versions
may work.< / p >
< p > Care should be taken so that the tools that this kit installs do not conflict
with the FreeBSD userland tools. There are several steps:< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > FreeBSD stores its ports pkg database in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /var/db/pkg< / code > . It is therefore
2006-05-28 22:41:22 +02:00
recommended that you choose a different location (e.g.
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkgdb< / code > ) by
2006-05-28 22:41:22 +02:00
using the --pkgdbdir option to the bootstrap script.< / p > < / li >
< li >
< p > If you do not intend to use the FreeBSD ports tools, it's probably a
good idea to move them out of the way to avoid confusion, e.g.< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > cd /usr/sbin< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > mv pkg_add pkg_add.orig< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > mv pkg_create pkg_create.orig< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > mv pkg_delete pkg_delete.orig< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > mv pkg_info pkg_info.orig< / code > < / strong > < / pre >
< / li >
2006-05-29 10:55:59 +02:00
< li > < p > An example < code class = "filename" > /etc/mk.conf< / code > file will be placed in
< code class = "filename" > /etc/mk.conf.example< / code > file
2006-05-28 22:41:22 +02:00
when you use the bootstrap script.< / p > < / li >
< / ol > < / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "interix" > < / a > 3.2.3.<2E> Interix< / h3 > < / div > < / div > < / div >
< p > Interix is a POSIX-compatible subsystem for the Windows NT kernel,
providing a Unix-like environment with a tighter kernel integration than
available with Cygwin. It is part of the Windows Services for Unix
package, available for free for any licensed copy of Windows 2000, XP
(not including XP Home), or 2003. SFU can be downloaded from < a href = "http://www.microsoft.com/windows/sfu/" target = "_top" > http://www.microsoft.com/windows/sfu/< / a > .< / p >
< p > Services for Unix 3.5, current as of this writing, has been tested. 3.0
or 3.1 may work, but are not officially supported. (The main difference
in 3.0/3.1 is lack of pthreads.)< / p >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
< a name = "platform.interix-sfu-install" > < / a > 3.2.3.1.<2E> When installing Interix/SFU< / h4 > < / div > < / div > < / div >
< p > At an absolute minimum, the following packages must be installed from
the Windows Services for Unix 3.5 distribution in order to use pkgsrc:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > Utilities -> Base Utilities< / p > < / li >
< li > < p > Interix GNU Components -> (all)< / p > < / li >
< li > < p > Remote Connectivity< / p > < / li >
< li > < p > Interix SDK< / p > < / li >
< / ul > < / div >
< p > When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
"UNIX Perl". That is Perl 5.6 without shared module support, installed to
/usr/local, and will only cause confusion. Instead, install Perl 5.8 from
pkgsrc (or from a binary package).< / p >
< p > The Remote Connectivity subcomponent "Windows Remote Shell Service" does
not need to be installed, but Remote Connectivity itself should be
installed in order to have a working inetd.< / p >
< p > During installation you may be asked whether to enable setuid
behavior for Interix programs, and whether to make pathnames default to
case-sensitive. Setuid should be enabled, and case-sensitivity MUST be
enabled. (Without case-sensitivity, a large number of packages including
perl will not build.)< / p >
< p > NOTE: Newer Windows service packs change the way binary execution
works (via the Data Execution Prevention feature). In order to use
pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
must be installed. Hotfixes are available from Microsoft through a
support contract; however, a NetBSD developer has made most Interix
hotfixes available for personal use from < a href = "http://www.duh.org/interix/hotfixes.php" target = "_top" > http://www.duh.org/interix/hotfixes.php< / a > .< / p >
< / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
< a name = "platform.interix-sfu-postinstall" > < / a > 3.2.3.2.<2E> What to do if Interix/SFU is already installed< / h4 > < / div > < / div > < / div >
< p > If SFU is already installed and you wish to alter these settings to work
with pkgsrc, note the following things.< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
Windows Services for UNIX, then click Change. In the installer, choose
Add or Remove, then uncheck Utilities-> UNIX Perl.< / p > < / li >
< li >
< p > To enable case-sensitivity for the file system, run REGEDIT.EXE, and
change the following registry key:< / p >
< p > HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel< / p >
< p > Set the DWORD value "obcaseinsensitive" to 0; then reboot.< / p >
< / li >
< li >
< p > To enable setuid binaries (optional), run REGEDIT.EXE, and change the
following registry key:< / p >
< p > HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX< / p >
< p > Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.< / p >
< / li >
< / ul > < / div >
< / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
< a name = "platform.interix-notes" > < / a > 3.2.3.3.<2E> Important notes for using pkgsrc< / h4 > < / div > < / div > < / div >
< p > The package manager (either the pkgsrc "su" user, or the user
running "pkg_add") must be a member of the local Administrators
group. Such a user must also be used to run the bootstrap. This is
slightly relaxed from the normal pkgsrc requirement of "root".< / p >
< p > The package manager should use a umask of 002. "make install" will
automatically complain if this is not the case. This ensures that
directories written in /var/db/pkg are Administrators-group writeable.< / p >
< p > The popular Interix binary packages from http://www.interopsystems.com/
use an older version of pkgsrc's pkg_* tools. Ideally, these should
NOT be used in conjunction with pkgsrc. If you choose to use them at
the same time as the pkgsrc packages, ensure that you use the proper
pkg_* tools for each type of binary package.< / p >
< p > The TERM setting used for DOS-type console windows (including those
invoked by the csh and ksh startup shortcuts) is "interix". Most systems
don't have a termcap/terminfo entry for it, but the following .termcap
entry provides adequate emulation in most cases:< / p >
< pre class = "programlisting" >
interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
< a name = "platform.interix-limits" > < / a > 3.2.3.4.<2E> Limitations of the Interix platform< / h4 > < / div > < / div > < / div >
< p > Though Interix suffices as a familiar and flexible substitute
for a full Unix-like platform, it has some drawbacks that should
be noted for those desiring to make the most of Interix.< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li >
< p > < span class = "strong" > < strong > X11:< / strong > < / span > < / p >
< p > Interix comes with the standard set of X11R6 client libraries,
and can run X11 based applications, but it does
< span class = "emphasis" > < em > not< / em > < / span > come with an X server. Some options are
< a href = "http://www.starnet.com/products/xwin32/" target = "_top" > StarNet X-Win32< / a > ,
< a href = "http://connectivity.hummingbird.com/products/nc/exceed/" target = "_top" > Hummingbird Exceed< / a >
(available in a trimmed version for Interix from Interop Systems as the
< a href = "http://www.interopsystems.com/InteropXserver.htm" target = "_top" > Interop X Server< / a > ),
and the free X11 server included with
< a href = "http://x.cygwin.com/" target = "_top" > Cygwin< / a > .< / p >
< p > Also, StarNet Communications has graciously provided a free
version of their X-Win32 product that accepts connections only
from localhost:
< a href = "http://www.starnet.com/xwin32LX/get_xwin32LX.htm" target = "_top" > X-Win32 LX< / a > ,
recommended by the maintainer of Interix pkgsrc support.< / p >
< / li >
< li >
< p > < span class = "strong" > < strong > X11 acceleration:< / strong > < / span > < / p >
< p > Because Interix runs in a completely different NT subsystem from
Win32 applications, it does not currently support various X11
protocol extensions for acceleration (such as MIT-SHM or DGA).
Most interactive applications to a local X server will run
reasonably fast, but full motion video and other graphics
intensive applications may require a faster-than-expected CPU.< / p >
< / li >
< li >
< p > < span class = "strong" > < strong > Audio:< / strong > < / span > < / p >
< p > Interix has no native support for audio output. For audio
support, pkgsrc uses the < span > < strong class = "command" > esound< / strong > < / span > client/server
audio system on Interix. Unlike on most platforms, the
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/audio/esound/README.html" target = "_top" > < code class = "filename" > audio/esound< / code > < / a > package does
2006-05-28 22:41:22 +02:00
< span class = "emphasis" > < em > not< / em > < / span > contain the < span > < strong class = "command" > esd< / strong > < / span >
server component. To output audio via an Interix host, the
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/emulators/cygwin_esound/README.html" target = "_top" > < code class = "filename" > emulators/cygwin_esound< / code > < / a > package
2006-05-28 22:41:22 +02:00
must also be installed.< / p >
< / li >
< li >
< p > < span class = "strong" > < strong > CD/DVDs, USB, and SCSI:< / strong > < / span > < / p >
< p > Direct device access is not currently supported in Interix, so it
is not currently possible to access CD/DVD drives, USB devices,
or SCSI devices through non-filesystem means. Among other things,
this makes it impossible to use Interix directly for CD/DVD
burning.< / p >
< / li >
< li >
< p > < span class = "strong" > < strong > Tape drives:< / strong > < / span > < / p >
< p > Due to the same limitations as for CD-ROMs and SCSI devices, tape
drives are also not directly accessible in Interix. However,
support is in work to make tape drive access possible by using
Cygwin as a bridge (similarly to audio bridged via Cygwin's
esound server).< / p >
< / li >
< / ul > < / div >
< / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
< a name = "platform.interix-knownissues" > < / a > 3.2.3.5.<2E> Known issues for pkgsrc on Interix< / h4 > < / div > < / div > < / div >
< p > It is not necessary, in general, to have a "root" user on the
Windows system; any member of the local Administrators group will
suffice. However, some packages currently assume that the user
named "root" is the privileged user. To accommodate these, you
may create such a user; make sure it is in the local group
Administrators (or your language equivalent).< / p >
< p > "pkg_add" creates directories of mode 0755, not 0775, in
$PKG_DBDIR. For the time being, install packages as the local
Administrator (or your language equivalent), or run the following
command after installing a package to work around the issue:< / p >
< pre class = "screen" >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > chmod -R g+w $PKG_DBDIR< / code > < / strong > < / pre >
< / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "irix" > < / a > 3.2.4.<2E> IRIX< / h3 > < / div > < / div > < / div >
< p > You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
compiler (cc/c89). Please set the < code class = "varname" > CC< / code > environment variable
according to your preference. If you do not have a license for the MIPSpro
compiler suite, you can download a gcc tardist file from < a href = "http://freeware.sgi.com/" target = "_top" > http://freeware.sgi.com/< / a > .< / p >
< p > Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
version of IRIX providing support for < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > if_indextoname< / span > (3)< / span > < / a > , < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > if_nametoindex< / span > (3)< / span > < / a > ,
etc.< / p >
< p > At this point in time, pkgsrc only supports one ABI at a time. That is, you can not
switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI. If
you start out using "abi=n32", that's what all your packages will be built
with.< / p >
< p > Therefore, please make sure that you have no conflicting
< code class = "varname" > CFLAGS< / code > in your environment or the
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > . Particularly, make sure that you do not
2006-05-28 22:41:22 +02:00
try to link n32 object files with lib64 or vice versa. Check your
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/compiler.defaults< / code > !< / p >
2006-05-28 22:41:22 +02:00
< p > If you have the actual pkgsrc tree mounted via NFS from a different host,
please make sure to set < code class = "varname" > WRKOBJDIR< / code > to a local directory,
as it appears that IRIX linker occasionally runs into issues when trying to
link over a network-mounted file system.< / p >
< p > The bootstrapping process should set all the right options for programs such
as imake(1), but you may want to set some options depending on your local
2006-05-29 10:55:59 +02:00
setup. Please see < code class = "filename" > pkgsrc/mk/defaults/mk.conf< / code > and, of
2006-05-28 22:41:22 +02:00
course, your compiler's man pages for details.< / p >
< p > If you are using SGI's MIPSPro compiler, please set
< / p >
< pre class = "programlisting" >
PKGSRC_COMPILER= mipspro
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p >
2006-05-29 10:55:59 +02:00
in < code class = "filename" > /etc/mk.conf< / code > . Otherwise, pkgsrc will assume you
2006-05-28 22:41:22 +02:00
are using gcc and may end up passing invalid flags to the compiler. Note that
2006-05-29 10:55:59 +02:00
bootstrap should create an appropriate < code class = "filename" > mk.conf.example< / code > by
2006-05-28 22:41:22 +02:00
default.< / p >
< p > If you have both the MIPSPro compiler chain installed as well as gcc,
but want to make sure that MIPRPro is used, please set your < code class = "varname" > PATH< / code >
to < span class = "emphasis" > < em > not< / em > < / span > include the location of gcc (often
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/freeware/bin< / code > ), and (important) pass the
2006-05-28 22:41:22 +02:00
'--preserve-path' flag.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "linux" > < / a > 3.2.5.<2E> Linux< / h3 > < / div > < / div > < / div >
< p >
Some versions of Linux (for example Debian GNU/Linux) need either
libtermcap or libcurses (libncurses). Installing the distributions
libncurses-dev package (or equivalent) should fix the problem.< / p >
< p >
pkgsrc supports both gcc (GNU Compiler Collection) and icc (Intel C++
Compiler). gcc is the default. icc 8.0 and 8.1 on i386 have been tested.
< / p >
< p > To bootstrap using icc, assuming the default icc installation
directory:< / p >
< pre class = "programlisting" >
env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
ac_cv___attribute__=yes ./bootstrap
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< div class = "note" style = "margin-left: 0.5in; margin-right: 0.5in;" >
< h3 class = "title" > Note< / h3 >
< p > icc 8.1 needs the `-i-static' argument instead of -static-libcxa.< / p >
< / div >
< p > icc supports __attribute__, but the GNU configure test uses a nested
function, which icc does not support. #undef'ing __attribute__ has the
unfortunate side-effect of breaking many of the Linux header files, which
cannot be compiled properly without __attribute__. The test must be
overridden so that __attribute__ is assumed supported by the
compiler.< / p >
< p > After bootstrapping, you should set < code class = "varname" > PKGSRC_COMPILER< / code >
2006-05-29 10:55:59 +02:00
in < code class = "filename" > /etc/mk.conf< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
PKGSRC_COMPILER= icc
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > The default installation directory for icc is
2006-05-29 10:55:59 +02:00
< code class = "filename" > /opt/intel_cc_80< / code > , which
2006-05-28 22:41:22 +02:00
is also the pkgsrc default. If you have installed it into a different
directory, set < code class = "varname" > ICCBASE< / code > in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
ICCBASE= /opt/icc
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > pkgsrc uses the static linking method of the runtime libraries
provided by icc, so binaries can be run on other systems which do not
have the shared libraries installed.< / p >
< p > Libtool, however, extracts a list of libraries from the < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > ld< / span > (1)< / span > < / a >
command run when linking a C++ shared library and records it, throwing
away the -Bstatic and -Bdynamic options interspersed between the libraries.
This means that libtool-linked C++ shared libraries will have a
runtime dependency on the icc libraries until this is fixed in libtool.
< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "openbsd" > < / a > 3.2.6.<2E> OpenBSD< / h3 > < / div > < / div > < / div >
< p > OpenBSD 3.0 and 3.2 are tested and supported.< / p >
< p > Care should be taken so that the tools that this kit installs do not conflict
with the OpenBSD userland tools. There are several steps:< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > OpenBSD stores its ports pkg database in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /var/db/pkg< / code > . It is therefore
2006-05-28 22:41:22 +02:00
recommended that you choose a different location (e.g.
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkgdb< / code > ) by
2006-05-28 22:41:22 +02:00
using the --pkgdbdir option to the bootstrap script.< / p > < / li >
< li >
< p > If you do not intend to use the OpenBSD ports tools, it's probably a
good idea to move them out of the way to avoid confusion, e.g.< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > cd /usr/sbin< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > mv pkg_add pkg_add.orig< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > mv pkg_create pkg_create.orig< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > mv pkg_delete pkg_delete.orig< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > mv pkg_info pkg_info.orig< / code > < / strong > < / pre >
< / li >
< li >
2006-05-29 10:55:59 +02:00
< p > An example < code class = "filename" > /etc/mk.conf< / code > file will be placed in
< code class = "filename" > /etc/mk.conf.example< / code > file
2006-05-28 22:41:22 +02:00
when you use the bootstrap script. OpenBSD's make program uses
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code >
2006-05-28 22:41:22 +02:00
as well. You can work around this by enclosing all the pkgsrc-specific parts
of the file with:< / p >
< pre class = "programlisting" >
.ifdef BSD_PKG_MK
# pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
.else
# OpenBSD stuff
.endif
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< / li >
< / ol > < / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "solaris" > < / a > 3.2.7.<2E> Solaris< / h3 > < / div > < / div > < / div >
< p > Solaris 2.6 through 9 are supported on both x86 and sparc.
You will need a working C compiler. Both gcc 2.95.3 and
Sun WorkShop 5 have been tested.< / p >
< p > The following packages are required on Solaris 8 for the bootstrap
process and to build packages.< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > SUNWsprot< / p > < / li >
< li > < p > SUNWarc< / p > < / li >
< li > < p > SUNWbtool< / p > < / li >
< li > < p > SUNWtoo< / p > < / li >
< li > < p > SUNWlibm< / p > < / li >
< / ul > < / div >
< p > Please note the use of GNU binutils on Solaris is
< span class = "emphasis" > < em > not< / em > < / span > supported.< / p >
< p > Whichever compiler you use, please ensure the compiler tools and
your $prefix are in your < code class = "varname" > PATH< / code > . This includes
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/ccs/{bin,lib}< / code >
and e.g. < code class = "filename" > /usr/pkg/{bin,sbin}< / code > .< / p >
2006-05-28 22:41:22 +02:00
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
< a name = "solaris-gcc-note" > < / a > 3.2.7.1.<2E> If you are using gcc< / h4 > < / div > < / div > < / div >
< p > It makes life much simpler if you only use the same gcc consistently
for building all packages.< / p >
< p > It is recommended that an external gcc be used only for bootstrapping,
then either build gcc from
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/lang/gcc/README.html" target = "_top" > < code class = "filename" > lang/gcc< / code > < / a > or install a binary gcc
2006-05-28 22:41:22 +02:00
package, then remove gcc used during bootstrapping.< / p >
< p > Binary packages of gcc can be found through < a href = "http://www.sun.com/bigadmin/common/freewareSearch.html" target = "_top" > http://www.sun.com/bigadmin/common/freewareSearch.html< / a > .< / p >
< / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
< a name = "solaris-sun-workshop-note" > < / a > 3.2.7.2.<2E> If you are using Sun WorkShop< / h4 > < / div > < / div > < / div >
< p > You will need at least the following packages installed (from WorkShop
5.0)< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > SPROcc
- Sun WorkShop Compiler C 5.0< / p > < / li >
< li > < p > SPROcpl
- Sun WorkShop Compiler C++ 5.0< / p > < / li >
< li > < p > SPROild
- Sun WorkShop Incremental Linker< / p > < / li >
< li > < p > SPROlang
- Sun WorkShop Compilers common components< / p > < / li >
< / ul > < / div >
< p > You should set < code class = "varname" > CC< / code > , < code class = "varname" > CXX< / code > and
2006-05-29 10:55:59 +02:00
optionally, < code class = "varname" > CPP< / code > in < code class = "filename" > /etc/mk.conf< / code > ,
2006-05-28 22:41:22 +02:00
e.g.:< / p >
< pre class = "programlisting" >
CC= cc
CXX= CC
CPP= /usr/ccs/lib/cpp
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
< a name = "solaris-sunpro-64" > < / a > 3.2.7.3.<2E> Buildling 64-bit binaries with SunPro< / h4 > < / div > < / div > < / div >
< p > Building 64-bit binaries is a little trickier. First, you
need to bootstrap pkgsrc in 64-bit mode. One problem here is
that while building one of the programs in the bootstrap kit
2006-05-29 10:55:59 +02:00
(< code class = "filename" > bmake< / code > ), the < code class = "varname" > CFLAGS< / code >
2006-05-28 22:41:22 +02:00
variable is not honored, even if it is set in the environment.
To work around this bug, you can create a simple shell script
2006-05-29 10:55:59 +02:00
called < code class = "filename" > cc64< / code > and put it somewhere in the
2006-05-28 22:41:22 +02:00
< code class = "varname" > PATH< / code > :< / p >
< pre class = "programlisting" >
#! /bin/sh
exec /opt/SUNWspro/bin/cc -xtarget=ultra -xarch=v9 ${1+"$@"}
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > Then, pass the definition for < code class = "varname" > CC< / code > in the
environment of the < span > < strong class = "command" > bootstrap< / strong > < / span > command:< / p >
< pre class = "programlisting" >
< code class = "prompt" > $< / code > < strong class = "userinput" > < code > cd bootstrap< / code > < / strong >
< code class = "prompt" > $< / code > < strong class = "userinput" > < code > CC=cc64 ./bootstrap< / code > < / strong >
< / pre >
< p > After bootstrapping, there are two alternative ways,
depending on whether you want to find bugs in packages or get
your system ready quickly. If you just want a running system,
2006-05-29 10:55:59 +02:00
add the following lines to your < code class = "filename" > mk.conf< / code >
2006-05-28 22:41:22 +02:00
file:< / p >
< pre class = "programlisting" >
CC= cc64
CXX= CC64
PKGSRC_COMPILER= sunpro
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > This way, all calls to the compiler will be intercepted by
the above wrapper and therefore get the necessary ABI options
automatically. (Don't forget to create the shell script
2006-05-29 10:55:59 +02:00
< code class = "filename" > CC64< / code > , too.)< / p >
2006-05-28 22:41:22 +02:00
< p > To find packages that ignore the user-specified
< code class = "varname" > CFLAGS< / code > and < code class = "varname" > CXXFLAGS< / code > , add
2006-05-29 10:55:59 +02:00
the following lines to your < code class = "filename" > mk.conf< / code >
2006-05-28 22:41:22 +02:00
file:< / p >
< pre class = "programlisting" >
CC= cc
CXX= CC
PKGSRC_COMPILER= sunpro
CFLAGS= -xtarget=ultra -xarch=v9
CXXFLAGS= -xtarget=ultra -xarch=v9
LDFLAGS= -xtarget=ultra -xarch=v9
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > Packages that don't use the flags provided in the
configuration file will try to build 32-bit binaries and fail
during linking. Detecting this is useful to prevent bugs on
other platforms where the error would not show up but pass
silently.< / p >
< / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
< a name = "plat.sunos.problems" > < / a > 3.2.7.4.<2E> Common problems< / h4 > < / div > < / div > < / div >
< p > Sometimes, when using < span > < strong class = "command" > libtool< / strong > < / span > ,
2006-05-29 10:55:59 +02:00
< code class = "filename" > /bin/ksh< / code > crashes with a segmentation fault.
2006-05-28 22:41:22 +02:00
The workaround is to use another shell for the configure
2006-05-29 10:55:59 +02:00
scripts, for example by installing < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/shells/bash/README.html" target = "_top" > < code class = "filename" > shells/bash< / code > < / a > and adding the following lines
to your < code class = "filename" > mk.conf< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
CONFIG_SHELL= ${LOCALBASE}/bin/bash
WRAPPER_SHELL= ${LOCALBASE}/bin/bash
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-29 10:55:59 +02:00
< p > Then, rebuild the < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/devel/libtool-base/README.html" target = "_top" > < code class = "filename" > devel/libtool-base< / code > < / a > package.< / p >
2006-05-28 22:41:22 +02:00
< / div >
< / div >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
< a name = "using" > < / a > Chapter<EFBFBD> 4.<2E> Using pkgsrc< / h2 > < / div > < / div > < / div >
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
< dt > < span class = "sect1" > < a href = "#using-pkg" > 4.1. Using binary packages< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#finding-binary-packages" > 4.1.1. Finding binary packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#installing-binary-packages" > 4.1.2. Installing binary packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#a-word-of-warning" > 4.1.3. A word of warning< / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#building-packages-from-source" > 4.2. Building packages from source< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#requirements" > 4.2.1. Requirements< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#fetching-distfiles" > 4.2.2. Fetching distfiles< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#how-to-build-and-install" > 4.2.3. How to build and install< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#selecting-the-compiler" > 4.2.4. Selecting the compiler< / a > < / span > < / dt >
< / dl > < / dd >
< / dl >
< / div >
< p > Basically, there are two ways of using pkgsrc. The first
is to only install the package tools and to use binary packages
that someone else has prepared. This is the “ < span class = "quote" > pkg< / span > ”
in pkgsrc. The second way is to install the “ < span class = "quote" > src< / span > ”
of pkgsrc, too. Then you are able to build your own packages,
and you can still use binary packages from someone else.< / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "using-pkg" > < / a > 4.1.<2E> Using binary packages< / h2 > < / div > < / div > < / div >
< p > To use binary packages, you need some tools to manage
them. On NetBSD, these tools are already installed. On all other
operating systems, you need to install them first. For the
following platforms, prebuilt versions of the package tools
are available and can simply be downloaded and unpacked in the
2006-05-29 10:55:59 +02:00
< code class = "filename" > /< / code > directory:< / p >
2006-05-28 22:41:22 +02:00
< div class = "informaltable" >
< a name = "binary-bootstrap-kits" > < / a > < table border = "1" >
< colgroup >
< col >
< col >
< / colgroup >
< thead > < tr >
< th > Platform< / th >
< th > URL< / th >
< / tr > < / thead >
< tbody >
< tr >
< td > Solaris 9< / td >
2006-05-29 10:55:59 +02:00
< td > < code class = "filename" > ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/bootstrap-pkgsrc/< / code > < / td >
2006-05-28 22:41:22 +02:00
< / tr >
< tr >
< td > Solaris 10< / td >
2006-05-29 10:55:59 +02:00
< td > < code class = "filename" > http://public.enst.fr/pkgsrc/packages/bootstrap-pkgsrc/< / code > < / td >
2006-05-28 22:41:22 +02:00
< / tr >
< / tbody >
< / table >
< / div >
< p > These prebuilt package tools use
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkg< / code > for the base directory, and
< code class = "filename" > /var/db/pkg< / code > for the database of installed
2006-05-28 22:41:22 +02:00
packages. If you cannot use these directories for whatever
reasons (maybe because you're not root), you have to build the
package tools yourself, which is explained in < a href = "#bootstrapping-pkgsrc" title = "3.1.<2E> Bootstrapping pkgsrc" > Section<EFBFBD> 3.1, “ Bootstrapping pkgsrc” < / a > .< / p >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "finding-binary-packages" > < / a > 4.1.1.<2E> Finding binary packages< / h3 > < / div > < / div > < / div >
< p > To install binary packages, you first need to know from
where to get them. You can get them on CD-ROMs, DVDs, or via FTP
or HTTP.< / p >
< p > For NetBSD, the binary packages are made available on
2006-05-29 10:55:59 +02:00
< code class = "filename" > ftp.NetBSD.org< / code > and its mirrors, in the
2006-05-28 22:41:22 +02:00
directory
2006-05-29 10:55:59 +02:00
< code class = "filename" > /pub/NetBSD/packages/< em class = "replaceable" > < code > OSVERSION< / code > < / em > /< em class = "replaceable" > < code > ARCH< / code > < / em > /< / code > .
2006-05-28 22:41:22 +02:00
For < em class = "replaceable" > < code > OSVERSION< / code > < / em > , you should insert the
output of < span > < strong class = "command" > uname -r< / strong > < / span > , and for
< em class = "replaceable" > < code > ARCH< / code > < / em > the output of < span > < strong class = "command" > uname
-p< / strong > < / span > .< / p >
< p > For some other platforms, binary packages can be found at
the following locations:< / p >
< div class = "informaltable" >
< a name = "binary-packages" > < / a > < table border = "1" >
< colgroup >
< col >
< col >
< / colgroup >
< thead > < tr >
< th > Platform< / th >
< th > URL< / th >
< / tr > < / thead >
< tbody >
< tr >
< td > Solaris 9< / td >
2006-05-29 10:55:59 +02:00
< td > < code class = "filename" > ftp://ftp0.mh.bbc.co.uk/pub/pkgsrc/packages/< / code > < / td >
2006-05-28 22:41:22 +02:00
< / tr >
< tr >
< td > Solaris 10< / td >
2006-05-29 10:55:59 +02:00
< td > < code class = "filename" > http://public.enst.fr/pkgsrc/packages/< / code > < / td >
2006-05-28 22:41:22 +02:00
< / tr >
< / tbody >
< / table >
< / div >
< p > Most of these directories contain the pkgsrc distribution
for multiple platforms. Select the appropriate subdirectories,
according to your machine architecture and operating system,
2006-05-29 10:55:59 +02:00
until you find a directory called < code class = "filename" > All< / code > . This
2006-05-28 22:41:22 +02:00
directory contains all the binary packages. Further, there are
subdirectories for categories that contain symbolic links that
point to the actual binary package in
2006-05-29 10:55:59 +02:00
< code class = "filename" > ../All< / code > . This directory layout is used for
2006-05-28 22:41:22 +02:00
all package repositories, no matter if they are accessed via
HTTP, FTP, NFS, CD-ROM, or the local filesystem.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "installing-binary-packages" > < / a > 4.1.2.<2E> Installing binary packages< / h3 > < / div > < / div > < / div >
< p > If you have the files on a CD-ROM or downloaded them to
your hard disk, you can install them with the following command
(be sure to < span > < strong class = "command" > su< / strong > < / span > to root first):< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > pkg_add /path/to/package.tgz< / code > < / strong > < / pre >
< p > If you have FTP access and you don't want to download the
packages via FTP prior to installation, you can do this
automatically by giving < span > < strong class = "command" > pkg_add< / strong > < / span > an FTP URL:
< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > pkg_add ftp://ftp.NetBSD.org/pub/NetBSD/packages/< OSVERSION> /< ARCH> /All/package.tgz< / code > < / strong > < / pre >
< p > Note that any prerequisite packages needed to run the
package in question will be installed, too, assuming they are
present where you install from. < / p >
< p > To save some typing, you can set the
< code class = "varname" > PKG_PATH< / code > environment variable to a semicolon-separated
list of paths (including remote URLs); trailing slashes are not allowed.
< / p >
2006-05-29 10:55:59 +02:00
< p > Additionally to the < code class = "filename" > All< / code > directory
there exists a < code class = "filename" > vulnerable< / code > directory to
2006-05-28 22:41:22 +02:00
which binary packages with known vulnerabilities are
moved, since removing them could cause missing dependencies. To
2006-05-29 10:55:59 +02:00
use these packages, add the < code class = "filename" > vulnerable< / code >
2006-05-28 22:41:22 +02:00
directory to your < code class = "varname" > PKG_PATH< / code > . However, you should run
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/security/audit-packages/README.html" target = "_top" > < code class = "filename" > security/audit-packages< / code > < / a > regularly,
2006-05-28 22:41:22 +02:00
especially after installing new packages, and verify that the
vulnerabilities are acceptable for your configuration. An example
< code class = "varname" > PKG_PATH< / code > would be:
2006-05-29 10:55:59 +02:00
< code class = "filename" > ftp://ftp.NetBSD.org/pub/NetBSD/packages/< OSVERSION> /< ARCH> /All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/< OSVERSION> /< ARCH> /vulnerable< / code >
2006-05-28 22:41:22 +02:00
Please note that semicolon (';') is a shell meta-character, so
you'll probably have to quote it.< / p >
< p > After you've installed packages, be sure to have
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkg/bin< / code > and < code class = "filename" > /usr/pkg/sbin< / code > in your
2006-05-28 22:41:22 +02:00
< code class = "varname" > PATH< / code > so you can actually start the just
installed program. < / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "a-word-of-warning" > < / a > 4.1.3.<2E> A word of warning< / h3 > < / div > < / div > < / div >
< p > Please pay very careful attention to the warnings
expressed in the < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_add< / span > (1)< / span > < / a > manual page about the
inherent dangers of installing binary packages which you did
not create yourself, and the security holes that can be
introduced onto your system by indiscriminate adding of such
files.< / p >
< p > The same warning of course applies to every package you
install from source when you haven't completely read and
understood the source code of the package, the compiler that
is used to build the package and all the other tools that are
involved.< / p >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "building-packages-from-source" > < / a > 4.2.<2E> Building packages from source< / h2 > < / div > < / div > < / div >
< p > This assumes that the package is already in pkgsrc. If it
is not, see < a href = "#developers-guide" title = "Part<72> II.<2E> The pkgsrc developer's guide" > Part<EFBFBD> II, “ The pkgsrc developer's guide” < / a > for instructions
how to create your own packages.< / p >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "requirements" > < / a > 4.2.1.<2E> Requirements< / h3 > < / div > < / div > < / div >
< p > To build packages from source on a NetBSD system the
“ < span class = "quote" > comp< / span > ” and the “ < span class = "quote" > text< / span > ” distribution
sets must be installed. If you want to build X11-related
packages the “ < span class = "quote" > xbase< / span > ” and “ < span class = "quote" > xcomp< / span > ”
distribution sets are required, too.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "fetching-distfiles" > < / a > 4.2.2.<2E> Fetching distfiles< / h3 > < / div > < / div > < / div >
< p > The first step for building a package is downloading the
distfiles (i.e. the unmodified source). If they have not yet been
downloaded, pkgsrc will fetch them automatically.< / p >
< p > You can overwrite some of the major distribution sites to fit to sites
that are close to your own. Have a look at
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/mk/defaults/mk.conf< / code > to find some examples
2006-05-28 22:41:22 +02:00
— in particular, look for the < code class = "varname" > MASTER_SORT< / code > ,
< code class = "varname" > MASTER_SORT_REGEX< / code > and
< code class = "varname" > INET_COUNTRY< / code > definitions. This may save some of your
bandwidth and time.< / p >
< p > You can change these settings either in your shell's environment, or,
if you want to keep the settings, by editing the
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > file,
2006-05-28 22:41:22 +02:00
and adding the definitions there.< / p >
< p > If you don't have a permanent Internet connection and you want to know
which files to download, < span > < strong class = "command" > make fetch-list< / strong > < / span > will tell you
what you'll need. Put these distfiles into
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkgsrc/distfiles< / code > .< / p >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "how-to-build-and-install" > < / a > 4.2.3.<2E> How to build and install< / h3 > < / div > < / div > < / div >
< p > Assuming that the distfile has been fetched (see previous section), become
root and change into the relevant directory and run
< span > < strong class = "command" > make< / strong > < / span > .< / p >
< div class = "note" style = "margin-left: 0.5in; margin-right: 0.5in;" >
< h3 class = "title" > Note< / h3 >
< p > If using bootstrap or pkgsrc on a non-NetBSD system,
use the pkgsrc < span > < strong class = "command" > bmake< / strong > < / span > command instead of
“ < span class = "quote" > make< / span > ” in the examples in this guide.< / p >
< / div >
< p > For example, type < / p >
< pre class = "screen" > < code class = "prompt" > %< / code > < strong class = "userinput" > < code > cd misc/figlet< / code > < / strong >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > make< / code > < / strong > < / pre >
< p > at the shell prompt to build the various components of the
package, and< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > make install< / code > < / strong > < / pre >
< p > to install the various components into the correct places
on your system. Installing the package on your system requires
you to be root. However, pkgsrc has a
< span class = "emphasis" > < em > just-in-time-su< / em > < / span > feature, which allows you
to only become root for the actual installation step< / p >
< p > Taking the figlet utility as an example, we can install it on our
system by building as shown in < a href = "#logs" title = "Appendix<69> B.<2E> Build logs" > Appendix<EFBFBD> B, < i > Build logs< / i > < / a > .< / p >
< p > The program is installed under the default root of the packages tree -
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkg< / code > . Should this not conform to your tastes,
2006-05-28 22:41:22 +02:00
set the < code class = "varname" > LOCALBASE< / code >
variable in your environment, and it will use that value as the root of
2006-05-29 10:55:59 +02:00
your packages tree. So, to use < code class = "filename" > /usr/local< / code > , set
2006-05-28 22:41:22 +02:00
< code class = "varname" > LOCALBASE=/usr/local< / code > in your environment. Please note
that you should use a directory which is
dedicated to packages and not shared with other programs (i.e., do not try
and use < code class = "varname" > LOCALBASE=/usr< / code > ). Also, you should not try to
2006-05-29 10:55:59 +02:00
add any of your own files or directories (such as < code class = "filename" > src/< / code > ,
< code class = "filename" > obj/< / code > , or < code class = "filename" > pkgsrc/< / code > ) below the
2006-05-28 22:41:22 +02:00
< code class = "varname" > LOCALBASE< / code > tree. This is to prevent possible conflicts
between programs and other files installed by the package system and
whatever else may have been installed there.< / p >
2006-05-29 10:55:59 +02:00
< p > Some packages look in < code class = "filename" > /etc/mk.conf< / code > to alter some
2006-05-28 22:41:22 +02:00
configuration options at build time. Have a look at
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/mk/defaults/mk.conf< / code > to
2006-05-28 22:41:22 +02:00
get an overview of what will be set there by default. Environment
variables such as < code class = "varname" > LOCALBASE< / code >
2006-05-29 10:55:59 +02:00
can be set in < code class = "filename" > /etc/mk.conf< / code > to
2006-05-28 22:41:22 +02:00
save having to remember to set them each time you want to use pkgsrc.< / p >
< p > Occasionally, people want to “ < span class = "quote" > look under the covers< / span > ” to see
what is going on when a package is building or being installed. This may be
for debugging purposes, or out of simple curiosity. A number of utility
values have been added to help with this.< / p >
< div class = "orderedlist" > < ol type = "1" >
< li >
< p > If you invoke the < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > make< / span > (1)< / span > < / a > command with < code class = "varname" > PKG_DEBUG_LEVEL=2< / code > ,
then a huge amount of information will be displayed. For example,< / p >
< pre class = "screen" > < strong class = "userinput" > < code > make patch PKG_DEBUG_LEVEL=2< / code > < / strong > < / pre >
< p > will show all the commands that are invoked, up to and including the
“ < span class = "quote" > patch< / span > ” stage.< / p >
< / li >
< li >
< p > If you want to know the value of a certain < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > make< / span > (1)< / span > < / a > definition, then
the < code class = "varname" > VARNAME< / code > definition should be used, in conjunction
with the show-var target. e.g. to show the expansion of the < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > make< / span > (1)< / span > < / a > variable
< code class = "varname" > LOCALBASE< / code > :< / p >
< pre class = "screen" > < code class = "prompt" > %< / code > < strong class = "userinput" > < code > make show-var VARNAME=LOCALBASE< / code > < / strong >
/usr/pkg
< code class = "prompt" > %< / code >
< / pre >
< / li >
< / ol > < / div >
< p > If you want to install a binary package that you've either
created yourself (see next section), that you put into pkgsrc/packages manually or
that is located on a remote FTP server, you can use the "bin-install"
target. This target will install a binary package - if available - via
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_add< / span > (1)< / span > < / a > , else do a < span > < strong class = "command" > make package< / strong > < / span > .
The list of remote
FTP sites searched is kept in the variable
< code class = "varname" > BINPKG_SITES< / code > , which defaults to
ftp.NetBSD.org. Any flags that should be added to < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_add< / span > (1)< / span > < / a > can be put
into < code class = "varname" > BIN_INSTALL_FLAGS< / code > .
2006-05-29 10:55:59 +02:00
See < code class = "filename" > pkgsrc/mk/defaults/mk.conf< / code > for more details.< / p >
2006-05-28 22:41:22 +02:00
< p > A final word of warning: If you set up a system that has a non-standard
setting for < code class = "varname" > LOCALBASE< / code > , be sure to set that
before any packages are installed, as you can not use several directories
for the same purpose. Doing so will result in pkgsrc not being able to
properly detect your installed packages, and fail miserably. Note also that
precompiled binary packages are usually built with the default
< code class = "varname" > LOCALBASE< / code > of
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkg< / code > , and that you should < span class = "emphasis" > < em > not< / em > < / span >
2006-05-28 22:41:22 +02:00
install any if you use a non-standard < code class = "varname" > LOCALBASE< / code > .< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "selecting-the-compiler" > < / a > 4.2.4.<2E> Selecting the compiler< / h3 > < / div > < / div > < / div >
< p > By default, pkgsrc will use GCC to build packages. This may be
overridden by setting the following variables in /etc/mk.conf:
< / p >
< div class = "variablelist" > < dl >
< dt > < span class = "term" > < code class = "varname" > PKGSRC_COMPILER< / code > :< / span > < / dt >
< dd >
< p > This is a list of values specifying the chain of
compilers to invoke when building packages. Valid values
are: < / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < code class = "varname" > distcc< / code > :
distributed C/C++ (chainable)< / p > < / li >
< li > < p > < code class = "varname" > ccache< / code > :
compiler cache (chainable)< / p > < / li >
< li > < p > < code class = "varname" > gcc< / code > :
GNU C/C++ Compiler< / p > < / li >
< li > < p > < code class = "varname" > mipspro< / code > :
Silicon Graphics, Inc. MIPSpro (n32/n64)< / p > < / li >
< li > < p > < code class = "varname" > mipspro< / code > :
Silicon Graphics, Inc. MIPSpro (o32)< / p > < / li >
< li > < p > < code class = "varname" > sunpro< / code > :
Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio< / p > < / li >
< / ul > < / div >
< p > The default is
“ < span class = "quote" > < code class = "varname" > gcc< / code > < / span > ” . You can use
< code class = "varname" > ccache< / code > and/or
< code class = "varname" > distcc< / code > with an appropriate
< code class = "varname" > PKGSRC_COMPILER< / code > setting,
e.g. “ < span class = "quote" > < code class = "varname" > ccache gcc< / code > < / span > ” . This
variable should always be
terminated with a value for a real compiler. < / p >
< / dd >
< dt > < span class = "term" > < code class = "varname" > GCC_REQD< / code > :< / span > < / dt >
< dd > < p > This specifies the minimum version of GCC to use
when building packages. If the system GCC doesn't
satisfy this requirement, then pkgsrc will build and
install one of the GCC packages to use instead. < / p > < / dd >
< / dl > < / div >
< / div >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
< a name = "configuring" > < / a > Chapter<EFBFBD> 5.<2E> Configuring pkgsrc< / h2 > < / div > < / div > < / div >
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
< dt > < span class = "sect1" > < a href = "#general-configuration" > 5.1. General configuration< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#variables-affecting-build" > 5.2. Variables affecting the build process< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#developer-advanced-settings" > 5.3. Developer/advanced settings< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#selecting-build-options" > 5.4. Selecting Build Options< / a > < / span > < / dt >
< / dl >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "general-configuration" > < / a > 5.1.<2E> General configuration< / h2 > < / div > < / div > < / div >
< p > In this section, you can find some variables that apply to all
pkgsrc packages. The preferred method of setting these variables
2006-05-29 10:55:59 +02:00
is by setting them in < code class = "filename" > /etc/mk.conf< / code > .
2006-05-28 22:41:22 +02:00
< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < code class = "varname" > LOCALBASE< / code > : Where
packages will be installed. The default is
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkg< / code > . Do not mix binary packages
2006-05-28 22:41:22 +02:00
with different < code class = "varname" > LOCALBASE< / code > s!< / p > < / li >
< li > < p > < code class = "varname" > CROSSBASE< / code > : Where
“ < span class = "quote" > cross< / span > ” category packages will be
installed. The default is
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${LOCALBASE}/cross< / code > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< li > < p > < code class = "varname" > X11BASE< / code > : Where
X11 is installed on the system. The default is
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/X11R6< / code > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< li > < p > < code class = "varname" > DISTDIR< / code > : Where to store the
downloaded copies of the original source distributions used
for building pkgsrc packages. The default is
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${PKGSRCDIR}/distfiles< / code > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< li > < p > < code class = "varname" > MASTER_SITE_OVERRIDE< / code > :
If set, override the packages'
< code class = "varname" > MASTER_SITES< / code > with this value.< / p > < / li >
< li > < p > < code class = "varname" > MASTER_SITE_BACKUP< / code > :
Backup location(s) for distribution files and patch files
if not found locally or in
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${MASTER_SITES}< / code > or
< code class = "filename" > ${PATCH_SITES}< / code > respectively.
2006-05-28 22:41:22 +02:00
The defaults are
2006-05-29 10:55:59 +02:00
< code class = "filename" > ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/< / code >
2006-05-28 22:41:22 +02:00
and
2006-05-29 10:55:59 +02:00
< code class = "filename" > ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/< / code > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< li > < p > < code class = "varname" > BINPKG_SITES< / code > :
List of sites carrying binary pkgs.< / p > < / li >
< / ul > < / div >
< p >
< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "variables-affecting-build" > < / a > 5.2.<2E> Variables affecting the build process< / h2 > < / div > < / div > < / div >
< p > XXX
< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < code class = "varname" > PACKAGES< / code > : The top level
directory for the binary packages. The default is
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${PKGSRCDIR}/packages< / code > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< li > < p > < code class = "varname" > WRKOBJDIR< / code > :
The top level directory where, if defined, the separate
working directories will get created, and symbolically
2006-05-29 10:55:59 +02:00
linked to from < code class = "filename" > ${WRKDIR}< / code > (see below).
2006-05-28 22:41:22 +02:00
This is useful for building packages on several
2006-05-29 10:55:59 +02:00
architectures, then < code class = "filename" > ${PKGSRCDIR}< / code >
can be NFS-mounted while < code class = "filename" > ${WRKOBJDIR}< / code >
2006-05-28 22:41:22 +02:00
is local to every architecture. (It should be noted that
< code class = "varname" > PKGSRCDIR< / code > should not be set by the user
— it is an internal definition which refers to the
root of the pkgsrc tree. It is possible to have many
pkgsrc tree instances.)< / p > < / li >
< li > < p > < code class = "varname" > LOCALPATCHES< / code > :
Directory for local patches that aren't part of pkgsrc.
2006-06-01 11:36:55 +02:00
See < a href = "#components.patches" title = "9.3.<2E> patches/*" > Section<EFBFBD> 9.3, “ patches/*” < / a > for more
2006-05-28 22:41:22 +02:00
information. < em class = "replaceable" > < code > rel< / code > < / em > and
< em class = "replaceable" > < code > arch< / code > < / em > are replaced with OS
release (“ < span class = "quote" > 2.0< / span > ” , etc.) and architecture
(“ < span class = "quote" > mipsel< / span > ” , etc.).< / p > < / li >
< li > < p > < code class = "varname" > PKGMAKECONF< / code > : Location of
2006-05-29 10:55:59 +02:00
the < code class = "filename" > mk.conf< / code > file used by a package's
2006-05-28 22:41:22 +02:00
BSD-style Makefile. If this is not set,
< code class = "varname" > MAKECONF< / code > is set to
2006-05-29 10:55:59 +02:00
< code class = "filename" > /dev/null< / code > to avoid picking up
settings used by builds in < code class = "filename" > /usr/src< / code > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< / ul > < / div >
< p >
< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "developer-advanced-settings" > < / a > 5.3.<2E> Developer/advanced settings< / h2 > < / div > < / div > < / div >
< p > XXX
< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li >
< p > < code class = "varname" > PKG_DEVELOPER< / code > :
Run some sanity checks that package developers want:
< / p >
< div class = "itemizedlist" > < ul type = "circle" >
< li > < p > make sure patches apply with zero fuzz< / p > < / li >
< li > < p > run check-shlibs to see that all binaries will
find their shared libs.< / p > < / li >
< / ul > < / div >
< p >
< / p >
< / li >
< li > < p > < code class = "varname" > PKG_DEBUG_LEVEL< / code > :
The level of debugging output which is displayed whilst
making and installing the package.
The default value for this is 0, which will not display
the commands as they are executed (normal, default, quiet
operation); the value 1 will display all shell commands
before their invocation, and the value 2 will display both
the shell commands before their invocation, and their
actual execution progress with < span > < strong class = "command" > set -x< / strong > < / span >
will be displayed.< / p > < / li >
< li > < p > < code class = "varname" > ALLOW_VULNERABILITIES.< em class = "replaceable" > < code > pkgbase< / code > < / em > < / code > :
A space separated list of vulnerability IDs that may be ignored when
performing the automated security checks. These IDs are listed in the
pkg-vulnerabilities file and are displayed by
< span > < strong class = "command" > audit-packages< / strong > < / span > when
it finds a vulnerable package.
< / p > < / li >
< li > < p > < code class = "varname" > SKIP_AUDIT_PACKAGES< / code > :
If this is set to “ < span class = "quote" > yes< / span > ” , the automated security checks
2006-05-29 10:55:59 +02:00
(which use the < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/security/audit-packages/README.html" target = "_top" > < code class = "filename" > security/audit-packages< / code > < / a >
2006-05-28 22:41:22 +02:00
package) will be < span class = "strong" > < strong > entirely< / strong > < / span > skipped
for < span class = "strong" > < strong > all< / strong > < / span > packages built. Normally
you'll want to use ALLOW_VULNERABILITIES instead of this.
< / p > < / li >
< / ul > < / div >
< p >
< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "selecting-build-options" > < / a > 5.4.<2E> Selecting Build Options< / h2 > < / div > < / div > < / div >
< p > Some packages have build time options, usually to select between
different dependencies, enable optional support for big dependencies
or enable experimental features.< / p >
< p > To see which options, if any, a package supports, and which
options are mutually exclusive, run < span > < strong class = "command" > make show-options< / strong > < / span > ,
for example:< / p >
< pre class = "programlisting" >
The following options are supported by this package:
ssl Enable SSL support.
Exactly one of the following gecko options is required:
firefox Use firefox as gecko rendering engine.
mozilla Use mozilla as gecko rendering engine.
At most one of the following database options may be selected:
mysql Enable support for MySQL database.
pgsql Enable support for PostgreSQL database.
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
These options are enabled by default: firefox
These options are currently enabled: mozilla ssl
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > The following variables can be defined in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > to select which options to enable
2006-05-28 22:41:22 +02:00
for a package: < code class = "varname" > PKG_DEFAULT_OPTIONS< / code > , which can be
used to select or disable options for all packages that support them,
and < code class = "varname" > PKG_OPTIONS.< em class = "replaceable" > < code > pkgbase< / code > < / em > < / code > ,
which can be used to select or disable options specifically for
package < em class = "replaceable" > < code > pkgbase< / code > < / em > . Options listed in these
variables are selected, options preceded by “ < span class = "quote" > -< / span > ” are
disabled. A few examples:< / p >
< pre class = "screen" >
< code class = "prompt" > $< / code > < span > < strong class = "command" > grep "PKG.*OPTION" /etc/mk.conf< / strong > < / span >
PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
PKG_OPTIONS.kdebase= debug -sasl
PKG_OPTIONS.apache= suexec < / pre >
< p > The following settings are consulted in the order given, and the
last setting that selects or disables an option is used:< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > the default options as suggested by the package
maintainer< / p > < / li >
< li > < p > the options implied by the settings of legacy
variables (see below)< / p > < / li >
< li > < p > < code class = "varname" > PKG_DEFAULT_OPTIONS< / code > < / p > < / li >
< li > < p > < code class = "varname" > PKG_OPTIONS.< em class = "replaceable" > < code > pkgbase< / code > < / em > < / code > < / p > < / li >
< / ol > < / div >
< p > For groups of mutually exclusive options, the last option
selected is used, all others are automatically disabled. If an option
of the group is explicitly disabled, the previously selected option,
if any, is used. It is an error if no option from a required group of
options is selected, and building the package will fail.< / p >
< p > Before the options framework was introduced, build options were
selected by setting a variable (often named
< code class = "varname" > USE_< em class = "replaceable" > < code > FOO< / code > < / em > < / code > ) in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > for each option. To ease transition
2006-05-28 22:41:22 +02:00
to the options framework for the user, these legacy variables are
converted to the appropriate options setting
(< code class = "varname" > PKG_OPTIONS.< em class = "replaceable" > < code > pkgbase< / code > < / em > < / code > )
automatically. A warning is issued to prompt the user to
2006-05-29 10:55:59 +02:00
update < code class = "filename" > /etc/mk.conf< / code > to use the options framework
2006-05-28 22:41:22 +02:00
directly. Support for the legacy variables will be removed
eventually.< / p >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
< a name = "binary" > < / a > Chapter<EFBFBD> 6.<2E> Creating binary packages< / h2 > < / div > < / div > < / div >
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
< dt > < span class = "sect1" > < a href = "#building-a-single-binary-package" > 6.1. Building a single binary package< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#settings-for-creationg-of-binary-packages" > 6.2. Settings for creation of binary packages< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#bulkbuild" > 6.3. Doing a bulk build of all packages< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#binary.configuration" > 6.3.1. Configuration< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#other-environmental-considerations" > 6.3.2. Other environmental considerations< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#operation" > 6.3.3. Operation< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#what-it-does" > 6.3.4. What it does< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#disk-space-requirements" > 6.3.5. Disk space requirements< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#setting-up-a-sandbox" > 6.3.6. Setting up a sandbox for chrooted builds< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#building-a-partial-set" > 6.3.7. Building a partial set of packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#bulk-upload" > 6.3.8. Uploading results of a bulk build< / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#creating-cdroms" > 6.4. Creating a multiple CD-ROM packages collection< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#cdpack-example" > 6.4.1. Example of cdpack< / a > < / span > < / dt > < / dl > < / dd >
< / dl >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "building-a-single-binary-package" > < / a > 6.1.<2E> Building a single binary package< / h2 > < / div > < / div > < / div >
< p >
Once you have built and installed a package, you can create a
< span class = "emphasis" > < em > binary package< / em > < / span > which can be installed on
another system with < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_add< / span > (1)< / span > < / a > . This saves having to build
the same package on a group of hosts and wasting CPU time. It
also provides a simple means for others to install your package,
should you distribute it.
< / p >
< p >
To create a binary package, change into the appropriate
directory in pkgsrc, and run < span > < strong class = "command" > make
package< / strong > < / span > :
< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > cd misc/figlet< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > make package< / code > < / strong > < / pre >
< p >
This will build and install your package (if not already done),
and then build a binary package from what was installed. You can
then use the < span > < strong class = "command" > pkg_*< / strong > < / span > tools to manipulate
it. Binary packages are created by default in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkgsrc/packages< / code > , in the form of a
2006-05-28 22:41:22 +02:00
gzipped tar file. See < a href = "#logs.package" title = "B.2.<2E> Packaging figlet" > Section<EFBFBD> B.2, “ Packaging figlet” < / a > for a
2006-05-29 10:55:59 +02:00
continuation of the above < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/misc/figlet/README.html" target = "_top" > < code class = "filename" > misc/figlet< / code > < / a > example.< / p >
2006-05-28 22:41:22 +02:00
< p >
2006-06-01 11:36:55 +02:00
See < a href = "#submit" title = "Chapter<65> 19.<2E> Submitting and Committing" > Chapter<EFBFBD> 19, < i > Submitting and Committing< / i > < / a > for information on how to submit
2006-05-28 22:41:22 +02:00
such a binary package.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "settings-for-creationg-of-binary-packages" > < / a > 6.2.<2E> Settings for creation of binary packages< / h2 > < / div > < / div > < / div >
2006-06-01 11:36:55 +02:00
< p > See < a href = "#build.helpful-targets" title = "15.16.<2E> Other helpful targets" > Section<EFBFBD> 15.16, “ Other helpful targets” < / a > .< / p >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "bulkbuild" > < / a > 6.3.<2E> Doing a bulk build of all packages< / h2 > < / div > < / div > < / div >
< p > If you want to get a full set of precompiled binary
packages, this section describes how to get them. Beware that
the bulk build will remove all currently installed packages from
your system!< / p >
< p > Having an FTP server configured either on the
machine doing the bulk builds or on a nearby NFS server can help
to make the packages available to other machines that can then
save time by installing only the binary packages. See < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?ftpd+8+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > ftpd< / span > (8)< / span > < / a > for
more information. If you use a remote NFS server's storage, be
sure to not actually compile on NFS storage, as this slows
things down a lot.< / p >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "binary.configuration" > < / a > 6.3.1.<2E> Configuration< / h3 > < / div > < / div > < / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
2006-05-29 10:55:59 +02:00
< a name = "binary.bulk.build.conf" > < / a > 6.3.1.1.<2E> < code class = "filename" > build.conf< / code > < / h4 > < / div > < / div > < / div >
< p > The < code class = "filename" > build.conf< / code > file is the main
2006-05-28 22:41:22 +02:00
configuration file for bulk builds. You can configure how your
copy of pkgsrc is kept up to date, how the distfiles are
downloaded, how the packages are built and how the report is
generated. You can find an annotated example file in
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/mk/bulk/build.conf-example< / code > . To use
it, copy < code class = "filename" > build.conf-example< / code > to
< code class = "filename" > build.conf< / code > and edit it, following the
2006-05-28 22:41:22 +02:00
comments in that file.< / p >
< / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
< a name = "binary.mk.conf" > < / a > 6.3.1.2.<2E> /etc/mk.conf< / h4 > < / div > < / div > < / div >
< p > You may want to set variables in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > .
Look at < code class = "filename" > pkgsrc/mk/defaults/mk.conf< / code > for
2006-05-28 22:41:22 +02:00
details of the default settings. You will want to ensure that
< code class = "varname" > ACCEPTABLE_LICENSES< / code > meet your local policy.
As used in this example, < code class = "varname" > _ACCEPTABLE=yes< / code >
accepts < span class = "emphasis" > < em > all< / em > < / span > licenses.< / p >
< pre class = "programlisting" >
PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
BSDSRCDIR= /usr/src
BSDXSRCDIR= /usr/xsrc # for x11/xservers
OBJHOSTNAME?= yes # use work.`hostname`
FAILOVER_FETCH= yes # insist on the correct checksum
PKG_DEVELOPER?= yes
_ACCEPTABLE= yes
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > Some options that are especially useful for bulk builds
can be found at the top lines of the file
2006-05-29 10:55:59 +02:00
< code class = "filename" > mk/bulk/bsd.bulk-pkg.mk< / code > . The most useful
2006-05-28 22:41:22 +02:00
options of these are briefly described here.< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > If you are on a slow machine, you may want to
set < code class = "varname" > USE_BULK_BROKEN_CHECK< / code > to
“ < span class = "quote" > no< / span > ” .< / p > < / li >
< li > < p > If you are doing bulk builds from a read-only
copy of pkgsrc, you have to set < code class = "varname" > BULKFILESDIR< / code >
to the directory where all log files are created. Otherwise the
log files are created in the pkgsrc directory.< / p > < / li >
< li > < p > Another important variable is
< code class = "varname" > BULK_PREREQ< / code > , which is a list of packages that
should be always available while building other
packages.< / p > < / li >
< / ul > < / div >
< p > Some other options are scattered in the pkgsrc
infrastructure:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < code class = "varname" > ALLOW_VULNERABLE_PACKAGES< / code >
should be set to < code class = "literal" > yes< / code > . The purpose of the bulk
builds is creating binary packages, no matter if they are
vulnerable or not. When uploading the packages to a public
server, the vulnerable packages will be put into a directory of
their own. Leaving this variable unset would prevent the bulk
build system from even trying to build them, so possible
building errors would not show up.< / p > < / li >
< li > < p > < code class = "varname" > CHECK_FILES< / code >
2006-05-29 10:55:59 +02:00
(< code class = "filename" > pkgsrc/mk/bsd.pkg.check.mk< / code > ) can be set to
2006-05-28 22:41:22 +02:00
“ < span class = "quote" > yes< / span > ” to check that the installed set of files
2006-05-29 10:55:59 +02:00
matches the < code class = "filename" > PLIST< / code > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< li > < p > < code class = "varname" > CHECK_INTERPRETER< / code >
2006-05-29 10:55:59 +02:00
(< code class = "filename" > pkgsrc/mk/bsd.pkg.check.mk< / code > ) can be set to
2006-05-28 22:41:22 +02:00
“ < span class = "quote" > yes< / span > ” to check that the installed
“ < span class = "quote" > #!< / span > ” -scripts will find their
interpreter.< / p > < / li >
< / ul > < / div >
< / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
2006-05-29 10:55:59 +02:00
< a name = "pre-build.local" > < / a > 6.3.1.3.<2E> < code class = "filename" > pre-build.local< / code > < / h4 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > It is possible to configure the bulk build to perform
certain site-specific tasks at the end of the pre-build
stage. If the file
2006-05-29 10:55:59 +02:00
< code class = "filename" > pre-build.local< / code > exists in
< code class = "filename" > /usr/pkgsrc/mk/bulk< / code > , it will be executed
2006-05-28 22:41:22 +02:00
(as a < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > sh< / span > (1)< / span > < / a > script) at the end of the usual pre-build
stage. An example use of
2006-05-29 10:55:59 +02:00
< code class = "filename" > pre-build.local< / code > is to have the line:< / p >
2006-05-28 22:41:22 +02:00
< pre class = "screen" > echo "I do not have enough disk space to build this pig." \
> misc/openoffice/$BROKENF< / pre >
< p > to prevent the system from trying to build a particular package
which requires nearly 3 GB of disk space.< / p >
< / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "other-environmental-considerations" > < / a > 6.3.2.<2E> Other environmental considerations< / h3 > < / div > < / div > < / div >
2006-05-29 10:55:59 +02:00
< p > As < code class = "filename" > /usr/pkg< / code > will be completely
2006-05-28 22:41:22 +02:00
deleted at the start of bulk builds, make sure your login
shell is placed somewhere else. Either drop it into
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/local/bin< / code > (and adjust your login
2006-05-28 22:41:22 +02:00
shell in the passwd file), or (re-)install it via
2006-05-29 10:55:59 +02:00
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_add< / span > (1)< / span > < / a > from < code class = "filename" > /etc/rc.local< / code > , so
2006-05-28 22:41:22 +02:00
you can login after a reboot (remember that your current
process won't die if the package is removed, you just can't
start any new instances of the shell any more). Also, if you
use NetBSD earlier than 1.5, or you still want to use the pkgsrc
version of ssh for some reason, be sure to install ssh before
2006-05-29 10:55:59 +02:00
starting it from < code class = "filename" > rc.local< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
( cd /usr/pkgsrc/security/ssh ; make bulk-install )
if [ -f /usr/pkg/etc/rc.d/sshd ]; then
/usr/pkg/etc/rc.d/sshd
fi
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > Not doing so will result in you being not able to log in
via ssh after the bulk build is finished or if the machine
gets rebooted or crashes. You have been warned! :)< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "operation" > < / a > 6.3.3.<2E> Operation< / h3 > < / div > < / div > < / div >
< p > Make sure you don't need any of the packages still
installed.
< / p >
< div class = "warning" style = "margin-left: 0.5in; margin-right: 0.5in;" >
< h3 class = "title" > Warning< / h3 >
< p > During the bulk build, < span class = "emphasis" > < em > all packages will be
removed!< / em > < / span > < / p >
< / div >
< p > Be sure to remove all other things that might
interfere with builds, like some libs installed in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/local< / code > , etc. then become root and type:< / p >
2006-05-28 22:41:22 +02:00
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > cd /usr/pkgsrc< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > sh mk/bulk/build< / code > < / strong > < / pre >
< p > If for some reason your last build didn't complete (power
failure, system panic, ...), you can continue it by
running:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > sh mk/bulk/build restart< / code > < / strong > < / pre >
< p >
At the end of the bulk build, you will get a summary via mail,
and find build logs in the directory specified by
2006-05-29 10:55:59 +02:00
< code class = "varname" > FTP< / code > in the < code class = "filename" > build.conf< / code >
2006-05-28 22:41:22 +02:00
file.
< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "what-it-does" > < / a > 6.3.4.<2E> What it does< / h3 > < / div > < / div > < / div >
< p > The bulk builds consist of three steps:< / p >
< div class = "variablelist" > < dl >
< dt > < span class = "term" > 1. pre-build< / span > < / dt >
< dd > < p >
The script updates your pkgsrc tree via (anon)cvs, then
cleans out any broken distfiles, and removes all
packages installed.< / p > < / dd >
< dt > < span class = "term" > 2. the bulk build< / span > < / dt >
< dd > < p >
This is basically “ < span class = "quote" > make bulk-package< / span > ” with
an optimised order in which packages will be
built. Packages that don't require other packages will
be built first, and packages with many dependencies will
be built later.
< / p > < / dd >
< dt > < span class = "term" > 3. post-build< / span > < / dt >
< dd > < p >
Generates a report that's placed in the directory
2006-05-29 10:55:59 +02:00
specified in the < code class = "filename" > build.conf< / code > file
named < code class = "filename" > broken.html< / code > , a short version
2006-05-28 22:41:22 +02:00
of that report will also be mailed to the build's
admin.< / p > < / dd >
< / dl > < / div >
< p >
During the build, a list of broken packages will be compiled
2006-05-29 10:55:59 +02:00
in < code class = "filename" > /usr/pkgsrc/.broken< / code > (or
< code class = "filename" > .../.broken.${MACHINE}< / code > if
2006-05-28 22:41:22 +02:00
< code class = "varname" > OBJMACHINE< / code > is set), individual build logs
of broken builds can be found in the package's
directory. These files are used by the bulk-targets to mark
broken builds to not waste time trying to rebuild them, and
they can be used to debug these broken package builds
later.
< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "disk-space-requirements" > < / a > 6.3.5.<2E> Disk space requirements< / h3 > < / div > < / div > < / div >
< p > Currently, roughly the following requirements are valid for
NetBSD 2.0/i386:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p >
10 GB - distfiles (NFS ok)
< / p > < / li >
< li > < p >
8 GB - full set of all binaries (NFS ok)
< / p > < / li >
< li > < p >
5 GB - temp space for compiling (local disk recommended)
< / p > < / li >
< / ul > < / div >
< p >
Note that all pkgs will be de-installed as soon as they are
turned into a binary package, and that sources are removed,
so there is no excessively huge demand to disk
space. Afterwards, if the package is needed again, it will
be installed via < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_add< / span > (1)< / span > < / a > instead of building again, so
there are no cycles wasted by recompiling.
< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "setting-up-a-sandbox" > < / a > 6.3.6.<2E> Setting up a sandbox for chrooted builds< / h3 > < / div > < / div > < / div >
< p >
If you don't want all the packages nuked from a machine
(rendering it useless for anything but pkg compiling), there
is the possibility of doing the package bulk build inside a
chroot environment.
< / p >
< p >
The first step is to set up a chroot sandbox,
2006-05-29 10:55:59 +02:00
e.g. < code class = "filename" > /usr/sandbox< / code > . This can be done by
2006-05-28 22:41:22 +02:00
using null mounts, or manually.
< / p >
< p >
There is a shell script called
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/mk/bulk/mksandbox< / code > which will set
2006-05-28 22:41:22 +02:00
up the sandbox environment using null mounts. It will also
2006-05-29 10:55:59 +02:00
create a script called < code class = "filename" > sandbox< / code > in the
2006-05-28 22:41:22 +02:00
root of the sandbox environment, which will allow the null
mounts to be activated using the < span > < strong class = "command" > sandbox
mount< / strong > < / span > command and deactivated using the
< span > < strong class = "command" > sandbox umount< / strong > < / span > command.
< / p >
< p >
To set up a sandbox environment by hand, after extracting all
the sets from a NetBSD installation or doing a < span > < strong class = "command" > make
distribution DESTDIR=/usr/sandbox< / strong > < / span > in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/src/etc< / code > , be sure the following items
2006-05-28 22:41:22 +02:00
are present and properly configured:
< / p >
< div class = "procedure" > < ol type = "1" >
< li >
< p > Kernel< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > cp /netbsd /usr/sandbox< / code > < / strong > < / pre >
< / li >
< li >
2006-05-29 10:55:59 +02:00
< p > < code class = "filename" > /dev/*< / code > < / p >
2006-05-28 22:41:22 +02:00
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > cd /usr/sandbox/dev ; sh MAKEDEV all< / code > < / strong > < / pre >
< / li >
< li >
2006-05-29 10:55:59 +02:00
< p > < code class = "filename" > /etc/resolv.conf< / code > (for < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/security/smtpd/README.html" target = "_top" > < code class = "filename" > security/smtpd< / code > < / a > and mail):< / p >
2006-05-28 22:41:22 +02:00
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > cp /etc/resolv.conf /usr/sandbox/etc< / code > < / strong > < / pre >
< / li >
< li >
< p > Working(!) mail config (hostname, sendmail.cf):< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail< / code > < / strong > < / pre >
< / li >
< li >
2006-05-29 10:55:59 +02:00
< p > < code class = "filename" > /etc/localtime< / code > (for < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/security/smtpd/README.html" target = "_top" > < code class = "filename" > security/smtpd< / code > < / a > ):< / p >
2006-05-28 22:41:22 +02:00
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime< / code > < / strong > < / pre >
< / li >
< li >
2006-05-29 10:55:59 +02:00
< p > < code class = "filename" > /usr/src< / code > (system sources,
e.<2E> g. for < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/sysutils/aperture/README.html" target = "_top" > < code class = "filename" > sysutils/aperture< / code > < / a > ):< / p >
2006-05-28 22:41:22 +02:00
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > ln -s ../disk1/cvs .< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > ln -s cvs/src-2.0 src< / code > < / strong > < / pre >
< / li >
< li >
2006-05-29 10:55:59 +02:00
< p > Create < code class = "filename" > /var/db/pkg< / code > (not part of default install):< / p >
2006-05-28 22:41:22 +02:00
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > mkdir /usr/sandbox/var/db/pkg< / code > < / strong > < / pre >
< / li >
< li >
2006-05-29 10:55:59 +02:00
< p > Create < code class = "filename" > /usr/pkg< / code > (not part of default install):< / p >
2006-05-28 22:41:22 +02:00
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > mkdir /usr/sandbox/usr/pkg< / code > < / strong > < / pre >
< / li >
< li >
< p > Checkout pkgsrc via cvs into
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/sandbox/usr/pkgsrc< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > cd /usr/sandbox/usr< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc< / code > < / strong > < / pre >
< p > Do not mount/link this to the copy of your pkgsrc tree
you do development in, as this will likely cause problems!
< / p >
< / li >
< li > < p > Make
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/sandbox/usr/pkgsrc/packages< / code > and
< code class = "filename" > .../distfiles< / code > point somewhere
2006-05-28 22:41:22 +02:00
appropriate. NFS- and/or nullfs-mounts may come in handy!
< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > Edit < code class = "filename" > /etc/mk.conf< / code > , see < a href = "#binary.mk.conf" title = "6.3.1.2.<2E> /etc/mk.conf" > Section<EFBFBD> 6.3.1.2, “ /etc/mk.conf” < / a > .< / p > < / li >
< li > < p > Adjust < code class = "filename" > mk/bulk/build.conf< / code > to suit your needs.< / p > < / li >
2006-05-28 22:41:22 +02:00
< / ol > < / div >
< p > When the chroot sandbox is set up, you can start
the build with the following steps:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > cd /usr/sandbox/usr/pkgsrc< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > sh mk/bulk/do-sandbox-build< / code > < / strong > < / pre >
< p >
This will just jump inside the sandbox and start building. At
the end of the build, mail will be sent with the results of
the build. Created binary pkgs will be in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/sandbox/usr/pkgsrc/packages< / code >
2006-05-28 22:41:22 +02:00
(wherever that points/mounts to/from).< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "building-a-partial-set" > < / a > 6.3.7.<2E> Building a partial set of packages< / h3 > < / div > < / div > < / div >
< p > In addition to building a complete set of all packages in
2006-05-29 10:55:59 +02:00
pkgsrc, the < code class = "filename" > pkgsrc/mk/bulk/build< / code > script
2006-05-28 22:41:22 +02:00
may be used to build a subset of the packages contained in
pkgsrc. By setting < code class = "varname" > SPECIFIC_PKGS< / code >
2006-05-29 10:55:59 +02:00
in < code class = "filename" > /etc/mk.conf< / code > , the variables< / p >
2006-05-28 22:41:22 +02:00
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > SITE_SPECIFIC_PKGS< / p > < / li >
< li > < p > HOST_SPECIFIC_PKGS< / p > < / li >
< li > < p > GROUP_SPECIFIC_PKGS< / p > < / li >
< li > < p > USER_SPECIFIC_PKGS< / p > < / li >
< / ul > < / div >
< p > will define the set of packages which should be built.
The bulk build code will also include any packages which are
needed as dependencies for the explicitly listed packages.
< / p >
< p > One use of this is to do a bulk build with
< code class = "varname" > SPECIFIC_PKGS< / code > in a chroot sandbox
periodically to have a complete set of the binary packages
needed for your site available without the overhead of
building extra packages that are not needed. < / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "bulk-upload" > < / a > 6.3.8.<2E> Uploading results of a bulk build< / h3 > < / div > < / div > < / div >
< p >
This section describes how pkgsrc developers can upload binary
pkgs built by bulk builds to ftp.NetBSD.org.
< / p >
< p >
If you would like to automatically create checksum files for the
binary packages you intend to upload, remember to set
< code class = "varname" > MKSUMS=yes< / code > in your
2006-05-29 10:55:59 +02:00
< code class = "filename" > mk/bulk/build.conf< / code > .
2006-05-28 22:41:22 +02:00
< / p >
< p >
If you would like to PGP sign the checksum files (highly
recommended!), remember to set
< code class = "varname" > SIGN_AS=username@NetBSD.org< / code > in your
2006-05-29 10:55:59 +02:00
< code class = "filename" > mk/bulk/build.conf< / code > . This will prompt you for
2006-05-28 22:41:22 +02:00
your GPG password to sign the files before uploading everything.
< / p >
< p >
Then, make sure that you have < code class = "varname" > RSYNC_DST< / code >
2006-05-29 10:55:59 +02:00
set properly in your < code class = "filename" > mk/bulk/build.conf< / code >
2006-05-28 22:41:22 +02:00
file, i.e. adjust it to something like one of the following:
< / p >
< pre class = "screen" > RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload < / pre >
< p > Please use appropriate values for "pkgsrc-200xQy",
"NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
is different from your local login, write your login directly
into the variable, e.g. my local account is "feyrer", but for my
login "hubertf", I use:< / p >
< pre class = "screen" > RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload < / pre >
< p >
2006-05-29 10:55:59 +02:00
A separate < code class = "filename" > upload< / code > directory is used
2006-05-28 22:41:22 +02:00
here to allow "closing" the directory during upload. To do
so, run the following command on ftp.NetBSD.org next:
< / p >
< pre class = "screen" > nbftp% < strong class = "userinput" > < code > mkdir -p -m 750 /pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload< / code > < / strong > < / pre >
< p >
2006-05-29 10:55:59 +02:00
Please note that < code class = "filename" > /pub/NetBSD/packages< / code > is
2006-05-28 22:41:22 +02:00
only appropriate for packages for the NetBSD operating
system. Binary packages for other operating systems should go
2006-05-29 10:55:59 +02:00
into < code class = "filename" > /pub/pkgsrc< / code > .
2006-05-28 22:41:22 +02:00
< / p >
< p >
Before uploading the binary pkgs, ssh authentication needs to
be set up. This example shows how to set up temporary keys
for the root account < span class = "emphasis" > < em > inside the sandbox< / em > < / span >
(assuming that no keys should be present there usually):
< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > chroot /usr/sandbox< / code > < / strong >
chroot-< code class = "prompt" > #< / code > < strong class = "userinput" > < code > rm $HOME/.ssh/id-dsa*< / code > < / strong >
chroot-< code class = "prompt" > #< / code > < strong class = "userinput" > < code > ssh-keygen -t dsa< / code > < / strong >
chroot-< code class = "prompt" > #< / code > < strong class = "userinput" > < code > cat $HOME/.ssh/id-dsa.pub< / code > < / strong > < / pre >
< p >
2006-05-29 10:55:59 +02:00
Now take the output of < code class = "filename" > id-dsa.pub< / code > and
append it to your < code class = "filename" > ~/.ssh/authorized_keys< / code >
2006-05-28 22:41:22 +02:00
file on ftp.NetBSD.org. You can remove the key after the
upload is done!
< / p >
< p >
Next, test if your ssh connection really works:
< / p >
< pre class = "screen" > chroot-< code class = "prompt" > #< / code > < strong class = "userinput" > < code > ssh ftp.NetBSD.org date< / code > < / strong > < / pre >
< p >
Use "-l yourNetBSDlogin" here as appropriate!
< / p >
< p >
Now after all this works, you can exit the sandbox and start
the upload:
< / p >
< pre class = "screen" > chroot-< code class = "prompt" > #< / code > < strong class = "userinput" > < code > exit< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > cd /usr/sandbox/usr/pkgsrc< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > sh mk/bulk/do-sandbox-upload< / code > < / strong > < / pre >
< p >
The upload process may take quite some time. Use < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?ls+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > ls< / span > (1)< / span > < / a > or
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > du< / span > (1)< / span > < / a > on the FTP server to monitor progress of the
upload. The upload script will take care of not uploading
restricted packages and putting vulnerable packages into the
2006-05-29 10:55:59 +02:00
< code class = "filename" > vulnerable< / code > subdirectory.
2006-05-28 22:41:22 +02:00
< / p >
< p >
After the upload has ended, first thing is to revoke ssh access:
< / p >
< pre class = "screen" > nbftp% < strong class = "userinput" > < code > vi ~/.ssh/authorized_keys< / code > < / strong >
Gdd:x! < / pre >
< p >
Use whatever is needed to remove the key you've entered
before! Last, move the uploaded packages out of the
2006-05-29 10:55:59 +02:00
< code class = "filename" > upload< / code > directory to have them accessible
2006-05-28 22:41:22 +02:00
to everyone:
< / p >
< pre class = "screen" > nbftp% < strong class = "userinput" > < code > cd /pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch< / code > < / strong >
nbftp% < strong class = "userinput" > < code > mv upload/* .< / code > < / strong >
nbftp% < strong class = "userinput" > < code > rmdir upload< / code > < / strong >
nbftp% < strong class = "userinput" > < code > chmod 755 .< / code > < / strong > < / pre >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "creating-cdroms" > < / a > 6.4.<2E> Creating a multiple CD-ROM packages collection< / h2 > < / div > < / div > < / div >
< p >
After your pkgsrc bulk-build has completed, you may wish to
create a CD-ROM set of the resulting binary packages to assist
in installing packages on other machines. The
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/cdpack/README.html" target = "_top" > < code class = "filename" > pkgtools/cdpack< / code > < / a > package provides
2006-05-28 22:41:22 +02:00
a simple tool for creating the ISO 9660 images.
< span > < strong class = "command" > cdpack< / strong > < / span > arranges the packages on the CD-ROMs in a
way that keeps all the dependencies for a given package on the same
CD as that package.
< / p >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "cdpack-example" > < / a > 6.4.1.<2E> Example of cdpack< / h3 > < / div > < / div > < / div >
< p >
Complete documentation for cdpack is found in the cdpack(1)
man page. The following short example assumes that the binary
packages are left in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkgsrc/packages/All< / code > and that
sufficient disk space exists in < code class = "filename" > /u2< / code > to
2006-05-28 22:41:22 +02:00
hold the ISO 9660 images.< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > mkdir /u2/images< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > pkg_add /usr/pkgsrc/packages/All/cdpack< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > cdpack /usr/pkgsrc/packages/All /u2/images< / code > < / strong > < / pre >
< p >
If you wish to include a common set of files
2006-05-29 10:55:59 +02:00
(< code class = "filename" > COPYRIGHT< / code > , < code class = "filename" > README< / code > ,
2006-05-28 22:41:22 +02:00
etc.) on each CD in the collection, then you need to create a
directory which contains these files. e.g.
< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > mkdir /tmp/common< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > echo "This is a README" > /tmp/common/README< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > echo "Another file" > /tmp/common/COPYING< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > mkdir /tmp/common/bin< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > echo "#!/bin/sh" > /tmp/common/bin/myscript< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > echo "echo Hello world" > > /tmp/common/bin/myscript< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > chmod 755 /tmp/common/bin/myscript< / code > < / strong > < / pre >
< p > Now create the images:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images< / code > < / strong > < / pre >
2006-05-29 10:55:59 +02:00
< p > Each image will contain < code class = "filename" > README< / code > ,
< code class = "filename" > COPYING< / code > , and < code class = "filename" > bin/myscript< / code >
2006-05-28 22:41:22 +02:00
in their root directories.< / p >
< / div >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
< a name = "faq" > < / a > Chapter<EFBFBD> 7.<2E> Frequently Asked Questions< / h2 > < / div > < / div > < / div >
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
< dt > < span class = "sect1" > < a href = "#mailing-list-pointers" > 7.1. Are there any mailing lists for pkg-related discussion?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#pkgviews-docs" > 7.2. Where's the pkgviews documentation?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#faq-pkgtools" > 7.3. Utilities for package management (pkgtools)< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#non-root-pkgsrc" > 7.4. How to use pkgsrc as non-root< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#resume-transfers" > 7.5. How to resume transfers when fetching distfiles?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#XFree86-from-pkgsrc" > 7.6. How can I install/use XFree86 from pkgsrc?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#x.org-from-pkgsrc" > 7.7. How can I install/use X.org from pkgsrc?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#fetch-behind-firewall" > 7.8. How to fetch files from behind a firewall< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#passive-ftp" > 7.9. How do I tell < span > < strong class = "command" > make fetch< / strong > < / span > to do passive FTP?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#fetching-all-distfiles" > 7.10. How to fetch all distfiles at once< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#tmac.andoc-missing" > 7.11. What does “ < span class = "quote" > Don't know how to make
/usr/share/tmac/tmac.andoc< / span > ” mean?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#bsd.own.mk-missing" > 7.12. What does “ < span class = "quote" > Could not find bsd.own.mk< / span > ” mean?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#using-sudo-with-pkgsrc" > 7.13. Using 'sudo' with pkgsrc< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#faq.conf" > 7.14. How do I change the location of configuration files?< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#audit-packages" > 7.15. Automated security checks< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#ufaq-cflags" > 7.16. Why do some packages ignore my < code class = "varname" > CFLAGS< / code > ?< / a > < / span > < / dt >
< / dl >
< / div >
< p > This section contains hints, tips & tricks on special things in
pkgsrc that we didn't find a better place for in the previous chapters, and
it contains items for both pkgsrc users and developers.< / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "mailing-list-pointers" > < / a > 7.1.<2E> Are there any mailing lists for pkg-related discussion?< / h2 > < / div > < / div > < / div >
< p > The following mailing lists may be of interest to pkgsrc users:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < a href = "http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bugs" target = "_top" > pkgsrc-bugs< / a > :
All bug reports in category "pkg" sent with < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > send-pr< / span > (1)< / span > < / a > appear
here. Please do not report your bugs here directly; use one
of the other mailing lists.
discussed.< / p > < / li >
< li > < p > < a href = "http://www.NetBSD.org/MailingLists/index.html#pkgsrc-bulk" target = "_top" > pkgsrc-bulk< / a > :
A list where the results of pkgsrc bulk builds are sent and
discussed.< / p > < / li >
< li > < p > < a href = "http://www.NetBSD.org/MailingLists/index.html#pkgsrc-changes" target = "_top" > pkgsrc-changes< / a > :
This list is for those who are interested in getting a
commit message for every change committed to pkgsrc. It is
also available in digest form, meaning one daily message
containing all commit messages for changes to the package
source tree in that 24 hour period.< / p > < / li >
< li > < p > < a href = "http://www.NetBSD.org/MailingLists/index.html#tech-pkg" target = "_top" > pkgsrc-users< / a > :
This is a general purpose list for most issues regarding
pkgsrc, regardless of platform, e.g. soliciting user help
for pkgsrc configuration, unexpected build failures, using
particular packages, upgrading pkgsrc installations,
questions regarding the pkgsrc release branches, etc. General announcements or
proposals for changes that impact the pkgsrc user community,
e.g. major infrastructure changes, new features, package
removals, etc., may also be posted.< / p > < / li >
< li > < p > < a href = "http://www.NetBSD.org/MailingLists/index.html#tech-pkg" target = "_top" > tech-pkg< / a > :
This is a list for technical discussions related to pkgsrc
development, e.g. soliciting feedback for changes to pkgsrc
infrastructure, proposed new features, questions related
to porting pkgsrc to a new platform, advice for maintaining
a package, patches that affect many packages, help requests
moved from pkgsrc-users when an infrastructure bug is found,
etc.< / p > < / li >
< / ul > < / div >
< p > To subscribe, do:< / p >
< pre class = "programlisting" >
< code class = "prompt" > %< / code > echo subscribe < em class = "replaceable" > < code > listname< / code > < / em > | mail majordomo@NetBSD.org
< / pre >
< p > Archives for all these mailing lists are available from
< a href = "http://mail-index.NetBSD.org/" target = "_top" > http://mail-index.NetBSD.org/< / a > .< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "pkgviews-docs" > < / a > 7.2.<2E> Where's the pkgviews documentation?< / h2 > < / div > < / div > < / div >
< p > Pkgviews is tightly integrated with buildlink. You can find a
pkgviews User's guide in
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/mk/buildlink3/PKGVIEWS_UG< / code > .< / p >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "faq-pkgtools" > < / a > 7.3.<2E> Utilities for package management (pkgtools)< / h2 > < / div > < / div > < / div >
2006-05-29 10:55:59 +02:00
< p > The < code class = "filename" > pkgsrc/pkgtools< / code > directory pkgtools contains
2006-05-28 22:41:22 +02:00
a number of useful utilities for both users and developers of pkgsrc. This
section attempts only to make the reader aware of the utilities and when
they might be useful, and not to duplicate the documentation that comes
with each package.< / p >
< p > Utilities used by pkgsrc (automatically installed when needed):< / p >
2006-05-29 10:55:59 +02:00
< div class = "itemizedlist" > < ul type = "disc" > < li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/x11-links/README.html" target = "_top" > < code class = "filename" > pkgtools/x11-links< / code > < / a > :
2006-05-28 22:41:22 +02:00
Symlinks for use by buildlink.< / p > < / li > < / ul > < / div >
< p > OS tool augmentation (automatically installed when needed):< / p >
< div class = "itemizedlist" > < ul type = "disc" >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/digest/README.html" target = "_top" > < code class = "filename" > pkgtools/digest< / code > < / a > :
2006-05-28 22:41:22 +02:00
Calculates various kinds of checksums (including SHA1).< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/libnbcompat/README.html" target = "_top" > < code class = "filename" > pkgtools/libnbcompat< / code > < / a > :
2006-05-28 22:41:22 +02:00
Compatibility library for pkgsrc tools.< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/mtree/README.html" target = "_top" > < code class = "filename" > pkgtools/mtree< / code > < / a > : Installed on
2006-05-28 22:41:22 +02:00
non-BSD systems due to lack of native mtree.
< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkg_install/README.html" target = "_top" > < code class = "filename" > pkgtools/pkg_install< / code > < / a > :
2006-05-28 22:41:22 +02:00
Up-to-date replacement for
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/sbin/pkg_install< / code > , or for use on operating
2006-05-28 22:41:22 +02:00
systems where pkg_install is not present.< / p > < / li >
< / ul > < / div >
< p > Utilities used by pkgsrc (not automatically installed):< / p >
< div class = "itemizedlist" > < ul type = "disc" >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkg_tarup/README.html" target = "_top" > < code class = "filename" > pkgtools/pkg_tarup< / code > < / a > :
2006-05-28 22:41:22 +02:00
Create a binary package from an
already-installed package. Used by < span > < strong class = "command" > make replace< / strong > < / span > to
save the old package.< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/dfdisk/README.html" target = "_top" > < code class = "filename" > pkgtools/dfdisk< / code > < / a > :
2006-05-28 22:41:22 +02:00
Adds extra functionality to pkgsrc, allowing it to fetch distfiles
from multiple locations. It currently supports the following
methods: multiple CD-ROMs and network FTP/HTTP connections.< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/xpkgwedge/README.html" target = "_top" > < code class = "filename" > pkgtools/xpkgwedge< / code > < / a > : Put X11
2006-05-28 22:41:22 +02:00
packages someplace else (enabled by default).< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/devel/cpuflags/README.html" target = "_top" > < code class = "filename" > devel/cpuflags< / code > < / a > : Determine the
2006-05-28 22:41:22 +02:00
best compiler flags to optimise code for your current CPU and
compiler.< / p > < / li >
< / ul > < / div >
< p > Utilities for keeping track of installed packages, being up to date,
etc:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkg_chk/README.html" target = "_top" > < code class = "filename" > pkgtools/pkg_chk< / code > < / a > : Reports on
2006-05-28 22:41:22 +02:00
packages whose installed versions do not match the latest pkgsrc
entries.< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkgdep/README.html" target = "_top" > < code class = "filename" > pkgtools/pkgdep< / code > < / a > : Makes
2006-05-28 22:41:22 +02:00
dependency graphs of packages, to aid in choosing a strategy for
updating.< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkgdepgraph/README.html" target = "_top" > < code class = "filename" > pkgtools/pkgdepgraph< / code > < / a > : Makes
graphs from the output of < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkgdep/README.html" target = "_top" > < code class = "filename" > pkgtools/pkgdep< / code > < / a > (uses graphviz).< / p > < / li >
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkglint/README.html" target = "_top" > < code class = "filename" > pkgtools/pkglint< / code > < / a > : The
2006-05-28 22:41:22 +02:00
pkglint(1) program checks a pkgsrc entry for errors, lintpkgsrc(1)
does various checks on the complete pkgsrc system.< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkgsurvey/README.html" target = "_top" > < code class = "filename" > pkgtools/pkgsurvey< / code > < / a > : Report what
2006-05-28 22:41:22 +02:00
packages you have installed.< / p > < / li >
< / ul > < / div >
< p > Utilities for people maintaining or creating individual packages:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkgdiff/README.html" target = "_top" > < code class = "filename" > pkgtools/pkgdiff< / code > < / a > : Automate
2006-05-28 22:41:22 +02:00
making and maintaining patches for a package (includes pkgdiff,
pkgvi, mkpatches, etc.).< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/rpm2pkg/README.html" target = "_top" > < code class = "filename" > pkgtools/rpm2pkg< / code > < / a > ,
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/url2pkg/README.html" target = "_top" > < code class = "filename" > pkgtools/url2pkg< / code > < / a > : Aids in
2006-05-28 22:41:22 +02:00
converting to pkgsrc.< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/gensolpkg/README.html" target = "_top" > < code class = "filename" > pkgtools/gensolpkg< / code > < / a > : Convert
2006-05-28 22:41:22 +02:00
pkgsrc to a Solaris package.< / p > < / li >
< / ul > < / div >
< p > Utilities for people maintaining pkgsrc (or: more obscure pkg
utilities)< / p >
< div class = "itemizedlist" > < ul type = "disc" >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkg_comp/README.html" target = "_top" > < code class = "filename" > pkgtools/pkg_comp< / code > < / a > : Build
2006-05-28 22:41:22 +02:00
packages in a chrooted area.< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/libkver/README.html" target = "_top" > < code class = "filename" > pkgtools/libkver< / code > < / a > : Spoof
2006-05-28 22:41:22 +02:00
kernel version for chrooted cross builds.< / p > < / li >
< / ul > < / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "non-root-pkgsrc" > < / a > 7.4.<2E> How to use pkgsrc as non-root< / h2 > < / div > < / div > < / div >
< p > If you want to use pkgsrc as non-root user, you can set some
variables to make pkgsrc work under these conditions. At the very least,
you need to set < code class = "varname" > UNPRIVILEGED< / code > to “ < span class = "quote" > yes< / span > ” ; this
will turn on unprivileged mode and set multiple related variables to allow
installation of packages as non-root.< / p >
< p > In case the defaults are not enough, you may want to tune some other
variables used. For example, if the automatic user/group detection leads
to incorrect values (or not the ones you would like to use), you can change
them by setting < code class = "varname" > UNPRIVILEGED_USER< / code > and
< code class = "varname" > UNPRIVILEGED_GROUP< / code > respectively.< / p >
< p > As regards bootstrapping, please note that the
< span > < strong class = "command" > bootstrap< / strong > < / span > script will ease non-root configuration when
given the “ < span class = "quote" > --ignore-user-check< / span > ” flag, as it will choose and
2006-05-29 10:55:59 +02:00
use multiple default directories under < code class = "filename" > ~/pkg< / code > as the
2006-05-28 22:41:22 +02:00
installation targets. These directories can be overriden by the
“ < span class = "quote" > --prefix< / span > ” flag provided by the script, as well as some others
that allow finer tuning of the tree layout.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "resume-transfers" > < / a > 7.5.<2E> How to resume transfers when fetching distfiles?< / h2 > < / div > < / div > < / div >
< p > By default, resuming transfers in pkgsrc is disabled, but you can
enable this feature by adding the option
< code class = "varname" > PKG_RESUME_TRANSFERS=YES< / code > into
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > . If, during a fetch step, an incomplete
2006-05-28 22:41:22 +02:00
distfile is found, pkgsrc will try to resume it.< / p >
< p > You can also
use a different program than the default < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > ftp< / span > (1)< / span > < / a > by changing the
< code class = "varname" > FETCH_CMD< / code > variable. Don't forget to set
< code class = "varname" > FETCH_RESUME_ARGS< / code > and
< code class = "varname" > FETCH_OUTPUT_ARGS< / code > if you are not using default
values.< / p >
< p > For example, if you want to use
2006-05-29 10:55:59 +02:00
< code class = "filename" > wget< / code > to resume downloads, you'll have to use something
2006-05-28 22:41:22 +02:00
like:< / p >
< pre class = "programlisting" >
FETCH_CMD= wget
FETCH_BEFORE_ARGS= --passive-ftp
FETCH_RESUME_ARGS= -c
FETCH_OUTPUT_ARGS= -O
2006-05-23 11:14:12 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "XFree86-from-pkgsrc" > < / a > 7.6.<2E> How can I install/use XFree86 from pkgsrc?< / h2 > < / div > < / div > < / div >
< p > If you want to use XFree86 from pkgsrc instead of your system's own
2006-05-29 10:55:59 +02:00
X11 (< code class = "filename" > /usr/X11R6< / code > , < code class = "filename" > /usr/openwin< / code > ,
2006-05-28 22:41:22 +02:00
...), you will have to add the following line into
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
X11_TYPE=XFree86
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "x.org-from-pkgsrc" > < / a > 7.7.<2E> How can I install/use X.org from pkgsrc?< / h2 > < / div > < / div > < / div >
< p > If you want to use X.org from pkgsrc instead of your system's own X11
2006-05-29 10:55:59 +02:00
(< code class = "filename" > /usr/X11R6< / code > , < code class = "filename" > /usr/openwin< / code > , ...)
2006-05-28 22:41:22 +02:00
you will have to add the following line into
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
X11_TYPE=xorg
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< div class = "note" style = "margin-left: 0.5in; margin-right: 0.5in;" >
< h3 class = "title" > Note< / h3 >
< p > The DragonFly operating system defaults to using
this X.org X11 implementation from pkgsrc.
< / p >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "fetch-behind-firewall" > < / a > 7.8.<2E> How to fetch files from behind a firewall< / h2 > < / div > < / div > < / div >
< p > If you are sitting behind a firewall which does not allow direct
connections to Internet hosts (i.e. non-NAT), you may specify the
relevant proxy hosts. This is done using an environment variable in the
form of a URL, e.g. in Amdahl, the machine
“ < span class = "quote" > orpheus.amdahl.com< / span > ” is one of the firewalls, and it uses
port 80 as the proxy port number. So the proxy environment variables
are:< / p >
< pre class = "programlisting" >
ftp_proxy=ftp://orpheus.amdahl.com:80/
http_proxy=http://orpheus.amdahl.com:80/
< / pre >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "passive-ftp" > < / a > 7.9.<2E> How do I tell < span > < strong class = "command" > make fetch< / strong > < / span > to do passive FTP?< / h2 > < / div > < / div > < / div >
< p > This depends on which utility is used to retrieve distfiles. From
2006-05-29 10:55:59 +02:00
< code class = "filename" > bsd.pkg.mk< / code > , < code class = "varname" > FETCH_CMD< / code > is assigned
2006-05-28 22:41:22 +02:00
the first available command from the following list:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
2006-05-29 10:55:59 +02:00
< li > < p > < code class = "filename" > ${LOCALBASE}/bin/ftp< / code > < / p > < / li >
< li > < p > < code class = "filename" > /usr/bin/ftp< / code > < / p > < / li >
2006-05-28 22:41:22 +02:00
< / ul > < / div >
< p > On a default NetBSD installation, this will be
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/bin/ftp< / code > , which automatically tries passive
2006-05-28 22:41:22 +02:00
connections first, and falls back to active connections if the server
refuses to do passive. For the other tools, add the following to your
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > file:
2006-05-28 22:41:22 +02:00
< code class = "varname" > PASSIVE_FETCH=1< / code > .< / p >
< p > Having that option present will prevent
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/bin/ftp< / code > from falling back to active
2006-05-28 22:41:22 +02:00
transfers.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "fetching-all-distfiles" > < / a > 7.10.<2E> How to fetch all distfiles at once< / h2 > < / div > < / div > < / div >
< p > You would like to download all the distfiles in a single batch from
work or university, where you can't run a < span > < strong class = "command" > make fetch< / strong > < / span > .
There is an archive of distfiles on < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target = "_top" > ftp.NetBSD.org< / a > ,
but downloading the entire directory may not be appropriate.< / p >
< p > The answer here is to do a < span > < strong class = "command" > make fetch-list< / strong > < / span > in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkgsrc< / code > or one of its subdirectories, carry the
2006-05-28 22:41:22 +02:00
resulting list to your machine at work/school and use it there. If you
don't have a NetBSD-compatible < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > ftp< / span > (1)< / span > < / a > (like tnftp) at work, don't
forget to set < code class = "varname" > FETCH_CMD< / code > to something that fetches a
URL:< / p >
< p > At home:< / p >
< pre class = "screen" > < code class = "prompt" > %< / code > < strong class = "userinput" > < code > cd /usr/pkgsrc< / code > < / strong >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles > /tmp/fetch.sh< / code > < / strong >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > scp /tmp/fetch.sh work:/tmp< / code > < / strong > < / pre >
< p > At work:< / p >
< pre class = "screen" > < code class = "prompt" > %< / code > < strong class = "userinput" > < code > sh /tmp/fetch.sh< / code > < / strong > < / pre >
2006-05-29 10:55:59 +02:00
< p > then tar up < code class = "filename" > /tmp/distfiles< / code > and take it
2006-05-28 22:41:22 +02:00
home.< / p >
< p > If you have a machine running NetBSD, and you want to get
< span class = "emphasis" > < em > all< / em > < / span > distfiles (even ones that aren't for your machine
architecture), you can do so by using the above-mentioned < span > < strong class = "command" > make
fetch-list< / strong > < / span > approach, or fetch the distfiles directly by
running:< / p >
< pre class = "screen" > < code class = "prompt" > %< / code > < strong class = "userinput" > < code > make mirror-distfiles< / code > < / strong > < / pre >
< p > If you even decide to ignore
< code class = "varname" > NO_{SRC,BIN}_ON_{FTP,CDROM}< / code > , then you can get everything
by running:< / p >
< pre class = "screen" > < code class = "prompt" > %< / code > < strong class = "userinput" > < code > make fetch NO_SKIP=yes< / code > < / strong > < / pre >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "tmac.andoc-missing" > < / a > 7.11.<2E> What does “ < span class = "quote" > Don't know how to make
/usr/share/tmac/tmac.andoc< / span > ” mean?< / h2 > < / div > < / div > < / div >
2006-05-29 10:55:59 +02:00
< p > When compiling the < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkg_install/README.html" target = "_top" > < code class = "filename" > pkgtools/pkg_install< / code > < / a >
2006-05-28 22:41:22 +02:00
package, you get the error from make that it doesn't know how to make
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/share/tmac/tmac.andoc< / code > ? This indicates that
2006-05-28 22:41:22 +02:00
you don't have installed the “ < span class = "quote" > text< / span > ” set (nroff, ...) from
the NetBSD base distribution on your machine. It is recommended to do
that to format man pages.< / p >
2006-05-29 10:55:59 +02:00
< p > In the case of the < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkg_install/README.html" target = "_top" > < code class = "filename" > pkgtools/pkg_install< / code > < / a > package, you
2006-05-28 22:41:22 +02:00
can get away with setting < code class = "varname" > NOMAN=YES< / code > either in the
2006-05-29 10:55:59 +02:00
environment or in < code class = "filename" > /etc/mk.conf< / code > .< / p >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "bsd.own.mk-missing" > < / a > 7.12.<2E> What does “ < span class = "quote" > Could not find bsd.own.mk< / span > ” mean?< / h2 > < / div > < / div > < / div >
2006-05-29 10:55:59 +02:00
< p > You didn't install the compiler set, < code class = "filename" > comp.tgz< / code > ,
2006-05-28 22:41:22 +02:00
when you installed your NetBSD machine. Please get and install it, by
2006-05-29 10:55:59 +02:00
extracting it in < code class = "filename" > /< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > cd /< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > tar --unlink -zxvpf .../comp.tgz< / code > < / strong > < / pre >
2006-05-29 10:55:59 +02:00
< p > < code class = "filename" > comp.tgz< / code > is part of every NetBSD release. Get
2006-05-28 22:41:22 +02:00
the one that corresponds to your release (determine via < span > < strong class = "command" > uname
-r< / strong > < / span > ).< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "using-sudo-with-pkgsrc" > < / a > 7.13.<2E> Using 'sudo' with pkgsrc< / h2 > < / div > < / div > < / div >
< p > When installing packages as non-root user and using the just-in-time
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > su< / span > (1)< / span > < / a > feature of pkgsrc, it can become annoying to type in the root
password for each required package installed. To avoid this, the sudo
package can be used, which does password caching over a limited time. To
use it, install sudo (either as binary package or from
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/security/sudo/README.html" target = "_top" > < code class = "filename" > security/sudo< / code > < / a > ) and then put the following
into your < code class = "filename" > /etc/mk.conf< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
.if exists(${LOCALBASE}/bin/sudo)
SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
.endif
< / pre >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "faq.conf" > < / a > 7.14.<2E> How do I change the location of configuration files?< / h2 > < / div > < / div > < / div >
< p > As the system administrator, you can choose where configuration files
are installed. The default settings make all these files go into
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${PREFIX}/etc< / code > or some of its subdirectories; this may
2006-05-28 22:41:22 +02:00
be suboptimal depending on your expectations (e.g., a read-only,
NFS-exported < code class = "varname" > PREFIX< / code > with a need of per-machine
configuration of the provided packages).< / p >
< p > In order to change the defaults, you can modify the
< code class = "varname" > PKG_SYSCONFBASE< / code > variable (in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > ) to point to your preferred configuration
directory; some common examples include < code class = "filename" > /etc< / code > or
< code class = "filename" > /etc/pkg< / code > .< / p >
2006-05-28 22:41:22 +02:00
< p > Furthermore, you can change this value on a per-package basis by
setting the < code class = "varname" > PKG_SYSCONFDIR.${PKG_SYSCONFVAR}< / code > variable.
< code class = "varname" > PKG_SYSCONFVAR< / code > 's value usually matches the name of the
package you would like to modify, that is, the contents of
< code class = "varname" > PKGBASE< / code > .< / p >
< p > Note that after changing these settings, you must rebuild and
reinstall any affected packages.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "audit-packages" > < / a > 7.15.<2E> Automated security checks< / h2 > < / div > < / div > < / div >
< p > Please be aware that there can often be bugs in third-party software,
and some of these bugs can leave a machine vulnerable to exploitation by
attackers. In an effort to lessen the exposure, the NetBSD packages team
maintains a database of known-exploits to packages which have at one time
been included in pkgsrc. The database can be downloaded automatically, and
a security audit of all packages installed on a system can take place. To
2006-05-29 10:55:59 +02:00
do this, install the < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/security/audit-packages/README.html" target = "_top" > < code class = "filename" > security/audit-packages< / code > < / a > package. It has two
2006-05-28 22:41:22 +02:00
components:< / p >
< div class = "orderedlist" > < ol type = "1" >
< li >
< p > < span > < strong class = "command" > download-vulnerability-list< / strong > < / span > , an easy way to
download a list of the security vulnerabilities information. This list
is kept up to date by the NetBSD security officer and the NetBSD
packages team, and is distributed from the NetBSD ftp server:< / p >
< p > < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities" target = "_top" > ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities< / a > < / p >
< / li >
< li > < p > < span > < strong class = "command" > audit-packages< / strong > < / span > , an easy way to audit the
current machine, checking each vulnerability which is known. If a
vulnerable package is installed, it will be shown by output to stdout,
including a description of the type of vulnerability, and a URL
containing more information.< / p > < / li >
< / ol > < / div >
2006-05-29 10:55:59 +02:00
< p > Use of the < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/security/audit-packages/README.html" target = "_top" > < code class = "filename" > security/audit-packages< / code > < / a >
2006-05-28 22:41:22 +02:00
package is strongly recommended! After
“ < span class = "quote" > audit-packages< / span > ” is installed, please read
the package's message, which you can get by running < strong class = "userinput" > < code > pkg_info -D
audit-packages< / code > < / strong > .< / p >
< p > If this package is installed, pkgsrc builds will use it to perform
a security check before building any package. See
< a href = "#variables-affecting-build" title = "5.2.<2E> Variables affecting the build process" > Section<EFBFBD> 5.2, “ Variables affecting the build process” < / a > for ways to control this check.
< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "ufaq-cflags" > < / a > 7.16.<2E> Why do some packages ignore my < code class = "varname" > CFLAGS< / code > ?< / h2 > < / div > < / div > < / div >
< p > When you add your own preferences to the
< code class = "varname" > CFLAGS< / code > variable in your
2006-05-29 10:55:59 +02:00
< code class = "filename" > mk.conf< / code > , these flags are passed in
environment variables to the < code class = "filename" > ./configure< / code >
2006-05-28 22:41:22 +02:00
scripts and to < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > make< / span > (1)< / span > < / a > . Some package authors ignore the
< code class = "varname" > CFLAGS< / code > from the environment variable by
2006-05-29 10:55:59 +02:00
overriding them in the < code class = "filename" > Makefile< / code > s of their
2006-05-28 22:41:22 +02:00
package.< / p >
< p > Currently there is no solution to this problem. If you
really need the package to use your < code class = "varname" > CFLAGS< / code >
you should run < span > < strong class = "command" > make patch< / strong > < / span > in the package
2006-05-29 10:55:59 +02:00
directory and then inspect any < code class = "filename" > Makefile< / code > and
< code class = "filename" > Makefile.in< / code > for whether they define
2006-05-28 22:41:22 +02:00
< code class = "varname" > CFLAGS< / code > explicitly. Usually you can remove
these lines. But be aware that some “ < span class = "quote" > smart< / span > ”
programmers write so bad code that it only works for the
specific combination of < code class = "varname" > CFLAGS< / code > they have
chosen.< / p >
< / div >
< / div >
< / div >
< div class = "part" lang = "en" >
< div class = "titlepage" > < div > < div > < h1 class = "title" >
< a name = "developers-guide" > < / a > Part<EFBFBD> II.<2E> The pkgsrc developer's guide< / h1 > < / div > < / div > < / div >
2006-06-01 11:36:55 +02:00
< div class = "partintro" lang = "en" >
< div > < / div >
< p > This part of the book deals with creating and
modifying packages. It starts with a “ < span class = "quote" > HOWTO< / span > ” -like
guide on creating a new package. The remaining chapters are more
like a reference manual for pkgsrc.< / p >
2006-05-28 22:41:22 +02:00
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#creating" > 8. Creating a new pkgsrc package from scratch< / a > < / span > < / dt >
< dt > < span class = "chapter" > < a href = "#components" > 9. Package components - files, directories and contents< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#components.Makefile" > 9.1. < code class = "filename" > Makefile< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#components.distinfo" > 9.2. < code class = "filename" > distinfo< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#components.patches" > 9.3. patches/*< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#other-mandatory-files" > 9.4. Other mandatory files< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#components.optional" > 9.5. Optional files< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#work-dir" > 9.6. < code class = "filename" > work*< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#files-dir" > 9.7. < code class = "filename" > files/*< / code > < / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#makefile" > 10. Programming in < code class = "filename" > Makefile< / code > s< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#makefile.variables" > 10.1. < code class = "filename" > Makefile< / code > variables< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#makefile.variables.names" > 10.1.1. Naming conventions< / a > < / span > < / dt > < / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#makefile.code" > 10.2. Code snippets< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#adding-to-list" > 10.2.1. Adding things to a list< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#converting-internal-to-external" > 10.2.2. Converting an internal list into an external list< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#passing-variable-to-shell" > 10.2.3. Passing variables to a shell command< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#quoting-guideline" > 10.2.4. Quoting guideline< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#bsd-make-bug-workaround" > 10.2.5. Workaround for a bug in BSD Make< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#plist" > 11. PLIST issues< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#rcs-id" > 11.1. RCS ID< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#automatic-plist-generation" > 11.2. Semi-automatic < code class = "filename" > PLIST< / code > generation< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#print-PLIST" > 11.3. Tweaking output of < span > < strong class = "command" > make print-PLIST< / strong > < / span > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#plist.misc" > 11.4. Variable substitution in PLIST< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#manpage-compression" > 11.5. Man page compression< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#using-PLIST_SRC" > 11.6. Changing PLIST source with < code class = "varname" > PLIST_SRC< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#platform-specific-plist" > 11.7. Platform-specific and differing PLISTs< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#faq.common-dirs" > 11.8. Sharing directories between packages< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#buildlink" > 12. Buildlink methodology< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#converting-to-buildlink3" > 12.1. Converting packages to use buildlink3< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#creating-buildlink3.mk" > 12.2. Writing < code class = "filename" > buildlink3.mk< / code > files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#anatomy-of-bl3" > 12.2.1. Anatomy of a buildlink3.mk file< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#updating-buildlink-depends" > 12.2.2. Updating < code class = "varname" > BUILDLINK_API_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code > in < code class = "filename" > buildlink3.mk< / code > files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#writing-builtin.mk" > 12.3. Writing < code class = "filename" > builtin.mk< / code > files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#anatomy-of-builtin.mk" > 12.3.1. Anatomy of a < code class = "filename" > builtin.mk< / code > file< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#native-or-pkgsrc-preference" > 12.3.2. Global preferences for native or pkgsrc software< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#pkginstall" > 13. The pkginstall framework< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#files-and-dirs-outside-prefix" > 13.1. Files and directories outside the installation prefix< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#dirs-outside-prefix" > 13.1.1. Directory manipulation< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#files-outside-prefix" > 13.1.2. File manipulation< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#conf-files" > 13.2. Configuration files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#conf-files-sysconfdir" > 13.2.1. How < code class = "varname" > PKG_SYSCONFDIR< / code > is set< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#conf-files-configure" > 13.2.2. Telling the software where configuration files are< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#conf-files-patching" > 13.2.3. Patching installations< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#conf-files-disable" > 13.2.4. Disabling handling of configuration files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#rcd-scripts" > 13.3. System startup scripts< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#rcd-scripts-disable" > 13.3.1. Disabling handling of system startup scripts< / a > < / span > < / dt > < / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#users-and-groups" > 13.4. System users and groups< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#shells" > 13.5. System shells< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#shells-disable" > 13.5.1. Disabling shell registration< / a > < / span > < / dt > < / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#fonts" > 13.6. Fonts< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#fonts-disable" > 13.6.1. Disabling automatic update of the fonts databases< / a > < / span > < / dt > < / dl > < / dd >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#options" > 14. Options handling< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#global-default-options" > 14.1. Global default options< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#converting-to-options" > 14.2. Converting packages to use < code class = "filename" > bsd.options.mk< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#option-names" > 14.3. Option Names< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#build" > 15. The build process< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#build.intro" > 15.1. Introduction< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.prefix" > 15.2. Program location< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.builddirs" > 15.3. Directories used during the build process< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.running" > 15.4. Running a phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.fetch" > 15.5. The < span class = "emphasis" > < em > fetch< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.checksum" > 15.6. The < span class = "emphasis" > < em > checksum< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.extract" > 15.7. The < span class = "emphasis" > < em > extract< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.patch" > 15.8. The < span class = "emphasis" > < em > patch< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.tools" > 15.9. The < span class = "emphasis" > < em > tools< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.wrapper" > 15.10. The < span class = "emphasis" > < em > wrapper< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.configure" > 15.11. The < span class = "emphasis" > < em > configure< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.build" > 15.12. The < span class = "emphasis" > < em > build< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.test" > 15.13. The < span class = "emphasis" > < em > test< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.install" > 15.14. The < span class = "emphasis" > < em > install< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.package" > 15.15. The < span class = "emphasis" > < em > package< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.helpful-targets" > 15.16. Other helpful targets< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#tools" > 16. Tools needed for building or running< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#pkgsrc-tools" > 16.1. Tools for pkgsrc builds< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#package-tools" > 16.2. Tools needed by packages< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#platform-tools" > 16.3. Tools provided by platforms< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#fixes" > 17. Making your package work< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#general-operation" > 17.1. General operation< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#pulling-vars-from-etc-mk.conf" > 17.1.1. How to pull in variables from /etc/mk.conf< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#where-to-install-documentation" > 17.1.2. Where to install documentation< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#restricted-packages" > 17.1.3. Restricted packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#dependencies" > 17.1.4. Handling dependencies< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#conflicts" > 17.1.5. Handling conflicts with other packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#not-building-packages" > 17.1.6. Packages that cannot or should not be built< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#undeletable-packages" > 17.1.7. Packages which should not be deleted, once installed< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#security-handling" > 17.1.8. Handling packages with security problems< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#compiler-bugs" > 17.1.9. How to handle compiler bugs< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#bumping-pkgrevision" > 17.1.10. How to handle incrementing versions when fixing an existing package< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#portability-of-packages" > 17.1.11. Portability of packages< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#fixes.fetch" > 17.2. Fixing problems in the < span class = "emphasis" > < em > fetch< / em > < / span > phase< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#no-plain-download" > 17.2.1. Packages whose distfiles aren't available for plain downloading< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#modified-distfiles-same-name" > 17.2.2. How to handle modified distfiles with the 'old' name< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#fixes.configure" > 17.3. Fixing problems in the < span class = "emphasis" > < em > configure< / em > < / span > phase< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#fixes.libtool" > 17.3.1. Shared libraries - libtool< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#using-libtool" > 17.3.2. Using libtool on GNU packages that already support libtool< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#autoconf-automake" > 17.3.3. GNU Autoconf/Automake< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#fixes.build" > 17.4. Fixing problems in the < span class = "emphasis" > < em > build< / em > < / span > phase< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#fixes.build.cpp" > 17.4.1. Compiling C and C++ code conditionally< / a > < / span > < / dt > < / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#package-specific-actions" > 17.5. Package specific actions< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#user-interaction" > 17.5.1. User interaction< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#handling-licenses" > 17.5.2. Handling licenses< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#fixes.install" > 17.6. Fixing problems in the < span class = "emphasis" > < em > install< / em > < / span > phase< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#installing-score-files" > 17.6.1. Installing score files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#perl-scripts" > 17.6.2. Packages containing perl scripts< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#hardcoded-paths" > 17.6.3. Packages with hardcoded paths to other interpreters< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#perl-modules" > 17.6.4. Packages installing perl modules< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#faq.info-files" > 17.6.5. Packages installing info files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#manpages" > 17.6.6. Packages installing man pages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#gconf2-data-files" > 17.6.7. Packages installing GConf2 data files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#scrollkeeper-data-files" > 17.6.8. Packages installing scrollkeeper data files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#x11-fonts" > 17.6.9. Packages installing X11 fonts< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#gtk2-modules" > 17.6.10. Packages installing GTK2 modules< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#sgml-xml-data" > 17.6.11. Packages installing SGML or XML data< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#mime-database" > 17.6.12. Packages installing extensions to the MIME database< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#intltool" > 17.6.13. Packages using intltool< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#startup-scripts" > 17.6.14. Packages installing startup scripts< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#tex-packages" > 17.6.15. Packages installing TeX modules< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#feedback-to-author" > 17.7. Feedback to the author< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#debug" > 18. Debugging< / a > < / span > < / dt >
< dt > < span class = "chapter" > < a href = "#submit" > 19. Submitting and Committing< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#submitting-binary-packages" > 19.1. Submitting binary packages< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#submitting-your-package" > 19.2. Submitting source packages (for non-NetBSD-developers)< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#general-notes-for-changes" > 19.3. General notes when adding, updating, or removing packages< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#committing-importing" > 19.4. Committing: Importing a package into CVS< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#updating-package" > 19.5. Updating a package to a newer version< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#moving-package" > 19.6. Moving a package in pkgsrc< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#devfaq" > 20. Frequently Asked Questions< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl >
< / div >
2006-06-01 11:36:55 +02:00
< / div >
2006-05-28 22:41:22 +02:00
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "creating" > < / a > Chapter<EFBFBD> 8.<2E> Creating a new pkgsrc package from scratch< / h2 > < / div > < / div > < / div >
< p > When you find a package that is not yet in pkgsrc, you
most likely have a URL from where you can download the source
code. Starting with this URL, creating a package involves only a
few steps.< / p >
< div class = "procedure" > < ol type = "1" >
< li > < p > First, install the packages < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/url2pkg/README.html" target = "_top" > < code class = "filename" > pkgtools/url2pkg< / code > < / a > and < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkglint/README.html" target = "_top" > < code class = "filename" > pkgtools/pkglint< / code > < / a > .< / p > < / li >
< li > < p > Then, choose one of the top-level directories as the
category in which you want to place your package. You can also
create a directory of your own (maybe called
< code class = "filename" > local< / code > ). In that category directory, create
another directory for your package and change into
it.< / p > < / li >
< li > < p > Run the program < span > < strong class = "command" > url2pkg< / strong > < / span > , which
will ask you for a URL. Enter the URL of the distribution file
(in most cases a < code class = "filename" > .tar.gz< / code > file) and watch
how the basic ingredients of your package are created
automatically. The distribution file is extracted automatically
to fill in some details in the < code class = "filename" > Makefile< / code >
that would otherwise have to be done manually.< / p > < / li >
< li >
< p > Examine the extracted files to determine the
dependencies of your package. Ideally, this is mentioned in some
< code class = "filename" > README< / code > file, but things may differ. For
each of these dependencies, look where it exists in pkgsrc, and
if there is a file called < code class = "filename" > buildlink3.mk< / code > in
that directory, add a line to your package
< code class = "filename" > Makefile< / code > which includes that file just
before the last line. If the < code class = "filename" > buildlink3.mk< / code >
file does not exist, add a < code class = "varname" > DEPENDS< / code > line to
the Makefile, which specifies the version of the dependency and
where it can be found in pkgsrc. This line should be placed in
the third paragraph. If the dependency is only needed for
building the package, but not when using it, use
< code class = "varname" > BUILD_DEPENDS< / code > instead of
< code class = "varname" > DEPENDS< / code > . Your package may then look like
this:< / p >
< pre class = "programlisting" >
[...]
BUILD_DEPENDS+= lua> =5.0:../../lang/lua
DEPENDS+= screen-[0-9]*:../../misc/screen
DEPENDS+= screen> =4.0:../../misc/screen
[...]
.include "../../< em class = "replaceable" > < code > category< / code > < / em > /< em class = "replaceable" > < code > package< / code > < / em > /buildlink3.mk"
.include "../../devel/glib2/buildlink3.mk"
.include "../../mk/bsd.pkg.mk"
< / pre >
< / li >
< li > < p > Run < span > < strong class = "command" > pkglint< / strong > < / span > to see what things
still need to be done to make your package a “ < span class = "quote" > good< / span > ”
one. If you don't know what pkglint's warnings want to tell you,
try < span > < strong class = "command" > pkglint --explain< / strong > < / span > or < span > < strong class = "command" > pkglint
-e< / strong > < / span > , which outputs additional
explanations.< / p > < / li >
< li > < p > Now, run < span > < strong class = "command" > bmake< / strong > < / span > to build the
package. For the various things that can go wrong in this phase,
consult < a href = "#fixes" title = "Chapter<65> 17.<2E> Making your package work" > Chapter<EFBFBD> 17, < i > Making your package work< / i > < / a > .< / p > < / li >
< li > < p > When the package builds fine, the next step is to
install the package. Run < span > < strong class = "command" > bmake install< / strong > < / span > and
hope that everything works.< / p > < / li >
< li > < p > Up to now, the file < code class = "filename" > PLIST< / code > ,
which contains a list of the files that are installed by the
package, is nearly empty. Run < span > < strong class = "command" > bmake print-PLIST
> PLIST< / strong > < / span > to generate a probably correct list. Check
the file using your preferred text editor to see if the list of
files looks plausible.< / p > < / li >
< li > < p > Run < span > < strong class = "command" > pkglint< / strong > < / span > again to see if the
generated < code class = "filename" > PLIST< / code > contains garbage or
not.< / p > < / li >
< li > < p > When you ran < span > < strong class = "command" > bmake install< / strong > < / span > , the
package has been registered in the database of installed files,
but with an empty list of files. To fix this, run < span > < strong class = "command" > bmake
deinstall< / strong > < / span > and < span > < strong class = "command" > bmake install< / strong > < / span > again.
Now the package is registered with the list of files from
< code class = "filename" > PLIST< / code > .< / p > < / li >
< li > < p > Run < span > < strong class = "command" > bmake package< / strong > < / span > to create a
binary package from the set of installed files.< / p > < / li >
< / ol > < / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
< a name = "components" > < / a > Chapter<EFBFBD> 9.<2E> Package components - files, directories and contents< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#components.Makefile" > 9.1. < code class = "filename" > Makefile< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#components.distinfo" > 9.2. < code class = "filename" > distinfo< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#components.patches" > 9.3. patches/*< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#other-mandatory-files" > 9.4. Other mandatory files< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#components.optional" > 9.5. Optional files< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#work-dir" > 9.6. < code class = "filename" > work*< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#files-dir" > 9.7. < code class = "filename" > files/*< / code > < / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl >
< / div >
< p > Whenever you're preparing a package, there are a number of
files involved which are described in the following
sections. < / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "components.Makefile" > < / a > 9.1.<2E> < code class = "filename" > Makefile< / code > < / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Building, installation and creation of a binary package are all
2006-05-29 10:55:59 +02:00
controlled by the package's < code class = "filename" > Makefile< / code > .
The < code class = "filename" > Makefile< / code > describes various things about
2006-05-28 22:41:22 +02:00
a package, for example from where to get it, how to configure,
build, and install it.
< / p >
2006-05-29 10:55:59 +02:00
< p > A package < code class = "filename" > Makefile< / code > contains several
2006-05-28 22:41:22 +02:00
sections that describe the package.< / p >
< p > In the first section there are the following variables, which
should appear exactly in the order given here.
< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < code class = "varname" > DISTNAME< / code > is the basename of the
distribution file to be downloaded from the package's
website.< / p > < / li >
< li > < p > < code class = "varname" > PKGNAME< / code > is the name of the
package, as used by pkgsrc. You only need to provide it if it
differs from < code class = "varname" > DISTNAME< / code > . Usually it is the directory name together
with the version number. It must match the regular expression
< code class = "varname" > ^[A-Za-z0-9][A-Za-z0-9-_.+]*$< / code > , that is, it
starts with a letter or digit, and contains only letters, digits,
dashes, underscores, dots and plus signs.< / p > < / li >
< li >
< p > < code class = "varname" > CATEGORIES< / code > is a list of categories
which the package fits in. You can choose any of the top-level
directories of pkgsrc for it.< / p >
< p > Currently the following values are available for
< code class = "varname" > CATEGORIES< / code > . If more than
one is used, they need to be separated by spaces:< / p >
< pre class = "programlisting" >
archivers cross geography meta-pkgs security
audio databases graphics misc shells
benchmarks devel ham multimedia sysutils
biology editors inputmethod net textproc
cad emulators lang news time
chat finance mail parallel wm
comms fonts math pkgtools www
converters games mbone print x11
< / pre >
< / li >
< li >
< p > < code class = "varname" > MASTER_SITES< / code > is a list of URLs where
the distribution files can be downloaded. Each URL must end with a
slash.< / p >
< p > The < code class = "varname" > MASTER_SITES< / code > may make use of
the following predefined sites:< / p >
< pre class = "programlisting" >
${MASTER_SITE_APACHE}
${MASTER_SITE_BACKUP}
${MASTER_SITE_CYGWIN}
${MASTER_SITE_DEBIAN}
${MASTER_SITE_FREEBSD}
${MASTER_SITE_FREEBSD_LOCAL}
${MASTER_SITE_GNOME}
${MASTER_SITE_GNU}
${MASTER_SITE_GNUSTEP}
${MASTER_SITE_IFARCHIVE}
${MASTER_SITE_MOZILLA}
${MASTER_SITE_OPENOFFICE}
${MASTER_SITE_PERL_CPAN}
${MASTER_SITE_R_CRAN}
${MASTER_SITE_SOURCEFORGE}
${MASTER_SITE_SUNSITE}
${MASTER_SITE_SUSE}
${MASTER_SITE_TEX_CTAN}
${MASTER_SITE_XCONTRIB}
${MASTER_SITE_XEMACS}
< / pre >
< p > If one of these predefined sites is chosen, you may
want to specify a subdirectory of that
site. Since these macros may expand to more than one
actual site, you < span class = "emphasis" > < em > must< / em > < / span > use the
following construct to specify a subdirectory:< / p >
< pre class = "programlisting" >
${MASTER_SITE_GNU:=subdirectory/name/}
${MASTER_SITE_SOURCEFORGE:=project_name/}
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > Note the trailing slash after the subdirectory name.< / p >
< p > If the package has multiple
< code class = "varname" > DISTFILES< / code > or multiple
< code class = "varname" > PATCHFILES< / code > from different
sites, set < code class = "varname" > SITES.foo< / code > to a list of URIs
where file “ < span class = "quote" > foo< / span > ” may be
found. “ < span class = "quote" > foo< / span > ” includes the suffix, e.g.:< / p >
< pre class = "programlisting" >
DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
DISTFILES+= foo-file.tar.gz
SITES.foo-file.tar.gz= \
http://www.somewhere.com/somehow/ \
http://www.somewhereelse.com/mirror/somehow/
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< / li >
< li >
< p > < code class = "varname" > DISTFILES< / code > : Name(s)
of archive file(s) containing distribution. The default is
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${DISTNAME}${EXTRACT_SUFX}< / code > . Should only
2006-05-28 22:41:22 +02:00
be set if you have more than one distfile.< / p >
< p > Note that the normal default setting of
< code class = "varname" > DISTFILES< / code > must be made explicit if you
want to add to it (rather than replace it), as you usually
would.< / p >
< / li >
< li > < p > < code class = "varname" > EXTRACT_SUFX< / code > : Suffix of the
distribution file, will be appended to
< code class = "varname" > DISTNAME< / code > . Defaults to
2006-05-29 10:55:59 +02:00
< code class = "filename" > .tar.gz< / code > .
2006-05-28 22:41:22 +02:00
< / p > < / li >
< / ul > < / div >
< p >
< / p >
< p > The second section contains information about separately
downloaded patches, if any.
< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < code class = "varname" > PATCHFILES:< / code >
Name(s) of additional files that contain distribution patches.
There is no default. pkgsrc will look for them at
< code class = "varname" > PATCH_SITES< / code > .
They will automatically be uncompressed before patching if
2006-05-29 10:55:59 +02:00
the names end with < code class = "filename" > .gz< / code > or
< code class = "filename" > .Z< / code > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< li > < p > < code class = "varname" > PATCH_SITES< / code > :
Primary location(s) for distribution patch files (see
< code class = "varname" > PATCHFILES< / code > below) if not found locally.< / p > < / li >
< / ul > < / div >
< p >
< / p >
< p > The third section contains the following variables.
< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < code class = "varname" > MAINTAINER< / code > is the email address
of the person who feels responsible for this package, and who is
most likely to look at problems or questions regarding this
package which have been reported with < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > send-pr< / span > (1)< / span > < / a > . Other
developers should contact the < code class = "varname" > MAINTAINER< / code > before
making major changes to the package. When packaging a new program,
set < code class = "varname" > MAINTAINER< / code > to yourself. If you really can't
maintain the package for future updates, set it to
< code class = "email" > < < a href = "mailto:pkgsrc-users@NetBSD.org" > pkgsrc-users@NetBSD.org< / a > > < / code > .< / p > < / li >
< li > < p > < code class = "varname" > HOMEPAGE< / code > is a URL where users can
find more information about the package.< / p > < / li >
< li > < p > < code class = "varname" > COMMENT< / code > is a one-line
description of the package (should not include the package
name).< / p > < / li >
< / ul > < / div >
< p >
< / p >
< p > Other variables that affect the build:
< / p >
< div class = "itemizedlist" > < ul type = "disc" > < li >
< p > < code class = "varname" > WRKSRC< / code > : The directory where the
interesting distribution files of the package are found. The
2006-05-29 10:55:59 +02:00
default is < code class = "filename" > ${WRKDIR}/${DISTNAME}< / code > , which
2006-05-28 22:41:22 +02:00
works for most packages.< / p >
< p > If a package doesn't create a subdirectory for itself
(most GNU software does, for instance), but extracts itself in
the current directory, you should set < code class = "varname" > WRKSRC=
${WRKDIR}< / code > .< / p >
< p > If a package doesn't create a subdirectory with the name
of < code class = "varname" > DISTNAME< / code > but some different name, set
< code class = "varname" > WRKSRC< / code > to point to the proper name in
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${WRKDIR}< / code > , for example < code class = "varname" > WRKSRC=
${WRKDIR}/${DISTNAME}/unix< / code > . See < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/lang/tcl/README.html" target = "_top" > < code class = "filename" > lang/tcl< / code > < / a > and < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/x11/tk/README.html" target = "_top" > < code class = "filename" > x11/tk< / code > < / a > for other examples.< / p >
2006-05-28 22:41:22 +02:00
< p > The name of the working directory created by pkgsrc is
taken from the < code class = "varname" > WRKDIR_BASENAME< / code > variable. By
2006-05-29 10:55:59 +02:00
default, its value is < code class = "filename" > work< / code > . If you want
2006-05-28 22:41:22 +02:00
to use the same pkgsrc tree for building different kinds of
binary packages, you can change the variable according to your
needs. Two other variables handle common cases of setting
< code class = "varname" > WRKDIR_BASENAME< / code > individually. If
< code class = "varname" > OBJHOSTNAME< / code > is defined in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > , the first component of the
2006-05-28 22:41:22 +02:00
host's name is attached to the directory name. If
< code class = "varname" > OBJMACHINE< / code > is defined, the platform name is
2006-05-29 10:55:59 +02:00
attached, which might look like < code class = "filename" > work.i386< / code >
or < code class = "filename" > work.sparc< / code > .< / p >
2006-05-28 22:41:22 +02:00
< / li > < / ul > < / div >
< p >
< / p >
< p > Please pay attention to the following gotchas:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > Add < code class = "varname" > MANCOMPRESSED< / code > if man pages are installed in
compressed form by the package; see comment in
2006-05-29 10:55:59 +02:00
< code class = "filename" > bsd.pkg.mk< / code > .< / p > < / li >
< li > < p > Replace < code class = "filename" > /usr/local< / code > with
2006-05-28 22:41:22 +02:00
“ < span class = "quote" > ${PREFIX}< / span > ” in all files (see patches, below).< / p > < / li >
< li > < p > If the package installs any info files, see
2006-06-01 11:36:55 +02:00
< a href = "#faq.info-files" title = "17.6.5.<2E> Packages installing info files" > Section<EFBFBD> 17.6.5, “ Packages installing info files” < / a > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< / ul > < / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "components.distinfo" > < / a > 9.2.<2E> < code class = "filename" > distinfo< / code > < / h2 > < / div > < / div > < / div >
2006-05-29 10:55:59 +02:00
< p > The < code class = "filename" > distinfo< / code > file contains the message
2006-05-28 22:41:22 +02:00
digest, or checksum, of each distfile needed for the package. This
ensures that the distfiles retrieved from the Internet have not been
corrupted during transfer or altered by a malign force to introduce
a security hole. Due to recent rumor about weaknesses of digest
algorithms, all distfiles are protected using both SHA1 and RMD160
message digests, as well as the file size.< / p >
2006-05-29 10:55:59 +02:00
< p > The < code class = "filename" > distinfo< / code > file also contains the
2006-05-28 22:41:22 +02:00
checksums for all the patches found in the
2006-06-01 11:36:55 +02:00
< code class = "filename" > patches< / code > directory (see < a href = "#components.patches" title = "9.3.<2E> patches/*" > Section<EFBFBD> 9.3, “ patches/*” < / a > ).< / p >
2006-05-29 10:55:59 +02:00
< p > To regenerate the < code class = "filename" > distinfo< / code > file, use the
2006-05-28 22:41:22 +02:00
< span > < strong class = "command" > make makedistinfo< / strong > < / span > or < span > < strong class = "command" > make mdi< / strong > < / span >
command.< / p >
< p > Some packages have different sets of distfiles depending on
2006-05-29 10:55:59 +02:00
the platform, for example < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/www/navigator/README.html" target = "_top" > < code class = "filename" > www/navigator< / code > < / a > ). These are kept in the same
< code class = "filename" > distinfo< / code > file and care should be taken when
2006-05-28 22:41:22 +02:00
upgrading such a package to ensure distfile information is not
lost.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "components.patches" > < / a > 9.3.<2E> patches/*< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > This directory contains files that are used by the
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > patch< / span > (1)< / span > < / a > command to
modify the sources as distributed in the distribution file into a form
that will compile and run perfectly on NetBSD. The files are applied
successively in alphabetic order (as returned by a shell
“ < span class = "quote" > patches/patch-*< / span > ” glob expansion), so
2006-05-29 10:55:59 +02:00
< code class = "filename" > patch-aa< / code > is applied before
< code class = "filename" > patch-ab< / code > , etc.< / p >
< p > The < code class = "filename" > patch-*< / code > files should be in
2006-05-28 22:41:22 +02:00
< span > < strong class = "command" > diff -bu< / strong > < / span > format, and apply without a fuzz to avoid
problems. (To force patches to apply
with fuzz you can set < code class = "varname" > PATCH_FUZZ_FACTOR=-F2< / code > ).
Furthermore, do not put changes for more than one file into a single
patch file, as this will make future modifications more difficult.< / p >
< p > Similar, a file should be patched at most once, not several times by
several different patches. If a file needs several patches, they should
be combined into one file.< / p >
< p > One important thing to mention is to pay attention that no RCS IDs
get stored in the patch files, as these will cause problems when
later checked into the NetBSD CVS tree. Use the
< span > < strong class = "command" > pkgdiff< / strong > < / span > from the
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkgdiff/README.html" target = "_top" > < code class = "filename" > pkgtools/pkgdiff< / code > < / a > package to avoid
2006-05-28 22:41:22 +02:00
these problems.< / p >
< p > For even more automation, we recommend using < span > < strong class = "command" > mkpatches< / strong > < / span > from the same
package to make a whole set of patches. You just have to backup files
2006-05-29 10:55:59 +02:00
before you edit them to < code class = "filename" > filename.orig< / code > , e.g. with
2006-05-28 22:41:22 +02:00
< span > < strong class = "command" > cp -p filename filename.orig< / strong > < / span > or, easier, by using
< span > < strong class = "command" > pkgvi< / strong > < / span > again from the same package. If you upgrade a package
this way, you can easily compare the new set of patches with the
previously existing one with < span > < strong class = "command" > patchdiff< / strong > < / span > .< / p >
< p > When you have finished a package, remember to generate the checksums
for the patch files by using the < span > < strong class = "command" > make makepatchsum< / strong > < / span >
2006-06-01 11:36:55 +02:00
command, see < a href = "#components.distinfo" title = "9.2.<2E> distinfo" > Section<EFBFBD> 9.2, “ < code class = "filename" > distinfo< / code > ” < / a > .< / p >
2006-05-28 22:41:22 +02:00
< p > When adding a patch that corrects a problem in the distfile (rather
than e.g. enforcing pkgsrc's view of where man pages should go), send
the patch as a bug report to the maintainer. This benefits
non-pkgsrc users of the package, and usually enables removing
the patch in future version.< / p >
< p > Patch files that are distributed by the author or other
maintainers can be listed in
< code class = "varname" > $PATCHFILES< / code > . < / p >
< p > If it is desired to store any patches that should not be committed into
pkgsrc, they can be kept outside the pkgsrc tree in the
2006-05-29 10:55:59 +02:00
< code class = "filename" > $LOCALPATCHES< / code >
2006-05-28 22:41:22 +02:00
directory. The directory tree there is expected to have the same
“ < span class = "quote" > category/package< / span > ” structure as pkgsrc, and patches are
expected to be stored inside these dirs (also known as
2006-05-29 10:55:59 +02:00
< code class = "filename" > $LOCALPATCHES/$PKGPATH< / code > ). For
2006-05-28 22:41:22 +02:00
example, if you want to keep a private patch for
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/graphics/png< / code > , keep
it in < code class = "filename" > $LOCALPATCHES/graphics/png/mypatch< / code > . All
2006-05-28 22:41:22 +02:00
files in the named directory are expected to be patch files, and
< span class = "emphasis" > < em > they are applied after pkgsrc patches are applied< / em > < / span > .< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "other-mandatory-files" > < / a > 9.4.<2E> Other mandatory files< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "variablelist" > < dl >
2006-05-29 10:55:59 +02:00
< dt > < span class = "term" > < code class = "filename" > DESCR< / code > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < p > A multi-line description of the piece of software. This should include
any credits where they are due. Please bear in mind that others do not
share your sense of humour (or spelling idiosyncrasies), and that others
will read everything that you write here.< / p > < / dd >
2006-05-29 10:55:59 +02:00
< dt > < span class = "term" > < code class = "filename" > PLIST< / code > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < p >
This file governs the files that are installed on your system: all the
binaries, manual pages, etc. There are other directives which may be
entered in this file, to control the creation and deletion of
directories, and the location of inserted files.
2006-06-01 11:36:55 +02:00
See < a href = "#plist" title = "Chapter<65> 11.<2E> PLIST issues" > Chapter<EFBFBD> 11, < i > PLIST issues< / i > < / a > for more information. < / p > < / dd >
2006-05-28 22:41:22 +02:00
< / dl > < / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "components.optional" > < / a > 9.5.<2E> Optional files< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "variablelist" > < dl >
2006-05-29 10:55:59 +02:00
< dt > < span class = "term" > < code class = "filename" > INSTALL< / code > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < p > This shell script is invoked twice by < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_add< / span > (1)< / span > < / a > .
First time after package
extraction and before files are moved in place, the second time after
the files to install are moved in place. This can be used to do any
custom procedures not possible with @exec commands in
2006-05-29 10:55:59 +02:00
< code class = "filename" > PLIST< / code > . See
2006-05-28 22:41:22 +02:00
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_add< / span > (1)< / span > < / a > and < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_create< / span > (1)< / span > < / a > for more information.< / p > < / dd >
2006-05-29 10:55:59 +02:00
< dt > < span class = "term" > < code class = "filename" > DEINSTALL< / code > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < p > This script is executed before and after any files are removed. It is
this script's responsibility to clean up any additional messy details
around the package's installation, since all pkg_delete knows is how to
delete the files created in the original distribution.
See < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_delete< / span > (1)< / span > < / a >
and < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_create< / span > (1)< / span > < / a > for more information.< / p > < / dd >
2006-05-29 10:55:59 +02:00
< dt > < span class = "term" > < code class = "filename" > MESSAGE< / code > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd >
< p > This file is displayed after installation of the package.
Useful for things like legal notices on almost-free
software and hints for updating config files after
installing modules for apache, PHP etc.
Please note that you can modify variables in it easily by using
< code class = "varname" > MESSAGE_SUBST< / code > in the package's
2006-05-29 10:55:59 +02:00
< code class = "filename" > Makefile< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
MESSAGE_SUBST+= SOMEVAR="somevalue"
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > replaces "${SOMEVAR}" with “ < span class = "quote" > somevalue< / span > ” in
2006-05-29 10:55:59 +02:00
< code class = "filename" > MESSAGE< / code > .< / p >
2006-05-28 22:41:22 +02:00
< / dd >
< / dl > < / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "work-dir" > < / a > 9.6.<2E> < code class = "filename" > work*< / code > < / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > When you type < span > < strong class = "command" > make< / strong > < / span > , the distribution files are
unpacked into the directory denoted by
< code class = "varname" > WRKDIR< / code > . It can be removed by running
< span > < strong class = "command" > make clean< / strong > < / span > . Besides the sources, this
directory is also used to keep various timestamp files.
The directory gets < span class = "emphasis" > < em > removed completely< / em > < / span > on clean.
2006-05-29 10:55:59 +02:00
The default is < code class = "filename" > ${.CURDIR}/work< / code >
or < code class = "filename" > ${.CURDIR}/work.${MACHINE_ARCH}< / code >
2006-05-28 22:41:22 +02:00
if < code class = "varname" > OBJMACHINE< / code > is set.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "files-dir" > < / a > 9.7.<2E> < code class = "filename" > files/*< / code > < / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > If you have any files that you wish to be placed in the package prior
to configuration or building, you could place these files here and use
a “ < span class = "quote" > ${CP}< / span > ” command in the
“ < span class = "quote" > pre-configure< / span > ” target to achieve
this. Alternatively, you could simply diff the file against
2006-05-29 10:55:59 +02:00
< code class = "filename" > /dev/null< / code > and use the patch mechanism to manage
2006-05-28 22:41:22 +02:00
the creation of this file.< / p >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "makefile" > < / a > Chapter<EFBFBD> 10.<2E> Programming in < code class = "filename" > Makefile< / code > s< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#makefile.variables" > 10.1. < code class = "filename" > Makefile< / code > variables< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#makefile.variables.names" > 10.1.1. Naming conventions< / a > < / span > < / dt > < / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#makefile.code" > 10.2. Code snippets< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#adding-to-list" > 10.2.1. Adding things to a list< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#converting-internal-to-external" > 10.2.2. Converting an internal list into an external list< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#passing-variable-to-shell" > 10.2.3. Passing variables to a shell command< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#quoting-guideline" > 10.2.4. Quoting guideline< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#bsd-make-bug-workaround" > 10.2.5. Workaround for a bug in BSD Make< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< / dl >
< / div >
2006-05-29 10:55:59 +02:00
< p > Pkgsrc consists of many < code class = "filename" > Makefile< / code > fragments,
2006-05-28 22:41:22 +02:00
each of which forms a well-defined part of the pkgsrc system. Using
the < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > make< / span > (1)< / span > < / a > system as a programming language for a big system
like pkgsrc requires some discipline to keep the code correct and
understandable.< / p >
2006-05-29 10:55:59 +02:00
< p > The basic ingredients for < code class = "filename" > Makefile< / code >
2006-05-28 22:41:22 +02:00
programming are variables (which are actually macros) and shell
commands. Among these shell commands may even be more complex ones
like < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > awk< / span > (1)< / span > < / a > programs. To make sure that every shell command runs
as intended it is necessary to quote all variables correctly when they
are used.< / p >
< p > This chapter describes some patterns, that appear quite often in
2006-05-29 10:55:59 +02:00
< code class = "filename" > Makefile< / code > s, including the pitfalls that come along
2006-05-28 22:41:22 +02:00
with them.< / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "makefile.variables" > < / a > 10.1.<2E> < code class = "filename" > Makefile< / code > variables< / h2 > < / div > < / div > < / div >
2006-05-29 10:55:59 +02:00
< p > < code class = "filename" > Makefile< / code > variables contain strings that
2006-05-28 22:41:22 +02:00
can be processed using the five operators ``='', ``+='', ``?='',
``:='', and ``!='', which are described in the < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > make< / span > (1)< / span > < / a > man
page.< / p >
< p > When a variable's value is parsed from a
2006-05-29 10:55:59 +02:00
< code class = "filename" > Makefile< / code > , the hash character ``#'' and the
2006-05-28 22:41:22 +02:00
backslash character ``\'' are handled specially. If a backslash is
followed by a newline, any whitespace immediately in front of the
backslash, the backslash, the newline, and any whitespace
immediately behind the newline are replaced with a single space. A
backslash character and an immediately following hash character are
replaced with a single hash character. Otherwise, the backslash is
passed as is. In a variable assignment, any hash character that is
not preceded by a backslash starts a comment that continues upto the
end of the logical line.< / p >
< p > < span class = "emphasis" > < em > Note:< / em > < / span > Because of this parsing algorithm
the only way to create a variable consisting of a single backslash
is using the ``!='' operator, for example: < code class = "varname" > BACKSLASH!=echo "\\"< / code > .< / p >
< p > So far for defining variables. The other thing you can do with
variables is evaluating them. A variable is evaluated when it is
part of the right side of the ``:='' or the ``!='' operator, or
directly before executing a shell command which the variable is part
of. In all other cases, < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > make< / span > (1)< / span > < / a > performs lazy evaluation, that
is, variables are not evaluated until there's no other way. The
``modifiers'' mentioned in the man page also evaluate the
variable.< / p >
< p > Some of the modifiers split the string into words and then
operate on the words, others operate on the string as a whole. When
a string is split into words, it is split as you would expect
it from < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > sh< / span > (1)< / span > < / a > .< / p >
< p > No rule without exception— the < span > < strong class = "command" > .for< / strong > < / span >
loop does not follow the shell quoting rules but splits at sequences
of whitespace.< / p >
< p > There are several types of variables that should be handled
differently. Strings and two types of lists.< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < span class = "emphasis" > < em > Strings< / em > < / span > can contain arbitrary
characters. Nevertheless, you should restrict yourself to only
using printable characters. Examples are
< code class = "varname" > PREFIX< / code > and
< code class = "varname" > COMMENT< / code > .< / p > < / li >
< li > < p > < span class = "emphasis" > < em > Internal lists< / em > < / span > are lists that
are never exported to any shell command. Their elements are
separated by whitespace. Therefore, the elements themselves cannot
have embedded whitespace. Any other characters are allowed.
Internal lists can be used in < span > < strong class = "command" > .for< / strong > < / span > loops.
Examples are < code class = "varname" > DEPENDS< / code > and
< code class = "varname" > BUILD_DEPENDS< / code > .< / p > < / li >
< li > < p > < span class = "emphasis" > < em > External lists< / em > < / span > are lists that
may be exported to a shell command. Their elements can contain any
characters, including whitespace. That's why they cannot be used
in < span > < strong class = "command" > .for< / strong > < / span > loops. Examples are
< code class = "varname" > DISTFILES< / code > and
< code class = "varname" > MASTER_SITES< / code > .< / p > < / li >
< / ul > < / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "makefile.variables.names" > < / a > 10.1.1.<2E> Naming conventions< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > All variable names starting with an underscore
are reserved for use by the pkgsrc infrastructure. They shall
not be used by package
2006-05-29 10:55:59 +02:00
< code class = "filename" > Makefile< / code > s.< / p > < / li >
2006-05-28 22:41:22 +02:00
< li > < p > In < span > < strong class = "command" > .for< / strong > < / span > loops you should use
lowercase variable names for the iteration
variables.< / p > < / li >
< li > < p > All list variables should have a ``plural''
name, e.g. < code class = "varname" > PKG_OPTIONS< / code > or
< code class = "varname" > DISTFILES< / code > .< / p > < / li >
< / ul > < / div >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "makefile.code" > < / a > 10.2.<2E> Code snippets< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > This section presents you with some code snippets you should
use in your own code. If you don't find anything appropriate here,
you should test your code and add it here.< / p >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "adding-to-list" > < / a > 10.2.1.<2E> Adding things to a list< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
STRING= foo * bar `date`
INT_LIST= # empty
ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
EXT_LIST= # empty
ANOTHER_EXT_LIST= a=b c=d
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
INT_LIST+= ${STRING} # 1
INT_LIST+= ${ANOTHER_INT_LIST} # 2
EXT_LIST+= ${STRING:Q} # 3
EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > When you add a string to an external list (example 3), it
must be quoted. In all other cases, you must not add a quoting
level. You must not merge internal and external lists, unless you
are sure that all entries are correctly interpreted in both
lists.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "converting-internal-to-external" > < / a > 10.2.2.<2E> Converting an internal list into an external list< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
EXT_LIST= # empty
.for i in ${INT_LIST}
EXT_LIST+= ${i:Q}""
.endfor
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > This code converts the internal list
< code class = "varname" > INT_LIST< / code > into the external list
< code class = "varname" > EXT_LIST< / code > . As the elements of an internal list
are unquoted they must be quoted here. The reason for appending
< code class = "varname" > ""< / code > is explained below.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "passing-variable-to-shell" > < / a > 10.2.3.<2E> Passing variables to a shell command< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
STRING= foo bar < > * `date` $$HOME ' "
EXT_LIST= string=${STRING:Q} x=second\ item
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
all:
echo ${STRING} # 1
echo "${STRING}" # 2
echo "${STRING:Q}" # 3
echo ${STRING:Q} # 4
echo x${STRING:Q} | sed 1s,.,, # 5
env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
< / pre >
< p > Example 1 leads to a syntax error in the shell, as the
characters are just copied.< / p >
< p > Example 2 leads to a syntax error too, and if you leave out
the last " character from < code class = "varname" > ${STRING}< / code > ,
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > date< / span > (1)< / span > < / a > will be executed. The < code class = "varname" > $HOME< / code > shell
variable would be evaluated, too.< / p >
< p > Example 3 outputs each space character preceded by a
backslash (or not), depending on the implementation of the
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > echo< / span > (1)< / span > < / a > command.< / p >
< p > Example 4 handles correctly every string that does not start
with a dash. In that case, the result depends on the
implementation of the < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > echo< / span > (1)< / span > < / a > command. As long as you can
guarantee that your input does not start with a dash, this form is
appropriate.< / p >
< p > Example 5 handles even the case of a leading dash
correctly.< / p >
< p > The < code class = "varname" > EXT_LIST< / code > does not need to be quoted
because the quoting has already been done when adding elements to
the list.< / p >
< p > As internal lists shall not be passed to the shell, there is
no example for it.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "quoting-guideline" > < / a > 10.2.4.<2E> Quoting guideline< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > There are many possible sources of wrongly quoted variables.
This section lists some of the commonly known ones.< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li >
< p > Whenever you use the value of a list, think
about what happens to leading or trailing whitespace. If the
list is a well-formed shell expression, you can apply the
< code class = "varname" > :M*< / code > modifier to strip leading and trailing
whitespace from each word. The < code class = "varname" > :M< / code > operator
first splits its argument according to the rules of the shell,
and then creates a new list consisting of all words that match
the shell glob expression < code class = "varname" > *< / code > , that is: all.
One class of situations where this is needed is when adding a
variable like < code class = "varname" > CPPFLAGS< / code > to
< code class = "varname" > CONFIGURE_ARGS< / code > . If the configure script
invokes other configure scripts, it strips the leading and
trailing whitespace from the variable and then passes it to the
other configure scripts. But these configure scripts expect the
(child) < code class = "varname" > CPPFLAGS< / code > variable to be the same as
the parent < code class = "varname" > CPPFLAGS< / code > . That's why we better
pass the < code class = "varname" > CPPFLAGS< / code > value properly trimmed. And
here is how we do it:< / p >
< pre class = "programlisting" >
CPPFLAGS= # empty
CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
CPPFLAGS+= ${MY_CPPFLAGS}
2005-11-03 03:55:51 +01:00
2006-05-28 22:41:22 +02:00
CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
all:
echo x${CPPFLAGS:Q}x # leading and trailing whitespace
echo x${CONFIGURE_ARGS}x # properly trimmed
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< / li >
< li > < p > The example above contains one bug: The
< code class = "varname" > ${PREFIX}< / code > is a properly quoted shell
expression, but there is the C compiler after it, which also
expects a properly quoted string (this time in C syntax). The
version above is therefore only correct if
< code class = "varname" > ${PREFIX}< / code > does not have embedded backslashes
or double quotes. If you want to allow these, you have to add
another layer of quoting to each variable that is used as a C
string literal. You cannot use the < code class = "varname" > :Q< / code >
operator for it, as this operator only works for the
shell.< / p > < / li >
< li >
< p > Whenever a variable can be empty, the
< code class = "varname" > :Q< / code > operator can have surprising results. Here
are two completely different cases which can be solved with the
same trick.< / p >
< pre class = "programlisting" >
EMPTY= # empty
empty_test:
for i in a ${EMPTY:Q} c; do \
echo "$$i"; \
done
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
for_test:
.for i in a:\ a:\test.txt
echo ${i:Q}
echo "foo"
.endfor
2005-11-03 03:55:51 +01:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > The first example will only print two of the three lines
we might have expected. This is because
< code class = "varname" > ${EMPTY:Q}< / code > expands to the empty string, which
the shell cannot see. The workaround is to write
< code class = "varname" > ${EMPTY:Q}""< / code > . This pattern can be often found
as < code class = "varname" > ${TEST} -z ${VAR:Q}< / code > or as < code class = "varname" > ${TEST}
-f ${FNAME:Q}< / code > (both of these are wrong).< / p >
< p > The second example will only print three lines instead of
four. The first line looks like < code class = "varname" > a:\ echo foo< / code > .
This is because the backslash of the value
< code class = "varname" > a:\< / code > is interpreted as a line-continuation by
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > make< / span > (1)< / span > < / a > , which makes the second line the arguments of the
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > echo< / span > (1)< / span > < / a > command from the first line. To avoid this, write
< code class = "varname" > ${i:Q}""< / code > .< / p >
< / li >
< / ul > < / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "bsd-make-bug-workaround" > < / a > 10.2.5.<2E> Workaround for a bug in BSD Make< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > The pkgsrc bmake program does not handle the following
assignment correctly. In case < code class = "varname" > _othervar_< / code >
contains a ``-'' character, one of the closing braces is included
in < code class = "varname" > ${VAR}< / code > after this code executes.< / p >
< pre class = "programlisting" >
VAR:= ${VAR:N${_othervar_:C/-//}}
2005-11-03 03:55:51 +01:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > For a more complex code snippet and a workaround, see the
2006-05-29 10:55:59 +02:00
package < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/regress/make-quoting/README.html" target = "_top" > < code class = "filename" > regress/make-quoting< / code > < / a > , testcase
2006-05-28 22:41:22 +02:00
< code class = "varname" > bug1< / code > .< / p >
< / div >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "plist" > < / a > Chapter<EFBFBD> 11.<2E> PLIST issues< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#rcs-id" > 11.1. RCS ID< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#automatic-plist-generation" > 11.2. Semi-automatic < code class = "filename" > PLIST< / code > generation< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#print-PLIST" > 11.3. Tweaking output of < span > < strong class = "command" > make print-PLIST< / strong > < / span > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#plist.misc" > 11.4. Variable substitution in PLIST< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#manpage-compression" > 11.5. Man page compression< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#using-PLIST_SRC" > 11.6. Changing PLIST source with < code class = "varname" > PLIST_SRC< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#platform-specific-plist" > 11.7. Platform-specific and differing PLISTs< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#faq.common-dirs" > 11.8. Sharing directories between packages< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl >
< / div >
2006-05-29 10:55:59 +02:00
< p > The < code class = "filename" > PLIST< / code > file contains a package's
2006-05-28 22:41:22 +02:00
“ < span class = "quote" > packing list< / span > ” , i.e. a list of files that belong to
2006-05-29 10:55:59 +02:00
the package (relative to the < code class = "filename" > ${PREFIX}< / code >
2006-05-28 22:41:22 +02:00
directory it's been installed in) plus some additional statements
- see the < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_create< / span > (1)< / span > < / a > man page for a full list.
This chapter addresses some issues that need attention when
2006-05-29 10:55:59 +02:00
dealing with the < code class = "filename" > PLIST< / code > file (or files, see
2006-05-28 22:41:22 +02:00
below!).< / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "rcs-id" > < / a > 11.1.<2E> RCS ID< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p >
Be sure to add a RCS ID line as the first thing in any
2006-05-29 10:55:59 +02:00
< code class = "filename" > PLIST< / code > file you write:
2006-05-28 22:41:22 +02:00
< / p >
< pre class = "programlisting" >
@comment $NetBSD$
2005-11-03 03:55:51 +01:00
< / pre >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "automatic-plist-generation" > < / a > 11.2.<2E> Semi-automatic < code class = "filename" > PLIST< / code > generation< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > You can use the < span > < strong class = "command" > make print-PLIST< / strong > < / span > command
to output a PLIST that matches any new files since the package
2006-06-01 11:36:55 +02:00
was extracted. See < a href = "#build.helpful-targets" title = "15.16.<2E> Other helpful targets" > Section<EFBFBD> 15.16, “ Other helpful targets” < / a > for
2006-05-28 22:41:22 +02:00
more information on this target.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "print-PLIST" > < / a > 11.3.<2E> Tweaking output of < span > < strong class = "command" > make print-PLIST< / strong > < / span > < / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > If you have used any of the *-dirs packages, as explained in
2006-06-01 11:36:55 +02:00
< a href = "#faq.common-dirs" title = "11.8.<2E> Sharing directories between packages" > Section<EFBFBD> 11.8, “ Sharing directories between packages” < / a > , you may have noticed that
2006-05-28 22:41:22 +02:00
< span > < strong class = "command" > make print-PLIST< / strong > < / span > outputs a set of
< code class = "varname" > @comment< / code > s instead of real
< code class = "varname" > @dirrm< / code > lines. You can also do this for
specific directories and files, so that the results of that
command are very close to reality. This helps < span class = "emphasis" > < em > a
lot< / em > < / span > during the update of packages. < / p >
< p > The < code class = "varname" > PRINT_PLIST_AWK< / code > variable takes a set
of AWK patterns and actions that are used to filter the output of
print-PLIST. You can < span class = "emphasis" > < em > append< / em > < / span > any chunk of AWK
scripting you like to it, but be careful with quoting. < / p >
< p > For example, to get all files inside the
2006-05-29 10:55:59 +02:00
< code class = "filename" > libdata/foo< / code > directory removed from the
2006-05-28 22:41:22 +02:00
resulting PLIST:< / p >
< pre class = "programlisting" >
PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
2005-10-23 13:33:53 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > And to get all the < code class = "varname" > @dirrm< / code > lines referring
to a specific (shared) directory converted to
< code class = "varname" > @comment< / code > s: < / p >
< pre class = "programlisting" >
PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "plist.misc" > < / a > 11.4.<2E> Variable substitution in PLIST< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p >
A number of variables are substituted automatically in PLISTs
when a package is installed on a system. This includes the
following variables: < / p >
< div class = "variablelist" > < dl >
< dt > < span class = "term" > < code class = "varname" > ${MACHINE_ARCH}< / code > , < code class = "varname" > ${MACHINE_GNU_ARCH}< / code > < / span > < / dt >
< dd >
< p > Some packages like emacs and perl embed information
about which architecture they were built on into the
pathnames where they install their files. To handle this
case, PLIST will be preprocessed before actually used, and
the symbol
“ < span class = "quote" > < code class = "varname" > ${MACHINE_ARCH}< / code > < / span > ” will be
replaced by what < span > < strong class = "command" > uname -p< / strong > < / span > gives. The
same is done if the string
< code class = "varname" > ${MACHINE_GNU_ARCH}< / code > is embedded in
PLIST somewhere - use this on packages that have GNU
autoconf-created configure scripts.< / p >
< div class = "note" style = "margin-left: 0.5in; margin-right: 0.5in;" >
< h3 class = "title" > Legacy note< / h3 >
< p > There used to be a symbol
“ < span class = "quote" > < code class = "varname" > $ARCH< / code > < / span > ” that
was replaced by the output of < span > < strong class = "command" > uname
-m< / strong > < / span > , but that's no longer supported and has
been removed.< / p >
< / div >
< / dd >
< dt > < span class = "term" > < code class = "varname" > ${OPSYS}< / code > , < code class = "varname" > ${LOWER_OPSYS}< / code > , < code class = "varname" > ${OS_VERSION}< / code > < / span > < / dt >
< dd >
< p > Some packages want to embed the OS name and version
into some paths. To do this, use these variables in the
2006-05-29 10:55:59 +02:00
< code class = "filename" > PLIST< / code > :
2006-05-28 22:41:22 +02:00
< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < code class = "varname" > ${OPSYS}< / code > - output of “ < span class = "quote" > < span > < strong class = "command" > uname -s< / strong > < / span > < / span > ” < / p > < / li >
< li > < p > < code class = "varname" > ${LOWER_OPSYS}< / code > - lowercase common name (eg. “ < span class = "quote" > solaris< / span > ” )< / p > < / li >
< li > < p > < code class = "varname" > ${OS_VERSION}< / code > - “ < span class = "quote" > < span > < strong class = "command" > uname -r< / strong > < / span > < / span > ” < / p > < / li >
< / ul > < / div >
< / dd >
< / dl > < / div >
< p > For a complete list of values which are replaced by
2006-05-29 10:55:59 +02:00
default, please look in < code class = "filename" > bsd.pkg.mk< / code > (and
2006-05-28 22:41:22 +02:00
search for < span class = "emphasis" > < em > PLIST_SUBST< / em > < / span > ). < / p >
< p > If you want to change other variables not listed above, you
can add variables and their expansions to this variable in the
2006-06-01 11:36:55 +02:00
following way, similar to < code class = "varname" > MESSAGE_SUBST< / code > (see < a href = "#components.optional" title = "9.5.<2E> Optional files" > Section<EFBFBD> 9.5, “ Optional files” < / a > ): < / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
PLIST_SUBST+= SOMEVAR="somevalue"
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > This replaces all occurrences of “ < span class = "quote" > ${SOMEVAR}< / span > ”
in the PLIST with “ < span class = "quote" > somevalue< / span > ” . < / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "manpage-compression" > < / a > 11.5.<2E> Man page compression< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Man pages should be installed in compressed form if
2006-05-29 10:55:59 +02:00
< code class = "varname" > MANZ< / code > is set (in < code class = "filename" > bsd.own.mk< / code > ),
2006-05-28 22:41:22 +02:00
and uncompressed otherwise. To handle this in the
2006-05-29 10:55:59 +02:00
< code class = "filename" > PLIST< / code > file, the suffix “ < span class = "quote" > .gz< / span > ” is
2006-05-28 22:41:22 +02:00
appended/removed automatically for man pages according to
< code class = "varname" > MANZ< / code > and < code class = "varname" > MANCOMPRESSED< / code > being set
or not, see above for details. This modification of the
2006-05-29 10:55:59 +02:00
< code class = "filename" > PLIST< / code > file is done on a copy of it, not
< code class = "filename" > PLIST< / code > itself.< / p >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "using-PLIST_SRC" > < / a > 11.6.<2E> Changing PLIST source with < code class = "varname" > PLIST_SRC< / code > < / h2 > < / div > < / div > < / div >
2006-05-29 10:55:59 +02:00
< p > To use one or more files as source for the < code class = "filename" > PLIST< / code > used
2006-05-28 22:41:22 +02:00
in generating the binary package, set the variable
< code class = "varname" > PLIST_SRC< / code > to the names of that file(s).
The files are later concatenated using < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > cat< / span > (1)< / span > < / a > , and order of things is
important.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "platform-specific-plist" > < / a > 11.7.<2E> Platform-specific and differing PLISTs< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Some packages decide to install a different set of files based on
the operating system being used. These differences can be
automatically handled by using the following files:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
2006-05-29 10:55:59 +02:00
< li > < p > < code class = "filename" > PLIST.common< / code > < / p > < / li >
< li > < p > < code class = "filename" > PLIST.${OPSYS}< / code > < / p > < / li >
< li > < p > < code class = "filename" > PLIST.${MACHINE_ARCH}< / code > < / p > < / li >
< li > < p > < code class = "filename" > PLIST.${OPSYS}-${MACHINE_ARCH}< / code > < / p > < / li >
< li > < p > < code class = "filename" > PLIST.common_end< / code > < / p > < / li >
2006-05-28 22:41:22 +02:00
< / ul > < / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "faq.common-dirs" > < / a > 11.8.<2E> Sharing directories between packages< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > A “ < span class = "quote" > shared directory< / span > ” is a directory where
multiple (and unrelated) packages install files. These
directories are problematic because you have to add special tricks
in the PLIST to conditionally remove them, or have some
centralized package handle them. < / p >
< p > Within pkgsrc, you'll find both approaches. If a directory
is shared by a few unrelated packages, it's often not worth to add
an extra package to remove it. Therefore, one simply does:
< / p >
< pre class = "programlisting" >
@unexec ${RMDIR} %D/path/to/shared/directory 2> /dev/null || ${TRUE}
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > in the PLISTs of all affected packages, instead of the
regular "@dirrm" line. < / p >
< p > However, if the directory is shared across many packages, two
different solutions are available: < / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > If the packages have a common dependency, the directory
can be removed in that. For example, see
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/textproc/scrollkeeper/README.html" target = "_top" > < code class = "filename" > textproc/scrollkeeper< / code > < / a > , which
2006-05-28 22:41:22 +02:00
removes the shared directory
2006-05-29 10:55:59 +02:00
< code class = "filename" > share/omf< / code > . < / p > < / li >
2006-05-28 22:41:22 +02:00
< li > < p > If the packages using the directory are not related at
all (they have no common dependencies), a *-dirs package is
used. < / p > < / li >
< / ol > < / div >
< p > From now on, we'll discuss the second solution. To get an
idea of the *-dirs packages available, issue: < / p >
< pre class = "programlisting" >
< code class = "prompt" > %< / code > cd .../pkgsrc
< code class = "prompt" > %< / code > ls -d */*-dirs
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > Their use from other packages is very simple. The
< code class = "varname" > USE_DIRS< / code > variable takes a list of package names
(without the “ < span class = "quote" > -dirs< / span > ” part) together with the required
version number (always pick the latest one when writing new
packages). < / p >
< p > For example, if a package installs files under
2006-05-29 10:55:59 +02:00
< code class = "filename" > share/applications< / code > , it should have the
2006-05-28 22:41:22 +02:00
following line in it:
< / p >
< pre class = "programlisting" >
USE_DIRS+= xdg-1.1
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > After regenerating the PLIST using < span > < strong class = "command" > make
print-PLIST< / strong > < / span > , you should get the right (commented out)
lines. < / p >
< p > Note that even if your package is using
2006-05-29 10:55:59 +02:00
< code class = "filename" > $X11BASE< / code > , it must not depend on the
2006-05-28 22:41:22 +02:00
*-x11-dirs packages. Just specify the name without that part and
2006-05-29 10:55:59 +02:00
pkgsrc (in particular, < code class = "filename" > mk/dirs.mk< / code > ) will take
2006-05-28 22:41:22 +02:00
care of it. < / p >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "buildlink" > < / a > Chapter<EFBFBD> 12.<2E> Buildlink methodology< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#converting-to-buildlink3" > 12.1. Converting packages to use buildlink3< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#creating-buildlink3.mk" > 12.2. Writing < code class = "filename" > buildlink3.mk< / code > files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#anatomy-of-bl3" > 12.2.1. Anatomy of a buildlink3.mk file< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#updating-buildlink-depends" > 12.2.2. Updating < code class = "varname" > BUILDLINK_API_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code > in < code class = "filename" > buildlink3.mk< / code > files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#writing-builtin.mk" > 12.3. Writing < code class = "filename" > builtin.mk< / code > files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#anatomy-of-builtin.mk" > 12.3.1. Anatomy of a < code class = "filename" > builtin.mk< / code > file< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#native-or-pkgsrc-preference" > 12.3.2. Global preferences for native or pkgsrc software< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< / dl >
< / div >
< p > Buildlink is a framework in pkgsrc that controls what headers and libraries
are seen by a package's configure and build processes. This is implemented
in a two step process:< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > Symlink headers and libraries for dependencies into
< code class = "varname" > BUILDLINK_DIR< / code > , which by default is a subdirectory
of < code class = "varname" > WRKDIR< / code > .< / p > < / li >
< li > < p > Create wrapper scripts that are used in place of the normal compiler
tools that translate < code class = "option" > -I${LOCALBASE}/include< / code > and
< code class = "option" > -L${LOCALBASE}/lib< / code > into references to
< code class = "varname" > BUILDLINK_DIR< / code > . The wrapper scripts also make
native compiler on some operating systems look like GCC, so that
packages that expect GCC won't require modifications to build with
those native compilers.< / p > < / li >
< / ol > < / div >
< p > This normalizes the environment in which a package is built so that the
package may be built consistently despite what other software may be
installed. Please note that the normal system header and library paths,
2006-05-29 10:55:59 +02:00
e.g. < code class = "filename" > /usr/include< / code > ,
< code class = "filename" > /usr/lib< / code > , etc., are always searched -- buildlink3 is
2006-05-28 22:41:22 +02:00
designed to insulate the package build from non-system-supplied
software. < / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "converting-to-buildlink3" > < / a > 12.1.<2E> Converting packages to use buildlink3< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > The process of converting packages to use the buildlink3
framework (“ < span class = "quote" > bl3ifying< / span > ” ) is fairly straightforward.
The things to keep in mind are:< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > Ensure that the build always calls the wrapper scripts
instead of the actual toolchain. Some packages are tricky,
and the only way to know for sure is the check
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${WRKDIR}/.work.log< / code > to see if the
2006-05-28 22:41:22 +02:00
wrappers are being invoked. < / p > < / li >
< li > < p > Don't override < code class = "varname" > PREFIX< / code > from within
the package Makefile, e.g. Java VMs, standalone shells,
etc., because the code to symlink files into
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${BUILDLINK_DIR}< / code > looks for files
2006-05-28 22:41:22 +02:00
relative to “ < span class = "quote" > pkg_info -qp < em class = "replaceable" > < code > pkgname< / code > < / em > < / span > ” .
< / p > < / li >
< li > < p > Remember that < span class = "emphasis" > < em > only< / em > < / span > the
2006-05-29 10:55:59 +02:00
< code class = "filename" > buildlink3.mk< / code > files that you list in a
2006-05-28 22:41:22 +02:00
package's Makefile are added as dependencies for that package.
< / p > < / li >
< / ol > < / div >
< p > If a dependency on a particular package is required for its libraries and
headers, then we replace: < / p >
< pre class = "programlisting" >
DEPENDS+= foo> =1.1.0:../../category/foo
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > with< / p >
< pre class = "programlisting" >
.include "../../category/foo/buildlink3.mk"
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > The buildlink3.mk files usually define the required dependencies.
If you need a newer version of the dependency when using buildlink3.mk
files, then you can define it in your Makefile; for example:
< / p >
< pre class = "programlisting" >
BUILDLINK_API_DEPENDS.foo+= foo> =1.1.0
.include "../../category/foo/buildlink3.mk"
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-29 10:55:59 +02:00
< p > There are several < code class = "filename" > buildlink3.mk< / code >
files in < code class = "filename" > pkgsrc/mk< / code >
2006-05-28 22:41:22 +02:00
that handle special package issues:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
2006-05-29 10:55:59 +02:00
< li > < p > < code class = "filename" > bdb.buildlink3.mk< / code > chooses either
2006-05-28 22:41:22 +02:00
the native or a pkgsrc Berkeley DB implementation based on
the values of < code class = "varname" > BDB_ACCEPTED< / code > and
< code class = "varname" > BDB_DEFAULT< / code > .< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < code class = "filename" > curses.buildlink3.mk< / code > : If the system
2006-05-28 22:41:22 +02:00
comes with neither Curses nor NCurses, this will take care
2006-05-29 10:55:59 +02:00
to install the < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/devel/ncurses/README.html" target = "_top" > < code class = "filename" > devel/ncurses< / code > < / a > package.< / p > < / li >
< li > < p > < code class = "filename" > krb5.buildlink3.mk< / code > uses the value
2006-05-28 22:41:22 +02:00
of < code class = "varname" > KRB5_ACCEPTED< / code > to choose between
adding a dependency on Heimdal or MIT-krb5 for packages that
require a Kerberos 5 implementation.< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < code class = "filename" > motif.buildlink3.mk< / code > checks
2006-05-28 22:41:22 +02:00
for a system-provided
2006-05-29 10:55:59 +02:00
Motif installation or adds a dependency on < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/x11/lesstif/README.html" target = "_top" > < code class = "filename" > x11/lesstif< / code > < / a > or
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/x11/openmotif/README.html" target = "_top" > < code class = "filename" > x11/openmotif< / code > < / a > .< / p > < / li >
< li > < p > < code class = "filename" > oss.buildlink3.mk< / code > defines several
2006-05-28 22:41:22 +02:00
variables that may be used by packages that use the
Open Sound System (OSS) API.< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < code class = "filename" > pgsql.buildlink3.mk< / code > will accept
2006-05-28 22:41:22 +02:00
either Postgres 7.3 or 7.4, whichever is found installed. See
the file for more information. < / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > < code class = "filename" > pthread.buildlink3.mk< / code > uses the value of
2006-05-28 22:41:22 +02:00
< code class = "varname" > PTHREAD_OPTS< / code > and checks for native pthreads or adds
2006-05-29 10:55:59 +02:00
a dependency on < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/devel/pth/README.html" target = "_top" > < code class = "filename" > devel/pth< / code > < / a > as needed.< / p > < / li >
< li > < p > < code class = "filename" > xaw.buildlink3.mk< / code > uses the value of
2006-05-28 22:41:22 +02:00
< code class = "varname" > XAW_TYPE< / code > to choose a particular Athena widgets
library.< / p > < / li >
< / ul > < / div >
2006-05-29 10:55:59 +02:00
< p > The comments in those < code class = "filename" > buildlink3.mk< / code >
2006-05-28 22:41:22 +02:00
files provide a more complete
description of how to use them properly.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "creating-buildlink3.mk" > < / a > 12.2.<2E> Writing < code class = "filename" > buildlink3.mk< / code > files< / h2 > < / div > < / div > < / div >
2006-05-29 10:55:59 +02:00
< p > A package's < code class = "filename" > buildlink3.mk< / code > file is
2006-05-28 22:41:22 +02:00
included by Makefiles to indicate the need to compile and link
against header files and libraries provided by the package. A
2006-05-29 10:55:59 +02:00
< code class = "filename" > buildlink3.mk< / code > file should always provide
2006-05-28 22:41:22 +02:00
enough information to add the correct type of dependency
relationship and include any other
2006-05-29 10:55:59 +02:00
< code class = "filename" > buildlink3.mk< / code > files that it needs to find
2006-05-28 22:41:22 +02:00
headers and libraries that it needs in turn.< / p >
2006-05-29 10:55:59 +02:00
< p > To generate an initial < code class = "filename" > buildlink3.mk< / code >
file for further editing, Rene Hexel's < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/createbuildlink/README.html" target = "_top" > < code class = "filename" > pkgtools/createbuildlink< / code > < / a >
2006-05-28 22:41:22 +02:00
package is highly recommended. For most packages, the following
command will generate a good starting point for
2006-05-29 10:55:59 +02:00
< code class = "filename" > buildlink3.mk< / code > files:< / p >
2006-05-28 22:41:22 +02:00
< pre class = "screen" > < code class = "prompt" > %< / code > < strong class = "userinput" > < code > cd pkgsrc/< em class = "replaceable" > < code > category< / code > < / em > /< em class = "replaceable" > < code > pkgdir< / code > < / em >
< code class = "prompt" > %< / code > createbuildlink > buildlink3.mk< / code > < / strong > < / pre >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "anatomy-of-bl3" > < / a > 12.2.1.<2E> Anatomy of a buildlink3.mk file< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > The following real-life example
2006-05-29 10:55:59 +02:00
< code class = "filename" > buildlink3.mk< / code > is taken
from < code class = "filename" > pkgsrc/graphics/tiff< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
# $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
.if !empty(BUILDLINK_DEPTH:M+)
BUILDLINK_DEPENDS+= tiff
.endif
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
BUILDLINK_PACKAGES+= tiff
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
.if !empty(TIFF_BUILDLINK3_MK:M+)
BUILDLINK_API_DEPENDS.tiff+= tiff> =3.6.1
BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
.endif # TIFF_BUILDLINK3_MK
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
.include "../../devel/zlib/buildlink3.mk"
.include "../../graphics/jpeg/buildlink3.mk"
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
2005-01-11 16:48:17 +01:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > The header and footer manipulate
< code class = "varname" > BUILDLINK_DEPTH< / code > , which is common across all
2006-05-29 10:55:59 +02:00
< code class = "filename" > buildlink3.mk< / code > files and is used to track
2006-05-28 22:41:22 +02:00
at what depth we are including
2006-05-29 10:55:59 +02:00
< code class = "filename" > buildlink3.mk< / code > files.< / p >
2006-05-28 22:41:22 +02:00
< p > The first section controls if the dependency on
< em class = "replaceable" > < code > pkg< / code > < / em > is added.
< code class = "varname" > BUILDLINK_DEPENDS< / code > is the global list of
packages for which dependencies are added by
buildlink3.< / p >
< p > The second section advises pkgsrc that the
2006-05-29 10:55:59 +02:00
< code class = "filename" > buildlink3.mk< / code > file for
2006-05-28 22:41:22 +02:00
< em class = "replaceable" > < code > pkg< / code > < / em > has been included at some point.
< code class = "varname" > BUILDLINK_PACKAGES< / code > is the global list of
2006-05-29 10:55:59 +02:00
packages for which < code class = "filename" > buildlink3.mk< / code > files
2006-05-28 22:41:22 +02:00
have been included. It must < span class = "emphasis" > < em > always< / em > < / span > be
2006-05-29 10:55:59 +02:00
appended to within a < code class = "filename" > buildlink3.mk< / code >
2006-05-28 22:41:22 +02:00
file. < / p >
< p > The third section is protected from multiple inclusion
and controls how the dependency on < em class = "replaceable" > < code > pkg< / code > < / em > is
added. Several important variables are set in the section:
< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < code class = "varname" > BUILDLINK_API_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
is the actual dependency recorded in the installed
package; this should always be set using
< span > < strong class = "command" > +=< / strong > < / span > to ensure that
we're appending to any pre-existing list of values. This
variable should be set to the first version of the
package that had an API change.
< / p > < / li >
< li > < p > < code class = "varname" > BUILDLINK_PKGSRCDIR.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
is the location of the < em class = "replaceable" > < code > pkg< / code > < / em >
pkgsrc directory.< / p > < / li >
< li > < p >
< code class = "varname" > BUILDLINK_DEPMETHOD.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
(not shown above) controls whether we use
< code class = "varname" > BUILD_DEPENDS< / code > or
< code class = "varname" > DEPENDS< / code > to add the dependency on
< em class = "replaceable" > < code > pkg< / code > < / em > .
The build dependency is selected by setting
< code class = "varname" > BUILDLINK_DEPMETHOD.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
to “ < span class = "quote" > build< / span > ” . By default, the
full dependency is used.
< / p > < / li >
< li > < p >
< code class = "varname" > BUILDLINK_INCDIRS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
and
< code class = "varname" > BUILDLINK_LIBDIRS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
(not shown above) are lists of subdirectories of
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${BUILDLINK_PREFIX.< em class = "replaceable" > < code > pkg< / code > < / em > }< / code >
2006-05-28 22:41:22 +02:00
to add to the header and library search paths. These
default to “ < span class = "quote" > include< / span > ” and “ < span class = "quote" > lib< / span > ”
respectively. < / p > < / li >
< li > < p >
< code class = "varname" > BUILDLINK_CPPFLAGS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
(not shown above) is the list of preprocessor flags to add
to < code class = "varname" > CPPFLAGS< / code > , which are passed on to the
configure and build phases. The “ < span class = "quote" > -I< / span > ” option
should be avoided and instead be handled using
< code class = "varname" > BUILDLINK_INCDIRS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code > as
above.< / p > < / li >
< / ul > < / div >
< p > The following variables are all optionally defined within
this second section (protected against multiple inclusion) and
control which package files are symlinked into
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${BUILDLINK_DIR}< / code > and how their names are
2006-05-28 22:41:22 +02:00
transformed during the symlinking: < / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p >
< code class = "varname" > BUILDLINK_FILES.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
(not shown above) is a shell glob pattern relative to
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${BUILDLINK_PREFIX.< em class = "replaceable" > < code > pkg< / code > < / em > }< / code >
2006-05-28 22:41:22 +02:00
to be symlinked into
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${BUILDLINK_DIR}< / code > ,
e.g. < code class = "filename" > include/*.h< / code > . < / p > < / li >
2006-05-28 22:41:22 +02:00
< li > < p >
< code class = "varname" > BUILDLINK_FILES_CMD.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
(not shown above) is a shell pipeline that
outputs to stdout a list of files relative to
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${BUILDLINK_PREFIX.< em class = "replaceable" > < code > pkg< / code > < / em > }< / code > .
2006-05-28 22:41:22 +02:00
The resulting files are to be symlinked
2006-05-29 10:55:59 +02:00
into < code class = "filename" > ${BUILDLINK_DIR}< / code > . By default,
this takes the < code class = "filename" > +CONTENTS< / code > of a
2006-05-28 22:41:22 +02:00
< em class = "replaceable" > < code > pkg< / code > < / em > and filters it through
< code class = "varname" > ${BUILDLINK_CONTENTS_FILTER.< em class = "replaceable" > < code > pkg< / code > < / em > }< / code > .
< / p > < / li >
< li > < p >
< code class = "varname" > BUILDLINK_CONTENTS_FILTER.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
(not shown above) is a filter command that filters
2006-05-29 10:55:59 +02:00
< code class = "filename" > +CONTENTS< / code > input into a list of files
2006-05-28 22:41:22 +02:00
relative to
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${BUILDLINK_PREFIX.< em class = "replaceable" > < code > pkg< / code > < / em > }< / code >
2006-05-28 22:41:22 +02:00
on stdout. By default for overwrite packages,
< code class = "varname" > BUILDLINK_CONTENTS_FILTER.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
2006-05-29 10:55:59 +02:00
outputs the contents of the < code class = "filename" > include< / code >
and < code class = "filename" > lib< / code > directories in the package
< code class = "filename" > +CONTENTS< / code > , and for pkgviews packages,
2006-05-28 22:41:22 +02:00
it outputs any libtool archives in
2006-05-29 10:55:59 +02:00
< code class = "filename" > lib< / code > directories.
2006-05-28 22:41:22 +02:00
< / p > < / li >
< li > < p >
< code class = "varname" > BUILDLINK_TRANSFORM.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
(not shown above) is a list of sed arguments used to
transform the name of the source filename into a
destination filename, e.g. < span > < strong class = "command" > -e
"s|/curses.h|/ncurses.h|g"< / strong > < / span > .
< / p > < / li >
< / ul > < / div >
< p > The last section includes any
2006-05-29 10:55:59 +02:00
< code class = "filename" > buildlink3.mk< / code > needed for
2006-05-28 22:41:22 +02:00
< em class = "replaceable" > < code > pkg< / code > < / em > 's library dependencies.
2006-05-29 10:55:59 +02:00
Including these < code class = "filename" > buildlink3.mk< / code > files
2006-05-28 22:41:22 +02:00
means that the headers and libraries for these
dependencies are also symlinked into
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${BUILDLINK_DIR}< / code >
2006-05-28 22:41:22 +02:00
whenever the < em class = "replaceable" > < code > pkg< / code > < / em >
2006-05-29 10:55:59 +02:00
< code class = "filename" > buildlink3.mk< / code >
2006-05-28 22:41:22 +02:00
file is included.
< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "updating-buildlink-depends" > < / a > 12.2.2.<2E> Updating < code class = "varname" > BUILDLINK_API_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code > in < code class = "filename" > buildlink3.mk< / code > files< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p >
The situation that requires increasing the dependency listed in
< code class = "varname" > BUILDLINK_API_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
after a package update is when the API or interface to the
header files change.< / p >
< p > In this case,
< code class = "varname" > BUILDLINK_API_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
should be adjusted to require at least the new package
version. In some cases, the packages that depend on this new
version may need their < code class = "varname" > PKGREVISION< / code > s
2006-05-29 10:55:59 +02:00
increased and, if they have < code class = "filename" > buildlink3.mk< / code >
2006-05-28 22:41:22 +02:00
files, their
< code class = "varname" > BUILDLINK_API_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
adjusted, too. This is needed so pkgsrc will require the
correct package dependency and not settle for an older one
when building the source.< / p >
< p >
< code class = "varname" > BUILDLINK_ABI_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
should be increased when the binary interface or sonames
(major number of the library version) of any installed
shared libraries change. This is needed so that binary
packages made using it will require the correct package
dependency and not settle for an older one which will not
contain the necessary shared libraries. < / p >
< p >
2006-06-01 11:36:55 +02:00
See < a href = "#dependencies" title = "17.1.4.<2E> Handling dependencies" > Section<EFBFBD> 17.1.4, “ Handling dependencies” < / a > for
2006-05-28 22:41:22 +02:00
more information about dependencies on other packages,
including the < code class = "varname" > BUILDLINK_ABI_DEPENDS< / code > and
< code class = "varname" > ABI_DEPENDS< / code > definitions. < / p >
< p > Please take careful consideration before adjusting
< code class = "varname" > BUILDLINK_API_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
or
< code class = "varname" > BUILDLINK_ABI_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
as we don't want to cause unneeded package deletions and
rebuilds. In many cases, new versions of packages work just
fine with older dependencies.< / p >
< p >
Also it is not needed to set
< code class = "varname" > BUILDLINK_ABI_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
when it is identical to
< code class = "varname" > BUILDLINK_API_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code > . < / p >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "writing-builtin.mk" > < / a > 12.3.<2E> Writing < code class = "filename" > builtin.mk< / code > files< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p >
Some packages in pkgsrc install headers and libraries that
coincide with headers and libraries present in the base system.
2006-05-29 10:55:59 +02:00
Aside from a < code class = "filename" > buildlink3.mk< / code > file, these
packages should also include a < code class = "filename" > builtin.mk< / code >
2006-05-28 22:41:22 +02:00
file that includes the necessary checks to decide whether using
the built-in software or the pkgsrc software is
appropriate. < / p >
< p > The only requirements of a builtin.mk file for
< em class = "replaceable" > < code > pkg< / code > < / em > are:
< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > It should set
< code class = "varname" > USE_BUILTIN.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
to either “ < span class = "quote" > yes< / span > ” or “ < span class = "quote" > no< / span > ”
after it is included.
< / p > < / li >
< li > < p > It should < span class = "emphasis" > < em > not< / em > < / span > override any
< code class = "varname" > USE_BUILTIN.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
which is already set before the
2006-05-29 10:55:59 +02:00
< code class = "filename" > builtin.mk< / code > file is included.
2006-05-28 22:41:22 +02:00
< / p > < / li >
< li > < p > It should be written to allow multiple inclusion. This
is < span class = "emphasis" > < em > very< / em > < / span > important and takes careful
2006-05-29 10:55:59 +02:00
attention to < code class = "filename" > Makefile< / code > coding.
2006-05-28 22:41:22 +02:00
< / p > < / li >
< / ol > < / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "anatomy-of-builtin.mk" > < / a > 12.3.1.<2E> Anatomy of a < code class = "filename" > builtin.mk< / code > file< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > The following is the recommended template for builtin.mk
files: < / p >
< pre class = "programlisting" >
.if !defined(IS_BUILTIN.foo)
#
# IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
# genuinely exists in the system or not.
#
IS_BUILTIN.foo?= no
2005-01-11 16:48:17 +01:00
2006-05-28 22:41:22 +02:00
# BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
# version can be determined.
#
. if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
BUILTIN_PKG.foo?= foo-1.0
. endif
.endif # IS_BUILTIN.foo
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
.if !defined(USE_BUILTIN.foo)
USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
. if defined(BUILTIN_PKG.foo)
. for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
. if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
USE_BUILTIN.foo!= \
if ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}; then \
${ECHO} "yes"; \
else \
${ECHO} "no"; \
fi
. endif
. endfor
. endif
.endif # USE_BUILTIN.foo
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
CHECK_BUILTIN.foo?= no
.if !empty(CHECK_BUILTIN.foo:M[nN][oO])
#
# Here we place code that depends on whether USE_BUILTIN.foo is set to
# "yes" or "no".
#
.endif # CHECK_BUILTIN.foo
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > The first section sets
< code class = "varname" > IS_BUILTIN.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
depending on if < em class = "replaceable" > < code > pkg< / code > < / em > really exists
in the base system. This should not be a base system software
with similar functionality to < em class = "replaceable" > < code > pkg< / code > < / em > ;
it should only be “ < span class = "quote" > yes< / span > ” if the actual package is
included as part of the base system. This variable is only
2006-05-29 10:55:59 +02:00
used internally within the < code class = "filename" > builtin.mk< / code >
2006-05-28 22:41:22 +02:00
file. < / p >
< p > The second section sets
< code class = "varname" > BUILTIN_PKG.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
to the version of < em class = "replaceable" > < code > pkg< / code > < / em > in the base
system if it exists (if
< code class = "varname" > IS_BUILTIN.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
is “ < span class = "quote" > yes< / span > ” ). This variable is only used internally
2006-05-29 10:55:59 +02:00
within the < code class = "filename" > builtin.mk< / code > file. < / p >
2006-05-28 22:41:22 +02:00
< p > The third section sets
< code class = "varname" > USE_BUILTIN.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
and is < span class = "emphasis" > < em > required< / em > < / span > in all
2006-05-29 10:55:59 +02:00
< code class = "filename" > builtin.mk< / code > files. The code in this
2006-05-28 22:41:22 +02:00
section must make the determination whether the built-in
software is adequate to satisfy the dependencies listed in
< code class = "varname" > BUILDLINK_API_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code > .
This is typically done by comparing
< code class = "varname" > BUILTIN_PKG.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
against each of the dependencies in
< code class = "varname" > BUILDLINK_API_DEPENDS.< em class = "replaceable" > < code > pkg< / code > < / em > < / code > .
< code class = "varname" > USE_BUILTIN.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
< span class = "emphasis" > < em > must< / em > < / span > be set to the correct value by the
2006-05-29 10:55:59 +02:00
end of the < code class = "filename" > builtin.mk< / code > file. Note that
2006-05-28 22:41:22 +02:00
< code class = "varname" > USE_BUILTIN.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
may be “ < span class = "quote" > yes< / span > ” even if
< code class = "varname" > IS_BUILTIN.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
is “ < span class = "quote" > no< / span > ” because we may make the determination
that the built-in version of the software is similar enough to
be used as a replacement. < / p >
< p > The last section is guarded by
< code class = "varname" > CHECK_BUILTIN.< em class = "replaceable" > < code > pkg< / code > < / em > < / code > ,
and includes code that uses the value of
< code class = "varname" > USE_BUILTIN.< em class = "replaceable" > < code > pkg< / code > < / em > < / code >
set in the previous section. This typically includes, e.g.,
adding additional dependency restrictions and listing
additional files to symlink into
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${BUILDLINK_DIR}< / code > (via
2006-05-28 22:41:22 +02:00
< code class = "varname" > BUILDLINK_FILES.< em class = "replaceable" > < code > pkg< / code > < / em > < / code > ).
< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "native-or-pkgsrc-preference" > < / a > 12.3.2.<2E> Global preferences for native or pkgsrc software< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p >
When building packages, it's possible to choose whether to set
a global preference for using either the built-in (native)
version or the pkgsrc version of software to satisfy a
dependency. This is controlled by setting
< code class = "varname" > PREFER_PKGSRC< / code > and
< code class = "varname" > PREFER_NATIVE< / code > . These variables take values
of either “ < span class = "quote" > yes< / span > ” , “ < span class = "quote" > no< / span > ” , or a list of
packages. < code class = "varname" > PREFER_PKGSRC< / code > tells pkgsrc to
use the pkgsrc versions of software, while
< code class = "varname" > PREFER_NATIVE< / code > tells pkgsrc to use the
built-in versions. Preferences are determined by the most
specific instance of the package in either
< code class = "varname" > PREFER_PKGSRC< / code > or
< code class = "varname" > PREFER_NATIVE< / code > . If a package is specified
in neither or in both variables, then
< code class = "varname" > PREFER_PKGSRC< / code > has precedence over
< code class = "varname" > PREFER_NATIVE< / code > . For example, to require
using pkgsrc versions of software for all but the most basic
bits on a NetBSD system, you can set: < / p >
< pre class = "programlisting" >
PREFER_PKGSRC= yes
PREFER_NATIVE= getopt skey tcp_wrappers
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > A package < span class = "emphasis" > < em > must< / em > < / span > have a
2006-05-29 10:55:59 +02:00
< code class = "filename" > builtin.mk< / code >
2006-05-28 22:41:22 +02:00
file to be listed in < code class = "varname" > PREFER_NATIVE< / code > ,
otherwise it is simply ignored in that list.
< / p >
< / div >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "pkginstall" > < / a > Chapter<EFBFBD> 13.<2E> The pkginstall framework< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#files-and-dirs-outside-prefix" > 13.1. Files and directories outside the installation prefix< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#dirs-outside-prefix" > 13.1.1. Directory manipulation< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#files-outside-prefix" > 13.1.2. File manipulation< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#conf-files" > 13.2. Configuration files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#conf-files-sysconfdir" > 13.2.1. How < code class = "varname" > PKG_SYSCONFDIR< / code > is set< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#conf-files-configure" > 13.2.2. Telling the software where configuration files are< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#conf-files-patching" > 13.2.3. Patching installations< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#conf-files-disable" > 13.2.4. Disabling handling of configuration files< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#rcd-scripts" > 13.3. System startup scripts< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#rcd-scripts-disable" > 13.3.1. Disabling handling of system startup scripts< / a > < / span > < / dt > < / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#users-and-groups" > 13.4. System users and groups< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#shells" > 13.5. System shells< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#shells-disable" > 13.5.1. Disabling shell registration< / a > < / span > < / dt > < / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#fonts" > 13.6. Fonts< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#fonts-disable" > 13.6.1. Disabling automatic update of the fonts databases< / a > < / span > < / dt > < / dl > < / dd >
2006-05-28 22:41:22 +02:00
< / dl >
< / div >
< p > This chapter describes the framework known as
< code class = "literal" > pkginstall< / code > , whose key features are:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > Generic installation and manipulation of directories and files
outside the pkgsrc-handled tree, < code class = "varname" > LOCALBASE< / code > .< / p > < / li >
< li > < p > Automatic handling of configuration files during installation,
provided that packages are correctly designed.< / p > < / li >
< li > < p > Generation and installation of system startup scripts.< / p > < / li >
< li > < p > Registration of system users and groups.< / p > < / li >
< li > < p > Registration of system shells.< / p > < / li >
< li > < p > Automatic updating of fonts databases.< / p > < / li >
< / ul > < / div >
< p > The following sections inspect each of the above points in detail.< / p >
< p > You may be thinking that many of the things described here could be
easily done with simple code in the package's post-installation target
(< code class = "literal" > post-install< / code > ). < span class = "emphasis" > < em > This is incorrect< / em > < / span > ,
as the code in them is only executed when building from source. Machines
using binary packages could not benefit from it at all (as the code itself
could be unavailable). Therefore, the only way to achieve any of the items
described above is by means of the installation scripts, which are
automatically generated by pkginstall.< / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "files-and-dirs-outside-prefix" > < / a > 13.1.<2E> Files and directories outside the installation prefix< / h2 > < / div > < / div > < / div >
2006-05-29 10:55:59 +02:00
< p > As you already know, the < code class = "filename" > PLIST< / code > file holds a list
2006-05-28 22:41:22 +02:00
of files and directories that belong to a package. The names used in it
2006-05-29 10:55:59 +02:00
are relative to the installation prefix (< code class = "filename" > ${PREFIX}< / code > ),
2006-05-28 22:41:22 +02:00
which means that it cannot register files outside this directory (absolute
path names are not allowed). Despite this restriction, some packages need
to install files outside this location; e.g., under
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${VARBASE}< / code > or
< code class = "filename" > ${PKG_SYSCONFDIR}< / code > .< / p >
2006-05-28 22:41:22 +02:00
< p > The only way to achieve this is to create such files during
installation time by using the installation scripts. These scripts can run
arbitrary commands, so they have the potential to create and manage files
anywhere in the file system. Here is where pkginstall comes into play: it
provides generic scripts to abstract the manipulation of such files and
directories based on variables set in the package's
2006-05-29 10:55:59 +02:00
< code class = "filename" > Makefile< / code > . The rest of this section describes these
2006-05-28 22:41:22 +02:00
variables.< / p >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "dirs-outside-prefix" > < / a > 13.1.1.<2E> Directory manipulation< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > The following variables can be set to request the creation of
directories anywhere in the file system:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < code class = "varname" > MAKE_DIRS< / code > and < code class = "varname" > OWN_DIRS< / code >
contain a list of directories that should be created and should attempt
to be destroyed by the installation scripts. The difference between
the two is that the latter prompts the administrator to remove any
directories that may be left after deinstallation (because they were
not empty), while the former does not.< / p > < / li >
< li >
< p > < code class = "varname" > MAKE_DIRS_PERMS< / code > and
< code class = "varname" > OWN_DIRS_PERMS< / code > contain a list of tuples describing
which directories should be created and should attempt to be destroyed
by the installation scripts. Each tuple holds the following values,
separated by spaces: the directory name, its owner, its group and its
numerical mode. For example:< / p >
< pre class = "programlisting" >
MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > The difference between the two is exactly the same as their
non-< code class = "varname" > PERMS< / code > counterparts.< / p >
< / li >
< / ul > < / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "files-outside-prefix" > < / a > 13.1.2.<2E> File manipulation< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Creating non-empty files outside the installation prefix is tricky
2006-05-29 10:55:59 +02:00
because the < code class = "filename" > PLIST< / code > forces all files to be inside it.
2006-05-28 22:41:22 +02:00
To overcome this problem, the only solution is to extract the file in the
known place (i.e., inside the installation prefix) and copy it to the
appropriate location during installation (done by the installation scripts
generated by pkginstall). We will call the former the < span class = "emphasis" > < em > master
file< / em > < / span > in the following paragraphs, which describe the variables
that can be used to automatically and consistently handle files outside the
installation prefix:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li >
< p > < code class = "varname" > CONF_FILES< / code > and
< code class = "varname" > SUPPORT_FILES< / code > are pairs of master and target files.
During installation time, the master file is copied to the target one
if and only if the latter does not exist. Upon deinstallation, the
target file is removed provided that it was not modified by the
installation.< / p >
< p > The difference between the two is that the latter prompts the
administrator to remove any files that may be left after
deinstallation (because they were not empty), while the former does
not.< / p >
< / li >
< li >
< p > < code class = "varname" > CONF_FILES_PERMS< / code > and
< code class = "varname" > SUPPORT_FILES_PERMS< / code > contain tuples describing master
files as well as their target locations. For each of them, it also
specifies their owner, their group and their numeric permissions, in
this order. For example:< / p >
< pre class = "programlisting" >
SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > The difference between the two is exactly the same as their
non-< code class = "varname" > PERMS< / code > counterparts.< / p >
< / li >
< / ul > < / div >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "conf-files" > < / a > 13.2.<2E> Configuration files< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Configuration files are special in the sense that they are installed
in their own specific directory, < code class = "varname" > PKG_SYSCONFDIR< / code > , and
need special treatment during installation (most of which is automated by
pkginstall). The main concept you must bear in mind is that files marked
as configuration files are automatically copied to the right place (somewhere
inside < code class = "varname" > PKG_SYSCONFDIR< / code > ) during installation < span class = "emphasis" > < em > if
and only if< / em > < / span > they didn't exist before. Similarly, they will not
be removed if they have local modifications. This ensures that
administrators never lose any custom changes they may have made.< / p >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "conf-files-sysconfdir" > < / a > 13.2.1.<2E> How < code class = "varname" > PKG_SYSCONFDIR< / code > is set< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > As said before, the < code class = "varname" > PKG_SYSCONFDIR< / code > variable
specifies where configuration files shall be installed. Its contents are
set based upon the following variables:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < code class = "varname" > PKG_SYSCONFBASE< / code > : The configuration's root
2006-05-29 10:55:59 +02:00
directory. Defaults to < code class = "filename" > ${PREFIX}/etc< / code > although it may
2006-05-28 22:41:22 +02:00
be overridden by the user to point to his preferred location (e.g.,
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc< / code > , < code class = "filename" > /etc/pkg< / code > , etc.).
2006-05-28 22:41:22 +02:00
Packages must not use it directly.< / p > < / li >
< li >
< p > < code class = "varname" > PKG_SYSCONFSUBDIR< / code > : A subdirectory of
< code class = "varname" > PKG_SYSCONFBASE< / code > under which the configuration files
for the package being built shall be installed. The definition of this
variable only makes sense in the package's
2006-05-29 10:55:59 +02:00
< code class = "filename" > Makefile< / code > (i.e., it is not user-customizable).< / p >
2006-05-28 22:41:22 +02:00
< p > As an example, consider the Apache package,
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/www/apache2/README.html" target = "_top" > < code class = "filename" > www/apache2< / code > < / a > , which places its
2006-05-28 22:41:22 +02:00
configuration files under the
2006-05-29 10:55:59 +02:00
< code class = "filename" > httpd/< / code > subdirectory of
2006-05-28 22:41:22 +02:00
< code class = "varname" > PKG_SYSCONFBASE< / code > . This should be set in the package
Makefile.< / p >
< / li >
< li > < p > < code class = "varname" > PKG_SYSCONFVAR< / code > : Specifies the name of the
variable that holds this package's configuration directory (if
different from < code class = "varname" > PKG_SYSCONFBASE< / code > ). It defaults to
< code class = "varname" > PKGBASE< / code > 's value, and is always prefixed with
< code class = "literal" > PKG_SYSCONFDIR< / code > .< / p > < / li >
< li > < p > < code class = "varname" > PKG_SYSCONFDIR.${PKG_SYSCONFVAR}< / code > : Holds the
directory where the configuration files for the package identified by
< code class = "varname" > PKG_SYSCONFVAR< / code > 's shall be placed.< / p > < / li >
< / ul > < / div >
< p > Based on the above variables, pkginstall determines the value of
< code class = "varname" > PKG_SYSCONFDIR< / code > , which is the < span class = "emphasis" > < em > only< / em > < / span >
variable that can be used within a package to refer to its configuration
directory. The algorithm used to set its value is basically the
following:< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > If < code class = "varname" > PKG_SYSCONFDIR.${PKG_SYSCONFVAR}< / code > is set,
its value is used.< / p > < / li >
< li > < p > If the previous variable is not defined but
< code class = "varname" > PKG_SYSCONFSUBDIR< / code > is set in the package's
2006-05-29 10:55:59 +02:00
< code class = "filename" > Makefile< / code > , the resulting value is
< code class = "filename" > ${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}< / code > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< li > < p > Otherwise, it is set to
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${PKG_SYSCONFBASE}< / code > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< / ol > < / div >
2006-05-29 10:55:59 +02:00
< p > It is worth mentioning that < code class = "filename" > ${PKG_SYSCONFDIR}< / code > is
2006-06-01 11:36:55 +02:00
automatically added to < code class = "filename" > OWN_DIRS< / code > . See < a href = "#dirs-outside-prefix" title = "13.1.1.<2E> Directory manipulation" > Section<EFBFBD> 13.1.1, “ Directory manipulation” < / a > what this means.< / p >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "conf-files-configure" > < / a > 13.2.2.<2E> Telling the software where configuration files are< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Given that pkgsrc (and users!) expect configuration files to be in a
known place, you need to teach each package where it shall install its
files. In some cases you will have to patch the package Makefiles to
achieve it. If you are lucky, though, it may be as easy as passing an
extra flag to the configuration script; this is the case of GNU Autoconf-
generated files:< / p >
< pre class = "programlisting" >
CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > Note that this specifies where the package has to < span class = "emphasis" > < em > look
for< / em > < / span > its configuration files, not where they will be originally
installed (although the difference is never explicit,
unfortunately).< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "conf-files-patching" > < / a > 13.2.3.<2E> Patching installations< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > As said before, pkginstall automatically handles configuration files.
This means that < span class = "strong" > < strong > the packages themselves must not
2006-05-29 10:55:59 +02:00
touch the contents of < code class = "filename" > ${PKG_SYSCONFDIR}< / code >
2006-05-28 22:41:22 +02:00
directly< / strong > < / span > . Bad news is that many software installation scripts
will, out of the box, mess with the contents of that directory. So what is
the correct procedure to fix this issue?< / p >
< p > You must teach the package (usually by manually patching it) to
install any configuration files under the examples hierarchy,
2006-05-29 10:55:59 +02:00
< code class = "filename" > share/examples/${PKGBASE}/< / code > . This way, the
< code class = "filename" > PLIST< / code > registers them and the administrator always
2006-05-28 22:41:22 +02:00
has the original copies available.< / p >
< p > Once the required configuration files are in place (i.e., under the
examples hierarchy), the pkginstall framework can use them as master copies
during the package installation to update what is in
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${PKG_SYSCONFDIR}< / code > . To achieve this, the variables
2006-05-28 22:41:22 +02:00
< code class = "varname" > CONF_FILES< / code > and < code class = "varname" > CONF_FILES_PERMS< / code > are
2006-06-01 11:36:55 +02:00
used. Check out < a href = "#files-outside-prefix" title = "13.1.2.<2E> File manipulation" > Section<EFBFBD> 13.1.2, “ File manipulation” < / a > for information
2006-05-28 22:41:22 +02:00
about their syntax and their purpose. Here is an example, taken from the
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/mail/mutt/README.html" target = "_top" > < code class = "filename" > mail/mutt< / code > < / a > package:< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
EGDIR= ${PREFIX}/share/doc/mutt/samples
CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > Note that the < code class = "varname" > EGDIR< / code > variable is specific to that
package and has no meaning outside it.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "conf-files-disable" > < / a > 13.2.4.<2E> Disabling handling of configuration files< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > The automatic copying of config files can be toggled by setting the
environment variable < code class = "varname" > PKG_CONFIG< / code > prior to package
installation.< / p >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "rcd-scripts" > < / a > 13.3.<2E> System startup scripts< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > System startup scripts are special files because they must be
installed in a place known by the underlying OS, usually outside the
2006-06-01 11:36:55 +02:00
installation prefix. Therefore, the same rules described in < a href = "#files-and-dirs-outside-prefix" title = "13.1.<2E> Files and directories outside the installation prefix" > Section<EFBFBD> 13.1, “ Files and directories outside the installation prefix” < / a > apply, and the same solutions
2006-05-28 22:41:22 +02:00
can be used. However, pkginstall provides a special mechanism to handle
these files.< / p >
< p > In order to provide system startup scripts, the package has
to:< / p >
< div class = "orderedlist" > < ol type = "1" >
2006-05-29 10:55:59 +02:00
< li > < p > Store the script inside < code class = "filename" > ${FILESDIR}< / code > , with
2006-05-28 22:41:22 +02:00
the < code class = "literal" > .sh< / code > suffix appended. Considering the
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/print/cups/README.html" target = "_top" > < code class = "filename" > print/cups< / code > < / a > package as an example, it has a
< code class = "filename" > cupsd.sh< / code > in its files directory.< / p > < / li >
2006-05-28 22:41:22 +02:00
< li >
< p > Tell pkginstall to handle it, appending the name of the script,
without its extension, to the < code class = "varname" > RCD_SCRIPTS< / code > variable.
Continuing the previous example:< / p >
< pre class = "programlisting" >
RCD_SCRIPTS+= cupsd
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< / li >
< / ol > < / div >
< p > Once this is done, pkginstall will do the following steps for each
script in an automated fashion:< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > Process the file found in the files directory applying all the
2006-05-29 10:55:59 +02:00
substitutions described in the < code class = "filename" > FILES_SUBST< / code >
2006-05-28 22:41:22 +02:00
variable.< / p > < / li >
< li > < p > Copy the script from the files directory to the examples
2006-05-29 10:55:59 +02:00
hierarchy, < code class = "filename" > ${PREFIX}/share/examples/rc.d/< / code > . Note
2006-05-28 22:41:22 +02:00
that this master file must be explicitly registered in the
2006-05-29 10:55:59 +02:00
< code class = "filename" > PLIST< / code > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< li > < p > Add code to the installation scripts to copy the startup script
from the examples hierarchy into the system-wide startup scripts
directory.< / p > < / li >
< / ol > < / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "rcd-scripts-disable" > < / a > 13.3.1.<2E> Disabling handling of system startup scripts< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > The automatic copying of config files can be toggled by setting the
environment variable < code class = "varname" > PKG_RCD_SCRIPTS< / code > prior to package
installation. Note that the scripts will be always copied inside the
2006-05-29 10:55:59 +02:00
examples hierarchy, < code class = "filename" > ${PREFIX}/share/examples/rc.d/< / code > , no
2006-05-28 22:41:22 +02:00
matter what the value of this variable is.< / p >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "users-and-groups" > < / a > 13.4.<2E> System users and groups< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > If a package needs to create special users and/or groups during
installation, it can do so by using the pkginstall framework.< / p >
< p > Users can be created by adding entries to the
< code class = "varname" > PKG_USERS< / code > variable. Each entry has the following
syntax:< / p >
< pre class = "programlisting" >
user:group
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > Further specification of user details may be done by setting per-user
variables.
< code class = "varname" > PKG_UID.< em class = "replaceable" > < code > user< / code > < / em > < / code > is the numeric
UID for the user.
< code class = "varname" > PKG_GECOS.< em class = "replaceable" > < code > user< / code > < / em > < / code > is the user's
description or comment.
< code class = "varname" > PKG_HOME.< em class = "replaceable" > < code > user< / code > < / em > < / code > is the user's
2006-05-29 10:55:59 +02:00
home directory, and defaults to < code class = "filename" > /nonexistent< / code > if not
2006-05-28 22:41:22 +02:00
specified.
< code class = "varname" > PKG_SHELL.< em class = "replaceable" > < code > user< / code > < / em > < / code > is the user's
2006-05-29 10:55:59 +02:00
shell, and defaults to < code class = "filename" > /sbinno/login< / code > if not specified.
2006-05-28 22:41:22 +02:00
< / p >
< p > Similarly, groups can be created by adding entries to the
< code class = "varname" > PKG_GROUPS< / code > variable, whose syntax is:< / p >
< pre class = "programlisting" >
group
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< p > The numeric GID of the group may be set by defining
< code class = "varname" > PKG_GID.< em class = "replaceable" > < code > group< / code > < / em > < / code > .< / p >
< p > If a package needs to create the users and groups at an earlier
stage, then it can set < code class = "varname" > USERGROUP_PHASE< / code > to
either < code class = "literal" > configure< / code > or < code class = "literal" > build< / code > to
indicate the phase before which the users and groups are created. In
this case, the numeric UIDs and GIDs of the created users and groups
are automatically hardcoded into the final installation scripts.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "shells" > < / a > 13.5.<2E> System shells< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Packages that install system shells should register them in the shell
2006-05-29 10:55:59 +02:00
database, < code class = "filename" > /etc/shells< / code > , to make things easier to the
2006-05-28 22:41:22 +02:00
administrator. This must be done from the installation scripts to keep
binary packages working on any system. pkginstall provides an easy way to
accomplish this task.< / p >
< p > When a package provides a shell interpreter, it has to set the
< code class = "varname" > PKG_SHELL< / code > variable to its absolute file name. This will
add some hooks to the installation scripts to handle it. Consider the
2006-05-29 10:55:59 +02:00
following example, taken from < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/shells/zsh/README.html" target = "_top" > < code class = "filename" > shells/zsh< / code > < / a > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
PKG_SHELL= ${PREFIX}/bin/zsh
2006-05-13 01:07:28 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "shells-disable" > < / a > 13.5.1.<2E> Disabling shell registration< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > The automatic registration of shell interpreters can be disabled by
2006-05-29 10:55:59 +02:00
the administrator by setting the < code class = "filename" > PKG_REGISTER_SHELLS< / code >
2006-05-28 22:41:22 +02:00
environment variable to < code class = "literal" > NO< / code > .< / p >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "fonts" > < / a > 13.6.<2E> Fonts< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Packages that install X11 fonts should update the database files
that index the fonts within each fonts directory. This can easily be
accomplished within the pkginstall framework.< / p >
< p > When a package installs X11 fonts, it must list the directories in
which fonts are installed in the
< code class = "varname" > FONTS_DIRS.< em class = "replaceable" > < code > type< / code > < / em > < / code > variables,
where < em class = "replaceable" > < code > type< / code > < / em > can be one of “ < span class = "quote" > ttf< / span > ” ,
“ < span class = "quote" > type1< / span > ” or “ < span class = "quote" > x11< / span > ” . This will add hooks to the
installation scripts to run the appropriate commands to update the fonts
database files within each of those directories. For convenience, if the
directory path is relative, it is taken to be relative to the package's
2006-05-29 10:55:59 +02:00
installation prefix. Consider the following example, taken from < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/fonts/dbz-ttf/README.html" target = "_top" > < code class = "filename" > fonts/dbz-ttf< / code > < / a > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
< / pre >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "fonts-disable" > < / a > 13.6.1.<2E> Disabling automatic update of the fonts databases< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > The automatic update of fonts databases can be disabled by
2006-05-29 10:55:59 +02:00
the administrator by setting the < code class = "filename" > PKG_UPDATE_FONTS_DB< / code >
2006-05-28 22:41:22 +02:00
environment variable to < code class = "literal" > NO< / code > .< / p >
< / div >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "options" > < / a > Chapter<EFBFBD> 14.<2E> Options handling< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#global-default-options" > 14.1. Global default options< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#converting-to-options" > 14.2. Converting packages to use < code class = "filename" > bsd.options.mk< / code > < / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#option-names" > 14.3. Option Names< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl >
< / div >
< p > Many packages have the ability to be built to support different
2006-05-29 10:55:59 +02:00
sets of features. < code class = "filename" > bsd.options.mk< / code > is a framework
2006-05-28 22:41:22 +02:00
in pkgsrc that provides generic handling of those options that
determine different ways in which the packages can be built. It's
possible for the user to specify exactly which sets of options will be
built into a package or to allow a set of global default options
apply.< / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "global-default-options" > < / a > 14.1.<2E> Global default options< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Global default options are listed in
< code class = "varname" > PKG_DEFAULT_OPTIONS< / code > , which is a list of the options
that should be built into every package if that option is supported.
2006-05-29 10:55:59 +02:00
This variable should be set in < code class = "filename" > /etc/mk.conf< / code > .< / p >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "converting-to-options" > < / a > 14.2.<2E> Converting packages to use < code class = "filename" > bsd.options.mk< / code > < / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > The following example shows how
2006-05-29 10:55:59 +02:00
< code class = "filename" > bsd.options.mk< / code > should be used
2006-05-28 22:41:22 +02:00
by the hypothetical ``wibble'' package, either in the package
2006-05-29 10:55:59 +02:00
< code class = "filename" > Makefile< / code > , or in a file,
e.g. < code class = "filename" > options.mk< / code > , that is included by the
main package < code class = "filename" > Makefile< / code > .< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
PKG_SUPPORTED_OPTIONS= wibble-foo ldap
PKG_OPTIONS_OPTIONAL_GROUPS= database
PKG_OPTIONS_GROUP.database= mysql pgsql
PKG_SUGGESTED_OPTIONS= wibble-foo
PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
2006-05-13 01:07:28 +02:00
2006-05-28 22:41:22 +02:00
.include "../../mk/bsd.prefs.mk"
2006-02-18 18:18:14 +01:00
2006-05-28 22:41:22 +02:00
# this package was previously named wibble2
.if defined(PKG_OPTIONS.wibble2)
PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
PKG_OPTIONS_DEPRECATED_WARNINGS+= \
"Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR instead."
.endif
2006-02-18 18:18:14 +01:00
2006-05-28 22:41:22 +02:00
.include "../../mk/bsd.options.mk"
2006-02-18 18:18:14 +01:00
2006-05-28 22:41:22 +02:00
# Package-specific option-handling
2006-02-18 18:18:14 +01:00
2006-05-28 22:41:22 +02:00
###
### FOO support
###
.if !empty(PKG_OPTIONS:Mwibble-foo)
CONFIGURE_ARGS+= --enable-foo
.endif
2006-02-18 18:18:14 +01:00
2006-05-28 22:41:22 +02:00
###
### LDAP support
###
.if !empty(PKG_OPTIONS:Mldap)
2006-06-01 11:36:55 +02:00
. include "../../databases/openldap-client/buildlink3.mk"
CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
2006-05-28 22:41:22 +02:00
.endif
2006-02-18 18:18:14 +01:00
2006-05-28 22:41:22 +02:00
###
### database support
###
.if !empty(PKG_OPTIONS:Mmysql)
. include "../../mk/mysql.buildlink3.mk"
.endif
.if !empty(PKG_OPTIONS:Mpgsql)
. include "../../mk/pgsql.buildlink3.mk"
.endif
< / pre >
< p > The first section contains the information about which build
options are supported by the package, and any default options settings
if needed.< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > < code class = "varname" > PKG_OPTIONS_VAR< / code > is the name of the
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > make< / span > (1)< / span > < / a > variable that the user can set to override the default
options. It should be set to
PKG_OPTIONS.< em class = "replaceable" > < code > pkgbase< / code > < / em > . Do not set it to
PKG_OPTIONS.${PKGBASE}, since < code class = "varname" > PKGBASE< / code > is set after
< code class = "varname" > PKG_OPTIONS_VAR< / code > is used.< / p > < / li >
< li > < p > < code class = "varname" > PKG_SUPPORTED_OPTIONS< / code > is a list of
build options supported by the package.< / p > < / li >
< li > < p > < code class = "varname" > PKG_OPTIONS_OPTIONAL_GROUPS< / code > is a
list of names of groups of mutually exclusive options. The options in
each group are listed in
< code class = "varname" > PKG_OPTIONS_GROUP.< em class = "replaceable" > < code > groupname< / code > < / em > < / code > .
The most specific setting of any option from the group takes
precedence over all other options in the group. Options from the
groups will be automatically added to
< code class = "varname" > PKG_SUPPORTED_OPTIONS< / code > .< / p > < / li >
< li > < p > < code class = "varname" > PKG_OPTIONS_REQUIRED_GROUPS< / code > is like
< code class = "varname" > PKG_OPTIONS_OPTIONAL_GROUPS< / code > , but building the
packages will fail if no option from the group is
selected.< / p > < / li >
< li > < p > < code class = "varname" > PKG_OPTIONS_NONEMPTY_SETS< / code > is a list
of names of sets of options. At least one option from each set must
be selected. The options in each set are listed in
< code class = "varname" > PKG_OPTIONS_SET.< em class = "replaceable" > < code > setname< / code > < / em > < / code > .
Options from the sets will be automatically added to
< code class = "varname" > PKG_SUPPORTED_OPTIONS< / code > . Building the package will
fail if no option from the set is selected.< / p > < / li >
< li > < p > < code class = "varname" > PKG_SUGGESTED_OPTIONS< / code > is a list of
build options which are enabled by default.< / p > < / li >
< li > < p > < code class = "varname" > PKG_OPTIONS_LEGACY_VARS< / code > is a list
of
“ < span class = "quote" > < em class = "replaceable" > < code > USE_VARIABLE< / code > < / em > :< em class = "replaceable" > < code > option< / code > < / em > < / span > ”
2006-05-29 10:55:59 +02:00
pairs that map legacy < code class = "filename" > /etc/mk.conf< / code > variables to
2006-05-28 22:41:22 +02:00
their option counterparts. Pairs should be added with
“ < span class = "quote" > +=< / span > ” to keep the listing of global legacy variables. A
warning will be issued if the user uses a legacy
variable.< / p > < / li >
< li > < p > < code class = "varname" > PKG_OPTIONS_LEGACY_OPTS< / code > is a list
of
“ < span class = "quote" > < em class = "replaceable" > < code > old-option< / code > < / em > :< em class = "replaceable" > < code > new-option< / code > < / em > < / span > ”
pairs that map options that have been renamed to their new
counterparts. Pairs should be added with “ < span class = "quote" > +=< / span > ” to keep
the listing of global legacy options. A warning will be issued if
the user uses a legacy option.< / p > < / li >
< li > < p > < code class = "varname" > PKG_LEGACY_OPTIONS< / code > is a list of
options implied by deprecated variables used. This can be used for
cases that neither < code class = "varname" > PKG_OPTIONS_LEGACY_VARS< / code > nor
< code class = "varname" > PKG_OPTIONS_LEGACY_OPTS< / code > can handle, e. g. when
< code class = "varname" > PKG_OPTIONS_VAR< / code > is renamed.< / p > < / li >
< li > < p > < code class = "varname" > PKG_OPTIONS_DEPRECATED_WARNINGS< / code > is
a list of warnings about deprecated variables or options used, and
what to use instead.< / p > < / li >
< / ol > < / div >
< p > A package should never modify
< code class = "varname" > PKG_DEFAULT_OPTIONS< / code > or the variable named in
< code class = "varname" > PKG_OPTIONS_VAR< / code > . These are strictly user-settable.
To suggest a default set of options, use
< code class = "varname" > PKG_SUGGESTED_OPTIONS< / code > .< / p >
< p > < code class = "varname" > PKG_OPTIONS_VAR< / code > must be defined before
2006-05-29 10:55:59 +02:00
including < code class = "filename" > bsd.options.mk< / code > . If none of
2006-05-28 22:41:22 +02:00
< code class = "varname" > PKG_SUPPORTED_OPTIONS< / code > ,
< code class = "varname" > PKG_OPTIONS_OPTIONAL_GROUPS< / code > , and
< code class = "varname" > PKG_OPTIONS_REQUIRED_GROUPS< / code > are defined (as can
happen with platform-specific options if none of them is supported on
the current platform), < code class = "varname" > PKG_OPTIONS< / code > is set to the
empty list and the package is otherwise treated as not using the
options framework.< / p >
2006-05-29 10:55:59 +02:00
< p > After the inclusion of < code class = "filename" > bsd.options.mk< / code > , the
2006-05-28 22:41:22 +02:00
variable < code class = "varname" > PKG_OPTIONS< / code > contains the list of selected
build options, properly filtered to remove unsupported and duplicate
options.< / p >
< p > The remaining sections contain the logic that is specific to
each option. The correct way to check for an option is to check
whether it is listed in < code class = "varname" > PKG_OPTIONS< / code > :< / p >
< pre class = "programlisting" >
.if !empty(PKG_OPTIONS:M< em class = "replaceable" > < code > option< / code > < / em > )
< / pre >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "option-names" > < / a > 14.3.<2E> Option Names< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Options that enable similar features in different packages (like
optional support for a library) should use a common name in all
packages that support it (like the name of the library). If another
package already has an option with the same meaning, use the same
name.< / p >
< p > Options that enable features specific to one package, where it's
unlikely that another (unrelated) package has the same (or a similar)
optional feature, should use a name prefixed with
< code class = "varname" > < em class = "replaceable" > < code > pkgname< / code > < / em > -< / code > .< / p >
< p > If a group of related packages share an optional feature
specific to that group, prefix it with the name of the
“ < span class = "quote" > main< / span > ” package
(e. g. < code class = "varname" > djbware-errno-hack< / code > ).< / p >
< p > For new options, add a line to
2006-05-29 10:55:59 +02:00
< code class = "filename" > mk/defaults/options.description< / code > . Lines have two
2006-05-28 22:41:22 +02:00
fields, separated by tab. The first field is the option name, the
second its description. The description should be a whole sentence
(starting with an uppercase letter and ending with a period) that
describes what enabling the option does. E. g. “ < span class = "quote" > Enable ispell
support.< / span > ” The file is sorted by option names.< / p >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "build" > < / a > Chapter<EFBFBD> 15.<2E> The build process< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#build.intro" > 15.1. Introduction< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.prefix" > 15.2. Program location< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.builddirs" > 15.3. Directories used during the build process< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.running" > 15.4. Running a phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.fetch" > 15.5. The < span class = "emphasis" > < em > fetch< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.checksum" > 15.6. The < span class = "emphasis" > < em > checksum< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.extract" > 15.7. The < span class = "emphasis" > < em > extract< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.patch" > 15.8. The < span class = "emphasis" > < em > patch< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.tools" > 15.9. The < span class = "emphasis" > < em > tools< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.wrapper" > 15.10. The < span class = "emphasis" > < em > wrapper< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.configure" > 15.11. The < span class = "emphasis" > < em > configure< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.build" > 15.12. The < span class = "emphasis" > < em > build< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.test" > 15.13. The < span class = "emphasis" > < em > test< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.install" > 15.14. The < span class = "emphasis" > < em > install< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.package" > 15.15. The < span class = "emphasis" > < em > package< / em > < / span > phase< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#build.helpful-targets" > 15.16. Other helpful targets< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.intro" > < / a > 15.1.<2E> Introduction< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > This chapter gives a detailed description on how a package is
built. Building a package is separated into different
< span class = "emphasis" > < em > phases< / em > < / span > (for example < code class = "varname" > fetch< / code > ,
< code class = "varname" > build< / code > , < code class = "varname" > install< / code > ), all of which are
described in the following sections. Each phase is splitted into
so-called < span class = "emphasis" > < em > stages< / em > < / span > , which take the name of the
containing phase, prefixed by one of < code class = "varname" > pre-< / code > ,
< code class = "varname" > do-< / code > or < code class = "varname" > post-< / code > . (Examples are
< code class = "varname" > pre-configure< / code > , < code class = "varname" > post-build< / code > .) Most
of the actual work is done in the < code class = "varname" > do-*< / code > stages.< / p >
< p > The basic steps for building a program are always the same. First
the program's source (< span class = "emphasis" > < em > distfile< / em > < / span > ) must be brought to
the local system and then extracted. After any pkgsrc-specific patches
to compile properly are applied, the software can be configured, then
built (usually by compiling), and finally the generated binaries, etc.
can be put into place on the system.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.prefix" > < / a > 15.2.<2E> Program location< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Before outlining the process performed by the NetBSD package system in
the next section, here's a brief discussion on where programs are
installed, and which variables influence this.< / p >
< p > The automatic variable < code class = "varname" > PREFIX< / code > indicates
where all files of the final program shall be installed. It is
usually set to < code class = "varname" > LOCALBASE< / code >
2006-05-29 10:55:59 +02:00
(< code class = "filename" > /usr/pkg< / code > ), or < code class = "varname" > CROSSBASE< / code >
2006-05-28 22:41:22 +02:00
for pkgs in the “ < span class = "quote" > cross< / span > ” category. The value of
< code class = "varname" > PREFIX< / code > needs to be put
into the various places in the program's source where paths to
2006-06-01 11:36:55 +02:00
these files are encoded. See < a href = "#components.patches" title = "9.3.<2E> patches/*" > Section<EFBFBD> 9.3, “ patches/*” < / a > and < a href = "#fixes.libtool" title = "17.3.1.<2E> Shared libraries - libtool" > Section<EFBFBD> 17.3.1, “ Shared libraries - libtool” < / a > for more details.< / p >
2006-05-28 22:41:22 +02:00
< p > When choosing which of these variables to use,
follow the following rules:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > < code class = "varname" > PREFIX< / code > always points to the location where the current
pkg will be installed. When referring to a pkg's own installation path,
use “ < span class = "quote" > ${PREFIX}< / span > ” .< / p > < / li >
< li > < p > < code class = "varname" > LOCALBASE< / code > is where all non-X11 pkgs are installed.
If you need to construct a -I or -L argument to the compiler to find
includes and libraries installed by another non-X11 pkg, use
“ < span class = "quote" > ${LOCALBASE}< / span > ” .< / p > < / li >
< li > < p > < code class = "varname" > X11BASE< / code > is where the actual X11 distribution (from
xsrc, etc.) is installed. When looking for
< span class = "emphasis" > < em > standard< / em > < / span > X11 includes (not
those installed by a pkg), use “ < span class = "quote" > ${X11BASE}< / span > ” .< / p > < / li >
< li >
< p > X11-based packages are special in that they may be installed in
either < code class = "varname" > X11BASE< / code > or < code class = "varname" > LOCALBASE< / code > .< / p >
< p > Usually, X11 packages should be installed under
< code class = "varname" > LOCALBASE< / code > whenever possible. Note that you will
2006-05-29 10:55:59 +02:00
need to include < code class = "filename" > ../../mk/x11.buildlink3.mk< / code >
2006-05-28 22:41:22 +02:00
in them to request the
presence of X11 and to get the right compilation flags.< / p >
< p > Even though, there are some packages that cannot be installed
under < code class = "varname" > LOCALBASE< / code > : those that come with app-defaults
files. These packages are special and they must be placed under
< code class = "varname" > X11BASE< / code > . To accomplish this, set either
< code class = "varname" > USE_X11BASE< / code > or < code class = "varname" > USE_IMAKE< / code > in
your package.< / p >
< p > Some notes: If you need
to find includes or libraries installed by a pkg that has
< code class = "varname" > USE_IMAKE< / code > or < code class = "varname" > USE_X11BASE< / code > in
2006-05-29 10:55:59 +02:00
its pkg < code class = "filename" > Makefile< / code > , you need to look in
< span class = "emphasis" > < em > both< / em > < / span > < code class = "filename" > ${X11BASE}< / code > and
< code class = "filename" > ${LOCALBASE}< / code > . To force installation of
2006-05-28 22:41:22 +02:00
all X11 packages in < code class = "varname" > LOCALBASE< / code > , the
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/xpkgwedge/README.html" target = "_top" > < code class = "filename" > pkgtools/xpkgwedge< / code > < / a > package
2006-05-28 22:41:22 +02:00
is enabled by default.< / p >
< / li >
< li > < p > < code class = "varname" > X11PREFIX< / code > should be used to refer to the installed
location of an X11 package. < code class = "varname" > X11PREFIX< / code > will be set to
< code class = "varname" > X11BASE< / code > if xpkgwedge is not installed,
and to < code class = "varname" > LOCALBASE< / code > if xpkgwedge is installed.< / p > < / li >
< li >
< p > If xpkgwedge is installed, it is possible to have some packages installed
in < code class = "varname" > X11BASE< / code > and some in < code class = "varname" > LOCALBASE< / code > .
To determine the prefix of an installed package, the
< code class = "varname" > EVAL_PREFIX< / code > definition can be used. It takes pairs in the
format “ < span class = "quote" > DIRNAME=< package> < / span > ” , and the < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > make< / span > (1)< / span > < / a > variable
< code class = "varname" > DIRNAME< / code > will be set to the prefix of the installed
package < package> , or “ < span class = "quote" > ${X11PREFIX}< / span > ” if the package is
not installed.< / p >
< p > This is best illustrated by example.< / p >
< p > The following lines are taken from
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/wm/scwm/Makefile< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
EVAL_PREFIX+= GTKDIR=gtk+
CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
CONFIGURE_ARGS+= --enable-multibyte
< / pre >
< p > Specific defaults can be defined for the packages evaluated using
< code class = "varname" > EVAL_PREFIX< / code > , by using a definition of the form:< / p >
< pre class = "programlisting" >
GTKDIR_DEFAULT= ${LOCALBASE}
< / pre >
< p > where < code class = "varname" > GTKDIR< / code > corresponds
to the first definition in
the < code class = "varname" > EVAL_PREFIX< / code > pair.< / p >
< / li >
2006-05-29 10:55:59 +02:00
< li > < p > Within < code class = "filename" > ${PREFIX}< / code > , packages should
2006-05-28 22:41:22 +02:00
install files according to < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > hier< / span > (7)< / span > < / a > , with the exception that
2006-05-29 10:55:59 +02:00
manual pages go into < code class = "filename" > ${PREFIX}/man< / code > , not
< code class = "filename" > ${PREFIX}/share/man< / code > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< / ul > < / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.builddirs" > < / a > 15.3.<2E> Directories used during the build process< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > When building a package, a number of directories is used to store
source files, temporary files, pkgsrc-internal files, and so on. These
directories are explained here.< / p >
< p > Some of the directory variables contain relative pathnames. There
are two common base directories for these relative directories:
< code class = "varname" > PKGSRCDIR/PKGPATH< / code > is used for directories that are
pkgsrc-specific. < code class = "varname" > WRKSRC< / code > is used for directories
inside the package itself.< / p >
< div class = "variablelist" > < dl >
< dt > < span class = "term" > < code class = "varname" > PKGSRCDIR< / code > < / span > < / dt >
< dd > < p > This is an absolute pathname that points to the pkgsrc
root directory. Generally, you don't need
it.< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > PKGPATH< / code > < / span > < / dt >
< dd > < p > This is a pathname relative to
< code class = "varname" > PKGSRCDIR< / code > that points to the current
package.< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > WRKDIR< / code > < / span > < / dt >
< dd > < p > This is an absolute pathname pointing to the directory
where all work takes place. The distfiles are extraced to this
directory. It also contains temporary directories and log files used by
the various pkgsrc frameworks, like < span class = "emphasis" > < em > buildlink< / em > < / span > or
the < span class = "emphasis" > < em > wrappers< / em > < / span > .< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > WRKSRC< / code > < / span > < / dt >
< dd > < p > This is an absolute pathname pointing to the directory
where the distfiles are extracted. It is usually a direct subdirectory
of < code class = "varname" > WRKDIR< / code > , and often it's the only directory entry
that isn't hidden. This variable may be changed by a package
2006-05-29 10:55:59 +02:00
< code class = "filename" > Makefile< / code > .< / p > < / dd >
2006-05-28 22:41:22 +02:00
< / dl > < / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.running" > < / a > 15.4.<2E> Running a phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > You can run a particular phase by typing < span > < strong class = "command" > make
phase< / strong > < / span > , where < span class = "emphasis" > < em > phase< / em > < / span > is the name of the
phase. This will automatically run all phases that are required for this
phase. The default phase is < code class = "varname" > build< / code > , that is, when you
run < span > < strong class = "command" > make< / strong > < / span > without parameters in a package directory,
the package will be built, but not installed.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.fetch" > < / a > 15.5.<2E> The < span class = "emphasis" > < em > fetch< / em > < / span > phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > This will check if the file(s) given in the variables
< code class = "varname" > DISTFILES< / code > and < code class = "varname" > PATCHFILES< / code > (as
defined in the package's Makefile) are present on the
2006-05-29 10:55:59 +02:00
local system in < code class = "filename" > /usr/pkgsrc/distfiles< / code > . If they
2006-05-28 22:41:22 +02:00
are not present, an attempt will be made to fetch them using commands
of the form:< / p >
< pre class = "programlisting" >
${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
< / pre >
< p > where ${site} varies through several possibilities in turn: first,
< code class = "varname" > MASTER_SITE_OVERRIDE< / code > is tried, then the sites
specified in either < code class = "varname" > SITES.file< / code > if defined, else
< code class = "varname" > MASTER_SITES< / code > or < code class = "varname" > PATCH_SITES< / code > , as
applies, then finally the value of
< code class = "varname" > MASTER_SITE_BACKUP< / code > . The order of all except the
first can be optionally sorted by the user, via setting either
< code class = "varname" > MASTER_SORT_AWK< / code > or
< code class = "varname" > MASTER_SORT_REGEX< / code > .< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.checksum" > < / a > 15.6.<2E> The < span class = "emphasis" > < em > checksum< / em > < / span > phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > After the distfile(s) are fetched, their checksum is generated and
compared with the checksums stored in the distinfo file. If the
checksums don't match, the build is aborted. This is to ensure the same
distfile is used for building, and that the distfile wasn't changed,
e.g. by some malign force, deliberately changed distfiles on the master
distribution site or network lossage.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.extract" > < / a > 15.7.<2E> The < span class = "emphasis" > < em > extract< / em > < / span > phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > When the distfiles are present on the local system, they
need to be extracted, as they usually come in the form of some
compressed archive format.< / p >
< p > By default, all < code class = "varname" > DISTFILES< / code > are
extracted. If you only need some of them, you can set the
< code class = "varname" > EXTRACT_ONLY< / code > variable to the list of those
files.< / p >
< p > Extracting the files is usually done by a little program,
2006-05-29 10:55:59 +02:00
< code class = "filename" > mk/scripts/extract< / code > , which already knows how
2006-05-28 22:41:22 +02:00
to extract various archive formats, so most likely you will not
need to change anything here. But if you need, the following
variables may help you:< / p >
< div class = "variablelist" > < dl >
< dt > < span class = "term" > < code class = "varname" > EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}< / code > < / span > < / dt >
< dd > < p > Use these variables to override the default
options for an extract command, which are defined in
2006-05-29 10:55:59 +02:00
< code class = "filename" > mk/scripts/extract< / code > .< / p > < / dd >
2006-05-28 22:41:22 +02:00
< dt > < span class = "term" > < code class = "varname" > EXTRACT_USING< / code > < / span > < / dt >
< dd > < p > This variable can be set to
< code class = "literal" > pax< / code > , < code class = "literal" > tar< / code > or an absolute
pathname pointing to the command with which tar archives should
be extracted.< / p > < / dd >
< / dl > < / div >
2006-05-29 10:55:59 +02:00
< p > If the < code class = "filename" > extract< / code > program doesn't serve
2006-05-28 22:41:22 +02:00
your needs, you can also override the
< code class = "varname" > EXTRACT_CMD< / code > variable, which holds the command
used for extracting the files. This command is executed in the
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${WRKSRC}< / code > directory. During execution of
2006-05-28 22:41:22 +02:00
this command, the shell variable < code class = "varname" > extract_file< / code >
holds the absolute pathname of the file that is going to be
extracted.< / p >
< p > And if that still does not suffice, you can override the
< code class = "varname" > do-extract< / code > target in the package
Makefile.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.patch" > < / a > 15.8.<2E> The < span class = "emphasis" > < em > patch< / em > < / span > phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > After extraction, all the patches named by the
< code class = "varname" > PATCHFILES< / code > , those present in the patches
subdirectory of the package as well as in $LOCALPATCHES/$PKGPATH (e.g.
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/local/patches/graphics/png< / code > ) are applied.
Patchfiles ending in < code class = "filename" > .Z< / code > or
< code class = "filename" > .gz< / code > are uncompressed before they are applied,
files ending in < code class = "filename" > .orig< / code > or
< code class = "filename" > .rej< / code > are ignored. Any special options to < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > patch< / span > (1)< / span > < / a >
2006-05-28 22:41:22 +02:00
can be handed in < code class = "varname" > PATCH_DIST_ARGS< / code > .
2006-06-01 11:36:55 +02:00
See < a href = "#components.patches" title = "9.3.<2E> patches/*" > Section<EFBFBD> 9.3, “ patches/*” < / a > for more details.< / p >
2006-05-28 22:41:22 +02:00
< p > By default < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > patch< / span > (1)< / span > < / a > is given special args to make it fail if the
patches apply with some lines of fuzz. Please fix (regen) the patches
so that they apply cleanly. The rationale behind this is that
patches that don't apply cleanly may end up being applied in the wrong
place, and cause severe harm there.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.tools" > < / a > 15.9.<2E> The < span class = "emphasis" > < em > tools< / em > < / span > phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > This is covered in
2006-06-01 11:36:55 +02:00
< a href = "#tools" title = "Chapter<65> 16.<2E> Tools needed for building or running" > Chapter<EFBFBD> 16, < i > Tools needed for building or running< / i > < / a > .
2006-05-28 22:41:22 +02:00
< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.wrapper" > < / a > 15.10.<2E> The < span class = "emphasis" > < em > wrapper< / em > < / span > phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > This phase creates wrapper programs for the compilers and
linkers. The following variables can be used to tweak the
wrappers.< / p >
< div class = "variablelist" > < dl >
< dt > < span class = "term" > < code class = "varname" > ECHO_WRAPPER_MSG< / code > < / span > < / dt >
< dd > < p > The command used to print progress
messages. Does nothing by default. Set to
< code class = "literal" > ${ECHO}< / code > to see the progress
messages.< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > WRAPPER_DEBUG< / code > < / span > < / dt >
< dd > < p > This variable can be set to
< code class = "literal" > yes< / code > (default) or
< code class = "literal" > no< / code > , depending on whether you want
additional information in the wrapper log
file.< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > WRAPPER_UPDATE_CACHE< / code > < / span > < / dt >
< dd > < p > This variable can be set to
< code class = "literal" > yes< / code > or < code class = "literal" > no< / code > ,
depending on whether the wrapper should use its cache,
which will improve the speed. The default value is
< code class = "literal" > yes< / code > , but is forced to
< code class = "literal" > no< / code > if the platform does not support
it.< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > WRAPPER_REORDER_CMDS< / code > < / span > < / dt >
< dd > < p > A list of reordering commands. A
reordering command has the form
< code class = "literal" > reorder:l:< em class = "replaceable" > < code > lib1< / code > < / em > :< em class = "replaceable" > < code > lib2< / code > < / em > < / code > .
It ensures that that
< code class = "literal" > -l< em class = "replaceable" > < code > lib1< / code > < / em > < / code >
occurs before
< code class = "literal" > -l< em class = "replaceable" > < code > lib2< / code > < / em > < / code > .
< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > WRAPPER_TRANSFORM_CMDS< / code > < / span > < / dt >
< dd > < p > A list of transformation commands. [TODO:
investigate further]< / p > < / dd >
< / dl > < / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.configure" > < / a > 15.11.<2E> The < span class = "emphasis" > < em > configure< / em > < / span > phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Most pieces of software need information on the header files,
system calls, and library routines which are available on the platform
they run on. The process of determining this information is known as
configuration, and is usually automated. In most cases, a script is
supplied with the distfiles, and its invocation results in generation of
header files, Makefiles, etc.< / p >
< p > If the package contains a configure script, this can be invoked by
setting < code class = "varname" > HAS_CONFIGURE< / code > to “ < span class = "quote" > yes< / span > ” . If the
configure script is a GNU autoconf script, you should set
< code class = "varname" > GNU_CONFIGURE< / code > to “ < span class = "quote" > yes< / span > ” instead. What
happens in the < span class = "emphasis" > < em > configure< / em > < / span > phase is roughly:< / p >
< pre class = "programlisting" >
.for d in ${CONFIGURE_DIRS}
cd ${WRKSRC} & & cd ${d} & & env ${CONFIGURE_ENV} \
${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
.endfor
< / pre >
< p > < code class = "varname" > CONFIGURE_DIRS< / code > (default: “ < span class = "quote" > .< / span > ” ) is a
list of pathnames relative to < code class = "varname" > WRKSRC< / code > . In each of
these directories, the configure script is run with the environment
< code class = "varname" > CONFIGURE_ENV< / code > and arguments
< code class = "varname" > CONFIGURE_ARGS< / code > . The variables
< code class = "varname" > CONFIGURE_ENV< / code > , < code class = "varname" > CONFIGURE_SCRIPT< / code >
(default: “ < span class = "quote" > ./configure< / span > ” ) and
< code class = "varname" > CONFIGURE_ARGS< / code > may all be changed by the
package.< / p >
2006-05-29 10:55:59 +02:00
< p > If the program uses an < code class = "filename" > Imakefile< / code > for
2006-05-28 22:41:22 +02:00
configuration, the appropriate steps can be invoked by setting
< code class = "varname" > USE_IMAKE< / code > to “ < span class = "quote" > yes< / span > ” . (If you only want
the package installed in < code class = "varname" > ${X11PREFIX}< / code > but xmkmf not
being run, set < code class = "varname" > USE_X11BASE< / code > instead.)< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.build" > < / a > 15.12.<2E> The < span class = "emphasis" > < em > build< / em > < / span > phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > For building a package, a rough equivalent of the following code
is executed.< / p >
< pre class = "programlisting" >
.for d in ${BUILD_DIRS}
cd ${WRKSRC} & & cd ${d} & & env ${MAKE_ENV} \
${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
-f ${MAKEFILE} ${BUILD_TARGET}
.endfor
< / pre >
< p > < code class = "varname" > BUILD_DIRS< / code > (default: “ < span class = "quote" > .< / span > ” ) is a
list of pathnames relative to < code class = "varname" > WRKSRC< / code > . In each of
these directories, < code class = "varname" > MAKE_PROGRAM< / code > is run with the
environment < code class = "varname" > MAKE_ENV< / code > and arguments
< code class = "varname" > BUILD_MAKE_FLAGS< / code > . The variables
< code class = "varname" > MAKE_ENV< / code > , < code class = "varname" > BUILD_MAKE_FLAGS< / code > ,
< code class = "varname" > MAKEFILE< / code > and < code class = "varname" > BUILD_TARGET< / code > may all
be changed by the package.< / p >
< p > The default value of < code class = "varname" > MAKE_PROGRAM< / code > is
“ < span class = "quote" > gmake< / span > ” if < code class = "varname" > USE_TOOLS< / code > contains
“ < span class = "quote" > gmake< / span > ” , “ < span class = "quote" > make< / span > ” otherwise. The default value
of < code class = "varname" > MAKEFILE< / code > is “ < span class = "quote" > Makefile< / span > ” , and
< code class = "varname" > BUILD_TARGET< / code > defaults to “ < span class = "quote" > all< / span > ” .< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.test" > < / a > 15.13.<2E> The < span class = "emphasis" > < em > test< / em > < / span > phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > [TODO]< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.install" > < / a > 15.14.<2E> The < span class = "emphasis" > < em > install< / em > < / span > phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Once the build stage has completed, the final step is to
install the software in public directories, so users can access
the programs and files.< / p >
< p > In the < span class = "emphasis" > < em > install< / em > < / span > phase, a rough
equivalent of the following code is executed. Additionally,
before and after this code, much magic is performed to do
consistency checks, registering the package, and so on.< / p >
< pre class = "programlisting" >
.for d in ${INSTALL_DIRS}
cd ${WRKSRC} & & cd ${d} & & env ${MAKE_ENV} \
${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
-f ${MAKEFILE} ${BUILD_TARGET}
.endfor
< / pre >
< p > The variable's meanings are analogous to the ones in the
< span class = "emphasis" > < em > build< / em > < / span > phase.
< code class = "varname" > INSTALL_DIRS< / code > defaults to
< code class = "varname" > BUILD_DIRS< / code > . < code class = "varname" > INSTALL_TARGET< / code >
is “ < span class = "quote" > install< / span > ” by default, plus
“ < span class = "quote" > install.man< / span > ” if < code class = "varname" > USE_IMAKE< / code > is
defined.< / p >
< p > In the < span class = "emphasis" > < em > install< / em > < / span > phase, the following
variables are useful. They are all variations of the
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > install< / span > (1)< / span > < / a > command that have the owner, group and
permissions preset. < code class = "varname" > INSTALL< / code > is the plain
install command. The specialized variants, together with their
intended use, are:< / p >
< div class = "variablelist" > < dl >
< dt > < span class = "term" > < code class = "varname" > INSTALL_PROGRAM_DIR< / code > < / span > < / dt >
< dd > < p > directories that contain binaries< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > INSTALL_SCRIPT_DIR< / code > < / span > < / dt >
< dd > < p > directories that contain scripts< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > INSTALL_LIB_DIR< / code > < / span > < / dt >
< dd > < p > directories that contain shared and static libraries< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > INSTALL_DATA_DIR< / code > < / span > < / dt >
< dd > < p > directories that contain data files< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > INSTALL_MAN_DIR< / code > < / span > < / dt >
< dd > < p > directories that contain man pages< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > INSTALL_PROGRAM< / code > < / span > < / dt >
< dd > < p > binaries that can be stripped from debugging symbols< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > INSTALL_SCRIPT< / code > < / span > < / dt >
< dd > < p > binaries that cannot be stripped< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > INSTALL_GAME< / code > < / span > < / dt >
< dd > < p > game binaries< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > INSTALL_LIB< / code > < / span > < / dt >
< dd > < p > shared and static libraries< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > INSTALL_DATA< / code > < / span > < / dt >
< dd > < p > data files< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > INSTALL_GAME_DATA< / code > < / span > < / dt >
< dd > < p > data files for games< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > INSTALL_MAN< / code > < / span > < / dt >
< dd > < p > man pages< / p > < / dd >
< / dl > < / div >
< p > Some other variables are:< / p >
< div class = "variablelist" > < dl >
< dt > < span class = "term" > < code class = "varname" > INSTALLATION_DIRS< / code > < / span > < / dt >
< dd > < p > A list of directories relative to
< code class = "varname" > PREFIX< / code > that are created by pkgsrc at
the beginning of the < span class = "emphasis" > < em > install< / em > < / span > phase. If
this variable is set,
< code class = "varname" > NO_MTREE< / code > =“ < span class = "quote" > yes< / span > ” is
assumed, which means that the package claims to create
all needed directories itself before installing files to
it. Therefore this variable should only be set in
2006-05-29 10:55:59 +02:00
< code class = "filename" > Makefile< / code > s that are under control of
2006-05-28 22:41:22 +02:00
the package's author.< / p > < / dd >
< / dl > < / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.package" > < / a > 15.15.<2E> The < span class = "emphasis" > < em > package< / em > < / span > phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > [TODO]< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "build.helpful-targets" > < / a > 15.16.<2E> Other helpful targets< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "variablelist" > < dl >
< dt > < span class = "term" > pre/post-*< / span > < / dt >
< dd > < p > For any of the main targets described in the previous section, two
auxiliary targets exist with “ < span class = "quote" > pre-< / span > ” and
“ < span class = "quote" > post-< / span > ” used as a prefix
for the main target's name. These targets are invoked before and
after the main target is called, allowing extra configuration or
installation steps be performed from a package's Makefile, for
example, which a program's configure script
or install target omitted.< / p > < / dd >
< dt > < span class = "term" > do-*< / span > < / dt >
< dd > < p > Should one of the main targets do the wrong thing, and should there
be no variable to fix this, you can redefine it with the do-*
target. (Note that redefining the target itself instead of the
do-* target is a bad idea, as the pre-* and post-* targets won't be
called anymore, etc.) You will not usually need to do this.< / p > < / dd >
< dt > < span class = "term" > reinstall< / span > < / dt >
< dd > < p > If you did a < span > < strong class = "command" > make install< / strong > < / span > and you noticed some file
was not installed properly, you can repeat the installation with this
target, which will ignore the “ < span class = "quote" > already installed< / span > ” flag.< / p > < / dd >
< dt > < span class = "term" > deinstall< / span > < / dt >
< dd >
< p > This target does a < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_delete< / span > (1)< / span > < / a > in the current directory,
effectively de-installing the package. The following variables can
be used to tune the behaviour:< / p >
< div class = "variablelist" > < dl >
< dt > < span class = "term" > < code class = "varname" > PKG_VERBOSE< / code > < / span > < / dt >
< dd > < p > Add a "-v" to the < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_delete< / span > (1)< / span > < / a > command.< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > DEINSTALLDEPENDS< / code > < / span > < / dt >
< dd > < p > Remove all packages that require (depend on) the given package.
This can be used to remove any packages that may have been pulled in
by a given package, e.g. if < span > < strong class = "command" > make deinstall
DEINSTALLDEPENDS=1< / strong > < / span > is done in
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/x11/kde< / code > , this is likely to remove whole
2006-05-28 22:41:22 +02:00
KDE. Works by adding “ < span class = "quote" > -R< / span > ” to the < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_delete< / span > (1)< / span > < / a > command line.< / p > < / dd >
< / dl > < / div >
< / dd >
< dt > < span class = "term" > update< / span > < / dt >
< dd >
< p > This target causes the current package to be updated to the latest
version. The package and all depending packages first get de-installed,
then current versions of the corresponding packages get compiled and
installed. This is similar to manually noting which packages are
currently installed, then performing a series of < span > < strong class = "command" > make
deinstall< / strong > < / span > and < span > < strong class = "command" > make install< / strong > < / span > (or whatever
< code class = "varname" > UPDATE_TARGET< / code > is set to) for these packages.< / p >
< p > You can use the “ < span class = "quote" > update< / span > ” target to resume package
updating in case a previous < span > < strong class = "command" > make update< / strong > < / span > was interrupted
for some reason. However, in this case, make sure you don't call
< span > < strong class = "command" > make clean< / strong > < / span > or otherwise remove the list of dependent
packages in < code class = "varname" > WRKDIR< / code > . Otherwise, you lose the
ability to automatically update the current package along with the
dependent packages you have installed.< / p >
< p > Resuming an interrupted < span > < strong class = "command" > make update< / strong > < / span > will only work as
long as the package tree remains unchanged. If the source code for
one of the packages to be updated has been changed, resuming
< span > < strong class = "command" > make update< / strong > < / span > will most certainly fail!< / p >
< p > The following variables can be used either on the command line or in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > to alter the behaviour of
2006-05-28 22:41:22 +02:00
< span > < strong class = "command" > make update< / strong > < / span > :< / p >
< div class = "variablelist" > < dl >
< dt > < span class = "term" > < code class = "varname" > UPDATE_TARGET< / code > < / span > < / dt >
< dd > < p > Install target to recursively use for the updated package and the
dependent packages. Defaults to < code class = "varname" > DEPENDS_TARGET< / code > if set,
“ < span class = "quote" > install< / span > ” otherwise for < span > < strong class = "command" > make update< / strong > < / span > .
e.g. < span > < strong class = "command" > make update UPDATE_TARGET=package< / strong > < / span > < / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > NOCLEAN< / code > < / span > < / dt >
< dd > < p > Don't clean up after updating. Useful if you want to leave the
work sources of the updated packages around for inspection or
other purposes. Be sure you eventually clean up the source
tree (see the “ < span class = "quote" > clean-update< / span > ” target below) or you may
run into troubles with old source code still lying around on your
next < span > < strong class = "command" > make< / strong > < / span > or < span > < strong class = "command" > make update< / strong > < / span > .< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > REINSTALL< / code > < / span > < / dt >
< dd > < p > Deinstall each package before installing (making
< code class = "varname" > DEPENDS_TARGET< / code > ). This may be necessary if the
“ < span class = "quote" > clean-update< / span > ” target (see below) was called after
interrupting a running < span > < strong class = "command" > make update< / strong > < / span > .< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > DEPENDS_TARGET< / code > < / span > < / dt >
< dd > < p > Allows you to disable recursion and hardcode the target for
packages. The default is “ < span class = "quote" > update< / span > ” for the update target,
facilitating a recursive update of prerequisite packages.
Only set < code class = "varname" > DEPENDS_TARGET< / code > if you want to disable
recursive updates. Use < code class = "varname" > UPDATE_TARGET< / code > instead to just
set a specific target for each package to be installed during
< span > < strong class = "command" > make update< / strong > < / span > (see above).< / p > < / dd >
< / dl > < / div >
< / dd >
< dt > < span class = "term" > clean-update< / span > < / dt >
< dd >
< p > Clean the source tree for all packages that would get updated if
< span > < strong class = "command" > make update< / strong > < / span > was called from the current directory.
This target should not be used if the current package (or any of its
depending packages) have already been de-installed (e.g., after calling
< span > < strong class = "command" > make update< / strong > < / span > ) or you may lose some packages you intended
to update. As a rule of thumb: only use this target
< span class = "emphasis" > < em > before< / em > < / span > the first time you run
< span > < strong class = "command" > make update< / strong > < / span > and only if you have a dirty package tree
(e.g., if you used < code class = "varname" > NOCLEAN< / code > ).< / p >
< p > If you are unsure about whether your tree is clean, you can either
perform a < span > < strong class = "command" > make clean< / strong > < / span > at the top of the tree, or use
the following sequence of commands from the directory of the package
you want to update (< span class = "emphasis" > < em > before< / em > < / span > running
< span > < strong class = "command" > make update< / strong > < / span > for the first time, otherwise you lose
all the packages you wanted to update!):< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > make clean-update< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > make clean CLEANDEPENDS=YES< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > make update< / code > < / strong > < / pre >
< p > The following variables can be used either on the command line or in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > to alter the behaviour of
2006-05-28 22:41:22 +02:00
< span > < strong class = "command" > make clean-update< / strong > < / span > :< / p >
< div class = "variablelist" > < dl >
< dt > < span class = "term" > < code class = "varname" > CLEAR_DIRLIST< / code > < / span > < / dt >
< dd > < p > After < span > < strong class = "command" > make clean< / strong > < / span > , do not reconstruct the list of
directories to update for this package. Only use this if < span > < strong class = "command" > make
update< / strong > < / span > successfully installed all packages you wanted to
update. Normally, this is done automatically on < span > < strong class = "command" > make
update< / strong > < / span > , but may have been suppressed by the
< code class = "varname" > NOCLEAN< / code > variable (see above).< / p > < / dd >
< / dl > < / div >
< / dd >
< dt > < span class = "term" > info< / span > < / dt >
< dd > < p > This target invokes < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_info< / span > (1)< / span > < / a > for the current
package. You can use this to check which version of a package is
installed.< / p > < / dd >
< dt > < span class = "term" > readme< / span > < / dt >
2006-05-29 10:55:59 +02:00
< dd > < p > This target generates a < code class = "filename" > README.html< / code > file, which
2006-05-28 22:41:22 +02:00
can be viewed using a browser such as
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/www/mozilla/README.html" target = "_top" > < code class = "filename" > www/mozilla< / code > < / a > or
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/www/links/README.html" target = "_top" > < code class = "filename" > www/links< / code > < / a > .
2006-05-28 22:41:22 +02:00
The generated files contain references to any
packages which are in the < code class = "varname" > PACKAGES< / code > directory on
the local host. The generated files can be made to refer to URLs based on
< code class = "varname" > FTP_PKG_URL_HOST< / code > and
< code class = "varname" > FTP_PKG_URL_DIR< / code > . For example, if I wanted to generate
2006-05-29 10:55:59 +02:00
< code class = "filename" > README.html< / code > files which pointed to binary packages
2006-05-28 22:41:22 +02:00
on the local machine, in the directory
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/packages< / code > , set
2006-05-28 22:41:22 +02:00
< code class = "varname" > FTP_PKG_URL_HOST=file://localhost< / code > and
< code class = "varname" > FTP_PKG_URL_DIR=/usr/packages< / code > . The
< code class = "varname" > ${PACKAGES}< / code > directory and its subdirectories will be
searched for all the binary packages.< / p > < / dd >
< dt > < span class = "term" > readme-all< / span > < / dt >
2006-05-29 10:55:59 +02:00
< dd > < p > Use this target to create a file < code class = "filename" > README-all.html< / code >
2006-05-28 22:41:22 +02:00
which contains a list of all packages currently available in the NetBSD
Packages Collection, together with the category they belong to and a
short description. This file is compiled from the
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/*/README.html< / code > files, so be sure to run
2006-05-28 22:41:22 +02:00
this < span class = "emphasis" > < em > after< / em > < / span > a < span > < strong class = "command" > make readme< / strong > < / span > .< / p > < / dd >
< dt > < span class = "term" > cdrom-readme< / span > < / dt >
< dd > < p > This is very much the same as the “ < span class = "quote" > readme< / span > ” target (see
above), but is to be used when generating a pkgsrc tree to be written
to a CD-ROM. This target also produces
2006-05-29 10:55:59 +02:00
< code class = "filename" > README.html< / code > files, and can be made to refer
2006-05-28 22:41:22 +02:00
to URLs based on < code class = "varname" > CDROM_PKG_URL_HOST< / code > and
< code class = "varname" > CDROM_PKG_URL_DIR< / code > .< / p > < / dd >
< dt > < span class = "term" > show-distfiles< / span > < / dt >
< dd > < p > This target shows which distfiles and patchfiles are needed to build
the package. (< code class = "varname" > DISTFILES< / code > and
2006-05-29 10:55:59 +02:00
< code class = "varname" > PATCHFILES< / code > , but not < code class = "filename" > patches/*< / code > )< / p > < / dd >
2006-05-28 22:41:22 +02:00
< dt > < span class = "term" > show-downlevel< / span > < / dt >
< dd > < p > This target shows nothing if the package is not installed. If a version
of this package is installed, but is not the version provided in this
version of pkgsrc, then a warning message is displayed. This target can
be used to show which of your installed packages are downlevel, and so
the old versions can be deleted, and the current ones added.< / p > < / dd >
< dt > < span class = "term" > show-pkgsrc-dir< / span > < / dt >
< dd > < p > This target shows the directory in the pkgsrc hierarchy from which the
package can be built and installed. This may not be the same directory
as the one from which the package was installed. This target is intended
to be used by people who may wish to upgrade many packages on a single
host, and can be invoked from the top-level pkgsrc Makefile by using the
“ < span class = "quote" > show-host-specific-pkgs< / span > ” target.< / p > < / dd >
< dt > < span class = "term" > show-installed-depends< / span > < / dt >
< dd > < p > This target shows which installed packages match the current package's
< code class = "varname" > DEPENDS< / code > . Useful if out of date dependencies are
causing build problems.< / p > < / dd >
< dt > < span class = "term" > check-shlibs< / span > < / dt >
< dd > < p > After a package is installed, check all its binaries and (on ELF
platforms) shared libraries to see if they find the shared libs they need.
Run by default if < code class = "varname" > PKG_DEVELOPER< / code > is set in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > .< / p > < / dd >
2006-05-28 22:41:22 +02:00
< dt > < span class = "term" > print-PLIST< / span > < / dt >
< dd >
< p > After a “ < span class = "quote" > make install< / span > ” from a new or
upgraded pkg, this prints out an attempt to generate a new
2006-05-29 10:55:59 +02:00
< code class = "filename" > PLIST< / code > from a < span > < strong class = "command" > find -newer
2006-05-28 22:41:22 +02:00
work/.extract_done< / strong > < / span > . An attempt is made to care
for shared libs etc., but it is
< span class = "emphasis" > < em > strongly< / em > < / span > recommended to review the
result before putting it into
2006-05-29 10:55:59 +02:00
< code class = "filename" > PLIST< / code > . On upgrades, it's useful to
2006-05-28 22:41:22 +02:00
diff the output of this command against an already
2006-05-29 10:55:59 +02:00
existing < code class = "filename" > PLIST< / code > file.< / p >
2006-05-28 22:41:22 +02:00
< p > If the package installs files via < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > tar< / span > (1)< / span > < / a > or other
methods that don't update file access times, be sure to
add these files manually to your
2006-05-29 10:55:59 +02:00
< code class = "filename" > PLIST< / code > , as the “ < span class = "quote" > find
2006-05-28 22:41:22 +02:00
-newer< / span > ” command used by this target won't catch
them!< / p >
2006-06-01 11:36:55 +02:00
< p > See < a href = "#print-PLIST" title = "11.3.<2E> Tweaking output of make print-PLIST" > Section<EFBFBD> 11.3, “ Tweaking output of < span > < strong class = "command" > make print-PLIST< / strong > < / span > ” < / a > for more
2006-05-28 22:41:22 +02:00
information on this target.< / p >
< / dd >
< dt > < span class = "term" > bulk-package< / span > < / dt >
< dd >
< p > Used to do bulk builds. If an appropriate binary package already exists,
no action is taken. If not, this target will compile, install and
package it (and its depends, if < code class = "varname" > PKG_DEPENDS< / code > is
set properly. See < a href = "#binary.configuration" title = "6.3.1.<2E> Configuration" > Section<EFBFBD> 6.3.1, “ Configuration” < / a > ).
After creating the binary
package, the sources, the just-installed package and its required
packages are removed, preserving free disk space.< / p >
< p > < span class = "emphasis" > < em > Beware that this target may deinstall all
packages installed on a system!< / em > < / span > < / p >
< / dd >
< dt > < span class = "term" > bulk-install< / span > < / dt >
< dd >
< p > Used during bulk-installs to install required packages. If an
up-to-date binary package is available, it will be installed via
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_add< / span > (1)< / span > < / a > . If not, < span > < strong class = "command" > make bulk-package< / strong > < / span > will be executed,
but the installed binary won't be removed. < / p >
< p > A binary package is considered “ < span class = "quote" > up-to-date< / span > ” to be
installed via < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_add< / span > (1)< / span > < / a > if:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
2006-05-29 10:55:59 +02:00
< li > < p > None of the package's files (< code class = "filename" > Makefile< / code > ,
2006-05-28 22:41:22 +02:00
...) were modified since it was built.< / p > < / li >
< li > < p > None of the package's required (binary) packages were
modified since it was built.< / p > < / li >
< / ul > < / div >
< p > < span class = "emphasis" > < em > Beware that this target may deinstall all
packages installed on a system!< / em > < / span > < / p >
< / dd >
< / dl > < / div >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "tools" > < / a > Chapter<EFBFBD> 16.<2E> Tools needed for building or running< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#pkgsrc-tools" > 16.1. Tools for pkgsrc builds< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#package-tools" > 16.2. Tools needed by packages< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#platform-tools" > 16.3. Tools provided by platforms< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl >
< / div >
< p >
The < code class = "varname" > USE_TOOLS< / code > definition is used both internally
by pkgsrc and also for individual packages to define what commands
are needed for building a package (like < code class = "varname" > BUILD_DEPENDS< / code > )
or for later run-time of an installed packaged (such as
< code class = "varname" > DEPENDS< / code > ).
If the native system provides an adequate tool, then in many cases, a pkgsrc
package will not be used.
< / p >
< p >
When building a package, the replacement tools are
made available in a directory (as symlinks or wrapper scripts)
that is early in the executable search path. Just like the buildlink
system, this helps with consistent builds.
< / p >
< p >
A tool may be needed to help build a specific package. For example,
perl, GNU make (gmake) or yacc may be needed.
< / p >
< p >
Also a tool may be needed, for example, because the native system's supplied
tool may be inefficient for building a package with pkgsrc.
For example, a package may need GNU awk, bison (instead of
yacc) or a better sed.
< / p >
< p >
The tools used by a package can be listed by running
< span > < strong class = "command" > make show-tools< / strong > < / span > .
< / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "pkgsrc-tools" > < / a > 16.1.<2E> Tools for pkgsrc builds< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p >
The default set of tools used by pkgsrc is defined in
2006-05-29 10:55:59 +02:00
< code class = "filename" > bsd.pkg.mk< / code > . This includes standard Unix tools,
2006-05-28 22:41:22 +02:00
such as: < span > < strong class = "command" > cat< / strong > < / span > , < span > < strong class = "command" > awk< / strong > < / span > ,
< span > < strong class = "command" > chmod< / strong > < / span > , < span > < strong class = "command" > test< / strong > < / span > , and so on.
These can be seen by running:
< span > < strong class = "command" > make show-var VARNAME=USE_TOOLS< / strong > < / span > .
< / p >
< p >
If a package needs a specific program to build
then the < code class = "varname" > USE_TOOLS< / code > variable can be used
to define the tools needed.
< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "package-tools" > < / a > 16.2.<2E> Tools needed by packages< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p >
In the following examples, the :pkgsrc means to use the pkgsrc version
and not the native version for a build dependency.
And the :run means that it is used for a
run-time dependencies also (and becomes a DEPENDS).
The default is a build dependency which can be set with
:build. (So in this example, it is the same as gmake:build
and pkg-config:build.)
< / p >
< pre class = "programlisting" >
USE_TOOLS+= mktemp:pkgsrc
USE_TOOLS+= gmake perl:run pkg-config
< / pre >
< p >
When using the tools framework, a
< code class = "varname" > TOOLS_PATH.foo< / code > variable is defined
which contains the full path to the appropriate tool. For example,
< code class = "varname" > TOOLS_PATH.bash< / code > could be “ < span class = "quote" > /bin/bash< / span > ”
on Linux systems.
< / p >
< p >
If you always need a pkgsrc version of the
tool at run-time, then just use < code class = "varname" > DEPENDS< / code > instead.
< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "platform-tools" > < / a > 16.3.<2E> Tools provided by platforms< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p >
When improving or porting pkgsrc to a new platform, have a look
at (or create) the corresponding platform specific make file fragment under
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/mk/tools/tools.${OPSYS}.mk< / code > which defines
2006-05-28 22:41:22 +02:00
the name of the common tools. For example:< / p >
< pre class = "programlisting" >
.if exists(/usr/bin/bzcat)
TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
.elif exists(/usr/bin/bzip2)
TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
.endif
2006-02-18 18:18:14 +01:00
2006-05-28 22:41:22 +02:00
TOOLS_PLATFORM.true?= true # shell builtin
< / pre >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "fixes" > < / a > Chapter<EFBFBD> 17.<2E> Making your package work< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#general-operation" > 17.1. General operation< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#pulling-vars-from-etc-mk.conf" > 17.1.1. How to pull in variables from /etc/mk.conf< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#where-to-install-documentation" > 17.1.2. Where to install documentation< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#restricted-packages" > 17.1.3. Restricted packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#dependencies" > 17.1.4. Handling dependencies< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#conflicts" > 17.1.5. Handling conflicts with other packages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#not-building-packages" > 17.1.6. Packages that cannot or should not be built< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#undeletable-packages" > 17.1.7. Packages which should not be deleted, once installed< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#security-handling" > 17.1.8. Handling packages with security problems< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#compiler-bugs" > 17.1.9. How to handle compiler bugs< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#bumping-pkgrevision" > 17.1.10. How to handle incrementing versions when fixing an existing package< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#portability-of-packages" > 17.1.11. Portability of packages< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#fixes.fetch" > 17.2. Fixing problems in the < span class = "emphasis" > < em > fetch< / em > < / span > phase< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#no-plain-download" > 17.2.1. Packages whose distfiles aren't available for plain downloading< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#modified-distfiles-same-name" > 17.2.2. How to handle modified distfiles with the 'old' name< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#fixes.configure" > 17.3. Fixing problems in the < span class = "emphasis" > < em > configure< / em > < / span > phase< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#fixes.libtool" > 17.3.1. Shared libraries - libtool< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#using-libtool" > 17.3.2. Using libtool on GNU packages that already support libtool< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#autoconf-automake" > 17.3.3. GNU Autoconf/Automake< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#fixes.build" > 17.4. Fixing problems in the < span class = "emphasis" > < em > build< / em > < / span > phase< / a > < / span > < / dt >
< dd > < dl > < dt > < span class = "sect2" > < a href = "#fixes.build.cpp" > 17.4.1. Compiling C and C++ code conditionally< / a > < / span > < / dt > < / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#package-specific-actions" > 17.5. Package specific actions< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#user-interaction" > 17.5.1. User interaction< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#handling-licenses" > 17.5.2. Handling licenses< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#fixes.install" > 17.6. Fixing problems in the < span class = "emphasis" > < em > install< / em > < / span > phase< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#installing-score-files" > 17.6.1. Installing score files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#perl-scripts" > 17.6.2. Packages containing perl scripts< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#hardcoded-paths" > 17.6.3. Packages with hardcoded paths to other interpreters< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#perl-modules" > 17.6.4. Packages installing perl modules< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#faq.info-files" > 17.6.5. Packages installing info files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#manpages" > 17.6.6. Packages installing man pages< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#gconf2-data-files" > 17.6.7. Packages installing GConf2 data files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#scrollkeeper-data-files" > 17.6.8. Packages installing scrollkeeper data files< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#x11-fonts" > 17.6.9. Packages installing X11 fonts< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#gtk2-modules" > 17.6.10. Packages installing GTK2 modules< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#sgml-xml-data" > 17.6.11. Packages installing SGML or XML data< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#mime-database" > 17.6.12. Packages installing extensions to the MIME database< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#intltool" > 17.6.13. Packages using intltool< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#startup-scripts" > 17.6.14. Packages installing startup scripts< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#tex-packages" > 17.6.15. Packages installing TeX modules< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#feedback-to-author" > 17.7. Feedback to the author< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "general-operation" > < / a > 17.1.<2E> General operation< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "pulling-vars-from-etc-mk.conf" > < / a > 17.1.1.<2E> How to pull in variables from /etc/mk.conf< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > The problem with package-defined variables that can be
overridden via < code class = "varname" > MAKECONF< / code > or
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > is that < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > make< / span > (1)< / span > < / a > expands a
2006-05-28 22:41:22 +02:00
variable as it is used, but evaluates preprocessor-like
statements (.if, .ifdef and .ifndef) as they are read. So, to
use any variable (which may be set in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > ) in one of the .if*
statements, the file < code class = "filename" > /etc/mk.conf< / code > must be
2006-05-28 22:41:22 +02:00
included before that .if* statement.< / p >
< p > Rather than having a number of ad-hoc ways of including
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > , should it exist, or
2006-05-28 22:41:22 +02:00
< code class = "varname" > MAKECONF< / code > , should it exist, include the
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/mk/bsd.prefs.mk< / code > file in the package
2006-05-28 22:41:22 +02:00
Makefile before any preprocessor-like .if, .ifdef, or .ifndef
statements:< / p >
< pre class = "programlisting" >
.include "../../mk/bsd.prefs.mk"
2006-02-18 18:18:14 +01:00
2006-05-28 22:41:22 +02:00
.if defined(USE_MENUS)
# ...
.endif
< / pre >
< p > If you wish to set the < code class = "varname" > CFLAGS< / code > variable
2006-05-29 10:55:59 +02:00
in < code class = "filename" > /etc/mk.conf< / code > , please make sure to use:
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
< / p >
< pre class = "programlisting" >
CFLAGS+= -your -flags
< / pre >
< p >
Using < code class = "varname" > CFLAGS=< / code > (i.e. without the
“ < span class = "quote" > +< / span > ” ) may lead to problems with packages that need
to add their own flags. Also, you may want to take a look at
2006-05-29 10:55:59 +02:00
the < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/devel/cpuflags/README.html" target = "_top" > < code class = "filename" > devel/cpuflags< / code > < / a > package if
2006-05-28 22:41:22 +02:00
you're interested in optimization for the current CPU.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "where-to-install-documentation" > < / a > 17.1.2.<2E> Where to install documentation< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Documentation should be installed into
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${PREFIX}/share/doc/${PKGBASE}< / code > or
< code class = "filename" > ${PREFIX}/share/doc/${PKGNAME}< / code > (the
2006-05-28 22:41:22 +02:00
latter includes the version number of the package).< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "restricted-packages" > < / a > 17.1.3.<2E> Restricted packages< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Some licenses restrict how software may be re-distributed.
In order to satisfy these restrictions, the package system
defines five make variables that can be set to note these
restrictions:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li >
< p > < code class = "varname" > RESTRICTED< / code > < / p >
< p > This variable should be set whenever a restriction
exists (regardless of its kind). Set this variable to a
string containing the reason for the restriction.< / p >
< / li >
< li >
< p > < code class = "varname" > NO_BIN_ON_CDROM< / code > < / p >
< p > Binaries may not be placed on CD-ROM. Set this
variable to < code class = "varname" > ${RESTRICTED}< / code > whenever a
binary package may not be included on a CD-ROM.< / p >
< / li >
< li >
< p > < code class = "varname" > NO_BIN_ON_FTP< / code > < / p >
< p > Binaries may not be placed on an FTP server. Set
this variable to < code class = "varname" > ${RESTRICTED}< / code >
whenever a binary package may not not be made available
on the Internet.< / p >
< / li >
< li >
< p > < code class = "varname" > NO_SRC_ON_CDROM< / code > < / p >
< p > Distfiles may not be placed on CD-ROM. Set this
variable to < code class = "varname" > ${RESTRICTED}< / code > if
re-distribution of the source code or other distfile(s) is
not allowed on CD-ROMs.< / p >
< / li >
< li >
< p > < code class = "varname" > NO_SRC_ON_FTP< / code > < / p >
< p > Distfiles may not be placed on FTP. Set this variable
to < code class = "varname" > ${RESTRICTED}< / code > if re-distribution of
the source code or other distfile(s) via the Internet is not
allowed.< / p >
< / li >
< / ul > < / div >
< p > Please note that the use of < code class = "varname" > NO_PACKAGE< / code > ,
< code class = "varname" > IGNORE< / code > , < code class = "varname" > NO_CDROM< / code > , or other
generic make variables to denote restrictions is deprecated,
because they unconditionally prevent users from generating
binary packages!< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "dependencies" > < / a > 17.1.4.<2E> Handling dependencies< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Your package may depend on some other package being present
- and there are various ways of expressing this
dependency. pkgsrc supports the < code class = "varname" > BUILD_DEPENDS< / code >
and < code class = "varname" > DEPENDS< / code > definitions, the
< code class = "varname" > USE_TOOLS< / code > definition, as well as
2006-05-29 10:55:59 +02:00
dependencies via < code class = "filename" > buildlink3.mk< / code > , which is
2006-05-28 22:41:22 +02:00
the preferred way to handle dependencies, and which uses the
2006-06-01 11:36:55 +02:00
variables named above. See < a href = "#buildlink" title = "Chapter<65> 12.<2E> Buildlink methodology" > Chapter<EFBFBD> 12, < i > Buildlink methodology< / i > < / a > for more
2006-05-28 22:41:22 +02:00
information.< / p >
< p > The basic difference between the two variables is as
follows: The < code class = "varname" > DEPENDS< / code > definition registers
that pre-requisite in the binary package so it will be pulled in
when the binary package is later installed, whilst the
< code class = "varname" > BUILD_DEPENDS< / code > definition does not, marking a
dependency that is only needed for building the package.
< / p >
< p > This means that if you only need a package present whilst
you are building, it should be noted as a
< code class = "varname" > BUILD_DEPENDS< / code > .< / p >
< p > The format for a < code class = "varname" > BUILD_DEPENDS< / code > and a
< code class = "varname" > DEPENDS< / code > definition is:< / p >
< pre class = "programlisting" >
< pre-req-package-name> :../../< category> /< pre-req-package>
< / pre >
< p > Please note that the “ < span class = "quote" > pre-req-package-name< / span > ”
may include any of the wildcard version numbers recognized by
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_info< / span > (1)< / span > < / a > .< / p >
< div class = "orderedlist" > < ol type = "1" >
< li >
< p > If your package needs another package's binaries or
libraries to build or run, and if that package has a
2006-05-29 10:55:59 +02:00
< code class = "filename" > buildlink3.mk< / code > file available, use it:
2006-05-28 22:41:22 +02:00
< / p >
< pre class = "programlisting" >
.include "../../graphics/jpeg/buildlink3.mk"
< / pre >
< / li >
< li >
< p > If your package needs to use another package to build
2006-05-29 10:55:59 +02:00
itself and there is no < code class = "filename" > buildlink3.mk< / code >
2006-05-28 22:41:22 +02:00
file available, use the < code class = "varname" > BUILD_DEPENDS< / code >
definition:< / p >
< pre class = "programlisting" >
BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
< / pre >
< / li >
< li >
< p > If your package needs a library with which to link and
2006-05-29 10:55:59 +02:00
again there is no < code class = "filename" > buildlink3.mk< / code > file
2006-05-28 22:41:22 +02:00
available, this is specified using the
< code class = "varname" > DEPENDS< / code > definition. For example:< / p >
< pre class = "programlisting" >
DEPENDS+= xpm-3.4j:../../graphics/xpm
< / pre >
< p > You can also use wildcards in package dependences:< / p >
< pre class = "programlisting" >
DEPENDS+= xpm-[0-9]*:../../graphics/xpm
< / pre >
< p > Note that such wildcard dependencies are retained when
creating binary packages. The dependency is checked when
installing the binary package and any package which matches
the pattern will be used. Wildcard dependencies should be
used with care.< / p >
< p > The “ < span class = "quote" > -[0-9]*< / span > ” should be used instead of
“ < span class = "quote" > -*< / span > ” to avoid potentially ambiguous matches
such as “ < span class = "quote" > tk-postgresql< / span > ” matching a
“ < span class = "quote" > tk-*< / span > ” < code class = "varname" > DEPENDS< / code > .< / p >
< p > Wildcards can also be used to specify that a package
will only build against a certain minimum version of a
pre-requisite:< / p >
< pre class = "programlisting" >
DEPENDS+= tiff> =3.5.4:../../graphics/tiff
< / pre >
< p > This means that the package will build against version
3.5.4 of the tiff library or newer. Such a dependency may
be warranted if, for example, the API of the library has
changed with version 3.5.4 and a package would not compile
against an earlier version of tiff.< / p >
< p > Please note that such dependencies should only be
updated if a package requires a newer pre-requisite, but
not to denote recommendations such as
ABI changes that do not prevent a package from building
correctly. Such recommendations can be expressed using
< code class = "varname" > ABI_DEPENDS< / code > :< / p >
< pre class = "programlisting" >
ABI_DEPENDS+= tiff> =3.6.1:../../graphics/tiff
< / pre >
< p > In addition to the above < code class = "varname" > DEPENDS< / code >
line, this denotes that while a package will build against
tiff> =3.5.4, at least version 3.6.1 is recommended.
< code class = "varname" > ABI_DEPENDS< / code > entries will be turned into
dependencies unless explicitly ignored (in which case a
warning will be printed).< / p >
< p > To ignore these ABI dependency recommendations and just
use the required < code class = "varname" > DEPENDS< / code > , set
< code class = "varname" > USE_ABI_DEPENDS=NO< / code > . This may make
it easier and faster to update packages built using pkgsrc,
since older compatible dependencies can continue to be
used. This is useful for people who watch their rebuilds
very carefully; it is not very good as a general-purpose
hammer. If you use it, you need to be mindful of possible
ABI changes, including those from the underlying OS.
< / p >
< p > Packages that are built with recommendations ignored
may not be uploaded to ftp.NetBSD.org by developers and
should not be used across different systems that may have
different versions of binary packages installed.< / p >
< p > For security fixes, please update the package
2006-06-01 11:36:55 +02:00
vulnerabilities file. See < a href = "#security-handling" title = "17.1.8.<2E> Handling packages with security problems" > Section<EFBFBD> 17.1.8, “ Handling packages with security problems” < / a > for more
2006-05-28 22:41:22 +02:00
information.< / p >
< / li >
< li >
< p > If your package needs some executable to be able to run
correctly and if there's no
2006-05-29 10:55:59 +02:00
< code class = "filename" > buildlink3.mk< / code > file, this is specified
2006-05-28 22:41:22 +02:00
using the < code class = "varname" > DEPENDS< / code > variable. The
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/print/lyx/README.html" target = "_top" > < code class = "filename" > print/lyx< / code > < / a > package needs to
2006-05-28 22:41:22 +02:00
be able to execute the latex binary from the teTeX package
when it runs, and that is specified:< / p >
< pre class = "programlisting" >
DEPENDS+= teTeX-[0-9]*:../../print/teTeX
< / pre >
< p > The comment about wildcard dependencies from previous
paragraph applies here, too.< / p >
< / li >
< / ol > < / div >
< p > If your package needs files from another package to build,
add the relevant distribution files to
< code class = "varname" > DISTFILES< / code > , so they will be extracted
2006-05-29 10:55:59 +02:00
automatically. See the < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/print/ghostscript/README.html" target = "_top" > < code class = "filename" > print/ghostscript< / code > < / a > package for an example.
2006-05-28 22:41:22 +02:00
(It relies on the jpeg sources being present in source form
during the build.)< / p >
< p > Please also note the < code class = "varname" > BUILD_USES_MSGFMT< / code >
and < code class = "varname" > BUILD_USES_GETTEXT_M4< / code > definitions, which
are provided as convenience definitions. The former works out
whether < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?msgfmt+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > msgfmt< / span > (1)< / span > < / a > is part of the base system, and, if it isn't,
2006-05-29 10:55:59 +02:00
installs the < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/devel/gettext/README.html" target = "_top" > < code class = "filename" > devel/gettext< / code > < / a > package.
2006-05-28 22:41:22 +02:00
The latter adds a build dependency on either an installed
version of an older gettext package, or if it isn't, installs the
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/devel/gettext-m4/README.html" target = "_top" > < code class = "filename" > devel/gettext-m4< / code > < / a > package.< / p >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "conflicts" > < / a > 17.1.5.<2E> Handling conflicts with other packages< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Your package may conflict with other packages a user might
already have installed on his system, e.g. if your package
installs the same set of files like another package in our
pkgsrc tree.< / p >
< p > In this case you can set < code class = "varname" > CONFLICTS< / code > to a
space-separated list of packages (including version string) your
package conflicts with.< / p >
2006-05-29 10:55:59 +02:00
< p > For example, < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/x11/Xaw3d/README.html" target = "_top" > < code class = "filename" > x11/Xaw3d< / code > < / a >
and < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/x11/Xaw-Xpm/README.html" target = "_top" > < code class = "filename" > x11/Xaw-Xpm< / code > < / a >
2006-05-28 22:41:22 +02:00
install the same shared library, thus you set in
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/x11/Xaw3d/Makefile< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
CONFLICTS= Xaw-Xpm-[0-9]*
< / pre >
2006-05-29 10:55:59 +02:00
< p > and in < code class = "filename" > pkgsrc/x11/Xaw-Xpm/Makefile< / code > :
2006-05-28 22:41:22 +02:00
< / p >
< pre class = "programlisting" >
CONFLICTS= Xaw3d-[0-9]*
< / pre >
< p > Packages will automatically conflict with other packages
with the name prefix and a different version
string. “ < span class = "quote" > Xaw3d-1.5< / span > ” e.g. will automatically
conflict with the older version “ < span class = "quote" > Xaw3d-1.3< / span > ” .
< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "not-building-packages" > < / a > 17.1.6.<2E> Packages that cannot or should not be built< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > There are several reasons why a package might be
instructed to not build under certain circumstances. If the
package builds and runs on most platforms, the exceptions
should be noted with < code class = "varname" > NOT_FOR_PLATFORM< / code > . If
the package builds and runs on a small handful of platforms,
set < code class = "varname" > ONLY_FOR_PLATFORM< / code > instead.
Both < code class = "varname" > ONLY_FOR_PLATFORM< / code > and
< code class = "varname" > NOT_FOR_PLATFORM< / code > are OS triples
(OS-version-platform) that can use glob-style
wildcards.< / p >
< p > If the package should be skipped (for example, because it
provides functionality already provided by the system), set
< code class = "varname" > PKG_SKIP_REASON< / code > to a descriptive message.
If the package should fail because some preconditions are not
met, set < code class = "varname" > PKG_FAIL_REASON< / code > to a descriptive
message.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "undeletable-packages" > < / a > 17.1.7.<2E> Packages which should not be deleted, once installed< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > To ensure that a package may not be deleted, once it has been
installed, the < code class = "varname" > PKG_PRESERVE< / code > definition should
be set in the package Makefile. This will be carried into any
binary package that is made from this pkgsrc entry. A
“ < span class = "quote" > preserved< / span > ” package will
not be deleted using < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > pkg_delete< / span > (1)< / span > < / a > unless the
“ < span class = "quote" > -f< / span > ” option is used.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "security-handling" > < / a > 17.1.8.<2E> Handling packages with security problems< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > When a vulnerability is found, this should be noted in
2006-05-29 10:55:59 +02:00
< code class = "filename" > localsrc/security/advisories/pkg-vulnerabilities< / code > ,
2006-05-28 22:41:22 +02:00
and after committing that file, use < span > < strong class = "command" > make upload< / strong > < / span >
in the same directory to update the file on ftp.NetBSD.org.< / p >
< p > After fixing the vulnerability by a patch, its
< code class = "varname" > PKGREVISION< / code > should be increased (this
is of course not necessary if the problem is fixed by using
a newer release of the software).< / p >
< p > Also, if the fix should be applied to the stable pkgsrc
branch, be sure to submit a pullup request!< / p >
< p > Binary packages already on ftp.NetBSD.org will be handled
semi-automatically by a weekly cron job.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "compiler-bugs" > < / a > 17.1.9.<2E> How to handle compiler bugs< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Some source files trigger bugs in the compiler, based on
combinations of compiler version and architecture and almost
always relation to optimisation being enabled. Common symptoms
are gcc internal errors or never finishing compiling a file.
< / p >
< p > Typically, a workaround involves testing the
< code class = "varname" > MACHINE_ARCH< / code > and compiler version, disabling
optimisation for that
file/< code class = "varname" > MACHINE_ARCH< / code > /compiler combination, and
2006-05-29 10:55:59 +02:00
documenting it in < code class = "filename" > pkgsrc/doc/HACKS< / code > . See
2006-05-28 22:41:22 +02:00
that file for a number of examples!< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "bumping-pkgrevision" > < / a > 17.1.10.<2E> How to handle incrementing versions when fixing an existing package< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > When making fixes to an existing package it can be useful
to change the version number in < code class = "varname" > PKGNAME< / code > . To
avoid conflicting with future versions by the original author, a
“ < span class = "quote" > nb1< / span > ” , “ < span class = "quote" > nb2< / span > ” , ... suffix can be used
on package versions by setting < code class = "varname" > PKGREVISION=1< / code >
(2, ...). The “ < span class = "quote" > nb< / span > ” is treated like a
“ < span class = "quote" > .< / span > ” by the pkg tools. e.g.< / p >
< pre class = "programlisting" >
DISTNAME= foo-17.42
PKGREVISION= 9
< / pre >
< p > will result in a < code class = "varname" > PKGNAME< / code > of
“ < span class = "quote" > foo-17.42nb9< / span > ” .< / p >
< p > When a new release of the package is released, the
< code class = "varname" > PKGREVISION< / code > should be removed, e.g. on a new
minor release of the above package, things should be like:< / p >
< pre class = "programlisting" >
DISTNAME= foo-17.43
< / pre >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "portability-of-packages" > < / a > 17.1.11.<2E> Portability of packages< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > One appealing feature of pkgsrc is that it runs on many different
platforms. As a result, it is important to ensure, where possible,
that packages in pkgsrc are portable. There are some particular
details you should pay attention to while working on pkgsrc.< / p >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "install-scripts" > < / a > 17.1.11.1.<2E> ${INSTALL}, ${INSTALL_DATA_DIR}, ...< / h4 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > The BSD-compatible < span > < strong class = "command" > install< / strong > < / span > supplied with some
operating systems will not perform more than one operation at a time.
As such, you should call “ < span class = "quote" > ${INSTALL}< / span > ” , etc. like this:< / p >
< pre class = "programlisting" >
${INSTALL_DATA_DIR} ${PREFIX}/dir1
${INSTALL_DATA_DIR} ${PREFIX}/dir2
< / pre >
< / div >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "fixes.fetch" > < / a > 17.2.<2E> Fixing problems in the < span class = "emphasis" > < em > fetch< / em > < / span > phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "no-plain-download" > < / a > 17.2.1.<2E> Packages whose distfiles aren't available for plain downloading< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > If you need to download from a dynamic URL you can set
< code class = "varname" > DYNAMIC_MASTER_SITES< / code > and a < span > < strong class = "command" > make
2006-05-29 10:55:59 +02:00
fetch< / strong > < / span > will call < code class = "filename" > files/getsite.sh< / code >
2006-05-28 22:41:22 +02:00
with the name of each file to download as an argument, expecting
it to output the URL of the directory from which to download
2006-05-29 10:55:59 +02:00
it. < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/graphics/ns-cult3d/README.html" target = "_top" > < code class = "filename" > graphics/ns-cult3d< / code > < / a > is an
2006-05-28 22:41:22 +02:00
example of this usage.
< / p >
< p > If the download can't be automated, because the user must
submit personal information to apply for a password, or must pay
for the source, or whatever, you can set
< code class = "varname" > FETCH_MESSAGE< / code > to a list of lines that are
displayed to the user before aborting the build. Example:< / p >
< pre class = "programlisting" >
FETCH_MESSAGE= "Please download the files"
FETCH_MESSAGE+= " "${DISTFILES:Q}
FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
< / pre >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "modified-distfiles-same-name" > < / a > 17.2.2.<2E> How to handle modified distfiles with the 'old' name< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Sometimes authors of a software package make some
modifications after the software was released, and they put up a
new distfile without changing the package's version number. If a
package is already in pkgsrc at that time, the checksum will
no longer match. The contents of the new distfile should be
compared against the old one before changing anything, to make
sure the distfile was really updated on purpose, and that
no trojan horse or so crept in.
Then, the correct way to work around this is to
set < code class = "varname" > DIST_SUBDIR< / code > to a unique directory name,
usually based on < code class = "varname" > PKGNAME_NOREV< / code > . In case this
happens more often, < code class = "varname" > PKGNAME< / code > can be used (thus
2006-05-29 10:55:59 +02:00
including the < code class = "filename" > nbX< / code > suffix) or a date stamp
2006-05-28 22:41:22 +02:00
can be appended, like < code class = "varname" > ${PKGNAME_NOREV}-YYYYMMDD< / code > .
2006-05-29 10:55:59 +02:00
Do not forget regenerating the < code class = "filename" > distinfo< / code > file
2006-05-28 22:41:22 +02:00
after that, since it contains the < code class = "varname" > DIST_SUBDIR< / code >
path in the filenames.
Furthermore, a mail to the package's authors seems appropriate
telling them that changing distfiles after releases without
changing the file names is not good practice.< / p >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "fixes.configure" > < / a > 17.3.<2E> Fixing problems in the < span class = "emphasis" > < em > configure< / em > < / span > phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "fixes.libtool" > < / a > 17.3.1.<2E> Shared libraries - libtool< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > pkgsrc supports many different machines, with different
object formats like a.out and ELF, and varying abilities to do
shared library and dynamic loading at all. To accompany this,
varying commands and options have to be passed to the
compiler, linker, etc. to get the Right Thing, which can be
pretty annoying especially if you don't have all the machines
at your hand to test things. The
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/devel/libtool/README.html" target = "_top" > < code class = "filename" > devel/libtool< / code > < / a > pkg
2006-05-28 22:41:22 +02:00
can help here, as it just “ < span class = "quote" > knows< / span > ” how to build
both static and dynamic libraries from a set of source files,
thus being platform-independent.< / p >
< p > Here's how to use libtool in a pkg in seven simple
steps:< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > Add < code class = "varname" > USE_LIBTOOL=yes< / code > to the package
Makefile.< / p > < / li >
< li > < p > For library objects, use “ < span class = "quote" > ${LIBTOOL} --mode=compile
${CC}< / span > ” in place of “ < span class = "quote" > ${CC}< / span > ” . You could even
add it to the definition of < code class = "varname" > CC< / code > , if only
libraries are being built in a given Makefile. This one command
will build both PIC and non-PIC library objects, so you need not
have separate shared and non-shared library rules.< / p > < / li >
< li >
< p > For the linking of the library, remove any
“ < span class = "quote" > ar< / span > ” , “ < span class = "quote" > ranlib< / span > ” , and “ < span class = "quote" > ld
-Bshareable< / span > ” commands, and instead use:< / p >
< pre class = "programlisting" >
${LIBTOOL} --mode=link ${CC} -o ${.TARGET:.a=.la} ${OBJS:.o=.lo} \
-rpath ${PREFIX}/lib -version-info major:minor
< / pre >
< p > Note that the library is changed to have a
2006-05-29 10:55:59 +02:00
< code class = "filename" > .la< / code > extension, and the objects are
changed to have a < code class = "filename" > .lo< / code >
2006-05-28 22:41:22 +02:00
extension. Change < code class = "varname" > OBJS< / code > as
necessary. This automatically creates all of the
2006-05-29 10:55:59 +02:00
< code class = "filename" > .a< / code > ,
< code class = "filename" > .so.major.minor< / code > , and ELF symlinks (if
2006-05-28 22:41:22 +02:00
necessary) in the build directory. Be sure to include
“ < span class = "quote" > -version-info< / span > ” , especially when major and
minor are zero, as libtool will otherwise strip off the
shared library version.< / p >
< p > From the libtool manual:< / p >
< pre class = "programlisting" >
So, libtool library versions are described by three integers:
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
CURRENT
The most recent interface number that this library implements.
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
REVISION
The implementation number of the CURRENT interface.
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
AGE
The difference between the newest and oldest interfaces that
this library implements. In other words, the library implements
all the interface numbers in the range from number `CURRENT -
AGE' to `CURRENT'.
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
If two libraries have identical CURRENT and AGE numbers, then the
dynamic linker chooses the library with the greater REVISION number.
< / pre >
< p > The “ < span class = "quote" > -release< / span > ” option will produce
different results for a.out and ELF (excluding symlinks)
in only one case. An ELF library of the form
“ < span class = "quote" > libfoo-release.so.< span class = "emphasis" > < em > x< / em > < / span > .< span class = "emphasis" > < em > y< / em > < / span > < / span > ”
will have a symlink of
“ < span class = "quote" > libfoo.so.< span class = "emphasis" > < em > x< / em > < / span > .< span class = "emphasis" > < em > y< / em > < / span > < / span > ”
on an a.out platform. This is handled
automatically.< / p >
< p > The “ < span class = "quote" > -rpath argument< / span > ” is the install
directory of the library being built.< / p >
2006-05-29 10:55:59 +02:00
< p > In the < code class = "filename" > PLIST< / code > , include only the
< code class = "filename" > .la< / code > file, the other files will be
2006-05-28 22:41:22 +02:00
added automatically.< / p >
< / li >
< li >
2006-05-29 10:55:59 +02:00
< p > When linking shared object (< code class = "filename" > .so< / code > )
2006-05-28 22:41:22 +02:00
files, i.e. files that are loaded via < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > dlopen< / span > (3)< / span > < / a > , NOT
shared libraries, use “ < span class = "quote" > -module
-avoid-version< / span > ” to prevent them getting version
tacked on.< / p >
2006-05-29 10:55:59 +02:00
< p > The < code class = "filename" > PLIST< / code > file gets the
< code class = "filename" > foo.so< / code > entry.< / p >
2006-05-28 22:41:22 +02:00
< / li >
< li >
< p > When linking programs that depend on these libraries
< span class = "emphasis" > < em > before< / em > < / span > they are installed, preface
the < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > cc< / span > (1)< / span > < / a > or < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > ld< / span > (1)< / span > < / a > line with “ < span class = "quote" > ${LIBTOOL}
--mode=link< / span > ” , and it will find the correct
libraries (static or shared), but please be aware that
libtool will not allow you to specify a relative path in
-L (such as “ < span class = "quote" > -L../somelib< / span > ” ), because it
expects you to change that argument to be the
2006-05-29 10:55:59 +02:00
< code class = "filename" > .la< / code > file. e.g.< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
< / pre >
< p > should be changed to:< / p >
< pre class = "programlisting" >
${LIBTOOL} --mode=link ${CC} -o < em class = "replaceable" > < code > someprog< / code > < / em > < em class = "replaceable" > < code > ../somelib/somelib.la< / code > < / em >
< / pre >
< p > and it will do the right thing with the libraries.< / p >
< / li >
< li >
< p > When installing libraries, preface the < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > install< / span > (1)< / span > < / a >
or < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > cp< / span > (1)< / span > < / a > command with “ < span class = "quote" > ${LIBTOOL}
--mode=install< / span > ” , and change the library name to
2006-05-29 10:55:59 +02:00
< code class = "filename" > .la< / code > . e.g.< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
< / pre >
2006-05-29 10:55:59 +02:00
< p > This will install the static < code class = "filename" > .a< / code > ,
2006-05-28 22:41:22 +02:00
shared library, any needed symlinks, and run
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > ldconfig< / span > (8)< / span > < / a > .< / p >
< / li >
2006-05-29 10:55:59 +02:00
< li > < p > In your < code class = "filename" > PLIST< / code > , include only
the < code class = "filename" > .la< / code >
2006-05-28 22:41:22 +02:00
file (this is a change from previous behaviour).< / p > < / li >
< / ol > < / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "using-libtool" > < / a > 17.3.2.<2E> Using libtool on GNU packages that already support libtool< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Add < code class = "varname" > USE_LIBTOOL=yes< / code > to the
package Makefile. This will override the package's own libtool
in most cases. For older libtool using packages, libtool is
made by ltconfig script during the do-configure step; you can
check the libtool script location by doing < span > < strong class = "command" > make
configure; find work*/ -name libtool< / strong > < / span > .< / p >
< p > < code class = "varname" > LIBTOOL_OVERRIDE< / code > specifies which libtool
scripts, relative to < code class = "varname" > WRKSRC< / code > , to override. By
default, it is set to “ < span class = "quote" > libtool */libtool
*/*/libtool< / span > ” . If this does not match the location of the
package's libtool script(s), set it as appropriate.< / p >
2006-05-29 10:55:59 +02:00
< p > If you do not need < code class = "filename" > *.a< / code > static
2006-05-28 22:41:22 +02:00
libraries built and installed, then use
< code class = "varname" > SHLIBTOOL_OVERRIDE< / code > instead.< / p >
< p > If your package makes use of the platform-independent library
for loading dynamic shared objects, that comes with libtool
(libltdl), you should include devel/libltdl/buildlink3.mk.< / p >
< p > Some packages use libtool incorrectly so that the package may not work or
build in some circumstances. Some of the more common errors are:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li >
< p > The inclusion of a shared object (-module) as a dependent library in an
executable or library. This in itself isn't a problem if one of two things
has been done:< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > The shared object is named correctly, i.e.
2006-05-29 10:55:59 +02:00
< code class = "filename" > libfoo.la< / code > , not
< code class = "filename" > foo.la< / code > < / p > < / li >
2006-05-28 22:41:22 +02:00
< li > < p > The -dlopen option is used when linking an executable.< / p > < / li >
< / ol > < / div >
< / li >
< li > < p > The use of libltdl without the correct calls to initialisation routines.
The function lt_dlinit() should be called and the macro
< code class = "varname" > LTDL_SET_PRELOADED_SYMBOLS< / code > included in
executables.< / p > < / li >
< / ul > < / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "autoconf-automake" > < / a > 17.3.3.<2E> GNU Autoconf/Automake< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > If a package needs GNU autoconf or automake to be executed
to regenerate the configure script and Makefile.in makefile
templates, then they should be executed in a pre-configure
target.< / p >
< p > For packages that need only autoconf:< / p >
< pre class = "programlisting" >
AUTOCONF_REQD= 2.50 # if default version is not good enough
USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
...
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
pre-configure:
cd ${WRKSRC}; autoconf
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
...
< / pre >
< p > and for packages that need automake and autoconf:< / p >
< pre class = "programlisting" >
AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
USE_TOOLS+= automake # use "automake14" for automake-1.4
...
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
pre-configure:
cd ${WRKSRC}; \
aclocal; autoheader; \
automake -a --foreign -i; autoconf
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
...
< / pre >
< p > Packages which use GNU Automake will almost certainly
require GNU Make.< / p >
< p > There are times when the configure process makes
additional changes to the generated files, which then causes
the build process to try to re-execute the automake sequence.
This is prevented by touching various files in the configure
stage. If this causes problems with your package you can set
< code class = "varname" > AUTOMAKE_OVERRIDE=NO< / code > in the package
Makefile.< / p >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "fixes.build" > < / a > 17.4.<2E> Fixing problems in the < span class = "emphasis" > < em > build< / em > < / span > phase< / h2 > < / div > < / div > < / div >
< p > The most common failures when building a package are that
some platforms do not provide certain header files, functions or
libraries, or they provide the functions in a library that the
original package author didn't know. To work around this, you
can rewrite the source code in most cases so that it does not
use the missing functions or provides a replacement function.< / p >
2006-05-28 22:41:22 +02:00
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "fixes.build.cpp" > < / a > 17.4.1.<2E> Compiling C and C++ code conditionally< / h3 > < / div > < / div > < / div >
< p > If a package already comes with a GNU configure script, the
preferred way to fix the build failure is to change the
configure script, not the code. In the other cases, you can
utilize the C preprocessor, which defines certain macros
depending on the operating system and hardware architecture it
compiles for. These macros can be queried using for example
< code class = "varname" > #if defined(__i386)< / code > . Almost every operating
system, hardware architecture and compiler has its own macro.
For example, if the macros < code class = "varname" > __GNUC__< / code > ,
< code class = "varname" > __i386__< / code > and < code class = "varname" > __NetBSD__< / code >
are all defined, you know that you are using NetBSD on an i386
compatible CPU, and your compiler is GCC.< / p >
< p > The list of the following macros for hardware and
operating system depends on the compiler that is used. For
example, if you want to conditionally compile code on Solaris,
don't use < code class = "varname" > __sun__< / code > , as the SunPro compiler
does not define it. Use < code class = "varname" > __sun< / code > instead.< / p >
2006-05-28 22:41:22 +02:00
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "fixes.build.cpp.os" > < / a > 17.4.1.1.<2E> C preprocessor macros to identify the operating system< / h4 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > To distinguish between 4.4 BSD-derived systems and the
rest of the world, you should use the following code.< / p >
< pre class = "programlisting" >
#include < sys/param.h>
#if (defined(BSD) & & BSD > = 199306)
/* BSD-specific code goes here */
#else
/* non-BSD-specific code goes here */
#endif
< / pre >
2006-06-01 11:36:55 +02:00
< p > If this distinction is not fine enough, you can also test
for the following macros.< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
FreeBSD __FreeBSD__
DragonFly __DragonFly__
Interix __INTERIX
Linux linux, __linux, __linux__
NetBSD __NetBSD__
OpenBSD __OpenBSD__
Solaris sun, __sun
< / pre >
< / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "fixes.build.cpp.arch" > < / a > 17.4.1.2.<2E> C preprocessor macros to identify the hardware architecture< / h4 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
i386 i386, __i386, __i386__
MIPS __mips
SPARC sparc, __sparc
< / pre >
< / div >
< div class = "sect3" lang = "en" >
< div class = "titlepage" > < div > < div > < h4 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "fixes.build.cpp.compiler" > < / a > 17.4.1.3.<2E> C preprocessor macros to identify the compiler< / h4 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
GCC __GNUC__ (major version), __GNUC_MINOR__
SunPro __SUNPRO_C (0x570 for version 5.7)
< / pre >
< / div >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "package-specific-actions" > < / a > 17.5.<2E> Package specific actions< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "user-interaction" > < / a > 17.5.1.<2E> User interaction< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Occasionally, packages require interaction from the user, and this can be
in a number of ways:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > help in fetching the distfiles< / p > < / li >
< li > < p > help to configure the package before it is built< / p > < / li >
< li > < p > help during the build process< / p > < / li >
< li > < p > help during the installation of a package< / p > < / li >
< / ul > < / div >
< p > The < code class = "varname" > INTERACTIVE_STAGE< / code > definition is provided to notify
the pkgsrc mechanism of an interactive stage which will be needed, and
2006-05-29 10:55:59 +02:00
this should be set in the package's < code class = "filename" > Makefile< / code > , e.g.:< / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
INTERACTIVE_STAGE= build
< / pre >
< p > Multiple interactive stages can be specified:< / p >
< pre class = "programlisting" >
INTERACTIVE_STAGE= configure install
< / pre >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "handling-licenses" > < / a > 17.5.2.<2E> Handling licenses< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > A package may be covered by a license which the user has
or has not agreed to accept. For these cases, pkgsrc contains
a mechanism to note that a package is covered by a particular
license, and the package cannot be built unless the user has
accepted the license. (Installation of binary packages are
not currently subject to this mechanism.) Packages with
licenses that are either Open Source according to the Open
Source Initiative or Free according to the Free Software
Foundation will not be marked with a license tag. Packages
with licenses that have not been determined to meet either
definition will be marked with a license tag referring to the
license. This will prevent building unless pkgsrc is informed
that the license is acceptable, and enables displaying the
license.< / p >
< p > The license tag mechanism is intended to address
copyright-related issues surrounding building, installing and
using a package, and not to address redistribution issues (see
< code class = "varname" > RESTRICTED< / code > and
< code class = "varname" > NO_SRC_ON_FTP< / code > , etc.). However, the above
definition of licenses for which tags are not needed implies
that packages with redistribution restrictions should have
tags.< / p >
< p >
Denoting that a package is covered by a particular license is
done by placing the license in
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/licenses< / code > and setting the
2006-05-28 22:41:22 +02:00
< code class = "varname" > LICENSE< / code > variable to a string identifying
the license, e.g. in
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/graphics/xv/README.html" target = "_top" > < code class = "filename" > graphics/xv< / code > < / a > : < / p >
2006-05-28 22:41:22 +02:00
< pre class = "programlisting" >
LICENSE= xv-license
< / pre >
< p >
When trying to build, the user will get a notice that the
package is covered by a license which has not been
accepted:< / p >
< pre class = "programlisting" >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > make< / code > < / strong >
===> xv-3.10anb9 has an unacceptable license: xv-license.
===> To view the license, enter "/usr/bin/make show-license".
===> To indicate acceptance, add this line to your /etc/mk.conf:
===> ACCEPTABLE_LICENSES+=xv-license
*** Error code 1
< / pre >
< p > The license can be viewed with < span > < strong class = "command" > make
show-license< / strong > < / span > , and if it is considered appropriate,
the line printed above can be added to
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > to indicate acceptance of
2006-05-28 22:41:22 +02:00
the particular license:< / p >
< pre class = "programlisting" >
ACCEPTABLE_LICENSES+=xv-license
< / pre >
< p > When adding a package with a new license, the license
2006-05-29 10:55:59 +02:00
text should be added to < code class = "filename" > pkgsrc/licenses< / code >
2006-05-28 22:41:22 +02:00
for displaying. A list of known licenses can be seen in this
directory as well as by looking at the list of (commented
out) < code class = "varname" > ACCEPTABLE_LICENSES< / code > variable
settings in
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/mk/defaults/mk.conf< / code > .< / p >
2006-05-28 22:41:22 +02:00
< p > The use of < code class = "varname" > LICENSE=shareware< / code > ,
< code class = "varname" > LICENSE=no-commercial-use< / code > , and similar
language is deprecated because it does not crisply refer to
a particular license text. Another problem with such usage
is that it does not enable a user to denote acceptance of
the license for a single package without accepting the same
license text for another package. In particular, this can
be inappropriate when e.g. one accepts a particular license to
indicate to pkgsrc that a fee has been paid.< / p >
< / div >
2006-06-01 11:36:55 +02:00
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "fixes.install" > < / a > 17.6.<2E> Fixing problems in the < span class = "emphasis" > < em > install< / em > < / span > phase< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "installing-score-files" > < / a > 17.6.1.<2E> Installing score files< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Certain packages, most of them in the games category, install
a score file that allows all users on the system to record their
highscores. In order for this to work, the binaries need to be
installed setgid and the score files owned by the appropriate
group and/or owner (traditionally the "games" user/group). The
following variables, documented in more detail in
2006-05-29 10:55:59 +02:00
< code class = "filename" > mk/defaults/mk.conf< / code > , control this
2006-05-28 22:41:22 +02:00
behaviour: < code class = "varname" > SETGIDGAME< / code > ,
< code class = "varname" > GAMEDATAMODE< / code > , < code class = "varname" > GAMEGRP< / code > ,
< code class = "varname" > GAMEMODE< / code > , < code class = "varname" > GAMEOWN< / code > .< / p >
< p > Note that per default, setgid installation of games is
disabled; setting < code class = "varname" > SETGIDGAME=YES< / code > will set all
the other variables accordingly.< / p >
< p > A package should therefor never hard code file ownership or
access permissions but rely on < code class = "varname" > INSTALL_GAME< / code > and
< code class = "varname" > INSTALL_GAME_DATA< / code > to set these
correctly.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "perl-scripts" > < / a > 17.6.2.<2E> Packages containing perl scripts< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p >
If your package contains interpreted perl scripts, set
< code class = "varname" > REPLACE_PERL< / code > to ensure that the proper
interpreter path is set. < code class = "varname" > REPLACE_PERL< / code > should
contain a list of scripts, relative to
< code class = "varname" > WRKSRC< / code > , that you want adjusted.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "hardcoded-paths" > < / a > 17.6.3.<2E> Packages with hardcoded paths to other interpreters< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p >
Your package may also contain scripts with hardcoded paths to
other interpreters besides (or as well as) perl. To correct the
full pathname to the script interpreter, you need to set the
2006-05-29 10:55:59 +02:00
following definitions in your < code class = "filename" > Makefile< / code > (we
2006-05-28 22:41:22 +02:00
shall use < span > < strong class = "command" > tclsh< / strong > < / span > in this example):< / p >
< pre class = "programlisting" >
REPLACE_INTERPRETER+= tcl
REPLACE.tcl.old= .*/bin/tclsh
REPLACE.tcl.new= ${PREFIX}/bin/tclsh
REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
# relative to ${WRKSRC}, just as in REPLACE_PERL
< / pre >
< div class = "note" style = "margin-left: 0.5in; margin-right: 0.5in;" >
< h3 class = "title" > Note< / h3 >
< p > Before March 2006, these variables were called
< code class = "varname" > _REPLACE.*< / code > and
< code class = "varname" > _REPLACE_FILES.*< / code > .< / p >
< / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "perl-modules" > < / a > 17.6.4.<2E> Packages installing perl modules< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Makefiles of packages providing perl5 modules should include
the Makefile fragment
2006-05-29 10:55:59 +02:00
< code class = "filename" > ../../lang/perl5/module.mk< / code > . It provides a
2006-05-28 22:41:22 +02:00
< span > < strong class = "command" > do-configure< / strong > < / span > target for the standard perl
configuration for such modules as well as various hooks to tune
this configuration. See comments in this file for
details.< / p >
< p > Perl5 modules will install into different places depending
on the version of perl used during the build process. To
address this, pkgsrc will append lines to the
2006-05-29 10:55:59 +02:00
< code class = "filename" > PLIST< / code > corresponding to the files listed in
the installed < code class = "filename" > .packlist< / code > file generated by
2006-05-28 22:41:22 +02:00
most perl5 modules. This is invoked by defining
< code class = "varname" > PERL5_PACKLIST< / code > to a space-separated list of
paths to packlist files, e.g.:< / p >
< pre class = "programlisting" >
PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
< / pre >
< p > The variables < code class = "varname" > PERL5_SITELIB< / code > ,
< code class = "varname" > PERL5_SITEARCH< / code > , and
< code class = "varname" > PERL5_ARCHLIB< / code > represent the three locations
in which perl5 modules may be installed, and may be used by
perl5 packages that don't have a packlist. These three
variables are also substituted for in the
2006-05-29 10:55:59 +02:00
< code class = "filename" > PLIST< / code > .< / p >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "faq.info-files" > < / a > 17.6.5.<2E> Packages installing info files< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Some packages install info files or use the
“ < span class = "quote" > makeinfo< / span > ” or “ < span class = "quote" > install-info< / span > ”
commands. < code class = "varname" > INFO_FILES< / code > should be defined in
2006-05-29 10:55:59 +02:00
the package Makefile so that < code class = "filename" > INSTALL< / code > and
< code class = "filename" > DEINSTALL< / code > scripts will be generated to
2006-05-28 22:41:22 +02:00
handle registration of the info files in the Info directory
file. The “ < span class = "quote" > install-info< / span > ” command used for the info
files registration is either provided by the system, or by a
special purpose package automatically added as dependency if
needed.< / p >
< p > < code class = "varname" > PKGINFODIR< / code > is the directory under
2006-05-29 10:55:59 +02:00
< code class = "filename" > ${PREFIX}< / code > where info files are primarily
2006-05-28 22:41:22 +02:00
located. < code class = "varname" > PKGINFODIR< / code > defaults to
“ < span class = "quote" > info< / span > ” and can be overridden by the user.< / p >
< p > The info files for the package should be listed in the
2006-05-29 10:55:59 +02:00
package < code class = "filename" > PLIST< / code > ; however any split info files
2006-05-28 22:41:22 +02:00
need not be listed.< / p >
< p > A package which needs the “ < span class = "quote" > makeinfo< / span > ” command
at build time must add “ < span class = "quote" > makeinfo< / span > ” to
< code class = "varname" > USE_TOOLS< / code > in its Makefile. If a minimum
version of the “ < span class = "quote" > makeinfo< / span > ” command is needed it
should be noted with the < code class = "varname" > TEXINFO_REQD< / code >
2006-05-29 10:55:59 +02:00
variable in the package < code class = "filename" > Makefile< / code > . By
2006-05-28 22:41:22 +02:00
default, a minimum version of 3.12 is required. If the system
does not provide a < span > < strong class = "command" > makeinfo< / strong > < / span > command or if it
does not match the required minimum, a build dependency on the
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/devel/gtexinfo/README.html" target = "_top" > < code class = "filename" > devel/gtexinfo< / code > < / a > package will
2006-05-28 22:41:22 +02:00
be added automatically.< / p >
< p > The build and installation process of the software provided
by the package should not use the
< span > < strong class = "command" > install-info< / strong > < / span > command as the registration of
info files is the task of the package
2006-05-29 10:55:59 +02:00
< code class = "filename" > INSTALL< / code > script, and it must use the
2006-05-28 22:41:22 +02:00
appropriate < span > < strong class = "command" > makeinfo< / strong > < / span > command.< / p >
< p > To achieve this goal, the pkgsrc infrastructure creates
overriding scripts for the < span > < strong class = "command" > install-info< / strong > < / span > and
< span > < strong class = "command" > makeinfo< / strong > < / span > commands in a directory listed early
in < code class = "varname" > PATH< / code > .< / p >
< p > The script overriding < span > < strong class = "command" > install-info< / strong > < / span > has
no effect except the logging of a message. The script overriding
< span > < strong class = "command" > makeinfo< / strong > < / span > logs a message and according to the
value of < code class = "varname" > TEXINFO_REQD< / code > either runs the appropriate
< span > < strong class = "command" > makeinfo< / strong > < / span > command or exit on error.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "manpages" > < / a > 17.6.6.<2E> Packages installing man pages< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Many packages install manual pages. The man pages
are installed under < code class = "varname" > ${PREFIX}/${PKGMANDIR}< / code >
2006-05-29 10:55:59 +02:00
which is < code class = "filename" > /usr/pkg/man< / code > by default.
2006-05-28 22:41:22 +02:00
< code class = "varname" > PKGMANDIR< / code > defaults to “ < span class = "quote" > man< / span > ” .
For example, you can set < code class = "varname" > PKGMANDIR< / code > to
“ < span class = "quote" > share/man< / span > ” to have man pages install under
2006-05-29 10:55:59 +02:00
< code class = "filename" > /usr/pkg/share/man/< / code > by default.
2006-05-28 22:41:22 +02:00
< / p >
< div class = "note" style = "margin-left: 0.5in; margin-right: 0.5in;" >
< h3 class = "title" > Note< / h3 >
< p > The support for a custom < code class = "varname" > PKGMANDIR< / code >
is not complete.
< / p >
< / div >
2006-05-29 10:55:59 +02:00
< p > The < code class = "filename" > PLIST< / code > files can just
use < code class = "filename" > man/< / code > as the top level directory
2006-05-28 22:41:22 +02:00
for the man page file entries
and the pkgsrc framework will convert as needed.
< / p >
< p > Packages that are
configured with < code class = "varname" > GNU_CONFIGURE< / code > set as
“ < span class = "quote" > yes< / span > ” , by default will use the
2006-05-29 10:55:59 +02:00
< code class = "filename" > ./configure< / code >
2006-05-28 22:41:22 +02:00
--mandir switch to set where the man pages should be installed.
The path is < code class = "varname" > GNU_CONFIGURE_MANDIR< / code > which defaults
to < code class = "varname" > ${PREFIX}/${PKGMANDIR}< / code > .
< / p >
< p >
Packages that use < code class = "varname" > GNU_CONFIGURE< / code > but do not
use --mandir, can set < code class = "varname" > CONFIGURE_HAS_MANDIR< / code >
to “ < span class = "quote" > no< / span > ” .
2006-05-29 10:55:59 +02:00
Or if the < code class = "filename" > ./configure< / code > script uses
2006-05-28 22:41:22 +02:00
a non-standard use of --mandir, you can set
< code class = "varname" > GNU_CONFIGURE_MANDIR< / code > as needed.
< / p >
2006-06-01 11:36:55 +02:00
< p > See < a href = "#manpage-compression" title = "11.5.<2E> Man page compression" > Section<EFBFBD> 11.5, “ Man page compression” < / a > for
2006-05-28 22:41:22 +02:00
information on installation of compressed manual pages.
< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "gconf2-data-files" > < / a > 17.6.7.<2E> Packages installing GConf2 data files< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p >
2006-05-29 10:55:59 +02:00
If a package installs < code class = "filename" > .schemas< / code > or
< code class = "filename" > .entries< / code > files, used by GConf2,
2006-05-28 22:41:22 +02:00
you need to take some extra steps to make sure they get registered
in the database:
< / p >
< div class = "orderedlist" > < ol type = "1" >
2006-05-29 10:55:59 +02:00
< li > < p > Include < code class = "filename" > ../../devel/GConf2/schemas.mk< / code >
instead of its < code class = "filename" > buildlink3.mk< / code > file. This
2006-05-28 22:41:22 +02:00
takes care of rebuilding the GConf2 database at installation and
deinstallation time, and tells the package where to install
GConf2 data files using some standard configure arguments. It
also disallows any access to the database directly from the
package.< / p > < / li >
< li > < p > Ensure that the package installs its
2006-05-29 10:55:59 +02:00
< code class = "filename" > .schemas< / code > files under
< code class = "filename" > ${PREFIX}/share/gconf/schemas< / code > . If they get
installed under < code class = "filename" > ${PREFIX}/etc< / code > , you will
2006-05-28 22:41:22 +02:00
need to manually patch the package.< / p > < / li >
< li > < p > Check the PLIST and remove any entries under the etc/gconf
directory, as they will be handled automatically. See
< a href = "#faq.conf" title = "7.14.<2E> How do I change the location of configuration files?" > Section<EFBFBD> 7.14, “ How do I change the location of configuration files?” < / a > for more information.< / p > < / li >
< li > < p > Define the < code class = "varname" > GCONF2_SCHEMAS< / code > variable in
2006-05-29 10:55:59 +02:00
your < code class = "filename" > Makefile< / code > with a list of all
< code class = "filename" > .schemas< / code > files installed by the package, if
2006-05-28 22:41:22 +02:00
any. Names must not contain any directories in them.< / p > < / li >
< li > < p > Define the < code class = "varname" > GCONF2_ENTRIES< / code > variable in
2006-05-29 10:55:59 +02:00
your < code class = "filename" > Makefile< / code > with a
list of all < code class = "filename" > .entries< / code > files installed by the
2006-05-28 22:41:22 +02:00
package, if any. Names must not contain any directories in
them.< / p > < / li >
< / ol > < / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "scrollkeeper-data-files" > < / a > 17.6.8.<2E> Packages installing scrollkeeper data files< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p >
2006-05-29 10:55:59 +02:00
If a package installs < code class = "filename" > .omf< / code > files, used by
2006-05-28 22:41:22 +02:00
scrollkeeper, you need to take some extra steps to make sure they
get registered in the database:
< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > Include
2006-05-29 10:55:59 +02:00
< code class = "filename" > ../../textproc/scrollkeeper/omf.mk< / code >
instead of its < code class = "filename" > buildlink3.mk< / code > file. This
2006-05-28 22:41:22 +02:00
takes care of rebuilding the scrollkeeper database at
installation and deinstallation time, and disallows any access
to it directly from the package.
< / p > < / li >
< li > < p > Check the PLIST and remove any entries under the
2006-05-29 10:55:59 +02:00
< code class = "filename" > libdata/scrollkeeper< / code > directory, as they
2006-05-28 22:41:22 +02:00
will be handled automatically.< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > Remove the < code class = "filename" > share/omf< / code > directory from
2006-05-28 22:41:22 +02:00
the PLIST. It will be handled by scrollkeeper.< / p > < / li >
< / ol > < / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "x11-fonts" > < / a > 17.6.9.<2E> Packages installing X11 fonts< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > If a package installs font files, you will need to rebuild
the fonts database in the directory where they get installed at
installation and deinstallation time. This can be automatically
done by using the pkginstall framework.< / p >
< p > You can list the directories where fonts are installed in the
< code class = "varname" > FONTS_DIRS.< em class = "replaceable" > < code > type< / code > < / em > < / code >
variables, where < em class = "replaceable" > < code > type< / code > < / em > can be one of
“ < span class = "quote" > ttf< / span > ” , “ < span class = "quote" > type1< / span > ” or “ < span class = "quote" > x11< / span > ” .
Also make sure that the database file
2006-05-29 10:55:59 +02:00
< code class = "filename" > fonts.dir< / code > is not listed in the PLIST.< / p >
2006-05-28 22:41:22 +02:00
< p > Note that you should not create new directories for fonts;
instead use the standard ones to avoid that the user needs to
manually configure his X server to find them.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "gtk2-modules" > < / a > 17.6.10.<2E> Packages installing GTK2 modules< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > If a package installs GTK2 immodules or loaders, you need to
take some extra steps to get them registered in the GTK2 database
properly:< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > Include
2006-05-29 10:55:59 +02:00
< code class = "filename" > ../../x11/gtk2/modules.mk< / code > instead of its
< code class = "filename" > buildlink3.mk< / code > file. This takes care of
2006-05-28 22:41:22 +02:00
rebuilding the database at installation and deinstallation time.
< / p > < / li >
< li > < p >
Set < code class = "varname" > GTK2_IMMODULES=YES< / code > if
your package installs GTK2 immodules.< / p > < / li >
< li > < p >
Set < code class = "varname" > GTK2_LOADERS=YES< / code > if your package installs
GTK2 loaders.< / p > < / li >
< li >
< p >
Patch the package to not touch any of the GTK2 databases directly.
These are:
< / p >
< div class = "itemizedlist" > < ul type = "disc" >
2006-05-29 10:55:59 +02:00
< li > < p > < code class = "filename" > libdata/gtk-2.0/gdk-pixbuf.loaders< / code > < / p > < / li >
< li > < p > < code class = "filename" > libdata/gtk-2.0/gtk.immodules< / code > < / p > < / li >
2006-05-28 22:41:22 +02:00
< / ul > < / div >
< p >
< / p >
< / li >
< li > < p >
Check the PLIST and remove any entries under the
2006-05-29 10:55:59 +02:00
< code class = "filename" > libdata/gtk-2.0< / code > directory, as they will be
2006-05-28 22:41:22 +02:00
handled automatically.< / p > < / li >
< / ol > < / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "sgml-xml-data" > < / a > 17.6.11.<2E> Packages installing SGML or XML data< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > If a package installs SGML or XML data files that need to be
registered in system-wide catalogs (like DTDs, sub-catalogs,
etc.), you need to take some extra steps:
< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > Include
2006-05-29 10:55:59 +02:00
< code class = "filename" > ../../textproc/xmlcatmgr/catalogs.mk< / code > in
your < code class = "filename" > Makefile< / code > , which takes care of
2006-05-28 22:41:22 +02:00
registering those files in system-wide catalogs at
installation and deinstallation time.< / p > < / li >
< li > < p > Set < code class = "varname" > SGML_CATALOGS< / code > to the full path of
any SGML catalogs installed by the package.< / p > < / li >
< li > < p > Set < code class = "varname" > XML_CATALOGS< / code > to the full path of
any XML catalogs installed by the package.< / p > < / li >
< li > < p > Set < code class = "varname" > SGML_ENTRIES< / code > to individual entries
to be added to the SGML catalog. These come in groups of
three strings; see xmlcatmgr(1) for more information
(specifically, arguments recognized by the 'add' action).
Note that you will normally not use this variable.< / p > < / li >
< li > < p > Set < code class = "varname" > XML_ENTRIES< / code > to individual entries
to be added to the XML catalog. These come in groups of three
strings; see xmlcatmgr(1) for more information (specifically,
arguments recognized by the 'add' action). Note that you will
normally not use this variable.
< / p > < / li >
< / ol > < / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "mime-database" > < / a > 17.6.12.<2E> Packages installing extensions to the MIME database< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > If a package provides extensions to the MIME database by
2006-05-29 10:55:59 +02:00
installing < code class = "filename" > .xml< / code > files inside
< code class = "filename" > ${PREFIX}/share/mime/packages< / code > , you
2006-05-28 22:41:22 +02:00
need to take some extra steps to ensure that the database is kept
consistent with respect to these new files:
< / p >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > Include
2006-05-29 10:55:59 +02:00
< code class = "filename" > ../../databases/shared-mime-info/mimedb.mk< / code >
(avoid using the < code class = "filename" > buildlink3.mk< / code > file from
2006-05-28 22:41:22 +02:00
this same directory, which is reserved for inclusion from
2006-05-29 10:55:59 +02:00
other < code class = "filename" > buildlink3.mk< / code > files). It takes
2006-05-28 22:41:22 +02:00
care of rebuilding the MIME database at installation and
deinstallation time, and disallows any access to it directly
from the package.< / p > < / li >
< li > < p > Check the PLIST and remove any entries under the
2006-05-29 10:55:59 +02:00
< code class = "filename" > share/mime< / code > directory,
2006-05-28 22:41:22 +02:00
< span class = "emphasis" > < em > except< / em > < / span > for files saved under
2006-05-29 10:55:59 +02:00
< code class = "filename" > share/mime/packages< / code > . The former are
2006-05-28 22:41:22 +02:00
handled automatically by
the update-mime-database program, but the latter are
package-dependent and must be removed by the package that
installed them in the first place.< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > Remove any < code class = "filename" > share/mime/*< / code > directories
2006-05-28 22:41:22 +02:00
from the PLIST. They will be handled by the shared-mime-info
package.< / p > < / li >
< / ol > < / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "intltool" > < / a > 17.6.13.<2E> Packages using intltool< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > If a package uses intltool during its build, include the
2006-05-29 10:55:59 +02:00
< code class = "filename" > ../../textproc/intltool/buildlink3.mk< / code > file,
2006-05-28 22:41:22 +02:00
which forces it to use the intltool package provided by pkgsrc,
instead of the one bundled with the distribution file.
< / p >
< p > This tracks intltool's build-time dependencies and uses the
latest available version; this way, the package benefits of any
bug fixes that may have appeared since it was released.
< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "startup-scripts" > < / a > 17.6.14.<2E> Packages installing startup scripts< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > If a package contains a rc.d script, it won't be copied into
the startup directory by default, but you can enable it, by adding
the option < code class = "varname" > PKG_RCD_SCRIPTS=YES< / code > in
2006-05-29 10:55:59 +02:00
< code class = "filename" > /etc/mk.conf< / code > . This option will copy the scripts
into < code class = "filename" > /etc/rc.d< / code > when a package is installed, and
2006-05-28 22:41:22 +02:00
it will automatically remove the scripts when the package is
deinstalled.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "tex-packages" > < / a > 17.6.15.<2E> Packages installing TeX modules< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > If a package installs TeX packages into the texmf tree,
2006-05-29 10:55:59 +02:00
the < code class = "filename" > ls-R< / code > database of the tree needs to be
2006-05-28 22:41:22 +02:00
updated.< / p >
< div class = "note" style = "margin-left: 0.5in; margin-right: 0.5in;" >
< h3 class = "title" > Note< / h3 >
< p > Except the main TeX packages such as teTeX-texmf,
packages should install files
into < code class = "varname" > PKG_LOCALTEXMFPREFIX< / code > ,
not < code class = "varname" > PKG_TEXMFPREFIX< / code > .< / p >
< / div >
< div class = "orderedlist" > < ol type = "1" >
< li > < p > Include
2006-05-29 10:55:59 +02:00
< code class = "filename" > ../../print/teTeX/module.mk< / code > instead
of < code class = "filename" > ../../mk/tex.buildlink3.mk< / code > . This
takes care of rebuilding the < code class = "filename" > ls-R< / code >
2006-05-28 22:41:22 +02:00
database at installation and deinstallation time.< / p > < / li >
< li >
< p > If your package installs files into a texmf
tree other than the one
at < code class = "varname" > PKG_LOCALTEXMFPREFIX< / code > ,
set < code class = "varname" > TEXMFDIRS< / code > to the list of all texmf
trees that need database update.< / p >
< p > If your package also installs font map files that need
to be registered using < span > < strong class = "command" > updmap< / strong > < / span > ,
set < code class = "varname" > TEX_FONTMAPS< / code > to the list of all
such font map files. Then < span > < strong class = "command" > updmap< / strong > < / span > will
be run automatically at installation/deinstallation to
enable/disable font map files for TeX output
drivers.< / p >
< / li >
2006-05-29 10:55:59 +02:00
< li > < p > Make sure that none of < code class = "filename" > ls-R< / code >
databases are included in < code class = "filename" > PLIST< / code > , as
2006-05-28 22:41:22 +02:00
they will be removed only by the teTeX-bin package.< / p > < / li >
< / ol > < / div >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "feedback-to-author" > < / a > 17.7.<2E> Feedback to the author< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > If you have found any bugs in the package you make available,
if you had to do special steps to make it run under NetBSD or
if you enhanced the software in various other ways, be sure
to report these changes back to the original author of the
program! With that kind of support, the next release of the
program can incorporate these fixes, and people not using the
NetBSD packages system can win from your efforts.< / p >
< p > Support the idea of free software!< / p >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "debug" > < / a > Chapter<EFBFBD> 18.<2E> Debugging< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > To check out all the gotchas when building a package, here are the steps
that I do in order to get a package working. Please note this is basically
the same as what was explained in the previous sections, only with some
debugging aids.< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > Be sure to set < code class = "varname" > PKG_DEVELOPER=1< / code >
2006-05-29 10:55:59 +02:00
in < code class = "filename" > /etc/mk.conf< / code > < / p > < / li >
2006-05-28 22:41:22 +02:00
< li >
2006-05-29 10:55:59 +02:00
< p > Install < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/url2pkg/README.html" target = "_top" > < code class = "filename" > pkgtools/url2pkg< / code > < / a > ,
2006-05-28 22:41:22 +02:00
create a directory for a new package, change into it, then run
< span > < strong class = "command" > url2pkg< / strong > < / span > :< / p >
< pre class = "screen" > < code class = "prompt" > %< / code > < strong class = "userinput" > < code > mkdir /usr/pkgsrc/< em class = "replaceable" > < code > category< / code > < / em > /< em class = "replaceable" > < code > examplepkg< / code > < / em > < / code > < / strong >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > cd /usr/pkgsrc/< em class = "replaceable" > < code > category< / code > < / em > /< em class = "replaceable" > < code > examplepkg< / code > < / em > < / code > < / strong >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > url2pkg http://www.example.com/path/to/distfile.tar.gz< / code > < / strong > < / pre >
< / li >
2006-05-29 10:55:59 +02:00
< li > < p > Edit the < code class = "filename" > Makefile< / code > as requested.< / p > < / li >
< li > < p > Fill in the < code class = "filename" > DESCR< / code > file< / p > < / li >
2006-05-28 22:41:22 +02:00
< li > < p > Run < span > < strong class = "command" > make configure< / strong > < / span >
< / p > < / li >
< li > < p > Add any dependencies glimpsed from documentation and the
configure step to the package's
2006-05-29 10:55:59 +02:00
< code class = "filename" > Makefile< / code > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< li >
< p > Make the package compile, doing multiple rounds of< / p >
< pre class = "screen" > < code class = "prompt" > %< / code > < strong class = "userinput" > < code > make< / code > < / strong >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > pkgvi ${WRKSRC}/some/file/that/does/not/compile< / code > < / strong >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > mkpatches< / code > < / strong >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > patchdiff< / code > < / strong >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > mv ${WRKDIR}/.newpatches/* patches< / code > < / strong >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > make mps< / code > < / strong >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > make clean< / code > < / strong > < / pre >
< p > Doing as non-root user will ensure that no files are modified that
shouldn't be, especially during the build
phase. < span > < strong class = "command" > mkpatches< / strong > < / span > ,
< span > < strong class = "command" > patchdiff< / strong > < / span > and < span > < strong class = "command" > pkgvi< / strong > < / span > are
2006-05-29 10:55:59 +02:00
from the < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkgdiff/README.html" target = "_top" > < code class = "filename" > pkgtools/pkgdiff< / code > < / a >
2006-05-28 22:41:22 +02:00
package. < / p >
< / li >
2006-05-29 10:55:59 +02:00
< li > < p > Look at the < code class = "filename" > Makefile< / code > , fix if necessary;
2006-06-01 11:36:55 +02:00
see < a href = "#components.Makefile" title = "9.1.<2E> Makefile" > Section<EFBFBD> 9.1, “ < code class = "filename" > Makefile< / code > ” < / a > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< li >
2006-05-29 10:55:59 +02:00
< p > Generate a < code class = "filename" > PLIST< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > make install< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > make print-PLIST > PLIST< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > make deinstall< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > make install< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > make deinstall< / code > < / strong > < / pre >
2006-05-29 10:55:59 +02:00
< p > You usually need to be < code class = "username" > root< / code > to do this.
2006-05-28 22:41:22 +02:00
Look if there are any files left:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > make print-PLIST< / code > < / strong > < / pre >
< p > If this reveals any files that are missing in
2006-05-29 10:55:59 +02:00
< code class = "filename" > PLIST< / code > , add them.< / p >
2006-05-28 22:41:22 +02:00
< / li >
< li >
2006-05-29 10:55:59 +02:00
< p > Now that the < code class = "filename" > PLIST< / code > is OK,
2006-05-28 22:41:22 +02:00
install the package again and make a binary package:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > make reinstall< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > make package< / code > < / strong > < / pre >
< / li >
< li >
< p > Delete the installed package:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > pkg_delete blub< / code > < / strong > < / pre >
< / li >
< li >
< p > Repeat the above < span > < strong class = "command" > make print-PLIST< / strong > < / span > command,
which shouldn't find anything now:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > make print-PLIST< / code > < / strong > < / pre >
< / li >
< li >
< p > Reinstall the binary package:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > pkgadd .../blub.tgz< / code > < / strong > < / pre >
< / li >
< li > < p > Play with it. Make sure everything works.< / p > < / li >
< li >
< p > Run < span > < strong class = "command" > pkglint< / strong > < / span > from
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkglint/README.html" target = "_top" > < code class = "filename" > pkgtools/pkglint< / code > < / a > ,
2006-05-28 22:41:22 +02:00
and fix the problems it reports:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > pkglint< / code > < / strong > < / pre >
< / li >
< li > < p > Submit (or commit, if you have cvs access);
2006-06-01 11:36:55 +02:00
see < a href = "#submit" title = "Chapter<65> 19.<2E> Submitting and Committing" > Chapter<EFBFBD> 19, < i > Submitting and Committing< / i > < / a > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< / ul > < / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "submit" > < / a > Chapter<EFBFBD> 19.<2E> Submitting and Committing< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#submitting-binary-packages" > 19.1. Submitting binary packages< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#submitting-your-package" > 19.2. Submitting source packages (for non-NetBSD-developers)< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#general-notes-for-changes" > 19.3. General notes when adding, updating, or removing packages< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#committing-importing" > 19.4. Committing: Importing a package into CVS< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#updating-package" > 19.5. Updating a package to a newer version< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#moving-package" > 19.6. Moving a package in pkgsrc< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "submitting-binary-packages" > < / a > 19.1.<2E> Submitting binary packages< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Our policy is that we accept binaries only from pkgsrc
developers to guarantee that the packages don't contain any
trojan horses etc. This is not to annoy anyone but rather to
protect our users! You're still free to put up your home-made
binary packages and tell the world where to get them. NetBSD
developers doing bulk builds and wanting to upload them please
see < a href = "#bulk-upload" title = "6.3.8.<2E> Uploading results of a bulk build" > Section<EFBFBD> 6.3.8, “ Uploading results of a bulk build” < / a > .< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "submitting-your-package" > < / a > 19.2.<2E> Submitting source packages (for non-NetBSD-developers)< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > First, check that your package is complete, compiles and
2006-06-01 11:36:55 +02:00
runs well; see < a href = "#debug" title = "Chapter<65> 18.<2E> Debugging" > Chapter<EFBFBD> 18, < i > Debugging< / i > < / a > and the rest of this
2006-05-28 22:41:22 +02:00
document. Next, generate an uuencoded gzipped < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > tar< / span > (1)< / span > < / a >
archive, preferably with all files in a single directory.
Finally, < span > < strong class = "command" > send-pr< / strong > < / span > with category
“ < span class = "quote" > pkg< / span > ” , a synopsis which includes the package name
and version number, a short description of your package
(contents of the COMMENT variable or DESCR file are OK) and
attach the archive to your PR.< / p >
< p > If you want to submit several packages, please send a
separate PR for each one, it's easier for us to track things
that way.< / p >
< p > Alternatively, you can also import new packages into
pkgsrc-wip (“ < span class = "quote" > pkgsrc work-in-progress< / span > ” ); see the
homepage at < a href = "http://pkgsrc-wip.sourceforge.net/" target = "_top" > http://pkgsrc-wip.sourceforge.net/< / a >
for details.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "general-notes-for-changes" > < / a > 19.3.<2E> General notes when adding, updating, or removing packages< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Please note all package additions, updates, moves, and
2006-05-29 10:55:59 +02:00
removals in < code class = "filename" > pkgsrc/doc/CHANGES< / code > . It's very
2006-05-28 22:41:22 +02:00
important to keep this file up to date and conforming to the
existing format, because it will be used by scripts to
automatically update pages on < a href = "http://www.NetBSD.org/" target = "_top" > www.NetBSD.org< / a > and other
sites. Additionally, check the
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/doc/TODO< / code > file and remove the entry
2006-05-28 22:41:22 +02:00
for the package you updated or removed, in case it was mentioned
there.< / p >
< p > When the < code class = "varname" > PKGREVISION< / code > of a package is
bumped, the change should appear in
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/doc/CHANGES< / code > if it is security
2006-05-28 22:41:22 +02:00
related or otherwise relevant. Mass bumps that result from a
dependency being updated should not be mentioned. In all other
cases it's the developer's decision.< / p >
< p > There is a make target that helps in creating proper
2006-05-29 10:55:59 +02:00
< code class = "filename" > CHANGES< / code > entries: < span > < strong class = "command" > make
2006-05-28 22:41:22 +02:00
changes-entry< / strong > < / span > . It uses the optional < code class = "varname" > CTYPE< / code >
and < code class = "varname" > NETBSD_LOGIN_NAME< / code > variables. The general
2006-05-29 10:55:59 +02:00
usage is to first make sure that your < code class = "filename" > CHANGES< / code >
2006-05-28 22:41:22 +02:00
file is up-to-date (to avoid having to resolve conflicts later-on)
and then to < span > < strong class = "command" > cd< / strong > < / span > to the package directory. For
package updates, < span > < strong class = "command" > make changes-entry< / strong > < / span > is enough.
For new packages, or package moves or removals, set the
< code class = "varname" > CTYPE< / code > variable on the command line to "Added",
"Moved", or "Removed". You can set < code class = "varname" > NETBSD_LOGIN_NAME< / code >
2006-05-29 10:55:59 +02:00
in < code class = "filename" > /etc/mk.conf< / code > if your local login name is
2006-05-28 22:41:22 +02:00
not the same as your NetBSD login name. Don't forget to commit
2006-05-29 10:55:59 +02:00
the changes to < code class = "filename" > pkgsrc/doc/CHANGES< / code > !< / p >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "committing-importing" > < / a > 19.4.<2E> Committing: Importing a package into CVS< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p >
This section is only of interest for pkgsrc developers with write
access to the pkgsrc repository. Please remember that cvs
imports files relative to the current working directory, and that
the pathname that you
give the < span > < strong class = "command" > cvs import< / strong > < / span > command is so that it knows where
to place the files in the repository. Newly created packages should be
imported with a vendor tag of “ < span class = "quote" > TNF< / span > ” and a release tag of
“ < span class = "quote" > pkgsrc-base< / span > ” , e.g:
< / p >
< pre class = "programlisting" >
< code class = "prompt" > $< / code > cd .../pkgsrc/category/pkgname
< code class = "prompt" > $< / code > cvs import pkgsrc/category/pkgname TNF pkgsrc-base
< / pre >
< p >
Remember to move the directory from which you imported out of
the way, or cvs will complain the next time you “ < span class = "quote" > cvs
update< / span > ” your source tree. Also don't forget to add the new
2006-05-29 10:55:59 +02:00
package to the category's < code class = "filename" > Makefile< / code > .
2006-05-28 22:41:22 +02:00
< / p >
< p >
The commit message of the initial import should include part of the
2006-05-29 10:55:59 +02:00
< code class = "filename" > DESCR< / code > file, so people reading the mailing lists know
2006-05-28 22:41:22 +02:00
what the package is/does.
< / p >
< p >
For new packages, “ < span class = "quote" > cvs import< / span > ” is preferred to “ < span class = "quote" > cvs
add< / span > ” because the former gets everything with a single command,
and provides a consistent tag.
< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "updating-package" > < / a > 19.5.<2E> Updating a package to a newer version< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p >
Please always put a concise, appropriate and relevant summary of the
changes between old and new versions into the commit log when updating
a package. There are various reasons for this:
< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p >
A URL is volatile, and can change over time. It may go away completely
or its information may be overwritten by newer information.
< / p > < / li >
< li > < p >
Having the change information between old and new versions in our CVS
repository is very useful for people who use either cvs or anoncvs.
< / p > < / li >
< li > < p >
Having the change information between old and new versions in our CVS
repository is very useful for people who read the pkgsrc-changes mailing
list, so that they can make tactical decisions about when to upgrade
the package.
< / p > < / li >
< / ul > < / div >
< p >
Please also recognize that, just because a new version of a package
has been released, it should not automatically be upgraded in the CVS
repository. We prefer to be conservative in the packages that are
included in pkgsrc - development or beta packages are not really the
best thing for most places in which pkgsrc is used. Please use your
judgement about what should go into pkgsrc, and bear in mind that
stability is to be preferred above new and possibly untested features.
< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "moving-package" > < / a > 19.6.<2E> Moving a package in pkgsrc< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "orderedlist" > < ol type = "1" >
< li > < p > Make a copy of the directory somewhere else.< / p > < / li >
< li >
< p > Remove all CVS dirs.< / p >
< p >
Alternatively to the first two steps you can also do:
< / p >
< pre class = "screen" > < code class = "prompt" > %< / code > < strong class = "userinput" > < code > cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package< / code > < / strong > < / pre >
< p >
and use that for further work.
< / p >
< / li >
< li > < p > Fix < code class = "varname" > CATEGORIES< / code > and any
< code class = "varname" > DEPENDS< / code > paths that just did “ < span class = "quote" > ../package< / span > ”
instead of “ < span class = "quote" > ../../category/package< / span > ” .< / p > < / li >
< li > < p > < span > < strong class = "command" > cvs import< / strong > < / span > the modified package in the new
place.< / p > < / li >
< li >
< p > Check if any package depends on it:
< / p >
< pre class = "screen" > < code class = "prompt" > %< / code > < strong class = "userinput" > < code > cd /usr/pkgsrc< / code > < / strong >
< code class = "prompt" > %< / code > < strong class = "userinput" > < code > grep /package */*/Makefile* */*/buildlink*< / code > < / strong > < / pre >
< p >
< / p >
< / li >
< li > < p > Fix paths in packages from step 5 to point to new location.< / p > < / li >
< li > < p > < span > < strong class = "command" > cvs rm (-f)< / strong > < / span > the package at the old location.< / p > < / li >
2006-05-29 10:55:59 +02:00
< li > < p > Remove from < code class = "filename" > oldcategory/Makefile< / code > .< / p > < / li >
< li > < p > Add to < code class = "filename" > newcategory/Makefile< / code > .< / p > < / li >
2006-05-28 22:41:22 +02:00
< li >
< p > Commit the changed and removed files:< / p >
< pre class = "screen" > < code class = "prompt" > %< / code > < strong class = "userinput" > < code > cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile< / code > < / strong > < / pre >
< p >
(and any packages from step 5, of course).
< / p >
< / li >
< / ol > < / div >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "devfaq" > < / a > Chapter<EFBFBD> 20.<2E> Frequently Asked Questions< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > This section contains the answers to questions that may
arise when you are writing a package. If you don't find your
question answered here, first have a look in the other chapters,
and if you still don't have the answer, ask on the
< code class = "literal" > pkgsrc-users< / code > mailing list.< / p >
< div class = "qandaset" >
< dl >
2006-06-01 11:36:55 +02:00
< dt > 20.1. < a href = "#id2655161" > What is the difference between
2006-05-28 22:41:22 +02:00
MAKEFLAGS, .MAKEFLAGS and
MAKE_FLAGS?< / a >
< / dt >
2006-06-01 11:36:55 +02:00
< dt > 20.2. < a href = "#id2655197" > What is the difference between
2006-05-28 22:41:22 +02:00
MAKE, GMAKE and
MAKE_PROGRAM?< / a >
< / dt >
2006-06-01 11:36:55 +02:00
< dt > 20.3. < a href = "#id2655236" > What is the difference between
2006-05-28 22:41:22 +02:00
CC, PKG_CC and
PKGSRC_COMPILER?< / a >
< / dt >
2006-06-01 11:36:55 +02:00
< dt > 20.4. < a href = "#id2655273" > What is the difference between
2006-05-28 22:41:22 +02:00
BUILDLINK_LDFLAGS,
BUILDLINK_LDADD and
BUILDLINK_LIBS?< / a >
< / dt >
2006-06-01 11:36:55 +02:00
< dt > 20.5. < a href = "#id2655291" > Why does make show-var
2006-05-28 22:41:22 +02:00
VARNAME=BUILDLINK_PREFIX.foo
say it's empty?< / a >
< / dt >
< / dl >
< table border = "0" summary = "Q and A Set" >
< col align = "left" width = "1%" >
< tbody >
< tr class = "question" >
< td align = "left" valign = "top" >
2006-06-01 11:36:55 +02:00
< a name = "id2655161" > < / a > < a name = "id2655162" > < / a > < b > 20.1.< / b >
2006-05-28 22:41:22 +02:00
< / td >
< td align = "left" valign = "top" > < p > What is the difference between
< code class = "varname" > MAKEFLAGS< / code > , < code class = "varname" > .MAKEFLAGS< / code > and
< code class = "varname" > MAKE_FLAGS< / code > ?< / p > < / td >
< / tr >
< tr class = "answer" >
< td align = "left" valign = "top" > < b > < / b > < / td >
< td align = "left" valign = "top" > < p > < code class = "varname" > MAKEFLAGS< / code > are the flags passed
to the pkgsrc-internal invocations of < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > make< / span > (1)< / span > < / a > , while
< code class = "varname" > MAKE_FLAGS< / code > are the flags that are passed to
the < code class = "varname" > MAKE_PROGRAM< / code > when building the
package. [FIXME: What is .MAKEFLAGS for?]< / p > < / td >
< / tr >
< tr class = "question" >
< td align = "left" valign = "top" >
2006-06-01 11:36:55 +02:00
< a name = "id2655197" > < / a > < a name = "id2655198" > < / a > < b > 20.2.< / b >
2006-05-28 22:41:22 +02:00
< / td >
< td align = "left" valign = "top" > < p > What is the difference between
< code class = "varname" > MAKE< / code > , < code class = "varname" > GMAKE< / code > and
< code class = "varname" > MAKE_PROGRAM< / code > ?< / p > < / td >
< / tr >
< tr class = "answer" >
< td align = "left" valign = "top" > < b > < / b > < / td >
< td align = "left" valign = "top" > < p > < code class = "varname" > MAKE< / code > is the path to the
< a href = "http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > make< / span > (1)< / span > < / a > program that is used in the pkgsrc
infrastructure. < code class = "varname" > GMAKE< / code > is the path to GNU
Make, but you need to say < code class = "varname" > USE_TOOLS+=gmake< / code > to
use that. < code class = "varname" > MAKE_PROGRAM< / code > is the path to the
Make program that is used for building the
package.< / p > < / td >
< / tr >
< tr class = "question" >
< td align = "left" valign = "top" >
2006-06-01 11:36:55 +02:00
< a name = "id2655236" > < / a > < a name = "id2655237" > < / a > < b > 20.3.< / b >
2006-05-28 22:41:22 +02:00
< / td >
< td align = "left" valign = "top" > < p > What is the difference between
< code class = "varname" > CC< / code > , < code class = "varname" > PKG_CC< / code > and
< code class = "varname" > PKGSRC_COMPILER< / code > ?< / p > < / td >
< / tr >
< tr class = "answer" >
< td align = "left" valign = "top" > < b > < / b > < / td >
< td align = "left" valign = "top" > < p > < code class = "varname" > CC< / code > is the path to the real C
compiler, which can be configured by the pkgsrc user.
< code class = "varname" > PKG_CC< / code > is the path to the compiler wrapper.
< code class = "varname" > PKGSRC_COMPILER< / code > is < span class = "emphasis" > < em > not< / em > < / span > a
path to a compiler, but the type of compiler that should be
2006-05-29 10:55:59 +02:00
used. See < code class = "filename" > mk/compiler.mk< / code > for more
2006-05-28 22:41:22 +02:00
information about the latter variable.< / p > < / td >
< / tr >
< tr class = "question" >
< td align = "left" valign = "top" >
2006-06-01 11:36:55 +02:00
< a name = "id2655273" > < / a > < a name = "id2655274" > < / a > < b > 20.4.< / b >
2006-05-28 22:41:22 +02:00
< / td >
< td align = "left" valign = "top" > < p > What is the difference between
< code class = "varname" > BUILDLINK_LDFLAGS< / code > ,
< code class = "varname" > BUILDLINK_LDADD< / code > and
< code class = "varname" > BUILDLINK_LIBS< / code > ?< / p > < / td >
< / tr >
< tr class = "answer" >
< td align = "left" valign = "top" > < b > < / b > < / td >
< td align = "left" valign = "top" > < p > [FIXME]< / p > < / td >
< / tr >
< tr class = "question" >
< td align = "left" valign = "top" >
2006-06-01 11:36:55 +02:00
< a name = "id2655291" > < / a > < a name = "id2655292" > < / a > < b > 20.5.< / b >
2006-05-28 22:41:22 +02:00
< / td >
< td align = "left" valign = "top" > < p > Why does < span > < strong class = "command" > make show-var
VARNAME=BUILDLINK_PREFIX.< em class = "replaceable" > < code > foo< / code > < / em > < / strong > < / span >
say it's empty?< / p > < / td >
< / tr >
< tr class = "answer" >
< td align = "left" valign = "top" > < b > < / b > < / td >
< td align = "left" valign = "top" > < p > For optimization reasons, some variables are only
available in the “ < span class = "quote" > wrapper< / span > ” phase and later. To
“ < span class = "quote" > simulate< / span > ” the wrapper phase, append
< span > < strong class = "command" > PKG_PHASE=wrapper< / strong > < / span > to the above
command.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / div >
< / div >
< / div >
< div class = "part" lang = "en" >
< div class = "titlepage" > < div > < div > < h1 class = "title" >
< a name = "infrastructure" > < / a > Part<EFBFBD> III.<2E> The pkgsrc infrastructure internals< / h1 > < / div > < / div > < / div >
< div class = "partintro" lang = "en" >
< div > < / div >
< p > This part of the guide deals with everything
from the infrastructure that is behind the interfaces described
in the developer's guide. A casual package maintainer should not
need anything from this part.< / p >
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#infr.design" > 21. Design of the pkgsrc infrastructure< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#infr.var" > 21.1. Variable evaluation< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#infr.var.load" > 21.1.1. At load time< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#infr.var.run" > 21.1.2. At runtime< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#infr.design.intf" > 21.2. Designing interfaces for Makefile fragments< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#infr.design.intf.proc" > 21.2.1. Procedures with parameters< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#infr.design.intf.action" > 21.2.2. Actions taken on behalf of parameters< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#regression" > 22. Regression tests< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#regression.descr" > 22.1. The regression tests framework< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#regression.run" > 22.2. Running the regression tests< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#regression.new" > 22.3. Adding a new regression test< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#regression.fun.override" > 22.3.1. Overridable functions< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#regression.fun.helper" > 22.3.2. Helper functions< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "chapter" > < a href = "#porting" > 23. Porting pkgsrc< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#porting.opsys" > 23.1. Porting pkgsrc to a new operating system< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#porting.compiler" > 23.2. Adding support for a new compiler< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< / dl >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "infr.design" > < / a > Chapter<EFBFBD> 21.<2E> Design of the pkgsrc infrastructure< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#infr.var" > 21.1. Variable evaluation< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#infr.var.load" > 21.1.1. At load time< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#infr.var.run" > 21.1.2. At runtime< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#infr.design.intf" > 21.2. Designing interfaces for Makefile fragments< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#infr.design.intf.proc" > 21.2.1. Procedures with parameters< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#infr.design.intf.action" > 21.2.2. Actions taken on behalf of parameters< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< / dl >
< / div >
< p > The pkgsrc infrastructure consists of many small Makefile
fragments. Each such fragment needs a properly specified
interface. This chapter explains how such an interface looks
like.< / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "infr.var" > < / a > 21.1.<2E> Variable evaluation< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "infr.var.load" > < / a > 21.1.1.<2E> At load time< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Variable evaluation takes place either at load time or at
runtime, depending on the context in which they occur. The
contexts where variables are evaluated at load time are:< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p > The right hand side of the < code class = "literal" > :=< / code >
and < code class = "literal" > !=< / code > operators,< / p > < / li >
< li > < p > Make directives like < code class = "literal" > .if< / code > or
< code class = "literal" > .for< / code > ,< / p > < / li >
< li > < p > Dependency lines.< / p > < / li >
< / ul > < / div >
< p > A special exception are references to the iteration
variables of < code class = "literal" > .for< / code > loops, which are expanded
inline, no matter in which context they appear.< / p >
< p > As the values of variables may change during load time,
care must be taken not to evaluate them by accident. Typical
examples for variables that should not be evaluated at load time
are < code class = "varname" > DEPENDS< / code > and
< code class = "varname" > CONFIGURE_ARGS< / code > . To make the effect more
clear, here is an example:< / p >
< pre class = "programlisting" >
CONFIGURE_ARGS= # none
CFLAGS= -O
CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
2004-10-21 16:44:39 +02:00
2006-05-28 22:41:22 +02:00
CFLAGS+= -Wall
< / pre >
< p > This code shows how the use of the < code class = "literal" > :=< / code >
operator can quickly lead to unexpected results. The first
paragraph is fairly common code. The second paragraph evaluates
the < code class = "varname" > CONFIGURE_ARGS< / code > variable, which results in
< code class = "literal" > CFLAGS=-O< / code > . In the third paragraph, the
< code class = "literal" > -Wall< / code > is appended to the
< code class = "varname" > CFLAGS< / code > , but this addition will not appear in
< code class = "varname" > CONFIGURE_ARGS< / code > . In actual code, the three
paragraphs from above typically occur in completely unrelated
files.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "infr.var.run" > < / a > 21.1.2.<2E> At runtime< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > After all the files have been loaded, the values of the
variables cannot be changed anymore. Variables that are used in
the shell commands are expanded at this point.< / p >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "infr.design.intf" > < / a > 21.2.<2E> Designing interfaces for Makefile fragments< / h2 > < / div > < / div > < / div >
2006-05-29 10:55:59 +02:00
< p > Most of the < code class = "filename" > .mk< / code > files fall into one
2006-05-28 22:41:22 +02:00
of the following classes. Cases where a file falls into more
than one class should be avoided as it often leads to subtle
bugs.< / p >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "infr.design.intf.proc" > < / a > 21.2.1.<2E> Procedures with parameters< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > In a traditional imperative programming language some of
2006-05-29 10:55:59 +02:00
the < code class = "filename" > .mk< / code > files could be described as
2006-05-28 22:41:22 +02:00
procedures. They take some input parameters and— after
inclusion— provide a result in output parameters. Since all
2006-05-29 10:55:59 +02:00
variables in < code class = "filename" > Makefile< / code > s have global scope
2006-05-28 22:41:22 +02:00
care must be taken not to use parameter names that have already
another meaning. For example, < code class = "varname" > PKGNAME< / code > is a
bad choice for a parameter name.< / p >
< p > Procedures are completely evaluated at preprocessing time.
That is, when calling a procedure all input parameters must be
completely resolvable. For example,
< code class = "varname" > CONFIGURE_ARGS< / code > should never be an input
parameter since it is very likely that further text will be
added after calling the procedure, which would effectively apply
the procedure to only a part of the variable. Also, references
to other variables wit will be modified after calling the
procedure.< / p >
< p > A procedure can declare its output parameters either as
suitable for use in preprocessing directives or as only
available at runtime. The latter alternative is for variables
that contain references to other runtime variables.< / p >
< p > Procedures shall be written such that it is possible to
call the procedure more than once. That is, the file must not
contain multiple-inclusion guards.< / p >
< p > Examples for procedures are
2006-05-29 10:55:59 +02:00
< code class = "filename" > mk/bsd.options.mk< / code > and
< code class = "filename" > mk/buildlink3/bsd.builtin.mk< / code > . To express
2006-05-28 22:41:22 +02:00
that the parameters are evaluated at load time, they should be
assigned using the < code class = "literal" > :=< / code > operator, which should
be used only for this purpose.< / p >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "infr.design.intf.action" > < / a > 21.2.2.<2E> Actions taken on behalf of parameters< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > Action files take some input parameters and may define
runtime variables. They shall not define loadtime variables.
There are action files that are included implicitly by the
pkgsrc infrastructure, while other must be included
explicitly.< / p >
< p > An example for action files is
2006-05-29 10:55:59 +02:00
< code class = "filename" > mk/subst.mk< / code > .< / p >
2006-05-28 22:41:22 +02:00
< / div >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "regression" > < / a > Chapter<EFBFBD> 22.<2E> Regression tests< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#regression.descr" > 22.1. The regression tests framework< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#regression.run" > 22.2. Running the regression tests< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#regression.new" > 22.3. Adding a new regression test< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect2" > < a href = "#regression.fun.override" > 22.3.1. Overridable functions< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#regression.fun.helper" > 22.3.2. Helper functions< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl > < / dd >
< / dl >
< / div >
< p > The pkgsrc infrastructure consists of a large codebase,
and there are many corners where every little bit of a file is
well thought out, making pkgsrc likely to fail as soon as
anything is changed near those parts. To prevent most changes
from breaking anything, a suite of regression tests should go
along with every important part of the pkgsrc infrastructure.
This chapter describes how regression tests work in pkgsrc and
how you can add new tests.< / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "regression.descr" > < / a > 22.1.<2E> The regression tests framework< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > < / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "regression.run" > < / a > 22.2.<2E> Running the regression tests< / h2 > < / div > < / div > < / div >
2006-05-29 10:55:59 +02:00
< p > You first need to install the < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkg_regress/README.html" target = "_top" > < code class = "filename" > pkgtools/pkg_regress< / code > < / a > package, which
2006-05-28 22:41:22 +02:00
provides the < span > < strong class = "command" > pkg_regress< / strong > < / span > command. Then you
can simply run that command, which will run all tests in the
2006-05-29 10:55:59 +02:00
< code class = "filename" > regress< / code > category.< / p >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "regression.new" > < / a > 22.3.<2E> Adding a new regression test< / h2 > < / div > < / div > < / div >
2006-05-29 10:55:59 +02:00
< p > Every directory in the < code class = "filename" > regress< / code >
category that contains a file called < code class = "filename" > spec< / code >
2006-05-28 22:41:22 +02:00
is considered a regression test. This file is a shell program
that is included by the < span > < strong class = "command" > pkg_regress< / strong > < / span > command.
The following functions can be overridden to suit your
needs.< / p >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "regression.fun.override" > < / a > 22.3.1.<2E> Overridable functions< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > These functions do not take any parameters. They are all
called in “ < span class = "quote" > set -e< / span > ” mode, so you should be careful
to check the exitcodes of any commands you run in the
test.< / p >
< div class = "variablelist" > < dl >
< dt > < span class = "term" > < code class = "varname" > do_setup()< / code > < / span > < / dt >
< dd > < p > This function prepares the environment for the
test. By default it does nothing.< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > do_test()< / code > < / span > < / dt >
< dd > < p > This function runs the actual test. By default,
it calls < code class = "varname" > TEST_MAKE< / code > with the arguments
< code class = "varname" > MAKEARGS_TEST< / code > and writes its output including
error messages into the file
< code class = "varname" > TEST_OUTFILE< / code > .< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > check_result()< / code > < / span > < / dt >
< dd > < p > This function is run after the test and is
typically used to compare the actual output from the one that is
expected. It can make use of the various helper functions from
the next section.< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > do_cleanup()< / code > < / span > < / dt >
< dd > < p > This function cleans everything up after the
test has been run. By default it does nothing.< / p > < / dd >
< / dl > < / div >
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "regression.fun.helper" > < / a > 22.3.2.<2E> Helper functions< / h3 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "variablelist" > < dl >
< dt > < span class = "term" > < code class = "varname" > exit_status(expected)< / code > < / span > < / dt >
< dd > < p > This function compares the exitcode of the
< span > < strong class = "command" > do_test()< / strong > < / span > function with its first parameter.
If they differ, the test will fail.< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > output_require(regex...)< / code > < / span > < / dt >
< dd > < p > This function checks for each of its parameters
if the output from < span > < strong class = "command" > do_test()< / strong > < / span > matches the
extended regular expression. If it does not, the test will
fail.< / p > < / dd >
< dt > < span class = "term" > < code class = "varname" > output_prohibit(regex...)< / code > < / span > < / dt >
< dd > < p > This function checks for each of its parameters
if the output from < span > < strong class = "command" > do_test()< / strong > < / span > does
< span class = "emphasis" > < em > not< / em > < / span > match the extended regular expression.
If any of the regular expressions matches, the test will
fail.< / p > < / dd >
< / dl > < / div >
< / div >
< / div >
< / div >
< div class = "chapter" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-06-01 11:36:55 +02:00
< a name = "porting" > < / a > Chapter<EFBFBD> 23.<2E> Porting pkgsrc< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
2006-06-01 11:36:55 +02:00
< dt > < span class = "sect1" > < a href = "#porting.opsys" > 23.1. Porting pkgsrc to a new operating system< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#porting.compiler" > 23.2. Adding support for a new compiler< / a > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< / dl >
< / div >
< p > The pkgsrc system has already been ported to many
operating systems, hardware architectures and compilers. This
chapter explains the necessary steps to make pkgsrc even more
portable.< / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "porting.opsys" > < / a > 23.1.<2E> Porting pkgsrc to a new operating system< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > To port pkgsrc to a new operating system (called
< code class = "literal" > MyOS< / code > in this example), you need to touch the
following files:< / p >
< div class = "variablelist" > < dl >
2006-05-29 10:55:59 +02:00
< dt > < span class = "term" > < code class = "filename" > bootstrap/mods/mk/< em class = "replaceable" > < code > MyOS< / code > < / em > .sys.mk< / code > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < p > This file contains some basic definitions, for
example the name of the C
compiler.< / p > < / dd >
2006-05-29 10:55:59 +02:00
< dt > < span class = "term" > < code class = "filename" > mk/bsd.prefs.mk< / code > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < p > Insert code that defines the variables
< code class = "varname" > OPSYS< / code > , < code class = "varname" > OS_VERSION< / code > ,
< code class = "varname" > LOWER_OS_VERSION< / code > ,
< code class = "varname" > LOWER_VENDOR< / code > ,
< code class = "varname" > MACHINE_ARCH< / code > , < code class = "varname" > OBJECT_FMT< / code > ,
< code class = "varname" > APPEND_ELF< / code > , and the other variables that
appear in this file.< / p > < / dd >
2006-05-29 10:55:59 +02:00
< dt > < span class = "term" > < code class = "filename" > mk/platform/MyOS.mk< / code > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < p > This file contains the platform-specific
definitions that are used by pkgsrc. Start by copying one of the
other files and edit it to your
needs.< / p > < / dd >
2006-05-29 10:55:59 +02:00
< dt > < span class = "term" > < code class = "filename" > mk/platform/MyOS.pkg.dist< / code > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < p > This file contains a list of directories,
together with their permission bits and ownership. These
directories will be created automatically with every package
that does not explicitly set < code class = "varname" > NO_MTREE< / code > . There
have been some discussions about whether this file is needed at
all, but with no result.< / p > < / dd >
2006-05-29 10:55:59 +02:00
< dt > < span class = "term" > < code class = "filename" > mk/platform/MyOS.x11.dist< / code > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < p > Just copy one of the pre-existing x11.dist files
to your
2006-05-29 10:55:59 +02:00
< code class = "filename" > < em class = "replaceable" > < code > MyOS< / code > < / em > .x11.dist< / code > .< / p > < / dd >
< dt > < span class = "term" > < code class = "filename" > mk/tools/bootstrap.mk< / code > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < p > On some operating systems, the tools that are
provided with the base system are not good enough for pkgsrc.
For example, there are many versions of < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > sed< / span > (1)< / span > < / a > that have a
narrow limit on the line length they can process. Therefore
pkgsrc brings its own tools, which can be enabled
here.< / p > < / dd >
2006-05-29 10:55:59 +02:00
< dt > < span class = "term" > < code class = "filename" > mk/tools/< em class = "replaceable" > < code > MyOS< / code > < / em > .mk< / code > < / span > < / dt >
2006-05-28 22:41:22 +02:00
< dd > < p > This file defines the paths to all the tools
that are needed by one or the other package in pkgsrc, as well
as by pkgsrc itself. Find out where these tools are on your
platform and add them.< / p > < / dd >
< / dl > < / div >
< p > Now, you should be able to build some basic packages, like
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/lang/perl5/README.html" target = "_top" > < code class = "filename" > lang/perl5< / code > < / a > , < a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/shells/bash/README.html" target = "_top" > < code class = "filename" > shells/bash< / code > < / a > .< / p >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
2006-06-01 11:36:55 +02:00
< a name = "porting.compiler" > < / a > 23.2.<2E> Adding support for a new compiler< / h2 > < / div > < / div > < / div >
2006-05-28 22:41:22 +02:00
< p > TODO< / p >
< / div >
< / div >
< / div >
< div class = "appendix" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
< a name = "examples" > < / a > Appendix<EFBFBD> A.<2E> A simple example package: bison< / h2 > < / div > < / div > < / div >
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
< dt > < span class = "sect1" > < a href = "#example-files" > A.1. files< / a > < / span > < / dt >
< dd > < dl >
< dt > < span class = "sect2" > < a href = "#example-Makefile" > A.1.1. Makefile< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#example-descr" > A.1.2. DESCR< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#example-plist" > A.1.3. PLIST< / a > < / span > < / dt >
< dt > < span class = "sect2" > < a href = "#checking-package-with-pkglint" > A.1.4. Checking a package with < span > < strong class = "command" > pkglint< / strong > < / span > < / a > < / span > < / dt >
< / dl > < / dd >
< dt > < span class = "sect1" > < a href = "#steps-for-b-i-p" > A.2. Steps for building, installing, packaging< / a > < / span > < / dt >
< / dl >
< / div >
< p > We checked to find a piece of software that wasn't in the packages
collection, and picked GNU bison. Quite why someone would want to have
< span > < strong class = "command" > bison< / strong > < / span > when Berkeley < span > < strong class = "command" > yacc< / strong > < / span > is already
present in the tree is beyond us, but it's useful for the purposes of
this exercise.< / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "example-files" > < / a > A.1.<2E> files< / h2 > < / div > < / div > < / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "example-Makefile" > < / a > A.1.1.<2E> Makefile< / h3 > < / div > < / div > < / div >
< pre class = "programlisting" >
2005-10-23 13:33:53 +02:00
# $NetBSD$
#
2004-10-21 16:44:39 +02:00
2005-10-23 13:33:53 +02:00
DISTNAME= bison-1.25
CATEGORIES= devel
MASTER_SITES= ${MASTER_SITE_GNU}
2004-10-21 16:44:39 +02:00
2005-10-23 13:33:53 +02:00
MAINTAINER= thorpej@NetBSD.org
HOMEPAGE= http://www.gnu.org/software/bison/bison.html
COMMENT= GNU yacc clone
2004-10-21 16:44:39 +02:00
2005-10-23 13:33:53 +02:00
GNU_CONFIGURE= yes
INFO_FILES= bison.info
2004-10-21 16:44:39 +02:00
2005-10-23 13:33:53 +02:00
.include "../../mk/bsd.pkg.mk"
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "example-descr" > < / a > A.1.2.<2E> DESCR< / h3 > < / div > < / div > < / div >
< pre class = "programlisting" >
2005-10-23 13:33:53 +02:00
GNU version of yacc. Can make re-entrant parsers, and numerous other
2006-05-28 22:41:22 +02:00
improvements. Why you would want this when Berkeley < a href = "http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-current" > < span class = "citerefentry" > < span class = "refentrytitle" > yacc< / span > (1)< / span > < / a > is part
2005-10-23 13:33:53 +02:00
of the NetBSD source tree is beyond me.
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "example-plist" > < / a > A.1.3.<2E> PLIST< / h3 > < / div > < / div > < / div >
< pre class = "programlisting" >
2005-10-23 13:33:53 +02:00
@comment $NetBSD$
bin/bison
man/man1/bison.1.gz
share/bison.simple
share/bison.hairy
2004-10-21 16:44:39 +02:00
< / pre >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "sect2" lang = "en" >
< div class = "titlepage" > < div > < div > < h3 class = "title" >
< a name = "checking-package-with-pkglint" > < / a > A.1.4.<2E> Checking a package with < span > < strong class = "command" > pkglint< / strong > < / span > < / h3 > < / div > < / div > < / div >
< p > The NetBSD package system comes with
2006-05-29 10:55:59 +02:00
< a href = "ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/pkgtools/pkglint/README.html" target = "_top" > < code class = "filename" > pkgtools/pkglint< / code > < / a >
2006-05-28 22:41:22 +02:00
which helps to check the contents of these
files. After installation it is quite easy to use, just change to the
directory of the package you wish to examine and execute
< span > < strong class = "command" > pkglint< / strong > < / span > :< / p >
< pre class = "screen" > < code class = "prompt" > $< / code > < strong class = "userinput" > < code > pkglint< / code > < / strong >
looks fine.< / pre >
< p > Depending on the supplied command line arguments (see pkglint(1)),
more checks will be performed. Use e.g. < span > < strong class = "command" > pkglint -Call
-Wall< / strong > < / span > for a very thorough check.< / p >
< / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "steps-for-b-i-p" > < / a > A.2.<2E> Steps for building, installing, packaging< / h2 > < / div > < / div > < / div >
< p > Create the directory where the package lives,
plus any auxiliary directories:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > cd /usr/pkgsrc/lang< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > mkdir bison< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > cd bison< / code > < / strong >
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > mkdir patches< / code > < / strong > < / pre >
2006-05-29 10:55:59 +02:00
< p > Create < code class = "filename" > Makefile< / code > , < code class = "filename" > DESCR< / code > and
2006-06-01 11:36:55 +02:00
< code class = "filename" > PLIST< / code > (see < a href = "#components" title = "Chapter<65> 9.<2E> Package components - files, directories and contents" > Chapter<EFBFBD> 9, < i > Package components - files, directories and contents< / i > < / a > )
2006-05-28 22:41:22 +02:00
then continue with fetching the distfile:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > make fetch< / code > < / strong >
2004-10-21 16:44:39 +02:00
> > bison-1.25.tar.gz doesn't seem to exist on this system.
> > Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
ftp: Error retrieving file: 500 Internal error
> > Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
ftp: Error retrieving file: 500 Internal error
> > Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
2006-05-28 22:41:22 +02:00
Successfully retrieved file.< / pre >
< p > Generate the checksum of the distfile into
2006-05-29 10:55:59 +02:00
< code class = "filename" > distinfo< / code > :< / p >
2006-05-28 22:41:22 +02:00
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > make makesum< / code > < / strong > < / pre >
< p > Now compile:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > make< / code > < / strong >
2004-10-21 16:44:39 +02:00
> > Checksum OK for bison-1.25.tar.gz.
===> Extracting for bison-1.25
===> Patching for bison-1.25
===> Ignoring empty patch directory
===> Configuring for bison-1.25
creating cache ./config.cache
checking for gcc... cc
checking whether we are using GNU C... yes
checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
checking how to run the C preprocessor... cc -E
checking for minix/config.h... no
checking for POSIXized ISC... no
checking whether cross-compiling... no
checking for ANSI C header files... yes
checking for string.h... yes
checking for stdlib.h... yes
checking for memory.h... yes
checking for working const... yes
checking for working alloca.h... no
checking for alloca... yes
checking for strerror... yes
updating cache ./config.cache
creating ./config.status
creating Makefile
===> Building for bison-1.25
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g LR0.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g allocate.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g closure.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g conflicts.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g derives.c
2006-02-14 11:16:26 +01:00
cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\" -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -g ./files.c
2004-10-21 16:44:39 +02:00
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getargs.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g gram.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lalr.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g lex.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g main.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g nullable.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g output.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g print.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reader.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g reduce.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g symtab.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g warshall.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g version.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt.c
cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include -g getopt1.c
cc -g -o bison LR0.o allocate.o closure.o conflicts.o derives.o files.o getargs.o gram.o lalr.o lex.o main.o nullable.o output.o print.o reader.o reduce.o symtab.o warshall.o version.o getopt.o getopt1.o
./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
rm -f bison.s1
2006-05-28 22:41:22 +02:00
sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1< / pre >
< p > Everything seems OK, so install the files:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > make install< / code > < / strong >
2004-10-21 16:44:39 +02:00
> > Checksum OK for bison-1.25.tar.gz.
===> Installing for bison-1.25
sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
rm -f /usr/pkg/bin/bison
cd /usr/pkg/share; rm -f bison.simple bison.hairy
rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
/usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
/usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
/usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
2006-05-28 22:41:22 +02:00
===> Registering installation for bison-1.25< / pre >
< p > You can now use bison, and also - if you decide so - remove it with
< span > < strong class = "command" > pkg_delete bison< / strong > < / span > . Should you decide that you want a
binary package, do this now:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > make package< / code > < / strong >
2004-10-21 16:44:39 +02:00
> > Checksum OK for bison-1.25.tar.gz.
===> Building package for bison-1.25
Creating package bison-1.25.tgz
Registering depends:.
2006-05-28 22:41:22 +02:00
Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'< / pre >
< p > Now that you don't need the source and object files
any more, clean up:< / p >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > make clean< / code > < / strong >
===> Cleaning for bison-1.25< / pre >
< / div >
< / div >
< div class = "appendix" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
< a name = "logs" > < / a > Appendix<EFBFBD> B.<2E> Build logs< / h2 > < / div > < / div > < / div >
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
< dt > < span class = "sect1" > < a href = "#logs.building" > B.1. Building figlet< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#logs.package" > B.2. Packaging figlet< / a > < / span > < / dt >
< / dl >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "logs.building" > < / a > B.1.<2E> Building figlet< / h2 > < / div > < / div > < / div >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > make< / code > < / strong >
2004-10-21 16:44:39 +02:00
===> Checking for vulnerabilities in figlet-2.2.1nb2
=> figlet221.tar.gz doesn't seem to exist on this system.
=> Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
=> [172219 bytes]
Connected to ftp.plig.net.
220 ftp.plig.org NcFTPd Server (licensed copy) ready.
331 Guest login ok, send your complete e-mail address as password.
230-You are user #5 of 500 simultaneous users allowed.
230-
2006-02-14 11:16:26 +01:00
230- ___ _ _ _
230- | _| |_ ___ ___| |_|___ ___ ___ ___
2004-10-21 16:44:39 +02:00
230- | _| _| . |_| . | | | . |_| . | _| . |
230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
230- |_| |_| |___| |___|
230-
230-** Welcome to ftp.plig.org **
230-
230-Please note that all transfers from this FTP site are logged. If you
230-do not like this, please disconnect now.
230-
230-This arhive is available via
230-
230-HTTP: http://ftp.plig.org/
230-FTP: ftp://ftp.plig.org/ (max 500 connections)
230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
230-
230-Please email comments, bug reports and requests for packages to be
2006-02-14 11:16:26 +01:00
230-mirrored to ftp-admin@plig.org.
2004-10-21 16:44:39 +02:00
230-
230-
230 Logged in anonymously.
Remote system type is UNIX.
Using binary mode to transfer files.
200 Type okay.
250 "/pub" is new cwd.
250-"/pub/figlet" is new cwd.
250-
250-Welcome to the figlet archive at ftp.figlet.org
2006-02-14 11:16:26 +01:00
250-
2006-05-28 22:41:22 +02:00
250- ftp://ftp.figlet.org/pub/figlet/
2004-10-21 16:44:39 +02:00
250-
250-The official FIGlet web page is:
2006-05-28 22:41:22 +02:00
250- http://www.figlet.org/
2004-10-21 16:44:39 +02:00
250-
250-If you have questions, please mailto:info@figlet.org. If you want to
250-contribute a font or something else, you can email us.
2006-02-14 11:16:26 +01:00
250
2004-10-21 16:44:39 +02:00
250 "/pub/figlet/program" is new cwd.
250 "/pub/figlet/program/unix" is new cwd.
local: figlet221.tar.gz remote: figlet221.tar.gz
502 Unimplemented command.
227 Entering Passive Mode (195,40,6,41,246,104)
150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
38% |************** | 65800 64.16 KB/s 00:01 ETA
226 Transfer completed.
172219 bytes received in 00:02 (75.99 KB/s)
221 Goodbye.
=> Checksum OK for figlet221.tar.gz.
===> Extracting for figlet-2.2.1nb2
===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
===> Patching for figlet-2.2.1nb2
===> Applying pkgsrc patches for figlet-2.2.1nb2
===> Overriding tools for figlet-2.2.1nb2
===> Creating toolchain wrappers for figlet-2.2.1nb2
===> Configuring for figlet-2.2.1nb2
===> Building for figlet-2.2.1nb2
gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
chmod a+x figlet
gcc -O2 -o chkfont chkfont.c
=> Unwrapping files-to-be-installed.
2005-01-11 16:48:17 +01:00
< code class = "prompt" > #< / code >
2006-05-28 22:41:22 +02:00
< code class = "prompt" > #< / code > < strong class = "userinput" > < code > make install< / code > < / strong >
2004-10-21 16:44:39 +02:00
===> Checking for vulnerabilities in figlet-2.2.1nb2
===> Installing for figlet-2.2.1nb2
install -d -o root -g wheel -m 755 /usr/pkg/bin
install -d -o root -g wheel -m 755 /usr/pkg/man/man6
mkdir -p /usr/pkg/share/figlet
cp figlet /usr/pkg/bin
cp chkfont /usr/pkg/bin
chmod 555 figlist showfigfonts
cp figlist /usr/pkg/bin
cp showfigfonts /usr/pkg/bin
cp fonts/*.flf /usr/pkg/share/figlet
cp fonts/*.flc /usr/pkg/share/figlet
cp figlet.6 /usr/pkg/man/man6
===> Registering installation for figlet-2.2.1nb2
2006-05-28 22:41:22 +02:00
< code class = "prompt" > #< / code > < / pre >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "logs.package" > < / a > B.2.<2E> Packaging figlet< / h2 > < / div > < / div > < / div >
< pre class = "screen" > < code class = "prompt" > #< / code > < strong class = "userinput" > < code > make package< / code > < / strong >
2004-10-21 16:44:39 +02:00
===> Checking for vulnerabilities in figlet-2.2.1nb2
===> Packaging figlet-2.2.1nb2
===> Building binary package for figlet-2.2.1nb2
Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
Using SrcDir value of /usr/pkg
2006-02-14 11:16:26 +01:00
Registering depends:.
2006-05-28 22:41:22 +02:00
< code class = "prompt" > #< / code > < / pre >
< / div >
< / div >
< div class = "appendix" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
2006-05-29 10:55:59 +02:00
< a name = "ftp-layout" > < / a > Appendix<EFBFBD> C.<2E> Directory layout of the pkgsrc FTP server< / h2 > < / div > < / div > < / div >
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
< dt > < span class = "sect1" > < a href = "#ftp-bootstrap" > C.1. < code class = "filename" > bootstrap-pkgsrc< / code > : Bootstrap kits< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#ftp-distfiles" > C.2. < code class = "filename" > distfiles< / code > : The distributed source files< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#ftp-iso" > C.3. < code class = "filename" > iso< / code > : Currently empty< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#ftp-misc" > C.4. < code class = "filename" > misc< / code > : Miscellaneous things< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#ftp-packages" > C.5. < code class = "filename" > packages*< / code > : Binary packages< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#ftp-source" > C.6. < code class = "filename" > current< / code > ,
< code class = "filename" > 200< em class = "replaceable" > < code > x< / code > < / em > Q< em class = "replaceable" > < code > y< / code > < / em > < / code > :
source packages< / a > < / span > < / dt >
< / dl >
< / div >
< p > As in other big projects, the directory layout of pkgsrc
is quite complex for newbies. This chapter explains where you
find things on the FTP server. The base directory on
< code class = "filename" > ftp.NetBSD.org< / code > is < a href = "ftp://ftp.NetBSD.org/pub/pkgsrc" target = "_top" > < code class = "filename" > /pub/pkgsrc< / code > < / a > .
This directory contains some subdirectories, which are explained
below.< / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "ftp-bootstrap" > < / a > C.1.<2E> < code class = "filename" > bootstrap-pkgsrc< / code > : Bootstrap kits< / h2 > < / div > < / div > < / div >
< p > For those who only want to manage binary packages on
systems other than NetBSD, we provide the package management
tools in a separate, small tar file.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "ftp-distfiles" > < / a > C.2.<2E> < code class = "filename" > distfiles< / code > : The distributed source files< / h2 > < / div > < / div > < / div >
< p > The directory < code class = "filename" > distfiles< / code > contains lots
of archive files from all pkgsrc packages, which are mirrored
here. The subdirectories are called after their package names
and are used when the distributed files have names that don't
explicitly contain a version number or are otherwise too generic
(for example < code class = "filename" > release.tar.gz< / code > ).< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "ftp-iso" > < / a > C.3.<2E> < code class = "filename" > iso< / code > : Currently empty< / h2 > < / div > < / div > < / div >
< p > This directory is currently not in use.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "ftp-misc" > < / a > C.4.<2E> < code class = "filename" > misc< / code > : Miscellaneous things< / h2 > < / div > < / div > < / div >
< p > This directory contains things that individual pkgsrc
developers find worth publishing.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "ftp-packages" > < / a > C.5.<2E> < code class = "filename" > packages*< / code > : Binary packages< / h2 > < / div > < / div > < / div >
< p > These directories contain binary packages. Those
directories that have a branch name
(200< em class = "replaceable" > < code > x< / code > < / em > Q< em class = "replaceable" > < code > y< / code > < / em > )
contain packages from that particular branch. The directory
< code class = "filename" > packages< / code > contains binary packages from
pkgsrc-current. (However, this does not necessarily mean that
the packages are still current anymore.)< / p >
< p > Below the < code class = "filename" > packages*< / code > directories are
directories that distinguish the packages by operating system
and version, the next directory level specifies the hardware
architecture.< / p >
< p > In each of the platform-specific directories, there is a
whole binary packages collection. It has a directory called
< code class = "filename" > All< / code > which contains all binary packages.
Besides that, there are various category directories that
contain symbolic links to the real binary packages.< / p >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "ftp-source" > < / a > C.6.<2E> < code class = "filename" > current< / code > ,
< code class = "filename" > 200< em class = "replaceable" > < code > x< / code > < / em > Q< em class = "replaceable" > < code > y< / code > < / em > < / code > :
source packages< / h2 > < / div > < / div > < / div >
< p > These directories contain the “ < span class = "quote" > real< / span > ” pkgsrc,
that is the files that define how to create binary packages from
source archives.< / p >
< p > The directory < code class = "filename" > pkgsrc< / code > contains a
snapshot of the CVS repository, which is updated on a regularly
basis. The file < code class = "filename" > pkgsrc.tar.gz< / code > contains the
same as the directory, ready to be downloaded as a whole.< / p >
< p > In the directories for the quarterly branches, there is an
additional file called
< code class = "filename" > pkgsrc-200< em class = "replaceable" > < code > x< / code > < / em > Q< em class = "replaceable" > < code > y< / code > < / em > .tar.gz< / code > ,
which contains the state of pkgsrc when it was branched.< / p >
< / div >
2006-05-28 22:41:22 +02:00
< / div >
< div class = "appendix" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" >
< a name = "editing" > < / a > Appendix<EFBFBD> D.<2E> Editing guidelines for the pkgsrc guide< / h2 > < / div > < / div > < / div >
< div class = "toc" >
< p > < b > Table of Contents< / b > < / p >
< dl >
< dt > < span class = "sect1" > < a href = "#targets" > D.1. Targets< / a > < / span > < / dt >
< dt > < span class = "sect1" > < a href = "#procedure" > D.2. Procedure< / a > < / span > < / dt >
< / dl >
< / div >
< p >
This section contains information on editing the pkgsrc guide
itself.
< / p >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "targets" > < / a > D.1.<2E> Targets< / h2 > < / div > < / div > < / div >
< p >
The pkgsrc guide's source code is stored in
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/doc/guide/files< / code > , and several files are
2006-05-28 22:41:22 +02:00
created from it:
< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p >
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/doc/pkgsrc.txt< / code >
2006-05-28 22:41:22 +02:00
< / p > < / li >
< li > < p >
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/doc/pkgsrc.html< / code >
2006-05-28 22:41:22 +02:00
< / p > < / li >
< li > < p >
2006-05-29 10:55:59 +02:00
< code class = "filename" > http://www.NetBSD.org/Documentation/pkgsrc/< / code > :
2006-05-28 22:41:22 +02:00
the documentation on the NetBSD website will be built from
pkgsrc and kept up to date on the web server itself. This
means you < span class = "emphasis" > < em > must< / em > < / span > make sure that your
changes haven't broken the build!
< / p > < / li >
< li > < p >
2006-05-29 10:55:59 +02:00
< code class = "filename" > http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.pdf< / code > :
2006-05-28 22:41:22 +02:00
PDF version of the pkgsrc guide.
< / p > < / li >
< li > < p >
2006-05-29 10:55:59 +02:00
< code class = "filename" > http://www.NetBSD.org/Documentation/pkgsrc/pkgsrc.ps< / code > :
2006-05-28 22:41:22 +02:00
PostScript version of the pkgsrc guide.
< / p > < / li >
< / ul > < / div >
< / div >
< div class = "sect1" lang = "en" >
< div class = "titlepage" > < div > < div > < h2 class = "title" style = "clear: both" >
< a name = "procedure" > < / a > D.2.<2E> Procedure< / h2 > < / div > < / div > < / div >
< p >
The procedure to edit the pkgsrc guide is:
< / p >
< div class = "itemizedlist" > < ul type = "disc" >
< li > < p >
Make sure you have the packages needed to re-generate the
pkgsrc guide (and other XML-based NetBSD documentation)
installed. These are “ < span class = "quote" > netbsd-doc< / span > ” for creating the
ASCII and HTML versions, and
“ < span class = "quote" > netbsd-doc-print< / span > ” for the PostScript and PDF
versions. You will need both packages installed, to make sure
documentation is consistent across all formats. The packages
can be found in
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/meta-pkgs/netbsd-doc< / code > and
< code class = "filename" > pkgsrc/meta-pkgs/netbsd-doc-print< / code > .
2006-05-28 22:41:22 +02:00
< / p > < / li >
< li > < p >
Edit the XML file(s) in
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/doc/guide/files< / code > .
2006-05-28 22:41:22 +02:00
< / p > < / li >
< li > < p >
Run < span > < strong class = "command" > make extract & & make do-lint< / strong > < / span > in
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/doc/guide< / code > to check the XML
2006-05-28 22:41:22 +02:00
syntax, and fix it if needed.
< / p > < / li >
< li > < p >
Run < span > < strong class = "command" > make< / strong > < / span > in
2006-05-29 10:55:59 +02:00
< code class = "filename" > pkgsrc/doc/guide< / code > to build the HTML and
2006-05-28 22:41:22 +02:00
ASCII version.
< / p > < / li >
< li > < p >
If all is well, run < span > < strong class = "command" > make install-doc< / strong > < / span > to put
2006-05-29 10:55:59 +02:00
the generated files into < code class = "filename" > pkgsrc/doc< / code > .
2006-05-28 22:41:22 +02:00
< / p > < / li >
< li > < p >
< span > < strong class = "command" > cvs commit pkgsrc/doc/guide/files< / strong > < / span >
< / p > < / li >
< li > < p >
< span > < strong class = "command" > cvs commit -m re-generate pkgsrc/doc/pkgsrc.{html,txt}< / strong > < / span >
< / p > < / li >
< li > < p >
Until the webserver on www.NetBSD.org is really updated
automatically to pick up changes to the pkgsrc guide
automatically, also run < span > < strong class = "command" > make install-htdocs
HTDOCSDIR=../../../htdocs< / strong > < / span > (or similar, adjust
< code class = "varname" > HTDOCSDIR< / code > !).
< / p > < / li >
< li > < p >
< span > < strong class = "command" > cvs commit htdocs/Documentation/pkgsrc< / strong > < / span >
< / p > < / li >
< / ul > < / div >
< / div >
< / div >
< / div > < / body >
2004-10-21 16:44:39 +02:00
< / html >
