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