Annotation of htdocs/docs/pkgsrc/pkgsrc.txt, revision 1.155
1.1 dsieger 1: The pkgsrc guide
2:
3: Documentation on the NetBSD packages system
4:
5: Alistair Crooks
6:
7: <agc@NetBSD.org>
8:
9: Hubert Feyrer
10:
11: <hubertf@NetBSD.org>
12:
13: The pkgsrc Developers
14:
1.146 jnemeth 15: Copyright 1994-2019 The NetBSD Foundation, Inc
1.1 dsieger 16:
1.155 ! sevan 17: $NetBSD: pkgsrc.xml,v 1.35 2019/04/28 15:22:24 rillig Exp $
1.1 dsieger 18:
19: Abstract
20:
21: pkgsrc is a centralized package management system for Unix-like operating
22: systems. This guide provides information for users and developers of pkgsrc. It
23: covers installation of binary and source packages, creation of binary and
24: source packages and a high-level overview about the infrastructure.
25:
26: -------------------------------------------------------------------------------
27:
28: Table of Contents
29:
30: 1. What is pkgsrc?
31:
32: 1.1. Introduction
33:
34: 1.1.1. Why pkgsrc?
35: 1.1.2. Supported platforms
36:
37: 1.2. Overview
38: 1.3. Terminology
39:
40: 1.3.1. Roles involved in pkgsrc
41:
42: 1.4. Typography
43:
44: I. The pkgsrc user's guide
45:
1.154 rillig 46: 2. Getting help
47: 3. Where to get pkgsrc and how to keep it up-to-date
1.1 dsieger 48:
1.154 rillig 49: 3.1. Getting pkgsrc for the first time
1.1 dsieger 50:
1.154 rillig 51: 3.1.1. As tar archive
52: 3.1.2. Via anonymous CVS
1.1 dsieger 53:
1.154 rillig 54: 3.2. Keeping pkgsrc up-to-date
1.1 dsieger 55:
1.154 rillig 56: 3.2.1. Via tar files
57: 3.2.2. Via CVS
1.1 dsieger 58:
1.154 rillig 59: 4. Using pkgsrc on systems other than NetBSD
1.1 dsieger 60:
1.154 rillig 61: 4.1. Binary distribution
62: 4.2. Bootstrapping pkgsrc
1.1 dsieger 63:
1.154 rillig 64: 5. Using pkgsrc
1.1 dsieger 65:
1.154 rillig 66: 5.1. Using binary packages
1.1 dsieger 67:
1.154 rillig 68: 5.1.1. Finding binary packages
69: 5.1.2. Installing binary packages
70: 5.1.3. Deinstalling packages
71: 5.1.4. Getting information about installed packages
72: 5.1.5. Checking for security vulnerabilities in installed packages
73: 5.1.6. Finding if newer versions of your installed packages are in
1.1 dsieger 74: pkgsrc
1.154 rillig 75: 5.1.7. Other administrative functions
1.1 dsieger 76:
1.154 rillig 77: 5.2. Building packages from source
1.1 dsieger 78:
1.154 rillig 79: 5.2.1. Requirements
80: 5.2.2. Fetching distfiles
81: 5.2.3. How to build and install
1.1 dsieger 82:
1.154 rillig 83: 6. Configuring pkgsrc
1.1 dsieger 84:
1.154 rillig 85: 6.1. General configuration
86: 6.2. Variables affecting the build process
87: 6.3. Variables affecting the installation process
88: 6.4. Selecting and configuring the compiler
1.1 dsieger 89:
1.154 rillig 90: 6.4.1. Selecting the compiler
91: 6.4.2. Additional flags to the compiler (CFLAGS)
92: 6.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 93:
1.154 rillig 94: 6.5. Developer/advanced settings
95: 6.6. Selecting Build Options
1.1 dsieger 96:
1.154 rillig 97: 7. Creating binary packages
1.1 dsieger 98:
1.154 rillig 99: 7.1. Building a single binary package
100: 7.2. Settings for creation of binary packages
1.1 dsieger 101:
1.154 rillig 102: 8. Creating binary packages for everything in pkgsrc (bulk builds)
1.6 rillig 103:
1.154 rillig 104: 8.1. Preparations
105: 8.2. Running a pbulk-style bulk build
1.6 rillig 106:
1.154 rillig 107: 8.2.1. Configuration
1.6 rillig 108:
1.154 rillig 109: 8.3. Requirements of a full bulk build
110: 8.4. Creating a multiple CD-ROM packages collection
1.6 rillig 111:
1.154 rillig 112: 8.4.1. Example of cdpack
1.6 rillig 113:
1.154 rillig 114: 9. Directory layout of the installed files
1.6 rillig 115:
1.154 rillig 116: 9.1. File system layout in ${LOCALBASE}
117: 9.2. File system layout in ${VARBASE}
1.6 rillig 118:
1.154 rillig 119: 10. Frequently Asked Questions
1.6 rillig 120:
1.154 rillig 121: 10.1. Are there any mailing lists for pkg-related discussion?
122: 10.2. Utilities for package management (pkgtools)
123: 10.3. How to use pkgsrc as non-root
124: 10.4. How to resume transfers when fetching distfiles?
125: 10.5. How can I install/use modular X.org from pkgsrc?
126: 10.6. How to fetch files from behind a firewall
127: 10.7. How to fetch files from HTTPS sites
128: 10.8. How do I tell make fetch to do passive FTP?
129: 10.9. How to fetch all distfiles at once
130: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc"
1.24 wiz 131: mean?
1.154 rillig 132: 10.11. What does "Could not find bsd.own.mk" mean?
133: 10.12. Using 'sudo' with pkgsrc
134: 10.13. How do I change the location of configuration files?
135: 10.14. Automated security checks
136: 10.15. Why do some packages ignore my CFLAGS?
137: 10.16. A package does not build. What shall I do?
138: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/???
1.24 wiz 139: merge conflicts" mean?
1.1 dsieger 140:
141: II. The pkgsrc developer's guide
142:
1.154 rillig 143: 11. Getting help
144: 12. Creating a new pkgsrc package from scratch
1.1 dsieger 145:
1.154 rillig 146: 12.1. Common types of packages
1.1 dsieger 147:
1.154 rillig 148: 12.1.1. Perl modules
149: 12.1.2. Python modules and programs
1.1 dsieger 150:
1.154 rillig 151: 12.2. Examples
1.1 dsieger 152:
1.154 rillig 153: 12.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 154:
1.154 rillig 155: 13. Package components - files, directories and contents
1.1 dsieger 156:
1.154 rillig 157: 13.1. Makefile
158: 13.2. distinfo
159: 13.3. patches/*
1.1 dsieger 160:
1.154 rillig 161: 13.3.1. Structure of a single patch file
162: 13.3.2. Creating patch files
163: 13.3.3. Sources where the patch files come from
164: 13.3.4. Patching guidelines
165: 13.3.5. Feedback to the author
1.1 dsieger 166:
1.154 rillig 167: 13.4. Other mandatory files
168: 13.5. Optional files
1.1 dsieger 169:
1.154 rillig 170: 13.5.1. Files affecting the binary package
171: 13.5.2. Files affecting the build process
172: 13.5.3. Files affecting nothing at all
1.1 dsieger 173:
1.154 rillig 174: 13.6. work*
175: 13.7. files/*
1.1 dsieger 176:
1.154 rillig 177: 14. Programming in Makefiles
1.1 dsieger 178:
1.154 rillig 179: 14.1. Caveats
180: 14.2. Makefile variables
1.1 dsieger 181:
1.154 rillig 182: 14.2.1. Naming conventions
1.1 dsieger 183:
1.154 rillig 184: 14.3. Code snippets
1.1 dsieger 185:
1.154 rillig 186: 14.3.1. Adding things to a list
187: 14.3.2. Echoing a string exactly as-is
188: 14.3.3. Passing CFLAGS to GNU configure scripts
189: 14.3.4. Handling possibly empty variables
1.1 dsieger 190:
1.154 rillig 191: 15. PLIST issues
1.1 dsieger 192:
1.154 rillig 193: 15.1. RCS ID
194: 15.2. Semi-automatic PLIST generation
195: 15.3. Tweaking output of make print-PLIST
196: 15.4. Variable substitution in PLIST
197: 15.5. Man page compression
198: 15.6. Changing PLIST source with PLIST_SRC
199: 15.7. Platform-specific and differing PLISTs
200: 15.8. Build-specific PLISTs
201: 15.9. Sharing directories between packages
1.1 dsieger 202:
1.154 rillig 203: 16. Buildlink methodology
1.1 dsieger 204:
1.154 rillig 205: 16.1. Converting packages to use buildlink3
206: 16.2. Writing buildlink3.mk files
1.1 dsieger 207:
1.154 rillig 208: 16.2.1. Anatomy of a buildlink3.mk file
209: 16.2.2. Updating BUILDLINK_API_DEPENDS.pkg and
1.27 wiz 210: BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files
1.1 dsieger 211:
1.154 rillig 212: 16.3. Writing builtin.mk files
1.1 dsieger 213:
1.154 rillig 214: 16.3.1. Anatomy of a builtin.mk file
215: 16.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 216:
1.154 rillig 217: 17. The pkginstall framework
1.1 dsieger 218:
1.154 rillig 219: 17.1. Files and directories outside the installation prefix
1.1 dsieger 220:
1.154 rillig 221: 17.1.1. Directory manipulation
222: 17.1.2. File manipulation
1.1 dsieger 223:
1.154 rillig 224: 17.2. Configuration files
1.1 dsieger 225:
1.154 rillig 226: 17.2.1. How PKG_SYSCONFDIR is set
227: 17.2.2. Telling the software where configuration files are
228: 17.2.3. Patching installations
229: 17.2.4. Disabling handling of configuration files
1.1 dsieger 230:
1.154 rillig 231: 17.3. System startup scripts
1.1 dsieger 232:
1.154 rillig 233: 17.3.1. Disabling handling of system startup scripts
1.1 dsieger 234:
1.154 rillig 235: 17.4. System users and groups
236: 17.5. System shells
1.1 dsieger 237:
1.154 rillig 238: 17.5.1. Disabling shell registration
1.1 dsieger 239:
1.154 rillig 240: 17.6. Fonts
1.1 dsieger 241:
1.154 rillig 242: 17.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 243:
1.154 rillig 244: 18. Options handling
1.1 dsieger 245:
1.154 rillig 246: 18.1. Global default options
247: 18.2. Converting packages to use bsd.options.mk
248: 18.3. Option Names
249: 18.4. Determining the options of dependencies
1.1 dsieger 250:
1.154 rillig 251: 19. The build process
1.1 dsieger 252:
1.154 rillig 253: 19.1. Introduction
254: 19.2. Program location
255: 19.3. Directories used during the build process
256: 19.4. Running a phase
257: 19.5. The fetch phase
1.1 dsieger 258:
1.154 rillig 259: 19.5.1. What to fetch and where to get it from
260: 19.5.2. How are the files fetched?
1.1 dsieger 261:
1.154 rillig 262: 19.6. The checksum phase
263: 19.7. The extract phase
264: 19.8. The patch phase
265: 19.9. The tools phase
266: 19.10. The wrapper phase
267: 19.11. The configure phase
268: 19.12. The build phase
269: 19.13. The test phase
270: 19.14. The install phase
271: 19.15. The package phase
272: 19.16. Cleaning up
273: 19.17. Other helpful targets
1.1 dsieger 274:
1.154 rillig 275: 20. Tools needed for building or running
1.1 dsieger 276:
1.154 rillig 277: 20.1. Tools for pkgsrc builds
278: 20.2. Tools needed by packages
279: 20.3. Tools provided by platforms
1.1 dsieger 280:
1.154 rillig 281: 21. Making your package work
1.1 dsieger 282:
1.154 rillig 283: 21.1. General operation
1.1 dsieger 284:
1.154 rillig 285: 21.1.1. How to pull in user-settable variables from mk.conf
286: 21.1.2. User interaction
287: 21.1.3. Handling licenses
288: 21.1.4. Restricted packages
289: 21.1.5. Handling dependencies
290: 21.1.6. Handling conflicts with other packages
291: 21.1.7. Packages that cannot or should not be built
292: 21.1.8. Packages which should not be deleted, once installed
293: 21.1.9. Handling packages with security problems
294: 21.1.10. How to handle incrementing versions when fixing an
1.1 dsieger 295: existing package
1.154 rillig 296: 21.1.11. Substituting variable text in the package files (the SUBST
1.1 dsieger 297: framework)
298:
1.154 rillig 299: 21.2. The fetch phase
1.1 dsieger 300:
1.154 rillig 301: 21.2.1. Packages whose distfiles aren't available for plain
1.1 dsieger 302: downloading
1.154 rillig 303: 21.2.2. How to handle modified distfiles with the 'old' name
304: 21.2.3. Packages hosted on github.com
1.1 dsieger 305:
1.154 rillig 306: 21.3. The configure phase
1.1 dsieger 307:
1.154 rillig 308: 21.3.1. Shared libraries - libtool
309: 21.3.2. Using libtool on GNU packages that already support libtool
310: 21.3.3. GNU Autoconf/Automake
311:
312: 21.4. Programming languages
313:
314: 21.4.1. C, C++, and Fortran
315: 21.4.2. Java
316: 21.4.3. Packages containing perl scripts
317: 21.4.4. Packages containing shell scripts
318: 21.4.5. Other programming languages
319:
320: 21.5. The build phase
321:
322: 21.5.1. Compiling C and C++ code conditionally
323: 21.5.2. How to handle compiler bugs
324: 21.5.3. Undefined reference to "..."
325: 21.5.4. Running out of memory
326:
327: 21.6. The install phase
328:
329: 21.6.1. Creating needed directories
330: 21.6.2. Where to install documentation
331: 21.6.3. Installing highscore files
332: 21.6.4. Adding DESTDIR support to packages
333: 21.6.5. Packages with hardcoded paths to other interpreters
334: 21.6.6. Packages installing perl modules
335: 21.6.7. Packages installing info files
336: 21.6.8. Packages installing man pages
337: 21.6.9. Packages installing GConf data files
338: 21.6.10. Packages installing scrollkeeper/rarian data files
339: 21.6.11. Packages installing X11 fonts
340: 21.6.12. Packages installing GTK2 modules
341: 21.6.13. Packages installing SGML or XML data
342: 21.6.14. Packages installing extensions to the MIME database
343: 21.6.15. Packages using intltool
344: 21.6.16. Packages installing startup scripts
345: 21.6.17. Packages installing TeX modules
346: 21.6.18. Packages supporting running binaries in emulation
347: 21.6.19. Packages installing hicolor theme icons
348: 21.6.20. Packages installing desktop files
349:
350: 21.7. Marking packages as having problems
351:
352: 22. Debugging
353: 23. Submitting and Committing
354:
355: 23.1. Submitting binary packages
356: 23.2. Submitting source packages (for non-NetBSD-developers)
357: 23.3. General notes when adding, updating, or removing packages
358: 23.4. Commit Messages
359: 23.5. Committing: Adding a package to CVS
360: 23.6. Updating a package to a newer version
361: 23.7. Renaming a package in pkgsrc
362: 23.8. Moving a package in pkgsrc
363:
364: 24. Frequently Asked Questions
365: 25. GNOME packaging and porting
366:
367: 25.1. Meta packages
368: 25.2. Packaging a GNOME application
369: 25.3. Updating GNOME to a newer version
370: 25.4. Patching guidelines
1.1 dsieger 371:
372: III. The pkgsrc infrastructure internals
373:
1.154 rillig 374: 26. Design of the pkgsrc infrastructure
1.1 dsieger 375:
1.154 rillig 376: 26.1. The meaning of variable definitions
377: 26.2. Avoiding problems before they arise
378: 26.3. Variable evaluation
1.1 dsieger 379:
1.154 rillig 380: 26.3.1. At load time
381: 26.3.2. At runtime
1.1 dsieger 382:
1.154 rillig 383: 26.4. How can variables be specified?
384: 26.5. Designing interfaces for Makefile fragments
1.1 dsieger 385:
1.154 rillig 386: 26.5.1. Procedures with parameters
387: 26.5.2. Actions taken on behalf of parameters
1.1 dsieger 388:
1.154 rillig 389: 26.6. The order in which files are loaded
1.1 dsieger 390:
1.154 rillig 391: 26.6.1. The order in bsd.prefs.mk
392: 26.6.2. The order in bsd.pkg.mk
1.1 dsieger 393:
1.154 rillig 394: 27. Regression tests
1.1 dsieger 395:
1.154 rillig 396: 27.1. Running the regression tests
397: 27.2. Adding a new regression test
1.1 dsieger 398:
1.154 rillig 399: 27.2.1. Overridable functions
400: 27.2.2. Helper functions
1.1 dsieger 401:
1.154 rillig 402: 28. Porting pkgsrc
1.1 dsieger 403:
1.154 rillig 404: 28.1. Porting pkgsrc to a new operating system
1.1 dsieger 405:
406: A. A simple example package: bison
407:
408: A.1. files
409:
410: A.1.1. Makefile
411: A.1.2. DESCR
412: A.1.3. PLIST
413: A.1.4. Checking a package with pkglint
414:
415: A.2. Steps for building, installing, packaging
416:
417: B. Build logs
418:
419: B.1. Building figlet
420: B.2. Packaging figlet
421:
422: C. Directory layout of the pkgsrc FTP server
423:
1.23 jakllsch 424: C.1. distfiles: The distributed source files
425: C.2. misc: Miscellaneous things
426: C.3. packages: Binary packages
427: C.4. reports: Bulk build reports
1.148 leot 428: C.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 429:
1.154 rillig 430: D. Help topics
431: E. Editing guidelines for the pkgsrc guide
1.1 dsieger 432:
1.154 rillig 433: E.1. Make targets
434: E.2. Procedure
1.1 dsieger 435:
436: List of Tables
437:
438: 1.1. Platforms supported by pkgsrc
1.154 rillig 439: 13.1. Patching examples
440: 25.1. PLIST handling for GNOME packages
1.1 dsieger 441:
442: Chapter 1. What is pkgsrc?
443:
444: Table of Contents
445:
446: 1.1. Introduction
447:
448: 1.1.1. Why pkgsrc?
449: 1.1.2. Supported platforms
450:
451: 1.2. Overview
452: 1.3. Terminology
453:
454: 1.3.1. Roles involved in pkgsrc
455:
456: 1.4. Typography
457:
458: 1.1. Introduction
459:
460: There is a lot of software freely available for Unix-based systems, which is
461: usually available in form of the source code. Before such software can be used,
462: it needs to be configured to the local system, compiled and installed, and this
463: is exactly what The NetBSD Packages Collection (pkgsrc) does. pkgsrc also has
464: some basic commands to handle binary packages, so that not every user has to
465: build the packages for himself, which is a time-costly task.
466:
467: pkgsrc currently contains several thousand packages, including:
468:
1.104 sevan 469: * www/apache24 - The Apache web server
1.1 dsieger 470:
471: * www/firefox - The Firefox web browser
472:
473: * meta-pkgs/gnome - The GNOME Desktop Environment
474:
1.102 ryoon 475: * meta-pkgs/kde4 - The K Desktop Environment
1.1 dsieger 476:
1.108 rillig 477: ? just to name a few.
1.1 dsieger 478:
479: pkgsrc has built-in support for handling varying dependencies, such as pthreads
480: and X11, and extended features such as IPv6 support on a range of platforms.
481:
482: 1.1.1. Why pkgsrc?
483:
484: pkgsrc provides the following key features:
485:
486: * Easy building of software from source as well as the creation and
487: installation of binary packages. The source and latest patches are
488: retrieved from a master or mirror download site, checksum verified, then
489: built on your system. Support for binary-only distributions is available
490: for both native platforms and NetBSD emulated platforms.
491:
492: * All packages are installed in a consistent directory tree, including
493: binaries, libraries, man pages and other documentation.
494:
1.104 sevan 495: * Tracking of package dependencies automatically, including when performing
496: updates, to ensure required packages are installed. The configuration files
497: of various packages are handled automatically during updates, so local
498: changes are preserved.
1.1 dsieger 499:
500: * Like NetBSD, pkgsrc is designed with portability in mind and consists of
501: highly portable code. This allows the greatest speed of development when
1.26 spz 502: porting to a new platform. This portability also ensures that pkgsrc is
1.1 dsieger 503: consistent across all platforms.
504:
505: * The installation prefix, acceptable software licenses, international
506: encryption requirements and build-time options for a large number of
507: packages are all set in a simple, central configuration file.
508:
509: * The entire source (not including the distribution files) is freely
510: available under a BSD license, so you may extend and adapt pkgsrc to your
511: needs. Support for local packages and patches is available right out of the
512: box, so you can configure it specifically for your environment.
513:
514: The following principles are basic to pkgsrc:
515:
516: * "It should only work if it's right." ? That means, if a package contains
517: bugs, it's better to find them and to complain about them rather than to
518: just install the package and hope that it works. There are numerous checks
519: in pkgsrc that try to find such bugs: Static analysis tools (pkgtools/
520: pkglint), build-time checks (portability of shell scripts), and
521: post-installation checks (installed files, references to shared libraries,
522: script interpreters).
523:
524: * "If it works, it should work everywhere" ? Like NetBSD has been ported to
525: many hardware architectures, pkgsrc has been ported to many operating
526: systems. Care is taken that packages behave the same on all platforms.
527:
528: 1.1.2. Supported platforms
529:
530: pkgsrc consists of both a source distribution and a binary distribution for
531: these operating systems. After retrieving the required source or binaries, you
532: can be up and running with pkgsrc in just minutes!
533:
534: pkgsrc was derived from FreeBSD's ports system, and initially developed for
535: NetBSD only. Since then, pkgsrc has grown a lot, and now supports the following
536: platforms:
537:
538: Table 1.1. Platforms supported by pkgsrc
539:
1.92 sevan 540: +-----------------------------------------------------------------------------+
541: | Platform | Date Support | Notes |
542: | | Added | |
543: |--------------------------------------+---------------+----------------------|
544: |NetBSD | Aug 1997 | |
545: |--------------------------------------+---------------+----------------------|
546: |Solaris | Mar 1999 |README.Solaris |
547: |--------------------------------------+---------------+----------------------|
548: |Linux | Jun 1999 |README.Linux |
549: |--------------------------------------+---------------+----------------------|
1.118 sevan 550: |Darwin / Mac OS X / OS X / macOS | Oct 2001 |README.MacOSX |
1.92 sevan 551: |--------------------------------------+---------------+----------------------|
552: |FreeBSD | Nov 2002 |README.FreeBSD |
553: |--------------------------------------+---------------+----------------------|
554: |OpenBSD | Nov 2002 |README.OpenBSD |
555: |--------------------------------------+---------------+----------------------|
556: |IRIX | Dec 2002 |README.IRIX |
557: | | |README.IRIX5.3 |
558: |--------------------------------------+---------------+----------------------|
559: |BSD/OS | Dec 2003 | |
560: |--------------------------------------+---------------+----------------------|
561: |AIX | Dec 2003 |README.AIX |
562: |--------------------------------------+---------------+----------------------|
563: |Interix (Microsoft Windows Services | Mar 2004 |README.Interix |
564: |for Unix) | | |
565: |--------------------------------------+---------------+----------------------|
566: |DragonFlyBSD | Oct 2004 | |
567: |--------------------------------------+---------------+----------------------|
568: |OSF/1 | Nov 2004 |README.OSF1 |
569: |--------------------------------------+---------------+----------------------|
570: |HP-UX | Apr 2007 |README.HPUX |
571: |--------------------------------------+---------------+----------------------|
572: |Haiku | Sep 2010 |README.Haiku |
573: |--------------------------------------+---------------+----------------------|
574: |MirBSD | Jan 2011 | |
575: |--------------------------------------+---------------+----------------------|
576: |Minix3 | Nov 2011 |README.Minix3 |
577: |--------------------------------------+---------------+----------------------|
578: |Cygwin | Mar 2013 |README.Cygwin |
579: |--------------------------------------+---------------+----------------------|
580: |GNU/kFreeBSD | Jul 2013 |README.GNUkFreeBSD |
1.104 sevan 581: |--------------------------------------+---------------+----------------------|
582: |Bitrig | Jun 2014 |README.Bitrig |
1.92 sevan 583: +-----------------------------------------------------------------------------+
1.1 dsieger 584:
585:
586: 1.2. Overview
587:
588: This document is divided into three parts. The first, The pkgsrc user's guide,
589: describes how one can use one of the packages in the Package Collection, either
590: by installing a precompiled binary package, or by building one's own copy using
591: the NetBSD package system. The second part, The pkgsrc developer's guide,
592: explains how to prepare a package so it can be easily built by other NetBSD
593: users without knowing about the package's building details. The third part, The
594: pkgsrc infrastructure internals is intended for those who want to understand
595: how pkgsrc is implemented.
596:
597: This document is available in various formats: HTML, PDF, PS, TXT.
598:
599: 1.3. Terminology
600:
601: There has been a lot of talk about "ports", "packages", etc. so far. Here is a
602: description of all the terminology used within this document.
603:
604: Package
605:
606: A set of files and building instructions that describe what's necessary to
607: build a certain piece of software using pkgsrc. Packages are traditionally
1.123 wiz 608: stored under /usr/pkgsrc, but may be stored in any location, referred to as
609: PKGSRCDIR.
1.1 dsieger 610:
611: The NetBSD package system
612:
613: This is the former name of "pkgsrc". It is part of the NetBSD operating
614: system and can be bootstrapped to run on non-NetBSD operating systems as
615: well. It handles building (compiling), installing, and removing of
616: packages.
617:
618: Distfile
619:
620: This term describes the file or files that are provided by the author of
621: the piece of software to distribute his work. All the changes necessary to
622: build on NetBSD are reflected in the corresponding package. Usually the
623: distfile is in the form of a compressed tar-archive, but other types are
624: possible, too. Distfiles are usually stored below /usr/pkgsrc/distfiles.
625:
626: Port
627:
628: This is the term used by FreeBSD and OpenBSD people for what we call a
629: package. In NetBSD terminology, "port" refers to a different architecture.
630:
631: Precompiled/binary package
632:
633: A set of binaries built with pkgsrc from a distfile and stuffed together in
634: a single .tgz file so it can be installed on machines of the same machine
635: architecture without the need to recompile. Packages are usually generated
636: in /usr/pkgsrc/packages; there is also an archive on ftp.NetBSD.org.
637:
638: Sometimes, this is referred to by the term "package" too, especially in the
639: context of precompiled packages.
640:
641: Program
642:
643: The piece of software to be installed which will be constructed from all
644: the files in the distfile by the actions defined in the corresponding
645: package.
646:
647: 1.3.1. Roles involved in pkgsrc
648:
649: pkgsrc users
650:
651: The pkgsrc users are people who use the packages provided by pkgsrc.
652: Typically they are system administrators. The people using the software
653: that is inside the packages (maybe called "end users") are not covered by
654: the pkgsrc guide.
655:
656: There are two kinds of pkgsrc users: Some only want to install pre-built
657: binary packages. Others build the pkgsrc packages from source, either for
658: installing them directly or for building binary packages themselves. For
659: pkgsrc users Part I, "The pkgsrc user's guide" should provide all necessary
660: documentation.
661:
662: package maintainers
663:
664: A package maintainer creates packages as described in Part II, "The pkgsrc
665: developer's guide".
666:
667: infrastructure developers
668:
669: These people are involved in all those files that live in the mk/ directory
670: and below. Only these people should need to read through Part III, "The
671: pkgsrc infrastructure internals", though others might be curious, too.
672:
673: 1.4. Typography
674:
675: When giving examples for commands, shell prompts are used to show if the
676: command should/can be issued as root, or if "normal" user privileges are
1.115 sevan 677: sufficient. We use a # for root's shell prompt, a % for users' shell prompt,
678: assuming they use the C-shell or tcsh and a $ for bourne shell and derivatives.
1.1 dsieger 679:
680: Part I. The pkgsrc user's guide
681:
682: Table of Contents
683:
1.154 rillig 684: 2. Getting help
685: 3. Where to get pkgsrc and how to keep it up-to-date
1.1 dsieger 686:
1.154 rillig 687: 3.1. Getting pkgsrc for the first time
1.1 dsieger 688:
1.154 rillig 689: 3.1.1. As tar archive
690: 3.1.2. Via anonymous CVS
1.1 dsieger 691:
1.154 rillig 692: 3.2. Keeping pkgsrc up-to-date
1.1 dsieger 693:
1.154 rillig 694: 3.2.1. Via tar files
695: 3.2.2. Via CVS
1.1 dsieger 696:
1.154 rillig 697: 4. Using pkgsrc on systems other than NetBSD
1.1 dsieger 698:
1.154 rillig 699: 4.1. Binary distribution
700: 4.2. Bootstrapping pkgsrc
1.1 dsieger 701:
1.154 rillig 702: 5. Using pkgsrc
1.1 dsieger 703:
1.154 rillig 704: 5.1. Using binary packages
1.1 dsieger 705:
1.154 rillig 706: 5.1.1. Finding binary packages
707: 5.1.2. Installing binary packages
708: 5.1.3. Deinstalling packages
709: 5.1.4. Getting information about installed packages
710: 5.1.5. Checking for security vulnerabilities in installed packages
711: 5.1.6. Finding if newer versions of your installed packages are in
1.1 dsieger 712: pkgsrc
1.154 rillig 713: 5.1.7. Other administrative functions
1.1 dsieger 714:
1.154 rillig 715: 5.2. Building packages from source
1.1 dsieger 716:
1.154 rillig 717: 5.2.1. Requirements
718: 5.2.2. Fetching distfiles
719: 5.2.3. How to build and install
1.1 dsieger 720:
1.154 rillig 721: 6. Configuring pkgsrc
1.1 dsieger 722:
1.154 rillig 723: 6.1. General configuration
724: 6.2. Variables affecting the build process
725: 6.3. Variables affecting the installation process
726: 6.4. Selecting and configuring the compiler
1.1 dsieger 727:
1.154 rillig 728: 6.4.1. Selecting the compiler
729: 6.4.2. Additional flags to the compiler (CFLAGS)
730: 6.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 731:
1.154 rillig 732: 6.5. Developer/advanced settings
733: 6.6. Selecting Build Options
1.1 dsieger 734:
1.154 rillig 735: 7. Creating binary packages
1.1 dsieger 736:
1.154 rillig 737: 7.1. Building a single binary package
738: 7.2. Settings for creation of binary packages
1.1 dsieger 739:
1.154 rillig 740: 8. Creating binary packages for everything in pkgsrc (bulk builds)
1.6 rillig 741:
1.154 rillig 742: 8.1. Preparations
743: 8.2. Running a pbulk-style bulk build
1.6 rillig 744:
1.154 rillig 745: 8.2.1. Configuration
1.6 rillig 746:
1.154 rillig 747: 8.3. Requirements of a full bulk build
748: 8.4. Creating a multiple CD-ROM packages collection
1.6 rillig 749:
1.154 rillig 750: 8.4.1. Example of cdpack
1.6 rillig 751:
1.154 rillig 752: 9. Directory layout of the installed files
1.6 rillig 753:
1.154 rillig 754: 9.1. File system layout in ${LOCALBASE}
755: 9.2. File system layout in ${VARBASE}
1.6 rillig 756:
1.154 rillig 757: 10. Frequently Asked Questions
1.6 rillig 758:
1.154 rillig 759: 10.1. Are there any mailing lists for pkg-related discussion?
760: 10.2. Utilities for package management (pkgtools)
761: 10.3. How to use pkgsrc as non-root
762: 10.4. How to resume transfers when fetching distfiles?
763: 10.5. How can I install/use modular X.org from pkgsrc?
764: 10.6. How to fetch files from behind a firewall
765: 10.7. How to fetch files from HTTPS sites
766: 10.8. How do I tell make fetch to do passive FTP?
767: 10.9. How to fetch all distfiles at once
768: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
769: 10.11. What does "Could not find bsd.own.mk" mean?
770: 10.12. Using 'sudo' with pkgsrc
771: 10.13. How do I change the location of configuration files?
772: 10.14. Automated security checks
773: 10.15. Why do some packages ignore my CFLAGS?
774: 10.16. A package does not build. What shall I do?
775: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.24 wiz 776: conflicts" mean?
1.1 dsieger 777:
1.154 rillig 778: Chapter 2. Getting help
779:
780: To get help when using pkgsrc, the definitive source is this document, the
781: pkgsrc guide. If you don't find anything here, there are alternatives:
782:
783: * The built-in pkgsrc help, which is available after bootstrapping pkgsrc.
784: Run bmake help topic=? to get help for any topic, such as a variable name
785: like BUILD_DEFS, a make target like do-build, a missing C or C++ function
786: like strcasecmp or any other topic.
787:
788: The available help topics are listed in Appendix D, Help topics.
789:
790: * The pkgsrc-users mailing list, to which you can subscribe and then ask your
791: questions.
792:
793: * The #pkgsrc IRC channel, which is accessible via a web browser or by using
794: a specialized chat program such as XChat. Pick any user name and join the
795: channel #pkgsrc.
796:
797: Chapter 3. Where to get pkgsrc and how to keep it up-to-date
1.1 dsieger 798:
799: Table of Contents
800:
1.154 rillig 801: 3.1. Getting pkgsrc for the first time
1.1 dsieger 802:
1.154 rillig 803: 3.1.1. As tar archive
804: 3.1.2. Via anonymous CVS
1.1 dsieger 805:
1.154 rillig 806: 3.2. Keeping pkgsrc up-to-date
1.1 dsieger 807:
1.154 rillig 808: 3.2.1. Via tar files
809: 3.2.2. Via CVS
1.1 dsieger 810:
811: Before you download and extract the files, you need to decide where you want to
812: extract them. When using pkgsrc as root user, pkgsrc is usually installed in /
813: usr/pkgsrc. You are though free to install the sources and binary packages
814: wherever you want in your filesystem, provided that the pathname does not
815: contain white-space or other characters that are interpreted specially by the
816: shell and some other programs. A safe bet is to use only letters, digits,
817: underscores and dashes.
818:
1.154 rillig 819: 3.1. Getting pkgsrc for the first time
1.1 dsieger 820:
1.25 wiz 821: Before you download any pkgsrc files, you should decide whether you want the
1.1 dsieger 822: current branch or the stable branch. The latter is forked on a quarterly basis
823: from the current branch and only gets modified for security updates. The names
824: of the stable branches are built from the year and the quarter, for example
1.152 leot 825: 2019Q1.
1.1 dsieger 826:
827: The second step is to decide how you want to download pkgsrc. You can get it as
1.24 wiz 828: a tar file or via CVS. Both ways are described here.
1.1 dsieger 829:
1.52 asau 830: Note that tar archive contains CVS working copy. Thus you can switch to using
831: CVS at any later time.
1.1 dsieger 832:
1.154 rillig 833: 3.1.1. As tar archive
1.52 asau 834:
1.151 sevan 835: The primary download location for all pkgsrc files is https://cdn.NetBSD.org/
836: pub/pkgsrc/ or ftp://ftp.NetBSD.org/pub/pkgsrc/ (it points to the same
837: location). There are a number of subdirectories for different purposes, which
838: are described in detail in Appendix C, Directory layout of the pkgsrc FTP
839: server.
1.1 dsieger 840:
1.52 asau 841: The tar archive for the current branch is in the directory current and is
1.118 sevan 842: called pkgsrc.tar.gz. It is autogenerated weekly.
1.52 asau 843:
844: To save download time we provide bzip2- and xz-compressed archives which are
845: published at pkgsrc.tar.bz2 and pkgsrc.tar.xz respectively.
846:
847: You can fetch the same files using FTP.
1.1 dsieger 848:
1.152 leot 849: The tar file for the stable branch 2019Q1 is in the directory pkgsrc-2019Q1 and
1.59 jnemeth 850: is also called pkgsrc.tar.gz.
1.1 dsieger 851:
1.136 leot 852: To download the latest pkgsrc stable tarball, run:
1.12 weinem 853:
1.152 leot 854: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2019Q1/pkgsrc.tar.gz
1.12 weinem 855:
1.78 snj 856: If you prefer, you can also fetch it using "wget", "curl", or your web browser.
1.52 asau 857:
1.12 weinem 858: Then, extract it with:
859:
1.78 snj 860: $ tar -xzf pkgsrc.tar.gz -C /usr
1.12 weinem 861:
862: This will create the directory pkgsrc/ in /usr/ and all the package source will
863: be stored under /usr/pkgsrc/.
864:
865: To download pkgsrc-current, run:
866:
867: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz
1.1 dsieger 868:
1.154 rillig 869: 3.1.2. Via anonymous CVS
1.1 dsieger 870:
1.24 wiz 871: To fetch a specific pkgsrc stable branch, run:
1.1 dsieger 872:
1.152 leot 873: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2019Q1 -P pkgsrc
1.13 weinem 874:
1.24 wiz 875: This will create the directory pkgsrc/ in your /usr/ directory and all the
876: package source will be stored under /usr/pkgsrc/.
877:
878: To fetch the pkgsrc current branch, run:
1.1 dsieger 879:
1.40 wiz 880: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 881:
1.30 dholland 882: Refer to the list of available mirrors to choose a faster CVS mirror, if
883: needed.
1.1 dsieger 884:
1.24 wiz 885: If you get error messages from rsh, you need to set CVS_RSH variable. E.g.:
1.1 dsieger 886:
1.40 wiz 887: $ cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 888:
1.24 wiz 889: Refer to documentation on your command shell how to set CVS_RSH=ssh
890: permanently. For Bourne shells, you can set it in your .profile or better
891: globally in /etc/profile:
892:
893: # set CVS remote shell command
894: CVS_RSH=ssh
895: export CVS_RSH
1.12 weinem 896:
1.13 weinem 897: By default, CVS doesn't do things like most people would expect it to do. But
898: there is a way to convince CVS, by creating a file called .cvsrc in your home
1.12 weinem 899: directory and saving the following lines to it. This file will save you lots of
900: headache and some bug reports, so we strongly recommend it. You can find an
901: explanation of this file in the CVS documentation.
1.2 rillig 902:
903: # recommended CVS configuration file from the pkgsrc guide
1.155 ! sevan 904: cvs -q
1.2 rillig 905: checkout -P
1.4 rillig 906: update -dP
907: diff -upN
1.2 rillig 908: rdiff -u
1.24 wiz 909: release -d
1.1 dsieger 910:
1.154 rillig 911: 3.2. Keeping pkgsrc up-to-date
1.1 dsieger 912:
913: The preferred way to keep pkgsrc up-to-date is via CVS (which also works if you
914: have first installed it via a tar file). It saves bandwidth and hard disk
915: activity, compared to downloading the tar file again.
916:
1.154 rillig 917: 3.2.1. Via tar files
1.1 dsieger 918:
919: Warning
920:
921: When updating from a tar file, you first need to completely remove the old
922: pkgsrc directory. Otherwise those files that have been removed from pkgsrc in
923: the mean time will not be removed on your local disk, resulting in
924: inconsistencies. When removing the old files, any changes that you have done to
925: the pkgsrc files will be lost after updating. Therefore updating via CVS is
926: strongly recommended.
927:
928: Note that by default the distfiles and the binary packages are saved in the
929: pkgsrc tree, so don't forget to rescue them before updating. You can also
1.78 snj 930: configure pkgsrc to store distfiles and packages in directories outside the
1.154 rillig 931: pkgsrc tree by setting the DISTDIR and PACKAGES variables. See Chapter 6,
1.78 snj 932: Configuring pkgsrc for the details.
1.1 dsieger 933:
934: To update pkgsrc from a tar file, download the tar file as explained above.
935: Then, make sure that you have not made any changes to the files in the pkgsrc
936: directory. Remove the pkgsrc directory and extract the new tar file. Done.
937:
1.154 rillig 938: 3.2.2. Via CVS
1.1 dsieger 939:
1.26 spz 940: To update pkgsrc via CVS, change to the pkgsrc directory and run cvs:
1.12 weinem 941:
1.26 spz 942: $ cd /usr/pkgsrc && cvs update -dP
943:
944: If you get error messages from rsh, you need to set CVS_RSH variable as
945: described above. E.g.:
946:
947: $ cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP
1.1 dsieger 948:
1.154 rillig 949: 3.2.2.1. Switching between different pkgsrc branches
1.1 dsieger 950:
951: When updating pkgsrc, the CVS program keeps track of the branch you selected.
952: But if you, for whatever reason, want to switch from the stable branch to the
953: current one, you can do it by adding the option "-A" after the "update"
1.25 wiz 954: keyword. To switch from the current branch back to the stable branch, add the "
1.152 leot 955: -rpkgsrc-2019Q1" option.
1.1 dsieger 956:
1.154 rillig 957: 3.2.2.2. What happens to my changes when updating?
1.1 dsieger 958:
959: When you update pkgsrc, the CVS program will only touch those files that are
960: registered in the CVS repository. That means that any packages that you created
961: on your own will stay unmodified. If you change files that are managed by CVS,
962: later updates will try to merge your changes with those that have been done by
963: others. See the CVS manual, chapter "update" for details.
964:
1.154 rillig 965: Chapter 4. Using pkgsrc on systems other than NetBSD
1.1 dsieger 966:
967: Table of Contents
968:
1.154 rillig 969: 4.1. Binary distribution
970: 4.2. Bootstrapping pkgsrc
1.1 dsieger 971:
1.154 rillig 972: 4.1. Binary distribution
1.1 dsieger 973:
1.154 rillig 974: See Section 5.1, "Using binary packages".
1.1 dsieger 975:
1.154 rillig 976: 4.2. Bootstrapping pkgsrc
1.1 dsieger 977:
1.44 asau 978: pkgsrc can be bootstrapped for use in two different modes: privileged and
979: unprivileged one. In unprivileged mode in contrast to privileged one all
1.45 asau 980: programs are installed under one particular user and cannot utilise privileged
1.44 asau 981: operations (packages don't create special users and all special file
982: permissions like setuid are ignored).
983:
1.1 dsieger 984: Installing the bootstrap kit from source should be as simple as:
985:
1.60 asau 986: # env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 987: # cd pkgsrc/bootstrap
988: # ./bootstrap
989:
990:
1.44 asau 991: To bootstrap in unprivileged mode pass "--unprivileged" flag to bootstrap
992:
993: By default, in privileged mode pkgsrc uses /usr/pkg for prefix where programs
1.118 sevan 994: will be installed in, and /usr/pkg/pkgdb for the package database directory
995: where pkgsrc will do its internal bookkeeping, /var is used as varbase, where
1.44 asau 996: packages install their persistent data. In unprivileged mode pkgsrc uses ~/pkg
1.118 sevan 997: for prefix, ~/pkg/pkgdb for the package database, and ~/pkg/var for varbase.
1.44 asau 998:
999: You can change default layout using command-line arguments. Run "./bootstrap
1000: --help" to get details.
1.1 dsieger 1001:
1002: Note
1003:
1004: The bootstrap installs a bmake tool. Use this bmake when building via pkgsrc.
1005: For examples in this guide, use bmake instead of "make".
1006:
1.44 asau 1007: Note
1008:
1009: It is possible to bootstrap multiple instances of pkgsrc using non-intersecting
1010: directories. Use bmake corresponding to the installation you're working with to
1011: build and install packages.
1012:
1.154 rillig 1013: Chapter 5. Using pkgsrc
1.1 dsieger 1014:
1015: Table of Contents
1016:
1.154 rillig 1017: 5.1. Using binary packages
1.1 dsieger 1018:
1.154 rillig 1019: 5.1.1. Finding binary packages
1020: 5.1.2. Installing binary packages
1021: 5.1.3. Deinstalling packages
1022: 5.1.4. Getting information about installed packages
1023: 5.1.5. Checking for security vulnerabilities in installed packages
1024: 5.1.6. Finding if newer versions of your installed packages are in pkgsrc
1025: 5.1.7. Other administrative functions
1026:
1027: 5.2. Building packages from source
1028:
1029: 5.2.1. Requirements
1030: 5.2.2. Fetching distfiles
1031: 5.2.3. How to build and install
1.1 dsieger 1032:
1033: Basically, there are two ways of using pkgsrc. The first is to only install the
1034: package tools and to use binary packages that someone else has prepared. This
1035: is the "pkg" in pkgsrc. The second way is to install the "src" of pkgsrc, too.
1036: Then you are able to build your own packages, and you can still use binary
1037: packages from someone else.
1038:
1.154 rillig 1039: 5.1. Using binary packages
1.1 dsieger 1040:
1.151 sevan 1041: On the cdn.NetBSD.org site and mirrors, there are collections of binary
1.9 rillig 1042: packages, ready to be installed. These binary packages have been built using
1043: the default settings for the directories, that is:
1044:
1045: * /usr/pkg for LOCALBASE, where most of the files are installed,
1046:
1047: * /usr/pkg/etc for configuration files,
1048:
1049: * /var for VARBASE, where those files are installed that may change after
1050: installation.
1051:
1052: If you cannot use these directories for whatever reasons (maybe because you're
1053: not root), you cannot use these binary packages, but have to build the packages
1.154 rillig 1054: yourself, which is explained in Section 4.2, "Bootstrapping pkgsrc".
1.1 dsieger 1055:
1.154 rillig 1056: 5.1.1. Finding binary packages
1.1 dsieger 1057:
1.5 weinem 1058: To install binary packages, you first need to know from where to get them. The
1059: first place where you should look is on the main pkgsrc FTP server in the
1060: directory /pub/pkgsrc/packages.
1061:
1062: This directory contains binary packages for multiple platforms. First, select
1063: your operating system. (Ignore the directories with version numbers attached to
1064: it, they just exist for legacy reasons.) Then, select your hardware
1065: architecture, and in the third step, the OS version and the "version" of
1.9 rillig 1066: pkgsrc.
1067:
1068: In this directory, you often find a file called bootstrap.tar.gz which contains
1069: the package management tools. If the file is missing, it is likely that your
1070: operating system already provides those tools. Download the file and extract it
1071: in the / directory. It will create the directories /usr/pkg (containing the
1.118 sevan 1072: tools for managing binary packages and the database of installed packages).
1.1 dsieger 1073:
1.154 rillig 1074: 5.1.2. Installing binary packages
1.1 dsieger 1075:
1.85 wiz 1076: In the directory from the last section, there is a subdirectory called All/,
1.9 rillig 1077: which contains all the binary packages that are available for the platform,
1078: excluding those that may not be distributed via FTP or CDROM (depending on
1.24 wiz 1079: which medium you are using).
1.9 rillig 1080:
1081: To install packages directly from an FTP or HTTP server, run the following
1082: commands in a Bourne-compatible shell (be sure to su to root first):
1083:
1084: # PATH="/usr/pkg/sbin:$PATH"
1.151 sevan 1085: # PKG_PATH="http://cdn.NetBSD.org/pub/pkgsrc/packages/OPSYS/ARCH/VERSIONS/All/"
1.9 rillig 1086: # export PATH PKG_PATH
1087:
1088: Instead of URLs, you can also use local paths, for example if you are
1089: installing from a set of CDROMs, DVDs or an NFS-mounted repository. If you want
1090: to install packages from multiple sources, you can separate them by a semicolon
1091: in PKG_PATH.
1092:
1093: After these preparations, installing a package is very easy:
1094:
1.118 sevan 1095: # pkg_add libreoffice
1096: # pkg_add ap24-php71-*
1.1 dsieger 1097:
1098: Note that any prerequisite packages needed to run the package in question will
1099: be installed, too, assuming they are present where you install from.
1100:
1.25 wiz 1101: Adding packages might install vulnerable packages. Thus you should run
1.24 wiz 1102: pkg_admin audit regularly, especially after installing new packages, and verify
1103: that the vulnerabilities are acceptable for your configuration.
1.1 dsieger 1104:
1105: After you've installed packages, be sure to have /usr/pkg/bin and /usr/pkg/sbin
1106: in your PATH so you can actually start the just installed program.
1107:
1.154 rillig 1108: 5.1.3. Deinstalling packages
1.1 dsieger 1109:
1110: To deinstall a package, it does not matter whether it was installed from source
1111: code or from a binary package. The pkg_delete command does not know it anyway.
1112: To delete a package, you can just run pkg_delete package-name. The package name
1113: can be given with or without version number. Wildcards can also be used to
1114: deinstall a set of packages, for example *emacs*. Be sure to include them in
1115: quotes, so that the shell does not expand them before pkg_delete sees them.
1116:
1117: The -r option is very powerful: it removes all the packages that require the
1118: package in question and then removes the package itself. For example:
1119:
1120: # pkg_delete -r jpeg
1121:
1122:
1123: will remove jpeg and all the packages that used it; this allows upgrading the
1124: jpeg package.
1125:
1.154 rillig 1126: 5.1.4. Getting information about installed packages
1.1 dsieger 1127:
1128: The pkg_info shows information about installed packages or binary package
1129: files.
1130:
1.154 rillig 1131: 5.1.5. Checking for security vulnerabilities in installed packages
1.1 dsieger 1132:
1133: The NetBSD Security-Officer and Packages Groups maintain a list of known
1134: security vulnerabilities to packages which are (or have been) included in
1.151 sevan 1135: pkgsrc. The list is available from the NetBSD FTP site at http://ftp.NetBSD.org
1136: /pub/pkgsrc/distfiles/vulnerabilities.
1.1 dsieger 1137:
1.23 jakllsch 1138: Through pkg_admin fetch-pkg-vulnerabilities, this list can be downloaded
1139: automatically, and a security audit of all packages installed on a system can
1140: take place.
1141:
1142: There are two components to auditing. The first step, pkg_admin
1143: fetch-pkg-vulnerabilities, is for downloading the list of vulnerabilities from
1144: the NetBSD FTP site. The second step, pkg_admin audit, checks to see if any of
1145: your installed packages are vulnerable. If a package is vulnerable, you will
1146: see output similar to the following:
1.1 dsieger 1147:
1148: Package samba-2.0.9 has a local-root-shell vulnerability, see
1149: http://www.samba.org/samba/whatsnew/macroexploit.html
1150:
1.23 jakllsch 1151: You may wish to have the vulnerabilities file downloaded daily so that it
1152: remains current. This may be done by adding an appropriate entry to the root
1153: users crontab(5) entry. For example the entry
1154:
1.121 sevan 1155: # Download vulnerabilities file
1.118 sevan 1156: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1157: # Audit the installed packages and email results to root
1158: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1159: root >/dev/null 2>&1
1.118 sevan 1160:
1161:
1162: will update the vulnerability list every day at 3AM, followed by an audit at
1163: 3:09AM. The result of the audit are then emailed to root. On NetBSD this may be
1164: accomplished instead by adding the following line to /etc/daily.conf:
1165:
1166: fetch_pkg_vulnerabilities=YES
1167:
1.23 jakllsch 1168:
1.118 sevan 1169: to fetch the vulnerability list from the daily security script. The system is
1170: set to audit the packages by default but can be set explicitly, if desired (not
1.123 wiz 1171: required), by adding the following line to /etc/security.conf:
1.23 jakllsch 1172:
1.118 sevan 1173: check_pkg_vulnerabilities=YES
1.23 jakllsch 1174:
1175:
1.118 sevan 1176: see daily.conf(5) and security.conf(5) for more details.
1.1 dsieger 1177:
1.154 rillig 1178: 5.1.6. Finding if newer versions of your installed packages are in pkgsrc
1.1 dsieger 1179:
1.12 weinem 1180: Install pkgtools/lintpkgsrc and run lintpkgsrc with the "-i" argument to check
1181: if your packages are up-to-date, e.g.
1.1 dsieger 1182:
1183: % lintpkgsrc -i
1184: ...
1185: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1186:
1187:
1188: You can then use make update to update the package on your system and rebuild
1189: any dependencies.
1190:
1.154 rillig 1191: 5.1.7. Other administrative functions
1.1 dsieger 1192:
1193: The pkg_admin executes various administrative functions on the package system.
1194:
1.154 rillig 1195: 5.2. Building packages from source
1.1 dsieger 1196:
1197: After obtaining pkgsrc, the pkgsrc directory now contains a set of packages,
1.25 wiz 1198: organized into categories. You can browse the online index of packages, or run
1.1 dsieger 1199: make readme from the pkgsrc directory to build local README.html files for all
1200: packages, viewable with any web browser such as www/lynx or www/firefox.
1201:
1202: The default prefix for installed packages is /usr/pkg. If you wish to change
1203: this, you should do so by setting LOCALBASE in mk.conf. You should not try to
1204: use multiple different LOCALBASE definitions on the same system (inside a
1205: chroot is an exception).
1206:
1207: The rest of this chapter assumes that the package is already in pkgsrc. If it
1208: is not, see Part II, "The pkgsrc developer's guide" for instructions how to
1209: create your own packages.
1210:
1.154 rillig 1211: 5.2.1. Requirements
1.1 dsieger 1212:
1213: To build packages from source, you need a working C compiler. On NetBSD, you
1214: need to install the "comp" and the "text" distribution sets. If you want to
1215: build X11-related packages, the "xbase" and "xcomp" distribution sets are
1216: required, too.
1217:
1.154 rillig 1218: 5.2.2. Fetching distfiles
1.1 dsieger 1219:
1220: The first step for building a package is downloading the distfiles (i.e. the
1221: unmodified source). If they have not yet been downloaded, pkgsrc will fetch
1222: them automatically.
1223:
1224: If you have all files that you need in the distfiles directory, you don't need
1225: to connect. If the distfiles are on CD-ROM, you can mount the CD-ROM on /cdrom
1226: and add:
1227:
1228: DISTDIR=/cdrom/pkgsrc/distfiles
1229:
1230: to your mk.conf.
1231:
1232: By default a list of distribution sites will be randomly intermixed to prevent
1233: huge load on servers which holding popular packages (for example,
1234: SourceForge.net mirrors). Thus, every time when you need to fetch yet another
1235: distfile all the mirrors will be tried in new (random) order. You can turn this
1236: feature off by setting MASTER_SORT_RANDOM=NO (for PKG_DEVELOPERs it's already
1237: disabled).
1238:
1239: You can overwrite some of the major distribution sites to fit to sites that are
1240: close to your own. By setting one or two variables you can modify the order in
1241: which the master sites are accessed. MASTER_SORT contains a whitespace
1242: delimited list of domain suffixes. MASTER_SORT_REGEX is even more flexible, it
1243: contains a whitespace delimited list of regular expressions. It has higher
1244: priority than MASTER_SORT. Have a look at pkgsrc/mk/defaults/mk.conf to find
1245: some examples. This may save some of your bandwidth and time.
1246:
1247: You can change these settings either in your shell's environment, or, if you
1.4 rillig 1248: want to keep the settings, by editing the mk.conf file, and adding the
1.1 dsieger 1249: definitions there.
1250:
1.132 wiz 1251: If a package depends on many other packages (such as meta-pkgs/kde4), the build
1.1 dsieger 1252: process may alternate between periods of downloading source, and compiling. To
1253: ensure you have all the source downloaded initially you can run the command:
1254:
1255: % make fetch-list | sh
1256:
1257: which will output and run a set of shell commands to fetch the necessary files
1258: into the distfiles directory. You can also choose to download the files
1259: manually.
1260:
1.154 rillig 1261: 5.2.3. How to build and install
1.1 dsieger 1262:
1263: Once the software has downloaded, any patches will be applied, then it will be
1264: compiled for you. This may take some time depending on your computer, and how
1265: many other packages the software depends on and their compile time.
1266:
1267: Note
1268:
1269: If using bootstrap or pkgsrc on a non-NetBSD system, use the pkgsrc bmake
1270: command instead of "make" in the examples in this guide.
1271:
1272: For example, type
1273:
1274: % cd misc/figlet
1275: % make
1276:
1277:
1278: at the shell prompt to build the various components of the package.
1279:
1280: The next stage is to actually install the newly compiled program onto your
1281: system. Do this by entering:
1282:
1283: % make install
1284:
1285:
1286: while you are still in the directory for whatever package you are installing.
1287:
1288: Installing the package on your system may require you to be root. However,
1289: pkgsrc has a just-in-time-su feature, which allows you to only become root for
1290: the actual installation step.
1291:
1292: That's it, the software should now be installed and setup for use. You can now
1293: enter:
1294:
1295: % make clean
1296:
1297:
1298: to remove the compiled files in the work directory, as you shouldn't need them
1299: any more. If other packages were also added to your system (dependencies) to
1300: allow your program to compile, you can tidy these up also with the command:
1301:
1302: % make clean-depends
1303:
1304:
1305: Taking the figlet utility as an example, we can install it on our system by
1306: building as shown in Appendix B, Build logs.
1307:
1308: The program is installed under the default root of the packages tree - /usr/
1309: pkg. Should this not conform to your tastes, set the LOCALBASE variable in your
1310: environment, and it will use that value as the root of your packages tree. So,
1311: to use /usr/local, set LOCALBASE=/usr/local in your environment. Please note
1312: that you should use a directory which is dedicated to packages and not shared
1313: with other programs (i.e., do not try and use LOCALBASE=/usr). Also, you should
1314: not try to add any of your own files or directories (such as src/, obj/, or
1315: pkgsrc/) below the LOCALBASE tree. This is to prevent possible conflicts
1316: between programs and other files installed by the package system and whatever
1317: else may have been installed there.
1318:
1.4 rillig 1319: Some packages look in mk.conf to alter some configuration options at build
1.1 dsieger 1320: time. Have a look at pkgsrc/mk/defaults/mk.conf to get an overview of what will
1321: be set there by default. Environment variables such as LOCALBASE can be set in
1.4 rillig 1322: mk.conf to save having to remember to set them each time you want to use
1.1 dsieger 1323: pkgsrc.
1324:
1325: Occasionally, people want to "look under the covers" to see what is going on
1326: when a package is building or being installed. This may be for debugging
1327: purposes, or out of simple curiosity. A number of utility values have been
1328: added to help with this.
1329:
1330: 1. If you invoke the make(1) command with PKG_DEBUG_LEVEL=2, then a huge
1331: amount of information will be displayed. For example,
1332:
1333: make patch PKG_DEBUG_LEVEL=2
1334:
1.25 wiz 1335: will show all the commands that are invoked, up to and including the "patch
1336: " stage.
1.1 dsieger 1337:
1338: 2. If you want to know the value of a certain make(1) definition, then the
1339: VARNAME definition should be used, in conjunction with the show-var target.
1340: e.g. to show the expansion of the make(1) variable LOCALBASE:
1341:
1342: % make show-var VARNAME=LOCALBASE
1343: /usr/pkg
1344: %
1345:
1346:
1347: If you want to install a binary package that you've either created yourself
1348: (see next section), that you put into pkgsrc/packages manually or that is
1349: located on a remote FTP server, you can use the "bin-install" target. This
1350: target will install a binary package - if available - via pkg_add(1), else do a
1351: make package. The list of remote FTP sites searched is kept in the variable
1352: BINPKG_SITES, which defaults to ftp.NetBSD.org. Any flags that should be added
1353: to pkg_add(1) can be put into BIN_INSTALL_FLAGS. See pkgsrc/mk/defaults/mk.conf
1354: for more details.
1355:
1356: A final word of warning: If you set up a system that has a non-standard setting
1357: for LOCALBASE, be sure to set that before any packages are installed, as you
1358: cannot use several directories for the same purpose. Doing so will result in
1359: pkgsrc not being able to properly detect your installed packages, and fail
1360: miserably. Note also that precompiled binary packages are usually built with
1361: the default LOCALBASE of /usr/pkg, and that you should not install any if you
1362: use a non-standard LOCALBASE.
1363:
1.154 rillig 1364: Chapter 6. Configuring pkgsrc
1.1 dsieger 1365:
1366: Table of Contents
1367:
1.154 rillig 1368: 6.1. General configuration
1369: 6.2. Variables affecting the build process
1370: 6.3. Variables affecting the installation process
1371: 6.4. Selecting and configuring the compiler
1372:
1373: 6.4.1. Selecting the compiler
1374: 6.4.2. Additional flags to the compiler (CFLAGS)
1375: 6.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 1376:
1.154 rillig 1377: 6.5. Developer/advanced settings
1378: 6.6. Selecting Build Options
1.1 dsieger 1379:
1380: The whole pkgsrc system is configured in a single file, usually called mk.conf.
1381: In which directory pkgsrc looks for that file depends on the installation. On
1382: NetBSD, when you use make(1) from the base system, it is in the directory /etc
1383: /. In all other cases the default location is ${PREFIX}/etc/, depending on
1384: where you told the bootstrap program to install the binary packages.
1385:
1386: The format of the configuration file is that of the usual BSD-style Makefiles.
1387: The whole pkgsrc configuration is done by setting variables in this file. Note
1388: that you can define all kinds of variables, and no special error checking (for
1.112 rillig 1389: example for spelling mistakes) takes place.
1.1 dsieger 1390:
1.154 rillig 1391: 6.1. General configuration
1.1 dsieger 1392:
1.112 rillig 1393: The following variables apply to all pkgsrc packages. A complete list of the
1394: variables that can be configured by the user is available in mk/defaults/
1395: mk.conf, together with some comments that describe each variable's intent.
1.1 dsieger 1396:
1397: * LOCALBASE: Where packages will be installed. The default is /usr/pkg. Do
1398: not mix binary packages with different LOCALBASEs!
1399:
1400: * CROSSBASE: Where "cross" category packages will be installed. The default
1401: is ${LOCALBASE}/cross.
1402:
1.84 wiz 1403: * X11BASE: Where X11 is installed on the system. The default is /usr/X11R7.
1.1 dsieger 1404:
1405: * DISTDIR: Where to store the downloaded copies of the original source
1406: distributions used for building pkgsrc packages. The default is $
1407: {PKGSRCDIR}/distfiles.
1408:
1409: * PKG_DBDIR: Where the database about installed packages is stored. The
1.118 sevan 1410: default is /usr/pkg/pkgdb.
1.1 dsieger 1411:
1412: * MASTER_SITE_OVERRIDE: If set, override the packages' MASTER_SITES with this
1413: value.
1414:
1415: * MASTER_SITE_BACKUP: Backup location(s) for distribution files and patch
1416: files if not found locally or in ${MASTER_SITES} or ${PATCH_SITES}
1.118 sevan 1417: respectively. The defaults is ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/$
1.1 dsieger 1418: {DIST_SUBDIR}/.
1419:
1420: * BINPKG_SITES: List of sites carrying binary pkgs. rel and arch are replaced
1421: with OS release ("2.0", etc.) and architecture ("mipsel", etc.).
1422:
1.23 jakllsch 1423: * ACCEPTABLE_LICENSES: List of acceptable licenses. License names are
1424: case-sensitive. Whenever you try to build a package whose license is not in
1425: this list, you will get an error message. If the license condition is
1426: simple enough, the error message will include specific instructions on how
1427: to change this variable.
1.1 dsieger 1428:
1.154 rillig 1429: 6.2. Variables affecting the build process
1.1 dsieger 1430:
1431: * PACKAGES: The top level directory for the binary packages. The default is $
1432: {PKGSRCDIR}/packages.
1433:
1434: * WRKOBJDIR: The top level directory where, if defined, the separate working
1435: directories will get created, and symbolically linked to from ${WRKDIR}
1436: (see below). This is useful for building packages on several architectures,
1437: then ${PKGSRCDIR} can be NFS-mounted while ${WRKOBJDIR} is local to every
1438: architecture. (It should be noted that PKGSRCDIR should not be set by the
1439: user ? it is an internal definition which refers to the root of the pkgsrc
1440: tree. It is possible to have many pkgsrc tree instances.)
1441:
1442: * LOCALPATCHES: Directory for local patches that aren't part of pkgsrc. See
1.154 rillig 1443: Section 13.3, "patches/*" for more information.
1.1 dsieger 1444:
1445: * PKGMAKECONF: Location of the mk.conf file used by a package's BSD-style
1446: Makefile. If this is not set, MAKECONF is set to /dev/null to avoid picking
1447: up settings used by builds in /usr/src.
1448:
1.154 rillig 1449: 6.3. Variables affecting the installation process
1.1 dsieger 1450:
1.143 maya 1451: * PKGSRC_KEEP_BIN_PKGSRC: By default, binary packages of built packages are
1.150 leot 1452: preserved in ${PACKAGES}/All. Setting this variable to "no" prevents this.
1.1 dsieger 1453:
1.107 jnemeth 1454: Packages have to support installation into a subdirectory of WRKDIR. This
1455: allows a package to be built, before the actual filesystem is touched. DESTDIR
1456: support exists in two variations:
1.4 rillig 1457:
1458: * Basic DESTDIR support means that the package installation and packaging is
1459: still run as root.
1460:
1461: * Full DESTDIR support can run the complete build, installation and packaging
1462: as normal user. Root privileges are only needed to add packages.
1463:
1464: With basic DESTDIR support, make clean needs to be run as root.
1465:
1.17 imil 1466: Considering the foo/bar package, DESTDIR full support can be tested using the
1467: following commands
1468:
1469: $ id
1470: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1471: $ mkdir $HOME/packages
1472: $ cd $PKGSRCDIR/foo/bar
1473:
1474: Verify DESTDIR full support, no root privileges should be needed
1475:
1.66 asau 1476: $ make stage-install
1.17 imil 1477:
1478: Create a package without root privileges
1479:
1.66 asau 1480: $ make PACKAGES=$HOME/packages package
1.17 imil 1481:
1482: For the following command, you must be able to gain root privileges using su(1)
1483:
1.66 asau 1484: $ make PACKAGES=$HOME/packages install
1.17 imil 1485:
1486: Then, as a simple user
1487:
1488: $ make clean
1489:
1.154 rillig 1490: 6.4. Selecting and configuring the compiler
1.4 rillig 1491:
1.154 rillig 1492: 6.4.1. Selecting the compiler
1.1 dsieger 1493:
1494: By default, pkgsrc will use GCC to build packages. This may be overridden by
1495: setting the following variables in /etc/mk.conf:
1496:
1497: PKGSRC_COMPILER:
1498:
1499: This is a list of values specifying the chain of compilers to invoke when
1500: building packages. Valid values are:
1501:
1.66 asau 1502: + ccc: Compaq C Compilers (Tru64)
1503:
1504: + ccache: compiler cache (chainable)
1505:
1506: + clang: Clang C and Objective-C compiler
1507:
1.42 asau 1508: + distcc: distributed C/C++ (chainable)
1.1 dsieger 1509:
1.66 asau 1510: + f2c: Fortran 77 to C compiler (chainable)
1511:
1512: + icc: Intel C++ Compiler (Linux)
1513:
1514: + ido: SGI IRIS Development Option cc (IRIX 5)
1.1 dsieger 1515:
1.42 asau 1516: + gcc: GNU C/C++ Compiler
1.1 dsieger 1517:
1.66 asau 1518: + hp: HP-UX C/aC++ compilers
1519:
1.42 asau 1520: + mipspro: Silicon Graphics, Inc. MIPSpro (n32/n64)
1.1 dsieger 1521:
1.66 asau 1522: + mipspro-ucode: Silicon Graphics, Inc. MIPSpro (o32)
1.1 dsieger 1523:
1.42 asau 1524: + sunpro: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio
1.1 dsieger 1525:
1.118 sevan 1526: + xlc: IBM's XL C/C++ compiler suite
1.66 asau 1527:
1.1 dsieger 1528: The default is "gcc". You can use ccache and/or distcc with an appropriate
1529: PKGSRC_COMPILER setting, e.g. "ccache gcc". This variable should always be
1530: terminated with a value for a real compiler. Note that only one real
1531: compiler should be listed (e.g. "sunpro gcc" is not allowed).
1532:
1533: GCC_REQD:
1534:
1535: This specifies the minimum version of GCC to use when building packages. If
1536: the system GCC doesn't satisfy this requirement, then pkgsrc will build and
1537: install one of the GCC packages to use instead.
1538:
1.153 leot 1539: PYTHON_VERSION_DEFAULT:
1.114 maya 1540:
1541: Specifies which version of python to use when several options are
1542: available.
1543:
1544: PKGSRC_FORTRAN:
1545:
1546: Specifies the fortran compiler to use. The default is g95, and gfortran is
1547: an alternative.
1548:
1549: GFORTRAN_VERSION:
1550:
1551: If PKGSRC_FORTRAN= gfortran is used, this option specifies which version to
1552: use.
1553:
1.154 rillig 1554: 6.4.2. Additional flags to the compiler (CFLAGS)
1.1 dsieger 1555:
1556: If you wish to set the CFLAGS variable, please make sure to use the += operator
1557: instead of the = operator:
1558:
1559: CFLAGS+= -your -flags
1560:
1561: Using CFLAGS= (i.e. without the "+") may lead to problems with packages that
1.16 jnemeth 1562: need to add their own flags. You may want to take a look at the devel/cpuflags
1.24 wiz 1563: package if you're interested in optimization specifically for the current CPU.
1.1 dsieger 1564:
1.154 rillig 1565: 6.4.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 1566:
1567: If you want to pass flags to the linker, both in the configure step and the
1568: build step, you can do this in two ways. Either set LDFLAGS or LIBS. The
1569: difference between the two is that LIBS will be appended to the command line,
1570: while LDFLAGS come earlier. LDFLAGS is pre-loaded with rpath settings for ELF
1571: machines depending on the setting of USE_IMAKE or the inclusion of mk/
1572: x11.buildlink3.mk. As with CFLAGS, if you do not wish to override these
1573: settings, use the += operator:
1574:
1575: LDFLAGS+= -your -linkerflags
1576:
1.154 rillig 1577: 6.5. Developer/advanced settings
1.1 dsieger 1578:
1579: * PKG_DEVELOPER: Run some sanity checks that package developers want:
1580:
1.42 asau 1581: + make sure patches apply with zero fuzz
1.1 dsieger 1582:
1.42 asau 1583: + run check-shlibs to see that all binaries will find their shared libs.
1.1 dsieger 1584:
1585: * PKG_DEBUG_LEVEL: The level of debugging output which is displayed whilst
1586: making and installing the package. The default value for this is 0, which
1587: will not display the commands as they are executed (normal, default, quiet
1588: operation); the value 1 will display all shell commands before their
1589: invocation, and the value 2 will display both the shell commands before
1.112 rillig 1590: their invocation, as well as their actual execution progress with set -x.
1.1 dsieger 1591:
1.154 rillig 1592: 6.6. Selecting Build Options
1.1 dsieger 1593:
1594: Some packages have build time options, usually to select between different
1595: dependencies, enable optional support for big dependencies or enable
1596: experimental features.
1597:
1598: To see which options, if any, a package supports, and which options are
1599: mutually exclusive, run make show-options, for example:
1600:
1601: The following options are supported by this package:
1602: ssl Enable SSL support.
1603: Exactly one of the following gecko options is required:
1604: firefox Use firefox as gecko rendering engine.
1605: mozilla Use mozilla as gecko rendering engine.
1606: At most one of the following database options may be selected:
1607: mysql Enable support for MySQL database.
1608: pgsql Enable support for PostgreSQL database.
1609:
1610: These options are enabled by default: firefox
1611: These options are currently enabled: mozilla ssl
1612:
1.4 rillig 1613: The following variables can be defined in mk.conf to select which options to
1614: enable for a package: PKG_DEFAULT_OPTIONS, which can be used to select or
1.1 dsieger 1615: disable options for all packages that support them, and PKG_OPTIONS.pkgbase,
1616: which can be used to select or disable options specifically for package pkgbase
1617: . Options listed in these variables are selected, options preceded by "-" are
1618: disabled. A few examples:
1619:
1.4 rillig 1620: $ grep "PKG.*OPTION" mk.conf
1.1 dsieger 1621: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1622: PKG_OPTIONS.kdebase= debug -sasl
1623: PKG_OPTIONS.apache= suexec
1624:
1.11 rillig 1625: It is important to note that options that were specifically suggested by the
1.19 snj 1626: package maintainer must be explicitly removed if you do not wish to include the
1627: option. If you are unsure you can view the current state with make show-options
1628: .
1.11 rillig 1629:
1.1 dsieger 1630: The following settings are consulted in the order given, and the last setting
1631: that selects or disables an option is used:
1632:
1633: 1. the default options as suggested by the package maintainer
1634:
1635: 2. the options implied by the settings of legacy variables (see below)
1636:
1637: 3. PKG_DEFAULT_OPTIONS
1638:
1639: 4. PKG_OPTIONS.pkgbase
1640:
1641: For groups of mutually exclusive options, the last option selected is used, all
1642: others are automatically disabled. If an option of the group is explicitly
1643: disabled, the previously selected option, if any, is used. It is an error if no
1644: option from a required group of options is selected, and building the package
1645: will fail.
1646:
1647: Before the options framework was introduced, build options were selected by
1.4 rillig 1648: setting a variable (often named USE_FOO) in mk.conf for each option. To ease
1649: transition to the options framework for the user, these legacy variables are
1650: converted to the appropriate options setting (PKG_OPTIONS.pkgbase)
1651: automatically. A warning is issued to prompt the user to update mk.conf to use
1652: the options framework directly. Support for the legacy variables will be
1.1 dsieger 1653: removed eventually.
1654:
1.154 rillig 1655: Chapter 7. Creating binary packages
1.1 dsieger 1656:
1657: Table of Contents
1658:
1.154 rillig 1659: 7.1. Building a single binary package
1660: 7.2. Settings for creation of binary packages
1.1 dsieger 1661:
1.154 rillig 1662: 7.1. Building a single binary package
1.1 dsieger 1663:
1664: Once you have built and installed a package, you can create a binary package
1665: which can be installed on another system with pkg_add(1). This saves having to
1666: build the same package on a group of hosts and wasting CPU time. It also
1667: provides a simple means for others to install your package, should you
1668: distribute it.
1669:
1670: To create a binary package, change into the appropriate directory in pkgsrc,
1671: and run make package:
1672:
1.112 rillig 1673: $ cd misc/figlet
1674: $ make package
1.1 dsieger 1675:
1676: This will build and install your package (if not already done), and then build
1677: a binary package from what was installed. You can then use the pkg_* tools to
1678: manipulate it. Binary packages are created by default in /usr/pkgsrc/packages,
1679: in the form of a gzipped tar file. See Section B.2, "Packaging figlet" for a
1680: continuation of the above misc/figlet example.
1681:
1.154 rillig 1682: See Chapter 23, Submitting and Committing for information on how to submit such
1.1 dsieger 1683: a binary package.
1684:
1.154 rillig 1685: 7.2. Settings for creation of binary packages
1.1 dsieger 1686:
1.154 rillig 1687: See Section 19.17, "Other helpful targets".
1.6 rillig 1688:
1.154 rillig 1689: Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)
1.6 rillig 1690:
1691: Table of Contents
1692:
1.154 rillig 1693: 8.1. Preparations
1694: 8.2. Running a pbulk-style bulk build
1.6 rillig 1695:
1.154 rillig 1696: 8.2.1. Configuration
1.6 rillig 1697:
1.154 rillig 1698: 8.3. Requirements of a full bulk build
1699: 8.4. Creating a multiple CD-ROM packages collection
1.6 rillig 1700:
1.154 rillig 1701: 8.4.1. Example of cdpack
1.6 rillig 1702:
1.71 wiz 1703: For a number of reasons you may want to build binary packages for a large
1704: selected set of packages in pkgsrc or even for all pkgsrc packages. For
1705: instance, when you have multiple machines that should run the same software, it
1706: is wasted time if they all build their packages themselves from source. Or you
1707: may want to build a list of packages you want and check them before deploying
1708: onto production system. There is a way of getting a set of binary packages: The
1.112 rillig 1709: bulk build system, or pbulk ("p" stands for "parallel"). This chapter describes
1710: how to set it up.
1.71 wiz 1711:
1.154 rillig 1712: 8.1. Preparations
1.71 wiz 1713:
1714: First of all, you have to decide whether you build all packages or a limited
1715: set of them. Full bulk builds usually consume a lot more resources, both space
1716: and time, than builds for some practical sets of packages. There exists a
1717: number of particularly heavy packages that are not actually interesting to a
1718: wide audience. For a limited bulk builds you need to make a list of packages
1.112 rillig 1719: you want to build. Note that all their dependencies will be built, so you don't
1720: need to track them manually.
1.71 wiz 1721:
1722: During bulk builds various packages are installed and deinstalled in /usr/pkg
1723: (or whatever LOCALBASE is), so make sure that you don't need any package during
1.112 rillig 1724: the builds. Essentially, you should provide a fresh system, either a chroot
1.71 wiz 1725: environment or something even more restrictive, depending on what the operating
1726: system provides, or dedicate the whole physical machine. As a useful side
1727: effect this makes sure that bulk builds cannot break anything in your system.
1728: There have been numerous cases where certain packages tried to install files
1729: outside the LOCALBASE or wanted to edit some files in /etc.
1.6 rillig 1730:
1.154 rillig 1731: 8.2. Running a pbulk-style bulk build
1.6 rillig 1732:
1.15 rillig 1733: Running a pbulk-style bulk build works roughly as follows:
1734:
1735: * First, build the pbulk infrastructure in a fresh pkgsrc location.
1736:
1737: * Then, build each of the packages from a clean installation directory using
1738: the infrastructure.
1739:
1.154 rillig 1740: 8.2.1. Configuration
1.6 rillig 1741:
1.112 rillig 1742: To simplify configuration, we provide the helper script mk/pbulk/pbulk.sh.
1.6 rillig 1743:
1.68 asau 1744: In order to use it, prepare a clear system (real one, chroot environment, jail,
1745: zone, virtual machine). Configure network access to fetch distribution files.
1.112 rillig 1746: Create a user with name "pbulk".
1.68 asau 1747:
1748: Fetch and extract pkgsrc. Use a command like one of these:
1749:
1.151 sevan 1750: # (cd /usr && ftp -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
1751: # (cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
1.72 wiz 1752: # (cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)
1.68 asau 1753:
1754: Or any other way that fits (e.g., curl, wget).
1755:
1756: Deploy and configure pbulk tools, e.g.:
1757:
1.118 sevan 1758: # sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)
1.68 asau 1759: # sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment
1760: # sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build
1761:
1762: Note
1763:
1764: mk.conf.frag is a fragment of mk.conf that contains settings you want to apply
1765: to packages you build. For instance,
1766:
1.112 rillig 1767: PKG_DEVELOPER= yes # perform more checks
1768: X11_TYPE= modular # use pkgsrc X11
1769: SKIP_LICENSE_CHECK= yes # accept all licences (useful
1770: # when building all packages)
1.68 asau 1771:
1772: If configured for limited list, replace the list in /usr/pbulk/etc/pbulk.list
1.112 rillig 1773: with your list of packages, one per line without empty lines or comments. E.g.:
1.68 asau 1774:
1775: www/firefox
1776: mail/thunderbird
1777: misc/libreoffice4
1778:
1.69 asau 1779: At this point you can also review configuration in /usr/pbulk/etc and make
1780: final amendments, if wanted.
1781:
1.68 asau 1782: Start it:
1783:
1784: # /usr/pbulk/bin/bulkbuild
1785:
1786: After it finishes, you'll have /mnt filled with distribution files, binary
1787: packages, and reports, plain text summary in /mnt/bulklog/meta/report.txt
1788:
1789: Note
1790:
1791: The pbulk.sh script does not cover all possible use cases. While being ready to
1792: run, it serves as a good starting point to understand and build more complex
1793: setups. The script is kept small enough for better understanding.
1794:
1795: Note
1796:
1797: The pbulk.sh script supports running unprivileged bulk build and helps
1798: configuring distributed bulk builds.
1.15 rillig 1799:
1.154 rillig 1800: 8.3. Requirements of a full bulk build
1.71 wiz 1801:
1802: A complete bulk build requires lots of disk space. Some of the disk space can
1803: be read-only, some other must be writable. Some can be on remote filesystems
1804: (such as NFS) and some should be local. Some can be temporary filesystems,
1805: others must survive a sudden reboot.
1806:
1807: * 40 GB for the distfiles (read-write, remote, temporary)
1808:
1809: * 30 GB for the binary packages (read-write, remote, permanent)
1810:
1811: * 1 GB for the pkgsrc tree (read-only, remote, permanent)
1812:
1813: * 5 GB for LOCALBASE (read-write, local, temporary)
1814:
1815: * 10 GB for the log files (read-write, remote, permanent)
1816:
1817: * 5 GB for temporary files (read-write, local, temporary)
1818:
1.154 rillig 1819: 8.4. Creating a multiple CD-ROM packages collection
1.1 dsieger 1820:
1821: After your pkgsrc bulk-build has completed, you may wish to create a CD-ROM set
1822: of the resulting binary packages to assist in installing packages on other
1823: machines. The pkgtools/cdpack package provides a simple tool for creating the
1824: ISO 9660 images. cdpack arranges the packages on the CD-ROMs in a way that
1825: keeps all the dependencies for a given package on the same CD as that package.
1826:
1.154 rillig 1827: 8.4.1. Example of cdpack
1.1 dsieger 1828:
1829: Complete documentation for cdpack is found in the cdpack(1) man page. The
1830: following short example assumes that the binary packages are left in /usr/
1831: pkgsrc/packages/All and that sufficient disk space exists in /u2 to hold the
1832: ISO 9660 images.
1833:
1834: # mkdir /u2/images
1835: # pkg_add /usr/pkgsrc/packages/All/cdpack
1836: # cdpack /usr/pkgsrc/packages/All /u2/images
1837:
1838:
1839: If you wish to include a common set of files (COPYRIGHT, README, etc.) on each
1840: CD in the collection, then you need to create a directory which contains these
1841: files. e.g.
1842:
1843: # mkdir /tmp/common
1844: # echo "This is a README" > /tmp/common/README
1845: # echo "Another file" > /tmp/common/COPYING
1846: # mkdir /tmp/common/bin
1847: # echo "#!/bin/sh" > /tmp/common/bin/myscript
1848: # echo "echo Hello world" >> /tmp/common/bin/myscript
1849: # chmod 755 /tmp/common/bin/myscript
1850:
1851:
1852: Now create the images:
1853:
1854: # cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images
1855:
1856: Each image will contain README, COPYING, and bin/myscript in their root
1857: directories.
1858:
1.154 rillig 1859: Chapter 9. Directory layout of the installed files
1.1 dsieger 1860:
1861: Table of Contents
1862:
1.154 rillig 1863: 9.1. File system layout in ${LOCALBASE}
1864: 9.2. File system layout in ${VARBASE}
1.1 dsieger 1865:
1866: The files that are installed by pkgsrc are organized in a way that is similar
1867: to what you find in the /usr directory of the base system. But some details are
1868: different. This is because pkgsrc initially came from FreeBSD and had adopted
1869: its file system hierarchy. Later it was largely influenced by NetBSD. But no
1870: matter which operating system you are using pkgsrc with, you can expect the
1871: same layout for pkgsrc.
1872:
1873: There are mainly four root directories for pkgsrc, which are all configurable
1874: in the bootstrap/bootstrap script. When pkgsrc has been installed as root, the
1875: default locations are:
1876:
1877: LOCALBASE= /usr/pkg
1878: PKG_SYSCONFBASE= /usr/pkg/etc
1879: VARBASE= /var
1.119 sevan 1880: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 1881:
1882: In unprivileged mode (when pkgsrc has been installed as any other user), the
1883: default locations are:
1884:
1885: LOCALBASE= ${HOME}/pkg
1886: PKG_SYSCONFBASE= ${HOME}/pkg/etc
1887: VARBASE= ${HOME}/pkg/var
1.119 sevan 1888: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 1889:
1890: What these four directories are for, and what they look like is explained
1891: below.
1892:
1.25 wiz 1893: * LOCALBASE corresponds to the /usr directory in the base system. It is the "
1894: main" directory where the files are installed and contains the well-known
1.1 dsieger 1895: subdirectories like bin, include, lib, share and sbin.
1896:
1897: * VARBASE corresponds to /var in the base system. Some programs (especially
1898: games, network daemons) need write access to it during normal operation.
1899:
1900: * PKG_SYSCONFDIR corresponds to /etc in the base system. It contains
1901: configuration files of the packages, as well as pkgsrc's mk.conf itself.
1902:
1.154 rillig 1903: 9.1. File system layout in ${LOCALBASE}
1.1 dsieger 1904:
1905: The following directories exist in a typical pkgsrc installation in $
1906: {LOCALBASE}.
1907:
1908: bin
1909:
1910: Contains executable programs that are intended to be directly used by the
1911: end user.
1912:
1913: emul
1914:
1915: Contains files for the emulation layers of various other operating systems,
1916: especially for NetBSD.
1917:
1918: etc (the usual location of ${PKG_SYSCONFDIR})
1919:
1920: Contains the configuration files.
1921:
1922: include
1923:
1924: Contains headers for the C and C++ programming languages.
1925:
1926: info
1927:
1928: Contains GNU info files of various packages.
1929:
1930: lib
1931:
1932: Contains shared and static libraries.
1933:
1934: libdata
1935:
1936: Contains data files that don't change after installation. Other data files
1937: belong into ${VARBASE}.
1938:
1939: libexec
1940:
1941: Contains programs that are not intended to be used by end users, such as
1942: helper programs or network daemons.
1943:
1944: libexec/cgi-bin
1945:
1946: Contains programs that are intended to be executed as CGI scripts by a web
1947: server.
1948:
1949: man (the usual value of ${PKGMANDIR})
1950:
1951: Contains brief documentation in form of manual pages.
1952:
1953: sbin
1954:
1955: Contains programs that are intended to be used only by the super-user.
1956:
1957: share
1958:
1959: Contains platform-independent data files that don't change after
1960: installation.
1961:
1962: share/doc
1963:
1964: Contains documentation files provided by the packages.
1965:
1966: share/examples
1967:
1968: Contains example files provided by the packages. Among others, the original
1969: configuration files are saved here and copied to ${PKG_SYSCONFDIR} during
1970: installation.
1971:
1972: share/examples/rc.d
1973:
1974: Contains the original files for rc.d scripts.
1975:
1976: var (the usual location of ${VARBASE})
1977:
1978: Contains files that may be modified after installation.
1979:
1.154 rillig 1980: 9.2. File system layout in ${VARBASE}
1.1 dsieger 1981:
1982: db/pkg (the usual location of ${PKG_DBDIR})
1983:
1984: Contains information about the currently installed packages.
1985:
1986: games
1987:
1988: Contains highscore files.
1989:
1990: log
1991:
1992: Contains log files.
1993:
1994: run
1995:
1996: Contains informational files about daemons that are currently running.
1997:
1.154 rillig 1998: Chapter 10. Frequently Asked Questions
1.1 dsieger 1999:
2000: Table of Contents
2001:
1.154 rillig 2002: 10.1. Are there any mailing lists for pkg-related discussion?
2003: 10.2. Utilities for package management (pkgtools)
2004: 10.3. How to use pkgsrc as non-root
2005: 10.4. How to resume transfers when fetching distfiles?
2006: 10.5. How can I install/use modular X.org from pkgsrc?
2007: 10.6. How to fetch files from behind a firewall
2008: 10.7. How to fetch files from HTTPS sites
2009: 10.8. How do I tell make fetch to do passive FTP?
2010: 10.9. How to fetch all distfiles at once
2011: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
2012: 10.11. What does "Could not find bsd.own.mk" mean?
2013: 10.12. Using 'sudo' with pkgsrc
2014: 10.13. How do I change the location of configuration files?
2015: 10.14. Automated security checks
2016: 10.15. Why do some packages ignore my CFLAGS?
2017: 10.16. A package does not build. What shall I do?
2018: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.24 wiz 2019: conflicts" mean?
1.1 dsieger 2020:
2021: This section contains hints, tips & tricks on special things in pkgsrc that we
2022: didn't find a better place for in the previous chapters, and it contains items
2023: for both pkgsrc users and developers.
2024:
1.154 rillig 2025: 10.1. Are there any mailing lists for pkg-related discussion?
1.1 dsieger 2026:
2027: The following mailing lists may be of interest to pkgsrc users:
2028:
2029: * pkgsrc-users: This is a general purpose list for most issues regarding
2030: pkgsrc, regardless of platform, e.g. soliciting user help for pkgsrc
2031: configuration, unexpected build failures, using particular packages,
2032: upgrading pkgsrc installations, questions regarding the pkgsrc release
2033: branches, etc. General announcements or proposals for changes that impact
2034: the pkgsrc user community, e.g. major infrastructure changes, new features,
2035: package removals, etc., may also be posted.
2036:
2037: * pkgsrc-bulk: A list where the results of pkgsrc bulk builds are sent and
2038: discussed.
2039:
2040: * pkgsrc-changes: This list is for those who are interested in getting a
2041: commit message for every change committed to pkgsrc. It is also available
2042: in digest form, meaning one daily message containing all commit messages
2043: for changes to the package source tree in that 24 hour period.
2044:
2045: To subscribe, do:
2046:
2047: % echo subscribe listname | mail majordomo@NetBSD.org
2048:
2049: Archives for all these mailing lists are available from http://
2050: mail-index.NetBSD.org/.
2051:
1.154 rillig 2052: 10.2. Utilities for package management (pkgtools)
1.1 dsieger 2053:
2054: The directory pkgsrc/pkgtools contains a number of useful utilities for both
2055: users and developers of pkgsrc. This section attempts only to make the reader
1.121 sevan 2056: aware of some of the utilities and when they might be useful, and not to
2057: duplicate the documentation that comes with each package.
1.1 dsieger 2058:
2059: Utilities used by pkgsrc (automatically installed when needed):
2060:
2061: * pkgtools/x11-links: Symlinks for use by buildlink.
2062:
2063: OS tool augmentation (automatically installed when needed):
2064:
1.121 sevan 2065: * pkgtools/digest: Calculates various kinds of checksums (including SHA3).
1.1 dsieger 2066:
2067: * pkgtools/libnbcompat: Compatibility library for pkgsrc tools.
2068:
2069: * pkgtools/mtree: Installed on non-BSD systems due to lack of native mtree.
2070:
2071: * pkgtools/pkg_install: Up-to-date replacement for /usr/sbin/pkg_install, or
2072: for use on operating systems where pkg_install is not present.
2073:
2074: Utilities used by pkgsrc (not automatically installed):
2075:
2076: * pkgtools/pkg_tarup: Create a binary package from an already-installed
2077: package. Used by make replace to save the old package.
2078:
2079: * pkgtools/dfdisk: Adds extra functionality to pkgsrc, allowing it to fetch
2080: distfiles from multiple locations. It currently supports the following
2081: methods: multiple CD-ROMs and network FTP/HTTP connections.
2082:
2083: * devel/cpuflags: Determine the best compiler flags to optimise code for your
1.24 wiz 2084: current CPU and compiler.
1.1 dsieger 2085:
2086: Utilities for keeping track of installed packages, being up to date, etc:
2087:
1.65 wiz 2088: * pkgtools/pkgin: A package update tool similar to apt(1). Download, install,
2089: and upgrade binary packages easily.
2090:
1.1 dsieger 2091: * pkgtools/pkg_chk: Reports on packages whose installed versions do not match
2092: the latest pkgsrc entries.
2093:
2094: * pkgtools/pkgdep: Makes dependency graphs of packages, to aid in choosing a
2095: strategy for updating.
2096:
2097: * pkgtools/pkgdepgraph: Makes graphs from the output of pkgtools/pkgdep (uses
2098: graphviz).
2099:
1.12 weinem 2100: * pkgtools/pkglint: The pkglint(1) program checks a pkgsrc entry for errors.
2101:
2102: * pkgtools/lintpkgsrc: The lintpkgsrc(1) program does various checks on the
2103: complete pkgsrc system.
1.1 dsieger 2104:
2105: * pkgtools/pkgsurvey: Report what packages you have installed.
2106:
2107: Utilities for people maintaining or creating individual packages:
2108:
2109: * pkgtools/pkgdiff: Automate making and maintaining patches for a package
2110: (includes pkgdiff, pkgvi, mkpatches, etc.).
2111:
1.65 wiz 2112: * pkgtools/url2pkg: Aids in converting to pkgsrc.
1.1 dsieger 2113:
2114: Utilities for people maintaining pkgsrc (or: more obscure pkg utilities)
2115:
2116: * pkgtools/pkg_comp: Build packages in a chrooted area.
2117:
2118: * pkgtools/libkver: Spoof kernel version for chrooted cross builds.
2119:
1.154 rillig 2120: 10.3. How to use pkgsrc as non-root
1.1 dsieger 2121:
1.108 rillig 2122: To install packages from source as a non-root user, download pkgsrc as
1.154 rillig 2123: described in Chapter 3, Where to get pkgsrc and how to keep it up-to-date, cd
1.108 rillig 2124: into that directory and run the command ./bootstrap/bootstrap --unprivileged.
2125:
2126: This will install the binary part of pkgsrc to ~/pkg and put the pkgsrc
2127: configuration mk.conf into ~/pkg/etc.
2128:
2129: For more details, see mk/unprivileged.mk.
1.1 dsieger 2130:
1.154 rillig 2131: 10.4. How to resume transfers when fetching distfiles?
1.1 dsieger 2132:
2133: By default, resuming transfers in pkgsrc is disabled, but you can enable this
1.4 rillig 2134: feature by adding the option PKG_RESUME_TRANSFERS=YES into mk.conf. If, during
2135: a fetch step, an incomplete distfile is found, pkgsrc will try to resume it.
1.1 dsieger 2136:
1.61 wiz 2137: You can also use a different program than the platform default program by
2138: changing the FETCH_USING variable. You can specify the program by using of ftp,
2139: fetch, wget or curl. Alternatively, fetching can be disabled by using the value
2140: manual. A value of custom disables the system defaults and dependency tracking
2141: for the fetch program. In that case you have to provide FETCH_CMD,
2142: FETCH_BEFORE_ARGS, FETCH_RESUME_ARGS, FETCH_OUTPUT_ARGS, FETCH_AFTER_ARGS.
1.1 dsieger 2143:
1.16 jnemeth 2144: For example, if you want to use wget to download, you'll have to use something
2145: like:
1.1 dsieger 2146:
1.16 jnemeth 2147: FETCH_USING= wget
1.1 dsieger 2148:
1.154 rillig 2149: 10.5. How can I install/use modular X.org from pkgsrc?
1.1 dsieger 2150:
1.4 rillig 2151: If you want to use modular X.org from pkgsrc instead of your system's own X11
2152: (/usr/X11R6, /usr/openwin, ...) you will have to add the following line into
1.1 dsieger 2153: mk.conf:
2154:
1.4 rillig 2155: X11_TYPE=modular
1.1 dsieger 2156:
1.154 rillig 2157: 10.6. How to fetch files from behind a firewall
1.1 dsieger 2158:
2159: If you are sitting behind a firewall which does not allow direct connections to
2160: Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This
2161: is done using an environment variable in the form of a URL, e.g. in Amdahl, the
2162: machine "orpheus.amdahl.com" is one of the firewalls, and it uses port 80 as
2163: the proxy port number. So the proxy environment variables are:
2164:
2165: ftp_proxy=ftp://orpheus.amdahl.com:80/
2166: http_proxy=http://orpheus.amdahl.com:80/
2167:
1.154 rillig 2168: 10.7. How to fetch files from HTTPS sites
1.65 wiz 2169:
2170: Some fetch tools are not prepared to support HTTPS by default (for example, the
2171: one in NetBSD 6.0), or the one installed by the pkgsrc bootstrap (to avoid an
2172: openssl dependency that low in the dependency graph).
2173:
2174: Usually you won't notice, because distribution files are mirrored weekly to "
2175: ftp.NetBSD.org", but that might not be often enough if you are following
2176: pkgsrc-current. In that case, set FETCH_USING in your mk.conf file to "curl" or
2177: "wget", which are both compiled with HTTPS support by default. Of course, these
2178: tools need to be installed before you can use them this way.
2179:
1.154 rillig 2180: 10.8. How do I tell make fetch to do passive FTP?
1.1 dsieger 2181:
2182: This depends on which utility is used to retrieve distfiles. From bsd.pkg.mk,
2183: FETCH_CMD is assigned the first available command from the following list:
2184:
2185: * ${LOCALBASE}/bin/ftp
2186:
2187: * /usr/bin/ftp
2188:
2189: On a default NetBSD installation, this will be /usr/bin/ftp, which
2190: automatically tries passive connections first, and falls back to active
2191: connections if the server refuses to do passive. For the other tools, add the
1.4 rillig 2192: following to your mk.conf file: PASSIVE_FETCH=1.
1.1 dsieger 2193:
2194: Having that option present will prevent /usr/bin/ftp from falling back to
2195: active transfers.
2196:
1.154 rillig 2197: 10.9. How to fetch all distfiles at once
1.1 dsieger 2198:
2199: You would like to download all the distfiles in a single batch from work or
2200: university, where you can't run a make fetch. There is an archive of distfiles
2201: on ftp.NetBSD.org, but downloading the entire directory may not be appropriate.
2202:
2203: The answer here is to do a make fetch-list in /usr/pkgsrc or one of its
2204: subdirectories, carry the resulting list to your machine at work/school and use
2205: it there. If you don't have a NetBSD-compatible ftp(1) (like tnftp) at work,
2206: don't forget to set FETCH_CMD to something that fetches a URL:
2207:
2208: At home:
2209:
2210: % cd /usr/pkgsrc
2211: % make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh
2212: % scp /tmp/fetch.sh work:/tmp
2213:
2214: At work:
2215:
2216: % sh /tmp/fetch.sh
2217:
2218: then tar up /tmp/distfiles and take it home.
2219:
2220: If you have a machine running NetBSD, and you want to get all distfiles (even
2221: ones that aren't for your machine architecture), you can do so by using the
2222: above-mentioned make fetch-list approach, or fetch the distfiles directly by
2223: running:
2224:
2225: % make mirror-distfiles
2226:
2227: If you even decide to ignore NO_{SRC,BIN}_ON_{FTP,CDROM}, then you can get
2228: everything by running:
2229:
2230: % make fetch NO_SKIP=yes
2231:
1.154 rillig 2232: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
1.1 dsieger 2233:
2234: When compiling the pkgtools/pkg_install package, you get the error from make
2235: that it doesn't know how to make /usr/share/tmac/tmac.andoc? This indicates
2236: that you don't have installed the "text" set (nroff, ...) from the NetBSD base
2237: distribution on your machine. It is recommended to do that to format man pages.
2238:
2239: In the case of the pkgtools/pkg_install package, you can get away with setting
1.4 rillig 2240: NOMAN=YES either in the environment or in mk.conf.
1.1 dsieger 2241:
1.154 rillig 2242: 10.11. What does "Could not find bsd.own.mk" mean?
1.1 dsieger 2243:
2244: You didn't install the compiler set, comp.tgz, when you installed your NetBSD
2245: machine. Please get and install it, by extracting it in /:
2246:
2247: # cd /
2248: # tar --unlink -zxvpf .../comp.tgz
2249:
2250: comp.tgz is part of every NetBSD release. Get the one that corresponds to your
2251: release (determine via uname -r).
2252:
1.154 rillig 2253: 10.12. Using 'sudo' with pkgsrc
1.1 dsieger 2254:
2255: When installing packages as non-root user and using the just-in-time su(1)
2256: feature of pkgsrc, it can become annoying to type in the root password for each
2257: required package installed. To avoid this, the sudo package can be used, which
2258: does password caching over a limited time. To use it, install sudo (either as
1.4 rillig 2259: binary package or from security/sudo) and then put the following into your
2260: mk.conf, somewhere after the definition of the LOCALBASE variable:
1.1 dsieger 2261:
2262: .if exists(${LOCALBASE}/bin/sudo)
2263: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2264: .endif
2265:
1.154 rillig 2266: 10.13. How do I change the location of configuration files?
1.1 dsieger 2267:
2268: As the system administrator, you can choose where configuration files are
2269: installed. The default settings make all these files go into ${PREFIX}/etc or
2270: some of its subdirectories; this may be suboptimal depending on your
2271: expectations (e.g., a read-only, NFS-exported PREFIX with a need of per-machine
2272: configuration of the provided packages).
2273:
2274: In order to change the defaults, you can modify the PKG_SYSCONFBASE variable
1.4 rillig 2275: (in mk.conf) to point to your preferred configuration directory; some common
2276: examples include /etc or /etc/pkg.
1.1 dsieger 2277:
2278: Furthermore, you can change this value on a per-package basis by setting the
2279: PKG_SYSCONFDIR.${PKG_SYSCONFVAR} variable. PKG_SYSCONFVAR's value usually
2280: matches the name of the package you would like to modify, that is, the contents
2281: of PKGBASE.
2282:
2283: Note that after changing these settings, you must rebuild and reinstall any
2284: affected packages.
2285:
1.154 rillig 2286: 10.14. Automated security checks
1.1 dsieger 2287:
2288: Please be aware that there can often be bugs in third-party software, and some
2289: of these bugs can leave a machine vulnerable to exploitation by attackers. In
2290: an effort to lessen the exposure, the NetBSD packages team maintains a database
2291: of known-exploits to packages which have at one time been included in pkgsrc.
2292: The database can be downloaded automatically, and a security audit of all
1.14 jmcneill 2293: packages installed on a system can take place. To do this, refer to the
2294: following two tools (installed as part of the pkgtools/pkg_install package):
1.1 dsieger 2295:
1.21 snj 2296: 1. pkg_admin fetch-pkg-vulnerabilities, an easy way to download a list of the
2297: security vulnerabilities information. This list is kept up to date by the
1.26 spz 2298: pkgsrc security team, and is distributed from the NetBSD ftp server:
1.1 dsieger 2299:
1.26 spz 2300: ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities
1.1 dsieger 2301:
1.21 snj 2302: 2. pkg_admin audit, an easy way to audit the current machine, checking each
1.24 wiz 2303: known vulnerability. If a vulnerable package is installed, it will be shown
2304: by output to stdout, including a description of the type of vulnerability,
2305: and a URL containing more information.
1.1 dsieger 2306:
1.154 rillig 2307: Use of these tools is strongly recommended! See Section 5.1.5, "Checking for
1.121 sevan 2308: security vulnerabilities in installed packages" for instructions on how to
2309: automate checking and reporting.
2310:
2311: If this database is installed, pkgsrc builds will use it to perform a security
2312: check before building any package.
1.1 dsieger 2313:
1.154 rillig 2314: 10.15. Why do some packages ignore my CFLAGS?
1.1 dsieger 2315:
2316: When you add your own preferences to the CFLAGS variable in your mk.conf, these
2317: flags are passed in environment variables to the ./configure scripts and to
2318: make(1). Some package authors ignore the CFLAGS from the environment variable
2319: by overriding them in the Makefiles of their package.
2320:
2321: Currently there is no solution to this problem. If you really need the package
2322: to use your CFLAGS you should run make patch in the package directory and then
2323: inspect any Makefile and Makefile.in for whether they define CFLAGS explicitly.
2324: Usually you can remove these lines. But be aware that some "smart" programmers
2325: write so bad code that it only works for the specific combination of CFLAGS
2326: they have chosen.
2327:
1.154 rillig 2328: 10.16. A package does not build. What shall I do?
1.1 dsieger 2329:
2330: 1. Make sure that your copy of pkgsrc is consistent. A case that occurs often
2331: is that people only update pkgsrc in parts, because of performance reasons.
2332: Since pkgsrc is one large system, not a collection of many small systems,
2333: there are sometimes changes that only work when the whole pkgsrc tree is
2334: updated.
2335:
1.25 wiz 2336: 2. Make sure that you don't have any CVS conflicts. Search for "<<<<<<" or "
2337: >>>>>>" in all your pkgsrc files.
1.1 dsieger 2338:
1.25 wiz 2339: 3. Make sure that you don't have old copies of the packages extracted. Run
1.1 dsieger 2340: make clean clean-depends to verify this.
2341:
1.108 rillig 2342: 4. If you are a package developer who wants to invest some work, have a look
1.154 rillig 2343: at Chapter 21, Making your package work.
1.108 rillig 2344:
2345: 5. If the problem still exists, write a mail to the pkgsrc-users mailing list.
1.1 dsieger 2346:
1.154 rillig 2347: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.1 dsieger 2348: conflicts" mean?
2349:
2350: You have modified a file from pkgsrc, and someone else has modified that same
2351: file afterwards in the CVS repository. Both changes are in the same region of
2352: the file, so when you updated pkgsrc, the cvs command marked the conflicting
2353: changes in the file. Because of these markers, the file is no longer a valid
2354: Makefile.
2355:
2356: Have a look at that file, and if you don't need your local changes anymore, you
2357: can remove that file and run cvs -q update -dP in that directory to download
2358: the current version.
2359:
2360: Part II. The pkgsrc developer's guide
2361:
2362: This part of the book deals with creating and modifying packages. It starts
2363: with a "HOWTO"-like guide on creating a new package. The remaining chapters are
2364: more like a reference manual for pkgsrc.
2365:
2366: Table of Contents
2367:
1.154 rillig 2368: 11. Getting help
2369: 12. Creating a new pkgsrc package from scratch
1.1 dsieger 2370:
1.154 rillig 2371: 12.1. Common types of packages
1.1 dsieger 2372:
1.154 rillig 2373: 12.1.1. Perl modules
2374: 12.1.2. Python modules and programs
1.1 dsieger 2375:
1.154 rillig 2376: 12.2. Examples
1.1 dsieger 2377:
1.154 rillig 2378: 12.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 2379:
1.154 rillig 2380: 13. Package components - files, directories and contents
1.1 dsieger 2381:
1.154 rillig 2382: 13.1. Makefile
2383: 13.2. distinfo
2384: 13.3. patches/*
1.1 dsieger 2385:
1.154 rillig 2386: 13.3.1. Structure of a single patch file
2387: 13.3.2. Creating patch files
2388: 13.3.3. Sources where the patch files come from
2389: 13.3.4. Patching guidelines
2390: 13.3.5. Feedback to the author
1.1 dsieger 2391:
1.154 rillig 2392: 13.4. Other mandatory files
2393: 13.5. Optional files
1.1 dsieger 2394:
1.154 rillig 2395: 13.5.1. Files affecting the binary package
2396: 13.5.2. Files affecting the build process
2397: 13.5.3. Files affecting nothing at all
1.1 dsieger 2398:
1.154 rillig 2399: 13.6. work*
2400: 13.7. files/*
1.1 dsieger 2401:
1.154 rillig 2402: 14. Programming in Makefiles
1.1 dsieger 2403:
1.154 rillig 2404: 14.1. Caveats
2405: 14.2. Makefile variables
1.1 dsieger 2406:
1.154 rillig 2407: 14.2.1. Naming conventions
1.1 dsieger 2408:
1.154 rillig 2409: 14.3. Code snippets
1.1 dsieger 2410:
1.154 rillig 2411: 14.3.1. Adding things to a list
2412: 14.3.2. Echoing a string exactly as-is
2413: 14.3.3. Passing CFLAGS to GNU configure scripts
2414: 14.3.4. Handling possibly empty variables
1.1 dsieger 2415:
1.154 rillig 2416: 15. PLIST issues
1.1 dsieger 2417:
1.154 rillig 2418: 15.1. RCS ID
2419: 15.2. Semi-automatic PLIST generation
2420: 15.3. Tweaking output of make print-PLIST
2421: 15.4. Variable substitution in PLIST
2422: 15.5. Man page compression
2423: 15.6. Changing PLIST source with PLIST_SRC
2424: 15.7. Platform-specific and differing PLISTs
2425: 15.8. Build-specific PLISTs
2426: 15.9. Sharing directories between packages
1.1 dsieger 2427:
1.154 rillig 2428: 16. Buildlink methodology
1.1 dsieger 2429:
1.154 rillig 2430: 16.1. Converting packages to use buildlink3
2431: 16.2. Writing buildlink3.mk files
1.1 dsieger 2432:
1.154 rillig 2433: 16.2.1. Anatomy of a buildlink3.mk file
2434: 16.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.
1.27 wiz 2435: pkg in buildlink3.mk files
1.1 dsieger 2436:
1.154 rillig 2437: 16.3. Writing builtin.mk files
1.1 dsieger 2438:
1.154 rillig 2439: 16.3.1. Anatomy of a builtin.mk file
2440: 16.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 2441:
1.154 rillig 2442: 17. The pkginstall framework
1.1 dsieger 2443:
1.154 rillig 2444: 17.1. Files and directories outside the installation prefix
1.1 dsieger 2445:
1.154 rillig 2446: 17.1.1. Directory manipulation
2447: 17.1.2. File manipulation
1.1 dsieger 2448:
1.154 rillig 2449: 17.2. Configuration files
1.1 dsieger 2450:
1.154 rillig 2451: 17.2.1. How PKG_SYSCONFDIR is set
2452: 17.2.2. Telling the software where configuration files are
2453: 17.2.3. Patching installations
2454: 17.2.4. Disabling handling of configuration files
1.1 dsieger 2455:
1.154 rillig 2456: 17.3. System startup scripts
1.1 dsieger 2457:
1.154 rillig 2458: 17.3.1. Disabling handling of system startup scripts
1.1 dsieger 2459:
1.154 rillig 2460: 17.4. System users and groups
2461: 17.5. System shells
1.1 dsieger 2462:
1.154 rillig 2463: 17.5.1. Disabling shell registration
1.1 dsieger 2464:
1.154 rillig 2465: 17.6. Fonts
1.1 dsieger 2466:
1.154 rillig 2467: 17.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 2468:
1.154 rillig 2469: 18. Options handling
1.1 dsieger 2470:
1.154 rillig 2471: 18.1. Global default options
2472: 18.2. Converting packages to use bsd.options.mk
2473: 18.3. Option Names
2474: 18.4. Determining the options of dependencies
1.1 dsieger 2475:
1.154 rillig 2476: 19. The build process
1.1 dsieger 2477:
1.154 rillig 2478: 19.1. Introduction
2479: 19.2. Program location
2480: 19.3. Directories used during the build process
2481: 19.4. Running a phase
2482: 19.5. The fetch phase
1.1 dsieger 2483:
1.154 rillig 2484: 19.5.1. What to fetch and where to get it from
2485: 19.5.2. How are the files fetched?
1.1 dsieger 2486:
1.154 rillig 2487: 19.6. The checksum phase
2488: 19.7. The extract phase
2489: 19.8. The patch phase
2490: 19.9. The tools phase
2491: 19.10. The wrapper phase
2492: 19.11. The configure phase
2493: 19.12. The build phase
2494: 19.13. The test phase
2495: 19.14. The install phase
2496: 19.15. The package phase
2497: 19.16. Cleaning up
2498: 19.17. Other helpful targets
1.1 dsieger 2499:
1.154 rillig 2500: 20. Tools needed for building or running
1.1 dsieger 2501:
1.154 rillig 2502: 20.1. Tools for pkgsrc builds
2503: 20.2. Tools needed by packages
2504: 20.3. Tools provided by platforms
1.1 dsieger 2505:
1.154 rillig 2506: 21. Making your package work
1.1 dsieger 2507:
1.154 rillig 2508: 21.1. General operation
1.1 dsieger 2509:
1.154 rillig 2510: 21.1.1. How to pull in user-settable variables from mk.conf
2511: 21.1.2. User interaction
2512: 21.1.3. Handling licenses
2513: 21.1.4. Restricted packages
2514: 21.1.5. Handling dependencies
2515: 21.1.6. Handling conflicts with other packages
2516: 21.1.7. Packages that cannot or should not be built
2517: 21.1.8. Packages which should not be deleted, once installed
2518: 21.1.9. Handling packages with security problems
2519: 21.1.10. How to handle incrementing versions when fixing an existing
1.1 dsieger 2520: package
1.154 rillig 2521: 21.1.11. Substituting variable text in the package files (the SUBST
1.1 dsieger 2522: framework)
2523:
1.154 rillig 2524: 21.2. The fetch phase
1.1 dsieger 2525:
1.154 rillig 2526: 21.2.1. Packages whose distfiles aren't available for plain downloading
2527: 21.2.2. How to handle modified distfiles with the 'old' name
2528: 21.2.3. Packages hosted on github.com
2529:
2530: 21.3. The configure phase
2531:
2532: 21.3.1. Shared libraries - libtool
2533: 21.3.2. Using libtool on GNU packages that already support libtool
2534: 21.3.3. GNU Autoconf/Automake
2535:
2536: 21.4. Programming languages
2537:
2538: 21.4.1. C, C++, and Fortran
2539: 21.4.2. Java
2540: 21.4.3. Packages containing perl scripts
2541: 21.4.4. Packages containing shell scripts
2542: 21.4.5. Other programming languages
2543:
2544: 21.5. The build phase
2545:
2546: 21.5.1. Compiling C and C++ code conditionally
2547: 21.5.2. How to handle compiler bugs
2548: 21.5.3. Undefined reference to "..."
2549: 21.5.4. Running out of memory
2550:
2551: 21.6. The install phase
2552:
2553: 21.6.1. Creating needed directories
2554: 21.6.2. Where to install documentation
2555: 21.6.3. Installing highscore files
2556: 21.6.4. Adding DESTDIR support to packages
2557: 21.6.5. Packages with hardcoded paths to other interpreters
2558: 21.6.6. Packages installing perl modules
2559: 21.6.7. Packages installing info files
2560: 21.6.8. Packages installing man pages
2561: 21.6.9. Packages installing GConf data files
2562: 21.6.10. Packages installing scrollkeeper/rarian data files
2563: 21.6.11. Packages installing X11 fonts
2564: 21.6.12. Packages installing GTK2 modules
2565: 21.6.13. Packages installing SGML or XML data
2566: 21.6.14. Packages installing extensions to the MIME database
2567: 21.6.15. Packages using intltool
2568: 21.6.16. Packages installing startup scripts
2569: 21.6.17. Packages installing TeX modules
2570: 21.6.18. Packages supporting running binaries in emulation
2571: 21.6.19. Packages installing hicolor theme icons
2572: 21.6.20. Packages installing desktop files
2573:
2574: 21.7. Marking packages as having problems
2575:
2576: 22. Debugging
2577: 23. Submitting and Committing
2578:
2579: 23.1. Submitting binary packages
2580: 23.2. Submitting source packages (for non-NetBSD-developers)
2581: 23.3. General notes when adding, updating, or removing packages
2582: 23.4. Commit Messages
2583: 23.5. Committing: Adding a package to CVS
2584: 23.6. Updating a package to a newer version
2585: 23.7. Renaming a package in pkgsrc
2586: 23.8. Moving a package in pkgsrc
2587:
2588: 24. Frequently Asked Questions
2589: 25. GNOME packaging and porting
2590:
2591: 25.1. Meta packages
2592: 25.2. Packaging a GNOME application
2593: 25.3. Updating GNOME to a newer version
2594: 25.4. Patching guidelines
2595:
2596: Chapter 11. Getting help
2597:
2598: To get help when developing pkgsrc, the definitive source is this document, the
2599: pkgsrc guide. If you don't find anything here, there are alternatives:
2600:
2601: * The built-in pkgsrc help, which is available after bootstrapping pkgsrc.
2602: Run bmake help topic=? to get help for any topic, such as a variable name
2603: like BUILD_DEFS, a make target like do-build, a missing C or C++ function
2604: like strcasecmp or any other topic.
2605:
2606: The available help topics are listed in Appendix D, Help topics.
2607:
2608: * The tech-pkg mailing list, to which you can subscribe and then ask your
2609: questions.
2610:
2611: * The #pkgsrc IRC channel, which is accessible via a web browser or by using
2612: a specialized chat program such as XChat. Pick any user name and join the
2613: channel #pkgsrc.
1.1 dsieger 2614:
1.154 rillig 2615: Chapter 12. Creating a new pkgsrc package from scratch
1.1 dsieger 2616:
2617: Table of Contents
2618:
1.154 rillig 2619: 12.1. Common types of packages
1.1 dsieger 2620:
1.154 rillig 2621: 12.1.1. Perl modules
2622: 12.1.2. Python modules and programs
1.1 dsieger 2623:
1.154 rillig 2624: 12.2. Examples
1.1 dsieger 2625:
1.154 rillig 2626: 12.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 2627:
2628: When you find a package that is not yet in pkgsrc, you most likely have a URL
2629: from where you can download the source code. Starting with this URL, creating a
2630: package involves only a few steps.
2631:
2632: 1. First, install the packages pkgtools/url2pkg and pkgtools/pkglint.
2633:
2634: 2. Then, choose one of the top-level directories as the category in which you
2635: want to place your package. You can also create a directory of your own
2636: (maybe called local). In that category directory, create another directory
2637: for your package and change into it.
2638:
2639: 3. Run the program url2pkg, which will ask you for a URL. Enter the URL of the
2640: distribution file (in most cases a .tar.gz file) and watch how the basic
2641: ingredients of your package are created automatically. The distribution
2642: file is extracted automatically to fill in some details in the Makefile
2643: that would otherwise have to be done manually.
2644:
2645: 4. Examine the extracted files to determine the dependencies of your package.
2646: Ideally, this is mentioned in some README file, but things may differ. For
2647: each of these dependencies, look where it exists in pkgsrc, and if there is
2648: a file called buildlink3.mk in that directory, add a line to your package
2649: Makefile which includes that file just before the last line. If the
1.26 spz 2650: buildlink3.mk file does not exist, it must be created first. The
2651: buildlink3.mk file makes sure that the package's include files and
2652: libraries are provided.
2653:
2654: If you just need binaries from a package, add a DEPENDS line to the
2655: Makefile, which specifies the version of the dependency and where it can be
2656: found in pkgsrc. This line should be placed in the third paragraph. If the
1.1 dsieger 2657: dependency is only needed for building the package, but not when using it,
2658: use BUILD_DEPENDS instead of DEPENDS. Your package may then look like this:
2659:
2660: [...]
2661:
1.66 asau 2662: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1 dsieger 2663: DEPENDS+= screen-[0-9]*:../../misc/screen
2664: DEPENDS+= screen>=4.0:../../misc/screen
2665:
2666: [...]
2667:
2668: .include "../../category/package/buildlink3.mk"
2669: .include "../../devel/glib2/buildlink3.mk"
2670: .include "../../mk/bsd.pkg.mk"
2671:
2672: 5. Run pkglint to see what things still need to be done to make your package a
2673: "good" one. If you don't know what pkglint's warnings want to tell you, try
2674: pkglint --explain or pkglint -e, which outputs additional explanations.
2675:
2676: 6. In many cases the package is not yet ready to build. You can find
1.154 rillig 2677: instructions for the most common cases in the next section, Section 12.1,
1.1 dsieger 2678: "Common types of packages". After you have followed the instructions over
2679: there, you can hopefully continue here.
2680:
2681: 7. Run bmake clean to clean the working directory from the extracted files.
2682: Besides these files, a lot of cache files and other system information has
2683: been saved in the working directory, which may become wrong after you
2684: edited the Makefile.
2685:
2686: 8. Now, run bmake to build the package. For the various things that can go
1.154 rillig 2687: wrong in this phase, consult Chapter 21, Making your package work.
1.1 dsieger 2688:
1.25 wiz 2689: 9. When the package builds fine, the next step is to install the package. Run
1.1 dsieger 2690: bmake install and hope that everything works.
2691:
2692: 10. Up to now, the file PLIST, which contains a list of the files that are
2693: installed by the package, is nearly empty. Run bmake print-PLIST >PLIST to
2694: generate a probably correct list. Check the file using your preferred text
2695: editor to see if the list of files looks plausible.
2696:
2697: 11. Run pkglint again to see if the generated PLIST contains garbage or not.
2698:
2699: 12. When you ran bmake install, the package has been registered in the database
2700: of installed files, but with an empty list of files. To fix this, run bmake
2701: deinstall and bmake install again. Now the package is registered with the
2702: list of files from PLIST.
2703:
2704: 13. Run bmake package to create a binary package from the set of installed
2705: files.
2706:
1.154 rillig 2707: 12.1. Common types of packages
1.1 dsieger 2708:
1.154 rillig 2709: 12.1.1. Perl modules
1.1 dsieger 2710:
2711: Simple Perl modules are handled automatically by url2pkg, including
2712: dependencies.
2713:
1.154 rillig 2714: 12.1.2. Python modules and programs
1.17 imil 2715:
2716: Python modules and programs packages are easily created using a set of
2717: predefined variables.
2718:
1.63 wiz 2719: If some Python versions are not supported by the software, set the
2720: PYTHON_VERSIONS_INCOMPATIBLE variable to the Python versions that are not
2721: supported, e.g.
1.17 imil 2722:
1.93 sevan 2723: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.17 imil 2724:
1.103 wiz 2725: If the packaged software is a Python module, include one of ../../lang/python/
2726: egg.mk, ../../lang/python/distutils.mk, or ../../lang/python/extension.mk.
2727:
2728: Most Python packages use either "distutils" or easy-setup/setuptools ("eggs").
2729: if the packaged software is using setuptools, you only need to include "../../
2730: lang/python/egg.mk". Otherwise, if the software uses "distutils", include "..
2731: /../lang/python/distutils.mk". so pkgsrc will use this framework. "distutils"
2732: uses a script called setup.py, if the "distutils" driver is not called
2733: setup.py, set the PYSETUP variable to the name of the script.
2734:
2735: Either way, the package directory should be called "py-software" and PKGNAME
2736: should be set to "${PYPKGPREFIX}-${DISTNAME}", e.g.
1.17 imil 2737:
2738: DISTNAME= foopymodule-1.2.10
2739: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
2740:
1.63 wiz 2741: If it is an application, include "../../lang/python/application.mk". In order
2742: to correctly set the path to the Python interpreter, use the REPLACE_PYTHON
2743: variable and set it to the list of files (paths relative to WRKSRC) that must
2744: be corrected. For example:
1.17 imil 2745:
1.63 wiz 2746: REPLACE_PYTHON= *.py
1.17 imil 2747:
1.63 wiz 2748: Some Python modules have separate distributions for Python-2.x and Python-3.x
2749: support. In pkgsrc this is handled by the versioned_dependencies.mk file. Set
2750: PYTHON_VERSIONED_DEPENDENCIES to the list of packages that should be depended
2751: upon and include "../../lang/python/versioned_dependencies.mk", then the pkgsrc
2752: infrastructure will depend on the appropriate package version. For example:
1.17 imil 2753:
1.135 wiz 2754: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.63 wiz 2755:
2756: Look inside versioned_dependencies.mk for a list of supported packages.
1.17 imil 2757:
1.154 rillig 2758: 12.2. Examples
1.1 dsieger 2759:
1.154 rillig 2760: 12.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 2761:
1.154 rillig 2762: 12.2.1.1. The initial package
1.1 dsieger 2763:
2764: Looking at the file pkgsrc/doc/TODO, I saw that the "nvu" package has not yet
2765: been imported into pkgsrc. As the description says it has to do with the web,
2766: the obvious choice for the category is "www".
2767:
2768: $ mkdir www/nvu
2769: $ cd www/nvu
2770:
2771: The web site says that the sources are available as a tar file, so I fed that
2772: URL to the url2pkg program:
2773:
2774: $ url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
2775:
2776: My editor popped up, and I added a PKGNAME line below the DISTNAME line, as the
2777: package name should not have the word "sources" in it. I also filled in the
2778: MAINTAINER, HOMEPAGE and COMMENT fields. Then the package Makefile looked like
2779: that:
2780:
1.121 sevan 2781: # $NetBSD $
1.1 dsieger 2782: #
2783:
2784: DISTNAME= nvu-1.0-sources
2785: PKGNAME= nvu-1.0
2786: CATEGORIES= www
2787: MASTER_SITES= http://cvs.nvu.com/download/
2788: EXTRACT_SUFX= .tar.bz2
2789:
2790: MAINTAINER= rillig@NetBSD.org
2791: HOMEPAGE= http://cvs.nvu.com/
2792: COMMENT= Web Authoring System
2793:
2794: # url2pkg-marker (please do not remove this line.)
2795: .include "../../mk/bsd.pkg.mk"
2796:
1.124 wiz 2797: On the first line of output above, an artificial space has been added between
1.121 sevan 2798: NetBSD and $, this is a workaround to prevent CVS expanding to the filename of
2799: the guide.
2800:
1.1 dsieger 2801: Then, I quit the editor and watched pkgsrc downloading a large source archive:
2802:
2803: url2pkg> Running "make makesum" ...
2804: => Required installed package digest>=20010302: digest-20060826 found
2805: => Fetching nvu-1.0-sources.tar.bz2
2806: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
2807: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
2808: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
2809: url2pkg> Running "make extract" ...
2810: => Required installed package digest>=20010302: digest-20060826 found
2811: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
2812: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
2813: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
2814: ===> Installing dependencies for nvu-1.0
2815: ===> Overriding tools for nvu-1.0
2816: ===> Extracting for nvu-1.0
2817: url2pkg> Adjusting the Makefile.
2818:
2819: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
2820:
2821: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
2822:
1.154 rillig 2823: 12.2.1.2. Fixing all kinds of problems to make the package work
1.1 dsieger 2824:
2825: Now that the package has been extracted, let's see what's inside it. The
2826: package has a README.txt, but that only says something about mozilla, so it's
2827: probably useless for seeing what dependencies this package has. But since there
2828: is a GNU configure script in the package, let's hope that it will complain
2829: about everything it needs.
2830:
2831: $ bmake
2832: => Required installed package digest>=20010302: digest-20060826 found
2833: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
2834: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
2835: ===> Patching for nvu-1.0
2836: ===> Creating toolchain wrappers for nvu-1.0
2837: ===> Configuring for nvu-1.0
2838: [...]
2839: configure: error: Perl 5.004 or higher is required.
2840: [...]
2841: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
2842: [...]
2843:
2844: That worked quite well. So I opened the package Makefile in my editor, and
2845: since it already has a USE_TOOLS line, I just appended "perl" to it. Since the
2846: dependencies of the package have changed now, and since a perl wrapper is
2847: automatically installed in the "tools" phase, I need to build the package from
2848: scratch.
2849:
2850: $ bmake clean
2851: ===> Cleaning for nvu-1.0
2852: $ bmake
2853: [...]
2854: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
2855: GNU Make. You will not be able to build Mozilla without GNU Make.
2856: [...]
2857:
2858: So I added "gmake" to the USE_TOOLS line and tried again (from scratch).
2859:
2860: [...]
2861: checking for GTK - version >= 1.2.0... no
2862: *** Could not run GTK test program, checking why...
2863: [...]
2864:
2865: Now to the other dependencies. The first question is: Where is the GTK package
2866: hidden in pkgsrc?
2867:
2868: $ echo ../../*/gtk*
2869: [many packages ...]
2870: $ echo ../../*/gtk
2871: ../../x11/gtk
2872: $ echo ../../*/gtk2
2873: ../../x11/gtk2
2874: $ echo ../../*/gtk2/bui*
2875: ../../x11/gtk2/buildlink3.mk
2876:
2877: The first try was definitely too broad. The second one had exactly one result,
2878: which is very good. But there is one pitfall with GNOME packages. Before GNOME
2879: 2 had been released, there were already many GNOME 1 packages in pkgsrc. To be
2880: able to continue to use these packages, the GNOME 2 packages were imported as
2881: separate packages, and their names usually have a "2" appended. So I checked
2882: whether this was the case here, and indeed it was.
2883:
2884: Since the GTK2 package has a buildlink3.mk file, adding the dependency is very
2885: easy. I just inserted an .include line before the last line of the package
2886: Makefile, so that it now looks like this:
2887:
2888: [...]
2889: .include "../../x11/gtk2/buildlink3.mk"
2890: .include "../../mk/bsd.pkg.mk
2891:
2892: After another bmake clean && bmake, the answer was:
2893:
2894: [...]
2895: checking for gtk-config... /home/roland/pkg/bin/gtk-config
2896: checking for GTK - version >= 1.2.0... no
2897: *** Could not run GTK test program, checking why...
2898: *** The test program failed to compile or link. See the file config.log for the
2899: *** exact error that occured. This usually means GTK was incorrectly installed
2900: *** or that you have moved GTK since it was installed. In the latter case, you
2901: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
2902: configure: error: Test for GTK failed.
2903: [...]
2904:
2905: In this particular case, the assumption that "every package prefers GNOME 2"
2906: had been wrong. The first of the lines above told me that this package really
2907: wanted to have the GNOME 1 version of GTK. If the package had looked for GTK2,
2908: it would have looked for pkg-config instead of gtk-config. So I changed the x11
2909: /gtk2 to x11/gtk in the package Makefile, and tried again.
2910:
2911: [...]
1.59 jnemeth 2912: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
1.1 dsieger 2913: In file included from xpidl.c:42:
2914: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
2915: In file included from xpidl.c:42:
2916: xpidl.h:132: error: parse error before "IDL_ns"
2917: [...]
2918:
2919: The package still does not find all of its dependencies. Now the question is:
2920: Which package provides the libIDL/IDL.h header file?
2921:
2922: $ echo ../../*/*idl*
2923: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
2924: $ echo ../../*/*IDL*
2925: ../../net/libIDL
2926:
2927: Let's take the one from the second try. So I included the ../../net/libIDL/
2928: buildlink3.mk file and tried again. But the error didn't change. After digging
2929: through some of the code, I concluded that the build process of the package was
2930: broken and couldn't have ever worked, but since the Mozilla source tree is
2931: quite large, I didn't want to fix it. So I added the following to the package
2932: Makefile and tried again:
2933:
2934: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
1.139 leot 2935: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.1 dsieger 2936:
2937: The latter line is needed because the package expects the library libIDL.so,
2938: but only libIDL-2.so is available. So I told the compiler wrapper to rewrite
2939: that on the fly.
2940:
2941: The next problem was related to a recent change of the FreeType interface. I
2942: looked up in www/seamonkey which patch files were relevant for this issue and
2943: copied them to the patches directory. Then I retried, fixed the patches so that
2944: they applied cleanly and retried again. This time, everything worked.
2945:
1.154 rillig 2946: 12.2.1.3. Installing the package
1.1 dsieger 2947:
2948: $ bmake CHECK_FILES=no install
2949: [...]
2950: $ bmake print-PLIST >PLIST
2951: $ bmake deinstall
2952: $ bmake install
2953:
1.154 rillig 2954: Chapter 13. Package components - files, directories and contents
1.1 dsieger 2955:
2956: Table of Contents
2957:
1.154 rillig 2958: 13.1. Makefile
2959: 13.2. distinfo
2960: 13.3. patches/*
2961:
2962: 13.3.1. Structure of a single patch file
2963: 13.3.2. Creating patch files
2964: 13.3.3. Sources where the patch files come from
2965: 13.3.4. Patching guidelines
2966: 13.3.5. Feedback to the author
2967:
2968: 13.4. Other mandatory files
2969: 13.5. Optional files
2970:
2971: 13.5.1. Files affecting the binary package
2972: 13.5.2. Files affecting the build process
2973: 13.5.3. Files affecting nothing at all
1.1 dsieger 2974:
1.154 rillig 2975: 13.6. work*
2976: 13.7. files/*
1.1 dsieger 2977:
2978: Whenever you're preparing a package, there are a number of files involved which
2979: are described in the following sections.
2980:
1.154 rillig 2981: 13.1. Makefile
1.1 dsieger 2982:
2983: Building, installation and creation of a binary package are all controlled by
2984: the package's Makefile. The Makefile describes various things about a package,
2985: for example from where to get it, how to configure, build, and install it.
2986:
2987: A package Makefile contains several sections that describe the package.
2988:
2989: In the first section there are the following variables, which should appear
2990: exactly in the order given here. The order and grouping of the variables is
2991: mostly historical and has no further meaning.
2992:
2993: * DISTNAME is the basename of the distribution file to be downloaded from the
2994: package's website.
2995:
1.66 asau 2996: * PKGNAME is the name of the package, as used by pkgsrc. You need to provide
2997: it if DISTNAME (which is the default) is not a good name for the package in
2998: pkgsrc or DISTNAME is not provided (no distribution file is required).
2999: Usually it is the pkgsrc directory name together with the version number.
3000: It must match the regular expression ^[A-Za-z0-9][A-Za-z0-9-_.+]*$, that
3001: is, it starts with a letter or digit, and contains only letters, digits,
3002: dashes, underscores, dots and plus signs.
1.1 dsieger 3003:
3004: * CATEGORIES is a list of categories which the package fits in. You can
3005: choose any of the top-level directories of pkgsrc for it.
3006:
3007: Currently the following values are available for CATEGORIES. If more than
3008: one is used, they need to be separated by spaces:
3009:
3010: archivers cross geography meta-pkgs security
3011: audio databases graphics misc shells
3012: benchmarks devel ham multimedia sysutils
3013: biology editors inputmethod net textproc
3014: cad emulators lang news time
3015: chat finance mail parallel wm
3016: comms fonts math pkgtools www
3017: converters games mbone print x11
3018:
3019: * MASTER_SITES, DYNAMIC_MASTER_SITES, DIST_SUBDIR, EXTRACT_SUFX and DISTFILES
1.154 rillig 3020: are discussed in detail in Section 19.5, "The fetch phase".
1.1 dsieger 3021:
3022: The second section contains information about separately downloaded patches, if
3023: any.
3024:
3025: * PATCHFILES: Name(s) of additional files that contain distribution patches.
3026: There is no default. pkgsrc will look for them at PATCH_SITES. They will
3027: automatically be uncompressed before patching if the names end with .gz or
3028: .Z.
3029:
3030: * PATCH_SITES: Primary location(s) for distribution patch files (see
1.80 wiz 3031: PATCHFILES above) if not found locally.
3032:
3033: * PATCH_DIST_STRIP: an argument to patch(1) that sets the pathname strip
3034: count to help find the correct files to patch. It defaults to -p0.
1.1 dsieger 3035:
3036: The third section contains the following variables.
3037:
3038: * MAINTAINER is the email address of the person who feels responsible for
3039: this package, and who is most likely to look at problems or questions
3040: regarding this package which have been reported with send-pr(1). Other
1.14 jmcneill 3041: developers may contact the MAINTAINER before making changes to the package,
3042: but are not required to do so. When packaging a new program, set MAINTAINER
3043: to yourself. If you really can't maintain the package for future updates,
3044: set it to <pkgsrc-users@NetBSD.org>.
3045:
3046: * OWNER should be used instead of MAINTAINER when you do not want other
3047: developers to update or change the package without contacting you first. A
3048: package Makefile should contain one of MAINTAINER or OWNER, but not both.
1.1 dsieger 3049:
3050: * HOMEPAGE is a URL where users can find more information about the package.
3051:
3052: * COMMENT is a one-line description of the package (should not include the
3053: package name).
3054:
1.122 leot 3055: * LICENSE indicates the license(s) applicable for the package. See
1.154 rillig 3056: Section 21.1.3, "Handling licenses" for further details.
1.122 leot 3057:
1.1 dsieger 3058: Other variables that affect the build:
3059:
3060: * WRKSRC: The directory where the interesting distribution files of the
3061: package are found. The default is ${WRKDIR}/${DISTNAME}, which works for
3062: most packages.
3063:
3064: If a package doesn't create a subdirectory for itself (most GNU software
3065: does, for instance), but extracts itself in the current directory, you
3066: should set WRKSRC=${WRKDIR}.
3067:
3068: If a package doesn't create a subdirectory with the name of DISTNAME but
3069: some different name, set WRKSRC to point to the proper name in ${WRKDIR},
3070: for example WRKSRC=${WRKDIR}/${DISTNAME}/unix. See lang/tcl and x11/tk for
3071: other examples.
3072:
3073: The name of the working directory created by pkgsrc is taken from the
3074: WRKDIR_BASENAME variable. By default, its value is work. If you want to use
3075: the same pkgsrc tree for building different kinds of binary packages, you
3076: can change the variable according to your needs. Two other variables handle
3077: common cases of setting WRKDIR_BASENAME individually. If OBJHOSTNAME is
1.4 rillig 3078: defined in mk.conf, the first component of the host's name is attached to
3079: the directory name. If OBJMACHINE is defined, the platform name is
1.1 dsieger 3080: attached, which might look like work.i386 or work.sparc.
3081:
3082: Please pay attention to the following gotchas:
3083:
3084: * Add MANCOMPRESSED if man pages are installed in compressed form by the
3085: package. For packages using BSD-style makefiles which honor MANZ, there is
3086: MANCOMPRESSED_IF_MANZ.
3087:
3088: * Replace /usr/local with "${PREFIX}" in all files (see patches, below).
3089:
1.154 rillig 3090: * If the package installs any info files, see Section 21.6.7, "Packages
1.1 dsieger 3091: installing info files".
3092:
1.154 rillig 3093: 13.2. distinfo
1.1 dsieger 3094:
3095: The distinfo file contains the message digest, or checksum, of each distfile
3096: needed for the package. This ensures that the distfiles retrieved from the
3097: Internet have not been corrupted during transfer or altered by a malign force
1.108 rillig 3098: to introduce a security hole. To provide maximum security, all distfiles are
3099: protected using three different message digest algorithms (SHA1, RMD160,
3100: SHA512), as well as the file size.
1.1 dsieger 3101:
3102: The distinfo file also contains the checksums for all the patches found in the
1.154 rillig 3103: patches directory (see Section 13.3, "patches/*"). These checksums ensure that
1.145 leot 3104: patches are only applied intentionally and that they don't accidentally change,
3105: e.g. when merging different changes together. They also make sure that new
3106: patches are actually added to CVS and old ones are removed. Too see whether the
3107: patches and the distinfo file match, run pkglint after changing the patches.
1.1 dsieger 3108:
1.108 rillig 3109: To regenerate the distinfo file, use the make distinfo command.
1.1 dsieger 3110:
3111: Some packages have different sets of distfiles depending on the platform, for
1.24 wiz 3112: example lang/openjdk7. These are kept in the same distinfo file and care should
3113: be taken when upgrading such a package to ensure distfile information is not
3114: lost.
1.1 dsieger 3115:
1.154 rillig 3116: 13.3. patches/*
1.1 dsieger 3117:
1.108 rillig 3118: Some packages don't work out-of-the box on the various platforms that are
3119: supported by pkgsrc. These packages need to be patched to make them work. The
3120: patch files can be found in the patches/ directory.
1.1 dsieger 3121:
3122: In the patch phase, these patches are applied to the files in WRKSRC directory
1.25 wiz 3123: after extracting them, in alphabetic order.
1.1 dsieger 3124:
1.154 rillig 3125: 13.3.1. Structure of a single patch file
1.1 dsieger 3126:
3127: The patch-* files should be in diff -bu format, and apply without a fuzz to
3128: avoid problems. (To force patches to apply with fuzz you can set
3129: PATCH_FUZZ_FACTOR=-F2). Furthermore, each patch should contain only changes for
3130: a single file, and no file should be patched by more than one patch file. This
3131: helps to keep future modifications simple.
3132:
3133: Each patch file is structured as follows: In the first line, there is the RCS
3134: Id of the patch itself. The second line should be empty for aesthetic reasons.
3135: After that, there should be a comment for each change that the patch does.
3136: There are a number of standard cases:
3137:
3138: * Patches for commonly known vulnerabilities should mention the vulnerability
3139: ID (CAN, CVE).
3140:
3141: * Patches that change source code should mention the platform and other
3142: environment (for example, the compiler) that the patch is needed for.
3143:
1.108 rillig 3144: The patch should be commented so that any developer who knows the code of the
3145: application can make some use of the patch. Special care should be taken for
3146: the upstream developers, since we generally want that they accept our patches,
3147: so we have less work in the future.
1.1 dsieger 3148:
1.154 rillig 3149: 13.3.2. Creating patch files
1.1 dsieger 3150:
3151: One important thing to mention is to pay attention that no RCS IDs get stored
3152: in the patch files, as these will cause problems when later checked into the
3153: NetBSD CVS tree. Use the pkgdiff command from the pkgtools/pkgdiff package to
3154: avoid these problems.
3155:
3156: For even more automation, we recommend using mkpatches from the same package to
3157: make a whole set of patches. You just have to backup files before you edit them
1.25 wiz 3158: to filename.orig, e.g. with cp -p filename filename.orig or, easier, by using
1.1 dsieger 3159: pkgvi again from the same package. If you upgrade a package this way, you can
1.25 wiz 3160: easily compare the new set of patches with the previously existing one with
3161: patchdiff. The files in patches are replaced by new files, so carefully check
3162: if you want to take all the changes.
1.1 dsieger 3163:
3164: When you have finished a package, remember to generate the checksums for the
1.154 rillig 3165: patch files by using the make makepatchsum command, see Section 13.2,
1.1 dsieger 3166: "distinfo".
3167:
3168: When adding a patch that corrects a problem in the distfile (rather than e.g.
3169: enforcing pkgsrc's view of where man pages should go), send the patch as a bug
3170: report to the maintainer. This benefits non-pkgsrc users of the package, and
3171: usually makes it possible to remove the patch in future version.
3172:
1.25 wiz 3173: The file names of the patch files are usually of the form patch-
3174: path_to_file__with__underscores.c. Many packages still use the previous
3175: convention patch-[a-z][a-z], but new patches should be of the form containing
3176: the filename. mkpatches included in pkgtools/pkgdiff takes care of the name
3177: automatically.
1.2 rillig 3178:
1.154 rillig 3179: 13.3.3. Sources where the patch files come from
1.1 dsieger 3180:
3181: If you want to share patches between multiple packages in pkgsrc, e.g. because
3182: they use the same distfiles, set PATCHDIR to the path where the patch files can
3183: be found, e.g.:
3184:
3185: PATCHDIR= ${.CURDIR}/../xemacs/patches
3186:
3187: Patch files that are distributed by the author or other maintainers can be
3188: listed in PATCHFILES.
3189:
3190: If it is desired to store any patches that should not be committed into pkgsrc,
3191: they can be kept outside the pkgsrc tree in the $LOCALPATCHES directory. The
3192: directory tree there is expected to have the same "category/package" structure
3193: as pkgsrc, and patches are expected to be stored inside these dirs (also known
3194: as $LOCALPATCHES/$PKGPATH). For example, if you want to keep a private patch
3195: for pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All
3196: files in the named directory are expected to be patch files, and they are
3197: applied after pkgsrc patches are applied.
3198:
1.154 rillig 3199: 13.3.4. Patching guidelines
1.1 dsieger 3200:
3201: When fixing a portability issue in the code do not use preprocessor magic to
3202: check for the current operating system nor platform. Doing so hurts portability
3203: to other platforms because the OS-specific details are not abstracted
3204: appropriately.
3205:
3206: The general rule to follow is: instead of checking for the operating system the
3207: application is being built on, check for the specific features you need. For
3208: example, instead of assuming that kqueue is available under NetBSD and using
3209: the __NetBSD__ macro to conditionalize kqueue support, add a check that detects
3210: kqueue itself ? yes, this generally involves patching the configure script.
3211: There is absolutely nothing that prevents some OSes from adopting interfaces
3212: from other OSes (e.g. Linux implementing kqueue), something that the above
3213: checks cannot take into account.
3214:
3215: Of course, checking for features generally involves more work on the
3216: developer's side, but the resulting changes are cleaner and there are chances
3217: they will work on many other platforms. Not to mention that there are higher
3218: chances of being later integrated into the mainstream sources. Remember: It
3219: doesn't work unless it is right!
3220:
3221: Some typical examples:
3222:
1.154 rillig 3223: Table 13.1. Patching examples
1.1 dsieger 3224:
3225: +-------------------------------------------------------------------------------------------+
3226: | Where | Incorrect | Correct |
3227: |---------+--------------------------+------------------------------------------------------|
3228: | |case ${target_os} in | |
3229: |configure|netbsd*) have_kvm=yes ;; |AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)|
3230: |script |*) have_kvm=no ;; | |
3231: | |esac | |
3232: |---------+--------------------------+------------------------------------------------------|
1.2 rillig 3233: |C source |#if defined(__NetBSD__) |#if defined(HAVE_SYS_EVENT_H) |
3234: |file |# include <sys/event.h> |# include <sys/event.h> |
3235: | |#endif |#endif |
1.1 dsieger 3236: |---------+--------------------------+------------------------------------------------------|
3237: | |int |int |
3238: | |monitor_file(...) |monitor_file(...) |
3239: | |{ |{ |
3240: | |#if defined(__NetBSD__) |#if defined(HAVE_KQUEUE) |
3241: |C source | int fd = kqueue();| int fd = kqueue(); |
3242: |file | ... | ... |
3243: | |#else |#else |
3244: | | ... | ... |
3245: | |#endif |#endif |
3246: | |} |} |
3247: +-------------------------------------------------------------------------------------------+
3248:
3249:
1.154 rillig 3250: 13.3.5. Feedback to the author
1.1 dsieger 3251:
3252: Always, always, always feed back any portability fixes or improvements you do
3253: to a package to the mainstream developers. This is the only way to get their
3254: attention on portability issues and to ensure that future versions can be built
3255: out-of-the box on NetBSD. Furthermore, any user that gets newer distfiles will
3256: get the fixes straight from the packaged code.
3257:
3258: This generally involves cleaning up the patches (because sometimes the patches
1.41 wiz 3259: that are added to pkgsrc are quick hacks), filing bug reports in the
1.1 dsieger 3260: appropriate trackers for the projects and working with the mainstream authors
3261: to accept your changes. It is extremely important that you do it so that the
3262: packages in pkgsrc are kept simple and thus further changes can be done without
3263: much hassle.
3264:
1.25 wiz 3265: When you have done this, please add a URL to the upstream bug report to the
3266: patch comment.
3267:
1.1 dsieger 3268: Support the idea of free software!
3269:
1.154 rillig 3270: 13.4. Other mandatory files
1.1 dsieger 3271:
3272: DESCR
3273:
3274: A multi-line description of the piece of software. This should include any
3275: credits where they are due. Please bear in mind that others do not share
3276: your sense of humour (or spelling idiosyncrasies), and that others will
3277: read everything that you write here.
3278:
3279: PLIST
3280:
3281: This file governs the files that are installed on your system: all the
3282: binaries, manual pages, etc. There are other directives which may be
3283: entered in this file, to control the creation and deletion of directories,
1.154 rillig 3284: and the location of inserted files. See Chapter 15, PLIST issues for more
1.1 dsieger 3285: information.
3286:
1.154 rillig 3287: 13.5. Optional files
1.1 dsieger 3288:
1.154 rillig 3289: 13.5.1. Files affecting the binary package
1.1 dsieger 3290:
3291: INSTALL
3292:
3293: This shell script is invoked twice by pkg_add(1). First time after package
3294: extraction and before files are moved in place, the second time after the
3295: files to install are moved in place. This can be used to do any custom
3296: procedures not possible with @exec commands in PLIST. See pkg_add(1) and
1.154 rillig 3297: pkg_create(1) for more information. See also Section 17.1, "Files and
1.29 wiz 3298: directories outside the installation prefix". Please note that you can
3299: modify variables in it easily by using FILES_SUBST in the package's
3300: Makefile:
3301:
3302: FILES_SUBST+= SOMEVAR="somevalue"
3303:
3304: replaces "@SOMEVAR@" with "somevalue" in the INSTALL. By default,
3305: substitution is performed for PREFIX, LOCALBASE, X11BASE, VARBASE, and a
3306: few others, type make help topic=FILES_SUBST for a complete list.
1.1 dsieger 3307:
3308: DEINSTALL
3309:
3310: This script is executed before and after any files are removed. It is this
3311: script's responsibility to clean up any additional messy details around the
3312: package's installation, since all pkg_delete knows is how to delete the
3313: files created in the original distribution. See pkg_delete(1) and
1.29 wiz 3314: pkg_create(1) for more information. The same methods to replace variables
3315: can be used as for the INSTALL file.
1.1 dsieger 3316:
3317: MESSAGE
3318:
3319: This file is displayed after installation of the package. Useful for things
3320: like legal notices on almost-free software and hints for updating config
3321: files after installing modules for apache, PHP etc. Please note that you
3322: can modify variables in it easily by using MESSAGE_SUBST in the package's
3323: Makefile:
3324:
3325: MESSAGE_SUBST+= SOMEVAR="somevalue"
3326:
3327: replaces "${SOMEVAR}" with "somevalue" in MESSAGE. By default, substitution
1.99 sevan 3328: is performed for PKGNAME, PKGBASE, PREFIX, LOCALBASE, X11BASE,
1.16 jnemeth 3329: PKG_SYSCONFDIR, ROOT_GROUP, and ROOT_USER.
1.1 dsieger 3330:
3331: You can display a different or additional files by setting the MESSAGE_SRC
3332: variable. Its default is MESSAGE, if the file exists.
3333:
3334: ALTERNATIVES
3335:
1.66 asau 3336: This file is used by the alternatives framework. It creates, configures,
3337: and destroys generic wrappers used to run programs with similar interfaces.
3338: See pkg_alternatives(8) from pkgtools/pkg_alternatives for more
3339: information.
3340:
3341: Each line of the file contains two filenames, first the wrapper and then
3342: the alternative provided by the package. Both paths are relative to PREFIX.
1.1 dsieger 3343:
1.154 rillig 3344: 13.5.2. Files affecting the build process
1.1 dsieger 3345:
3346: Makefile.common
3347:
3348: This file contains arbitrary things that could also go into a Makefile, but
3349: its purpose is to be used by more than one package. This file should only
3350: be used when the packages that will use the file are known in advance. For
3351: other purposes it is often better to write a *.mk file and give it a good
3352: name that describes what it does.
3353:
3354: buildlink3.mk
3355:
3356: This file contains the dependency information for the buildlink3 framework
1.154 rillig 3357: (see Chapter 16, Buildlink methodology).
1.1 dsieger 3358:
3359: hacks.mk
3360:
3361: This file contains workarounds for compiler bugs and similar things. It is
3362: included automatically by the pkgsrc infrastructure, so you don't need an
3363: extra .include line for it.
3364:
3365: options.mk
3366:
3367: This file contains the code for the package-specific options (see
1.154 rillig 3368: Chapter 18, Options handling) that can be selected by the user. If a
1.1 dsieger 3369: package has only one or two options, it is equally acceptable to put the
3370: code directly into the Makefile.
3371:
1.154 rillig 3372: 13.5.3. Files affecting nothing at all
1.1 dsieger 3373:
3374: README*
3375:
3376: These files do not take place in the creation of a package and thus are
3377: purely informative to the package developer.
3378:
3379: TODO
3380:
3381: This file contains things that need to be done to make the package even
3382: better.
3383:
1.154 rillig 3384: 13.6. work*
1.1 dsieger 3385:
3386: When you type make, the distribution files are unpacked into the directory
3387: denoted by WRKDIR. It can be removed by running make clean. Besides the
3388: sources, this directory is also used to keep various timestamp files. The
3389: directory gets removed completely on clean. The default is ${.CURDIR}/work or $
3390: {.CURDIR}/work.${MACHINE_ARCH} if OBJMACHINE is set.
3391:
1.154 rillig 3392: 13.7. files/*
1.1 dsieger 3393:
3394: If you have any files that you wish to be placed in the package prior to
3395: configuration or building, you could place these files here and use a ${CP}
3396: command in the "pre-configure" target to achieve this. Alternatively, you could
3397: simply diff the file against /dev/null and use the patch mechanism to manage
3398: the creation of this file.
3399:
3400: If you want to share files in this way with other packages, set the FILESDIR
3401: variable to point to the other package's files directory, e.g.:
3402:
3403: FILESDIR=${.CURDIR}/../xemacs/files
3404:
1.154 rillig 3405: Chapter 14. Programming in Makefiles
1.1 dsieger 3406:
3407: Table of Contents
3408:
1.154 rillig 3409: 14.1. Caveats
3410: 14.2. Makefile variables
1.1 dsieger 3411:
1.154 rillig 3412: 14.2.1. Naming conventions
1.1 dsieger 3413:
1.154 rillig 3414: 14.3. Code snippets
1.1 dsieger 3415:
1.154 rillig 3416: 14.3.1. Adding things to a list
3417: 14.3.2. Echoing a string exactly as-is
3418: 14.3.3. Passing CFLAGS to GNU configure scripts
3419: 14.3.4. Handling possibly empty variables
1.1 dsieger 3420:
3421: Pkgsrc consists of many Makefile fragments, each of which forms a well-defined
3422: part of the pkgsrc system. Using the make(1) system as a programming language
3423: for a big system like pkgsrc requires some discipline to keep the code correct
3424: and understandable.
3425:
1.154 rillig 3426: The basic ingredients for Makefile programming are variables and shell
3427: commands. Among these shell commands may even be more complex ones like awk(1)
3428: programs. To make sure that every shell command runs as intended it is
3429: necessary to quote all variables correctly when they are used.
1.1 dsieger 3430:
1.154 rillig 3431: This chapter describes some patterns that appear quite often in Makefiles,
1.1 dsieger 3432: including the pitfalls that come along with them.
3433:
1.154 rillig 3434: 14.1. Caveats
1.1 dsieger 3435:
3436: * When you are creating a file as a target of a rule, always write the data
3437: to a temporary file first and finally rename that file. Otherwise there
3438: might occur an error in the middle of generating the file, and when the
3439: user runs make(1) for the second time, the file exists and will not be
3440: regenerated properly. Example:
3441:
3442: wrong:
3443: @echo "line 1" > ${.TARGET}
3444: @echo "line 2" >> ${.TARGET}
3445: @false
3446:
3447: correct:
3448: @echo "line 1" > ${.TARGET}.tmp
3449: @echo "line 2" >> ${.TARGET}.tmp
3450: @false
3451: @mv ${.TARGET}.tmp ${.TARGET}
3452:
3453: When you run make wrong twice, the file wrong will exist, although there
3454: was an error message in the first run. On the other hand, running make
3455: correct gives an error message twice, as expected.
3456:
3457: You might remember that make(1) sometimes removes ${.TARGET} in case of
3458: error, but this only happens when it is interrupted, for example by
1.154 rillig 3459: pressing Ctrl+C. This does not happen when one of the commands fails (like
1.1 dsieger 3460: false(1) above).
3461:
1.154 rillig 3462: 14.2. Makefile variables
1.1 dsieger 3463:
3464: Makefile variables contain strings that can be processed using the five
1.154 rillig 3465: operators =, +=, ?=, := and !=, which are described in the make(1) man page.
1.1 dsieger 3466:
1.154 rillig 3467: When a variable's value is parsed from a Makefile, the hash character # and the
3468: backslash character \ are handled specially. If a backslash is the last
3469: character in a line, that backslash is removed from the line and the line
3470: continues with the next line of the file.
3471:
3472: The # character starts a comment that reaches until the end of the line. To get
3473: an actual # character, such as in a URL, write \# instead.
1.1 dsieger 3474:
1.108 rillig 3475: The evaluation of variables either happens immediately or lazy. It happens
1.154 rillig 3476: immediately when the variable occurs on the right-hand side of the := or the !=
3477: operator, in a .if condition or a .for loop. In the other cases, it is
3478: evaluated lazily.
1.1 dsieger 3479:
3480: Some of the modifiers split the string into words and then operate on the
3481: words, others operate on the string as a whole. When a string is split into
1.154 rillig 3482: words, double quotes and single quotes are interpreted as delimiters, just like
3483: in sh(1).
1.1 dsieger 3484:
1.154 rillig 3485: 14.2.1. Naming conventions
1.1 dsieger 3486:
3487: * All variable names starting with an underscore are reserved for use by the
1.154 rillig 3488: pkgsrc infrastructure. They shall not be used by packages.
1.1 dsieger 3489:
3490: * In .for loops you should use lowercase variable names for the iteration
3491: variables.
3492:
1.154 rillig 3493: * All list variables should have a plural name, such as PKG_OPTIONS or
1.1 dsieger 3494: DISTFILES.
3495:
1.154 rillig 3496: 14.3. Code snippets
1.1 dsieger 3497:
1.154 rillig 3498: 14.3.1. Adding things to a list
1.108 rillig 3499:
3500: When adding a string that possibly contains whitespace or quotes to a list
3501: (example 1), it must be quoted using the :Q modifier.
1.1 dsieger 3502:
1.108 rillig 3503: When adding another list to a list (example 2), it must not be quoted, since
3504: its elements are already quoted.
1.1 dsieger 3505:
1.108 rillig 3506: STRING= foo * bar `date`
3507: LIST= # empty
3508: ANOTHER_LIST= a=b c=d
1.1 dsieger 3509:
1.108 rillig 3510: LIST+= ${STRING:Q} # 1
3511: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 3512:
1.154 rillig 3513: 14.3.2. Echoing a string exactly as-is
1.1 dsieger 3514:
1.108 rillig 3515: Echoing a string containing special characters needs special work.
1.1 dsieger 3516:
3517: STRING= foo bar < > * `date` $$HOME ' "
1.108 rillig 3518: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 3519:
3520: all:
3521: echo ${STRING} # 1
1.108 rillig 3522: echo ${STRING:Q} # 2
3523: printf '%s\n' ${STRING:Q}'' # 3
3524: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 3525:
3526: Example 1 leads to a syntax error in the shell, as the characters are just
3527: copied.
3528:
1.108 rillig 3529: Example 2 quotes the string so that the shell interprets it correctly. But the
3530: echo command may additionally interpret strings with a leading dash or those
3531: containing backslashes.
3532:
3533: Example 3 can handle arbitrary strings, since printf(1) only interprets the
1.139 leot 3534: format string, but not the next argument. The trailing single quotes handle the
3535: case when the string is empty. In that case, the :Q modifier would result in an
3536: empty string too, which would then be skipped by the shell. For printf(1) this
3537: doesn't make a difference, but other programs may care.
1.108 rillig 3538:
3539: In example 4, the EXAMPLE_ENV does not need to be quoted because the quoting
3540: has already been done when adding elements to the list.
3541:
1.154 rillig 3542: 14.3.3. Passing CFLAGS to GNU configure scripts
1.108 rillig 3543:
3544: When passing CFLAGS or similar variables to a GNU-style configure script
3545: (especially those that call other configure scripts), it must not have leading
3546: or trailing whitespace, since otherwise the configure script gets confused. To
3547: trim leading and trailing whitespace, use the :M modifier, as in the following
3548: example:
3549:
3550: CPPFLAGS= # empty
3551: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
3552: CPPFLAGS+= ${MY_CPPFLAGS}
3553:
3554: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
3555:
3556: all:
3557: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
3558: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
3559:
3560: In this example, CPPFLAGS has both leading and trailing whitespace because the
3561: += operator always adds a space.
3562:
1.154 rillig 3563: 14.3.4. Handling possibly empty variables
1.108 rillig 3564:
3565: When a possibly empty variable is used in a shell program, it may lead to a
3566: syntax error.
3567:
3568: EGFILES= # empty
3569:
3570: install-examples: # produces a syntax error in the shell
3571: for egfile in ${EGFILES}; do \
3572: echo "Installing $$egfile"; \
3573: done
3574:
3575: The shell only sees the text for egfile in ; do, since ${EGFILES} is replaced
3576: with an empty string by make(1). To fix this syntax error, use one of the
3577: snippets below.
3578:
3579: EMPTY= # empty
3580:
3581: install-examples:
3582: for egfile in ${EGFILES} ""; do \
3583: [ -n "$$egfile" ] || continue; \
3584: echo "Installing $$egfile"; \
3585: done
3586:
3587: In this case, an empty string is appended to the iteration list (to prevent the
3588: syntax error) and filtered out later.
1.1 dsieger 3589:
1.108 rillig 3590: EGFILES= # empty
1.1 dsieger 3591:
1.108 rillig 3592: install-examples:
3593: .for egfile in ${EGFILES}
3594: echo "Installing ${egfile}"
3595: .endfor
3596:
1.154 rillig 3597: If one of the filenames contains special characters, it should be enclosed in
3598: single or double quotes.
1.108 rillig 3599:
3600: To have a shell command test whether a make variable is empty, use the
3601: following code: ${TEST} -z ${POSSIBLY_EMPTY:Q}"".
1.1 dsieger 3602:
1.154 rillig 3603: Chapter 15. PLIST issues
1.1 dsieger 3604:
3605: Table of Contents
3606:
1.154 rillig 3607: 15.1. RCS ID
3608: 15.2. Semi-automatic PLIST generation
3609: 15.3. Tweaking output of make print-PLIST
3610: 15.4. Variable substitution in PLIST
3611: 15.5. Man page compression
3612: 15.6. Changing PLIST source with PLIST_SRC
3613: 15.7. Platform-specific and differing PLISTs
3614: 15.8. Build-specific PLISTs
3615: 15.9. Sharing directories between packages
1.1 dsieger 3616:
3617: The PLIST file contains a package's "packing list", i.e. a list of files that
3618: belong to the package (relative to the ${PREFIX} directory it's been installed
3619: in) plus some additional statements - see the pkg_create(1) man page for a full
3620: list. This chapter addresses some issues that need attention when dealing with
3621: the PLIST file (or files, see below!).
3622:
1.154 rillig 3623: 15.1. RCS ID
1.1 dsieger 3624:
3625: Be sure to add a RCS ID line as the first thing in any PLIST file you write:
3626:
1.121 sevan 3627: @comment $NetBSD $
3628:
1.123 wiz 3629: An artificial space has been added between NetBSD and $, this is a workaround
1.121 sevan 3630: here to prevent CVS expanding to the filename of the guide. When adding the RCS
1.125 leot 3631: ID the space should be omitted.
1.1 dsieger 3632:
1.154 rillig 3633: 15.2. Semi-automatic PLIST generation
1.1 dsieger 3634:
3635: You can use the make print-PLIST command to output a PLIST that matches any new
1.154 rillig 3636: files since the package was extracted. See Section 19.17, "Other helpful
1.1 dsieger 3637: targets" for more information on this target.
3638:
1.154 rillig 3639: 15.3. Tweaking output of make print-PLIST
1.1 dsieger 3640:
3641: The PRINT_PLIST_AWK variable takes a set of AWK patterns and actions that are
3642: used to filter the output of print-PLIST. You can append any chunk of AWK
3643: scripting you like to it, but be careful with quoting.
3644:
3645: For example, to get all files inside the libdata/foo directory removed from the
3646: resulting PLIST:
3647:
3648: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
3649:
1.154 rillig 3650: 15.4. Variable substitution in PLIST
1.1 dsieger 3651:
3652: A number of variables are substituted automatically in PLISTs when a package is
3653: installed on a system. This includes the following variables:
3654:
3655: ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}
3656:
3657: Some packages like emacs and perl embed information about which
3658: architecture they were built on into the pathnames where they install their
3659: files. To handle this case, PLIST will be preprocessed before actually
3660: used, and the symbol "${MACHINE_ARCH}" will be replaced by what uname -p
3661: gives. The same is done if the string ${MACHINE_GNU_ARCH} is embedded in
3662: PLIST somewhere - use this on packages that have GNU autoconf-created
3663: configure scripts.
3664:
3665: Legacy note
3666:
3667: There used to be a symbol "$ARCH" that was replaced by the output of uname
3668: -m, but that's no longer supported and has been removed.
3669:
3670: ${OPSYS}, ${LOWER_OPSYS}, ${OS_VERSION}
3671:
3672: Some packages want to embed the OS name and version into some paths. To do
3673: this, use these variables in the PLIST:
3674:
1.42 asau 3675: + ${OPSYS} - output of "uname -s"
1.1 dsieger 3676:
1.42 asau 3677: + ${LOWER_OPSYS} - lowercase common name (eg. "solaris")
1.1 dsieger 3678:
1.42 asau 3679: + ${OS_VERSION} - "uname -r"
1.1 dsieger 3680:
1.88 tnn 3681: For a list of values which are replaced by default, the output of make help
3682: topic=PLIST_SUBST as well as searching the pkgsrc/mk directory with grep for
3683: PLIST_SUBST should help.
1.1 dsieger 3684:
3685: If you want to change other variables not listed above, you can add variables
3686: and their expansions to this variable in the following way, similar to
1.154 rillig 3687: MESSAGE_SUBST (see Section 13.5, "Optional files"):
1.1 dsieger 3688:
3689: PLIST_SUBST+= SOMEVAR="somevalue"
3690:
3691: This replaces all occurrences of "${SOMEVAR}" in the PLIST with "somevalue".
3692:
1.19 snj 3693: The PLIST_VARS variable can be used to simplify the common case of
3694: conditionally including some PLIST entries. It can be done by adding
3695: PLIST_VARS+=foo and setting the corresponding PLIST.foo variable to yes if the
3696: entry should be included. This will substitute "${PLIST.foo}" in the PLIST with
3697: either """" or ""@comment "". For example, in Makefile:
1.18 mishka 3698:
3699: PLIST_VARS+= foo
3700: .if condition
3701: PLIST.foo= yes
3702: .else
3703:
3704: And then in PLIST:
3705:
1.121 sevan 3706: @comment $NetBSD $
1.18 mishka 3707: bin/bar
3708: man/man1/bar.1
3709: ${PLIST.foo}bin/foo
3710: ${PLIST.foo}man/man1/foo.1
3711: ${PLIST.foo}share/bar/foo.data
3712:
1.123 wiz 3713: An artificial space has been added between NetBSD and $, this is a workaround
1.121 sevan 3714: here to prevent CVS expanding to the filename of the guide. When adding the RCS
3715: ID the space should be ommited.
3716:
1.154 rillig 3717: 15.5. Man page compression
1.1 dsieger 3718:
3719: Man pages should be installed in compressed form if MANZ is set (in
3720: bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the
3721: suffix ".gz" is appended/removed automatically for man pages according to MANZ
3722: and MANCOMPRESSED being set or not, see above for details. This modification of
3723: the PLIST file is done on a copy of it, not PLIST itself.
3724:
1.154 rillig 3725: 15.6. Changing PLIST source with PLIST_SRC
1.1 dsieger 3726:
3727: To use one or more files as source for the PLIST used in generating the binary
3728: package, set the variable PLIST_SRC to the names of that file(s). The files are
3729: later concatenated using cat(1), and the order of things is important. The
3730: default for PLIST_SRC is ${PKGDIR}/PLIST.
3731:
1.154 rillig 3732: 15.7. Platform-specific and differing PLISTs
1.1 dsieger 3733:
3734: Some packages decide to install a different set of files based on the operating
3735: system being used. These differences can be automatically handled by using the
3736: following files:
3737:
3738: * PLIST.common
3739:
3740: * PLIST.${OPSYS}
3741:
3742: * PLIST.${MACHINE_ARCH}
3743:
3744: * PLIST.${OPSYS}-${MACHINE_ARCH}
3745:
3746: * PLIST.common_end
3747:
1.154 rillig 3748: 15.8. Build-specific PLISTs
1.86 wiz 3749:
3750: Some packages decide to generate hard-to-guess file names during installation
3751: that are hard to wire down.
3752:
3753: In such cases, you can set the GENERATE_PLIST variable to shell code terminated
3754: (with a semicolon) that will output PLIST entries which will be appended to the
3755: PLIST
3756:
3757: You can find one example in editors/xemacs:
3758:
1.111 sevan 3759: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
1.86 wiz 3760:
3761: which will append something like bin/xemacs-21.4.23-54e8ea71.dmp to the PLIST.
3762:
1.154 rillig 3763: 15.9. Sharing directories between packages
1.1 dsieger 3764:
3765: A "shared directory" is a directory where multiple (and unrelated) packages
1.23 jakllsch 3766: install files. These directories were problematic because you had to add
1.1 dsieger 3767: special tricks in the PLIST to conditionally remove them, or have some
3768: centralized package handle them.
3769:
1.23 jakllsch 3770: In pkgsrc, it is now easy: Each package should create directories and install
3771: files as needed; pkg_delete will remove any directories left empty after
3772: uninstalling a package.
1.1 dsieger 3773:
1.23 jakllsch 3774: If a package needs an empty directory to work, create the directory during
3775: installation as usual, and also add an entry to the PLIST:
1.1 dsieger 3776:
1.23 jakllsch 3777: @pkgdir path/to/empty/directory
1.1 dsieger 3778:
1.86 wiz 3779: or take a look at MAKE_DIRS and OWN_DIRS.
3780:
1.154 rillig 3781: Chapter 16. Buildlink methodology
1.1 dsieger 3782:
3783: Table of Contents
3784:
1.154 rillig 3785: 16.1. Converting packages to use buildlink3
3786: 16.2. Writing buildlink3.mk files
1.1 dsieger 3787:
1.154 rillig 3788: 16.2.1. Anatomy of a buildlink3.mk file
3789: 16.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
1.27 wiz 3790: buildlink3.mk files
1.1 dsieger 3791:
1.154 rillig 3792: 16.3. Writing builtin.mk files
1.1 dsieger 3793:
1.154 rillig 3794: 16.3.1. Anatomy of a builtin.mk file
3795: 16.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 3796:
3797: Buildlink is a framework in pkgsrc that controls what headers and libraries are
3798: seen by a package's configure and build processes. This is implemented in a two
3799: step process:
3800:
3801: 1. Symlink headers and libraries for dependencies into BUILDLINK_DIR, which by
3802: default is a subdirectory of WRKDIR.
3803:
3804: 2. Create wrapper scripts that are used in place of the normal compiler tools
3805: that translate -I${LOCALBASE}/include and -L${LOCALBASE}/lib into
3806: references to BUILDLINK_DIR. The wrapper scripts also make native compiler
3807: on some operating systems look like GCC, so that packages that expect GCC
3808: won't require modifications to build with those native compilers.
3809:
3810: This normalizes the environment in which a package is built so that the package
3811: may be built consistently despite what other software may be installed. Please
3812: note that the normal system header and library paths, e.g. /usr/include, /usr/
3813: lib, etc., are always searched -- buildlink3 is designed to insulate the
3814: package build from non-system-supplied software.
3815:
1.154 rillig 3816: 16.1. Converting packages to use buildlink3
1.1 dsieger 3817:
1.25 wiz 3818: The process of converting packages to use the buildlink3 framework ("bl3ifying"
3819: ) is fairly straightforward. The things to keep in mind are:
1.1 dsieger 3820:
3821: 1. Ensure that the build always calls the wrapper scripts instead of the
3822: actual toolchain. Some packages are tricky, and the only way to know for
3823: sure is the check ${WRKDIR}/.work.log to see if the wrappers are being
3824: invoked.
3825:
3826: 2. Don't override PREFIX from within the package Makefile, e.g. Java VMs,
3827: standalone shells, etc., because the code to symlink files into $
3828: {BUILDLINK_DIR} looks for files relative to "pkg_info -qp pkgname".
3829:
3830: 3. Remember that only the buildlink3.mk files that you list in a package's
3831: Makefile are added as dependencies for that package.
3832:
3833: If a dependency on a particular package is required for its libraries and
3834: headers, then we replace:
3835:
3836: DEPENDS+= foo>=1.1.0:../../category/foo
3837:
3838: with
3839:
3840: .include "../../category/foo/buildlink3.mk"
3841:
3842: The buildlink3.mk files usually define the required dependencies. If you need a
3843: newer version of the dependency when using buildlink3.mk files, then you can
3844: define it in your Makefile; for example:
3845:
3846: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
3847: .include "../../category/foo/buildlink3.mk"
3848:
3849: There are several buildlink3.mk files in pkgsrc/mk that handle special package
3850: issues:
3851:
3852: * bdb.buildlink3.mk chooses either the native or a pkgsrc Berkeley DB
3853: implementation based on the values of BDB_ACCEPTED and BDB_DEFAULT.
3854:
3855: * curses.buildlink3.mk: If the system comes with neither Curses nor NCurses,
3856: this will take care to install the devel/ncurses package.
3857:
3858: * krb5.buildlink3.mk uses the value of KRB5_ACCEPTED to choose between adding
3859: a dependency on Heimdal or MIT-krb5 for packages that require a Kerberos 5
3860: implementation.
3861:
3862: * motif.buildlink3.mk checks for a system-provided Motif installation or adds
1.126 leot 3863: a dependency on x11/lesstif or x11/motif. The user can set MOTIF_TYPE to "
3864: dt", "lesstif" or "motif" to choose which Motif version will be used.
1.1 dsieger 3865:
1.57 wiz 3866: * readline.buildlink3.mk checks for a system-provided GNU readline or
3867: editline (libedit) installation, or adds a dependency on devel/readline,
3868: devel/editline. The user can set READLINE_DEFAULT to choose readline
1.56 ryoon 3869: implementation. If your package really needs GNU readline library, its
3870: Makefile should include devel/readline/buildlink3.mk instead of
3871: readline.buildlink3.mk.
3872:
1.1 dsieger 3873: * oss.buildlink3.mk defines several variables that may be used by packages
3874: that use the Open Sound System (OSS) API.
3875:
1.36 wiz 3876: * pgsql.buildlink3.mk will accept any of the Postgres versions in the
3877: variable PGSQL_VERSIONS_ACCEPTED and default to the version
3878: PGSQL_VERSION_DEFAULT. See the file for more information.
1.1 dsieger 3879:
3880: * pthread.buildlink3.mk uses the value of PTHREAD_OPTS and checks for native
3881: pthreads or adds a dependency on devel/pth as needed.
3882:
3883: * xaw.buildlink3.mk uses the value of XAW_TYPE to choose a particular Athena
3884: widgets library.
3885:
3886: The comments in those buildlink3.mk files provide a more complete description
3887: of how to use them properly.
3888:
1.154 rillig 3889: 16.2. Writing buildlink3.mk files
1.1 dsieger 3890:
3891: A package's buildlink3.mk file is included by Makefiles to indicate the need to
3892: compile and link against header files and libraries provided by the package. A
3893: buildlink3.mk file should always provide enough information to add the correct
3894: type of dependency relationship and include any other buildlink3.mk files that
3895: it needs to find headers and libraries that it needs in turn.
3896:
3897: To generate an initial buildlink3.mk file for further editing, Rene Hexel's
3898: pkgtools/createbuildlink package is highly recommended. For most packages, the
3899: following command will generate a good starting point for buildlink3.mk files:
3900:
3901: % cd pkgsrc/category/pkgdir
3902: % createbuildlink >buildlink3.mk
3903:
3904:
1.154 rillig 3905: 16.2.1. Anatomy of a buildlink3.mk file
1.1 dsieger 3906:
3907: The following real-life example buildlink3.mk is taken from pkgsrc/graphics/
3908: tiff:
3909:
1.19 snj 3910: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1 dsieger 3911:
1.19 snj 3912: BUILDLINK_TREE+= tiff
1.1 dsieger 3913:
1.19 snj 3914: .if !defined(TIFF_BUILDLINK3_MK)
3915: TIFF_BUILDLINK3_MK:=
1.1 dsieger 3916:
1.19 snj 3917: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
3918: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
1.1 dsieger 3919: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
3920:
3921: .include "../../devel/zlib/buildlink3.mk"
3922: .include "../../graphics/jpeg/buildlink3.mk"
1.19 snj 3923: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 3924:
1.19 snj 3925: BUILDLINK_TREE+= -tiff
1.1 dsieger 3926:
1.19 snj 3927: The header and footer manipulate BUILDLINK_TREE, which is common across all
3928: buildlink3.mk files and is used to track the dependency tree.
1.1 dsieger 3929:
1.19 snj 3930: The main section is protected from multiple inclusion and controls how the
1.1 dsieger 3931: dependency on pkg is added. Several important variables are set in the section:
3932:
3933: * BUILDLINK_API_DEPENDS.pkg is the actual dependency recorded in the
3934: installed package; this should always be set using += to ensure that we're
3935: appending to any pre-existing list of values. This variable should be set
1.27 wiz 3936: to the first version of the package that had an backwards-incompatible API
3937: change.
1.1 dsieger 3938:
3939: * BUILDLINK_PKGSRCDIR.pkg is the location of the pkg pkgsrc directory.
3940:
3941: * BUILDLINK_DEPMETHOD.pkg (not shown above) controls whether we use
3942: BUILD_DEPENDS or DEPENDS to add the dependency on pkg. The build dependency
3943: is selected by setting BUILDLINK_DEPMETHOD.pkg to "build". By default, the
3944: full dependency is used.
3945:
3946: * BUILDLINK_INCDIRS.pkg and BUILDLINK_LIBDIRS.pkg (not shown above) are lists
3947: of subdirectories of ${BUILDLINK_PREFIX.pkg} to add to the header and
3948: library search paths. These default to "include" and "lib" respectively.
3949:
3950: * BUILDLINK_CPPFLAGS.pkg (not shown above) is the list of preprocessor flags
3951: to add to CPPFLAGS, which are passed on to the configure and build phases.
3952: The "-I" option should be avoided and instead be handled using
3953: BUILDLINK_INCDIRS.pkg as above.
3954:
3955: The following variables are all optionally defined within this second section
3956: (protected against multiple inclusion) and control which package files are
3957: symlinked into ${BUILDLINK_DIR} and how their names are transformed during the
3958: symlinking:
3959:
3960: * BUILDLINK_FILES.pkg (not shown above) is a shell glob pattern relative to $
3961: {BUILDLINK_PREFIX.pkg} to be symlinked into ${BUILDLINK_DIR}, e.g. include/
3962: *.h.
3963:
3964: * BUILDLINK_FILES_CMD.pkg (not shown above) is a shell pipeline that outputs
3965: to stdout a list of files relative to ${BUILDLINK_PREFIX.pkg}. The
3966: resulting files are to be symlinked into ${BUILDLINK_DIR}. By default, this
3967: takes the +CONTENTS of a pkg and filters it through $
3968: {BUILDLINK_CONTENTS_FILTER.pkg}.
3969:
3970: * BUILDLINK_CONTENTS_FILTER.pkg (not shown above) is a filter command that
3971: filters +CONTENTS input into a list of files relative to $
1.84 wiz 3972: {BUILDLINK_PREFIX.pkg} on stdout. By default, BUILDLINK_CONTENTS_FILTER.pkg
3973: outputs the contents of the include and lib directories in the package
3974: +CONTENTS.
1.1 dsieger 3975:
3976: * BUILDLINK_FNAME_TRANSFORM.pkg (not shown above) is a list of sed arguments
3977: used to transform the name of the source filename into a destination
3978: filename, e.g. -e "s|/curses.h|/ncurses.h|g".
3979:
1.19 snj 3980: This section can additionally include any buildlink3.mk needed for pkg's
3981: library dependencies. Including these buildlink3.mk files means that the
3982: headers and libraries for these dependencies are also symlinked into $
3983: {BUILDLINK_DIR} whenever the pkg buildlink3.mk file is included. Dependencies
3984: are only added for directly include buildlink3.mk files.
1.1 dsieger 3985:
1.48 wiz 3986: When providing a buildlink3.mk and including other buildlink3.mk files in it,
1.51 wiz 3987: please only add necessary ones, i.e., those whose libraries or header files are
1.48 wiz 3988: automatically exposed when the package is use.
3989:
3990: In particular, if only an executable (bin/foo) is linked against a library,
3991: that library does not need to be propagated in the buildlink3.mk file.
3992:
3993: The following steps should help you decide if a buildlink3.mk file needs to be
3994: included:
3995:
3996: * Look at the installed header files: What headers do they include? The
3997: packages providing these files must be buildlinked.
3998:
1.50 wiz 3999: * Run ldd on all installed libraries and look against what other libraries
4000: they link. Some of the packages providing these probably need to be
4001: buildlinked; however, it's not automatic, since e.g. GTK on some systems
4002: pulls in the X libraries, so they will show up in the ldd output, while on
1.51 wiz 4003: others (like OS X) it won't. ldd output can thus only be used as a hint.
1.50 wiz 4004:
1.154 rillig 4005: 16.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
1.27 wiz 4006: buildlink3.mk files
1.1 dsieger 4007:
1.27 wiz 4008: These two variables differ in that one describes source compatibility (API) and
4009: the other binary compatibility (ABI). The difference is that a change in the
4010: API breaks compilation of programs while changes in the ABI stop compiled
4011: programs from running.
4012:
1.28 wiz 4013: Changes to the BUILDLINK_API_DEPENDS.pkg variable in a buildlink3.mk file
4014: happen very rarely. One possible reason is that all packages depending on this
4015: already need a newer version. In case it is bumped see the description below.
1.27 wiz 4016:
4017: The most common example of an ABI change is that the major version of a shared
4018: library is increased. In this case, BUILDLINK_ABI_DEPENDS.pkg should be
4019: adjusted to require at least the new package version. Then the packages that
4020: depend on this package need their PKGREVISIONs increased and, if they have
4021: buildlink3.mk files, their BUILDLINK_ABI_DEPENDS.pkg adjusted, too. This is
4022: needed so pkgsrc will require the correct package dependency and not settle for
4023: an older one when building the source.
1.1 dsieger 4024:
1.154 rillig 4025: See Section 21.1.5, "Handling dependencies" for more information about
1.1 dsieger 4026: dependencies on other packages, including the BUILDLINK_ABI_DEPENDS and
4027: ABI_DEPENDS definitions.
4028:
4029: Please take careful consideration before adjusting BUILDLINK_API_DEPENDS.pkg or
4030: BUILDLINK_ABI_DEPENDS.pkg as we don't want to cause unneeded package deletions
4031: and rebuilds. In many cases, new versions of packages work just fine with older
4032: dependencies.
4033:
4034: Also it is not needed to set BUILDLINK_ABI_DEPENDS.pkg when it is identical to
4035: BUILDLINK_API_DEPENDS.pkg.
4036:
1.154 rillig 4037: 16.3. Writing builtin.mk files
1.1 dsieger 4038:
4039: Some packages in pkgsrc install headers and libraries that coincide with
4040: headers and libraries present in the base system. Aside from a buildlink3.mk
4041: file, these packages should also include a builtin.mk file that includes the
4042: necessary checks to decide whether using the built-in software or the pkgsrc
4043: software is appropriate.
4044:
4045: The only requirements of a builtin.mk file for pkg are:
4046:
4047: 1. It should set USE_BUILTIN.pkg to either "yes" or "no" after it is included.
4048:
4049: 2. It should not override any USE_BUILTIN.pkg which is already set before the
4050: builtin.mk file is included.
4051:
4052: 3. It should be written to allow multiple inclusion. This is very important
4053: and takes careful attention to Makefile coding.
4054:
1.154 rillig 4055: 16.3.1. Anatomy of a builtin.mk file
1.1 dsieger 4056:
4057: The following is the recommended template for builtin.mk files:
4058:
4059: .if !defined(IS_BUILTIN.foo)
4060: #
4061: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
4062: # genuinely exists in the system or not.
4063: #
4064: IS_BUILTIN.foo?= no
4065:
4066: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
4067: # version can be determined.
4068: #
4069: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
4070: BUILTIN_PKG.foo?= foo-1.0
4071: . endif
4072: .endif # IS_BUILTIN.foo
4073:
4074: .if !defined(USE_BUILTIN.foo)
4075: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
4076: . if defined(BUILTIN_PKG.foo)
4077: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
4078: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
4079: USE_BUILTIN.foo!= \
4080: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
4081: && ${ECHO} "yes" || ${ECHO} "no"
4082: . endif
4083: . endfor
4084: . endif
4085: .endif # USE_BUILTIN.foo
4086:
4087: CHECK_BUILTIN.foo?= no
4088: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
4089: #
4090: # Here we place code that depends on whether USE_BUILTIN.foo is set to
4091: # "yes" or "no".
4092: #
4093: .endif # CHECK_BUILTIN.foo
4094:
4095: The first section sets IS_BUILTIN.pkg depending on if pkg really exists in the
4096: base system. This should not be a base system software with similar
4097: functionality to pkg; it should only be "yes" if the actual package is included
4098: as part of the base system. This variable is only used internally within the
4099: builtin.mk file.
4100:
4101: The second section sets BUILTIN_PKG.pkg to the version of pkg in the base
4102: system if it exists (if IS_BUILTIN.pkg is "yes"). This variable is only used
4103: internally within the builtin.mk file.
4104:
4105: The third section sets USE_BUILTIN.pkg and is required in all builtin.mk files.
4106: The code in this section must make the determination whether the built-in
4107: software is adequate to satisfy the dependencies listed in
4108: BUILDLINK_API_DEPENDS.pkg. This is typically done by comparing BUILTIN_PKG.pkg
1.25 wiz 4109: against each of the dependencies in BUILDLINK_API_DEPENDS.pkg. USE_BUILTIN.pkg
1.1 dsieger 4110: must be set to the correct value by the end of the builtin.mk file. Note that
4111: USE_BUILTIN.pkg may be "yes" even if IS_BUILTIN.pkg is "no" because we may make
4112: the determination that the built-in version of the software is similar enough
4113: to be used as a replacement.
4114:
4115: The last section is guarded by CHECK_BUILTIN.pkg, and includes code that uses
4116: the value of USE_BUILTIN.pkg set in the previous section. This typically
4117: includes, e.g., adding additional dependency restrictions and listing
4118: additional files to symlink into ${BUILDLINK_DIR} (via BUILDLINK_FILES.pkg).
4119:
1.154 rillig 4120: 16.3.2. Global preferences for native or pkgsrc software
1.1 dsieger 4121:
4122: When building packages, it's possible to choose whether to set a global
4123: preference for using either the built-in (native) version or the pkgsrc version
4124: of software to satisfy a dependency. This is controlled by setting
1.25 wiz 4125: PREFER_PKGSRC and PREFER_NATIVE. These variables take values of either "yes", "
4126: no", or a list of packages. PREFER_PKGSRC tells pkgsrc to use the pkgsrc
1.1 dsieger 4127: versions of software, while PREFER_NATIVE tells pkgsrc to use the built-in
4128: versions. Preferences are determined by the most specific instance of the
4129: package in either PREFER_PKGSRC or PREFER_NATIVE. If a package is specified in
4130: neither or in both variables, then PREFER_PKGSRC has precedence over
4131: PREFER_NATIVE. For example, to require using pkgsrc versions of software for
4132: all but the most basic bits on a NetBSD system, you can set:
4133:
4134: PREFER_PKGSRC= yes
4135: PREFER_NATIVE= getopt skey tcp_wrappers
4136:
4137: A package must have a builtin.mk file to be listed in PREFER_NATIVE, otherwise
4138: it is simply ignored in that list.
4139:
1.117 sevan 4140: Setting PREFER_NATIVE should be performed straight after bootstrap and
4141: PREFER_PKGSRC during bootstrap. Switching between settings globally at a later
4142: date can introduce complications with dependency resolution. This is caused by
4143: packages built with the opposite preference being installed alongside each
4144: other.
4145:
4146: # ./bootstrap --prefer-pkgsrc yes
4147:
1.154 rillig 4148: Chapter 17. The pkginstall framework
1.1 dsieger 4149:
4150: Table of Contents
4151:
1.154 rillig 4152: 17.1. Files and directories outside the installation prefix
1.1 dsieger 4153:
1.154 rillig 4154: 17.1.1. Directory manipulation
4155: 17.1.2. File manipulation
1.1 dsieger 4156:
1.154 rillig 4157: 17.2. Configuration files
1.1 dsieger 4158:
1.154 rillig 4159: 17.2.1. How PKG_SYSCONFDIR is set
4160: 17.2.2. Telling the software where configuration files are
4161: 17.2.3. Patching installations
4162: 17.2.4. Disabling handling of configuration files
1.1 dsieger 4163:
1.154 rillig 4164: 17.3. System startup scripts
1.1 dsieger 4165:
1.154 rillig 4166: 17.3.1. Disabling handling of system startup scripts
1.1 dsieger 4167:
1.154 rillig 4168: 17.4. System users and groups
4169: 17.5. System shells
1.1 dsieger 4170:
1.154 rillig 4171: 17.5.1. Disabling shell registration
1.1 dsieger 4172:
1.154 rillig 4173: 17.6. Fonts
1.1 dsieger 4174:
1.154 rillig 4175: 17.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 4176:
4177: This chapter describes the framework known as pkginstall, whose key features
4178: are:
4179:
4180: * Generic installation and manipulation of directories and files outside the
4181: pkgsrc-handled tree, LOCALBASE.
4182:
4183: * Automatic handling of configuration files during installation, provided
4184: that packages are correctly designed.
4185:
4186: * Generation and installation of system startup scripts.
4187:
4188: * Registration of system users and groups.
4189:
4190: * Registration of system shells.
4191:
4192: * Automatic updating of fonts databases.
4193:
4194: The following sections inspect each of the above points in detail.
4195:
4196: You may be thinking that many of the things described here could be easily done
4197: with simple code in the package's post-installation target (post-install). This
4198: is incorrect, as the code in them is only executed when building from source.
4199: Machines using binary packages could not benefit from it at all (as the code
4200: itself could be unavailable). Therefore, the only way to achieve any of the
4201: items described above is by means of the installation scripts, which are
4202: automatically generated by pkginstall.
4203:
1.154 rillig 4204: 17.1. Files and directories outside the installation prefix
1.1 dsieger 4205:
4206: As you already know, the PLIST file holds a list of files and directories that
4207: belong to a package. The names used in it are relative to the installation
4208: prefix (${PREFIX}), which means that it cannot register files outside this
4209: directory (absolute path names are not allowed). Despite this restriction, some
4210: packages need to install files outside this location; e.g., under ${VARBASE} or
4211: ${PKG_SYSCONFDIR}. The only way to achieve this is to create such files during
4212: installation time by using installation scripts.
4213:
4214: The generic installation scripts are shell scripts that can contain arbitrary
4215: code. The list of scripts to execute is taken from the INSTALL_FILE variable,
4216: which defaults to INSTALL. A similar variable exists for package removal
4217: (DEINSTALL_FILE, whose default is DEINSTALL). These scripts can run arbitrary
4218: commands, so they have the potential to create and manage files anywhere in the
4219: file system.
4220:
4221: Using these general installation files is not recommended, but may be needed in
4222: some special cases. One reason for avoiding them is that the user has to trust
4223: the packager that there is no unwanted or simply erroneous code included in the
4224: installation script. Also, previously there were many similar scripts for the
4225: same functionality, and fixing a common error involved finding and changing all
4226: of them.
4227:
4228: The pkginstall framework offers another, standardized way. It provides generic
4229: scripts to abstract the manipulation of such files and directories based on
4230: variables set in the package's Makefile. The rest of this section describes
4231: these variables.
4232:
1.154 rillig 4233: 17.1.1. Directory manipulation
1.1 dsieger 4234:
4235: The following variables can be set to request the creation of directories
4236: anywhere in the file system:
4237:
4238: * MAKE_DIRS and OWN_DIRS contain a list of directories that should be created
4239: and should attempt to be destroyed by the installation scripts. The
4240: difference between the two is that the latter prompts the administrator to
4241: remove any directories that may be left after deinstallation (because they
1.108 rillig 4242: were not empty), while the former does not. Example:
4243:
4244: MAKE_DIRS+= ${VARBASE}/foo/private
1.1 dsieger 4245:
4246: * MAKE_DIRS_PERMS and OWN_DIRS_PERMS contain a list of tuples describing
4247: which directories should be created and should attempt to be destroyed by
4248: the installation scripts. Each tuple holds the following values, separated
4249: by spaces: the directory name, its owner, its group and its numerical mode.
4250: For example:
4251:
1.108 rillig 4252: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
4253: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 4254:
4255: The difference between the two is exactly the same as their non-PERMS
4256: counterparts.
4257:
1.154 rillig 4258: 17.1.2. File manipulation
1.1 dsieger 4259:
4260: Creating non-empty files outside the installation prefix is tricky because the
4261: PLIST forces all files to be inside it. To overcome this problem, the only
4262: solution is to extract the file in the known place (i.e., inside the
4263: installation prefix) and copy it to the appropriate location during
4264: installation (done by the installation scripts generated by pkginstall). We
4265: will call the former the master file in the following paragraphs, which
4266: describe the variables that can be used to automatically and consistently
4267: handle files outside the installation prefix:
4268:
1.31 wiz 4269: * CONF_FILES and REQD_FILES are pairs of master and target files. During
1.1 dsieger 4270: installation time, the master file is copied to the target one if and only
4271: if the latter does not exist. Upon deinstallation, the target file is
4272: removed provided that it was not modified by the installation.
4273:
4274: The difference between the two is that the latter prompts the administrator
4275: to remove any files that may be left after deinstallation (because they
4276: were not empty), while the former does not.
4277:
1.31 wiz 4278: * CONF_FILES_PERMS and REQD_FILES_PERMS contain tuples describing master
1.1 dsieger 4279: files as well as their target locations. For each of them, it also
4280: specifies their owner, their group and their numeric permissions, in this
4281: order. For example:
4282:
1.108 rillig 4283: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
4284: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 4285:
4286: The difference between the two is exactly the same as their non-PERMS
4287: counterparts.
4288:
1.154 rillig 4289: 17.2. Configuration files
1.1 dsieger 4290:
4291: Configuration files are special in the sense that they are installed in their
4292: own specific directory, PKG_SYSCONFDIR, and need special treatment during
4293: installation (most of which is automated by pkginstall). The main concept you
4294: must bear in mind is that files marked as configuration files are automatically
4295: copied to the right place (somewhere inside PKG_SYSCONFDIR) during installation
4296: if and only if they didn't exist before. Similarly, they will not be removed if
4297: they have local modifications. This ensures that administrators never lose any
4298: custom changes they may have made.
4299:
1.154 rillig 4300: 17.2.1. How PKG_SYSCONFDIR is set
1.1 dsieger 4301:
4302: As said before, the PKG_SYSCONFDIR variable specifies where configuration files
4303: shall be installed. Its contents are set based upon the following variables:
4304:
4305: * PKG_SYSCONFBASE: The configuration's root directory. Defaults to ${PREFIX}/
4306: etc although it may be overridden by the user to point to his preferred
4307: location (e.g., /etc, /etc/pkg, etc.). Packages must not use it directly.
4308:
4309: * PKG_SYSCONFSUBDIR: A subdirectory of PKG_SYSCONFBASE under which the
4310: configuration files for the package being built shall be installed. The
4311: definition of this variable only makes sense in the package's Makefile
4312: (i.e., it is not user-customizable).
4313:
1.68 asau 4314: As an example, consider the Apache package, www/apache24, which places its
1.1 dsieger 4315: configuration files under the httpd/ subdirectory of PKG_SYSCONFBASE. This
4316: should be set in the package Makefile.
4317:
4318: * PKG_SYSCONFVAR: Specifies the name of the variable that holds this
4319: package's configuration directory (if different from PKG_SYSCONFBASE). It
4320: defaults to PKGBASE's value, and is always prefixed with PKG_SYSCONFDIR.
4321:
4322: * PKG_SYSCONFDIR.${PKG_SYSCONFVAR}: Holds the directory where the
4323: configuration files for the package identified by PKG_SYSCONFVAR's shall be
4324: placed.
4325:
4326: Based on the above variables, pkginstall determines the value of
4327: PKG_SYSCONFDIR, which is the only variable that can be used within a package to
4328: refer to its configuration directory. The algorithm used to set its value is
4329: basically the following:
4330:
4331: 1. If PKG_SYSCONFDIR.${PKG_SYSCONFVAR} is set, its value is used.
4332:
4333: 2. If the previous variable is not defined but PKG_SYSCONFSUBDIR is set in the
4334: package's Makefile, the resulting value is ${PKG_SYSCONFBASE}/$
4335: {PKG_SYSCONFSUBDIR}.
4336:
4337: 3. Otherwise, it is set to ${PKG_SYSCONFBASE}.
4338:
4339: It is worth mentioning that ${PKG_SYSCONFDIR} is automatically added to
1.154 rillig 4340: OWN_DIRS. See Section 17.1.1, "Directory manipulation" what this means. This
1.16 jnemeth 4341: does not apply to subdirectories of ${PKG_SYSCONFDIR}, they still have to be
4342: created with OWN_DIRS or MAKE_DIRS.
1.1 dsieger 4343:
1.154 rillig 4344: 17.2.2. Telling the software where configuration files are
1.1 dsieger 4345:
4346: Given that pkgsrc (and users!) expect configuration files to be in a known
4347: place, you need to teach each package where it shall install its files. In some
4348: cases you will have to patch the package Makefiles to achieve it. If you are
4349: lucky, though, it may be as easy as passing an extra flag to the configuration
4350: script; this is the case of GNU Autoconf- generated files:
4351:
4352: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
4353:
4354: Note that this specifies where the package has to look for its configuration
4355: files, not where they will be originally installed (although the difference is
4356: never explicit, unfortunately).
4357:
1.154 rillig 4358: 17.2.3. Patching installations
1.1 dsieger 4359:
4360: As said before, pkginstall automatically handles configuration files. This
4361: means that the packages themselves must not touch the contents of $
4362: {PKG_SYSCONFDIR} directly. Bad news is that many software installation scripts
4363: will, out of the box, mess with the contents of that directory. So what is the
4364: correct procedure to fix this issue?
4365:
4366: You must teach the package (usually by manually patching it) to install any
4367: configuration files under the examples hierarchy, share/examples/${PKGBASE}/.
4368: This way, the PLIST registers them and the administrator always has the
4369: original copies available.
4370:
4371: Once the required configuration files are in place (i.e., under the examples
4372: hierarchy), the pkginstall framework can use them as master copies during the
4373: package installation to update what is in ${PKG_SYSCONFDIR}. To achieve this,
4374: the variables CONF_FILES and CONF_FILES_PERMS are used. Check out
1.154 rillig 4375: Section 17.1.2, "File manipulation" for information about their syntax and
1.1 dsieger 4376: their purpose. Here is an example, taken from the mail/mutt package:
4377:
4378: EGDIR= ${PREFIX}/share/doc/mutt/samples
4379: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
4380:
4381: Note that the EGDIR variable is specific to that package and has no meaning
4382: outside it.
4383:
1.154 rillig 4384: 17.2.4. Disabling handling of configuration files
1.1 dsieger 4385:
4386: The automatic copying of config files can be toggled by setting the environment
4387: variable PKG_CONFIG prior to package installation.
4388:
1.154 rillig 4389: 17.3. System startup scripts
1.1 dsieger 4390:
4391: System startup scripts are special files because they must be installed in a
4392: place known by the underlying OS, usually outside the installation prefix.
1.154 rillig 4393: Therefore, the same rules described in Section 17.1, "Files and directories
1.1 dsieger 4394: outside the installation prefix" apply, and the same solutions can be used.
4395: However, pkginstall provides a special mechanism to handle these files.
4396:
4397: In order to provide system startup scripts, the package has to:
4398:
4399: 1. Store the script inside ${FILESDIR}, with the .sh suffix appended.
4400: Considering the print/cups package as an example, it has a cupsd.sh in its
4401: files directory.
4402:
4403: 2. Tell pkginstall to handle it, appending the name of the script, without its
4404: extension, to the RCD_SCRIPTS variable. Continuing the previous example:
4405:
4406: RCD_SCRIPTS+= cupsd
4407:
4408: Once this is done, pkginstall will do the following steps for each script in an
4409: automated fashion:
4410:
4411: 1. Process the file found in the files directory applying all the
4412: substitutions described in the FILES_SUBST variable.
4413:
4414: 2. Copy the script from the files directory to the examples hierarchy, $
4415: {PREFIX}/share/examples/rc.d/. Note that this master file must be
4416: explicitly registered in the PLIST.
4417:
4418: 3. Add code to the installation scripts to copy the startup script from the
4419: examples hierarchy into the system-wide startup scripts directory.
4420:
1.154 rillig 4421: 17.3.1. Disabling handling of system startup scripts
1.1 dsieger 4422:
4423: The automatic copying of config files can be toggled by setting the environment
4424: variable PKG_RCD_SCRIPTS prior to package installation. Note that the scripts
4425: will be always copied inside the examples hierarchy, ${PREFIX}/share/examples/
4426: rc.d/, no matter what the value of this variable is.
4427:
1.154 rillig 4428: 17.4. System users and groups
1.1 dsieger 4429:
4430: If a package needs to create special users and/or groups during installation,
4431: it can do so by using the pkginstall framework.
4432:
4433: Users can be created by adding entries to the PKG_USERS variable. Each entry
4434: has the following syntax:
4435:
4436: user:group
4437:
4438: Further specification of user details may be done by setting per-user
4439: variables. PKG_UID.user is the numeric UID for the user. PKG_GECOS.user is the
4440: user's description or comment. PKG_HOME.user is the user's home directory, and
4441: defaults to /nonexistent if not specified. PKG_SHELL.user is the user's shell,
4442: and defaults to /sbin/nologin if not specified.
4443:
4444: Similarly, groups can be created by adding entries to the PKG_GROUPS variable,
4445: whose syntax is:
4446:
4447: group
4448:
4449: The numeric GID of the group may be set by defining PKG_GID.group.
4450:
4451: If a package needs to create the users and groups at an earlier stage, then it
1.116 wiz 4452: can set USERGROUP_PHASE to either configure,build, or pre-install to indicate
4453: the phase before which the users and groups are created. In this case, the
4454: numeric UIDs and GIDs of the created users and groups are automatically
4455: hardcoded into the final installation scripts.
1.1 dsieger 4456:
1.154 rillig 4457: 17.5. System shells
1.1 dsieger 4458:
4459: Packages that install system shells should register them in the shell database,
4460: /etc/shells, to make things easier to the administrator. This must be done from
4461: the installation scripts to keep binary packages working on any system.
4462: pkginstall provides an easy way to accomplish this task.
4463:
4464: When a package provides a shell interpreter, it has to set the PKG_SHELL
4465: variable to its absolute file name. This will add some hooks to the
4466: installation scripts to handle it. Consider the following example, taken from
4467: shells/zsh:
4468:
4469: PKG_SHELL= ${PREFIX}/bin/zsh
4470:
1.154 rillig 4471: 17.5.1. Disabling shell registration
1.1 dsieger 4472:
4473: The automatic registration of shell interpreters can be disabled by the
4474: administrator by setting the PKG_REGISTER_SHELLS environment variable to NO.
4475:
1.154 rillig 4476: 17.6. Fonts
1.1 dsieger 4477:
4478: Packages that install X11 fonts should update the database files that index the
4479: fonts within each fonts directory. This can easily be accomplished within the
4480: pkginstall framework.
4481:
4482: When a package installs X11 fonts, it must list the directories in which fonts
4483: are installed in the FONTS_DIRS.type variables, where type can be one of "ttf",
4484: "type1" or "x11". This will add hooks to the installation scripts to run the
4485: appropriate commands to update the fonts database files within each of those
4486: directories. For convenience, if the directory path is relative, it is taken to
4487: be relative to the package's installation prefix. Consider the following
4488: example, taken from fonts/dbz-ttf:
4489:
1.67 wiz 4490: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 4491:
1.154 rillig 4492: 17.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 4493:
4494: The automatic update of fonts databases can be disabled by the administrator by
4495: setting the PKG_UPDATE_FONTS_DB environment variable to NO.
4496:
1.154 rillig 4497: Chapter 18. Options handling
1.1 dsieger 4498:
4499: Table of Contents
4500:
1.154 rillig 4501: 18.1. Global default options
4502: 18.2. Converting packages to use bsd.options.mk
4503: 18.3. Option Names
4504: 18.4. Determining the options of dependencies
1.1 dsieger 4505:
4506: Many packages have the ability to be built to support different sets of
4507: features. bsd.options.mk is a framework in pkgsrc that provides generic
4508: handling of those options that determine different ways in which the packages
4509: can be built. It's possible for the user to specify exactly which sets of
4510: options will be built into a package or to allow a set of global default
4511: options apply.
4512:
1.7 rillig 4513: There are two broad classes of behaviors that one might want to control via
4514: options. One is whether some particular feature is enabled in a program that
4515: will be built anyway, often by including or not including a dependency on some
4516: other package. The other is whether or not an additional program will be built
4517: as part of the package. Generally, it is better to make a split package for
4518: such additional programs instead of using options, because it enables binary
4519: packages to be built which can then be added separately. For example, the foo
4520: package might have minimal dependencies (those packages without which foo
4521: doesn't make sense), and then the foo-gfoo package might include the GTK
4522: frontend program gfoo. This is better than including a gtk option to foo that
4523: adds gfoo, because either that option is default, in which case binary users
4524: can't get foo without gfoo, or not default, in which case they can't get gfoo.
4525: With split packages, they can install foo without having GTK, and later decide
4526: to install gfoo (pulling in GTK at that time). This is an advantage to source
4527: users too, avoiding the need for rebuilds.
4528:
4529: Plugins with widely varying dependencies should usually be split instead of
4530: options.
4531:
4532: It is often more work to maintain split packages, especially if the upstream
4533: package does not support this. The decision of split vs. option should be made
4534: based on the likelihood that users will want or object to the various pieces,
4535: the size of the dependencies that are included, and the amount of work.
4536:
4537: A further consideration is licensing. Non-free parts, or parts that depend on
4538: non-free dependencies (especially plugins) should almost always be split if
4539: feasible.
4540:
1.154 rillig 4541: 18.1. Global default options
1.1 dsieger 4542:
4543: Global default options are listed in PKG_DEFAULT_OPTIONS, which is a list of
4544: the options that should be built into every package if that option is
1.4 rillig 4545: supported. This variable should be set in mk.conf.
1.1 dsieger 4546:
1.154 rillig 4547: 18.2. Converting packages to use bsd.options.mk
1.1 dsieger 4548:
4549: The following example shows how bsd.options.mk should be used by the
4550: hypothetical ``wibble'' package, either in the package Makefile, or in a file,
4551: e.g. options.mk, that is included by the main package Makefile.
4552:
4553: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
4554: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
4555: PKG_OPTIONS_OPTIONAL_GROUPS= database
4556: PKG_OPTIONS_GROUP.database= mysql pgsql
4557: PKG_SUGGESTED_OPTIONS= wibble-foo
4558: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
4559: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
4560:
4561: .include "../../mk/bsd.prefs.mk"
4562:
4563: # this package was previously named wibble2
4564: .if defined(PKG_OPTIONS.wibble2)
4565: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
4566: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
4567: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
4568: .endif
4569:
4570: .include "../../mk/bsd.options.mk"
4571:
4572: # Package-specific option-handling
4573:
4574: ###
4575: ### FOO support
4576: ###
4577: .if !empty(PKG_OPTIONS:Mwibble-foo)
4578: CONFIGURE_ARGS+= --enable-foo
4579: .endif
4580:
4581: ###
4582: ### LDAP support
4583: ###
4584: .if !empty(PKG_OPTIONS:Mldap)
4585: . include "../../databases/openldap-client/buildlink3.mk"
4586: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
4587: .endif
4588:
4589: ###
4590: ### database support
4591: ###
4592: .if !empty(PKG_OPTIONS:Mmysql)
4593: . include "../../mk/mysql.buildlink3.mk"
4594: .endif
4595: .if !empty(PKG_OPTIONS:Mpgsql)
4596: . include "../../mk/pgsql.buildlink3.mk"
4597: .endif
4598:
4599: The first section contains the information about which build options are
4600: supported by the package, and any default options settings if needed.
4601:
4602: 1. PKG_OPTIONS_VAR is the name of the make(1) variable that the user can set
4603: to override the default options. It should be set to PKG_OPTIONS.pkgbase.
4604: Do not set it to PKG_OPTIONS.${PKGBASE}, since PKGBASE is not defined at
4605: the point where the options are processed.
4606:
4607: 2. PKG_SUPPORTED_OPTIONS is a list of build options supported by the package.
4608:
4609: 3. PKG_OPTIONS_OPTIONAL_GROUPS is a list of names of groups of mutually
4610: exclusive options. The options in each group are listed in
4611: PKG_OPTIONS_GROUP.groupname. The most specific setting of any option from
4612: the group takes precedence over all other options in the group. Options
4613: from the groups will be automatically added to PKG_SUPPORTED_OPTIONS.
4614:
4615: 4. PKG_OPTIONS_REQUIRED_GROUPS is like PKG_OPTIONS_OPTIONAL_GROUPS, but
4616: building the packages will fail if no option from the group is selected.
4617:
4618: 5. PKG_OPTIONS_NONEMPTY_SETS is a list of names of sets of options. At least
4619: one option from each set must be selected. The options in each set are
4620: listed in PKG_OPTIONS_SET.setname. Options from the sets will be
4621: automatically added to PKG_SUPPORTED_OPTIONS. Building the package will
4622: fail if no option from the set is selected.
4623:
4624: 6. PKG_SUGGESTED_OPTIONS is a list of build options which are enabled by
4625: default.
4626:
4627: 7. PKG_OPTIONS_LEGACY_VARS is a list of "USE_VARIABLE:option" pairs that map
1.4 rillig 4628: legacy mk.conf variables to their option counterparts. Pairs should be
1.1 dsieger 4629: added with "+=" to keep the listing of global legacy variables. A warning
4630: will be issued if the user uses a legacy variable.
4631:
4632: 8. PKG_OPTIONS_LEGACY_OPTS is a list of "old-option:new-option" pairs that map
4633: options that have been renamed to their new counterparts. Pairs should be
4634: added with "+=" to keep the listing of global legacy options. A warning
4635: will be issued if the user uses a legacy option.
4636:
4637: 9. PKG_LEGACY_OPTIONS is a list of options implied by deprecated variables
4638: used. This can be used for cases that neither PKG_OPTIONS_LEGACY_VARS nor
4639: PKG_OPTIONS_LEGACY_OPTS can handle, e. g. when PKG_OPTIONS_VAR is renamed.
4640:
4641: 10. PKG_OPTIONS_DEPRECATED_WARNINGS is a list of warnings about deprecated
4642: variables or options used, and what to use instead.
4643:
4644: A package should never modify PKG_DEFAULT_OPTIONS or the variable named in
4645: PKG_OPTIONS_VAR. These are strictly user-settable. To suggest a default set of
4646: options, use PKG_SUGGESTED_OPTIONS.
4647:
4648: PKG_OPTIONS_VAR must be defined before including bsd.options.mk. If none of
4649: PKG_SUPPORTED_OPTIONS, PKG_OPTIONS_OPTIONAL_GROUPS, and
4650: PKG_OPTIONS_REQUIRED_GROUPS are defined (as can happen with platform-specific
4651: options if none of them is supported on the current platform), PKG_OPTIONS is
4652: set to the empty list and the package is otherwise treated as not using the
4653: options framework.
4654:
4655: After the inclusion of bsd.options.mk, the variable PKG_OPTIONS contains the
4656: list of selected build options, properly filtered to remove unsupported and
4657: duplicate options.
4658:
4659: The remaining sections contain the logic that is specific to each option. The
4660: correct way to check for an option is to check whether it is listed in
4661: PKG_OPTIONS:
4662:
4663: .if !empty(PKG_OPTIONS:Moption)
4664:
1.154 rillig 4665: 18.3. Option Names
1.1 dsieger 4666:
4667: Options that enable similar features in different packages (like optional
4668: support for a library) should use a common name in all packages that support it
4669: (like the name of the library). If another package already has an option with
4670: the same meaning, use the same name.
4671:
4672: Options that enable features specific to one package, where it's unlikely that
4673: another (unrelated) package has the same (or a similar) optional feature,
4674: should use a name prefixed with pkgname-.
4675:
4676: If a group of related packages share an optional feature specific to that
4677: group, prefix it with the name of the "main" package (e. g.
4678: djbware-errno-hack).
4679:
4680: For new options, add a line to mk/defaults/options.description. Lines have two
4681: fields, separated by tab. The first field is the option name, the second its
4682: description. The description should be a whole sentence (starting with an
4683: uppercase letter and ending with a period) that describes what enabling the
4684: option does. E. g. "Enable ispell support." The file is sorted by option names.
4685:
1.154 rillig 4686: 18.4. Determining the options of dependencies
1.7 rillig 4687:
4688: When writing buildlink3.mk files, it is often necessary to list different
4689: dependencies based on the options with which the package was built. For
4690: querying these options, the file pkgsrc/mk/pkg-build-options.mk should be used.
4691: A typical example looks like this:
4692:
4693: pkgbase := libpurple
4694: .include "../../mk/pkg-build-options.mk"
4695:
4696: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
4697: ...
4698: .endif
4699:
4700: Including pkg-build-options.mk here will set the variable
4701: PKG_BUILD_OPTIONS.libpurple to the build options of the libpurple package,
4702: which can then be queried like PKG_OPTIONS in the options.mk file. See the file
4703: pkg-build-options.mk for more details.
4704:
1.154 rillig 4705: Chapter 19. The build process
1.1 dsieger 4706:
4707: Table of Contents
4708:
1.154 rillig 4709: 19.1. Introduction
4710: 19.2. Program location
4711: 19.3. Directories used during the build process
4712: 19.4. Running a phase
4713: 19.5. The fetch phase
4714:
4715: 19.5.1. What to fetch and where to get it from
4716: 19.5.2. How are the files fetched?
4717:
4718: 19.6. The checksum phase
4719: 19.7. The extract phase
4720: 19.8. The patch phase
4721: 19.9. The tools phase
4722: 19.10. The wrapper phase
4723: 19.11. The configure phase
4724: 19.12. The build phase
4725: 19.13. The test phase
4726: 19.14. The install phase
4727: 19.15. The package phase
4728: 19.16. Cleaning up
4729: 19.17. Other helpful targets
1.1 dsieger 4730:
1.154 rillig 4731: 19.1. Introduction
1.1 dsieger 4732:
4733: This chapter gives a detailed description on how a package is built. Building a
4734: package is separated into different phases (for example fetch, build, install),
1.19 snj 4735: all of which are described in the following sections. Each phase is split into
4736: so-called stages, which take the name of the containing phase, prefixed by one
4737: of pre-, do- or post-. (Examples are pre-configure, post-build.) Most of the
4738: actual work is done in the do-* stages.
1.1 dsieger 4739:
4740: Never override the regular targets (like fetch), if you have to, override the
4741: do-* ones instead.
4742:
4743: The basic steps for building a program are always the same. First the program's
4744: source (distfile) must be brought to the local system and then extracted. After
4745: any pkgsrc-specific patches to compile properly are applied, the software can
4746: be configured, then built (usually by compiling), and finally the generated
4747: binaries, etc. can be put into place on the system.
4748:
4749: To get more details about what is happening at each step, you can set the
4750: PKG_VERBOSE variable, or the PATCH_DEBUG variable if you are just interested in
4751: more details about the patch step.
4752:
1.154 rillig 4753: 19.2. Program location
1.1 dsieger 4754:
4755: Before outlining the process performed by the NetBSD package system in the next
4756: section, here's a brief discussion on where programs are installed, and which
4757: variables influence this.
4758:
4759: The automatic variable PREFIX indicates where all files of the final program
4760: shall be installed. It is usually set to LOCALBASE (/usr/pkg), or CROSSBASE for
4761: pkgs in the cross category. The value of PREFIX needs to be put into the
4762: various places in the program's source where paths to these files are encoded.
1.154 rillig 4763: See Section 13.3, "patches/*" and Section 21.3.1, "Shared libraries - libtool"
1.1 dsieger 4764: for more details.
4765:
4766: When choosing which of these variables to use, follow the following rules:
4767:
4768: * PREFIX always points to the location where the current pkg will be
1.25 wiz 4769: installed. When referring to a pkg's own installation path, use "${PREFIX}"
4770: .
1.1 dsieger 4771:
4772: * LOCALBASE is where all non-X11 pkgs are installed. If you need to construct
4773: a -I or -L argument to the compiler to find includes and libraries
4774: installed by another non-X11 pkg, use "${LOCALBASE}". The name LOCALBASE
4775: stems from FreeBSD, which installed all packages in /usr/local. As pkgsrc
4776: leaves /usr/local for the system administrator, this variable is a
4777: misnomer.
4778:
4779: * X11BASE is where the actual X11 distribution (from xsrc, etc.) is
4780: installed. When looking for standard X11 includes (not those installed by a
4781: package), use "${X11BASE}".
4782:
1.99 sevan 4783: * X11-based packages using imake must set USE_IMAKE to be installed correctly
4784: under LOCALBASE.
1.1 dsieger 4785:
4786: * Within ${PREFIX}, packages should install files according to hier(7), with
4787: the exception that manual pages go into ${PREFIX}/man, not ${PREFIX}/share/
4788: man.
4789:
1.154 rillig 4790: 19.3. Directories used during the build process
1.1 dsieger 4791:
1.14 jmcneill 4792: When building a package, various directories are used to store source files,
1.1 dsieger 4793: temporary files, pkgsrc-internal files, and so on. These directories are
4794: explained here.
4795:
4796: Some of the directory variables contain relative pathnames. There are two
4797: common base directories for these relative directories: PKGSRCDIR/PKGPATH is
4798: used for directories that are pkgsrc-specific. WRKSRC is used for directories
4799: inside the package itself.
4800:
4801: PKGSRCDIR
4802:
4803: This is an absolute pathname that points to the pkgsrc root directory.
4804: Generally, you don't need it.
4805:
4806: PKGDIR
4807:
4808: This is an absolute pathname that points to the current package.
4809:
4810: PKGPATH
4811:
4812: This is a pathname relative to PKGSRCDIR that points to the current
4813: package.
4814:
4815: WRKDIR
4816:
4817: This is an absolute pathname pointing to the directory where all work takes
4818: place. The distfiles are extracted to this directory. It also contains
4819: temporary directories and log files used by the various pkgsrc frameworks,
4820: like buildlink or the wrappers.
4821:
4822: WRKSRC
4823:
4824: This is an absolute pathname pointing to the directory where the distfiles
4825: are extracted. It is usually a direct subdirectory of WRKDIR, and often
4826: it's the only directory entry that isn't hidden. This variable may be
4827: changed by a package Makefile.
4828:
1.14 jmcneill 4829: The CREATE_WRKDIR_SYMLINK definition takes either the value yes or no and
1.15 rillig 4830: defaults to no. It indicates whether a symbolic link to the WRKDIR is to be
1.14 jmcneill 4831: created in the pkgsrc entry's directory. If users would like to have their
4832: pkgsrc trees behave in a read-only manner, then the value of
4833: CREATE_WRKDIR_SYMLINK should be set to no.
4834:
1.154 rillig 4835: 19.4. Running a phase
1.1 dsieger 4836:
4837: You can run a particular phase by typing make phase, where phase is the name of
4838: the phase. This will automatically run all phases that are required for this
4839: phase. The default phase is build, that is, when you run make without
4840: parameters in a package directory, the package will be built, but not
4841: installed.
4842:
1.154 rillig 4843: 19.5. The fetch phase
1.1 dsieger 4844:
4845: The first step in building a package is to fetch the distribution files
1.25 wiz 4846: (distfiles) from the sites that are providing them. This is the task of the
1.1 dsieger 4847: fetch phase.
4848:
1.154 rillig 4849: 19.5.1. What to fetch and where to get it from
1.1 dsieger 4850:
4851: In simple cases, MASTER_SITES defines all URLs from where the distfile, whose
4852: name is derived from the DISTNAME variable, is fetched. The more complicated
4853: cases are described below.
4854:
4855: The variable DISTFILES specifies the list of distfiles that have to be fetched.
1.66 asau 4856: Its value defaults to ${DEFAULT_DISTFILES} and its value is ${DISTNAME}$
4857: {EXTRACT_SUFX}, so that most packages don't need to define it at all.
4858: EXTRACT_SUFX is .tar.gz by default, but can be changed freely. Note that if
4859: your package requires additional distfiles to the default one, you cannot just
4860: append the additional filenames using the += operator, but you have write for
4861: example:
1.1 dsieger 4862:
1.66 asau 4863: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 4864:
4865: Each distfile is fetched from a list of sites, usually MASTER_SITES. If the
4866: package has multiple DISTFILES or multiple PATCHFILES from different sites, you
4867: can set SITES.distfile to the list of URLs where the file distfile (including
4868: the suffix) can be found.
4869:
4870: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
4871: DISTFILES+= foo-file.tar.gz
4872: SITES.foo-file.tar.gz= \
4873: http://www.somewhere.com/somehow/ \
4874: http://www.somewhereelse.com/mirror/somehow/
4875:
4876: When actually fetching the distfiles, each item from MASTER_SITES or SITES.*
4877: gets the name of each distfile appended to it, without an intermediate slash.
4878: Therefore, all site values have to end with a slash or other separator
4879: character. This allows for example to set MASTER_SITES to a URL of a CGI script
4880: that gets the name of the distfile as a parameter. In this case, the definition
4881: would look like:
4882:
4883: MASTER_SITES= http://www.example.com/download.cgi?file=
4884:
1.23 jakllsch 4885: The exception to this rule are URLs starting with a dash. In that case the URL
4886: is taken as is, fetched and the result stored under the name of the distfile.
1.66 asau 4887: You can use this style for the case when the download URL style does not match
4888: the above common case. For example, if permanent download URL is a redirector
4889: to the real download URL, or the download file name is offered by an HTTP
4890: Content-Disposition header. In the following example, foo-1.0.0.tar.gz will be
4891: created instead of the default v1.0.0.tar.gz.
4892:
4893: DISTNAME= foo-1.0.0
4894: MASTER_SITES= -http://www.example.com/archive/v1.0.0.tar.gz
1.23 jakllsch 4895:
1.1 dsieger 4896: There are some predefined values for MASTER_SITES, which can be used in
4897: packages. The names of the variables should speak for themselves.
4898:
4899: ${MASTER_SITE_APACHE}
4900: ${MASTER_SITE_BACKUP}
4901: ${MASTER_SITE_CYGWIN}
4902: ${MASTER_SITE_DEBIAN}
4903: ${MASTER_SITE_FREEBSD}
4904: ${MASTER_SITE_FREEBSD_LOCAL}
4905: ${MASTER_SITE_GENTOO}
4906: ${MASTER_SITE_GNOME}
4907: ${MASTER_SITE_GNU}
4908: ${MASTER_SITE_GNUSTEP}
1.66 asau 4909: ${MASTER_SITE_HASKELL_HACKAGE}
1.1 dsieger 4910: ${MASTER_SITE_IFARCHIVE}
4911: ${MASTER_SITE_KDE}
4912: ${MASTER_SITE_MOZILLA}
1.66 asau 4913: ${MASTER_SITE_MOZILLA_ALL}
4914: ${MASTER_SITE_MOZILLA_ESR}
1.1 dsieger 4915: ${MASTER_SITE_MYSQL}
1.66 asau 4916: ${MASTER_SITE_NETLIB}
1.1 dsieger 4917: ${MASTER_SITE_OPENOFFICE}
1.98 ryoon 4918: ${MASTER_SITE_OSDN}
1.1 dsieger 4919: ${MASTER_SITE_PERL_CPAN}
4920: ${MASTER_SITE_PGSQL}
1.66 asau 4921: ${MASTER_SITE_RUBYGEMS}
1.1 dsieger 4922: ${MASTER_SITE_R_CRAN}
4923: ${MASTER_SITE_SOURCEFORGE}
4924: ${MASTER_SITE_SUNSITE}
4925: ${MASTER_SITE_SUSE}
4926: ${MASTER_SITE_TEX_CTAN}
4927: ${MASTER_SITE_XCONTRIB}
4928: ${MASTER_SITE_XEMACS}
1.66 asau 4929: ${MASTER_SITE_XORG}
1.1 dsieger 4930:
4931: Some explanations for the less self-explaining ones: MASTER_SITE_BACKUP
4932: contains backup sites for packages that are maintained in ftp://ftp.NetBSD.org/
1.27 wiz 4933: pub/pkgsrc/distfiles/${DIST_SUBDIR}. MASTER_SITE_LOCAL contains local package
1.26 spz 4934: source distributions that are maintained in ftp://ftp.NetBSD.org/pub/pkgsrc/
4935: distfiles/LOCAL_PORTS/.
1.1 dsieger 4936:
4937: If you choose one of these predefined sites, you may want to specify a
4938: subdirectory of that site. Since these macros may expand to more than one
4939: actual site, you must use the following construct to specify a subdirectory:
4940:
4941: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
4942: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
4943:
4944: Note the trailing slash after the subdirectory name.
4945:
1.154 rillig 4946: 19.5.2. How are the files fetched?
1.1 dsieger 4947:
4948: The fetch phase makes sure that all the distfiles exist in a local directory
4949: (DISTDIR, which can be set by the pkgsrc user). If the files do not exist, they
4950: are fetched using commands of the form
4951:
4952: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
4953:
4954: where ${site} varies through several possibilities in turn: first,
4955: MASTER_SITE_OVERRIDE is tried, then the sites specified in either SITES.file if
4956: defined, else MASTER_SITES or PATCH_SITES, as applies, then finally the value
4957: of MASTER_SITE_BACKUP. The order of all except the first and the last can be
4958: optionally sorted by the user, via setting either MASTER_SORT_RANDOM, and
4959: MASTER_SORT_AWK or MASTER_SORT_REGEX.
4960:
1.16 jnemeth 4961: The specific command and arguments used depend on the FETCH_USING parameter.
4962: The example above is for FETCH_USING=custom.
4963:
1.1 dsieger 4964: The distfiles mirror run by the NetBSD Foundation uses the mirror-distfiles
4965: target to mirror the distfiles, if they are freely distributable. Packages
4966: setting NO_SRC_ON_FTP (usually to "${RESTRICTED}") will not have their
4967: distfiles mirrored.
4968:
1.154 rillig 4969: 19.6. The checksum phase
1.1 dsieger 4970:
4971: After the distfile(s) are fetched, their checksum is generated and compared
4972: with the checksums stored in the distinfo file. If the checksums don't match,
4973: the build is aborted. This is to ensure the same distfile is used for building,
4974: and that the distfile wasn't changed, e.g. by some malign force, deliberately
4975: changed distfiles on the master distribution site or network lossage.
4976:
1.154 rillig 4977: 19.7. The extract phase
1.1 dsieger 4978:
4979: When the distfiles are present on the local system, they need to be extracted,
4980: as they usually come in the form of some compressed archive format.
4981:
4982: By default, all DISTFILES are extracted. If you only need some of them, you can
4983: set the EXTRACT_ONLY variable to the list of those files.
4984:
4985: Extracting the files is usually done by a little program, mk/extract/extract,
4986: which already knows how to extract various archive formats, so most likely you
4987: will not need to change anything here. But if you need, the following variables
4988: may help you:
4989:
4990: EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}
4991:
4992: Use these variables to override the default options for an extract command,
4993: which are defined in mk/extract/extract.
4994:
4995: EXTRACT_USING
4996:
1.14 jmcneill 4997: This variable can be set to bsdtar, gtar, nbtar (which is the default
4998: value), pax, or an absolute pathname pointing to the command with which tar
4999: archives should be extracted. It is preferred to choose bsdtar over gtar if
5000: NetBSD's pax-as-tar is not good enough.
1.1 dsieger 5001:
5002: If the extract program doesn't serve your needs, you can also override the
5003: EXTRACT_CMD variable, which holds the command used for extracting the files.
5004: This command is executed in the ${WRKSRC} directory. During execution of this
5005: command, the shell variable extract_file holds the absolute pathname of the
5006: file that is going to be extracted.
5007:
5008: And if that still does not suffice, you can override the do-extract target in
5009: the package Makefile.
5010:
1.154 rillig 5011: 19.8. The patch phase
1.1 dsieger 5012:
5013: After extraction, all the patches named by the PATCHFILES, those present in the
5014: patches subdirectory of the package as well as in $LOCALPATCHES/$PKGPATH (e.g.
5015: /usr/local/patches/graphics/png) are applied. Patchfiles ending in .Z or .gz
5016: are uncompressed before they are applied, files ending in .orig or .rej are
5017: ignored. Any special options to patch(1) can be handed in PATCH_DIST_ARGS. See
1.154 rillig 5018: Section 13.3, "patches/*" for more details.
1.1 dsieger 5019:
5020: By default patch(1) is given special args to make it fail if the patches apply
5021: with some lines of fuzz. Please fix (regen) the patches so that they apply
5022: cleanly. The rationale behind this is that patches that don't apply cleanly may
5023: end up being applied in the wrong place, and cause severe harm there.
5024:
1.154 rillig 5025: 19.9. The tools phase
1.1 dsieger 5026:
1.154 rillig 5027: This is covered in Chapter 20, Tools needed for building or running.
1.1 dsieger 5028:
1.154 rillig 5029: 19.10. The wrapper phase
1.1 dsieger 5030:
5031: This phase creates wrapper programs for the compilers and linkers. The
5032: following variables can be used to tweak the wrappers.
5033:
5034: ECHO_WRAPPER_MSG
5035:
5036: The command used to print progress messages. Does nothing by default. Set
5037: to ${ECHO} to see the progress messages.
5038:
5039: WRAPPER_DEBUG
5040:
5041: This variable can be set to yes (default) or no, depending on whether you
5042: want additional information in the wrapper log file.
5043:
5044: WRAPPER_UPDATE_CACHE
5045:
5046: This variable can be set to yes or no, depending on whether the wrapper
5047: should use its cache, which will improve the speed. The default value is
5048: yes, but is forced to no if the platform does not support it.
5049:
5050: WRAPPER_REORDER_CMDS
5051:
5052: A list of reordering commands. A reordering command has the form reorder:l:
5053: lib1:lib2. It ensures that that -llib1 occurs before -llib2.
5054:
5055: WRAPPER_TRANSFORM_CMDS
5056:
5057: A list of transformation commands. [TODO: investigate further]
5058:
1.154 rillig 5059: 19.11. The configure phase
1.1 dsieger 5060:
5061: Most pieces of software need information on the header files, system calls, and
5062: library routines which are available on the platform they run on. The process
5063: of determining this information is known as configuration, and is usually
5064: automated. In most cases, a script is supplied with the distfiles, and its
5065: invocation results in generation of header files, Makefiles, etc.
5066:
5067: If the package contains a configure script, this can be invoked by setting
5068: HAS_CONFIGURE to "yes". If the configure script is a GNU autoconf script, you
5069: should set GNU_CONFIGURE to "yes" instead. What happens in the configure phase
5070: is roughly:
5071:
5072: .for d in ${CONFIGURE_DIRS}
5073: cd ${WRKSRC} \
5074: && cd ${d} \
5075: && env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
5076: .endfor
5077:
5078: CONFIGURE_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In
5079: each of these directories, the configure script is run with the environment
5080: CONFIGURE_ENV and arguments CONFIGURE_ARGS. The variables CONFIGURE_ENV,
5081: CONFIGURE_SCRIPT (default: "./configure") and CONFIGURE_ARGS may all be changed
5082: by the package.
5083:
1.38 wiz 5084: If the program uses the Perl way of configuration (mainly Perl modules, but not
5085: only), i.e. a file called Makefile.PL, it should include ../../lang/perl5/
5086: module.mk. To set any parameter for Makefile.PL use the MAKE_PARAMS variable
5087: (e.g., MAKE_PARAMS+=foo=bar
5088:
1.1 dsieger 5089: If the program uses an Imakefile for configuration, the appropriate steps can
1.99 sevan 5090: be invoked by setting USE_IMAKE to "yes". If you only need xmkmf, add it to
5091: USE_TOOLS. You can add variables to xmkmf's environment by adding them to the
5092: SCRIPTS_ENV variable.
1.1 dsieger 5093:
1.11 rillig 5094: If the program uses cmake for configuration, the appropriate steps can be
5095: invoked by setting USE_CMAKE to "yes". You can add variables to cmake's
5096: environment by adding them to the CONFIGURE_ENV variable and arguments to cmake
5097: by adding them to the CMAKE_ARGS variable. The top directory argument is given
5098: by the CMAKE_ARG_PATH variable, that defaults to "." (relative to
5099: CONFIGURE_DIRS)
5100:
1.1 dsieger 5101: If there is no configure step at all, set NO_CONFIGURE to "yes".
5102:
1.154 rillig 5103: 19.12. The build phase
1.1 dsieger 5104:
5105: For building a package, a rough equivalent of the following code is executed.
5106:
5107: .for d in ${BUILD_DIRS}
5108: cd ${WRKSRC} \
5109: && cd ${d} \
5110: && env ${MAKE_ENV} \
5111: ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
5112: -f ${MAKE_FILE} \
5113: ${BUILD_TARGET}
5114: .endfor
5115:
5116: BUILD_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In each of
5117: these directories, MAKE_PROGRAM is run with the environment MAKE_ENV and
5118: arguments BUILD_MAKE_FLAGS. The variables MAKE_ENV, BUILD_MAKE_FLAGS, MAKE_FILE
5119: and BUILD_TARGET may all be changed by the package.
5120:
1.25 wiz 5121: The default value of MAKE_PROGRAM is "gmake" if USE_TOOLS contains "gmake", "
5122: make" otherwise. The default value of MAKE_FILE is "Makefile", and BUILD_TARGET
5123: defaults to "all".
1.1 dsieger 5124:
5125: If there is no build step at all, set NO_BUILD to "yes".
5126:
1.154 rillig 5127: 19.13. The test phase
1.1 dsieger 5128:
5129: [TODO]
5130:
1.154 rillig 5131: 19.14. The install phase
1.1 dsieger 5132:
5133: Once the build stage has completed, the final step is to install the software
5134: in public directories, so users can access the programs and files.
5135:
5136: In the install phase, a rough equivalent of the following code is executed.
5137: Additionally, before and after this code, much magic is performed to do
5138: consistency checks, registering the package, and so on.
5139:
5140: .for d in ${INSTALL_DIRS}
5141: cd ${WRKSRC} \
5142: && cd ${d} \
5143: && env ${MAKE_ENV} \
5144: ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
5145: -f ${MAKE_FILE} \
5146: ${INSTALL_TARGET}
5147: .endfor
5148:
5149: The variable's meanings are analogous to the ones in the build phase.
5150: INSTALL_DIRS defaults to BUILD_DIRS. INSTALL_TARGET is "install" by default,
5151: plus "install.man" if USE_IMAKE is defined and NO_INSTALL_MANPAGES is not
5152: defined.
5153:
5154: In the install phase, the following variables are useful. They are all
5155: variations of the install(1) command that have the owner, group and permissions
5156: preset. INSTALL is the plain install command. The specialized variants,
5157: together with their intended use, are:
5158:
5159: INSTALL_PROGRAM_DIR
5160:
5161: directories that contain binaries
5162:
5163: INSTALL_SCRIPT_DIR
5164:
5165: directories that contain scripts
5166:
5167: INSTALL_LIB_DIR
5168:
5169: directories that contain shared and static libraries
5170:
5171: INSTALL_DATA_DIR
5172:
5173: directories that contain data files
5174:
5175: INSTALL_MAN_DIR
5176:
5177: directories that contain man pages
5178:
1.100 leot 5179: INSTALL_GAME_DIR
5180:
5181: directories that contain data files for games
5182:
1.1 dsieger 5183: INSTALL_PROGRAM
5184:
5185: binaries that can be stripped from debugging symbols
5186:
5187: INSTALL_SCRIPT
5188:
5189: binaries that cannot be stripped
5190:
5191: INSTALL_GAME
5192:
5193: game binaries
5194:
5195: INSTALL_LIB
5196:
5197: shared and static libraries
5198:
5199: INSTALL_DATA
5200:
5201: data files
5202:
5203: INSTALL_GAME_DATA
5204:
5205: data files for games
5206:
5207: INSTALL_MAN
5208:
5209: man pages
5210:
5211: Some other variables are:
5212:
1.106 tnn 5213: INSTALL_UNSTRIPPED
5214:
5215: If set to yes, do not run strip(1) when installing binaries. Any debugging
5216: sections and symbols present in binaries will be preserved.
5217:
1.1 dsieger 5218: INSTALLATION_DIRS
5219:
5220: A list of directories relative to PREFIX that are created by pkgsrc at the
5221: beginning of the install phase. The package is supposed to create all
5222: needed directories itself before installing files to it and list all other
5223: directories here.
5224:
1.25 wiz 5225: In the rare cases that a package shouldn't install anything, set NO_INSTALL to
1.1 dsieger 5226: "yes". This is mostly relevant for packages in the regress category.
5227:
1.154 rillig 5228: 19.15. The package phase
1.1 dsieger 5229:
5230: Once the install stage has completed, a binary package of the installed files
5231: can be built. These binary packages can be used for quick installation without
5232: previous compilation, e.g. by the make bin-install or by using pkg_add.
5233:
5234: By default, the binary packages are created in ${PACKAGES}/All and symlinks are
5235: created in ${PACKAGES}/category, one for each category in the CATEGORIES
5236: variable. PACKAGES defaults to pkgsrc/packages.
5237:
1.154 rillig 5238: 19.16. Cleaning up
1.1 dsieger 5239:
5240: Once you're finished with a package, you can clean the work directory by
5241: running make clean. If you want to clean the work directories of all
5242: dependencies too, use make clean-depends.
5243:
1.154 rillig 5244: 19.17. Other helpful targets
1.1 dsieger 5245:
5246: pre/post-*
5247:
5248: For any of the main targets described in the previous section, two
5249: auxiliary targets exist with "pre-" and "post-" used as a prefix for the
5250: main target's name. These targets are invoked before and after the main
5251: target is called, allowing extra configuration or installation steps be
5252: performed from a package's Makefile, for example, which a program's
5253: configure script or install target omitted.
5254:
5255: do-*
5256:
5257: Should one of the main targets do the wrong thing, and should there be no
5258: variable to fix this, you can redefine it with the do-* target. (Note that
5259: redefining the target itself instead of the do-* target is a bad idea, as
5260: the pre-* and post-* targets won't be called anymore, etc.) You will not
5261: usually need to do this.
5262:
5263: reinstall
5264:
5265: If you did a make install and you noticed some file was not installed
5266: properly, you can repeat the installation with this target, which will
5267: ignore the "already installed" flag.
5268:
5269: This is the default value of DEPENDS_TARGET except in the case of make
5270: update and make package, where the defaults are "package" and "update",
5271: respectively.
5272:
5273: deinstall
5274:
5275: This target does a pkg_delete(1) in the current directory, effectively
5276: de-installing the package. The following variables can be used to tune the
5277: behaviour:
5278:
5279: PKG_VERBOSE
5280:
5281: Add a "-v" to the pkg_delete(1) command.
5282:
5283: DEINSTALLDEPENDS
5284:
5285: Remove all packages that require (depend on) the given package. This
5286: can be used to remove any packages that may have been pulled in by a
5287: given package, e.g. if make deinstall DEINSTALLDEPENDS=1 is done in
1.25 wiz 5288: pkgsrc/x11/kde, this is likely to remove whole KDE. Works by adding "-R
5289: " to the pkg_delete(1) command line.
1.1 dsieger 5290:
5291: bin-install
5292:
5293: Install a binary package from local disk and via FTP from a list of sites
5294: (see the BINPKG_SITES variable), and do a make package if no binary package
5295: is available anywhere. The arguments given to pkg_add can be set via
5296: BIN_INSTALL_FLAGS e.g., to do verbose operation, etc.
5297:
1.95 wiz 5298: install-clean
5299:
5300: This target removes the state files for the "install" and later phases so
5301: that the "install" target may be re-invoked. This can be used after editing
5302: the PLIST to install the package without rebuilding it.
5303:
5304: build-clean
5305:
5306: This target removes the state files for the "build" and later phases so
5307: that the "build" target may be re-invoked.
5308:
1.1 dsieger 5309: update
5310:
5311: This target causes the current package to be updated to the latest version.
5312: The package and all depending packages first get de-installed, then current
5313: versions of the corresponding packages get compiled and installed. This is
5314: similar to manually noting which packages are currently installed, then
5315: performing a series of make deinstall and make install (or whatever
5316: UPDATE_TARGET is set to) for these packages.
5317:
5318: You can use the "update" target to resume package updating in case a
5319: previous make update was interrupted for some reason. However, in this
5320: case, make sure you don't call make clean or otherwise remove the list of
5321: dependent packages in WRKDIR. Otherwise, you lose the ability to
5322: automatically update the current package along with the dependent packages
5323: you have installed.
5324:
5325: Resuming an interrupted make update will only work as long as the package
5326: tree remains unchanged. If the source code for one of the packages to be
5327: updated has been changed, resuming make update will most certainly fail!
5328:
1.4 rillig 5329: The following variables can be used either on the command line or in
1.1 dsieger 5330: mk.conf to alter the behaviour of make update:
5331:
5332: UPDATE_TARGET
5333:
5334: Install target to recursively use for the updated package and the
5335: dependent packages. Defaults to DEPENDS_TARGET if set, "install"
1.25 wiz 5336: otherwise for make update. Other good targets are "package" or "
5337: bin-install". Do not set this to "update" or you will get stuck in an
1.1 dsieger 5338: endless loop!
5339:
5340: NOCLEAN
5341:
5342: Don't clean up after updating. Useful if you want to leave the work
5343: sources of the updated packages around for inspection or other
1.25 wiz 5344: purposes. Be sure you eventually clean up the source tree (see the "
5345: clean-update" target below) or you may run into troubles with old
1.1 dsieger 5346: source code still lying around on your next make or make update.
5347:
5348: REINSTALL
5349:
5350: Deinstall each package before installing (making DEPENDS_TARGET). This
5351: may be necessary if the "clean-update" target (see below) was called
5352: after interrupting a running make update.
5353:
5354: DEPENDS_TARGET
5355:
5356: Allows you to disable recursion and hardcode the target for packages.
5357: The default is "update" for the update target, facilitating a recursive
5358: update of prerequisite packages. Only set DEPENDS_TARGET if you want to
5359: disable recursive updates. Use UPDATE_TARGET instead to just set a
5360: specific target for each package to be installed during make update
5361: (see above).
5362:
5363: clean-update
5364:
5365: Clean the source tree for all packages that would get updated if make
5366: update was called from the current directory. This target should not be
5367: used if the current package (or any of its depending packages) have already
5368: been de-installed (e.g., after calling make update) or you may lose some
1.25 wiz 5369: packages you intended to update. As a rule of thumb: only use this target
1.1 dsieger 5370: before the first time you run make update and only if you have a dirty
5371: package tree (e.g., if you used NOCLEAN).
5372:
5373: If you are unsure about whether your tree is clean, you can either perform
5374: a make clean at the top of the tree, or use the following sequence of
5375: commands from the directory of the package you want to update (before
5376: running make update for the first time, otherwise you lose all the packages
5377: you wanted to update!):
5378:
5379: # make clean-update
5380: # make clean CLEANDEPENDS=YES
5381: # make update
5382:
5383:
1.4 rillig 5384: The following variables can be used either on the command line or in
1.1 dsieger 5385: mk.conf to alter the behaviour of make clean-update:
5386:
5387: CLEAR_DIRLIST
5388:
5389: After make clean, do not reconstruct the list of directories to update
5390: for this package. Only use this if make update successfully installed
5391: all packages you wanted to update. Normally, this is done automatically
5392: on make update, but may have been suppressed by the NOCLEAN variable
5393: (see above).
5394:
5395: replace
5396:
5397: Update the installation of the current package. This differs from update in
5398: that it does not replace dependent packages. You will need to install
5399: pkgtools/pkg_tarup for this target to work.
5400:
5401: Be careful when using this target! There are no guarantees that dependent
5402: packages will still work, in particular they will most certainly break if
5403: you make replace a library package whose shared library major version
5404: changed between your installed version and the new one. For this reason,
5405: this target is not officially supported and only recommended for advanced
5406: users.
5407:
5408: info
5409:
5410: This target invokes pkg_info(1) for the current package. You can use this
5411: to check which version of a package is installed.
5412:
5413: index
5414:
5415: This is a top-level command, i.e. it should be used in the pkgsrc
5416: directory. It creates a database of all packages in the local pkgsrc tree,
5417: including dependencies, comment, maintainer, and some other useful
5418: information. Individual entries are created by running make describe in the
5419: packages' directories. This index file is saved as pkgsrc/INDEX. It can be
5420: displayed in verbose format by running make print-index. You can search in
5421: it with make search key=something. You can extract a list of all packages
5422: that depend on a particular one by running make show-deps PKG=somepackage.
5423:
5424: Running this command takes a very long time, some hours even on fast
5425: machines!
5426:
5427: readme
5428:
5429: This target generates a README.html file, which can be viewed using a
5430: browser such as www/firefox or www/links. The generated files contain
5431: references to any packages which are in the PACKAGES directory on the local
5432: host. The generated files can be made to refer to URLs based on
5433: FTP_PKG_URL_HOST and FTP_PKG_URL_DIR. For example, if I wanted to generate
5434: README.html files which pointed to binary packages on the local machine, in
5435: the directory /usr/packages, set FTP_PKG_URL_HOST=file://localhost and
5436: FTP_PKG_URL_DIR=/usr/packages. The ${PACKAGES} directory and its
5437: subdirectories will be searched for all the binary packages.
5438:
5439: The target can be run at the toplevel or in category directories, in which
5440: case it descends recursively.
5441:
5442: readme-all
5443:
5444: This is a top-level command, run it in pkgsrc. Use this target to create a
5445: file README-all.html which contains a list of all packages currently
5446: available in the NetBSD Packages Collection, together with the category
5447: they belong to and a short description. This file is compiled from the
5448: pkgsrc/*/README.html files, so be sure to run this after a make readme.
5449:
5450: cdrom-readme
5451:
5452: This is very much the same as the "readme" target (see above), but is to be
5453: used when generating a pkgsrc tree to be written to a CD-ROM. This target
5454: also produces README.html files, and can be made to refer to URLs based on
5455: CDROM_PKG_URL_HOST and CDROM_PKG_URL_DIR.
5456:
5457: show-distfiles
5458:
5459: This target shows which distfiles and patchfiles are needed to build the
5460: package (ALLFILES, which contains all DISTFILES and PATCHFILES, but not
5461: patches/*).
5462:
5463: show-downlevel
5464:
5465: This target shows nothing if the package is not installed. If a version of
5466: this package is installed, but is not the version provided in this version
5467: of pkgsrc, then a warning message is displayed. This target can be used to
5468: show which of your installed packages are downlevel, and so the old
5469: versions can be deleted, and the current ones added.
5470:
5471: show-pkgsrc-dir
5472:
5473: This target shows the directory in the pkgsrc hierarchy from which the
5474: package can be built and installed. This may not be the same directory as
5475: the one from which the package was installed. This target is intended to be
5476: used by people who may wish to upgrade many packages on a single host, and
1.25 wiz 5477: can be invoked from the top-level pkgsrc Makefile by using the "
5478: show-host-specific-pkgs" target.
1.1 dsieger 5479:
5480: show-installed-depends
5481:
5482: This target shows which installed packages match the current package's
5483: DEPENDS. Useful if out of date dependencies are causing build problems.
5484:
1.95 wiz 5485: print-build-depends-list
5486:
5487: This target shows the list of packages that the current package depends on
5488: for building.
5489:
5490: print-run-depends-list
5491:
5492: This target shows the list of packages that the current package depends on
5493: for running.
5494:
1.1 dsieger 5495: check-shlibs
5496:
5497: After a package is installed, check all its binaries and (on ELF platforms)
5498: shared libraries to see if they find the shared libs they need. Run by
1.4 rillig 5499: default if PKG_DEVELOPER is set in mk.conf.
1.1 dsieger 5500:
5501: print-PLIST
5502:
5503: After a "make install" from a new or upgraded pkg, this prints out an
5504: attempt to generate a new PLIST from a find -newer work/.extract_done. An
5505: attempt is made to care for shared libs etc., but it is strongly
5506: recommended to review the result before putting it into PLIST. On upgrades,
5507: it's useful to diff the output of this command against an already existing
5508: PLIST file.
5509:
5510: If the package installs files via tar(1) or other methods that don't update
5511: file access times, be sure to add these files manually to your PLIST, as
5512: the "find -newer" command used by this target won't catch them!
5513:
1.154 rillig 5514: See Section 15.3, "Tweaking output of make print-PLIST" for more
1.1 dsieger 5515: information on this target.
5516:
5517: bulk-package
5518:
5519: Used to do bulk builds. If an appropriate binary package already exists, no
5520: action is taken. If not, this target will compile, install and package it
1.154 rillig 5521: (and its depends, if PKG_DEPENDS is set properly. See Chapter 8, Creating
1.66 asau 5522: binary packages for everything in pkgsrc (bulk builds)). After creating the
5523: binary package, the sources, the just-installed package and its required
5524: packages are removed, preserving free disk space.
1.1 dsieger 5525:
5526: Beware that this target may deinstall all packages installed on a system!
5527:
5528: bulk-install
5529:
5530: Used during bulk-installs to install required packages. If an up-to-date
1.25 wiz 5531: binary package is available, it will be installed via pkg_add(1). If not,
1.1 dsieger 5532: make bulk-package will be executed, but the installed binary won't be
5533: removed.
5534:
5535: A binary package is considered "up-to-date" to be installed via pkg_add(1)
5536: if:
5537:
1.42 asau 5538: + None of the package's files (Makefile, ...) were modified since it was
1.1 dsieger 5539: built.
5540:
1.42 asau 5541: + None of the package's required (binary) packages were modified since it
1.1 dsieger 5542: was built.
5543:
5544: Beware that this target may deinstall all packages installed on a system!
5545:
1.154 rillig 5546: Chapter 20. Tools needed for building or running
1.1 dsieger 5547:
5548: Table of Contents
5549:
1.154 rillig 5550: 20.1. Tools for pkgsrc builds
5551: 20.2. Tools needed by packages
5552: 20.3. Tools provided by platforms
1.1 dsieger 5553:
5554: The USE_TOOLS definition is used both internally by pkgsrc and also for
5555: individual packages to define what commands are needed for building a package
5556: (like BUILD_DEPENDS) or for later run-time of an installed packaged (such as
5557: DEPENDS). If the native system provides an adequate tool, then in many cases, a
5558: pkgsrc package will not be used.
5559:
5560: When building a package, the replacement tools are made available in a
5561: directory (as symlinks or wrapper scripts) that is early in the executable
5562: search path. Just like the buildlink system, this helps with consistent builds.
5563:
5564: A tool may be needed to help build a specific package. For example, perl, GNU
5565: make (gmake) or yacc may be needed.
5566:
5567: Also a tool may be needed, for example, because the native system's supplied
5568: tool may be inefficient for building a package with pkgsrc. For example, a
5569: package may need GNU awk, bison (instead of yacc) or a better sed.
5570:
5571: The tools used by a package can be listed by running make show-tools.
5572:
1.154 rillig 5573: 20.1. Tools for pkgsrc builds
1.1 dsieger 5574:
5575: The default set of tools used by pkgsrc is defined in bsd.pkg.mk. This includes
5576: standard Unix tools, such as: cat, awk, chmod, test, and so on. These can be
5577: seen by running: make show-var VARNAME=USE_TOOLS.
5578:
5579: If a package needs a specific program to build then the USE_TOOLS variable can
5580: be used to define the tools needed.
5581:
1.154 rillig 5582: 20.2. Tools needed by packages
1.1 dsieger 5583:
1.29 wiz 5584: In the following examples, the :run means that it is needed at run-time (and
5585: becomes a DEPENDS). The default is a build dependency which can be set with
5586: :build. (So in this example, it is the same as gmake:build and
5587: pkg-config:build.)
1.1 dsieger 5588:
5589: USE_TOOLS+= gmake perl:run pkg-config
5590:
5591: When using the tools framework, a TOOLS_PATH.foo variable is defined which
5592: contains the full path to the appropriate tool. For example, TOOLS_PATH.bash
5593: could be "/bin/bash" on Linux systems.
5594:
5595: If you always need a pkgsrc version of the tool at run-time, then just use
5596: DEPENDS instead.
5597:
1.154 rillig 5598: 20.3. Tools provided by platforms
1.1 dsieger 5599:
5600: When improving or porting pkgsrc to a new platform, have a look at (or create)
5601: the corresponding platform specific make file fragment under pkgsrc/mk/tools/
5602: tools.${OPSYS}.mk which defines the name of the common tools. For example:
5603:
5604: .if exists(/usr/bin/bzcat)
5605: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
5606: .elif exists(/usr/bin/bzip2)
5607: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
5608: .endif
5609:
5610: TOOLS_PLATFORM.true?= true # shell builtin
5611:
1.154 rillig 5612: Chapter 21. Making your package work
1.1 dsieger 5613:
5614: Table of Contents
5615:
1.154 rillig 5616: 21.1. General operation
1.1 dsieger 5617:
1.154 rillig 5618: 21.1.1. How to pull in user-settable variables from mk.conf
5619: 21.1.2. User interaction
5620: 21.1.3. Handling licenses
5621: 21.1.4. Restricted packages
5622: 21.1.5. Handling dependencies
5623: 21.1.6. Handling conflicts with other packages
5624: 21.1.7. Packages that cannot or should not be built
5625: 21.1.8. Packages which should not be deleted, once installed
5626: 21.1.9. Handling packages with security problems
5627: 21.1.10. How to handle incrementing versions when fixing an existing
1.1 dsieger 5628: package
1.154 rillig 5629: 21.1.11. Substituting variable text in the package files (the SUBST
1.1 dsieger 5630: framework)
5631:
1.154 rillig 5632: 21.2. The fetch phase
1.1 dsieger 5633:
1.154 rillig 5634: 21.2.1. Packages whose distfiles aren't available for plain downloading
5635: 21.2.2. How to handle modified distfiles with the 'old' name
5636: 21.2.3. Packages hosted on github.com
5637:
5638: 21.3. The configure phase
5639:
5640: 21.3.1. Shared libraries - libtool
5641: 21.3.2. Using libtool on GNU packages that already support libtool
5642: 21.3.3. GNU Autoconf/Automake
5643:
5644: 21.4. Programming languages
5645:
5646: 21.4.1. C, C++, and Fortran
5647: 21.4.2. Java
5648: 21.4.3. Packages containing perl scripts
5649: 21.4.4. Packages containing shell scripts
5650: 21.4.5. Other programming languages
5651:
5652: 21.5. The build phase
5653:
5654: 21.5.1. Compiling C and C++ code conditionally
5655: 21.5.2. How to handle compiler bugs
5656: 21.5.3. Undefined reference to "..."
5657: 21.5.4. Running out of memory
5658:
5659: 21.6. The install phase
5660:
5661: 21.6.1. Creating needed directories
5662: 21.6.2. Where to install documentation
5663: 21.6.3. Installing highscore files
5664: 21.6.4. Adding DESTDIR support to packages
5665: 21.6.5. Packages with hardcoded paths to other interpreters
5666: 21.6.6. Packages installing perl modules
5667: 21.6.7. Packages installing info files
5668: 21.6.8. Packages installing man pages
5669: 21.6.9. Packages installing GConf data files
5670: 21.6.10. Packages installing scrollkeeper/rarian data files
5671: 21.6.11. Packages installing X11 fonts
5672: 21.6.12. Packages installing GTK2 modules
5673: 21.6.13. Packages installing SGML or XML data
5674: 21.6.14. Packages installing extensions to the MIME database
5675: 21.6.15. Packages using intltool
5676: 21.6.16. Packages installing startup scripts
5677: 21.6.17. Packages installing TeX modules
5678: 21.6.18. Packages supporting running binaries in emulation
5679: 21.6.19. Packages installing hicolor theme icons
5680: 21.6.20. Packages installing desktop files
1.1 dsieger 5681:
1.154 rillig 5682: 21.7. Marking packages as having problems
1.1 dsieger 5683:
1.154 rillig 5684: 21.1. General operation
1.1 dsieger 5685:
5686: One appealing feature of pkgsrc is that it runs on many different platforms. As
5687: a result, it is important to ensure, where possible, that packages in pkgsrc
5688: are portable. This chapter mentions some particular details you should pay
5689: attention to while working on pkgsrc.
5690:
1.154 rillig 5691: 21.1.1. How to pull in user-settable variables from mk.conf
1.1 dsieger 5692:
5693: The pkgsrc user can configure pkgsrc by overriding several variables in the
1.4 rillig 5694: file pointed to by MAKECONF, which is mk.conf by default. When you want to use
5695: those variables in the preprocessor directives of make(1) (for example .if or
5696: .for), you need to include the file ../../mk/bsd.prefs.mk before, which in turn
5697: loads the user preferences.
1.1 dsieger 5698:
5699: But note that some variables may not be completely defined after ../../mk/
5700: bsd.prefs.mk has been included, as they may contain references to variables
1.108 rillig 5701: that are not yet defined. In shell commands (the lines in Makefile that are
5702: indented with a tab) this is no problem, since variables are only expanded when
5703: they are used. But in the preprocessor directives mentioned above and in
5704: dependency lines (of the form target: dependencies) the variables are expanded
5705: at load time.
1.1 dsieger 5706:
5707: Note
5708:
1.108 rillig 5709: To check whether a variable can be used at load time, run pkglint -Wall on your
5710: package.
1.1 dsieger 5711:
1.154 rillig 5712: 21.1.2. User interaction
1.1 dsieger 5713:
5714: Occasionally, packages require interaction from the user, and this can be in a
5715: number of ways:
5716:
5717: * When fetching the distfiles, some packages require user interaction such as
5718: entering username/password or accepting a license on a web page.
5719:
5720: * When extracting the distfiles, some packages may ask for passwords.
5721:
5722: * help to configure the package before it is built
5723:
5724: * help during the build process
5725:
5726: * help during the installation of a package
5727:
1.108 rillig 5728: A package can set the INTERACTIVE_STAGE variable to define which stages need
5729: interaction. This should be done in the package's Makefile, e.g.:
1.1 dsieger 5730:
5731: INTERACTIVE_STAGE= configure install
5732:
5733: The user can then decide to skip this package by setting the BATCH variable.
1.108 rillig 5734: Packages that require interaction are also excluded from bulk builds.
1.1 dsieger 5735:
1.154 rillig 5736: 21.1.3. Handling licenses
1.1 dsieger 5737:
5738: Authors of software can choose the licence under which software can be copied.
1.111 sevan 5739: The Free Software Foundation has declared some licenses "Free", and the Open
5740: Source Initiative has a definition of "Open Source".
5741:
5742: By default, pkgsrc allows packages with Free or Open Source licenses to be
5743: built. To allow packages with other licenses to be built as well, the pkgsrc
5744: user needs to add these licenses to the ACCEPTABLE_LICENSES variable in mk.conf
5745: . Note that this variable only affects which packages may be built, while the
5746: license terms often also restrict the actual use of the package and its
5747: redistribution.
1.1 dsieger 5748:
5749: One might want to only install packages with a BSD license, or the GPL, and not
1.20 jnemeth 5750: the other. The free licenses are added to the default ACCEPTABLE_LICENSES
1.111 sevan 5751: variable. The pkgsrc user can override the default by setting the
5752: ACCEPTABLE_LICENSES variable with "=" instead of "+=". The licenses accepted by
5753: default are defined in the DEFAULT_ACCEPTABLE_LICENSES variable in the file
5754: pkgsrc/mk/license.mk.
1.1 dsieger 5755:
5756: The license tag mechanism is intended to address copyright-related issues
5757: surrounding building, installing and using a package, and not to address
1.20 jnemeth 5758: redistribution issues (see RESTRICTED and NO_SRC_ON_FTP, etc.). Packages with
5759: redistribution restrictions should set these tags.
1.1 dsieger 5760:
5761: Denoting that a package may be copied according to a particular license is done
5762: by placing the license in pkgsrc/licenses and setting the LICENSE variable to a
5763: string identifying the license, e.g. in graphics/xv:
5764:
5765: LICENSE= xv-license
5766:
5767: When trying to build, the user will get a notice that the package is covered by
5768: a license which has not been placed in the ACCEPTABLE_LICENSES variable:
5769:
5770: % make
5771: ===> xv-3.10anb9 has an unacceptable license: xv-license.
5772: ===> To view the license, enter "/usr/bin/make show-license".
5773: ===> To indicate acceptance, add this line to your /etc/mk.conf:
5774: ===> ACCEPTABLE_LICENSES+=xv-license
5775: *** Error code 1
5776:
5777: The license can be viewed with make show-license, and if the user so chooses,
1.4 rillig 5778: the line printed above can be added to mk.conf to convey to pkgsrc that it
1.1 dsieger 5779: should not in the future fail because of that license:
5780:
5781: ACCEPTABLE_LICENSES+=xv-license
5782:
1.111 sevan 5783: The use of LICENSE=shareware, LICENSE=no-commercial-use, and similar language
5784: is deprecated because it does not crisply refer to a particular license text.
5785: Another problem with such usage is that it does not enable a user to tell
5786: pkgsrc to proceed for a single package without also telling pkgsrc to proceed
5787: for all packages with that tag.
5788:
1.154 rillig 5789: 21.1.3.1. Adding a package with a new license
1.1 dsieger 5790:
1.49 rodent 5791: When adding a package with a new license, the following steps are required:
5792:
1.111 sevan 5793: 1. Check whether the license qualifies as Free or Open Source by referencing
5794: Various Licenses and Comments about Them and Licenses by Name | Open Source
5795: Initiative. If this is the case, the filename in pkgsrc/licenses/ does not
5796: need the -license suffix, and the license name should be added to:
1.49 rodent 5797:
5798: + DEFAULT_ACCEPTABLE_LICENSES in pkgsrc/mk/license.mk
5799:
5800: + default_acceptable_licenses in pkgsrc/pkgtools/pkg_install/files/lib/
5801: license.c
5802:
5803: 2. The license text should be added to pkgsrc/licenses for displaying. A list
5804: of known licenses can be seen in this directory.
1.1 dsieger 5805:
1.154 rillig 5806: 21.1.3.2. Change to the license
1.1 dsieger 5807:
1.111 sevan 5808: When the license changes (in a way other than formatting), make sure that the
5809: new license has a different name (e.g., append the version number if it exists,
5810: or the date). Just because a user told pkgsrc to build programs under a
5811: previous version of a license does not mean that pkgsrc should build programs
5812: under the new licenses. The higher-level point is that pkgsrc does not evaluate
5813: licenses for reasonableness; the only test is a mechanistic test of whether a
5814: particular text has been approved by either of two bodies (FSF or OSI).
1.1 dsieger 5815:
1.154 rillig 5816: 21.1.4. Restricted packages
1.1 dsieger 5817:
1.111 sevan 5818: Some licenses restrict how software may be re-distributed. By declaring the
5819: restrictions, package tools can automatically refrain from e.g. placing binary
5820: packages on FTP sites.
5821:
5822: There are four possible restrictions, which are the cross product of sources
5823: (distfiles) and binaries not being placed on FTP sites and CD-ROMs. Because
5824: this is rarely the exact language in any license, and because non-Free licenses
5825: tend to be different from each other, pkgsrc adopts a definition of FTP and
5826: CD-ROM. "FTP" means making the source or binary file available over the
5827: Internet at no charge. "CD-ROM" means making the source or binary available on
5828: some kind of media, together with other source and binary packages, which is
5829: sold for a distribution charge.
1.1 dsieger 5830:
5831: In order to encode these restrictions, the package system defines five make
5832: variables that can be set to note these restrictions:
5833:
5834: * RESTRICTED
5835:
5836: This variable should be set whenever a restriction exists (regardless of
5837: its kind). Set this variable to a string containing the reason for the
5838: restriction. It should be understood that those wanting to understand the
5839: restriction will have to read the license, and perhaps seek advice of
5840: counsel.
5841:
5842: * NO_BIN_ON_CDROM
5843:
5844: Binaries may not be placed on CD-ROM containing other binary packages, for
5845: which a distribution charge may be made. In this case, set this variable to
5846: ${RESTRICTED}.
5847:
5848: * NO_BIN_ON_FTP
5849:
5850: Binaries may not made available on the Internet without charge. In this
5851: case, set this variable to ${RESTRICTED}. If this variable is set, binary
5852: packages will not be included on ftp.NetBSD.org.
5853:
5854: * NO_SRC_ON_CDROM
5855:
5856: Distfiles may not be placed on CD-ROM, together with other distfiles, for
5857: which a fee may be charged. In this case, set this variable to $
5858: {RESTRICTED}.
5859:
5860: * NO_SRC_ON_FTP
5861:
5862: Distfiles may not made available via FTP at no charge. In this case, set
5863: this variable to ${RESTRICTED}. If this variable is set, the distfile(s)
5864: will not be mirrored on ftp.NetBSD.org.
5865:
1.111 sevan 5866: Please note that packages will be removed from pkgsrc when the distfiles are
1.33 wiz 5867: not distributable and cannot be obtained for a period of one full quarter
1.111 sevan 5868: branch. Packages with manual/interactive fetch must have a maintainer and it is
5869: his/her responsibility to ensure this.
1.33 wiz 5870:
1.154 rillig 5871: 21.1.5. Handling dependencies
1.1 dsieger 5872:
5873: Your package may depend on some other package being present - and there are
5874: various ways of expressing this dependency. pkgsrc supports the BUILD_DEPENDS
5875: and DEPENDS definitions, the USE_TOOLS definition, as well as dependencies via
5876: buildlink3.mk, which is the preferred way to handle dependencies, and which
1.154 rillig 5877: uses the variables named above. See Chapter 16, Buildlink methodology for more
1.1 dsieger 5878: information.
5879:
5880: The basic difference between the two variables is as follows: The DEPENDS
5881: definition registers that pre-requisite in the binary package so it will be
5882: pulled in when the binary package is later installed, whilst the BUILD_DEPENDS
5883: definition does not, marking a dependency that is only needed for building the
5884: package.
5885:
5886: This means that if you only need a package present whilst you are building, it
5887: should be noted as a BUILD_DEPENDS.
5888:
5889: The format for a BUILD_DEPENDS and a DEPENDS definition is:
5890:
5891: <pre-req-package-name>:../../<category>/<pre-req-package>
5892:
5893: Please note that the "pre-req-package-name" may include any of the wildcard
5894: version numbers recognized by pkg_info(1).
5895:
1.55 wiz 5896: 1. If your package needs another package's binaries or libraries to build and
1.1 dsieger 5897: run, and if that package has a buildlink3.mk file available, use it:
5898:
5899: .include "../../graphics/jpeg/buildlink3.mk"
5900:
1.55 wiz 5901: 2. If your package needs another package's binaries or libraries only for
5902: building, and if that package has a buildlink3.mk file available, use it:
5903:
5904: .include "../../graphics/jpeg/buildlink3.mk"
5905:
5906: but set BUILDLINK_DEPMETHOD.jpeg?=build to make it a build dependency only.
5907: This case is rather rare.
5908:
5909: 3. If your package needs binaries from another package to build, use the
1.26 spz 5910: BUILD_DEPENDS definition:
1.1 dsieger 5911:
1.147 tnn 5912: BUILD_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.1 dsieger 5913:
1.55 wiz 5914: 4. If your package needs a library with which to link and there is no
1.26 spz 5915: buildlink3.mk file available, create one. Using DEPENDS won't be sufficient
5916: because the include files and libraries will be hidden from the compiler.
1.1 dsieger 5917:
1.55 wiz 5918: 5. If your package needs some executable to be able to run correctly and if
1.26 spz 5919: there's no buildlink3.mk file, this is specified using the DEPENDS
5920: variable. The print/lyx package needs to be able to execute the latex
1.129 wiz 5921: binary from the tex-latex-bin package when it runs, and that is specified:
1.1 dsieger 5922:
1.129 wiz 5923: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.1 dsieger 5924:
1.55 wiz 5925: 6. You can use wildcards in package dependencies. Note that such wildcard
1.26 spz 5926: dependencies are retained when creating binary packages. The dependency is
5927: checked when installing the binary package and any package which matches
5928: the pattern will be used. Wildcard dependencies should be used with care.
1.1 dsieger 5929:
5930: The "-[0-9]*" should be used instead of "-*" to avoid potentially ambiguous
5931: matches such as "tk-postgresql" matching a "tk-*" DEPENDS.
5932:
5933: Wildcards can also be used to specify that a package will only build
5934: against a certain minimum version of a pre-requisite:
5935:
1.26 spz 5936: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.1 dsieger 5937:
1.26 spz 5938: This means that the package will build using version 6.0 of ImageMagick or
5939: newer. Such a dependency may be warranted if, for example, the command line
5940: options of an executable have changed.
5941:
5942: If you need to depend on minimum versions of libraries, see the buildlink
5943: section of the pkgsrc guide.
1.1 dsieger 5944:
5945: For security fixes, please update the package vulnerabilities file. See
1.154 rillig 5946: Section 21.1.9, "Handling packages with security problems" for more
1.1 dsieger 5947: information.
5948:
5949: If your package needs files from another package to build, add the relevant
5950: distribution files to DISTFILES, so they will be extracted automatically. See
5951: the print/ghostscript package for an example. (It relies on the jpeg sources
5952: being present in source form during the build.)
5953:
1.154 rillig 5954: 21.1.6. Handling conflicts with other packages
1.1 dsieger 5955:
5956: Your package may conflict with other packages a user might already have
5957: installed on his system, e.g. if your package installs the same set of files as
1.80 wiz 5958: another package in the pkgsrc tree or has the same PKGNAME.
1.1 dsieger 5959:
1.142 leot 5960: For example, x11/libXaw3d and x11/Xaw-Xpm install the same shared library, thus
5961: you set in pkgsrc/x11/libXaw3d/Makefile:
1.1 dsieger 5962:
1.142 leot 5963: CONFLICTS= Xaw-Xpm-[0-9]*
1.1 dsieger 5964:
5965:
1.142 leot 5966: and in pkgsrc/x11/Xaw-Xpm/Makefile:
1.1 dsieger 5967:
1.142 leot 5968: CONFLICTS= libXaw3d-[0-9]*
1.1 dsieger 5969:
1.142 leot 5970:
5971: pkg_add(1) is able to detect attempts to install packages that conflict with
5972: existing packages and abort. However, in many situations this is too late in
5973: the process. Binary package managers will not know about the conflict until
5974: they attempt to install the package after already downloading it and all its
5975: dependencies. Users may also waste time building a package and its dependencies
5976: only to find out at the end that it conflicts with another package they have
5977: installed.
5978:
5979: To avoid these issues CONFLICTS entries should be added in all cases where it
5980: is known that packages conflict with each other. These CONFLICTS entries are
5981: exported in pkg_summary(5) files and consumed by binary package managers to
5982: inform users that packages cannot be installed onto the target system.
1.1 dsieger 5983:
1.154 rillig 5984: 21.1.7. Packages that cannot or should not be built
1.1 dsieger 5985:
5986: There are several reasons why a package might be instructed to not build under
5987: certain circumstances. If the package builds and runs on most platforms, the
1.83 dholland 5988: exceptions should be noted with BROKEN_ON_PLATFORM. If the package builds and
5989: runs on a small handful of platforms, set BROKEN_EXCEPT_ON_PLATFORM instead.
5990: Both BROKEN_ON_PLATFORM and BROKEN_EXCEPT_ON_PLATFORM are OS triples
5991: (OS-version-platform) that can use glob-style wildcards.
5992:
1.114 maya 5993: If a package is not appropriate for some platforms (as opposed to merely
1.83 dholland 5994: broken), a different set of variables should be used as this affects failure
5995: reporting and statistics. If the package is appropriate for most platforms, the
5996: exceptions should be noted with NOT_FOR_PLATFORM. If the package is appropriate
5997: for only a small handful of platforms (often exactly one), set
5998: ONLY_FOR_PLATFORM instead. Both ONLY_FOR_PLATFORM and NOT_FOR_PLATFORM are OS
5999: triples (OS-version-platform) that can use glob-style wildcards.
1.1 dsieger 6000:
6001: Some packages are tightly bound to a specific version of an operating system,
6002: e.g. LKMs or sysutils/lsof. Such binary packages are not backwards compatible
6003: with other versions of the OS, and should be uploaded to a version specific
6004: directory on the FTP server. Mark these packages by setting OSVERSION_SPECIFIC
6005: to "yes". This variable is not currently used by any of the package system
6006: internals, but may be used in the future.
6007:
6008: If the package should be skipped (for example, because it provides
6009: functionality already provided by the system), set PKG_SKIP_REASON to a
6010: descriptive message. If the package should fail because some preconditions are
6011: not met, set PKG_FAIL_REASON to a descriptive message.
6012:
1.154 rillig 6013: 21.1.8. Packages which should not be deleted, once installed
1.1 dsieger 6014:
6015: To ensure that a package may not be deleted, once it has been installed, the
6016: PKG_PRESERVE definition should be set in the package Makefile. This will be
1.25 wiz 6017: carried into any binary package that is made from this pkgsrc entry. A "
6018: preserved" package will not be deleted using pkg_delete(1) unless the "-f"
1.1 dsieger 6019: option is used.
6020:
1.154 rillig 6021: 21.1.9. Handling packages with security problems
1.1 dsieger 6022:
6023: When a vulnerability is found, this should be noted in localsrc/security/
1.32 wiz 6024: advisories/pkg-vulnerabilities, and after committing that file, ask
6025: pkgsrc-security@NetBSD.org to update the file on ftp.NetBSD.org.
1.1 dsieger 6026:
6027: After fixing the vulnerability by a patch, its PKGREVISION should be increased
6028: (this is of course not necessary if the problem is fixed by using a newer
1.32 wiz 6029: release of the software), and the pattern in the pkg-vulnerabilities file must
6030: be updated.
1.1 dsieger 6031:
6032: Also, if the fix should be applied to the stable pkgsrc branch, be sure to
6033: submit a pullup request!
6034:
6035: Binary packages already on ftp.NetBSD.org will be handled semi-automatically by
6036: a weekly cron job.
6037:
1.154 rillig 6038: 21.1.10. How to handle incrementing versions when fixing an existing package
1.1 dsieger 6039:
6040: When making fixes to an existing package it can be useful to change the version
6041: number in PKGNAME. To avoid conflicting with future versions by the original
6042: author, a "nb1", "nb2", ... suffix can be used on package versions by setting
6043: PKGREVISION=1 (2, ...). The "nb" is treated like a "." by the package tools.
6044: e.g.
6045:
6046: DISTNAME= foo-17.42
6047: PKGREVISION= 9
6048:
6049: will result in a PKGNAME of "foo-17.42nb9". If you want to use the original
6050: value of PKGNAME without the "nbX" suffix, e.g. for setting DIST_SUBDIR, use
6051: PKGNAME_NOREV.
6052:
6053: When a new release of the package is released, the PKGREVISION should be
6054: removed, e.g. on a new minor release of the above package, things should be
6055: like:
6056:
6057: DISTNAME= foo-17.43
6058:
6059: PKGREVISION should be incremented for any non-trivial change in the resulting
6060: binary package. Without a PKGREVISION bump, someone with the previous version
6061: installed has no way of knowing that their package is out of date. Thus,
6062: changes without increasing PKGREVISION are essentially labeled "this is so
6063: trivial that no reasonable person would want to upgrade", and this is the rough
6064: test for when increasing PKGREVISION is appropriate. Examples of changes that
6065: do not merit increasing PKGREVISION are:
6066:
1.14 jmcneill 6067: * Changing HOMEPAGE, MAINTAINER, OWNER, or comments in Makefile.
1.1 dsieger 6068:
6069: * Changing build variables if the resulting binary package is the same.
6070:
6071: * Changing DESCR.
6072:
6073: * Adding PKG_OPTIONS if the default options don't change.
6074:
6075: Examples of changes that do merit an increase to PKGREVISION include:
6076:
6077: * Security fixes
6078:
6079: * Changes or additions to a patch file
6080:
6081: * Changes to the PLIST
6082:
1.12 weinem 6083: * A dependency is changed or renamed.
6084:
1.1 dsieger 6085: PKGREVISION must also be incremented when dependencies have ABI changes.
6086:
1.154 rillig 6087: 21.1.11. Substituting variable text in the package files (the SUBST framework)
1.1 dsieger 6088:
6089: When you want to replace the same text in multiple files or when the
6090: replacement text varies, patches alone cannot help. This is where the SUBST
6091: framework comes in. It provides an easy-to-use interface for replacing text in
6092: files. Example:
6093:
6094: SUBST_CLASSES+= fix-paths
6095: SUBST_STAGE.fix-paths= pre-configure
6096: SUBST_MESSAGE.fix-paths= Fixing absolute paths.
6097: SUBST_FILES.fix-paths= src/*.c
6098: SUBST_FILES.fix-paths+= scripts/*.sh
6099: SUBST_SED.fix-paths= -e 's,"/usr/local,"${PREFIX},g'
6100: SUBST_SED.fix-paths+= -e 's,"/var/log,"${VARBASE}/log,g'
6101:
6102: SUBST_CLASSES is a list of identifiers that are used to identify the different
6103: SUBST blocks that are defined. The SUBST framework is heavily used by pkgsrc,
6104: so it is important to always use the += operator with this variable. Otherwise
6105: some substitutions may be skipped.
6106:
6107: The remaining variables of each SUBST block are parameterized with the
6108: identifier from the first line (fix-paths in this case.) They can be seen as
6109: parameters to a function call.
6110:
6111: SUBST_STAGE.* specifies the stage at which the replacement will take place. All
6112: combinations of pre-, do- and post- together with a phase name are possible,
6113: though only few are actually used. Most commonly used are post-patch and
6114: pre-configure. Of these two, pre-configure should be preferred because then it
6115: is possible to run bmake patch and have the state after applying the patches
6116: but before making any other changes. This is especially useful when you are
6117: debugging a package in order to create new patches for it. Similarly,
6118: post-build is preferred over pre-install, because the install phase should
6119: generally be kept as simple as possible. When you use post-build, you have the
6120: same files in the working directory that will be installed later, so you can
6121: check if the substitution has succeeded.
6122:
6123: SUBST_MESSAGE.* is an optional text that is printed just before the
6124: substitution is done.
6125:
6126: SUBST_FILES.* is the list of shell globbing patterns that specifies the files
6127: in which the substitution will take place. The patterns are interpreted
6128: relatively to the WRKSRC directory.
6129:
6130: SUBST_SED.* is a list of arguments to sed(1) that specify the actual
6131: substitution. Every sed command should be prefixed with -e, so that all SUBST
6132: blocks look uniform.
6133:
6134: There are some more variables, but they are so seldomly used that they are only
6135: documented in the mk/subst.mk file.
6136:
1.154 rillig 6137: 21.2. The fetch phase
1.1 dsieger 6138:
1.154 rillig 6139: 21.2.1. Packages whose distfiles aren't available for plain downloading
1.1 dsieger 6140:
6141: If you need to download from a dynamic URL you can set DYNAMIC_MASTER_SITES and
6142: a make fetch will call files/getsite.sh with the name of each file to download
6143: as an argument, expecting it to output the URL of the directory from which to
6144: download it. graphics/ns-cult3d is an example of this usage.
6145:
6146: If the download can't be automated, because the user must submit personal
6147: information to apply for a password, or must pay for the source, or whatever,
6148: you can set FETCH_MESSAGE to a list of lines that are displayed to the user
6149: before aborting the build. Example:
6150:
6151: FETCH_MESSAGE= "Please download the files"
6152: FETCH_MESSAGE+= " "${DISTFILES:Q}
6153: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
6154:
1.154 rillig 6155: 21.2.2. How to handle modified distfiles with the 'old' name
1.1 dsieger 6156:
6157: Sometimes authors of a software package make some modifications after the
6158: software was released, and they put up a new distfile without changing the
6159: package's version number. If a package is already in pkgsrc at that time, the
6160: checksum will no longer match. The contents of the new distfile should be
6161: compared against the old one before changing anything, to make sure the
6162: distfile was really updated on purpose, and that no trojan horse or so crept
6163: in. Please mention that the distfiles were compared and what was found in your
1.54 rodent 6164: commit message.
6165:
6166: Then, the correct way to work around this is to set DIST_SUBDIR to a unique
1.109 wiz 6167: directory name, usually based on PKGNAME_NOREV (but take care with python or
6168: ruby packages, where PKGNAME includes a variable prefix). All DISTFILES and
6169: PATCHFILES for this package will be put in that subdirectory of the local
1.154 rillig 6170: distfiles directory. (See Section 21.1.10, "How to handle incrementing versions
1.109 wiz 6171: when fixing an existing package" for more details.) In case this happens more
6172: often, PKGNAME can be used (thus including the nbX suffix) or a date stamp can
6173: be appended, like ${PKGNAME_NOREV}-YYYYMMDD.
1.54 rodent 6174:
6175: DIST_SUBDIR is also used when a distfile's name does not contain a version and
6176: the distfile is apt to change. In cases where the likelihood of this is very
6177: small, DIST_SUBDIR might not be required. Additionally, DIST_SUBDIR must not be
6178: removed unless the distfile name changes, even if a package is being moved or
6179: renamed.
6180:
6181: Do not forget regenerating the distinfo file after that, since it contains the
6182: DIST_SUBDIR path in the filenames. Also, increase the PKGREVISION if the
6183: installed package is different. Furthermore, a mail to the package's authors
6184: seems appropriate telling them that changing distfiles after releases without
6185: changing the file names is not good practice.
1.1 dsieger 6186:
1.154 rillig 6187: 21.2.3. Packages hosted on github.com
1.88 tnn 6188:
1.90 tnn 6189: Helper methods exist for packages hosted on github.com which will often have
6190: distfile names that clash with other packages, for example 1.0.tar.gz. Use one
6191: of the three recipes from below:
1.88 tnn 6192:
1.154 rillig 6193: 21.2.3.1. Fetch based on a tagged release
1.88 tnn 6194:
6195: If your distfile URL looks similar to http://github.com/username/exampleproject
6196: /archive/v1.0.zip, then you are packaging a tagged release.
6197:
6198: DISTNAME= exampleproject-1.0
1.90 tnn 6199: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
6200: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
6201: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 6202: EXTRACT_SUFX= .zip
6203:
1.154 rillig 6204: 21.2.3.2. Fetch based on a specific commit
1.88 tnn 6205:
6206: If your distfile URL looks similar to http://github.com/example/example/archive
6207: /988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz, then you are packaging a
6208: specific commit not tied to a release.
6209:
6210: DISTNAME= example-1.0
1.107 jnemeth 6211: MASTER_SITES= ${MASTER_SITE_GITHUB:=example/}
1.90 tnn 6212: #GITHUB_PROJECT= # can be omitted if same as DISTNAME
6213: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.88 tnn 6214:
1.154 rillig 6215: 21.2.3.3. Fetch based on release
1.88 tnn 6216:
6217: If your distfile URL looks similar to http://github.com/username/exampleproject
6218: /releases/download/rel-1.6/offensive-1.6.zip, then you are packaging a release.
6219:
1.90 tnn 6220: DISTNAME= offensive-1.6
1.88 tnn 6221: PKGNAME= ${DISTNAME:S/offensive/proper/}
1.90 tnn 6222: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
6223: GITHUB_PROJECT= exampleproject
6224: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
6225: EXTRACT_SUFX= .zip
1.88 tnn 6226:
1.154 rillig 6227: 21.3. The configure phase
1.1 dsieger 6228:
1.154 rillig 6229: 21.3.1. Shared libraries - libtool
1.1 dsieger 6230:
6231: pkgsrc supports many different machines, with different object formats like
6232: a.out and ELF, and varying abilities to do shared library and dynamic loading
6233: at all. To accompany this, varying commands and options have to be passed to
6234: the compiler, linker, etc. to get the Right Thing, which can be pretty annoying
6235: especially if you don't have all the machines at your hand to test things. The
6236: devel/libtool pkg can help here, as it just "knows" how to build both static
6237: and dynamic libraries from a set of source files, thus being
6238: platform-independent.
6239:
6240: Here's how to use libtool in a package in seven simple steps:
6241:
6242: 1. Add USE_LIBTOOL=yes to the package Makefile.
6243:
6244: 2. For library objects, use "${LIBTOOL} --mode=compile ${CC}" in place of "$
6245: {CC}". You could even add it to the definition of CC, if only libraries are
6246: being built in a given Makefile. This one command will build both PIC and
6247: non-PIC library objects, so you need not have separate shared and
6248: non-shared library rules.
6249:
6250: 3. For the linking of the library, remove any "ar", "ranlib", and "ld
6251: -Bshareable" commands, and instead use:
6252:
6253: ${LIBTOOL} --mode=link \
6254: ${CC} -o ${.TARGET:.a=.la} \
6255: ${OBJS:.o=.lo} \
6256: -rpath ${PREFIX}/lib \
6257: -version-info major:minor
6258:
6259: Note that the library is changed to have a .la extension, and the objects
6260: are changed to have a .lo extension. Change OBJS as necessary. This
6261: automatically creates all of the .a, .so.major.minor, and ELF symlinks (if
6262: necessary) in the build directory. Be sure to include "-version-info",
6263: especially when major and minor are zero, as libtool will otherwise strip
6264: off the shared library version.
6265:
6266: From the libtool manual:
6267:
6268: So, libtool library versions are described by three integers:
6269:
6270: CURRENT
6271: The most recent interface number that this library implements.
6272:
6273: REVISION
6274: The implementation number of the CURRENT interface.
6275:
6276: AGE
6277: The difference between the newest and oldest interfaces that
6278: this library implements. In other words, the library implements
6279: all the interface numbers in the range from number `CURRENT -
6280: AGE' to `CURRENT'.
6281:
6282: If two libraries have identical CURRENT and AGE numbers, then the
6283: dynamic linker chooses the library with the greater REVISION number.
6284:
6285: The "-release" option will produce different results for a.out and ELF
1.25 wiz 6286: (excluding symlinks) in only one case. An ELF library of the form "
6287: libfoo-release.so.x.y" will have a symlink of "libfoo.so.x.y" on an a.out
1.1 dsieger 6288: platform. This is handled automatically.
6289:
6290: The "-rpath argument" is the install directory of the library being built.
6291:
6292: In the PLIST, include only the .la file, the other files will be added
6293: automatically.
6294:
6295: 4. When linking shared object (.so) files, i.e. files that are loaded via
6296: dlopen(3), NOT shared libraries, use "-module -avoid-version" to prevent
6297: them getting version tacked on.
6298:
6299: The PLIST file gets the foo.so entry.
6300:
6301: 5. When linking programs that depend on these libraries before they are
6302: installed, preface the cc(1) or ld(1) line with "${LIBTOOL} --mode=link",
6303: and it will find the correct libraries (static or shared), but please be
6304: aware that libtool will not allow you to specify a relative path in -L
6305: (such as "-L../somelib"), because it expects you to change that argument to
6306: be the .la file. e.g.
6307:
6308: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
6309:
6310: should be changed to:
6311:
6312: ${LIBTOOL} --mode=link ${CC} -o someprog ../somelib/somelib.la
6313:
6314: and it will do the right thing with the libraries.
6315:
6316: 6. When installing libraries, preface the install(1) or cp(1) command with "$
6317: {LIBTOOL} --mode=install", and change the library name to .la. e.g.
6318:
1.23 jakllsch 6319: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1 dsieger 6320:
6321: This will install the static .a, shared library, any needed symlinks, and
6322: run ldconfig(8).
6323:
6324: 7. In your PLIST, include only the .la file (this is a change from previous
6325: behaviour).
6326:
1.154 rillig 6327: 21.3.2. Using libtool on GNU packages that already support libtool
1.1 dsieger 6328:
6329: Add USE_LIBTOOL=yes to the package Makefile. This will override the package's
6330: own libtool in most cases. For older libtool using packages, libtool is made by
6331: ltconfig script during the do-configure step; you can check the libtool script
6332: location by doing make configure; find work*/ -name libtool.
6333:
6334: LIBTOOL_OVERRIDE specifies which libtool scripts, relative to WRKSRC, to
6335: override. By default, it is set to "libtool */libtool */*/libtool". If this
6336: does not match the location of the package's libtool script(s), set it as
6337: appropriate.
6338:
6339: If you do not need *.a static libraries built and installed, then use
6340: SHLIBTOOL_OVERRIDE instead.
6341:
6342: If your package makes use of the platform-independent library for loading
6343: dynamic shared objects, that comes with libtool (libltdl), you should include
6344: devel/libltdl/buildlink3.mk.
6345:
6346: Some packages use libtool incorrectly so that the package may not work or build
6347: in some circumstances. Some of the more common errors are:
6348:
6349: * The inclusion of a shared object (-module) as a dependent library in an
6350: executable or library. This in itself isn't a problem if one of two things
6351: has been done:
6352:
6353: 1. The shared object is named correctly, i.e. libfoo.la, not foo.la
6354:
6355: 2. The -dlopen option is used when linking an executable.
6356:
6357: * The use of libltdl without the correct calls to initialisation routines.
6358: The function lt_dlinit() should be called and the macro
6359: LTDL_SET_PRELOADED_SYMBOLS included in executables.
6360:
1.154 rillig 6361: 21.3.3. GNU Autoconf/Automake
1.1 dsieger 6362:
6363: If a package needs GNU autoconf or automake to be executed to regenerate the
6364: configure script and Makefile.in makefile templates, then they should be
6365: executed in a pre-configure target.
6366:
6367: For packages that need only autoconf:
6368:
6369: AUTOCONF_REQD= 2.50 # if default version is not good enough
6370: USE_TOOLS+= autoconf # use "autoconf213" for autoconf-2.13
6371: ...
6372:
6373: pre-configure:
6374: cd ${WRKSRC} && autoconf
6375:
6376: ...
6377:
6378: and for packages that need automake and autoconf:
6379:
6380: AUTOMAKE_REQD= 1.7.1 # if default version is not good enough
6381: USE_TOOLS+= automake # use "automake14" for automake-1.4
6382: ...
6383:
6384: pre-configure:
6385: set -e; cd ${WRKSRC}; \
6386: aclocal; autoheader; automake -a --foreign -i; autoconf
6387:
6388: ...
6389:
6390: Packages which use GNU Automake will almost certainly require GNU Make.
6391:
6392: There are times when the configure process makes additional changes to the
6393: generated files, which then causes the build process to try to re-execute the
6394: automake sequence. This is prevented by touching various files in the configure
6395: stage. If this causes problems with your package you can set AUTOMAKE_OVERRIDE=
6396: NO in the package Makefile.
6397:
1.154 rillig 6398: 21.4. Programming languages
1.1 dsieger 6399:
1.154 rillig 6400: 21.4.1. C, C++, and Fortran
1.1 dsieger 6401:
6402: Compilers for the C, C++, and Fortran languages comes with the NetBSD base
6403: system. By default, pkgsrc assumes that a package is written in C and will hide
1.154 rillig 6404: all other compilers (via the wrapper framework, see Chapter 16, Buildlink
1.1 dsieger 6405: methodology).
6406:
6407: To declare which language's compiler a package needs, set the USE_LANGUAGES
6408: variable. Allowed values currently are "c", "c++", and "fortran" (and any
6409: combination). The default is "c". Packages using GNU configure scripts, even if
6410: written in C++, usually need a C compiler for the configure phase.
6411:
1.154 rillig 6412: 21.4.2. Java
1.1 dsieger 6413:
6414: If a program is written in Java, use the Java framework in pkgsrc. The package
6415: must include ../../mk/java-vm.mk. This Makefile fragment provides the following
6416: variables:
6417:
6418: * USE_JAVA defines if a build dependency on the JDK is added. If USE_JAVA is
6419: set to "run", then there is only a runtime dependency on the JDK. The
6420: default is "yes", which also adds a build dependency on the JDK.
6421:
6422: * Set USE_JAVA2 to declare that a package needs a Java2 implementation. The
6423: supported values are "yes", "1.4", and "1.5". "yes" accepts any Java2
6424: implementation, "1.4" insists on versions 1.4 or above, and "1.5" only
6425: accepts versions 1.5 or above. This variable is not set by default.
6426:
1.25 wiz 6427: * PKG_JAVA_HOME is automatically set to the runtime location of the used Java
6428: implementation dependency. It may be used to set JAVA_HOME to a good value
6429: if the program needs this variable to be defined.
6430:
1.154 rillig 6431: 21.4.3. Packages containing perl scripts
1.1 dsieger 6432:
6433: If your package contains interpreted perl scripts, add "perl" to the USE_TOOLS
6434: variable and set REPLACE_PERL to ensure that the proper interpreter path is
6435: set. REPLACE_PERL should contain a list of scripts, relative to WRKSRC, that
1.74 wiz 6436: you want adjusted. Every occurrence of */bin/perl in a she-bang line will be
6437: replaced with the full path to the perl executable.
1.1 dsieger 6438:
6439: If a particular version of perl is needed, set the PERL5_REQD variable to the
6440: version number. The default is "5.0".
6441:
1.154 rillig 6442: See Section 21.6.6, "Packages installing perl modules" for information about
1.1 dsieger 6443: handling perl modules.
6444:
1.154 rillig 6445: 21.4.4. Packages containing shell scripts
1.41 wiz 6446:
6447: REPLACE_SH, REPLACE_BASH, REPLACE_CSH, and REPLACE_KSH can be used to replace
6448: shell hash bangs in files. Please use the appropriate one, prefering REPLACE_SH
1.74 wiz 6449: in case this shell is sufficient. Each should contain a list of scripts,
6450: relative to WRKSRC, that you want adjusted. Every occurrence of the matching
6451: shell in a she-bang line will be replaced with the full path to the shell
6452: executable. When using REPLACE_BASH, don't forget to add bash to USE_TOOLS.
1.41 wiz 6453:
1.154 rillig 6454: 21.4.5. Other programming languages
1.1 dsieger 6455:
6456: Currently, there is no special handling for other languages in pkgsrc. If a
6457: compiler package provides a buildlink3.mk file, include that, otherwise just
6458: add a (build) dependency on the appropriate compiler package.
6459:
1.154 rillig 6460: 21.5. The build phase
1.1 dsieger 6461:
6462: The most common failures when building a package are that some platforms do not
6463: provide certain header files, functions or libraries, or they provide the
6464: functions in a library that the original package author didn't know. To work
6465: around this, you can rewrite the source code in most cases so that it does not
6466: use the missing functions or provides a replacement function.
6467:
1.154 rillig 6468: 21.5.1. Compiling C and C++ code conditionally
1.1 dsieger 6469:
6470: If a package already comes with a GNU configure script, the preferred way to
6471: fix the build failure is to change the configure script, not the code. In the
6472: other cases, you can utilize the C preprocessor, which defines certain macros
6473: depending on the operating system and hardware architecture it compiles for.
6474: These macros can be queried using for example #if defined(__i386). Almost every
6475: operating system, hardware architecture and compiler has its own macro. For
6476: example, if the macros __GNUC__, __i386__ and __NetBSD__ are all defined, you
6477: know that you are using NetBSD on an i386 compatible CPU, and your compiler is
6478: GCC.
6479:
6480: The list of the following macros for hardware and operating system depends on
6481: the compiler that is used. For example, if you want to conditionally compile
6482: code on Solaris, don't use __sun__, as the SunPro compiler does not define it.
6483: Use __sun instead.
6484:
1.154 rillig 6485: 21.5.1.1. C preprocessor macros to identify the operating system
1.1 dsieger 6486:
6487: To distinguish between 4.4 BSD-derived systems and the rest of the world, you
6488: should use the following code.
6489:
6490: #include <sys/param.h>
6491: #if (defined(BSD) && BSD >= 199306)
6492: /* BSD-specific code goes here */
6493: #else
6494: /* non-BSD-specific code goes here */
6495: #endif
6496:
6497: If this distinction is not fine enough, you can also test for the following
6498: macros.
6499:
1.46 obache 6500: Cygwin __CYGWIN__
6501: DragonFly __DragonFly__
1.1 dsieger 6502: FreeBSD __FreeBSD__
1.46 obache 6503: Haiku __HAIKU__
1.1 dsieger 6504: Interix __INTERIX
6505: IRIX __sgi (TODO: get a definite source for this)
6506: Linux linux, __linux, __linux__
1.83 dholland 6507: Mac OS X __APPLE__
1.46 obache 6508: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
6509: Minix3 __minix
1.1 dsieger 6510: NetBSD __NetBSD__
6511: OpenBSD __OpenBSD__
6512: Solaris sun, __sun
6513:
1.154 rillig 6514: 21.5.1.2. C preprocessor macros to identify the hardware architecture
1.1 dsieger 6515:
6516: i386 i386, __i386, __i386__
6517: MIPS __mips
6518: SPARC sparc, __sparc
6519:
1.154 rillig 6520: 21.5.1.3. C preprocessor macros to identify the compiler
1.1 dsieger 6521:
6522: GCC __GNUC__ (major version), __GNUC_MINOR__
6523: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
6524: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
6525: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
6526:
1.154 rillig 6527: 21.5.2. How to handle compiler bugs
1.1 dsieger 6528:
6529: Some source files trigger bugs in the compiler, based on combinations of
6530: compiler version and architecture and almost always relation to optimisation
6531: being enabled. Common symptoms are gcc internal errors or never finishing
6532: compiling a file.
6533:
6534: Typically, a workaround involves testing the MACHINE_ARCH and compiler version,
1.87 tnn 6535: disabling optimisation for that combination of file, MACHINE_ARCH and compiler.
6536:
6537: This used to be a big problem in the past, but is rarely needed now as compiler
6538: technology has matured. If you still need to add a compiler specific
6539: workaround, please do so in the file hacks.mk and describe the symptom and
6540: compiler version as detailed as possible.
1.1 dsieger 6541:
1.154 rillig 6542: 21.5.3. Undefined reference to "..."
1.1 dsieger 6543:
6544: This error message often means that a package did not link to a shared library
6545: it needs. The following functions are known to cause this error message over
6546: and over.
6547:
6548: +-----------------------------------------------------+
6549: | Function |Library |Affected platforms|
6550: |-------------------------+--------+------------------|
6551: |accept, bind, connect |-lsocket|Solaris |
6552: |-------------------------+--------+------------------|
6553: |crypt |-lcrypt |DragonFly, NetBSD |
6554: |-------------------------+--------+------------------|
6555: |dlopen, dlsym |-ldl |Linux |
6556: |-------------------------+--------+------------------|
6557: |gethost* |-lnsl |Solaris |
6558: |-------------------------+--------+------------------|
6559: |inet_aton |-lresolv|Solaris |
6560: |-------------------------+--------+------------------|
6561: |nanosleep, sem_*, timer_*|-lrt |Solaris |
6562: |-------------------------+--------+------------------|
6563: |openpty |-lutil |Linux |
6564: +-----------------------------------------------------+
6565:
6566: To fix these linker errors, it is often sufficient to say LIBS.OperatingSystem+
6567: = -lfoo to the package Makefile and then say bmake clean; bmake.
6568:
1.154 rillig 6569: 21.5.3.1. Special issue: The SunPro compiler
1.1 dsieger 6570:
6571: When you are using the SunPro compiler, there is another possibility. That
6572: compiler cannot handle the following code:
6573:
6574: extern int extern_func(int);
6575:
6576: static inline int
6577: inline_func(int x)
6578: {
6579: return extern_func(x);
6580: }
6581:
6582: int main(void)
6583: {
6584: return 0;
6585: }
6586:
6587: It generates the code for inline_func even if that function is never used. This
6588: code then refers to extern_func, which can usually not be resolved. To solve
6589: this problem you can try to tell the package to disable inlining of functions.
6590:
1.154 rillig 6591: 21.5.4. Running out of memory
1.1 dsieger 6592:
6593: Sometimes packages fail to build because the compiler runs into an operating
6594: system specific soft limit. With the UNLIMIT_RESOURCES variable pkgsrc can be
1.94 wiz 6595: told to unlimit the resources. Currently, the allowed values are any
6596: combination of "cputime", "datasize", "memorysize", and "stacksize". Setting
6597: this variable is similar to running the shell builtin ulimit command to raise
6598: the maximum data segment size or maximum stack size of a process, respectively,
6599: to their hard limits.
1.1 dsieger 6600:
1.154 rillig 6601: 21.6. The install phase
1.1 dsieger 6602:
1.154 rillig 6603: 21.6.1. Creating needed directories
1.1 dsieger 6604:
6605: The BSD-compatible install supplied with some operating systems cannot create
6606: more than one directory at a time. As such, you should call ${INSTALL_*_DIR}
6607: like this:
6608:
6609: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
6610: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
6611:
6612: You can also just append "dir1 dir2" to the INSTALLATION_DIRS variable, which
6613: will automatically do the right thing.
6614:
1.154 rillig 6615: 21.6.2. Where to install documentation
1.1 dsieger 6616:
6617: In general, documentation should be installed into ${PREFIX}/share/doc/$
6618: {PKGBASE} or ${PREFIX}/share/doc/${PKGNAME} (the latter includes the version
6619: number of the package).
6620:
6621: Many modern packages using GNU autoconf allow to set the directory where HTML
6622: documentation is installed with the "--with-html-dir" option. Sometimes using
6623: this flag is needed because otherwise the documentation ends up in ${PREFIX}/
6624: share/doc/html or other places.
6625:
6626: An exception to the above is that library API documentation generated with the
6627: textproc/gtk-doc tools, for use by special browsers (devhelp) should be left at
6628: their default location, which is ${PREFIX}/share/gtk-doc. Such documentation
6629: can be recognized from files ending in .devhelp or .devhelp2. (It is also
6630: acceptable to install such files in ${PREFIX}/share/doc/${PKGBASE} or ${PREFIX}
6631: /share/doc/${PKGNAME}; the .devhelp* file must be directly in that directory
6632: then, no additional subdirectory level is allowed in this case. This is usually
6633: achieved by using "--with-html-dir=${PREFIX}/share/doc". ${PREFIX}/share/
6634: gtk-doc is preferred though.)
6635:
1.154 rillig 6636: 21.6.3. Installing highscore files
1.1 dsieger 6637:
6638: Certain packages, most of them in the games category, install a score file that
6639: allows all users on the system to record their highscores. In order for this to
6640: work, the binaries need to be installed setgid and the score files owned by the
1.36 wiz 6641: appropriate group and/or owner (traditionally the "games" user/group). Set
6642: USE_GAMESGROUP to yes to support this. The following variables, documented in
6643: more detail in mk/defaults/mk.conf, control this behaviour: GAMEDATAMODE,
1.100 leot 6644: GAMEDIRMODE, GAMES_GROUP, GAMEMODE, GAME_USER. Other useful variables are:
6645: GAMEDIR_PERMS, GAMEDATA_PERMS and SETGID_GAMES_PERMS.
6646:
6647: An example that illustrates some of the variables described above is games/
6648: moon-buggy. OWN_DIRS_PERMS is used to properly set directory permissions of the
6649: directory where the scorefile is saved, REQD_FILES_PERMS is used to create a
6650: dummy scorefile (mbscore) with the proper permissions and SPECIAL_PERMS is used
6651: to install setgid the game binary:
6652:
6653: USE_GAMESGROUP= yes
6654:
6655: BUILD_DEFS+= VARBASE
6656:
6657: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
6658: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
6659: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
6660:
6661: Various INSTALL_* variables are also available: INSTALL_GAME to install setgid
6662: game binaries, INSTALL_GAME_DIR to install game directories that are needed to
6663: be accessed by setgid games and INSTALL_GAME_DATA to install scorefiles.
1.1 dsieger 6664:
1.14 jmcneill 6665: A package should therefore never hard code file ownership or access permissions
1.100 leot 6666: but rely on *_PERMS as described above or alternatively on INSTALL_GAME,
6667: INSTALL_GAME_DATA and INSTALL_GAME_DIR to set these correctly.
1.1 dsieger 6668:
1.154 rillig 6669: 21.6.4. Adding DESTDIR support to packages
1.4 rillig 6670:
1.14 jmcneill 6671: DESTDIR support means that a package installs into a staging directory, not the
6672: final location of the files. Then a binary package is created which can be used
6673: for installation as usual. There are two ways: Either the package must install
1.25 wiz 6674: as root ("destdir") or the package can install as non-root user ("user-destdir"
6675: ).
1.14 jmcneill 6676:
1.113 leot 6677: * PKG_DESTDIR_SUPPORT has to be set to "destdir" or "user-destdir". By
6678: default PKG_DESTDIR_SUPPORT is set to "user-destdir" to help catching more
6679: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
6680: PKG_DESTDIR_SUPPORT needs to be set before the inclusion.
1.14 jmcneill 6681:
1.4 rillig 6682: * All installation operations have to be prefixed with ${DESTDIR}.
6683:
6684: * automake gets this DESTDIR mostly right automatically. Many manual rules
6685: and pre/post-install often are incorrect; fix them.
6686:
1.17 imil 6687: * If files are installed with special owner/group use SPECIAL_PERMS.
1.4 rillig 6688:
6689: * In general, packages should support UNPRIVILEGED to be able to use DESTDIR.
6690:
1.154 rillig 6691: 21.6.5. Packages with hardcoded paths to other interpreters
1.1 dsieger 6692:
6693: Your package may also contain scripts with hardcoded paths to other
6694: interpreters besides (or as well as) perl. To correct the full pathname to the
6695: script interpreter, you need to set the following definitions in your Makefile
6696: (we shall use tclsh in this example):
6697:
6698: REPLACE_INTERPRETER+= tcl
6699: REPLACE.tcl.old= .*/bin/tclsh
6700: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
6701: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
6702: # relative to ${WRKSRC}, just as in REPLACE_PERL
6703:
6704: Note
6705:
6706: Before March 2006, these variables were called _REPLACE.* and _REPLACE_FILES.*.
6707:
1.154 rillig 6708: 21.6.6. Packages installing perl modules
1.1 dsieger 6709:
6710: Makefiles of packages providing perl5 modules should include the Makefile
6711: fragment ../../lang/perl5/module.mk. It provides a do-configure target for the
6712: standard perl configuration for such modules as well as various hooks to tune
6713: this configuration. See comments in this file for details.
6714:
6715: Perl5 modules will install into different places depending on the version of
6716: perl used during the build process. To address this, pkgsrc will append lines
6717: to the PLIST corresponding to the files listed in the installed .packlist file
6718: generated by most perl5 modules. This is invoked by defining PERL5_PACKLIST to
1.48 wiz 6719: a space-separated list of packlist files relative to PERL5_PACKLIST_DIR
6720: (PERL5_INSTALLVENDORARCH by default), e.g.:
1.1 dsieger 6721:
1.48 wiz 6722: PERL5_PACKLIST= auto/Pg/.packlist
1.1 dsieger 6723:
1.48 wiz 6724: The perl5 config variables installarchlib, installscript, installvendorbin,
6725: installvendorscript, installvendorarch, installvendorlib, installvendorman1dir,
6726: and installvendorman3dir represent those locations in which components of perl5
6727: modules may be installed, provided as variable with uppercase and prefixed with
6728: PERL5_, e.g. PERL5_INSTALLARCHLIB and may be used by perl5 packages that don't
6729: have a packlist. These variables are also substituted for in the PLIST as
6730: uppercase prefixed with PERL5_SUB_.
1.1 dsieger 6731:
1.154 rillig 6732: 21.6.7. Packages installing info files
1.1 dsieger 6733:
6734: Some packages install info files or use the "makeinfo" or "install-info"
6735: commands. INFO_FILES should be defined in the package Makefile so that INSTALL
6736: and DEINSTALL scripts will be generated to handle registration of the info
6737: files in the Info directory file. The "install-info" command used for the info
6738: files registration is either provided by the system, or by a special purpose
6739: package automatically added as dependency if needed.
6740:
6741: PKGINFODIR is the directory under ${PREFIX} where info files are primarily
6742: located. PKGINFODIR defaults to "info" and can be overridden by the user.
6743:
6744: The info files for the package should be listed in the package PLIST; however
6745: any split info files need not be listed.
6746:
6747: A package which needs the "makeinfo" command at build time must add "makeinfo"
6748: to USE_TOOLS in its Makefile. If a minimum version of the "makeinfo" command is
6749: needed it should be noted with the TEXINFO_REQD variable in the package
6750: Makefile. By default, a minimum version of 3.12 is required. If the system does
6751: not provide a makeinfo command or if it does not match the required minimum, a
6752: build dependency on the devel/gtexinfo package will be added automatically.
6753:
6754: The build and installation process of the software provided by the package
6755: should not use the install-info command as the registration of info files is
1.25 wiz 6756: the task of the package INSTALL script, and it must use the appropriate
1.1 dsieger 6757: makeinfo command.
6758:
6759: To achieve this goal, the pkgsrc infrastructure creates overriding scripts for
6760: the install-info and makeinfo commands in a directory listed early in PATH.
6761:
6762: The script overriding install-info has no effect except the logging of a
6763: message. The script overriding makeinfo logs a message and according to the
6764: value of TEXINFO_REQD either runs the appropriate makeinfo command or exit on
6765: error.
6766:
1.154 rillig 6767: 21.6.8. Packages installing man pages
1.1 dsieger 6768:
6769: All packages that install manual pages should install them into the same
6770: directory, so that there is one common place to look for them. In pkgsrc, this
6771: place is ${PREFIX}/${PKGMANDIR}, and this expression should be used in
1.25 wiz 6772: packages. The default for PKGMANDIR is "man". Another often-used value is "
6773: share/man".
1.1 dsieger 6774:
6775: Note
6776:
6777: The support for a custom PKGMANDIR is far from complete.
6778:
6779: The PLIST files can just use man/ as the top level directory for the man page
6780: file entries, and the pkgsrc framework will convert as needed. In all other
6781: places, the correct PKGMANDIR must be used.
6782:
6783: Packages that are configured with GNU_CONFIGURE set as "yes", by default will
6784: use the ./configure --mandir switch to set where the man pages should be
6785: installed. The path is GNU_CONFIGURE_MANDIR which defaults to ${PREFIX}/$
6786: {PKGMANDIR}.
6787:
6788: Packages that use GNU_CONFIGURE but do not use --mandir, can set
6789: CONFIGURE_HAS_MANDIR to "no". Or if the ./configure script uses a non-standard
6790: use of --mandir, you can set GNU_CONFIGURE_MANDIR as needed.
6791:
1.154 rillig 6792: See Section 15.5, "Man page compression" for information on installation of
1.1 dsieger 6793: compressed manual pages.
6794:
1.154 rillig 6795: 21.6.9. Packages installing GConf data files
1.1 dsieger 6796:
1.7 rillig 6797: If a package installs .schemas or .entries files, used by GConf, you need to
1.1 dsieger 6798: take some extra steps to make sure they get registered in the database:
6799:
1.7 rillig 6800: 1. Include ../../devel/GConf/schemas.mk instead of its buildlink3.mk file.
6801: This takes care of rebuilding the GConf database at installation and
6802: deinstallation time, and tells the package where to install GConf data
1.1 dsieger 6803: files using some standard configure arguments. It also disallows any access
6804: to the database directly from the package.
6805:
6806: 2. Ensure that the package installs its .schemas files under ${PREFIX}/share/
6807: gconf/schemas. If they get installed under ${PREFIX}/etc, you will need to
6808: manually patch the package.
6809:
6810: 3. Check the PLIST and remove any entries under the etc/gconf directory, as
1.154 rillig 6811: they will be handled automatically. See Section 10.13, "How do I change the
1.1 dsieger 6812: location of configuration files?" for more information.
6813:
1.7 rillig 6814: 4. Define the GCONF_SCHEMAS variable in your Makefile with a list of all
1.1 dsieger 6815: .schemas files installed by the package, if any. Names must not contain any
6816: directories in them.
6817:
1.7 rillig 6818: 5. Define the GCONF_ENTRIES variable in your Makefile with a list of all
1.1 dsieger 6819: .entries files installed by the package, if any. Names must not contain any
6820: directories in them.
6821:
1.154 rillig 6822: 21.6.10. Packages installing scrollkeeper/rarian data files
1.1 dsieger 6823:
1.18 mishka 6824: If a package installs .omf files, used by scrollkeeper/rarian, you need to take
6825: some extra steps to make sure they get registered in the database:
1.1 dsieger 6826:
1.18 mishka 6827: 1. Include ../../mk/omf-scrollkeeper.mk instead of rarian's buildlink3.mk
6828: file. This takes care of rebuilding the scrollkeeper database at
6829: installation and deinstallation time, and disallows any access to it
6830: directly from the package.
1.1 dsieger 6831:
6832: 2. Check the PLIST and remove any entries under the libdata/scrollkeeper
6833: directory, as they will be handled automatically.
6834:
6835: 3. Remove the share/omf directory from the PLIST. It will be handled by
1.18 mishka 6836: rarian. (make print-PLIST does this automatically.)
1.1 dsieger 6837:
1.154 rillig 6838: 21.6.11. Packages installing X11 fonts
1.1 dsieger 6839:
6840: If a package installs font files, you will need to rebuild the fonts database
6841: in the directory where they get installed at installation and deinstallation
6842: time. This can be automatically done by using the pkginstall framework.
6843:
6844: You can list the directories where fonts are installed in the FONTS_DIRS.type
6845: variables, where type can be one of "ttf", "type1" or "x11". Also make sure
6846: that the database file fonts.dir is not listed in the PLIST.
6847:
6848: Note that you should not create new directories for fonts; instead use the
6849: standard ones to avoid that the user needs to manually configure his X server
6850: to find them.
6851:
1.154 rillig 6852: 21.6.12. Packages installing GTK2 modules
1.1 dsieger 6853:
6854: If a package installs GTK2 immodules or loaders, you need to take some extra
6855: steps to get them registered in the GTK2 database properly:
6856:
6857: 1. Include ../../x11/gtk2/modules.mk instead of its buildlink3.mk file. This
6858: takes care of rebuilding the database at installation and deinstallation
6859: time.
6860:
6861: 2. Set GTK2_IMMODULES=YES if your package installs GTK2 immodules.
6862:
6863: 3. Set GTK2_LOADERS=YES if your package installs GTK2 loaders.
6864:
6865: 4. Patch the package to not touch any of the GTK2 databases directly. These
6866: are:
6867:
1.42 asau 6868: + libdata/gtk-2.0/gdk-pixbuf.loaders
1.1 dsieger 6869:
1.42 asau 6870: + libdata/gtk-2.0/gtk.immodules
1.1 dsieger 6871:
6872: 5. Check the PLIST and remove any entries under the libdata/gtk-2.0 directory,
6873: as they will be handled automatically.
6874:
1.154 rillig 6875: 21.6.13. Packages installing SGML or XML data
1.1 dsieger 6876:
6877: If a package installs SGML or XML data files that need to be registered in
6878: system-wide catalogs (like DTDs, sub-catalogs, etc.), you need to take some
6879: extra steps:
6880:
6881: 1. Include ../../textproc/xmlcatmgr/catalogs.mk in your Makefile, which takes
6882: care of registering those files in system-wide catalogs at installation and
6883: deinstallation time.
6884:
6885: 2. Set SGML_CATALOGS to the full path of any SGML catalogs installed by the
6886: package.
6887:
6888: 3. Set XML_CATALOGS to the full path of any XML catalogs installed by the
6889: package.
6890:
6891: 4. Set SGML_ENTRIES to individual entries to be added to the SGML catalog.
6892: These come in groups of three strings; see xmlcatmgr(1) for more
6893: information (specifically, arguments recognized by the 'add' action). Note
6894: that you will normally not use this variable.
6895:
6896: 5. Set XML_ENTRIES to individual entries to be added to the XML catalog. These
6897: come in groups of three strings; see xmlcatmgr(1) for more information
6898: (specifically, arguments recognized by the 'add' action). Note that you
6899: will normally not use this variable.
6900:
1.154 rillig 6901: 21.6.14. Packages installing extensions to the MIME database
1.1 dsieger 6902:
6903: If a package provides extensions to the MIME database by installing .xml files
6904: inside ${PREFIX}/share/mime/packages, you need to take some extra steps to
6905: ensure that the database is kept consistent with respect to these new files:
6906:
6907: 1. Include ../../databases/shared-mime-info/mimedb.mk (avoid using the
6908: buildlink3.mk file from this same directory, which is reserved for
6909: inclusion from other buildlink3.mk files). It takes care of rebuilding the
6910: MIME database at installation and deinstallation time, and disallows any
6911: access to it directly from the package.
6912:
1.25 wiz 6913: 2. Check the PLIST and remove any entries under the share/mime directory,
1.1 dsieger 6914: except for files saved under share/mime/packages. The former are handled
6915: automatically by the update-mime-database program, but the latter are
6916: package-dependent and must be removed by the package that installed them in
6917: the first place.
6918:
6919: 3. Remove any share/mime/* directories from the PLIST. They will be handled by
6920: the shared-mime-info package.
6921:
1.154 rillig 6922: 21.6.15. Packages using intltool
1.1 dsieger 6923:
6924: If a package uses intltool during its build, add intltool to the USE_TOOLS,
6925: which forces it to use the intltool package provided by pkgsrc, instead of the
6926: one bundled with the distribution file.
6927:
6928: This tracks intltool's build-time dependencies and uses the latest available
6929: version; this way, the package benefits of any bug fixes that may have appeared
6930: since it was released.
6931:
1.154 rillig 6932: 21.6.16. Packages installing startup scripts
1.1 dsieger 6933:
6934: If a package contains a rc.d script, it won't be copied into the startup
6935: directory by default, but you can enable it, by adding the option
1.4 rillig 6936: PKG_RCD_SCRIPTS=YES in mk.conf. This option will copy the scripts into /etc/
6937: rc.d when a package is installed, and it will automatically remove the scripts
6938: when the package is deinstalled.
1.1 dsieger 6939:
1.154 rillig 6940: 21.6.17. Packages installing TeX modules
1.1 dsieger 6941:
6942: If a package installs TeX packages into the texmf tree, the ls-R database of
6943: the tree needs to be updated.
6944:
6945: Note
6946:
1.23 jakllsch 6947: Except the main TeX packages such as kpathsea, packages should install files
6948: into ${PREFIX}/share/texmf-dist, not ${PREFIX}/share/texmf.
1.1 dsieger 6949:
1.23 jakllsch 6950: 1. Include ../../print/kpathsea/texmf.mk. This takes care of rebuilding the
6951: ls-R database at installation and deinstallation time.
1.1 dsieger 6952:
1.23 jakllsch 6953: 2. If your package installs files into a texmf tree other than the one at $
6954: {PREFIX}/share/texmf-dist, set TEX_TEXMF_DIRS to the list of all texmf
6955: trees that need database update.
1.1 dsieger 6956:
6957: If your package also installs font map files that need to be registered
1.30 dholland 6958: using updmap, include ../../print/tex-tetex/map.mk and set TEX_MAP_FILES
6959: and/or TEX_MIXEDMAP_FILES to the list of all such font map files. Then
6960: updmap will be run automatically at installation/deinstallation to enable/
6961: disable font map files for TeX output drivers.
1.1 dsieger 6962:
6963: 3. Make sure that none of ls-R databases are included in PLIST, as they will
1.30 dholland 6964: be removed only by the kpathsea package.
1.1 dsieger 6965:
1.154 rillig 6966: 21.6.18. Packages supporting running binaries in emulation
1.1 dsieger 6967:
6968: There are some packages that provide libraries and executables for running
6969: binaries from a one operating system on a different one (if the latter supports
6970: it). One example is running Linux binaries on NetBSD.
6971:
6972: The pkgtools/rpm2pkg helps in extracting and packaging Linux rpm packages.
6973:
6974: The CHECK_SHLIBS can be set to no to avoid the check-shlibs target, which tests
6975: if all libraries for each installed executable can be found by the dynamic
6976: linker. Since the standard dynamic linker is run, this fails for emulation
6977: packages, because the libraries used by the emulation are not in the standard
6978: directories.
6979:
1.154 rillig 6980: 21.6.19. Packages installing hicolor theme icons
1.1 dsieger 6981:
6982: If a package installs images under the share/icons/hicolor and/or updates the
6983: share/icons/hicolor/icon-theme.cache database, you need to take some extra
6984: steps to make sure that the shared theme directory is handled appropriately and
6985: that the cache database is rebuilt:
6986:
6987: 1. Include ../../graphics/hicolor-icon-theme/buildlink3.mk.
6988:
6989: 2. Check the PLIST and remove the entry that refers to the theme cache.
6990:
6991: 3. Ensure that the PLIST does not remove the shared icon directories from the
6992: share/icons/hicolor hierarchy because they will be handled automatically.
6993:
6994: The best way to verify that the PLIST is correct with respect to the last two
6995: points is to regenerate it using make print-PLIST.
6996:
1.154 rillig 6997: 21.6.20. Packages installing desktop files
1.1 dsieger 6998:
6999: If a package installs .desktop files under share/applications and these include
1.54 rodent 7000: MIME information (MimeType key), you need to take extra steps to ensure that
7001: they are registered into the MIME database:
1.1 dsieger 7002:
7003: 1. Include ../../sysutils/desktop-file-utils/desktopdb.mk.
7004:
7005: 2. Check the PLIST and remove the entry that refers to the share/applications/
7006: mimeinfo.cache file. It will be handled automatically.
7007:
7008: The best way to verify that the PLIST is correct with respect to the last point
7009: is to regenerate it using make print-PLIST.
7010:
1.154 rillig 7011: 21.7. Marking packages as having problems
1.1 dsieger 7012:
1.23 jakllsch 7013: In some cases one does not have the time to solve a problem immediately. In
7014: this case, one can plainly mark a package as broken. For this, one just sets
7015: the variable BROKEN to the reason why the package is broken (similar to the
7016: RESTRICTED variable). A user trying to build the package will immediately be
7017: shown this message, and the build will not be even tried.
1.1 dsieger 7018:
1.23 jakllsch 7019: BROKEN packages are removed from pkgsrc in irregular intervals.
1.1 dsieger 7020:
1.154 rillig 7021: Chapter 22. Debugging
1.1 dsieger 7022:
7023: To check out all the gotchas when building a package, here are the steps that I
7024: do in order to get a package working. Please note this is basically the same as
7025: what was explained in the previous sections, only with some debugging aids.
7026:
1.4 rillig 7027: * Be sure to set PKG_DEVELOPER=yes in mk.conf.
1.1 dsieger 7028:
7029: * Install pkgtools/url2pkg, create a directory for a new package, change into
7030: it, then run url2pkg:
7031:
7032: % mkdir /usr/pkgsrc/category/examplepkg
7033: % cd /usr/pkgsrc/category/examplepkg
7034: % url2pkg http://www.example.com/path/to/distfile.tar.gz
7035:
7036: * Edit the Makefile as requested.
7037:
7038: * Fill in the DESCR file
7039:
7040: * Run make configure
7041:
7042: * Add any dependencies glimpsed from documentation and the configure step to
7043: the package's Makefile.
7044:
7045: * Make the package compile, doing multiple rounds of
7046:
7047: % make
7048: % pkgvi ${WRKSRC}/some/file/that/does/not/compile
7049: % mkpatches
7050: % patchdiff
7051: % mv ${WRKDIR}/.newpatches/* patches
7052: % make mps
7053: % make clean
7054:
7055: Doing this step as non-root user will ensure that no files are modified
7056: that shouldn't be, especially during the build phase. mkpatches, patchdiff
7057: and pkgvi are from the pkgtools/pkgdiff package.
7058:
1.154 rillig 7059: * Look at the Makefile, fix if necessary; see Section 13.1, "Makefile".
1.1 dsieger 7060:
7061: * Generate a PLIST:
7062:
7063: # make install
7064: # make print-PLIST >PLIST
7065: # make deinstall
7066: # make install
7067: # make deinstall
7068:
7069: You usually need to be root to do this. Look if there are any files left:
7070:
7071: # make print-PLIST
7072:
7073: If this reveals any files that are missing in PLIST, add them.
7074:
7075: * Now that the PLIST is OK, install the package again and make a binary
7076: package:
7077:
7078: # make reinstall
7079: # make package
7080:
7081: * Delete the installed package:
7082:
7083: # pkg_delete examplepkg
7084:
7085: * Repeat the above make print-PLIST command, which shouldn't find anything
7086: now:
7087:
7088: # make print-PLIST
7089:
7090: * Reinstall the binary package:
7091:
7092: # pkg_add .../examplepkg.tgz
7093:
7094: * Play with it. Make sure everything works.
7095:
7096: * Run pkglint from pkgtools/pkglint, and fix the problems it reports:
7097:
7098: # pkglint
7099:
1.154 rillig 7100: * Submit (or commit, if you have cvs access); see Chapter 23, Submitting and
1.1 dsieger 7101: Committing.
7102:
1.154 rillig 7103: Chapter 23. Submitting and Committing
1.1 dsieger 7104:
7105: Table of Contents
7106:
1.154 rillig 7107: 23.1. Submitting binary packages
7108: 23.2. Submitting source packages (for non-NetBSD-developers)
7109: 23.3. General notes when adding, updating, or removing packages
7110: 23.4. Commit Messages
7111: 23.5. Committing: Adding a package to CVS
7112: 23.6. Updating a package to a newer version
7113: 23.7. Renaming a package in pkgsrc
7114: 23.8. Moving a package in pkgsrc
1.1 dsieger 7115:
1.154 rillig 7116: 23.1. Submitting binary packages
1.1 dsieger 7117:
7118: Our policy is that we accept binaries only from pkgsrc developers to guarantee
7119: that the packages don't contain any trojan horses etc. This is not to annoy
7120: anyone but rather to protect our users! You're still free to put up your
7121: home-made binary packages and tell the world where to get them. NetBSD
1.154 rillig 7122: developers doing bulk builds and wanting to upload them please see Chapter 8,
1.66 asau 7123: Creating binary packages for everything in pkgsrc (bulk builds).
1.1 dsieger 7124:
1.154 rillig 7125: 23.2. Submitting source packages (for non-NetBSD-developers)
1.1 dsieger 7126:
7127: First, check that your package is complete, compiles and runs well; see
1.154 rillig 7128: Chapter 22, Debugging and the rest of this document. Next, generate an
1.1 dsieger 7129: uuencoded gzipped tar(1) archive that contains all files that make up the
7130: package. Finally, send this package to the pkgsrc bug tracking system, either
7131: with the send-pr(1) command, or if you don't have that, go to the web page
1.4 rillig 7132: http://www.NetBSD.org/support/send-pr.html, which contains some instructions
1.22 snj 7133: and a link to a form where you can submit packages. The sysutils/gtk-send-pr
7134: package is also available as a substitute for either of the above two tools.
1.1 dsieger 7135:
7136: In the form of the problem report, the category should be "pkg", the synopsis
7137: should include the package name and version number, and the description field
7138: should contain a short description of your package (contents of the COMMENT
1.25 wiz 7139: variable or DESCR file are OK). The uuencoded package data should go into the "
7140: fix" field.
1.1 dsieger 7141:
7142: If you want to submit several packages, please send a separate PR for each one,
7143: it's easier for us to track things that way.
7144:
7145: Alternatively, you can also import new packages into pkgsrc-wip ("pkgsrc
1.105 wiz 7146: work-in-progress"); see the homepage at http://pkgsrc.org/wip/ for details.
1.1 dsieger 7147:
1.154 rillig 7148: 23.3. General notes when adding, updating, or removing packages
1.1 dsieger 7149:
7150: Please note all package additions, updates, moves, and removals in pkgsrc/doc/
7151: CHANGES-YYYY. It's very important to keep this file up to date and conforming
7152: to the existing format, because it will be used by scripts to automatically
7153: update pages on www.NetBSD.org and other sites. Additionally, check the pkgsrc/
7154: doc/TODO file and remove the entry for the package you updated or removed, in
7155: case it was mentioned there.
7156:
7157: When the PKGREVISION of a package is bumped, the change should appear in pkgsrc
7158: /doc/CHANGES-YYYY if it is security related or otherwise relevant. Mass bumps
7159: that result from a dependency being updated should not be mentioned. In all
7160: other cases it's the developer's decision.
7161:
7162: There is a make target that helps in creating proper CHANGES-YYYY entries: make
7163: changes-entry. It uses the optional CTYPE and NETBSD_LOGIN_NAME variables. The
7164: general usage is to first make sure that your CHANGES-YYYY file is up-to-date
7165: (to avoid having to resolve conflicts later-on) and then to cd to the package
7166: directory. For package updates, make changes-entry is enough. For new packages,
7167: or package moves or removals, set the CTYPE variable on the command line to
1.4 rillig 7168: "Added", "Moved", or "Removed". You can set NETBSD_LOGIN_NAME in mk.conf if
1.23 jakllsch 7169: your local login name is not the same as your NetBSD login name. The target
7170: also automatically removes possibly existing entries for the package in the
7171: TODO file. Don't forget to commit the changes, e.g. by using make
1.66 asau 7172: commit-changes-entry! If you are not using a checkout directly from
1.23 jakllsch 7173: cvs.NetBSD.org, but e.g. a local copy of the repository, you can set
7174: USE_NETBSD_REPO=yes. This makes the cvs commands use the main repository.
1.1 dsieger 7175:
1.154 rillig 7176: 23.4. Commit Messages
1.130 wiz 7177:
7178: For several years, there have been mirrors of pkgsrc in fossil, git, and hg.
7179: Standard practise when using these tools is to make the first line of a commit
7180: message function as a summary that can be read without the rest, such as is
7181: commonly done with "git log --oneline". For this reason, we have the following
7182: guidelines for pkgsrc commit messages:
7183:
1.131 wiz 7184: * Start the commit message with a line that explains the big picture in 65
1.130 wiz 7185: characters or less. When a commit is for one package, include the name of
7186: the package. For updates, include the version to which it is updated.
7187:
7188: * Leave the next line empty.
7189:
7190: * Then come the details for the commit (changes in that package, reason for a
7191: change) and any relevant PRs. Wrap this section.
7192:
7193: Here is an example:
7194:
7195: libxslt: update to 1.0.30
7196:
7197: Changes since 1.0.29:
7198: ...
7199:
7200:
7201: Here is another example:
7202:
7203: mk/bsd.pkg.mk: enable SSP by default on NetBSD
7204:
7205: (rationale)
7206:
7207:
7208: Commit messages are final: no "cvs admin" is allowed on the pkgsrc repository
7209: to change commit messages.
7210:
1.154 rillig 7211: 23.5. Committing: Adding a package to CVS
1.1 dsieger 7212:
7213: This section is only of interest for pkgsrc developers with write access to the
1.34 wiz 7214: pkgsrc repository.
7215:
7216: When the package is finished, "cvs add" the files. Start by adding the
7217: directory and then files in the directory. Don't forget to add the new package
7218: to the category's Makefile. Make sure you don't forget any files; you can check
7219: by running "cvs status". An example:
7220:
7221: $ cd .../pkgsrc/category
7222: $ cvs add pkgname
7223: $ cd pkgname
7224: $ cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
7225: $ cvs add patches/p*
7226: $ cvs status | less
1.35 wiz 7227: $ cvs commit
1.34 wiz 7228: $ cd ..
7229: $ vi Makefile # add SUBDIRS+=pkgname line
1.35 wiz 7230: $ cvs commit Makefile
1.66 asau 7231: $ cd pkgname
1.73 jnemeth 7232: $ make CTYPE=Added commit-changes-entry
1.1 dsieger 7233:
7234: The commit message of the initial import should include part of the DESCR file,
7235: so people reading the mailing lists know what the package is/does.
7236:
1.34 wiz 7237: Also mention the new package in pkgsrc/doc/CHANGES-20xx.
7238:
7239: Previously, "cvs import" was suggested, but it was much easier to get wrong
7240: than "cvs add".
1.1 dsieger 7241:
1.154 rillig 7242: 23.6. Updating a package to a newer version
1.1 dsieger 7243:
7244: Please always put a concise, appropriate and relevant summary of the changes
7245: between old and new versions into the commit log when updating a package. There
7246: are various reasons for this:
7247:
7248: * A URL is volatile, and can change over time. It may go away completely or
7249: its information may be overwritten by newer information.
7250:
7251: * Having the change information between old and new versions in our CVS
7252: repository is very useful for people who use either cvs or anoncvs.
7253:
7254: * Having the change information between old and new versions in our CVS
7255: repository is very useful for people who read the pkgsrc-changes mailing
7256: list, so that they can make tactical decisions about when to upgrade the
7257: package.
7258:
7259: Please also recognize that, just because a new version of a package has been
7260: released, it should not automatically be upgraded in the CVS repository. We
7261: prefer to be conservative in the packages that are included in pkgsrc -
7262: development or beta packages are not really the best thing for most places in
7263: which pkgsrc is used. Please use your judgement about what should go into
7264: pkgsrc, and bear in mind that stability is to be preferred above new and
7265: possibly untested features.
7266:
1.154 rillig 7267: 23.7. Renaming a package in pkgsrc
1.21 snj 7268:
7269: Renaming packages is not recommended.
7270:
7271: When renaming packages, be sure to fix any references to old name in other
7272: Makefiles, options, buildlink files, etc.
7273:
7274: Also When renaming a package, please define SUPERSEDES to the package name and
7275: dewey version pattern(s) of the previous package name. This may be repeated for
7276: multiple renames. The new package would be an exact replacement.
7277:
7278: Note that "successor" in the CHANGES-YYYY file doesn't necessarily mean that it
7279: supersedes, as that successor may not be an exact replacement but is a
7280: suggestion for the replaced functionality.
7281:
1.154 rillig 7282: 23.8. Moving a package in pkgsrc
1.21 snj 7283:
7284: It is preferred that packages are not renamed or moved, but if needed please
7285: follow these steps.
1.1 dsieger 7286:
7287: 1. Make a copy of the directory somewhere else.
7288:
7289: 2. Remove all CVS dirs.
7290:
7291: Alternatively to the first two steps you can also do:
7292:
7293: % cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package
7294:
7295: and use that for further work.
7296:
1.25 wiz 7297: 3. Fix CATEGORIES and any DEPENDS paths that just did "../package" instead of
1.1 dsieger 7298: "../../category/package".
7299:
1.21 snj 7300: 4. In the modified package's Makefile, consider setting PREV_PKGPATH to the
7301: previous category/package pathname. The PREV_PKGPATH can be used by tools
7302: for doing an update using pkgsrc building; for example, it can search the
7303: pkg_summary(5) database for PREV_PKGPATH (if no SUPERSEDES) and then use
7304: the corresponding new PKGPATH for that moved package. Note that it may have
7305: multiple matches, so the tool should also check on the PKGBASE too. The
7306: PREV_PKGPATH probably has no value unless SUPERSEDES is not set, i.e.
7307: PKGBASE stays the same.
7308:
7309: 5. cvs import the modified package in the new place.
1.1 dsieger 7310:
1.21 snj 7311: 6. Check if any package depends on it:
1.1 dsieger 7312:
7313: % cd /usr/pkgsrc
7314: % grep /package */*/Makefile* */*/buildlink*
7315:
1.21 snj 7316: 7. Fix paths in packages from step 5 to point to new location.
1.1 dsieger 7317:
1.21 snj 7318: 8. cvs rm (-f) the package at the old location.
1.1 dsieger 7319:
1.21 snj 7320: 9. Remove from oldcategory/Makefile.
1.1 dsieger 7321:
1.21 snj 7322: 10. Add to newcategory/Makefile.
1.1 dsieger 7323:
1.21 snj 7324: 11. Commit the changed and removed files:
1.1 dsieger 7325:
7326: % cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile
7327:
7328: (and any packages from step 5, of course).
7329:
1.154 rillig 7330: Chapter 24. Frequently Asked Questions
1.1 dsieger 7331:
7332: This section contains the answers to questions that may arise when you are
7333: writing a package. If you don't find your question answered here, first have a
7334: look in the other chapters, and if you still don't have the answer, ask on the
7335: pkgsrc-users mailing list.
7336:
1.154 rillig 7337: 24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
7338: 24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
7339: 24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
7340: 24.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and
1.1 dsieger 7341: BUILDLINK_LIBS?
1.154 rillig 7342: 24.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
7343: 24.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1 dsieger 7344: the := inside it.
1.154 rillig 7345: 24.7. Which mailing lists are there for package developers?
7346: 24.8. Where is the pkgsrc documentation?
7347: 24.9. I have a little time to kill. What shall I do?
1.1 dsieger 7348:
1.154 rillig 7349: 24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
1.1 dsieger 7350:
7351: MAKEFLAGS are the flags passed to the pkgsrc-internal invocations of make
7352: (1), while MAKE_FLAGS are the flags that are passed to the MAKE_PROGRAM
7353: when building the package. [FIXME: What is .MAKEFLAGS for?]
7354:
1.154 rillig 7355: 24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
1.1 dsieger 7356:
7357: MAKE is the path to the make(1) program that is used in the pkgsrc
7358: infrastructure. GMAKE is the path to GNU Make, but you need to say
7359: USE_TOOLS+=gmake to use that. MAKE_PROGRAM is the path to the Make
7360: program that is used for building the package.
7361:
1.154 rillig 7362: 24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
1.1 dsieger 7363:
7364: CC is the path to the real C compiler, which can be configured by the
7365: pkgsrc user. PKG_CC is the path to the compiler wrapper. PKGSRC_COMPILER
7366: is not a path to a compiler, but the type of compiler that should be
7367: used. See mk/compiler.mk for more information about the latter variable.
7368:
1.154 rillig 7369: 24.4. What is the difference between BUILDLINK_LDFLAGS, BUILDLINK_LDADD and
1.1 dsieger 7370: BUILDLINK_LIBS?
7371:
7372: [FIXME]
7373:
1.154 rillig 7374: 24.5. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
1.1 dsieger 7375:
1.25 wiz 7376: For optimization reasons, some variables are only available in the "
7377: wrapper" phase and later. To "simulate" the wrapper phase, append
1.1 dsieger 7378: PKG_PHASE=wrapper to the above command.
7379:
1.154 rillig 7380: 24.6. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1 dsieger 7381: the := inside it.
7382:
1.108 rillig 7383: The := is not really an assignment operator, although it looks like it.
7384: Instead, it is a degenerate form of ${LIST:old_string=new_string}, which
7385: is documented in the make(1) man page and which is commonly used in the
7386: form ${SRCS:.c=.o}. In the case of MASTER_SITE_*, old_string is the empty
7387: string and new_string is package/. That's where the : and the = fall
7388: together.
1.1 dsieger 7389:
1.154 rillig 7390: 24.7. Which mailing lists are there for package developers?
1.1 dsieger 7391:
7392: tech-pkg
7393:
7394: This is a list for technical discussions related to pkgsrc
7395: development, e.g. soliciting feedback for changes to pkgsrc
7396: infrastructure, proposed new features, questions related to porting
7397: pkgsrc to a new platform, advice for maintaining a package, patches
7398: that affect many packages, help requests moved from pkgsrc-users when
7399: an infrastructure bug is found, etc.
7400:
7401: pkgsrc-bugs
7402:
7403: All bug reports in category "pkg" sent with send-pr(1) appear here.
7404: Please do not report your bugs here directly; use one of the other
7405: mailing lists.
7406:
1.154 rillig 7407: 24.8. Where is the pkgsrc documentation?
1.1 dsieger 7408:
7409: There are many places where you can find documentation about pkgsrc:
7410:
7411: * The pkgsrc guide (this document) is a collection of chapters that
7412: explain large parts of pkgsrc, but some chapters tend to be outdated.
7413: Which ones they are is hard to say.
7414:
7415: * On the mailing list archives (see http://mail-index.NetBSD.org/), you
7416: can find discussions about certain features, announcements of new
7417: parts of the pkgsrc infrastructure and sometimes even announcements
7418: that a certain feature has been marked as obsolete. The benefit here
7419: is that each message has a date appended to it.
7420:
7421: * Many of the files in the mk/ directory start with a comment that
7422: describes the purpose of the file and how it can be used by the
7423: pkgsrc user and package authors. An easy way to find this
7424: documentation is to run bmake help.
7425:
7426: * The CVS log messages are a rich source of information, but they tend
7427: to be highly abbreviated, especially for actions that occur often.
7428: Some contain a detailed description of what has changed, but they are
7429: geared towards the other pkgsrc developers, not towards an average
7430: pkgsrc user. They also only document changes, so if you don't know
7431: what has been before, these messages may not be worth too much to
7432: you.
7433:
7434: * Some parts of pkgsrc are only "implicitly documented", that is the
7435: documentation exists only in the mind of the developer who wrote the
7436: code. To get this information, use the cvs annotate command to see
7437: who has written it and ask on the tech-pkg mailing list, so that
7438: others can find your questions later (see above). To be sure that the
7439: developer in charge reads the mail, you may CC him or her.
7440:
1.154 rillig 7441: 24.9. I have a little time to kill. What shall I do?
1.1 dsieger 7442:
7443: This is not really an FAQ yet, but here's the answer anyway.
7444:
7445: * Run pkg_chk -N (from the pkgtools/pkg_chk package). It will tell you
7446: about newer versions of installed packages that are available, but
7447: not yet updated in pkgsrc.
7448:
7449: * Browse pkgsrc/doc/TODO ? it contains a list of suggested new packages
7450: and a list of cleanups and enhancements for pkgsrc that would be nice
7451: to have.
7452:
1.71 wiz 7453: * Review packages for which review was requested on the tech-pkg
7454: mailing list.
1.1 dsieger 7455:
1.154 rillig 7456: Chapter 25. GNOME packaging and porting
1.1 dsieger 7457:
7458: Table of Contents
7459:
1.154 rillig 7460: 25.1. Meta packages
7461: 25.2. Packaging a GNOME application
7462: 25.3. Updating GNOME to a newer version
7463: 25.4. Patching guidelines
1.1 dsieger 7464:
7465: Quoting GNOME's web site:
7466:
7467: The GNOME project provides two things: The GNOME desktop environment, an
7468: intuitive and attractive desktop for users, and the GNOME development
7469: platform, an extensive framework for building applications that integrate
7470: into the rest of the desktop.
7471:
7472: pkgsrc provides a seamless way to automatically build and install a complete
7473: GNOME environment under many different platforms. We can say with confidence
7474: that pkgsrc is one of the most advanced build and packaging systems for GNOME
7475: due to its included technologies buildlink3, the wrappers and tools framework
7476: and automatic configuration file management. Lots of efforts are put into
7477: achieving a completely clean deinstallation of installed software components.
7478:
7479: Given that pkgsrc is NetBSD's official packaging system, the above also means
7480: that great efforts are put into making GNOME work under this operating system.
7481: Recently, DragonFly BSD also adopted pkgsrc as its preferred packaging system,
7482: contributing lots of portability fixes to make GNOME build and install under
7483: it.
7484:
7485: This chapter is aimed at pkgsrc developers and other people interested in
7486: helping our GNOME porting and packaging efforts. It provides instructions on
7487: how to manage the existing packages and some important information regarding
7488: their internals.
7489:
7490: We need your help!
7491:
7492: Should you have some spare cycles to devote to NetBSD, pkgsrc and GNOME and are
7493: willing to learn new exciting stuff, please jump straight to the pending work
7494: list! There is still a long way to go to get a fully-functional GNOME desktop
7495: under NetBSD and we need your help to achieve it!
7496:
1.154 rillig 7497: 25.1. Meta packages
1.1 dsieger 7498:
7499: pkgsrc includes three GNOME-related meta packages:
7500:
7501: * meta-pkgs/gnome-base: Provides the core GNOME desktop environment. It only
7502: includes the necessary bits to get it to boot correctly, although it may
7503: lack important functionality for daily operation. The idea behind this
7504: package is to let end users build their own configurations on top of this
7505: one, first installing this meta package to achieve a functional setup and
7506: then adding individual applications.
7507:
7508: * meta-pkgs/gnome: Provides a complete installation of the GNOME platform and
7509: desktop as defined by the GNOME project; this is based on the components
7510: distributed in the platform/x.y/x.y.z/sources and desktop/x.y/x.y.z/sources
7511: directories of the official FTP server. Developer-only tools found in those
7512: directories are not installed unless required by some other component to
7513: work properly. Similarly, packages from the bindings set (bindings/x.y/
7514: x.y.z/sources) are not pulled in unless required as a dependency for an
7515: end-user component. This package "extends" meta-pkgs/gnome-base.
7516:
7517: * meta-pkgs/gnome-devel: Installs all the tools required to build a GNOME
7518: component when fetched from the CVS repository. These are required to let
7519: the autogen.sh scripts work appropriately.
7520:
7521: In all these packages, the DEPENDS lines are sorted in a way that eases
7522: updates: a package may depend on other packages listed before it but not on any
1.25 wiz 7523: listed after it. It is very important to keep this order to ease updates so...
1.1 dsieger 7524: do not change it to alphabetical sorting!
7525:
1.154 rillig 7526: 25.2. Packaging a GNOME application
1.1 dsieger 7527:
7528: Almost all GNOME applications are written in C and use a common set of tools as
7529: their build system. Things get different with the new bindings to other
7530: languages (such as Python), but the following will give you a general idea on
7531: the minimum required tools:
7532:
7533: * Almost all GNOME applications use the GNU Autotools as their build system.
7534: As a general rule you will need to tell this to your package:
7535:
7536: GNU_CONFIGURE=yes
7537: USE_LIBTOOL=yes
7538: USE_TOOLS+=gmake
7539:
7540: * If the package uses pkg-config to detect dependencies, add this tool to the
7541: list of required utilities:
7542:
7543: USE_TOOLS+=pkg-config
7544:
7545: Also use pkgtools/verifypc at the end of the build process to ensure that
7546: you did not miss to specify any dependency in your package and that the
7547: version requirements are all correct.
7548:
7549: * If the package uses intltool, be sure to add intltool to the USE_TOOLS to
7550: handle dependencies and to force the package to use the latest available
7551: version.
7552:
7553: * If the package uses gtk-doc (a documentation generation utility), do not
7554: add a dependency on it. The tool is rather big and the distfile should come
7555: with pregenerated documentation anyway; if it does not, it is a bug that
7556: you ought to report. For such packages you should disable gtk-doc (unless
7557: it is the default):
7558:
7559: CONFIGURE_ARGS+=--disable-gtk-doc
7560:
7561: The default location of installed HTML files (share/gtk-doc/<package-name>)
7562: is correct and should not be changed unless the package insists on
7563: installing them somewhere else. Otherwise programs as devhelp will not be
7564: able to open them. You can do that with an entry similar to:
7565:
7566: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
7567:
7568: GNOME uses multiple shared directories and files under the installation prefix
7569: to maintain databases. In this context, shared means that those exact same
7570: directories and files are used among several different packages, leading to
7571: conflicts in the PLIST. pkgsrc currently includes functionality to handle the
7572: most common cases, so you have to forget about using @unexec ${RMDIR} lines in
7573: your file lists and omitting shared files from them. If you find yourself doing
7574: those, your package is most likely incorrect.
7575:
7576: The following table lists the common situations that result in using shared
7577: directories or files. For each of them, the appropriate solution is given.
1.25 wiz 7578: After applying the solution be sure to regenerate the package's file list with
1.1 dsieger 7579: make print-PLIST and ensure it is correct.
7580:
1.154 rillig 7581: Table 25.1. PLIST handling for GNOME packages
1.1 dsieger 7582:
7583: +-----------------------------------------------------------------------------+
7584: | If the package... | Then... |
7585: |-------------------------------------------+---------------------------------|
1.154 rillig 7586: | |See Section 21.6.10, "Packages |
1.18 mishka 7587: |Installs OMF files under share/omf. |installing scrollkeeper/rarian |
7588: | |data files". |
1.1 dsieger 7589: |-------------------------------------------+---------------------------------|
1.154 rillig 7590: |Installs icons under the share/icons/ |See Section 21.6.19, "Packages |
1.1 dsieger 7591: |hicolor hierarchy or updates share/icons/ |installing hicolor theme icons". |
7592: |hicolor/icon-theme.cache. | |
7593: |-------------------------------------------+---------------------------------|
1.154 rillig 7594: | |See Section 21.6.14, "Packages |
1.1 dsieger 7595: |Installs files under share/mime/packages. |installing extensions to the MIME|
7596: | |database". |
7597: |-------------------------------------------+---------------------------------|
1.154 rillig 7598: |Installs .desktop files under share/ |See Section 21.6.20, "Packages |
1.1 dsieger 7599: |applications and these include MIME |installing desktop files". |
7600: |information. | |
7601: +-----------------------------------------------------------------------------+
7602:
7603:
1.154 rillig 7604: 25.3. Updating GNOME to a newer version
1.1 dsieger 7605:
7606: When seeing GNOME as a whole, there are two kinds of updates:
7607:
7608: Major update
7609:
7610: Given that there is still a very long way for GNOME 3 (if it ever appears),
7611: we consider a major update one that goes from a 2.X version to a 2.Y one,
7612: where Y is even and greater than X. These are hard to achieve because they
7613: introduce lots of changes in the components' code and almost all GNOME
7614: distfiles are updated to newer versions. Some of them can even break API
7615: and ABI compatibility with the previous major version series. As a result,
7616: the update needs to be done all at once to minimize breakage.
7617:
7618: A major update typically consists of around 80 package updates and the
7619: addition of some new ones.
7620:
7621: Minor update
7622:
7623: We consider a minor update one that goes from a 2.A.X version to a 2.A.Y
7624: one where Y is greater than X. These are easy to achieve because they do
7625: not update all GNOME components, can be done in an incremental way and do
7626: not break API nor ABI compatibility.
7627:
7628: A minor update typically consists of around 50 package updates, although
7629: the numbers here may vary a lot.
7630:
7631: In order to update the GNOME components in pkgsrc to a new stable release
7632: (either major or minor), the following steps should be followed:
7633:
7634: 1. Get a list of all the tarballs that form the new release by using the
1.19 snj 7635: following commands. These will leave the full list of the components'
1.1 dsieger 7636: distfiles into the list.txt file:
7637:
7638: % echo ls "*.tar.bz2" | \
7639: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
7640: awk '{ print $9 }' >list.txt
7641: % echo ls "*.tar.bz2" | \
7642: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
7643: awk '{ print $9 }' >>list.txt
7644:
7645: 2. Open each meta package's Makefile and bump their version to the release you
7646: are updating them to. The three meta packages should be always consistent
7647: with versioning. Obviously remove any PKGREVISIONs that might be in them.
7648:
7649: 3. For each meta package, update all its DEPENDS lines to match the latest
7650: versions as shown by the above commands. Do not list any newer version
7651: (even if found in the FTP) because the meta packages are supposed to list
7652: the exact versions that form a specific GNOME release. Exceptions are
7653: permitted here if a newer version solves a serious issue in the overall
7654: desktop experience; these typically come in the form of a revision bump in
7655: pkgsrc, not in newer versions from the developers.
7656:
7657: Packages not listed in the list.txt file should be updated to the latest
7658: version available (if found in pkgsrc). This is the case, for example, of
7659: the dependencies on the GNU Autotools in the meta-pkgs/gnome-devel meta
7660: package.
7661:
7662: 4. Generate a patch from the modified meta packages and extract the list of
7663: "new" lines. This will provide you an outline on what packages need to be
7664: updated in pkgsrc and in what order:
7665:
7666: % cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt
7667:
7668: 5. For major desktop updates it is recommended to zap all your installed
7669: packages and start over from scratch at this point.
7670:
7671: 6. Now comes the longest step by far: iterate over the contents of todo.txt
7672: and update the packages listed in it in order. For major desktop updates
7673: none of these should be committed until the entire set is completed because
7674: there are chances of breaking not-yet-updated packages.
7675:
7676: 7. Once the packages are up to date and working, commit them to the tree one
7677: by one with appropriate log messages. At the end, commit the three meta
7678: package updates and all the corresponding changes to the doc/CHANGES-<YEAR>
7679: and pkgsrc/doc/TODO files.
7680:
1.154 rillig 7681: 25.4. Patching guidelines
1.1 dsieger 7682:
7683: GNOME is a very big component in pkgsrc which approaches 100 packages. Please,
7684: it is very important that you always, always, always feed back any portability
7685: fixes you do to a GNOME package to the mainstream developers (see
1.154 rillig 7686: Section 13.3.5, "Feedback to the author"). This is the only way to get their
1.1 dsieger 7687: attention on portability issues and to ensure that future versions can be built
7688: out-of-the box on NetBSD. The less custom patches in pkgsrc, the easier further
7689: updates are. Those developers in charge of issuing major GNOME updates will be
7690: grateful if you do that.
7691:
7692: The most common places to report bugs are the GNOME's Bugzilla and the
7693: freedesktop.org's Bugzilla. Not all components use these to track bugs, but
7694: most of them do. Do not be short on your reports: always provide detailed
7695: explanations of the current failure, how it can be improved to achieve maximum
7696: portability and, if at all possible, provide a patch against CVS head. The more
7697: verbose you are, the higher chances of your patch being accepted.
7698:
7699: Also, please avoid using preprocessor magic to fix portability issues. While
7700: the FreeBSD GNOME people are doing a great job in porting GNOME to their
7701: operating system, the official GNOME sources are now plagued by conditionals
7702: that check for __FreeBSD__ and similar macros. This hurts portability. Please
1.154 rillig 7703: see our patching guidelines (Section 13.3.4, "Patching guidelines") for more
1.1 dsieger 7704: details.
7705:
7706: Part III. The pkgsrc infrastructure internals
7707:
7708: This part of the guide deals with everything from the infrastructure that is
7709: behind the interfaces described in the developer's guide. A casual package
7710: maintainer should not need anything from this part.
7711:
7712: Table of Contents
7713:
1.154 rillig 7714: 26. Design of the pkgsrc infrastructure
1.1 dsieger 7715:
1.154 rillig 7716: 26.1. The meaning of variable definitions
7717: 26.2. Avoiding problems before they arise
7718: 26.3. Variable evaluation
1.1 dsieger 7719:
1.154 rillig 7720: 26.3.1. At load time
7721: 26.3.2. At runtime
1.1 dsieger 7722:
1.154 rillig 7723: 26.4. How can variables be specified?
7724: 26.5. Designing interfaces for Makefile fragments
1.1 dsieger 7725:
1.154 rillig 7726: 26.5.1. Procedures with parameters
7727: 26.5.2. Actions taken on behalf of parameters
1.1 dsieger 7728:
1.154 rillig 7729: 26.6. The order in which files are loaded
1.1 dsieger 7730:
1.154 rillig 7731: 26.6.1. The order in bsd.prefs.mk
7732: 26.6.2. The order in bsd.pkg.mk
1.1 dsieger 7733:
1.154 rillig 7734: 27. Regression tests
1.1 dsieger 7735:
1.154 rillig 7736: 27.1. Running the regression tests
7737: 27.2. Adding a new regression test
1.1 dsieger 7738:
1.154 rillig 7739: 27.2.1. Overridable functions
7740: 27.2.2. Helper functions
1.1 dsieger 7741:
1.154 rillig 7742: 28. Porting pkgsrc
1.1 dsieger 7743:
1.154 rillig 7744: 28.1. Porting pkgsrc to a new operating system
1.1 dsieger 7745:
1.154 rillig 7746: Chapter 26. Design of the pkgsrc infrastructure
1.1 dsieger 7747:
7748: Table of Contents
7749:
1.154 rillig 7750: 26.1. The meaning of variable definitions
7751: 26.2. Avoiding problems before they arise
7752: 26.3. Variable evaluation
1.1 dsieger 7753:
1.154 rillig 7754: 26.3.1. At load time
7755: 26.3.2. At runtime
1.1 dsieger 7756:
1.154 rillig 7757: 26.4. How can variables be specified?
7758: 26.5. Designing interfaces for Makefile fragments
1.1 dsieger 7759:
1.154 rillig 7760: 26.5.1. Procedures with parameters
7761: 26.5.2. Actions taken on behalf of parameters
1.1 dsieger 7762:
1.154 rillig 7763: 26.6. The order in which files are loaded
1.1 dsieger 7764:
1.154 rillig 7765: 26.6.1. The order in bsd.prefs.mk
7766: 26.6.2. The order in bsd.pkg.mk
1.1 dsieger 7767:
7768: The pkgsrc infrastructure consists of many small Makefile fragments. Each such
7769: fragment needs a properly specified interface. This chapter explains how such
7770: an interface looks like.
7771:
1.154 rillig 7772: 26.1. The meaning of variable definitions
1.1 dsieger 7773:
7774: Whenever a variable is defined in the pkgsrc infrastructure, the location and
7775: the way of definition provide much information about the intended use of that
7776: variable. Additionally, more documentation may be found in a header comment or
7777: in this pkgsrc guide.
7778:
7779: A special file is mk/defaults/mk.conf, which lists all variables that are
7780: intended to be user-defined. They are either defined using the ?= operator or
7781: they are left undefined because defining them to anything would effectively
7782: mean "yes". All these variables may be overridden by the pkgsrc user in the
7783: MAKECONF file.
7784:
7785: Outside this file, the following conventions apply: Variables that are defined
7786: using the ?= operator may be overridden by a package.
7787:
7788: Variables that are defined using the = operator may be used read-only at
7789: run-time.
7790:
7791: Variables whose name starts with an underscore must not be accessed outside the
7792: pkgsrc infrastructure at all. They may change without further notice.
7793:
7794: Note
7795:
7796: These conventions are currently not applied consistently to the complete pkgsrc
7797: infrastructure.
7798:
1.154 rillig 7799: 26.2. Avoiding problems before they arise
1.1 dsieger 7800:
7801: All variables that contain lists of things should default to being empty. Two
7802: examples that do not follow this rule are USE_LANGUAGES and DISTFILES. These
7803: variables cannot simply be modified using the += operator in package Makefiles
7804: (or other files included by them), since there is no guarantee whether the
7805: variable is already set or not, and what its value is. In the case of
7806: DISTFILES, the packages "know" the default value and just define it as in the
7807: following example.
7808:
7809: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
7810:
7811: Because of the selection of this default value, the same value appears in many
7812: package Makefiles. Similarly for USE_LANGUAGES, but in this case the default
7813: value ("c") is so short that it doesn't stand out. Nevertheless it is mentioned
7814: in many files.
7815:
1.154 rillig 7816: 26.3. Variable evaluation
1.1 dsieger 7817:
1.154 rillig 7818: 26.3.1. At load time
1.1 dsieger 7819:
7820: Variable evaluation takes place either at load time or at runtime, depending on
7821: the context in which they occur. The contexts where variables are evaluated at
7822: load time are:
7823:
7824: * The right hand side of the := and != operators,
7825:
7826: * Make directives like .if or .for,
7827:
7828: * Dependency lines.
7829:
7830: A special exception are references to the iteration variables of .for loops,
7831: which are expanded inline, no matter in which context they appear.
7832:
7833: As the values of variables may change during load time, care must be taken not
7834: to evaluate them by accident. Typical examples for variables that should not be
7835: evaluated at load time are DEPENDS and CONFIGURE_ARGS. To make the effect more
7836: clear, here is an example:
7837:
7838: CONFIGURE_ARGS= # none
7839: CFLAGS= -O
7840: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
7841:
7842: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
7843:
7844: CFLAGS+= -Wall
7845:
7846: This code shows how the use of the := operator can quickly lead to unexpected
7847: results. The first paragraph is fairly common code. The second paragraph
7848: evaluates the CONFIGURE_ARGS variable, which results in CFLAGS=-O. In the third
7849: paragraph, the -Wall is appended to the CFLAGS, but this addition will not
7850: appear in CONFIGURE_ARGS. In actual code, the three paragraphs from above
7851: typically occur in completely unrelated files.
7852:
1.154 rillig 7853: 26.3.2. At runtime
1.1 dsieger 7854:
7855: After all the files have been loaded, the values of the variables cannot be
7856: changed anymore. Variables that are used in the shell commands are expanded at
7857: this point.
7858:
1.154 rillig 7859: 26.4. How can variables be specified?
1.1 dsieger 7860:
7861: There are many ways in which the definition and use of a variable can be
7862: restricted in order to detect bugs and violations of the (mostly unwritten)
1.108 rillig 7863: policies. A package can be checked with pkglint -Wall to see whether it meets
7864: these rules.
1.1 dsieger 7865:
1.154 rillig 7866: 26.5. Designing interfaces for Makefile fragments
1.1 dsieger 7867:
7868: Most of the .mk files fall into one of the following classes. Cases where a
7869: file falls into more than one class should be avoided as it often leads to
7870: subtle bugs.
7871:
1.154 rillig 7872: 26.5.1. Procedures with parameters
1.1 dsieger 7873:
7874: In a traditional imperative programming language some of the .mk files could be
1.23 jakllsch 7875: described as procedures. They take some input parameters and?after
7876: inclusion?provide a result in output parameters. Since all variables in
7877: Makefiles have global scope care must be taken not to use parameter names that
7878: have already another meaning. For example, PKGNAME is a bad choice for a
7879: parameter name.
1.1 dsieger 7880:
7881: Procedures are completely evaluated at preprocessing time. That is, when
7882: calling a procedure all input parameters must be completely resolvable. For
7883: example, CONFIGURE_ARGS should never be an input parameter since it is very
7884: likely that further text will be added after calling the procedure, which would
7885: effectively apply the procedure to only a part of the variable. Also,
1.108 rillig 7886: references to other variables will be modified after calling the procedure.
1.1 dsieger 7887:
7888: A procedure can declare its output parameters either as suitable for use in
7889: preprocessing directives or as only available at runtime. The latter
7890: alternative is for variables that contain references to other runtime
7891: variables.
7892:
7893: Procedures shall be written such that it is possible to call the procedure more
7894: than once. That is, the file must not contain multiple-inclusion guards.
7895:
7896: Examples for procedures are mk/bsd.options.mk and mk/buildlink3/bsd.builtin.mk.
7897: To express that the parameters are evaluated at load time, they should be
7898: assigned using the := operator, which should be used only for this purpose.
7899:
1.154 rillig 7900: 26.5.2. Actions taken on behalf of parameters
1.1 dsieger 7901:
7902: Action files take some input parameters and may define runtime variables. They
7903: shall not define loadtime variables. There are action files that are included
7904: implicitly by the pkgsrc infrastructure, while other must be included
7905: explicitly.
7906:
7907: An example for action files is mk/subst.mk.
7908:
1.154 rillig 7909: 26.6. The order in which files are loaded
1.1 dsieger 7910:
7911: Package Makefiles usually consist of a set of variable definitions, and include
7912: the file ../../mk/bsd.pkg.mk in the very last line. Before that, they may also
7913: include various other *.mk files if they need to query the availability of
7914: certain features like the type of compiler or the X11 implementation. Due to
7915: the heavy use of preprocessor directives like .if and .for, the order in which
7916: the files are loaded matters.
7917:
7918: This section describes at which point the various files are loaded and gives
7919: reasons for that order.
7920:
1.154 rillig 7921: 26.6.1. The order in bsd.prefs.mk
1.1 dsieger 7922:
7923: The very first action in bsd.prefs.mk is to define some essential variables
7924: like OPSYS, OS_VERSION and MACHINE_ARCH.
7925:
1.4 rillig 7926: Then, the user settings are loaded from the file specified in MAKECONF, which
7927: is usually mk.conf. After that, those variables that have not been overridden
7928: by the user are loaded from mk/defaults/mk.conf.
1.1 dsieger 7929:
7930: After the user settings, the system settings and platform settings are loaded,
7931: which may override the user settings.
7932:
7933: Then, the tool definitions are loaded. The tool wrappers are not yet in effect.
7934: This only happens when building a package, so the proper variables must be used
7935: instead of the direct tool names.
7936:
7937: As the last steps, some essential variables from the wrapper and the package
7938: system flavor are loaded, as well as the variables that have been cached in
7939: earlier phases of a package build.
7940:
1.154 rillig 7941: 26.6.2. The order in bsd.pkg.mk
1.1 dsieger 7942:
7943: First, bsd.prefs.mk is loaded.
7944:
7945: Then, the various *-vars.mk files are loaded, which fill default values for
7946: those variables that have not been defined by the package. These variables may
7947: later be used even in unrelated files.
7948:
7949: Then, the file bsd.pkg.error.mk provides the target error-check that is added
7950: as a special dependency to all other targets that use DELAYED_ERROR_MSG or
7951: DELAYED_WARNING_MSG.
7952:
7953: Then, the package-specific hacks from hacks.mk are included.
7954:
7955: Then, various other files follow. Most of them don't have any dependencies on
7956: what they need to have included before or after them, though some do.
7957:
7958: The code to check PKG_FAIL_REASON and PKG_SKIP_REASON is then executed, which
7959: restricts the use of these variables to all the files that have been included
7960: before. Appearances in later files will be silently ignored.
7961:
7962: Then, the files for the main targets are included, in the order of later
7963: execution, though the actual order should not matter.
7964:
7965: At last, some more files are included that don't set any interesting variables
7966: but rather just define make targets to be executed.
7967:
1.154 rillig 7968: Chapter 27. Regression tests
1.1 dsieger 7969:
7970: Table of Contents
7971:
1.154 rillig 7972: 27.1. Running the regression tests
7973: 27.2. Adding a new regression test
1.1 dsieger 7974:
1.154 rillig 7975: 27.2.1. Overridable functions
7976: 27.2.2. Helper functions
1.1 dsieger 7977:
7978: The pkgsrc infrastructure consists of a large codebase, and there are many
7979: corners where every little bit of a file is well thought out, making pkgsrc
7980: likely to fail as soon as anything is changed near those parts. To prevent most
7981: changes from breaking anything, a suite of regression tests should go along
7982: with every important part of the pkgsrc infrastructure. This chapter describes
7983: how regression tests work in pkgsrc and how you can add new tests.
7984:
1.154 rillig 7985: 27.1. Running the regression tests
1.1 dsieger 7986:
1.25 wiz 7987: You first need to install the pkgtools/pkg_regress package, which provides the
1.1 dsieger 7988: pkg_regress command. Then you can simply run that command, which will run all
7989: tests in the regress category.
7990:
1.154 rillig 7991: 27.2. Adding a new regression test
1.1 dsieger 7992:
7993: Every directory in the regress category that contains a file called spec is
7994: considered a regression test. This file is a shell program that is included by
7995: the pkg_regress command. The following functions can be overridden to suit your
7996: needs.
7997:
1.154 rillig 7998: 27.2.1. Overridable functions
1.1 dsieger 7999:
1.108 rillig 8000: These functions do not take any parameters. Although they are called in "set -e
8001: " mode, they don't stop at the first failing command. See this StackOverflow
8002: question for details.
1.1 dsieger 8003:
1.108 rillig 8004: do_setup
1.1 dsieger 8005:
8006: This function prepares the environment for the test. By default it does
8007: nothing.
8008:
1.108 rillig 8009: do_test
1.1 dsieger 8010:
8011: This function runs the actual test. By default, it calls TEST_MAKE with the
8012: arguments MAKEARGS_TEST and writes its output including error messages into
8013: the file TEST_OUTFILE.
8014:
1.108 rillig 8015: When defining this function, make sure that all output that needs to be
8016: checked is written to the correct output file. Example:
8017:
8018: do_test() {
8019: echo "Example output"
8020: } 1>$TEST_OUTFILE 2>&1
8021:
8022: check_result
1.1 dsieger 8023:
8024: This function is run after the test and is typically used to compare the
8025: actual output from the one that is expected. It can make use of the various
1.108 rillig 8026: helper functions from the next section. Example:
8027:
8028: check_result() {
8029: exit_status 0
8030: output_require "Example"
8031: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
8032: output_prohibit "no such file or directory"
8033: }
1.1 dsieger 8034:
1.108 rillig 8035: do_cleanup
1.1 dsieger 8036:
8037: This function cleans everything up after the test has been run. By default
8038: it does nothing.
8039:
1.154 rillig 8040: 27.2.2. Helper functions
1.1 dsieger 8041:
1.108 rillig 8042: exit_status expected
1.1 dsieger 8043:
1.108 rillig 8044: This function compares the exitcode of the do_test function with its first
8045: parameter. If they differ, the test will fail.
1.1 dsieger 8046:
1.108 rillig 8047: output_require regex...
1.1 dsieger 8048:
8049: This function checks for each of its parameters if the output from do_test
1.108 rillig 8050: matches the extended regular expression. If it does not, the test will
8051: fail. Example:
8052:
8053: output_require "looks fine"
8054: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.1 dsieger 8055:
8056: output_prohibit(regex...)
8057:
8058: This function checks for each of its parameters if the output from do_test
8059: () does not match the extended regular expression. If any of the regular
8060: expressions matches, the test will fail.
8061:
1.154 rillig 8062: Chapter 28. Porting pkgsrc
1.1 dsieger 8063:
8064: Table of Contents
8065:
1.154 rillig 8066: 28.1. Porting pkgsrc to a new operating system
1.1 dsieger 8067:
8068: The pkgsrc system has already been ported to many operating systems, hardware
8069: architectures and compilers. This chapter explains the necessary steps to make
8070: pkgsrc even more portable.
8071:
1.154 rillig 8072: 28.1. Porting pkgsrc to a new operating system
1.1 dsieger 8073:
8074: To port pkgsrc to a new operating system (called MyOS in this example), you
8075: need to touch the following files:
8076:
8077: pkgtools/bootstrap-mk-files/files/mods/MyOS.sys.mk
8078:
8079: This file contains some basic definitions, for example the name of the C
8080: compiler.
8081:
8082: mk/bsd.prefs.mk
8083:
8084: Insert code that defines the variables OPSYS, OS_VERSION, LOWER_OS_VERSION,
8085: LOWER_VENDOR, MACHINE_ARCH, OBJECT_FMT, APPEND_ELF, and the other variables
8086: that appear in this file.
8087:
8088: mk/platform/MyOS.mk
8089:
8090: This file contains the platform-specific definitions that are used by
8091: pkgsrc. Start by copying one of the other files and edit it to your needs.
8092:
8093: mk/tools/tools.MyOS.mk
8094:
8095: This file defines the paths to all the tools that are needed by one or the
8096: other package in pkgsrc, as well as by pkgsrc itself. Find out where these
8097: tools are on your platform and add them.
8098:
8099: Now, you should be able to build some basic packages, like lang/perl5, shells/
8100: bash.
8101:
8102: Appendix A. A simple example package: bison
8103:
8104: Table of Contents
8105:
8106: A.1. files
8107:
8108: A.1.1. Makefile
8109: A.1.2. DESCR
8110: A.1.3. PLIST
8111: A.1.4. Checking a package with pkglint
8112:
8113: A.2. Steps for building, installing, packaging
8114:
8115: We checked to find a piece of software that wasn't in the packages collection,
1.25 wiz 8116: and picked GNU bison. Quite why someone would want to have bison when Berkeley
1.1 dsieger 8117: yacc is already present in the tree is beyond us, but it's useful for the
8118: purposes of this exercise.
8119:
8120: A.1. files
8121:
8122: A.1.1. Makefile
8123:
1.2 rillig 8124: # $NetBSD$
1.1 dsieger 8125: #
8126:
8127: DISTNAME= bison-1.25
8128: CATEGORIES= devel
8129: MASTER_SITES= ${MASTER_SITE_GNU}
8130:
1.30 dholland 8131: MAINTAINER= pkgsrc-users@NetBSD.org
1.1 dsieger 8132: HOMEPAGE= http://www.gnu.org/software/bison/bison.html
8133: COMMENT= GNU yacc clone
8134:
8135: GNU_CONFIGURE= yes
1.47 wiz 8136: INFO_FILES= yes
1.1 dsieger 8137:
8138: .include "../../mk/bsd.pkg.mk"
8139:
8140: A.1.2. DESCR
8141:
8142: GNU version of yacc. Can make re-entrant parsers, and numerous other
8143: improvements. Why you would want this when Berkeley yacc(1) is part
8144: of the NetBSD source tree is beyond me.
8145:
8146: A.1.3. PLIST
8147:
1.2 rillig 8148: @comment $NetBSD$
1.1 dsieger 8149: bin/bison
8150: man/man1/bison.1.gz
8151: share/bison.simple
8152: share/bison.hairy
8153:
8154: A.1.4. Checking a package with pkglint
8155:
8156: The NetBSD package system comes with pkgtools/pkglint which helps to check the
8157: contents of these files. After installation it is quite easy to use, just
8158: change to the directory of the package you wish to examine and execute pkglint:
8159:
8160: $ pkglint
8161: looks fine.
8162:
8163: Depending on the supplied command line arguments (see pkglint(1)), more checks
8164: will be performed. Use e.g. pkglint -Call -Wall for a very thorough check.
8165:
8166: A.2. Steps for building, installing, packaging
8167:
8168: Create the directory where the package lives, plus any auxiliary directories:
8169:
8170: # cd /usr/pkgsrc/lang
8171: # mkdir bison
8172: # cd bison
8173: # mkdir patches
8174:
1.154 rillig 8175: Create Makefile, DESCR and PLIST (see Chapter 13, Package components - files,
1.1 dsieger 8176: directories and contents) then continue with fetching the distfile:
8177:
8178: # make fetch
8179: >> bison-1.25.tar.gz doesn't seem to exist on this system.
8180: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
8181: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8182: ftp: Error retrieving file: 500 Internal error
8183:
8184: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
8185: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8186: ftp: Error retrieving file: 500 Internal error
8187:
8188: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
8189: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8190: Successfully retrieved file.
8191:
8192: Generate the checksum of the distfile into distinfo:
8193:
8194: # make makedistinfo
8195:
8196: Now compile:
8197:
8198: # make
8199: >> Checksum OK for bison-1.25.tar.gz.
8200: ===> Extracting for bison-1.25
8201: ===> Patching for bison-1.25
8202: ===> Ignoring empty patch directory
8203: ===> Configuring for bison-1.25
8204: creating cache ./config.cache
8205: checking for gcc... cc
8206: checking whether we are using GNU C... yes
8207: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
8208: checking how to run the C preprocessor... cc -E
8209: checking for minix/config.h... no
8210: checking for POSIXized ISC... no
8211: checking whether cross-compiling... no
8212: checking for ANSI C header files... yes
8213: checking for string.h... yes
8214: checking for stdlib.h... yes
8215: checking for memory.h... yes
8216: checking for working const... yes
8217: checking for working alloca.h... no
8218: checking for alloca... yes
8219: checking for strerror... yes
8220: updating cache ./config.cache
8221: creating ./config.status
8222: creating Makefile
8223: ===> Building for bison-1.25
8224: 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
8225: 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
8226: 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
8227: 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
8228: 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
8229: 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
8230: 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
8231: 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
8232: 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
8233: 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
8234: 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
8235: 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
8236: 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
8237: 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
8238: 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
8239: 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
8240: 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
8241: 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
8242: 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
8243: 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
8244: 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
8245: 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
8246: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
8247: rm -f bison.s1
8248: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1
8249:
8250: Everything seems OK, so install the files:
8251:
8252: # make install
8253: >> Checksum OK for bison-1.25.tar.gz.
8254: ===> Installing for bison-1.25
8255: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
8256: rm -f /usr/pkg/bin/bison
8257: cd /usr/pkg/share; rm -f bison.simple bison.hairy
8258: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
8259: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
8260: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
8261: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
8262: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
8263: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
8264: ===> Registering installation for bison-1.25
8265:
8266: You can now use bison, and also - if you decide so - remove it with pkg_delete
8267: bison. Should you decide that you want a binary package, do this now:
8268:
8269: # make package
8270: >> Checksum OK for bison-1.25.tar.gz.
8271: ===> Building package for bison-1.25
8272: Creating package bison-1.25.tgz
8273: Registering depends:.
8274: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'
8275:
8276: Now that you don't need the source and object files any more, clean up:
8277:
8278: # make clean
8279: ===> Cleaning for bison-1.25
8280:
8281: Appendix B. Build logs
8282:
8283: Table of Contents
8284:
8285: B.1. Building figlet
8286: B.2. Packaging figlet
8287:
8288: B.1. Building figlet
8289:
8290: # make
8291: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8292: => figlet221.tar.gz doesn't seem to exist on this system.
8293: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
8294: => [172219 bytes]
8295: Connected to ftp.plig.net.
8296: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
8297: 331 Guest login ok, send your complete e-mail address as password.
8298: 230-You are user #5 of 500 simultaneous users allowed.
8299: 230-
8300: 230- ___ _ _ _
8301: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
8302: 230- | _| _| . |_| . | | | . |_| . | _| . |
8303: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
8304: 230- |_| |_| |___| |___|
8305: 230-
8306: 230-** Welcome to ftp.plig.org **
8307: 230-
8308: 230-Please note that all transfers from this FTP site are logged. If you
8309: 230-do not like this, please disconnect now.
8310: 230-
1.19 snj 8311: 230-This archive is available via
1.1 dsieger 8312: 230-
8313: 230-HTTP: http://ftp.plig.org/
8314: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
8315: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
8316: 230-
8317: 230-Please email comments, bug reports and requests for packages to be
8318: 230-mirrored to ftp-admin@plig.org.
8319: 230-
8320: 230-
8321: 230 Logged in anonymously.
8322: Remote system type is UNIX.
8323: Using binary mode to transfer files.
8324: 200 Type okay.
8325: 250 "/pub" is new cwd.
8326: 250-"/pub/figlet" is new cwd.
8327: 250-
8328: 250-Welcome to the figlet archive at ftp.figlet.org
8329: 250-
8330: 250- ftp://ftp.figlet.org/pub/figlet/
8331: 250-
8332: 250-The official FIGlet web page is:
8333: 250- http://www.figlet.org/
8334: 250-
8335: 250-If you have questions, please mailto:info@figlet.org. If you want to
8336: 250-contribute a font or something else, you can email us.
8337: 250
8338: 250 "/pub/figlet/program" is new cwd.
8339: 250 "/pub/figlet/program/unix" is new cwd.
8340: local: figlet221.tar.gz remote: figlet221.tar.gz
8341: 502 Unimplemented command.
8342: 227 Entering Passive Mode (195,40,6,41,246,104)
8343: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
8344: 38% |************** | 65800 64.16 KB/s 00:01 ETA
8345: 226 Transfer completed.
8346: 172219 bytes received in 00:02 (75.99 KB/s)
8347: 221 Goodbye.
8348: => Checksum OK for figlet221.tar.gz.
8349: ===> Extracting for figlet-2.2.1nb2
8350: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
8351: ===> Patching for figlet-2.2.1nb2
8352: ===> Applying pkgsrc patches for figlet-2.2.1nb2
8353: ===> Overriding tools for figlet-2.2.1nb2
8354: ===> Creating toolchain wrappers for figlet-2.2.1nb2
8355: ===> Configuring for figlet-2.2.1nb2
8356: ===> Building for figlet-2.2.1nb2
8357: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
8358: chmod a+x figlet
8359: gcc -O2 -o chkfont chkfont.c
8360: => Unwrapping files-to-be-installed.
8361: #
8362: # make install
8363: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8364: ===> Installing for figlet-2.2.1nb2
8365: install -d -o root -g wheel -m 755 /usr/pkg/bin
8366: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
8367: mkdir -p /usr/pkg/share/figlet
8368: cp figlet /usr/pkg/bin
8369: cp chkfont /usr/pkg/bin
8370: chmod 555 figlist showfigfonts
8371: cp figlist /usr/pkg/bin
8372: cp showfigfonts /usr/pkg/bin
8373: cp fonts/*.flf /usr/pkg/share/figlet
8374: cp fonts/*.flc /usr/pkg/share/figlet
8375: cp figlet.6 /usr/pkg/man/man6
8376: ===> Registering installation for figlet-2.2.1nb2
8377: #
8378:
8379: B.2. Packaging figlet
8380:
8381: # make package
8382: ===> Checking for vulnerabilities in figlet-2.2.1nb2
8383: ===> Packaging figlet-2.2.1nb2
8384: ===> Building binary package for figlet-2.2.1nb2
8385: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
8386: Using SrcDir value of /usr/pkg
8387: Registering depends:.
8388: #
8389:
8390: Appendix C. Directory layout of the pkgsrc FTP server
8391:
8392: Table of Contents
8393:
1.23 jakllsch 8394: C.1. distfiles: The distributed source files
8395: C.2. misc: Miscellaneous things
8396: C.3. packages: Binary packages
8397: C.4. reports: Bulk build reports
1.148 leot 8398: C.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 8399:
8400: As in other big projects, the directory layout of pkgsrc is quite complex for
8401: newbies. This chapter explains where you find things on the FTP server. The
8402: base directory on ftp.NetBSD.org is /pub/pkgsrc/. On other servers it may be
8403: different, but inside this directory, everything should look the same, no
8404: matter on which server you are. This directory contains some subdirectories,
8405: which are explained below.
8406:
1.23 jakllsch 8407: C.1. distfiles: The distributed source files
1.1 dsieger 8408:
8409: The directory distfiles contains lots of archive files from all pkgsrc
8410: packages, which are mirrored here. The subdirectories are called after their
8411: package names and are used when the distributed files have names that don't
8412: explicitly contain a version number or are otherwise too generic (for example
8413: release.tar.gz).
8414:
1.23 jakllsch 8415: C.2. misc: Miscellaneous things
1.1 dsieger 8416:
8417: This directory contains things that individual pkgsrc developers find worth
8418: publishing.
8419:
1.23 jakllsch 8420: C.3. packages: Binary packages
1.1 dsieger 8421:
1.3 rillig 8422: This directory contains binary packages for the various platforms that are
8423: supported by pkgsrc. Each subdirectory is of the form OPSYS/ARCH/OSVERSION_TAG.
8424: The meaning of these variables is:
8425:
8426: * OPSYS is the name of the operating system for which the packages have been
1.9 rillig 8427: built. The name is taken from the output of the uname command, so it may
8428: differ from the one you are used to hear.
1.3 rillig 8429:
1.8 rillig 8430: * ARCH is the hardware architecture of the platform for which the packages
1.10 hubertf 8431: have been built. It also includes the ABI (Application Binary Interface)
8432: for platforms that have several of them.
1.3 rillig 8433:
1.8 rillig 8434: * OSVERSION is the version of the operating system. For version numbers that
8435: change often (for example NetBSD-current), the often-changing part should
8436: be replaced with an x, for example 4.99.x.
1.3 rillig 8437:
1.23 jakllsch 8438: * TAG is either 20xxQy for a stable branch, or head for packages built from
1.8 rillig 8439: the HEAD branch. The latter should only be used when the packages are
8440: updated on a regular basis. Otherwise the date from checking out pkgsrc
8441: should be appended, for example head_20071015.
1.3 rillig 8442:
8443: The rationale for exactly this scheme is that the pkgsrc users looking for
8444: binary packages can quickly click through the directories on the server and
8445: find the best binary packages for their machines. Since they usually know the
8446: operating system and the hardware architecture, OPSYS and ARCH are placed
8447: first. After these choices, they can select the best combination of OSVERSION
8448: and TAG together, since it is usually the case that packages stay compatible
8449: between different version of the operating system.
8450:
8451: In each of these directories, there is a whole binary packages collection for a
8452: specific platform. It has a directory called All which contains all binary
8453: packages. Besides that, there are various category directories that contain
8454: symbolic links to the real binary packages.
1.1 dsieger 8455:
1.23 jakllsch 8456: C.4. reports: Bulk build reports
1.8 rillig 8457:
8458: Here are the reports from bulk builds, for those who want to fix packages that
8459: didn't build on some of the platforms. The structure of subdirectories should
1.23 jakllsch 8460: look like the one in Section C.3, "packages: Binary packages".
1.8 rillig 8461:
1.148 leot 8462: C.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 8463:
8464: These directories contain the "real" pkgsrc, that is the files that define how
8465: to create binary packages from source archives.
8466:
1.149 leot 8467: Each of the current, stable and pkgsrc-20xxQy directories share the same
8468: structure. They each contain a pkgsrc directory and pkgsrc.tar.{bz,gz,xz} file.
8469:
1.1 dsieger 8470: The directory pkgsrc contains a snapshot of the CVS repository, which is
1.149 leot 8471: updated regularly. The file pkgsrc.tar.{bz,gz,xz} contains the same as the
8472: directory, ready to be downloaded as a whole.
1.1 dsieger 8473:
1.149 leot 8474: The current directory contains files related to the HEAD branch of the CVS
8475: repository. In this directory there is an additional file called
8476: pkgsrc-readmes.tar.{bz,gz,xz} that contains all pkgsrc READMEs with information
8477: about categories and packages.
8478:
8479: The stable directory is a symlink to the latest pkgsrc-20xxQy.
8480:
8481: The pkgsrc-20xxQy. directories contain files related to the -20xxQy stable
8482: branch of the CVS repository. In these directories there is an additional file
8483: called pkgsrc-20xxQy.tar.{bz,gz,xz}, which contains the state of pkgsrc when it
8484: was branched.
1.148 leot 8485:
1.154 rillig 8486: Appendix D. Help topics
8487:
8488: The following list contains all help topics that are available when running
8489: bmake help topic=:index.
8490:
8491: * #!
8492:
8493: * -lintl
8494:
8495: * 64bit
8496:
8497: * ABI
8498:
8499: * ACCEPTABLE_LICENSES
8500:
8501: * ACROREAD_FONTPATH
8502:
8503: * ADDITIONAL
8504:
8505: * AFAIK
8506:
8507: * AIX
8508:
8509: * ALLOW_VULNERABLE_PACKAGES
8510:
8511: * ALL_ENV
8512:
8513: * ALTERNATIVES_SRC
8514:
8515: * AMANDA_TMP
8516:
8517: * AMANDA_USER
8518:
8519: * AMANDA_VAR
8520:
8521: * APACHE_GROUP
8522:
8523: * APACHE_MODULE_NAME
8524:
8525: * APACHE_MODULE_SRC
8526:
8527: * APACHE_MODULE_SRCDIR
8528:
8529: * APACHE_PKG_PREFIX
8530:
8531: * APACHE_SUEXEC_CONFIGURE_ARGS
8532:
8533: * APACHE_SUEXEC_DOCROOT
8534:
8535: * APACHE_USER
8536:
8537: * APPEND_ABI
8538:
8539: * APPEND_ELF
8540:
8541: * ARLA_CACHE
8542:
8543: * AUDIT_PACKAGES_FLAGS
8544:
8545: * AUTOCONF_REQD
8546:
8547: * AUTOMAKE_OVERRIDE
8548:
8549: * AUTOMAKE_REQD
8550:
8551: * AUTO_MKDIRS
8552:
8553: * BDB185_DEFAULT
8554:
8555: * BDBBASE
8556:
8557: * BDB_ACCEPTED
8558:
8559: * BDB_DEFAULT
8560:
8561: * BDB_LIBS
8562:
8563: * BDB_TYPE
8564:
8565: * BIND_DIR
8566:
8567: * BIND_GROUP
8568:
8569: * BIND_USER
8570:
8571: * BINPKG_SITES
8572:
8573: * BIN_INSTALL_FLAGS
8574:
8575: * BISON_PKGDATADIR
8576:
8577: * BOOTSTRAP_DEPENDS
8578:
8579: * BOOTSTRAP_SETUPTOOLS
8580:
8581: * BROKEN
8582:
8583: * BROKEN_EXCEPT_ON_PLATFORM
8584:
8585: * BROKEN_ON_PLATFORM
8586:
8587: * BSDSRCDIR
8588:
8589: * BSDXSRCDIR
8590:
8591: * BSD_MAKE_ENV
8592:
8593: * BUILDLINK_AUTO_DIRS
8594:
8595: * BUILDLINK_AUTO_VARS
8596:
8597: * BUILDLINK_CFLAGS
8598:
8599: * BUILDLINK_CONTENTS_FILTER
8600:
8601: * BUILDLINK_CPPFLAGS
8602:
8603: * BUILDLINK_DEPMETHOD
8604:
8605: * BUILDLINK_FILES
8606:
8607: * BUILDLINK_FILES_CMD
8608:
8609: * BUILDLINK_FNAME_TRANSFORM
8610:
8611: * BUILDLINK_LDFLAGS
8612:
8613: * BUILDLINK_LIBS
8614:
8615: * BUILDLINK_OPSYS_SUPPORT_PTHREAD
8616:
8617: * BUILDLINK_PKGNAME
8618:
8619: * BUILDLINK_PREFIX
8620:
8621: * BUILDLINK_RPATHDIRS
8622:
8623: * BUILDLINK_TREE
8624:
8625: * BUILD_DEFS
8626:
8627: * BUILD_DEFS_EFFECTS
8628:
8629: * BUILD_DIRS
8630:
8631: * BUILD_ENV_SHELL
8632:
8633: * BUILD_MAKE_CMD
8634:
8635: * BUILD_MAKE_FLAGS
8636:
8637: * BUILD_TARGET
8638:
8639: * BUILTIN_FIND_FILES
8640:
8641: * BUILTIN_FIND_FILES_VAR
8642:
8643: * BUILTIN_FIND_GREP
8644:
8645: * BUILTIN_FIND_HEADERS
8646:
8647: * BUILTIN_FIND_HEADERS_VAR
8648:
8649: * BUILTIN_PKG
8650:
8651: * BUILTIN_TEST_CURSES_DEFINES
8652:
8653: * BUILTIN_TEST_CURSES_FUNCS
8654:
8655: * BUILTIN_VERSION_SCRIPT
8656:
8657: * BUILTIN_X11_TYPE
8658:
8659: * BUILTIN_X11_VERSION
8660:
8661: * CACTI_GROUP
8662:
8663: * CACTI_USER
8664:
8665: * CANNA_GROUP
8666:
8667: * CANNA_USER
8668:
8669: * CAT
8670:
8671: * CCACHE_BASE
8672:
8673: * CCACHE_DIR
8674:
8675: * CCACHE_LOGFILE
8676:
8677: * CC_VERSION
8678:
8679: * CC_VERSION_STRING
8680:
8681: * CDRECORD_CONF
8682:
8683: * CDROM_PKG_URL_DIR
8684:
8685: * CDROM_PKG_URL_HOST
8686:
8687: * CHECK_FAKEHOME
8688:
8689: * CHECK_FILES
8690:
8691: * CHECK_FILES_SKIP
8692:
8693: * CHECK_FILES_STRICT
8694:
8695: * CHECK_HEADERS
8696:
8697: * CHECK_HEADERS_SKIP
8698:
8699: * CHECK_INTERPRETER
8700:
8701: * CHECK_INTERPRETER_SKIP
8702:
8703: * CHECK_PERMS
8704:
8705: * CHECK_PERMS_AUTOFIX
8706:
8707: * CHECK_PERMS_SKIP
8708:
8709: * CHECK_PORTABILITY
8710:
8711: * CHECK_PORTABILITY_SKIP
8712:
8713: * CHECK_RELRO
8714:
8715: * CHECK_RELRO_SKIP
8716:
8717: * CHECK_RELRO_SUPPORTED
8718:
8719: * CHECK_SHLIBS
8720:
8721: * CHECK_SHLIBS_BLACKLIST
8722:
8723: * CHECK_SHLIBS_SKIP
8724:
8725: * CHECK_SHLIBS_SUPPORTED
8726:
8727: * CHECK_SSP
8728:
8729: * CHECK_SSP_SKIP
8730:
8731: * CHECK_SSP_SUPPORTED
8732:
8733: * CHECK_STRIPPED
8734:
8735: * CHECK_STRIPPED_SKIP
8736:
8737: * CHECK_WRKREF
8738:
8739: * CHECK_WRKREF_EXTRA_DIRS
8740:
8741: * CHECK_WRKREF_SKIP
8742:
8743: * CLAMAV_DBDIR
8744:
8745: * CLAMAV_GROUP
8746:
8747: * CLAMAV_USER
8748:
8749: * CLANGBASE
8750:
8751: * CLEANDEPENDS
8752:
8753: * CMAKE_DEPENDENCIES_REWRITE
8754:
8755: * CMAKE_INSTALL_PREFIX
8756:
8757: * CMAKE_MODULE_PATH_OVERRIDE
8758:
8759: * CMAKE_PKGSRC_BUILD_FLAGS
8760:
8761: * CMAKE_PREFIX_PATH
8762:
8763: * CMAKE_USE_GNU_INSTALL_DIRS
8764:
8765: * COMPILER_RPATH_FLAG
8766:
8767: * COMPILER_USE_SYMLINKS
8768:
8769: * CONFIGURE_ARGS
8770:
8771: * CONFIGURE_DIRS
8772:
8773: * CONFIGURE_ENV
8774:
8775: * CONFIGURE_HAS_INFODIR
8776:
8777: * CONFIGURE_HAS_MANDIR
8778:
8779: * CONFIGURE_SCRIPT
8780:
8781: * CONFIG_SHELL
8782:
8783: * CONFIG_SHELL_FLAGS
8784:
8785: * CONF_FILES
8786:
8787: * CONF_FILES_MODE
8788:
8789: * CONF_FILES_PERMS
8790:
8791: * CONSERVER_DEFAULTHOST
8792:
8793: * CONSERVER_DEFAULTPORT
8794:
8795: * CP
8796:
8797: * CPP
8798:
8799: * CPP_PRECOMP_FLAGS
8800:
8801: * CREATE_WRKDIR_SYMLINK
8802:
8803: * CROSSBASE
8804:
8805: * CTFCONVERT
8806:
8807: * CTF_FILES_SKIP
8808:
8809: * CTF_SUPPORTED
8810:
8811: * CTYPE
8812:
8813: * CUPS_GROUP
8814:
8815: * CUPS_SYSTEM_GROUPS
8816:
8817: * CUPS_USER
8818:
8819: * CURSES_DEFAULT
8820:
8821: * CURSES_TYPE
8822:
8823: * CXX
8824:
8825: * CYRUS_GROUP
8826:
8827: * CYRUS_IDLE
8828:
8829: * CYRUS_USER
8830:
8831: * DAEMONTOOLS_GROUP
8832:
8833: * DAEMONTOOLS_LOG_USER
8834:
8835: * DBUS_GROUP
8836:
8837: * DBUS_USER
8838:
8839: * DEFANG_GROUP
8840:
8841: * DEFANG_USER
8842:
8843: * DEFAULT_ACCEPTABLE_LICENSES
8844:
8845: * DEFAULT_DISTFILES
8846:
8847: * DEFAULT_IRC_SERVER
8848:
8849: * DEFAULT_SERIAL_DEVICE
8850:
8851: * DEF_UMASK
8852:
8853: * DEINSTALLDEPENDS
8854:
8855: * DEINSTALL_SRC
8856:
8857: * DEINSTALL_TEMPLATES
8858:
8859: * DELAYED_ERROR_MSG
8860:
8861: * DELAYED_WARNING_MSG
8862:
8863: * DEPENDS_TARGET
8864:
8865: * DEPENDS_TYPE
8866:
8867: * DESTDIR
8868:
8869: * DESTDIR_VARNAME
8870:
8871: * DIALER_GROUP
8872:
8873: * DIGEST_REQD
8874:
8875: * DISTDIR
8876:
8877: * DISTFILES
8878:
8879: * DISTINFO_FILE
8880:
8881: * DISTNAME
8882:
8883: * DIST_PATH
8884:
8885: * DIST_SUBDIR
8886:
8887: * DJBDNS_AXFR_USER
8888:
8889: * DJBDNS_CACHE_USER
8890:
8891: * DJBDNS_DJBDNS_GROUP
8892:
8893: * DJBDNS_LOG_USER
8894:
8895: * DJBDNS_RBL_USER
8896:
8897: * DJBDNS_TINY_USER
8898:
8899: * DLOPEN_REQUIRE_PTHREADS
8900:
8901: * DL_AUTO_VARS
8902:
8903: * DL_CFLAGS
8904:
8905: * DL_LDFLAGS
8906:
8907: * DL_LIBS
8908:
8909: * DNS
8910:
8911: * DOWNLOADED_DISTFILE
8912:
8913: * DT_LAYOUT
8914:
8915: * DYNAMIC_SITES_CMD
8916:
8917: * DYNAMIC_SITES_SCRIPT
8918:
8919: * ECHO
8920:
8921: * ECHO_N
8922:
8923: * ELK_GUI
8924:
8925: * EMACS_TYPE
8926:
8927: * EMULDIR
8928:
8929: * EMULSUBDIR
8930:
8931: * EMULSUBDIRSLASH
8932:
8933: * EMUL_ARCH
8934:
8935: * EMUL_DISTRO
8936:
8937: * EMUL_EXEC_FMT
8938:
8939: * EMUL_IS_NATIVE
8940:
8941: * EMUL_MODULES
8942:
8943: * EMUL_OPSYS
8944:
8945: * EMUL_PKG_FMT
8946:
8947: * EMUL_PLATFORM
8948:
8949: * EMUL_PLATFORMS
8950:
8951: * EMUL_PREFER
8952:
8953: * EMUL_REQD
8954:
8955: * EMUL_TYPE
8956:
8957: * ERROR_MSG
8958:
8959: * EXIM_GROUP
8960:
8961: * EXIM_USER
8962:
8963: * EXPORT_SYMBOLS_LDFLAGS
8964:
8965: * EXTRACTOR
8966:
8967: * EXTRACT_CMD
8968:
8969: * EXTRACT_CMD_DEFAULT
8970:
8971: * EXTRACT_DIR
8972:
8973: * EXTRACT_ELEMENTS
8974:
8975: * EXTRACT_ENV
8976:
8977: * EXTRACT_ONLY
8978:
8979: * EXTRACT_OPTS
8980:
8981: * EXTRACT_SUFX
8982:
8983: * EXTRACT_USING
8984:
8985: * FAILOVER_FETCH
8986:
8987: * FAIL_MSG
8988:
8989: * FAKE_NCURSES
8990:
8991: * FAM
8992:
8993: * FAM_ACCEPTED
8994:
8995: * FAM_DEFAULT
8996:
8997: * FAM_SERVER
8998:
8999: * FCPATH
9000:
9001: * FEATURE_CPPFLAGS
9002:
9003: * FEATURE_LDFLAGS
9004:
9005: * FEATURE_LIBS
9006:
9007: * FETCH_AFTER_ARGS
9008:
9009: * FETCH_BEFORE_ARGS
9010:
9011: * FETCH_CMD
9012:
9013: * FETCH_OUTPUT_ARGS
9014:
9015: * FETCH_PROXY
9016:
9017: * FETCH_RESUME_ARGS
9018:
9019: * FETCH_USING
9020:
9021: * FILES_SUBST
9022:
9023: * FILES_SUBST_SED
9024:
9025: * FIX_SYSTEM_HEADERS
9026:
9027: * FLUXBOX_USE_GNOME
9028:
9029: * FLUXBOX_USE_KDE
9030:
9031: * FLUXBOX_USE_XFT
9032:
9033: * FLUXBOX_USE_XINERAMA
9034:
9035: * FONTS_DIRS
9036:
9037: * FONTS_VERBOSE
9038:
9039: * FOO_HACKS_MK
9040:
9041: * FOX_USE_XUNICODE
9042:
9043: * FREEWNN_GROUP
9044:
9045: * FREEWNN_USER
9046:
9047: * FTP_PKG_URL_DIR
9048:
9049: * FTP_PKG_URL_HOST
9050:
9051: * GAMEDATAMODE
9052:
9053: * GAMEDATA_PERMS
9054:
9055: * GAMEDIRMODE
9056:
9057: * GAMEDIR_PERMS
9058:
9059: * GAMEGRP
9060:
9061: * GAMEMODE
9062:
9063: * GAMEOWN
9064:
9065: * GAMES_GROUP
9066:
9067: * GAMES_USER
9068:
9069: * GCC
9070:
9071: * GCCBASE
9072:
9073: * GCC_REQD
9074:
9075: * GCC_VERSION_SUFFIX
9076:
9077: * GEM_BUILD
9078:
9079: * GEM_CLEANBUILD
9080:
9081: * GEM_CLEANBUILD_EXTENSIONS
9082:
9083: * GEM_DOCDIR
9084:
9085: * GEM_EXTSDIR
9086:
9087: * GEM_HOME
9088:
9089: * GEM_LIBDIR
9090:
9091: * GEM_NAME
9092:
9093: * GEM_PATH
9094:
9095: * GEM_SPECFILE
9096:
9097: * GENERATE_PLIST
9098:
9099: * GHOSTSCRIPT_REQD
9100:
9101: * GITHUB_PROJECT
9102:
9103: * GITHUB_RELEASE
9104:
9105: * GITHUB_TAG
9106:
9107: * GITHUB_TYPE
9108:
9109: * GNU
9110:
9111: * GNU_CONFIGURE
9112:
9113: * GNU_CONFIGURE_INFODIR
9114:
9115: * GNU_CONFIGURE_MANDIR
9116:
9117: * GNU_CONFIGURE_STRICT
9118:
9119: * GO_BUILD_PATTERN
9120:
9121: * GO_DIST_BASE
9122:
9123: * GO_SRCPATH
9124:
9125: * GROUP_SPECIFIC_PKGS
9126:
9127: * GRUB_NETWORK_CARDS
9128:
9129: * GRUB_PRESET_COMMAND
9130:
9131: * GRUB_SCAN_ARGS
9132:
9133: * GZIP
9134:
9135: * HASKELL_COMPILER
9136:
9137: * HASKELL_ENABLE_HADDOCK_DOCUMENTATION
9138:
9139: * HASKELL_ENABLE_LIBRARY_PROFILING
9140:
9141: * HASKELL_ENABLE_SHARED_LIBRARY
9142:
9143: * HAS_CONFIGURE
9144:
9145: * HEADER_TEMPLATES
9146:
9147: * HOST_PKGTOOLS_ARGS
9148:
9149: * HOST_SPECIFIC_PKGS
9150:
9151: * HOWL_GROUP
9152:
9153: * HOWL_USER
9154:
9155: * ICCBASE
9156:
9157: * ICECAST_CHROOTDIR
9158:
9159: * ICON_THEMES
9160:
9161: * IDOBASE
9162:
9163: * IGNORE_CCACHE
9164:
9165: * IGNORE_INFO_DIRS
9166:
9167: * IGNORE_INTERACTIVE_FETCH
9168:
9169: * IMAKE
9170:
9171: * IMAKEOPTS
9172:
9173: * IMAKE_MAKE
9174:
9175: * IMAKE_MANINSTALL
9176:
9177: * IMAP_UW_CCLIENT_MBOX_FMT
9178:
9179: * IMDICTDIR
9180:
9181: * INCOMPAT_CURSES
9182:
9183: * INFO_DIR
9184:
9185: * INFO_FILES
9186:
9187: * INFO_FILES_VERBOSE
9188:
9189: * INFO_MSG
9190:
9191: * INIT_SYSTEM
9192:
9193: * INN_DATA_DIR
9194:
9195: * INN_GROUP
9196:
9197: * INN_USER
9198:
9199: * INSTALLATION_DIRS
9200:
9201: * INSTALLATION_DIRS_FROM_PLIST
9202:
9203: * INSTALL_ENV
9204:
9205: * INSTALL_SH_OVERRIDE
9206:
9207: * INSTALL_SRC
9208:
9209: * INSTALL_TEMPLATES
9210:
9211: * INSTALL_UNSTRIPPED
9212:
9213: * IRCD_HYBRID_IRC_GROUP
9214:
9215: * IRCD_HYBRID_IRC_USER
9216:
9217: * IRCD_HYBRID_MAXCONN
9218:
9219: * IRCD_HYBRID_NICLEN
9220:
9221: * IRCD_HYBRID_SYSLOG_EVENTS
9222:
9223: * IRCD_HYBRID_SYSLOG_FACILITY
9224:
9225: * IRCD_HYBRID_TOPICLEN
9226:
9227: * IRIX
9228:
9229: * IRRD_USE_PGP
9230:
9231: * JABBERD_GROUP
9232:
9233: * JABBERD_LOGDIR
9234:
9235: * JABBERD_PIDDIR
9236:
9237: * JABBERD_SPOOLDIR
9238:
9239: * JABBERD_USER
9240:
9241: * JAKARTA_HOME
9242:
9243: * JAVA_BINPREFIX
9244:
9245: * JAVA_CLASSPATH
9246:
9247: * JAVA_HOME
9248:
9249: * JAVA_LD_LIBRARY_PATH
9250:
9251: * JAVA_NAME
9252:
9253: * JAVA_UNLIMIT
9254:
9255: * JAVA_WRAPPERS
9256:
9257: * JPEG_ACCEPTED
9258:
9259: * JPEG_DEFAULT
9260:
9261: * KERBEROS
9262:
9263: * KERMIT_SUID_UUCP
9264:
9265: * KJS_USE_PCRE
9266:
9267: * KNEWS_DOMAIN_FILE
9268:
9269: * KNEWS_DOMAIN_NAME
9270:
9271: * KRB5_ACCEPTED
9272:
9273: * KRB5_DEFAULT
9274:
9275: * LANGUAGES
9276:
9277: * LATEX2HTML_ICONPATH
9278:
9279: * LDCONFIG_ADD_CMD
9280:
9281: * LDCONFIG_REMOVE_CMD
9282:
9283: * LEAFNODE_DATA_DIR
9284:
9285: * LEAFNODE_GROUP
9286:
9287: * LEAFNODE_USER
9288:
9289: * LIBDVDCSS_HOMEPAGE
9290:
9291: * LIBDVDCSS_MASTER_SITES
9292:
9293: * LIBTOOL
9294:
9295: * LIBTOOLIZE_PLIST
9296:
9297: * LIBTOOL_M4_OVERRIDE
9298:
9299: * LIBUSB_TYPE
9300:
9301: * LICENSE
9302:
9303: * LINKER_RPATH_FLAG
9304:
9305: * LINK_RPATH_FLAG
9306:
9307: * LINUX_LOCALES
9308:
9309: * LOCALBASE
9310:
9311: * LOCALBASE_LOCKTYPE
9312:
9313: * LOCALPATCHES
9314:
9315: * LOVE_DATA
9316:
9317: * LOVE_GAME
9318:
9319: * LOVE_VERSION
9320:
9321: * LP64PLATFORMS
9322:
9323: * MACHINE_PLATFORM
9324:
9325: * MAILAGENT_DOMAIN
9326:
9327: * MAILAGENT_EMAIL
9328:
9329: * MAILAGENT_FQDN
9330:
9331: * MAILAGENT_ORGANIZATION
9332:
9333: * MAJORDOMO_HOMEDIR
9334:
9335: * MAKEINFO_ARGS
9336:
9337: * MAKE_DIRS
9338:
9339: * MAKE_DIRS_PERMS
9340:
9341: * MAKE_ENV
9342:
9343: * MAKE_FILE
9344:
9345: * MAKE_FLAGS
9346:
9347: * MAKE_JOBS
9348:
9349: * MAKE_JOBS_SAFE
9350:
9351: * MAKE_PROGRAM
9352:
9353: * MANINSTALL
9354:
9355: * MANZ
9356:
9357: * MASTER_SITES
9358:
9359: * MASTER_SITE_BACKUP
9360:
9361: * MASTER_SITE_CYGWIN
9362:
9363: * MASTER_SITE_GNOME
9364:
9365: * MASTER_SITE_GNU
9366:
9367: * MASTER_SITE_LOCAL
9368:
9369: * MASTER_SITE_MOZILLA
9370:
9371: * MASTER_SITE_OPENOFFICE
9372:
9373: * MASTER_SITE_OVERRIDE
9374:
9375: * MASTER_SITE_PERL_CPAN
9376:
9377: * MASTER_SITE_SUNSITE
9378:
9379: * MASTER_SITE_SUSE
9380:
9381: * MASTER_SITE_TEX_CTAN
9382:
9383: * MASTER_SITE_XCONTRIB
9384:
9385: * MASTER_SITE_XEMACS
9386:
9387: * MASTER_SORT
9388:
9389: * MASTER_SORT_RANDOM
9390:
9391: * MASTER_SORT_REGEX
9392:
9393: * MECAB_CHARSET
9394:
9395: * MEDIATOMB_GROUP
9396:
9397: * MEDIATOMB_USER
9398:
9399: * MIPSPROBASE
9400:
9401: * MIREDO_GROUP
9402:
9403: * MIREDO_USER
9404:
9405: * MISSING_FEATURES
9406:
9407: * MKDIR
9408:
9409: * MLDONKEY_GROUP
9410:
9411: * MLDONKEY_HOME
9412:
9413: * MLDONKEY_USER
9414:
9415: * MONOTONE_GROUP
9416:
9417: * MONOTONE_USER
9418:
9419: * MOTIFBASE
9420:
9421: * MOTIF_TYPE
9422:
9423: * MOTIF_TYPE_DEFAULT
9424:
9425: * MPI_TYPE
9426:
9427: * MSGFMT_STRIP_MSGCTXT
9428:
9429: * MSGFMT_STRIP_MSGID_PLURAL
9430:
9431: * MTOOLS_ENABLE_FLOPPYD
9432:
9433: * MUST
9434:
9435: * MV
9436:
9437: * MYSQL_CHARSET
9438:
9439: * MYSQL_DATADIR
9440:
9441: * MYSQL_EXTRA_CHARSET
9442:
9443: * MYSQL_GROUP
9444:
9445: * MYSQL_PKGSRCDIR
9446:
9447: * MYSQL_USER
9448:
9449: * MYSQL_VERSIONS_ACCEPTED
9450:
9451: * MYSQL_VERSION_DEFAULT
9452:
9453: * NAGIOSCMD_GROUP
9454:
9455: * NAGIOSDIR
9456:
9457: * NAGIOS_GROUP
9458:
9459: * NAGIOS_USER
9460:
9461: * NATIVE_APPEND_ABI
9462:
9463: * NATIVE_APPEND_ELF
9464:
9465: * NATIVE_EXEC_FMT
9466:
9467: * NATIVE_MACHINE_PLATFORM
9468:
9469: * NATIVE_OBJECT_FMT
9470:
9471: * NBPAX_PROGRAM_PREFIX
9472:
9473: * NETBSD_LOGIN_NAME
9474:
9475: * NMH_EDITOR
9476:
9477: * NMH_MTA
9478:
9479: * NMH_PAGER
9480:
9481: * NOLOGIN
9482:
9483: * NONZERO_FILESIZE_P
9484:
9485: * NOTE
9486:
9487: * NOT_FOR_PLATFORM
9488:
9489: * NOT_PAX_ASLR_SAFE
9490:
9491: * NOT_PAX_MPROTECT_SAFE
9492:
9493: * NO_BUILD
9494:
9495: * NO_CHECKSUM
9496:
9497: * NO_CONFIGURE
9498:
9499: * NO_SKIP
9500:
9501: * NS_PREFERRED
9502:
9503: * NULLMAILER_GROUP
9504:
9505: * NULLMAILER_USER
9506:
9507: * OASIS
9508:
9509: * OASIS_BUILD_ARGS
9510:
9511: * OBJHOSTNAME
9512:
9513: * OBJMACHINE
9514:
9515: * OCAML_FINDLIB_DIRS
9516:
9517: * OCAML_FINDLIB_REGISTER
9518:
9519: * OCAML_FINDLIB_REGISTER_VERBOSE
9520:
9521: * OCAML_SITELIBDIR
9522:
9523: * OCAML_TOPKG_DOCDIR
9524:
9525: * OCAML_USE_DUNE
9526:
9527: * OCAML_USE_FINDLIB
9528:
9529: * OCAML_USE_JBUILDER
9530:
9531: * OCAML_USE_OASIS
9532:
9533: * OCAML_USE_OASIS_DYNRUN
9534:
9535: * OCAML_USE_OPAM
9536:
9537: * OCAML_USE_OPT_COMPILER
9538:
9539: * OCAML_USE_TOPKG
9540:
9541: * OMF
9542:
9543: * ONLY_FOR_COMPILER
9544:
9545: * ONLY_FOR_PLATFORM
9546:
9547: * OPENSSH_CHROOT
9548:
9549: * OPENSSH_GROUP
9550:
9551: * OPENSSH_USER
9552:
9553: * OPSYS
9554:
9555: * OPSYS_EMULDIR
9556:
9557: * OSS_TYPE
9558:
9559: * OSX
9560:
9561: * OSX_TOLERATE_SDK_SKEW
9562:
9563: * OS_VARIANT
9564:
9565: * OS_VERSION
9566:
9567: * OTF_FONTS_DIR
9568:
9569: * OVERRIDE_DIRDEPTH
9570:
9571: * OVERRIDE_GEMSPEC
9572:
9573: * OVERRIDE_GNU_CONFIG_SCRIPTS
9574:
9575: * OWN_DIRS
9576:
9577: * OWN_DIRS_PERMS
9578:
9579: * P4GROUP
9580:
9581: * P4PORT
9582:
9583: * P4ROOT
9584:
9585: * P4USER
9586:
9587: * PACKAGES
9588:
9589: * PALMOS_DEFAULT_SDK
9590:
9591: * PAMBASE
9592:
9593: * PAM_DEFAULT
9594:
9595: * PAPERSIZE
9596:
9597: * PASSIVE_FETCH
9598:
9599: * PATCHDIR
9600:
9601: * PATCHFILES
9602:
9603: * PATCH_ARGS
9604:
9605: * PATCH_DEBUG
9606:
9607: * PATCH_DIST_ARGS
9608:
9609: * PATCH_DIST_CAT
9610:
9611: * PATCH_DIST_STRIP
9612:
9613: * PATCH_FUZZ_FACTOR
9614:
9615: * PATCH_STRIP
9616:
9617: * PATH
9618:
9619: * PCCBASE
9620:
9621: * PEAR_CMD
9622:
9623: * PEAR_LIB
9624:
9625: * PEAR_PACKAGE_XML
9626:
9627: * PERL5
9628:
9629: * PERL5_CONFIGURE
9630:
9631: * PERL5_CONFIGURE_DIRS
9632:
9633: * PERL5_LDFLAGS
9634:
9635: * PERL5_LICENSE
9636:
9637: * PERL5_MODULE_TYPE
9638:
9639: * PERL5_PACKLIST
9640:
9641: * PERL5_PACKLIST_DIR
9642:
9643: * PERL5_PERLBASE
9644:
9645: * PERL5_SITEBASE
9646:
9647: * PERL5_USE_PACKLIST
9648:
9649: * PERL5_VENDORBASE
9650:
9651: * PFCTL
9652:
9653: * PFVAR_H
9654:
9655: * PF_VERSION
9656:
9657: * PGGROUP
9658:
9659: * PGHOME
9660:
9661: * PGPKGSRCDIR
9662:
9663: * PGSQL_TYPE
9664:
9665: * PGSQL_VERSIONS_ACCEPTED
9666:
9667: * PGSQL_VERSION_DEFAULT
9668:
9669: * PGUSER
9670:
9671: * PG_LIB_EXT
9672:
9673: * PHP
9674:
9675: * PHPCOMMON_MK
9676:
9677: * PHPPKGSRCDIR
9678:
9679: * PHP_BASE_VERS
9680:
9681: * PHP_CHECK_INSTALLED
9682:
9683: * PHP_EXTENSION_DIR
9684:
9685: * PHP_INITIAL_TEENY
9686:
9687: * PHP_PKG_PREFIX
9688:
9689: * PHP_VERSION
9690:
9691: * PHP_VERSIONS_ACCEPTED
9692:
9693: * PHP_VERSIONS_INCOMPATIBLE
9694:
9695: * PHP_VERSION_DEFAULT
9696:
9697: * PHP_VERSION_REQD
9698:
9699: * PILRC_USE_GTK
9700:
9701: * PKGCONFIG_BASE
9702:
9703: * PKGCONFIG_FILE
9704:
9705: * PKGCONFIG_OVERRIDE
9706:
9707: * PKGCONFIG_OVERRIDE_STAGE
9708:
9709: * PKGDIR
9710:
9711: * PKGGNUDIR
9712:
9713: * PKGINFODIR
9714:
9715: * PKGLOCALEDIR
9716:
9717: * PKGMANDIR
9718:
9719: * PKGNAME
9720:
9721: * PKGNAME_REQD
9722:
9723: * PKGPATH
9724:
9725: * PKGREVISION
9726:
9727: * PKGSRC_CHANGES
9728:
9729: * PKGSRC_COMPILER
9730:
9731: * PKGSRC_KEEP_BIN_PKGS
9732:
9733: * PKGSRC_LOCKTYPE
9734:
9735: * PKGSRC_MAKE_ENV
9736:
9737: * PKGSRC_MESSAGE_RECIPIENTS
9738:
9739: * PKGSRC_MKPIE
9740:
9741: * PKGSRC_MKREPRO
9742:
9743: * PKGSRC_RUN_TEST
9744:
9745: * PKGSRC_SETENV
9746:
9747: * PKGSRC_SLEEPSECS
9748:
9749: * PKGSRC_TODO
9750:
9751: * PKGSRC_USE_CTF
9752:
9753: * PKGSRC_USE_FORTIFY
9754:
9755: * PKGSRC_USE_RELRO
9756:
9757: * PKGSRC_USE_SSP
9758:
9759: * PKGSRC_USE_STACK_CHECK
9760:
9761: * PKGTASKS_DATAFILE
9762:
9763: * PKGTOOLS_ARGS
9764:
9765: * PKGTOOLS_ENV
9766:
9767: * PKG_ALTERNATIVES
9768:
9769: * PKG_APACHE
9770:
9771: * PKG_APACHE_ACCEPTED
9772:
9773: * PKG_APACHE_DEFAULT
9774:
9775: * PKG_BEST_EXISTS
9776:
9777: * PKG_BUILD_OPTIONS
9778:
9779: * PKG_COMPRESSION
9780:
9781: * PKG_CONFIG
9782:
9783: * PKG_CONFIG_PERMS
9784:
9785: * PKG_CREATE_USERGROUP
9786:
9787: * PKG_DB_TMPDIR
9788:
9789: * PKG_DEBUG_LEVEL
9790:
9791: * PKG_DEFAULT_OPTIONS
9792:
9793: * PKG_DESTDIR_SUPPORT
9794:
9795: * PKG_DEVELOPER
9796:
9797: * PKG_DISABLED_OPTIONS
9798:
9799: * PKG_FATAL_ERRORS
9800:
9801: * PKG_FC
9802:
9803: * PKG_FILELIST_CMD
9804:
9805: * PKG_GECOS
9806:
9807: * PKG_GID
9808:
9809: * PKG_GROUPS
9810:
9811: * PKG_GROUPS_VARS
9812:
9813: * PKG_HOME
9814:
9815: * PKG_INIT_SCRIPTS
9816:
9817: * PKG_JAVA_HOME
9818:
9819: * PKG_JVM
9820:
9821: * PKG_JVMS_ACCEPTED
9822:
9823: * PKG_JVM_DEFAULT
9824:
9825: * PKG_LEGACY_OPTIONS
9826:
9827: * PKG_LIBTOOL
9828:
9829: * PKG_OPTIONS
9830:
9831: * PKG_OPTIONS_DEPRECATED_WARNINGS
9832:
9833: * PKG_OPTIONS_LEGACY_OPTS
9834:
9835: * PKG_OPTIONS_LEGACY_VARS
9836:
9837: * PKG_OPTIONS_NONEMPTY_SETS
9838:
9839: * PKG_OPTIONS_OPTIONAL_GROUPS
9840:
9841: * PKG_OPTIONS_REQUIRED_GROUPS
9842:
9843: * PKG_OPTIONS_VAR
9844:
9845: * PKG_PHP
9846:
9847: * PKG_PHP_MAJOR_VERS
9848:
9849: * PKG_PHP_VERSION
9850:
9851: * PKG_RCD_SCRIPTS
9852:
9853: * PKG_REFCOUNT_DBDIR
9854:
9855: * PKG_REGISTER_SHELLS
9856:
9857: * PKG_RESUME_TRANSFERS
9858:
9859: * PKG_SHELL
9860:
9861: * PKG_SUGGESTED_OPTIONS
9862:
9863: * PKG_SUPPORTED_OPTIONS
9864:
9865: * PKG_SYSCONFBASE
9866:
9867: * PKG_SYSCONFBASEDIR
9868:
9869: * PKG_SYSCONFDIR
9870:
9871: * PKG_SYSCONFDIR_PERMS
9872:
9873: * PKG_SYSCONFSUBDIR
9874:
9875: * PKG_SYSCONFVAR
9876:
9877: * PKG_TOOLS_BIN
9878:
9879: * PKG_UID
9880:
9881: * PKG_UPDATE_FONTS_DB
9882:
9883: * PKG_USERS
9884:
9885: * PKG_USERS_VARS
9886:
9887: * PKG_VERBOSE
9888:
9889: * PLIST
9890:
9891: * PLIST_AWK
9892:
9893: * PLIST_AWK_ENV
9894:
9895: * PLIST_SRC
9896:
9897: * PLIST_SUBST
9898:
9899: * PLIST_TYPE
9900:
9901: * PLIST_VARS
9902:
9903: * POPTOP_USE_MPPE
9904:
9905: * POST_FETCH_HOOK
9906:
9907: * PREFER
9908:
9909: * PREFER_NATIVE
9910:
9911: * PREFER_NATIVE_PTHREADS
9912:
9913: * PREFER_PKGSRC
9914:
9915: * PREFIX
9916:
9917: * PREPEND_PATH
9918:
9919: * PRE_ROOT_CMD
9920:
9921: * PRIVILEGED_STAGES
9922:
9923: * PS
9924:
9925: * PTHREAD_AUTO_VARS
9926:
9927: * PTHREAD_CFLAGS
9928:
9929: * PTHREAD_LDFLAGS
9930:
9931: * PTHREAD_LIBS
9932:
9933: * PTHREAD_OPTS
9934:
9935: * PTHREAD_TYPE
9936:
9937: * PVM_SSH
9938:
9939: * PYPKGPREFIX
9940:
9941: * PYTHON_FOR_BUILD_ONLY
9942:
9943: * PYTHON_SELF_CONFLICT
9944:
9945: * PYTHON_VERSIONED_DEPENDENCIES
9946:
9947: * PYTHON_VERSIONS_ACCEPTED
9948:
9949: * PYTHON_VERSIONS_INCOMPATIBLE
9950:
9951: * PYTHON_VERSION_DEFAULT
9952:
9953: * PYTHON_VERSION_REQD
9954:
9955: * PYVERSSUFFIX
9956:
9957: * PY_NO_EGG
9958:
9959: * QMAILDIR
9960:
9961: * QMAIL_ALIAS_USER
9962:
9963: * QMAIL_DAEMON_USER
9964:
9965: * QMAIL_LOG_USER
9966:
9967: * QMAIL_NOFILES_GROUP
9968:
9969: * QMAIL_PASSWD_USER
9970:
9971: * QMAIL_QMAIL_GROUP
9972:
9973: * QMAIL_QUEUE_DIR
9974:
9975: * QMAIL_QUEUE_EXTRA
9976:
9977: * QMAIL_QUEUE_USER
9978:
9979: * QMAIL_REMOTE_USER
9980:
9981: * QMAIL_ROOT_USER
9982:
9983: * QMAIL_SEND_USER
9984:
9985: * QPOPPER_FAC
9986:
9987: * QPOPPER_SPOOL_DIR
9988:
9989: * QPOPPER_USER
9990:
9991: * RAKE_NAME
9992:
9993: * RASMOL_DEPTH
9994:
9995: * RCD_SCRIPTS
9996:
9997: * RCD_SCRIPTS_DIR
9998:
9999: * RCD_SCRIPTS_EXAMPLEDIR
10000:
10001: * RCD_SCRIPTS_MODE
10002:
10003: * RCD_SCRIPTS_SHELL
10004:
10005: * RCD_SCRIPT_SRC
10006:
10007: * RDOC
10008:
10009: * READLINE_DEFAULT
10010:
10011: * READLINE_TYPE
10012:
10013: * REAL_ROOT_GROUP
10014:
10015: * REAL_ROOT_USER
10016:
10017: * RECURSIVE_MAKE
10018:
10019: * RELAY_CTRL_DIR
10020:
10021: * REPLACE_AWK
10022:
10023: * REPLACE_BASH
10024:
10025: * REPLACE_CSH
10026:
10027: * REPLACE_KSH
10028:
10029: * REPLACE_PERL
10030:
10031: * REPLACE_PERL6
10032:
10033: * REPLACE_PYTHON
10034:
10035: * REPLACE_RUBY
10036:
10037: * REPLACE_RUBY_DIRS
10038:
10039: * REPLACE_RUBY_PAT
10040:
10041: * REPLACE_SH
10042:
10043: * REPLACE_TEXLUA
10044:
10045: * REQD_DIRS
10046:
10047: * REQD_DIRS_PERMS
10048:
10049: * REQD_FILES
10050:
10051: * REQD_FILES_MODE
10052:
10053: * REQD_FILES_PERMS
10054:
10055: * RESOLV_AUTO_VARS
10056:
10057: * RESOLV_LDFLAGS
10058:
10059: * RESOLV_LIBS
10060:
10061: * RM
10062:
10063: * ROOT_CMD
10064:
10065: * ROOT_GROUP
10066:
10067: * ROOT_USER
10068:
10069: * RPCGEN
10070:
10071: * RPM
10072:
10073: * RPM2PKG_PLIST
10074:
10075: * RPM2PKG_PREFIX
10076:
10077: * RPM2PKG_STAGE
10078:
10079: * RPM2PKG_STRIP
10080:
10081: * RPM2PKG_SUBPREFIX
10082:
10083: * RPMFILES
10084:
10085: * RPMIGNOREPATH
10086:
10087: * RPM_DB_PREFIX
10088:
10089: * RSSH_CVS_PATH
10090:
10091: * RSSH_RDIST_PATH
10092:
10093: * RSSH_RSYNC_PATH
10094:
10095: * RSSH_SCP_PATH
10096:
10097: * RSSH_SFTP_SERVER_PATH
10098:
10099: * RUBY
10100:
10101: * RUBYGEM
10102:
10103: * RUBYGEM_NAME
10104:
10105: * RUBYGEM_OPTIONS
10106:
10107: * RUBY_ABI_VERSION
10108:
10109: * RUBY_ARCH
10110:
10111: * RUBY_ARCHINC
10112:
10113: * RUBY_ARCHLIB
10114:
10115: * RUBY_BASE
10116:
10117: * RUBY_BASERIDIR
10118:
10119: * RUBY_BUILD_RDOC
10120:
10121: * RUBY_BUILD_RI
10122:
10123: * RUBY_DLEXT
10124:
10125: * RUBY_DOC
10126:
10127: * RUBY_DYNAMIC_DIRS
10128:
10129: * RUBY_EG
10130:
10131: * RUBY_ENCODING_ARG
10132:
10133: * RUBY_EXTCONF
10134:
10135: * RUBY_EXTCONF_CHECK
10136:
10137: * RUBY_EXTCONF_DEBUG
10138:
10139: * RUBY_EXTCONF_MAKEFILE
10140:
10141: * RUBY_GEM_BASE
10142:
10143: * RUBY_INC
10144:
10145: * RUBY_LIB
10146:
10147: * RUBY_LIB_BASE
10148:
10149: * RUBY_NAME
10150:
10151: * RUBY_NOVERSION
10152:
10153: * RUBY_PKGPREFIX
10154:
10155: * RUBY_RAILS
10156:
10157: * RUBY_RAILS42_VERSION
10158:
10159: * RUBY_RAILS51_VERSION
10160:
10161: * RUBY_RAILS52_VERSION
10162:
10163: * RUBY_RAILS_ACCEPTED
10164:
10165: * RUBY_RAILS_DEFAULT
10166:
10167: * RUBY_RAILS_REQD
10168:
10169: * RUBY_RAILS_STRICT_DEP
10170:
10171: * RUBY_RIDIR
10172:
10173: * RUBY_SETUP
10174:
10175: * RUBY_SHLIB
10176:
10177: * RUBY_SHLIBALIAS
10178:
10179: * RUBY_SHLIBVER
10180:
10181: * RUBY_SIMPLE_INSTALL
10182:
10183: * RUBY_SITEARCHLIB
10184:
10185: * RUBY_SITELIB
10186:
10187: * RUBY_SITELIB_BASE
10188:
10189: * RUBY_SITERIDIR
10190:
10191: * RUBY_SLEXT
10192:
10193: * RUBY_SRCDIR
10194:
10195: * RUBY_STATICLIB
10196:
10197: * RUBY_SUFFIX
10198:
10199: * RUBY_SYSRIDIR
10200:
10201: * RUBY_USE_PTHREAD
10202:
10203: * RUBY_VENDORARCHLIB
10204:
10205: * RUBY_VENDORLIB
10206:
10207: * RUBY_VENDORLIB_BASE
10208:
10209: * RUBY_VER
10210:
10211: * RUBY_VERSION
10212:
10213: * RUBY_VERSIONS_ACCEPTED
10214:
10215: * RUBY_VERSION_DEFAULT
10216:
10217: * RUBY_VERSION_REQD
10218:
10219: * RUBY_VER_DIR
10220:
10221: * RUN
10222:
10223: * RUN_LDCONFIG
10224:
10225: * SAWFISH_THEMES
10226:
10227: * SCO
10228:
10229: * SCREWS_GROUP
10230:
10231: * SCREWS_USER
10232:
10233: * SCRIPTS_ENV
10234:
10235: * SCROLLKEEPER_DATADIR
10236:
10237: * SCROLLKEEPER_REBUILDDB
10238:
10239: * SCROLLKEEPER_UPDATEDB
10240:
10241: * SDIST_PAWD
10242:
10243: * SERIAL_DEVICES
10244:
10245: * SETGIDGAME
10246:
10247: * SETGID_GAMES_PERMS
10248:
10249: * SETUID_ROOT_PERMS
10250:
10251: * SH
10252:
10253: * SHLIB
10254:
10255: * SIGN_PACKAGES
10256:
10257: * SILC_CLIENT_WITH_PERL
10258:
10259: * SITE_SPECIFIC_PKGS
10260:
10261: * SKIP_DEPENDS
10262:
10263: * SKIP_PORTABILITY_CHECK
10264:
10265: * SMF_INSTANCES
10266:
10267: * SMF_MANIFEST
10268:
10269: * SMF_METHODS
10270:
10271: * SMF_METHOD_SHELL
10272:
10273: * SMF_METHOD_SRC
10274:
10275: * SMF_NAME
10276:
10277: * SMF_PREFIX
10278:
10279: * SMF_SRCDIR
10280:
10281: * SNIPROXY_GROUP
10282:
10283: * SNIPROXY_USER
10284:
10285: * SOURCE_BUFFSIZE
10286:
10287: * SPECIAL_PERMS
10288:
10289: * SPECIFIC_PKGS
10290:
10291: * SSH_SUID
10292:
10293: * SSYNC_PAWD
10294:
10295: * STEP_MSG
10296:
10297: * STRIP
10298:
10299: * STRIP_DBG
10300:
10301: * STRIP_DEBUG
10302:
10303: * STRIP_DEBUG_SUPPORTED
10304:
10305: * STRIP_FILES_SKIP
10306:
10307: * SU
10308:
10309: * SUBDIR
10310:
10311: * SUBST_CLASSES
10312:
10313: * SUBST_FILES
10314:
10315: * SUBST_FILTER_CMD
10316:
10317: * SUBST_MESSAGE
10318:
10319: * SUBST_SED
10320:
10321: * SUBST_SHOW_DIFF
10322:
10323: * SUBST_SKIP_TEXT_CHECK
10324:
10325: * SUBST_STAGE
10326:
10327: * SUBST_VARS
10328:
10329: * SUNWSPROBASE
10330:
10331: * SUSE_PREFER
10332:
10333: * SU_CMD
10334:
10335: * TERMCAP_TYPE
10336:
10337: * TERMINFO_DEFAULT
10338:
10339: * TERMINFO_TYPE
10340:
10341: * TEST
10342:
10343: * TEST_DIRS
10344:
10345: * TEST_ENV
10346:
10347: * TEST_MAKE_CMD
10348:
10349: * TEST_MAKE_FLAGS
10350:
10351: * TEST_TARGET
10352:
10353: * TEXLIVE_IGNORE_PATTERNS
10354:
10355: * TEXLIVE_REV
10356:
10357: * TEXMFSITE
10358:
10359: * TEX_FORMATS
10360:
10361: * TEX_HYPHEN_DAT
10362:
10363: * TEX_HYPHEN_DEF
10364:
10365: * TEX_TEXMF_DIRS
10366:
10367: * THTTPD_LOG_FACILITY
10368:
10369: * TO
10370:
10371: * TOOLS_ALIASES
10372:
10373: * TOOLS_ARGS
10374:
10375: * TOOLS_BROKEN
10376:
10377: * TOOLS_CMD
10378:
10379: * TOOLS_CREATE
10380:
10381: * TOOLS_DIR
10382:
10383: * TOOLS_FAIL
10384:
10385: * TOOLS_GNU_MISSING
10386:
10387: * TOOLS_LDCONFIG
10388:
10389: * TOOLS_NOOP
10390:
10391: * TOOLS_PATH
10392:
10393: * TOOLS_SCRIPT
10394:
10395: * TTF_FONTS_DIR
10396:
10397: * TYPE
10398:
10399: * UAC_REQD_EXECS
10400:
10401: * UCSPI_SSL_GROUP
10402:
10403: * UCSPI_SSL_USER
10404:
10405: * UNLIMIT_RESOURCES
10406:
10407: * UNPRIVILEGED
10408:
10409: * UNPRIVILEGED_GROUP
10410:
10411: * UNPRIVILEGED_GROUPS
10412:
10413: * UNPRIVILEGED_USER
10414:
10415: * UNWRAP_FILES
10416:
10417: * UNWRAP_PATTERNS
10418:
10419: * UPDATE_GEMSPEC
10420:
10421: * UPDATE_TARGET
10422:
10423: * URI
10424:
10425: * USA
10426:
10427: * USERGROUP_PHASE
10428:
10429: * USERPPP_GROUP
10430:
10431: * USER_SPECIFIC_PKGS
10432:
10433: * USE_ABI_DEPENDS
10434:
10435: * USE_APR
10436:
10437: * USE_BSD_MAKEFILE
10438:
10439: * USE_BUILTIN
10440:
10441: * USE_CROSS_COMPILE
10442:
10443: * USE_CURSES
10444:
10445: * USE_CWRAPPERS
10446:
10447: * USE_DB185
10448:
10449: * USE_FEATURES
10450:
10451: * USE_GAMESGROUP
10452:
10453: * USE_GCC_RUNTIME
10454:
10455: * USE_IMAKE
10456:
10457: * USE_JAVA
10458:
10459: * USE_JAVA2
10460:
10461: * USE_LANGUAGES
10462:
10463: * USE_LIBTOOL
10464:
10465: * USE_NATIVE_GCC
10466:
10467: * USE_NETBSD_REPO
10468:
10469: * USE_PKGSRC_GCC
10470:
10471: * USE_PKGSRC_GCC_RUNTIME
10472:
10473: * USE_PKGTASKS
10474:
10475: * USE_RUBY_EXTCONF
10476:
10477: * USE_RUBY_INSTALL
10478:
10479: * USE_RUBY_SETUP
10480:
10481: * USE_RUBY_SETUP_PKG
10482:
10483: * USE_TOOLS
10484:
10485: * UUCP_GROUP
10486:
10487: * UUCP_USER
10488:
10489: * VARBASE
10490:
10491: * VARNAME
10492:
10493: * VIM_EXTRA_OPTS
10494:
10495: * WARNING_MSG
10496:
10497: * WCALC_CGIDIR
10498:
10499: * WCALC_CGIPATH
10500:
10501: * WCALC_HTMLDIR
10502:
10503: * WCALC_HTMLPATH
10504:
10505: * WDM_MANAGERS
10506:
10507: * WRAPPER_REORDER_CMDS
10508:
10509: * WRKDIR
10510:
10511: * WRKDIR_BASENAME
10512:
10513: * WRKDIR_LOCKTYPE
10514:
10515: * WRKLOG
10516:
10517: * WRKOBJDIR
10518:
10519: * WRKSRC
10520:
10521: * WXGTK_ACCEPTED
10522:
10523: * WXGTK_DEFAULT
10524:
10525: * X10_PORT
10526:
10527: * X11
10528:
10529: * X11BASE
10530:
10531: * X11_PKGSRCDIR
10532:
10533: * X11_TYPE
10534:
10535: * X509_CERTIFICATE
10536:
10537: * X509_KEY
10538:
10539: * XAW_TYPE
10540:
10541: * XLOCK_DEFAULT_MODE
10542:
10543: * XMKMF_FLAGS
10544:
10545: * XXX
10546:
10547: * YES
10548:
10549: * ZERO_FILESIZE_P
10550:
10551: * ZSH_STATIC
10552:
10553: * __stdc__
10554:
10555: * _vargroups
10556:
10557: * add
10558:
10559: * all
10560:
10561: * alternatives
10562:
10563: * aslr
10564:
10565: * asprintf
10566:
10567: * autoconf
10568:
10569: * automake
10570:
10571: * autoreconf
10572:
10573: * awk
10574:
10575: * bash
10576:
10577: * big-endian
10578:
10579: * bin-install
10580:
10581: * binpkg-list
10582:
10583: * bootstrap-depends
10584:
10585: * broken
10586:
10587: * broken_on_platform
10588:
10589: * build
10590:
10591: * build-env
10592:
10593: * buildlink-directories
10594:
10595: * buildlink-oss-soundcard-h
10596:
10597: * c
10598:
10599: * c++
10600:
10601: * ccache
10602:
10603: * cce
10604:
10605: * cdefs
10606:
10607: * changes
10608:
10609: * changes-entry
10610:
10611: * changes-entry-noupdate
10612:
10613: * check
10614:
10615: * check-clean
10616:
10617: * check-files
10618:
10619: * check-files-clean
10620:
10621: * check-vulnerable
10622:
10623: * checksum
10624:
10625: * checksum-phase
10626:
10627: * clean
10628:
10629: * clean-depends
10630:
10631: * cleandir
10632:
10633: * commit
10634:
10635: * commit-changes-entry
10636:
10637: * compact
10638:
10639: * compiler
10640:
10641: * conf
10642:
10643: * config.guess
10644:
10645: * config.sub
10646:
10647: * configuration
10648:
10649: * configure-help
10650:
10651: * cputime
10652:
10653: * create-usergroup
10654:
10655: * csh
10656:
10657: * ctf
10658:
10659: * debug
10660:
10661: * declaration
10662:
10663: * declare
10664:
10665: * defined
10666:
10667: * depend
10668:
10669: * dependencies
10670:
10671: * depends
10672:
10673: * depends-checksum
10674:
10675: * depends-fetch
10676:
10677: * describe
10678:
10679: * destdir
10680:
10681: * distclean
10682:
10683: * distinfo
10684:
10685: * dl
10686:
10687: * dlopen
10688:
10689: * do-build
10690:
10691: * do-buildlink
10692:
10693: * do-clean
10694:
10695: * do-configure-post-hook
10696:
10697: * do-extract
10698:
10699: * do-fetch
10700:
10701: * emul
10702:
10703: * emulation
10704:
10705: * emulator
10706:
10707: * endian
10708:
10709: * enomem
10710:
10711: * err
10712:
10713: * errx
10714:
10715: * etc
10716:
10717: * feature
10718:
10719: * features
10720:
10721: * fetch
10722:
10723: * fetch-list
10724:
10725: * follows
10726:
10727: * forbids
10728:
10729: * form
10730:
10731: * format
10732:
10733: * fortify
10734:
10735: * fortify_source
10736:
10737: * friend
10738:
10739: * from
10740:
10741: * fts
10742:
10743: * fts_close
10744:
10745: * fts_open
10746:
10747: * fts_read
10748:
10749: * fts_set
10750:
10751: * full
10752:
10753: * gcc
10754:
10755: * getopt_long
10756:
10757: * getprogname
10758:
10759: * gettext
10760:
10761: * github
10762:
10763: * glob
10764:
10765: * go
10766:
10767: * golang
10768:
10769: * guess-license
10770:
10771: * hashbang
10772:
10773: * heimdal
10774:
10775: * help
10776:
10777: * imake
10778:
10779: * increment
10780:
10781: * interp
10782:
10783: * interpreter
10784:
10785: * intl
10786:
10787: * iso
10788:
10789: * kerberos
10790:
10791: * krb
10792:
10793: * krb5
10794:
10795: * ksh
10796:
10797: * latex
10798:
10799: * libnbcompat
10800:
10801: * libs
10802:
10803: * libtool
10804:
10805: * licence
10806:
10807: * license
10808:
10809: * lintl
10810:
10811: * little-endian
10812:
10813: * lock
10814:
10815: * locking
10816:
10817: * lvalue
10818:
10819: * make
10820:
10821: * makesum
10822:
10823: * memory
10824:
10825: * meta
10826:
10827: * meta-package
10828:
10829: * meta_package
10830:
10831: * mit-krb5
10832:
10833: * mk.conf
10834:
10835: * mount
10836:
10837: * mprotect
10838:
10839: * mremap
10840:
10841: * nb
10842:
10843: * nbcompat
10844:
10845: * no
10846:
10847: * obstack
10848:
10849: * obstack_ptr_grow
10850:
10851: * occurs
10852:
10853: * only
10854:
10855: * options
10856:
10857: * options.mk
10858:
10859: * order
10860:
10861: * override
10862:
10863: * override-intltool
10864:
10865: * override-message-intltool
10866:
10867: * package
10868:
10869: * parallel
10870:
10871: * partial
10872:
10873: * path
10874:
10875: * pax
10876:
10877: * paxctl
10878:
10879: * pbulk-index
10880:
10881: * pc
10882:
10883: * perl
10884:
10885: * perl5
10886:
10887: * perms
10888:
10889: * php
10890:
10891: * pkg-build-options
10892:
10893: * pkg-config
10894:
10895: * pkg_build_options
10896:
10897: * platform
10898:
10899: * plist
10900:
10901: * post-extract
10902:
10903: * post-fetch
10904:
10905: * post-wrapper
10906:
10907: * pre-configure
10908:
10909: * pre-extract
10910:
10911: * pre-fetch
10912:
10913: * print-plist
10914:
10915: * print-summary-data
10916:
10917: * privileged-install-hook
10918:
10919: * pypi
10920:
10921: * python
10922:
10923: * readme-all
10924:
10925: * regcomp
10926:
10927: * relro
10928:
10929: * rename
10930:
10931: * reorder
10932:
10933: * replace
10934:
10935: * replace_interpreter
10936:
10937: * reproducible
10938:
10939: * resolv
10940:
10941: * root
10942:
10943: * ruby
10944:
10945: * setenv
10946:
10947: * setgid
10948:
10949: * setprogname
10950:
10951: * setuid
10952:
10953: * sh
10954:
10955: * show
10956:
10957: * show-all
10958:
10959: * show-build-defs
10960:
10961: * show-depends
10962:
10963: * show-deps
10964:
10965: * show-distfiles
10966:
10967: * show-downlevel
10968:
10969: * show-subdir-var
10970:
10971: * show-tools
10972:
10973: * show-var
10974:
10975: * show-vars
10976:
10977: * snprintf
10978:
10979: * ssp
10980:
10981: * st_mode
10982:
10983: * stage-install
10984:
10985: * strip
10986:
10987: * strong
10988:
10989: * subst
10990:
10991: * sun
10992:
10993: * sunpro
10994:
10995: * sunwspro
10996:
10997: * test
10998:
10999: * tex
11000:
11001: * texlive
11002:
11003: * tmp
11004:
11005: * tool
11006:
11007: * tools
11008:
11009: * tools-libtool-m4-override
11010:
11011: * type
11012:
11013: * ulimit
11014:
11015: * undefined
11016:
11017: * undo-replace
11018:
11019: * unlimit
11020:
11021: * unprivileged
11022:
11023: * unprivileged-install-hook
11024:
11025: * unstripped
11026:
11027: * update
11028:
11029: * upload
11030:
11031: * upload-distfiles
11032:
11033: * usage
11034:
11035: * use_tools
11036:
11037: * user
11038:
11039: * utimes
11040:
11041: * vasprintf
11042:
11043: * verbose
11044:
11045: * vsnprintf
11046:
11047: * warn
11048:
11049: * warning
11050:
11051: * warnings
11052:
11053: * warnx
11054:
11055: * weak
11056:
11057: * work
11058:
11059: * wrapper
11060:
11061: * yes
11062:
11063: Appendix E. Editing guidelines for the pkgsrc guide
1.1 dsieger 11064:
11065: Table of Contents
11066:
1.154 rillig 11067: E.1. Make targets
11068: E.2. Procedure
1.1 dsieger 11069:
11070: This section contains information on editing the pkgsrc guide itself.
11071:
1.154 rillig 11072: E.1. Make targets
1.1 dsieger 11073:
11074: The pkgsrc guide's source code is stored in pkgsrc/doc/guide/files, and several
11075: files are created from it:
11076:
11077: * pkgsrc/doc/pkgsrc.txt
11078:
11079: * pkgsrc/doc/pkgsrc.html
11080:
1.2 rillig 11081: * http://www.NetBSD.org/docs/pkgsrc/
1.1 dsieger 11082:
1.2 rillig 11083: * http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf: The PDF version of the pkgsrc
11084: guide.
1.1 dsieger 11085:
1.2 rillig 11086: * http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps: PostScript version of the
11087: pkgsrc guide.
1.1 dsieger 11088:
1.154 rillig 11089: E.2. Procedure
1.1 dsieger 11090:
11091: The procedure to edit the pkgsrc guide is:
11092:
11093: 1. Make sure you have the packages needed to regenerate the pkgsrc guide (and
1.46 obache 11094: other XML-based NetBSD documentation) installed. These are automatically
11095: installed when you install the meta-pkgs/pkgsrc-guide-tools package.
1.1 dsieger 11096:
11097: 2. Run cd doc/guide to get to the right directory. All further steps will take
11098: place here.
11099:
11100: 3. Edit the XML file(s) in files/.
11101:
11102: 4. Run bmake to check the pkgsrc guide for valid XML and to build the final
11103: output files. If you get any errors at this stage, you can just edit the
11104: files, as there are only symbolic links in the working directory, pointing
11105: to the files in files/.
11106:
11107: 5. (cd files && cvs commit)
11108:
11109: 6. Run bmake clean && bmake to regenerate the output files with the proper RCS
11110: Ids.
11111:
11112: 7. Run bmake regen to install and commit the files in both pkgsrc/doc and
11113: htdocs.
11114:
11115: Note
11116:
11117: If you have added, removed or renamed some chapters, you need to
11118: synchronize them using cvs add or cvs delete in the htdocs directory.
11119:
CVSweb <webmaster@jp.NetBSD.org>