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