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