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