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