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