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