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