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