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