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