Annotation of htdocs/docs/pkgsrc/pkgsrc.txt, revision 1.6
1.1 dsieger 1: The pkgsrc guide
2:
3: Documentation on the NetBSD packages system
4:
5: Alistair Crooks
6:
7: <agc@NetBSD.org>
8:
9: Hubert Feyrer
10:
11: <hubertf@NetBSD.org>
12:
13: The pkgsrc Developers
14:
1.4 rillig 15: Copyright 1994-2007 The NetBSD Foundation, Inc
1.1 dsieger 16:
1.6 ! rillig 17: $NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $
1.1 dsieger 18:
19: Abstract
20:
21: pkgsrc is a centralized package management system for Unix-like operating
22: systems. This guide provides information for users and developers of pkgsrc. It
23: covers installation of binary and source packages, creation of binary and
24: source packages and a high-level overview about the infrastructure.
25:
26: -------------------------------------------------------------------------------
27:
28: Table of Contents
29:
30: 1. What is pkgsrc?
31:
32: 1.1. Introduction
33:
34: 1.1.1. Why pkgsrc?
35: 1.1.2. Supported platforms
36:
37: 1.2. Overview
38: 1.3. Terminology
39:
40: 1.3.1. Roles involved in pkgsrc
41:
42: 1.4. Typography
43:
44: I. The pkgsrc user's guide
45:
46: 2. Where to get pkgsrc and how to keep it up-to-date
47:
48: 2.1. Getting pkgsrc for the first time
49:
50: 2.1.1. As tar file
51: 2.1.2. Via SUP
52: 2.1.3. Via anonymous CVS
53:
54: 2.2. Keeping pkgsrc up-to-date
55:
56: 2.2.1. Via tar files
57: 2.2.2. Via CVS
58:
59: 3. Using pkgsrc on systems other than NetBSD
60:
61: 3.1. Binary distribution
62: 3.2. Bootstrapping pkgsrc
63: 3.3. Platform-specific notes
64:
65: 3.3.1. Darwin (Mac OS X)
66: 3.3.2. FreeBSD
67: 3.3.3. Interix
68: 3.3.4. IRIX
69: 3.3.5. Linux
70: 3.3.6. OpenBSD
71: 3.3.7. Solaris
72:
73: 4. Using pkgsrc
74:
75: 4.1. Using binary packages
76:
77: 4.1.1. Finding binary packages
78: 4.1.2. Installing binary packages
79: 4.1.3. Deinstalling packages
80: 4.1.4. Getting information about installed packages
81: 4.1.5. Checking for security vulnerabilities in installed packages
82: 4.1.6. Finding if newer versions of your installed packages are in
83: pkgsrc
84: 4.1.7. Other administrative functions
85: 4.1.8. A word of warning
86:
87: 4.2. Building packages from source
88:
89: 4.2.1. Requirements
90: 4.2.2. Fetching distfiles
91: 4.2.3. How to build and install
92:
93: 5. Configuring pkgsrc
94:
95: 5.1. General configuration
96: 5.2. Variables affecting the build process
1.4 rillig 97: 5.3. Variables affecting the installion process
98: 5.4. Selecting and configuring the compiler
1.1 dsieger 99:
1.4 rillig 100: 5.4.1. Selecting the compiler
101: 5.4.2. Additional flags to the compiler (CFLAGS)
102: 5.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 103:
1.4 rillig 104: 5.5. Developer/advanced settings
105: 5.6. Selecting Build Options
1.1 dsieger 106:
107: 6. Creating binary packages
108:
109: 6.1. Building a single binary package
110: 6.2. Settings for creation of binary packages
111:
1.6 ! rillig 112: 7. Creating binary packages for everything in pkgsrc (bulk builds)
! 113:
! 114: 7.1. Think first, build later
! 115: 7.2. Requirements of a bulk build
! 116: 7.3. Running an old-style bulk build
! 117:
! 118: 7.3.1. Configuration
! 119: 7.3.2. Other environmental considerations
! 120: 7.3.3. Operation
! 121: 7.3.4. What it does
! 122: 7.3.5. Disk space requirements
! 123: 7.3.6. Setting up a sandbox for chrooted builds
! 124: 7.3.7. Building a partial set of packages
! 125: 7.3.8. Uploading results of a bulk build
! 126:
! 127: 7.4. Running a pbulk-style bulk build
! 128:
! 129: 7.4.1. Configuration
! 130:
! 131: 7.5. Creating a multiple CD-ROM packages collection
! 132:
! 133: 7.5.1. Example of cdpack
! 134:
! 135: 8. Directory layout of the installed files
! 136:
! 137: 8.1. File system layout in ${LOCALBASE}
! 138: 8.2. File system layout in ${VARBASE}
! 139:
! 140: 9. Frequently Asked Questions
! 141:
! 142: 9.1. Are there any mailing lists for pkg-related discussion?
! 143: 9.2. Where's the pkgviews documentation?
! 144: 9.3. Utilities for package management (pkgtools)
! 145: 9.4. How to use pkgsrc as non-root
! 146: 9.5. How to resume transfers when fetching distfiles?
! 147: 9.6. How can I install/use modular X.org from pkgsrc?
! 148: 9.7. How to fetch files from behind a firewall
! 149: 9.8. How do I tell make fetch to do passive FTP?
! 150: 9.9. How to fetch all distfiles at once
! 151: 9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc"
1.1 dsieger 152: mean?
1.6 ! rillig 153: 9.11. What does "Could not find bsd.own.mk" mean?
! 154: 9.12. Using 'sudo' with pkgsrc
! 155: 9.13. How do I change the location of configuration files?
! 156: 9.14. Automated security checks
! 157: 9.15. Why do some packages ignore my CFLAGS?
! 158: 9.16. A package does not build. What shall I do?
! 159: 9.17. What does "Makefile appears to contain unresolved cvs/rcs/???
1.1 dsieger 160: merge conflicts" mean?
161:
162: II. The pkgsrc developer's guide
163:
1.6 ! rillig 164: 10. Creating a new pkgsrc package from scratch
1.1 dsieger 165:
1.6 ! rillig 166: 10.1. Common types of packages
1.1 dsieger 167:
1.6 ! rillig 168: 10.1.1. Perl modules
! 169: 10.1.2. KDE applications
1.1 dsieger 170:
1.6 ! rillig 171: 10.2. Examples
1.1 dsieger 172:
1.6 ! rillig 173: 10.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 174:
1.6 ! rillig 175: 11. Package components - files, directories and contents
1.1 dsieger 176:
1.6 ! rillig 177: 11.1. Makefile
! 178: 11.2. distinfo
! 179: 11.3. patches/*
1.1 dsieger 180:
1.6 ! rillig 181: 11.3.1. Structure of a single patch file
! 182: 11.3.2. Creating patch files
! 183: 11.3.3. Sources where the patch files come from
! 184: 11.3.4. Patching guidelines
! 185: 11.3.5. Feedback to the author
1.1 dsieger 186:
1.6 ! rillig 187: 11.4. Other mandatory files
! 188: 11.5. Optional files
1.1 dsieger 189:
1.6 ! rillig 190: 11.5.1. Files affecting the binary package
! 191: 11.5.2. Files affecting the build process
! 192: 11.5.3. Files affecting nothing at all
1.1 dsieger 193:
1.6 ! rillig 194: 11.6. work*
! 195: 11.7. files/*
1.1 dsieger 196:
1.6 ! rillig 197: 12. Programming in Makefiles
1.1 dsieger 198:
1.6 ! rillig 199: 12.1. Caveats
! 200: 12.2. Makefile variables
1.1 dsieger 201:
1.6 ! rillig 202: 12.2.1. Naming conventions
1.1 dsieger 203:
1.6 ! rillig 204: 12.3. Code snippets
1.1 dsieger 205:
1.6 ! rillig 206: 12.3.1. Adding things to a list
! 207: 12.3.2. Converting an internal list into an external list
! 208: 12.3.3. Passing variables to a shell command
! 209: 12.3.4. Quoting guideline
! 210: 12.3.5. Workaround for a bug in BSD Make
1.1 dsieger 211:
1.6 ! rillig 212: 13. PLIST issues
1.1 dsieger 213:
1.6 ! rillig 214: 13.1. RCS ID
! 215: 13.2. Semi-automatic PLIST generation
! 216: 13.3. Tweaking output of make print-PLIST
! 217: 13.4. Variable substitution in PLIST
! 218: 13.5. Man page compression
! 219: 13.6. Changing PLIST source with PLIST_SRC
! 220: 13.7. Platform-specific and differing PLISTs
! 221: 13.8. Sharing directories between packages
1.1 dsieger 222:
1.6 ! rillig 223: 14. Buildlink methodology
1.1 dsieger 224:
1.6 ! rillig 225: 14.1. Converting packages to use buildlink3
! 226: 14.2. Writing buildlink3.mk files
1.1 dsieger 227:
1.6 ! rillig 228: 14.2.1. Anatomy of a buildlink3.mk file
! 229: 14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files
1.1 dsieger 230:
1.6 ! rillig 231: 14.3. Writing builtin.mk files
1.1 dsieger 232:
1.6 ! rillig 233: 14.3.1. Anatomy of a builtin.mk file
! 234: 14.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 235:
1.6 ! rillig 236: 15. The pkginstall framework
1.1 dsieger 237:
1.6 ! rillig 238: 15.1. Files and directories outside the installation prefix
1.1 dsieger 239:
1.6 ! rillig 240: 15.1.1. Directory manipulation
! 241: 15.1.2. File manipulation
1.1 dsieger 242:
1.6 ! rillig 243: 15.2. Configuration files
1.1 dsieger 244:
1.6 ! rillig 245: 15.2.1. How PKG_SYSCONFDIR is set
! 246: 15.2.2. Telling the software where configuration files are
! 247: 15.2.3. Patching installations
! 248: 15.2.4. Disabling handling of configuration files
1.1 dsieger 249:
1.6 ! rillig 250: 15.3. System startup scripts
1.1 dsieger 251:
1.6 ! rillig 252: 15.3.1. Disabling handling of system startup scripts
1.1 dsieger 253:
1.6 ! rillig 254: 15.4. System users and groups
! 255: 15.5. System shells
1.1 dsieger 256:
1.6 ! rillig 257: 15.5.1. Disabling shell registration
1.1 dsieger 258:
1.6 ! rillig 259: 15.6. Fonts
1.1 dsieger 260:
1.6 ! rillig 261: 15.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 262:
1.6 ! rillig 263: 16. Options handling
1.1 dsieger 264:
1.6 ! rillig 265: 16.1. Global default options
! 266: 16.2. Converting packages to use bsd.options.mk
! 267: 16.3. Option Names
1.1 dsieger 268:
1.6 ! rillig 269: 17. The build process
1.1 dsieger 270:
1.6 ! rillig 271: 17.1. Introduction
! 272: 17.2. Program location
! 273: 17.3. Directories used during the build process
! 274: 17.4. Running a phase
! 275: 17.5. The fetch phase
1.1 dsieger 276:
1.6 ! rillig 277: 17.5.1. What to fetch and where to get it from
! 278: 17.5.2. How are the files fetched?
1.1 dsieger 279:
1.6 ! rillig 280: 17.6. The checksum phase
! 281: 17.7. The extract phase
! 282: 17.8. The patch phase
! 283: 17.9. The tools phase
! 284: 17.10. The wrapper phase
! 285: 17.11. The configure phase
! 286: 17.12. The build phase
! 287: 17.13. The test phase
! 288: 17.14. The install phase
! 289: 17.15. The package phase
! 290: 17.16. Cleaning up
! 291: 17.17. Other helpful targets
1.1 dsieger 292:
1.6 ! rillig 293: 18. Tools needed for building or running
1.1 dsieger 294:
1.6 ! rillig 295: 18.1. Tools for pkgsrc builds
! 296: 18.2. Tools needed by packages
! 297: 18.3. Tools provided by platforms
! 298: 18.4. Questions regarding the tools
1.1 dsieger 299:
1.6 ! rillig 300: 19. Making your package work
1.1 dsieger 301:
1.6 ! rillig 302: 19.1. General operation
1.1 dsieger 303:
1.6 ! rillig 304: 19.1.1. Portability of packages
! 305: 19.1.2. How to pull in user-settable variables from mk.conf
! 306: 19.1.3. User interaction
! 307: 19.1.4. Handling licenses
! 308: 19.1.5. Restricted packages
! 309: 19.1.6. Handling dependencies
! 310: 19.1.7. Handling conflicts with other packages
! 311: 19.1.8. Packages that cannot or should not be built
! 312: 19.1.9. Packages which should not be deleted, once installed
! 313: 19.1.10. Handling packages with security problems
! 314: 19.1.11. How to handle incrementing versions when fixing an
1.1 dsieger 315: existing package
1.6 ! rillig 316: 19.1.12. Substituting variable text in the package files (the SUBST
1.1 dsieger 317: framework)
318:
1.6 ! rillig 319: 19.2. Fixing problems in the fetch phase
1.1 dsieger 320:
1.6 ! rillig 321: 19.2.1. Packages whose distfiles aren't available for plain
1.1 dsieger 322: downloading
1.6 ! rillig 323: 19.2.2. How to handle modified distfiles with the 'old' name
1.1 dsieger 324:
1.6 ! rillig 325: 19.3. Fixing problems in the configure phase
1.1 dsieger 326:
1.6 ! rillig 327: 19.3.1. Shared libraries - libtool
! 328: 19.3.2. Using libtool on GNU packages that already support libtool
! 329: 19.3.3. GNU Autoconf/Automake
! 330:
! 331: 19.4. Programming languages
! 332:
! 333: 19.4.1. C, C++, and Fortran
! 334: 19.4.2. Java
! 335: 19.4.3. Packages containing perl scripts
! 336: 19.4.4. Other programming languages
! 337:
! 338: 19.5. Fixing problems in the build phase
! 339:
! 340: 19.5.1. Compiling C and C++ code conditionally
! 341: 19.5.2. How to handle compiler bugs
! 342: 19.5.3. Undefined reference to "..."
! 343: 19.5.4. Running out of memory
! 344:
! 345: 19.6. Fixing problems in the install phase
! 346:
! 347: 19.6.1. Creating needed directories
! 348: 19.6.2. Where to install documentation
! 349: 19.6.3. Installing highscore files
! 350: 19.6.4. Adding DESTDIR support to packages
! 351: 19.6.5. Packages with hardcoded paths to other interpreters
! 352: 19.6.6. Packages installing perl modules
! 353: 19.6.7. Packages installing info files
! 354: 19.6.8. Packages installing man pages
! 355: 19.6.9. Packages installing GConf2 data files
! 356: 19.6.10. Packages installing scrollkeeper data files
! 357: 19.6.11. Packages installing X11 fonts
! 358: 19.6.12. Packages installing GTK2 modules
! 359: 19.6.13. Packages installing SGML or XML data
! 360: 19.6.14. Packages installing extensions to the MIME database
! 361: 19.6.15. Packages using intltool
! 362: 19.6.16. Packages installing startup scripts
! 363: 19.6.17. Packages installing TeX modules
! 364: 19.6.18. Packages supporting running binaries in emulation
! 365: 19.6.19. Packages installing hicolor theme icons
! 366: 19.6.20. Packages installing desktop files
! 367:
! 368: 19.7. Marking packages as having problems
! 369:
! 370: 20. Debugging
! 371: 21. Submitting and Committing
! 372:
! 373: 21.1. Submitting binary packages
! 374: 21.2. Submitting source packages (for non-NetBSD-developers)
! 375: 21.3. General notes when adding, updating, or removing packages
! 376: 21.4. Committing: Importing a package into CVS
! 377: 21.5. Updating a package to a newer version
! 378: 21.6. Moving a package in pkgsrc
! 379:
! 380: 22. Frequently Asked Questions
! 381: 23. GNOME packaging and porting
! 382:
! 383: 23.1. Meta packages
! 384: 23.2. Packaging a GNOME application
! 385: 23.3. Updating GNOME to a newer version
! 386: 23.4. Patching guidelines
1.1 dsieger 387:
388: III. The pkgsrc infrastructure internals
389:
1.6 ! rillig 390: 24. Design of the pkgsrc infrastructure
1.1 dsieger 391:
1.6 ! rillig 392: 24.1. The meaning of variable definitions
! 393: 24.2. Avoiding problems before they arise
! 394: 24.3. Variable evaluation
1.1 dsieger 395:
1.6 ! rillig 396: 24.3.1. At load time
! 397: 24.3.2. At runtime
1.1 dsieger 398:
1.6 ! rillig 399: 24.4. How can variables be specified?
! 400: 24.5. Designing interfaces for Makefile fragments
1.1 dsieger 401:
1.6 ! rillig 402: 24.5.1. Procedures with parameters
! 403: 24.5.2. Actions taken on behalf of parameters
1.1 dsieger 404:
1.6 ! rillig 405: 24.6. The order in which files are loaded
1.1 dsieger 406:
1.6 ! rillig 407: 24.6.1. The order in bsd.prefs.mk
! 408: 24.6.2. The order in bsd.pkg.mk
1.1 dsieger 409:
1.6 ! rillig 410: 25. Regression tests
1.1 dsieger 411:
1.6 ! rillig 412: 25.1. The regression tests framework
! 413: 25.2. Running the regression tests
! 414: 25.3. Adding a new regression test
1.1 dsieger 415:
1.6 ! rillig 416: 25.3.1. Overridable functions
! 417: 25.3.2. Helper functions
1.1 dsieger 418:
1.6 ! rillig 419: 26. Porting pkgsrc
1.1 dsieger 420:
1.6 ! rillig 421: 26.1. Porting pkgsrc to a new operating system
! 422: 26.2. Adding support for a new compiler
1.1 dsieger 423:
424: A. A simple example package: bison
425:
426: A.1. files
427:
428: A.1.1. Makefile
429: A.1.2. DESCR
430: A.1.3. PLIST
431: A.1.4. Checking a package with pkglint
432:
433: A.2. Steps for building, installing, packaging
434:
435: B. Build logs
436:
437: B.1. Building figlet
438: B.2. Packaging figlet
439:
440: C. Directory layout of the pkgsrc FTP server
441:
442: C.1. bootstrap-pkgsrc: Bootstrap kits
443: C.2. distfiles: The distributed source files
444: C.3. iso: Currently empty
445: C.4. misc: Miscellaneous things
1.3 rillig 446: C.5. packages: Binary packages
1.1 dsieger 447: C.6. current, pkgsrc-200xQy: source packages
448:
449: D. Editing guidelines for the pkgsrc guide
450:
451: D.1. Make targets
452: D.2. Procedure
453:
454: List of Tables
455:
456: 1.1. Platforms supported by pkgsrc
457: 3.1. Binary kits and available packages
1.6 ! rillig 458: 11.1. Patching examples
! 459: 23.1. PLIST handling for GNOME packages
1.1 dsieger 460:
461: Chapter 1. What is pkgsrc?
462:
463: Table of Contents
464:
465: 1.1. Introduction
466:
467: 1.1.1. Why pkgsrc?
468: 1.1.2. Supported platforms
469:
470: 1.2. Overview
471: 1.3. Terminology
472:
473: 1.3.1. Roles involved in pkgsrc
474:
475: 1.4. Typography
476:
477: 1.1. Introduction
478:
479: There is a lot of software freely available for Unix-based systems, which is
480: usually available in form of the source code. Before such software can be used,
481: it needs to be configured to the local system, compiled and installed, and this
482: is exactly what The NetBSD Packages Collection (pkgsrc) does. pkgsrc also has
483: some basic commands to handle binary packages, so that not every user has to
484: build the packages for himself, which is a time-costly task.
485:
486: pkgsrc currently contains several thousand packages, including:
487:
488: * www/apache - The Apache web server
489:
490: * www/firefox - The Firefox web browser
491:
492: * meta-pkgs/gnome - The GNOME Desktop Environment
493:
494: * meta-pkgs/kde3 - The K Desktop Environment
495:
496: ...just to name a few.
497:
498: pkgsrc has built-in support for handling varying dependencies, such as pthreads
499: and X11, and extended features such as IPv6 support on a range of platforms.
500:
501: 1.1.1. Why pkgsrc?
502:
503: pkgsrc provides the following key features:
504:
505: * Easy building of software from source as well as the creation and
506: installation of binary packages. The source and latest patches are
507: retrieved from a master or mirror download site, checksum verified, then
508: built on your system. Support for binary-only distributions is available
509: for both native platforms and NetBSD emulated platforms.
510:
511: * All packages are installed in a consistent directory tree, including
512: binaries, libraries, man pages and other documentation.
513:
514: * Package dependencies, including when performing package updates, are
515: handled automatically. The configuration files of various packages are
516: handled automatically during updates, so local changes are preserved.
517:
518: * Like NetBSD, pkgsrc is designed with portability in mind and consists of
519: highly portable code. This allows the greatest speed of development when
520: porting to new a platform. This portability also ensures that pkgsrc is
521: consistent across all platforms.
522:
523: * The installation prefix, acceptable software licenses, international
524: encryption requirements and build-time options for a large number of
525: packages are all set in a simple, central configuration file.
526:
527: * The entire source (not including the distribution files) is freely
528: available under a BSD license, so you may extend and adapt pkgsrc to your
529: needs. Support for local packages and patches is available right out of the
530: box, so you can configure it specifically for your environment.
531:
532: The following principles are basic to pkgsrc:
533:
534: * "It should only work if it's right." ? That means, if a package contains
535: bugs, it's better to find them and to complain about them rather than to
536: just install the package and hope that it works. There are numerous checks
537: in pkgsrc that try to find such bugs: Static analysis tools (pkgtools/
538: pkglint), build-time checks (portability of shell scripts), and
539: post-installation checks (installed files, references to shared libraries,
540: script interpreters).
541:
542: * "If it works, it should work everywhere" ? Like NetBSD has been ported to
543: many hardware architectures, pkgsrc has been ported to many operating
544: systems. Care is taken that packages behave the same on all platforms.
545:
546: 1.1.2. Supported platforms
547:
548: pkgsrc consists of both a source distribution and a binary distribution for
549: these operating systems. After retrieving the required source or binaries, you
550: can be up and running with pkgsrc in just minutes!
551:
552: pkgsrc was derived from FreeBSD's ports system, and initially developed for
553: NetBSD only. Since then, pkgsrc has grown a lot, and now supports the following
554: platforms:
555:
556: Table 1.1. Platforms supported by pkgsrc
557:
558: +----------------------------------------------------------------+
559: | Platform |Date Support Added|
560: |---------------------------------------------+------------------|
561: |NetBSD | Aug 1997 |
562: |---------------------------------------------+------------------|
563: |Solaris | Mar 1999 |
564: |---------------------------------------------+------------------|
565: |Linux | Jun 1999 |
566: |---------------------------------------------+------------------|
567: |Darwin (Mac OS X) | Oct 2001 |
568: |---------------------------------------------+------------------|
569: |FreeBSD | Nov 2002 |
570: |---------------------------------------------+------------------|
571: |OpenBSD | Nov 2002 |
572: |---------------------------------------------+------------------|
573: |IRIX | Dec 2002 |
574: |---------------------------------------------+------------------|
575: |BSD/OS | Dec 2003 |
576: |---------------------------------------------+------------------|
577: |AIX | Dec 2003 |
578: |---------------------------------------------+------------------|
579: |Interix (Microsoft Windows Services for Unix)| Mar 2004 |
580: |---------------------------------------------+------------------|
581: |DragonFlyBSD | Oct 2004 |
582: |---------------------------------------------+------------------|
583: |OSF/1 | Nov 2004 |
584: |---------------------------------------------+------------------|
585: |HP-UX | Apr 2007 |
586: +----------------------------------------------------------------+
587:
588:
589: 1.2. Overview
590:
591: This document is divided into three parts. The first, The pkgsrc user's guide,
592: describes how one can use one of the packages in the Package Collection, either
593: by installing a precompiled binary package, or by building one's own copy using
594: the NetBSD package system. The second part, The pkgsrc developer's guide,
595: explains how to prepare a package so it can be easily built by other NetBSD
596: users without knowing about the package's building details. The third part, The
597: pkgsrc infrastructure internals is intended for those who want to understand
598: how pkgsrc is implemented.
599:
600: This document is available in various formats: HTML, PDF, PS, TXT.
601:
602: 1.3. Terminology
603:
604: There has been a lot of talk about "ports", "packages", etc. so far. Here is a
605: description of all the terminology used within this document.
606:
607: Package
608:
609: A set of files and building instructions that describe what's necessary to
610: build a certain piece of software using pkgsrc. Packages are traditionally
611: stored under /usr/pkgsrc.
612:
613: The NetBSD package system
614:
615: This is the former name of "pkgsrc". It is part of the NetBSD operating
616: system and can be bootstrapped to run on non-NetBSD operating systems as
617: well. It handles building (compiling), installing, and removing of
618: packages.
619:
620: Distfile
621:
622: This term describes the file or files that are provided by the author of
623: the piece of software to distribute his work. All the changes necessary to
624: build on NetBSD are reflected in the corresponding package. Usually the
625: distfile is in the form of a compressed tar-archive, but other types are
626: possible, too. Distfiles are usually stored below /usr/pkgsrc/distfiles.
627:
628: Port
629:
630: This is the term used by FreeBSD and OpenBSD people for what we call a
631: package. In NetBSD terminology, "port" refers to a different architecture.
632:
633: Precompiled/binary package
634:
635: A set of binaries built with pkgsrc from a distfile and stuffed together in
636: a single .tgz file so it can be installed on machines of the same machine
637: architecture without the need to recompile. Packages are usually generated
638: in /usr/pkgsrc/packages; there is also an archive on ftp.NetBSD.org.
639:
640: Sometimes, this is referred to by the term "package" too, especially in the
641: context of precompiled packages.
642:
643: Program
644:
645: The piece of software to be installed which will be constructed from all
646: the files in the distfile by the actions defined in the corresponding
647: package.
648:
649: 1.3.1. Roles involved in pkgsrc
650:
651: pkgsrc users
652:
653: The pkgsrc users are people who use the packages provided by pkgsrc.
654: Typically they are system administrators. The people using the software
655: that is inside the packages (maybe called "end users") are not covered by
656: the pkgsrc guide.
657:
658: There are two kinds of pkgsrc users: Some only want to install pre-built
659: binary packages. Others build the pkgsrc packages from source, either for
660: installing them directly or for building binary packages themselves. For
661: pkgsrc users Part I, "The pkgsrc user's guide" should provide all necessary
662: documentation.
663:
664: package maintainers
665:
666: A package maintainer creates packages as described in Part II, "The pkgsrc
667: developer's guide".
668:
669: infrastructure developers
670:
671: These people are involved in all those files that live in the mk/ directory
672: and below. Only these people should need to read through Part III, "The
673: pkgsrc infrastructure internals", though others might be curious, too.
674:
675: 1.4. Typography
676:
677: When giving examples for commands, shell prompts are used to show if the
678: command should/can be issued as root, or if "normal" user privileges are
679: sufficient. We use a # for root's shell prompt, and a % for users' shell
680: prompt, assuming they use the C-shell or tcsh.
681:
682: Part I. The pkgsrc user's guide
683:
684: Table of Contents
685:
686: 2. Where to get pkgsrc and how to keep it up-to-date
687:
688: 2.1. Getting pkgsrc for the first time
689:
690: 2.1.1. As tar file
691: 2.1.2. Via SUP
692: 2.1.3. Via anonymous CVS
693:
694: 2.2. Keeping pkgsrc up-to-date
695:
696: 2.2.1. Via tar files
697: 2.2.2. Via CVS
698:
699: 3. Using pkgsrc on systems other than NetBSD
700:
701: 3.1. Binary distribution
702: 3.2. Bootstrapping pkgsrc
703: 3.3. Platform-specific notes
704:
705: 3.3.1. Darwin (Mac OS X)
706: 3.3.2. FreeBSD
707: 3.3.3. Interix
708: 3.3.4. IRIX
709: 3.3.5. Linux
710: 3.3.6. OpenBSD
711: 3.3.7. Solaris
712:
713: 4. Using pkgsrc
714:
715: 4.1. Using binary packages
716:
717: 4.1.1. Finding binary packages
718: 4.1.2. Installing binary packages
719: 4.1.3. Deinstalling packages
720: 4.1.4. Getting information about installed packages
721: 4.1.5. Checking for security vulnerabilities in installed packages
722: 4.1.6. Finding if newer versions of your installed packages are in
723: pkgsrc
724: 4.1.7. Other administrative functions
725: 4.1.8. A word of warning
726:
727: 4.2. Building packages from source
728:
729: 4.2.1. Requirements
730: 4.2.2. Fetching distfiles
731: 4.2.3. How to build and install
732:
733: 5. Configuring pkgsrc
734:
735: 5.1. General configuration
736: 5.2. Variables affecting the build process
1.4 rillig 737: 5.3. Variables affecting the installion process
738: 5.4. Selecting and configuring the compiler
1.1 dsieger 739:
1.4 rillig 740: 5.4.1. Selecting the compiler
741: 5.4.2. Additional flags to the compiler (CFLAGS)
742: 5.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 743:
1.4 rillig 744: 5.5. Developer/advanced settings
745: 5.6. Selecting Build Options
1.1 dsieger 746:
747: 6. Creating binary packages
748:
749: 6.1. Building a single binary package
750: 6.2. Settings for creation of binary packages
751:
1.6 ! rillig 752: 7. Creating binary packages for everything in pkgsrc (bulk builds)
! 753:
! 754: 7.1. Think first, build later
! 755: 7.2. Requirements of a bulk build
! 756: 7.3. Running an old-style bulk build
! 757:
! 758: 7.3.1. Configuration
! 759: 7.3.2. Other environmental considerations
! 760: 7.3.3. Operation
! 761: 7.3.4. What it does
! 762: 7.3.5. Disk space requirements
! 763: 7.3.6. Setting up a sandbox for chrooted builds
! 764: 7.3.7. Building a partial set of packages
! 765: 7.3.8. Uploading results of a bulk build
! 766:
! 767: 7.4. Running a pbulk-style bulk build
! 768:
! 769: 7.4.1. Configuration
! 770:
! 771: 7.5. Creating a multiple CD-ROM packages collection
! 772:
! 773: 7.5.1. Example of cdpack
! 774:
! 775: 8. Directory layout of the installed files
! 776:
! 777: 8.1. File system layout in ${LOCALBASE}
! 778: 8.2. File system layout in ${VARBASE}
! 779:
! 780: 9. Frequently Asked Questions
! 781:
! 782: 9.1. Are there any mailing lists for pkg-related discussion?
! 783: 9.2. Where's the pkgviews documentation?
! 784: 9.3. Utilities for package management (pkgtools)
! 785: 9.4. How to use pkgsrc as non-root
! 786: 9.5. How to resume transfers when fetching distfiles?
! 787: 9.6. How can I install/use modular X.org from pkgsrc?
! 788: 9.7. How to fetch files from behind a firewall
! 789: 9.8. How do I tell make fetch to do passive FTP?
! 790: 9.9. How to fetch all distfiles at once
! 791: 9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
! 792: 9.11. What does "Could not find bsd.own.mk" mean?
! 793: 9.12. Using 'sudo' with pkgsrc
! 794: 9.13. How do I change the location of configuration files?
! 795: 9.14. Automated security checks
! 796: 9.15. Why do some packages ignore my CFLAGS?
! 797: 9.16. A package does not build. What shall I do?
! 798: 9.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.1 dsieger 799: conflicts" mean?
800:
801: Chapter 2. Where to get pkgsrc and how to keep it up-to-date
802:
803: Table of Contents
804:
805: 2.1. Getting pkgsrc for the first time
806:
807: 2.1.1. As tar file
808: 2.1.2. Via SUP
809: 2.1.3. Via anonymous CVS
810:
811: 2.2. Keeping pkgsrc up-to-date
812:
813: 2.2.1. Via tar files
814: 2.2.2. Via CVS
815:
816: Before you download and extract the files, you need to decide where you want to
817: extract them. When using pkgsrc as root user, pkgsrc is usually installed in /
818: usr/pkgsrc. You are though free to install the sources and binary packages
819: wherever you want in your filesystem, provided that the pathname does not
820: contain white-space or other characters that are interpreted specially by the
821: shell and some other programs. A safe bet is to use only letters, digits,
822: underscores and dashes.
823:
824: 2.1. Getting pkgsrc for the first time
825:
826: Before you download any pkgsrc files, you should decide whether you want the
827: current branch or the stable branch. The latter is forked on a quarterly basis
828: from the current branch and only gets modified for security updates. The names
829: of the stable branches are built from the year and the quarter, for example
830: 2007Q1.
831:
832: The second step is to decide how you want to download pkgsrc. You can get it as
833: a tar file, via SUP, or via CVS. All three ways are described here.
834:
835: 2.1.1. As tar file
836:
837: The primary download location for all pkgsrc files is ftp://ftp.NetBSD.org/pub/
838: pkgsrc/. There are a number of subdirectories for different purposes, which are
839: described in detail in Appendix C, Directory layout of the pkgsrc FTP server.
840:
841: The tar file for the current branch is in the directory current and is called
842: pkgsrc.tar.gz. It is autogenerated daily.
843:
844: The tar file for the stable branch 2007Q1 is in the directory pkgsrc-2007Q1 and
845: is also called pkgsrc-2007Q1.tar.gz.
846:
847: After downloading the tar file, change to the directory where you want to have
848: pkgsrc. This is usually /usr. Then, run gzcat pkgsrc.tar.gz | tar xf - to
849: extract the files.
850:
851: 2.1.2. Via SUP
852:
853: As an alternative to the tar file, you can get pkgsrc via the Software Update
854: Protocol, SUP. To do so, make sure your supfile has a line
855:
856: release=pkgsrc
857:
858: in it, see the examples in /usr/share/examples/supfiles, and that the /usr/
859: pkgsrc directory exists. Then, simply run sup -v /path/to/your/supfile.
860:
861: 2.1.3. Via anonymous CVS
862:
863: To get pkgsrc via CVS, make sure you have cvs(1) installed. To do an initial
864: (full) checkout of pkgsrc, you first have to set some environment variables.
865: For the C-Shell, type:
866:
867: % setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot
868: % setenv CVS_RSH ssh
869:
870: Or, the same for the bourne shell:
871:
872: $ CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"
873: $ CVS_RSH="ssh"
874: $ export CVSROOT CVS_RSH
875:
1.2 rillig 876: By default, cvs doesn't do things like most people would expect it to do, and
877: this is unlikely to change. But there is a way to convince cvs, by creating a
878: file called .cvsrc in your home directory and saving the following lines to it.
879: This file will save you lots of headache and some bug reports, so we strongly
880: recommend it. You can find an explanation of this file in the CVS
881: documentation.
882:
883: # recommended CVS configuration file from the pkgsrc guide
884: checkout -P
1.4 rillig 885: update -dP
1.2 rillig 886: release -d
1.4 rillig 887: diff -upN
1.2 rillig 888: cvs -q -z3
889: rdiff -u
890:
1.1 dsieger 891: Then, you change to the directory where you want to have your copy of pkgsrc.
892: In most cases this is /usr. In that directory you run the checkout command,
893: which is cvs -q checkout -P pkgsrc for the current branch and cvs -q checkout
894: -rpkgsrc-2007Q1 -P pkgsrc for the stable branch. This command will create a
895: directory called pkgsrc with all the pkgsrc files in it.
896:
897: 2.2. Keeping pkgsrc up-to-date
898:
899: The preferred way to keep pkgsrc up-to-date is via CVS (which also works if you
900: have first installed it via a tar file). It saves bandwidth and hard disk
901: activity, compared to downloading the tar file again.
902:
903: 2.2.1. Via tar files
904:
905: Warning
906:
907: When updating from a tar file, you first need to completely remove the old
908: pkgsrc directory. Otherwise those files that have been removed from pkgsrc in
909: the mean time will not be removed on your local disk, resulting in
910: inconsistencies. When removing the old files, any changes that you have done to
911: the pkgsrc files will be lost after updating. Therefore updating via CVS is
912: strongly recommended.
913:
914: Note that by default the distfiles and the binary packages are saved in the
915: pkgsrc tree, so don't forget to rescue them before updating. You can also
916: configure pkgsrc to use other than the default directories by setting the
917: DISTDIR and PACKAGES variables. See Chapter 5, Configuring pkgsrc for the
918: details.
919:
920: To update pkgsrc from a tar file, download the tar file as explained above.
921: Then, make sure that you have not made any changes to the files in the pkgsrc
922: directory. Remove the pkgsrc directory and extract the new tar file. Done.
923:
924: 2.2.2. Via CVS
925:
926: To update pkgsrc via CVS, make sure the environment variable CVS_RSH is set as
927: above. Then, change to the pkgsrc directory and run cvs -q update -dP.
928:
929: 2.2.2.1. Switching between different pkgsrc branches
930:
931: When updating pkgsrc, the CVS program keeps track of the branch you selected.
932: But if you, for whatever reason, want to switch from the stable branch to the
933: current one, you can do it by adding the option "-A" after the "update"
934: keyword. To switch from the current branch back to the stable branch, add the
935: "-rpkgsrc-2007Q1" option.
936:
937: 2.2.2.2. What happens to my changes when updating?
938:
939: When you update pkgsrc, the CVS program will only touch those files that are
940: registered in the CVS repository. That means that any packages that you created
941: on your own will stay unmodified. If you change files that are managed by CVS,
942: later updates will try to merge your changes with those that have been done by
943: others. See the CVS manual, chapter "update" for details.
944:
945: Chapter 3. Using pkgsrc on systems other than NetBSD
946:
947: Table of Contents
948:
949: 3.1. Binary distribution
950: 3.2. Bootstrapping pkgsrc
951: 3.3. Platform-specific notes
952:
953: 3.3.1. Darwin (Mac OS X)
954: 3.3.2. FreeBSD
955: 3.3.3. Interix
956: 3.3.4. IRIX
957: 3.3.5. Linux
958: 3.3.6. OpenBSD
959: 3.3.7. Solaris
960:
961: 3.1. Binary distribution
962:
963: We provide a bootstrap kit in both source and binary form for other platforms
964: than NetBSD, consisting of the pkg administration tools and other tools
965: required to use pkgsrc and build packages.
966:
967: Note
968:
969: Older binary snapshots are available in the bootstrap-pkgsrc/archive directory
970: on ftp.NetBSD.org.
971:
972: Table 3.1. Binary kits and available packages
973:
974: +------------------------------------------------------------------------------+
975: | Platform |Latest snapshot|Binary kit|Binary packages|
976: |-----------------------------------+---------------+----------+---------------|
977: |Darwin 5.5/powerpc (Mac OS X |20021209 |binary kit| |
978: |10.1.5) | | | |
979: |-----------------------------------+---------------+----------+---------------|
980: |Darwin 6.6/powerpc (Mac OS X |20030623 |binary kit| |
981: |10.2.6) | | | |
982: |-----------------------------------+---------------+----------+---------------|
983: |Darwin 7.6/powerpc (Mac OS X |20041219 |binary kit|binary packages|
984: |10.3.6) | | | |
985: |-----------------------------------+---------------+----------+---------------|
986: |Darwin 7.8/powerpc (Mac OS X |20050320 |binary kit| |
987: |10.3.8) | | | |
988: |-----------------------------------+---------------+----------+---------------|
989: |Darwin 8.1/powerpc (Mac OS X |20050625 |binary kit|binary packages|
990: |10.4.1) | | | |
991: |-----------------------------------+---------------+----------+---------------|
992: |Debian GNU Linux/i386 |20031023 |binary kit| |
993: |-----------------------------------+---------------+----------+---------------|
994: |Fedora Core 2 Linux/i386 |20050618 |binary kit| |
995: |-----------------------------------+---------------+----------+---------------|
996: |Fedora Core 4 Linux/i386 |20060105 |binary kit| |
997: |-----------------------------------+---------------+----------+---------------|
998: |FreeBSD 3.5/i386 |20030411 |binary kit| |
999: |-----------------------------------+---------------+----------+---------------|
1000: |FreeBSD 4.7/i386 |20021211 |binary kit| |
1001: |-----------------------------------+---------------+----------+---------------|
1002: |FreeBSD 5.0/i386 |20030411 |binary kit| |
1003: |-----------------------------------+---------------+----------+---------------|
1004: |FreeBSD 5.1/i386 |20030630 |binary kit| |
1005: |-----------------------------------+---------------+----------+---------------|
1006: |FreeBSD 5.2.1/i386 |20040227 |binary kit| |
1007: |-----------------------------------+---------------+----------+---------------|
1008: |FreeBSD 5.3/i386 |20050119 |binary kit| |
1009: |-----------------------------------+---------------+----------+---------------|
1010: |HP-UX 11.11/hppa |20070421 |binary kit| |
1011: |-----------------------------------+---------------+----------+---------------|
1012: |Interix 3.5 |20061106 |binary kit| |
1013: |-----------------------------------+---------------+----------+---------------|
1014: |IRIX 6.5 n32-bit ABI |20040911 |binary kit|binary packages|
1015: |-----------------------------------+---------------+----------+---------------|
1016: |IRIX 6.5 64-bit ABI |20040912 |binary kit|binary packages|
1017: |-----------------------------------+---------------+----------+---------------|
1018: |OpenBSD 3.2/i386 |20030420 |binary kit| |
1019: |-----------------------------------+---------------+----------+---------------|
1020: |OpenBSD 3.3/i386 |20030503 |binary kit| |
1021: |-----------------------------------+---------------+----------+---------------|
1022: |OpenBSD 3.5/i386 |20040703 |binary kit| |
1023: |-----------------------------------+---------------+----------+---------------|
1024: |OSF1 5.1/alpha |20070420 |binary kit| |
1025: |-----------------------------------+---------------+----------+---------------|
1026: |Slackware Linux 8.1/i386 |20030417 |binary kit| |
1027: |-----------------------------------+---------------+----------+---------------|
1028: |Slackware Linux 9/i386 |20040703 |binary kit| |
1029: |-----------------------------------+---------------+----------+---------------|
1030: |Solaris 8/sparc |20050220 |binary kit| |
1031: |-----------------------------------+---------------+----------+---------------|
1032: |Solaris 8/i386 |20050220 |binary kit| |
1033: |-----------------------------------+---------------+----------+---------------|
1034: |Solaris 9/sparc |20060713 |binary kit| |
1035: |-----------------------------------+---------------+----------+---------------|
1036: |Solaris 9/i386 |20030411 |binary kit| |
1037: +------------------------------------------------------------------------------+
1038:
1039:
1040: Simply download the binary kit for your platform, and extract it into / e.g.
1041:
1042: # cd /
1043: # gzip -c -d /tmp/bootstrap-pkgsrc-SunOS-5.9-sparc-20031023.tar.gz \
1044: | tar -xpf -
1045:
1046: Of course, as with any binary distributions, you should verify the checksum
1047: against the SUM or CKSUM file and inspect the contents before extracting it.
1048:
1049: 3.2. Bootstrapping pkgsrc
1050:
1051: Installing the bootstrap kit from source should be as simple as:
1052:
1053: # env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc
1054: # cd pkgsrc/bootstrap
1055: # ./bootstrap
1056:
1057:
1058: See Chapter 2, Where to get pkgsrc and how to keep it up-to-date for other ways
1059: to get pkgsrc before bootstrapping. The given bootstrap command will use the
1060: defaults of /usr/pkg for the prefix where programs will be installed in, and /
1061: var/db/pkg for the package database directory where pkgsrc will do its internal
1062: bookkeeping. However, these can also be set using command-line arguments.
1063:
1064: Binary packages for the pkgsrc tools and an initial set of packages is
1065: available for supported platforms. An up-to-date list of these can be found on
1066: www.pkgsrc.org. Note that this only works for privileged builds that install
1067: into /usr/pkg.
1068:
1069: Note
1070:
1071: The bootstrap installs a bmake tool. Use this bmake when building via pkgsrc.
1072: For examples in this guide, use bmake instead of "make".
1073:
1074: 3.3. Platform-specific notes
1075:
1076: Here are some platform-specific notes you should be aware of.
1077:
1078: 3.3.1. Darwin (Mac OS X)
1079:
1080: Darwin 5.x and up are supported. There are two methods of using pkgsrc on Mac
1081: OS X, by using a disk image, or a UFS or HFSX partition.
1082:
1083: Before you start, you will need to download and install the Mac OS X Developer
1084: Tools from Apple's Developer Connection. See http://developer.apple.com/macosx/
1085: for details. Also, make sure you install X11 for Mac OS X and the X11 SDK from
1086: http://www.apple.com/macosx/x11/download/ if you intend to build packages that
1087: use the X11 Window System.
1088:
1089: If you already have a UFS or HFSX partition, or have a spare partition that you
1090: can format as UFS or HFSX, it is recommended to use that instead of the disk
1091: image. It'll be somewhat faster and will mount automatically at boot time,
1092: where you must manually mount a disk image.
1093:
1094: Note
1095:
1096: You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc
1097: currently requires the file system to be case-sensitive. You can, however, use
1098: a case-sensitive HFS+ (aka HFSX) file system as found in Darwin 7.0 and newer.
1099:
1100: 3.3.1.1. Using a disk image
1101:
1102: Create the disk image:
1103:
1104: # cd pkgsrc/bootstrap
1105: # ./darwindiskimage create ~/Documents/NetBSD 1024 # megabytes - season to taste
1106: # ./darwindiskimage mount ~/Documents/NetBSD
1107: # sudo chown `id -u`:`id -g` /Volumes/NetBSD
1108:
1109: Note
1110:
1111: darwindiskimage will mount the filesystem nosuid, which will cause problems for
1112: packages that depend on setgid. In the case of UFS, it will also mount the
1113: filesystem asynchronous, which is somewhat dangerous according to the mount(8)
1114: man page. In the case of HFSX, it will disable journalling.
1115:
1116: Allow suid:
1117:
1118: # sudo mount -u -o suid /Volumes/NetBSD
1119:
1.5 weinem 1120: Changing the build directory:
1121:
1122: After bootstrapping you need to change the default package build directory to
1123: somewhere outside the disk image so it doesn't get filled up in the process of
1124: building packages. Add something like that to mk.conf.
1125:
1126: WRKOBJDIR?= /tmp/pkgsrc # build here instead of in pkgsrc
1127:
1128:
1.1 dsieger 1129: 3.3.1.2. Using a UFS or HFSX partition
1130:
1131: By default, /usr will be on your root file system, normally HFS+. It is
1132: possible to use the default prefix of /usr/pkg by symlinking /usr/pkg to a
1133: directory on a UFS or HFSX file system. Obviously, another symlink is required
1134: if you want to place the package database directory outside the prefix. e.g.
1135:
1136: # ./bootstrap --pkgdbdir /usr/pkg/pkgdb
1137:
1138: If you created your partitions at the time of installing Mac OS X and formatted
1139: the target partition as UFS or HFSX, it should automatically mount on /Volumes/
1140: <volume name> when the machine boots. If you are (re)formatting a partition as
1141: UFS or HFSX, you need to ensure that the partition map correctly reflects
1142: "Apple_UFS" or "Apple_HFSX" and not "Apple_HFS".
1143:
1144: The problem is that none of the disk tools will let you touch a disk that is
1145: booted from. You can unmount the partition, but even if you newfs it, the
1146: partition type will be incorrect and the automounter won't mount it. It can be
1147: mounted manually, but it won't appear in Finder.
1148:
1149: You'll need to boot off of the OS X Installation (User) CD. When the
1150: Installation program starts, go up to the menu and select Disk Utility. Now,
1151: you will be able to select the partition you want to be UFS or HFSX, and Format
1152: it Apple UFS or HFSX. Quit the Disk Utility, quit the installer which will
1153: reboot your machine. The new UFS or HFSX file system will appear in Finder.
1154:
1155: Be aware that the permissions on the new file system will be writable by root
1156: only.
1157:
1158: This note is as of 10.2 (Jaguar) and applies to earlier versions. Hopefully
1159: Apple will fix Disk Utility in 10.3 (Panther).
1160:
1161: 3.3.2. FreeBSD
1162:
1163: FreeBSD 4.7 and 5.0 have been tested and are supported, other versions may
1164: work.
1165:
1166: Care should be taken so that the tools that this kit installs do not conflict
1167: with the FreeBSD userland tools. There are several steps:
1168:
1169: 1. FreeBSD stores its ports pkg database in /var/db/pkg. It is therefore
1170: recommended that you choose a different location (e.g. /usr/pkgdb) by using
1171: the --pkgdbdir option to the bootstrap script.
1172:
1173: 2. If you do not intend to use the FreeBSD ports tools, it's probably a good
1174: idea to move them out of the way to avoid confusion, e.g.
1175:
1176: # cd /usr/sbin
1177: # mv pkg_add pkg_add.orig
1178: # mv pkg_create pkg_create.orig
1179: # mv pkg_delete pkg_delete.orig
1180: # mv pkg_info pkg_info.orig
1181:
1182:
1.4 rillig 1183: 3. An example mk.conf file will be placed in /etc/mk.conf.example file when
1184: you use the bootstrap script.
1.1 dsieger 1185:
1186: 3.3.3. Interix
1187:
1188: Interix is a POSIX-compatible subsystem for the Windows NT kernel, providing a
1189: Unix-like environment with a tighter kernel integration than available with
1190: Cygwin. It is part of the Windows Services for Unix package, available for free
1191: for any licensed copy of Windows 2000, XP (not including XP Home), or 2003. SFU
1192: can be downloaded from http://www.microsoft.com/windows/sfu/.
1193:
1194: Services for Unix 3.5 has been tested. 3.0 or 3.1 may work, but are not
1195: officially supported. (The main difference in 3.0/3.1 is lack of pthreads, but
1196: other parts of libc may also be lacking.)
1197:
1198: Services for Unix Applications (aka SUA) is an integrated component of Windows
1199: Server 2003 R2 and Windows Vista. As of this writing, SUA's Interix 5.x
1200: subsystem has not yet been tested with pkgsrc.
1201:
1202: 3.3.3.1. When installing Interix/SFU
1203:
1204: At an absolute minimum, the following packages must be installed from the
1205: Windows Services for Unix 3.5 distribution in order to use pkgsrc:
1206:
1207: * Utilities -> Base Utilities
1208:
1209: * Interix GNU Components -> (all)
1210:
1211: * Remote Connectivity
1212:
1213: * Interix SDK
1214:
1215: When using pkgsrc on Interix, DO NOT install the Utilities subcomponent "UNIX
1216: Perl". That is Perl 5.6 without shared module support, installed to /usr/local,
1217: and will only cause confusion. Instead, install Perl 5.8 from pkgsrc (or from a
1218: binary package).
1219:
1220: The Remote Connectivity subcomponent "Windows Remote Shell Service" does not
1221: need to be installed, but Remote Connectivity itself should be installed in
1222: order to have a working inetd.
1223:
1224: During installation you may be asked whether to enable setuid behavior for
1225: Interix programs, and whether to make pathnames default to case-sensitive.
1226: Setuid should be enabled, and case-sensitivity MUST be enabled. (Without
1227: case-sensitivity, a large number of packages including perl will not build.)
1228:
1229: NOTE: Newer Windows service packs change the way binary execution works (via
1230: the Data Execution Prevention feature). In order to use pkgsrc and other
1231: gcc-compiled binaries reliably, a hotfix containing POSIX.EXE, PSXDLL.DLL,
1232: PSXRUN.EXE, and PSXSS.EXE (899522 or newer) must be installed. Hotfixes are
1233: available from Microsoft through a support contract; however, a NetBSD
1234: developer has made most Interix hotfixes available for personal use from http:/
1235: /www.duh.org/interix/hotfixes.php.
1236:
1237: In addition to the hotfix noted above, it may be necessary to disable Data
1238: Execution Prevention entirely to make Interix functional. This may happen only
1239: with certain types of CPUs; the cause is not fully understood at this time. If
1240: gcc or other applications still segfault repeatedly after installing one of the
1241: hotfixes note above, the following option can be added to the appropriate
1242: "boot.ini" line on the Windows boot drive: /NoExecute=AlwaysOff (WARNING, this
1243: will disable DEP completely, which may be a security risk if applications are
1244: often run as a user in the Administrators group!)
1245:
1246: 3.3.3.2. What to do if Interix/SFU is already installed
1247:
1248: If SFU is already installed and you wish to alter these settings to work with
1249: pkgsrc, note the following things.
1250:
1251: * To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft Windows
1252: Services for UNIX, then click Change. In the installer, choose Add or
1253: Remove, then uncheck Utilities->UNIX Perl.
1254:
1255: * To enable case-sensitivity for the file system, run REGEDIT.EXE, and change
1256: the following registry key:
1257:
1258: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel
1259:
1260: Set the DWORD value "obcaseinsensitive" to 0; then reboot.
1261:
1262: * To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1263: following registry key:
1264:
1265: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX
1266:
1267: Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.
1268:
1269: 3.3.3.3. Important notes for using pkgsrc
1270:
1271: The package manager (either the pkgsrc "su" user, or the user running
1272: "pkg_add") must be a member of the local Administrators group. Such a user must
1273: also be used to run the bootstrap. This is slightly relaxed from the normal
1274: pkgsrc requirement of "root".
1275:
1276: The package manager should use a umask of 002. "make install" will
1277: automatically complain if this is not the case. This ensures that directories
1278: written in /var/db/pkg are Administrators-group writeable.
1279:
1280: The popular Interix binary packages from http://www.interopsystems.com/ use an
1281: older version of pkgsrc's pkg_* tools. Ideally, these should NOT be used in
1282: conjunction with pkgsrc. If you choose to use them at the same time as the
1283: pkgsrc packages, ensure that you use the proper pkg_* tools for each type of
1284: binary package.
1285:
1286: The TERM setting used for DOS-type console windows (including those invoked by
1287: the csh and ksh startup shortcuts) is "interix". Most systems don't have a
1288: termcap/terminfo entry for it, but the following .termcap entry provides
1289: adequate emulation in most cases:
1290:
1291: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1292:
1293:
1294: 3.3.3.4. Limitations of the Interix platform
1295:
1296: Though Interix suffices as a familiar and flexible substitute for a full
1297: Unix-like platform, it has some drawbacks that should be noted for those
1298: desiring to make the most of Interix.
1299:
1300: * X11:
1301:
1302: Interix comes with the standard set of X11R6 client libraries, and can run
1303: X11 based applications, but it does not come with an X server. Some options
1304: are StarNet X-Win32, Hummingbird Exceed (available in a trimmed version for
1305: Interix from Interop Systems as the Interop X Server), and the free X11
1306: server included with Cygwin.
1307:
1308: * X11 acceleration:
1309:
1310: Because Interix runs in a completely different NT subsystem from Win32
1311: applications, it does not currently support various X11 protocol extensions
1312: for acceleration (such as MIT-SHM or DGA). Most interactive applications to
1313: a local X server will run reasonably fast, but full motion video and other
1314: graphics intensive applications may require a faster-than-expected CPU.
1315:
1316: * Audio:
1317:
1318: Interix has no native support for audio output. For audio support, pkgsrc
1319: uses the esound client/server audio system on Interix. Unlike on most
1320: platforms, the audio/esound package does not contain the esd server
1321: component. To output audio via an Interix host, the emulators/cygwin_esound
1322: package must also be installed.
1323:
1324: * CD/DVDs, USB, and SCSI:
1325:
1326: Direct device access is not currently supported in Interix, so it is not
1327: currently possible to access CD/DVD drives, USB devices, or SCSI devices
1328: through non-filesystem means. Among other things, this makes it impossible
1329: to use Interix directly for CD/DVD burning.
1330:
1331: * Tape drives:
1332:
1333: Due to the same limitations as for CD-ROMs and SCSI devices, tape drives
1334: are also not directly accessible in Interix. However, support is in work to
1335: make tape drive access possible by using Cygwin as a bridge (similarly to
1336: audio bridged via Cygwin's esound server).
1337:
1338: 3.3.3.5. Known issues for pkgsrc on Interix
1339:
1340: It is not necessary, in general, to have a "root" user on the Windows system;
1341: any member of the local Administrators group will suffice. However, some
1342: packages currently assume that the user named "root" is the privileged user. To
1343: accommodate these, you may create such a user; make sure it is in the local
1344: group Administrators (or your language equivalent).
1345:
1346: pkg_add creates directories of mode 0755, not 0775, in $PKG_DBDIR. For the time
1347: being, install packages as the local Administrator (or your language
1348: equivalent), or run the following command after installing a package to work
1349: around the issue:
1350:
1351: # chmod -R g+w $PKG_DBDIR
1352:
1353:
1354: 3.3.4. IRIX
1355:
1356: You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1357: compiler (cc/c89). Please set the CC environment variable according to your
1358: preference. If you do not have a license for the MIPSpro compiler suite, you
1359: can download a gcc tardist file from http://freeware.sgi.com/.
1360:
1361: Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1362: version of IRIX providing support for if_indextoname(3), if_nametoindex(3),
1363: etc.
1364:
1365: At this point in time, pkgsrc only supports one ABI at a time. That is, you
1366: cannot switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit
1367: ABI. If you start out using "abi=n32", that's what all your packages will be
1368: built with.
1369:
1370: Therefore, please make sure that you have no conflicting CFLAGS in your
1.4 rillig 1371: environment or the mk.conf. Particularly, make sure that you do not try to link
1372: n32 object files with lib64 or vice versa. Check your /etc/compiler.defaults!
1.1 dsieger 1373:
1374: If you have the actual pkgsrc tree mounted via NFS from a different host,
1375: please make sure to set WRKOBJDIR to a local directory, as it appears that IRIX
1376: linker occasionally runs into issues when trying to link over a network-mounted
1377: file system.
1378:
1379: The bootstrapping process should set all the right options for programs such as
1380: imake(1), but you may want to set some options depending on your local setup.
1381: Please see pkgsrc/mk/defaults/mk.conf and, of course, your compiler's man pages
1382: for details.
1383:
1384: If you are using SGI's MIPSPro compiler, please set
1385:
1386: PKGSRC_COMPILER= mipspro
1387:
1388:
1.4 rillig 1389: in mk.conf. Otherwise, pkgsrc will assume you are using gcc and may end up
1.1 dsieger 1390: passing invalid flags to the compiler. Note that bootstrap should create an
1391: appropriate mk.conf.example by default.
1392:
1393: If you have both the MIPSPro compiler chain installed as well as gcc, but want
1394: to make sure that MIPSPro is used, please set your PATH to not include the
1395: location of gcc (often /usr/freeware/bin), and (important) pass the
1396: '--preserve-path' flag.
1397:
1398: 3.3.5. Linux
1399:
1400: Some versions of Linux (for example Debian GNU/Linux) need either libtermcap or
1401: libcurses (libncurses). Installing the distributions libncurses-dev package (or
1402: equivalent) should fix the problem.
1403:
1404: pkgsrc supports both gcc (GNU Compiler Collection) and icc (Intel C++
1405: Compiler). gcc is the default. icc 8.0 and 8.1 on i386 have been tested.
1406:
1407: To bootstrap using icc, assuming the default icc installation directory:
1408:
1409: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1410: ac_cv___attribute__=yes ./bootstrap
1411:
1412:
1413: Note
1414:
1415: icc 8.1 needs the `-i-static' argument instead of -static-libcxa.
1416:
1417: icc supports __attribute__, but the GNU configure test uses a nested function,
1418: which icc does not support. #undef'ing __attribute__ has the unfortunate
1419: side-effect of breaking many of the Linux header files, which cannot be
1420: compiled properly without __attribute__. The test must be overridden so that
1421: __attribute__ is assumed supported by the compiler.
1422:
1.4 rillig 1423: After bootstrapping, you should set PKGSRC_COMPILER in mk.conf:
1.1 dsieger 1424:
1425: PKGSRC_COMPILER= icc
1426:
1427:
1428: The default installation directory for icc is /opt/intel_cc_80, which is also
1429: the pkgsrc default. If you have installed it into a different directory, set
1.4 rillig 1430: ICCBASE in mk.conf:
1.1 dsieger 1431:
1432: ICCBASE= /opt/icc
1433:
1434:
1435: pkgsrc uses the static linking method of the runtime libraries provided by icc,
1436: so binaries can be run on other systems which do not have the shared libraries
1437: installed.
1438:
1439: Libtool, however, extracts a list of libraries from the ld(1) command run when
1440: linking a C++ shared library and records it, throwing away the -Bstatic and
1441: -Bdynamic options interspersed between the libraries. This means that
1442: libtool-linked C++ shared libraries will have a runtime dependency on the icc
1443: libraries until this is fixed in libtool.
1444:
1445: 3.3.6. OpenBSD
1446:
1447: OpenBSD 3.0 and 3.2 are tested and supported.
1448:
1449: Care should be taken so that the tools that this kit installs do not conflict
1450: with the OpenBSD userland tools. There are several steps:
1451:
1452: 1. OpenBSD stores its ports pkg database in /var/db/pkg. It is therefore
1453: recommended that you choose a different location (e.g. /usr/pkgdb) by using
1454: the --pkgdbdir option to the bootstrap script.
1455:
1456: 2. If you do not intend to use the OpenBSD ports tools, it's probably a good
1457: idea to move them out of the way to avoid confusion, e.g.
1458:
1459: # cd /usr/sbin
1460: # mv pkg_add pkg_add.orig
1461: # mv pkg_create pkg_create.orig
1462: # mv pkg_delete pkg_delete.orig
1463: # mv pkg_info pkg_info.orig
1464:
1465:
1.4 rillig 1466: 3. An example mk.conf file will be placed in /etc/mk.conf.example file when
1467: you use the bootstrap script. OpenBSD's make program uses mk.conf as well.
1468: You can work around this by enclosing all the pkgsrc-specific parts of the
1469: file with:
1.1 dsieger 1470:
1471: .ifdef BSD_PKG_MK
1472: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1473: .else
1474: # OpenBSD stuff
1475: .endif
1476:
1477:
1478: 3.3.7. Solaris
1479:
1480: Solaris 2.6 through 9 are supported on both x86 and sparc. You will need a
1481: working C compiler. Both gcc 2.95.3 and Sun WorkShop 5 have been tested.
1482:
1483: The following packages are required on Solaris 8 for the bootstrap process and
1484: to build packages.
1485:
1486: * SUNWsprot
1487:
1488: * SUNWarc
1489:
1490: * SUNWbtool
1491:
1492: * SUNWtoo
1493:
1494: * SUNWlibm
1495:
1496: Please note that the use of GNU binutils on Solaris is not supported, as of
1497: June 2006.
1498:
1499: Whichever compiler you use, please ensure the compiler tools and your $prefix
1500: are in your PATH. This includes /usr/ccs/{bin,lib} and e.g. /usr/pkg/
1501: {bin,sbin}.
1502:
1503: 3.3.7.1. If you are using gcc
1504:
1505: It makes life much simpler if you only use the same gcc consistently for
1506: building all packages.
1507:
1508: It is recommended that an external gcc be used only for bootstrapping, then
1509: either build gcc from lang/gcc or install a binary gcc package, then remove gcc
1510: used during bootstrapping.
1511:
1512: Binary packages of gcc can be found through http://www.sunfreeware.com/.
1513:
1514: 3.3.7.2. If you are using Sun WorkShop
1515:
1516: You will need at least the following packages installed (from WorkShop 5.0)
1517:
1518: * SPROcc - Sun WorkShop Compiler C 5.0
1519:
1520: * SPROcpl - Sun WorkShop Compiler C++ 5.0
1521:
1522: * SPROild - Sun WorkShop Incremental Linker
1523:
1524: * SPROlang - Sun WorkShop Compilers common components
1525:
1526: You should set the following variables in your mk.conf file:
1527:
1528: CC= cc
1529: CXX= CC
1530: CPP= cc -E
1531: CXXCPP= CC -E
1532:
1533: Note
1534:
1535: The CPP setting might break some packages that use the C preprocessor for
1536: processing things other than C source code.
1537:
1538: 3.3.7.3. Building 64-bit binaries with SunPro
1539:
1540: To build 64-bit packages, you just need to have the following lines in your
1541: mk.conf file:
1542:
1543: PKGSRC_COMPILER= sunpro
1544: ABI= 64
1545:
1546: Note
1547:
1548: This setting has been tested for the SPARC architecture. Intel and AMD machines
1549: need some more work.
1550:
1551: 3.3.7.4. Common problems
1552:
1553: Sometimes, when using libtool, /bin/ksh crashes with a segmentation fault. The
1554: workaround is to use another shell for the configure scripts, for example by
1555: installing shells/bash and adding the following lines to your mk.conf:
1556:
1557: CONFIG_SHELL= ${LOCALBASE}/bin/bash
1558: WRAPPER_SHELL= ${LOCALBASE}/bin/bash
1559:
1560:
1561: Then, rebuild the devel/libtool-base package.
1562:
1563: Chapter 4. Using pkgsrc
1564:
1565: Table of Contents
1566:
1567: 4.1. Using binary packages
1568:
1569: 4.1.1. Finding binary packages
1570: 4.1.2. Installing binary packages
1571: 4.1.3. Deinstalling packages
1572: 4.1.4. Getting information about installed packages
1573: 4.1.5. Checking for security vulnerabilities in installed packages
1574: 4.1.6. Finding if newer versions of your installed packages are in pkgsrc
1575: 4.1.7. Other administrative functions
1576: 4.1.8. A word of warning
1577:
1578: 4.2. Building packages from source
1579:
1580: 4.2.1. Requirements
1581: 4.2.2. Fetching distfiles
1582: 4.2.3. How to build and install
1583:
1584: Basically, there are two ways of using pkgsrc. The first is to only install the
1585: package tools and to use binary packages that someone else has prepared. This
1586: is the "pkg" in pkgsrc. The second way is to install the "src" of pkgsrc, too.
1587: Then you are able to build your own packages, and you can still use binary
1588: packages from someone else.
1589:
1590: 4.1. Using binary packages
1591:
1592: To use binary packages, you need some tools to manage them. On NetBSD, these
1593: tools are already installed. On all other operating systems, you need to
1.5 weinem 1594: install them first. For some platforms, these tools are already packages in an
1595: archive, ready to be extracted in the / directory. They can be found in the
1596: bootstrap-pkgsrc directory of the FTP server.
1.1 dsieger 1597:
1598: These pre-built package tools use /usr/pkg for the base directory, and /var/db/
1599: pkg for the database of installed packages. If you cannot use these directories
1600: for whatever reasons (maybe because you're not root), you have to build the
1601: package tools yourself, which is explained in Section 3.2, "Bootstrapping
1602: pkgsrc".
1603:
1604: 4.1.1. Finding binary packages
1605:
1.5 weinem 1606: To install binary packages, you first need to know from where to get them. The
1607: first place where you should look is on the main pkgsrc FTP server in the
1608: directory /pub/pkgsrc/packages.
1609:
1610: This directory contains binary packages for multiple platforms. First, select
1611: your operating system. (Ignore the directories with version numbers attached to
1612: it, they just exist for legacy reasons.) Then, select your hardware
1613: architecture, and in the third step, the OS version and the "version" of
1614: pkgsrc. This directory contains a subdirectory called All, where (almost) all
1615: binary packages are stored. Almost, because vulnerable packages are moved to
1616: the vulnerable directory so they don't get installed accidentally.
1.1 dsieger 1617:
1618: 4.1.2. Installing binary packages
1619:
1620: If you have the files on a CD-ROM or downloaded them to your hard disk, you can
1621: install them with the following command (be sure to su to root first):
1622:
1623: # pkg_add /path/to/package.tgz
1624:
1625: If you have FTP access and you don't want to download the packages via FTP
1626: prior to installation, you can do this automatically by giving pkg_add an FTP
1627: URL:
1628:
1.5 weinem 1629: # pkg_add ftp://ftp.NetBSD.org/pub/pkgsrc/packages/OPSYS/ARCH/VERSIONS/All/package
1.1 dsieger 1630:
1631: Note that any prerequisite packages needed to run the package in question will
1632: be installed, too, assuming they are present where you install from.
1633:
1634: To save some typing, you can set the PKG_PATH environment variable to a
1635: semicolon-separated list of paths (including remote URLs); trailing slashes are
1636: not allowed.
1637:
1638: Additionally to the All directory there exists a vulnerable directory to which
1639: binary packages with known vulnerabilities are moved, since removing them could
1640: cause missing dependencies. To use these packages, add the vulnerable directory
1641: to your PKG_PATH. However, you should run security/audit-packages regularly,
1642: especially after installing new packages, and verify that the vulnerabilities
1643: are acceptable for your configuration. An example PKG_PATH would be: ftp://
1644: ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/
1645: pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable Please note that semicolon
1646: (';') is a shell meta-character, so you'll probably have to quote it.
1647:
1648: After you've installed packages, be sure to have /usr/pkg/bin and /usr/pkg/sbin
1649: in your PATH so you can actually start the just installed program.
1650:
1651: 4.1.3. Deinstalling packages
1652:
1653: To deinstall a package, it does not matter whether it was installed from source
1654: code or from a binary package. The pkg_delete command does not know it anyway.
1655: To delete a package, you can just run pkg_delete package-name. The package name
1656: can be given with or without version number. Wildcards can also be used to
1657: deinstall a set of packages, for example *emacs*. Be sure to include them in
1658: quotes, so that the shell does not expand them before pkg_delete sees them.
1659:
1660: The -r option is very powerful: it removes all the packages that require the
1661: package in question and then removes the package itself. For example:
1662:
1663: # pkg_delete -r jpeg
1664:
1665:
1666: will remove jpeg and all the packages that used it; this allows upgrading the
1667: jpeg package.
1668:
1669: 4.1.4. Getting information about installed packages
1670:
1671: The pkg_info shows information about installed packages or binary package
1672: files.
1673:
1674: 4.1.5. Checking for security vulnerabilities in installed packages
1675:
1676: The NetBSD Security-Officer and Packages Groups maintain a list of known
1677: security vulnerabilities to packages which are (or have been) included in
1678: pkgsrc. The list is available from the NetBSD FTP site at ftp://ftp.NetBSD.org/
1679: pub/pkgsrc/distfiles/vulnerabilities.
1680:
1681: Through security/audit-packages, this list can be downloaded automatically, and
1682: a security audit of all packages installed on a system can take place.
1683:
1684: There are two components to security/audit-packages. The first component,
1685: "download-vulnerability-list", is for downloading the list of vulnerabilities
1686: from the NetBSD FTP site. The second component, "audit-packages", checks to see
1687: if any of your installed packages are vulnerable. If a package is vulnerable,
1688: you will see output similar to the following:
1689:
1690: Package samba-2.0.9 has a local-root-shell vulnerability, see
1691: http://www.samba.org/samba/whatsnew/macroexploit.html
1692:
1693: One can set up security/audit-packages to download the vulnerabilities file
1694: daily, and include a package audit in the daily security script. Details on
1695: this are located in the MESSAGE file for security/audit-packages.
1696:
1697: 4.1.6. Finding if newer versions of your installed packages are in pkgsrc
1698:
1699: Install pkgtools/pkglint and run lintpkgsrc with the "-i" argument to check if
1700: your packages are up-to-date, e.g.
1701:
1702: % lintpkgsrc -i
1703: ...
1704: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1705:
1706:
1707: You can then use make update to update the package on your system and rebuild
1708: any dependencies.
1709:
1710: 4.1.7. Other administrative functions
1711:
1712: The pkg_admin executes various administrative functions on the package system.
1713:
1714: 4.1.8. A word of warning
1715:
1716: Please pay very careful attention to the warnings expressed in the pkg_add(1)
1717: manual page about the inherent dangers of installing binary packages which you
1718: did not create yourself, and the security holes that can be introduced onto
1719: your system by indiscriminate adding of such files.
1720:
1721: The same warning of course applies to every package you install from source
1722: when you haven't completely read and understood the source code of the package,
1723: the compiler that is used to build the package and all the other tools that are
1724: involved.
1725:
1726: 4.2. Building packages from source
1727:
1728: After obtaining pkgsrc, the pkgsrc directory now contains a set of packages,
1729: organized into categories. You can browse the online index of packages, or run
1730: make readme from the pkgsrc directory to build local README.html files for all
1731: packages, viewable with any web browser such as www/lynx or www/firefox.
1732:
1733: The default prefix for installed packages is /usr/pkg. If you wish to change
1734: this, you should do so by setting LOCALBASE in mk.conf. You should not try to
1735: use multiple different LOCALBASE definitions on the same system (inside a
1736: chroot is an exception).
1737:
1738: The rest of this chapter assumes that the package is already in pkgsrc. If it
1739: is not, see Part II, "The pkgsrc developer's guide" for instructions how to
1740: create your own packages.
1741:
1742: 4.2.1. Requirements
1743:
1744: To build packages from source, you need a working C compiler. On NetBSD, you
1745: need to install the "comp" and the "text" distribution sets. If you want to
1746: build X11-related packages, the "xbase" and "xcomp" distribution sets are
1747: required, too.
1748:
1749: 4.2.2. Fetching distfiles
1750:
1751: The first step for building a package is downloading the distfiles (i.e. the
1752: unmodified source). If they have not yet been downloaded, pkgsrc will fetch
1753: them automatically.
1754:
1755: If you have all files that you need in the distfiles directory, you don't need
1756: to connect. If the distfiles are on CD-ROM, you can mount the CD-ROM on /cdrom
1757: and add:
1758:
1759: DISTDIR=/cdrom/pkgsrc/distfiles
1760:
1761: to your mk.conf.
1762:
1763: By default a list of distribution sites will be randomly intermixed to prevent
1764: huge load on servers which holding popular packages (for example,
1765: SourceForge.net mirrors). Thus, every time when you need to fetch yet another
1766: distfile all the mirrors will be tried in new (random) order. You can turn this
1767: feature off by setting MASTER_SORT_RANDOM=NO (for PKG_DEVELOPERs it's already
1768: disabled).
1769:
1770: You can overwrite some of the major distribution sites to fit to sites that are
1771: close to your own. By setting one or two variables you can modify the order in
1772: which the master sites are accessed. MASTER_SORT contains a whitespace
1773: delimited list of domain suffixes. MASTER_SORT_REGEX is even more flexible, it
1774: contains a whitespace delimited list of regular expressions. It has higher
1775: priority than MASTER_SORT. Have a look at pkgsrc/mk/defaults/mk.conf to find
1776: some examples. This may save some of your bandwidth and time.
1777:
1778: You can change these settings either in your shell's environment, or, if you
1.4 rillig 1779: want to keep the settings, by editing the mk.conf file, and adding the
1.1 dsieger 1780: definitions there.
1781:
1782: If a package depends on many other packages (such as meta-pkgs/kde3), the build
1783: process may alternate between periods of downloading source, and compiling. To
1784: ensure you have all the source downloaded initially you can run the command:
1785:
1786: % make fetch-list | sh
1787:
1788: which will output and run a set of shell commands to fetch the necessary files
1789: into the distfiles directory. You can also choose to download the files
1790: manually.
1791:
1792: 4.2.3. How to build and install
1793:
1794: Once the software has downloaded, any patches will be applied, then it will be
1795: compiled for you. This may take some time depending on your computer, and how
1796: many other packages the software depends on and their compile time.
1797:
1798: Note
1799:
1800: If using bootstrap or pkgsrc on a non-NetBSD system, use the pkgsrc bmake
1801: command instead of "make" in the examples in this guide.
1802:
1803: For example, type
1804:
1805: % cd misc/figlet
1806: % make
1807:
1808:
1809: at the shell prompt to build the various components of the package.
1810:
1811: The next stage is to actually install the newly compiled program onto your
1812: system. Do this by entering:
1813:
1814: % make install
1815:
1816:
1817: while you are still in the directory for whatever package you are installing.
1818:
1819: Installing the package on your system may require you to be root. However,
1820: pkgsrc has a just-in-time-su feature, which allows you to only become root for
1821: the actual installation step.
1822:
1823: That's it, the software should now be installed and setup for use. You can now
1824: enter:
1825:
1826: % make clean
1827:
1828:
1829: to remove the compiled files in the work directory, as you shouldn't need them
1830: any more. If other packages were also added to your system (dependencies) to
1831: allow your program to compile, you can tidy these up also with the command:
1832:
1833: % make clean-depends
1834:
1835:
1836: Taking the figlet utility as an example, we can install it on our system by
1837: building as shown in Appendix B, Build logs.
1838:
1839: The program is installed under the default root of the packages tree - /usr/
1840: pkg. Should this not conform to your tastes, set the LOCALBASE variable in your
1841: environment, and it will use that value as the root of your packages tree. So,
1842: to use /usr/local, set LOCALBASE=/usr/local in your environment. Please note
1843: that you should use a directory which is dedicated to packages and not shared
1844: with other programs (i.e., do not try and use LOCALBASE=/usr). Also, you should
1845: not try to add any of your own files or directories (such as src/, obj/, or
1846: pkgsrc/) below the LOCALBASE tree. This is to prevent possible conflicts
1847: between programs and other files installed by the package system and whatever
1848: else may have been installed there.
1849:
1.4 rillig 1850: Some packages look in mk.conf to alter some configuration options at build
1.1 dsieger 1851: time. Have a look at pkgsrc/mk/defaults/mk.conf to get an overview of what will
1852: be set there by default. Environment variables such as LOCALBASE can be set in
1.4 rillig 1853: mk.conf to save having to remember to set them each time you want to use
1.1 dsieger 1854: pkgsrc.
1855:
1856: Occasionally, people want to "look under the covers" to see what is going on
1857: when a package is building or being installed. This may be for debugging
1858: purposes, or out of simple curiosity. A number of utility values have been
1859: added to help with this.
1860:
1861: 1. If you invoke the make(1) command with PKG_DEBUG_LEVEL=2, then a huge
1862: amount of information will be displayed. For example,
1863:
1864: make patch PKG_DEBUG_LEVEL=2
1865:
1866: will show all the commands that are invoked, up to and including the
1867: "patch" stage.
1868:
1869: 2. If you want to know the value of a certain make(1) definition, then the
1870: VARNAME definition should be used, in conjunction with the show-var target.
1871: e.g. to show the expansion of the make(1) variable LOCALBASE:
1872:
1873: % make show-var VARNAME=LOCALBASE
1874: /usr/pkg
1875: %
1876:
1877:
1878: If you want to install a binary package that you've either created yourself
1879: (see next section), that you put into pkgsrc/packages manually or that is
1880: located on a remote FTP server, you can use the "bin-install" target. This
1881: target will install a binary package - if available - via pkg_add(1), else do a
1882: make package. The list of remote FTP sites searched is kept in the variable
1883: BINPKG_SITES, which defaults to ftp.NetBSD.org. Any flags that should be added
1884: to pkg_add(1) can be put into BIN_INSTALL_FLAGS. See pkgsrc/mk/defaults/mk.conf
1885: for more details.
1886:
1887: A final word of warning: If you set up a system that has a non-standard setting
1888: for LOCALBASE, be sure to set that before any packages are installed, as you
1889: cannot use several directories for the same purpose. Doing so will result in
1890: pkgsrc not being able to properly detect your installed packages, and fail
1891: miserably. Note also that precompiled binary packages are usually built with
1892: the default LOCALBASE of /usr/pkg, and that you should not install any if you
1893: use a non-standard LOCALBASE.
1894:
1895: Chapter 5. Configuring pkgsrc
1896:
1897: Table of Contents
1898:
1899: 5.1. General configuration
1900: 5.2. Variables affecting the build process
1.4 rillig 1901: 5.3. Variables affecting the installion process
1902: 5.4. Selecting and configuring the compiler
1.1 dsieger 1903:
1.4 rillig 1904: 5.4.1. Selecting the compiler
1905: 5.4.2. Additional flags to the compiler (CFLAGS)
1906: 5.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 1907:
1.4 rillig 1908: 5.5. Developer/advanced settings
1909: 5.6. Selecting Build Options
1.1 dsieger 1910:
1911: The whole pkgsrc system is configured in a single file, usually called mk.conf.
1912: In which directory pkgsrc looks for that file depends on the installation. On
1913: NetBSD, when you use make(1) from the base system, it is in the directory /etc
1914: /. In all other cases the default location is ${PREFIX}/etc/, depending on
1915: where you told the bootstrap program to install the binary packages.
1916:
1917: During the bootstrap, an example configuration file is created. To use that,
1918: you have to create the directory ${PREFIX}/etc and copy the example file there.
1919:
1920: The format of the configuration file is that of the usual BSD-style Makefiles.
1921: The whole pkgsrc configuration is done by setting variables in this file. Note
1922: that you can define all kinds of variables, and no special error checking (for
1923: example for spelling mistakes) takes place, so you have to try it out to see if
1924: it works.
1925:
1926: 5.1. General configuration
1927:
1928: In this section, you can find some variables that apply to all pkgsrc packages.
1929: A complete list of the variables that can be configured by the user is
1930: available in mk/defaults/mk.conf, together with some comments that describe
1931: each variable's intent.
1932:
1933: * LOCALBASE: Where packages will be installed. The default is /usr/pkg. Do
1934: not mix binary packages with different LOCALBASEs!
1935:
1936: * CROSSBASE: Where "cross" category packages will be installed. The default
1937: is ${LOCALBASE}/cross.
1938:
1939: * X11BASE: Where X11 is installed on the system. The default is /usr/X11R6.
1940:
1941: * DISTDIR: Where to store the downloaded copies of the original source
1942: distributions used for building pkgsrc packages. The default is $
1943: {PKGSRCDIR}/distfiles.
1944:
1945: * PKG_DBDIR: Where the database about installed packages is stored. The
1946: default is /var/db/pkg.
1947:
1948: * MASTER_SITE_OVERRIDE: If set, override the packages' MASTER_SITES with this
1949: value.
1950:
1951: * MASTER_SITE_BACKUP: Backup location(s) for distribution files and patch
1952: files if not found locally or in ${MASTER_SITES} or ${PATCH_SITES}
1953: respectively. The defaults are ftp://ftp.NetBSD.org/pub/NetBSD/packages/
1954: distfiles/${DIST_SUBDIR}/ and ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/$
1955: {DIST_SUBDIR}/.
1956:
1957: * BINPKG_SITES: List of sites carrying binary pkgs. rel and arch are replaced
1958: with OS release ("2.0", etc.) and architecture ("mipsel", etc.).
1959:
1960: * ACCEPTABLE_LICENSES: List of acceptable licenses. Whenever you try to build
1961: a package whose license is not in this list, you will get an error message
1962: that includes instructions on how to change this variable.
1963:
1964: 5.2. Variables affecting the build process
1965:
1966: XXX
1967:
1968: * PACKAGES: The top level directory for the binary packages. The default is $
1969: {PKGSRCDIR}/packages.
1970:
1971: * WRKOBJDIR: The top level directory where, if defined, the separate working
1972: directories will get created, and symbolically linked to from ${WRKDIR}
1973: (see below). This is useful for building packages on several architectures,
1974: then ${PKGSRCDIR} can be NFS-mounted while ${WRKOBJDIR} is local to every
1975: architecture. (It should be noted that PKGSRCDIR should not be set by the
1976: user ? it is an internal definition which refers to the root of the pkgsrc
1977: tree. It is possible to have many pkgsrc tree instances.)
1978:
1979: * LOCALPATCHES: Directory for local patches that aren't part of pkgsrc. See
1.6 ! rillig 1980: Section 11.3, "patches/*" for more information.
1.1 dsieger 1981:
1982: * PKGMAKECONF: Location of the mk.conf file used by a package's BSD-style
1983: Makefile. If this is not set, MAKECONF is set to /dev/null to avoid picking
1984: up settings used by builds in /usr/src.
1985:
1986: * DEPENDS_TARGET: By default, dependencies are only installed, and no binary
1987: package is created for them. You can set this variable to package to
1988: automatically create binary packages after installing dependencies.
1989:
1.4 rillig 1990: 5.3. Variables affecting the installion process
1.1 dsieger 1991:
1.4 rillig 1992: A growing number of packages support installation into a subdirectory of
1993: WRKDIR. This allows a package to be built, before the actual filesystem is
1994: touched. DESTDIR support exists in two variations:
1995:
1996: * Basic DESTDIR support means that the package installation and packaging is
1997: still run as root.
1998:
1999: * Full DESTDIR support can run the complete build, installation and packaging
2000: as normal user. Root privileges are only needed to add packages.
2001:
2002: To use the DESTDIR support, set either USE_DESTDIR=yes to use the basic support
2003: for packages that offer it or USE_DESTDIR=full to get the full support with
2004: fallback to basic support. USE_DESTDIR=full needs pkgtools/pkg_install version
2005: 20070802 (or newer). It might become the default DESTDIR support later.
2006:
2007: DESTDIR support changes the behaviour of various targets slightly. To install a
2008: package after building it, use package-install. package and install don't do
2009: that any longer. package-install can be used as DEPENDS_TARGET. bin-install
2010: will ask for the root password to install the package and fail, package-install
2011: will ask again.
2012:
2013: With basic DESTDIR support, make clean needs to be run as root.
2014:
2015: 5.4. Selecting and configuring the compiler
2016:
2017: 5.4.1. Selecting the compiler
1.1 dsieger 2018:
2019: By default, pkgsrc will use GCC to build packages. This may be overridden by
2020: setting the following variables in /etc/mk.conf:
2021:
2022: PKGSRC_COMPILER:
2023:
2024: This is a list of values specifying the chain of compilers to invoke when
2025: building packages. Valid values are:
2026:
2027: * distcc: distributed C/C++ (chainable)
2028:
2029: * ccache: compiler cache (chainable)
2030:
2031: * gcc: GNU C/C++ Compiler
2032:
2033: * mipspro: Silicon Graphics, Inc. MIPSpro (n32/n64)
2034:
2035: * mipspro: Silicon Graphics, Inc. MIPSpro (o32)
2036:
2037: * sunpro: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio
2038:
2039: The default is "gcc". You can use ccache and/or distcc with an appropriate
2040: PKGSRC_COMPILER setting, e.g. "ccache gcc". This variable should always be
2041: terminated with a value for a real compiler. Note that only one real
2042: compiler should be listed (e.g. "sunpro gcc" is not allowed).
2043:
2044: GCC_REQD:
2045:
2046: This specifies the minimum version of GCC to use when building packages. If
2047: the system GCC doesn't satisfy this requirement, then pkgsrc will build and
2048: install one of the GCC packages to use instead.
2049:
1.4 rillig 2050: 5.4.2. Additional flags to the compiler (CFLAGS)
1.1 dsieger 2051:
2052: If you wish to set the CFLAGS variable, please make sure to use the += operator
2053: instead of the = operator:
2054:
2055: CFLAGS+= -your -flags
2056:
2057: Using CFLAGS= (i.e. without the "+") may lead to problems with packages that
2058: need to add their own flags. Also, you may want to take a look at the devel/
2059: cpuflags package if you're interested in optimization for the current CPU.
2060:
1.4 rillig 2061: 5.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 2062:
2063: If you want to pass flags to the linker, both in the configure step and the
2064: build step, you can do this in two ways. Either set LDFLAGS or LIBS. The
2065: difference between the two is that LIBS will be appended to the command line,
2066: while LDFLAGS come earlier. LDFLAGS is pre-loaded with rpath settings for ELF
2067: machines depending on the setting of USE_IMAKE or the inclusion of mk/
2068: x11.buildlink3.mk. As with CFLAGS, if you do not wish to override these
2069: settings, use the += operator:
2070:
2071: LDFLAGS+= -your -linkerflags
2072:
1.4 rillig 2073: 5.5. Developer/advanced settings
1.1 dsieger 2074:
2075: XXX
2076:
2077: * PKG_DEVELOPER: Run some sanity checks that package developers want:
2078:
2079: o make sure patches apply with zero fuzz
2080:
2081: o run check-shlibs to see that all binaries will find their shared libs.
2082:
2083: * PKG_DEBUG_LEVEL: The level of debugging output which is displayed whilst
2084: making and installing the package. The default value for this is 0, which
2085: will not display the commands as they are executed (normal, default, quiet
2086: operation); the value 1 will display all shell commands before their
2087: invocation, and the value 2 will display both the shell commands before
2088: their invocation, and their actual execution progress with set -x will be
2089: displayed.
2090:
1.4 rillig 2091: 5.6. Selecting Build Options
1.1 dsieger 2092:
2093: Some packages have build time options, usually to select between different
2094: dependencies, enable optional support for big dependencies or enable
2095: experimental features.
2096:
2097: To see which options, if any, a package supports, and which options are
2098: mutually exclusive, run make show-options, for example:
2099:
2100: The following options are supported by this package:
2101: ssl Enable SSL support.
2102: Exactly one of the following gecko options is required:
2103: firefox Use firefox as gecko rendering engine.
2104: mozilla Use mozilla as gecko rendering engine.
2105: At most one of the following database options may be selected:
2106: mysql Enable support for MySQL database.
2107: pgsql Enable support for PostgreSQL database.
2108:
2109: These options are enabled by default: firefox
2110: These options are currently enabled: mozilla ssl
2111:
1.4 rillig 2112: The following variables can be defined in mk.conf to select which options to
2113: enable for a package: PKG_DEFAULT_OPTIONS, which can be used to select or
1.1 dsieger 2114: disable options for all packages that support them, and PKG_OPTIONS.pkgbase,
2115: which can be used to select or disable options specifically for package pkgbase
2116: . Options listed in these variables are selected, options preceded by "-" are
2117: disabled. A few examples:
2118:
1.4 rillig 2119: $ grep "PKG.*OPTION" mk.conf
1.1 dsieger 2120: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
2121: PKG_OPTIONS.kdebase= debug -sasl
2122: PKG_OPTIONS.apache= suexec
2123:
2124: The following settings are consulted in the order given, and the last setting
2125: that selects or disables an option is used:
2126:
2127: 1. the default options as suggested by the package maintainer
2128:
2129: 2. the options implied by the settings of legacy variables (see below)
2130:
2131: 3. PKG_DEFAULT_OPTIONS
2132:
2133: 4. PKG_OPTIONS.pkgbase
2134:
2135: For groups of mutually exclusive options, the last option selected is used, all
2136: others are automatically disabled. If an option of the group is explicitly
2137: disabled, the previously selected option, if any, is used. It is an error if no
2138: option from a required group of options is selected, and building the package
2139: will fail.
2140:
2141: Before the options framework was introduced, build options were selected by
1.4 rillig 2142: setting a variable (often named USE_FOO) in mk.conf for each option. To ease
2143: transition to the options framework for the user, these legacy variables are
2144: converted to the appropriate options setting (PKG_OPTIONS.pkgbase)
2145: automatically. A warning is issued to prompt the user to update mk.conf to use
2146: the options framework directly. Support for the legacy variables will be
1.1 dsieger 2147: removed eventually.
2148:
2149: Chapter 6. Creating binary packages
2150:
2151: Table of Contents
2152:
2153: 6.1. Building a single binary package
2154: 6.2. Settings for creation of binary packages
2155:
2156: 6.1. Building a single binary package
2157:
2158: Once you have built and installed a package, you can create a binary package
2159: which can be installed on another system with pkg_add(1). This saves having to
2160: build the same package on a group of hosts and wasting CPU time. It also
2161: provides a simple means for others to install your package, should you
2162: distribute it.
2163:
2164: To create a binary package, change into the appropriate directory in pkgsrc,
2165: and run make package:
2166:
2167: # cd misc/figlet
2168: # make package
2169:
2170:
2171: This will build and install your package (if not already done), and then build
2172: a binary package from what was installed. You can then use the pkg_* tools to
2173: manipulate it. Binary packages are created by default in /usr/pkgsrc/packages,
2174: in the form of a gzipped tar file. See Section B.2, "Packaging figlet" for a
2175: continuation of the above misc/figlet example.
2176:
1.6 ! rillig 2177: See Chapter 21, Submitting and Committing for information on how to submit such
1.1 dsieger 2178: a binary package.
2179:
2180: 6.2. Settings for creation of binary packages
2181:
1.6 ! rillig 2182: See Section 17.17, "Other helpful targets".
! 2183:
! 2184: Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds)
! 2185:
! 2186: Table of Contents
! 2187:
! 2188: 7.1. Think first, build later
! 2189: 7.2. Requirements of a bulk build
! 2190: 7.3. Running an old-style bulk build
! 2191:
! 2192: 7.3.1. Configuration
! 2193: 7.3.2. Other environmental considerations
! 2194: 7.3.3. Operation
! 2195: 7.3.4. What it does
! 2196: 7.3.5. Disk space requirements
! 2197: 7.3.6. Setting up a sandbox for chrooted builds
! 2198: 7.3.7. Building a partial set of packages
! 2199: 7.3.8. Uploading results of a bulk build
! 2200:
! 2201: 7.4. Running a pbulk-style bulk build
! 2202:
! 2203: 7.4.1. Configuration
! 2204:
! 2205: 7.5. Creating a multiple CD-ROM packages collection
! 2206:
! 2207: 7.5.1. Example of cdpack
! 2208:
! 2209: When you have multiple machines that should run the same packages, it is wasted
! 2210: time if they all build their packages themselves from source. There are two
! 2211: ways of getting a set of binary packages: The old bulk build system, or the new
! 2212: (as of 2007) parallel bulk build (pbulk) system. This chapter describes how to
! 2213: set them up so that the packages are most likely to be usable later.
! 2214:
! 2215: 7.1. Think first, build later
! 2216:
! 2217: Since a bulk build takes several days or even weeks to finish, you should think
! 2218: about the setup before you start everything. Pay attention to at least the
! 2219: following points:
1.1 dsieger 2220:
1.6 ! rillig 2221: * If you want to upload the binary packages to ftp.NetBSD.org, make sure the
! 2222: setup complies to the requirements for binary packages:
1.1 dsieger 2223:
1.6 ! rillig 2224: o To end up on ftp.NetBSD.org, the packages must be built by a NetBSD
! 2225: developer on a trusted machine (that is, where you and only you have
! 2226: root access).
1.1 dsieger 2227:
1.6 ! rillig 2228: o Packages on ftp.NetBSD.org should only be created from the stable
! 2229: branches (like 2007Q1), so that users browsing the available
! 2230: collections can see at a glance how old the packages are.
1.1 dsieger 2231:
1.6 ! rillig 2232: o The packages must be built as root, since some packages require set-uid
! 2233: binaries at runtime, and creating those packages as unprivileged user
! 2234: doesn't work well at the moment.
1.1 dsieger 2235:
1.6 ! rillig 2236: * Make sure that the bulk build cannot break anything in your system. Most
! 2237: bulk builds run as root, so they should be run at least in a chroot
! 2238: environment or something even more restrictive, depending on what the
! 2239: operating system provides. There have been numerous cases where certain
! 2240: packages tried to install files outside the LOCALBASE or wanted to edit
! 2241: some files in /etc. Furthermore, the bulk builds install and deinstall
! 2242: packages in /usr/pkg (or whatever LOCALBASE is) during their operation, so
! 2243: be sure that you don't need any package during the build.
! 2244:
! 2245: 7.2. Requirements of a bulk build
! 2246:
! 2247: A complete bulk build requires lots of disk space. Some of the disk space can
! 2248: be read-only, some other must be writable. Some can be on remote filesystems
! 2249: (such as NFS) and some should be local. Some can be temporary filesystems,
! 2250: others must survive a sudden reboot.
! 2251:
! 2252: * 10 GB for the distfiles (read-write, remote, temporary)
! 2253:
! 2254: * 10 GB for the binary packages (read-write, remote, permanent)
! 2255:
! 2256: * 400 MB for the pkgsrc tree (read-only, remote, permanent)
! 2257:
! 2258: * 5 GB for LOCALBASE (read-write, local, temporary for pbulk, permanent for
! 2259: old-bulk)
! 2260:
! 2261: * 5 GB for the log files (read-write, remote, permanent)
! 2262:
! 2263: * 5 GB for temporary files (read-write, local, temporary)
! 2264:
! 2265: 7.3. Running an old-style bulk build
! 2266:
! 2267: Warning
! 2268:
! 2269: The rest of this section is rather old. Don't rely on it too much.
! 2270:
! 2271: 7.3.1. Configuration
! 2272:
! 2273: 7.3.1.1. build.conf
1.1 dsieger 2274:
2275: The build.conf file is the main configuration file for bulk builds. You can
2276: configure how your copy of pkgsrc is kept up to date, how the distfiles are
2277: downloaded, how the packages are built and how the report is generated. You can
2278: find an annotated example file in pkgsrc/mk/bulk/build.conf-example. To use it,
2279: copy build.conf-example to build.conf and edit it, following the comments in
2280: that file.
2281:
1.6 ! rillig 2282: 7.3.1.2. mk.conf
1.1 dsieger 2283:
1.4 rillig 2284: You may want to set variables in mk.conf. Look at pkgsrc/mk/defaults/mk.conf
2285: for details of the default settings. You will want to ensure that
1.1 dsieger 2286: ACCEPTABLE_LICENSES meet your local policy. As used in this example,
1.4 rillig 2287: _ACCEPTABLE=yes completely bypasses the license check.
1.1 dsieger 2288:
2289: PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2290: WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
2291: BSDSRCDIR= /usr/src
2292: BSDXSRCDIR= /usr/xsrc # for x11/xservers
2293: OBJHOSTNAME?= yes # use work.`hostname`
2294: FAILOVER_FETCH= yes # insist on the correct checksum
2295: PKG_DEVELOPER?= yes
2296: _ACCEPTABLE= yes
2297:
2298: Some options that are especially useful for bulk builds can be found at the top
2299: lines of the file mk/bulk/bsd.bulk-pkg.mk. The most useful options of these are
2300: briefly described here.
2301:
2302: * If you are on a slow machine, you may want to set USE_BULK_BROKEN_CHECK to
2303: "no".
2304:
2305: * If you are doing bulk builds from a read-only copy of pkgsrc, you have to
2306: set BULKFILESDIR to the directory where all log files are created.
2307: Otherwise the log files are created in the pkgsrc directory.
2308:
2309: * Another important variable is BULK_PREREQ, which is a list of packages that
2310: should be always available while building other packages.
2311:
2312: Some other options are scattered in the pkgsrc infrastructure:
2313:
2314: * ALLOW_VULNERABLE_PACKAGES should be set to yes. The purpose of the bulk
2315: builds is creating binary packages, no matter if they are vulnerable or
2316: not. When uploading the packages to a public server, the vulnerable
2317: packages will be put into a directory of their own. Leaving this variable
2318: unset would prevent the bulk build system from even trying to build them,
2319: so possible building errors would not show up.
2320:
2321: * CHECK_FILES (pkgsrc/mk/check/check-files.mk) can be set to "yes" to check
2322: that the installed set of files matches the PLIST.
2323:
2324: * CHECK_INTERPRETER (pkgsrc/mk/check/check-interpreter.mk) can be set to
2325: "yes" to check that the installed "#!"-scripts will find their interpreter.
2326:
2327: * PKGSRC_RUN_TEST can be set to "yes" to run each package's self-test before
2328: installing it. Note that some packages make heavy use of "good" random
2329: numbers, so you need to assure that the machine on which you are doing the
2330: bulk builds is not completely idle. Otherwise some test programs will seem
2331: to hang, while they are just waiting for new random data to be available.
2332:
1.6 ! rillig 2333: 7.3.1.3. pre-build.local
1.1 dsieger 2334:
2335: It is possible to configure the bulk build to perform certain site-specific
2336: tasks at the end of the pre-build stage. If the file pre-build.local exists in
2337: /usr/pkgsrc/mk/bulk, it will be executed (as a sh(1) script) at the end of the
2338: usual pre-build stage. An example use of pre-build.local is to have the line:
2339:
2340: echo "I do not have enough disk space to build this pig." \
2341: > misc/openoffice/$BROKENF
2342:
2343: to prevent the system from trying to build a particular package which requires
2344: nearly 3 GB of disk space.
2345:
1.6 ! rillig 2346: 7.3.2. Other environmental considerations
1.1 dsieger 2347:
2348: As /usr/pkg will be completely deleted at the start of bulk builds, make sure
2349: your login shell is placed somewhere else. Either drop it into /usr/local/bin
2350: (and adjust your login shell in the passwd file), or (re-)install it via
2351: pkg_add(1) from /etc/rc.local, so you can login after a reboot (remember that
2352: your current process won't die if the package is removed, you just can't start
2353: any new instances of the shell any more). Also, if you use NetBSD earlier than
2354: 1.5, or you still want to use the pkgsrc version of ssh for some reason, be
2355: sure to install ssh before starting it from rc.local:
2356:
2357: (cd /usr/pkgsrc/security/ssh && make bulk-install)
2358: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2359: /usr/pkg/etc/rc.d/sshd
2360: fi
2361:
2362: Not doing so will result in you being not able to log in via ssh after the bulk
2363: build is finished or if the machine gets rebooted or crashes. You have been
2364: warned! :)
2365:
1.6 ! rillig 2366: 7.3.3. Operation
1.1 dsieger 2367:
2368: Make sure you don't need any of the packages still installed.
2369:
2370: Warning
2371:
2372: During the bulk build, all packages, their configuration files and some more
2373: files from /var, /home and possibly other locations will be removed! So don't
2374: run a bulk build with privileges that might harm your system.
2375:
2376: Be sure to remove all other things that might interfere with builds, like some
2377: libs installed in /usr/local, etc. then become root and type:
2378:
2379: # cd /usr/pkgsrc
2380: # sh mk/bulk/build
2381:
2382:
2383: If for some reason your last build didn't complete (power failure, system
2384: panic, ...), you can continue it by running:
2385:
2386: # sh mk/bulk/build restart
2387:
2388: At the end of the bulk build, you will get a summary via mail, and find build
2389: logs in the directory specified by FTP in the build.conf file.
2390:
1.6 ! rillig 2391: 7.3.4. What it does
1.1 dsieger 2392:
2393: The bulk builds consist of three steps:
2394:
2395: 1. pre-build
2396:
2397: The script updates your pkgsrc tree via (anon)cvs, then cleans out any
2398: broken distfiles, and removes all packages installed.
2399:
2400: 2. the bulk build
2401:
2402: This is basically "make bulk-package" with an optimised order in which
2403: packages will be built. Packages that don't require other packages will be
2404: built first, and packages with many dependencies will be built later.
2405:
2406: 3. post-build
2407:
2408: Generates a report that's placed in the directory specified in the
2409: build.conf file named broken.html, a short version of that report will also
2410: be mailed to the build's admin.
2411:
2412: During the build, a list of broken packages will be compiled in /usr/pkgsrc
2413: /.broken (or .../.broken.${MACHINE} if OBJMACHINE is set), individual build
2414: logs of broken builds can be found in the package's directory. These files are
2415: used by the bulk-targets to mark broken builds to not waste time trying to
2416: rebuild them, and they can be used to debug these broken package builds later.
2417:
1.6 ! rillig 2418: 7.3.5. Disk space requirements
1.1 dsieger 2419:
2420: Currently, roughly the following requirements are valid for NetBSD 2.0/i386:
2421:
2422: * 10 GB - distfiles (NFS ok)
2423:
2424: * 8 GB - full set of all binaries (NFS ok)
2425:
2426: * 5 GB - temp space for compiling (local disk recommended)
2427:
2428: Note that all pkgs will be de-installed as soon as they are turned into a
2429: binary package, and that sources are removed, so there is no excessively huge
2430: demand to disk space. Afterwards, if the package is needed again, it will be
2431: installed via pkg_add(1) instead of building again, so there are no cycles
2432: wasted by recompiling.
2433:
1.6 ! rillig 2434: 7.3.6. Setting up a sandbox for chrooted builds
1.1 dsieger 2435:
2436: If you don't want all the packages nuked from a machine (rendering it useless
2437: for anything but pkg compiling), there is the possibility of doing the package
2438: bulk build inside a chroot environment.
2439:
2440: The first step is to set up a chroot sandbox, e.g. /usr/sandbox. This can be
2441: done by using null mounts, or manually.
2442:
2443: There is a shell script called pkgsrc/mk/bulk/mksandbox which will set up the
2444: sandbox environment using null mounts. It will also create a script called
2445: sandbox in the root of the sandbox environment, which will allow the null
2446: mounts to be activated using the sandbox mount command and deactivated using
2447: the sandbox umount command.
2448:
2449: To set up a sandbox environment by hand, after extracting all the sets from a
2450: NetBSD installation or doing a make distribution DESTDIR=/usr/sandbox in /usr/
2451: src/etc, be sure the following items are present and properly configured:
2452:
2453: 1. Kernel
2454:
2455: # cp /netbsd /usr/sandbox
2456:
2457: 2. /dev/*
2458:
2459: # cd /usr/sandbox/dev ; sh MAKEDEV all
2460:
2461: 3. /etc/resolv.conf (for security/smtpd and mail):
2462:
2463: # cp /etc/resolv.conf /usr/sandbox/etc
2464:
2465: 4. Working(!) mail config (hostname, sendmail.cf):
2466:
2467: # cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail
2468:
2469: 5. /etc/localtime (for security/smtpd):
2470:
2471: # ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime
2472:
2473: 6. /usr/src (system sources, e. g. for sysutils/aperture):
2474:
2475: # ln -s ../disk1/cvs .
2476: # ln -s cvs/src-2.0 src
2477:
2478: 7. Create /var/db/pkg (not part of default install):
2479:
2480: # mkdir /usr/sandbox/var/db/pkg
2481:
2482: 8. Create /usr/pkg (not part of default install):
2483:
2484: # mkdir /usr/sandbox/usr/pkg
2485:
2486: 9. Checkout pkgsrc via cvs into /usr/sandbox/usr/pkgsrc:
2487:
2488: # cd /usr/sandbox/usr
2489: # cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc
2490:
2491:
2492: Do not mount/link this to the copy of your pkgsrc tree you do development
2493: in, as this will likely cause problems!
2494:
2495: 10. Make /usr/sandbox/usr/pkgsrc/packages and .../distfiles point somewhere
2496: appropriate. NFS- and/or nullfs-mounts may come in handy!
2497:
1.6 ! rillig 2498: 11. Edit mk.conf, see Section 7.3.1.2, "mk.conf".
1.1 dsieger 2499:
2500: 12. Adjust mk/bulk/build.conf to suit your needs.
2501:
2502: When the chroot sandbox is set up, you can start the build with the following
2503: steps:
2504:
2505: # cd /usr/sandbox/usr/pkgsrc
2506: # sh mk/bulk/do-sandbox-build
2507:
2508:
2509: This will just jump inside the sandbox and start building. At the end of the
2510: build, mail will be sent with the results of the build. Created binary pkgs
2511: will be in /usr/sandbox/usr/pkgsrc/packages (wherever that points/mounts to/
2512: from).
2513:
1.6 ! rillig 2514: 7.3.7. Building a partial set of packages
1.1 dsieger 2515:
2516: In addition to building a complete set of all packages in pkgsrc, the pkgsrc/mk
2517: /bulk/build script may be used to build a subset of the packages contained in
1.4 rillig 2518: pkgsrc. By setting SPECIFIC_PKGS in mk.conf, the variables
1.1 dsieger 2519:
2520: * SITE_SPECIFIC_PKGS
2521:
2522: * HOST_SPECIFIC_PKGS
2523:
2524: * GROUP_SPECIFIC_PKGS
2525:
2526: * USER_SPECIFIC_PKGS
2527:
2528: will define the set of packages which should be built. The bulk build code will
2529: also include any packages which are needed as dependencies for the explicitly
2530: listed packages.
2531:
2532: One use of this is to do a bulk build with SPECIFIC_PKGS in a chroot sandbox
2533: periodically to have a complete set of the binary packages needed for your site
2534: available without the overhead of building extra packages that are not needed.
2535:
1.6 ! rillig 2536: 7.3.8. Uploading results of a bulk build
1.1 dsieger 2537:
2538: This section describes how pkgsrc developers can upload binary pkgs built by
2539: bulk builds to ftp.NetBSD.org.
2540:
2541: If you would like to automatically create checksum files for the binary
2542: packages you intend to upload, remember to set MKSUMS=yes in your mk/bulk/
2543: build.conf.
2544:
2545: If you would like to PGP sign the checksum files (highly recommended!),
2546: remember to set SIGN_AS=username@NetBSD.org in your mk/bulk/build.conf. This
2547: will prompt you for your GPG password to sign the files before uploading
2548: everything.
2549:
2550: Then, make sure that you have RSYNC_DST set properly in your mk/bulk/build.conf
2551: file, i.e. adjust it to something like one of the following:
2552:
2553: RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload
2554:
2555: Please use appropriate values for "packages-200xQy", "NetBSD-a.b.c" and "arch"
2556: here. If your login on ftp.NetBSD.org is different from your local login, write
2557: your login directly into the variable, e.g. my local account is "feyrer", but
2558: for my login "hubertf", I use:
2559:
2560: RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload
2561:
2562: A separate upload directory is used here to allow "closing" the directory
2563: during upload. To do so, run the following command on ftp.NetBSD.org next:
2564:
2565: nbftp% mkdir -p -m 750 /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload
2566:
2567: Please note that /pub/NetBSD/packages is only appropriate for packages for the
2568: NetBSD operating system. Binary packages for other operating systems should go
2569: into /pub/pkgsrc.
2570:
2571: Before uploading the binary pkgs, ssh authentication needs to be set up. This
2572: example shows how to set up temporary keys for the root account inside the
2573: sandbox (assuming that no keys should be present there usually):
2574:
2575: # chroot /usr/sandbox
2576: chroot-# rm $HOME/.ssh/id-dsa*
2577: chroot-# ssh-keygen -t dsa
2578: chroot-# cat $HOME/.ssh/id-dsa.pub
2579:
2580:
2581: Now take the output of id-dsa.pub and append it to your ~/.ssh/authorized_keys
2582: file on ftp.NetBSD.org. You can remove the key after the upload is done!
2583:
2584: Next, test if your ssh connection really works:
2585:
2586: chroot-# ssh ftp.NetBSD.org date
2587:
2588: Use "-l yourNetBSDlogin" here as appropriate!
2589:
2590: Now after all this works, you can exit the sandbox and start the upload:
2591:
2592: chroot-# exit
2593: # cd /usr/sandbox/usr/pkgsrc
2594: # sh mk/bulk/do-sandbox-upload
2595:
2596:
2597: The upload process may take quite some time. Use ls(1) or du(1) on the FTP
2598: server to monitor progress of the upload. The upload script will take care of
2599: not uploading restricted packages and putting vulnerable packages into the
2600: vulnerable subdirectory.
2601:
2602: After the upload has ended, first thing is to revoke ssh access:
2603:
2604: nbftp% vi ~/.ssh/authorized_keys
2605: Gdd:x!
2606:
2607: Use whatever is needed to remove the key you've entered before! Last, move the
2608: uploaded packages out of the upload directory to have them accessible to
2609: everyone:
2610:
2611: nbftp% cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch
2612: nbftp% mv upload/* .
2613: nbftp% rmdir upload
2614: nbftp% chmod 755 .
2615:
2616:
1.6 ! rillig 2617: 7.4. Running a pbulk-style bulk build
! 2618:
! 2619: 7.4.1. Configuration
! 2620:
! 2621: TODO; see the wiki for more information.
! 2622:
! 2623: 7.5. Creating a multiple CD-ROM packages collection
1.1 dsieger 2624:
2625: After your pkgsrc bulk-build has completed, you may wish to create a CD-ROM set
2626: of the resulting binary packages to assist in installing packages on other
2627: machines. The pkgtools/cdpack package provides a simple tool for creating the
2628: ISO 9660 images. cdpack arranges the packages on the CD-ROMs in a way that
2629: keeps all the dependencies for a given package on the same CD as that package.
2630:
1.6 ! rillig 2631: 7.5.1. Example of cdpack
1.1 dsieger 2632:
2633: Complete documentation for cdpack is found in the cdpack(1) man page. The
2634: following short example assumes that the binary packages are left in /usr/
2635: pkgsrc/packages/All and that sufficient disk space exists in /u2 to hold the
2636: ISO 9660 images.
2637:
2638: # mkdir /u2/images
2639: # pkg_add /usr/pkgsrc/packages/All/cdpack
2640: # cdpack /usr/pkgsrc/packages/All /u2/images
2641:
2642:
2643: If you wish to include a common set of files (COPYRIGHT, README, etc.) on each
2644: CD in the collection, then you need to create a directory which contains these
2645: files. e.g.
2646:
2647: # mkdir /tmp/common
2648: # echo "This is a README" > /tmp/common/README
2649: # echo "Another file" > /tmp/common/COPYING
2650: # mkdir /tmp/common/bin
2651: # echo "#!/bin/sh" > /tmp/common/bin/myscript
2652: # echo "echo Hello world" >> /tmp/common/bin/myscript
2653: # chmod 755 /tmp/common/bin/myscript
2654:
2655:
2656: Now create the images:
2657:
2658: # cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images
2659:
2660: Each image will contain README, COPYING, and bin/myscript in their root
2661: directories.
2662:
1.6 ! rillig 2663: Chapter 8. Directory layout of the installed files
1.1 dsieger 2664:
2665: Table of Contents
2666:
1.6 ! rillig 2667: 8.1. File system layout in ${LOCALBASE}
! 2668: 8.2. File system layout in ${VARBASE}
1.1 dsieger 2669:
2670: The files that are installed by pkgsrc are organized in a way that is similar
2671: to what you find in the /usr directory of the base system. But some details are
2672: different. This is because pkgsrc initially came from FreeBSD and had adopted
2673: its file system hierarchy. Later it was largely influenced by NetBSD. But no
2674: matter which operating system you are using pkgsrc with, you can expect the
2675: same layout for pkgsrc.
2676:
2677: There are mainly four root directories for pkgsrc, which are all configurable
2678: in the bootstrap/bootstrap script. When pkgsrc has been installed as root, the
2679: default locations are:
2680:
2681: LOCALBASE= /usr/pkg
2682: PKG_SYSCONFBASE= /usr/pkg/etc
2683: VARBASE= /var
2684: PKG_DBDIR= /var/db/pkg
2685:
2686: In unprivileged mode (when pkgsrc has been installed as any other user), the
2687: default locations are:
2688:
2689: LOCALBASE= ${HOME}/pkg
2690: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2691: VARBASE= ${HOME}/pkg/var
2692: PKG_DBDIR= ${HOME}/pkg/var/db/pkg
2693:
2694: What these four directories are for, and what they look like is explained
2695: below.
2696:
2697: * LOCALBASE corresponds to the /usr directory in the base system. It is the
2698: "main" directory where the files are installed and contains the well-known
2699: subdirectories like bin, include, lib, share and sbin.
2700:
2701: * VARBASE corresponds to /var in the base system. Some programs (especially
2702: games, network daemons) need write access to it during normal operation.
2703:
2704: * PKG_SYSCONFDIR corresponds to /etc in the base system. It contains
2705: configuration files of the packages, as well as pkgsrc's mk.conf itself.
2706:
1.6 ! rillig 2707: 8.1. File system layout in ${LOCALBASE}
1.1 dsieger 2708:
2709: The following directories exist in a typical pkgsrc installation in $
2710: {LOCALBASE}.
2711:
2712: bin
2713:
2714: Contains executable programs that are intended to be directly used by the
2715: end user.
2716:
2717: emul
2718:
2719: Contains files for the emulation layers of various other operating systems,
2720: especially for NetBSD.
2721:
2722: etc (the usual location of ${PKG_SYSCONFDIR})
2723:
2724: Contains the configuration files.
2725:
2726: include
2727:
2728: Contains headers for the C and C++ programming languages.
2729:
2730: info
2731:
2732: Contains GNU info files of various packages.
2733:
2734: lib
2735:
2736: Contains shared and static libraries.
2737:
2738: libdata
2739:
2740: Contains data files that don't change after installation. Other data files
2741: belong into ${VARBASE}.
2742:
2743: libexec
2744:
2745: Contains programs that are not intended to be used by end users, such as
2746: helper programs or network daemons.
2747:
2748: libexec/cgi-bin
2749:
2750: Contains programs that are intended to be executed as CGI scripts by a web
2751: server.
2752:
2753: man (the usual value of ${PKGMANDIR})
2754:
2755: Contains brief documentation in form of manual pages.
2756:
2757: sbin
2758:
2759: Contains programs that are intended to be used only by the super-user.
2760:
2761: share
2762:
2763: Contains platform-independent data files that don't change after
2764: installation.
2765:
2766: share/doc
2767:
2768: Contains documentation files provided by the packages.
2769:
2770: share/examples
2771:
2772: Contains example files provided by the packages. Among others, the original
2773: configuration files are saved here and copied to ${PKG_SYSCONFDIR} during
2774: installation.
2775:
2776: share/examples/rc.d
2777:
2778: Contains the original files for rc.d scripts.
2779:
2780: var (the usual location of ${VARBASE})
2781:
2782: Contains files that may be modified after installation.
2783:
1.6 ! rillig 2784: 8.2. File system layout in ${VARBASE}
1.1 dsieger 2785:
2786: db/pkg (the usual location of ${PKG_DBDIR})
2787:
2788: Contains information about the currently installed packages.
2789:
2790: games
2791:
2792: Contains highscore files.
2793:
2794: log
2795:
2796: Contains log files.
2797:
2798: run
2799:
2800: Contains informational files about daemons that are currently running.
2801:
1.6 ! rillig 2802: Chapter 9. Frequently Asked Questions
1.1 dsieger 2803:
2804: Table of Contents
2805:
1.6 ! rillig 2806: 9.1. Are there any mailing lists for pkg-related discussion?
! 2807: 9.2. Where's the pkgviews documentation?
! 2808: 9.3. Utilities for package management (pkgtools)
! 2809: 9.4. How to use pkgsrc as non-root
! 2810: 9.5. How to resume transfers when fetching distfiles?
! 2811: 9.6. How can I install/use modular X.org from pkgsrc?
! 2812: 9.7. How to fetch files from behind a firewall
! 2813: 9.8. How do I tell make fetch to do passive FTP?
! 2814: 9.9. How to fetch all distfiles at once
! 2815: 9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
! 2816: 9.11. What does "Could not find bsd.own.mk" mean?
! 2817: 9.12. Using 'sudo' with pkgsrc
! 2818: 9.13. How do I change the location of configuration files?
! 2819: 9.14. Automated security checks
! 2820: 9.15. Why do some packages ignore my CFLAGS?
! 2821: 9.16. A package does not build. What shall I do?
! 2822: 9.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.1 dsieger 2823: conflicts" mean?
2824:
2825: This section contains hints, tips & tricks on special things in pkgsrc that we
2826: didn't find a better place for in the previous chapters, and it contains items
2827: for both pkgsrc users and developers.
2828:
1.6 ! rillig 2829: 9.1. Are there any mailing lists for pkg-related discussion?
1.1 dsieger 2830:
2831: The following mailing lists may be of interest to pkgsrc users:
2832:
2833: * pkgsrc-users: This is a general purpose list for most issues regarding
2834: pkgsrc, regardless of platform, e.g. soliciting user help for pkgsrc
2835: configuration, unexpected build failures, using particular packages,
2836: upgrading pkgsrc installations, questions regarding the pkgsrc release
2837: branches, etc. General announcements or proposals for changes that impact
2838: the pkgsrc user community, e.g. major infrastructure changes, new features,
2839: package removals, etc., may also be posted.
2840:
2841: * pkgsrc-bulk: A list where the results of pkgsrc bulk builds are sent and
2842: discussed.
2843:
2844: * pkgsrc-changes: This list is for those who are interested in getting a
2845: commit message for every change committed to pkgsrc. It is also available
2846: in digest form, meaning one daily message containing all commit messages
2847: for changes to the package source tree in that 24 hour period.
2848:
2849: To subscribe, do:
2850:
2851: % echo subscribe listname | mail majordomo@NetBSD.org
2852:
2853: Archives for all these mailing lists are available from http://
2854: mail-index.NetBSD.org/.
2855:
1.6 ! rillig 2856: 9.2. Where's the pkgviews documentation?
1.1 dsieger 2857:
2858: Pkgviews is tightly integrated with buildlink. You can find a pkgviews User's
2859: guide in pkgsrc/mk/buildlink3/PKGVIEWS_UG.
2860:
1.6 ! rillig 2861: 9.3. Utilities for package management (pkgtools)
1.1 dsieger 2862:
2863: The directory pkgsrc/pkgtools contains a number of useful utilities for both
2864: users and developers of pkgsrc. This section attempts only to make the reader
2865: aware of the utilities and when they might be useful, and not to duplicate the
2866: documentation that comes with each package.
2867:
2868: Utilities used by pkgsrc (automatically installed when needed):
2869:
2870: * pkgtools/x11-links: Symlinks for use by buildlink.
2871:
2872: OS tool augmentation (automatically installed when needed):
2873:
2874: * pkgtools/digest: Calculates various kinds of checksums (including SHA1).
2875:
2876: * pkgtools/libnbcompat: Compatibility library for pkgsrc tools.
2877:
2878: * pkgtools/mtree: Installed on non-BSD systems due to lack of native mtree.
2879:
2880: * pkgtools/pkg_install: Up-to-date replacement for /usr/sbin/pkg_install, or
2881: for use on operating systems where pkg_install is not present.
2882:
2883: Utilities used by pkgsrc (not automatically installed):
2884:
2885: * pkgtools/pkg_tarup: Create a binary package from an already-installed
2886: package. Used by make replace to save the old package.
2887:
2888: * pkgtools/dfdisk: Adds extra functionality to pkgsrc, allowing it to fetch
2889: distfiles from multiple locations. It currently supports the following
2890: methods: multiple CD-ROMs and network FTP/HTTP connections.
2891:
2892: * pkgtools/xpkgwedge: Put X11 packages someplace else (enabled by default).
2893:
2894: * devel/cpuflags: Determine the best compiler flags to optimise code for your
2895: current CPU and compiler.
2896:
2897: Utilities for keeping track of installed packages, being up to date, etc:
2898:
2899: * pkgtools/pkg_chk: Reports on packages whose installed versions do not match
2900: the latest pkgsrc entries.
2901:
2902: * pkgtools/pkgdep: Makes dependency graphs of packages, to aid in choosing a
2903: strategy for updating.
2904:
2905: * pkgtools/pkgdepgraph: Makes graphs from the output of pkgtools/pkgdep (uses
2906: graphviz).
2907:
2908: * pkgtools/pkglint: The pkglint(1) program checks a pkgsrc entry for errors,
2909: lintpkgsrc(1) does various checks on the complete pkgsrc system.
2910:
2911: * pkgtools/pkgsurvey: Report what packages you have installed.
2912:
2913: Utilities for people maintaining or creating individual packages:
2914:
2915: * pkgtools/pkgdiff: Automate making and maintaining patches for a package
2916: (includes pkgdiff, pkgvi, mkpatches, etc.).
2917:
2918: * pkgtools/rpm2pkg, pkgtools/url2pkg: Aids in converting to pkgsrc.
2919:
2920: * pkgtools/gensolpkg: Convert pkgsrc to a Solaris package.
2921:
2922: Utilities for people maintaining pkgsrc (or: more obscure pkg utilities)
2923:
2924: * pkgtools/pkg_comp: Build packages in a chrooted area.
2925:
2926: * pkgtools/libkver: Spoof kernel version for chrooted cross builds.
2927:
1.6 ! rillig 2928: 9.4. How to use pkgsrc as non-root
1.1 dsieger 2929:
2930: If you want to use pkgsrc as non-root user, you can set some variables to make
2931: pkgsrc work under these conditions. At the very least, you need to set
2932: UNPRIVILEGED to "yes"; this will turn on unprivileged mode and set multiple
2933: related variables to allow installation of packages as non-root.
2934:
2935: In case the defaults are not enough, you may want to tune some other variables
2936: used. For example, if the automatic user/group detection leads to incorrect
2937: values (or not the ones you would like to use), you can change them by setting
2938: UNPRIVILEGED_USER and UNPRIVILEGED_GROUP respectively.
2939:
2940: As regards bootstrapping, please note that the bootstrap script will ease
2941: non-root configuration when given the "--ignore-user-check" flag, as it will
2942: choose and use multiple default directories under ~/pkg as the installation
2943: targets. These directories can be overridden by the "--prefix" flag provided by
2944: the script, as well as some others that allow finer tuning of the tree layout.
2945:
1.6 ! rillig 2946: 9.5. How to resume transfers when fetching distfiles?
1.1 dsieger 2947:
2948: By default, resuming transfers in pkgsrc is disabled, but you can enable this
1.4 rillig 2949: feature by adding the option PKG_RESUME_TRANSFERS=YES into mk.conf. If, during
2950: a fetch step, an incomplete distfile is found, pkgsrc will try to resume it.
1.1 dsieger 2951:
2952: You can also use a different program than the default ftp(1) by changing the
2953: FETCH_CMD variable. Don't forget to set FETCH_RESUME_ARGS and FETCH_OUTPUT_ARGS
2954: if you are not using default values.
2955:
2956: For example, if you want to use wget to resume downloads, you'll have to use
2957: something like:
2958:
2959: FETCH_CMD= wget
2960: FETCH_BEFORE_ARGS= --passive-ftp
2961: FETCH_RESUME_ARGS= -c
2962: FETCH_OUTPUT_ARGS= -O
2963:
1.6 ! rillig 2964: 9.6. How can I install/use modular X.org from pkgsrc?
1.1 dsieger 2965:
1.4 rillig 2966: If you want to use modular X.org from pkgsrc instead of your system's own X11
2967: (/usr/X11R6, /usr/openwin, ...) you will have to add the following line into
1.1 dsieger 2968: mk.conf:
2969:
1.4 rillig 2970: X11_TYPE=modular
1.1 dsieger 2971:
2972: Note
2973:
1.4 rillig 2974: The DragonFly operating system defaults to using modular X.org from pkgsrc.
1.1 dsieger 2975:
1.6 ! rillig 2976: 9.7. How to fetch files from behind a firewall
1.1 dsieger 2977:
2978: If you are sitting behind a firewall which does not allow direct connections to
2979: Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This
2980: is done using an environment variable in the form of a URL, e.g. in Amdahl, the
2981: machine "orpheus.amdahl.com" is one of the firewalls, and it uses port 80 as
2982: the proxy port number. So the proxy environment variables are:
2983:
2984: ftp_proxy=ftp://orpheus.amdahl.com:80/
2985: http_proxy=http://orpheus.amdahl.com:80/
2986:
1.6 ! rillig 2987: 9.8. How do I tell make fetch to do passive FTP?
1.1 dsieger 2988:
2989: This depends on which utility is used to retrieve distfiles. From bsd.pkg.mk,
2990: FETCH_CMD is assigned the first available command from the following list:
2991:
2992: * ${LOCALBASE}/bin/ftp
2993:
2994: * /usr/bin/ftp
2995:
2996: On a default NetBSD installation, this will be /usr/bin/ftp, which
2997: automatically tries passive connections first, and falls back to active
2998: connections if the server refuses to do passive. For the other tools, add the
1.4 rillig 2999: following to your mk.conf file: PASSIVE_FETCH=1.
1.1 dsieger 3000:
3001: Having that option present will prevent /usr/bin/ftp from falling back to
3002: active transfers.
3003:
1.6 ! rillig 3004: 9.9. How to fetch all distfiles at once
1.1 dsieger 3005:
3006: You would like to download all the distfiles in a single batch from work or
3007: university, where you can't run a make fetch. There is an archive of distfiles
3008: on ftp.NetBSD.org, but downloading the entire directory may not be appropriate.
3009:
3010: The answer here is to do a make fetch-list in /usr/pkgsrc or one of its
3011: subdirectories, carry the resulting list to your machine at work/school and use
3012: it there. If you don't have a NetBSD-compatible ftp(1) (like tnftp) at work,
3013: don't forget to set FETCH_CMD to something that fetches a URL:
3014:
3015: At home:
3016:
3017: % cd /usr/pkgsrc
3018: % make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh
3019: % scp /tmp/fetch.sh work:/tmp
3020:
3021: At work:
3022:
3023: % sh /tmp/fetch.sh
3024:
3025: then tar up /tmp/distfiles and take it home.
3026:
3027: If you have a machine running NetBSD, and you want to get all distfiles (even
3028: ones that aren't for your machine architecture), you can do so by using the
3029: above-mentioned make fetch-list approach, or fetch the distfiles directly by
3030: running:
3031:
3032: % make mirror-distfiles
3033:
3034: If you even decide to ignore NO_{SRC,BIN}_ON_{FTP,CDROM}, then you can get
3035: everything by running:
3036:
3037: % make fetch NO_SKIP=yes
3038:
1.6 ! rillig 3039: 9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
1.1 dsieger 3040:
3041: When compiling the pkgtools/pkg_install package, you get the error from make
3042: that it doesn't know how to make /usr/share/tmac/tmac.andoc? This indicates
3043: that you don't have installed the "text" set (nroff, ...) from the NetBSD base
3044: distribution on your machine. It is recommended to do that to format man pages.
3045:
3046: In the case of the pkgtools/pkg_install package, you can get away with setting
1.4 rillig 3047: NOMAN=YES either in the environment or in mk.conf.
1.1 dsieger 3048:
1.6 ! rillig 3049: 9.11. What does "Could not find bsd.own.mk" mean?
1.1 dsieger 3050:
3051: You didn't install the compiler set, comp.tgz, when you installed your NetBSD
3052: machine. Please get and install it, by extracting it in /:
3053:
3054: # cd /
3055: # tar --unlink -zxvpf .../comp.tgz
3056:
3057: comp.tgz is part of every NetBSD release. Get the one that corresponds to your
3058: release (determine via uname -r).
3059:
1.6 ! rillig 3060: 9.12. Using 'sudo' with pkgsrc
1.1 dsieger 3061:
3062: When installing packages as non-root user and using the just-in-time su(1)
3063: feature of pkgsrc, it can become annoying to type in the root password for each
3064: required package installed. To avoid this, the sudo package can be used, which
3065: does password caching over a limited time. To use it, install sudo (either as
1.4 rillig 3066: binary package or from security/sudo) and then put the following into your
3067: mk.conf, somewhere after the definition of the LOCALBASE variable:
1.1 dsieger 3068:
3069: .if exists(${LOCALBASE}/bin/sudo)
3070: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
3071: .endif
3072:
1.6 ! rillig 3073: 9.13. How do I change the location of configuration files?
1.1 dsieger 3074:
3075: As the system administrator, you can choose where configuration files are
3076: installed. The default settings make all these files go into ${PREFIX}/etc or
3077: some of its subdirectories; this may be suboptimal depending on your
3078: expectations (e.g., a read-only, NFS-exported PREFIX with a need of per-machine
3079: configuration of the provided packages).
3080:
3081: In order to change the defaults, you can modify the PKG_SYSCONFBASE variable
1.4 rillig 3082: (in mk.conf) to point to your preferred configuration directory; some common
3083: examples include /etc or /etc/pkg.
1.1 dsieger 3084:
3085: Furthermore, you can change this value on a per-package basis by setting the
3086: PKG_SYSCONFDIR.${PKG_SYSCONFVAR} variable. PKG_SYSCONFVAR's value usually
3087: matches the name of the package you would like to modify, that is, the contents
3088: of PKGBASE.
3089:
3090: Note that after changing these settings, you must rebuild and reinstall any
3091: affected packages.
3092:
1.6 ! rillig 3093: 9.14. Automated security checks
1.1 dsieger 3094:
3095: Please be aware that there can often be bugs in third-party software, and some
3096: of these bugs can leave a machine vulnerable to exploitation by attackers. In
3097: an effort to lessen the exposure, the NetBSD packages team maintains a database
3098: of known-exploits to packages which have at one time been included in pkgsrc.
3099: The database can be downloaded automatically, and a security audit of all
3100: packages installed on a system can take place. To do this, install the security
3101: /audit-packages package. It has two components:
3102:
3103: 1. download-vulnerability-list, an easy way to download a list of the security
3104: vulnerabilities information. This list is kept up to date by the NetBSD
3105: security officer and the NetBSD packages team, and is distributed from the
3106: NetBSD ftp server:
3107:
3108: ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities
3109:
3110: 2. audit-packages, an easy way to audit the current machine, checking each
3111: vulnerability which is known. If a vulnerable package is installed, it will
3112: be shown by output to stdout, including a description of the type of
3113: vulnerability, and a URL containing more information.
3114:
3115: Use of the security/audit-packages package is strongly recommended! After
3116: "audit-packages" is installed, please read the package's message, which you can
3117: get by running pkg_info -D audit-packages.
3118:
3119: If this package is installed, pkgsrc builds will use it to perform a security
3120: check before building any package. See Section 5.2, "Variables affecting the
3121: build process" for ways to control this check.
3122:
1.6 ! rillig 3123: 9.15. Why do some packages ignore my CFLAGS?
1.1 dsieger 3124:
3125: When you add your own preferences to the CFLAGS variable in your mk.conf, these
3126: flags are passed in environment variables to the ./configure scripts and to
3127: make(1). Some package authors ignore the CFLAGS from the environment variable
3128: by overriding them in the Makefiles of their package.
3129:
3130: Currently there is no solution to this problem. If you really need the package
3131: to use your CFLAGS you should run make patch in the package directory and then
3132: inspect any Makefile and Makefile.in for whether they define CFLAGS explicitly.
3133: Usually you can remove these lines. But be aware that some "smart" programmers
3134: write so bad code that it only works for the specific combination of CFLAGS
3135: they have chosen.
3136:
1.6 ! rillig 3137: 9.16. A package does not build. What shall I do?
1.1 dsieger 3138:
3139: 1. Make sure that your copy of pkgsrc is consistent. A case that occurs often
3140: is that people only update pkgsrc in parts, because of performance reasons.
3141: Since pkgsrc is one large system, not a collection of many small systems,
3142: there are sometimes changes that only work when the whole pkgsrc tree is
3143: updated.
3144:
3145: 2. Make sure that you don't have any CVS conflicts. Search for "<<<<<<" or
3146: ">>>>>>" in all your pkgsrc files.
3147:
3148: 3. Make sure that you don't have old copies of the packages extracted. Run
3149: make clean clean-depends to verify this.
3150:
3151: 4. If the problem still exists, write a mail to the pkgsrc-users mailing list.
3152:
1.6 ! rillig 3153: 9.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.1 dsieger 3154: conflicts" mean?
3155:
3156: You have modified a file from pkgsrc, and someone else has modified that same
3157: file afterwards in the CVS repository. Both changes are in the same region of
3158: the file, so when you updated pkgsrc, the cvs command marked the conflicting
3159: changes in the file. Because of these markers, the file is no longer a valid
3160: Makefile.
3161:
3162: Have a look at that file, and if you don't need your local changes anymore, you
3163: can remove that file and run cvs -q update -dP in that directory to download
3164: the current version.
3165:
3166: Part II. The pkgsrc developer's guide
3167:
3168: This part of the book deals with creating and modifying packages. It starts
3169: with a "HOWTO"-like guide on creating a new package. The remaining chapters are
3170: more like a reference manual for pkgsrc.
3171:
3172: Table of Contents
3173:
1.6 ! rillig 3174: 10. Creating a new pkgsrc package from scratch
1.1 dsieger 3175:
1.6 ! rillig 3176: 10.1. Common types of packages
1.1 dsieger 3177:
1.6 ! rillig 3178: 10.1.1. Perl modules
! 3179: 10.1.2. KDE applications
1.1 dsieger 3180:
1.6 ! rillig 3181: 10.2. Examples
1.1 dsieger 3182:
1.6 ! rillig 3183: 10.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 3184:
1.6 ! rillig 3185: 11. Package components - files, directories and contents
1.1 dsieger 3186:
1.6 ! rillig 3187: 11.1. Makefile
! 3188: 11.2. distinfo
! 3189: 11.3. patches/*
1.1 dsieger 3190:
1.6 ! rillig 3191: 11.3.1. Structure of a single patch file
! 3192: 11.3.2. Creating patch files
! 3193: 11.3.3. Sources where the patch files come from
! 3194: 11.3.4. Patching guidelines
! 3195: 11.3.5. Feedback to the author
1.1 dsieger 3196:
1.6 ! rillig 3197: 11.4. Other mandatory files
! 3198: 11.5. Optional files
1.1 dsieger 3199:
1.6 ! rillig 3200: 11.5.1. Files affecting the binary package
! 3201: 11.5.2. Files affecting the build process
! 3202: 11.5.3. Files affecting nothing at all
1.1 dsieger 3203:
1.6 ! rillig 3204: 11.6. work*
! 3205: 11.7. files/*
1.1 dsieger 3206:
1.6 ! rillig 3207: 12. Programming in Makefiles
1.1 dsieger 3208:
1.6 ! rillig 3209: 12.1. Caveats
! 3210: 12.2. Makefile variables
1.1 dsieger 3211:
1.6 ! rillig 3212: 12.2.1. Naming conventions
1.1 dsieger 3213:
1.6 ! rillig 3214: 12.3. Code snippets
1.1 dsieger 3215:
1.6 ! rillig 3216: 12.3.1. Adding things to a list
! 3217: 12.3.2. Converting an internal list into an external list
! 3218: 12.3.3. Passing variables to a shell command
! 3219: 12.3.4. Quoting guideline
! 3220: 12.3.5. Workaround for a bug in BSD Make
1.1 dsieger 3221:
1.6 ! rillig 3222: 13. PLIST issues
1.1 dsieger 3223:
1.6 ! rillig 3224: 13.1. RCS ID
! 3225: 13.2. Semi-automatic PLIST generation
! 3226: 13.3. Tweaking output of make print-PLIST
! 3227: 13.4. Variable substitution in PLIST
! 3228: 13.5. Man page compression
! 3229: 13.6. Changing PLIST source with PLIST_SRC
! 3230: 13.7. Platform-specific and differing PLISTs
! 3231: 13.8. Sharing directories between packages
1.1 dsieger 3232:
1.6 ! rillig 3233: 14. Buildlink methodology
1.1 dsieger 3234:
1.6 ! rillig 3235: 14.1. Converting packages to use buildlink3
! 3236: 14.2. Writing buildlink3.mk files
1.1 dsieger 3237:
1.6 ! rillig 3238: 14.2.1. Anatomy of a buildlink3.mk file
! 3239: 14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files
1.1 dsieger 3240:
1.6 ! rillig 3241: 14.3. Writing builtin.mk files
1.1 dsieger 3242:
1.6 ! rillig 3243: 14.3.1. Anatomy of a builtin.mk file
! 3244: 14.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 3245:
1.6 ! rillig 3246: 15. The pkginstall framework
1.1 dsieger 3247:
1.6 ! rillig 3248: 15.1. Files and directories outside the installation prefix
1.1 dsieger 3249:
1.6 ! rillig 3250: 15.1.1. Directory manipulation
! 3251: 15.1.2. File manipulation
1.1 dsieger 3252:
1.6 ! rillig 3253: 15.2. Configuration files
1.1 dsieger 3254:
1.6 ! rillig 3255: 15.2.1. How PKG_SYSCONFDIR is set
! 3256: 15.2.2. Telling the software where configuration files are
! 3257: 15.2.3. Patching installations
! 3258: 15.2.4. Disabling handling of configuration files
1.1 dsieger 3259:
1.6 ! rillig 3260: 15.3. System startup scripts
1.1 dsieger 3261:
1.6 ! rillig 3262: 15.3.1. Disabling handling of system startup scripts
1.1 dsieger 3263:
1.6 ! rillig 3264: 15.4. System users and groups
! 3265: 15.5. System shells
1.1 dsieger 3266:
1.6 ! rillig 3267: 15.5.1. Disabling shell registration
1.1 dsieger 3268:
1.6 ! rillig 3269: 15.6. Fonts
1.1 dsieger 3270:
1.6 ! rillig 3271: 15.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 3272:
1.6 ! rillig 3273: 16. Options handling
1.1 dsieger 3274:
1.6 ! rillig 3275: 16.1. Global default options
! 3276: 16.2. Converting packages to use bsd.options.mk
! 3277: 16.3. Option Names
1.1 dsieger 3278:
1.6 ! rillig 3279: 17. The build process
1.1 dsieger 3280:
1.6 ! rillig 3281: 17.1. Introduction
! 3282: 17.2. Program location
! 3283: 17.3. Directories used during the build process
! 3284: 17.4. Running a phase
! 3285: 17.5. The fetch phase
1.1 dsieger 3286:
1.6 ! rillig 3287: 17.5.1. What to fetch and where to get it from
! 3288: 17.5.2. How are the files fetched?
1.1 dsieger 3289:
1.6 ! rillig 3290: 17.6. The checksum phase
! 3291: 17.7. The extract phase
! 3292: 17.8. The patch phase
! 3293: 17.9. The tools phase
! 3294: 17.10. The wrapper phase
! 3295: 17.11. The configure phase
! 3296: 17.12. The build phase
! 3297: 17.13. The test phase
! 3298: 17.14. The install phase
! 3299: 17.15. The package phase
! 3300: 17.16. Cleaning up
! 3301: 17.17. Other helpful targets
1.1 dsieger 3302:
1.6 ! rillig 3303: 18. Tools needed for building or running
1.1 dsieger 3304:
1.6 ! rillig 3305: 18.1. Tools for pkgsrc builds
! 3306: 18.2. Tools needed by packages
! 3307: 18.3. Tools provided by platforms
! 3308: 18.4. Questions regarding the tools
1.1 dsieger 3309:
1.6 ! rillig 3310: 19. Making your package work
1.1 dsieger 3311:
1.6 ! rillig 3312: 19.1. General operation
1.1 dsieger 3313:
1.6 ! rillig 3314: 19.1.1. Portability of packages
! 3315: 19.1.2. How to pull in user-settable variables from mk.conf
! 3316: 19.1.3. User interaction
! 3317: 19.1.4. Handling licenses
! 3318: 19.1.5. Restricted packages
! 3319: 19.1.6. Handling dependencies
! 3320: 19.1.7. Handling conflicts with other packages
! 3321: 19.1.8. Packages that cannot or should not be built
! 3322: 19.1.9. Packages which should not be deleted, once installed
! 3323: 19.1.10. Handling packages with security problems
! 3324: 19.1.11. How to handle incrementing versions when fixing an existing
1.1 dsieger 3325: package
1.6 ! rillig 3326: 19.1.12. Substituting variable text in the package files (the SUBST
1.1 dsieger 3327: framework)
3328:
1.6 ! rillig 3329: 19.2. Fixing problems in the fetch phase
1.1 dsieger 3330:
1.6 ! rillig 3331: 19.2.1. Packages whose distfiles aren't available for plain downloading
! 3332: 19.2.2. How to handle modified distfiles with the 'old' name
1.1 dsieger 3333:
1.6 ! rillig 3334: 19.3. Fixing problems in the configure phase
1.1 dsieger 3335:
1.6 ! rillig 3336: 19.3.1. Shared libraries - libtool
! 3337: 19.3.2. Using libtool on GNU packages that already support libtool
! 3338: 19.3.3. GNU Autoconf/Automake
! 3339:
! 3340: 19.4. Programming languages
! 3341:
! 3342: 19.4.1. C, C++, and Fortran
! 3343: 19.4.2. Java
! 3344: 19.4.3. Packages containing perl scripts
! 3345: 19.4.4. Other programming languages
! 3346:
! 3347: 19.5. Fixing problems in the build phase
! 3348:
! 3349: 19.5.1. Compiling C and C++ code conditionally
! 3350: 19.5.2. How to handle compiler bugs
! 3351: 19.5.3. Undefined reference to "..."
! 3352: 19.5.4. Running out of memory
! 3353:
! 3354: 19.6. Fixing problems in the install phase
! 3355:
! 3356: 19.6.1. Creating needed directories
! 3357: 19.6.2. Where to install documentation
! 3358: 19.6.3. Installing highscore files
! 3359: 19.6.4. Adding DESTDIR support to packages
! 3360: 19.6.5. Packages with hardcoded paths to other interpreters
! 3361: 19.6.6. Packages installing perl modules
! 3362: 19.6.7. Packages installing info files
! 3363: 19.6.8. Packages installing man pages
! 3364: 19.6.9. Packages installing GConf2 data files
! 3365: 19.6.10. Packages installing scrollkeeper data files
! 3366: 19.6.11. Packages installing X11 fonts
! 3367: 19.6.12. Packages installing GTK2 modules
! 3368: 19.6.13. Packages installing SGML or XML data
! 3369: 19.6.14. Packages installing extensions to the MIME database
! 3370: 19.6.15. Packages using intltool
! 3371: 19.6.16. Packages installing startup scripts
! 3372: 19.6.17. Packages installing TeX modules
! 3373: 19.6.18. Packages supporting running binaries in emulation
! 3374: 19.6.19. Packages installing hicolor theme icons
! 3375: 19.6.20. Packages installing desktop files
! 3376:
! 3377: 19.7. Marking packages as having problems
! 3378:
! 3379: 20. Debugging
! 3380: 21. Submitting and Committing
! 3381:
! 3382: 21.1. Submitting binary packages
! 3383: 21.2. Submitting source packages (for non-NetBSD-developers)
! 3384: 21.3. General notes when adding, updating, or removing packages
! 3385: 21.4. Committing: Importing a package into CVS
! 3386: 21.5. Updating a package to a newer version
! 3387: 21.6. Moving a package in pkgsrc
! 3388:
! 3389: 22. Frequently Asked Questions
! 3390: 23. GNOME packaging and porting
! 3391:
! 3392: 23.1. Meta packages
! 3393: 23.2. Packaging a GNOME application
! 3394: 23.3. Updating GNOME to a newer version
! 3395: 23.4. Patching guidelines
1.1 dsieger 3396:
1.6 ! rillig 3397: Chapter 10. Creating a new pkgsrc package from scratch
1.1 dsieger 3398:
3399: Table of Contents
3400:
1.6 ! rillig 3401: 10.1. Common types of packages
1.1 dsieger 3402:
1.6 ! rillig 3403: 10.1.1. Perl modules
! 3404: 10.1.2. KDE applications
1.1 dsieger 3405:
1.6 ! rillig 3406: 10.2. Examples
1.1 dsieger 3407:
1.6 ! rillig 3408: 10.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 3409:
3410: When you find a package that is not yet in pkgsrc, you most likely have a URL
3411: from where you can download the source code. Starting with this URL, creating a
3412: package involves only a few steps.
3413:
3414: 1. First, install the packages pkgtools/url2pkg and pkgtools/pkglint.
3415:
3416: 2. Then, choose one of the top-level directories as the category in which you
3417: want to place your package. You can also create a directory of your own
3418: (maybe called local). In that category directory, create another directory
3419: for your package and change into it.
3420:
3421: 3. Run the program url2pkg, which will ask you for a URL. Enter the URL of the
3422: distribution file (in most cases a .tar.gz file) and watch how the basic
3423: ingredients of your package are created automatically. The distribution
3424: file is extracted automatically to fill in some details in the Makefile
3425: that would otherwise have to be done manually.
3426:
3427: 4. Examine the extracted files to determine the dependencies of your package.
3428: Ideally, this is mentioned in some README file, but things may differ. For
3429: each of these dependencies, look where it exists in pkgsrc, and if there is
3430: a file called buildlink3.mk in that directory, add a line to your package
3431: Makefile which includes that file just before the last line. If the
3432: buildlink3.mk file does not exist, add a DEPENDS line to the Makefile,
3433: which specifies the version of the dependency and where it can be found in
3434: pkgsrc. This line should be placed in the third paragraph. If the
3435: dependency is only needed for building the package, but not when using it,
3436: use BUILD_DEPENDS instead of DEPENDS. Your package may then look like this:
3437:
3438: [...]
3439:
3440: BUILD_DEPENDS+= lua>=5.0:../../lang/lua
3441: DEPENDS+= screen-[0-9]*:../../misc/screen
3442: DEPENDS+= screen>=4.0:../../misc/screen
3443:
3444: [...]
3445:
3446: .include "../../category/package/buildlink3.mk"
3447: .include "../../devel/glib2/buildlink3.mk"
3448: .include "../../mk/bsd.pkg.mk"
3449:
3450: 5. Run pkglint to see what things still need to be done to make your package a
3451: "good" one. If you don't know what pkglint's warnings want to tell you, try
3452: pkglint --explain or pkglint -e, which outputs additional explanations.
3453:
3454: 6. In many cases the package is not yet ready to build. You can find
1.6 ! rillig 3455: instructions for the most common cases in the next section, Section 10.1,
1.1 dsieger 3456: "Common types of packages". After you have followed the instructions over
3457: there, you can hopefully continue here.
3458:
3459: 7. Run bmake clean to clean the working directory from the extracted files.
3460: Besides these files, a lot of cache files and other system information has
3461: been saved in the working directory, which may become wrong after you
3462: edited the Makefile.
3463:
3464: 8. Now, run bmake to build the package. For the various things that can go
1.6 ! rillig 3465: wrong in this phase, consult Chapter 19, Making your package work.
1.1 dsieger 3466:
3467: 9. When the package builds fine, the next step is to install the package. Run
3468: bmake install and hope that everything works.
3469:
3470: 10. Up to now, the file PLIST, which contains a list of the files that are
3471: installed by the package, is nearly empty. Run bmake print-PLIST >PLIST to
3472: generate a probably correct list. Check the file using your preferred text
3473: editor to see if the list of files looks plausible.
3474:
3475: 11. Run pkglint again to see if the generated PLIST contains garbage or not.
3476:
3477: 12. When you ran bmake install, the package has been registered in the database
3478: of installed files, but with an empty list of files. To fix this, run bmake
3479: deinstall and bmake install again. Now the package is registered with the
3480: list of files from PLIST.
3481:
3482: 13. Run bmake package to create a binary package from the set of installed
3483: files.
3484:
1.6 ! rillig 3485: 10.1. Common types of packages
1.1 dsieger 3486:
1.6 ! rillig 3487: 10.1.1. Perl modules
1.1 dsieger 3488:
3489: Simple Perl modules are handled automatically by url2pkg, including
3490: dependencies.
3491:
1.6 ! rillig 3492: 10.1.2. KDE applications
1.1 dsieger 3493:
3494: KDE applications should always include meta-pkgs/kde3/kde3.mk, which contains
3495: numerous settings that are typical of KDE packages.
3496:
1.6 ! rillig 3497: 10.2. Examples
1.1 dsieger 3498:
1.6 ! rillig 3499: 10.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 3500:
1.6 ! rillig 3501: 10.2.1.1. The initial package
1.1 dsieger 3502:
3503: Looking at the file pkgsrc/doc/TODO, I saw that the "nvu" package has not yet
3504: been imported into pkgsrc. As the description says it has to do with the web,
3505: the obvious choice for the category is "www".
3506:
3507: $ mkdir www/nvu
3508: $ cd www/nvu
3509:
3510: The web site says that the sources are available as a tar file, so I fed that
3511: URL to the url2pkg program:
3512:
3513: $ url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3514:
3515: My editor popped up, and I added a PKGNAME line below the DISTNAME line, as the
3516: package name should not have the word "sources" in it. I also filled in the
3517: MAINTAINER, HOMEPAGE and COMMENT fields. Then the package Makefile looked like
3518: that:
3519:
1.2 rillig 3520: # $NetBSD$
1.1 dsieger 3521: #
3522:
3523: DISTNAME= nvu-1.0-sources
3524: PKGNAME= nvu-1.0
3525: CATEGORIES= www
3526: MASTER_SITES= http://cvs.nvu.com/download/
3527: EXTRACT_SUFX= .tar.bz2
3528:
3529: MAINTAINER= rillig@NetBSD.org
3530: HOMEPAGE= http://cvs.nvu.com/
3531: COMMENT= Web Authoring System
3532:
3533: # url2pkg-marker (please do not remove this line.)
3534: .include "../../mk/bsd.pkg.mk"
3535:
3536: Then, I quit the editor and watched pkgsrc downloading a large source archive:
3537:
3538: url2pkg> Running "make makesum" ...
3539: => Required installed package digest>=20010302: digest-20060826 found
3540: => Fetching nvu-1.0-sources.tar.bz2
3541: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
3542: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
3543: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
3544: url2pkg> Running "make extract" ...
3545: => Required installed package digest>=20010302: digest-20060826 found
3546: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3547: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3548: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
3549: ===> Installing dependencies for nvu-1.0
3550: ===> Overriding tools for nvu-1.0
3551: ===> Extracting for nvu-1.0
3552: url2pkg> Adjusting the Makefile.
3553:
3554: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
3555:
3556: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
3557:
1.6 ! rillig 3558: 10.2.1.2. Fixing all kinds of problems to make the package work
1.1 dsieger 3559:
3560: Now that the package has been extracted, let's see what's inside it. The
3561: package has a README.txt, but that only says something about mozilla, so it's
3562: probably useless for seeing what dependencies this package has. But since there
3563: is a GNU configure script in the package, let's hope that it will complain
3564: about everything it needs.
3565:
3566: $ bmake
3567: => Required installed package digest>=20010302: digest-20060826 found
3568: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
3569: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
3570: ===> Patching for nvu-1.0
3571: ===> Creating toolchain wrappers for nvu-1.0
3572: ===> Configuring for nvu-1.0
3573: [...]
3574: configure: error: Perl 5.004 or higher is required.
3575: [...]
3576: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
3577: [...]
3578:
3579: That worked quite well. So I opened the package Makefile in my editor, and
3580: since it already has a USE_TOOLS line, I just appended "perl" to it. Since the
3581: dependencies of the package have changed now, and since a perl wrapper is
3582: automatically installed in the "tools" phase, I need to build the package from
3583: scratch.
3584:
3585: $ bmake clean
3586: ===> Cleaning for nvu-1.0
3587: $ bmake
3588: [...]
3589: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
3590: GNU Make. You will not be able to build Mozilla without GNU Make.
3591: [...]
3592:
3593: So I added "gmake" to the USE_TOOLS line and tried again (from scratch).
3594:
3595: [...]
3596: checking for GTK - version >= 1.2.0... no
3597: *** Could not run GTK test program, checking why...
3598: [...]
3599:
3600: Now to the other dependencies. The first question is: Where is the GTK package
3601: hidden in pkgsrc?
3602:
3603: $ echo ../../*/gtk*
3604: [many packages ...]
3605: $ echo ../../*/gtk
3606: ../../x11/gtk
3607: $ echo ../../*/gtk2
3608: ../../x11/gtk2
3609: $ echo ../../*/gtk2/bui*
3610: ../../x11/gtk2/buildlink3.mk
3611:
3612: The first try was definitely too broad. The second one had exactly one result,
3613: which is very good. But there is one pitfall with GNOME packages. Before GNOME
3614: 2 had been released, there were already many GNOME 1 packages in pkgsrc. To be
3615: able to continue to use these packages, the GNOME 2 packages were imported as
3616: separate packages, and their names usually have a "2" appended. So I checked
3617: whether this was the case here, and indeed it was.
3618:
3619: Since the GTK2 package has a buildlink3.mk file, adding the dependency is very
3620: easy. I just inserted an .include line before the last line of the package
3621: Makefile, so that it now looks like this:
3622:
3623: [...]
3624: .include "../../x11/gtk2/buildlink3.mk"
3625: .include "../../mk/bsd.pkg.mk
3626:
3627: After another bmake clean && bmake, the answer was:
3628:
3629: [...]
3630: checking for gtk-config... /home/roland/pkg/bin/gtk-config
3631: checking for GTK - version >= 1.2.0... no
3632: *** Could not run GTK test program, checking why...
3633: *** The test program failed to compile or link. See the file config.log for the
3634: *** exact error that occured. This usually means GTK was incorrectly installed
3635: *** or that you have moved GTK since it was installed. In the latter case, you
3636: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
3637: configure: error: Test for GTK failed.
3638: [...]
3639:
3640: In this particular case, the assumption that "every package prefers GNOME 2"
3641: had been wrong. The first of the lines above told me that this package really
3642: wanted to have the GNOME 1 version of GTK. If the package had looked for GTK2,
3643: it would have looked for pkg-config instead of gtk-config. So I changed the x11
3644: /gtk2 to x11/gtk in the package Makefile, and tried again.
3645:
3646: [...]
3647: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" -I../../../dist/include/xpcom -I../../../dist/include -I/tmp/roland/pkgsrc/www/nvu/work.bacc/mozilla/dist/include/nspr -I/usr/X11R6/include -fPIC -DPIC -I/home/roland/pkg/include -I/usr/include -I/usr/X11R6/include -Wall -W -Wno-unused -Wpointer-arith -Wcast-align -Wno-long-long -pedantic -O2 -I/home/roland/pkg/include -I/usr/include -Dunix -pthread -pipe -DDEBUG -D_DEBUG -DDEBUG_roland -DTRACING -g -I/home/roland/pkg/include/glib/glib-1.2 -I/home/roland/pkg/lib/glib/include -I/usr/pkg/include/orbit-1.0 -I/home/roland/pkg/include -I/usr/include -I/usr/X11R6/include -include ../../../mozilla-config.h -DMOZILLA_CLIENT -Wp,-MD,.deps/xpidl.pp xpidl.c
3648: In file included from xpidl.c:42:
3649: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
3650: In file included from xpidl.c:42:
3651: xpidl.h:132: error: parse error before "IDL_ns"
3652: [...]
3653:
3654: The package still does not find all of its dependencies. Now the question is:
3655: Which package provides the libIDL/IDL.h header file?
3656:
3657: $ echo ../../*/*idl*
3658: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
3659: $ echo ../../*/*IDL*
3660: ../../net/libIDL
3661:
3662: Let's take the one from the second try. So I included the ../../net/libIDL/
3663: buildlink3.mk file and tried again. But the error didn't change. After digging
3664: through some of the code, I concluded that the build process of the package was
3665: broken and couldn't have ever worked, but since the Mozilla source tree is
3666: quite large, I didn't want to fix it. So I added the following to the package
3667: Makefile and tried again:
3668:
3669: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
3670: BUILDLINK_TRANSFORM+= -l:IDL:IDL-2
3671:
3672: The latter line is needed because the package expects the library libIDL.so,
3673: but only libIDL-2.so is available. So I told the compiler wrapper to rewrite
3674: that on the fly.
3675:
3676: The next problem was related to a recent change of the FreeType interface. I
3677: looked up in www/seamonkey which patch files were relevant for this issue and
3678: copied them to the patches directory. Then I retried, fixed the patches so that
3679: they applied cleanly and retried again. This time, everything worked.
3680:
1.6 ! rillig 3681: 10.2.1.3. Installing the package
1.1 dsieger 3682:
3683: $ bmake CHECK_FILES=no install
3684: [...]
3685: $ bmake print-PLIST >PLIST
3686: $ bmake deinstall
3687: $ bmake install
3688:
1.6 ! rillig 3689: Chapter 11. Package components - files, directories and contents
1.1 dsieger 3690:
3691: Table of Contents
3692:
1.6 ! rillig 3693: 11.1. Makefile
! 3694: 11.2. distinfo
! 3695: 11.3. patches/*
! 3696:
! 3697: 11.3.1. Structure of a single patch file
! 3698: 11.3.2. Creating patch files
! 3699: 11.3.3. Sources where the patch files come from
! 3700: 11.3.4. Patching guidelines
! 3701: 11.3.5. Feedback to the author
! 3702:
! 3703: 11.4. Other mandatory files
! 3704: 11.5. Optional files
! 3705:
! 3706: 11.5.1. Files affecting the binary package
! 3707: 11.5.2. Files affecting the build process
! 3708: 11.5.3. Files affecting nothing at all
1.1 dsieger 3709:
1.6 ! rillig 3710: 11.6. work*
! 3711: 11.7. files/*
1.1 dsieger 3712:
3713: Whenever you're preparing a package, there are a number of files involved which
3714: are described in the following sections.
3715:
1.6 ! rillig 3716: 11.1. Makefile
1.1 dsieger 3717:
3718: Building, installation and creation of a binary package are all controlled by
3719: the package's Makefile. The Makefile describes various things about a package,
3720: for example from where to get it, how to configure, build, and install it.
3721:
3722: A package Makefile contains several sections that describe the package.
3723:
3724: In the first section there are the following variables, which should appear
3725: exactly in the order given here. The order and grouping of the variables is
3726: mostly historical and has no further meaning.
3727:
3728: * DISTNAME is the basename of the distribution file to be downloaded from the
3729: package's website.
3730:
3731: * PKGNAME is the name of the package, as used by pkgsrc. You only need to
3732: provide it if DISTNAME (which is the default) is not a good name for the
3733: package in pkgsrc. Usually it is the pkgsrc directory name together with
3734: the version number. It must match the regular expression ^[A-Za-z0-9]
3735: [A-Za-z0-9-_.+]*$, that is, it starts with a letter or digit, and contains
3736: only letters, digits, dashes, underscores, dots and plus signs.
3737:
3738: * SVR4_PKGNAME is the name of the package file to create if the PKGNAME isn't
3739: unique on a SVR4 system. The default is PKGNAME, which may be shortened
3740: when you use pkgtools/gensolpkg. Only add SVR4_PKGNAME if PKGNAME does not
3741: produce an unique package name on a SVR4 system. The length of SVR4_PKGNAME
3742: is limited to 5 characters.
3743:
3744: * CATEGORIES is a list of categories which the package fits in. You can
3745: choose any of the top-level directories of pkgsrc for it.
3746:
3747: Currently the following values are available for CATEGORIES. If more than
3748: one is used, they need to be separated by spaces:
3749:
3750: archivers cross geography meta-pkgs security
3751: audio databases graphics misc shells
3752: benchmarks devel ham multimedia sysutils
3753: biology editors inputmethod net textproc
3754: cad emulators lang news time
3755: chat finance mail parallel wm
3756: comms fonts math pkgtools www
3757: converters games mbone print x11
3758:
3759: * MASTER_SITES, DYNAMIC_MASTER_SITES, DIST_SUBDIR, EXTRACT_SUFX and DISTFILES
1.6 ! rillig 3760: are discussed in detail in Section 17.5, "The fetch phase".
1.1 dsieger 3761:
3762: The second section contains information about separately downloaded patches, if
3763: any.
3764:
3765: * PATCHFILES: Name(s) of additional files that contain distribution patches.
3766: There is no default. pkgsrc will look for them at PATCH_SITES. They will
3767: automatically be uncompressed before patching if the names end with .gz or
3768: .Z.
3769:
3770: * PATCH_SITES: Primary location(s) for distribution patch files (see
3771: PATCHFILES below) if not found locally.
3772:
3773: The third section contains the following variables.
3774:
3775: * MAINTAINER is the email address of the person who feels responsible for
3776: this package, and who is most likely to look at problems or questions
3777: regarding this package which have been reported with send-pr(1). Other
3778: developers should contact the MAINTAINER before making major changes to the
3779: package. When packaging a new program, set MAINTAINER to yourself. If you
3780: really can't maintain the package for future updates, set it to <
3781: pkgsrc-users@NetBSD.org>.
3782:
3783: * HOMEPAGE is a URL where users can find more information about the package.
3784:
3785: * COMMENT is a one-line description of the package (should not include the
3786: package name).
3787:
3788: Other variables that affect the build:
3789:
3790: * WRKSRC: The directory where the interesting distribution files of the
3791: package are found. The default is ${WRKDIR}/${DISTNAME}, which works for
3792: most packages.
3793:
3794: If a package doesn't create a subdirectory for itself (most GNU software
3795: does, for instance), but extracts itself in the current directory, you
3796: should set WRKSRC=${WRKDIR}.
3797:
3798: If a package doesn't create a subdirectory with the name of DISTNAME but
3799: some different name, set WRKSRC to point to the proper name in ${WRKDIR},
3800: for example WRKSRC=${WRKDIR}/${DISTNAME}/unix. See lang/tcl and x11/tk for
3801: other examples.
3802:
3803: The name of the working directory created by pkgsrc is taken from the
3804: WRKDIR_BASENAME variable. By default, its value is work. If you want to use
3805: the same pkgsrc tree for building different kinds of binary packages, you
3806: can change the variable according to your needs. Two other variables handle
3807: common cases of setting WRKDIR_BASENAME individually. If OBJHOSTNAME is
1.4 rillig 3808: defined in mk.conf, the first component of the host's name is attached to
3809: the directory name. If OBJMACHINE is defined, the platform name is
1.1 dsieger 3810: attached, which might look like work.i386 or work.sparc.
3811:
3812: Please pay attention to the following gotchas:
3813:
3814: * Add MANCOMPRESSED if man pages are installed in compressed form by the
3815: package. For packages using BSD-style makefiles which honor MANZ, there is
3816: MANCOMPRESSED_IF_MANZ.
3817:
3818: * Replace /usr/local with "${PREFIX}" in all files (see patches, below).
3819:
1.6 ! rillig 3820: * If the package installs any info files, see Section 19.6.7, "Packages
1.1 dsieger 3821: installing info files".
3822:
1.6 ! rillig 3823: 11.2. distinfo
1.1 dsieger 3824:
3825: The distinfo file contains the message digest, or checksum, of each distfile
3826: needed for the package. This ensures that the distfiles retrieved from the
3827: Internet have not been corrupted during transfer or altered by a malign force
3828: to introduce a security hole. Due to recent rumor about weaknesses of digest
3829: algorithms, all distfiles are protected using both SHA1 and RMD160 message
3830: digests, as well as the file size.
3831:
3832: The distinfo file also contains the checksums for all the patches found in the
1.6 ! rillig 3833: patches directory (see Section 11.3, "patches/*").
1.1 dsieger 3834:
3835: To regenerate the distinfo file, use the make makedistinfo or make mdi command.
3836:
3837: Some packages have different sets of distfiles depending on the platform, for
3838: example www/navigator). These are kept in the same distinfo file and care
3839: should be taken when upgrading such a package to ensure distfile information is
3840: not lost.
3841:
1.6 ! rillig 3842: 11.3. patches/*
1.1 dsieger 3843:
3844: Many packages still don't work out-of-the box on the various platforms that are
3845: supported by pkgsrc. Therefore, a number of custom patch files are needed to
3846: make the package work. These patch files are found in the patches/ directory.
3847:
3848: In the patch phase, these patches are applied to the files in WRKSRC directory
3849: after extracting them, in alphabetic order, so patch-aa is applied before
3850: patch-ab, etc.
3851:
1.6 ! rillig 3852: 11.3.1. Structure of a single patch file
1.1 dsieger 3853:
3854: The patch-* files should be in diff -bu format, and apply without a fuzz to
3855: avoid problems. (To force patches to apply with fuzz you can set
3856: PATCH_FUZZ_FACTOR=-F2). Furthermore, each patch should contain only changes for
3857: a single file, and no file should be patched by more than one patch file. This
3858: helps to keep future modifications simple.
3859:
3860: Each patch file is structured as follows: In the first line, there is the RCS
3861: Id of the patch itself. The second line should be empty for aesthetic reasons.
3862: After that, there should be a comment for each change that the patch does.
3863: There are a number of standard cases:
3864:
3865: * Patches that replace the == operator for test(1) with = in shell scripts
3866: should contain a reference to , to avoid redundant explanations.
3867:
3868: * Patches for commonly known vulnerabilities should mention the vulnerability
3869: ID (CAN, CVE).
3870:
3871: * Patches that change source code should mention the platform and other
3872: environment (for example, the compiler) that the patch is needed for.
3873:
3874: In all other cases, the patch should be commented so that any developer who
3875: knows the code of the application can make some use of the patch. Special care
3876: should be taken for the upstream developers, since we generally want that they
3877: accept our patches, so we have less work in the future.
3878:
1.6 ! rillig 3879: 11.3.2. Creating patch files
1.1 dsieger 3880:
3881: One important thing to mention is to pay attention that no RCS IDs get stored
3882: in the patch files, as these will cause problems when later checked into the
3883: NetBSD CVS tree. Use the pkgdiff command from the pkgtools/pkgdiff package to
3884: avoid these problems.
3885:
3886: For even more automation, we recommend using mkpatches from the same package to
3887: make a whole set of patches. You just have to backup files before you edit them
3888: to filename.orig, e.g. with cp -p filename filename.orig or, easier, by using
3889: pkgvi again from the same package. If you upgrade a package this way, you can
3890: easily compare the new set of patches with the previously existing one with
3891: patchdiff. Copy the patches you want to use or update from the work/.newpatches
3892: directory to patches/.
3893:
3894: When you have finished a package, remember to generate the checksums for the
1.6 ! rillig 3895: patch files by using the make makepatchsum command, see Section 11.2,
1.1 dsieger 3896: "distinfo".
3897:
3898: When adding a patch that corrects a problem in the distfile (rather than e.g.
3899: enforcing pkgsrc's view of where man pages should go), send the patch as a bug
3900: report to the maintainer. This benefits non-pkgsrc users of the package, and
3901: usually makes it possible to remove the patch in future version.
3902:
1.2 rillig 3903: The file names of the patch files are usually of the form patch-[a-z][a-z].
3904:
1.6 ! rillig 3905: 11.3.3. Sources where the patch files come from
1.1 dsieger 3906:
3907: If you want to share patches between multiple packages in pkgsrc, e.g. because
3908: they use the same distfiles, set PATCHDIR to the path where the patch files can
3909: be found, e.g.:
3910:
3911: PATCHDIR= ${.CURDIR}/../xemacs/patches
3912:
3913: Patch files that are distributed by the author or other maintainers can be
3914: listed in PATCHFILES.
3915:
3916: If it is desired to store any patches that should not be committed into pkgsrc,
3917: they can be kept outside the pkgsrc tree in the $LOCALPATCHES directory. The
3918: directory tree there is expected to have the same "category/package" structure
3919: as pkgsrc, and patches are expected to be stored inside these dirs (also known
3920: as $LOCALPATCHES/$PKGPATH). For example, if you want to keep a private patch
3921: for pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All
3922: files in the named directory are expected to be patch files, and they are
3923: applied after pkgsrc patches are applied.
3924:
1.6 ! rillig 3925: 11.3.4. Patching guidelines
1.1 dsieger 3926:
3927: When fixing a portability issue in the code do not use preprocessor magic to
3928: check for the current operating system nor platform. Doing so hurts portability
3929: to other platforms because the OS-specific details are not abstracted
3930: appropriately.
3931:
3932: The general rule to follow is: instead of checking for the operating system the
3933: application is being built on, check for the specific features you need. For
3934: example, instead of assuming that kqueue is available under NetBSD and using
3935: the __NetBSD__ macro to conditionalize kqueue support, add a check that detects
3936: kqueue itself ? yes, this generally involves patching the configure script.
3937: There is absolutely nothing that prevents some OSes from adopting interfaces
3938: from other OSes (e.g. Linux implementing kqueue), something that the above
3939: checks cannot take into account.
3940:
3941: Of course, checking for features generally involves more work on the
3942: developer's side, but the resulting changes are cleaner and there are chances
3943: they will work on many other platforms. Not to mention that there are higher
3944: chances of being later integrated into the mainstream sources. Remember: It
3945: doesn't work unless it is right!
3946:
3947: Some typical examples:
3948:
1.6 ! rillig 3949: Table 11.1. Patching examples
1.1 dsieger 3950:
3951: +-------------------------------------------------------------------------------------------+
3952: | Where | Incorrect | Correct |
3953: |---------+--------------------------+------------------------------------------------------|
3954: | |case ${target_os} in | |
3955: |configure|netbsd*) have_kvm=yes ;; |AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)|
3956: |script |*) have_kvm=no ;; | |
3957: | |esac | |
3958: |---------+--------------------------+------------------------------------------------------|
1.2 rillig 3959: |C source |#if defined(__NetBSD__) |#if defined(HAVE_SYS_EVENT_H) |
3960: |file |# include <sys/event.h> |# include <sys/event.h> |
3961: | |#endif |#endif |
1.1 dsieger 3962: |---------+--------------------------+------------------------------------------------------|
3963: | |int |int |
3964: | |monitor_file(...) |monitor_file(...) |
3965: | |{ |{ |
3966: | |#if defined(__NetBSD__) |#if defined(HAVE_KQUEUE) |
3967: |C source | int fd = kqueue();| int fd = kqueue(); |
3968: |file | ... | ... |
3969: | |#else |#else |
3970: | | ... | ... |
3971: | |#endif |#endif |
3972: | |} |} |
3973: +-------------------------------------------------------------------------------------------+
3974:
3975:
3976: For more information, please read the Making packager-friendly software article
3977: (part 1, part 2). It summarizes multiple details on how to make software easier
3978: to package; all the suggestions in it were collected from our experience in
3979: pkgsrc work, so they are possibly helpful when creating patches too.
3980:
1.6 ! rillig 3981: 11.3.5. Feedback to the author
1.1 dsieger 3982:
3983: Always, always, always feed back any portability fixes or improvements you do
3984: to a package to the mainstream developers. This is the only way to get their
3985: attention on portability issues and to ensure that future versions can be built
3986: out-of-the box on NetBSD. Furthermore, any user that gets newer distfiles will
3987: get the fixes straight from the packaged code.
3988:
3989: This generally involves cleaning up the patches (because sometimes the patches
3990: that are added to pkgsrc are quick hacks), filling bug reports in the
3991: appropriate trackers for the projects and working with the mainstream authors
3992: to accept your changes. It is extremely important that you do it so that the
3993: packages in pkgsrc are kept simple and thus further changes can be done without
3994: much hassle.
3995:
3996: Support the idea of free software!
3997:
1.6 ! rillig 3998: 11.4. Other mandatory files
1.1 dsieger 3999:
4000: DESCR
4001:
4002: A multi-line description of the piece of software. This should include any
4003: credits where they are due. Please bear in mind that others do not share
4004: your sense of humour (or spelling idiosyncrasies), and that others will
4005: read everything that you write here.
4006:
4007: PLIST
4008:
4009: This file governs the files that are installed on your system: all the
4010: binaries, manual pages, etc. There are other directives which may be
4011: entered in this file, to control the creation and deletion of directories,
1.6 ! rillig 4012: and the location of inserted files. See Chapter 13, PLIST issues for more
1.1 dsieger 4013: information.
4014:
1.6 ! rillig 4015: 11.5. Optional files
1.1 dsieger 4016:
1.6 ! rillig 4017: 11.5.1. Files affecting the binary package
1.1 dsieger 4018:
4019: INSTALL
4020:
4021: This shell script is invoked twice by pkg_add(1). First time after package
4022: extraction and before files are moved in place, the second time after the
4023: files to install are moved in place. This can be used to do any custom
4024: procedures not possible with @exec commands in PLIST. See pkg_add(1) and
1.6 ! rillig 4025: pkg_create(1) for more information. See also Section 15.1, "Files and
1.1 dsieger 4026: directories outside the installation prefix".
4027:
4028: DEINSTALL
4029:
4030: This script is executed before and after any files are removed. It is this
4031: script's responsibility to clean up any additional messy details around the
4032: package's installation, since all pkg_delete knows is how to delete the
4033: files created in the original distribution. See pkg_delete(1) and
4034: pkg_create(1) for more information.
4035:
4036: MESSAGE
4037:
4038: This file is displayed after installation of the package. Useful for things
4039: like legal notices on almost-free software and hints for updating config
4040: files after installing modules for apache, PHP etc. Please note that you
4041: can modify variables in it easily by using MESSAGE_SUBST in the package's
4042: Makefile:
4043:
4044: MESSAGE_SUBST+= SOMEVAR="somevalue"
4045:
4046: replaces "${SOMEVAR}" with "somevalue" in MESSAGE. By default, substitution
4047: is performed for PKGNAME, PKGBASE, PREFIX, LOCALBASE, X11PREFIX, X11BASE,
4048: PKG_SYSCONFDIR, ROOT_GROUP, and ROOT_GROUP.
4049:
4050: You can display a different or additional files by setting the MESSAGE_SRC
4051: variable. Its default is MESSAGE, if the file exists.
4052:
4053: ALTERNATIVES
4054:
4055: FIXME: There is no documentation on the alternatives framework.
4056:
1.6 ! rillig 4057: 11.5.2. Files affecting the build process
1.1 dsieger 4058:
4059: Makefile.common
4060:
4061: This file contains arbitrary things that could also go into a Makefile, but
4062: its purpose is to be used by more than one package. This file should only
4063: be used when the packages that will use the file are known in advance. For
4064: other purposes it is often better to write a *.mk file and give it a good
4065: name that describes what it does.
4066:
4067: buildlink3.mk
4068:
4069: This file contains the dependency information for the buildlink3 framework
1.6 ! rillig 4070: (see Chapter 14, Buildlink methodology).
1.1 dsieger 4071:
4072: hacks.mk
4073:
4074: This file contains workarounds for compiler bugs and similar things. It is
4075: included automatically by the pkgsrc infrastructure, so you don't need an
4076: extra .include line for it.
4077:
4078: options.mk
4079:
4080: This file contains the code for the package-specific options (see
1.6 ! rillig 4081: Chapter 16, Options handling) that can be selected by the user. If a
1.1 dsieger 4082: package has only one or two options, it is equally acceptable to put the
4083: code directly into the Makefile.
4084:
1.6 ! rillig 4085: 11.5.3. Files affecting nothing at all
1.1 dsieger 4086:
4087: README*
4088:
4089: These files do not take place in the creation of a package and thus are
4090: purely informative to the package developer.
4091:
4092: TODO
4093:
4094: This file contains things that need to be done to make the package even
4095: better.
4096:
1.6 ! rillig 4097: 11.6. work*
1.1 dsieger 4098:
4099: When you type make, the distribution files are unpacked into the directory
4100: denoted by WRKDIR. It can be removed by running make clean. Besides the
4101: sources, this directory is also used to keep various timestamp files. The
4102: directory gets removed completely on clean. The default is ${.CURDIR}/work or $
4103: {.CURDIR}/work.${MACHINE_ARCH} if OBJMACHINE is set.
4104:
1.6 ! rillig 4105: 11.7. files/*
1.1 dsieger 4106:
4107: If you have any files that you wish to be placed in the package prior to
4108: configuration or building, you could place these files here and use a ${CP}
4109: command in the "pre-configure" target to achieve this. Alternatively, you could
4110: simply diff the file against /dev/null and use the patch mechanism to manage
4111: the creation of this file.
4112:
4113: If you want to share files in this way with other packages, set the FILESDIR
4114: variable to point to the other package's files directory, e.g.:
4115:
4116: FILESDIR=${.CURDIR}/../xemacs/files
4117:
1.6 ! rillig 4118: Chapter 12. Programming in Makefiles
1.1 dsieger 4119:
4120: Table of Contents
4121:
1.6 ! rillig 4122: 12.1. Caveats
! 4123: 12.2. Makefile variables
1.1 dsieger 4124:
1.6 ! rillig 4125: 12.2.1. Naming conventions
1.1 dsieger 4126:
1.6 ! rillig 4127: 12.3. Code snippets
1.1 dsieger 4128:
1.6 ! rillig 4129: 12.3.1. Adding things to a list
! 4130: 12.3.2. Converting an internal list into an external list
! 4131: 12.3.3. Passing variables to a shell command
! 4132: 12.3.4. Quoting guideline
! 4133: 12.3.5. Workaround for a bug in BSD Make
1.1 dsieger 4134:
4135: Pkgsrc consists of many Makefile fragments, each of which forms a well-defined
4136: part of the pkgsrc system. Using the make(1) system as a programming language
4137: for a big system like pkgsrc requires some discipline to keep the code correct
4138: and understandable.
4139:
4140: The basic ingredients for Makefile programming are variables (which are
4141: actually macros) and shell commands. Among these shell commands may even be
4142: more complex ones like awk(1) programs. To make sure that every shell command
4143: runs as intended it is necessary to quote all variables correctly when they are
4144: used.
4145:
4146: This chapter describes some patterns, that appear quite often in Makefiles,
4147: including the pitfalls that come along with them.
4148:
1.6 ! rillig 4149: 12.1. Caveats
1.1 dsieger 4150:
4151: * When you are creating a file as a target of a rule, always write the data
4152: to a temporary file first and finally rename that file. Otherwise there
4153: might occur an error in the middle of generating the file, and when the
4154: user runs make(1) for the second time, the file exists and will not be
4155: regenerated properly. Example:
4156:
4157: wrong:
4158: @echo "line 1" > ${.TARGET}
4159: @echo "line 2" >> ${.TARGET}
4160: @false
4161:
4162: correct:
4163: @echo "line 1" > ${.TARGET}.tmp
4164: @echo "line 2" >> ${.TARGET}.tmp
4165: @false
4166: @mv ${.TARGET}.tmp ${.TARGET}
4167:
4168: When you run make wrong twice, the file wrong will exist, although there
4169: was an error message in the first run. On the other hand, running make
4170: correct gives an error message twice, as expected.
4171:
4172: You might remember that make(1) sometimes removes ${.TARGET} in case of
4173: error, but this only happens when it is interrupted, for example by
4174: pressing ^C. This does not happen when one of the commands fails (like
4175: false(1) above).
4176:
1.6 ! rillig 4177: 12.2. Makefile variables
1.1 dsieger 4178:
4179: Makefile variables contain strings that can be processed using the five
4180: operators ``='', ``+='', ``?='', ``:='', and ``!='', which are described in the
4181: make(1) man page.
4182:
4183: When a variable's value is parsed from a Makefile, the hash character ``#'' and
4184: the backslash character ``\'' are handled specially. If a backslash is followed
4185: by a newline, any whitespace immediately in front of the backslash, the
4186: backslash, the newline, and any whitespace immediately behind the newline are
4187: replaced with a single space. A backslash character and an immediately
4188: following hash character are replaced with a single hash character. Otherwise,
4189: the backslash is passed as is. In a variable assignment, any hash character
4190: that is not preceded by a backslash starts a comment that continues upto the
4191: end of the logical line.
4192:
4193: Note: Because of this parsing algorithm the only way to create a variable
4194: consisting of a single backslash is using the ``!='' operator, for example:
4195: BACKSLASH!=echo "\\".
4196:
4197: So far for defining variables. The other thing you can do with variables is
4198: evaluating them. A variable is evaluated when it is part of the right side of
4199: the ``:='' or the ``!='' operator, or directly before executing a shell command
4200: which the variable is part of. In all other cases, make(1) performs lazy
4201: evaluation, that is, variables are not evaluated until there's no other way.
4202: The ``modifiers'' mentioned in the man page also evaluate the variable.
4203:
4204: Some of the modifiers split the string into words and then operate on the
4205: words, others operate on the string as a whole. When a string is split into
4206: words, it is split as you would expect it from sh(1).
4207:
4208: No rule without exception?the .for loop does not follow the shell quoting rules
4209: but splits at sequences of whitespace.
4210:
4211: There are several types of variables that should be handled differently.
4212: Strings and two types of lists.
4213:
4214: * Strings can contain arbitrary characters. Nevertheless, you should restrict
4215: yourself to only using printable characters. Examples are PREFIX and
4216: COMMENT.
4217:
4218: * Internal lists are lists that are never exported to any shell command.
4219: Their elements are separated by whitespace. Therefore, the elements
4220: themselves cannot have embedded whitespace. Any other characters are
4221: allowed. Internal lists can be used in .for loops. Examples are DEPENDS and
4222: BUILD_DEPENDS.
4223:
4224: * External lists are lists that may be exported to a shell command. Their
4225: elements can contain any characters, including whitespace. That's why they
4226: cannot be used in .for loops. Examples are DISTFILES and MASTER_SITES.
4227:
1.6 ! rillig 4228: 12.2.1. Naming conventions
1.1 dsieger 4229:
4230: * All variable names starting with an underscore are reserved for use by the
4231: pkgsrc infrastructure. They shall not be used by package Makefiles.
4232:
4233: * In .for loops you should use lowercase variable names for the iteration
4234: variables.
4235:
4236: * All list variables should have a ``plural'' name, e.g. PKG_OPTIONS or
4237: DISTFILES.
4238:
1.6 ! rillig 4239: 12.3. Code snippets
1.1 dsieger 4240:
4241: This section presents you with some code snippets you should use in your own
4242: code. If you don't find anything appropriate here, you should test your code
4243: and add it here.
4244:
1.6 ! rillig 4245: 12.3.1. Adding things to a list
1.1 dsieger 4246:
4247: STRING= foo * bar `date`
4248: INT_LIST= # empty
4249: ANOTHER_INT_LIST= apache-[0-9]*:../../www/apache
4250: EXT_LIST= # empty
4251: ANOTHER_EXT_LIST= a=b c=d
4252:
4253: INT_LIST+= ${STRING} # 1
4254: INT_LIST+= ${ANOTHER_INT_LIST} # 2
4255: EXT_LIST+= ${STRING:Q} # 3
4256: EXT_LIST+= ${ANOTHER_EXT_LIST} # 4
4257:
4258: When you add a string to an external list (example 3), it must be quoted. In
4259: all other cases, you must not add a quoting level. You must not merge internal
4260: and external lists, unless you are sure that all entries are correctly
4261: interpreted in both lists.
4262:
1.6 ! rillig 4263: 12.3.2. Converting an internal list into an external list
1.1 dsieger 4264:
4265: EXT_LIST= # empty
4266: .for i in ${INT_LIST}
4267: EXT_LIST+= ${i:Q}""
4268: .endfor
4269:
4270: This code converts the internal list INT_LIST into the external list EXT_LIST.
4271: As the elements of an internal list are unquoted they must be quoted here. The
4272: reason for appending "" is explained below.
4273:
1.6 ! rillig 4274: 12.3.3. Passing variables to a shell command
1.1 dsieger 4275:
4276: Sometimes you may want to print an arbitrary string. There are many ways to get
4277: it wrong and only few that can handle every nastiness.
4278:
4279: STRING= foo bar < > * `date` $$HOME ' "
4280: EXT_LIST= string=${STRING:Q} x=second\ item
4281:
4282: all:
4283: echo ${STRING} # 1
4284: echo "${STRING}" # 2
4285: echo "${STRING:Q}" # 3
4286: echo ${STRING:Q} # 4
4287: echo x${STRING:Q} | sed 1s,.,, # 5
4288: printf "%s\\n" ${STRING:Q}"" # 6
4289: env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
4290:
4291: Example 1 leads to a syntax error in the shell, as the characters are just
4292: copied.
4293:
4294: Example 2 leads to a syntax error too, and if you leave out the last "
4295: character from ${STRING}, date(1) will be executed. The $HOME shell variable
4296: would be evaluated, too.
4297:
4298: Example 3 outputs each space character preceded by a backslash (or not),
4299: depending on the implementation of the echo(1) command.
4300:
4301: Example 4 handles correctly every string that does not start with a dash. In
4302: that case, the result depends on the implementation of the echo(1) command. As
4303: long as you can guarantee that your input does not start with a dash, this form
4304: is appropriate.
4305:
4306: Example 5 handles even the case of a leading dash correctly.
4307:
4308: Example 6 also works with every string and is the light-weight solution, since
4309: it does not involve a pipe, which has its own problems.
4310:
4311: The EXT_LIST does not need to be quoted because the quoting has already been
4312: done when adding elements to the list.
4313:
4314: As internal lists shall not be passed to the shell, there is no example for it.
4315:
1.6 ! rillig 4316: 12.3.4. Quoting guideline
1.1 dsieger 4317:
4318: There are many possible sources of wrongly quoted variables. This section lists
4319: some of the commonly known ones.
4320:
4321: * Whenever you use the value of a list, think about what happens to leading
4322: or trailing whitespace. If the list is a well-formed shell expression, you
4323: can apply the :M* modifier to strip leading and trailing whitespace from
4324: each word. The :M operator first splits its argument according to the rules
4325: of the shell, and then creates a new list consisting of all words that
4326: match the shell glob expression *, that is: all. One class of situations
4327: where this is needed is when adding a variable like CPPFLAGS to
4328: CONFIGURE_ARGS. If the configure script invokes other configure scripts, it
4329: strips the leading and trailing whitespace from the variable and then
4330: passes it to the other configure scripts. But these configure scripts
4331: expect the (child) CPPFLAGS variable to be the same as the parent CPPFLAGS.
4332: That's why we better pass the CPPFLAGS value properly trimmed. And here is
4333: how we do it:
4334:
4335: CPPFLAGS= # empty
4336: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX:Q}\"
4337: CPPFLAGS+= ${MY_CPPFLAGS}
4338:
4339: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
4340:
4341: all:
4342: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4343: echo x${CONFIGURE_ARGS}x # properly trimmed
4344:
4345: * The example above contains one bug: The ${PREFIX} is a properly quoted
4346: shell expression, but there is the C compiler after it, which also expects
4347: a properly quoted string (this time in C syntax). The version above is
4348: therefore only correct if ${PREFIX} does not have embedded backslashes or
4349: double quotes. If you want to allow these, you have to add another layer of
4350: quoting to each variable that is used as a C string literal. You cannot use
4351: the :Q operator for it, as this operator only works for the shell.
4352:
4353: * Whenever a variable can be empty, the :Q operator can have surprising
4354: results. Here are two completely different cases which can be solved with
4355: the same trick.
4356:
4357: EMPTY= # empty
4358: empty_test:
4359: for i in a ${EMPTY:Q} c; do \
4360: echo "$$i"; \
4361: done
4362:
4363: for_test:
4364: .for i in a:\ a:\test.txt
4365: echo ${i:Q}
4366: echo "foo"
4367: .endfor
4368:
4369: The first example will only print two of the three lines we might have
4370: expected. This is because ${EMPTY:Q} expands to the empty string, which the
4371: shell cannot see. The workaround is to write ${EMPTY:Q}"". This pattern can
4372: be often found as ${TEST} -z ${VAR:Q} or as ${TEST} -f ${FNAME:Q} (both of
4373: these are wrong).
4374:
4375: The second example will only print three lines instead of four. The first
4376: line looks like a:\ echo foo. This is because the backslash of the value a:
4377: \ is interpreted as a line-continuation by make(1), which makes the second
4378: line the arguments of the echo(1) command from the first line. To avoid
4379: this, write ${i:Q}"".
4380:
1.6 ! rillig 4381: 12.3.5. Workaround for a bug in BSD Make
1.1 dsieger 4382:
4383: The pkgsrc bmake program does not handle the following assignment correctly. In
4384: case _othervar_ contains a ``-'' character, one of the closing braces is
4385: included in ${VAR} after this code executes.
4386:
4387: VAR:= ${VAR:N${_othervar_:C/-//}}
4388:
4389: For a more complex code snippet and a workaround, see the package regress/
4390: make-quoting, testcase bug1.
4391:
1.6 ! rillig 4392: Chapter 13. PLIST issues
1.1 dsieger 4393:
4394: Table of Contents
4395:
1.6 ! rillig 4396: 13.1. RCS ID
! 4397: 13.2. Semi-automatic PLIST generation
! 4398: 13.3. Tweaking output of make print-PLIST
! 4399: 13.4. Variable substitution in PLIST
! 4400: 13.5. Man page compression
! 4401: 13.6. Changing PLIST source with PLIST_SRC
! 4402: 13.7. Platform-specific and differing PLISTs
! 4403: 13.8. Sharing directories between packages
1.1 dsieger 4404:
4405: The PLIST file contains a package's "packing list", i.e. a list of files that
4406: belong to the package (relative to the ${PREFIX} directory it's been installed
4407: in) plus some additional statements - see the pkg_create(1) man page for a full
4408: list. This chapter addresses some issues that need attention when dealing with
4409: the PLIST file (or files, see below!).
4410:
1.6 ! rillig 4411: 13.1. RCS ID
1.1 dsieger 4412:
4413: Be sure to add a RCS ID line as the first thing in any PLIST file you write:
4414:
1.2 rillig 4415: @comment $NetBSD$
1.1 dsieger 4416:
4417:
1.6 ! rillig 4418: 13.2. Semi-automatic PLIST generation
1.1 dsieger 4419:
4420: You can use the make print-PLIST command to output a PLIST that matches any new
1.6 ! rillig 4421: files since the package was extracted. See Section 17.17, "Other helpful
1.1 dsieger 4422: targets" for more information on this target.
4423:
1.6 ! rillig 4424: 13.3. Tweaking output of make print-PLIST
1.1 dsieger 4425:
1.6 ! rillig 4426: If you have used any of the *-dirs packages, as explained in Section 13.8,
1.1 dsieger 4427: "Sharing directories between packages", you may have noticed that make
4428: print-PLIST outputs a set of @comments instead of real @dirrm lines. You can
4429: also do this for specific directories and files, so that the results of that
4430: command are very close to reality. This helps a lot during the update of
4431: packages.
4432:
4433: The PRINT_PLIST_AWK variable takes a set of AWK patterns and actions that are
4434: used to filter the output of print-PLIST. You can append any chunk of AWK
4435: scripting you like to it, but be careful with quoting.
4436:
4437: For example, to get all files inside the libdata/foo directory removed from the
4438: resulting PLIST:
4439:
4440: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
4441:
4442:
4443: And to get all the @dirrm lines referring to a specific (shared) directory
4444: converted to @comments:
4445:
4446: PRINT_PLIST_AWK+= /^@dirrm share\/specific/ { print "@comment " $$0; next; }
4447:
4448:
1.6 ! rillig 4449: 13.4. Variable substitution in PLIST
1.1 dsieger 4450:
4451: A number of variables are substituted automatically in PLISTs when a package is
4452: installed on a system. This includes the following variables:
4453:
4454: ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}
4455:
4456: Some packages like emacs and perl embed information about which
4457: architecture they were built on into the pathnames where they install their
4458: files. To handle this case, PLIST will be preprocessed before actually
4459: used, and the symbol "${MACHINE_ARCH}" will be replaced by what uname -p
4460: gives. The same is done if the string ${MACHINE_GNU_ARCH} is embedded in
4461: PLIST somewhere - use this on packages that have GNU autoconf-created
4462: configure scripts.
4463:
4464: Legacy note
4465:
4466: There used to be a symbol "$ARCH" that was replaced by the output of uname
4467: -m, but that's no longer supported and has been removed.
4468:
4469: ${OPSYS}, ${LOWER_OPSYS}, ${OS_VERSION}
4470:
4471: Some packages want to embed the OS name and version into some paths. To do
4472: this, use these variables in the PLIST:
4473:
4474: * ${OPSYS} - output of "uname -s"
4475:
4476: * ${LOWER_OPSYS} - lowercase common name (eg. "solaris")
4477:
4478: * ${OS_VERSION} - "uname -r"
4479:
4480: For a complete list of values which are replaced by default, please look in
4481: bsd.pkg.mk (and search for PLIST_SUBST).
4482:
4483: If you want to change other variables not listed above, you can add variables
4484: and their expansions to this variable in the following way, similar to
1.6 ! rillig 4485: MESSAGE_SUBST (see Section 11.5, "Optional files"):
1.1 dsieger 4486:
4487: PLIST_SUBST+= SOMEVAR="somevalue"
4488:
4489:
4490: This replaces all occurrences of "${SOMEVAR}" in the PLIST with "somevalue".
4491:
1.6 ! rillig 4492: 13.5. Man page compression
1.1 dsieger 4493:
4494: Man pages should be installed in compressed form if MANZ is set (in
4495: bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the
4496: suffix ".gz" is appended/removed automatically for man pages according to MANZ
4497: and MANCOMPRESSED being set or not, see above for details. This modification of
4498: the PLIST file is done on a copy of it, not PLIST itself.
4499:
1.6 ! rillig 4500: 13.6. Changing PLIST source with PLIST_SRC
1.1 dsieger 4501:
4502: To use one or more files as source for the PLIST used in generating the binary
4503: package, set the variable PLIST_SRC to the names of that file(s). The files are
4504: later concatenated using cat(1), and the order of things is important. The
4505: default for PLIST_SRC is ${PKGDIR}/PLIST.
4506:
1.6 ! rillig 4507: 13.7. Platform-specific and differing PLISTs
1.1 dsieger 4508:
4509: Some packages decide to install a different set of files based on the operating
4510: system being used. These differences can be automatically handled by using the
4511: following files:
4512:
4513: * PLIST.common
4514:
4515: * PLIST.${OPSYS}
4516:
4517: * PLIST.${MACHINE_ARCH}
4518:
4519: * PLIST.${OPSYS}-${MACHINE_ARCH}
4520:
4521: * PLIST.common_end
4522:
1.6 ! rillig 4523: 13.8. Sharing directories between packages
1.1 dsieger 4524:
4525: A "shared directory" is a directory where multiple (and unrelated) packages
4526: install files. These directories are problematic because you have to add
4527: special tricks in the PLIST to conditionally remove them, or have some
4528: centralized package handle them.
4529:
4530: Within pkgsrc, you'll find both approaches. If a directory is shared by a few
4531: unrelated packages, it's often not worth to add an extra package to remove it.
4532: Therefore, one simply does:
4533:
4534: @unexec ${RMDIR} %D/path/to/shared/directory 2>/dev/null || ${TRUE}
4535:
4536:
4537: in the PLISTs of all affected packages, instead of the regular "@dirrm" line.
4538:
4539: However, if the directory is shared across many packages, two different
4540: solutions are available:
4541:
4542: 1. If the packages have a common dependency, the directory can be removed in
4543: that. For example, see textproc/scrollkeeper, which removes the shared
4544: directory share/omf.
4545:
4546: 2. If the packages using the directory are not related at all (they have no
4547: common dependencies), a *-dirs package is used.
4548:
4549: From now on, we'll discuss the second solution. To get an idea of the *-dirs
4550: packages available, issue:
4551:
4552: % cd .../pkgsrc
4553: % ls -d */*-dirs
4554:
4555:
4556: Their use from other packages is very simple. The USE_DIRS variable takes a
4557: list of package names (without the "-dirs" part) together with the required
4558: version number (always pick the latest one when writing new packages).
4559:
4560: For example, if a package installs files under share/applications, it should
4561: have the following line in it:
4562:
4563: USE_DIRS+= xdg-1.1
4564:
4565:
4566: After regenerating the PLIST using make print-PLIST, you should get the right
4567: (commented out) lines.
4568:
4569: Note that even if your package is using $X11BASE, it must not depend on the
4570: *-x11-dirs packages. Just specify the name without that part and pkgsrc (in
4571: particular, mk/dirs.mk) will take care of it.
4572:
1.6 ! rillig 4573: Chapter 14. Buildlink methodology
1.1 dsieger 4574:
4575: Table of Contents
4576:
1.6 ! rillig 4577: 14.1. Converting packages to use buildlink3
! 4578: 14.2. Writing buildlink3.mk files
1.1 dsieger 4579:
1.6 ! rillig 4580: 14.2.1. Anatomy of a buildlink3.mk file
! 4581: 14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files
1.1 dsieger 4582:
1.6 ! rillig 4583: 14.3. Writing builtin.mk files
1.1 dsieger 4584:
1.6 ! rillig 4585: 14.3.1. Anatomy of a builtin.mk file
! 4586: 14.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 4587:
4588: Buildlink is a framework in pkgsrc that controls what headers and libraries are
4589: seen by a package's configure and build processes. This is implemented in a two
4590: step process:
4591:
4592: 1. Symlink headers and libraries for dependencies into BUILDLINK_DIR, which by
4593: default is a subdirectory of WRKDIR.
4594:
4595: 2. Create wrapper scripts that are used in place of the normal compiler tools
4596: that translate -I${LOCALBASE}/include and -L${LOCALBASE}/lib into
4597: references to BUILDLINK_DIR. The wrapper scripts also make native compiler
4598: on some operating systems look like GCC, so that packages that expect GCC
4599: won't require modifications to build with those native compilers.
4600:
4601: This normalizes the environment in which a package is built so that the package
4602: may be built consistently despite what other software may be installed. Please
4603: note that the normal system header and library paths, e.g. /usr/include, /usr/
4604: lib, etc., are always searched -- buildlink3 is designed to insulate the
4605: package build from non-system-supplied software.
4606:
1.6 ! rillig 4607: 14.1. Converting packages to use buildlink3
1.1 dsieger 4608:
4609: The process of converting packages to use the buildlink3 framework
4610: ("bl3ifying") is fairly straightforward. The things to keep in mind are:
4611:
4612: 1. Ensure that the build always calls the wrapper scripts instead of the
4613: actual toolchain. Some packages are tricky, and the only way to know for
4614: sure is the check ${WRKDIR}/.work.log to see if the wrappers are being
4615: invoked.
4616:
4617: 2. Don't override PREFIX from within the package Makefile, e.g. Java VMs,
4618: standalone shells, etc., because the code to symlink files into $
4619: {BUILDLINK_DIR} looks for files relative to "pkg_info -qp pkgname".
4620:
4621: 3. Remember that only the buildlink3.mk files that you list in a package's
4622: Makefile are added as dependencies for that package.
4623:
4624: If a dependency on a particular package is required for its libraries and
4625: headers, then we replace:
4626:
4627: DEPENDS+= foo>=1.1.0:../../category/foo
4628:
4629: with
4630:
4631: .include "../../category/foo/buildlink3.mk"
4632:
4633: The buildlink3.mk files usually define the required dependencies. If you need a
4634: newer version of the dependency when using buildlink3.mk files, then you can
4635: define it in your Makefile; for example:
4636:
4637: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
4638: .include "../../category/foo/buildlink3.mk"
4639:
4640: There are several buildlink3.mk files in pkgsrc/mk that handle special package
4641: issues:
4642:
4643: * bdb.buildlink3.mk chooses either the native or a pkgsrc Berkeley DB
4644: implementation based on the values of BDB_ACCEPTED and BDB_DEFAULT.
4645:
4646: * curses.buildlink3.mk: If the system comes with neither Curses nor NCurses,
4647: this will take care to install the devel/ncurses package.
4648:
4649: * krb5.buildlink3.mk uses the value of KRB5_ACCEPTED to choose between adding
4650: a dependency on Heimdal or MIT-krb5 for packages that require a Kerberos 5
4651: implementation.
4652:
4653: * motif.buildlink3.mk checks for a system-provided Motif installation or adds
4654: a dependency on x11/lesstif or x11/openmotif. The user can set MOTIF_TYPE
4655: to "dt", "lesstif", or "openmotif" to choose which Motif version will be
4656: used.
4657:
4658: * oss.buildlink3.mk defines several variables that may be used by packages
4659: that use the Open Sound System (OSS) API.
4660:
4661: * pgsql.buildlink3.mk will accept either Postgres 8.0, 8.1, or 8.2, whichever
4662: is found installed. See the file for more information.
4663:
4664: * pthread.buildlink3.mk uses the value of PTHREAD_OPTS and checks for native
4665: pthreads or adds a dependency on devel/pth as needed.
4666:
4667: * xaw.buildlink3.mk uses the value of XAW_TYPE to choose a particular Athena
4668: widgets library.
4669:
4670: The comments in those buildlink3.mk files provide a more complete description
4671: of how to use them properly.
4672:
1.6 ! rillig 4673: 14.2. Writing buildlink3.mk files
1.1 dsieger 4674:
4675: A package's buildlink3.mk file is included by Makefiles to indicate the need to
4676: compile and link against header files and libraries provided by the package. A
4677: buildlink3.mk file should always provide enough information to add the correct
4678: type of dependency relationship and include any other buildlink3.mk files that
4679: it needs to find headers and libraries that it needs in turn.
4680:
4681: To generate an initial buildlink3.mk file for further editing, Rene Hexel's
4682: pkgtools/createbuildlink package is highly recommended. For most packages, the
4683: following command will generate a good starting point for buildlink3.mk files:
4684:
4685: % cd pkgsrc/category/pkgdir
4686: % createbuildlink >buildlink3.mk
4687:
4688:
1.6 ! rillig 4689: 14.2.1. Anatomy of a buildlink3.mk file
1.1 dsieger 4690:
4691: The following real-life example buildlink3.mk is taken from pkgsrc/graphics/
4692: tiff:
4693:
1.2 rillig 4694: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1 dsieger 4695:
4696: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH}+
4697: TIFF_BUILDLINK3_MK:= ${TIFF_BUILDLINK3_MK}+
4698:
4699: .if ${BUILDLINK_DEPTH} == "+"
4700: BUILDLINK_DEPENDS+= tiff
4701: .endif
4702:
4703: BUILDLINK_PACKAGES:= ${BUILDLINK_PACKAGES:Ntiff}
4704: BUILDLINK_PACKAGES+= tiff
4705:
4706: .if ${TIFF_BUILDLINK3_MK} == "+"
4707: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
4708: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
4709: .endif # TIFF_BUILDLINK3_MK
4710:
4711: .include "../../devel/zlib/buildlink3.mk"
4712: .include "../../graphics/jpeg/buildlink3.mk"
4713:
4714: BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//}
4715:
4716: The header and footer manipulate BUILDLINK_DEPTH, which is common across all
4717: buildlink3.mk files and is used to track at what depth we are including
4718: buildlink3.mk files.
4719:
4720: The first section controls if the dependency on pkg is added. BUILDLINK_DEPENDS
4721: is the global list of packages for which dependencies are added by buildlink3.
4722:
4723: The second section advises pkgsrc that the buildlink3.mk file for pkg has been
4724: included at some point. BUILDLINK_PACKAGES is the global list of packages for
4725: which buildlink3.mk files have been included. It must always be appended to
4726: within a buildlink3.mk file.
4727:
4728: The third section is protected from multiple inclusion and controls how the
4729: dependency on pkg is added. Several important variables are set in the section:
4730:
4731: * BUILDLINK_API_DEPENDS.pkg is the actual dependency recorded in the
4732: installed package; this should always be set using += to ensure that we're
4733: appending to any pre-existing list of values. This variable should be set
4734: to the first version of the package that had an API change.
4735:
4736: * BUILDLINK_PKGSRCDIR.pkg is the location of the pkg pkgsrc directory.
4737:
4738: * BUILDLINK_DEPMETHOD.pkg (not shown above) controls whether we use
4739: BUILD_DEPENDS or DEPENDS to add the dependency on pkg. The build dependency
4740: is selected by setting BUILDLINK_DEPMETHOD.pkg to "build". By default, the
4741: full dependency is used.
4742:
4743: * BUILDLINK_INCDIRS.pkg and BUILDLINK_LIBDIRS.pkg (not shown above) are lists
4744: of subdirectories of ${BUILDLINK_PREFIX.pkg} to add to the header and
4745: library search paths. These default to "include" and "lib" respectively.
4746:
4747: * BUILDLINK_CPPFLAGS.pkg (not shown above) is the list of preprocessor flags
4748: to add to CPPFLAGS, which are passed on to the configure and build phases.
4749: The "-I" option should be avoided and instead be handled using
4750: BUILDLINK_INCDIRS.pkg as above.
4751:
4752: The following variables are all optionally defined within this second section
4753: (protected against multiple inclusion) and control which package files are
4754: symlinked into ${BUILDLINK_DIR} and how their names are transformed during the
4755: symlinking:
4756:
4757: * BUILDLINK_FILES.pkg (not shown above) is a shell glob pattern relative to $
4758: {BUILDLINK_PREFIX.pkg} to be symlinked into ${BUILDLINK_DIR}, e.g. include/
4759: *.h.
4760:
4761: * BUILDLINK_FILES_CMD.pkg (not shown above) is a shell pipeline that outputs
4762: to stdout a list of files relative to ${BUILDLINK_PREFIX.pkg}. The
4763: resulting files are to be symlinked into ${BUILDLINK_DIR}. By default, this
4764: takes the +CONTENTS of a pkg and filters it through $
4765: {BUILDLINK_CONTENTS_FILTER.pkg}.
4766:
4767: * BUILDLINK_CONTENTS_FILTER.pkg (not shown above) is a filter command that
4768: filters +CONTENTS input into a list of files relative to $
4769: {BUILDLINK_PREFIX.pkg} on stdout. By default for overwrite packages,
4770: BUILDLINK_CONTENTS_FILTER.pkg outputs the contents of the include and lib
4771: directories in the package +CONTENTS, and for pkgviews packages, it outputs
4772: any libtool archives in lib directories.
4773:
4774: * BUILDLINK_FNAME_TRANSFORM.pkg (not shown above) is a list of sed arguments
4775: used to transform the name of the source filename into a destination
4776: filename, e.g. -e "s|/curses.h|/ncurses.h|g".
4777:
4778: The last section includes any buildlink3.mk needed for pkg's library
4779: dependencies. Including these buildlink3.mk files means that the headers and
4780: libraries for these dependencies are also symlinked into ${BUILDLINK_DIR}
4781: whenever the pkg buildlink3.mk file is included.
4782:
1.6 ! rillig 4783: 14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files
1.1 dsieger 4784:
4785: The situation that requires increasing the dependency listed in
4786: BUILDLINK_API_DEPENDS.pkg after a package update is when the API or interface
4787: to the header files change.
4788:
4789: In this case, BUILDLINK_API_DEPENDS.pkg should be adjusted to require at least
4790: the new package version. In some cases, the packages that depend on this new
4791: version may need their PKGREVISIONs increased and, if they have buildlink3.mk
4792: files, their BUILDLINK_API_DEPENDS.pkg adjusted, too. This is needed so pkgsrc
4793: will require the correct package dependency and not settle for an older one
4794: when building the source.
4795:
4796: BUILDLINK_ABI_DEPENDS.pkg should be increased when the binary interface or
4797: sonames (major number of the library version) of any installed shared libraries
4798: change. This is needed so that binary packages made using it will require the
4799: correct package dependency and not settle for an older one which will not
4800: contain the necessary shared libraries.
4801:
1.6 ! rillig 4802: See Section 19.1.6, "Handling dependencies" for more information about
1.1 dsieger 4803: dependencies on other packages, including the BUILDLINK_ABI_DEPENDS and
4804: ABI_DEPENDS definitions.
4805:
4806: Please take careful consideration before adjusting BUILDLINK_API_DEPENDS.pkg or
4807: BUILDLINK_ABI_DEPENDS.pkg as we don't want to cause unneeded package deletions
4808: and rebuilds. In many cases, new versions of packages work just fine with older
4809: dependencies.
4810:
4811: Also it is not needed to set BUILDLINK_ABI_DEPENDS.pkg when it is identical to
4812: BUILDLINK_API_DEPENDS.pkg.
4813:
1.6 ! rillig 4814: 14.3. Writing builtin.mk files
1.1 dsieger 4815:
4816: Some packages in pkgsrc install headers and libraries that coincide with
4817: headers and libraries present in the base system. Aside from a buildlink3.mk
4818: file, these packages should also include a builtin.mk file that includes the
4819: necessary checks to decide whether using the built-in software or the pkgsrc
4820: software is appropriate.
4821:
4822: The only requirements of a builtin.mk file for pkg are:
4823:
4824: 1. It should set USE_BUILTIN.pkg to either "yes" or "no" after it is included.
4825:
4826: 2. It should not override any USE_BUILTIN.pkg which is already set before the
4827: builtin.mk file is included.
4828:
4829: 3. It should be written to allow multiple inclusion. This is very important
4830: and takes careful attention to Makefile coding.
4831:
1.6 ! rillig 4832: 14.3.1. Anatomy of a builtin.mk file
1.1 dsieger 4833:
4834: The following is the recommended template for builtin.mk files:
4835:
4836: .if !defined(IS_BUILTIN.foo)
4837: #
4838: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4839: # genuinely exists in the system or not.
4840: #
4841: IS_BUILTIN.foo?= no
4842:
4843: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4844: # version can be determined.
4845: #
4846: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4847: BUILTIN_PKG.foo?= foo-1.0
4848: . endif
4849: .endif # IS_BUILTIN.foo
4850:
4851: .if !defined(USE_BUILTIN.foo)
4852: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
4853: . if defined(BUILTIN_PKG.foo)
4854: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
4855: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
4856: USE_BUILTIN.foo!= \
4857: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
4858: && ${ECHO} "yes" || ${ECHO} "no"
4859: . endif
4860: . endfor
4861: . endif
4862: .endif # USE_BUILTIN.foo
4863:
4864: CHECK_BUILTIN.foo?= no
4865: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
4866: #
4867: # Here we place code that depends on whether USE_BUILTIN.foo is set to
4868: # "yes" or "no".
4869: #
4870: .endif # CHECK_BUILTIN.foo
4871:
4872: The first section sets IS_BUILTIN.pkg depending on if pkg really exists in the
4873: base system. This should not be a base system software with similar
4874: functionality to pkg; it should only be "yes" if the actual package is included
4875: as part of the base system. This variable is only used internally within the
4876: builtin.mk file.
4877:
4878: The second section sets BUILTIN_PKG.pkg to the version of pkg in the base
4879: system if it exists (if IS_BUILTIN.pkg is "yes"). This variable is only used
4880: internally within the builtin.mk file.
4881:
4882: The third section sets USE_BUILTIN.pkg and is required in all builtin.mk files.
4883: The code in this section must make the determination whether the built-in
4884: software is adequate to satisfy the dependencies listed in
4885: BUILDLINK_API_DEPENDS.pkg. This is typically done by comparing BUILTIN_PKG.pkg
4886: against each of the dependencies in BUILDLINK_API_DEPENDS.pkg. USE_BUILTIN.pkg
4887: must be set to the correct value by the end of the builtin.mk file. Note that
4888: USE_BUILTIN.pkg may be "yes" even if IS_BUILTIN.pkg is "no" because we may make
4889: the determination that the built-in version of the software is similar enough
4890: to be used as a replacement.
4891:
4892: The last section is guarded by CHECK_BUILTIN.pkg, and includes code that uses
4893: the value of USE_BUILTIN.pkg set in the previous section. This typically
4894: includes, e.g., adding additional dependency restrictions and listing
4895: additional files to symlink into ${BUILDLINK_DIR} (via BUILDLINK_FILES.pkg).
4896:
1.6 ! rillig 4897: 14.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 4898:
4899: When building packages, it's possible to choose whether to set a global
4900: preference for using either the built-in (native) version or the pkgsrc version
4901: of software to satisfy a dependency. This is controlled by setting
4902: PREFER_PKGSRC and PREFER_NATIVE. These variables take values of either "yes",
4903: "no", or a list of packages. PREFER_PKGSRC tells pkgsrc to use the pkgsrc
4904: versions of software, while PREFER_NATIVE tells pkgsrc to use the built-in
4905: versions. Preferences are determined by the most specific instance of the
4906: package in either PREFER_PKGSRC or PREFER_NATIVE. If a package is specified in
4907: neither or in both variables, then PREFER_PKGSRC has precedence over
4908: PREFER_NATIVE. For example, to require using pkgsrc versions of software for
4909: all but the most basic bits on a NetBSD system, you can set:
4910:
4911: PREFER_PKGSRC= yes
4912: PREFER_NATIVE= getopt skey tcp_wrappers
4913:
4914: A package must have a builtin.mk file to be listed in PREFER_NATIVE, otherwise
4915: it is simply ignored in that list.
4916:
1.6 ! rillig 4917: Chapter 15. The pkginstall framework
1.1 dsieger 4918:
4919: Table of Contents
4920:
1.6 ! rillig 4921: 15.1. Files and directories outside the installation prefix
1.1 dsieger 4922:
1.6 ! rillig 4923: 15.1.1. Directory manipulation
! 4924: 15.1.2. File manipulation
1.1 dsieger 4925:
1.6 ! rillig 4926: 15.2. Configuration files
1.1 dsieger 4927:
1.6 ! rillig 4928: 15.2.1. How PKG_SYSCONFDIR is set
! 4929: 15.2.2. Telling the software where configuration files are
! 4930: 15.2.3. Patching installations
! 4931: 15.2.4. Disabling handling of configuration files
1.1 dsieger 4932:
1.6 ! rillig 4933: 15.3. System startup scripts
1.1 dsieger 4934:
1.6 ! rillig 4935: 15.3.1. Disabling handling of system startup scripts
1.1 dsieger 4936:
1.6 ! rillig 4937: 15.4. System users and groups
! 4938: 15.5. System shells
1.1 dsieger 4939:
1.6 ! rillig 4940: 15.5.1. Disabling shell registration
1.1 dsieger 4941:
1.6 ! rillig 4942: 15.6. Fonts
1.1 dsieger 4943:
1.6 ! rillig 4944: 15.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 4945:
4946: This chapter describes the framework known as pkginstall, whose key features
4947: are:
4948:
4949: * Generic installation and manipulation of directories and files outside the
4950: pkgsrc-handled tree, LOCALBASE.
4951:
4952: * Automatic handling of configuration files during installation, provided
4953: that packages are correctly designed.
4954:
4955: * Generation and installation of system startup scripts.
4956:
4957: * Registration of system users and groups.
4958:
4959: * Registration of system shells.
4960:
4961: * Automatic updating of fonts databases.
4962:
4963: The following sections inspect each of the above points in detail.
4964:
4965: You may be thinking that many of the things described here could be easily done
4966: with simple code in the package's post-installation target (post-install). This
4967: is incorrect, as the code in them is only executed when building from source.
4968: Machines using binary packages could not benefit from it at all (as the code
4969: itself could be unavailable). Therefore, the only way to achieve any of the
4970: items described above is by means of the installation scripts, which are
4971: automatically generated by pkginstall.
4972:
1.6 ! rillig 4973: 15.1. Files and directories outside the installation prefix
1.1 dsieger 4974:
4975: As you already know, the PLIST file holds a list of files and directories that
4976: belong to a package. The names used in it are relative to the installation
4977: prefix (${PREFIX}), which means that it cannot register files outside this
4978: directory (absolute path names are not allowed). Despite this restriction, some
4979: packages need to install files outside this location; e.g., under ${VARBASE} or
4980: ${PKG_SYSCONFDIR}. The only way to achieve this is to create such files during
4981: installation time by using installation scripts.
4982:
4983: The generic installation scripts are shell scripts that can contain arbitrary
4984: code. The list of scripts to execute is taken from the INSTALL_FILE variable,
4985: which defaults to INSTALL. A similar variable exists for package removal
4986: (DEINSTALL_FILE, whose default is DEINSTALL). These scripts can run arbitrary
4987: commands, so they have the potential to create and manage files anywhere in the
4988: file system.
4989:
4990: Using these general installation files is not recommended, but may be needed in
4991: some special cases. One reason for avoiding them is that the user has to trust
4992: the packager that there is no unwanted or simply erroneous code included in the
4993: installation script. Also, previously there were many similar scripts for the
4994: same functionality, and fixing a common error involved finding and changing all
4995: of them.
4996:
4997: The pkginstall framework offers another, standardized way. It provides generic
4998: scripts to abstract the manipulation of such files and directories based on
4999: variables set in the package's Makefile. The rest of this section describes
5000: these variables.
5001:
1.6 ! rillig 5002: 15.1.1. Directory manipulation
1.1 dsieger 5003:
5004: The following variables can be set to request the creation of directories
5005: anywhere in the file system:
5006:
5007: * MAKE_DIRS and OWN_DIRS contain a list of directories that should be created
5008: and should attempt to be destroyed by the installation scripts. The
5009: difference between the two is that the latter prompts the administrator to
5010: remove any directories that may be left after deinstallation (because they
5011: were not empty), while the former does not.
5012:
5013: * MAKE_DIRS_PERMS and OWN_DIRS_PERMS contain a list of tuples describing
5014: which directories should be created and should attempt to be destroyed by
5015: the installation scripts. Each tuple holds the following values, separated
5016: by spaces: the directory name, its owner, its group and its numerical mode.
5017: For example:
5018:
5019: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
5020:
5021: The difference between the two is exactly the same as their non-PERMS
5022: counterparts.
5023:
1.6 ! rillig 5024: 15.1.2. File manipulation
1.1 dsieger 5025:
5026: Creating non-empty files outside the installation prefix is tricky because the
5027: PLIST forces all files to be inside it. To overcome this problem, the only
5028: solution is to extract the file in the known place (i.e., inside the
5029: installation prefix) and copy it to the appropriate location during
5030: installation (done by the installation scripts generated by pkginstall). We
5031: will call the former the master file in the following paragraphs, which
5032: describe the variables that can be used to automatically and consistently
5033: handle files outside the installation prefix:
5034:
5035: * CONF_FILES and SUPPORT_FILES are pairs of master and target files. During
5036: installation time, the master file is copied to the target one if and only
5037: if the latter does not exist. Upon deinstallation, the target file is
5038: removed provided that it was not modified by the installation.
5039:
5040: The difference between the two is that the latter prompts the administrator
5041: to remove any files that may be left after deinstallation (because they
5042: were not empty), while the former does not.
5043:
5044: * CONF_FILES_PERMS and SUPPORT_FILES_PERMS contain tuples describing master
5045: files as well as their target locations. For each of them, it also
5046: specifies their owner, their group and their numeric permissions, in this
5047: order. For example:
5048:
5049: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
5050:
5051: The difference between the two is exactly the same as their non-PERMS
5052: counterparts.
5053:
1.6 ! rillig 5054: 15.2. Configuration files
1.1 dsieger 5055:
5056: Configuration files are special in the sense that they are installed in their
5057: own specific directory, PKG_SYSCONFDIR, and need special treatment during
5058: installation (most of which is automated by pkginstall). The main concept you
5059: must bear in mind is that files marked as configuration files are automatically
5060: copied to the right place (somewhere inside PKG_SYSCONFDIR) during installation
5061: if and only if they didn't exist before. Similarly, they will not be removed if
5062: they have local modifications. This ensures that administrators never lose any
5063: custom changes they may have made.
5064:
1.6 ! rillig 5065: 15.2.1. How PKG_SYSCONFDIR is set
1.1 dsieger 5066:
5067: As said before, the PKG_SYSCONFDIR variable specifies where configuration files
5068: shall be installed. Its contents are set based upon the following variables:
5069:
5070: * PKG_SYSCONFBASE: The configuration's root directory. Defaults to ${PREFIX}/
5071: etc although it may be overridden by the user to point to his preferred
5072: location (e.g., /etc, /etc/pkg, etc.). Packages must not use it directly.
5073:
5074: * PKG_SYSCONFSUBDIR: A subdirectory of PKG_SYSCONFBASE under which the
5075: configuration files for the package being built shall be installed. The
5076: definition of this variable only makes sense in the package's Makefile
5077: (i.e., it is not user-customizable).
5078:
5079: As an example, consider the Apache package, www/apache2, which places its
5080: configuration files under the httpd/ subdirectory of PKG_SYSCONFBASE. This
5081: should be set in the package Makefile.
5082:
5083: * PKG_SYSCONFVAR: Specifies the name of the variable that holds this
5084: package's configuration directory (if different from PKG_SYSCONFBASE). It
5085: defaults to PKGBASE's value, and is always prefixed with PKG_SYSCONFDIR.
5086:
5087: * PKG_SYSCONFDIR.${PKG_SYSCONFVAR}: Holds the directory where the
5088: configuration files for the package identified by PKG_SYSCONFVAR's shall be
5089: placed.
5090:
5091: Based on the above variables, pkginstall determines the value of
5092: PKG_SYSCONFDIR, which is the only variable that can be used within a package to
5093: refer to its configuration directory. The algorithm used to set its value is
5094: basically the following:
5095:
5096: 1. If PKG_SYSCONFDIR.${PKG_SYSCONFVAR} is set, its value is used.
5097:
5098: 2. If the previous variable is not defined but PKG_SYSCONFSUBDIR is set in the
5099: package's Makefile, the resulting value is ${PKG_SYSCONFBASE}/$
5100: {PKG_SYSCONFSUBDIR}.
5101:
5102: 3. Otherwise, it is set to ${PKG_SYSCONFBASE}.
5103:
5104: It is worth mentioning that ${PKG_SYSCONFDIR} is automatically added to
1.6 ! rillig 5105: OWN_DIRS. See Section 15.1.1, "Directory manipulation" what this means.
1.1 dsieger 5106:
1.6 ! rillig 5107: 15.2.2. Telling the software where configuration files are
1.1 dsieger 5108:
5109: Given that pkgsrc (and users!) expect configuration files to be in a known
5110: place, you need to teach each package where it shall install its files. In some
5111: cases you will have to patch the package Makefiles to achieve it. If you are
5112: lucky, though, it may be as easy as passing an extra flag to the configuration
5113: script; this is the case of GNU Autoconf- generated files:
5114:
5115: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5116:
5117: Note that this specifies where the package has to look for its configuration
5118: files, not where they will be originally installed (although the difference is
5119: never explicit, unfortunately).
5120:
1.6 ! rillig 5121: 15.2.3. Patching installations
1.1 dsieger 5122:
5123: As said before, pkginstall automatically handles configuration files. This
5124: means that the packages themselves must not touch the contents of $
5125: {PKG_SYSCONFDIR} directly. Bad news is that many software installation scripts
5126: will, out of the box, mess with the contents of that directory. So what is the
5127: correct procedure to fix this issue?
5128:
5129: You must teach the package (usually by manually patching it) to install any
5130: configuration files under the examples hierarchy, share/examples/${PKGBASE}/.
5131: This way, the PLIST registers them and the administrator always has the
5132: original copies available.
5133:
5134: Once the required configuration files are in place (i.e., under the examples
5135: hierarchy), the pkginstall framework can use them as master copies during the
5136: package installation to update what is in ${PKG_SYSCONFDIR}. To achieve this,
5137: the variables CONF_FILES and CONF_FILES_PERMS are used. Check out
1.6 ! rillig 5138: Section 15.1.2, "File manipulation" for information about their syntax and
1.1 dsieger 5139: their purpose. Here is an example, taken from the mail/mutt package:
5140:
5141: EGDIR= ${PREFIX}/share/doc/mutt/samples
5142: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5143:
5144: Note that the EGDIR variable is specific to that package and has no meaning
5145: outside it.
5146:
1.6 ! rillig 5147: 15.2.4. Disabling handling of configuration files
1.1 dsieger 5148:
5149: The automatic copying of config files can be toggled by setting the environment
5150: variable PKG_CONFIG prior to package installation.
5151:
1.6 ! rillig 5152: 15.3. System startup scripts
1.1 dsieger 5153:
5154: System startup scripts are special files because they must be installed in a
5155: place known by the underlying OS, usually outside the installation prefix.
1.6 ! rillig 5156: Therefore, the same rules described in Section 15.1, "Files and directories
1.1 dsieger 5157: outside the installation prefix" apply, and the same solutions can be used.
5158: However, pkginstall provides a special mechanism to handle these files.
5159:
5160: In order to provide system startup scripts, the package has to:
5161:
5162: 1. Store the script inside ${FILESDIR}, with the .sh suffix appended.
5163: Considering the print/cups package as an example, it has a cupsd.sh in its
5164: files directory.
5165:
5166: 2. Tell pkginstall to handle it, appending the name of the script, without its
5167: extension, to the RCD_SCRIPTS variable. Continuing the previous example:
5168:
5169: RCD_SCRIPTS+= cupsd
5170:
5171: Once this is done, pkginstall will do the following steps for each script in an
5172: automated fashion:
5173:
5174: 1. Process the file found in the files directory applying all the
5175: substitutions described in the FILES_SUBST variable.
5176:
5177: 2. Copy the script from the files directory to the examples hierarchy, $
5178: {PREFIX}/share/examples/rc.d/. Note that this master file must be
5179: explicitly registered in the PLIST.
5180:
5181: 3. Add code to the installation scripts to copy the startup script from the
5182: examples hierarchy into the system-wide startup scripts directory.
5183:
1.6 ! rillig 5184: 15.3.1. Disabling handling of system startup scripts
1.1 dsieger 5185:
5186: The automatic copying of config files can be toggled by setting the environment
5187: variable PKG_RCD_SCRIPTS prior to package installation. Note that the scripts
5188: will be always copied inside the examples hierarchy, ${PREFIX}/share/examples/
5189: rc.d/, no matter what the value of this variable is.
5190:
1.6 ! rillig 5191: 15.4. System users and groups
1.1 dsieger 5192:
5193: If a package needs to create special users and/or groups during installation,
5194: it can do so by using the pkginstall framework.
5195:
5196: Users can be created by adding entries to the PKG_USERS variable. Each entry
5197: has the following syntax:
5198:
5199: user:group
5200:
5201: Further specification of user details may be done by setting per-user
5202: variables. PKG_UID.user is the numeric UID for the user. PKG_GECOS.user is the
5203: user's description or comment. PKG_HOME.user is the user's home directory, and
5204: defaults to /nonexistent if not specified. PKG_SHELL.user is the user's shell,
5205: and defaults to /sbin/nologin if not specified.
5206:
5207: Similarly, groups can be created by adding entries to the PKG_GROUPS variable,
5208: whose syntax is:
5209:
5210: group
5211:
5212: The numeric GID of the group may be set by defining PKG_GID.group.
5213:
5214: If a package needs to create the users and groups at an earlier stage, then it
5215: can set USERGROUP_PHASE to either configure or build to indicate the phase
5216: before which the users and groups are created. In this case, the numeric UIDs
5217: and GIDs of the created users and groups are automatically hardcoded into the
5218: final installation scripts.
5219:
1.6 ! rillig 5220: 15.5. System shells
1.1 dsieger 5221:
5222: Packages that install system shells should register them in the shell database,
5223: /etc/shells, to make things easier to the administrator. This must be done from
5224: the installation scripts to keep binary packages working on any system.
5225: pkginstall provides an easy way to accomplish this task.
5226:
5227: When a package provides a shell interpreter, it has to set the PKG_SHELL
5228: variable to its absolute file name. This will add some hooks to the
5229: installation scripts to handle it. Consider the following example, taken from
5230: shells/zsh:
5231:
5232: PKG_SHELL= ${PREFIX}/bin/zsh
5233:
1.6 ! rillig 5234: 15.5.1. Disabling shell registration
1.1 dsieger 5235:
5236: The automatic registration of shell interpreters can be disabled by the
5237: administrator by setting the PKG_REGISTER_SHELLS environment variable to NO.
5238:
1.6 ! rillig 5239: 15.6. Fonts
1.1 dsieger 5240:
5241: Packages that install X11 fonts should update the database files that index the
5242: fonts within each fonts directory. This can easily be accomplished within the
5243: pkginstall framework.
5244:
5245: When a package installs X11 fonts, it must list the directories in which fonts
5246: are installed in the FONTS_DIRS.type variables, where type can be one of "ttf",
5247: "type1" or "x11". This will add hooks to the installation scripts to run the
5248: appropriate commands to update the fonts database files within each of those
5249: directories. For convenience, if the directory path is relative, it is taken to
5250: be relative to the package's installation prefix. Consider the following
5251: example, taken from fonts/dbz-ttf:
5252:
5253: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
5254:
1.6 ! rillig 5255: 15.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 5256:
5257: The automatic update of fonts databases can be disabled by the administrator by
5258: setting the PKG_UPDATE_FONTS_DB environment variable to NO.
5259:
1.6 ! rillig 5260: Chapter 16. Options handling
1.1 dsieger 5261:
5262: Table of Contents
5263:
1.6 ! rillig 5264: 16.1. Global default options
! 5265: 16.2. Converting packages to use bsd.options.mk
! 5266: 16.3. Option Names
1.1 dsieger 5267:
5268: Many packages have the ability to be built to support different sets of
5269: features. bsd.options.mk is a framework in pkgsrc that provides generic
5270: handling of those options that determine different ways in which the packages
5271: can be built. It's possible for the user to specify exactly which sets of
5272: options will be built into a package or to allow a set of global default
5273: options apply.
5274:
1.6 ! rillig 5275: 16.1. Global default options
1.1 dsieger 5276:
5277: Global default options are listed in PKG_DEFAULT_OPTIONS, which is a list of
5278: the options that should be built into every package if that option is
1.4 rillig 5279: supported. This variable should be set in mk.conf.
1.1 dsieger 5280:
1.6 ! rillig 5281: 16.2. Converting packages to use bsd.options.mk
1.1 dsieger 5282:
5283: The following example shows how bsd.options.mk should be used by the
5284: hypothetical ``wibble'' package, either in the package Makefile, or in a file,
5285: e.g. options.mk, that is included by the main package Makefile.
5286:
5287: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
5288: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
5289: PKG_OPTIONS_OPTIONAL_GROUPS= database
5290: PKG_OPTIONS_GROUP.database= mysql pgsql
5291: PKG_SUGGESTED_OPTIONS= wibble-foo
5292: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
5293: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
5294:
5295: .include "../../mk/bsd.prefs.mk"
5296:
5297: # this package was previously named wibble2
5298: .if defined(PKG_OPTIONS.wibble2)
5299: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
5300: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
5301: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
5302: .endif
5303:
5304: .include "../../mk/bsd.options.mk"
5305:
5306: # Package-specific option-handling
5307:
5308: ###
5309: ### FOO support
5310: ###
5311: .if !empty(PKG_OPTIONS:Mwibble-foo)
5312: CONFIGURE_ARGS+= --enable-foo
5313: .endif
5314:
5315: ###
5316: ### LDAP support
5317: ###
5318: .if !empty(PKG_OPTIONS:Mldap)
5319: . include "../../databases/openldap-client/buildlink3.mk"
5320: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
5321: .endif
5322:
5323: ###
5324: ### database support
5325: ###
5326: .if !empty(PKG_OPTIONS:Mmysql)
5327: . include "../../mk/mysql.buildlink3.mk"
5328: .endif
5329: .if !empty(PKG_OPTIONS:Mpgsql)
5330: . include "../../mk/pgsql.buildlink3.mk"
5331: .endif
5332:
5333: The first section contains the information about which build options are
5334: supported by the package, and any default options settings if needed.
5335:
5336: 1. PKG_OPTIONS_VAR is the name of the make(1) variable that the user can set
5337: to override the default options. It should be set to PKG_OPTIONS.pkgbase.
5338: Do not set it to PKG_OPTIONS.${PKGBASE}, since PKGBASE is not defined at
5339: the point where the options are processed.
5340:
5341: 2. PKG_SUPPORTED_OPTIONS is a list of build options supported by the package.
5342:
5343: 3. PKG_OPTIONS_OPTIONAL_GROUPS is a list of names of groups of mutually
5344: exclusive options. The options in each group are listed in
5345: PKG_OPTIONS_GROUP.groupname. The most specific setting of any option from
5346: the group takes precedence over all other options in the group. Options
5347: from the groups will be automatically added to PKG_SUPPORTED_OPTIONS.
5348:
5349: 4. PKG_OPTIONS_REQUIRED_GROUPS is like PKG_OPTIONS_OPTIONAL_GROUPS, but
5350: building the packages will fail if no option from the group is selected.
5351:
5352: 5. PKG_OPTIONS_NONEMPTY_SETS is a list of names of sets of options. At least
5353: one option from each set must be selected. The options in each set are
5354: listed in PKG_OPTIONS_SET.setname. Options from the sets will be
5355: automatically added to PKG_SUPPORTED_OPTIONS. Building the package will
5356: fail if no option from the set is selected.
5357:
5358: 6. PKG_SUGGESTED_OPTIONS is a list of build options which are enabled by
5359: default.
5360:
5361: 7. PKG_OPTIONS_LEGACY_VARS is a list of "USE_VARIABLE:option" pairs that map
1.4 rillig 5362: legacy mk.conf variables to their option counterparts. Pairs should be
1.1 dsieger 5363: added with "+=" to keep the listing of global legacy variables. A warning
5364: will be issued if the user uses a legacy variable.
5365:
5366: 8. PKG_OPTIONS_LEGACY_OPTS is a list of "old-option:new-option" pairs that map
5367: options that have been renamed to their new counterparts. Pairs should be
5368: added with "+=" to keep the listing of global legacy options. A warning
5369: will be issued if the user uses a legacy option.
5370:
5371: 9. PKG_LEGACY_OPTIONS is a list of options implied by deprecated variables
5372: used. This can be used for cases that neither PKG_OPTIONS_LEGACY_VARS nor
5373: PKG_OPTIONS_LEGACY_OPTS can handle, e. g. when PKG_OPTIONS_VAR is renamed.
5374:
5375: 10. PKG_OPTIONS_DEPRECATED_WARNINGS is a list of warnings about deprecated
5376: variables or options used, and what to use instead.
5377:
5378: A package should never modify PKG_DEFAULT_OPTIONS or the variable named in
5379: PKG_OPTIONS_VAR. These are strictly user-settable. To suggest a default set of
5380: options, use PKG_SUGGESTED_OPTIONS.
5381:
5382: PKG_OPTIONS_VAR must be defined before including bsd.options.mk. If none of
5383: PKG_SUPPORTED_OPTIONS, PKG_OPTIONS_OPTIONAL_GROUPS, and
5384: PKG_OPTIONS_REQUIRED_GROUPS are defined (as can happen with platform-specific
5385: options if none of them is supported on the current platform), PKG_OPTIONS is
5386: set to the empty list and the package is otherwise treated as not using the
5387: options framework.
5388:
5389: After the inclusion of bsd.options.mk, the variable PKG_OPTIONS contains the
5390: list of selected build options, properly filtered to remove unsupported and
5391: duplicate options.
5392:
5393: The remaining sections contain the logic that is specific to each option. The
5394: correct way to check for an option is to check whether it is listed in
5395: PKG_OPTIONS:
5396:
5397: .if !empty(PKG_OPTIONS:Moption)
5398:
1.6 ! rillig 5399: 16.3. Option Names
1.1 dsieger 5400:
5401: Options that enable similar features in different packages (like optional
5402: support for a library) should use a common name in all packages that support it
5403: (like the name of the library). If another package already has an option with
5404: the same meaning, use the same name.
5405:
5406: Options that enable features specific to one package, where it's unlikely that
5407: another (unrelated) package has the same (or a similar) optional feature,
5408: should use a name prefixed with pkgname-.
5409:
5410: If a group of related packages share an optional feature specific to that
5411: group, prefix it with the name of the "main" package (e. g.
5412: djbware-errno-hack).
5413:
5414: For new options, add a line to mk/defaults/options.description. Lines have two
5415: fields, separated by tab. The first field is the option name, the second its
5416: description. The description should be a whole sentence (starting with an
5417: uppercase letter and ending with a period) that describes what enabling the
5418: option does. E. g. "Enable ispell support." The file is sorted by option names.
5419:
1.6 ! rillig 5420: Chapter 17. The build process
1.1 dsieger 5421:
5422: Table of Contents
5423:
1.6 ! rillig 5424: 17.1. Introduction
! 5425: 17.2. Program location
! 5426: 17.3. Directories used during the build process
! 5427: 17.4. Running a phase
! 5428: 17.5. The fetch phase
! 5429:
! 5430: 17.5.1. What to fetch and where to get it from
! 5431: 17.5.2. How are the files fetched?
! 5432:
! 5433: 17.6. The checksum phase
! 5434: 17.7. The extract phase
! 5435: 17.8. The patch phase
! 5436: 17.9. The tools phase
! 5437: 17.10. The wrapper phase
! 5438: 17.11. The configure phase
! 5439: 17.12. The build phase
! 5440: 17.13. The test phase
! 5441: 17.14. The install phase
! 5442: 17.15. The package phase
! 5443: 17.16. Cleaning up
! 5444: 17.17. Other helpful targets
1.1 dsieger 5445:
1.6 ! rillig 5446: 17.1. Introduction
1.1 dsieger 5447:
5448: This chapter gives a detailed description on how a package is built. Building a
5449: package is separated into different phases (for example fetch, build, install),
5450: all of which are described in the following sections. Each phase is splitted
5451: into so-called stages, which take the name of the containing phase, prefixed by
5452: one of pre-, do- or post-. (Examples are pre-configure, post-build.) Most of
5453: the actual work is done in the do-* stages.
5454:
5455: Never override the regular targets (like fetch), if you have to, override the
5456: do-* ones instead.
5457:
5458: The basic steps for building a program are always the same. First the program's
5459: source (distfile) must be brought to the local system and then extracted. After
5460: any pkgsrc-specific patches to compile properly are applied, the software can
5461: be configured, then built (usually by compiling), and finally the generated
5462: binaries, etc. can be put into place on the system.
5463:
5464: To get more details about what is happening at each step, you can set the
5465: PKG_VERBOSE variable, or the PATCH_DEBUG variable if you are just interested in
5466: more details about the patch step.
5467:
1.6 ! rillig 5468: 17.2. Program location
1.1 dsieger 5469:
5470: Before outlining the process performed by the NetBSD package system in the next
5471: section, here's a brief discussion on where programs are installed, and which
5472: variables influence this.
5473:
5474: The automatic variable PREFIX indicates where all files of the final program
5475: shall be installed. It is usually set to LOCALBASE (/usr/pkg), or CROSSBASE for
5476: pkgs in the cross category. The value of PREFIX needs to be put into the
5477: various places in the program's source where paths to these files are encoded.
1.6 ! rillig 5478: See Section 11.3, "patches/*" and Section 19.3.1, "Shared libraries - libtool"
1.1 dsieger 5479: for more details.
5480:
5481: When choosing which of these variables to use, follow the following rules:
5482:
5483: * PREFIX always points to the location where the current pkg will be
5484: installed. When referring to a pkg's own installation path, use "${PREFIX}
5485: ".
5486:
5487: * LOCALBASE is where all non-X11 pkgs are installed. If you need to construct
5488: a -I or -L argument to the compiler to find includes and libraries
5489: installed by another non-X11 pkg, use "${LOCALBASE}". The name LOCALBASE
5490: stems from FreeBSD, which installed all packages in /usr/local. As pkgsrc
5491: leaves /usr/local for the system administrator, this variable is a
5492: misnomer.
5493:
5494: * X11BASE is where the actual X11 distribution (from xsrc, etc.) is
5495: installed. When looking for standard X11 includes (not those installed by a
5496: package), use "${X11BASE}".
5497:
5498: * X11-based packages are special in that they may be installed in either
5499: X11BASE or LOCALBASE.
5500:
5501: Usually, X11 packages should be installed under LOCALBASE whenever
5502: possible. Note that you will need to include ../../mk/x11.buildlink3.mk in
5503: them to request the presence of X11 and to get the right compilation flags.
5504:
5505: Even though, there are some packages that cannot be installed under
5506: LOCALBASE: those that come with app-defaults files. These packages are
5507: special and they must be placed under X11BASE. To accomplish this, set
5508: either USE_X11BASE or USE_IMAKE in your package.
5509:
5510: Some notes: If you need to find includes or libraries installed by a pkg
5511: that has USE_IMAKE or USE_X11BASE in its pkg Makefile, you need to look in
5512: both ${X11BASE} and ${LOCALBASE}. To force installation of all X11 packages
5513: in LOCALBASE, the pkgtools/xpkgwedge package is enabled by default.
5514:
5515: * X11PREFIX should be used to refer to the installed location of an X11
5516: package. X11PREFIX will be set to X11BASE if xpkgwedge is not installed,
5517: and to LOCALBASE if xpkgwedge is installed.
5518:
5519: * If xpkgwedge is installed, it is possible to have some packages installed
5520: in X11BASE and some in LOCALBASE. To determine the prefix of an installed
5521: package, the EVAL_PREFIX definition can be used. It takes pairs in the
5522: format "DIRNAME=<package>", and the make(1) variable DIRNAME will be set to
5523: the prefix of the installed package <package>, or "${X11PREFIX}" if the
5524: package is not installed.
5525:
5526: This is best illustrated by example.
5527:
5528: The following lines are taken from pkgsrc/wm/scwm/Makefile:
5529:
5530: EVAL_PREFIX+= GTKDIR=gtk+
5531: CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE:Q}
5532: CONFIGURE_ARGS+= --with-gtk-prefix=${GTKDIR:Q}
5533: CONFIGURE_ARGS+= --enable-multibyte
5534:
5535: Specific defaults can be defined for the packages evaluated using
5536: EVAL_PREFIX, by using a definition of the form:
5537:
5538: GTKDIR_DEFAULT= ${LOCALBASE}
5539:
5540: where GTKDIR corresponds to the first definition in the EVAL_PREFIX pair.
5541:
5542: * Within ${PREFIX}, packages should install files according to hier(7), with
5543: the exception that manual pages go into ${PREFIX}/man, not ${PREFIX}/share/
5544: man.
5545:
1.6 ! rillig 5546: 17.3. Directories used during the build process
1.1 dsieger 5547:
5548: When building a package, a number of directories is used to store source files,
5549: temporary files, pkgsrc-internal files, and so on. These directories are
5550: explained here.
5551:
5552: Some of the directory variables contain relative pathnames. There are two
5553: common base directories for these relative directories: PKGSRCDIR/PKGPATH is
5554: used for directories that are pkgsrc-specific. WRKSRC is used for directories
5555: inside the package itself.
5556:
5557: PKGSRCDIR
5558:
5559: This is an absolute pathname that points to the pkgsrc root directory.
5560: Generally, you don't need it.
5561:
5562: PKGDIR
5563:
5564: This is an absolute pathname that points to the current package.
5565:
5566: PKGPATH
5567:
5568: This is a pathname relative to PKGSRCDIR that points to the current
5569: package.
5570:
5571: WRKDIR
5572:
5573: This is an absolute pathname pointing to the directory where all work takes
5574: place. The distfiles are extracted to this directory. It also contains
5575: temporary directories and log files used by the various pkgsrc frameworks,
5576: like buildlink or the wrappers.
5577:
5578: WRKSRC
5579:
5580: This is an absolute pathname pointing to the directory where the distfiles
5581: are extracted. It is usually a direct subdirectory of WRKDIR, and often
5582: it's the only directory entry that isn't hidden. This variable may be
5583: changed by a package Makefile.
5584:
1.6 ! rillig 5585: 17.4. Running a phase
1.1 dsieger 5586:
5587: You can run a particular phase by typing make phase, where phase is the name of
5588: the phase. This will automatically run all phases that are required for this
5589: phase. The default phase is build, that is, when you run make without
5590: parameters in a package directory, the package will be built, but not
5591: installed.
5592:
1.6 ! rillig 5593: 17.5. The fetch phase
1.1 dsieger 5594:
5595: The first step in building a package is to fetch the distribution files
5596: (distfiles) from the sites that are providing them. This is the task of the
5597: fetch phase.
5598:
1.6 ! rillig 5599: 17.5.1. What to fetch and where to get it from
1.1 dsieger 5600:
5601: In simple cases, MASTER_SITES defines all URLs from where the distfile, whose
5602: name is derived from the DISTNAME variable, is fetched. The more complicated
5603: cases are described below.
5604:
5605: The variable DISTFILES specifies the list of distfiles that have to be fetched.
5606: Its value defaults to ${DISTNAME}${EXTRACT_SUFX}, so that most packages don't
5607: need to define it at all. EXTRACT_SUFX is .tar.gz by default, but can be
5608: changed freely. Note that if your package requires additional distfiles to the
5609: default one, you cannot just append the additional filenames using the +=
5610: operator, but you have write for example:
5611:
5612: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
5613:
5614: Each distfile is fetched from a list of sites, usually MASTER_SITES. If the
5615: package has multiple DISTFILES or multiple PATCHFILES from different sites, you
5616: can set SITES.distfile to the list of URLs where the file distfile (including
5617: the suffix) can be found.
5618:
5619: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
5620: DISTFILES+= foo-file.tar.gz
5621: SITES.foo-file.tar.gz= \
5622: http://www.somewhere.com/somehow/ \
5623: http://www.somewhereelse.com/mirror/somehow/
5624:
5625: When actually fetching the distfiles, each item from MASTER_SITES or SITES.*
5626: gets the name of each distfile appended to it, without an intermediate slash.
5627: Therefore, all site values have to end with a slash or other separator
5628: character. This allows for example to set MASTER_SITES to a URL of a CGI script
5629: that gets the name of the distfile as a parameter. In this case, the definition
5630: would look like:
5631:
5632: MASTER_SITES= http://www.example.com/download.cgi?file=
5633:
5634: There are some predefined values for MASTER_SITES, which can be used in
5635: packages. The names of the variables should speak for themselves.
5636:
5637: ${MASTER_SITE_APACHE}
5638: ${MASTER_SITE_BACKUP}
5639: ${MASTER_SITE_CYGWIN}
5640: ${MASTER_SITE_DEBIAN}
5641: ${MASTER_SITE_FREEBSD}
5642: ${MASTER_SITE_FREEBSD_LOCAL}
5643: ${MASTER_SITE_GENTOO}
5644: ${MASTER_SITE_GNOME}
5645: ${MASTER_SITE_GNU}
5646: ${MASTER_SITE_GNUSTEP}
5647: ${MASTER_SITE_IFARCHIVE}
5648: ${MASTER_SITE_KDE}
5649: ${MASTER_SITE_MOZILLA}
5650: ${MASTER_SITE_MYSQL}
5651: ${MASTER_SITE_OPENOFFICE}
5652: ${MASTER_SITE_PERL_CPAN}
5653: ${MASTER_SITE_PGSQL}
5654: ${MASTER_SITE_R_CRAN}
5655: ${MASTER_SITE_SOURCEFORGE}
5656: ${MASTER_SITE_SOURCEFORGE_JP}
5657: ${MASTER_SITE_SUNSITE}
5658: ${MASTER_SITE_SUSE}
5659: ${MASTER_SITE_TEX_CTAN}
5660: ${MASTER_SITE_XCONTRIB}
5661: ${MASTER_SITE_XEMACS}
5662:
5663: Some explanations for the less self-explaining ones: MASTER_SITE_BACKUP
5664: contains backup sites for packages that are maintained in ftp://ftp.NetBSD.org/
5665: pub/NetBSD/packages/distfiles/${DIST_SUBDIR}. MASTER_SITE_LOCAL contains local
5666: package source distributions that are maintained in ftp://ftp.NetBSD.org/pub/
5667: NetBSD/packages/distfiles/LOCAL_PORTS/.
5668:
5669: If you choose one of these predefined sites, you may want to specify a
5670: subdirectory of that site. Since these macros may expand to more than one
5671: actual site, you must use the following construct to specify a subdirectory:
5672:
5673: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
5674: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
5675:
5676: Note the trailing slash after the subdirectory name.
5677:
1.6 ! rillig 5678: 17.5.2. How are the files fetched?
1.1 dsieger 5679:
5680: The fetch phase makes sure that all the distfiles exist in a local directory
5681: (DISTDIR, which can be set by the pkgsrc user). If the files do not exist, they
5682: are fetched using commands of the form
5683:
5684: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
5685:
5686: where ${site} varies through several possibilities in turn: first,
5687: MASTER_SITE_OVERRIDE is tried, then the sites specified in either SITES.file if
5688: defined, else MASTER_SITES or PATCH_SITES, as applies, then finally the value
5689: of MASTER_SITE_BACKUP. The order of all except the first and the last can be
5690: optionally sorted by the user, via setting either MASTER_SORT_RANDOM, and
5691: MASTER_SORT_AWK or MASTER_SORT_REGEX.
5692:
5693: The distfiles mirror run by the NetBSD Foundation uses the mirror-distfiles
5694: target to mirror the distfiles, if they are freely distributable. Packages
5695: setting NO_SRC_ON_FTP (usually to "${RESTRICTED}") will not have their
5696: distfiles mirrored.
5697:
1.6 ! rillig 5698: 17.6. The checksum phase
1.1 dsieger 5699:
5700: After the distfile(s) are fetched, their checksum is generated and compared
5701: with the checksums stored in the distinfo file. If the checksums don't match,
5702: the build is aborted. This is to ensure the same distfile is used for building,
5703: and that the distfile wasn't changed, e.g. by some malign force, deliberately
5704: changed distfiles on the master distribution site or network lossage.
5705:
1.6 ! rillig 5706: 17.7. The extract phase
1.1 dsieger 5707:
5708: When the distfiles are present on the local system, they need to be extracted,
5709: as they usually come in the form of some compressed archive format.
5710:
5711: By default, all DISTFILES are extracted. If you only need some of them, you can
5712: set the EXTRACT_ONLY variable to the list of those files.
5713:
5714: Extracting the files is usually done by a little program, mk/extract/extract,
5715: which already knows how to extract various archive formats, so most likely you
5716: will not need to change anything here. But if you need, the following variables
5717: may help you:
5718:
5719: EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}
5720:
5721: Use these variables to override the default options for an extract command,
5722: which are defined in mk/extract/extract.
5723:
5724: EXTRACT_USING
5725:
5726: This variable can be set to gtar, nbtar (which is the default value), pax,
5727: or an absolute pathname pointing to the command with which tar archives
5728: should be extracted.
5729:
5730: If the extract program doesn't serve your needs, you can also override the
5731: EXTRACT_CMD variable, which holds the command used for extracting the files.
5732: This command is executed in the ${WRKSRC} directory. During execution of this
5733: command, the shell variable extract_file holds the absolute pathname of the
5734: file that is going to be extracted.
5735:
5736: And if that still does not suffice, you can override the do-extract target in
5737: the package Makefile.
5738:
1.6 ! rillig 5739: 17.8. The patch phase
1.1 dsieger 5740:
5741: After extraction, all the patches named by the PATCHFILES, those present in the
5742: patches subdirectory of the package as well as in $LOCALPATCHES/$PKGPATH (e.g.
5743: /usr/local/patches/graphics/png) are applied. Patchfiles ending in .Z or .gz
5744: are uncompressed before they are applied, files ending in .orig or .rej are
5745: ignored. Any special options to patch(1) can be handed in PATCH_DIST_ARGS. See
1.6 ! rillig 5746: Section 11.3, "patches/*" for more details.
1.1 dsieger 5747:
5748: By default patch(1) is given special args to make it fail if the patches apply
5749: with some lines of fuzz. Please fix (regen) the patches so that they apply
5750: cleanly. The rationale behind this is that patches that don't apply cleanly may
5751: end up being applied in the wrong place, and cause severe harm there.
5752:
1.6 ! rillig 5753: 17.9. The tools phase
1.1 dsieger 5754:
1.6 ! rillig 5755: This is covered in Chapter 18, Tools needed for building or running.
1.1 dsieger 5756:
1.6 ! rillig 5757: 17.10. The wrapper phase
1.1 dsieger 5758:
5759: This phase creates wrapper programs for the compilers and linkers. The
5760: following variables can be used to tweak the wrappers.
5761:
5762: ECHO_WRAPPER_MSG
5763:
5764: The command used to print progress messages. Does nothing by default. Set
5765: to ${ECHO} to see the progress messages.
5766:
5767: WRAPPER_DEBUG
5768:
5769: This variable can be set to yes (default) or no, depending on whether you
5770: want additional information in the wrapper log file.
5771:
5772: WRAPPER_UPDATE_CACHE
5773:
5774: This variable can be set to yes or no, depending on whether the wrapper
5775: should use its cache, which will improve the speed. The default value is
5776: yes, but is forced to no if the platform does not support it.
5777:
5778: WRAPPER_REORDER_CMDS
5779:
5780: A list of reordering commands. A reordering command has the form reorder:l:
5781: lib1:lib2. It ensures that that -llib1 occurs before -llib2.
5782:
5783: WRAPPER_TRANSFORM_CMDS
5784:
5785: A list of transformation commands. [TODO: investigate further]
5786:
1.6 ! rillig 5787: 17.11. The configure phase
1.1 dsieger 5788:
5789: Most pieces of software need information on the header files, system calls, and
5790: library routines which are available on the platform they run on. The process
5791: of determining this information is known as configuration, and is usually
5792: automated. In most cases, a script is supplied with the distfiles, and its
5793: invocation results in generation of header files, Makefiles, etc.
5794:
5795: If the package contains a configure script, this can be invoked by setting
5796: HAS_CONFIGURE to "yes". If the configure script is a GNU autoconf script, you
5797: should set GNU_CONFIGURE to "yes" instead. What happens in the configure phase
5798: is roughly:
5799:
5800: .for d in ${CONFIGURE_DIRS}
5801: cd ${WRKSRC} \
5802: && cd ${d} \
5803: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
5804: .endfor
5805:
5806: CONFIGURE_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In
5807: each of these directories, the configure script is run with the environment
5808: CONFIGURE_ENV and arguments CONFIGURE_ARGS. The variables CONFIGURE_ENV,
5809: CONFIGURE_SCRIPT (default: "./configure") and CONFIGURE_ARGS may all be changed
5810: by the package.
5811:
5812: If the program uses an Imakefile for configuration, the appropriate steps can
5813: be invoked by setting USE_IMAKE to "yes". (If you only want the package
5814: installed in ${X11PREFIX} but xmkmf not being run, set USE_X11BASE instead.)
5815: You can add variables to xmkmf's environment by adding them to the SCRIPTS_ENV
5816: variable.
5817:
5818: If there is no configure step at all, set NO_CONFIGURE to "yes".
5819:
1.6 ! rillig 5820: 17.12. The build phase
1.1 dsieger 5821:
5822: For building a package, a rough equivalent of the following code is executed.
5823:
5824: .for d in ${BUILD_DIRS}
5825: cd ${WRKSRC} \
5826: && cd ${d} \
5827: && env ${MAKE_ENV} \
5828: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
5829: -f ${MAKE_FILE} \
5830: ${BUILD_TARGET}
5831: .endfor
5832:
5833: BUILD_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In each of
5834: these directories, MAKE_PROGRAM is run with the environment MAKE_ENV and
5835: arguments BUILD_MAKE_FLAGS. The variables MAKE_ENV, BUILD_MAKE_FLAGS, MAKE_FILE
5836: and BUILD_TARGET may all be changed by the package.
5837:
5838: The default value of MAKE_PROGRAM is "gmake" if USE_TOOLS contains "gmake",
5839: "make" otherwise. The default value of MAKE_FILE is "Makefile", and
5840: BUILD_TARGET defaults to "all".
5841:
5842: If there is no build step at all, set NO_BUILD to "yes".
5843:
1.6 ! rillig 5844: 17.13. The test phase
1.1 dsieger 5845:
5846: [TODO]
5847:
1.6 ! rillig 5848: 17.14. The install phase
1.1 dsieger 5849:
5850: Once the build stage has completed, the final step is to install the software
5851: in public directories, so users can access the programs and files.
5852:
5853: In the install phase, a rough equivalent of the following code is executed.
5854: Additionally, before and after this code, much magic is performed to do
5855: consistency checks, registering the package, and so on.
5856:
5857: .for d in ${INSTALL_DIRS}
5858: cd ${WRKSRC} \
5859: && cd ${d} \
5860: && env ${MAKE_ENV} \
5861: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
5862: -f ${MAKE_FILE} \
5863: ${INSTALL_TARGET}
5864: .endfor
5865:
5866: The variable's meanings are analogous to the ones in the build phase.
5867: INSTALL_DIRS defaults to BUILD_DIRS. INSTALL_TARGET is "install" by default,
5868: plus "install.man" if USE_IMAKE is defined and NO_INSTALL_MANPAGES is not
5869: defined.
5870:
5871: In the install phase, the following variables are useful. They are all
5872: variations of the install(1) command that have the owner, group and permissions
5873: preset. INSTALL is the plain install command. The specialized variants,
5874: together with their intended use, are:
5875:
5876: INSTALL_PROGRAM_DIR
5877:
5878: directories that contain binaries
5879:
5880: INSTALL_SCRIPT_DIR
5881:
5882: directories that contain scripts
5883:
5884: INSTALL_LIB_DIR
5885:
5886: directories that contain shared and static libraries
5887:
5888: INSTALL_DATA_DIR
5889:
5890: directories that contain data files
5891:
5892: INSTALL_MAN_DIR
5893:
5894: directories that contain man pages
5895:
5896: INSTALL_PROGRAM
5897:
5898: binaries that can be stripped from debugging symbols
5899:
5900: INSTALL_SCRIPT
5901:
5902: binaries that cannot be stripped
5903:
5904: INSTALL_GAME
5905:
5906: game binaries
5907:
5908: INSTALL_LIB
5909:
5910: shared and static libraries
5911:
5912: INSTALL_DATA
5913:
5914: data files
5915:
5916: INSTALL_GAME_DATA
5917:
5918: data files for games
5919:
5920: INSTALL_MAN
5921:
5922: man pages
5923:
5924: Some other variables are:
5925:
5926: INSTALLATION_DIRS
5927:
5928: A list of directories relative to PREFIX that are created by pkgsrc at the
5929: beginning of the install phase. The package is supposed to create all
5930: needed directories itself before installing files to it and list all other
5931: directories here.
5932:
5933: In the rare cases that a package shouldn't install anything, set NO_INSTALL to
5934: "yes". This is mostly relevant for packages in the regress category.
5935:
1.6 ! rillig 5936: 17.15. The package phase
1.1 dsieger 5937:
5938: Once the install stage has completed, a binary package of the installed files
5939: can be built. These binary packages can be used for quick installation without
5940: previous compilation, e.g. by the make bin-install or by using pkg_add.
5941:
5942: By default, the binary packages are created in ${PACKAGES}/All and symlinks are
5943: created in ${PACKAGES}/category, one for each category in the CATEGORIES
5944: variable. PACKAGES defaults to pkgsrc/packages.
5945:
5946: If there should be no binary package, set NO_PACKAGE to "yes". This should only
5947: be used in rare cases, like when a package definitely is only usable on the
5948: machine where it is built and even then, a binary package can be useful.
5949:
1.6 ! rillig 5950: 17.16. Cleaning up
1.1 dsieger 5951:
5952: Once you're finished with a package, you can clean the work directory by
5953: running make clean. If you want to clean the work directories of all
5954: dependencies too, use make clean-depends.
5955:
1.6 ! rillig 5956: 17.17. Other helpful targets
1.1 dsieger 5957:
5958: pre/post-*
5959:
5960: For any of the main targets described in the previous section, two
5961: auxiliary targets exist with "pre-" and "post-" used as a prefix for the
5962: main target's name. These targets are invoked before and after the main
5963: target is called, allowing extra configuration or installation steps be
5964: performed from a package's Makefile, for example, which a program's
5965: configure script or install target omitted.
5966:
5967: do-*
5968:
5969: Should one of the main targets do the wrong thing, and should there be no
5970: variable to fix this, you can redefine it with the do-* target. (Note that
5971: redefining the target itself instead of the do-* target is a bad idea, as
5972: the pre-* and post-* targets won't be called anymore, etc.) You will not
5973: usually need to do this.
5974:
5975: reinstall
5976:
5977: If you did a make install and you noticed some file was not installed
5978: properly, you can repeat the installation with this target, which will
5979: ignore the "already installed" flag.
5980:
5981: This is the default value of DEPENDS_TARGET except in the case of make
5982: update and make package, where the defaults are "package" and "update",
5983: respectively.
5984:
5985: deinstall
5986:
5987: This target does a pkg_delete(1) in the current directory, effectively
5988: de-installing the package. The following variables can be used to tune the
5989: behaviour:
5990:
5991: PKG_VERBOSE
5992:
5993: Add a "-v" to the pkg_delete(1) command.
5994:
5995: DEINSTALLDEPENDS
5996:
5997: Remove all packages that require (depend on) the given package. This
5998: can be used to remove any packages that may have been pulled in by a
5999: given package, e.g. if make deinstall DEINSTALLDEPENDS=1 is done in
6000: pkgsrc/x11/kde, this is likely to remove whole KDE. Works by adding
6001: "-R" to the pkg_delete(1) command line.
6002:
6003: bin-install
6004:
6005: Install a binary package from local disk and via FTP from a list of sites
6006: (see the BINPKG_SITES variable), and do a make package if no binary package
6007: is available anywhere. The arguments given to pkg_add can be set via
6008: BIN_INSTALL_FLAGS e.g., to do verbose operation, etc.
6009:
6010: update
6011:
6012: This target causes the current package to be updated to the latest version.
6013: The package and all depending packages first get de-installed, then current
6014: versions of the corresponding packages get compiled and installed. This is
6015: similar to manually noting which packages are currently installed, then
6016: performing a series of make deinstall and make install (or whatever
6017: UPDATE_TARGET is set to) for these packages.
6018:
6019: You can use the "update" target to resume package updating in case a
6020: previous make update was interrupted for some reason. However, in this
6021: case, make sure you don't call make clean or otherwise remove the list of
6022: dependent packages in WRKDIR. Otherwise, you lose the ability to
6023: automatically update the current package along with the dependent packages
6024: you have installed.
6025:
6026: Resuming an interrupted make update will only work as long as the package
6027: tree remains unchanged. If the source code for one of the packages to be
6028: updated has been changed, resuming make update will most certainly fail!
6029:
1.4 rillig 6030: The following variables can be used either on the command line or in
1.1 dsieger 6031: mk.conf to alter the behaviour of make update:
6032:
6033: UPDATE_TARGET
6034:
6035: Install target to recursively use for the updated package and the
6036: dependent packages. Defaults to DEPENDS_TARGET if set, "install"
6037: otherwise for make update. Other good targets are "package" or
6038: "bin-install". Do not set this to "update" or you will get stuck in an
6039: endless loop!
6040:
6041: NOCLEAN
6042:
6043: Don't clean up after updating. Useful if you want to leave the work
6044: sources of the updated packages around for inspection or other
6045: purposes. Be sure you eventually clean up the source tree (see the
6046: "clean-update" target below) or you may run into troubles with old
6047: source code still lying around on your next make or make update.
6048:
6049: REINSTALL
6050:
6051: Deinstall each package before installing (making DEPENDS_TARGET). This
6052: may be necessary if the "clean-update" target (see below) was called
6053: after interrupting a running make update.
6054:
6055: DEPENDS_TARGET
6056:
6057: Allows you to disable recursion and hardcode the target for packages.
6058: The default is "update" for the update target, facilitating a recursive
6059: update of prerequisite packages. Only set DEPENDS_TARGET if you want to
6060: disable recursive updates. Use UPDATE_TARGET instead to just set a
6061: specific target for each package to be installed during make update
6062: (see above).
6063:
6064: clean-update
6065:
6066: Clean the source tree for all packages that would get updated if make
6067: update was called from the current directory. This target should not be
6068: used if the current package (or any of its depending packages) have already
6069: been de-installed (e.g., after calling make update) or you may lose some
6070: packages you intended to update. As a rule of thumb: only use this target
6071: before the first time you run make update and only if you have a dirty
6072: package tree (e.g., if you used NOCLEAN).
6073:
6074: If you are unsure about whether your tree is clean, you can either perform
6075: a make clean at the top of the tree, or use the following sequence of
6076: commands from the directory of the package you want to update (before
6077: running make update for the first time, otherwise you lose all the packages
6078: you wanted to update!):
6079:
6080: # make clean-update
6081: # make clean CLEANDEPENDS=YES
6082: # make update
6083:
6084:
1.4 rillig 6085: The following variables can be used either on the command line or in
1.1 dsieger 6086: mk.conf to alter the behaviour of make clean-update:
6087:
6088: CLEAR_DIRLIST
6089:
6090: After make clean, do not reconstruct the list of directories to update
6091: for this package. Only use this if make update successfully installed
6092: all packages you wanted to update. Normally, this is done automatically
6093: on make update, but may have been suppressed by the NOCLEAN variable
6094: (see above).
6095:
6096: replace
6097:
6098: Update the installation of the current package. This differs from update in
6099: that it does not replace dependent packages. You will need to install
6100: pkgtools/pkg_tarup for this target to work.
6101:
6102: Be careful when using this target! There are no guarantees that dependent
6103: packages will still work, in particular they will most certainly break if
6104: you make replace a library package whose shared library major version
6105: changed between your installed version and the new one. For this reason,
6106: this target is not officially supported and only recommended for advanced
6107: users.
6108:
6109: info
6110:
6111: This target invokes pkg_info(1) for the current package. You can use this
6112: to check which version of a package is installed.
6113:
6114: index
6115:
6116: This is a top-level command, i.e. it should be used in the pkgsrc
6117: directory. It creates a database of all packages in the local pkgsrc tree,
6118: including dependencies, comment, maintainer, and some other useful
6119: information. Individual entries are created by running make describe in the
6120: packages' directories. This index file is saved as pkgsrc/INDEX. It can be
6121: displayed in verbose format by running make print-index. You can search in
6122: it with make search key=something. You can extract a list of all packages
6123: that depend on a particular one by running make show-deps PKG=somepackage.
6124:
6125: Running this command takes a very long time, some hours even on fast
6126: machines!
6127:
6128: readme
6129:
6130: This target generates a README.html file, which can be viewed using a
6131: browser such as www/firefox or www/links. The generated files contain
6132: references to any packages which are in the PACKAGES directory on the local
6133: host. The generated files can be made to refer to URLs based on
6134: FTP_PKG_URL_HOST and FTP_PKG_URL_DIR. For example, if I wanted to generate
6135: README.html files which pointed to binary packages on the local machine, in
6136: the directory /usr/packages, set FTP_PKG_URL_HOST=file://localhost and
6137: FTP_PKG_URL_DIR=/usr/packages. The ${PACKAGES} directory and its
6138: subdirectories will be searched for all the binary packages.
6139:
6140: The target can be run at the toplevel or in category directories, in which
6141: case it descends recursively.
6142:
6143: readme-all
6144:
6145: This is a top-level command, run it in pkgsrc. Use this target to create a
6146: file README-all.html which contains a list of all packages currently
6147: available in the NetBSD Packages Collection, together with the category
6148: they belong to and a short description. This file is compiled from the
6149: pkgsrc/*/README.html files, so be sure to run this after a make readme.
6150:
6151: cdrom-readme
6152:
6153: This is very much the same as the "readme" target (see above), but is to be
6154: used when generating a pkgsrc tree to be written to a CD-ROM. This target
6155: also produces README.html files, and can be made to refer to URLs based on
6156: CDROM_PKG_URL_HOST and CDROM_PKG_URL_DIR.
6157:
6158: show-distfiles
6159:
6160: This target shows which distfiles and patchfiles are needed to build the
6161: package (ALLFILES, which contains all DISTFILES and PATCHFILES, but not
6162: patches/*).
6163:
6164: show-downlevel
6165:
6166: This target shows nothing if the package is not installed. If a version of
6167: this package is installed, but is not the version provided in this version
6168: of pkgsrc, then a warning message is displayed. This target can be used to
6169: show which of your installed packages are downlevel, and so the old
6170: versions can be deleted, and the current ones added.
6171:
6172: show-pkgsrc-dir
6173:
6174: This target shows the directory in the pkgsrc hierarchy from which the
6175: package can be built and installed. This may not be the same directory as
6176: the one from which the package was installed. This target is intended to be
6177: used by people who may wish to upgrade many packages on a single host, and
6178: can be invoked from the top-level pkgsrc Makefile by using the
6179: "show-host-specific-pkgs" target.
6180:
6181: show-installed-depends
6182:
6183: This target shows which installed packages match the current package's
6184: DEPENDS. Useful if out of date dependencies are causing build problems.
6185:
6186: check-shlibs
6187:
6188: After a package is installed, check all its binaries and (on ELF platforms)
6189: shared libraries to see if they find the shared libs they need. Run by
1.4 rillig 6190: default if PKG_DEVELOPER is set in mk.conf.
1.1 dsieger 6191:
6192: print-PLIST
6193:
6194: After a "make install" from a new or upgraded pkg, this prints out an
6195: attempt to generate a new PLIST from a find -newer work/.extract_done. An
6196: attempt is made to care for shared libs etc., but it is strongly
6197: recommended to review the result before putting it into PLIST. On upgrades,
6198: it's useful to diff the output of this command against an already existing
6199: PLIST file.
6200:
6201: If the package installs files via tar(1) or other methods that don't update
6202: file access times, be sure to add these files manually to your PLIST, as
6203: the "find -newer" command used by this target won't catch them!
6204:
1.6 ! rillig 6205: See Section 13.3, "Tweaking output of make print-PLIST" for more
1.1 dsieger 6206: information on this target.
6207:
6208: bulk-package
6209:
6210: Used to do bulk builds. If an appropriate binary package already exists, no
6211: action is taken. If not, this target will compile, install and package it
1.6 ! rillig 6212: (and its depends, if PKG_DEPENDS is set properly. See Section 7.3.1,
1.1 dsieger 6213: "Configuration"). After creating the binary package, the sources, the
6214: just-installed package and its required packages are removed, preserving
6215: free disk space.
6216:
6217: Beware that this target may deinstall all packages installed on a system!
6218:
6219: bulk-install
6220:
6221: Used during bulk-installs to install required packages. If an up-to-date
6222: binary package is available, it will be installed via pkg_add(1). If not,
6223: make bulk-package will be executed, but the installed binary won't be
6224: removed.
6225:
6226: A binary package is considered "up-to-date" to be installed via pkg_add(1)
6227: if:
6228:
6229: * None of the package's files (Makefile, ...) were modified since it was
6230: built.
6231:
6232: * None of the package's required (binary) packages were modified since it
6233: was built.
6234:
6235: Beware that this target may deinstall all packages installed on a system!
6236:
1.6 ! rillig 6237: Chapter 18. Tools needed for building or running
1.1 dsieger 6238:
6239: Table of Contents
6240:
1.6 ! rillig 6241: 18.1. Tools for pkgsrc builds
! 6242: 18.2. Tools needed by packages
! 6243: 18.3. Tools provided by platforms
! 6244: 18.4. Questions regarding the tools
1.1 dsieger 6245:
6246: The USE_TOOLS definition is used both internally by pkgsrc and also for
6247: individual packages to define what commands are needed for building a package
6248: (like BUILD_DEPENDS) or for later run-time of an installed packaged (such as
6249: DEPENDS). If the native system provides an adequate tool, then in many cases, a
6250: pkgsrc package will not be used.
6251:
6252: When building a package, the replacement tools are made available in a
6253: directory (as symlinks or wrapper scripts) that is early in the executable
6254: search path. Just like the buildlink system, this helps with consistent builds.
6255:
6256: A tool may be needed to help build a specific package. For example, perl, GNU
6257: make (gmake) or yacc may be needed.
6258:
6259: Also a tool may be needed, for example, because the native system's supplied
6260: tool may be inefficient for building a package with pkgsrc. For example, a
6261: package may need GNU awk, bison (instead of yacc) or a better sed.
6262:
6263: The tools used by a package can be listed by running make show-tools.
6264:
1.6 ! rillig 6265: 18.1. Tools for pkgsrc builds
1.1 dsieger 6266:
6267: The default set of tools used by pkgsrc is defined in bsd.pkg.mk. This includes
6268: standard Unix tools, such as: cat, awk, chmod, test, and so on. These can be
6269: seen by running: make show-var VARNAME=USE_TOOLS.
6270:
6271: If a package needs a specific program to build then the USE_TOOLS variable can
6272: be used to define the tools needed.
6273:
1.6 ! rillig 6274: 18.2. Tools needed by packages
1.1 dsieger 6275:
6276: In the following examples, the :pkgsrc means to use the pkgsrc version and not
6277: the native version for a build dependency. And the :run means that it is used
6278: for a run-time dependencies also (and becomes a DEPENDS). The default is a
6279: build dependency which can be set with :build. (So in this example, it is the
6280: same as gmake:build and pkg-config:build.)
6281:
6282: USE_TOOLS+= mktemp:pkgsrc
6283: USE_TOOLS+= gmake perl:run pkg-config
6284:
6285: When using the tools framework, a TOOLS_PATH.foo variable is defined which
6286: contains the full path to the appropriate tool. For example, TOOLS_PATH.bash
6287: could be "/bin/bash" on Linux systems.
6288:
6289: If you always need a pkgsrc version of the tool at run-time, then just use
6290: DEPENDS instead.
6291:
1.6 ! rillig 6292: 18.3. Tools provided by platforms
1.1 dsieger 6293:
6294: When improving or porting pkgsrc to a new platform, have a look at (or create)
6295: the corresponding platform specific make file fragment under pkgsrc/mk/tools/
6296: tools.${OPSYS}.mk which defines the name of the common tools. For example:
6297:
6298: .if exists(/usr/bin/bzcat)
6299: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
6300: .elif exists(/usr/bin/bzip2)
6301: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
6302: .endif
6303:
6304: TOOLS_PLATFORM.true?= true # shell builtin
6305:
1.6 ! rillig 6306: 18.4. Questions regarding the tools
1.1 dsieger 6307:
1.6 ! rillig 6308: 18.4.1. How do I add a new tool?
! 6309: 18.4.2. How do I get a list of all available tools?
! 6310: 18.4.3. How can I get a list of all the tools that a package is using while
1.1 dsieger 6311: being built? I want to know whether it uses sed or not.
6312:
1.6 ! rillig 6313: 18.4.1. How do I add a new tool?
1.1 dsieger 6314:
6315: TODO
6316:
1.6 ! rillig 6317: 18.4.2. How do I get a list of all available tools?
1.1 dsieger 6318:
6319: TODO
6320:
1.6 ! rillig 6321: 18.4.3. How can I get a list of all the tools that a package is using while
1.1 dsieger 6322: being built? I want to know whether it uses sed or not.
6323:
6324: Currently, you can't. (TODO: But I want to be able to do it.)
6325:
1.6 ! rillig 6326: Chapter 19. Making your package work
1.1 dsieger 6327:
6328: Table of Contents
6329:
1.6 ! rillig 6330: 19.1. General operation
1.1 dsieger 6331:
1.6 ! rillig 6332: 19.1.1. Portability of packages
! 6333: 19.1.2. How to pull in user-settable variables from mk.conf
! 6334: 19.1.3. User interaction
! 6335: 19.1.4. Handling licenses
! 6336: 19.1.5. Restricted packages
! 6337: 19.1.6. Handling dependencies
! 6338: 19.1.7. Handling conflicts with other packages
! 6339: 19.1.8. Packages that cannot or should not be built
! 6340: 19.1.9. Packages which should not be deleted, once installed
! 6341: 19.1.10. Handling packages with security problems
! 6342: 19.1.11. How to handle incrementing versions when fixing an existing
1.1 dsieger 6343: package
1.6 ! rillig 6344: 19.1.12. Substituting variable text in the package files (the SUBST
1.1 dsieger 6345: framework)
6346:
1.6 ! rillig 6347: 19.2. Fixing problems in the fetch phase
1.1 dsieger 6348:
1.6 ! rillig 6349: 19.2.1. Packages whose distfiles aren't available for plain downloading
! 6350: 19.2.2. How to handle modified distfiles with the 'old' name
1.1 dsieger 6351:
1.6 ! rillig 6352: 19.3. Fixing problems in the configure phase
1.1 dsieger 6353:
1.6 ! rillig 6354: 19.3.1. Shared libraries - libtool
! 6355: 19.3.2. Using libtool on GNU packages that already support libtool
! 6356: 19.3.3. GNU Autoconf/Automake
! 6357:
! 6358: 19.4. Programming languages
! 6359:
! 6360: 19.4.1. C, C++, and Fortran
! 6361: 19.4.2. Java
! 6362: 19.4.3. Packages containing perl scripts
! 6363: 19.4.4. Other programming languages
! 6364:
! 6365: 19.5. Fixing problems in the build phase
! 6366:
! 6367: 19.5.1. Compiling C and C++ code conditionally
! 6368: 19.5.2. How to handle compiler bugs
! 6369: 19.5.3. Undefined reference to "..."
! 6370: 19.5.4. Running out of memory
! 6371:
! 6372: 19.6. Fixing problems in the install phase
! 6373:
! 6374: 19.6.1. Creating needed directories
! 6375: 19.6.2. Where to install documentation
! 6376: 19.6.3. Installing highscore files
! 6377: 19.6.4. Adding DESTDIR support to packages
! 6378: 19.6.5. Packages with hardcoded paths to other interpreters
! 6379: 19.6.6. Packages installing perl modules
! 6380: 19.6.7. Packages installing info files
! 6381: 19.6.8. Packages installing man pages
! 6382: 19.6.9. Packages installing GConf2 data files
! 6383: 19.6.10. Packages installing scrollkeeper data files
! 6384: 19.6.11. Packages installing X11 fonts
! 6385: 19.6.12. Packages installing GTK2 modules
! 6386: 19.6.13. Packages installing SGML or XML data
! 6387: 19.6.14. Packages installing extensions to the MIME database
! 6388: 19.6.15. Packages using intltool
! 6389: 19.6.16. Packages installing startup scripts
! 6390: 19.6.17. Packages installing TeX modules
! 6391: 19.6.18. Packages supporting running binaries in emulation
! 6392: 19.6.19. Packages installing hicolor theme icons
! 6393: 19.6.20. Packages installing desktop files
1.1 dsieger 6394:
1.6 ! rillig 6395: 19.7. Marking packages as having problems
1.1 dsieger 6396:
1.6 ! rillig 6397: 19.1. General operation
1.1 dsieger 6398:
1.6 ! rillig 6399: 19.1.1. Portability of packages
1.1 dsieger 6400:
6401: One appealing feature of pkgsrc is that it runs on many different platforms. As
6402: a result, it is important to ensure, where possible, that packages in pkgsrc
6403: are portable. This chapter mentions some particular details you should pay
6404: attention to while working on pkgsrc.
6405:
1.6 ! rillig 6406: 19.1.2. How to pull in user-settable variables from mk.conf
1.1 dsieger 6407:
6408: The pkgsrc user can configure pkgsrc by overriding several variables in the
1.4 rillig 6409: file pointed to by MAKECONF, which is mk.conf by default. When you want to use
6410: those variables in the preprocessor directives of make(1) (for example .if or
6411: .for), you need to include the file ../../mk/bsd.prefs.mk before, which in turn
6412: loads the user preferences.
1.1 dsieger 6413:
6414: But note that some variables may not be completely defined after ../../mk/
6415: bsd.prefs.mk has been included, as they may contain references to variables
6416: that are not yet defined. In shell commands this is no problem, since variables
6417: are actually macros, which are only expanded when they are used. But in the
6418: preprocessor directives mentioned above and in dependency lines (of the form
6419: target: dependencies) the variables are expanded at load time.
6420:
6421: Note
6422:
6423: Currently there is no exhaustive list of all variables that tells you whether
6424: they can be used at load time or only at run time, but it is in preparation.
6425:
1.6 ! rillig 6426: 19.1.3. User interaction
1.1 dsieger 6427:
6428: Occasionally, packages require interaction from the user, and this can be in a
6429: number of ways:
6430:
6431: * When fetching the distfiles, some packages require user interaction such as
6432: entering username/password or accepting a license on a web page.
6433:
6434: * When extracting the distfiles, some packages may ask for passwords.
6435:
6436: * help to configure the package before it is built
6437:
6438: * help during the build process
6439:
6440: * help during the installation of a package
6441:
6442: The INTERACTIVE_STAGE definition is provided to notify the pkgsrc mechanism of
6443: an interactive stage which will be needed, and this should be set in the
6444: package's Makefile, e.g.:
6445:
6446: INTERACTIVE_STAGE= build
6447:
6448:
6449: Multiple interactive stages can be specified:
6450:
6451: INTERACTIVE_STAGE= configure install
6452:
6453:
6454: The user can then decide to skip this package by setting the BATCH variable.
6455:
1.6 ! rillig 6456: 19.1.4. Handling licenses
1.1 dsieger 6457:
6458: Authors of software can choose the licence under which software can be copied.
6459: This is due to copyright law, and reasons for license choices are outside the
6460: scope of pkgsrc. The pkgsrc system recognizes that there are a number of
6461: licenses which some users may find objectionable or difficult or impossible to
6462: comply with. The Free Software Foundation has declared some licenses "Free",
6463: and the Open Source Initiative has a definition of "Open Source". The pkgsrc
6464: system, as a policy choice, does not label packages which have licenses that
6465: are Free or Open Source. However, packages without a license meeting either of
6466: those tests are labeled with a license tag denoting the license. Note that a
6467: package with no license to copy trivially does not meet either the Free or Open
6468: Source test.
6469:
6470: For packages which are not Free or Open Source, pkgsrc will not build the
6471: package unless the user has indicated to pkgsrc that packages with that
6472: particular license may be built. Note that this documentation avoids the term
6473: "accepted the license". The pkgsrc system is merely providing a mechanism to
6474: avoid accidentally building a package with a non-free license; judgement and
6475: responsibility remain with the user. (Installation of binary packages are not
6476: currently subject to this mechanism; this is a bug.)
6477:
6478: One might want to only install packages with a BSD license, or the GPL, and not
6479: the other. The pkgsrc license tag mechanism does not provide a way to do this.
6480: It might be possible to put in tags for free licenses, and have a default
6481: ACCEPTABLE_LICENSES variable value, but this is widely viewed as having a very
6482: poor ratio of benefit to work.
6483:
6484: The license tag mechanism is intended to address copyright-related issues
6485: surrounding building, installing and using a package, and not to address
6486: redistribution issues (see RESTRICTED and NO_SRC_ON_FTP, etc.). However, the
6487: above definition of licenses for which tags are not needed implies that
6488: packages with redistribution restrictions should have tags, because Free or
6489: Open Source programs do not have redistribution restrictions.
6490:
6491: Denoting that a package may be copied according to a particular license is done
6492: by placing the license in pkgsrc/licenses and setting the LICENSE variable to a
6493: string identifying the license, e.g. in graphics/xv:
6494:
6495: LICENSE= xv-license
6496:
6497:
6498: When trying to build, the user will get a notice that the package is covered by
6499: a license which has not been placed in the ACCEPTABLE_LICENSES variable:
6500:
6501: % make
6502: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6503: ===> To view the license, enter "/usr/bin/make show-license".
6504: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6505: ===> ACCEPTABLE_LICENSES+=xv-license
6506: *** Error code 1
6507:
6508:
6509: The license can be viewed with make show-license, and if the user so chooses,
1.4 rillig 6510: the line printed above can be added to mk.conf to convey to pkgsrc that it
1.1 dsieger 6511: should not in the future fail because of that license:
6512:
6513: ACCEPTABLE_LICENSES+=xv-license
6514:
6515:
6516: When adding a package with a new license, the license text should be added to
6517: pkgsrc/licenses for displaying. A list of known licenses can be seen in this
6518: directory.
6519:
6520: When the license changes (in a way other than formatting), please make sure
6521: that the new license has a different name (e.g., append the version number if
6522: it exists, or the date). Just because a user told pkgsrc to build programs
6523: under a previous version of a license does not mean that pkgsrc should build
6524: programs under the new licenses. The higher-level point is that pkgsrc does not
6525: evaluate licenses for reasonableness; the only test is a mechanistic test of
6526: whether a particular text has been approved by either of two bodies.
6527:
6528: The use of LICENSE=shareware, LICENSE=no-commercial-use, and similar language
6529: is deprecated because it does not crisply refer to a particular license text.
6530: Another problem with such usage is that it does not enable a user to tell
6531: pkgsrc to proceed for a single package without also telling pkgsrc to proceed
6532: for all packages with that tag.
6533:
1.6 ! rillig 6534: 19.1.5. Restricted packages
1.1 dsieger 6535:
6536: Some licenses restrict how software may be re-distributed. Because a license
6537: tag is required unless the package is Free or Open Source, all packages with
6538: restrictions should have license tags. By declaring the restrictions, package
6539: tools can automatically refrain from e.g. placing binary packages on FTP sites.
6540:
6541: There are four restrictions that may be encoded, which are the cross product of
6542: sources (distfiles) and binaries not being placed on FTP sites and CD-ROMs.
6543: Because this is rarely the exact language in any license, and because non-Free
6544: licenses tend to be different from each other, pkgsrc adopts a definition of
6545: FTP and CD-ROM. Pkgsrc uses "FTP" to mean that the source or binary file should
6546: not be made available over the Internet at no charge. Pkgsrc uses "CD-ROM" to
6547: mean that the source or binary may not be made available on some kind of media,
6548: together with other source and binary packages, and which is sold for a
6549: distribution charge.
6550:
6551: In order to encode these restrictions, the package system defines five make
6552: variables that can be set to note these restrictions:
6553:
6554: * RESTRICTED
6555:
6556: This variable should be set whenever a restriction exists (regardless of
6557: its kind). Set this variable to a string containing the reason for the
6558: restriction. It should be understood that those wanting to understand the
6559: restriction will have to read the license, and perhaps seek advice of
6560: counsel.
6561:
6562: * NO_BIN_ON_CDROM
6563:
6564: Binaries may not be placed on CD-ROM containing other binary packages, for
6565: which a distribution charge may be made. In this case, set this variable to
6566: ${RESTRICTED}.
6567:
6568: * NO_BIN_ON_FTP
6569:
6570: Binaries may not made available on the Internet without charge. In this
6571: case, set this variable to ${RESTRICTED}. If this variable is set, binary
6572: packages will not be included on ftp.NetBSD.org.
6573:
6574: * NO_SRC_ON_CDROM
6575:
6576: Distfiles may not be placed on CD-ROM, together with other distfiles, for
6577: which a fee may be charged. In this case, set this variable to $
6578: {RESTRICTED}.
6579:
6580: * NO_SRC_ON_FTP
6581:
6582: Distfiles may not made available via FTP at no charge. In this case, set
6583: this variable to ${RESTRICTED}. If this variable is set, the distfile(s)
6584: will not be mirrored on ftp.NetBSD.org.
6585:
6586: Please note that the use of NO_PACKAGE, IGNORE, NO_CDROM, or other generic make
6587: variables to denote restrictions is deprecated, because they unconditionally
6588: prevent users from generating binary packages!
6589:
1.6 ! rillig 6590: 19.1.6. Handling dependencies
1.1 dsieger 6591:
6592: Your package may depend on some other package being present - and there are
6593: various ways of expressing this dependency. pkgsrc supports the BUILD_DEPENDS
6594: and DEPENDS definitions, the USE_TOOLS definition, as well as dependencies via
6595: buildlink3.mk, which is the preferred way to handle dependencies, and which
1.6 ! rillig 6596: uses the variables named above. See Chapter 14, Buildlink methodology for more
1.1 dsieger 6597: information.
6598:
6599: The basic difference between the two variables is as follows: The DEPENDS
6600: definition registers that pre-requisite in the binary package so it will be
6601: pulled in when the binary package is later installed, whilst the BUILD_DEPENDS
6602: definition does not, marking a dependency that is only needed for building the
6603: package.
6604:
6605: This means that if you only need a package present whilst you are building, it
6606: should be noted as a BUILD_DEPENDS.
6607:
6608: The format for a BUILD_DEPENDS and a DEPENDS definition is:
6609:
6610: <pre-req-package-name>:../../<category>/<pre-req-package>
6611:
6612:
6613: Please note that the "pre-req-package-name" may include any of the wildcard
6614: version numbers recognized by pkg_info(1).
6615:
6616: 1. If your package needs another package's binaries or libraries to build or
6617: run, and if that package has a buildlink3.mk file available, use it:
6618:
6619: .include "../../graphics/jpeg/buildlink3.mk"
6620:
6621:
6622: 2. If your package needs to use another package to build itself and there is
6623: no buildlink3.mk file available, use the BUILD_DEPENDS definition:
6624:
6625: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
6626:
6627:
6628: 3. If your package needs a library with which to link and again there is no
6629: buildlink3.mk file available, this is specified using the DEPENDS
6630: definition. For example:
6631:
6632: DEPENDS+= xpm-3.4j:../../graphics/xpm
6633:
6634:
6635: You can also use wildcards in package dependences:
6636:
6637: DEPENDS+= xpm-[0-9]*:../../graphics/xpm
6638:
6639:
6640: Note that such wildcard dependencies are retained when creating binary
6641: packages. The dependency is checked when installing the binary package and
6642: any package which matches the pattern will be used. Wildcard dependencies
6643: should be used with care.
6644:
6645: The "-[0-9]*" should be used instead of "-*" to avoid potentially ambiguous
6646: matches such as "tk-postgresql" matching a "tk-*" DEPENDS.
6647:
6648: Wildcards can also be used to specify that a package will only build
6649: against a certain minimum version of a pre-requisite:
6650:
6651: DEPENDS+= tiff>=3.5.4:../../graphics/tiff
6652:
6653:
6654: This means that the package will build against version 3.5.4 of the tiff
6655: library or newer. Such a dependency may be warranted if, for example, the
6656: API of the library has changed with version 3.5.4 and a package would not
6657: compile against an earlier version of tiff.
6658:
6659: Please note that such dependencies should only be updated if a package
6660: requires a newer pre-requisite, but not to denote recommendations such as
6661: ABI changes that do not prevent a package from building correctly. Such
6662: recommendations can be expressed using ABI_DEPENDS:
6663:
6664: ABI_DEPENDS+= tiff>=3.6.1:../../graphics/tiff
6665:
6666:
6667: In addition to the above DEPENDS line, this denotes that while a package
6668: will build against tiff>=3.5.4, at least version 3.6.1 is recommended.
6669: ABI_DEPENDS entries will be turned into dependencies unless explicitly
6670: ignored (in which case a warning will be printed).
6671:
6672: To ignore these ABI dependency recommendations and just use the required
6673: DEPENDS, set USE_ABI_DEPENDS=NO. This may make it easier and faster to
6674: update packages built using pkgsrc, since older compatible dependencies can
6675: continue to be used. This is useful for people who watch their rebuilds
6676: very carefully; it is not very good as a general-purpose hammer. If you use
6677: it, you need to be mindful of possible ABI changes, including those from
6678: the underlying OS.
6679:
6680: Packages that are built with recommendations ignored may not be uploaded to
6681: ftp.NetBSD.org by developers and should not be used across different
6682: systems that may have different versions of binary packages installed.
6683:
6684: For security fixes, please update the package vulnerabilities file. See
1.6 ! rillig 6685: Section 19.1.10, "Handling packages with security problems" for more
1.1 dsieger 6686: information.
6687:
6688: 4. If your package needs some executable to be able to run correctly and if
6689: there's no buildlink3.mk file, this is specified using the DEPENDS
6690: variable. The print/lyx package needs to be able to execute the latex
6691: binary from the teTeX package when it runs, and that is specified:
6692:
6693: DEPENDS+= teTeX-[0-9]*:../../print/teTeX
6694:
6695:
6696: The comment about wildcard dependencies from previous paragraph applies
6697: here, too.
6698:
6699: If your package needs files from another package to build, add the relevant
6700: distribution files to DISTFILES, so they will be extracted automatically. See
6701: the print/ghostscript package for an example. (It relies on the jpeg sources
6702: being present in source form during the build.)
6703:
1.6 ! rillig 6704: 19.1.7. Handling conflicts with other packages
1.1 dsieger 6705:
6706: Your package may conflict with other packages a user might already have
6707: installed on his system, e.g. if your package installs the same set of files as
6708: another package in the pkgsrc tree.
6709:
6710: In this case you can set CONFLICTS to a space-separated list of packages
6711: (including version string) your package conflicts with.
6712:
6713: For example, x11/Xaw3d and x11/Xaw-Xpm install the same shared library, thus
6714: you set in pkgsrc/x11/Xaw3d/Makefile:
6715:
6716: CONFLICTS= Xaw-Xpm-[0-9]*
6717:
6718:
6719: and in pkgsrc/x11/Xaw-Xpm/Makefile:
6720:
6721: CONFLICTS= Xaw3d-[0-9]*
6722:
6723:
6724: Packages will automatically conflict with other packages with the name prefix
6725: and a different version string. "Xaw3d-1.5" e.g. will automatically conflict
6726: with the older version "Xaw3d-1.3".
6727:
1.6 ! rillig 6728: 19.1.8. Packages that cannot or should not be built
1.1 dsieger 6729:
6730: There are several reasons why a package might be instructed to not build under
6731: certain circumstances. If the package builds and runs on most platforms, the
6732: exceptions should be noted with NOT_FOR_PLATFORM. If the package builds and
6733: runs on a small handful of platforms, set ONLY_FOR_PLATFORM instead. Both
6734: ONLY_FOR_PLATFORM and NOT_FOR_PLATFORM are OS triples (OS-version-platform)
6735: that can use glob-style wildcards.
6736:
6737: Some packages are tightly bound to a specific version of an operating system,
6738: e.g. LKMs or sysutils/lsof. Such binary packages are not backwards compatible
6739: with other versions of the OS, and should be uploaded to a version specific
6740: directory on the FTP server. Mark these packages by setting OSVERSION_SPECIFIC
6741: to "yes". This variable is not currently used by any of the package system
6742: internals, but may be used in the future.
6743:
6744: If the package should be skipped (for example, because it provides
6745: functionality already provided by the system), set PKG_SKIP_REASON to a
6746: descriptive message. If the package should fail because some preconditions are
6747: not met, set PKG_FAIL_REASON to a descriptive message.
6748:
1.6 ! rillig 6749: 19.1.9. Packages which should not be deleted, once installed
1.1 dsieger 6750:
6751: To ensure that a package may not be deleted, once it has been installed, the
6752: PKG_PRESERVE definition should be set in the package Makefile. This will be
6753: carried into any binary package that is made from this pkgsrc entry. A
6754: "preserved" package will not be deleted using pkg_delete(1) unless the "-f"
6755: option is used.
6756:
1.6 ! rillig 6757: 19.1.10. Handling packages with security problems
1.1 dsieger 6758:
6759: When a vulnerability is found, this should be noted in localsrc/security/
6760: advisories/pkg-vulnerabilities, and after committing that file, use make upload
6761: in the same directory to update the file on ftp.NetBSD.org.
6762:
6763: After fixing the vulnerability by a patch, its PKGREVISION should be increased
6764: (this is of course not necessary if the problem is fixed by using a newer
6765: release of the software).
6766:
6767: Also, if the fix should be applied to the stable pkgsrc branch, be sure to
6768: submit a pullup request!
6769:
6770: Binary packages already on ftp.NetBSD.org will be handled semi-automatically by
6771: a weekly cron job.
6772:
1.6 ! rillig 6773: 19.1.11. How to handle incrementing versions when fixing an existing package
1.1 dsieger 6774:
6775: When making fixes to an existing package it can be useful to change the version
6776: number in PKGNAME. To avoid conflicting with future versions by the original
6777: author, a "nb1", "nb2", ... suffix can be used on package versions by setting
6778: PKGREVISION=1 (2, ...). The "nb" is treated like a "." by the package tools.
6779: e.g.
6780:
6781: DISTNAME= foo-17.42
6782: PKGREVISION= 9
6783:
6784:
6785: will result in a PKGNAME of "foo-17.42nb9". If you want to use the original
6786: value of PKGNAME without the "nbX" suffix, e.g. for setting DIST_SUBDIR, use
6787: PKGNAME_NOREV.
6788:
6789: When a new release of the package is released, the PKGREVISION should be
6790: removed, e.g. on a new minor release of the above package, things should be
6791: like:
6792:
6793: DISTNAME= foo-17.43
6794:
6795:
6796: PKGREVISION should be incremented for any non-trivial change in the resulting
6797: binary package. Without a PKGREVISION bump, someone with the previous version
6798: installed has no way of knowing that their package is out of date. Thus,
6799: changes without increasing PKGREVISION are essentially labeled "this is so
6800: trivial that no reasonable person would want to upgrade", and this is the rough
6801: test for when increasing PKGREVISION is appropriate. Examples of changes that
6802: do not merit increasing PKGREVISION are:
6803:
6804: * Changing HOMEPAGE, MAINTAINER, or comments in Makefile.
6805:
6806: * Changing build variables if the resulting binary package is the same.
6807:
6808: * Changing DESCR.
6809:
6810: * Adding PKG_OPTIONS if the default options don't change.
6811:
6812: Examples of changes that do merit an increase to PKGREVISION include:
6813:
6814: * Security fixes
6815:
6816: * Changes or additions to a patch file
6817:
6818: * Changes to the PLIST
6819:
6820: PKGREVISION must also be incremented when dependencies have ABI changes.
6821:
1.6 ! rillig 6822: 19.1.12. Substituting variable text in the package files (the SUBST framework)
1.1 dsieger 6823:
6824: When you want to replace the same text in multiple files or when the
6825: replacement text varies, patches alone cannot help. This is where the SUBST
6826: framework comes in. It provides an easy-to-use interface for replacing text in
6827: files. Example:
6828:
6829: SUBST_CLASSES+= fix-paths
6830: SUBST_STAGE.fix-paths= pre-configure
6831: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
6832: SUBST_FILES.fix-paths= src/*.c
6833: SUBST_FILES.fix-paths+= scripts/*.sh
6834: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
6835: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
6836:
6837:
6838: SUBST_CLASSES is a list of identifiers that are used to identify the different
6839: SUBST blocks that are defined. The SUBST framework is heavily used by pkgsrc,
6840: so it is important to always use the += operator with this variable. Otherwise
6841: some substitutions may be skipped.
6842:
6843: The remaining variables of each SUBST block are parameterized with the
6844: identifier from the first line (fix-paths in this case.) They can be seen as
6845: parameters to a function call.
6846:
6847: SUBST_STAGE.* specifies the stage at which the replacement will take place. All
6848: combinations of pre-, do- and post- together with a phase name are possible,
6849: though only few are actually used. Most commonly used are post-patch and
6850: pre-configure. Of these two, pre-configure should be preferred because then it
6851: is possible to run bmake patch and have the state after applying the patches
6852: but before making any other changes. This is especially useful when you are
6853: debugging a package in order to create new patches for it. Similarly,
6854: post-build is preferred over pre-install, because the install phase should
6855: generally be kept as simple as possible. When you use post-build, you have the
6856: same files in the working directory that will be installed later, so you can
6857: check if the substitution has succeeded.
6858:
6859: SUBST_MESSAGE.* is an optional text that is printed just before the
6860: substitution is done.
6861:
6862: SUBST_FILES.* is the list of shell globbing patterns that specifies the files
6863: in which the substitution will take place. The patterns are interpreted
6864: relatively to the WRKSRC directory.
6865:
6866: SUBST_SED.* is a list of arguments to sed(1) that specify the actual
6867: substitution. Every sed command should be prefixed with -e, so that all SUBST
6868: blocks look uniform.
6869:
6870: There are some more variables, but they are so seldomly used that they are only
6871: documented in the mk/subst.mk file.
6872:
1.6 ! rillig 6873: 19.2. Fixing problems in the fetch phase
1.1 dsieger 6874:
1.6 ! rillig 6875: 19.2.1. Packages whose distfiles aren't available for plain downloading
1.1 dsieger 6876:
6877: If you need to download from a dynamic URL you can set DYNAMIC_MASTER_SITES and
6878: a make fetch will call files/getsite.sh with the name of each file to download
6879: as an argument, expecting it to output the URL of the directory from which to
6880: download it. graphics/ns-cult3d is an example of this usage.
6881:
6882: If the download can't be automated, because the user must submit personal
6883: information to apply for a password, or must pay for the source, or whatever,
6884: you can set FETCH_MESSAGE to a list of lines that are displayed to the user
6885: before aborting the build. Example:
6886:
6887: FETCH_MESSAGE= "Please download the files"
6888: FETCH_MESSAGE+= " "${DISTFILES:Q}
6889: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
6890:
6891:
1.6 ! rillig 6892: 19.2.2. How to handle modified distfiles with the 'old' name
1.1 dsieger 6893:
6894: Sometimes authors of a software package make some modifications after the
6895: software was released, and they put up a new distfile without changing the
6896: package's version number. If a package is already in pkgsrc at that time, the
6897: checksum will no longer match. The contents of the new distfile should be
6898: compared against the old one before changing anything, to make sure the
6899: distfile was really updated on purpose, and that no trojan horse or so crept
6900: in. Please mention that the distfiles were compared and what was found in your
6901: commit message. Then, the correct way to work around this is to set DIST_SUBDIR
6902: to a unique directory name, usually based on PKGNAME_NOREV. All DISTFILES and
6903: PATCHFILES for this package will be put in that subdirectory of the local
1.6 ! rillig 6904: distfiles directory. (See Section 19.1.11, "How to handle incrementing versions
1.1 dsieger 6905: when fixing an existing package" for more details.) In case this happens more
6906: often, PKGNAME can be used (thus including the nbX suffix) or a date stamp can
6907: be appended, like ${PKGNAME_NOREV}-YYYYMMDD. Do not forget regenerating the
6908: distinfo file after that, since it contains the DIST_SUBDIR path in the
6909: filenames. Also increase the PKGREVISION if the installed package is different.
6910: Furthermore, a mail to the package's authors seems appropriate telling them
6911: that changing distfiles after releases without changing the file names is not
6912: good practice.
6913:
1.6 ! rillig 6914: 19.3. Fixing problems in the configure phase
1.1 dsieger 6915:
1.6 ! rillig 6916: 19.3.1. Shared libraries - libtool
1.1 dsieger 6917:
6918: pkgsrc supports many different machines, with different object formats like
6919: a.out and ELF, and varying abilities to do shared library and dynamic loading
6920: at all. To accompany this, varying commands and options have to be passed to
6921: the compiler, linker, etc. to get the Right Thing, which can be pretty annoying
6922: especially if you don't have all the machines at your hand to test things. The
6923: devel/libtool pkg can help here, as it just "knows" how to build both static
6924: and dynamic libraries from a set of source files, thus being
6925: platform-independent.
6926:
6927: Here's how to use libtool in a package in seven simple steps:
6928:
6929: 1. Add USE_LIBTOOL=yes to the package Makefile.
6930:
6931: 2. For library objects, use "${LIBTOOL} --mode=compile ${CC}" in place of "$
6932: {CC}". You could even add it to the definition of CC, if only libraries are
6933: being built in a given Makefile. This one command will build both PIC and
6934: non-PIC library objects, so you need not have separate shared and
6935: non-shared library rules.
6936:
6937: 3. For the linking of the library, remove any "ar", "ranlib", and "ld
6938: -Bshareable" commands, and instead use:
6939:
6940: ${LIBTOOL} --mode=link \
6941: ${CC} -o ${.TARGET:.a=.la} \
6942: ${OBJS:.o=.lo} \
6943: -rpath ${PREFIX}/lib \
6944: -version-info major:minor
6945:
6946:
6947: Note that the library is changed to have a .la extension, and the objects
6948: are changed to have a .lo extension. Change OBJS as necessary. This
6949: automatically creates all of the .a, .so.major.minor, and ELF symlinks (if
6950: necessary) in the build directory. Be sure to include "-version-info",
6951: especially when major and minor are zero, as libtool will otherwise strip
6952: off the shared library version.
6953:
6954: From the libtool manual:
6955:
6956: So, libtool library versions are described by three integers:
6957:
6958: CURRENT
6959: The most recent interface number that this library implements.
6960:
6961: REVISION
6962: The implementation number of the CURRENT interface.
6963:
6964: AGE
6965: The difference between the newest and oldest interfaces that
6966: this library implements. In other words, the library implements
6967: all the interface numbers in the range from number `CURRENT -
6968: AGE' to `CURRENT'.
6969:
6970: If two libraries have identical CURRENT and AGE numbers, then the
6971: dynamic linker chooses the library with the greater REVISION number.
6972:
6973:
6974: The "-release" option will produce different results for a.out and ELF
6975: (excluding symlinks) in only one case. An ELF library of the form
6976: "libfoo-release.so.x.y" will have a symlink of "libfoo.so.x.y" on an a.out
6977: platform. This is handled automatically.
6978:
6979: The "-rpath argument" is the install directory of the library being built.
6980:
6981: In the PLIST, include only the .la file, the other files will be added
6982: automatically.
6983:
6984: 4. When linking shared object (.so) files, i.e. files that are loaded via
6985: dlopen(3), NOT shared libraries, use "-module -avoid-version" to prevent
6986: them getting version tacked on.
6987:
6988: The PLIST file gets the foo.so entry.
6989:
6990: 5. When linking programs that depend on these libraries before they are
6991: installed, preface the cc(1) or ld(1) line with "${LIBTOOL} --mode=link",
6992: and it will find the correct libraries (static or shared), but please be
6993: aware that libtool will not allow you to specify a relative path in -L
6994: (such as "-L../somelib"), because it expects you to change that argument to
6995: be the .la file. e.g.
6996:
6997: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
6998:
6999:
7000: should be changed to:
7001:
7002: ${LIBTOOL} --mode=link ${CC} -o someprog ../somelib/somelib.la
7003:
7004:
7005: and it will do the right thing with the libraries.
7006:
7007: 6. When installing libraries, preface the install(1) or cp(1) command with "$
7008: {LIBTOOL} --mode=install", and change the library name to .la. e.g.
7009:
7010: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
7011:
7012:
7013: This will install the static .a, shared library, any needed symlinks, and
7014: run ldconfig(8).
7015:
7016: 7. In your PLIST, include only the .la file (this is a change from previous
7017: behaviour).
7018:
1.6 ! rillig 7019: 19.3.2. Using libtool on GNU packages that already support libtool
1.1 dsieger 7020:
7021: Add USE_LIBTOOL=yes to the package Makefile. This will override the package's
7022: own libtool in most cases. For older libtool using packages, libtool is made by
7023: ltconfig script during the do-configure step; you can check the libtool script
7024: location by doing make configure; find work*/ -name libtool.
7025:
7026: LIBTOOL_OVERRIDE specifies which libtool scripts, relative to WRKSRC, to
7027: override. By default, it is set to "libtool */libtool */*/libtool". If this
7028: does not match the location of the package's libtool script(s), set it as
7029: appropriate.
7030:
7031: If you do not need *.a static libraries built and installed, then use
7032: SHLIBTOOL_OVERRIDE instead.
7033:
7034: If your package makes use of the platform-independent library for loading
7035: dynamic shared objects, that comes with libtool (libltdl), you should include
7036: devel/libltdl/buildlink3.mk.
7037:
7038: Some packages use libtool incorrectly so that the package may not work or build
7039: in some circumstances. Some of the more common errors are:
7040:
7041: * The inclusion of a shared object (-module) as a dependent library in an
7042: executable or library. This in itself isn't a problem if one of two things
7043: has been done:
7044:
7045: 1. The shared object is named correctly, i.e. libfoo.la, not foo.la
7046:
7047: 2. The -dlopen option is used when linking an executable.
7048:
7049: * The use of libltdl without the correct calls to initialisation routines.
7050: The function lt_dlinit() should be called and the macro
7051: LTDL_SET_PRELOADED_SYMBOLS included in executables.
7052:
1.6 ! rillig 7053: 19.3.3. GNU Autoconf/Automake
1.1 dsieger 7054:
7055: If a package needs GNU autoconf or automake to be executed to regenerate the
7056: configure script and Makefile.in makefile templates, then they should be
7057: executed in a pre-configure target.
7058:
7059: For packages that need only autoconf:
7060:
7061: AUTOCONF_REQD= 2.50 # if default version is not good enough
7062: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
7063: ...
7064:
7065: pre-configure:
7066: cd ${WRKSRC} && autoconf
7067:
7068: ...
7069:
7070:
7071: and for packages that need automake and autoconf:
7072:
7073: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
7074: USE_TOOLS+= automake # use "automake14" for automake-1.4
7075: ...
7076:
7077: pre-configure:
7078: set -e; cd ${WRKSRC}; \
7079: aclocal; autoheader; automake -a --foreign -i; autoconf
7080:
7081: ...
7082:
7083:
7084: Packages which use GNU Automake will almost certainly require GNU Make.
7085:
7086: There are times when the configure process makes additional changes to the
7087: generated files, which then causes the build process to try to re-execute the
7088: automake sequence. This is prevented by touching various files in the configure
7089: stage. If this causes problems with your package you can set AUTOMAKE_OVERRIDE=
7090: NO in the package Makefile.
7091:
1.6 ! rillig 7092: 19.4. Programming languages
1.1 dsieger 7093:
1.6 ! rillig 7094: 19.4.1. C, C++, and Fortran
1.1 dsieger 7095:
7096: Compilers for the C, C++, and Fortran languages comes with the NetBSD base
7097: system. By default, pkgsrc assumes that a package is written in C and will hide
1.6 ! rillig 7098: all other compilers (via the wrapper framework, see Chapter 14, Buildlink
1.1 dsieger 7099: methodology).
7100:
7101: To declare which language's compiler a package needs, set the USE_LANGUAGES
7102: variable. Allowed values currently are "c", "c++", and "fortran" (and any
7103: combination). The default is "c". Packages using GNU configure scripts, even if
7104: written in C++, usually need a C compiler for the configure phase.
7105:
1.6 ! rillig 7106: 19.4.2. Java
1.1 dsieger 7107:
7108: If a program is written in Java, use the Java framework in pkgsrc. The package
7109: must include ../../mk/java-vm.mk. This Makefile fragment provides the following
7110: variables:
7111:
7112: * USE_JAVA defines if a build dependency on the JDK is added. If USE_JAVA is
7113: set to "run", then there is only a runtime dependency on the JDK. The
7114: default is "yes", which also adds a build dependency on the JDK.
7115:
7116: * Set USE_JAVA2 to declare that a package needs a Java2 implementation. The
7117: supported values are "yes", "1.4", and "1.5". "yes" accepts any Java2
7118: implementation, "1.4" insists on versions 1.4 or above, and "1.5" only
7119: accepts versions 1.5 or above. This variable is not set by default.
7120:
1.6 ! rillig 7121: 19.4.3. Packages containing perl scripts
1.1 dsieger 7122:
7123: If your package contains interpreted perl scripts, add "perl" to the USE_TOOLS
7124: variable and set REPLACE_PERL to ensure that the proper interpreter path is
7125: set. REPLACE_PERL should contain a list of scripts, relative to WRKSRC, that
7126: you want adjusted. Every occurrence of */bin/perl will be replaced with the
7127: full path to the perl executable.
7128:
7129: If a particular version of perl is needed, set the PERL5_REQD variable to the
7130: version number. The default is "5.0".
7131:
1.6 ! rillig 7132: See Section 19.6.6, "Packages installing perl modules" for information about
1.1 dsieger 7133: handling perl modules.
7134:
1.6 ! rillig 7135: 19.4.4. Other programming languages
1.1 dsieger 7136:
7137: Currently, there is no special handling for other languages in pkgsrc. If a
7138: compiler package provides a buildlink3.mk file, include that, otherwise just
7139: add a (build) dependency on the appropriate compiler package.
7140:
1.6 ! rillig 7141: 19.5. Fixing problems in the build phase
1.1 dsieger 7142:
7143: The most common failures when building a package are that some platforms do not
7144: provide certain header files, functions or libraries, or they provide the
7145: functions in a library that the original package author didn't know. To work
7146: around this, you can rewrite the source code in most cases so that it does not
7147: use the missing functions or provides a replacement function.
7148:
1.6 ! rillig 7149: 19.5.1. Compiling C and C++ code conditionally
1.1 dsieger 7150:
7151: If a package already comes with a GNU configure script, the preferred way to
7152: fix the build failure is to change the configure script, not the code. In the
7153: other cases, you can utilize the C preprocessor, which defines certain macros
7154: depending on the operating system and hardware architecture it compiles for.
7155: These macros can be queried using for example #if defined(__i386). Almost every
7156: operating system, hardware architecture and compiler has its own macro. For
7157: example, if the macros __GNUC__, __i386__ and __NetBSD__ are all defined, you
7158: know that you are using NetBSD on an i386 compatible CPU, and your compiler is
7159: GCC.
7160:
7161: The list of the following macros for hardware and operating system depends on
7162: the compiler that is used. For example, if you want to conditionally compile
7163: code on Solaris, don't use __sun__, as the SunPro compiler does not define it.
7164: Use __sun instead.
7165:
1.6 ! rillig 7166: 19.5.1.1. C preprocessor macros to identify the operating system
1.1 dsieger 7167:
7168: To distinguish between 4.4 BSD-derived systems and the rest of the world, you
7169: should use the following code.
7170:
7171: #include <sys/param.h>
7172: #if (defined(BSD) && BSD >= 199306)
7173: /* BSD-specific code goes here */
7174: #else
7175: /* non-BSD-specific code goes here */
7176: #endif
7177:
7178: If this distinction is not fine enough, you can also test for the following
7179: macros.
7180:
7181: FreeBSD __FreeBSD__
7182: DragonFly __DragonFly__
7183: Interix __INTERIX
7184: IRIX __sgi (TODO: get a definite source for this)
7185: Linux linux, __linux, __linux__
7186: NetBSD __NetBSD__
7187: OpenBSD __OpenBSD__
7188: Solaris sun, __sun
7189:
1.6 ! rillig 7190: 19.5.1.2. C preprocessor macros to identify the hardware architecture
1.1 dsieger 7191:
7192: i386 i386, __i386, __i386__
7193: MIPS __mips
7194: SPARC sparc, __sparc
7195:
1.6 ! rillig 7196: 19.5.1.3. C preprocessor macros to identify the compiler
1.1 dsieger 7197:
7198: GCC __GNUC__ (major version), __GNUC_MINOR__
7199: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7200: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7201: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
7202:
1.6 ! rillig 7203: 19.5.2. How to handle compiler bugs
1.1 dsieger 7204:
7205: Some source files trigger bugs in the compiler, based on combinations of
7206: compiler version and architecture and almost always relation to optimisation
7207: being enabled. Common symptoms are gcc internal errors or never finishing
7208: compiling a file.
7209:
7210: Typically, a workaround involves testing the MACHINE_ARCH and compiler version,
7211: disabling optimisation for that combination of file, MACHINE_ARCH and compiler,
7212: and documenting it in pkgsrc/doc/HACKS. See that file for a number of examples.
7213:
1.6 ! rillig 7214: 19.5.3. Undefined reference to "..."
1.1 dsieger 7215:
7216: This error message often means that a package did not link to a shared library
7217: it needs. The following functions are known to cause this error message over
7218: and over.
7219:
7220: +-----------------------------------------------------+
7221: | Function |Library |Affected platforms|
7222: |-------------------------+--------+------------------|
7223: |accept, bind, connect |-lsocket|Solaris |
7224: |-------------------------+--------+------------------|
7225: |crypt |-lcrypt |DragonFly, NetBSD |
7226: |-------------------------+--------+------------------|
7227: |dlopen, dlsym |-ldl |Linux |
7228: |-------------------------+--------+------------------|
7229: |gethost* |-lnsl |Solaris |
7230: |-------------------------+--------+------------------|
7231: |inet_aton |-lresolv|Solaris |
7232: |-------------------------+--------+------------------|
7233: |nanosleep, sem_*, timer_*|-lrt |Solaris |
7234: |-------------------------+--------+------------------|
7235: |openpty |-lutil |Linux |
7236: +-----------------------------------------------------+
7237:
7238: To fix these linker errors, it is often sufficient to say LIBS.OperatingSystem+
7239: = -lfoo to the package Makefile and then say bmake clean; bmake.
7240:
1.6 ! rillig 7241: 19.5.3.1. Special issue: The SunPro compiler
1.1 dsieger 7242:
7243: When you are using the SunPro compiler, there is another possibility. That
7244: compiler cannot handle the following code:
7245:
7246: extern int extern_func(int);
7247:
7248: static inline int
7249: inline_func(int x)
7250: {
7251: return extern_func(x);
7252: }
7253:
7254: int main(void)
7255: {
7256: return 0;
7257: }
7258:
7259: It generates the code for inline_func even if that function is never used. This
7260: code then refers to extern_func, which can usually not be resolved. To solve
7261: this problem you can try to tell the package to disable inlining of functions.
7262:
1.6 ! rillig 7263: 19.5.4. Running out of memory
1.1 dsieger 7264:
7265: Sometimes packages fail to build because the compiler runs into an operating
7266: system specific soft limit. With the UNLIMIT_RESOURCES variable pkgsrc can be
7267: told to unlimit the resources. Currently, the allowed values are "datasize" and
7268: "stacksize" (or both). Setting this variable is similar to running the shell
7269: builtin ulimit command to raise the maximum data segment size or maximum stack
7270: size of a process, respectively, to their hard limits.
7271:
1.6 ! rillig 7272: 19.6. Fixing problems in the install phase
1.1 dsieger 7273:
1.6 ! rillig 7274: 19.6.1. Creating needed directories
1.1 dsieger 7275:
7276: The BSD-compatible install supplied with some operating systems cannot create
7277: more than one directory at a time. As such, you should call ${INSTALL_*_DIR}
7278: like this:
7279:
7280: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
7281: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
7282:
7283:
7284: You can also just append "dir1 dir2" to the INSTALLATION_DIRS variable, which
7285: will automatically do the right thing.
7286:
1.6 ! rillig 7287: 19.6.2. Where to install documentation
1.1 dsieger 7288:
7289: In general, documentation should be installed into ${PREFIX}/share/doc/$
7290: {PKGBASE} or ${PREFIX}/share/doc/${PKGNAME} (the latter includes the version
7291: number of the package).
7292:
7293: Many modern packages using GNU autoconf allow to set the directory where HTML
7294: documentation is installed with the "--with-html-dir" option. Sometimes using
7295: this flag is needed because otherwise the documentation ends up in ${PREFIX}/
7296: share/doc/html or other places.
7297:
7298: An exception to the above is that library API documentation generated with the
7299: textproc/gtk-doc tools, for use by special browsers (devhelp) should be left at
7300: their default location, which is ${PREFIX}/share/gtk-doc. Such documentation
7301: can be recognized from files ending in .devhelp or .devhelp2. (It is also
7302: acceptable to install such files in ${PREFIX}/share/doc/${PKGBASE} or ${PREFIX}
7303: /share/doc/${PKGNAME}; the .devhelp* file must be directly in that directory
7304: then, no additional subdirectory level is allowed in this case. This is usually
7305: achieved by using "--with-html-dir=${PREFIX}/share/doc". ${PREFIX}/share/
7306: gtk-doc is preferred though.)
7307:
1.6 ! rillig 7308: 19.6.3. Installing highscore files
1.1 dsieger 7309:
7310: Certain packages, most of them in the games category, install a score file that
7311: allows all users on the system to record their highscores. In order for this to
7312: work, the binaries need to be installed setgid and the score files owned by the
7313: appropriate group and/or owner (traditionally the "games" user/group). The
7314: following variables, documented in more detail in mk/defaults/mk.conf, control
7315: this behaviour: SETGIDGAME, GAMEDATAMODE, GAMEGRP, GAMEMODE, GAMEOWN.
7316:
7317: Note that per default, setgid installation of games is disabled; setting
7318: SETGIDGAME=YES will set all the other variables accordingly.
7319:
7320: A package should therefor never hard code file ownership or access permissions
7321: but rely on INSTALL_GAME and INSTALL_GAME_DATA to set these correctly.
7322:
1.6 ! rillig 7323: 19.6.4. Adding DESTDIR support to packages
1.4 rillig 7324:
7325: * All installation operations have to be prefixed with ${DESTDIR}.
7326:
7327: * automake gets this DESTDIR mostly right automatically. Many manual rules
7328: and pre/post-install often are incorrect; fix them.
7329:
7330: * If files are installed with special owner/group either use @owner/@group in
7331: the PLIST (preferred) or use SPECIAL_PERMS (discouraged). Note that @owner/
7332: @group are sticky during install, keep this in mind.
7333:
7334: * In general, packages should support UNPRIVILEGED to be able to use DESTDIR.
7335:
1.6 ! rillig 7336: 19.6.5. Packages with hardcoded paths to other interpreters
1.1 dsieger 7337:
7338: Your package may also contain scripts with hardcoded paths to other
7339: interpreters besides (or as well as) perl. To correct the full pathname to the
7340: script interpreter, you need to set the following definitions in your Makefile
7341: (we shall use tclsh in this example):
7342:
7343: REPLACE_INTERPRETER+= tcl
7344: REPLACE.tcl.old= .*/bin/tclsh
7345: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
7346: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
7347: # relative to ${WRKSRC}, just as in REPLACE_PERL
7348:
7349:
7350: Note
7351:
7352: Before March 2006, these variables were called _REPLACE.* and _REPLACE_FILES.*.
7353:
1.6 ! rillig 7354: 19.6.6. Packages installing perl modules
1.1 dsieger 7355:
7356: Makefiles of packages providing perl5 modules should include the Makefile
7357: fragment ../../lang/perl5/module.mk. It provides a do-configure target for the
7358: standard perl configuration for such modules as well as various hooks to tune
7359: this configuration. See comments in this file for details.
7360:
7361: Perl5 modules will install into different places depending on the version of
7362: perl used during the build process. To address this, pkgsrc will append lines
7363: to the PLIST corresponding to the files listed in the installed .packlist file
7364: generated by most perl5 modules. This is invoked by defining PERL5_PACKLIST to
7365: a space-separated list of paths to packlist files, e.g.:
7366:
7367: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
7368:
7369:
7370: The variables PERL5_SITELIB, PERL5_SITEARCH, and PERL5_ARCHLIB represent the
7371: three locations in which perl5 modules may be installed, and may be used by
7372: perl5 packages that don't have a packlist. These three variables are also
7373: substituted for in the PLIST.
7374:
1.6 ! rillig 7375: 19.6.7. Packages installing info files
1.1 dsieger 7376:
7377: Some packages install info files or use the "makeinfo" or "install-info"
7378: commands. INFO_FILES should be defined in the package Makefile so that INSTALL
7379: and DEINSTALL scripts will be generated to handle registration of the info
7380: files in the Info directory file. The "install-info" command used for the info
7381: files registration is either provided by the system, or by a special purpose
7382: package automatically added as dependency if needed.
7383:
7384: PKGINFODIR is the directory under ${PREFIX} where info files are primarily
7385: located. PKGINFODIR defaults to "info" and can be overridden by the user.
7386:
7387: The info files for the package should be listed in the package PLIST; however
7388: any split info files need not be listed.
7389:
7390: A package which needs the "makeinfo" command at build time must add "makeinfo"
7391: to USE_TOOLS in its Makefile. If a minimum version of the "makeinfo" command is
7392: needed it should be noted with the TEXINFO_REQD variable in the package
7393: Makefile. By default, a minimum version of 3.12 is required. If the system does
7394: not provide a makeinfo command or if it does not match the required minimum, a
7395: build dependency on the devel/gtexinfo package will be added automatically.
7396:
7397: The build and installation process of the software provided by the package
7398: should not use the install-info command as the registration of info files is
7399: the task of the package INSTALL script, and it must use the appropriate
7400: makeinfo command.
7401:
7402: To achieve this goal, the pkgsrc infrastructure creates overriding scripts for
7403: the install-info and makeinfo commands in a directory listed early in PATH.
7404:
7405: The script overriding install-info has no effect except the logging of a
7406: message. The script overriding makeinfo logs a message and according to the
7407: value of TEXINFO_REQD either runs the appropriate makeinfo command or exit on
7408: error.
7409:
1.6 ! rillig 7410: 19.6.8. Packages installing man pages
1.1 dsieger 7411:
7412: All packages that install manual pages should install them into the same
7413: directory, so that there is one common place to look for them. In pkgsrc, this
7414: place is ${PREFIX}/${PKGMANDIR}, and this expression should be used in
7415: packages. The default for PKGMANDIR is "man". Another often-used value is
7416: "share/man".
7417:
7418: Note
7419:
7420: The support for a custom PKGMANDIR is far from complete.
7421:
7422: The PLIST files can just use man/ as the top level directory for the man page
7423: file entries, and the pkgsrc framework will convert as needed. In all other
7424: places, the correct PKGMANDIR must be used.
7425:
7426: Packages that are configured with GNU_CONFIGURE set as "yes", by default will
7427: use the ./configure --mandir switch to set where the man pages should be
7428: installed. The path is GNU_CONFIGURE_MANDIR which defaults to ${PREFIX}/$
7429: {PKGMANDIR}.
7430:
7431: Packages that use GNU_CONFIGURE but do not use --mandir, can set
7432: CONFIGURE_HAS_MANDIR to "no". Or if the ./configure script uses a non-standard
7433: use of --mandir, you can set GNU_CONFIGURE_MANDIR as needed.
7434:
1.6 ! rillig 7435: See Section 13.5, "Man page compression" for information on installation of
1.1 dsieger 7436: compressed manual pages.
7437:
1.6 ! rillig 7438: 19.6.9. Packages installing GConf2 data files
1.1 dsieger 7439:
7440: If a package installs .schemas or .entries files, used by GConf2, you need to
7441: take some extra steps to make sure they get registered in the database:
7442:
7443: 1. Include ../../devel/GConf2/schemas.mk instead of its buildlink3.mk file.
7444: This takes care of rebuilding the GConf2 database at installation and
7445: deinstallation time, and tells the package where to install GConf2 data
7446: files using some standard configure arguments. It also disallows any access
7447: to the database directly from the package.
7448:
7449: 2. Ensure that the package installs its .schemas files under ${PREFIX}/share/
7450: gconf/schemas. If they get installed under ${PREFIX}/etc, you will need to
7451: manually patch the package.
7452:
7453: 3. Check the PLIST and remove any entries under the etc/gconf directory, as
1.6 ! rillig 7454: they will be handled automatically. See Section 9.13, "How do I change the
1.1 dsieger 7455: location of configuration files?" for more information.
7456:
7457: 4. Define the GCONF2_SCHEMAS variable in your Makefile with a list of all
7458: .schemas files installed by the package, if any. Names must not contain any
7459: directories in them.
7460:
7461: 5. Define the GCONF2_ENTRIES variable in your Makefile with a list of all
7462: .entries files installed by the package, if any. Names must not contain any
7463: directories in them.
7464:
1.6 ! rillig 7465: 19.6.10. Packages installing scrollkeeper data files
1.1 dsieger 7466:
7467: If a package installs .omf files, used by scrollkeeper, you need to take some
7468: extra steps to make sure they get registered in the database:
7469:
7470: 1. Include ../../textproc/scrollkeeper/omf.mk instead of its buildlink3.mk
7471: file. This takes care of rebuilding the scrollkeeper database at
7472: installation and deinstallation time, and disallows any access to it
7473: directly from the package.
7474:
7475: 2. Check the PLIST and remove any entries under the libdata/scrollkeeper
7476: directory, as they will be handled automatically.
7477:
7478: 3. Remove the share/omf directory from the PLIST. It will be handled by
7479: scrollkeeper.
7480:
1.6 ! rillig 7481: 19.6.11. Packages installing X11 fonts
1.1 dsieger 7482:
7483: If a package installs font files, you will need to rebuild the fonts database
7484: in the directory where they get installed at installation and deinstallation
7485: time. This can be automatically done by using the pkginstall framework.
7486:
7487: You can list the directories where fonts are installed in the FONTS_DIRS.type
7488: variables, where type can be one of "ttf", "type1" or "x11". Also make sure
7489: that the database file fonts.dir is not listed in the PLIST.
7490:
7491: Note that you should not create new directories for fonts; instead use the
7492: standard ones to avoid that the user needs to manually configure his X server
7493: to find them.
7494:
1.6 ! rillig 7495: 19.6.12. Packages installing GTK2 modules
1.1 dsieger 7496:
7497: If a package installs GTK2 immodules or loaders, you need to take some extra
7498: steps to get them registered in the GTK2 database properly:
7499:
7500: 1. Include ../../x11/gtk2/modules.mk instead of its buildlink3.mk file. This
7501: takes care of rebuilding the database at installation and deinstallation
7502: time.
7503:
7504: 2. Set GTK2_IMMODULES=YES if your package installs GTK2 immodules.
7505:
7506: 3. Set GTK2_LOADERS=YES if your package installs GTK2 loaders.
7507:
7508: 4. Patch the package to not touch any of the GTK2 databases directly. These
7509: are:
7510:
7511: * libdata/gtk-2.0/gdk-pixbuf.loaders
7512:
7513: * libdata/gtk-2.0/gtk.immodules
7514:
7515: 5. Check the PLIST and remove any entries under the libdata/gtk-2.0 directory,
7516: as they will be handled automatically.
7517:
1.6 ! rillig 7518: 19.6.13. Packages installing SGML or XML data
1.1 dsieger 7519:
7520: If a package installs SGML or XML data files that need to be registered in
7521: system-wide catalogs (like DTDs, sub-catalogs, etc.), you need to take some
7522: extra steps:
7523:
7524: 1. Include ../../textproc/xmlcatmgr/catalogs.mk in your Makefile, which takes
7525: care of registering those files in system-wide catalogs at installation and
7526: deinstallation time.
7527:
7528: 2. Set SGML_CATALOGS to the full path of any SGML catalogs installed by the
7529: package.
7530:
7531: 3. Set XML_CATALOGS to the full path of any XML catalogs installed by the
7532: package.
7533:
7534: 4. Set SGML_ENTRIES to individual entries to be added to the SGML catalog.
7535: These come in groups of three strings; see xmlcatmgr(1) for more
7536: information (specifically, arguments recognized by the 'add' action). Note
7537: that you will normally not use this variable.
7538:
7539: 5. Set XML_ENTRIES to individual entries to be added to the XML catalog. These
7540: come in groups of three strings; see xmlcatmgr(1) for more information
7541: (specifically, arguments recognized by the 'add' action). Note that you
7542: will normally not use this variable.
7543:
1.6 ! rillig 7544: 19.6.14. Packages installing extensions to the MIME database
1.1 dsieger 7545:
7546: If a package provides extensions to the MIME database by installing .xml files
7547: inside ${PREFIX}/share/mime/packages, you need to take some extra steps to
7548: ensure that the database is kept consistent with respect to these new files:
7549:
7550: 1. Include ../../databases/shared-mime-info/mimedb.mk (avoid using the
7551: buildlink3.mk file from this same directory, which is reserved for
7552: inclusion from other buildlink3.mk files). It takes care of rebuilding the
7553: MIME database at installation and deinstallation time, and disallows any
7554: access to it directly from the package.
7555:
7556: 2. Check the PLIST and remove any entries under the share/mime directory,
7557: except for files saved under share/mime/packages. The former are handled
7558: automatically by the update-mime-database program, but the latter are
7559: package-dependent and must be removed by the package that installed them in
7560: the first place.
7561:
7562: 3. Remove any share/mime/* directories from the PLIST. They will be handled by
7563: the shared-mime-info package.
7564:
1.6 ! rillig 7565: 19.6.15. Packages using intltool
1.1 dsieger 7566:
7567: If a package uses intltool during its build, add intltool to the USE_TOOLS,
7568: which forces it to use the intltool package provided by pkgsrc, instead of the
7569: one bundled with the distribution file.
7570:
7571: This tracks intltool's build-time dependencies and uses the latest available
7572: version; this way, the package benefits of any bug fixes that may have appeared
7573: since it was released.
7574:
1.6 ! rillig 7575: 19.6.16. Packages installing startup scripts
1.1 dsieger 7576:
7577: If a package contains a rc.d script, it won't be copied into the startup
7578: directory by default, but you can enable it, by adding the option
1.4 rillig 7579: PKG_RCD_SCRIPTS=YES in mk.conf. This option will copy the scripts into /etc/
7580: rc.d when a package is installed, and it will automatically remove the scripts
7581: when the package is deinstalled.
1.1 dsieger 7582:
1.6 ! rillig 7583: 19.6.17. Packages installing TeX modules
1.1 dsieger 7584:
7585: If a package installs TeX packages into the texmf tree, the ls-R database of
7586: the tree needs to be updated.
7587:
7588: Note
7589:
7590: Except the main TeX packages such as teTeX-texmf, packages should install files
7591: into PKG_LOCALTEXMFPREFIX, not PKG_TEXMFPREFIX.
7592:
7593: 1. Include ../../print/teTeX/module.mk instead of ../../mk/tex.buildlink3.mk.
7594: This takes care of rebuilding the ls-R database at installation and
7595: deinstallation time.
7596:
7597: 2. If your package installs files into a texmf tree other than the one at
7598: PKG_LOCALTEXMFPREFIX, set TEXMFDIRS to the list of all texmf trees that
7599: need database update.
7600:
7601: If your package also installs font map files that need to be registered
7602: using updmap, set TEX_FONTMAPS to the list of all such font map files. Then
7603: updmap will be run automatically at installation/deinstallation to enable/
7604: disable font map files for TeX output drivers.
7605:
7606: 3. Make sure that none of ls-R databases are included in PLIST, as they will
7607: be removed only by the teTeX-bin package.
7608:
1.6 ! rillig 7609: 19.6.18. Packages supporting running binaries in emulation
1.1 dsieger 7610:
7611: There are some packages that provide libraries and executables for running
7612: binaries from a one operating system on a different one (if the latter supports
7613: it). One example is running Linux binaries on NetBSD.
7614:
7615: The pkgtools/rpm2pkg helps in extracting and packaging Linux rpm packages.
7616:
7617: The CHECK_SHLIBS can be set to no to avoid the check-shlibs target, which tests
7618: if all libraries for each installed executable can be found by the dynamic
7619: linker. Since the standard dynamic linker is run, this fails for emulation
7620: packages, because the libraries used by the emulation are not in the standard
7621: directories.
7622:
1.6 ! rillig 7623: 19.6.19. Packages installing hicolor theme icons
1.1 dsieger 7624:
7625: If a package installs images under the share/icons/hicolor and/or updates the
7626: share/icons/hicolor/icon-theme.cache database, you need to take some extra
7627: steps to make sure that the shared theme directory is handled appropriately and
7628: that the cache database is rebuilt:
7629:
7630: 1. Include ../../graphics/hicolor-icon-theme/buildlink3.mk.
7631:
7632: 2. Check the PLIST and remove the entry that refers to the theme cache.
7633:
7634: 3. Ensure that the PLIST does not remove the shared icon directories from the
7635: share/icons/hicolor hierarchy because they will be handled automatically.
7636:
7637: The best way to verify that the PLIST is correct with respect to the last two
7638: points is to regenerate it using make print-PLIST.
7639:
1.6 ! rillig 7640: 19.6.20. Packages installing desktop files
1.1 dsieger 7641:
7642: If a package installs .desktop files under share/applications and these include
7643: MIME information, you need to take extra steps to ensure that they are
7644: registered into the MIME database:
7645:
7646: 1. Include ../../sysutils/desktop-file-utils/desktopdb.mk.
7647:
7648: 2. Check the PLIST and remove the entry that refers to the share/applications/
7649: mimeinfo.cache file. It will be handled automatically.
7650:
7651: The best way to verify that the PLIST is correct with respect to the last point
7652: is to regenerate it using make print-PLIST.
7653:
1.6 ! rillig 7654: 19.7. Marking packages as having problems
1.1 dsieger 7655:
7656: In some cases one does not have the time to solve a problem immediately. There
7657: are currently two ways to declare that one knows that a package has problems.
7658:
7659: * The first way is to plainly mark it as broken. For this, one just sets the
7660: variable BROKEN to the reason why the package is broken (similar to the
7661: RESTRICTED variable). A user trying to build the package will immediately
7662: be shown this message, and the build will not be even tried.
7663:
7664: * After each pkgsrc freeze period (a time when the tree is stabilized and a
7665: new pkgsrc branch is cut), the packages that were not building in the
7666: official branch build on the latest NetBSD release will be marked as broken
7667: on that branch. This is done by setting the BROKEN_IN variable to the
7668: branch name (or appending the branch name to it). If a user tries to build
7669: such a package and the build fails, the user gets a message that says that
7670: the package was broken on the respective branch(es).
7671:
7672: Both types of packages are removed from pkgsrc in irregular intervals.
7673:
1.6 ! rillig 7674: Chapter 20. Debugging
1.1 dsieger 7675:
7676: To check out all the gotchas when building a package, here are the steps that I
7677: do in order to get a package working. Please note this is basically the same as
7678: what was explained in the previous sections, only with some debugging aids.
7679:
1.4 rillig 7680: * Be sure to set PKG_DEVELOPER=yes in mk.conf.
1.1 dsieger 7681:
7682: * Install pkgtools/url2pkg, create a directory for a new package, change into
7683: it, then run url2pkg:
7684:
7685: % mkdir /usr/pkgsrc/category/examplepkg
7686: % cd /usr/pkgsrc/category/examplepkg
7687: % url2pkg http://www.example.com/path/to/distfile.tar.gz
7688:
7689: * Edit the Makefile as requested.
7690:
7691: * Fill in the DESCR file
7692:
7693: * Run make configure
7694:
7695: * Add any dependencies glimpsed from documentation and the configure step to
7696: the package's Makefile.
7697:
7698: * Make the package compile, doing multiple rounds of
7699:
7700: % make
7701: % pkgvi ${WRKSRC}/some/file/that/does/not/compile
7702: % mkpatches
7703: % patchdiff
7704: % mv ${WRKDIR}/.newpatches/* patches
7705: % make mps
7706: % make clean
7707:
7708: Doing this step as non-root user will ensure that no files are modified
7709: that shouldn't be, especially during the build phase. mkpatches, patchdiff
7710: and pkgvi are from the pkgtools/pkgdiff package.
7711:
1.6 ! rillig 7712: * Look at the Makefile, fix if necessary; see Section 11.1, "Makefile".
1.1 dsieger 7713:
7714: * Generate a PLIST:
7715:
7716: # make install
7717: # make print-PLIST >PLIST
7718: # make deinstall
7719: # make install
7720: # make deinstall
7721:
7722: You usually need to be root to do this. Look if there are any files left:
7723:
7724: # make print-PLIST
7725:
7726: If this reveals any files that are missing in PLIST, add them.
7727:
7728: * Now that the PLIST is OK, install the package again and make a binary
7729: package:
7730:
7731: # make reinstall
7732: # make package
7733:
7734: * Delete the installed package:
7735:
7736: # pkg_delete examplepkg
7737:
7738: * Repeat the above make print-PLIST command, which shouldn't find anything
7739: now:
7740:
7741: # make print-PLIST
7742:
7743: * Reinstall the binary package:
7744:
7745: # pkg_add .../examplepkg.tgz
7746:
7747: * Play with it. Make sure everything works.
7748:
7749: * Run pkglint from pkgtools/pkglint, and fix the problems it reports:
7750:
7751: # pkglint
7752:
1.6 ! rillig 7753: * Submit (or commit, if you have cvs access); see Chapter 21, Submitting and
1.1 dsieger 7754: Committing.
7755:
1.6 ! rillig 7756: Chapter 21. Submitting and Committing
1.1 dsieger 7757:
7758: Table of Contents
7759:
1.6 ! rillig 7760: 21.1. Submitting binary packages
! 7761: 21.2. Submitting source packages (for non-NetBSD-developers)
! 7762: 21.3. General notes when adding, updating, or removing packages
! 7763: 21.4. Committing: Importing a package into CVS
! 7764: 21.5. Updating a package to a newer version
! 7765: 21.6. Moving a package in pkgsrc
1.1 dsieger 7766:
1.6 ! rillig 7767: 21.1. Submitting binary packages
1.1 dsieger 7768:
7769: Our policy is that we accept binaries only from pkgsrc developers to guarantee
7770: that the packages don't contain any trojan horses etc. This is not to annoy
7771: anyone but rather to protect our users! You're still free to put up your
7772: home-made binary packages and tell the world where to get them. NetBSD
7773: developers doing bulk builds and wanting to upload them please see
1.6 ! rillig 7774: Section 7.3.8, "Uploading results of a bulk build".
1.1 dsieger 7775:
1.6 ! rillig 7776: 21.2. Submitting source packages (for non-NetBSD-developers)
1.1 dsieger 7777:
7778: First, check that your package is complete, compiles and runs well; see
1.6 ! rillig 7779: Chapter 20, Debugging and the rest of this document. Next, generate an
1.1 dsieger 7780: uuencoded gzipped tar(1) archive that contains all files that make up the
7781: package. Finally, send this package to the pkgsrc bug tracking system, either
7782: with the send-pr(1) command, or if you don't have that, go to the web page
1.4 rillig 7783: http://www.NetBSD.org/support/send-pr.html, which contains some instructions
7784: and a link to a form, where you can submit packages.
1.1 dsieger 7785:
7786: In the form of the problem report, the category should be "pkg", the synopsis
7787: should include the package name and version number, and the description field
7788: should contain a short description of your package (contents of the COMMENT
7789: variable or DESCR file are OK). The uuencoded package data should go into the
7790: "fix" field.
7791:
7792: If you want to submit several packages, please send a separate PR for each one,
7793: it's easier for us to track things that way.
7794:
7795: Alternatively, you can also import new packages into pkgsrc-wip ("pkgsrc
7796: work-in-progress"); see the homepage at http://pkgsrc-wip.sourceforge.net/ for
7797: details.
7798:
1.6 ! rillig 7799: 21.3. General notes when adding, updating, or removing packages
1.1 dsieger 7800:
7801: Please note all package additions, updates, moves, and removals in pkgsrc/doc/
7802: CHANGES-YYYY. It's very important to keep this file up to date and conforming
7803: to the existing format, because it will be used by scripts to automatically
7804: update pages on www.NetBSD.org and other sites. Additionally, check the pkgsrc/
7805: doc/TODO file and remove the entry for the package you updated or removed, in
7806: case it was mentioned there.
7807:
7808: When the PKGREVISION of a package is bumped, the change should appear in pkgsrc
7809: /doc/CHANGES-YYYY if it is security related or otherwise relevant. Mass bumps
7810: that result from a dependency being updated should not be mentioned. In all
7811: other cases it's the developer's decision.
7812:
7813: There is a make target that helps in creating proper CHANGES-YYYY entries: make
7814: changes-entry. It uses the optional CTYPE and NETBSD_LOGIN_NAME variables. The
7815: general usage is to first make sure that your CHANGES-YYYY file is up-to-date
7816: (to avoid having to resolve conflicts later-on) and then to cd to the package
7817: directory. For package updates, make changes-entry is enough. For new packages,
7818: or package moves or removals, set the CTYPE variable on the command line to
1.4 rillig 7819: "Added", "Moved", or "Removed". You can set NETBSD_LOGIN_NAME in mk.conf if
7820: your local login name is not the same as your NetBSD login name. Don't forget
7821: to commit the changes to pkgsrc/doc/CHANGES-YYYY!
1.1 dsieger 7822:
1.6 ! rillig 7823: 21.4. Committing: Importing a package into CVS
1.1 dsieger 7824:
7825: This section is only of interest for pkgsrc developers with write access to the
7826: pkgsrc repository. Please remember that cvs imports files relative to the
7827: current working directory, and that the pathname that you give the cvs import
7828: command is so that it knows where to place the files in the repository. Newly
7829: created packages should be imported with a vendor tag of "TNF" and a release
7830: tag of "pkgsrc-base", e.g:
7831:
7832: $ cd .../pkgsrc/category/pkgname
7833: $ cvs import pkgsrc/category/pkgname TNF pkgsrc-base
7834:
7835: Remember to move the directory from which you imported out of the way, or cvs
7836: will complain the next time you "cvs update" your source tree. Also don't
7837: forget to add the new package to the category's Makefile.
7838:
7839: The commit message of the initial import should include part of the DESCR file,
7840: so people reading the mailing lists know what the package is/does.
7841:
7842: For new packages, "cvs import" is preferred to "cvs add" because the former
7843: gets everything with a single command, and provides a consistent tag.
7844:
1.6 ! rillig 7845: 21.5. Updating a package to a newer version
1.1 dsieger 7846:
7847: Please always put a concise, appropriate and relevant summary of the changes
7848: between old and new versions into the commit log when updating a package. There
7849: are various reasons for this:
7850:
7851: * A URL is volatile, and can change over time. It may go away completely or
7852: its information may be overwritten by newer information.
7853:
7854: * Having the change information between old and new versions in our CVS
7855: repository is very useful for people who use either cvs or anoncvs.
7856:
7857: * Having the change information between old and new versions in our CVS
7858: repository is very useful for people who read the pkgsrc-changes mailing
7859: list, so that they can make tactical decisions about when to upgrade the
7860: package.
7861:
7862: Please also recognize that, just because a new version of a package has been
7863: released, it should not automatically be upgraded in the CVS repository. We
7864: prefer to be conservative in the packages that are included in pkgsrc -
7865: development or beta packages are not really the best thing for most places in
7866: which pkgsrc is used. Please use your judgement about what should go into
7867: pkgsrc, and bear in mind that stability is to be preferred above new and
7868: possibly untested features.
7869:
1.6 ! rillig 7870: 21.6. Moving a package in pkgsrc
1.1 dsieger 7871:
7872: 1. Make a copy of the directory somewhere else.
7873:
7874: 2. Remove all CVS dirs.
7875:
7876: Alternatively to the first two steps you can also do:
7877:
7878: % cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package
7879:
7880: and use that for further work.
7881:
7882: 3. Fix CATEGORIES and any DEPENDS paths that just did "../package" instead of
7883: "../../category/package".
7884:
7885: 4. cvs import the modified package in the new place.
7886:
7887: 5. Check if any package depends on it:
7888:
7889: % cd /usr/pkgsrc
7890: % grep /package */*/Makefile* */*/buildlink*
7891:
7892: 6. Fix paths in packages from step 5 to point to new location.
7893:
7894: 7. cvs rm (-f) the package at the old location.
7895:
7896: 8. Remove from oldcategory/Makefile.
7897:
7898: 9. Add to newcategory/Makefile.
7899:
7900: 10. Commit the changed and removed files:
7901:
7902: % cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile
7903:
7904: (and any packages from step 5, of course).
7905:
1.6 ! rillig 7906: Chapter 22. Frequently Asked Questions
1.1 dsieger 7907:
7908: This section contains the answers to questions that may arise when you are
7909: writing a package. If you don't find your question answered here, first have a
7910: look in the other chapters, and if you still don't have the answer, ask on the
7911: pkgsrc-users mailing list.
7912:
1.6 ! rillig 7913: 22.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
! 7914: 22.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
! 7915: 22.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
! 7916: 22.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and
1.1 dsieger 7917: BUILDLINK_LIBS?
1.6 ! rillig 7918: 22.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
! 7919: 22.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1 dsieger 7920: the := inside it.
1.6 ! rillig 7921: 22.7. Which mailing lists are there for package developers?
! 7922: 22.8. Where is the pkgsrc documentation?
! 7923: 22.9. I have a little time to kill. What shall I do?
1.1 dsieger 7924:
1.6 ! rillig 7925: 22.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
1.1 dsieger 7926:
7927: MAKEFLAGS are the flags passed to the pkgsrc-internal invocations of make
7928: (1), while MAKE_FLAGS are the flags that are passed to the MAKE_PROGRAM
7929: when building the package. [FIXME: What is .MAKEFLAGS for?]
7930:
1.6 ! rillig 7931: 22.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
1.1 dsieger 7932:
7933: MAKE is the path to the make(1) program that is used in the pkgsrc
7934: infrastructure. GMAKE is the path to GNU Make, but you need to say
7935: USE_TOOLS+=gmake to use that. MAKE_PROGRAM is the path to the Make
7936: program that is used for building the package.
7937:
1.6 ! rillig 7938: 22.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
1.1 dsieger 7939:
7940: CC is the path to the real C compiler, which can be configured by the
7941: pkgsrc user. PKG_CC is the path to the compiler wrapper. PKGSRC_COMPILER
7942: is not a path to a compiler, but the type of compiler that should be
7943: used. See mk/compiler.mk for more information about the latter variable.
7944:
1.6 ! rillig 7945: 22.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and
1.1 dsieger 7946: BUILDLINK_LIBS?
7947:
7948: [FIXME]
7949:
1.6 ! rillig 7950: 22.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
1.1 dsieger 7951:
7952: For optimization reasons, some variables are only available in the
7953: "wrapper" phase and later. To "simulate" the wrapper phase, append
7954: PKG_PHASE=wrapper to the above command.
7955:
1.6 ! rillig 7956: 22.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1 dsieger 7957: the := inside it.
7958:
7959: The := is not really an assignment operator, like you might expect at
7960: first sight. Instead, it is a degenerate form of ${LIST:old_string=
7961: new_string}, which is documented in the make(1) man page and which you
7962: may have seen as in ${SRCS:.c=.o}. In the case of MASTER_SITE_*,
7963: old_string is the empty string and new_string is package/. That's where
7964: the : and the = fall together.
7965:
1.6 ! rillig 7966: 22.7. Which mailing lists are there for package developers?
1.1 dsieger 7967:
7968: tech-pkg
7969:
7970: This is a list for technical discussions related to pkgsrc
7971: development, e.g. soliciting feedback for changes to pkgsrc
7972: infrastructure, proposed new features, questions related to porting
7973: pkgsrc to a new platform, advice for maintaining a package, patches
7974: that affect many packages, help requests moved from pkgsrc-users when
7975: an infrastructure bug is found, etc.
7976:
7977: pkgsrc-bugs
7978:
7979: All bug reports in category "pkg" sent with send-pr(1) appear here.
7980: Please do not report your bugs here directly; use one of the other
7981: mailing lists.
7982:
1.6 ! rillig 7983: 22.8. Where is the pkgsrc documentation?
1.1 dsieger 7984:
7985: There are many places where you can find documentation about pkgsrc:
7986:
7987: * The pkgsrc guide (this document) is a collection of chapters that
7988: explain large parts of pkgsrc, but some chapters tend to be outdated.
7989: Which ones they are is hard to say.
7990:
7991: * On the mailing list archives (see http://mail-index.NetBSD.org/), you
7992: can find discussions about certain features, announcements of new
7993: parts of the pkgsrc infrastructure and sometimes even announcements
7994: that a certain feature has been marked as obsolete. The benefit here
7995: is that each message has a date appended to it.
7996:
7997: * Many of the files in the mk/ directory start with a comment that
7998: describes the purpose of the file and how it can be used by the
7999: pkgsrc user and package authors. An easy way to find this
8000: documentation is to run bmake help.
8001:
8002: * The CVS log messages are a rich source of information, but they tend
8003: to be highly abbreviated, especially for actions that occur often.
8004: Some contain a detailed description of what has changed, but they are
8005: geared towards the other pkgsrc developers, not towards an average
8006: pkgsrc user. They also only document changes, so if you don't know
8007: what has been before, these messages may not be worth too much to
8008: you.
8009:
8010: * Some parts of pkgsrc are only "implicitly documented", that is the
8011: documentation exists only in the mind of the developer who wrote the
8012: code. To get this information, use the cvs annotate command to see
8013: who has written it and ask on the tech-pkg mailing list, so that
8014: others can find your questions later (see above). To be sure that the
8015: developer in charge reads the mail, you may CC him or her.
8016:
1.6 ! rillig 8017: 22.9. I have a little time to kill. What shall I do?
1.1 dsieger 8018:
8019: This is not really an FAQ yet, but here's the answer anyway.
8020:
8021: * Run pkg_chk -N (from the pkgtools/pkg_chk package). It will tell you
8022: about newer versions of installed packages that are available, but
8023: not yet updated in pkgsrc.
8024:
8025: * Browse pkgsrc/doc/TODO ? it contains a list of suggested new packages
8026: and a list of cleanups and enhancements for pkgsrc that would be nice
8027: to have.
8028:
8029: * Review packages for which review was requested on the pkgsrc-wip
8030: review mailing list.
8031:
1.6 ! rillig 8032: Chapter 23. GNOME packaging and porting
1.1 dsieger 8033:
8034: Table of Contents
8035:
1.6 ! rillig 8036: 23.1. Meta packages
! 8037: 23.2. Packaging a GNOME application
! 8038: 23.3. Updating GNOME to a newer version
! 8039: 23.4. Patching guidelines
1.1 dsieger 8040:
8041: Quoting GNOME's web site:
8042:
8043: The GNOME project provides two things: The GNOME desktop environment, an
8044: intuitive and attractive desktop for users, and the GNOME development
8045: platform, an extensive framework for building applications that integrate
8046: into the rest of the desktop.
8047:
8048: pkgsrc provides a seamless way to automatically build and install a complete
8049: GNOME environment under many different platforms. We can say with confidence
8050: that pkgsrc is one of the most advanced build and packaging systems for GNOME
8051: due to its included technologies buildlink3, the wrappers and tools framework
8052: and automatic configuration file management. Lots of efforts are put into
8053: achieving a completely clean deinstallation of installed software components.
8054:
8055: Given that pkgsrc is NetBSD's official packaging system, the above also means
8056: that great efforts are put into making GNOME work under this operating system.
8057: Recently, DragonFly BSD also adopted pkgsrc as its preferred packaging system,
8058: contributing lots of portability fixes to make GNOME build and install under
8059: it.
8060:
8061: This chapter is aimed at pkgsrc developers and other people interested in
8062: helping our GNOME porting and packaging efforts. It provides instructions on
8063: how to manage the existing packages and some important information regarding
8064: their internals.
8065:
8066: We need your help!
8067:
8068: Should you have some spare cycles to devote to NetBSD, pkgsrc and GNOME and are
8069: willing to learn new exciting stuff, please jump straight to the pending work
8070: list! There is still a long way to go to get a fully-functional GNOME desktop
8071: under NetBSD and we need your help to achieve it!
8072:
1.6 ! rillig 8073: 23.1. Meta packages
1.1 dsieger 8074:
8075: pkgsrc includes three GNOME-related meta packages:
8076:
8077: * meta-pkgs/gnome-base: Provides the core GNOME desktop environment. It only
8078: includes the necessary bits to get it to boot correctly, although it may
8079: lack important functionality for daily operation. The idea behind this
8080: package is to let end users build their own configurations on top of this
8081: one, first installing this meta package to achieve a functional setup and
8082: then adding individual applications.
8083:
8084: * meta-pkgs/gnome: Provides a complete installation of the GNOME platform and
8085: desktop as defined by the GNOME project; this is based on the components
8086: distributed in the platform/x.y/x.y.z/sources and desktop/x.y/x.y.z/sources
8087: directories of the official FTP server. Developer-only tools found in those
8088: directories are not installed unless required by some other component to
8089: work properly. Similarly, packages from the bindings set (bindings/x.y/
8090: x.y.z/sources) are not pulled in unless required as a dependency for an
8091: end-user component. This package "extends" meta-pkgs/gnome-base.
8092:
8093: * meta-pkgs/gnome-devel: Installs all the tools required to build a GNOME
8094: component when fetched from the CVS repository. These are required to let
8095: the autogen.sh scripts work appropriately.
8096:
8097: In all these packages, the DEPENDS lines are sorted in a way that eases
8098: updates: a package may depend on other packages listed before it but not on any
8099: listed after it. It is very important to keep this order to ease updates so...
8100: do not change it to alphabetical sorting!
8101:
1.6 ! rillig 8102: 23.2. Packaging a GNOME application
1.1 dsieger 8103:
8104: Almost all GNOME applications are written in C and use a common set of tools as
8105: their build system. Things get different with the new bindings to other
8106: languages (such as Python), but the following will give you a general idea on
8107: the minimum required tools:
8108:
8109: * Almost all GNOME applications use the GNU Autotools as their build system.
8110: As a general rule you will need to tell this to your package:
8111:
8112: GNU_CONFIGURE=yes
8113: USE_LIBTOOL=yes
8114: USE_TOOLS+=gmake
8115:
8116: * If the package uses pkg-config to detect dependencies, add this tool to the
8117: list of required utilities:
8118:
8119: USE_TOOLS+=pkg-config
8120:
8121: Also use pkgtools/verifypc at the end of the build process to ensure that
8122: you did not miss to specify any dependency in your package and that the
8123: version requirements are all correct.
8124:
8125: * If the package uses intltool, be sure to add intltool to the USE_TOOLS to
8126: handle dependencies and to force the package to use the latest available
8127: version.
8128:
8129: * If the package uses gtk-doc (a documentation generation utility), do not
8130: add a dependency on it. The tool is rather big and the distfile should come
8131: with pregenerated documentation anyway; if it does not, it is a bug that
8132: you ought to report. For such packages you should disable gtk-doc (unless
8133: it is the default):
8134:
8135: CONFIGURE_ARGS+=--disable-gtk-doc
8136:
8137: The default location of installed HTML files (share/gtk-doc/<package-name>)
8138: is correct and should not be changed unless the package insists on
8139: installing them somewhere else. Otherwise programs as devhelp will not be
8140: able to open them. You can do that with an entry similar to:
8141:
8142: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
8143:
8144: GNOME uses multiple shared directories and files under the installation prefix
8145: to maintain databases. In this context, shared means that those exact same
8146: directories and files are used among several different packages, leading to
8147: conflicts in the PLIST. pkgsrc currently includes functionality to handle the
8148: most common cases, so you have to forget about using @unexec ${RMDIR} lines in
8149: your file lists and omitting shared files from them. If you find yourself doing
8150: those, your package is most likely incorrect.
8151:
8152: The following table lists the common situations that result in using shared
8153: directories or files. For each of them, the appropriate solution is given.
8154: After applying the solution be sure to regenerate the package's file list with
8155: make print-PLIST and ensure it is correct.
8156:
1.6 ! rillig 8157: Table 23.1. PLIST handling for GNOME packages
1.1 dsieger 8158:
8159: +-----------------------------------------------------------------------------+
8160: | If the package... | Then... |
8161: |-------------------------------------------+---------------------------------|
1.6 ! rillig 8162: | |See Section 19.6.10, "Packages |
1.1 dsieger 8163: |Installs OMF files under share/omf. |installing scrollkeeper data |
8164: | |files". |
8165: |-------------------------------------------+---------------------------------|
1.6 ! rillig 8166: |Installs icons under the share/icons/ |See Section 19.6.19, "Packages |
1.1 dsieger 8167: |hicolor hierarchy or updates share/icons/ |installing hicolor theme icons". |
8168: |hicolor/icon-theme.cache. | |
8169: |-------------------------------------------+---------------------------------|
1.6 ! rillig 8170: | |See Section 19.6.14, "Packages |
1.1 dsieger 8171: |Installs files under share/mime/packages. |installing extensions to the MIME|
8172: | |database". |
8173: |-------------------------------------------+---------------------------------|
1.6 ! rillig 8174: |Installs .desktop files under share/ |See Section 19.6.20, "Packages |
1.1 dsieger 8175: |applications and these include MIME |installing desktop files". |
8176: |information. | |
8177: +-----------------------------------------------------------------------------+
8178:
8179:
1.6 ! rillig 8180: 23.3. Updating GNOME to a newer version
1.1 dsieger 8181:
8182: When seeing GNOME as a whole, there are two kinds of updates:
8183:
8184: Major update
8185:
8186: Given that there is still a very long way for GNOME 3 (if it ever appears),
8187: we consider a major update one that goes from a 2.X version to a 2.Y one,
8188: where Y is even and greater than X. These are hard to achieve because they
8189: introduce lots of changes in the components' code and almost all GNOME
8190: distfiles are updated to newer versions. Some of them can even break API
8191: and ABI compatibility with the previous major version series. As a result,
8192: the update needs to be done all at once to minimize breakage.
8193:
8194: A major update typically consists of around 80 package updates and the
8195: addition of some new ones.
8196:
8197: Minor update
8198:
8199: We consider a minor update one that goes from a 2.A.X version to a 2.A.Y
8200: one where Y is greater than X. These are easy to achieve because they do
8201: not update all GNOME components, can be done in an incremental way and do
8202: not break API nor ABI compatibility.
8203:
8204: A minor update typically consists of around 50 package updates, although
8205: the numbers here may vary a lot.
8206:
8207: In order to update the GNOME components in pkgsrc to a new stable release
8208: (either major or minor), the following steps should be followed:
8209:
8210: 1. Get a list of all the tarballs that form the new release by using the
8211: following commands. These will leave the full list of the components's
8212: distfiles into the list.txt file:
8213:
8214: % echo ls "*.tar.bz2" | \
8215: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
8216: awk '{ print $9 }' >list.txt
8217: % echo ls "*.tar.bz2" | \
8218: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
8219: awk '{ print $9 }' >>list.txt
8220:
8221: 2. Open each meta package's Makefile and bump their version to the release you
8222: are updating them to. The three meta packages should be always consistent
8223: with versioning. Obviously remove any PKGREVISIONs that might be in them.
8224:
8225: 3. For each meta package, update all its DEPENDS lines to match the latest
8226: versions as shown by the above commands. Do not list any newer version
8227: (even if found in the FTP) because the meta packages are supposed to list
8228: the exact versions that form a specific GNOME release. Exceptions are
8229: permitted here if a newer version solves a serious issue in the overall
8230: desktop experience; these typically come in the form of a revision bump in
8231: pkgsrc, not in newer versions from the developers.
8232:
8233: Packages not listed in the list.txt file should be updated to the latest
8234: version available (if found in pkgsrc). This is the case, for example, of
8235: the dependencies on the GNU Autotools in the meta-pkgs/gnome-devel meta
8236: package.
8237:
8238: 4. Generate a patch from the modified meta packages and extract the list of
8239: "new" lines. This will provide you an outline on what packages need to be
8240: updated in pkgsrc and in what order:
8241:
8242: % cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt
8243:
8244: 5. For major desktop updates it is recommended to zap all your installed
8245: packages and start over from scratch at this point.
8246:
8247: 6. Now comes the longest step by far: iterate over the contents of todo.txt
8248: and update the packages listed in it in order. For major desktop updates
8249: none of these should be committed until the entire set is completed because
8250: there are chances of breaking not-yet-updated packages.
8251:
8252: 7. Once the packages are up to date and working, commit them to the tree one
8253: by one with appropriate log messages. At the end, commit the three meta
8254: package updates and all the corresponding changes to the doc/CHANGES-<YEAR>
8255: and pkgsrc/doc/TODO files.
8256:
1.6 ! rillig 8257: 23.4. Patching guidelines
1.1 dsieger 8258:
8259: GNOME is a very big component in pkgsrc which approaches 100 packages. Please,
8260: it is very important that you always, always, always feed back any portability
8261: fixes you do to a GNOME package to the mainstream developers (see
1.6 ! rillig 8262: Section 11.3.5, "Feedback to the author"). This is the only way to get their
1.1 dsieger 8263: attention on portability issues and to ensure that future versions can be built
8264: out-of-the box on NetBSD. The less custom patches in pkgsrc, the easier further
8265: updates are. Those developers in charge of issuing major GNOME updates will be
8266: grateful if you do that.
8267:
8268: The most common places to report bugs are the GNOME's Bugzilla and the
8269: freedesktop.org's Bugzilla. Not all components use these to track bugs, but
8270: most of them do. Do not be short on your reports: always provide detailed
8271: explanations of the current failure, how it can be improved to achieve maximum
8272: portability and, if at all possible, provide a patch against CVS head. The more
8273: verbose you are, the higher chances of your patch being accepted.
8274:
8275: Also, please avoid using preprocessor magic to fix portability issues. While
8276: the FreeBSD GNOME people are doing a great job in porting GNOME to their
8277: operating system, the official GNOME sources are now plagued by conditionals
8278: that check for __FreeBSD__ and similar macros. This hurts portability. Please
1.6 ! rillig 8279: see our patching guidelines (Section 11.3.4, "Patching guidelines") for more
1.1 dsieger 8280: details.
8281:
8282: Part III. The pkgsrc infrastructure internals
8283:
8284: This part of the guide deals with everything from the infrastructure that is
8285: behind the interfaces described in the developer's guide. A casual package
8286: maintainer should not need anything from this part.
8287:
8288: Table of Contents
8289:
1.6 ! rillig 8290: 24. Design of the pkgsrc infrastructure
1.1 dsieger 8291:
1.6 ! rillig 8292: 24.1. The meaning of variable definitions
! 8293: 24.2. Avoiding problems before they arise
! 8294: 24.3. Variable evaluation
1.1 dsieger 8295:
1.6 ! rillig 8296: 24.3.1. At load time
! 8297: 24.3.2. At runtime
1.1 dsieger 8298:
1.6 ! rillig 8299: 24.4. How can variables be specified?
! 8300: 24.5. Designing interfaces for Makefile fragments
1.1 dsieger 8301:
1.6 ! rillig 8302: 24.5.1. Procedures with parameters
! 8303: 24.5.2. Actions taken on behalf of parameters
1.1 dsieger 8304:
1.6 ! rillig 8305: 24.6. The order in which files are loaded
1.1 dsieger 8306:
1.6 ! rillig 8307: 24.6.1. The order in bsd.prefs.mk
! 8308: 24.6.2. The order in bsd.pkg.mk
1.1 dsieger 8309:
1.6 ! rillig 8310: 25. Regression tests
1.1 dsieger 8311:
1.6 ! rillig 8312: 25.1. The regression tests framework
! 8313: 25.2. Running the regression tests
! 8314: 25.3. Adding a new regression test
1.1 dsieger 8315:
1.6 ! rillig 8316: 25.3.1. Overridable functions
! 8317: 25.3.2. Helper functions
1.1 dsieger 8318:
1.6 ! rillig 8319: 26. Porting pkgsrc
1.1 dsieger 8320:
1.6 ! rillig 8321: 26.1. Porting pkgsrc to a new operating system
! 8322: 26.2. Adding support for a new compiler
1.1 dsieger 8323:
1.6 ! rillig 8324: Chapter 24. Design of the pkgsrc infrastructure
1.1 dsieger 8325:
8326: Table of Contents
8327:
1.6 ! rillig 8328: 24.1. The meaning of variable definitions
! 8329: 24.2. Avoiding problems before they arise
! 8330: 24.3. Variable evaluation
1.1 dsieger 8331:
1.6 ! rillig 8332: 24.3.1. At load time
! 8333: 24.3.2. At runtime
1.1 dsieger 8334:
1.6 ! rillig 8335: 24.4. How can variables be specified?
! 8336: 24.5. Designing interfaces for Makefile fragments
1.1 dsieger 8337:
1.6 ! rillig 8338: 24.5.1. Procedures with parameters
! 8339: 24.5.2. Actions taken on behalf of parameters
1.1 dsieger 8340:
1.6 ! rillig 8341: 24.6. The order in which files are loaded
1.1 dsieger 8342:
1.6 ! rillig 8343: 24.6.1. The order in bsd.prefs.mk
! 8344: 24.6.2. The order in bsd.pkg.mk
1.1 dsieger 8345:
8346: The pkgsrc infrastructure consists of many small Makefile fragments. Each such
8347: fragment needs a properly specified interface. This chapter explains how such
8348: an interface looks like.
8349:
1.6 ! rillig 8350: 24.1. The meaning of variable definitions
1.1 dsieger 8351:
8352: Whenever a variable is defined in the pkgsrc infrastructure, the location and
8353: the way of definition provide much information about the intended use of that
8354: variable. Additionally, more documentation may be found in a header comment or
8355: in this pkgsrc guide.
8356:
8357: A special file is mk/defaults/mk.conf, which lists all variables that are
8358: intended to be user-defined. They are either defined using the ?= operator or
8359: they are left undefined because defining them to anything would effectively
8360: mean "yes". All these variables may be overridden by the pkgsrc user in the
8361: MAKECONF file.
8362:
8363: Outside this file, the following conventions apply: Variables that are defined
8364: using the ?= operator may be overridden by a package.
8365:
8366: Variables that are defined using the = operator may be used read-only at
8367: run-time.
8368:
8369: Variables whose name starts with an underscore must not be accessed outside the
8370: pkgsrc infrastructure at all. They may change without further notice.
8371:
8372: Note
8373:
8374: These conventions are currently not applied consistently to the complete pkgsrc
8375: infrastructure.
8376:
1.6 ! rillig 8377: 24.2. Avoiding problems before they arise
1.1 dsieger 8378:
8379: All variables that contain lists of things should default to being empty. Two
8380: examples that do not follow this rule are USE_LANGUAGES and DISTFILES. These
8381: variables cannot simply be modified using the += operator in package Makefiles
8382: (or other files included by them), since there is no guarantee whether the
8383: variable is already set or not, and what its value is. In the case of
8384: DISTFILES, the packages "know" the default value and just define it as in the
8385: following example.
8386:
8387: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
8388:
8389: Because of the selection of this default value, the same value appears in many
8390: package Makefiles. Similarly for USE_LANGUAGES, but in this case the default
8391: value ("c") is so short that it doesn't stand out. Nevertheless it is mentioned
8392: in many files.
8393:
1.6 ! rillig 8394: 24.3. Variable evaluation
1.1 dsieger 8395:
1.6 ! rillig 8396: 24.3.1. At load time
1.1 dsieger 8397:
8398: Variable evaluation takes place either at load time or at runtime, depending on
8399: the context in which they occur. The contexts where variables are evaluated at
8400: load time are:
8401:
8402: * The right hand side of the := and != operators,
8403:
8404: * Make directives like .if or .for,
8405:
8406: * Dependency lines.
8407:
8408: A special exception are references to the iteration variables of .for loops,
8409: which are expanded inline, no matter in which context they appear.
8410:
8411: As the values of variables may change during load time, care must be taken not
8412: to evaluate them by accident. Typical examples for variables that should not be
8413: evaluated at load time are DEPENDS and CONFIGURE_ARGS. To make the effect more
8414: clear, here is an example:
8415:
8416: CONFIGURE_ARGS= # none
8417: CFLAGS= -O
8418: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
8419:
8420: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
8421:
8422: CFLAGS+= -Wall
8423:
8424:
8425: This code shows how the use of the := operator can quickly lead to unexpected
8426: results. The first paragraph is fairly common code. The second paragraph
8427: evaluates the CONFIGURE_ARGS variable, which results in CFLAGS=-O. In the third
8428: paragraph, the -Wall is appended to the CFLAGS, but this addition will not
8429: appear in CONFIGURE_ARGS. In actual code, the three paragraphs from above
8430: typically occur in completely unrelated files.
8431:
1.6 ! rillig 8432: 24.3.2. At runtime
1.1 dsieger 8433:
8434: After all the files have been loaded, the values of the variables cannot be
8435: changed anymore. Variables that are used in the shell commands are expanded at
8436: this point.
8437:
1.6 ! rillig 8438: 24.4. How can variables be specified?
1.1 dsieger 8439:
8440: There are many ways in which the definition and use of a variable can be
8441: restricted in order to detect bugs and violations of the (mostly unwritten)
8442: policies. See the pkglint developer's documentation for further details.
8443:
1.6 ! rillig 8444: 24.5. Designing interfaces for Makefile fragments
1.1 dsieger 8445:
8446: Most of the .mk files fall into one of the following classes. Cases where a
8447: file falls into more than one class should be avoided as it often leads to
8448: subtle bugs.
8449:
1.6 ! rillig 8450: 24.5.1. Procedures with parameters
1.1 dsieger 8451:
8452: In a traditional imperative programming language some of the .mk files could be
8453: described as procedures. They take some input parameters and?after inclusion?
8454: provide a result in output parameters. Since all variables in Makefiles have
8455: global scope care must be taken not to use parameter names that have already
8456: another meaning. For example, PKGNAME is a bad choice for a parameter name.
8457:
8458: Procedures are completely evaluated at preprocessing time. That is, when
8459: calling a procedure all input parameters must be completely resolvable. For
8460: example, CONFIGURE_ARGS should never be an input parameter since it is very
8461: likely that further text will be added after calling the procedure, which would
8462: effectively apply the procedure to only a part of the variable. Also,
8463: references to other variables wit will be modified after calling the procedure.
8464:
8465: A procedure can declare its output parameters either as suitable for use in
8466: preprocessing directives or as only available at runtime. The latter
8467: alternative is for variables that contain references to other runtime
8468: variables.
8469:
8470: Procedures shall be written such that it is possible to call the procedure more
8471: than once. That is, the file must not contain multiple-inclusion guards.
8472:
8473: Examples for procedures are mk/bsd.options.mk and mk/buildlink3/bsd.builtin.mk.
8474: To express that the parameters are evaluated at load time, they should be
8475: assigned using the := operator, which should be used only for this purpose.
8476:
1.6 ! rillig 8477: 24.5.2. Actions taken on behalf of parameters
1.1 dsieger 8478:
8479: Action files take some input parameters and may define runtime variables. They
8480: shall not define loadtime variables. There are action files that are included
8481: implicitly by the pkgsrc infrastructure, while other must be included
8482: explicitly.
8483:
8484: An example for action files is mk/subst.mk.
8485:
1.6 ! rillig 8486: 24.6. The order in which files are loaded
1.1 dsieger 8487:
8488: Package Makefiles usually consist of a set of variable definitions, and include
8489: the file ../../mk/bsd.pkg.mk in the very last line. Before that, they may also
8490: include various other *.mk files if they need to query the availability of
8491: certain features like the type of compiler or the X11 implementation. Due to
8492: the heavy use of preprocessor directives like .if and .for, the order in which
8493: the files are loaded matters.
8494:
8495: This section describes at which point the various files are loaded and gives
8496: reasons for that order.
8497:
1.6 ! rillig 8498: 24.6.1. The order in bsd.prefs.mk
1.1 dsieger 8499:
8500: The very first action in bsd.prefs.mk is to define some essential variables
8501: like OPSYS, OS_VERSION and MACHINE_ARCH.
8502:
1.4 rillig 8503: Then, the user settings are loaded from the file specified in MAKECONF, which
8504: is usually mk.conf. After that, those variables that have not been overridden
8505: by the user are loaded from mk/defaults/mk.conf.
1.1 dsieger 8506:
8507: After the user settings, the system settings and platform settings are loaded,
8508: which may override the user settings.
8509:
8510: Then, the tool definitions are loaded. The tool wrappers are not yet in effect.
8511: This only happens when building a package, so the proper variables must be used
8512: instead of the direct tool names.
8513:
8514: As the last steps, some essential variables from the wrapper and the package
8515: system flavor are loaded, as well as the variables that have been cached in
8516: earlier phases of a package build.
8517:
1.6 ! rillig 8518: 24.6.2. The order in bsd.pkg.mk
1.1 dsieger 8519:
8520: First, bsd.prefs.mk is loaded.
8521:
8522: Then, the various *-vars.mk files are loaded, which fill default values for
8523: those variables that have not been defined by the package. These variables may
8524: later be used even in unrelated files.
8525:
8526: Then, the file bsd.pkg.error.mk provides the target error-check that is added
8527: as a special dependency to all other targets that use DELAYED_ERROR_MSG or
8528: DELAYED_WARNING_MSG.
8529:
8530: Then, the package-specific hacks from hacks.mk are included.
8531:
8532: Then, various other files follow. Most of them don't have any dependencies on
8533: what they need to have included before or after them, though some do.
8534:
8535: The code to check PKG_FAIL_REASON and PKG_SKIP_REASON is then executed, which
8536: restricts the use of these variables to all the files that have been included
8537: before. Appearances in later files will be silently ignored.
8538:
8539: Then, the files for the main targets are included, in the order of later
8540: execution, though the actual order should not matter.
8541:
8542: At last, some more files are included that don't set any interesting variables
8543: but rather just define make targets to be executed.
8544:
1.6 ! rillig 8545: Chapter 25. Regression tests
1.1 dsieger 8546:
8547: Table of Contents
8548:
1.6 ! rillig 8549: 25.1. The regression tests framework
! 8550: 25.2. Running the regression tests
! 8551: 25.3. Adding a new regression test
1.1 dsieger 8552:
1.6 ! rillig 8553: 25.3.1. Overridable functions
! 8554: 25.3.2. Helper functions
1.1 dsieger 8555:
8556: The pkgsrc infrastructure consists of a large codebase, and there are many
8557: corners where every little bit of a file is well thought out, making pkgsrc
8558: likely to fail as soon as anything is changed near those parts. To prevent most
8559: changes from breaking anything, a suite of regression tests should go along
8560: with every important part of the pkgsrc infrastructure. This chapter describes
8561: how regression tests work in pkgsrc and how you can add new tests.
8562:
1.6 ! rillig 8563: 25.1. The regression tests framework
1.1 dsieger 8564:
1.6 ! rillig 8565: 25.2. Running the regression tests
1.1 dsieger 8566:
8567: You first need to install the pkgtools/pkg_regress package, which provides the
8568: pkg_regress command. Then you can simply run that command, which will run all
8569: tests in the regress category.
8570:
1.6 ! rillig 8571: 25.3. Adding a new regression test
1.1 dsieger 8572:
8573: Every directory in the regress category that contains a file called spec is
8574: considered a regression test. This file is a shell program that is included by
8575: the pkg_regress command. The following functions can be overridden to suit your
8576: needs.
8577:
1.6 ! rillig 8578: 25.3.1. Overridable functions
1.1 dsieger 8579:
8580: These functions do not take any parameters. They are all called in "set -e"
8581: mode, so you should be careful to check the exitcodes of any commands you run
8582: in the test.
8583:
8584: do_setup()
8585:
8586: This function prepares the environment for the test. By default it does
8587: nothing.
8588:
8589: do_test()
8590:
8591: This function runs the actual test. By default, it calls TEST_MAKE with the
8592: arguments MAKEARGS_TEST and writes its output including error messages into
8593: the file TEST_OUTFILE.
8594:
8595: check_result()
8596:
8597: This function is run after the test and is typically used to compare the
8598: actual output from the one that is expected. It can make use of the various
8599: helper functions from the next section.
8600:
8601: do_cleanup()
8602:
8603: This function cleans everything up after the test has been run. By default
8604: it does nothing.
8605:
1.6 ! rillig 8606: 25.3.2. Helper functions
1.1 dsieger 8607:
8608: exit_status(expected)
8609:
8610: This function compares the exitcode of the do_test() function with its
8611: first parameter. If they differ, the test will fail.
8612:
8613: output_require(regex...)
8614:
8615: This function checks for each of its parameters if the output from do_test
8616: () matches the extended regular expression. If it does not, the test will
8617: fail.
8618:
8619: output_prohibit(regex...)
8620:
8621: This function checks for each of its parameters if the output from do_test
8622: () does not match the extended regular expression. If any of the regular
8623: expressions matches, the test will fail.
8624:
1.6 ! rillig 8625: Chapter 26. Porting pkgsrc
1.1 dsieger 8626:
8627: Table of Contents
8628:
1.6 ! rillig 8629: 26.1. Porting pkgsrc to a new operating system
! 8630: 26.2. Adding support for a new compiler
1.1 dsieger 8631:
8632: The pkgsrc system has already been ported to many operating systems, hardware
8633: architectures and compilers. This chapter explains the necessary steps to make
8634: pkgsrc even more portable.
8635:
1.6 ! rillig 8636: 26.1. Porting pkgsrc to a new operating system
1.1 dsieger 8637:
8638: To port pkgsrc to a new operating system (called MyOS in this example), you
8639: need to touch the following files:
8640:
8641: pkgtools/bootstrap-mk-files/files/mods/MyOS.sys.mk
8642:
8643: This file contains some basic definitions, for example the name of the C
8644: compiler.
8645:
8646: mk/bsd.prefs.mk
8647:
8648: Insert code that defines the variables OPSYS, OS_VERSION, LOWER_OS_VERSION,
8649: LOWER_VENDOR, MACHINE_ARCH, OBJECT_FMT, APPEND_ELF, and the other variables
8650: that appear in this file.
8651:
8652: mk/platform/MyOS.mk
8653:
8654: This file contains the platform-specific definitions that are used by
8655: pkgsrc. Start by copying one of the other files and edit it to your needs.
8656:
8657: mk/platform/MyOS.pkg.dist
8658:
8659: This file contains a list of directories, together with their permission
8660: bits and ownership. These directories will be created automatically with
8661: every package that explicitly sets USE_MTREE. This feature will be removed.
8662:
8663: mk/platform/MyOS.x11.dist
8664:
8665: Just copy one of the pre-existing x11.dist files to your MyOS.x11.dist.
8666:
8667: mk/tools/bootstrap.mk
8668:
8669: On some operating systems, the tools that are provided with the base system
8670: are not good enough for pkgsrc. For example, there are many versions of sed
8671: (1) that have a narrow limit on the line length they can process. Therefore
8672: pkgsrc brings its own tools, which can be enabled here.
8673:
8674: mk/tools/tools.MyOS.mk
8675:
8676: This file defines the paths to all the tools that are needed by one or the
8677: other package in pkgsrc, as well as by pkgsrc itself. Find out where these
8678: tools are on your platform and add them.
8679:
8680: Now, you should be able to build some basic packages, like lang/perl5, shells/
8681: bash.
8682:
1.6 ! rillig 8683: 26.2. Adding support for a new compiler
1.1 dsieger 8684:
8685: TODO
8686:
8687: Appendix A. A simple example package: bison
8688:
8689: Table of Contents
8690:
8691: A.1. files
8692:
8693: A.1.1. Makefile
8694: A.1.2. DESCR
8695: A.1.3. PLIST
8696: A.1.4. Checking a package with pkglint
8697:
8698: A.2. Steps for building, installing, packaging
8699:
8700: We checked to find a piece of software that wasn't in the packages collection,
8701: and picked GNU bison. Quite why someone would want to have bison when Berkeley
8702: yacc is already present in the tree is beyond us, but it's useful for the
8703: purposes of this exercise.
8704:
8705: A.1. files
8706:
8707: A.1.1. Makefile
8708:
1.2 rillig 8709: # $NetBSD$
1.1 dsieger 8710: #
8711:
8712: DISTNAME= bison-1.25
8713: CATEGORIES= devel
8714: MASTER_SITES= ${MASTER_SITE_GNU}
8715:
8716: MAINTAINER= thorpej@NetBSD.org
8717: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
8718: COMMENT= GNU yacc clone
8719:
8720: GNU_CONFIGURE= yes
8721: INFO_FILES= bison.info
8722:
8723: .include "../../mk/bsd.pkg.mk"
8724:
8725: A.1.2. DESCR
8726:
8727: GNU version of yacc. Can make re-entrant parsers, and numerous other
8728: improvements. Why you would want this when Berkeley yacc(1) is part
8729: of the NetBSD source tree is beyond me.
8730:
8731: A.1.3. PLIST
8732:
1.2 rillig 8733: @comment $NetBSD$
1.1 dsieger 8734: bin/bison
8735: man/man1/bison.1.gz
8736: share/bison.simple
8737: share/bison.hairy
8738:
8739: A.1.4. Checking a package with pkglint
8740:
8741: The NetBSD package system comes with pkgtools/pkglint which helps to check the
8742: contents of these files. After installation it is quite easy to use, just
8743: change to the directory of the package you wish to examine and execute pkglint:
8744:
8745: $ pkglint
8746: looks fine.
8747:
8748: Depending on the supplied command line arguments (see pkglint(1)), more checks
8749: will be performed. Use e.g. pkglint -Call -Wall for a very thorough check.
8750:
8751: A.2. Steps for building, installing, packaging
8752:
8753: Create the directory where the package lives, plus any auxiliary directories:
8754:
8755: # cd /usr/pkgsrc/lang
8756: # mkdir bison
8757: # cd bison
8758: # mkdir patches
8759:
1.6 ! rillig 8760: Create Makefile, DESCR and PLIST (see Chapter 11, Package components - files,
1.1 dsieger 8761: directories and contents) then continue with fetching the distfile:
8762:
8763: # make fetch
8764: >> bison-1.25.tar.gz doesn't seem to exist on this system.
8765: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
8766: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8767: ftp: Error retrieving file: 500 Internal error
8768:
8769: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
8770: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8771: ftp: Error retrieving file: 500 Internal error
8772:
8773: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
8774: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8775: Successfully retrieved file.
8776:
8777: Generate the checksum of the distfile into distinfo:
8778:
8779: # make makedistinfo
8780:
8781: Now compile:
8782:
8783: # make
8784: >> Checksum OK for bison-1.25.tar.gz.
8785: ===> Extracting for bison-1.25
8786: ===> Patching for bison-1.25
8787: ===> Ignoring empty patch directory
8788: ===> Configuring for bison-1.25
8789: creating cache ./config.cache
8790: checking for gcc... cc
8791: checking whether we are using GNU C... yes
8792: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
8793: checking how to run the C preprocessor... cc -E
8794: checking for minix/config.h... no
8795: checking for POSIXized ISC... no
8796: checking whether cross-compiling... no
8797: checking for ANSI C header files... yes
8798: checking for string.h... yes
8799: checking for stdlib.h... yes
8800: checking for memory.h... yes
8801: checking for working const... yes
8802: checking for working alloca.h... no
8803: checking for alloca... yes
8804: checking for strerror... yes
8805: updating cache ./config.cache
8806: creating ./config.status
8807: creating Makefile
8808: ===> Building for bison-1.25
8809: 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
8810: 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
8811: 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
8812: 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
8813: 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
8814: 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
8815: 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
8816: 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
8817: 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
8818: 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
8819: 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
8820: 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
8821: 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
8822: 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
8823: 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
8824: 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
8825: 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
8826: 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
8827: 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
8828: 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
8829: 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
8830: 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
8831: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
8832: rm -f bison.s1
8833: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1
8834:
8835: Everything seems OK, so install the files:
8836:
8837: # make install
8838: >> Checksum OK for bison-1.25.tar.gz.
8839: ===> Installing for bison-1.25
8840: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
8841: rm -f /usr/pkg/bin/bison
8842: cd /usr/pkg/share; rm -f bison.simple bison.hairy
8843: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
8844: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
8845: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
8846: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
8847: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
8848: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
8849: ===> Registering installation for bison-1.25
8850:
8851: You can now use bison, and also - if you decide so - remove it with pkg_delete
8852: bison. Should you decide that you want a binary package, do this now:
8853:
8854: # make package
8855: >> Checksum OK for bison-1.25.tar.gz.
8856: ===> Building package for bison-1.25
8857: Creating package bison-1.25.tgz
8858: Registering depends:.
8859: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'
8860:
8861: Now that you don't need the source and object files any more, clean up:
8862:
8863: # make clean
8864: ===> Cleaning for bison-1.25
8865:
8866: Appendix B. Build logs
8867:
8868: Table of Contents
8869:
8870: B.1. Building figlet
8871: B.2. Packaging figlet
8872:
8873: B.1. Building figlet
8874:
8875: # make
8876: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8877: => figlet221.tar.gz doesn't seem to exist on this system.
8878: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
8879: => [172219 bytes]
8880: Connected to ftp.plig.net.
8881: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
8882: 331 Guest login ok, send your complete e-mail address as password.
8883: 230-You are user #5 of 500 simultaneous users allowed.
8884: 230-
8885: 230- ___ _ _ _
8886: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
8887: 230- | _| _| . |_| . | | | . |_| . | _| . |
8888: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
8889: 230- |_| |_| |___| |___|
8890: 230-
8891: 230-** Welcome to ftp.plig.org **
8892: 230-
8893: 230-Please note that all transfers from this FTP site are logged. If you
8894: 230-do not like this, please disconnect now.
8895: 230-
8896: 230-This arhive is available via
8897: 230-
8898: 230-HTTP: http://ftp.plig.org/
8899: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
8900: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
8901: 230-
8902: 230-Please email comments, bug reports and requests for packages to be
8903: 230-mirrored to ftp-admin@plig.org.
8904: 230-
8905: 230-
8906: 230 Logged in anonymously.
8907: Remote system type is UNIX.
8908: Using binary mode to transfer files.
8909: 200 Type okay.
8910: 250 "/pub" is new cwd.
8911: 250-"/pub/figlet" is new cwd.
8912: 250-
8913: 250-Welcome to the figlet archive at ftp.figlet.org
8914: 250-
8915: 250- ftp://ftp.figlet.org/pub/figlet/
8916: 250-
8917: 250-The official FIGlet web page is:
8918: 250- http://www.figlet.org/
8919: 250-
8920: 250-If you have questions, please mailto:info@figlet.org. If you want to
8921: 250-contribute a font or something else, you can email us.
8922: 250
8923: 250 "/pub/figlet/program" is new cwd.
8924: 250 "/pub/figlet/program/unix" is new cwd.
8925: local: figlet221.tar.gz remote: figlet221.tar.gz
8926: 502 Unimplemented command.
8927: 227 Entering Passive Mode (195,40,6,41,246,104)
8928: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
8929: 38% |************** | 65800 64.16 KB/s 00:01 ETA
8930: 226 Transfer completed.
8931: 172219 bytes received in 00:02 (75.99 KB/s)
8932: 221 Goodbye.
8933: => Checksum OK for figlet221.tar.gz.
8934: ===> Extracting for figlet-2.2.1nb2
8935: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
8936: ===> Patching for figlet-2.2.1nb2
8937: ===> Applying pkgsrc patches for figlet-2.2.1nb2
8938: ===> Overriding tools for figlet-2.2.1nb2
8939: ===> Creating toolchain wrappers for figlet-2.2.1nb2
8940: ===> Configuring for figlet-2.2.1nb2
8941: ===> Building for figlet-2.2.1nb2
8942: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
8943: chmod a+x figlet
8944: gcc -O2 -o chkfont chkfont.c
8945: => Unwrapping files-to-be-installed.
8946: #
8947: # make install
8948: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8949: ===> Installing for figlet-2.2.1nb2
8950: install -d -o root -g wheel -m 755 /usr/pkg/bin
8951: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
8952: mkdir -p /usr/pkg/share/figlet
8953: cp figlet /usr/pkg/bin
8954: cp chkfont /usr/pkg/bin
8955: chmod 555 figlist showfigfonts
8956: cp figlist /usr/pkg/bin
8957: cp showfigfonts /usr/pkg/bin
8958: cp fonts/*.flf /usr/pkg/share/figlet
8959: cp fonts/*.flc /usr/pkg/share/figlet
8960: cp figlet.6 /usr/pkg/man/man6
8961: ===> Registering installation for figlet-2.2.1nb2
8962: #
8963:
8964: B.2. Packaging figlet
8965:
8966: # make package
8967: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8968: ===> Packaging figlet-2.2.1nb2
8969: ===> Building binary package for figlet-2.2.1nb2
8970: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
8971: Using SrcDir value of /usr/pkg
8972: Registering depends:.
8973: #
8974:
8975: Appendix C. Directory layout of the pkgsrc FTP server
8976:
8977: Table of Contents
8978:
8979: C.1. bootstrap-pkgsrc: Bootstrap kits
8980: C.2. distfiles: The distributed source files
8981: C.3. iso: Currently empty
8982: C.4. misc: Miscellaneous things
1.3 rillig 8983: C.5. packages: Binary packages
1.1 dsieger 8984: C.6. current, pkgsrc-200xQy: source packages
8985:
8986: As in other big projects, the directory layout of pkgsrc is quite complex for
8987: newbies. This chapter explains where you find things on the FTP server. The
8988: base directory on ftp.NetBSD.org is /pub/pkgsrc/. On other servers it may be
8989: different, but inside this directory, everything should look the same, no
8990: matter on which server you are. This directory contains some subdirectories,
8991: which are explained below.
8992:
8993: C.1. bootstrap-pkgsrc: Bootstrap kits
8994:
8995: For those who only want to manage binary packages on systems other than NetBSD,
8996: we provide the package management tools in a separate, small tar file.
8997:
8998: C.2. distfiles: The distributed source files
8999:
9000: The directory distfiles contains lots of archive files from all pkgsrc
9001: packages, which are mirrored here. The subdirectories are called after their
9002: package names and are used when the distributed files have names that don't
9003: explicitly contain a version number or are otherwise too generic (for example
9004: release.tar.gz).
9005:
9006: C.3. iso: Currently empty
9007:
9008: This directory is currently not in use.
9009:
9010: C.4. misc: Miscellaneous things
9011:
9012: This directory contains things that individual pkgsrc developers find worth
9013: publishing.
9014:
1.3 rillig 9015: C.5. packages: Binary packages
1.1 dsieger 9016:
1.3 rillig 9017: This directory contains binary packages for the various platforms that are
9018: supported by pkgsrc. Each subdirectory is of the form OPSYS/ARCH/OSVERSION_TAG.
9019: The meaning of these variables is:
9020:
9021: * OPSYS is the name of the operating system for which the packages have been
9022: built,
9023:
9024: * ARCH is the hardware architecture,
9025:
9026: * OSVERSION is the version of the operating system,
9027:
9028: * TAG is either 200xQy for a stable branch, or head for packages built from
9029: the HEAD branch.
9030:
9031: The rationale for exactly this scheme is that the pkgsrc users looking for
9032: binary packages can quickly click through the directories on the server and
9033: find the best binary packages for their machines. Since they usually know the
9034: operating system and the hardware architecture, OPSYS and ARCH are placed
9035: first. After these choices, they can select the best combination of OSVERSION
9036: and TAG together, since it is usually the case that packages stay compatible
9037: between different version of the operating system.
9038:
9039: In each of these directories, there is a whole binary packages collection for a
9040: specific platform. It has a directory called All which contains all binary
9041: packages. Besides that, there are various category directories that contain
9042: symbolic links to the real binary packages.
1.1 dsieger 9043:
9044: C.6. current, pkgsrc-200xQy: source packages
9045:
9046: These directories contain the "real" pkgsrc, that is the files that define how
9047: to create binary packages from source archives.
9048:
9049: The directory pkgsrc contains a snapshot of the CVS repository, which is
9050: updated regularly. The file pkgsrc.tar.gz contains the same as the directory,
9051: ready to be downloaded as a whole.
9052:
9053: In the directories for the quarterly branches, there is an additional file
9054: called pkgsrc-200xQy.tar.gz, which contains the state of pkgsrc when it was
9055: branched.
9056:
9057: Appendix D. Editing guidelines for the pkgsrc guide
9058:
9059: Table of Contents
9060:
9061: D.1. Make targets
9062: D.2. Procedure
9063:
9064: This section contains information on editing the pkgsrc guide itself.
9065:
9066: D.1. Make targets
9067:
9068: The pkgsrc guide's source code is stored in pkgsrc/doc/guide/files, and several
9069: files are created from it:
9070:
9071: * pkgsrc/doc/pkgsrc.txt
9072:
9073: * pkgsrc/doc/pkgsrc.html
9074:
1.2 rillig 9075: * http://www.NetBSD.org/docs/pkgsrc/
1.1 dsieger 9076:
1.2 rillig 9077: * http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf: The PDF version of the pkgsrc
9078: guide.
1.1 dsieger 9079:
1.2 rillig 9080: * http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps: PostScript version of the
9081: pkgsrc guide.
1.1 dsieger 9082:
9083: D.2. Procedure
9084:
9085: The procedure to edit the pkgsrc guide is:
9086:
9087: 1. Make sure you have the packages needed to regenerate the pkgsrc guide (and
9088: other XML-based NetBSD documentation) installed. These are meta-pkgs/
9089: netbsd-doc for creating the ASCII and HTML versions, and meta-pkgs/
9090: netbsd-doc-print for the PostScript and PDF versions. You will need both
9091: packages installed, to make sure documentation is consistent across all
9092: formats.
9093:
9094: 2. Run cd doc/guide to get to the right directory. All further steps will take
9095: place here.
9096:
9097: 3. Edit the XML file(s) in files/.
9098:
9099: 4. Run bmake to check the pkgsrc guide for valid XML and to build the final
9100: output files. If you get any errors at this stage, you can just edit the
9101: files, as there are only symbolic links in the working directory, pointing
9102: to the files in files/.
9103:
9104: 5. (cd files && cvs commit)
9105:
9106: 6. Run bmake clean && bmake to regenerate the output files with the proper RCS
9107: Ids.
9108:
9109: 7. Run bmake regen to install and commit the files in both pkgsrc/doc and
9110: htdocs.
9111:
9112: Note
9113:
9114: If you have added, removed or renamed some chapters, you need to
9115: synchronize them using cvs add or cvs delete in the htdocs directory.
9116:
CVSweb <webmaster@jp.NetBSD.org>