Annotation of htdocs/docs/pkgsrc/pkgsrc.txt, revision 1.256
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.252 jnemeth 15: Copyright 1994-2024 The NetBSD Foundation, Inc
1.1 dsieger 16:
1.252 jnemeth 17: $NetBSD: pkgsrc.xml,v 1.43 2024/01/02 07:26:32 jnemeth 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: 1.1. Introduction
32: 1.1.1. Why pkgsrc?
33: 1.1.2. Supported platforms
34: 1.2. Overview
35: 1.3. Terminology
36: 1.3.1. Roles involved in pkgsrc
37: 1.4. Typography
38: I. The pkgsrc user's guide
1.154 rillig 39: 2. Getting help
40: 3. Where to get pkgsrc and how to keep it up-to-date
41: 3.1. Getting pkgsrc for the first time
42: 3.1.1. As tar archive
43: 3.1.2. Via anonymous CVS
44: 3.2. Keeping pkgsrc up-to-date
45: 3.2.1. Via tar files
46: 3.2.2. Via CVS
47: 4. Using pkgsrc on systems other than NetBSD
48: 4.1. Binary distribution
49: 4.2. Bootstrapping pkgsrc
50: 5. Using pkgsrc
51: 5.1. Using binary packages
52: 5.1.1. Finding binary packages
53: 5.1.2. Installing binary packages
1.202 nia 54: 5.1.3. Updating packages
55: 5.1.4. Deinstalling packages
56: 5.1.5. Getting information about installed packages
57: 5.1.6. Checking for security vulnerabilities in installed packages
58: 5.1.7. Finding if newer versions of your installed packages are in
1.232 gutterid 59: pkgsrc
1.202 nia 60: 5.1.8. Other administrative functions
1.154 rillig 61: 5.2. Building packages from source
62: 5.2.1. Requirements
63: 5.2.2. Fetching distfiles
64: 5.2.3. How to build and install
65: 6. Configuring pkgsrc
66: 6.1. General configuration
67: 6.2. Variables affecting the build process
1.241 rillig 68: 6.3. Preferences for native or pkgsrc software
69: 6.4. Variables affecting the installation process
70: 6.5. Selecting and configuring the compiler
71: 6.5.1. Selecting the compiler
72: 6.5.2. Additional flags to the compiler (CFLAGS)
73: 6.5.3. Additional flags to the linker (LDFLAGS)
74: 6.6. Developer/advanced settings
75: 6.7. Selecting Build Options
1.154 rillig 76: 7. Creating binary packages
77: 7.1. Building a single binary package
78: 7.2. Settings for creation of binary packages
79: 8. Creating binary packages for everything in pkgsrc (bulk builds)
80: 8.1. Preparations
1.180 rillig 81: 8.2. Running a bulk build
1.154 rillig 82: 8.2.1. Configuration
83: 8.3. Requirements of a full bulk build
1.178 rillig 84: 8.4. Bulk build variants
1.179 rillig 85: 8.4.1. Detect unknown configure options
86: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.181 rillig 87: 8.4.3. Force compiler options only in the build phase
88: 8.4.4. Use custom directories
89: 8.4.5. Turn warnings into errors
90: 8.4.6. Reject packages for which pkglint reports errors
91: 8.4.7. Reject packages that contain forbidden strings
92: 8.4.8. Reject packages whose self-test fails
93: 8.4.9. Reject packages that use undefined shell variables
94: 8.4.10. Turn off verbose logging
1.178 rillig 95: 8.5. Creating a multiple CD-ROM packages collection
96: 8.5.1. Example of cdpack
1.154 rillig 97: 9. Directory layout of the installed files
98: 9.1. File system layout in ${LOCALBASE}
99: 9.2. File system layout in ${VARBASE}
100: 10. Frequently Asked Questions
101: 10.1. Are there any mailing lists for pkg-related discussion?
102: 10.2. Utilities for package management (pkgtools)
103: 10.3. How to use pkgsrc as non-root
104: 10.4. How to resume transfers when fetching distfiles?
105: 10.5. How can I install/use modular X.org from pkgsrc?
106: 10.6. How to fetch files from behind a firewall
107: 10.7. How to fetch files from HTTPS sites
108: 10.8. How do I tell make fetch to do passive FTP?
109: 10.9. How to fetch all distfiles at once
110: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc"
1.232 gutterid 111: mean?
1.154 rillig 112: 10.11. What does "Could not find bsd.own.mk" mean?
1.221 nia 113: 10.12. Using 'sudo' or `priv` with pkgsrc
1.154 rillig 114: 10.13. How do I change the location of configuration files?
115: 10.14. Automated security checks
116: 10.15. Why do some packages ignore my CFLAGS?
117: 10.16. A package does not build. What shall I do?
118: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/???
1.232 gutterid 119: merge conflicts" mean?
1.1 dsieger 120: II. The pkgsrc developer's guide
1.154 rillig 121: 11. Getting help
1.184 rillig 122: 12. Package components - files, directories and contents
123: 12.1. Makefile
124: 12.2. distinfo
125: 12.3. patches/*
126: 12.3.1. Structure of a single patch file
127: 12.3.2. Creating patch files
128: 12.3.3. Sources where the patch files come from
129: 12.3.4. Patching guidelines
130: 12.3.5. Feedback to the author
131: 12.4. Other mandatory files
132: 12.5. Optional files
133: 12.5.1. Files affecting the binary package
134: 12.5.2. Files affecting the build process
135: 12.5.3. Files affecting nothing at all
136: 12.6. work*
137: 12.7. files/*
138: 13. The build process
139: 13.1. Introduction
140: 13.2. Program location
141: 13.3. Directories used during the build process
142: 13.4. Running a phase
143: 13.5. The fetch phase
144: 13.5.1. What to fetch and where to get it from
145: 13.5.2. How are the files fetched?
146: 13.6. The checksum phase
147: 13.7. The extract phase
148: 13.8. The patch phase
149: 13.9. The tools phase
150: 13.10. The wrapper phase
151: 13.11. The configure phase
152: 13.12. The build phase
153: 13.13. The test phase
154: 13.14. The install phase
155: 13.15. The package phase
156: 13.16. Cleaning up
157: 13.17. Other helpful targets
158: 14. Creating a new pkgsrc package from scratch
159: 14.1. Common types of packages
1.219 nia 160: 14.1.1. Python modules and programs
161: 14.1.2. R packages
162: 14.1.3. TeXlive packages
1.184 rillig 163: 14.2. Examples
164: 14.2.1. How the www/nvu package came into pkgsrc
165: 15. Programming in Makefiles
166: 15.1. Caveats
167: 15.2. Makefile variables
168: 15.2.1. Naming conventions
169: 15.3. Code snippets
170: 15.3.1. Adding things to a list
171: 15.3.2. Echoing a string exactly as-is
172: 15.3.3. Passing CFLAGS to GNU configure scripts
173: 15.3.4. Handling possibly empty variables
1.229 gutterid 174: 15.3.5. Testing yes/no variables in conditions
1.184 rillig 175: 16. Options handling
176: 16.1. Global default options
177: 16.2. Converting packages to use bsd.options.mk
178: 16.3. Option Names
179: 16.4. Determining the options of dependencies
180: 17. Tools needed for building or running
181: 17.1. Tools for pkgsrc builds
182: 17.2. Tools needed by packages
183: 17.3. Tools provided by platforms
184: 18. Buildlink methodology
185: 18.1. Converting packages to use buildlink3
186: 18.2. Writing buildlink3.mk files
187: 18.2.1. Anatomy of a buildlink3.mk file
188: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and
1.232 gutterid 189: BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files
1.184 rillig 190: 18.3. Writing builtin.mk files
191: 18.3.1. Anatomy of a builtin.mk file
192: 19. PLIST issues
193: 19.1. RCS ID
194: 19.2. Semi-automatic PLIST generation
195: 19.3. Tweaking output of make print-PLIST
196: 19.4. Variable substitution in PLIST
197: 19.5. Man page compression
198: 19.6. Changing PLIST source with PLIST_SRC
199: 19.7. Platform-specific and differing PLISTs
200: 19.8. Build-specific PLISTs
201: 19.9. Sharing directories between packages
202: 20. The pkginstall framework
203: 20.1. Files and directories outside the installation prefix
204: 20.1.1. Directory manipulation
205: 20.1.2. File manipulation
206: 20.2. Configuration files
207: 20.2.1. How PKG_SYSCONFDIR is set
208: 20.2.2. Telling the software where configuration files are
1.239 dholland 209: 20.2.3. Patching installation
210: 20.2.4. Declaring configuration files
211: 20.2.5. Disabling handling of configuration files
1.184 rillig 212: 20.3. System startup scripts
213: 20.3.1. Disabling handling of system startup scripts
214: 20.4. System users and groups
215: 20.5. System shells
216: 20.5.1. Disabling shell registration
217: 20.6. Fonts
218: 20.6.1. Disabling automatic update of the fonts databases
1.154 rillig 219: 21. Making your package work
220: 21.1. General operation
221: 21.1.1. How to pull in user-settable variables from mk.conf
222: 21.1.2. User interaction
223: 21.1.3. Handling licenses
224: 21.1.4. Restricted packages
225: 21.1.5. Handling dependencies
226: 21.1.6. Handling conflicts with other packages
227: 21.1.7. Packages that cannot or should not be built
228: 21.1.8. Packages which should not be deleted, once installed
229: 21.1.9. Handling packages with security problems
230: 21.1.10. How to handle incrementing versions when fixing an
1.232 gutterid 231: existing package
1.154 rillig 232: 21.1.11. Substituting variable text in the package files (the SUBST
1.232 gutterid 233: framework)
1.154 rillig 234: 21.2. The fetch phase
235: 21.2.1. Packages whose distfiles aren't available for plain
1.232 gutterid 236: downloading
1.154 rillig 237: 21.2.2. How to handle modified distfiles with the 'old' name
238: 21.2.3. Packages hosted on github.com
239: 21.3. The configure phase
240: 21.3.1. Shared libraries - libtool
241: 21.3.2. Using libtool on GNU packages that already support libtool
242: 21.3.3. GNU Autoconf/Automake
1.223 nia 243: 21.3.4. Meson / ninja
1.154 rillig 244: 21.4. Programming languages
245: 21.4.1. C, C++, and Fortran
246: 21.4.2. Java
1.205 wiz 247: 21.4.3. Go
1.223 nia 248: 21.4.4. Rust
249: 21.4.5. Packages containing Perl scripts
250: 21.4.6. Packages containing shell scripts
251: 21.4.7. Other programming languages
1.154 rillig 252: 21.5. The build phase
253: 21.5.1. Compiling C and C++ code conditionally
254: 21.5.2. How to handle compiler bugs
1.172 rillig 255: 21.5.3. No such file or directory
256: 21.5.4. Undefined reference to "..."
257: 21.5.5. Running out of memory
1.154 rillig 258: 21.6. The install phase
259: 21.6.1. Creating needed directories
260: 21.6.2. Where to install documentation
261: 21.6.3. Installing highscore files
262: 21.6.4. Adding DESTDIR support to packages
263: 21.6.5. Packages with hardcoded paths to other interpreters
1.203 nia 264: 21.6.6. Packages installing Perl modules
1.254 wiz 265: 21.6.7. Packages installing pkg-config files
266: 21.6.8. Packages installing info files
267: 21.6.9. Packages installing man pages
268: 21.6.10. Packages installing X11 fonts
269: 21.6.11. Packages installing SGML or XML data
270: 21.6.12. Packages installing extensions to the MIME database
271: 21.6.13. Packages using intltool
272: 21.6.14. Packages installing startup scripts
273: 21.6.15. Packages installing TeX modules
274: 21.6.16. Packages supporting running binaries in emulation
275: 21.6.17. Packages installing hicolor icons
276: 21.6.18. Packages installing desktop files
1.154 rillig 277: 21.7. Marking packages as having problems
1.184 rillig 278: 22. GNOME packaging and porting
279: 22.1. Meta packages
280: 22.2. Packaging a GNOME application
281: 22.3. Updating GNOME to a newer version
282: 22.4. Patching guidelines
1.154 rillig 283: 23. Submitting and Committing
284: 23.1. Submitting binary packages
285: 23.2. Submitting source packages (for non-NetBSD-developers)
286: 23.3. General notes when adding, updating, or removing packages
287: 23.4. Commit Messages
288: 23.5. Committing: Adding a package to CVS
289: 23.6. Updating a package to a newer version
290: 23.7. Renaming a package in pkgsrc
291: 23.8. Moving a package in pkgsrc
292: 24. Frequently Asked Questions
1.1 dsieger 293: III. The pkgsrc infrastructure internals
1.184 rillig 294: 25. Design of the pkgsrc infrastructure
295: 25.1. The meaning of variable definitions
296: 25.2. Avoiding problems before they arise
297: 25.3. Variable evaluation
298: 25.3.1. At load time
299: 25.3.2. At runtime
300: 25.4. How can variables be specified?
301: 25.5. Designing interfaces for Makefile fragments
302: 25.5.1. Procedures with parameters
303: 25.5.2. Actions taken on behalf of parameters
304: 25.6. The order in which files are loaded
305: 25.6.1. The order in bsd.prefs.mk
306: 25.6.2. The order in bsd.pkg.mk
307: 26. Regression tests
308: 26.1. Running the regression tests
309: 26.2. Adding a new regression test
310: 26.2.1. Overridable functions
311: 26.2.2. Helper functions
312: 27. Porting pkgsrc
313: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 314: A. A simple example package: bison
315: A.1. files
316: A.1.1. Makefile
317: A.1.2. DESCR
318: A.1.3. PLIST
319: A.1.4. Checking a package with pkglint
320: A.2. Steps for building, installing, packaging
1.207 leot 321: B. Security hardening
322: B.1. Mechanisms
323: B.1.1. Enabled by default
324: B.1.2. Not enabled by default
325: B.2. Caveats
326: B.2.1. Problems with PKGSRC_MKPIE
327: B.2.2. Problems with PKGSRC_USE_FORTIFY
328: B.2.3. Problems with PKGSRC_USE_RELRO
329: B.2.4. Problems with PKGSRC_USE_SSP
330: B.3. Auditing the system
331: B.3.1. Checking for PIE
332: B.3.2. Checking for partial RELRO
333: B.3.3. Checking for full RELRO
334: B.3.4. Checking for SSP
335: C. Build logs
336: C.1. Building figlet
337: C.2. Packaging figlet
338: D. Directory layout of the pkgsrc FTP server
339: D.1. distfiles: The distributed source files
340: D.2. misc: Miscellaneous things
341: D.3. packages: Binary packages
342: D.4. reports: Bulk build reports
343: D.5. current, stable, pkgsrc-20xxQy: source packages
344: E. Help topics
345: F. Editing guidelines for the pkgsrc guide
346: F.1. Make targets
347: F.2. Procedure
1.1 dsieger 348:
349: List of Tables
350:
351: 1.1. Platforms supported by pkgsrc
1.184 rillig 352: 12.1. Patching examples
353: 22.1. PLIST handling for GNOME packages
1.1 dsieger 354:
355: Chapter 1. What is pkgsrc?
356:
357: Table of Contents
358:
359: 1.1. Introduction
360: 1.1.1. Why pkgsrc?
361: 1.1.2. Supported platforms
362: 1.2. Overview
363: 1.3. Terminology
364: 1.3.1. Roles involved in pkgsrc
365: 1.4. Typography
366:
367: 1.1. Introduction
368:
369: There is a lot of software freely available for Unix-based systems, which is
370: usually available in form of the source code. Before such software can be used,
371: it needs to be configured to the local system, compiled and installed, and this
372: is exactly what The NetBSD Packages Collection (pkgsrc) does. pkgsrc also has
373: some basic commands to handle binary packages, so that not every user has to
374: build the packages for himself, which is a time-costly task.
375:
376: pkgsrc currently contains several thousand packages, including:
377:
1.104 sevan 378: * www/apache24 - The Apache web server
1.1 dsieger 379:
380: * www/firefox - The Firefox web browser
381:
382: * meta-pkgs/gnome - The GNOME Desktop Environment
383:
1.102 ryoon 384: * meta-pkgs/kde4 - The K Desktop Environment
1.1 dsieger 385:
1.108 rillig 386: ? just to name a few.
1.1 dsieger 387:
388: pkgsrc has built-in support for handling varying dependencies, such as pthreads
389: and X11, and extended features such as IPv6 support on a range of platforms.
390:
391: 1.1.1. Why pkgsrc?
392:
393: pkgsrc provides the following key features:
394:
395: * Easy building of software from source as well as the creation and
396: installation of binary packages. The source and latest patches are
397: retrieved from a master or mirror download site, checksum verified, then
398: built on your system. Support for binary-only distributions is available
399: for both native platforms and NetBSD emulated platforms.
400:
401: * All packages are installed in a consistent directory tree, including
402: binaries, libraries, man pages and other documentation.
403:
1.104 sevan 404: * Tracking of package dependencies automatically, including when performing
405: updates, to ensure required packages are installed. The configuration files
406: of various packages are handled automatically during updates, so local
407: changes are preserved.
1.1 dsieger 408:
409: * Like NetBSD, pkgsrc is designed with portability in mind and consists of
410: highly portable code. This allows the greatest speed of development when
1.26 spz 411: porting to a new platform. This portability also ensures that pkgsrc is
1.1 dsieger 412: consistent across all platforms.
413:
414: * The installation prefix, acceptable software licenses, international
415: encryption requirements and build-time options for a large number of
416: packages are all set in a simple, central configuration file.
417:
418: * The entire source (not including the distribution files) is freely
419: available under a BSD license, so you may extend and adapt pkgsrc to your
420: needs. Support for local packages and patches is available right out of the
421: box, so you can configure it specifically for your environment.
422:
423: The following principles are basic to pkgsrc:
424:
1.198 leot 425: * "It should only work if it's right." -- That means, if a package contains
1.1 dsieger 426: bugs, it's better to find them and to complain about them rather than to
427: just install the package and hope that it works. There are numerous checks
1.175 gutterid 428: in pkgsrc that try to find such bugs: static analysis tools (pkgtools/
1.1 dsieger 429: pkglint), build-time checks (portability of shell scripts), and
430: post-installation checks (installed files, references to shared libraries,
431: script interpreters).
432:
1.198 leot 433: * "If it works, it should work everywhere" -- Like NetBSD has been ported to
1.1 dsieger 434: many hardware architectures, pkgsrc has been ported to many operating
435: systems. Care is taken that packages behave the same on all platforms.
436:
437: 1.1.2. Supported platforms
438:
439: pkgsrc consists of both a source distribution and a binary distribution for
440: these operating systems. After retrieving the required source or binaries, you
441: can be up and running with pkgsrc in just minutes!
442:
443: pkgsrc was derived from FreeBSD's ports system, and initially developed for
444: NetBSD only. Since then, pkgsrc has grown a lot, and now supports the following
445: platforms:
446:
447: Table 1.1. Platforms supported by pkgsrc
448:
1.92 sevan 449: +-----------------------------------------------------------------------------+
1.229 gutterid 450: | Platform | Date Support | Notes |
451: | | Added | |
452: |-------------------------------------+---------------+-----------------------|
453: |NetBSD | Aug 1997 | |
454: |-------------------------------------+---------------+-----------------------|
455: |Solaris | Mar 1999 |README.Solaris |
456: |-------------------------------------+---------------+-----------------------|
457: |Linux | Jun 1999 |README.Linux |
458: |-------------------------------------+---------------+-----------------------|
459: |Darwin / Mac OS X / OS X / macOS | Oct 2001 |README.macOS |
460: |-------------------------------------+---------------+-----------------------|
461: |FreeBSD | Nov 2002 |README.FreeBSD |
462: |-------------------------------------+---------------+-----------------------|
463: |OpenBSD | Nov 2002 |README.OpenBSD |
464: |-------------------------------------+---------------+-----------------------|
465: |IRIX | Dec 2002 |README.IRIX |
466: |-------------------------------------+---------------+-----------------------|
467: |BSD/OS | Dec 2003 | |
468: |-------------------------------------+---------------+-----------------------|
469: |AIX | Dec 2003 |README.AIX |
470: |-------------------------------------+---------------+-----------------------|
471: |Interix (Microsoft Windows Services | Mar 2004 |README.Interix |
472: |for Unix) | | |
473: |-------------------------------------+---------------+-----------------------|
474: |DragonFlyBSD | Oct 2004 | |
475: |-------------------------------------+---------------+-----------------------|
476: |OSF/1 | Nov 2004 |README.OSF1 |
477: |-------------------------------------+---------------+-----------------------|
478: |HP-UX | Apr 2007 |README.HPUX |
479: |-------------------------------------+---------------+-----------------------|
480: |Haiku | Sep 2010 |README.Haiku |
481: |-------------------------------------+---------------+-----------------------|
482: |MirBSD | Jan 2011 | |
483: |-------------------------------------+---------------+-----------------------|
484: |Minix3 | Nov 2011 |README.Minix3 |
485: |-------------------------------------+---------------+-----------------------|
486: |Cygwin | Mar 2013 |README.Cygwin |
487: |-------------------------------------+---------------+-----------------------|
488: |GNU/kFreeBSD | Jul 2013 |README.GNUkFreeBSD |
489: |-------------------------------------+---------------+-----------------------|
490: |Bitrig | Jun 2014 |Removed from pkgsrc Sep|
491: | | |2022 |
1.92 sevan 492: +-----------------------------------------------------------------------------+
1.1 dsieger 493:
494:
495: 1.2. Overview
496:
497: This document is divided into three parts. The first, The pkgsrc user's guide,
498: describes how one can use one of the packages in the Package Collection, either
499: by installing a precompiled binary package, or by building one's own copy using
500: the NetBSD package system. The second part, The pkgsrc developer's guide,
501: explains how to prepare a package so it can be easily built by other NetBSD
502: users without knowing about the package's building details. The third part, The
503: pkgsrc infrastructure internals is intended for those who want to understand
504: how pkgsrc is implemented.
505:
506: This document is available in various formats: HTML, PDF, PS, TXT.
507:
508: 1.3. Terminology
509:
510: There has been a lot of talk about "ports", "packages", etc. so far. Here is a
511: description of all the terminology used within this document.
512:
513: Package
514:
515: A set of files and building instructions that describe what's necessary to
516: build a certain piece of software using pkgsrc. Packages are traditionally
1.123 wiz 517: stored under /usr/pkgsrc, but may be stored in any location, referred to as
518: PKGSRCDIR.
1.1 dsieger 519:
520: The NetBSD package system
521:
522: This is the former name of "pkgsrc". It is part of the NetBSD operating
523: system and can be bootstrapped to run on non-NetBSD operating systems as
524: well. It handles building (compiling), installing, and removing of
525: packages.
526:
527: Distfile
528:
529: This term describes the file or files that are provided by the author of
530: the piece of software to distribute his work. All the changes necessary to
531: build on NetBSD are reflected in the corresponding package. Usually the
532: distfile is in the form of a compressed tar-archive, but other types are
533: possible, too. Distfiles are usually stored below /usr/pkgsrc/distfiles.
534:
535: Port
536:
537: This is the term used by FreeBSD and OpenBSD people for what we call a
538: package. In NetBSD terminology, "port" refers to a different architecture.
539:
540: Precompiled/binary package
541:
542: A set of binaries built with pkgsrc from a distfile and stuffed together in
543: a single .tgz file so it can be installed on machines of the same machine
544: architecture without the need to recompile. Packages are usually generated
545: in /usr/pkgsrc/packages; there is also an archive on ftp.NetBSD.org.
546:
547: Sometimes, this is referred to by the term "package" too, especially in the
548: context of precompiled packages.
549:
550: Program
551:
552: The piece of software to be installed which will be constructed from all
553: the files in the distfile by the actions defined in the corresponding
554: package.
555:
556: 1.3.1. Roles involved in pkgsrc
557:
558: pkgsrc users
559:
560: The pkgsrc users are people who use the packages provided by pkgsrc.
561: Typically they are system administrators. The people using the software
562: that is inside the packages (maybe called "end users") are not covered by
563: the pkgsrc guide.
564:
565: There are two kinds of pkgsrc users: Some only want to install pre-built
566: binary packages. Others build the pkgsrc packages from source, either for
567: installing them directly or for building binary packages themselves. For
568: pkgsrc users Part I, "The pkgsrc user's guide" should provide all necessary
569: documentation.
570:
571: package maintainers
572:
573: A package maintainer creates packages as described in Part II, "The pkgsrc
574: developer's guide".
575:
576: infrastructure developers
577:
578: These people are involved in all those files that live in the mk/ directory
579: and below. Only these people should need to read through Part III, "The
580: pkgsrc infrastructure internals", though others might be curious, too.
581:
582: 1.4. Typography
583:
584: When giving examples for commands, shell prompts are used to show if the
585: command should/can be issued as root, or if "normal" user privileges are
1.115 sevan 586: sufficient. We use a # for root's shell prompt, a % for users' shell prompt,
1.229 gutterid 587: assuming they use the C-shell or tcsh and a $ for Bourne shell and derivatives.
1.1 dsieger 588:
589: Part I. The pkgsrc user's guide
590:
591: Table of Contents
592:
1.154 rillig 593: 2. Getting help
594: 3. Where to get pkgsrc and how to keep it up-to-date
595: 3.1. Getting pkgsrc for the first time
596: 3.1.1. As tar archive
597: 3.1.2. Via anonymous CVS
598: 3.2. Keeping pkgsrc up-to-date
599: 3.2.1. Via tar files
600: 3.2.2. Via CVS
601: 4. Using pkgsrc on systems other than NetBSD
602: 4.1. Binary distribution
603: 4.2. Bootstrapping pkgsrc
604: 5. Using pkgsrc
605: 5.1. Using binary packages
606: 5.1.1. Finding binary packages
607: 5.1.2. Installing binary packages
1.202 nia 608: 5.1.3. Updating packages
609: 5.1.4. Deinstalling packages
610: 5.1.5. Getting information about installed packages
611: 5.1.6. Checking for security vulnerabilities in installed packages
612: 5.1.7. Finding if newer versions of your installed packages are in
1.232 gutterid 613: pkgsrc
1.202 nia 614: 5.1.8. Other administrative functions
1.154 rillig 615: 5.2. Building packages from source
616: 5.2.1. Requirements
617: 5.2.2. Fetching distfiles
618: 5.2.3. How to build and install
619: 6. Configuring pkgsrc
620: 6.1. General configuration
621: 6.2. Variables affecting the build process
1.241 rillig 622: 6.3. Preferences for native or pkgsrc software
623: 6.4. Variables affecting the installation process
624: 6.5. Selecting and configuring the compiler
625: 6.5.1. Selecting the compiler
626: 6.5.2. Additional flags to the compiler (CFLAGS)
627: 6.5.3. Additional flags to the linker (LDFLAGS)
628: 6.6. Developer/advanced settings
629: 6.7. Selecting Build Options
1.154 rillig 630: 7. Creating binary packages
631: 7.1. Building a single binary package
632: 7.2. Settings for creation of binary packages
633: 8. Creating binary packages for everything in pkgsrc (bulk builds)
634: 8.1. Preparations
1.180 rillig 635: 8.2. Running a bulk build
1.154 rillig 636: 8.2.1. Configuration
637: 8.3. Requirements of a full bulk build
1.178 rillig 638: 8.4. Bulk build variants
1.179 rillig 639: 8.4.1. Detect unknown configure options
640: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.181 rillig 641: 8.4.3. Force compiler options only in the build phase
642: 8.4.4. Use custom directories
643: 8.4.5. Turn warnings into errors
644: 8.4.6. Reject packages for which pkglint reports errors
645: 8.4.7. Reject packages that contain forbidden strings
646: 8.4.8. Reject packages whose self-test fails
647: 8.4.9. Reject packages that use undefined shell variables
648: 8.4.10. Turn off verbose logging
1.178 rillig 649: 8.5. Creating a multiple CD-ROM packages collection
650: 8.5.1. Example of cdpack
1.154 rillig 651: 9. Directory layout of the installed files
652: 9.1. File system layout in ${LOCALBASE}
653: 9.2. File system layout in ${VARBASE}
654: 10. Frequently Asked Questions
655: 10.1. Are there any mailing lists for pkg-related discussion?
656: 10.2. Utilities for package management (pkgtools)
657: 10.3. How to use pkgsrc as non-root
658: 10.4. How to resume transfers when fetching distfiles?
659: 10.5. How can I install/use modular X.org from pkgsrc?
660: 10.6. How to fetch files from behind a firewall
661: 10.7. How to fetch files from HTTPS sites
662: 10.8. How do I tell make fetch to do passive FTP?
663: 10.9. How to fetch all distfiles at once
664: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
665: 10.11. What does "Could not find bsd.own.mk" mean?
1.221 nia 666: 10.12. Using 'sudo' or `priv` with pkgsrc
1.154 rillig 667: 10.13. How do I change the location of configuration files?
668: 10.14. Automated security checks
669: 10.15. Why do some packages ignore my CFLAGS?
670: 10.16. A package does not build. What shall I do?
671: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.232 gutterid 672: conflicts" mean?
1.1 dsieger 673:
1.154 rillig 674: Chapter 2. Getting help
675:
676: To get help when using pkgsrc, the definitive source is this document, the
677: pkgsrc guide. If you don't find anything here, there are alternatives:
678:
679: * The built-in pkgsrc help, which is available after bootstrapping pkgsrc.
680: Run bmake help topic=? to get help for any topic, such as a variable name
681: like BUILD_DEFS, a make target like do-build, a missing C or C++ function
682: like strcasecmp or any other topic.
683:
1.207 leot 684: The available help topics are listed in Appendix E, Help topics.
1.154 rillig 685:
1.163 rillig 686: * To see the value of a single variable, run bmake show-var VARNAME=X.
687:
688: * To see the values of the most common variables, run bmake show-all. These
689: variables are grouped by topic. To see the variables for a single topic,
690: run bmake show-all-topic, for example bmake show-all-fetch.
691:
1.154 rillig 692: * The pkgsrc-users mailing list, to which you can subscribe and then ask your
693: questions.
694:
695: * The #pkgsrc IRC channel, which is accessible via a web browser or by using
696: a specialized chat program such as XChat. Pick any user name and join the
697: channel #pkgsrc.
698:
699: Chapter 3. Where to get pkgsrc and how to keep it up-to-date
1.1 dsieger 700:
701: Table of Contents
702:
1.154 rillig 703: 3.1. Getting pkgsrc for the first time
704: 3.1.1. As tar archive
705: 3.1.2. Via anonymous CVS
706: 3.2. Keeping pkgsrc up-to-date
707: 3.2.1. Via tar files
708: 3.2.2. Via CVS
1.1 dsieger 709:
710: Before you download and extract the files, you need to decide where you want to
711: extract them. When using pkgsrc as root user, pkgsrc is usually installed in /
712: usr/pkgsrc. You are though free to install the sources and binary packages
713: wherever you want in your filesystem, provided that the pathname does not
714: contain white-space or other characters that are interpreted specially by the
715: shell and some other programs. A safe bet is to use only letters, digits,
716: underscores and dashes.
717:
1.154 rillig 718: 3.1. Getting pkgsrc for the first time
1.1 dsieger 719:
1.25 wiz 720: Before you download any pkgsrc files, you should decide whether you want the
1.1 dsieger 721: current branch or the stable branch. The latter is forked on a quarterly basis
722: from the current branch and only gets modified for security updates. The names
723: of the stable branches are built from the year and the quarter, for example
1.246 leot 724: 2023Q3.
1.1 dsieger 725:
726: The second step is to decide how you want to download pkgsrc. You can get it as
1.24 wiz 727: a tar file or via CVS. Both ways are described here.
1.1 dsieger 728:
1.52 asau 729: Note that tar archive contains CVS working copy. Thus you can switch to using
730: CVS at any later time.
1.1 dsieger 731:
1.154 rillig 732: 3.1.1. As tar archive
1.52 asau 733:
1.151 sevan 734: The primary download location for all pkgsrc files is https://cdn.NetBSD.org/
735: pub/pkgsrc/ or ftp://ftp.NetBSD.org/pub/pkgsrc/ (it points to the same
736: location). There are a number of subdirectories for different purposes, which
1.207 leot 737: are described in detail in Appendix D, Directory layout of the pkgsrc FTP
1.151 sevan 738: server.
1.1 dsieger 739:
1.52 asau 740: The tar archive for the current branch is in the directory current and is
1.118 sevan 741: called pkgsrc.tar.gz. It is autogenerated weekly.
1.52 asau 742:
743: To save download time we provide bzip2- and xz-compressed archives which are
744: published at pkgsrc.tar.bz2 and pkgsrc.tar.xz respectively.
745:
746: You can fetch the same files using FTP.
1.1 dsieger 747:
1.246 leot 748: The tar file for the stable branch 2023Q3 is in the directory pkgsrc-2023Q3 and
1.59 jnemeth 749: is also called pkgsrc.tar.gz.
1.1 dsieger 750:
1.136 leot 751: To download the latest pkgsrc stable tarball, run:
1.12 weinem 752:
1.246 leot 753: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2023Q3/pkgsrc.tar.gz
1.12 weinem 754:
1.78 snj 755: If you prefer, you can also fetch it using "wget", "curl", or your web browser.
1.52 asau 756:
1.12 weinem 757: Then, extract it with:
758:
1.78 snj 759: $ tar -xzf pkgsrc.tar.gz -C /usr
1.12 weinem 760:
761: This will create the directory pkgsrc/ in /usr/ and all the package source will
762: be stored under /usr/pkgsrc/.
763:
764: To download pkgsrc-current, run:
765:
766: $ ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz
1.1 dsieger 767:
1.154 rillig 768: 3.1.2. Via anonymous CVS
1.1 dsieger 769:
1.24 wiz 770: To fetch a specific pkgsrc stable branch, run:
1.1 dsieger 771:
1.246 leot 772: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2023Q3 -P pkgsrc
1.13 weinem 773:
1.24 wiz 774: This will create the directory pkgsrc/ in your /usr/ directory and all the
775: package source will be stored under /usr/pkgsrc/.
776:
777: To fetch the pkgsrc current branch, run:
1.1 dsieger 778:
1.40 wiz 779: $ cd /usr && cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 780:
1.30 dholland 781: Refer to the list of available mirrors to choose a faster CVS mirror, if
782: needed.
1.1 dsieger 783:
1.24 wiz 784: If you get error messages from rsh, you need to set CVS_RSH variable. E.g.:
1.1 dsieger 785:
1.40 wiz 786: $ cd /usr && env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 787:
1.24 wiz 788: Refer to documentation on your command shell how to set CVS_RSH=ssh
789: permanently. For Bourne shells, you can set it in your .profile or better
790: globally in /etc/profile:
791:
792: # set CVS remote shell command
793: CVS_RSH=ssh
794: export CVS_RSH
1.12 weinem 795:
1.13 weinem 796: By default, CVS doesn't do things like most people would expect it to do. But
797: there is a way to convince CVS, by creating a file called .cvsrc in your home
1.12 weinem 798: directory and saving the following lines to it. This file will save you lots of
799: headache and some bug reports, so we strongly recommend it. You can find an
800: explanation of this file in the CVS documentation.
1.2 rillig 801:
802: # recommended CVS configuration file from the pkgsrc guide
1.155 sevan 803: cvs -q
1.2 rillig 804: checkout -P
1.4 rillig 805: update -dP
806: diff -upN
1.2 rillig 807: rdiff -u
1.24 wiz 808: release -d
1.1 dsieger 809:
1.154 rillig 810: 3.2. Keeping pkgsrc up-to-date
1.1 dsieger 811:
812: The preferred way to keep pkgsrc up-to-date is via CVS (which also works if you
813: have first installed it via a tar file). It saves bandwidth and hard disk
814: activity, compared to downloading the tar file again.
815:
1.154 rillig 816: 3.2.1. Via tar files
1.1 dsieger 817:
818: Warning
819:
820: When updating from a tar file, you first need to completely remove the old
821: pkgsrc directory. Otherwise those files that have been removed from pkgsrc in
822: the mean time will not be removed on your local disk, resulting in
823: inconsistencies. When removing the old files, any changes that you have done to
824: the pkgsrc files will be lost after updating. Therefore updating via CVS is
825: strongly recommended.
826:
827: Note that by default the distfiles and the binary packages are saved in the
828: pkgsrc tree, so don't forget to rescue them before updating. You can also
1.78 snj 829: configure pkgsrc to store distfiles and packages in directories outside the
1.154 rillig 830: pkgsrc tree by setting the DISTDIR and PACKAGES variables. See Chapter 6,
1.78 snj 831: Configuring pkgsrc for the details.
1.1 dsieger 832:
833: To update pkgsrc from a tar file, download the tar file as explained above.
834: Then, make sure that you have not made any changes to the files in the pkgsrc
835: directory. Remove the pkgsrc directory and extract the new tar file. Done.
836:
1.154 rillig 837: 3.2.2. Via CVS
1.1 dsieger 838:
1.26 spz 839: To update pkgsrc via CVS, change to the pkgsrc directory and run cvs:
1.12 weinem 840:
1.26 spz 841: $ cd /usr/pkgsrc && cvs update -dP
842:
843: If you get error messages from rsh, you need to set CVS_RSH variable as
844: described above. E.g.:
845:
846: $ cd /usr/pkgsrc && env CVS_RSH=ssh cvs up -dP
1.1 dsieger 847:
1.154 rillig 848: 3.2.2.1. Switching between different pkgsrc branches
1.1 dsieger 849:
850: When updating pkgsrc, the CVS program keeps track of the branch you selected.
851: But if you, for whatever reason, want to switch from the stable branch to the
852: current one, you can do it by adding the option "-A" after the "update"
1.25 wiz 853: keyword. To switch from the current branch back to the stable branch, add the "
1.246 leot 854: -rpkgsrc-2023Q3" option.
1.1 dsieger 855:
1.154 rillig 856: 3.2.2.2. What happens to my changes when updating?
1.1 dsieger 857:
858: When you update pkgsrc, the CVS program will only touch those files that are
859: registered in the CVS repository. That means that any packages that you created
860: on your own will stay unmodified. If you change files that are managed by CVS,
861: later updates will try to merge your changes with those that have been done by
862: others. See the CVS manual, chapter "update" for details.
863:
1.154 rillig 864: Chapter 4. Using pkgsrc on systems other than NetBSD
1.1 dsieger 865:
866: Table of Contents
867:
1.154 rillig 868: 4.1. Binary distribution
869: 4.2. Bootstrapping pkgsrc
1.1 dsieger 870:
1.154 rillig 871: 4.1. Binary distribution
1.1 dsieger 872:
1.154 rillig 873: See Section 5.1, "Using binary packages".
1.1 dsieger 874:
1.154 rillig 875: 4.2. Bootstrapping pkgsrc
1.1 dsieger 876:
1.44 asau 877: pkgsrc can be bootstrapped for use in two different modes: privileged and
878: unprivileged one. In unprivileged mode in contrast to privileged one all
1.45 asau 879: programs are installed under one particular user and cannot utilise privileged
1.44 asau 880: operations (packages don't create special users and all special file
881: permissions like setuid are ignored).
882:
1.1 dsieger 883: Installing the bootstrap kit from source should be as simple as:
884:
1.60 asau 885: # env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc
1.1 dsieger 886: # cd pkgsrc/bootstrap
887: # ./bootstrap
888:
889:
1.44 asau 890: To bootstrap in unprivileged mode pass "--unprivileged" flag to bootstrap
891:
892: By default, in privileged mode pkgsrc uses /usr/pkg for prefix where programs
1.118 sevan 893: will be installed in, and /usr/pkg/pkgdb for the package database directory
894: where pkgsrc will do its internal bookkeeping, /var is used as varbase, where
1.44 asau 895: packages install their persistent data. In unprivileged mode pkgsrc uses ~/pkg
1.118 sevan 896: for prefix, ~/pkg/pkgdb for the package database, and ~/pkg/var for varbase.
1.44 asau 897:
898: You can change default layout using command-line arguments. Run "./bootstrap
899: --help" to get details.
1.1 dsieger 900:
901: Note
902:
903: The bootstrap installs a bmake tool. Use this bmake when building via pkgsrc.
904: For examples in this guide, use bmake instead of "make".
905:
1.44 asau 906: Note
907:
908: It is possible to bootstrap multiple instances of pkgsrc using non-intersecting
909: directories. Use bmake corresponding to the installation you're working with to
910: build and install packages.
911:
1.154 rillig 912: Chapter 5. Using pkgsrc
1.1 dsieger 913:
914: Table of Contents
915:
1.154 rillig 916: 5.1. Using binary packages
917: 5.1.1. Finding binary packages
918: 5.1.2. Installing binary packages
1.202 nia 919: 5.1.3. Updating packages
920: 5.1.4. Deinstalling packages
921: 5.1.5. Getting information about installed packages
922: 5.1.6. Checking for security vulnerabilities in installed packages
923: 5.1.7. Finding if newer versions of your installed packages are in pkgsrc
924: 5.1.8. Other administrative functions
1.154 rillig 925: 5.2. Building packages from source
926: 5.2.1. Requirements
927: 5.2.2. Fetching distfiles
928: 5.2.3. How to build and install
1.1 dsieger 929:
930: Basically, there are two ways of using pkgsrc. The first is to only install the
931: package tools and to use binary packages that someone else has prepared. This
932: is the "pkg" in pkgsrc. The second way is to install the "src" of pkgsrc, too.
933: Then you are able to build your own packages, and you can still use binary
934: packages from someone else.
935:
1.154 rillig 936: 5.1. Using binary packages
1.1 dsieger 937:
1.151 sevan 938: On the cdn.NetBSD.org site and mirrors, there are collections of binary
1.9 rillig 939: packages, ready to be installed. These binary packages have been built using
940: the default settings for the directories, that is:
941:
942: * /usr/pkg for LOCALBASE, where most of the files are installed,
943:
944: * /usr/pkg/etc for configuration files,
945:
946: * /var for VARBASE, where those files are installed that may change after
947: installation.
948:
949: If you cannot use these directories for whatever reasons (maybe because you're
950: not root), you cannot use these binary packages, but have to build the packages
1.154 rillig 951: yourself, which is explained in Section 4.2, "Bootstrapping pkgsrc".
1.1 dsieger 952:
1.154 rillig 953: 5.1.1. Finding binary packages
1.1 dsieger 954:
1.5 weinem 955: To install binary packages, you first need to know from where to get them. The
1.202 nia 956: first place where you should look is on the main pkgsrc CDN in the directory /
957: pub/pkgsrc/packages.
1.5 weinem 958:
959: This directory contains binary packages for multiple platforms. First, select
1.226 gutterid 960: your operating system. Then, select your hardware architecture, and in the
961: third step, the OS version and the "version" of pkgsrc.
1.9 rillig 962:
1.226 gutterid 963: In this directory, you may find a file called bootstrap.tar.gz which contains
1.9 rillig 964: the package management tools. If the file is missing, it is likely that your
965: operating system already provides those tools. Download the file and extract it
966: in the / directory. It will create the directories /usr/pkg (containing the
1.118 sevan 967: tools for managing binary packages and the database of installed packages).
1.1 dsieger 968:
1.154 rillig 969: 5.1.2. Installing binary packages
1.1 dsieger 970:
1.85 wiz 971: In the directory from the last section, there is a subdirectory called All/,
1.9 rillig 972: which contains all the binary packages that are available for the platform,
1.202 nia 973: excluding those that may not be distributed via HTTP or FTP.
1.9 rillig 974:
975: To install packages directly from an FTP or HTTP server, run the following
976: commands in a Bourne-compatible shell (be sure to su to root first):
977:
1.202 nia 978: # PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"
979: # PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"
1.169 rillig 980: # PKG_PATH="$PKG_PATH/OPSYS/ARCH/VERSIONS/All/"
1.9 rillig 981: # export PATH PKG_PATH
1.202 nia 982: # pkg_add pkgin
1.9 rillig 983:
984: Instead of URLs, you can also use local paths, for example if you are
985: installing from a set of CDROMs, DVDs or an NFS-mounted repository. If you want
986: to install packages from multiple sources, you can separate them by a semicolon
987: in PKG_PATH.
988:
989: After these preparations, installing a package is very easy:
990:
1.202 nia 991: # pkgin search nginx
992: nginx-1.19.6 Lightweight HTTP server and mail proxy server
993: nginx-1.18.0nb8 Lightweight HTTP server and mail proxy server
994: # pkgin install zsh nginx-1.19.6 vim
1.1 dsieger 995:
1.202 nia 996: Note that pkgin is a user-friendly frontend to the pkg_* tools.
1.1 dsieger 997:
1.202 nia 998: Any prerequisite packages needed to run the package in question will be
999: installed, too, assuming they are present in the repository.
1.1 dsieger 1000:
1001: After you've installed packages, be sure to have /usr/pkg/bin and /usr/pkg/sbin
1002: in your PATH so you can actually start the just installed program.
1003:
1.202 nia 1004: 5.1.3. Updating packages
1.1 dsieger 1005:
1.202 nia 1006: To update binary packages, it is recommended that you use pkgin upgrade. This
1007: will compare the remote package repository to your locally installed packages
1008: and safely replace any older packages.
1.1 dsieger 1009:
1.202 nia 1010: Note that pkgsrc is released as quarterly branches. If you are updating to a
1011: newer quarterly branch of pkgsrc, you may need to adjust the repository in /usr
1012: /pkg/etc/pkgin/repositories.conf.
1.1 dsieger 1013:
1.202 nia 1014: 5.1.4. Deinstalling packages
1.1 dsieger 1015:
1.202 nia 1016: To deinstall a package, it does not matter whether it was installed from source
1017: code or from a binary package. Neither the pkgin or the pkg_delete command need
1018: to know.
1.1 dsieger 1019:
1.202 nia 1020: To delete a package, you can just run pkgin remove package-name. The package
1021: name can be given with or without version number.
1.1 dsieger 1022:
1.202 nia 1023: 5.1.5. Getting information about installed packages
1.1 dsieger 1024:
1025: The pkg_info shows information about installed packages or binary package
1.202 nia 1026: files. As with other management tools, it works with packages installed from
1027: source or binaries.
1.1 dsieger 1028:
1.202 nia 1029: 5.1.6. Checking for security vulnerabilities in installed packages
1.1 dsieger 1030:
1.202 nia 1031: The pkgsrc Security Team and Packages Groups maintain a list of known
1.164 leot 1032: vulnerabilities to packages which are (or have been) included in pkgsrc. The
1.202 nia 1033: list is available from the NetBSD CDN at https://cdn.NetBSD.org/pub/NetBSD/
1.179 rillig 1034: packages/vulns/pkg-vulnerabilities.
1.1 dsieger 1035:
1.202 nia 1036: Please note that not every "vulnerability" with a CVE assignment is exploitable
1037: in every configuration. Some bugs are marked as active simply because an fix
1038: was not marked as such. Operating system specific hardening and mitigation
1039: features may also reduce the impact of bugs.
1040:
1.23 jakllsch 1041: Through pkg_admin fetch-pkg-vulnerabilities, this list can be downloaded
1042: automatically, and a security audit of all packages installed on a system can
1043: take place.
1044:
1045: There are two components to auditing. The first step, pkg_admin
1046: fetch-pkg-vulnerabilities, is for downloading the list of vulnerabilities from
1047: the NetBSD FTP site. The second step, pkg_admin audit, checks to see if any of
1048: your installed packages are vulnerable. If a package is vulnerable, you will
1049: see output similar to the following:
1.1 dsieger 1050:
1051: Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174 leot 1052: https://www.samba.org/samba/whatsnew/macroexploit.html
1.1 dsieger 1053:
1.23 jakllsch 1054: You may wish to have the vulnerabilities file downloaded daily so that it
1055: remains current. This may be done by adding an appropriate entry to the root
1056: users crontab(5) entry. For example the entry
1057:
1.121 sevan 1058: # Download vulnerabilities file
1.118 sevan 1059: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities >/dev/null 2>&1
1.121 sevan 1060: # Audit the installed packages and email results to root
1061: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
1062: root >/dev/null 2>&1
1.118 sevan 1063:
1064:
1065: will update the vulnerability list every day at 3AM, followed by an audit at
1066: 3:09AM. The result of the audit are then emailed to root. On NetBSD this may be
1067: accomplished instead by adding the following line to /etc/daily.conf:
1068:
1069: fetch_pkg_vulnerabilities=YES
1070:
1.23 jakllsch 1071:
1.118 sevan 1072: to fetch the vulnerability list from the daily security script. The system is
1073: set to audit the packages by default but can be set explicitly, if desired (not
1.123 wiz 1074: required), by adding the following line to /etc/security.conf:
1.23 jakllsch 1075:
1.118 sevan 1076: check_pkg_vulnerabilities=YES
1.23 jakllsch 1077:
1078:
1.118 sevan 1079: see daily.conf(5) and security.conf(5) for more details.
1.1 dsieger 1080:
1.202 nia 1081: 5.1.7. Finding if newer versions of your installed packages are in pkgsrc
1.1 dsieger 1082:
1.12 weinem 1083: Install pkgtools/lintpkgsrc and run lintpkgsrc with the "-i" argument to check
1.202 nia 1084: if any packages are stale, e.g.
1.1 dsieger 1085:
1086: % lintpkgsrc -i
1087: ...
1088: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1089:
1090:
1.202 nia 1091: 5.1.8. Other administrative functions
1.1 dsieger 1092:
1093: The pkg_admin executes various administrative functions on the package system.
1094:
1.154 rillig 1095: 5.2. Building packages from source
1.1 dsieger 1096:
1097: After obtaining pkgsrc, the pkgsrc directory now contains a set of packages,
1.25 wiz 1098: organized into categories. You can browse the online index of packages, or run
1.1 dsieger 1099: make readme from the pkgsrc directory to build local README.html files for all
1100: packages, viewable with any web browser such as www/lynx or www/firefox.
1101:
1102: The default prefix for installed packages is /usr/pkg. If you wish to change
1103: this, you should do so by setting LOCALBASE in mk.conf. You should not try to
1104: use multiple different LOCALBASE definitions on the same system (inside a
1105: chroot is an exception).
1106:
1107: The rest of this chapter assumes that the package is already in pkgsrc. If it
1108: is not, see Part II, "The pkgsrc developer's guide" for instructions how to
1109: create your own packages.
1110:
1.154 rillig 1111: 5.2.1. Requirements
1.1 dsieger 1112:
1113: To build packages from source, you need a working C compiler. On NetBSD, you
1114: need to install the "comp" and the "text" distribution sets. If you want to
1115: build X11-related packages, the "xbase" and "xcomp" distribution sets are
1116: required, too.
1117:
1.154 rillig 1118: 5.2.2. Fetching distfiles
1.1 dsieger 1119:
1120: The first step for building a package is downloading the distfiles (i.e. the
1121: unmodified source). If they have not yet been downloaded, pkgsrc will fetch
1122: them automatically.
1123:
1124: If you have all files that you need in the distfiles directory, you don't need
1125: to connect. If the distfiles are on CD-ROM, you can mount the CD-ROM on /cdrom
1126: and add:
1127:
1128: DISTDIR=/cdrom/pkgsrc/distfiles
1129:
1130: to your mk.conf.
1131:
1132: By default a list of distribution sites will be randomly intermixed to prevent
1133: huge load on servers which holding popular packages (for example,
1134: SourceForge.net mirrors). Thus, every time when you need to fetch yet another
1135: distfile all the mirrors will be tried in new (random) order. You can turn this
1136: feature off by setting MASTER_SORT_RANDOM=NO (for PKG_DEVELOPERs it's already
1137: disabled).
1138:
1139: You can overwrite some of the major distribution sites to fit to sites that are
1140: close to your own. By setting one or two variables you can modify the order in
1141: which the master sites are accessed. MASTER_SORT contains a whitespace
1142: delimited list of domain suffixes. MASTER_SORT_REGEX is even more flexible, it
1143: contains a whitespace delimited list of regular expressions. It has higher
1144: priority than MASTER_SORT. Have a look at pkgsrc/mk/defaults/mk.conf to find
1145: some examples. This may save some of your bandwidth and time.
1146:
1147: You can change these settings either in your shell's environment, or, if you
1.4 rillig 1148: want to keep the settings, by editing the mk.conf file, and adding the
1.1 dsieger 1149: definitions there.
1150:
1.132 wiz 1151: If a package depends on many other packages (such as meta-pkgs/kde4), the build
1.1 dsieger 1152: process may alternate between periods of downloading source, and compiling. To
1153: ensure you have all the source downloaded initially you can run the command:
1154:
1155: % make fetch-list | sh
1156:
1157: which will output and run a set of shell commands to fetch the necessary files
1158: into the distfiles directory. You can also choose to download the files
1159: manually.
1160:
1.154 rillig 1161: 5.2.3. How to build and install
1.1 dsieger 1162:
1163: Once the software has downloaded, any patches will be applied, then it will be
1164: compiled for you. This may take some time depending on your computer, and how
1165: many other packages the software depends on and their compile time.
1166:
1167: Note
1168:
1169: If using bootstrap or pkgsrc on a non-NetBSD system, use the pkgsrc bmake
1170: command instead of "make" in the examples in this guide.
1171:
1172: For example, type
1173:
1174: % cd misc/figlet
1175: % make
1176:
1177:
1178: at the shell prompt to build the various components of the package.
1179:
1180: The next stage is to actually install the newly compiled program onto your
1181: system. Do this by entering:
1182:
1183: % make install
1184:
1185:
1186: while you are still in the directory for whatever package you are installing.
1187:
1188: Installing the package on your system may require you to be root. However,
1189: pkgsrc has a just-in-time-su feature, which allows you to only become root for
1190: the actual installation step.
1191:
1192: That's it, the software should now be installed and setup for use. You can now
1193: enter:
1194:
1195: % make clean
1196:
1197:
1198: to remove the compiled files in the work directory, as you shouldn't need them
1199: any more. If other packages were also added to your system (dependencies) to
1200: allow your program to compile, you can tidy these up also with the command:
1201:
1202: % make clean-depends
1203:
1204:
1205: Taking the figlet utility as an example, we can install it on our system by
1.207 leot 1206: building as shown in Appendix C, Build logs.
1.1 dsieger 1207:
1208: The program is installed under the default root of the packages tree - /usr/
1209: pkg. Should this not conform to your tastes, set the LOCALBASE variable in your
1210: environment, and it will use that value as the root of your packages tree. So,
1211: to use /usr/local, set LOCALBASE=/usr/local in your environment. Please note
1212: that you should use a directory which is dedicated to packages and not shared
1213: with other programs (i.e., do not try and use LOCALBASE=/usr). Also, you should
1214: not try to add any of your own files or directories (such as src/, obj/, or
1215: pkgsrc/) below the LOCALBASE tree. This is to prevent possible conflicts
1216: between programs and other files installed by the package system and whatever
1217: else may have been installed there.
1218:
1.4 rillig 1219: Some packages look in mk.conf to alter some configuration options at build
1.1 dsieger 1220: time. Have a look at pkgsrc/mk/defaults/mk.conf to get an overview of what will
1221: be set there by default. Environment variables such as LOCALBASE can be set in
1.4 rillig 1222: mk.conf to save having to remember to set them each time you want to use
1.1 dsieger 1223: pkgsrc.
1224:
1225: Occasionally, people want to "look under the covers" to see what is going on
1226: when a package is building or being installed. This may be for debugging
1227: purposes, or out of simple curiosity. A number of utility values have been
1228: added to help with this.
1229:
1230: 1. If you invoke the make(1) command with PKG_DEBUG_LEVEL=2, then a huge
1231: amount of information will be displayed. For example,
1232:
1233: make patch PKG_DEBUG_LEVEL=2
1234:
1.25 wiz 1235: will show all the commands that are invoked, up to and including the "patch
1236: " stage.
1.1 dsieger 1237:
1238: 2. If you want to know the value of a certain make(1) definition, then the
1239: VARNAME definition should be used, in conjunction with the show-var target.
1240: e.g. to show the expansion of the make(1) variable LOCALBASE:
1241:
1242: % make show-var VARNAME=LOCALBASE
1243: /usr/pkg
1244: %
1245:
1246:
1247: If you want to install a binary package that you've either created yourself
1248: (see next section), that you put into pkgsrc/packages manually or that is
1249: located on a remote FTP server, you can use the "bin-install" target. This
1250: target will install a binary package - if available - via pkg_add(1), else do a
1251: make package. The list of remote FTP sites searched is kept in the variable
1252: BINPKG_SITES, which defaults to ftp.NetBSD.org. Any flags that should be added
1253: to pkg_add(1) can be put into BIN_INSTALL_FLAGS. See pkgsrc/mk/defaults/mk.conf
1254: for more details.
1255:
1256: A final word of warning: If you set up a system that has a non-standard setting
1257: for LOCALBASE, be sure to set that before any packages are installed, as you
1258: cannot use several directories for the same purpose. Doing so will result in
1259: pkgsrc not being able to properly detect your installed packages, and fail
1260: miserably. Note also that precompiled binary packages are usually built with
1261: the default LOCALBASE of /usr/pkg, and that you should not install any if you
1262: use a non-standard LOCALBASE.
1263:
1.154 rillig 1264: Chapter 6. Configuring pkgsrc
1.1 dsieger 1265:
1266: Table of Contents
1267:
1.154 rillig 1268: 6.1. General configuration
1269: 6.2. Variables affecting the build process
1.241 rillig 1270: 6.3. Preferences for native or pkgsrc software
1271: 6.4. Variables affecting the installation process
1272: 6.5. Selecting and configuring the compiler
1273: 6.5.1. Selecting the compiler
1274: 6.5.2. Additional flags to the compiler (CFLAGS)
1275: 6.5.3. Additional flags to the linker (LDFLAGS)
1276: 6.6. Developer/advanced settings
1277: 6.7. Selecting Build Options
1.1 dsieger 1278:
1279: The whole pkgsrc system is configured in a single file, usually called mk.conf.
1280: In which directory pkgsrc looks for that file depends on the installation. On
1281: NetBSD, when you use make(1) from the base system, it is in the directory /etc
1282: /. In all other cases the default location is ${PREFIX}/etc/, depending on
1283: where you told the bootstrap program to install the binary packages.
1284:
1285: The format of the configuration file is that of the usual BSD-style Makefiles.
1286: The whole pkgsrc configuration is done by setting variables in this file. Note
1287: that you can define all kinds of variables, and no special error checking (for
1.112 rillig 1288: example for spelling mistakes) takes place.
1.1 dsieger 1289:
1.154 rillig 1290: 6.1. General configuration
1.1 dsieger 1291:
1.112 rillig 1292: The following variables apply to all pkgsrc packages. A complete list of the
1293: variables that can be configured by the user is available in mk/defaults/
1294: mk.conf, together with some comments that describe each variable's intent.
1.1 dsieger 1295:
1296: * LOCALBASE: Where packages will be installed. The default is /usr/pkg. Do
1297: not mix binary packages with different LOCALBASEs!
1298:
1299: * CROSSBASE: Where "cross" category packages will be installed. The default
1300: is ${LOCALBASE}/cross.
1301:
1.84 wiz 1302: * X11BASE: Where X11 is installed on the system. The default is /usr/X11R7.
1.1 dsieger 1303:
1304: * DISTDIR: Where to store the downloaded copies of the original source
1305: distributions used for building pkgsrc packages. The default is $
1306: {PKGSRCDIR}/distfiles.
1307:
1308: * PKG_DBDIR: Where the database about installed packages is stored. The
1.118 sevan 1309: default is /usr/pkg/pkgdb.
1.1 dsieger 1310:
1311: * MASTER_SITE_OVERRIDE: If set, override the packages' MASTER_SITES with this
1312: value.
1313:
1314: * MASTER_SITE_BACKUP: Backup location(s) for distribution files and patch
1315: files if not found locally or in ${MASTER_SITES} or ${PATCH_SITES}
1.118 sevan 1316: respectively. The defaults is ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/$
1.1 dsieger 1317: {DIST_SUBDIR}/.
1318:
1319: * BINPKG_SITES: List of sites carrying binary pkgs. rel and arch are replaced
1320: with OS release ("2.0", etc.) and architecture ("mipsel", etc.).
1321:
1.23 jakllsch 1322: * ACCEPTABLE_LICENSES: List of acceptable licenses. License names are
1323: case-sensitive. Whenever you try to build a package whose license is not in
1324: this list, you will get an error message. If the license condition is
1325: simple enough, the error message will include specific instructions on how
1326: to change this variable.
1.1 dsieger 1327:
1.154 rillig 1328: 6.2. Variables affecting the build process
1.1 dsieger 1329:
1330: * PACKAGES: The top level directory for the binary packages. The default is $
1331: {PKGSRCDIR}/packages.
1332:
1333: * WRKOBJDIR: The top level directory where, if defined, the separate working
1334: directories will get created, and symbolically linked to from ${WRKDIR}
1335: (see below). This is useful for building packages on several architectures,
1336: then ${PKGSRCDIR} can be NFS-mounted while ${WRKOBJDIR} is local to every
1337: architecture. (It should be noted that PKGSRCDIR should not be set by the
1.198 leot 1338: user -- it is an internal definition which refers to the root of the pkgsrc
1.1 dsieger 1339: tree. It is possible to have many pkgsrc tree instances.)
1340:
1341: * LOCALPATCHES: Directory for local patches that aren't part of pkgsrc. See
1.184 rillig 1342: Section 12.3, "patches/*" for more information.
1.1 dsieger 1343:
1344: * PKGMAKECONF: Location of the mk.conf file used by a package's BSD-style
1345: Makefile. If this is not set, MAKECONF is set to /dev/null to avoid picking
1346: up settings used by builds in /usr/src.
1347:
1.241 rillig 1348: 6.3. Preferences for native or pkgsrc software
1349:
1350: Whenever a package depends on a package that has a builtin.mk file, the
1351: dependent package can either use the built-in (native) version from the base
1352: system or the pkgsrc-provided version. This only affects dependencies, so it is
1353: still possible to build the pkgsrc package devel/pcre++ even when other
1354: packages depend on the native pcre++ version instead.
1355:
1356: To force using the pkgsrc-provided version for a particular package, define "
1357: PREFER_PKGSRC = package-ID" in mk.conf. To force using the native package,
1358: define "PREFER_NATIVE = package-ID". In both cases, the package-ID is the one
1359: from the buildlink3.mk of the package. In most cases, this ID is the same as
1360: the directory name of the package, but for example, devel/pcre++ has the
1361: package ID "pcrexx".
1362:
1363: For the packages that are not listed by their package ID, pkgsrc uses the
1364: pkgsrc-provided version if PREFER_PKGSRC contains the word "yes". Otherwise, if
1365: PREFER_NATIVE contains the word "yes", pkgsrc uses the native version. For
1366: example, to require using the pkgsrc-provided versions for all but the most
1367: basic bits on a NetBSD system, you can set:
1368:
1369: PREFER_PKGSRC= yes
1370: PREFER_NATIVE= getopt skey tcp_wrappers
1371:
1372: A package must have a builtin.mk file to be listed in PREFER_NATIVE, otherwise
1373: it is simply ignored in that list.
1374:
1375: PREFER_PKGSRC and PREFER_NATIVE should be set during bootstrap to ensure that
1376: the bootstrap process does not use inapropriate native tools as dependencies
1377: for core packages.
1378:
1379: # ./bootstrap --prefer-pkgsrc yes --prefer-native openssl
1380:
1381: Switching between settings globally at a later date can introduce complications
1382: with dependency resolution. This is caused by packages built with the opposite
1383: preference being installed alongside each other. Hence, when changing any of
1384: these variables after bootstrap, you need to rebuild all packages depending on
1385: those whose preference has been changed. This is not trivial and should be
1386: avoided.
1387:
1388: When using pkgsrc on Linux systems, there is high risk of "leakage", where
1389: programs installed by pkgsrc may inadvertently use a command or library not
1390: installed by pkgsrc, e.g. those installed by yum or apt. Such foreign
1391: dependencies may be installed, removed, or upgraded to a version incompatible
1392: with the pkgsrc package at any time, causing pkgsrc packages to subsequently
1393: malfunction. Pkgsrc cannot prevent this, as it has no control over other
1394: package managers. Another potential problem is that under Redhat Enterprise and
1395: related Linux systems, yum packages are only patched and never upgraded, so
1396: eventually they may become too outdated for use by pkgsrc. Even intentionally
1397: using foreign dependencies, not considered leakage, can lead to these problems,
1398: so it is generally discouraged. In order to minimize such problems,
1399: PREFER_PKGSRC defaults to "yes" on Linux systems. This ensures that pkgsrc is
1400: aware of any changes to dependency packages and can rebuild or upgrade the
1401: entire dependency tree as needed. This default can be overridden by setting
1402: --prefer-pkgsrc to a list of packages and --prefer-native to "yes".
1403:
1404: 6.4. Variables affecting the installation process
1.1 dsieger 1405:
1.198 leot 1406: * PKGSRC_KEEP_BIN_PKGS: By default, binary packages of built packages are
1.150 leot 1407: preserved in ${PACKAGES}/All. Setting this variable to "no" prevents this.
1.1 dsieger 1408:
1.107 jnemeth 1409: Packages have to support installation into a subdirectory of WRKDIR. This
1410: allows a package to be built, before the actual filesystem is touched. DESTDIR
1411: support exists in two variations:
1.4 rillig 1412:
1413: * Basic DESTDIR support means that the package installation and packaging is
1414: still run as root.
1415:
1416: * Full DESTDIR support can run the complete build, installation and packaging
1417: as normal user. Root privileges are only needed to add packages.
1418:
1419: With basic DESTDIR support, make clean needs to be run as root.
1420:
1.17 imil 1421: Considering the foo/bar package, DESTDIR full support can be tested using the
1422: following commands
1423:
1424: $ id
1425: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
1426: $ mkdir $HOME/packages
1427: $ cd $PKGSRCDIR/foo/bar
1428:
1429: Verify DESTDIR full support, no root privileges should be needed
1430:
1.66 asau 1431: $ make stage-install
1.17 imil 1432:
1433: Create a package without root privileges
1434:
1.66 asau 1435: $ make PACKAGES=$HOME/packages package
1.17 imil 1436:
1437: For the following command, you must be able to gain root privileges using su(1)
1438:
1.66 asau 1439: $ make PACKAGES=$HOME/packages install
1.17 imil 1440:
1441: Then, as a simple user
1442:
1443: $ make clean
1444:
1.241 rillig 1445: 6.5. Selecting and configuring the compiler
1.4 rillig 1446:
1.241 rillig 1447: 6.5.1. Selecting the compiler
1.1 dsieger 1448:
1449: By default, pkgsrc will use GCC to build packages. This may be overridden by
1450: setting the following variables in /etc/mk.conf:
1451:
1452: PKGSRC_COMPILER:
1453:
1454: This is a list of values specifying the chain of compilers to invoke when
1455: building packages. Valid values are:
1456:
1.232 gutterid 1457: o ccc: Compaq C Compilers (Tru64)
1.66 asau 1458:
1.232 gutterid 1459: o ccache: compiler cache (chainable)
1.66 asau 1460:
1.232 gutterid 1461: o clang: Clang C and Objective-C compiler
1.66 asau 1462:
1.232 gutterid 1463: o distcc: distributed C/C++ (chainable)
1.1 dsieger 1464:
1.232 gutterid 1465: o f2c: Fortran 77 to C compiler (chainable)
1.66 asau 1466:
1.232 gutterid 1467: o icc: Intel C++ Compiler (Linux)
1.66 asau 1468:
1.232 gutterid 1469: o ido: SGI IRIS Development Option cc (IRIX 5)
1.1 dsieger 1470:
1.232 gutterid 1471: o gcc: GNU C/C++ Compiler
1.1 dsieger 1472:
1.232 gutterid 1473: o hp: HP-UX C/aC++ compilers
1.66 asau 1474:
1.232 gutterid 1475: o mipspro: Silicon Graphics, Inc. MIPSpro (n32/n64)
1.1 dsieger 1476:
1.232 gutterid 1477: o mipspro-ucode: Silicon Graphics, Inc. MIPSpro (o32)
1.1 dsieger 1478:
1.232 gutterid 1479: o sunpro: Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio
1.1 dsieger 1480:
1.232 gutterid 1481: o xlc: IBM's XL C/C++ compiler suite
1.66 asau 1482:
1.1 dsieger 1483: The default is "gcc". You can use ccache and/or distcc with an appropriate
1484: PKGSRC_COMPILER setting, e.g. "ccache gcc". This variable should always be
1485: terminated with a value for a real compiler. Note that only one real
1486: compiler should be listed (e.g. "sunpro gcc" is not allowed).
1487:
1488: GCC_REQD:
1489:
1490: This specifies the minimum version of GCC to use when building packages. If
1491: the system GCC doesn't satisfy this requirement, then pkgsrc will build and
1492: install one of the GCC packages to use instead.
1493:
1.153 leot 1494: PYTHON_VERSION_DEFAULT:
1.114 maya 1495:
1496: Specifies which version of python to use when several options are
1497: available.
1498:
1499: PKGSRC_FORTRAN:
1500:
1.176 gutterid 1501: Specifies the Fortran compiler to use. The default is gfortran.
1.114 maya 1502:
1503: GFORTRAN_VERSION:
1504:
1505: If PKGSRC_FORTRAN= gfortran is used, this option specifies which version to
1506: use.
1507:
1.241 rillig 1508: 6.5.2. Additional flags to the compiler (CFLAGS)
1.1 dsieger 1509:
1510: If you wish to set the CFLAGS variable, please make sure to use the += operator
1511: instead of the = operator:
1512:
1513: CFLAGS+= -your -flags
1514:
1515: Using CFLAGS= (i.e. without the "+") may lead to problems with packages that
1.16 jnemeth 1516: need to add their own flags. You may want to take a look at the devel/cpuflags
1.24 wiz 1517: package if you're interested in optimization specifically for the current CPU.
1.1 dsieger 1518:
1.241 rillig 1519: 6.5.3. Additional flags to the linker (LDFLAGS)
1.1 dsieger 1520:
1521: If you want to pass flags to the linker, both in the configure step and the
1522: build step, you can do this in two ways. Either set LDFLAGS or LIBS. The
1523: difference between the two is that LIBS will be appended to the command line,
1524: while LDFLAGS come earlier. LDFLAGS is pre-loaded with rpath settings for ELF
1525: machines depending on the setting of USE_IMAKE or the inclusion of mk/
1526: x11.buildlink3.mk. As with CFLAGS, if you do not wish to override these
1527: settings, use the += operator:
1528:
1529: LDFLAGS+= -your -linkerflags
1530:
1.241 rillig 1531: 6.6. Developer/advanced settings
1.1 dsieger 1532:
1533: * PKG_DEVELOPER: Run some sanity checks that package developers want:
1534:
1.42 asau 1535: + make sure patches apply with zero fuzz
1.1 dsieger 1536:
1.42 asau 1537: + run check-shlibs to see that all binaries will find their shared libs.
1.1 dsieger 1538:
1.232 gutterid 1539: * CHECK_FILES_STRICT: Also check VARBASE and PKG_SYSCONFDIR values in PLIST
1540: entries.
1541:
1.1 dsieger 1542: * PKG_DEBUG_LEVEL: The level of debugging output which is displayed whilst
1543: making and installing the package. The default value for this is 0, which
1544: will not display the commands as they are executed (normal, default, quiet
1545: operation); the value 1 will display all shell commands before their
1546: invocation, and the value 2 will display both the shell commands before
1.112 rillig 1547: their invocation, as well as their actual execution progress with set -x.
1.1 dsieger 1548:
1.241 rillig 1549: 6.7. Selecting Build Options
1.1 dsieger 1550:
1551: Some packages have build time options, usually to select between different
1552: dependencies, enable optional support for big dependencies or enable
1553: experimental features.
1554:
1555: To see which options, if any, a package supports, and which options are
1556: mutually exclusive, run make show-options, for example:
1557:
1558: The following options are supported by this package:
1559: ssl Enable SSL support.
1560: Exactly one of the following gecko options is required:
1561: firefox Use firefox as gecko rendering engine.
1562: mozilla Use mozilla as gecko rendering engine.
1563: At most one of the following database options may be selected:
1564: mysql Enable support for MySQL database.
1565: pgsql Enable support for PostgreSQL database.
1566:
1567: These options are enabled by default: firefox
1568: These options are currently enabled: mozilla ssl
1569:
1.4 rillig 1570: The following variables can be defined in mk.conf to select which options to
1571: enable for a package: PKG_DEFAULT_OPTIONS, which can be used to select or
1.1 dsieger 1572: disable options for all packages that support them, and PKG_OPTIONS.pkgbase,
1573: which can be used to select or disable options specifically for package pkgbase
1574: . Options listed in these variables are selected, options preceded by "-" are
1575: disabled. A few examples:
1576:
1.4 rillig 1577: $ grep "PKG.*OPTION" mk.conf
1.1 dsieger 1578: PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
1579: PKG_OPTIONS.kdebase= debug -sasl
1580: PKG_OPTIONS.apache= suexec
1581:
1.11 rillig 1582: It is important to note that options that were specifically suggested by the
1.19 snj 1583: package maintainer must be explicitly removed if you do not wish to include the
1584: option. If you are unsure you can view the current state with make show-options
1585: .
1.11 rillig 1586:
1.1 dsieger 1587: The following settings are consulted in the order given, and the last setting
1588: that selects or disables an option is used:
1589:
1590: 1. the default options as suggested by the package maintainer
1591:
1592: 2. the options implied by the settings of legacy variables (see below)
1593:
1594: 3. PKG_DEFAULT_OPTIONS
1595:
1596: 4. PKG_OPTIONS.pkgbase
1597:
1598: For groups of mutually exclusive options, the last option selected is used, all
1599: others are automatically disabled. If an option of the group is explicitly
1600: disabled, the previously selected option, if any, is used. It is an error if no
1601: option from a required group of options is selected, and building the package
1602: will fail.
1603:
1604: Before the options framework was introduced, build options were selected by
1.4 rillig 1605: setting a variable (often named USE_FOO) in mk.conf for each option. To ease
1606: transition to the options framework for the user, these legacy variables are
1607: converted to the appropriate options setting (PKG_OPTIONS.pkgbase)
1608: automatically. A warning is issued to prompt the user to update mk.conf to use
1609: the options framework directly. Support for the legacy variables will be
1.1 dsieger 1610: removed eventually.
1611:
1.154 rillig 1612: Chapter 7. Creating binary packages
1.1 dsieger 1613:
1614: Table of Contents
1615:
1.154 rillig 1616: 7.1. Building a single binary package
1617: 7.2. Settings for creation of binary packages
1.1 dsieger 1618:
1.154 rillig 1619: 7.1. Building a single binary package
1.1 dsieger 1620:
1621: Once you have built and installed a package, you can create a binary package
1622: which can be installed on another system with pkg_add(1). This saves having to
1623: build the same package on a group of hosts and wasting CPU time. It also
1624: provides a simple means for others to install your package, should you
1625: distribute it.
1626:
1627: To create a binary package, change into the appropriate directory in pkgsrc,
1628: and run make package:
1629:
1.112 rillig 1630: $ cd misc/figlet
1631: $ make package
1.1 dsieger 1632:
1.242 gutterid 1633: This will build your package (if not already done) and package it into a binary
1634: package. You can then use the pkg_* tools to manipulate it. Binary packages are
1635: created in PACKAGES, which defaults to /usr/pkgsrc/packages, in the form of a
1636: compressed tar file. See Section C.2, "Packaging figlet" for a continuation of
1637: the above misc/figlet example.
1.1 dsieger 1638:
1.154 rillig 1639: See Chapter 23, Submitting and Committing for information on how to submit such
1.1 dsieger 1640: a binary package.
1641:
1.154 rillig 1642: 7.2. Settings for creation of binary packages
1.1 dsieger 1643:
1.184 rillig 1644: See Section 13.17, "Other helpful targets".
1.6 rillig 1645:
1.154 rillig 1646: Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)
1.6 rillig 1647:
1648: Table of Contents
1649:
1.154 rillig 1650: 8.1. Preparations
1.180 rillig 1651: 8.2. Running a bulk build
1.154 rillig 1652: 8.2.1. Configuration
1653: 8.3. Requirements of a full bulk build
1.178 rillig 1654: 8.4. Bulk build variants
1.179 rillig 1655: 8.4.1. Detect unknown configure options
1656: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.181 rillig 1657: 8.4.3. Force compiler options only in the build phase
1658: 8.4.4. Use custom directories
1659: 8.4.5. Turn warnings into errors
1660: 8.4.6. Reject packages for which pkglint reports errors
1661: 8.4.7. Reject packages that contain forbidden strings
1662: 8.4.8. Reject packages whose self-test fails
1663: 8.4.9. Reject packages that use undefined shell variables
1664: 8.4.10. Turn off verbose logging
1.178 rillig 1665: 8.5. Creating a multiple CD-ROM packages collection
1666: 8.5.1. Example of cdpack
1.6 rillig 1667:
1.175 gutterid 1668: For a number of reasons, you may want to build binary packages for a large
1669: selected set of packages in pkgsrc, or even for all pkgsrc packages. For
1.71 wiz 1670: instance, when you have multiple machines that should run the same software, it
1671: is wasted time if they all build their packages themselves from source. Or you
1672: may want to build a list of packages you want and check them before deploying
1.175 gutterid 1673: onto production systems. There is a way of getting a set of binary packages:
1674: the bulk build system, or pbulk ("p" stands for "parallel"). This chapter
1675: describes how to set it up.
1.71 wiz 1676:
1.154 rillig 1677: 8.1. Preparations
1.71 wiz 1678:
1679: First of all, you have to decide whether you build all packages or a limited
1680: set of them. Full bulk builds usually consume a lot more resources, both space
1.175 gutterid 1681: and time, than builds for some practical sets of packages. A number of
1682: particularly heavy packages exist that are not actually interesting to a wide
1683: audience. (The approximate resource consumption for a full bulk build is given
1684: in section Section 8.3, "Requirements of a full bulk build".) For limited bulk
1685: builds you need to make a list of packages you want to build. Note that all
1686: their dependencies will be built, so you don't need to track them manually.
1.71 wiz 1687:
1688: During bulk builds various packages are installed and deinstalled in /usr/pkg
1689: (or whatever LOCALBASE is), so make sure that you don't need any package during
1.112 rillig 1690: the builds. Essentially, you should provide a fresh system, either a chroot
1.71 wiz 1691: environment or something even more restrictive, depending on what the operating
1692: system provides, or dedicate the whole physical machine. As a useful side
1693: effect this makes sure that bulk builds cannot break anything in your system.
1694: There have been numerous cases where certain packages tried to install files
1695: outside the LOCALBASE or wanted to edit some files in /etc.
1.6 rillig 1696:
1.180 rillig 1697: 8.2. Running a bulk build
1.6 rillig 1698:
1.180 rillig 1699: Running a bulk build works roughly as follows:
1.15 rillig 1700:
1701: * First, build the pbulk infrastructure in a fresh pkgsrc location.
1702:
1703: * Then, build each of the packages from a clean installation directory using
1704: the infrastructure.
1705:
1.154 rillig 1706: 8.2.1. Configuration
1.6 rillig 1707:
1.112 rillig 1708: To simplify configuration, we provide the helper script mk/pbulk/pbulk.sh.
1.6 rillig 1709:
1.68 asau 1710: In order to use it, prepare a clear system (real one, chroot environment, jail,
1711: zone, virtual machine). Configure network access to fetch distribution files.
1.112 rillig 1712: Create a user with name "pbulk".
1.68 asau 1713:
1714: Fetch and extract pkgsrc. Use a command like one of these:
1715:
1.151 sevan 1716: # (cd /usr && ftp -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
1717: # (cd /usr && fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)
1.72 wiz 1718: # (cd /usr && cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)
1.68 asau 1719:
1720: Or any other way that fits (e.g., curl, wget).
1721:
1722: Deploy and configure pbulk tools, e.g.:
1723:
1.118 sevan 1724: # sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)
1.68 asau 1725: # sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment
1726: # sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build
1727:
1728: Note
1729:
1730: mk.conf.frag is a fragment of mk.conf that contains settings you want to apply
1731: to packages you build. For instance,
1732:
1.112 rillig 1733: PKG_DEVELOPER= yes # perform more checks
1734: X11_TYPE= modular # use pkgsrc X11
1735: SKIP_LICENSE_CHECK= yes # accept all licences (useful
1736: # when building all packages)
1.68 asau 1737:
1738: If configured for limited list, replace the list in /usr/pbulk/etc/pbulk.list
1.112 rillig 1739: with your list of packages, one per line without empty lines or comments. E.g.:
1.68 asau 1740:
1741: www/firefox
1742: mail/thunderbird
1743: misc/libreoffice4
1744:
1.69 asau 1745: At this point you can also review configuration in /usr/pbulk/etc and make
1746: final amendments, if wanted.
1747:
1.68 asau 1748: Start it:
1749:
1750: # /usr/pbulk/bin/bulkbuild
1751:
1752: After it finishes, you'll have /mnt filled with distribution files, binary
1753: packages, and reports, plain text summary in /mnt/bulklog/meta/report.txt
1754:
1755: Note
1756:
1757: The pbulk.sh script does not cover all possible use cases. While being ready to
1758: run, it serves as a good starting point to understand and build more complex
1759: setups. The script is kept small enough for better understanding.
1760:
1761: Note
1762:
1763: The pbulk.sh script supports running unprivileged bulk build and helps
1.205 wiz 1764: configuring distributed bulk builds. Distributed bulk builds support either
1765: building in worker chroots (each node is a path to a different chroot) that
1766: replicate the target system, including the pbulk prefix, or remote machines
1767: (each node is an IP address that must be accessible over SSH without a
1768: password).
1.15 rillig 1769:
1.154 rillig 1770: 8.3. Requirements of a full bulk build
1.71 wiz 1771:
1772: A complete bulk build requires lots of disk space. Some of the disk space can
1773: be read-only, some other must be writable. Some can be on remote filesystems
1774: (such as NFS) and some should be local. Some can be temporary filesystems,
1775: others must survive a sudden reboot.
1776:
1.205 wiz 1777: * 70 GB for the distfiles (read-write, remote, temporary)
1.71 wiz 1778:
1.205 wiz 1779: * 60 GB for the binary packages (read-write, remote, permanent)
1.71 wiz 1780:
1781: * 1 GB for the pkgsrc tree (read-only, remote, permanent)
1782:
1783: * 5 GB for LOCALBASE (read-write, local, temporary)
1784:
1785: * 10 GB for the log files (read-write, remote, permanent)
1786:
1787: * 5 GB for temporary files (read-write, local, temporary)
1788:
1.178 rillig 1789: 8.4. Bulk build variants
1790:
1791: To ensure that pkgsrc packages work in different configurations, it makes sense
1792: to run non-default bulk builds from time to time. This section lists some ideas
1793: for bulk builds that intentionally let packages fail if they don't follow the
1794: pkgsrc style.
1795:
1.179 rillig 1796: 8.4.1. Detect unknown configure options
1.178 rillig 1797:
1798: Add the following line to mk.conf.
1799:
1800: GNU_CONFIGURE_STRICT= yes
1801:
1802: When a package fails this additional check, the most common cause is that the
1803: configure option was valid for an older version of the package but does not
1804: apply anymore. In that case, just remove it.
1805:
1.179 rillig 1806: 8.4.2. Detect classes of bugs by forcing compiler warnings
1.178 rillig 1807:
1808: The job of a compiler is not restricted to producing executable code, most
1.179 rillig 1809: compilers also detect typical programming mistakes. The pkgsrc compiler
1810: wrappers make it easy to force compiler options when the package is built. This
1811: can be used to find typical bugs across all packages that are in pkgsrc. By
1812: reporting these bugs upstream, the packages will be more reliable with the next
1813: updates.
1.178 rillig 1814:
1.179 rillig 1815: Add some of the following lines to mk.conf:
1.178 rillig 1816:
1817: CFLAGS+= -Werror=char-subscripts
1.179 rillig 1818: CFLAGS+= -Werror=implicit-function-declaration
1.178 rillig 1819:
1.179 rillig 1820: When a package fails to build using these stricter compiler options, document
1821: the circumstances in which the compiler produced the error message. This
1822: includes:
1.178 rillig 1823:
1824: * The platform (MACHINE_PLATFORM)
1825:
1826: * The source file
1827:
1828: * An excerpt of the code. GCC and Clang already do this as part of the
1829: diagnostic.
1830:
1.179 rillig 1831: * The exact error message from the compiler.
1.178 rillig 1832:
1.179 rillig 1833: If a package produces these error messages, but the package is fine, record
1834: this in your local mk.conf, like this, to skip this check in the next builds:
1.178 rillig 1835:
1.179 rillig 1836: .if ${PKGPATH} == category/package
1.178 rillig 1837: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
1838: # error message
1839: # code
1.179 rillig 1840: # Reason why the code does not need to be fixed.
1.178 rillig 1841: BUILDLINK_TRANSFORM+= rm:-Werror=char-subscripts
1.179 rillig 1842: .endif
1.178 rillig 1843:
1844: If the error messages from the compiler are valid and the code needs to be
1.179 rillig 1845: fixed, prepare a local patch (see LOCALPATCHES) and report the bug to the
1846: upstream authors of the package, providing them with the information you
1847: collected above.
1.178 rillig 1848:
1.179 rillig 1849: Patches that are not essential for the package to work should only be reported
1850: upstream but not committed to pkgsrc, to make future updates easier.
1851:
1.181 rillig 1852: 8.4.3. Force compiler options only in the build phase
1853:
1854: When adding custom compiler flags via CFLAGS, these apply to all phases of the
1855: package build process. Especially in the configure phase, adding -Werror leads
1856: to wrong decisions. The GNU configure scripts feed many small test programs to
1857: the C compiler to see whether certain headers are available, functions are
1858: defined in a library and programs can be run. In many cases these programs
1859: would not survive a strict compiler run with -Wall -Wextra -Werror.
1860:
1861: The pkgsrc infrastructure is flexible enough to support compiler options being
1862: added between the configure and build phases. It's a little more complicated
1863: than the other examples in this section but still easy enough.
1864:
1865: The basic idea is to use the pkgsrc compiler wrapper to inject the desired
1866: compiler options. The compiler wrapper's original task is to hide unwanted
1867: directories of include files and to normalize compiler options. It does this by
1868: wrapping the compiler command and rewriting the command line. To see this in
1869: action, run bmake patch in a package directory and examine the work/.cwrappers/
1870: config directory. It contains individual configurations for the C compiler and
1871: the related tools. The plan is to find a hook between the configure and build
1872: phases, and to modify these configuration files at that point.
1873:
1874: To find this hook, have a look at mk/build/build.mk, which contains among
1875: others the pre-build-checks-hook. The word checks doesn't quite fit, but the
1876: pre-build-hook sounds good enough.
1877:
1878: The code to be included in mk.conf is:
1879:
1880: # Just a few example options.
1881: BUILD_ONLY_CFLAGS= -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
1882:
1883: .if ${BUILD_ONLY_CFLAGS:U:M*}
1884: pre-build-checks-hook: add-build-only-cflags
1885:
1886: add-build-only-cflags: .PHONY
1887: ${RUN} cd ${CWRAPPERS_CONFIG_DIR}; \
1888: ${TEST} ! -f ${.TARGET} || exit 0; \
1889: for flag in ${BUILD_ONLY_CFLAGS}; do \
1890: ${ECHO} "append=$$flag" >> cc; \
1891: done; \
1892: > ${.TARGET}
1893: .endif
1894:
1895: (When editing the mk.conf, make sure that the commands of the
1896: add-build-only-cflags target are indented with a tab, not with spaces.)
1897:
1898: The condition in the .if statement contains the :U modifier to prevent parse
1899: errors if the variable should be undefined, possibly because it is only defined
1900: for a subset of the packages. The :M* modifier ensures that there is at least
1901: one compiler option, to prevent a syntax error in the shell parser.
1902:
1903: The code around the ${.TARGET} variable ensures that the additional compiler
1904: options are only appended once, even if bmake build is run multiple times. To
1905: do this, it creates a marker file.
1906:
1907: To verify that this setup works, run bmake configure in a package directory. Up
1908: to now, everything works as usual. Examine the directory work/.cwrappers/config
1909: to see that the compiler options from BUILD_ONLY_CFLAGS are not yet added to
1910: the file cc. Examine the tail of the work/.work.log file to see that the normal
1911: compiler options are used.
1912:
1913: Now run bmake build. This will append the options to the file cc and will
1914: create the marker file in the same directory. After that, the build starts as
1915: usual, but with the added compiler options. Examine the tail of the file work
1916: /.work.log to see that the lines starting with [*] don't contain the compiler
1917: options, but the corresponding lines starting with <.> do end with these
1918: options.
1919:
1920: Building packages using this setup variant and fixing the resulting bugs is the
1921: same as in Section 8.4.2, "Detect classes of bugs by forcing compiler warnings"
1922: .
1923:
1924: 8.4.4. Use custom directories
1.178 rillig 1925:
1926: Some directories like PREFIX, VARBASE, PKG_SYSCONFDIR, PKGMANDIR, PKG_INFODIR
1927: can be configured in pkgsrc. Set these to arbitrary paths during bootstrap or
1928: afterwards in mk.conf.
1929:
1930: PREFIX= /a-random-uuid
1931: PKG_SYSCONFDIR= /a-random-uuid
1932: VARBASE= /a-random-uuid
1933: PKGMANDIR= a-random-uuid
1934: PKG_INFODIR= a-random-uuid
1935:
1.181 rillig 1936: 8.4.5. Turn warnings into errors
1.178 rillig 1937:
1938: When building a package, warnings are typically ignored since they just flow by
1939: and do not cause the build to fail immediately. To find these warnings,
1940: redefine them to errors in mk.conf.
1941:
1942: DELAYED_WARNING_MSG= ${DELAYED_ERROR_MSG} "(was warning)"
1943: WARNING_MSG= ${FAIL_MSG} "(was warning)"
1944:
1945: (There are many more classes of warnings in pkgsrc, and most of them can be
1946: redefined with a simple definition like above.
1947:
1.179 rillig 1948: If a package suggests to add USE_TOOLS+=perl to the package Makefile, research
1.178 rillig 1949: whether the package actually needs Perl. If it does, add USE_TOOLS+=perl to the
1950: package Makefile, and if it doesn't, add TOOLS_BROKEN+=perl.
1951:
1.181 rillig 1952: 8.4.6. Reject packages for which pkglint reports errors
1.178 rillig 1953:
1954: Using pkglint as part of the regular build process is mostly a waste of time.
1955: If you want to fix some of the warnings, just run pkglint recursively on the
1956: whole pkgsrc tree. This will take a few minutes (up to 10), which is much
1957: faster than a complete bulk build.
1958:
1.181 rillig 1959: 8.4.7. Reject packages that contain forbidden strings
1.178 rillig 1960:
1961: To ensure that the binary packages don't contain references to the build
1962: directory, there is already CHECK_WRKREF. If that variable includes the item
1963: extra, it is possible to define additional patterns that must not appear in any
1964: installed file. This is specified in mk.conf.
1965:
1966: CHECK_WRKREF= extra
1967: CHECK_WRKREF_EXTRA_DIRS+= /usr/local
1968: CHECK_WRKREF_EXTRA_DIRS+= /usr/pkg
1969: CHECK_WRKREF_EXTRA_DIRS+= @[A-Z][A-Z]*@
1970:
1971: The above patterns will probably generate many false positives, therefore the
1972: results need to be taken with a grain of salt.
1973:
1.181 rillig 1974: 8.4.8. Reject packages whose self-test fails
1.178 rillig 1975:
1976: To run the test suites that come with each package, add this line to mk.conf.
1977:
1978: PKGSRC_RUN_TEST= yes
1979:
1980: Be prepared that even the most basic packages fail this test. When doing a bulk
1981: build with this, it will often abort in the early phase where the packages are
1982: scanned for their dependencies since there are cyclic dependencies. There is
1983: still a lot to do in this area.
1984:
1.181 rillig 1985: 8.4.9. Reject packages that use undefined shell variables
1.178 rillig 1986:
1987: To catch typos in the shell snippets from the Makefile fragments, add the -u
1988: flag to most of the commands by adding this line to mk.conf.
1989:
1990: RUN= @set -eu;
1991:
1.181 rillig 1992: After that, ensure that none of the bulk build log files (even those for
1993: successfully built packages) contains the string parameter not set or whatever
1994: error message the command sh -ceu '$undefined' outputs.
1995:
1.178 rillig 1996: See mk/misc/common.mk for the existing definition.
1997:
1.181 rillig 1998: 8.4.10. Turn off verbose logging
1.178 rillig 1999:
2000: The build logs of a package are often quite long. This allows error messages or
2001: other interesting details to hide between the noise. To make the actual error
2002: message stand out more, add these lines to mk.conf.
2003:
2004: GNU_CONFIGURE_QUIET= yes
2005: MAKE_FLAGS+= -s
2006:
2007: The -s option works for both GNU Make and BSD Make. On exotic platforms with
2008: their own make, it may be a little different.
2009:
2010: 8.5. Creating a multiple CD-ROM packages collection
1.1 dsieger 2011:
2012: After your pkgsrc bulk-build has completed, you may wish to create a CD-ROM set
2013: of the resulting binary packages to assist in installing packages on other
2014: machines. The pkgtools/cdpack package provides a simple tool for creating the
2015: ISO 9660 images. cdpack arranges the packages on the CD-ROMs in a way that
2016: keeps all the dependencies for a given package on the same CD as that package.
2017:
1.178 rillig 2018: 8.5.1. Example of cdpack
1.1 dsieger 2019:
2020: Complete documentation for cdpack is found in the cdpack(1) man page. The
2021: following short example assumes that the binary packages are left in /usr/
2022: pkgsrc/packages/All and that sufficient disk space exists in /u2 to hold the
2023: ISO 9660 images.
2024:
2025: # mkdir /u2/images
2026: # pkg_add /usr/pkgsrc/packages/All/cdpack
2027: # cdpack /usr/pkgsrc/packages/All /u2/images
2028:
2029:
2030: If you wish to include a common set of files (COPYRIGHT, README, etc.) on each
2031: CD in the collection, then you need to create a directory which contains these
1.175 gutterid 2032: files, e.g.:
1.1 dsieger 2033:
2034: # mkdir /tmp/common
2035: # echo "This is a README" > /tmp/common/README
2036: # echo "Another file" > /tmp/common/COPYING
2037: # mkdir /tmp/common/bin
2038: # echo "#!/bin/sh" > /tmp/common/bin/myscript
2039: # echo "echo Hello world" >> /tmp/common/bin/myscript
2040: # chmod 755 /tmp/common/bin/myscript
2041:
2042:
2043: Now create the images:
2044:
2045: # cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images
2046:
2047: Each image will contain README, COPYING, and bin/myscript in their root
2048: directories.
2049:
1.154 rillig 2050: Chapter 9. Directory layout of the installed files
1.1 dsieger 2051:
2052: Table of Contents
2053:
1.154 rillig 2054: 9.1. File system layout in ${LOCALBASE}
2055: 9.2. File system layout in ${VARBASE}
1.1 dsieger 2056:
2057: The files that are installed by pkgsrc are organized in a way that is similar
2058: to what you find in the /usr directory of the base system. But some details are
2059: different. This is because pkgsrc initially came from FreeBSD and had adopted
2060: its file system hierarchy. Later it was largely influenced by NetBSD. But no
2061: matter which operating system you are using pkgsrc with, you can expect the
2062: same layout for pkgsrc.
2063:
2064: There are mainly four root directories for pkgsrc, which are all configurable
2065: in the bootstrap/bootstrap script. When pkgsrc has been installed as root, the
2066: default locations are:
2067:
2068: LOCALBASE= /usr/pkg
2069: PKG_SYSCONFBASE= /usr/pkg/etc
2070: VARBASE= /var
1.119 sevan 2071: PKG_DBDIR= /usr/pkg/pkgdb
1.1 dsieger 2072:
2073: In unprivileged mode (when pkgsrc has been installed as any other user), the
2074: default locations are:
2075:
2076: LOCALBASE= ${HOME}/pkg
2077: PKG_SYSCONFBASE= ${HOME}/pkg/etc
2078: VARBASE= ${HOME}/pkg/var
1.119 sevan 2079: PKG_DBDIR= ${HOME}/pkg/pkgdb
1.1 dsieger 2080:
2081: What these four directories are for, and what they look like is explained
2082: below.
2083:
1.25 wiz 2084: * LOCALBASE corresponds to the /usr directory in the base system. It is the "
2085: main" directory where the files are installed and contains the well-known
1.1 dsieger 2086: subdirectories like bin, include, lib, share and sbin.
2087:
2088: * VARBASE corresponds to /var in the base system. Some programs (especially
2089: games, network daemons) need write access to it during normal operation.
2090:
2091: * PKG_SYSCONFDIR corresponds to /etc in the base system. It contains
2092: configuration files of the packages, as well as pkgsrc's mk.conf itself.
2093:
1.154 rillig 2094: 9.1. File system layout in ${LOCALBASE}
1.1 dsieger 2095:
2096: The following directories exist in a typical pkgsrc installation in $
2097: {LOCALBASE}.
2098:
2099: bin
2100:
2101: Contains executable programs that are intended to be directly used by the
2102: end user.
2103:
2104: emul
2105:
2106: Contains files for the emulation layers of various other operating systems,
2107: especially for NetBSD.
2108:
2109: etc (the usual location of ${PKG_SYSCONFDIR})
2110:
2111: Contains the configuration files.
2112:
2113: include
2114:
2115: Contains headers for the C and C++ programming languages.
2116:
2117: info
2118:
2119: Contains GNU info files of various packages.
2120:
2121: lib
2122:
2123: Contains shared and static libraries.
2124:
2125: libdata
2126:
2127: Contains data files that don't change after installation. Other data files
2128: belong into ${VARBASE}.
2129:
2130: libexec
2131:
2132: Contains programs that are not intended to be used by end users, such as
2133: helper programs or network daemons.
2134:
2135: libexec/cgi-bin
2136:
2137: Contains programs that are intended to be executed as CGI scripts by a web
2138: server.
2139:
2140: man (the usual value of ${PKGMANDIR})
2141:
2142: Contains brief documentation in form of manual pages.
2143:
2144: sbin
2145:
2146: Contains programs that are intended to be used only by the super-user.
2147:
2148: share
2149:
2150: Contains platform-independent data files that don't change after
2151: installation.
2152:
2153: share/doc
2154:
2155: Contains documentation files provided by the packages.
2156:
2157: share/examples
2158:
2159: Contains example files provided by the packages. Among others, the original
2160: configuration files are saved here and copied to ${PKG_SYSCONFDIR} during
2161: installation.
2162:
2163: share/examples/rc.d
2164:
2165: Contains the original files for rc.d scripts.
2166:
2167: var (the usual location of ${VARBASE})
2168:
2169: Contains files that may be modified after installation.
2170:
1.154 rillig 2171: 9.2. File system layout in ${VARBASE}
1.1 dsieger 2172:
2173: db/pkg (the usual location of ${PKG_DBDIR})
2174:
2175: Contains information about the currently installed packages.
2176:
2177: games
2178:
2179: Contains highscore files.
2180:
2181: log
2182:
2183: Contains log files.
2184:
2185: run
2186:
2187: Contains informational files about daemons that are currently running.
2188:
1.154 rillig 2189: Chapter 10. Frequently Asked Questions
1.1 dsieger 2190:
2191: Table of Contents
2192:
1.154 rillig 2193: 10.1. Are there any mailing lists for pkg-related discussion?
2194: 10.2. Utilities for package management (pkgtools)
2195: 10.3. How to use pkgsrc as non-root
2196: 10.4. How to resume transfers when fetching distfiles?
2197: 10.5. How can I install/use modular X.org from pkgsrc?
2198: 10.6. How to fetch files from behind a firewall
2199: 10.7. How to fetch files from HTTPS sites
2200: 10.8. How do I tell make fetch to do passive FTP?
2201: 10.9. How to fetch all distfiles at once
2202: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
2203: 10.11. What does "Could not find bsd.own.mk" mean?
1.221 nia 2204: 10.12. Using 'sudo' or `priv` with pkgsrc
1.154 rillig 2205: 10.13. How do I change the location of configuration files?
2206: 10.14. Automated security checks
2207: 10.15. Why do some packages ignore my CFLAGS?
2208: 10.16. A package does not build. What shall I do?
2209: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.232 gutterid 2210: conflicts" mean?
1.1 dsieger 2211:
2212: This section contains hints, tips & tricks on special things in pkgsrc that we
2213: didn't find a better place for in the previous chapters, and it contains items
2214: for both pkgsrc users and developers.
2215:
1.154 rillig 2216: 10.1. Are there any mailing lists for pkg-related discussion?
1.1 dsieger 2217:
2218: The following mailing lists may be of interest to pkgsrc users:
2219:
2220: * pkgsrc-users: This is a general purpose list for most issues regarding
2221: pkgsrc, regardless of platform, e.g. soliciting user help for pkgsrc
2222: configuration, unexpected build failures, using particular packages,
2223: upgrading pkgsrc installations, questions regarding the pkgsrc release
2224: branches, etc. General announcements or proposals for changes that impact
2225: the pkgsrc user community, e.g. major infrastructure changes, new features,
2226: package removals, etc., may also be posted.
2227:
2228: * pkgsrc-bulk: A list where the results of pkgsrc bulk builds are sent and
2229: discussed.
2230:
2231: * pkgsrc-changes: This list is for those who are interested in getting a
2232: commit message for every change committed to pkgsrc. It is also available
2233: in digest form, meaning one daily message containing all commit messages
2234: for changes to the package source tree in that 24 hour period.
2235:
2236: To subscribe, do:
2237:
2238: % echo subscribe listname | mail majordomo@NetBSD.org
2239:
1.174 leot 2240: Archives for all these mailing lists are available from https://
1.1 dsieger 2241: mail-index.NetBSD.org/.
2242:
1.154 rillig 2243: 10.2. Utilities for package management (pkgtools)
1.1 dsieger 2244:
2245: The directory pkgsrc/pkgtools contains a number of useful utilities for both
2246: users and developers of pkgsrc. This section attempts only to make the reader
1.121 sevan 2247: aware of some of the utilities and when they might be useful, and not to
2248: duplicate the documentation that comes with each package.
1.1 dsieger 2249:
2250: Utilities used by pkgsrc (automatically installed when needed):
2251:
2252: * pkgtools/x11-links: Symlinks for use by buildlink.
2253:
2254: OS tool augmentation (automatically installed when needed):
2255:
1.121 sevan 2256: * pkgtools/digest: Calculates various kinds of checksums (including SHA3).
1.1 dsieger 2257:
2258: * pkgtools/libnbcompat: Compatibility library for pkgsrc tools.
2259:
2260: * pkgtools/mtree: Installed on non-BSD systems due to lack of native mtree.
2261:
2262: * pkgtools/pkg_install: Up-to-date replacement for /usr/sbin/pkg_install, or
2263: for use on operating systems where pkg_install is not present.
2264:
2265: Utilities used by pkgsrc (not automatically installed):
2266:
2267: * pkgtools/pkg_tarup: Create a binary package from an already-installed
2268: package. Used by make replace to save the old package.
2269:
2270: * pkgtools/dfdisk: Adds extra functionality to pkgsrc, allowing it to fetch
2271: distfiles from multiple locations. It currently supports the following
2272: methods: multiple CD-ROMs and network FTP/HTTP connections.
2273:
2274: * devel/cpuflags: Determine the best compiler flags to optimise code for your
1.24 wiz 2275: current CPU and compiler.
1.1 dsieger 2276:
2277: Utilities for keeping track of installed packages, being up to date, etc:
2278:
1.65 wiz 2279: * pkgtools/pkgin: A package update tool similar to apt(1). Download, install,
2280: and upgrade binary packages easily.
2281:
1.1 dsieger 2282: * pkgtools/pkg_chk: Reports on packages whose installed versions do not match
2283: the latest pkgsrc entries.
2284:
2285: * pkgtools/pkgdep: Makes dependency graphs of packages, to aid in choosing a
2286: strategy for updating.
2287:
2288: * pkgtools/pkgdepgraph: Makes graphs from the output of pkgtools/pkgdep (uses
2289: graphviz).
2290:
1.12 weinem 2291: * pkgtools/pkglint: The pkglint(1) program checks a pkgsrc entry for errors.
2292:
2293: * pkgtools/lintpkgsrc: The lintpkgsrc(1) program does various checks on the
2294: complete pkgsrc system.
1.1 dsieger 2295:
2296: * pkgtools/pkgsurvey: Report what packages you have installed.
2297:
2298: Utilities for people maintaining or creating individual packages:
2299:
2300: * pkgtools/pkgdiff: Automate making and maintaining patches for a package
2301: (includes pkgdiff, pkgvi, mkpatches, etc.).
2302:
1.65 wiz 2303: * pkgtools/url2pkg: Aids in converting to pkgsrc.
1.1 dsieger 2304:
2305: Utilities for people maintaining pkgsrc (or: more obscure pkg utilities)
2306:
2307: * pkgtools/pkg_comp: Build packages in a chrooted area.
2308:
2309: * pkgtools/libkver: Spoof kernel version for chrooted cross builds.
2310:
1.154 rillig 2311: 10.3. How to use pkgsrc as non-root
1.1 dsieger 2312:
1.108 rillig 2313: To install packages from source as a non-root user, download pkgsrc as
1.154 rillig 2314: described in Chapter 3, Where to get pkgsrc and how to keep it up-to-date, cd
1.108 rillig 2315: into that directory and run the command ./bootstrap/bootstrap --unprivileged.
2316:
2317: This will install the binary part of pkgsrc to ~/pkg and put the pkgsrc
2318: configuration mk.conf into ~/pkg/etc.
2319:
2320: For more details, see mk/unprivileged.mk.
1.1 dsieger 2321:
1.154 rillig 2322: 10.4. How to resume transfers when fetching distfiles?
1.1 dsieger 2323:
2324: By default, resuming transfers in pkgsrc is disabled, but you can enable this
1.4 rillig 2325: feature by adding the option PKG_RESUME_TRANSFERS=YES into mk.conf. If, during
2326: a fetch step, an incomplete distfile is found, pkgsrc will try to resume it.
1.1 dsieger 2327:
1.61 wiz 2328: You can also use a different program than the platform default program by
2329: changing the FETCH_USING variable. You can specify the program by using of ftp,
2330: fetch, wget or curl. Alternatively, fetching can be disabled by using the value
2331: manual. A value of custom disables the system defaults and dependency tracking
2332: for the fetch program. In that case you have to provide FETCH_CMD,
2333: FETCH_BEFORE_ARGS, FETCH_RESUME_ARGS, FETCH_OUTPUT_ARGS, FETCH_AFTER_ARGS.
1.1 dsieger 2334:
1.16 jnemeth 2335: For example, if you want to use wget to download, you'll have to use something
2336: like:
1.1 dsieger 2337:
1.16 jnemeth 2338: FETCH_USING= wget
1.1 dsieger 2339:
1.154 rillig 2340: 10.5. How can I install/use modular X.org from pkgsrc?
1.1 dsieger 2341:
1.4 rillig 2342: If you want to use modular X.org from pkgsrc instead of your system's own X11
2343: (/usr/X11R6, /usr/openwin, ...) you will have to add the following line into
1.1 dsieger 2344: mk.conf:
2345:
1.4 rillig 2346: X11_TYPE=modular
1.1 dsieger 2347:
1.154 rillig 2348: 10.6. How to fetch files from behind a firewall
1.1 dsieger 2349:
2350: If you are sitting behind a firewall which does not allow direct connections to
2351: Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This
2352: is done using an environment variable in the form of a URL, e.g. in Amdahl, the
2353: machine "orpheus.amdahl.com" is one of the firewalls, and it uses port 80 as
2354: the proxy port number. So the proxy environment variables are:
2355:
2356: ftp_proxy=ftp://orpheus.amdahl.com:80/
2357: http_proxy=http://orpheus.amdahl.com:80/
2358:
1.154 rillig 2359: 10.7. How to fetch files from HTTPS sites
1.65 wiz 2360:
2361: Some fetch tools are not prepared to support HTTPS by default (for example, the
2362: one in NetBSD 6.0), or the one installed by the pkgsrc bootstrap (to avoid an
2363: openssl dependency that low in the dependency graph).
2364:
2365: Usually you won't notice, because distribution files are mirrored weekly to "
2366: ftp.NetBSD.org", but that might not be often enough if you are following
2367: pkgsrc-current. In that case, set FETCH_USING in your mk.conf file to "curl" or
2368: "wget", which are both compiled with HTTPS support by default. Of course, these
2369: tools need to be installed before you can use them this way.
2370:
1.154 rillig 2371: 10.8. How do I tell make fetch to do passive FTP?
1.1 dsieger 2372:
2373: This depends on which utility is used to retrieve distfiles. From bsd.pkg.mk,
2374: FETCH_CMD is assigned the first available command from the following list:
2375:
2376: * ${LOCALBASE}/bin/ftp
2377:
2378: * /usr/bin/ftp
2379:
2380: On a default NetBSD installation, this will be /usr/bin/ftp, which
2381: automatically tries passive connections first, and falls back to active
2382: connections if the server refuses to do passive. For the other tools, add the
1.4 rillig 2383: following to your mk.conf file: PASSIVE_FETCH=1.
1.1 dsieger 2384:
2385: Having that option present will prevent /usr/bin/ftp from falling back to
2386: active transfers.
2387:
1.154 rillig 2388: 10.9. How to fetch all distfiles at once
1.1 dsieger 2389:
2390: You would like to download all the distfiles in a single batch from work or
2391: university, where you can't run a make fetch. There is an archive of distfiles
2392: on ftp.NetBSD.org, but downloading the entire directory may not be appropriate.
2393:
2394: The answer here is to do a make fetch-list in /usr/pkgsrc or one of its
2395: subdirectories, carry the resulting list to your machine at work/school and use
2396: it there. If you don't have a NetBSD-compatible ftp(1) (like tnftp) at work,
2397: don't forget to set FETCH_CMD to something that fetches a URL:
2398:
2399: At home:
2400:
2401: % cd /usr/pkgsrc
2402: % make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles >/tmp/fetch.sh
2403: % scp /tmp/fetch.sh work:/tmp
2404:
2405: At work:
2406:
2407: % sh /tmp/fetch.sh
2408:
2409: then tar up /tmp/distfiles and take it home.
2410:
2411: If you have a machine running NetBSD, and you want to get all distfiles (even
2412: ones that aren't for your machine architecture), you can do so by using the
2413: above-mentioned make fetch-list approach, or fetch the distfiles directly by
2414: running:
2415:
2416: % make mirror-distfiles
2417:
2418: If you even decide to ignore NO_{SRC,BIN}_ON_{FTP,CDROM}, then you can get
2419: everything by running:
2420:
2421: % make fetch NO_SKIP=yes
2422:
1.154 rillig 2423: 10.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
1.1 dsieger 2424:
2425: When compiling the pkgtools/pkg_install package, you get the error from make
2426: that it doesn't know how to make /usr/share/tmac/tmac.andoc? This indicates
2427: that you don't have installed the "text" set (nroff, ...) from the NetBSD base
2428: distribution on your machine. It is recommended to do that to format man pages.
2429:
2430: In the case of the pkgtools/pkg_install package, you can get away with setting
1.4 rillig 2431: NOMAN=YES either in the environment or in mk.conf.
1.1 dsieger 2432:
1.154 rillig 2433: 10.11. What does "Could not find bsd.own.mk" mean?
1.1 dsieger 2434:
2435: You didn't install the compiler set, comp.tgz, when you installed your NetBSD
2436: machine. Please get and install it, by extracting it in /:
2437:
2438: # cd /
2439: # tar --unlink -zxvpf .../comp.tgz
2440:
2441: comp.tgz is part of every NetBSD release. Get the one that corresponds to your
2442: release (determine via uname -r).
2443:
1.221 nia 2444: 10.12. Using 'sudo' or `priv` with pkgsrc
1.1 dsieger 2445:
2446: When installing packages as non-root user and using the just-in-time su(1)
2447: feature of pkgsrc, it can become annoying to type in the root password for each
2448: required package installed. To avoid this, the sudo package can be used, which
1.221 nia 2449: does password caching over a limited time. To use it, install sudo or priv
2450: (either as binary package, from security/priv, or security/sudo) and then put
2451: the following into your mk.conf, somewhere after the definition of the
2452: LOCALBASE variable:
1.1 dsieger 2453:
2454: .if exists(${LOCALBASE}/bin/sudo)
2455: SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
2456: .endif
2457:
1.154 rillig 2458: 10.13. How do I change the location of configuration files?
1.1 dsieger 2459:
2460: As the system administrator, you can choose where configuration files are
2461: installed. The default settings make all these files go into ${PREFIX}/etc or
2462: some of its subdirectories; this may be suboptimal depending on your
2463: expectations (e.g., a read-only, NFS-exported PREFIX with a need of per-machine
2464: configuration of the provided packages).
2465:
2466: In order to change the defaults, you can modify the PKG_SYSCONFBASE variable
1.4 rillig 2467: (in mk.conf) to point to your preferred configuration directory; some common
2468: examples include /etc or /etc/pkg.
1.1 dsieger 2469:
2470: Furthermore, you can change this value on a per-package basis by setting the
2471: PKG_SYSCONFDIR.${PKG_SYSCONFVAR} variable. PKG_SYSCONFVAR's value usually
2472: matches the name of the package you would like to modify, that is, the contents
2473: of PKGBASE.
2474:
2475: Note that after changing these settings, you must rebuild and reinstall any
2476: affected packages.
2477:
1.154 rillig 2478: 10.14. Automated security checks
1.1 dsieger 2479:
2480: Please be aware that there can often be bugs in third-party software, and some
2481: of these bugs can leave a machine vulnerable to exploitation by attackers. In
2482: an effort to lessen the exposure, the NetBSD packages team maintains a database
2483: of known-exploits to packages which have at one time been included in pkgsrc.
2484: The database can be downloaded automatically, and a security audit of all
1.14 jmcneill 2485: packages installed on a system can take place. To do this, refer to the
2486: following two tools (installed as part of the pkgtools/pkg_install package):
1.1 dsieger 2487:
1.21 snj 2488: 1. pkg_admin fetch-pkg-vulnerabilities, an easy way to download a list of the
2489: security vulnerabilities information. This list is kept up to date by the
1.26 spz 2490: pkgsrc security team, and is distributed from the NetBSD ftp server:
1.1 dsieger 2491:
1.177 leot 2492: https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities
1.1 dsieger 2493:
1.21 snj 2494: 2. pkg_admin audit, an easy way to audit the current machine, checking each
1.24 wiz 2495: known vulnerability. If a vulnerable package is installed, it will be shown
2496: by output to stdout, including a description of the type of vulnerability,
2497: and a URL containing more information.
1.1 dsieger 2498:
1.202 nia 2499: Use of these tools is strongly recommended! See Section 5.1.6, "Checking for
1.121 sevan 2500: security vulnerabilities in installed packages" for instructions on how to
2501: automate checking and reporting.
2502:
2503: If this database is installed, pkgsrc builds will use it to perform a security
2504: check before building any package.
1.1 dsieger 2505:
1.154 rillig 2506: 10.15. Why do some packages ignore my CFLAGS?
1.1 dsieger 2507:
2508: When you add your own preferences to the CFLAGS variable in your mk.conf, these
2509: flags are passed in environment variables to the ./configure scripts and to
2510: make(1). Some package authors ignore the CFLAGS from the environment variable
2511: by overriding them in the Makefiles of their package.
2512:
2513: Currently there is no solution to this problem. If you really need the package
2514: to use your CFLAGS you should run make patch in the package directory and then
2515: inspect any Makefile and Makefile.in for whether they define CFLAGS explicitly.
2516: Usually you can remove these lines. But be aware that some "smart" programmers
2517: write so bad code that it only works for the specific combination of CFLAGS
2518: they have chosen.
2519:
1.172 rillig 2520: To find out where the CFLAGS are ignored, add the following lines to mk.conf:
2521:
2522: CPPFLAGS+= -Dpkgsrc___CPPFLAGS
2523: CFLAGS+= -Dpkgsrc___CFLAGS
2524: CXXFLAGS+= -Dpkgsrc___CXXFLAGS
2525:
2526: Then run bmake show-all-configure show-all-build to see whether the above flags
2527: are passed to the actual build commands in general.
2528:
2529: To find out whether the flags are passed to individual compiler commands, have
2530: a look at the file work/.work.log. In most cases, the flags from the original
2531: command lines (the lines starting with [*]) are passed unmodified to the actual
2532: compiler (the lines starting with <.>). If the flag is missing from the actual
2533: compiler command, it must have been removed by the pkgsrc compiler wrappers.
2534:
1.154 rillig 2535: 10.16. A package does not build. What shall I do?
1.1 dsieger 2536:
2537: 1. Make sure that your copy of pkgsrc is consistent. A case that occurs often
2538: is that people only update pkgsrc in parts, because of performance reasons.
2539: Since pkgsrc is one large system, not a collection of many small systems,
2540: there are sometimes changes that only work when the whole pkgsrc tree is
2541: updated.
2542:
1.25 wiz 2543: 2. Make sure that you don't have any CVS conflicts. Search for "<<<<<<" or "
2544: >>>>>>" in all your pkgsrc files.
1.1 dsieger 2545:
1.25 wiz 2546: 3. Make sure that you don't have old copies of the packages extracted. Run
1.1 dsieger 2547: make clean clean-depends to verify this.
2548:
1.108 rillig 2549: 4. If you are a package developer who wants to invest some work, have a look
1.154 rillig 2550: at Chapter 21, Making your package work.
1.108 rillig 2551:
2552: 5. If the problem still exists, write a mail to the pkgsrc-users mailing list.
1.1 dsieger 2553:
1.154 rillig 2554: 10.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
1.1 dsieger 2555: conflicts" mean?
2556:
2557: You have modified a file from pkgsrc, and someone else has modified that same
2558: file afterwards in the CVS repository. Both changes are in the same region of
2559: the file, so when you updated pkgsrc, the cvs command marked the conflicting
2560: changes in the file. Because of these markers, the file is no longer a valid
2561: Makefile.
2562:
2563: Have a look at that file, and if you don't need your local changes anymore, you
2564: can remove that file and run cvs -q update -dP in that directory to download
2565: the current version.
2566:
2567: Part II. The pkgsrc developer's guide
2568:
2569: This part of the book deals with creating and modifying packages. It starts
2570: with a "HOWTO"-like guide on creating a new package. The remaining chapters are
2571: more like a reference manual for pkgsrc.
2572:
2573: Table of Contents
2574:
1.154 rillig 2575: 11. Getting help
1.184 rillig 2576: 12. Package components - files, directories and contents
2577: 12.1. Makefile
2578: 12.2. distinfo
2579: 12.3. patches/*
2580: 12.3.1. Structure of a single patch file
2581: 12.3.2. Creating patch files
2582: 12.3.3. Sources where the patch files come from
2583: 12.3.4. Patching guidelines
2584: 12.3.5. Feedback to the author
2585: 12.4. Other mandatory files
2586: 12.5. Optional files
2587: 12.5.1. Files affecting the binary package
2588: 12.5.2. Files affecting the build process
2589: 12.5.3. Files affecting nothing at all
2590: 12.6. work*
2591: 12.7. files/*
2592: 13. The build process
2593: 13.1. Introduction
2594: 13.2. Program location
2595: 13.3. Directories used during the build process
2596: 13.4. Running a phase
2597: 13.5. The fetch phase
2598: 13.5.1. What to fetch and where to get it from
2599: 13.5.2. How are the files fetched?
2600: 13.6. The checksum phase
2601: 13.7. The extract phase
2602: 13.8. The patch phase
2603: 13.9. The tools phase
2604: 13.10. The wrapper phase
2605: 13.11. The configure phase
2606: 13.12. The build phase
2607: 13.13. The test phase
2608: 13.14. The install phase
2609: 13.15. The package phase
2610: 13.16. Cleaning up
2611: 13.17. Other helpful targets
2612: 14. Creating a new pkgsrc package from scratch
2613: 14.1. Common types of packages
1.219 nia 2614: 14.1.1. Python modules and programs
2615: 14.1.2. R packages
2616: 14.1.3. TeXlive packages
1.184 rillig 2617: 14.2. Examples
2618: 14.2.1. How the www/nvu package came into pkgsrc
2619: 15. Programming in Makefiles
2620: 15.1. Caveats
2621: 15.2. Makefile variables
2622: 15.2.1. Naming conventions
2623: 15.3. Code snippets
2624: 15.3.1. Adding things to a list
2625: 15.3.2. Echoing a string exactly as-is
2626: 15.3.3. Passing CFLAGS to GNU configure scripts
2627: 15.3.4. Handling possibly empty variables
1.229 gutterid 2628: 15.3.5. Testing yes/no variables in conditions
1.184 rillig 2629: 16. Options handling
2630: 16.1. Global default options
2631: 16.2. Converting packages to use bsd.options.mk
2632: 16.3. Option Names
2633: 16.4. Determining the options of dependencies
2634: 17. Tools needed for building or running
2635: 17.1. Tools for pkgsrc builds
2636: 17.2. Tools needed by packages
2637: 17.3. Tools provided by platforms
2638: 18. Buildlink methodology
2639: 18.1. Converting packages to use buildlink3
2640: 18.2. Writing buildlink3.mk files
2641: 18.2.1. Anatomy of a buildlink3.mk file
2642: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.
1.232 gutterid 2643: pkg in buildlink3.mk files
1.184 rillig 2644: 18.3. Writing builtin.mk files
2645: 18.3.1. Anatomy of a builtin.mk file
2646: 19. PLIST issues
2647: 19.1. RCS ID
2648: 19.2. Semi-automatic PLIST generation
2649: 19.3. Tweaking output of make print-PLIST
2650: 19.4. Variable substitution in PLIST
2651: 19.5. Man page compression
2652: 19.6. Changing PLIST source with PLIST_SRC
2653: 19.7. Platform-specific and differing PLISTs
2654: 19.8. Build-specific PLISTs
2655: 19.9. Sharing directories between packages
2656: 20. The pkginstall framework
2657: 20.1. Files and directories outside the installation prefix
2658: 20.1.1. Directory manipulation
2659: 20.1.2. File manipulation
2660: 20.2. Configuration files
2661: 20.2.1. How PKG_SYSCONFDIR is set
2662: 20.2.2. Telling the software where configuration files are
1.239 dholland 2663: 20.2.3. Patching installation
2664: 20.2.4. Declaring configuration files
2665: 20.2.5. Disabling handling of configuration files
1.184 rillig 2666: 20.3. System startup scripts
2667: 20.3.1. Disabling handling of system startup scripts
2668: 20.4. System users and groups
2669: 20.5. System shells
2670: 20.5.1. Disabling shell registration
2671: 20.6. Fonts
2672: 20.6.1. Disabling automatic update of the fonts databases
1.154 rillig 2673: 21. Making your package work
2674: 21.1. General operation
2675: 21.1.1. How to pull in user-settable variables from mk.conf
2676: 21.1.2. User interaction
2677: 21.1.3. Handling licenses
2678: 21.1.4. Restricted packages
2679: 21.1.5. Handling dependencies
2680: 21.1.6. Handling conflicts with other packages
2681: 21.1.7. Packages that cannot or should not be built
2682: 21.1.8. Packages which should not be deleted, once installed
2683: 21.1.9. Handling packages with security problems
2684: 21.1.10. How to handle incrementing versions when fixing an existing
1.232 gutterid 2685: package
1.154 rillig 2686: 21.1.11. Substituting variable text in the package files (the SUBST
1.232 gutterid 2687: framework)
1.154 rillig 2688: 21.2. The fetch phase
2689: 21.2.1. Packages whose distfiles aren't available for plain downloading
2690: 21.2.2. How to handle modified distfiles with the 'old' name
2691: 21.2.3. Packages hosted on github.com
2692: 21.3. The configure phase
2693: 21.3.1. Shared libraries - libtool
2694: 21.3.2. Using libtool on GNU packages that already support libtool
2695: 21.3.3. GNU Autoconf/Automake
1.223 nia 2696: 21.3.4. Meson / ninja
1.154 rillig 2697: 21.4. Programming languages
2698: 21.4.1. C, C++, and Fortran
2699: 21.4.2. Java
1.205 wiz 2700: 21.4.3. Go
1.223 nia 2701: 21.4.4. Rust
2702: 21.4.5. Packages containing Perl scripts
2703: 21.4.6. Packages containing shell scripts
2704: 21.4.7. Other programming languages
1.154 rillig 2705: 21.5. The build phase
2706: 21.5.1. Compiling C and C++ code conditionally
2707: 21.5.2. How to handle compiler bugs
1.172 rillig 2708: 21.5.3. No such file or directory
2709: 21.5.4. Undefined reference to "..."
2710: 21.5.5. Running out of memory
1.154 rillig 2711: 21.6. The install phase
2712: 21.6.1. Creating needed directories
2713: 21.6.2. Where to install documentation
2714: 21.6.3. Installing highscore files
2715: 21.6.4. Adding DESTDIR support to packages
2716: 21.6.5. Packages with hardcoded paths to other interpreters
1.203 nia 2717: 21.6.6. Packages installing Perl modules
1.254 wiz 2718: 21.6.7. Packages installing pkg-config files
2719: 21.6.8. Packages installing info files
2720: 21.6.9. Packages installing man pages
2721: 21.6.10. Packages installing X11 fonts
2722: 21.6.11. Packages installing SGML or XML data
2723: 21.6.12. Packages installing extensions to the MIME database
2724: 21.6.13. Packages using intltool
2725: 21.6.14. Packages installing startup scripts
2726: 21.6.15. Packages installing TeX modules
2727: 21.6.16. Packages supporting running binaries in emulation
2728: 21.6.17. Packages installing hicolor icons
2729: 21.6.18. Packages installing desktop files
1.154 rillig 2730: 21.7. Marking packages as having problems
1.184 rillig 2731: 22. GNOME packaging and porting
2732: 22.1. Meta packages
2733: 22.2. Packaging a GNOME application
2734: 22.3. Updating GNOME to a newer version
2735: 22.4. Patching guidelines
1.154 rillig 2736: 23. Submitting and Committing
2737: 23.1. Submitting binary packages
2738: 23.2. Submitting source packages (for non-NetBSD-developers)
2739: 23.3. General notes when adding, updating, or removing packages
2740: 23.4. Commit Messages
2741: 23.5. Committing: Adding a package to CVS
2742: 23.6. Updating a package to a newer version
2743: 23.7. Renaming a package in pkgsrc
2744: 23.8. Moving a package in pkgsrc
2745: 24. Frequently Asked Questions
2746:
2747: Chapter 11. Getting help
2748:
2749: To get help when developing pkgsrc, the definitive source is this document, the
2750: pkgsrc guide. If you don't find anything here, there are alternatives:
2751:
2752: * The built-in pkgsrc help, which is available after bootstrapping pkgsrc.
2753: Run bmake help topic=? to get help for any topic, such as a variable name
2754: like BUILD_DEFS, a make target like do-build, a missing C or C++ function
2755: like strcasecmp or any other topic.
2756:
1.207 leot 2757: The available help topics are listed in Appendix E, Help topics.
1.154 rillig 2758:
1.163 rillig 2759: * To see the value of a single variable, run bmake show-var VARNAME=X.
2760:
2761: * To see the values of the most common variables, run bmake show-all. These
2762: variables are grouped by topic. To see the variables for a single topic,
2763: run bmake show-all-topic, for example bmake show-all-fetch.
2764:
1.154 rillig 2765: * The tech-pkg mailing list, to which you can subscribe and then ask your
2766: questions.
2767:
2768: * The #pkgsrc IRC channel, which is accessible via a web browser or by using
2769: a specialized chat program such as XChat. Pick any user name and join the
2770: channel #pkgsrc.
1.1 dsieger 2771:
1.184 rillig 2772: Chapter 12. Package components - files, directories and contents
1.1 dsieger 2773:
2774: Table of Contents
2775:
1.184 rillig 2776: 12.1. Makefile
2777: 12.2. distinfo
2778: 12.3. patches/*
2779: 12.3.1. Structure of a single patch file
2780: 12.3.2. Creating patch files
2781: 12.3.3. Sources where the patch files come from
2782: 12.3.4. Patching guidelines
2783: 12.3.5. Feedback to the author
2784: 12.4. Other mandatory files
2785: 12.5. Optional files
2786: 12.5.1. Files affecting the binary package
2787: 12.5.2. Files affecting the build process
2788: 12.5.3. Files affecting nothing at all
2789: 12.6. work*
2790: 12.7. files/*
1.1 dsieger 2791:
1.184 rillig 2792: Whenever you're preparing a package, there are a number of files involved which
2793: are described in the following sections.
1.1 dsieger 2794:
1.184 rillig 2795: 12.1. Makefile
1.1 dsieger 2796:
1.184 rillig 2797: Building, installation and creation of a binary package are all controlled by
2798: the package's Makefile. The Makefile describes various things about a package,
2799: for example from where to get it, how to configure, build, and install it.
1.1 dsieger 2800:
1.184 rillig 2801: A package Makefile contains several sections that describe the package.
1.1 dsieger 2802:
1.184 rillig 2803: In the first section there are the following variables, which should appear
2804: exactly in the order given here. The order and grouping of the variables is
2805: mostly historical and has no further meaning.
1.1 dsieger 2806:
1.184 rillig 2807: * DISTNAME is the basename of the distribution file to be downloaded from the
2808: package's website.
1.1 dsieger 2809:
1.184 rillig 2810: * PKGNAME is the name of the package, as used by pkgsrc. You need to provide
2811: it if DISTNAME (which is the default) is not a good name for the package in
2812: pkgsrc or DISTNAME is not provided (no distribution file is required).
2813: Usually it is the pkgsrc directory name together with the version number.
2814: It must match the regular expression ^[A-Za-z0-9][A-Za-z0-9-_.+]*$, that
2815: is, it starts with a letter or digit, and contains only letters, digits,
1.204 nia 2816: dashes, underscores, dots and plus signs. New packages should have entirely
2817: lower-case names, with the exception of some that must follow pre-existing
2818: conventions (e.g. R packages begin with R-). You can use the :tl variable
2819: modifier to lower-case the package name.
1.26 spz 2820:
1.184 rillig 2821: * CATEGORIES is a list of categories which the package fits in. You can
2822: choose any of the top-level directories of pkgsrc for it.
1.1 dsieger 2823:
1.184 rillig 2824: Currently the following values are available for CATEGORIES. If more than
2825: one is used, they need to be separated by spaces:
1.1 dsieger 2826:
1.184 rillig 2827: archivers cross geography meta-pkgs security
2828: audio databases graphics misc shells
2829: benchmarks devel ham multimedia sysutils
2830: biology editors inputmethod net textproc
2831: cad emulators lang news time
2832: chat finance mail parallel wm
2833: comms fonts math pkgtools www
2834: converters games mbone print x11
1.1 dsieger 2835:
1.184 rillig 2836: * MASTER_SITES, DYNAMIC_MASTER_SITES, DIST_SUBDIR, EXTRACT_SUFX and DISTFILES
2837: are discussed in detail in Section 13.5, "The fetch phase".
1.1 dsieger 2838:
1.184 rillig 2839: The second section contains information about separately downloaded patches, if
2840: any.
1.1 dsieger 2841:
1.184 rillig 2842: * PATCHFILES: Name(s) of additional files that contain distribution patches.
2843: There is no default. pkgsrc will look for them at PATCH_SITES. They will
2844: automatically be uncompressed before patching if the names end with .gz or
2845: .Z.
1.1 dsieger 2846:
1.184 rillig 2847: * PATCH_SITES: Primary location(s) for distribution patch files (see
2848: PATCHFILES above) if not found locally.
1.1 dsieger 2849:
1.184 rillig 2850: * PATCH_DIST_STRIP: an argument to patch(1) that sets the pathname strip
2851: count to help find the correct files to patch. It defaults to -p0.
1.1 dsieger 2852:
1.184 rillig 2853: The third section contains the following variables.
1.1 dsieger 2854:
1.253 gutterid 2855: * MAINTAINER is the email address of the person who is currently responsible
2856: for this package. In theory, the maintainer will be aware of upstream
2857: release, keep it updated, and generally resolve problems. Others
2858: contemplating significant changes should ask the maintainer for advice or
2859: review of a proposed change. This is not necessary for micro updates, bug
2860: fixes, pkgsrc-wide changes affecting many packages, and other things
2861: expected to be uncontroversial. It goes with this "should ask" that the
2862: maintainer should respond to inquiries reasonably promptly (most of the
2863: time), and either approve changes or provide reasons why not. Typically,
2864: when packaging a new program, set MAINTAINER to yourself. If you don't
2865: intend to maintain the package (especially if you feel you have no special
2866: insight), set it to <pkgsrc-users@NetBSD.org>. This special value is a code
2867: point indicating that there is no maintainer, but the variable is
2868: mandatory, absent OWNER.
2869:
2870: * OWNER can be used instead of MAINTAINER in relatively rare circumstances
2871: when the package is such that modifying it is riskier than normal. This is
2872: a stronger form of being the maintainer, with an expectation that others
2873: will ask for almost all changes, except revbumps and accommodating
2874: structural changes. Someone who becomes OWNER has a strong obligation to
2875: keep the package very well maintained, to answer queries promptly and to be
2876: a steward of the package on behalf of users. In this case, MAINTAINER
2877: should be omitted.
2878:
2879: Because of the friction that OWNER adds, PMC may downgrade it to MAINTAINER
2880: at any time.
1.1 dsieger 2881:
1.184 rillig 2882: * HOMEPAGE is a URL where users can find more information about the package.
1.1 dsieger 2883:
1.184 rillig 2884: * COMMENT is a one-line description of the package (should not include the
2885: package name).
1.1 dsieger 2886:
1.184 rillig 2887: * LICENSE indicates the license(s) applicable for the package. See
2888: Section 21.1.3, "Handling licenses" for further details.
1.1 dsieger 2889:
1.184 rillig 2890: Other variables that affect the build:
1.1 dsieger 2891:
1.184 rillig 2892: * WRKSRC: The directory where the interesting distribution files of the
2893: package are found. The default is ${WRKDIR}/${DISTNAME}, which works for
2894: most packages.
1.1 dsieger 2895:
1.184 rillig 2896: If a package doesn't create a subdirectory for itself (most GNU software
2897: does, for instance), but extracts itself in the current directory, you
2898: should set WRKSRC=${WRKDIR}.
1.1 dsieger 2899:
1.184 rillig 2900: If a package doesn't create a subdirectory with the name of DISTNAME but
2901: some different name, set WRKSRC to point to the proper name in ${WRKDIR},
2902: for example WRKSRC=${WRKDIR}/${DISTNAME}/unix. See lang/tcl and x11/tk for
2903: other examples.
1.17 imil 2904:
1.184 rillig 2905: The name of the working directory created by pkgsrc is taken from the
2906: WRKDIR_BASENAME variable. By default, its value is work. If you want to use
2907: the same pkgsrc tree for building different kinds of binary packages, you
2908: can change the variable according to your needs. Two other variables handle
2909: common cases of setting WRKDIR_BASENAME individually. If OBJHOSTNAME is
2910: defined in mk.conf, the first component of the host's name is attached to
2911: the directory name. If OBJMACHINE is defined, the platform name is
2912: attached, which might look like work.i386 or work.sparc.
1.17 imil 2913:
1.184 rillig 2914: Please pay attention to the following gotchas:
1.17 imil 2915:
1.184 rillig 2916: * Add MANCOMPRESSED if man pages are installed in compressed form by the
2917: package. For packages using BSD-style makefiles which honor MANZ, there is
2918: MANCOMPRESSED_IF_MANZ.
1.17 imil 2919:
1.184 rillig 2920: * Replace /usr/local with "${PREFIX}" in all files (see patches, below).
1.103 wiz 2921:
1.254 wiz 2922: * If the package installs any info files, see Section 21.6.8, "Packages
1.184 rillig 2923: installing info files".
1.103 wiz 2924:
1.184 rillig 2925: 12.2. distinfo
1.17 imil 2926:
1.184 rillig 2927: The distinfo file contains the message digest, or checksum, of each distfile
2928: needed for the package. This ensures that the distfiles retrieved from the
2929: Internet have not been corrupted during transfer or altered by a malign force
2930: to introduce a security hole. To provide maximum security, all distfiles are
1.243 gutterid 2931: protected using two different message digest algorithms (BLAKE2s and SHA512),
2932: as well as the file size.
1.17 imil 2933:
1.184 rillig 2934: The distinfo file also contains the checksums for all the patches found in the
2935: patches directory (see Section 12.3, "patches/*"). These checksums ensure that
2936: patches are only applied intentionally and that they don't accidentally change,
2937: e.g. when merging different changes together. They also make sure that new
2938: patches are actually added to CVS and old ones are removed. Too see whether the
2939: patches and the distinfo file match, run pkglint after changing the patches.
1.17 imil 2940:
1.184 rillig 2941: To regenerate the distinfo file, use the make distinfo command.
1.17 imil 2942:
1.184 rillig 2943: Some packages have different sets of distfiles depending on the platform, for
2944: example lang/openjdk8. These are kept in the same distinfo file and care should
2945: be taken when upgrading such a package to ensure distfile information is not
2946: lost.
1.17 imil 2947:
1.184 rillig 2948: 12.3. patches/*
1.63 wiz 2949:
1.184 rillig 2950: Some packages don't work out-of-the box on the various platforms that are
2951: supported by pkgsrc. These packages need to be patched to make them work. The
2952: patch files can be found in the patches/ directory.
1.17 imil 2953:
1.184 rillig 2954: In the patch phase, these patches are applied to the files in WRKSRC directory
2955: after extracting them, in alphabetic order.
1.160 brook 2956:
1.184 rillig 2957: 12.3.1. Structure of a single patch file
1.160 brook 2958:
1.184 rillig 2959: The patch-* files should be in diff -bu format, and apply without a fuzz to
2960: avoid problems. (To force patches to apply with fuzz you can set
2961: PATCH_FUZZ_FACTOR=-F2). Furthermore, each patch should contain only changes for
2962: a single file, and no file should be patched by more than one patch file. This
2963: helps to keep future modifications simple.
1.160 brook 2964:
1.184 rillig 2965: Each patch file is structured as follows: In the first line, there is the RCS
2966: Id of the patch itself. The second line should be empty for aesthetic reasons.
2967: After that, there should be a comment for each change that the patch does.
2968: There are a number of standard cases:
1.160 brook 2969:
1.184 rillig 2970: * Patches for commonly known vulnerabilities should mention the vulnerability
2971: ID (CAN, CVE).
1.160 brook 2972:
1.184 rillig 2973: * Patches that change source code should mention the platform and other
2974: environment (for example, the compiler) that the patch is needed for.
1.160 brook 2975:
1.184 rillig 2976: The patch should be commented so that any developer who knows the code of the
2977: application can make some use of the patch. Special care should be taken for
2978: the upstream developers, since we generally want that they accept our patches,
2979: so we have less work in the future.
1.160 brook 2980:
1.184 rillig 2981: 12.3.2. Creating patch files
1.160 brook 2982:
1.184 rillig 2983: One important thing to mention is to pay attention that no RCS IDs get stored
2984: in the patch files, as these will cause problems when later checked into the
2985: NetBSD CVS tree. Use the pkgdiff command from the pkgtools/pkgdiff package to
2986: avoid these problems.
1.160 brook 2987:
1.184 rillig 2988: For even more automation, we recommend using mkpatches from the same package to
1.222 gutterid 2989: make a whole set of patches. You just have to back up files before you edit
2990: them to filename.orig, e.g., with cp -p filename filename.orig or, easier, by
2991: using pkgvi again from the same package. If you upgrade a package this way, you
2992: can easily compare the new set of patches with the previously existing one with
1.184 rillig 2993: patchdiff. The files in patches are replaced by new files, so carefully check
2994: if you want to take all the changes.
1.160 brook 2995:
1.184 rillig 2996: When you have finished a package, remember to generate the checksums for the
2997: patch files by using the make makepatchsum command, see Section 12.2,
2998: "distinfo".
1.1 dsieger 2999:
1.184 rillig 3000: When adding a patch that corrects a problem in the distfile (rather than e.g.
3001: enforcing pkgsrc's view of where man pages should go), send the patch as a bug
3002: report to the maintainer. This benefits non-pkgsrc users of the package, and
3003: usually makes it possible to remove the patch in future version.
1.1 dsieger 3004:
1.184 rillig 3005: The file names of the patch files are usually of the form patch-
3006: path_to_file__with__underscores.c. Many packages still use the previous
3007: convention patch-[a-z][a-z], but new patches should be of the form containing
3008: the filename. mkpatches included in pkgtools/pkgdiff takes care of the name
3009: automatically.
1.1 dsieger 3010:
1.222 gutterid 3011: When updating pre-existing patch files, if a file uses the old patch-[a-z][a-z]
3012: convention, it's best not to change it to the new form, as that will just cause
3013: churn that makes it harder to track changes to patching over time. Similarly,
3014: if a patch now applies at different line offsets, but still applies cleanly
3015: as-is, there's no need to update it, as that also unnecessarily complicates the
3016: patch history.
3017:
1.184 rillig 3018: 12.3.3. Sources where the patch files come from
1.1 dsieger 3019:
1.184 rillig 3020: If you want to share patches between multiple packages in pkgsrc, e.g. because
3021: they use the same distfiles, set PATCHDIR to the path where the patch files can
3022: be found, e.g.:
1.1 dsieger 3023:
1.184 rillig 3024: PATCHDIR= ../../editors/xemacs/patches
1.1 dsieger 3025:
1.184 rillig 3026: Patch files that are distributed by the author or other maintainers can be
3027: listed in PATCHFILES.
1.1 dsieger 3028:
1.184 rillig 3029: If it is desired to store any patches that should not be committed into pkgsrc,
3030: they can be kept outside the pkgsrc tree in the $LOCALPATCHES directory. The
3031: directory tree there is expected to have the same "category/package" structure
3032: as pkgsrc, and patches are expected to be stored inside these dirs (also known
3033: as $LOCALPATCHES/$PKGPATH). For example, if you want to keep a private patch
3034: for pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All
3035: files in the named directory are expected to be patch files, and they are
3036: applied after pkgsrc patches are applied.
1.1 dsieger 3037:
1.184 rillig 3038: 12.3.4. Patching guidelines
1.1 dsieger 3039:
1.184 rillig 3040: When fixing a portability issue in the code do not use preprocessor magic to
3041: check for the current operating system nor platform. Doing so hurts portability
3042: to other platforms because the OS-specific details are not abstracted
3043: appropriately.
1.1 dsieger 3044:
1.184 rillig 3045: The general rule to follow is: instead of checking for the operating system the
3046: application is being built on, check for the specific features you need. For
3047: example, instead of assuming that kqueue is available under NetBSD and using
3048: the __NetBSD__ macro to conditionalize kqueue support, add a check that detects
1.198 leot 3049: kqueue itself -- yes, this generally involves patching the configure script.
1.184 rillig 3050: There is absolutely nothing that prevents some OSes from adopting interfaces
3051: from other OSes (e.g. Linux implementing kqueue), something that the above
3052: checks cannot take into account.
1.1 dsieger 3053:
1.184 rillig 3054: Of course, checking for features generally involves more work on the
3055: developer's side, but the resulting changes are cleaner and there are chances
3056: they will work on many other platforms. Not to mention that there are higher
3057: chances of being later integrated into the mainstream sources. Remember: It
3058: doesn't work unless it is right!
1.1 dsieger 3059:
1.184 rillig 3060: Some typical examples:
1.121 sevan 3061:
1.184 rillig 3062: Table 12.1. Patching examples
1.1 dsieger 3063:
1.184 rillig 3064: +-------------------------------------------------------------------------------------------+
3065: | Where | Incorrect | Correct |
3066: |---------+--------------------------+------------------------------------------------------|
3067: | |case ${target_os} in | |
3068: |configure|netbsd*) have_kvm=yes ;; |AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)|
3069: |script |*) have_kvm=no ;; | |
3070: | |esac | |
3071: |---------+--------------------------+------------------------------------------------------|
3072: |C source |#if defined(__NetBSD__) |#if defined(HAVE_SYS_EVENT_H) |
3073: |file |# include <sys/event.h> |# include <sys/event.h> |
3074: | |#endif |#endif |
3075: |---------+--------------------------+------------------------------------------------------|
3076: | |int |int |
3077: | |monitor_file(...) |monitor_file(...) |
3078: | |{ |{ |
3079: | |#if defined(__NetBSD__) |#if defined(HAVE_KQUEUE) |
3080: |C source | int fd = kqueue();| int fd = kqueue(); |
3081: |file | ... | ... |
3082: | |#else |#else |
3083: | | ... | ... |
3084: | |#endif |#endif |
3085: | |} |} |
3086: +-------------------------------------------------------------------------------------------+
1.1 dsieger 3087:
3088:
1.184 rillig 3089: 12.3.5. Feedback to the author
1.1 dsieger 3090:
1.184 rillig 3091: Always, always, always feed back any portability fixes or improvements you do
3092: to a package to the mainstream developers. This is the only way to get their
3093: attention on portability issues and to ensure that future versions can be built
3094: out-of-the box on NetBSD. Furthermore, any user that gets newer distfiles will
3095: get the fixes straight from the packaged code.
1.1 dsieger 3096:
1.184 rillig 3097: This generally involves cleaning up the patches (because sometimes the patches
3098: that are added to pkgsrc are quick hacks), filing bug reports in the
3099: appropriate trackers for the projects and working with the mainstream authors
3100: to accept your changes. It is extremely important that you do it so that the
3101: packages in pkgsrc are kept simple and thus further changes can be done without
3102: much hassle.
1.1 dsieger 3103:
1.184 rillig 3104: When you have done this, please add a URL to the upstream bug report to the
3105: patch comment.
1.1 dsieger 3106:
1.184 rillig 3107: Support the idea of free software!
1.1 dsieger 3108:
1.184 rillig 3109: 12.4. Other mandatory files
1.1 dsieger 3110:
1.184 rillig 3111: DESCR
1.1 dsieger 3112:
1.184 rillig 3113: A multi-line description of the piece of software. This should include any
3114: credits where they are due. Please bear in mind that others do not share
3115: your sense of humour (or spelling idiosyncrasies), and that others will
3116: read everything that you write here.
1.1 dsieger 3117:
1.184 rillig 3118: PLIST
1.1 dsieger 3119:
1.184 rillig 3120: This file governs the files that are installed on your system: all the
3121: binaries, manual pages, etc. There are other directives which may be
3122: entered in this file, to control the creation and deletion of directories,
3123: and the location of inserted files. See Chapter 19, PLIST issues for more
3124: information.
1.1 dsieger 3125:
1.184 rillig 3126: 12.5. Optional files
1.1 dsieger 3127:
1.184 rillig 3128: 12.5.1. Files affecting the binary package
1.1 dsieger 3129:
1.184 rillig 3130: INSTALL
1.1 dsieger 3131:
1.184 rillig 3132: This shell script is invoked twice by pkg_add(1). First time after package
3133: extraction and before files are moved in place, the second time after the
3134: files to install are moved in place. This can be used to do any custom
3135: procedures not possible with @exec commands in PLIST. See pkg_add(1) and
3136: pkg_create(1) for more information. See also Section 20.1, "Files and
3137: directories outside the installation prefix". Please note that you can
3138: modify variables in it easily by using FILES_SUBST in the package's
3139: Makefile:
1.1 dsieger 3140:
1.184 rillig 3141: FILES_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3142:
1.184 rillig 3143: replaces "@SOMEVAR@" with "somevalue" in the INSTALL. By default,
3144: substitution is performed for PREFIX, LOCALBASE, X11BASE, VARBASE, and a
3145: few others, type make help topic=FILES_SUBST for a complete list.
1.1 dsieger 3146:
1.184 rillig 3147: DEINSTALL
1.1 dsieger 3148:
1.184 rillig 3149: This script is executed before and after any files are removed. It is this
3150: script's responsibility to clean up any additional messy details around the
3151: package's installation, since all pkg_delete knows is how to delete the
3152: files created in the original distribution. See pkg_delete(1) and
3153: pkg_create(1) for more information. The same methods to replace variables
3154: can be used as for the INSTALL file.
1.1 dsieger 3155:
1.184 rillig 3156: MESSAGE
1.1 dsieger 3157:
1.198 leot 3158: This file is displayed after installation of the package. While this was
3159: used often in the past, it has two problems: the display will be missed if
3160: many packages are intalled at once, and the person installing the package
3161: and the one using or configuring it may be different. It should therefore
3162: be used only in exceptional circumstances where lasting negative
3163: consequences would result from someone not reading it.
3164:
3165: MESSAGE should not be used for:
3166:
1.232 gutterid 3167: o exhortations to read the documentation
1.198 leot 3168:
1.232 gutterid 3169: o reminders to install rc.d files and set variables
1.198 leot 3170:
1.232 gutterid 3171: o anything that should be explained in the installation/configuration
1.198 leot 3172: documentation that should come with the package
3173:
3174: If the documentation provided by upstream needs enhancing, create e.g.
3175: files/README.pkgsrc and install it in the package's documentation
3176: directory.
3177:
3178: Note that MESSAGE is shown for all operating systems and all init systems.
3179: If a MESSAGE is necessary, it should be narrowed to only those operating
3180: systems and init systems to which it applies.
3181:
3182: Note that you can modify variables in it easily by using MESSAGE_SUBST in
3183: the package's Makefile:
1.1 dsieger 3184:
1.184 rillig 3185: MESSAGE_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 3186:
1.184 rillig 3187: replaces "${SOMEVAR}" with "somevalue" in MESSAGE. By default, substitution
3188: is performed for PKGNAME, PKGBASE, PREFIX, LOCALBASE, X11BASE,
3189: PKG_SYSCONFDIR, ROOT_GROUP, and ROOT_USER.
1.1 dsieger 3190:
1.184 rillig 3191: You can display a different or additional files by setting the MESSAGE_SRC
3192: variable. Its default is MESSAGE, if the file exists.
1.1 dsieger 3193:
1.184 rillig 3194: ALTERNATIVES
1.1 dsieger 3195:
1.184 rillig 3196: This file is used by the alternatives framework. It creates, configures,
3197: and destroys generic wrappers used to run programs with similar interfaces.
3198: See pkg_alternatives(8) from pkgtools/pkg_alternatives for more
3199: information.
1.1 dsieger 3200:
1.184 rillig 3201: Each line of the file contains two filenames, first the wrapper and then
3202: the alternative provided by the package. Both paths are relative to PREFIX.
1.1 dsieger 3203:
1.184 rillig 3204: 12.5.2. Files affecting the build process
1.1 dsieger 3205:
1.184 rillig 3206: Makefile.common
1.1 dsieger 3207:
1.184 rillig 3208: This file contains arbitrary things that could also go into a Makefile, but
3209: its purpose is to be used by more than one package. This file should only
3210: be used when the packages that will use the file are known in advance. For
3211: other purposes it is often better to write a *.mk file and give it a good
3212: name that describes what it does.
1.1 dsieger 3213:
1.184 rillig 3214: buildlink3.mk
1.1 dsieger 3215:
1.184 rillig 3216: This file contains the dependency information for the buildlink3 framework
3217: (see Chapter 18, Buildlink methodology).
1.1 dsieger 3218:
1.184 rillig 3219: hacks.mk
1.1 dsieger 3220:
1.184 rillig 3221: This file contains workarounds for compiler bugs and similar things. It is
3222: included automatically by the pkgsrc infrastructure, so you don't need an
3223: extra .include line for it.
1.1 dsieger 3224:
1.184 rillig 3225: options.mk
1.1 dsieger 3226:
1.184 rillig 3227: This file contains the code for the package-specific options (see
3228: Chapter 16, Options handling) that can be selected by the user. If a
3229: package has only one or two options, it is equally acceptable to put the
3230: code directly into the Makefile.
1.1 dsieger 3231:
1.184 rillig 3232: 12.5.3. Files affecting nothing at all
1.1 dsieger 3233:
1.184 rillig 3234: README*
1.1 dsieger 3235:
1.184 rillig 3236: These files do not take place in the creation of a package and thus are
3237: purely informative to the package developer.
1.1 dsieger 3238:
1.184 rillig 3239: TODO
1.1 dsieger 3240:
1.184 rillig 3241: This file contains things that need to be done to make the package even
3242: better.
1.1 dsieger 3243:
1.184 rillig 3244: 12.6. work*
1.1 dsieger 3245:
1.184 rillig 3246: When you type make, the distribution files are unpacked into the directory
3247: denoted by WRKDIR. It can be removed by running make clean. Besides the
3248: sources, this directory is also used to keep various timestamp files. The
3249: directory gets removed completely on clean. The default is ${.CURDIR}/work or $
3250: {.CURDIR}/work.${MACHINE_ARCH} if OBJMACHINE is set.
1.1 dsieger 3251:
1.184 rillig 3252: 12.7. files/*
1.80 wiz 3253:
1.184 rillig 3254: If you have any files that you wish to be placed in the package prior to
3255: configuration or building, you can place these files here and use a ${CP}
3256: command in the "post-extract" target to achieve this.
1.1 dsieger 3257:
1.184 rillig 3258: If you want to share files in this way with other packages, set the FILESDIR
3259: variable to point to the other package's files directory, e.g.:
1.1 dsieger 3260:
1.184 rillig 3261: FILESDIR= ../../editors/xemacs/files
1.14 jmcneill 3262:
1.184 rillig 3263: Chapter 13. The build process
1.1 dsieger 3264:
1.184 rillig 3265: Table of Contents
1.1 dsieger 3266:
1.184 rillig 3267: 13.1. Introduction
3268: 13.2. Program location
3269: 13.3. Directories used during the build process
3270: 13.4. Running a phase
3271: 13.5. The fetch phase
3272: 13.5.1. What to fetch and where to get it from
3273: 13.5.2. How are the files fetched?
3274: 13.6. The checksum phase
3275: 13.7. The extract phase
3276: 13.8. The patch phase
3277: 13.9. The tools phase
3278: 13.10. The wrapper phase
3279: 13.11. The configure phase
3280: 13.12. The build phase
3281: 13.13. The test phase
3282: 13.14. The install phase
3283: 13.15. The package phase
3284: 13.16. Cleaning up
3285: 13.17. Other helpful targets
1.1 dsieger 3286:
1.184 rillig 3287: 13.1. Introduction
1.122 leot 3288:
1.184 rillig 3289: This chapter gives a detailed description on how a package is built. Building a
3290: package is separated into different phases (for example fetch, build, install),
3291: all of which are described in the following sections. Each phase is split into
3292: so-called stages, which take the name of the containing phase, prefixed by one
3293: of pre-, do- or post-. (Examples are pre-configure, post-build.) Most of the
3294: actual work is done in the do-* stages.
1.1 dsieger 3295:
1.184 rillig 3296: Never override the regular targets (like fetch), if you have to, override the
3297: do-* ones instead.
1.1 dsieger 3298:
1.184 rillig 3299: The basic steps for building a program are always the same. First the program's
3300: source (distfile) must be brought to the local system and then extracted. After
3301: any pkgsrc-specific patches to compile properly are applied, the software can
3302: be configured, then built (usually by compiling), and finally the generated
3303: binaries, etc. can be put into place on the system.
1.1 dsieger 3304:
1.184 rillig 3305: To get more details about what is happening at each step, you can set the
3306: PKG_VERBOSE variable, or the PATCH_DEBUG variable if you are just interested in
3307: more details about the patch step.
1.1 dsieger 3308:
1.184 rillig 3309: 13.2. Program location
1.1 dsieger 3310:
1.184 rillig 3311: Before outlining the process performed by the NetBSD package system in the next
3312: section, here's a brief discussion on where programs are installed, and which
3313: variables influence this.
1.1 dsieger 3314:
1.184 rillig 3315: The automatic variable PREFIX indicates where all files of the final program
3316: shall be installed. It is usually set to LOCALBASE (/usr/pkg), or CROSSBASE for
3317: pkgs in the cross category. The value of PREFIX needs to be put into the
3318: various places in the program's source where paths to these files are encoded.
3319: See Section 12.3, "patches/*" and Section 21.3.1, "Shared libraries - libtool"
3320: for more details.
1.1 dsieger 3321:
1.184 rillig 3322: When choosing which of these variables to use, follow the following rules:
1.1 dsieger 3323:
1.184 rillig 3324: * PREFIX always points to the location where the current pkg will be
3325: installed. When referring to a pkg's own installation path, use "${PREFIX}"
3326: .
1.1 dsieger 3327:
1.223 nia 3328: * LOCALBASE is where all pkgs are installed. If you need to construct a -I or
3329: -L argument to the compiler to find includes and libraries installed by
3330: another pkg, use "${LOCALBASE}". The name LOCALBASE stems from FreeBSD,
3331: which installed all packages in /usr/local. As pkgsrc leaves /usr/local for
3332: the system administrator, this variable is a misnomer.
1.1 dsieger 3333:
1.184 rillig 3334: * X11BASE is where the actual X11 distribution (from xsrc, etc.) is
3335: installed. When looking for standard X11 includes (not those installed by a
3336: package), use "${X11BASE}".
1.1 dsieger 3337:
1.184 rillig 3338: * X11-based packages using imake must set USE_IMAKE to be installed correctly
3339: under LOCALBASE.
1.1 dsieger 3340:
1.184 rillig 3341: * Within ${PREFIX}, packages should install files according to hier(7), with
3342: the exception that manual pages go into ${PREFIX}/man, not ${PREFIX}/share/
3343: man.
1.1 dsieger 3344:
1.184 rillig 3345: 13.3. Directories used during the build process
1.2 rillig 3346:
1.184 rillig 3347: When building a package, various directories are used to store source files,
3348: temporary files, pkgsrc-internal files, and so on. These directories are
3349: explained here.
1.1 dsieger 3350:
1.184 rillig 3351: Some of the directory variables contain relative pathnames. There are two
3352: common base directories for these relative directories: PKGSRCDIR/PKGPATH is
3353: used for directories that are pkgsrc-specific. WRKSRC is used for directories
3354: inside the package itself.
1.1 dsieger 3355:
1.184 rillig 3356: PKGSRCDIR
1.1 dsieger 3357:
1.184 rillig 3358: This is an absolute pathname that points to the pkgsrc root directory.
3359: Generally, you don't need it.
1.1 dsieger 3360:
1.184 rillig 3361: PKGDIR
1.1 dsieger 3362:
1.184 rillig 3363: This is an absolute pathname that points to the current package.
1.1 dsieger 3364:
1.184 rillig 3365: PKGPATH
1.1 dsieger 3366:
1.184 rillig 3367: This is a pathname relative to PKGSRCDIR that points to the current
1.228 gutterid 3368: package. It is defined after including bsd.prefs.mk and can be used in
3369: makefile fragments that are used by several packages to distinguish between
3370: these packages. Other variables that would serve the same purpose are
3371: PKGBASE and PKGNAME, but these are only defined after including bsd.pkg.mk,
3372: which is too late.
3373:
3374: In mk.conf, the pkgsrc user can use PKGPATH to tweak variables like
3375: MAKE_JOBS and CFLAGS.
1.1 dsieger 3376:
1.184 rillig 3377: WRKDIR
1.1 dsieger 3378:
1.184 rillig 3379: This is an absolute pathname pointing to the directory where all work takes
3380: place. The distfiles are extracted to this directory. It also contains
3381: temporary directories and log files used by the various pkgsrc frameworks,
3382: like buildlink or the wrappers.
1.1 dsieger 3383:
1.184 rillig 3384: WRKSRC
1.1 dsieger 3385:
1.184 rillig 3386: This is an absolute pathname pointing to the directory where the distfiles
3387: are extracted. It is usually a direct subdirectory of WRKDIR, and often
3388: it's the only directory entry that isn't hidden. This variable may be
3389: changed by a package Makefile.
1.1 dsieger 3390:
1.184 rillig 3391: The CREATE_WRKDIR_SYMLINK definition takes either the value yes or no and
3392: defaults to no. It indicates whether a symbolic link to the WRKDIR is to be
3393: created in the pkgsrc entry's directory. If users would like to have their
3394: pkgsrc trees behave in a read-only manner, then the value of
3395: CREATE_WRKDIR_SYMLINK should be set to no.
1.1 dsieger 3396:
1.184 rillig 3397: 13.4. Running a phase
1.1 dsieger 3398:
1.184 rillig 3399: You can run a particular phase by typing make phase, where phase is the name of
3400: the phase. This will automatically run all phases that are required for this
3401: phase. The default phase is build, that is, when you run make without
3402: parameters in a package directory, the package will be built, but not
3403: installed.
1.1 dsieger 3404:
1.184 rillig 3405: 13.5. The fetch phase
1.1 dsieger 3406:
1.184 rillig 3407: The first step in building a package is to fetch the distribution files
3408: (distfiles) from the sites that are providing them. This is the task of the
3409: fetch phase.
1.25 wiz 3410:
1.184 rillig 3411: 13.5.1. What to fetch and where to get it from
1.1 dsieger 3412:
1.184 rillig 3413: In simple cases, MASTER_SITES defines all URLs from where the distfile, whose
3414: name is derived from the DISTNAME variable, is fetched. The more complicated
3415: cases are described below.
1.1 dsieger 3416:
1.184 rillig 3417: The variable DISTFILES specifies the list of distfiles that have to be fetched.
3418: Its value defaults to ${DEFAULT_DISTFILES} and its value is ${DISTNAME}$
3419: {EXTRACT_SUFX}, so that most packages don't need to define it at all.
3420: EXTRACT_SUFX is .tar.gz by default, but can be changed freely. Note that if
3421: your package requires additional distfiles to the default one, you cannot just
3422: append the additional filenames using the += operator, but you have write for
3423: example:
1.1 dsieger 3424:
1.184 rillig 3425: DISTFILES= ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1 dsieger 3426:
1.184 rillig 3427: Each distfile is fetched from a list of sites, usually MASTER_SITES. If the
3428: package has multiple DISTFILES or multiple PATCHFILES from different sites, you
3429: can set SITES.distfile to the list of URLs where the file distfile (including
3430: the suffix) can be found.
1.1 dsieger 3431:
1.184 rillig 3432: DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
3433: DISTFILES+= foo-file.tar.gz
3434: SITES.foo-file.tar.gz= \
3435: https://www.somewhere.com/somehow/ \
3436: https://www.somewhereelse.com/mirror/somehow/
1.1 dsieger 3437:
1.184 rillig 3438: When actually fetching the distfiles, each item from MASTER_SITES or SITES.*
3439: gets the name of each distfile appended to it, without an intermediate slash.
3440: Therefore, all site values have to end with a slash or other separator
3441: character. This allows for example to set MASTER_SITES to a URL of a CGI script
3442: that gets the name of the distfile as a parameter. In this case, the definition
3443: would look like:
1.1 dsieger 3444:
1.184 rillig 3445: MASTER_SITES= https://www.example.com/download.cgi?file=
1.1 dsieger 3446:
1.184 rillig 3447: The exception to this rule are URLs starting with a dash. In that case the URL
3448: is taken as is, fetched and the result stored under the name of the distfile.
3449: You can use this style for the case when the download URL style does not match
3450: the above common case. For example, if permanent download URL is a redirector
3451: to the real download URL, or the download file name is offered by an HTTP
3452: Content-Disposition header. In the following example, foo-1.0.0.tar.gz will be
3453: created instead of the default v1.0.0.tar.gz.
1.1 dsieger 3454:
1.184 rillig 3455: DISTNAME= foo-1.0.0
3456: MASTER_SITES= -https://www.example.com/archive/v1.0.0.tar.gz
1.29 wiz 3457:
1.184 rillig 3458: There are some predefined values for MASTER_SITES, which can be used in
3459: packages. The names of the variables should speak for themselves.
1.29 wiz 3460:
1.225 gutterid 3461: MASTER_SITE_APACHE MASTER_SITE_BACKUP
3462: MASTER_SITE_CRATESIO MASTER_SITE_CYGWIN
3463: MASTER_SITE_DEBIAN MASTER_SITE_FREEBSD
3464: MASTER_SITE_FREEBSD_LOCAL MASTER_SITE_GENTOO
3465: MASTER_SITE_GITHUB MASTER_SITE_GITLAB
3466: MASTER_SITE_GNOME MASTER_SITE_GNU
3467: MASTER_SITE_GNUSTEP MASTER_SITE_HASKELL_HACKAGE
3468: MASTER_SITE_IFARCHIVE MASTER_SITE_KDE
3469: MASTER_SITE_MOZILLA MASTER_SITE_MOZILLA_ALL
3470: MASTER_SITE_MYSQL MASTER_SITE_NETLIB
3471: MASTER_SITE_OPENBSD MASTER_SITE_OPENOFFICE
3472: MASTER_SITE_OSDN MASTER_SITE_PERL_CPAN
3473: MASTER_SITE_PGSQL MASTER_SITE_PYPI
3474: MASTER_SITE_RUBYGEMS MASTER_SITE_R_CRAN
3475: MASTER_SITE_SOURCEFORGE MASTER_SITE_SUNSITE
3476: MASTER_SITE_SUSE MASTER_SITE_TEX_CTAN
3477: MASTER_SITE_XCONTRIB MASTER_SITE_XEMACS
3478: MASTER_SITE_XORG
1.1 dsieger 3479:
1.184 rillig 3480: Some explanations for the less self-explaining ones: MASTER_SITE_BACKUP
3481: contains backup sites for packages that are maintained in ftp://ftp.NetBSD.org/
3482: pub/pkgsrc/distfiles/${DIST_SUBDIR}. MASTER_SITE_LOCAL contains local package
3483: source distributions that are maintained in ftp://ftp.NetBSD.org/pub/pkgsrc/
3484: distfiles/LOCAL_PORTS/.
1.1 dsieger 3485:
1.184 rillig 3486: If you choose one of these predefined sites, you may want to specify a
3487: subdirectory of that site. Since these macros may expand to more than one
3488: actual site, you must use the following construct to specify a subdirectory:
1.1 dsieger 3489:
1.184 rillig 3490: MASTER_SITES= ${MASTER_SITE_GNU:=subdirectory/name/}
3491: MASTER_SITES= ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1 dsieger 3492:
1.184 rillig 3493: Note the trailing slash after the subdirectory name.
1.1 dsieger 3494:
1.184 rillig 3495: 13.5.2. How are the files fetched?
1.1 dsieger 3496:
1.184 rillig 3497: The fetch phase makes sure that all the distfiles exist in a local directory
3498: (DISTDIR, which can be set by the pkgsrc user). If the files do not exist, they
3499: are fetched using commands of the form
1.1 dsieger 3500:
1.184 rillig 3501: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
1.1 dsieger 3502:
1.184 rillig 3503: where ${site} varies through several possibilities in turn: first,
3504: MASTER_SITE_OVERRIDE is tried, then the sites specified in either SITES.file if
3505: defined, else MASTER_SITES or PATCH_SITES, as applies, then finally the value
3506: of MASTER_SITE_BACKUP. The order of all except the first and the last can be
3507: optionally sorted by the user, via setting either MASTER_SORT_RANDOM, and
3508: MASTER_SORT_AWK or MASTER_SORT_REGEX.
1.1 dsieger 3509:
1.184 rillig 3510: The specific command and arguments used depend on the FETCH_USING parameter.
3511: The example above is for FETCH_USING=custom.
1.66 asau 3512:
1.184 rillig 3513: The distfiles mirror run by the NetBSD Foundation uses the mirror-distfiles
3514: target to mirror the distfiles, if they are freely distributable. Packages
3515: setting NO_SRC_ON_FTP (usually to "${RESTRICTED}") will not have their
3516: distfiles mirrored.
1.1 dsieger 3517:
1.184 rillig 3518: 13.6. The checksum phase
1.1 dsieger 3519:
1.184 rillig 3520: After the distfile(s) are fetched, their checksum is generated and compared
3521: with the checksums stored in the distinfo file. If the checksums don't match,
3522: the build is aborted. This is to ensure the same distfile is used for building,
3523: and that the distfile wasn't changed, e.g. by some malign force, deliberately
3524: changed distfiles on the master distribution site or network lossage.
1.1 dsieger 3525:
1.184 rillig 3526: 13.7. The extract phase
1.1 dsieger 3527:
1.184 rillig 3528: When the distfiles are present on the local system, they need to be extracted,
3529: as they usually come in the form of some compressed archive format.
1.1 dsieger 3530:
1.184 rillig 3531: By default, all DISTFILES are extracted. If you only need some of them, you can
3532: set the EXTRACT_ONLY variable to the list of those files.
1.1 dsieger 3533:
1.184 rillig 3534: Extracting the files is usually done by a little program, mk/extract/extract,
3535: which already knows how to extract various archive formats, so most likely you
3536: will not need to change anything here. But if you need, the following variables
3537: may help you:
1.1 dsieger 3538:
1.184 rillig 3539: EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}
1.1 dsieger 3540:
1.184 rillig 3541: Use these variables to override the default options for an extract command,
3542: which are defined in mk/extract/extract.
1.1 dsieger 3543:
1.184 rillig 3544: EXTRACT_USING
1.1 dsieger 3545:
1.184 rillig 3546: This variable can be set to bsdtar, gtar, nbtar (which is the default
3547: value), pax, or an absolute pathname pointing to the command with which tar
3548: archives should be extracted. It is preferred to choose bsdtar over gtar if
3549: NetBSD's pax-as-tar is not good enough.
1.1 dsieger 3550:
1.184 rillig 3551: If the extract program doesn't serve your needs, you can also override the
3552: EXTRACT_CMD variable, which holds the command used for extracting the files.
3553: This command is executed in the ${WRKSRC} directory. During execution of this
3554: command, the shell variable extract_file holds the absolute pathname of the
3555: file that is going to be extracted.
1.1 dsieger 3556:
1.184 rillig 3557: And if that still does not suffice, you can override the do-extract target in
3558: the package Makefile.
1.1 dsieger 3559:
1.184 rillig 3560: 13.8. The patch phase
1.1 dsieger 3561:
1.184 rillig 3562: After extraction, all the patches named by the PATCHFILES, those present in the
3563: patches subdirectory of the package as well as in $LOCALPATCHES/$PKGPATH (e.g.
3564: /usr/local/patches/graphics/png) are applied. Patchfiles ending in .Z or .gz
3565: are uncompressed before they are applied, files ending in .orig or .rej are
3566: ignored. Any special options to patch(1) can be handed in PATCH_DIST_ARGS. See
3567: Section 12.3, "patches/*" for more details.
1.1 dsieger 3568:
1.184 rillig 3569: By default patch(1) is given special arguments to make it fail if the expected
3570: text from the patch context is not found in the patched file. If that happens,
3571: fix the patch file by comparing it with the actual text in the file to be
3572: patched.
1.1 dsieger 3573:
1.184 rillig 3574: 13.9. The tools phase
1.1 dsieger 3575:
1.184 rillig 3576: This is covered in Chapter 17, Tools needed for building or running.
1.1 dsieger 3577:
1.184 rillig 3578: 13.10. The wrapper phase
1.1 dsieger 3579:
1.184 rillig 3580: This phase creates wrapper programs for the compilers and linkers. The
3581: following variables can be used to tweak the wrappers.
1.1 dsieger 3582:
1.184 rillig 3583: ECHO_WRAPPER_MSG
1.1 dsieger 3584:
1.184 rillig 3585: The command used to print progress messages. Does nothing by default. Set
3586: to ${ECHO} to see the progress messages.
1.1 dsieger 3587:
1.184 rillig 3588: WRAPPER_DEBUG
1.1 dsieger 3589:
1.184 rillig 3590: This variable can be set to yes (default) or no, depending on whether you
3591: want additional information in the wrapper log file.
1.1 dsieger 3592:
1.184 rillig 3593: WRAPPER_UPDATE_CACHE
1.1 dsieger 3594:
1.184 rillig 3595: This variable can be set to yes or no, depending on whether the wrapper
3596: should use its cache, which will improve the speed. The default value is
3597: yes, but is forced to no if the platform does not support it.
1.1 dsieger 3598:
1.184 rillig 3599: WRAPPER_REORDER_CMDS
1.1 dsieger 3600:
1.184 rillig 3601: A list of reordering commands. A reordering command has the form reorder:l:
3602: lib1:lib2. It ensures that that -llib1 occurs before -llib2.
1.1 dsieger 3603:
1.184 rillig 3604: 13.11. The configure phase
1.1 dsieger 3605:
1.184 rillig 3606: Most pieces of software need information on the header files, system calls, and
3607: library routines which are available on the platform they run on. The process
3608: of determining this information is known as configuration, and is usually
3609: automated. In most cases, a script is supplied with the distfiles, and its
3610: invocation results in generation of header files, Makefiles, etc.
1.1 dsieger 3611:
1.184 rillig 3612: If the package contains a configure script, this can be invoked by setting
3613: HAS_CONFIGURE to "yes". If the configure script is a GNU autoconf script, you
1.187 rillig 3614: should set GNU_CONFIGURE to "yes" instead.
1.1 dsieger 3615:
1.187 rillig 3616: In the do-configure stage, a rough equivalent of the following command is run.
3617: See mk/configure/configure.mk, target do-configure-script for the exact
3618: definition.
3619:
3620: .for dir in ${CONFIGURE_DIRS}
3621: cd ${WRKSRC} && cd ${dir} \
3622: && env ${CONFIGURE_ENV} \
3623: ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184 rillig 3624: .endfor
1.1 dsieger 3625:
1.184 rillig 3626: CONFIGURE_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In
3627: each of these directories, the configure script is run with the environment
3628: CONFIGURE_ENV and arguments CONFIGURE_ARGS. The variables CONFIGURE_ENV,
3629: CONFIGURE_SCRIPT (default: "./configure") and CONFIGURE_ARGS may all be changed
3630: by the package.
1.1 dsieger 3631:
1.184 rillig 3632: If the program uses the Perl way of configuration (mainly Perl modules, but not
3633: only), i.e. a file called Makefile.PL, it should include ../../lang/perl5/
3634: module.mk. To set any parameter for Makefile.PL use the MAKE_PARAMS variable
3635: (e.g., MAKE_PARAMS+=foo=bar
1.1 dsieger 3636:
1.184 rillig 3637: If the program uses an Imakefile for configuration, the appropriate steps can
3638: be invoked by setting USE_IMAKE to "yes". If you only need xmkmf, add it to
3639: USE_TOOLS. You can add variables to xmkmf's environment by adding them to the
3640: SCRIPTS_ENV variable.
1.1 dsieger 3641:
1.184 rillig 3642: If the program uses cmake for configuration, the appropriate steps can be
1.233 wiz 3643: invoked by including ../../devel/cmake/build.mk. You can add variables to
3644: cmake's environment by adding them to the CONFIGURE_ENV variable and arguments
1.256 ! wiz 3645: to cmake by adding them to the CMAKE_CONFIGURE_ARGS variable. If you want to
! 3646: add arguments only for particular stages, you can use the CMAKE_CONFIGURE_ARGS,
1.233 wiz 3647: CMAKE_BUILD_ARGS, and CMAKE_INSTALL_ARGS variables. You can set the
3648: CONFIGURE_DIRS variable to the directories in which CMake should be run,
3649: relative to WRKSRC. This defaults to to ".".
1.1 dsieger 3650:
1.256 ! wiz 3651: Any package using the now-deprecated USE_CMAKE=yes should be converted.
! 3652: Essentially, replace with an include of ../../devel/cmake/build.mk, prune
! 3653: creation of a build directory and settings to use it, and check/fix settings
! 3654: that intend to perform the build in a subdirectory.
! 3655:
1.184 rillig 3656: If there is no configure step at all, set NO_CONFIGURE to "yes".
1.1 dsieger 3657:
1.184 rillig 3658: 13.12. The build phase
1.1 dsieger 3659:
1.187 rillig 3660: For building a package, a rough equivalent of the following code is executed;
3661: see mk/build/build.mk, target do-build for the exact definition.
1.154 rillig 3662:
1.187 rillig 3663: .for dir in ${BUILD_DIRS}
3664: cd ${WRKSRC} && cd ${dir} \
1.184 rillig 3665: && env ${MAKE_ENV} \
1.187 rillig 3666: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184 rillig 3667: -f ${MAKE_FILE} \
3668: ${BUILD_TARGET}
3669: .endfor
1.1 dsieger 3670:
1.184 rillig 3671: BUILD_DIRS (default: ".") is a list of pathnames relative to WRKSRC. In each of
3672: these directories, MAKE_PROGRAM is run with the environment MAKE_ENV and
3673: arguments BUILD_MAKE_FLAGS. The variables MAKE_ENV, BUILD_MAKE_FLAGS, MAKE_FILE
3674: and BUILD_TARGET may all be changed by the package.
1.1 dsieger 3675:
1.184 rillig 3676: The default value of MAKE_PROGRAM is "gmake" if USE_TOOLS contains "gmake", "
3677: make" otherwise. The default value of MAKE_FILE is "Makefile", and BUILD_TARGET
3678: defaults to "all".
1.1 dsieger 3679:
1.184 rillig 3680: If there is no build step at all, set NO_BUILD to "yes".
1.1 dsieger 3681:
1.184 rillig 3682: 13.13. The test phase
1.1 dsieger 3683:
1.184 rillig 3684: [TODO]
1.1 dsieger 3685:
1.184 rillig 3686: 13.14. The install phase
1.1 dsieger 3687:
1.184 rillig 3688: Once the build stage has completed, the final step is to install the software
3689: in public directories, so users can access the programs and files.
1.1 dsieger 3690:
1.187 rillig 3691: In the install phase, a rough equivalent of the following code is executed; see
3692: mk/install/install.mk, target do-install for the exact definition.
3693: Additionally, before and after this code, several consistency checks are run
3694: against the files-to-be-installed, see mk/check/*.mk for details.
3695:
3696: .for dir in ${INSTALL_DIRS}
3697: cd ${WRKSRC} && cd ${dir} \
3698: && env ${INSTALL_ENV} ${MAKE_ENV} \
3699: ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
3700: -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184 rillig 3701: .endfor
1.1 dsieger 3702:
1.184 rillig 3703: The variable's meanings are analogous to the ones in the build phase.
3704: INSTALL_DIRS defaults to BUILD_DIRS. INSTALL_TARGET is "install" by default,
3705: plus "install.man" if USE_IMAKE is defined and NO_INSTALL_MANPAGES is not
3706: defined.
1.1 dsieger 3707:
1.184 rillig 3708: In the install phase, the following variables are useful. They are all
3709: variations of the install(1) command that have the owner, group and permissions
3710: preset. INSTALL is the plain install command. The specialized variants,
3711: together with their intended use, are:
1.1 dsieger 3712:
1.184 rillig 3713: INSTALL_PROGRAM_DIR
1.1 dsieger 3714:
1.184 rillig 3715: directories that contain binaries
1.1 dsieger 3716:
1.184 rillig 3717: INSTALL_SCRIPT_DIR
1.1 dsieger 3718:
1.184 rillig 3719: directories that contain scripts
1.1 dsieger 3720:
1.184 rillig 3721: INSTALL_LIB_DIR
1.1 dsieger 3722:
1.184 rillig 3723: directories that contain shared and static libraries
1.1 dsieger 3724:
1.184 rillig 3725: INSTALL_DATA_DIR
1.108 rillig 3726:
1.184 rillig 3727: directories that contain data files
1.108 rillig 3728:
1.184 rillig 3729: INSTALL_MAN_DIR
1.108 rillig 3730:
1.184 rillig 3731: directories that contain man pages
1.108 rillig 3732:
1.184 rillig 3733: INSTALL_GAME_DIR
1.108 rillig 3734:
1.184 rillig 3735: directories that contain data files for games
1.108 rillig 3736:
1.184 rillig 3737: INSTALL_PROGRAM
1.108 rillig 3738:
1.184 rillig 3739: binaries that can be stripped from debugging symbols
1.108 rillig 3740:
1.184 rillig 3741: INSTALL_SCRIPT
1.108 rillig 3742:
1.184 rillig 3743: binaries that cannot be stripped
1.108 rillig 3744:
1.184 rillig 3745: INSTALL_GAME
1.108 rillig 3746:
1.184 rillig 3747: game binaries
1.108 rillig 3748:
1.184 rillig 3749: INSTALL_LIB
1.108 rillig 3750:
1.184 rillig 3751: shared and static libraries
1.108 rillig 3752:
1.184 rillig 3753: INSTALL_DATA
1.108 rillig 3754:
1.184 rillig 3755: data files
1.1 dsieger 3756:
1.184 rillig 3757: INSTALL_GAME_DATA
1.1 dsieger 3758:
1.184 rillig 3759: data files for games
1.108 rillig 3760:
1.184 rillig 3761: INSTALL_MAN
1.108 rillig 3762:
1.184 rillig 3763: man pages
1.1 dsieger 3764:
1.184 rillig 3765: Some other variables are:
1.1 dsieger 3766:
1.184 rillig 3767: INSTALL_UNSTRIPPED
1.1 dsieger 3768:
1.184 rillig 3769: If set to yes, do not run strip(1) when installing binaries. Any debugging
3770: sections and symbols present in binaries will be preserved.
1.1 dsieger 3771:
1.184 rillig 3772: INSTALLATION_DIRS
1.1 dsieger 3773:
1.184 rillig 3774: A list of directories relative to PREFIX that are created by pkgsrc at the
3775: beginning of the install phase. The package is supposed to create all
3776: needed directories itself before installing files to it and list all other
3777: directories here.
1.1 dsieger 3778:
1.184 rillig 3779: In the rare cases that a package shouldn't install anything, set NO_INSTALL to
3780: "yes". This is mostly relevant for packages in the regress category.
1.1 dsieger 3781:
1.184 rillig 3782: 13.15. The package phase
1.121 sevan 3783:
1.184 rillig 3784: Once the install stage has completed, a binary package of the installed files
3785: can be built. These binary packages can be used for quick installation without
3786: previous compilation, e.g. by the make bin-install or by using pkg_add.
1.1 dsieger 3787:
1.184 rillig 3788: By default, the binary packages are created in ${PACKAGES}/All and symlinks are
3789: created in ${PACKAGES}/category, one for each category in the CATEGORIES
3790: variable. PACKAGES defaults to pkgsrc/packages.
1.1 dsieger 3791:
1.184 rillig 3792: 13.16. Cleaning up
1.1 dsieger 3793:
1.184 rillig 3794: Once you're finished with a package, you can clean the work directory by
3795: running make clean. If you want to clean the work directories of all
3796: dependencies too, use make clean-depends.
1.1 dsieger 3797:
1.184 rillig 3798: 13.17. Other helpful targets
1.1 dsieger 3799:
1.184 rillig 3800: pre/post-*
1.1 dsieger 3801:
1.184 rillig 3802: For any of the main targets described in the previous section (configure,
3803: build, install, etc.), two auxiliary targets exist with "pre-" and "post-"
3804: used as a prefix for the main target's name. These targets are invoked
3805: before and after the main target is called, allowing extra configuration or
3806: installation steps be performed from a package's Makefile, for example,
3807: which a program's configure script or install target omitted.
3808:
3809: About 5% of the pkgsrc packages define their custom post-extract target,
3810: another 5% define pre-configure, and 10% define post-install. The other pre
3811: /post-* targets are defined even less often.
1.1 dsieger 3812:
1.184 rillig 3813: do-*
1.182 leot 3814:
1.184 rillig 3815: Should one of the main targets do the wrong thing, and should there be no
3816: variable to fix this, you can redefine it with the do-* target. (Note that
3817: redefining the target itself instead of the do-* target is a bad idea, as
3818: the pre-* and post-* targets won't be called anymore, etc.)
1.1 dsieger 3819:
1.184 rillig 3820: About 15% of the pkgsrc packages override the default do-install, the other
3821: do-* targets are overridden even less often.
1.1 dsieger 3822:
1.184 rillig 3823: reinstall
1.1 dsieger 3824:
1.184 rillig 3825: If you did a make install and you noticed some file was not installed
3826: properly, you can repeat the installation with this target, which will
3827: ignore the "already installed" flag.
1.1 dsieger 3828:
1.184 rillig 3829: This is the default value of DEPENDS_TARGET except in the case of make
3830: update and make package, where the defaults are "package" and "update",
3831: respectively.
1.1 dsieger 3832:
1.184 rillig 3833: deinstall
1.1 dsieger 3834:
1.184 rillig 3835: This target does a pkg_delete(1) in the current directory, effectively
3836: de-installing the package. The following variables can be used to tune the
3837: behaviour:
1.1 dsieger 3838:
1.184 rillig 3839: PKG_VERBOSE
1.1 dsieger 3840:
1.184 rillig 3841: Add a "-v" to the pkg_delete(1) command.
1.1 dsieger 3842:
1.184 rillig 3843: DEINSTALLDEPENDS
1.1 dsieger 3844:
1.184 rillig 3845: Remove all packages that require (depend on) the given package. This
3846: can be used to remove any packages that may have been pulled in by a
3847: given package, e.g. if make deinstall DEINSTALLDEPENDS=1 is done in
3848: pkgsrc/x11/kde, this is likely to remove whole KDE. Works by adding "-R
3849: " to the pkg_delete(1) command line.
1.1 dsieger 3850:
1.184 rillig 3851: bin-install
1.1 dsieger 3852:
1.184 rillig 3853: Install a binary package from local disk and via FTP from a list of sites
3854: (see the BINPKG_SITES variable), and do a make package if no binary package
3855: is available anywhere. The arguments given to pkg_add can be set via
3856: BIN_INSTALL_FLAGS e.g., to do verbose operation, etc.
1.1 dsieger 3857:
1.184 rillig 3858: install-clean
1.1 dsieger 3859:
1.184 rillig 3860: This target removes the state files for the "install" and later phases so
3861: that the "install" target may be re-invoked. This can be used after editing
3862: the PLIST to install the package without rebuilding it.
1.1 dsieger 3863:
1.184 rillig 3864: build-clean
1.18 mishka 3865:
1.184 rillig 3866: This target removes the state files for the "build" and later phases so
3867: that the "build" target may be re-invoked.
1.18 mishka 3868:
1.184 rillig 3869: update
1.18 mishka 3870:
1.184 rillig 3871: This target causes the current package to be updated to the latest version.
3872: The package and all depending packages first get de-installed, then current
3873: versions of the corresponding packages get compiled and installed. This is
3874: similar to manually noting which packages are currently installed, then
3875: performing a series of make deinstall and make install (or whatever
3876: UPDATE_TARGET is set to) for these packages.
1.18 mishka 3877:
1.184 rillig 3878: You can use the "update" target to resume package updating in case a
3879: previous make update was interrupted for some reason. However, in this
3880: case, make sure you don't call make clean or otherwise remove the list of
3881: dependent packages in WRKDIR. Otherwise, you lose the ability to
3882: automatically update the current package along with the dependent packages
3883: you have installed.
1.121 sevan 3884:
1.184 rillig 3885: Resuming an interrupted make update will only work as long as the package
3886: tree remains unchanged. If the source code for one of the packages to be
3887: updated has been changed, resuming make update will most certainly fail!
1.1 dsieger 3888:
1.184 rillig 3889: The following variables can be used either on the command line or in
3890: mk.conf to alter the behaviour of make update:
1.1 dsieger 3891:
1.184 rillig 3892: UPDATE_TARGET
1.1 dsieger 3893:
1.184 rillig 3894: Install target to recursively use for the updated package and the
3895: dependent packages. Defaults to DEPENDS_TARGET if set, "install"
3896: otherwise for make update. Other good targets are "package" or "
3897: bin-install". Do not set this to "update" or you will get stuck in an
3898: endless loop!
1.1 dsieger 3899:
1.184 rillig 3900: NOCLEAN
1.1 dsieger 3901:
1.184 rillig 3902: Don't clean up after updating. Useful if you want to leave the work
3903: sources of the updated packages around for inspection or other
3904: purposes. Be sure you eventually clean up the source tree (see the "
3905: clean-update" target below) or you may run into troubles with old
3906: source code still lying around on your next make or make update.
1.1 dsieger 3907:
1.184 rillig 3908: REINSTALL
1.1 dsieger 3909:
1.184 rillig 3910: Deinstall each package before installing (making DEPENDS_TARGET). This
3911: may be necessary if the "clean-update" target (see below) was called
3912: after interrupting a running make update.
1.1 dsieger 3913:
1.184 rillig 3914: DEPENDS_TARGET
1.1 dsieger 3915:
1.184 rillig 3916: Allows you to disable recursion and hardcode the target for packages.
3917: The default is "update" for the update target, facilitating a recursive
3918: update of prerequisite packages. Only set DEPENDS_TARGET if you want to
3919: disable recursive updates. Use UPDATE_TARGET instead to just set a
3920: specific target for each package to be installed during make update
3921: (see above).
1.1 dsieger 3922:
1.184 rillig 3923: clean-update
1.1 dsieger 3924:
1.184 rillig 3925: Clean the source tree for all packages that would get updated if make
3926: update was called from the current directory. This target should not be
3927: used if the current package (or any of its depending packages) have already
3928: been de-installed (e.g., after calling make update) or you may lose some
3929: packages you intended to update. As a rule of thumb: only use this target
3930: before the first time you run make update and only if you have a dirty
3931: package tree (e.g., if you used NOCLEAN).
1.86 wiz 3932:
1.184 rillig 3933: If you are unsure about whether your tree is clean, you can either perform
3934: a make clean at the top of the tree, or use the following sequence of
3935: commands from the directory of the package you want to update (before
3936: running make update for the first time, otherwise you lose all the packages
3937: you wanted to update!):
1.86 wiz 3938:
1.184 rillig 3939: # make clean-update
3940: # make clean CLEANDEPENDS=YES
3941: # make update
1.86 wiz 3942:
3943:
1.184 rillig 3944: The following variables can be used either on the command line or in
3945: mk.conf to alter the behaviour of make clean-update:
1.86 wiz 3946:
1.184 rillig 3947: CLEAR_DIRLIST
1.86 wiz 3948:
1.184 rillig 3949: After make clean, do not reconstruct the list of directories to update
3950: for this package. Only use this if make update successfully installed
3951: all packages you wanted to update. Normally, this is done automatically
3952: on make update, but may have been suppressed by the NOCLEAN variable
3953: (see above).
1.1 dsieger 3954:
1.184 rillig 3955: replace
1.1 dsieger 3956:
1.184 rillig 3957: Update the installation of the current package. This differs from update in
3958: that it does not replace dependent packages. You will need to install
3959: pkgtools/pkg_tarup for this target to work.
1.1 dsieger 3960:
1.184 rillig 3961: Be careful when using this target! There are no guarantees that dependent
3962: packages will still work, in particular they will most certainly break if
3963: you make replace a library package whose shared library major version
3964: changed between your installed version and the new one. For this reason,
3965: this target is not officially supported and only recommended for advanced
3966: users.
1.1 dsieger 3967:
1.184 rillig 3968: info
1.1 dsieger 3969:
1.184 rillig 3970: This target invokes pkg_info(1) for the current package. You can use this
3971: to check which version of a package is installed.
1.86 wiz 3972:
1.184 rillig 3973: index
1.1 dsieger 3974:
1.184 rillig 3975: This is a top-level command, i.e. it should be used in the pkgsrc
3976: directory. It creates a database of all packages in the local pkgsrc tree,
3977: including dependencies, comment, maintainer, and some other useful
3978: information. Individual entries are created by running make describe in the
3979: packages' directories. This index file is saved as pkgsrc/INDEX. It can be
3980: displayed in verbose format by running make print-index. You can search in
3981: it with make search key=something. You can extract a list of all packages
3982: that depend on a particular one by running make show-deps PKG=somepackage.
1.1 dsieger 3983:
1.184 rillig 3984: Running this command takes a very long time, some hours even on fast
3985: machines!
1.1 dsieger 3986:
1.184 rillig 3987: readme
1.1 dsieger 3988:
1.199 nia 3989: This target generates a index.html file, which can be viewed using a
1.184 rillig 3990: browser such as www/firefox or www/links. The generated files contain
3991: references to any packages which are in the PACKAGES directory on the local
3992: host. The generated files can be made to refer to URLs based on
3993: FTP_PKG_URL_HOST and FTP_PKG_URL_DIR. For example, if I wanted to generate
1.199 nia 3994: index.html files which pointed to binary packages on the local machine, in
1.184 rillig 3995: the directory /usr/packages, set FTP_PKG_URL_HOST=file://localhost and
3996: FTP_PKG_URL_DIR=/usr/packages. The ${PACKAGES} directory and its
3997: subdirectories will be searched for all the binary packages.
1.1 dsieger 3998:
1.184 rillig 3999: The target can be run at the toplevel or in category directories, in which
4000: case it descends recursively.
1.1 dsieger 4001:
1.184 rillig 4002: readme-all
1.1 dsieger 4003:
1.184 rillig 4004: This is a top-level command, run it in pkgsrc. Use this target to create a
4005: file README-all.html which contains a list of all packages currently
4006: available in the NetBSD Packages Collection, together with the category
4007: they belong to and a short description. This file is compiled from the
1.199 nia 4008: pkgsrc/*/index.html files, so be sure to run this after a make readme.
1.1 dsieger 4009:
1.184 rillig 4010: cdrom-readme
1.1 dsieger 4011:
1.184 rillig 4012: This is very much the same as the "readme" target (see above), but is to be
4013: used when generating a pkgsrc tree to be written to a CD-ROM. This target
1.199 nia 4014: also produces index.html files, and can be made to refer to URLs based on
1.184 rillig 4015: CDROM_PKG_URL_HOST and CDROM_PKG_URL_DIR.
1.1 dsieger 4016:
1.184 rillig 4017: show-distfiles
1.1 dsieger 4018:
1.184 rillig 4019: This target shows which distfiles and patchfiles are needed to build the
4020: package (ALLFILES, which contains all DISTFILES and PATCHFILES, but not
4021: patches/*).
1.1 dsieger 4022:
1.184 rillig 4023: show-downlevel
1.1 dsieger 4024:
1.184 rillig 4025: This target shows nothing if the package is not installed. If a version of
4026: this package is installed, but is not the version provided in this version
4027: of pkgsrc, then a warning message is displayed. This target can be used to
4028: show which of your installed packages are downlevel, and so the old
4029: versions can be deleted, and the current ones added.
1.1 dsieger 4030:
1.184 rillig 4031: show-pkgsrc-dir
1.1 dsieger 4032:
1.184 rillig 4033: This target shows the directory in the pkgsrc hierarchy from which the
4034: package can be built and installed. This may not be the same directory as
4035: the one from which the package was installed. This target is intended to be
4036: used by people who may wish to upgrade many packages on a single host, and
4037: can be invoked from the top-level pkgsrc Makefile by using the "
4038: show-host-specific-pkgs" target.
1.1 dsieger 4039:
1.184 rillig 4040: show-installed-depends
1.1 dsieger 4041:
1.184 rillig 4042: This target shows which installed packages match the current package's
4043: DEPENDS. Useful if out of date dependencies are causing build problems.
1.1 dsieger 4044:
1.184 rillig 4045: print-build-depends-list
1.1 dsieger 4046:
1.184 rillig 4047: This target shows the list of packages that the current package depends on
4048: for building.
1.1 dsieger 4049:
1.184 rillig 4050: print-run-depends-list
1.1 dsieger 4051:
1.184 rillig 4052: This target shows the list of packages that the current package depends on
4053: for running.
1.1 dsieger 4054:
1.184 rillig 4055: check-shlibs
1.1 dsieger 4056:
1.184 rillig 4057: After a package is installed, check all its binaries and (on ELF platforms)
4058: shared libraries to see if they find the shared libs they need. Run by
4059: default if PKG_DEVELOPER is set in mk.conf.
1.1 dsieger 4060:
1.184 rillig 4061: print-PLIST
1.1 dsieger 4062:
1.184 rillig 4063: After a "make install" from a new or upgraded pkg, this prints out an
4064: attempt to generate a new PLIST from a find -newer work/.extract_done. An
4065: attempt is made to care for shared libs etc., but it is strongly
4066: recommended to review the result before putting it into PLIST. On upgrades,
4067: it's useful to diff the output of this command against an already existing
4068: PLIST file.
1.1 dsieger 4069:
1.184 rillig 4070: If the package installs files via tar(1) or other methods that don't update
4071: file access times, be sure to add these files manually to your PLIST, as
4072: the "find -newer" command used by this target won't catch them!
1.56 ryoon 4073:
1.184 rillig 4074: See Section 19.3, "Tweaking output of make print-PLIST" for more
4075: information on this target.
1.1 dsieger 4076:
1.255 wiz 4077: rebuild
4078:
4079: If you did a make build and you noticed some further modifications of
4080: sources are needed, you can repeat the build with this target, which will
4081: ignore the "already built" flag. This target is helpful while working with
4082: patches.
4083:
4084: repackage
4085:
4086: If you did a make package and you noticed some further modifications of
4087: sources are needed, you can repeat the package with this target, which will
4088: ignore the "already packaged" flag. This target is helpful while working
4089: with patches, PLIST* files etc.
4090:
4091: retest
4092:
4093: If you did a make test and you noticed some further modifications of
4094: sources are needed, you can repeat the test with this target, which will
4095: ignore the "already tested" flag. This target is helpful while working with
4096: patches.
4097:
1.184 rillig 4098: Chapter 14. Creating a new pkgsrc package from scratch
1.1 dsieger 4099:
1.184 rillig 4100: Table of Contents
1.1 dsieger 4101:
1.184 rillig 4102: 14.1. Common types of packages
1.219 nia 4103: 14.1.1. Python modules and programs
4104: 14.1.2. R packages
4105: 14.1.3. TeXlive packages
1.184 rillig 4106: 14.2. Examples
4107: 14.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 4108:
1.184 rillig 4109: When you find a package that is not yet in pkgsrc, you most likely have a URL
4110: from where you can download the source code. Starting with this URL, creating a
4111: package involves only a few steps.
1.1 dsieger 4112:
1.184 rillig 4113: 1. In your mk.conf, set PKG_DEVELOPER=yes to enable the basic quality checks.
1.1 dsieger 4114:
1.184 rillig 4115: 2. Install the package meta-pkgs/pkg_developer, which among others will
4116: install the utilities url2pkg, pkglint, pkgvi and mkpatches:
1.1 dsieger 4117:
1.184 rillig 4118: $ cd /usr/pkgsrc
4119: $ (cd meta-pkgs/pkg_developer && bmake update)
1.1 dsieger 4120:
1.184 rillig 4121: 3. Choose one of the top-level directories as the category in which you want
4122: to place your package. You can also create a directory of your own (maybe
1.219 nia 4123: called local). Change into that category directory:
1.1 dsieger 4124:
1.219 nia 4125: $ cd category
1.1 dsieger 4126:
1.219 nia 4127: 4. Run the program url2pkg, passing as argument the URL of the distribution
4128: file (in most cases a .tar.gz file). This will download the distribution
4129: file and create the necessary files of the package, based on what's in the
4130: distribution file:
1.1 dsieger 4131:
1.184 rillig 4132: $ url2pkg https://www.example.org/packages/package-1.0.tar.gz
1.1 dsieger 4133:
1.184 rillig 4134: 5. Examine the extracted files to determine the dependencies of your package.
4135: Ideally, this is mentioned in some README file, but things may differ. For
4136: each of these dependencies, look where it exists in pkgsrc, and if there is
4137: a file called buildlink3.mk in that directory, add a line to your package
4138: Makefile which includes that file just before the last line. If the
4139: buildlink3.mk file does not exist, it must be created first. The
4140: buildlink3.mk file makes sure that the package's include files and
4141: libraries are provided.
1.1 dsieger 4142:
1.219 nia 4143: If you just need binaries from a dependent package, add a DEPENDS line to
4144: the Makefile, which specifies the version of the dependency and where it
4145: can be found in pkgsrc. This line should be placed in the third paragraph.
4146: If the dependency is only needed for building the package, but not when
4147: using it, use TOOL_DEPENDS or BUILD_DEPENDS instead of DEPENDS. The
4148: difference between TOOL_DEPENDS and BUILD_DEPENDS occurs when
4149: cross-compiling: TOOL_DEPENDS are native packages, i.e. packages for the
4150: platform where the package is built; BUILD_DEPENDS are target packages,
4151: i.e. packages for the platform for which the package is built. There is
4152: also TEST_DEPENDS, which specifies a dependency used only for testing the
4153: resulting package built, using the upstream project's included test suite,
4154: on the native platform. Your package may then look like this:
1.1 dsieger 4155:
1.184 rillig 4156: [...]
1.1 dsieger 4157:
1.184 rillig 4158: TOOL_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
4159: DEPENDS+= screen-[0-9]*:../../misc/screen
4160: DEPENDS+= screen>=4.0:../../misc/screen
1.1 dsieger 4161:
1.184 rillig 4162: [...]
1.1 dsieger 4163:
1.184 rillig 4164: .include "../../category/package/buildlink3.mk"
4165: .include "../../devel/glib2/buildlink3.mk"
4166: .include "../../mk/bsd.pkg.mk"
1.1 dsieger 4167:
1.184 rillig 4168: 6. Run pkglint to see what things still need to be done to make your package a
4169: "good" one. If you don't know what pkglint's warnings want to tell you, try
4170: pkglint --explain or pkglint -e, which outputs additional explanations.
1.1 dsieger 4171:
1.184 rillig 4172: 7. In many cases the package is not yet ready to build. You can find
4173: instructions for the most common cases in the next section, Section 14.1,
4174: "Common types of packages". After you have followed the instructions over
4175: there, you can hopefully continue here.
1.1 dsieger 4176:
1.184 rillig 4177: 8. Run bmake clean to clean the working directory from the extracted files.
1.219 nia 4178: Besides these files, a lot of cache files and other system information have
4179: been saved in the working directory, which may have become outdated after
4180: you edited the Makefile.
1.1 dsieger 4181:
1.184 rillig 4182: 9. Now, run bmake to build the package. For the various things that can go
4183: wrong in this phase, consult Chapter 21, Making your package work.
1.1 dsieger 4184:
1.184 rillig 4185: If the extracted files from the package need to be fixed, run multiple
4186: rounds of these commands:
1.1 dsieger 4187:
1.219 nia 4188: $ bmake
1.184 rillig 4189: $ pkgvi ${WRKSRC}/some/file/that/does/not/compile
4190: $ mkpatches
1.219 nia 4191: $ bmake mps
4192: $ bmake clean
1.1 dsieger 4193:
1.184 rillig 4194: 10. When the package builds fine, the next step is to install the package. Run
4195: bmake install and hope that everything works.
1.1 dsieger 4196:
1.184 rillig 4197: 11. Up to now, the file PLIST, which contains a list of the files that are
4198: installed by the package, is nearly empty. Run bmake print-PLIST >PLIST to
4199: generate a probably correct list. Check the file using your preferred text
4200: editor to see if the list of files looks plausible.
1.1 dsieger 4201:
1.184 rillig 4202: 12. Run pkglint again to see if the generated PLIST contains garbage or not.
1.1 dsieger 4203:
1.184 rillig 4204: 13. When you ran bmake install, the package had been registered in the database
4205: of installed files, but with an empty list of files. To fix this, run bmake
4206: deinstall and bmake install again. Now the package is registered with the
4207: list of files from PLIST.
1.48 wiz 4208:
1.219 nia 4209: 14. Run bmake clean update to run everything from above again in a single step,
1.184 rillig 4210: making sure that the PLIST is correct and the whole package is created as
4211: intended.
1.48 wiz 4212:
1.219 nia 4213: 15. Run pkglint to see if there's anything left to do.
1.48 wiz 4214:
1.219 nia 4215: 16. Commit the package to pkgsrc-wip or main pkgsrc; see Chapter 23, Submitting
1.184 rillig 4216: and Committing.
1.50 wiz 4217:
1.184 rillig 4218: 14.1. Common types of packages
1.1 dsieger 4219:
1.219 nia 4220: 14.1.1. Python modules and programs
1.1 dsieger 4221:
1.184 rillig 4222: Python modules and programs packages are easily created using a set of
4223: predefined variables.
1.1 dsieger 4224:
1.184 rillig 4225: If some Python versions are not supported by the software, set the
4226: PYTHON_VERSIONS_INCOMPATIBLE variable to the Python versions that are not
4227: supported, e.g.
1.1 dsieger 4228:
1.184 rillig 4229: PYTHON_VERSIONS_INCOMPATIBLE= 27
1.1 dsieger 4230:
1.249 gutterid 4231: If the packaged software is a Python module, include ../../lang/python/
1.253 gutterid 4232: wheel.mk. Note per PEP-518, the minimum and default requirements to create .whl
1.255 wiz 4233: files are devel/py-setuptools plus devel/py-wheel; however, there are various
4234: other possible tools that projects can use. Thus inclusion of wheel.mk does not
4235: imply these defaults are defined as TOOL_DEPENDS. Whatever the project
4236: specifically requires as packaging tools must be defined in the package
4237: Makefile.
1.1 dsieger 4238:
1.248 wiz 4239: The package directory should be called "py-software" and PKGNAME should be set
4240: to "${PYPKGPREFIX}-${DISTNAME}", e.g.
1.1 dsieger 4241:
1.184 rillig 4242: DISTNAME= foopymodule-1.2.10
4243: PKGNAME= ${PYPKGPREFIX}-${DISTNAME}
1.1 dsieger 4244:
1.226 gutterid 4245: For software in PyPi, the name should match what PyPi specifies for "pip
4246: install software".
4247:
1.184 rillig 4248: If it is an application, include "../../lang/python/application.mk". In order
4249: to correctly set the path to the Python interpreter, use the REPLACE_PYTHON
4250: variable and set it to the list of files (paths relative to WRKSRC) that must
4251: be corrected. For example:
1.1 dsieger 4252:
1.184 rillig 4253: REPLACE_PYTHON= *.py
1.1 dsieger 4254:
1.219 nia 4255: 14.1.2. R packages
1.1 dsieger 4256:
1.184 rillig 4257: Simple R packages from CRAN are handled automatically by R2pkg, which is
4258: available in pkgtools/R2pkg. Individual packages (and optionally their
4259: dependencies) may be created and updated. R packages generally follow the same
4260: form, and most of the relevant information needed is contained in a DESCRIPTION
4261: file as part of each R package on CRAN. Consequently, R2pkg downloads that
4262: information and creates or updates a package in the canonical form. The
4263: resulting package should be reviewed for correctness.
1.1 dsieger 4264:
1.219 nia 4265: 14.1.3. TeXlive packages
1.1 dsieger 4266:
1.184 rillig 4267: TeXlive packages from CTAN are handled automatically by texlive2pkg, which is
4268: available in pkgtools/texlive2pkg.
1.1 dsieger 4269:
1.184 rillig 4270: If the TeXlive package name is not known, it may be useful to search CTAN. A "
4271: Contained in" field on the package page typically identifies the basename of
4272: the package file in the TeXlive archive.
1.1 dsieger 4273:
1.184 rillig 4274: If the TeXlive package name is known, download the files from the TeXlive
4275: archive. For package foo, you will need to download foo.tar.xz. Most TeXlive
4276: packages also have associated documentation packages, so download
4277: foo.doc.tar.xz at the same time. These files should be placed in the
4278: appropriate category directory, which is often but not always print. Then run
4279: the following command in the category directory.
1.1 dsieger 4280:
1.184 rillig 4281: texlive2pkg foo.tar.xz foo.doc.tar.xz
1.1 dsieger 4282:
1.184 rillig 4283: This will create two packages, tex-foo and tex-foo-doc. Be sure to check that
4284: both packages are correct.
1.1 dsieger 4285:
1.184 rillig 4286: Finally, CTAN currently does not include version information in package
4287: filenames and changes their contents periodically when updates occur.
4288: Consequently, pkgsrc avoids downloading distfiles directly from CTAN and
4289: instead relies on the pkgsrc archives. For each new or updated TeXlive package,
4290: e.g., the main one and the corresponding documentation, upload the distfiles
4291: with the following command in each package directory.
1.1 dsieger 4292:
1.184 rillig 4293: make upload-distfiles
1.117 sevan 4294:
1.184 rillig 4295: 14.2. Examples
1.117 sevan 4296:
1.184 rillig 4297: 14.2.1. How the www/nvu package came into pkgsrc
1.1 dsieger 4298:
1.184 rillig 4299: 14.2.1.1. The initial package
1.1 dsieger 4300:
1.184 rillig 4301: Looking at the file pkgsrc/doc/TODO, I saw that the "nvu" package has not yet
4302: been imported into pkgsrc. As the description says it has to do with the web,
4303: the obvious choice for the category is "www".
1.1 dsieger 4304:
1.184 rillig 4305: $ mkdir www/nvu
4306: $ cd www/nvu
1.1 dsieger 4307:
1.184 rillig 4308: The web site says that the sources are available as a tar file, so I fed that
4309: URL to the url2pkg program:
1.1 dsieger 4310:
1.184 rillig 4311: $ url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.1 dsieger 4312:
1.184 rillig 4313: My editor popped up, and I added a PKGNAME line below the DISTNAME line, as the
4314: package name should not have the word "sources" in it. I also filled in the
4315: MAINTAINER, HOMEPAGE and COMMENT fields. Then the package Makefile looked like
4316: that:
1.1 dsieger 4317:
1.184 rillig 4318: # $NetBSD $
4319: #
1.1 dsieger 4320:
1.184 rillig 4321: DISTNAME= nvu-1.0-sources
4322: PKGNAME= nvu-1.0
4323: CATEGORIES= www
4324: MASTER_SITES= http://cvs.nvu.com/download/
4325: EXTRACT_SUFX= .tar.bz2
1.1 dsieger 4326:
1.184 rillig 4327: MAINTAINER= rillig@NetBSD.org
4328: HOMEPAGE= http://cvs.nvu.com/
4329: COMMENT= Web Authoring System
1.1 dsieger 4330:
1.184 rillig 4331: # url2pkg-marker (please do not remove this line.)
4332: .include "../../mk/bsd.pkg.mk"
1.1 dsieger 4333:
1.184 rillig 4334: On the first line of output above, an artificial space has been added between
4335: NetBSD and $, this is a workaround to prevent CVS expanding to the filename of
4336: the guide.
1.1 dsieger 4337:
1.184 rillig 4338: Then, I quit the editor and watched pkgsrc downloading a large source archive:
1.1 dsieger 4339:
1.184 rillig 4340: url2pkg> Running "make makesum" ...
4341: => Required installed package digest>=20010302: digest-20060826 found
4342: => Fetching nvu-1.0-sources.tar.bz2
4343: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4344: 100% |*************************************| 28992 KB 150.77 KB/s00:00 ETA
4345: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4346: url2pkg> Running "make extract" ...
4347: => Required installed package digest>=20010302: digest-20060826 found
4348: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4349: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4350: work.bacc -> /tmp/roland/pkgsrc/www/nvu/work.bacc
4351: ===> Installing dependencies for nvu-1.0
4352: ===> Overriding tools for nvu-1.0
4353: ===> Extracting for nvu-1.0
4354: url2pkg> Adjusting the Makefile.
1.1 dsieger 4355:
1.184 rillig 4356: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.1 dsieger 4357:
1.184 rillig 4358: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.1 dsieger 4359:
1.184 rillig 4360: 14.2.1.2. Fixing all kinds of problems to make the package work
1.1 dsieger 4361:
1.184 rillig 4362: Now that the package has been extracted, let's see what's inside it. The
4363: package has a README.txt, but that only says something about mozilla, so it's
4364: probably useless for seeing what dependencies this package has. But since there
4365: is a GNU configure script in the package, let's hope that it will complain
4366: about everything it needs.
1.1 dsieger 4367:
1.184 rillig 4368: $ bmake
4369: => Required installed package digest>=20010302: digest-20060826 found
4370: => Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4371: => Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4372: ===> Patching for nvu-1.0
4373: ===> Creating toolchain wrappers for nvu-1.0
4374: ===> Configuring for nvu-1.0
4375: [...]
4376: configure: error: Perl 5.004 or higher is required.
4377: [...]
4378: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4379: [...]
1.1 dsieger 4380:
1.184 rillig 4381: That worked quite well. So I opened the package Makefile in my editor, and
4382: since it already has a USE_TOOLS line, I just appended "perl" to it. Since the
4383: dependencies of the package have changed now, and since a perl wrapper is
4384: automatically installed in the "tools" phase, I need to build the package from
4385: scratch.
1.1 dsieger 4386:
1.184 rillig 4387: $ bmake clean
4388: ===> Cleaning for nvu-1.0
4389: $ bmake
4390: [...]
4391: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4392: GNU Make. You will not be able to build Mozilla without GNU Make.
4393: [...]
1.1 dsieger 4394:
1.184 rillig 4395: So I added "gmake" to the USE_TOOLS line and tried again (from scratch).
1.1 dsieger 4396:
1.184 rillig 4397: [...]
4398: checking for GTK - version >= 1.2.0... no
4399: *** Could not run GTK test program, checking why...
4400: [...]
1.1 dsieger 4401:
1.184 rillig 4402: Now to the other dependencies. The first question is: Where is the GTK package
4403: hidden in pkgsrc?
1.1 dsieger 4404:
1.184 rillig 4405: $ echo ../../*/gtk*
4406: [many packages ...]
4407: $ echo ../../*/gtk
4408: ../../x11/gtk
4409: $ echo ../../*/gtk2
4410: ../../x11/gtk2
4411: $ echo ../../*/gtk2/bui*
4412: ../../x11/gtk2/buildlink3.mk
1.1 dsieger 4413:
1.184 rillig 4414: The first try was definitely too broad. The second one had exactly one result,
4415: which is very good. But there is one pitfall with GNOME packages. Before GNOME
4416: 2 had been released, there were already many GNOME 1 packages in pkgsrc. To be
4417: able to continue to use these packages, the GNOME 2 packages were imported as
4418: separate packages, and their names usually have a "2" appended. So I checked
4419: whether this was the case here, and indeed it was.
1.1 dsieger 4420:
1.184 rillig 4421: Since the GTK2 package has a buildlink3.mk file, adding the dependency is very
4422: easy. I just inserted an .include line before the last line of the package
4423: Makefile, so that it now looks like this:
1.1 dsieger 4424:
1.184 rillig 4425: [...]
4426: .include "../../x11/gtk2/buildlink3.mk"
4427: .include "../../mk/bsd.pkg.mk
1.1 dsieger 4428:
1.184 rillig 4429: After another bmake clean && bmake, the answer was:
1.108 rillig 4430:
1.184 rillig 4431: [...]
4432: checking for gtk-config... /home/roland/pkg/bin/gtk-config
4433: checking for GTK - version >= 1.2.0... no
4434: *** Could not run GTK test program, checking why...
4435: *** The test program failed to compile or link. See the file config.log for the
4436: *** exact error that occured. This usually means GTK was incorrectly installed
4437: *** or that you have moved GTK since it was installed. In the latter case, you
4438: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4439: configure: error: Test for GTK failed.
4440: [...]
1.1 dsieger 4441:
1.184 rillig 4442: In this particular case, the assumption that "every package prefers GNOME 2"
4443: had been wrong. The first of the lines above told me that this package really
4444: wanted to have the GNOME 1 version of GTK. If the package had looked for GTK2,
4445: it would have looked for pkg-config instead of gtk-config. So I changed the x11
4446: /gtk2 to x11/gtk in the package Makefile, and tried again.
1.1 dsieger 4447:
1.184 rillig 4448: [...]
4449: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\" [...]
4450: In file included from xpidl.c:42:
4451: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4452: In file included from xpidl.c:42:
4453: xpidl.h:132: error: parse error before "IDL_ns"
4454: [...]
1.1 dsieger 4455:
1.184 rillig 4456: The package still does not find all of its dependencies. Now the question is:
4457: Which package provides the libIDL/IDL.h header file?
1.1 dsieger 4458:
1.184 rillig 4459: $ echo ../../*/*idl*
4460: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4461: $ echo ../../*/*IDL*
4462: ../../net/libIDL
1.1 dsieger 4463:
1.184 rillig 4464: Let's take the one from the second try. So I included the ../../net/libIDL/
4465: buildlink3.mk file and tried again. But the error didn't change. After digging
4466: through some of the code, I concluded that the build process of the package was
4467: broken and couldn't have ever worked, but since the Mozilla source tree is
4468: quite large, I didn't want to fix it. So I added the following to the package
4469: Makefile and tried again:
1.1 dsieger 4470:
1.184 rillig 4471: CPPFLAGS+= -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4472: BUILDLINK_TRANSFORM+= l:IDL:IDL-2
1.1 dsieger 4473:
1.184 rillig 4474: The latter line is needed because the package expects the library libIDL.so,
4475: but only libIDL-2.so is available. So I told the compiler wrapper to rewrite
4476: that on the fly.
1.1 dsieger 4477:
1.184 rillig 4478: The next problem was related to a recent change of the FreeType interface. I
4479: looked up in www/seamonkey which patch files were relevant for this issue and
4480: copied them to the patches directory. Then I retried, fixed the patches so that
4481: they applied cleanly and retried again. This time, everything worked.
1.1 dsieger 4482:
1.184 rillig 4483: 14.2.1.3. Installing the package
1.1 dsieger 4484:
1.184 rillig 4485: $ bmake CHECK_FILES=no install
4486: [...]
4487: $ bmake print-PLIST >PLIST
4488: $ bmake deinstall
4489: $ bmake install
1.1 dsieger 4490:
1.184 rillig 4491: Chapter 15. Programming in Makefiles
1.1 dsieger 4492:
1.184 rillig 4493: Table of Contents
1.1 dsieger 4494:
1.184 rillig 4495: 15.1. Caveats
4496: 15.2. Makefile variables
4497: 15.2.1. Naming conventions
4498: 15.3. Code snippets
4499: 15.3.1. Adding things to a list
4500: 15.3.2. Echoing a string exactly as-is
4501: 15.3.3. Passing CFLAGS to GNU configure scripts
4502: 15.3.4. Handling possibly empty variables
1.229 gutterid 4503: 15.3.5. Testing yes/no variables in conditions
1.1 dsieger 4504:
1.184 rillig 4505: Pkgsrc consists of many Makefile fragments, each of which forms a well-defined
4506: part of the pkgsrc system. Using the make(1) system as a programming language
4507: for a big system like pkgsrc requires some discipline to keep the code correct
4508: and understandable.
1.1 dsieger 4509:
1.184 rillig 4510: The basic ingredients for Makefile programming are variables and shell
4511: commands. Among these shell commands may even be more complex ones like awk(1)
4512: programs. To make sure that every shell command runs as intended it is
4513: necessary to quote all variables correctly when they are used.
1.1 dsieger 4514:
1.184 rillig 4515: This chapter describes some patterns that appear quite often in Makefiles,
4516: including the pitfalls that come along with them.
1.1 dsieger 4517:
1.184 rillig 4518: 15.1. Caveats
1.1 dsieger 4519:
1.184 rillig 4520: * When you are creating a file as a target of a rule, always write the data
4521: to a temporary file first and finally rename that file. Otherwise there
4522: might occur an error in the middle of generating the file, and when the
4523: user runs make(1) for the second time, the file exists and will not be
4524: regenerated properly. Example:
1.1 dsieger 4525:
1.184 rillig 4526: wrong:
4527: @echo "line 1" > ${.TARGET}
4528: @echo "line 2" >> ${.TARGET}
4529: @false
1.1 dsieger 4530:
1.184 rillig 4531: correct:
4532: @echo "line 1" > ${.TARGET}.tmp
4533: @echo "line 2" >> ${.TARGET}.tmp
4534: @false
4535: @mv ${.TARGET}.tmp ${.TARGET}
1.1 dsieger 4536:
1.184 rillig 4537: When you run make wrong twice, the file wrong will exist, although there
4538: was an error message in the first run. On the other hand, running make
4539: correct gives an error message twice, as expected.
1.1 dsieger 4540:
1.184 rillig 4541: You might remember that make(1) sometimes removes ${.TARGET} in case of
4542: error, but this only happens when it is interrupted, for example by
4543: pressing Ctrl+C. This does not happen when one of the commands fails (like
4544: false(1) above).
1.1 dsieger 4545:
1.184 rillig 4546: 15.2. Makefile variables
1.1 dsieger 4547:
1.184 rillig 4548: Makefile variables contain strings that can be processed using the five
4549: operators =, +=, ?=, := and !=, which are described in the make(1) man page.
1.1 dsieger 4550:
1.184 rillig 4551: When a variable's value is parsed from a Makefile, the hash character # and the
4552: backslash character \ are handled specially. If a backslash is the last
4553: character in a line, that backslash is removed from the line and the line
4554: continues with the next line of the file.
1.1 dsieger 4555:
1.184 rillig 4556: The # character starts a comment that reaches until the end of the line. To get
4557: an actual # character, such as in a URL, write \# instead.
1.1 dsieger 4558:
1.184 rillig 4559: The evaluation of variables either happens immediately or lazy. It happens
4560: immediately when the variable occurs on the right-hand side of the := or the !=
4561: operator, in a .if condition or a .for loop. In the other cases, it is
4562: evaluated lazily.
1.1 dsieger 4563:
1.184 rillig 4564: Some of the modifiers split the string into words and then operate on the
4565: words, others operate on the string as a whole. When a string is split into
4566: words, double quotes and single quotes are interpreted as delimiters, just like
4567: in sh(1).
1.1 dsieger 4568:
1.184 rillig 4569: 15.2.1. Naming conventions
1.1 dsieger 4570:
1.184 rillig 4571: * All variable names starting with an underscore are reserved for use by the
4572: pkgsrc infrastructure. They shall not be used by packages.
1.1 dsieger 4573:
1.184 rillig 4574: * In .for loops you should use lowercase variable names for the iteration
4575: variables.
1.1 dsieger 4576:
1.184 rillig 4577: * All list variables should have a plural name, such as PKG_OPTIONS or
4578: DISTFILES.
1.1 dsieger 4579:
1.184 rillig 4580: 15.3. Code snippets
1.1 dsieger 4581:
1.184 rillig 4582: 15.3.1. Adding things to a list
1.1 dsieger 4583:
1.184 rillig 4584: When adding a string that possibly contains whitespace or quotes to a list
4585: (example 1), it must be quoted using the :Q modifier.
1.1 dsieger 4586:
1.184 rillig 4587: When adding another list to a list (example 2), it must not be quoted, since
4588: its elements are already quoted.
1.1 dsieger 4589:
1.184 rillig 4590: STRING= foo * bar `date`
4591: LIST= # empty
4592: ANOTHER_LIST= a=b c=d
1.1 dsieger 4593:
1.184 rillig 4594: LIST+= ${STRING:Q} # 1
4595: LIST+= ${ANOTHER_LIST} # 2
1.1 dsieger 4596:
1.184 rillig 4597: 15.3.2. Echoing a string exactly as-is
1.1 dsieger 4598:
1.184 rillig 4599: Echoing a string containing special characters needs special work.
1.1 dsieger 4600:
1.184 rillig 4601: STRING= foo bar < > * `date` $$HOME ' "
4602: EXAMPLE_ENV= string=${STRING:Q} x=multiple\ quoted\ words
1.1 dsieger 4603:
1.184 rillig 4604: all:
4605: echo ${STRING} # 1
4606: echo ${STRING:Q} # 2
4607: printf '%s\n' ${STRING:Q}'' # 3
4608: env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1 dsieger 4609:
1.184 rillig 4610: Example 1 leads to a syntax error in the shell, as the characters are just
4611: copied.
1.1 dsieger 4612:
1.184 rillig 4613: Example 2 quotes the string so that the shell interprets it correctly. But the
4614: echo command may additionally interpret strings with a leading dash or those
4615: containing backslashes.
1.1 dsieger 4616:
1.184 rillig 4617: Example 3 can handle arbitrary strings, since printf(1) only interprets the
4618: format string, but not the next argument. The trailing single quotes handle the
4619: case when the string is empty. In that case, the :Q modifier would result in an
4620: empty string too, which would then be skipped by the shell. For printf(1) this
4621: doesn't make a difference, but other programs may care.
1.1 dsieger 4622:
1.184 rillig 4623: In example 4, the EXAMPLE_ENV does not need to be quoted because the quoting
4624: has already been done when adding elements to the list.
1.1 dsieger 4625:
1.184 rillig 4626: 15.3.3. Passing CFLAGS to GNU configure scripts
1.1 dsieger 4627:
1.184 rillig 4628: When passing CFLAGS or similar variables to a GNU-style configure script
4629: (especially those that call other configure scripts), it must not have leading
4630: or trailing whitespace, since otherwise the configure script gets confused. To
4631: trim leading and trailing whitespace, use the :M modifier, as in the following
4632: example:
1.1 dsieger 4633:
1.184 rillig 4634: CPPFLAGS= # empty
4635: CPPFLAGS+= -Wundef -DPREFIX=\"${PREFIX}\"
4636: CPPFLAGS+= ${MY_CPPFLAGS}
1.1 dsieger 4637:
1.184 rillig 4638: CONFIGURE_ARGS+= CPPFLAGS=${CPPFLAGS:M*:Q}
1.1 dsieger 4639:
1.184 rillig 4640: all:
4641: echo x${CPPFLAGS:Q}x # leading and trailing whitespace
4642: echo x${CONFIGURE_ARGS:Q}x # properly trimmed
1.1 dsieger 4643:
1.184 rillig 4644: In this example, CPPFLAGS has both leading and trailing whitespace because the
4645: += operator always adds a space.
1.1 dsieger 4646:
1.184 rillig 4647: 15.3.4. Handling possibly empty variables
1.1 dsieger 4648:
1.184 rillig 4649: When a possibly empty variable is used in a shell program, it may lead to a
4650: syntax error.
1.1 dsieger 4651:
1.184 rillig 4652: EGFILES= # empty
1.1 dsieger 4653:
1.184 rillig 4654: install-examples: # produces a syntax error in the shell
4655: for egfile in ${EGFILES}; do \
4656: echo "Installing $$egfile"; \
4657: done
1.1 dsieger 4658:
1.184 rillig 4659: The shell only sees the text for egfile in ; do, since ${EGFILES} is replaced
4660: with an empty string by make(1). To fix this syntax error, use one of the
4661: snippets below.
1.1 dsieger 4662:
1.229 gutterid 4663: EGFILES= # empty
1.1 dsieger 4664:
1.184 rillig 4665: install-examples:
4666: for egfile in ${EGFILES} ""; do \
4667: [ -n "$$egfile" ] || continue; \
4668: echo "Installing $$egfile"; \
4669: done
1.1 dsieger 4670:
1.184 rillig 4671: In this case, an empty string is appended to the iteration list (to prevent the
4672: syntax error) and filtered out later.
1.1 dsieger 4673:
1.184 rillig 4674: EGFILES= # empty
1.1 dsieger 4675:
1.184 rillig 4676: install-examples:
4677: .for egfile in ${EGFILES}
4678: echo "Installing ${egfile}"
4679: .endfor
1.1 dsieger 4680:
1.184 rillig 4681: If one of the filenames contains special characters, it should be enclosed in
4682: single or double quotes.
1.1 dsieger 4683:
1.184 rillig 4684: To have a shell command test whether a make variable is empty, use the
4685: following code: ${TEST} -z ${POSSIBLY_EMPTY:Q}"".
1.1 dsieger 4686:
1.229 gutterid 4687: 15.3.5. Testing yes/no variables in conditions
4688:
4689: When a variable can have the values yes or no, use the following pattern to
4690: test the variable:
4691:
4692: .if ${VAR:U:tl} == "yes"
4693: # do something
4694: .endif
4695:
4696: The :U modifier is only necessary if the variable can be undefined. If the
4697: variable is guaranteed to be defined, the :U can be omitted.
4698:
4699: The :tl modifier converts the variable value to lowercase, allowing for the
4700: values yes, Yes, YES.
4701:
1.184 rillig 4702: Chapter 16. Options handling
1.1 dsieger 4703:
4704: Table of Contents
4705:
1.184 rillig 4706: 16.1. Global default options
4707: 16.2. Converting packages to use bsd.options.mk
4708: 16.3. Option Names
4709: 16.4. Determining the options of dependencies
1.1 dsieger 4710:
4711: Many packages have the ability to be built to support different sets of
4712: features. bsd.options.mk is a framework in pkgsrc that provides generic
4713: handling of those options that determine different ways in which the packages
4714: can be built. It's possible for the user to specify exactly which sets of
4715: options will be built into a package or to allow a set of global default
4716: options apply.
4717:
1.7 rillig 4718: There are two broad classes of behaviors that one might want to control via
4719: options. One is whether some particular feature is enabled in a program that
4720: will be built anyway, often by including or not including a dependency on some
4721: other package. The other is whether or not an additional program will be built
4722: as part of the package. Generally, it is better to make a split package for
4723: such additional programs instead of using options, because it enables binary
4724: packages to be built which can then be added separately. For example, the foo
4725: package might have minimal dependencies (those packages without which foo
4726: doesn't make sense), and then the foo-gfoo package might include the GTK
4727: frontend program gfoo. This is better than including a gtk option to foo that
4728: adds gfoo, because either that option is default, in which case binary users
4729: can't get foo without gfoo, or not default, in which case they can't get gfoo.
4730: With split packages, they can install foo without having GTK, and later decide
4731: to install gfoo (pulling in GTK at that time). This is an advantage to source
4732: users too, avoiding the need for rebuilds.
4733:
4734: Plugins with widely varying dependencies should usually be split instead of
4735: options.
4736:
4737: It is often more work to maintain split packages, especially if the upstream
4738: package does not support this. The decision of split vs. option should be made
4739: based on the likelihood that users will want or object to the various pieces,
4740: the size of the dependencies that are included, and the amount of work.
4741:
4742: A further consideration is licensing. Non-free parts, or parts that depend on
4743: non-free dependencies (especially plugins) should almost always be split if
4744: feasible.
4745:
1.184 rillig 4746: 16.1. Global default options
1.1 dsieger 4747:
4748: Global default options are listed in PKG_DEFAULT_OPTIONS, which is a list of
4749: the options that should be built into every package if that option is
1.4 rillig 4750: supported. This variable should be set in mk.conf.
1.1 dsieger 4751:
1.184 rillig 4752: 16.2. Converting packages to use bsd.options.mk
1.1 dsieger 4753:
4754: The following example shows how bsd.options.mk should be used by the
4755: hypothetical ``wibble'' package, either in the package Makefile, or in a file,
4756: e.g. options.mk, that is included by the main package Makefile.
4757:
4758: PKG_OPTIONS_VAR= PKG_OPTIONS.wibble
4759: PKG_SUPPORTED_OPTIONS= wibble-foo ldap
4760: PKG_OPTIONS_OPTIONAL_GROUPS= database
4761: PKG_OPTIONS_GROUP.database= mysql pgsql
4762: PKG_SUGGESTED_OPTIONS= wibble-foo
4763: PKG_OPTIONS_LEGACY_VARS+= WIBBLE_USE_OPENLDAP:ldap
4764: PKG_OPTIONS_LEGACY_OPTS+= foo:wibble-foo
4765:
4766: .include "../../mk/bsd.prefs.mk"
4767:
4768: # this package was previously named wibble2
4769: .if defined(PKG_OPTIONS.wibble2)
4770: PKG_LEGACY_OPTIONS+= ${PKG_OPTIONS.wibble2}
4771: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
4772: "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
4773: .endif
4774:
4775: .include "../../mk/bsd.options.mk"
4776:
4777: # Package-specific option-handling
4778:
4779: ###
4780: ### FOO support
4781: ###
4782: .if !empty(PKG_OPTIONS:Mwibble-foo)
4783: CONFIGURE_ARGS+= --enable-foo
4784: .endif
4785:
4786: ###
4787: ### LDAP support
4788: ###
4789: .if !empty(PKG_OPTIONS:Mldap)
4790: . include "../../databases/openldap-client/buildlink3.mk"
4791: CONFIGURE_ARGS+= --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
4792: .endif
4793:
4794: ###
4795: ### database support
4796: ###
4797: .if !empty(PKG_OPTIONS:Mmysql)
4798: . include "../../mk/mysql.buildlink3.mk"
4799: .endif
4800: .if !empty(PKG_OPTIONS:Mpgsql)
4801: . include "../../mk/pgsql.buildlink3.mk"
4802: .endif
4803:
4804: The first section contains the information about which build options are
4805: supported by the package, and any default options settings if needed.
4806:
4807: 1. PKG_OPTIONS_VAR is the name of the make(1) variable that the user can set
4808: to override the default options. It should be set to PKG_OPTIONS.pkgbase.
4809: Do not set it to PKG_OPTIONS.${PKGBASE}, since PKGBASE is not defined at
4810: the point where the options are processed.
4811:
4812: 2. PKG_SUPPORTED_OPTIONS is a list of build options supported by the package.
4813:
4814: 3. PKG_OPTIONS_OPTIONAL_GROUPS is a list of names of groups of mutually
4815: exclusive options. The options in each group are listed in
4816: PKG_OPTIONS_GROUP.groupname. The most specific setting of any option from
4817: the group takes precedence over all other options in the group. Options
4818: from the groups will be automatically added to PKG_SUPPORTED_OPTIONS.
4819:
4820: 4. PKG_OPTIONS_REQUIRED_GROUPS is like PKG_OPTIONS_OPTIONAL_GROUPS, but
4821: building the packages will fail if no option from the group is selected.
4822:
4823: 5. PKG_OPTIONS_NONEMPTY_SETS is a list of names of sets of options. At least
4824: one option from each set must be selected. The options in each set are
4825: listed in PKG_OPTIONS_SET.setname. Options from the sets will be
4826: automatically added to PKG_SUPPORTED_OPTIONS. Building the package will
4827: fail if no option from the set is selected.
4828:
4829: 6. PKG_SUGGESTED_OPTIONS is a list of build options which are enabled by
4830: default.
4831:
4832: 7. PKG_OPTIONS_LEGACY_VARS is a list of "USE_VARIABLE:option" pairs that map
1.4 rillig 4833: legacy mk.conf variables to their option counterparts. Pairs should be
1.1 dsieger 4834: added with "+=" to keep the listing of global legacy variables. A warning
4835: will be issued if the user uses a legacy variable.
4836:
4837: 8. PKG_OPTIONS_LEGACY_OPTS is a list of "old-option:new-option" pairs that map
4838: options that have been renamed to their new counterparts. Pairs should be
4839: added with "+=" to keep the listing of global legacy options. A warning
4840: will be issued if the user uses a legacy option.
4841:
4842: 9. PKG_LEGACY_OPTIONS is a list of options implied by deprecated variables
4843: used. This can be used for cases that neither PKG_OPTIONS_LEGACY_VARS nor
4844: PKG_OPTIONS_LEGACY_OPTS can handle, e. g. when PKG_OPTIONS_VAR is renamed.
4845:
4846: 10. PKG_OPTIONS_DEPRECATED_WARNINGS is a list of warnings about deprecated
4847: variables or options used, and what to use instead.
4848:
4849: A package should never modify PKG_DEFAULT_OPTIONS or the variable named in
4850: PKG_OPTIONS_VAR. These are strictly user-settable. To suggest a default set of
4851: options, use PKG_SUGGESTED_OPTIONS.
4852:
4853: PKG_OPTIONS_VAR must be defined before including bsd.options.mk. If none of
4854: PKG_SUPPORTED_OPTIONS, PKG_OPTIONS_OPTIONAL_GROUPS, and
4855: PKG_OPTIONS_REQUIRED_GROUPS are defined (as can happen with platform-specific
4856: options if none of them is supported on the current platform), PKG_OPTIONS is
4857: set to the empty list and the package is otherwise treated as not using the
4858: options framework.
4859:
4860: After the inclusion of bsd.options.mk, the variable PKG_OPTIONS contains the
4861: list of selected build options, properly filtered to remove unsupported and
4862: duplicate options.
4863:
4864: The remaining sections contain the logic that is specific to each option. The
4865: correct way to check for an option is to check whether it is listed in
4866: PKG_OPTIONS:
4867:
4868: .if !empty(PKG_OPTIONS:Moption)
4869:
1.184 rillig 4870: 16.3. Option Names
1.1 dsieger 4871:
4872: Options that enable similar features in different packages (like optional
4873: support for a library) should use a common name in all packages that support it
4874: (like the name of the library). If another package already has an option with
4875: the same meaning, use the same name.
4876:
4877: Options that enable features specific to one package, where it's unlikely that
4878: another (unrelated) package has the same (or a similar) optional feature,
4879: should use a name prefixed with pkgname-.
4880:
4881: If a group of related packages share an optional feature specific to that
4882: group, prefix it with the name of the "main" package (e. g.
4883: djbware-errno-hack).
4884:
4885: For new options, add a line to mk/defaults/options.description. Lines have two
4886: fields, separated by tab. The first field is the option name, the second its
4887: description. The description should be a whole sentence (starting with an
4888: uppercase letter and ending with a period) that describes what enabling the
4889: option does. E. g. "Enable ispell support." The file is sorted by option names.
4890:
1.184 rillig 4891: 16.4. Determining the options of dependencies
1.7 rillig 4892:
4893: When writing buildlink3.mk files, it is often necessary to list different
4894: dependencies based on the options with which the package was built. For
4895: querying these options, the file pkgsrc/mk/pkg-build-options.mk should be used.
4896: A typical example looks like this:
4897:
4898: pkgbase := libpurple
4899: .include "../../mk/pkg-build-options.mk"
4900:
4901: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
4902: ...
4903: .endif
4904:
4905: Including pkg-build-options.mk here will set the variable
4906: PKG_BUILD_OPTIONS.libpurple to the build options of the libpurple package,
4907: which can then be queried like PKG_OPTIONS in the options.mk file. See the file
4908: pkg-build-options.mk for more details.
4909:
1.184 rillig 4910: Chapter 17. Tools needed for building or running
4911:
4912: Table of Contents
4913:
4914: 17.1. Tools for pkgsrc builds
4915: 17.2. Tools needed by packages
4916: 17.3. Tools provided by platforms
4917:
4918: The USE_TOOLS definition is used both internally by pkgsrc and also for
4919: individual packages to define what commands are needed for building a package
4920: (like TOOL_DEPENDS) or for later run-time of an installed packaged (such as
4921: DEPENDS). If the native system provides an adequate tool, then in many cases, a
4922: pkgsrc package will not be used.
4923:
4924: When building a package, the replacement tools are made available in a
4925: directory (as symlinks or wrapper scripts) that is early in the executable
4926: search path. Just like the buildlink system, this helps with consistent builds.
4927:
4928: A tool may be needed to help build a specific package. For example, perl, GNU
4929: make (gmake) or yacc may be needed.
4930:
4931: Also a tool may be needed, for example, because the native system's supplied
4932: tool may be inefficient for building a package with pkgsrc. For example, a
4933: package may need GNU awk, bison (instead of yacc) or a better sed.
4934:
4935: The tools used by a package can be listed by running make show-tools.
4936:
4937: 17.1. Tools for pkgsrc builds
4938:
4939: The default set of tools used by pkgsrc is defined in bsd.pkg.mk. This includes
4940: standard Unix tools, such as: cat, awk, chmod, test, and so on. These can be
4941: seen by running: make show-var VARNAME=USE_TOOLS.
4942:
4943: If a package needs a specific program to build then the USE_TOOLS variable can
4944: be used to define the tools needed.
4945:
4946: 17.2. Tools needed by packages
4947:
4948: In the following examples, the :run means that it is needed at run-time (and
4949: becomes a DEPENDS). The default is a build dependency which can be set with
4950: :build. (So in this example, it is the same as gmake:build and
4951: pkg-config:build.)
4952:
4953: USE_TOOLS+= gmake perl:run pkg-config
4954:
4955: When using the tools framework, a TOOLS_PATH.foo variable is defined which
4956: contains the full path to the appropriate tool. For example, TOOLS_PATH.bash
4957: could be "/bin/bash" on Linux systems.
4958:
4959: If you always need a pkgsrc version of the tool at run-time, then just use
4960: DEPENDS instead.
4961:
4962: 17.3. Tools provided by platforms
4963:
4964: When improving or porting pkgsrc to a new platform, have a look at (or create)
4965: the corresponding platform specific make file fragment under pkgsrc/mk/tools/
4966: tools.${OPSYS}.mk which defines the name of the common tools. For example:
4967:
4968: .if exists(/usr/bin/bzcat)
4969: TOOLS_PLATFORM.bzcat?= /usr/bin/bzcat
4970: .elif exists(/usr/bin/bzip2)
4971: TOOLS_PLATFORM.bzcat?= /usr/bin/bzip2 -cd
4972: .endif
4973:
4974: TOOLS_PLATFORM.true?= true # shell builtin
4975:
4976: Chapter 18. Buildlink methodology
1.1 dsieger 4977:
4978: Table of Contents
4979:
1.184 rillig 4980: 18.1. Converting packages to use buildlink3
4981: 18.2. Writing buildlink3.mk files
4982: 18.2.1. Anatomy of a buildlink3.mk file
4983: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
1.232 gutterid 4984: buildlink3.mk files
1.184 rillig 4985: 18.3. Writing builtin.mk files
4986: 18.3.1. Anatomy of a builtin.mk file
4987:
4988: Buildlink is a framework in pkgsrc that controls what headers and libraries are
4989: seen by a package's configure and build processes. This is implemented in a two
4990: step process:
4991:
4992: 1. Symlink headers and libraries for dependencies into BUILDLINK_DIR, which by
4993: default is a subdirectory of WRKDIR.
4994:
4995: 2. Create wrapper scripts that are used in place of the normal compiler tools
4996: that translate -I${LOCALBASE}/include and -L${LOCALBASE}/lib into
4997: references to BUILDLINK_DIR. The wrapper scripts also make native compiler
4998: on some operating systems look like GCC, so that packages that expect GCC
4999: won't require modifications to build with those native compilers.
5000:
5001: This normalizes the environment in which a package is built so that the package
5002: may be built consistently despite what other software may be installed. Please
5003: note that the normal system header and library paths, e.g. /usr/include, /usr/
5004: lib, etc., are always searched -- buildlink3 is designed to insulate the
5005: package build from non-system-supplied software.
5006:
5007: 18.1. Converting packages to use buildlink3
1.1 dsieger 5008:
1.184 rillig 5009: The process of converting packages to use the buildlink3 framework ("bl3ifying"
5010: ) is fairly straightforward. The things to keep in mind are:
1.1 dsieger 5011:
1.184 rillig 5012: 1. Ensure that the build always calls the wrapper scripts instead of the
5013: actual toolchain. Some packages are tricky, and the only way to know for
5014: sure is the check ${WRKDIR}/.work.log to see if the wrappers are being
5015: invoked.
1.1 dsieger 5016:
1.184 rillig 5017: 2. Don't override PREFIX from within the package Makefile, e.g. Java VMs,
5018: standalone shells, etc., because the code to symlink files into $
5019: {BUILDLINK_DIR} looks for files relative to "pkg_info -qp pkgname".
1.1 dsieger 5020:
1.184 rillig 5021: 3. Remember that only the buildlink3.mk files that you list in a package's
5022: Makefile are added as dependencies for that package.
1.1 dsieger 5023:
1.184 rillig 5024: If a dependency on a particular package is required for its libraries and
5025: headers, then we replace:
1.1 dsieger 5026:
1.184 rillig 5027: DEPENDS+= foo>=1.1.0:../../category/foo
1.1 dsieger 5028:
1.184 rillig 5029: with
1.1 dsieger 5030:
1.184 rillig 5031: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 5032:
1.184 rillig 5033: The buildlink3.mk files usually define the required dependencies. If you need a
5034: newer version of the dependency when using buildlink3.mk files, then you can
5035: define it in your Makefile; for example:
1.1 dsieger 5036:
1.184 rillig 5037: BUILDLINK_API_DEPENDS.foo+= foo>=1.1.0
5038: .include "../../category/foo/buildlink3.mk"
1.1 dsieger 5039:
1.184 rillig 5040: There are several buildlink3.mk files in pkgsrc/mk that handle special package
5041: issues:
1.1 dsieger 5042:
1.184 rillig 5043: * bdb.buildlink3.mk chooses either the native or a pkgsrc Berkeley DB
5044: implementation based on the values of BDB_ACCEPTED and BDB_DEFAULT.
1.1 dsieger 5045:
1.184 rillig 5046: * curses.buildlink3.mk: If the system comes with neither Curses nor NCurses,
5047: this will take care to install the devel/ncurses package.
1.1 dsieger 5048:
1.184 rillig 5049: * krb5.buildlink3.mk uses the value of KRB5_ACCEPTED to choose between adding
5050: a dependency on Heimdal or MIT-krb5 for packages that require a Kerberos 5
5051: implementation.
1.1 dsieger 5052:
1.184 rillig 5053: * motif.buildlink3.mk checks for a system-provided Motif installation or adds
5054: a dependency on x11/lesstif or x11/motif. The user can set MOTIF_TYPE to "
5055: dt", "lesstif" or "motif" to choose which Motif version will be used.
1.1 dsieger 5056:
1.184 rillig 5057: * readline.buildlink3.mk checks for a system-provided GNU readline or
5058: editline (libedit) installation, or adds a dependency on devel/readline,
5059: devel/editline. The user can set READLINE_DEFAULT to choose readline
5060: implementation. If your package really needs GNU readline library, its
5061: Makefile should include devel/readline/buildlink3.mk instead of
5062: readline.buildlink3.mk.
1.1 dsieger 5063:
1.184 rillig 5064: * oss.buildlink3.mk defines several variables that may be used by packages
5065: that use the Open Sound System (OSS) API.
1.1 dsieger 5066:
1.184 rillig 5067: * pgsql.buildlink3.mk will accept any of the Postgres versions in the
5068: variable PGSQL_VERSIONS_ACCEPTED and default to the version
5069: PGSQL_VERSION_DEFAULT. See the file for more information.
1.1 dsieger 5070:
1.184 rillig 5071: * pthread.buildlink3.mk uses the value of PTHREAD_OPTS and checks for native
5072: pthreads or adds a dependency on devel/pth as needed.
1.1 dsieger 5073:
1.184 rillig 5074: * xaw.buildlink3.mk uses the value of XAW_TYPE to choose a particular Athena
5075: widgets library.
1.1 dsieger 5076:
1.184 rillig 5077: The comments in those buildlink3.mk files provide a more complete description
5078: of how to use them properly.
1.1 dsieger 5079:
1.184 rillig 5080: 18.2. Writing buildlink3.mk files
1.1 dsieger 5081:
1.184 rillig 5082: A package's buildlink3.mk file is included by Makefiles to indicate the need to
5083: compile and link against header files and libraries provided by the package. A
5084: buildlink3.mk file should always provide enough information to add the correct
5085: type of dependency relationship and include any other buildlink3.mk files that
5086: it needs to find headers and libraries that it needs in turn.
1.1 dsieger 5087:
1.184 rillig 5088: To generate an initial buildlink3.mk file for further editing, Rene Hexel's
5089: pkgtools/createbuildlink package is highly recommended. For most packages, the
5090: following command will generate a good starting point for buildlink3.mk files:
1.1 dsieger 5091:
1.184 rillig 5092: % cd pkgsrc/category/pkgdir
5093: % createbuildlink >buildlink3.mk
1.1 dsieger 5094:
5095:
1.184 rillig 5096: 18.2.1. Anatomy of a buildlink3.mk file
1.1 dsieger 5097:
1.184 rillig 5098: The following real-life example buildlink3.mk is taken from pkgsrc/graphics/
5099: tiff:
1.14 jmcneill 5100:
1.184 rillig 5101: BUILDLINK_TREE+= tiff
1.1 dsieger 5102:
1.184 rillig 5103: .if !defined(TIFF_BUILDLINK3_MK)
5104: TIFF_BUILDLINK3_MK:=
1.1 dsieger 5105:
1.184 rillig 5106: BUILDLINK_API_DEPENDS.tiff+= tiff>=3.6.1
5107: BUILDLINK_ABI_DEPENDS.tiff+= tiff>=3.7.2nb1
5108: BUILDLINK_PKGSRCDIR.tiff?= ../../graphics/tiff
1.1 dsieger 5109:
1.184 rillig 5110: .include "../../devel/zlib/buildlink3.mk"
5111: .include "../../graphics/jpeg/buildlink3.mk"
5112: .endif # TIFF_BUILDLINK3_MK
1.1 dsieger 5113:
1.184 rillig 5114: BUILDLINK_TREE+= -tiff
1.1 dsieger 5115:
1.184 rillig 5116: The header and footer manipulate BUILDLINK_TREE, which is common across all
5117: buildlink3.mk files and is used to track the dependency tree.
1.1 dsieger 5118:
1.184 rillig 5119: The main section is protected from multiple inclusion and controls how the
5120: dependency on pkg is added. Several important variables are set in the section:
1.1 dsieger 5121:
1.185 wiz 5122: * BUILDLINK_API_DEPENDS.pkg is the dependency version recorded in the
1.184 rillig 5123: installed package; this should always be set using += to ensure that we're
5124: appending to any pre-existing list of values. This variable should be set
1.185 wiz 5125: to the last version of the package that had an backwards-incompatible API
1.184 rillig 5126: change.
1.1 dsieger 5127:
1.184 rillig 5128: * BUILDLINK_PKGSRCDIR.pkg is the location of the pkg pkgsrc directory.
1.1 dsieger 5129:
1.184 rillig 5130: * BUILDLINK_DEPMETHOD.pkg (not shown above) controls whether we use
1.236 gutterid 5131: BUILD_DEPENDS or DEPENDS to add the dependency on pkg. The build dependency
5132: is selected by setting BUILDLINK_DEPMETHOD.pkg to "build". By default, the
5133: full dependency is used.
1.1 dsieger 5134:
1.184 rillig 5135: * BUILDLINK_INCDIRS.pkg and BUILDLINK_LIBDIRS.pkg (not shown above) are lists
5136: of subdirectories of ${BUILDLINK_PREFIX.pkg} to add to the header and
5137: library search paths. These default to "include" and "lib" respectively.
1.1 dsieger 5138:
1.184 rillig 5139: * BUILDLINK_CPPFLAGS.pkg (not shown above) is the list of preprocessor flags
5140: to add to CPPFLAGS, which are passed on to the configure and build phases.
5141: The "-I" option should be avoided and instead be handled using
5142: BUILDLINK_INCDIRS.pkg as above.
1.66 asau 5143:
1.184 rillig 5144: The following variables are all optionally defined within this second section
5145: (protected against multiple inclusion) and control which package files are
5146: symlinked into ${BUILDLINK_DIR} and how their names are transformed during the
5147: symlinking:
1.23 jakllsch 5148:
1.184 rillig 5149: * BUILDLINK_FILES.pkg (not shown above) is a shell glob pattern relative to $
5150: {BUILDLINK_PREFIX.pkg} to be symlinked into ${BUILDLINK_DIR}, e.g. include/
5151: *.h.
1.1 dsieger 5152:
1.184 rillig 5153: * BUILDLINK_FILES_CMD.pkg (not shown above) is a shell pipeline that outputs
5154: to stdout a list of files relative to ${BUILDLINK_PREFIX.pkg}. The
5155: resulting files are to be symlinked into ${BUILDLINK_DIR}. By default, this
5156: takes the +CONTENTS of a pkg and filters it through $
5157: {BUILDLINK_CONTENTS_FILTER.pkg}.
1.1 dsieger 5158:
1.184 rillig 5159: * BUILDLINK_CONTENTS_FILTER.pkg (not shown above) is a filter command that
5160: filters +CONTENTS input into a list of files relative to $
5161: {BUILDLINK_PREFIX.pkg} on stdout. By default, BUILDLINK_CONTENTS_FILTER.pkg
5162: outputs the contents of the include and lib directories in the package
5163: +CONTENTS.
1.1 dsieger 5164:
1.184 rillig 5165: * BUILDLINK_FNAME_TRANSFORM.pkg (not shown above) is a list of sed arguments
5166: used to transform the name of the source filename into a destination
5167: filename, e.g. -e "s|/curses.h|/ncurses.h|g".
1.1 dsieger 5168:
1.184 rillig 5169: This section can additionally include any buildlink3.mk needed for pkg's
5170: library dependencies. Including these buildlink3.mk files means that the
5171: headers and libraries for these dependencies are also symlinked into $
5172: {BUILDLINK_DIR} whenever the pkg buildlink3.mk file is included. Dependencies
5173: are only added for directly include buildlink3.mk files.
1.1 dsieger 5174:
1.184 rillig 5175: When providing a buildlink3.mk and including other buildlink3.mk files in it,
5176: please only add necessary ones, i.e., those whose libraries or header files are
5177: automatically exposed when the package is use.
1.1 dsieger 5178:
1.184 rillig 5179: In particular, if only an executable (bin/foo) is linked against a library,
5180: that library does not need to be propagated in the buildlink3.mk file.
1.1 dsieger 5181:
1.184 rillig 5182: The following steps should help you decide if a buildlink3.mk file needs to be
5183: included:
1.1 dsieger 5184:
1.184 rillig 5185: * Look at the installed header files: What headers do they include? The
5186: packages providing these files must be buildlinked.
1.1 dsieger 5187:
1.184 rillig 5188: * Run ldd on all installed libraries and look against what other libraries
5189: they link. Some of the packages providing these probably need to be
5190: buildlinked; however, it's not automatic, since e.g. GTK on some systems
5191: pulls in the X libraries, so they will show up in the ldd output, while on
5192: others (like OS X) it won't. ldd output can thus only be used as a hint.
1.1 dsieger 5193:
1.184 rillig 5194: 18.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
5195: buildlink3.mk files
1.16 jnemeth 5196:
1.185 wiz 5197: Both variables set lower bounds for a version of this package. The two
5198: variables differ in that one describes source compatibility (API) and the other
5199: binary compatibility (ABI). The difference is that a change in the API breaks
5200: compilation of programs while changes in the ABI stop compiled programs from
5201: running.
5202:
5203: The BUILDLINK_API_DEPENDS.pkg variable in a buildlink3.mk should be changed
5204: very rarely. (One possible scenario: If all packages using this package need a
5205: higher version than defined in the buildlink3.mk, BUILDLINK_API_DEPENDS.pkg
5206: could be updated to that higher version.)
5207:
5208: On the other hand, changes to BUILDLINK_ABI_DEPENDS.pkg are more common. The
5209: variable will need to be updated every time the major version of one of its
5210: shared libraries is changed, or any other change where a binary built against
5211: the previous version of the package will not run against the new version any
5212: longer.
5213:
5214: In such a case, the package's BUILDLINK_ABI_DEPENDS.pkg must be increased to
5215: require the new package version. Then the PKGREVISION of all packages foo that
5216: depend on this package need to be increased, and if they have buildlink3.mk
5217: files, BUILDLINK_ABI_DEPENDS.foo in their buildlink3.mk files must be increased
5218: to the new version as well. This is required so that a package will pull in the
5219: versions of the packages that use the new ABI and that the packages'
5220: PKGREVISIONs uniquely identify the packages built against the new ABI. The
5221: pkgtools/revbump package can help with these updates.
1.1 dsieger 5222:
1.184 rillig 5223: See Section 21.1.5, "Handling dependencies" for more information about
1.185 wiz 5224: dependencies on other packages, including the BUILDLINK_API_DEPENDS
5225: definitions.
1.1 dsieger 5226:
1.184 rillig 5227: Please take careful consideration before adjusting BUILDLINK_API_DEPENDS.pkg or
1.185 wiz 5228: BUILDLINK_ABI_DEPENDS.pkg in a buildlink3.mk file as we don't want to cause
5229: unneeded package deletions and rebuilds. In many cases, new versions of
5230: packages work just fine with older dependencies.
1.1 dsieger 5231:
1.211 gutterid 5232: Also, it is not needed to set BUILDLINK_ABI_DEPENDS.pkg when it is identical to
1.184 rillig 5233: BUILDLINK_API_DEPENDS.pkg.
1.1 dsieger 5234:
1.211 gutterid 5235: Note there is also the distinction that users are able to disable enforcement
5236: of ABI dependencies using the USE_ABI_DEPENDS variable, but there is no
5237: equivalent option for API dependencies.
5238:
1.184 rillig 5239: 18.3. Writing builtin.mk files
1.1 dsieger 5240:
1.184 rillig 5241: Some packages in pkgsrc install headers and libraries that coincide with
5242: headers and libraries present in the base system. Aside from a buildlink3.mk
5243: file, these packages should also include a builtin.mk file that includes the
5244: necessary checks to decide whether using the built-in software or the pkgsrc
5245: software is appropriate.
1.1 dsieger 5246:
1.184 rillig 5247: The only requirements of a builtin.mk file for pkg are:
1.1 dsieger 5248:
1.184 rillig 5249: 1. It should set USE_BUILTIN.pkg to either "yes" or "no" after it is included.
1.1 dsieger 5250:
1.184 rillig 5251: 2. It should not override any USE_BUILTIN.pkg which is already set before the
5252: builtin.mk file is included.
1.1 dsieger 5253:
1.184 rillig 5254: 3. It should be written to allow multiple inclusion. This is very important
5255: and takes careful attention to Makefile coding.
1.1 dsieger 5256:
1.184 rillig 5257: 18.3.1. Anatomy of a builtin.mk file
1.1 dsieger 5258:
1.184 rillig 5259: The following is the recommended template for builtin.mk files:
1.1 dsieger 5260:
1.184 rillig 5261: .if !defined(IS_BUILTIN.foo)
5262: #
5263: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5264: # genuinely exists in the system or not.
5265: #
5266: IS_BUILTIN.foo?= no
1.1 dsieger 5267:
1.184 rillig 5268: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5269: # version can be determined.
5270: #
5271: . if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5272: BUILTIN_PKG.foo?= foo-1.0
5273: . endif
5274: .endif # IS_BUILTIN.foo
1.1 dsieger 5275:
1.184 rillig 5276: .if !defined(USE_BUILTIN.foo)
5277: USE_BUILTIN.foo?= ${IS_BUILTIN.foo}
5278: . if defined(BUILTIN_PKG.foo)
5279: . for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5280: . if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5281: USE_BUILTIN.foo!= \
5282: ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo} \
5283: && ${ECHO} "yes" || ${ECHO} "no"
5284: . endif
5285: . endfor
5286: . endif
5287: .endif # USE_BUILTIN.foo
1.1 dsieger 5288:
1.184 rillig 5289: CHECK_BUILTIN.foo?= no
5290: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5291: #
5292: # Here we place code that depends on whether USE_BUILTIN.foo is set to
5293: # "yes" or "no".
5294: #
5295: .endif # CHECK_BUILTIN.foo
1.1 dsieger 5296:
1.184 rillig 5297: The first section sets IS_BUILTIN.pkg depending on if pkg really exists in the
5298: base system. This should not be a base system software with similar
5299: functionality to pkg; it should only be "yes" if the actual package is included
5300: as part of the base system. This variable is only used internally within the
5301: builtin.mk file.
1.1 dsieger 5302:
1.184 rillig 5303: The second section sets BUILTIN_PKG.pkg to the version of pkg in the base
5304: system if it exists (if IS_BUILTIN.pkg is "yes"). This variable is only used
5305: internally within the builtin.mk file.
1.1 dsieger 5306:
1.184 rillig 5307: The third section sets USE_BUILTIN.pkg and is required in all builtin.mk files.
5308: The code in this section must make the determination whether the built-in
5309: software is adequate to satisfy the dependencies listed in
5310: BUILDLINK_API_DEPENDS.pkg. This is typically done by comparing BUILTIN_PKG.pkg
5311: against each of the dependencies in BUILDLINK_API_DEPENDS.pkg. USE_BUILTIN.pkg
5312: must be set to the correct value by the end of the builtin.mk file. Note that
5313: USE_BUILTIN.pkg may be "yes" even if IS_BUILTIN.pkg is "no" because we may make
5314: the determination that the built-in version of the software is similar enough
5315: to be used as a replacement.
1.1 dsieger 5316:
1.184 rillig 5317: The last section is guarded by CHECK_BUILTIN.pkg, and includes code that uses
5318: the value of USE_BUILTIN.pkg set in the previous section. This typically
5319: includes, e.g., adding additional dependency restrictions and listing
5320: additional files to symlink into ${BUILDLINK_DIR} (via BUILDLINK_FILES.pkg).
1.1 dsieger 5321:
1.184 rillig 5322: Chapter 19. PLIST issues
1.1 dsieger 5323:
1.184 rillig 5324: Table of Contents
1.1 dsieger 5325:
1.184 rillig 5326: 19.1. RCS ID
5327: 19.2. Semi-automatic PLIST generation
5328: 19.3. Tweaking output of make print-PLIST
5329: 19.4. Variable substitution in PLIST
5330: 19.5. Man page compression
5331: 19.6. Changing PLIST source with PLIST_SRC
5332: 19.7. Platform-specific and differing PLISTs
5333: 19.8. Build-specific PLISTs
5334: 19.9. Sharing directories between packages
1.1 dsieger 5335:
1.184 rillig 5336: The PLIST file contains a package's "packing list", i.e. a list of files that
5337: belong to the package (relative to the ${PREFIX} directory it's been installed
5338: in) plus some additional statements - see the pkg_create(1) man page for a full
5339: list. This chapter addresses some issues that need attention when dealing with
5340: the PLIST file (or files, see below!).
1.1 dsieger 5341:
1.184 rillig 5342: 19.1. RCS ID
1.1 dsieger 5343:
1.184 rillig 5344: Be sure to add a RCS ID line as the first thing in any PLIST file you write:
1.1 dsieger 5345:
1.184 rillig 5346: @comment $NetBSD $
1.1 dsieger 5347:
1.184 rillig 5348: An artificial space has been added between NetBSD and $, this is a workaround
5349: here to prevent CVS expanding to the filename of the guide. When adding the RCS
5350: ID the space should be omitted.
1.38 wiz 5351:
1.184 rillig 5352: 19.2. Semi-automatic PLIST generation
1.1 dsieger 5353:
1.184 rillig 5354: You can use the make print-PLIST command to output a PLIST that matches any new
5355: files since the package was extracted. See Section 13.17, "Other helpful
5356: targets" for more information on this target.
1.11 rillig 5357:
1.184 rillig 5358: 19.3. Tweaking output of make print-PLIST
1.1 dsieger 5359:
1.184 rillig 5360: The PRINT_PLIST_AWK variable takes a set of AWK patterns and actions that are
5361: used to filter the output of print-PLIST. You can append any chunk of AWK
5362: scripting you like to it, but be careful with quoting.
1.1 dsieger 5363:
1.184 rillig 5364: For example, to get all files inside the libdata/foo directory removed from the
5365: resulting PLIST:
1.1 dsieger 5366:
1.184 rillig 5367: PRINT_PLIST_AWK+= /^libdata\/foo/ { next; }
1.1 dsieger 5368:
1.185 wiz 5369: The PRINT_PLIST_AWK transformations are evaluated after the file list and
5370: directory list are sorted. EARLY_PRINT_PLIST_AWK is like PRINT_PLIST_AWK except
5371: it operates before the file list and directory list are sorted.
5372:
1.184 rillig 5373: 19.4. Variable substitution in PLIST
1.1 dsieger 5374:
1.184 rillig 5375: A number of variables are substituted automatically in PLISTs when a package is
5376: installed on a system. This includes the following variables:
1.1 dsieger 5377:
1.184 rillig 5378: ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}
1.1 dsieger 5379:
1.184 rillig 5380: Some packages like emacs and perl embed information about which
5381: architecture they were built on into the pathnames where they install their
5382: files. To handle this case, PLIST will be preprocessed before actually
5383: used, and the symbol "${MACHINE_ARCH}" will be replaced by what uname -p
5384: gives. The same is done if the string ${MACHINE_GNU_ARCH} is embedded in
5385: PLIST somewhere - use this on packages that have GNU autoconf-created
5386: configure scripts.
1.1 dsieger 5387:
1.184 rillig 5388: Legacy note
1.1 dsieger 5389:
1.184 rillig 5390: There used to be a symbol "$ARCH" that was replaced by the output of uname
5391: -m, but that's no longer supported and has been removed.
1.1 dsieger 5392:
1.184 rillig 5393: ${OPSYS}, ${LOWER_OPSYS}, ${OS_VERSION}
1.1 dsieger 5394:
1.184 rillig 5395: Some packages want to embed the OS name and version into some paths. To do
5396: this, use these variables in the PLIST:
1.1 dsieger 5397:
1.232 gutterid 5398: o ${OPSYS} - output of "uname -s"
1.1 dsieger 5399:
1.232 gutterid 5400: o ${LOWER_OPSYS} - lowercase common name (eg. "solaris")
1.1 dsieger 5401:
1.232 gutterid 5402: o ${OS_VERSION} - "uname -r"
1.1 dsieger 5403:
1.184 rillig 5404: For a list of values which are replaced by default, the output of make help
5405: topic=PLIST_SUBST as well as searching the pkgsrc/mk directory with grep for
5406: PLIST_SUBST should help.
1.1 dsieger 5407:
1.184 rillig 5408: If you want to change other variables not listed above, you can add variables
5409: and their expansions to this variable in the following way, similar to
5410: MESSAGE_SUBST (see Section 12.5, "Optional files"):
1.1 dsieger 5411:
1.184 rillig 5412: PLIST_SUBST+= SOMEVAR="somevalue"
1.1 dsieger 5413:
1.184 rillig 5414: This replaces all occurrences of "${SOMEVAR}" in the PLIST with "somevalue".
1.1 dsieger 5415:
1.184 rillig 5416: The PLIST_VARS variable can be used to simplify the common case of
5417: conditionally including some PLIST entries. It can be done by adding
5418: PLIST_VARS+=foo and setting the corresponding PLIST.foo variable to yes if the
5419: entry should be included. This will substitute "${PLIST.foo}" in the PLIST with
5420: either """" or ""@comment "". For example, in Makefile:
1.1 dsieger 5421:
1.184 rillig 5422: PLIST_VARS+= foo
5423: .if condition
5424: PLIST.foo= yes
5425: .else
1.1 dsieger 5426:
1.184 rillig 5427: And then in PLIST:
1.1 dsieger 5428:
1.184 rillig 5429: @comment $NetBSD $
5430: bin/bar
5431: man/man1/bar.1
5432: ${PLIST.foo}bin/foo
5433: ${PLIST.foo}man/man1/foo.1
5434: ${PLIST.foo}share/bar/foo.data
1.1 dsieger 5435:
1.184 rillig 5436: An artificial space has been added between NetBSD and $, this is a workaround
5437: here to prevent CVS expanding to the filename of the guide. When adding the RCS
1.195 gutterid 5438: ID the space should be omitted.
1.1 dsieger 5439:
1.184 rillig 5440: 19.5. Man page compression
1.1 dsieger 5441:
1.184 rillig 5442: Man pages should be installed in compressed form if MANZ is set (in
5443: bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the
5444: suffix ".gz" is appended/removed automatically for man pages according to MANZ
5445: and MANCOMPRESSED being set or not, see above for details. This modification of
5446: the PLIST file is done on a copy of it, not PLIST itself.
1.100 leot 5447:
1.184 rillig 5448: 19.6. Changing PLIST source with PLIST_SRC
1.100 leot 5449:
1.184 rillig 5450: To use one or more files as source for the PLIST used in generating the binary
5451: package, set the variable PLIST_SRC to the names of that file(s). The files are
5452: later concatenated using cat(1), and the order of things is important. The
5453: default for PLIST_SRC is ${PKGDIR}/PLIST.
1.1 dsieger 5454:
1.184 rillig 5455: 19.7. Platform-specific and differing PLISTs
1.1 dsieger 5456:
1.184 rillig 5457: Some packages decide to install a different set of files based on the operating
5458: system being used. These differences can be automatically handled by using the
5459: following files:
1.1 dsieger 5460:
1.184 rillig 5461: * PLIST.common
1.1 dsieger 5462:
1.184 rillig 5463: * PLIST.${OPSYS}
1.1 dsieger 5464:
1.184 rillig 5465: * PLIST.${MACHINE_ARCH}
1.1 dsieger 5466:
1.184 rillig 5467: * PLIST.${OPSYS}-${MACHINE_ARCH}
1.1 dsieger 5468:
1.184 rillig 5469: * PLIST.common_end
1.1 dsieger 5470:
1.184 rillig 5471: 19.8. Build-specific PLISTs
1.1 dsieger 5472:
1.184 rillig 5473: Some packages decide to generate hard-to-guess file names during installation
5474: that are hard to wire down.
1.1 dsieger 5475:
1.184 rillig 5476: In such cases, you can set the GENERATE_PLIST variable to shell code terminated
5477: (with a semicolon) that will output PLIST entries which will be appended to the
5478: PLIST
1.1 dsieger 5479:
1.184 rillig 5480: You can find one example in editors/xemacs:
1.1 dsieger 5481:
1.184 rillig 5482: GENERATE_PLIST+= ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
1.1 dsieger 5483:
1.184 rillig 5484: which will append something like bin/xemacs-21.4.23-54e8ea71.dmp to the PLIST.
1.1 dsieger 5485:
1.184 rillig 5486: 19.9. Sharing directories between packages
1.1 dsieger 5487:
1.184 rillig 5488: A "shared directory" is a directory where multiple (and unrelated) packages
5489: install files. These directories were problematic because you had to add
5490: special tricks in the PLIST to conditionally remove them, or have some
5491: centralized package handle them.
1.106 tnn 5492:
1.184 rillig 5493: In pkgsrc, it is now easy: Each package should create directories and install
5494: files as needed; pkg_delete will remove any directories left empty after
5495: uninstalling a package.
1.106 tnn 5496:
1.184 rillig 5497: If a package needs an empty directory to work, create the directory during
5498: installation as usual, and also add an entry to the PLIST:
1.1 dsieger 5499:
1.184 rillig 5500: @pkgdir path/to/empty/directory
1.1 dsieger 5501:
1.184 rillig 5502: or take a look at MAKE_DIRS and OWN_DIRS.
1.1 dsieger 5503:
1.184 rillig 5504: Chapter 20. The pkginstall framework
1.1 dsieger 5505:
1.184 rillig 5506: Table of Contents
1.1 dsieger 5507:
1.184 rillig 5508: 20.1. Files and directories outside the installation prefix
5509: 20.1.1. Directory manipulation
5510: 20.1.2. File manipulation
5511: 20.2. Configuration files
5512: 20.2.1. How PKG_SYSCONFDIR is set
5513: 20.2.2. Telling the software where configuration files are
1.239 dholland 5514: 20.2.3. Patching installation
5515: 20.2.4. Declaring configuration files
5516: 20.2.5. Disabling handling of configuration files
1.184 rillig 5517: 20.3. System startup scripts
5518: 20.3.1. Disabling handling of system startup scripts
5519: 20.4. System users and groups
5520: 20.5. System shells
5521: 20.5.1. Disabling shell registration
5522: 20.6. Fonts
5523: 20.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 5524:
1.184 rillig 5525: This chapter describes the framework known as pkginstall, whose key features
5526: are:
1.1 dsieger 5527:
1.184 rillig 5528: * Generic installation and manipulation of directories and files outside the
5529: pkgsrc-handled tree, LOCALBASE.
1.1 dsieger 5530:
1.184 rillig 5531: * Automatic handling of configuration files during installation, provided
5532: that packages are correctly designed.
1.1 dsieger 5533:
1.184 rillig 5534: * Generation and installation of system startup scripts.
1.1 dsieger 5535:
1.184 rillig 5536: * Registration of system users and groups.
1.1 dsieger 5537:
1.184 rillig 5538: * Registration of system shells.
1.1 dsieger 5539:
1.184 rillig 5540: * Automatic updating of fonts databases.
1.1 dsieger 5541:
1.184 rillig 5542: The following sections inspect each of the above points in detail.
1.1 dsieger 5543:
1.184 rillig 5544: You may be thinking that many of the things described here could be easily done
5545: with simple code in the package's post-installation target (post-install). This
5546: is incorrect, as the code in them is only executed when building from source.
5547: Machines using binary packages could not benefit from it at all (as the code
5548: itself could be unavailable). Therefore, the only way to achieve any of the
5549: items described above is by means of the installation scripts, which are
5550: automatically generated by pkginstall.
1.1 dsieger 5551:
1.184 rillig 5552: 20.1. Files and directories outside the installation prefix
1.95 wiz 5553:
1.184 rillig 5554: As you already know, the PLIST file holds a list of files and directories that
5555: belong to a package. The names used in it are relative to the installation
5556: prefix (${PREFIX}), which means that it cannot register files outside this
5557: directory (absolute path names are not allowed). Despite this restriction, some
5558: packages need to install files outside this location; e.g., under ${VARBASE} or
5559: ${PKG_SYSCONFDIR}. The only way to achieve this is to create such files during
5560: installation time by using installation scripts.
1.95 wiz 5561:
1.184 rillig 5562: The generic installation scripts are shell scripts that can contain arbitrary
5563: code. The list of scripts to execute is taken from the INSTALL_FILE variable,
5564: which defaults to INSTALL. A similar variable exists for package removal
5565: (DEINSTALL_FILE, whose default is DEINSTALL). These scripts can run arbitrary
5566: commands, so they have the potential to create and manage files anywhere in the
5567: file system.
1.95 wiz 5568:
1.184 rillig 5569: Using these general installation files is not recommended, but may be needed in
5570: some special cases. One reason for avoiding them is that the user has to trust
5571: the packager that there is no unwanted or simply erroneous code included in the
5572: installation script. Also, previously there were many similar scripts for the
5573: same functionality, and fixing a common error involved finding and changing all
5574: of them.
1.95 wiz 5575:
1.184 rillig 5576: The pkginstall framework offers another, standardized way. It provides generic
5577: scripts to abstract the manipulation of such files and directories based on
5578: variables set in the package's Makefile. The rest of this section describes
5579: these variables.
1.1 dsieger 5580:
1.184 rillig 5581: 20.1.1. Directory manipulation
1.1 dsieger 5582:
1.184 rillig 5583: The following variables can be set to request the creation of directories
5584: anywhere in the file system:
1.1 dsieger 5585:
1.184 rillig 5586: * MAKE_DIRS and OWN_DIRS contain a list of directories that should be created
5587: and should attempt to be destroyed by the installation scripts. The
5588: difference between the two is that the latter prompts the administrator to
5589: remove any directories that may be left after deinstallation (because they
5590: were not empty), while the former does not. Example:
1.1 dsieger 5591:
1.184 rillig 5592: MAKE_DIRS+= ${VARBASE}/foo/private
1.1 dsieger 5593:
1.184 rillig 5594: * MAKE_DIRS_PERMS and OWN_DIRS_PERMS contain a list of tuples describing
5595: which directories should be created and should attempt to be destroyed by
5596: the installation scripts. Each tuple holds the following values, separated
5597: by spaces: the directory name, its owner, its group and its numerical mode.
5598: For example:
1.1 dsieger 5599:
1.184 rillig 5600: MAKE_DIRS_PERMS+= ${VARBASE}/foo/private \
5601: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5602:
1.184 rillig 5603: The difference between the two is exactly the same as their non-PERMS
5604: counterparts.
1.1 dsieger 5605:
1.184 rillig 5606: 20.1.2. File manipulation
1.1 dsieger 5607:
1.184 rillig 5608: Creating non-empty files outside the installation prefix is tricky because the
5609: PLIST forces all files to be inside it. To overcome this problem, the only
1.239 dholland 5610: solution is to extract the file in a known place (i.e., inside the installation
5611: prefix) and copy it to the appropriate location during installation (done by
5612: the installation scripts generated by pkginstall). We will call the former the
5613: reference file in the following paragraphs, which describe the variables that
5614: can be used to automatically and consistently handle files outside the
5615: installation prefix:
5616:
5617: * REQD_FILES is a list of pairs of reference and target files. At
5618: installation time, the reference file is copied to the target if and only
5619: if the latter does not exist. Upon deinstallation, the reference file is
1.184 rillig 5620: removed provided that it was not modified by the installation.
1.1 dsieger 5621:
1.239 dholland 5622: * REQD_FILES_PERMS contains tuples describing reference files and targets,
5623: including owner, group, and numeric permissions that should be set. For
5624: example:
1.1 dsieger 5625:
1.184 rillig 5626: REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile \
5627: ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1 dsieger 5628:
1.239 dholland 5629: * CONF_FILES and CONF_FILES_PERMS have the same syntax as REQD_FILES and
5630: REQD_FILES_PERMS respectively. The difference is that these variables are
5631: specifically intended for handling configuration files, for which
5632: additional conventions and constraints apply. See Section 20.2,
5633: "Configuration files" for further discussion. Note in particular that while
5634: handling of configuration files can be disabled by the user (see
5635: Section 20.2.5, "Disabling handling of configuration files"), this setting
5636: does not affect REQD_FILES and REQD_FILES_PERMS.
5637:
5638: To install an empty file, one can use these macros and /dev/null as the
5639: reference file.
1.1 dsieger 5640:
1.184 rillig 5641: 20.2. Configuration files
1.1 dsieger 5642:
1.239 dholland 5643: There are two principles that govern the handling of configuration files in
5644: pkgsrc: first, the user's configuration must not be lost or overwritten by
5645: upgrades or reinstallations; and second, the default configuration should
5646: always be available for reference. To that end, pkgsrc has a framework
5647: specifically for handling configuration files. In general, configuration files
5648: are installed into ${PREFIX}/share/examples, and copied from there to the
5649: pertinent etc directory as a separate step and only as needed.
5650:
5651: To make this work, there are three things that need to happen, any of which may
5652: require patching. First, the package must be told to read its configuration
5653: from the correct place at runtime; this place is ${PKG_SYSCONFDIR} (or possibly
5654: a subdirectory of it) which is often but not always ${PREFIX}/etc. Second, the
5655: package must be taught to install its default configuration files in ${PREFIX}/
5656: share/examples/${PKGBASE}; this is the point at which patching often becomes
5657: required because it is not the same place as the runtime location. Third, the
5658: configuration files need to be declared in the package makefile; this is the
5659: easy part.
5660:
5661: With those elements in place, the right things will happen: the package install
5662: phase and resulting binary package will not touch ${PKG_SYSCONFDIR}, and the
5663: default configuration will be copied into place by the pkgsrc framework only if
5664: not already present. Similarly, upon deinstall the configuration will not be
5665: removed if it has been modified. (This means that in the case of reinstallation
5666: and upgrades, unmodified configuration files are updated but modifications are
5667: never discarded.)
5668:
5669: The following sections describe how to make these things happen and document
5670: other relevant knobs available in the pkgsrc infrastructure.
1.1 dsieger 5671:
1.184 rillig 5672: 20.2.1. How PKG_SYSCONFDIR is set
1.1 dsieger 5673:
1.184 rillig 5674: As said before, the PKG_SYSCONFDIR variable specifies where configuration files
5675: shall be installed. Its contents are set based upon the following variables:
1.1 dsieger 5676:
1.184 rillig 5677: * PKG_SYSCONFBASE: The configuration's root directory. Defaults to ${PREFIX}/
1.239 dholland 5678: etc although it may be overridden by the user to point to their preferred
1.184 rillig 5679: location (e.g., /etc, /etc/pkg, etc.). Packages must not use it directly.
1.1 dsieger 5680:
1.184 rillig 5681: * PKG_SYSCONFSUBDIR: A subdirectory of PKG_SYSCONFBASE under which the
5682: configuration files for the package being built shall be installed. The
5683: definition of this variable only makes sense in the package's Makefile
5684: (i.e., it is not user-customizable).
1.1 dsieger 5685:
1.184 rillig 5686: As an example, consider the Apache package, www/apache24, which places its
5687: configuration files under the httpd/ subdirectory of PKG_SYSCONFBASE. This
5688: should be set in the package Makefile.
1.1 dsieger 5689:
1.184 rillig 5690: * PKG_SYSCONFVAR: Specifies the name of the variable that holds this
5691: package's configuration directory (if different from PKG_SYSCONFBASE). It
5692: defaults to PKGBASE's value, and is always prefixed with PKG_SYSCONFDIR.
1.1 dsieger 5693:
1.184 rillig 5694: * PKG_SYSCONFDIR.${PKG_SYSCONFVAR}: Holds the directory where the
5695: configuration files for the package identified by PKG_SYSCONFVAR's shall be
5696: placed.
1.1 dsieger 5697:
1.184 rillig 5698: Based on the above variables, pkginstall determines the value of
1.239 dholland 5699: PKG_SYSCONFDIR, which is the only variable that may be used within a package to
1.184 rillig 5700: refer to its configuration directory. The algorithm used to set its value is
5701: basically the following:
1.1 dsieger 5702:
1.184 rillig 5703: 1. If PKG_SYSCONFDIR.${PKG_SYSCONFVAR} is set, its value is used.
1.1 dsieger 5704:
1.184 rillig 5705: 2. If the previous variable is not defined but PKG_SYSCONFSUBDIR is set in the
5706: package's Makefile, the resulting value is ${PKG_SYSCONFBASE}/$
5707: {PKG_SYSCONFSUBDIR}.
1.1 dsieger 5708:
1.184 rillig 5709: 3. Otherwise, it is set to ${PKG_SYSCONFBASE}.
1.1 dsieger 5710:
1.184 rillig 5711: It is worth mentioning that ${PKG_SYSCONFDIR} is automatically added to
1.239 dholland 5712: OWN_DIRS. This causes it to be automatically created if needed. See
5713: Section 20.1.1, "Directory manipulation" for further details. This does not
5714: apply to subdirectories of ${PKG_SYSCONFDIR}; they must be manually created
5715: with OWN_DIRS or MAKE_DIRS.
1.1 dsieger 5716:
1.184 rillig 5717: 20.2.2. Telling the software where configuration files are
1.1 dsieger 5718:
1.184 rillig 5719: Given that pkgsrc (and users!) expect configuration files to be in a known
1.239 dholland 5720: place, you need to teach each package where to install its files. In some cases
5721: you will have to patch the package Makefiles to achieve it. If you are lucky,
5722: though, it may be as easy as passing an extra flag to the configuration script.
5723: This is the case for packages using GNU autoconf:
1.1 dsieger 5724:
1.184 rillig 5725: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1 dsieger 5726:
1.184 rillig 5727: Note that this specifies where the package has to look for its configuration
1.239 dholland 5728: files, not where they will be installed. Fortunately, there is a different way
1.240 gutterid 5729: to specify the latter, as seen in the next section, although the combination is
5730: rather confusing at first glance.
1.1 dsieger 5731:
1.239 dholland 5732: 20.2.3. Patching installation
1.1 dsieger 5733:
1.239 dholland 5734: As discussed above, packages themselves must not touch the contents of $
1.184 rillig 5735: {PKG_SYSCONFDIR} directly. Bad news is that many software installation scripts
5736: will, out of the box, mess with the contents of that directory. So what is the
5737: correct procedure to fix this issue?
1.1 dsieger 5738:
1.184 rillig 5739: You must teach the package (usually by manually patching it) to install any
5740: configuration files under the examples hierarchy, share/examples/${PKGBASE}/.
5741: This way, the PLIST registers them and the administrator always has the
5742: original copies available.
1.1 dsieger 5743:
1.239 dholland 5744: It turns out that for packages using GNU autoconf it is possible to create the
5745: desired effect by setting sysconfdir on the make command line at install time.
5746: Consider this example taken from mail/mutt:
5747:
5748: EGDIR= ${PREFIX}/share/examples/mutt
5749: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
5750:
5751: Note that the EGDIR variable, though commonly used for this purpose, is local
5752: to that package and has no meaning outside it.
1.1 dsieger 5753:
1.239 dholland 5754: 20.2.4. Declaring configuration files
1.1 dsieger 5755:
1.239 dholland 5756: Once the required configuration files are in place (i.e., under the examples
5757: hierarchy), the pkginstall framework can use them as reference copies during
5758: the package installation to update what is in ${PKG_SYSCONFDIR}. To achieve
5759: this, the variables CONF_FILES and CONF_FILES_PERMS are used. Check out
5760: Section 20.1.2, "File manipulation" for further information about their syntax
5761: and their purpose. Here is an example, taken from the mail/mutt package:
5762:
5763: EGDIR= ${PREFIX}/share/examples/mutt
5764: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5765:
5766: Note that (as in the previous section's example) the EGDIR variable is specific
5767: to the package and has no meaning outside it.
5768:
5769: For reference, the complete example from Mutt is as follows:
5770:
5771: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5772: EGDIR= ${PREFIX}/share/examples/mutt
5773: CONF_FILES= ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
5774: INSTALLATION_DIRS+= ${EGDIR}
5775: INSTALL_MAKE_FLAGS= ${MAKE_FLAGS} sysconfdir=${EGDIR}
1.1 dsieger 5776:
1.239 dholland 5777: 20.2.5. Disabling handling of configuration files
1.1 dsieger 5778:
1.184 rillig 5779: The automatic copying of config files can be toggled by setting the environment
5780: variable PKG_CONFIG prior to package installation.
1.1 dsieger 5781:
1.184 rillig 5782: 20.3. System startup scripts
1.1 dsieger 5783:
1.184 rillig 5784: System startup scripts are special files because they must be installed in a
5785: place known by the underlying OS, usually outside the installation prefix.
5786: Therefore, the same rules described in Section 20.1, "Files and directories
5787: outside the installation prefix" apply, and the same solutions can be used.
5788: However, pkginstall provides a special mechanism to handle these files.
1.1 dsieger 5789:
1.184 rillig 5790: In order to provide system startup scripts, the package has to:
1.1 dsieger 5791:
1.184 rillig 5792: 1. Store the script inside ${FILESDIR}, with the .sh suffix appended.
1.223 nia 5793: Considering the print/cups-base package as an example, it has a cupsd.sh in
5794: its files directory.
1.95 wiz 5795:
1.184 rillig 5796: 2. Tell pkginstall to handle it, appending the name of the script, without its
5797: extension, to the RCD_SCRIPTS variable. Continuing the previous example:
1.95 wiz 5798:
1.184 rillig 5799: RCD_SCRIPTS+= cupsd
1.95 wiz 5800:
1.184 rillig 5801: Once this is done, pkginstall will do the following steps for each script in an
5802: automated fashion:
1.95 wiz 5803:
1.184 rillig 5804: 1. Process the file found in the files directory applying all the
5805: substitutions described in the FILES_SUBST variable.
1.1 dsieger 5806:
1.184 rillig 5807: 2. Copy the script from the files directory to the examples hierarchy, $
1.239 dholland 5808: {PREFIX}/share/examples/rc.d/. Note that this reference file must be
1.184 rillig 5809: explicitly registered in the PLIST.
1.1 dsieger 5810:
1.184 rillig 5811: 3. Add code to the installation scripts to copy the startup script from the
5812: examples hierarchy into the system-wide startup scripts directory.
1.1 dsieger 5813:
1.184 rillig 5814: 20.3.1. Disabling handling of system startup scripts
1.1 dsieger 5815:
1.184 rillig 5816: The automatic copying of config files can be toggled by setting the environment
5817: variable PKG_RCD_SCRIPTS prior to package installation. Note that the scripts
5818: will be always copied inside the examples hierarchy, ${PREFIX}/share/examples/
5819: rc.d/, no matter what the value of this variable is.
1.1 dsieger 5820:
1.184 rillig 5821: 20.4. System users and groups
1.1 dsieger 5822:
1.184 rillig 5823: If a package needs to create special users and/or groups during installation,
5824: it can do so by using the pkginstall framework.
1.1 dsieger 5825:
1.184 rillig 5826: Users can be created by adding entries to the PKG_USERS variable. Each entry
5827: has the following syntax:
1.1 dsieger 5828:
1.184 rillig 5829: user:group
1.1 dsieger 5830:
1.184 rillig 5831: Further specification of user details may be done by setting per-user
5832: variables. PKG_UID.user is the numeric UID for the user. PKG_GECOS.user is the
5833: user's description or comment. PKG_HOME.user is the user's home directory, and
5834: defaults to /nonexistent if not specified. PKG_SHELL.user is the user's shell,
5835: and defaults to /sbin/nologin if not specified.
1.1 dsieger 5836:
1.184 rillig 5837: Similarly, groups can be created by adding entries to the PKG_GROUPS variable,
5838: whose syntax is:
1.1 dsieger 5839:
1.184 rillig 5840: group
1.1 dsieger 5841:
1.184 rillig 5842: The numeric GID of the group may be set by defining PKG_GID.group.
1.1 dsieger 5843:
1.184 rillig 5844: If a package needs to create the users and groups at an earlier stage, then it
5845: can set USERGROUP_PHASE to either configure,build, or pre-install to indicate
5846: the phase before which the users and groups are created. In this case, the
5847: numeric UIDs and GIDs of the created users and groups are automatically
5848: hardcoded into the final installation scripts.
1.1 dsieger 5849:
1.184 rillig 5850: 20.5. System shells
1.1 dsieger 5851:
1.184 rillig 5852: Packages that install system shells should register them in the shell database,
5853: /etc/shells, to make things easier to the administrator. This must be done from
5854: the installation scripts to keep binary packages working on any system.
5855: pkginstall provides an easy way to accomplish this task.
1.1 dsieger 5856:
1.184 rillig 5857: When a package provides a shell interpreter, it has to set the PKG_SHELL
5858: variable to its absolute file name. This will add some hooks to the
5859: installation scripts to handle it. Consider the following example, taken from
5860: shells/zsh:
1.1 dsieger 5861:
1.184 rillig 5862: PKG_SHELL= ${PREFIX}/bin/zsh
1.1 dsieger 5863:
1.184 rillig 5864: 20.5.1. Disabling shell registration
1.1 dsieger 5865:
1.184 rillig 5866: The automatic registration of shell interpreters can be disabled by the
5867: administrator by setting the PKG_REGISTER_SHELLS environment variable to NO.
1.1 dsieger 5868:
1.184 rillig 5869: 20.6. Fonts
1.1 dsieger 5870:
1.184 rillig 5871: Packages that install X11 fonts should update the database files that index the
5872: fonts within each fonts directory. This can easily be accomplished within the
5873: pkginstall framework.
1.1 dsieger 5874:
1.184 rillig 5875: When a package installs X11 fonts, it must list the directories in which fonts
5876: are installed in the FONTS_DIRS.type variables, where type can be one of "ttf",
5877: "type1" or "x11". This will add hooks to the installation scripts to run the
5878: appropriate commands to update the fonts database files within each of those
5879: directories. For convenience, if the directory path is relative, it is taken to
5880: be relative to the package's installation prefix. Consider the following
5881: example, taken from fonts/dbz-ttf:
1.1 dsieger 5882:
1.184 rillig 5883: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1 dsieger 5884:
1.184 rillig 5885: 20.6.1. Disabling automatic update of the fonts databases
1.1 dsieger 5886:
1.184 rillig 5887: The automatic update of fonts databases can be disabled by the administrator by
5888: setting the PKG_UPDATE_FONTS_DB environment variable to NO.
1.1 dsieger 5889:
1.154 rillig 5890: Chapter 21. Making your package work
1.1 dsieger 5891:
5892: Table of Contents
5893:
1.154 rillig 5894: 21.1. General operation
5895: 21.1.1. How to pull in user-settable variables from mk.conf
5896: 21.1.2. User interaction
5897: 21.1.3. Handling licenses
5898: 21.1.4. Restricted packages
5899: 21.1.5. Handling dependencies
5900: 21.1.6. Handling conflicts with other packages
5901: 21.1.7. Packages that cannot or should not be built
5902: 21.1.8. Packages which should not be deleted, once installed
5903: 21.1.9. Handling packages with security problems
5904: 21.1.10. How to handle incrementing versions when fixing an existing
1.232 gutterid 5905: package
1.154 rillig 5906: 21.1.11. Substituting variable text in the package files (the SUBST
1.232 gutterid 5907: framework)
1.154 rillig 5908: 21.2. The fetch phase
5909: 21.2.1. Packages whose distfiles aren't available for plain downloading
5910: 21.2.2. How to handle modified distfiles with the 'old' name
5911: 21.2.3. Packages hosted on github.com
5912: 21.3. The configure phase
5913: 21.3.1. Shared libraries - libtool
5914: 21.3.2. Using libtool on GNU packages that already support libtool
5915: 21.3.3. GNU Autoconf/Automake
1.223 nia 5916: 21.3.4. Meson / ninja
1.154 rillig 5917: 21.4. Programming languages
5918: 21.4.1. C, C++, and Fortran
5919: 21.4.2. Java
1.205 wiz 5920: 21.4.3. Go
1.223 nia 5921: 21.4.4. Rust
5922: 21.4.5. Packages containing Perl scripts
5923: 21.4.6. Packages containing shell scripts
5924: 21.4.7. Other programming languages
1.154 rillig 5925: 21.5. The build phase
5926: 21.5.1. Compiling C and C++ code conditionally
5927: 21.5.2. How to handle compiler bugs
1.172 rillig 5928: 21.5.3. No such file or directory
5929: 21.5.4. Undefined reference to "..."
5930: 21.5.5. Running out of memory
1.154 rillig 5931: 21.6. The install phase
5932: 21.6.1. Creating needed directories
5933: 21.6.2. Where to install documentation
5934: 21.6.3. Installing highscore files
5935: 21.6.4. Adding DESTDIR support to packages
5936: 21.6.5. Packages with hardcoded paths to other interpreters
1.203 nia 5937: 21.6.6. Packages installing Perl modules
1.254 wiz 5938: 21.6.7. Packages installing pkg-config files
5939: 21.6.8. Packages installing info files
5940: 21.6.9. Packages installing man pages
5941: 21.6.10. Packages installing X11 fonts
5942: 21.6.11. Packages installing SGML or XML data
5943: 21.6.12. Packages installing extensions to the MIME database
5944: 21.6.13. Packages using intltool
5945: 21.6.14. Packages installing startup scripts
5946: 21.6.15. Packages installing TeX modules
5947: 21.6.16. Packages supporting running binaries in emulation
5948: 21.6.17. Packages installing hicolor icons
5949: 21.6.18. Packages installing desktop files
1.154 rillig 5950: 21.7. Marking packages as having problems
1.1 dsieger 5951:
1.154 rillig 5952: 21.1. General operation
1.1 dsieger 5953:
5954: One appealing feature of pkgsrc is that it runs on many different platforms. As
5955: a result, it is important to ensure, where possible, that packages in pkgsrc
5956: are portable. This chapter mentions some particular details you should pay
5957: attention to while working on pkgsrc.
5958:
1.154 rillig 5959: 21.1.1. How to pull in user-settable variables from mk.conf
1.1 dsieger 5960:
5961: The pkgsrc user can configure pkgsrc by overriding several variables in the
1.4 rillig 5962: file pointed to by MAKECONF, which is mk.conf by default. When you want to use
5963: those variables in the preprocessor directives of make(1) (for example .if or
5964: .for), you need to include the file ../../mk/bsd.prefs.mk before, which in turn
5965: loads the user preferences.
1.1 dsieger 5966:
5967: But note that some variables may not be completely defined after ../../mk/
5968: bsd.prefs.mk has been included, as they may contain references to variables
1.108 rillig 5969: that are not yet defined. In shell commands (the lines in Makefile that are
5970: indented with a tab) this is no problem, since variables are only expanded when
5971: they are used. But in the preprocessor directives mentioned above and in
5972: dependency lines (of the form target: dependencies) the variables are expanded
5973: at load time.
1.1 dsieger 5974:
5975: Note
5976:
1.108 rillig 5977: To check whether a variable can be used at load time, run pkglint -Wall on your
5978: package.
1.1 dsieger 5979:
1.154 rillig 5980: 21.1.2. User interaction
1.1 dsieger 5981:
5982: Occasionally, packages require interaction from the user, and this can be in a
5983: number of ways:
5984:
5985: * When fetching the distfiles, some packages require user interaction such as
5986: entering username/password or accepting a license on a web page.
5987:
5988: * When extracting the distfiles, some packages may ask for passwords.
5989:
5990: * help to configure the package before it is built
5991:
5992: * help during the build process
5993:
5994: * help during the installation of a package
5995:
1.108 rillig 5996: A package can set the INTERACTIVE_STAGE variable to define which stages need
5997: interaction. This should be done in the package's Makefile, e.g.:
1.1 dsieger 5998:
5999: INTERACTIVE_STAGE= configure install
6000:
6001: The user can then decide to skip this package by setting the BATCH variable.
1.108 rillig 6002: Packages that require interaction are also excluded from bulk builds.
1.1 dsieger 6003:
1.154 rillig 6004: 21.1.3. Handling licenses
1.1 dsieger 6005:
6006: Authors of software can choose the licence under which software can be copied.
1.111 sevan 6007: The Free Software Foundation has declared some licenses "Free", and the Open
6008: Source Initiative has a definition of "Open Source".
6009:
6010: By default, pkgsrc allows packages with Free or Open Source licenses to be
6011: built. To allow packages with other licenses to be built as well, the pkgsrc
6012: user needs to add these licenses to the ACCEPTABLE_LICENSES variable in mk.conf
6013: . Note that this variable only affects which packages may be built, while the
6014: license terms often also restrict the actual use of the package and its
6015: redistribution.
1.1 dsieger 6016:
6017: One might want to only install packages with a BSD license, or the GPL, and not
1.20 jnemeth 6018: the other. The free licenses are added to the default ACCEPTABLE_LICENSES
1.111 sevan 6019: variable. The pkgsrc user can override the default by setting the
6020: ACCEPTABLE_LICENSES variable with "=" instead of "+=". The licenses accepted by
6021: default are defined in the DEFAULT_ACCEPTABLE_LICENSES variable in the file
6022: pkgsrc/mk/license.mk.
1.1 dsieger 6023:
6024: The license tag mechanism is intended to address copyright-related issues
6025: surrounding building, installing and using a package, and not to address
1.20 jnemeth 6026: redistribution issues (see RESTRICTED and NO_SRC_ON_FTP, etc.). Packages with
6027: redistribution restrictions should set these tags.
1.1 dsieger 6028:
6029: Denoting that a package may be copied according to a particular license is done
6030: by placing the license in pkgsrc/licenses and setting the LICENSE variable to a
6031: string identifying the license, e.g. in graphics/xv:
6032:
6033: LICENSE= xv-license
6034:
6035: When trying to build, the user will get a notice that the package is covered by
6036: a license which has not been placed in the ACCEPTABLE_LICENSES variable:
6037:
6038: % make
6039: ===> xv-3.10anb9 has an unacceptable license: xv-license.
6040: ===> To view the license, enter "/usr/bin/make show-license".
6041: ===> To indicate acceptance, add this line to your /etc/mk.conf:
6042: ===> ACCEPTABLE_LICENSES+=xv-license
6043: *** Error code 1
6044:
6045: The license can be viewed with make show-license, and if the user so chooses,
1.4 rillig 6046: the line printed above can be added to mk.conf to convey to pkgsrc that it
1.1 dsieger 6047: should not in the future fail because of that license:
6048:
6049: ACCEPTABLE_LICENSES+=xv-license
6050:
1.111 sevan 6051: The use of LICENSE=shareware, LICENSE=no-commercial-use, and similar language
6052: is deprecated because it does not crisply refer to a particular license text.
6053: Another problem with such usage is that it does not enable a user to tell
6054: pkgsrc to proceed for a single package without also telling pkgsrc to proceed
6055: for all packages with that tag.
6056:
1.154 rillig 6057: 21.1.3.1. Adding a package with a new license
1.1 dsieger 6058:
1.49 rodent 6059: When adding a package with a new license, the following steps are required:
6060:
1.111 sevan 6061: 1. Check whether the license qualifies as Free or Open Source by referencing
6062: Various Licenses and Comments about Them and Licenses by Name | Open Source
6063: Initiative. If this is the case, the filename in pkgsrc/licenses/ does not
6064: need the -license suffix, and the license name should be added to:
1.49 rodent 6065:
6066: + DEFAULT_ACCEPTABLE_LICENSES in pkgsrc/mk/license.mk
6067:
6068: + default_acceptable_licenses in pkgsrc/pkgtools/pkg_install/files/lib/
6069: license.c
6070:
6071: 2. The license text should be added to pkgsrc/licenses for displaying. A list
6072: of known licenses can be seen in this directory.
1.1 dsieger 6073:
1.154 rillig 6074: 21.1.3.2. Change to the license
1.1 dsieger 6075:
1.111 sevan 6076: When the license changes (in a way other than formatting), make sure that the
6077: new license has a different name (e.g., append the version number if it exists,
6078: or the date). Just because a user told pkgsrc to build programs under a
6079: previous version of a license does not mean that pkgsrc should build programs
6080: under the new licenses. The higher-level point is that pkgsrc does not evaluate
6081: licenses for reasonableness; the only test is a mechanistic test of whether a
6082: particular text has been approved by either of two bodies (FSF or OSI).
1.1 dsieger 6083:
1.154 rillig 6084: 21.1.4. Restricted packages
1.1 dsieger 6085:
1.111 sevan 6086: Some licenses restrict how software may be re-distributed. By declaring the
6087: restrictions, package tools can automatically refrain from e.g. placing binary
6088: packages on FTP sites.
6089:
6090: There are four possible restrictions, which are the cross product of sources
6091: (distfiles) and binaries not being placed on FTP sites and CD-ROMs. Because
6092: this is rarely the exact language in any license, and because non-Free licenses
6093: tend to be different from each other, pkgsrc adopts a definition of FTP and
6094: CD-ROM. "FTP" means making the source or binary file available over the
6095: Internet at no charge. "CD-ROM" means making the source or binary available on
6096: some kind of media, together with other source and binary packages, which is
6097: sold for a distribution charge.
1.1 dsieger 6098:
6099: In order to encode these restrictions, the package system defines five make
6100: variables that can be set to note these restrictions:
6101:
6102: * RESTRICTED
6103:
6104: This variable should be set whenever a restriction exists (regardless of
6105: its kind). Set this variable to a string containing the reason for the
6106: restriction. It should be understood that those wanting to understand the
6107: restriction will have to read the license, and perhaps seek advice of
6108: counsel.
6109:
6110: * NO_BIN_ON_CDROM
6111:
6112: Binaries may not be placed on CD-ROM containing other binary packages, for
6113: which a distribution charge may be made. In this case, set this variable to
6114: ${RESTRICTED}.
6115:
6116: * NO_BIN_ON_FTP
6117:
6118: Binaries may not made available on the Internet without charge. In this
6119: case, set this variable to ${RESTRICTED}. If this variable is set, binary
6120: packages will not be included on ftp.NetBSD.org.
6121:
6122: * NO_SRC_ON_CDROM
6123:
6124: Distfiles may not be placed on CD-ROM, together with other distfiles, for
6125: which a fee may be charged. In this case, set this variable to $
6126: {RESTRICTED}.
6127:
6128: * NO_SRC_ON_FTP
6129:
6130: Distfiles may not made available via FTP at no charge. In this case, set
6131: this variable to ${RESTRICTED}. If this variable is set, the distfile(s)
6132: will not be mirrored on ftp.NetBSD.org.
6133:
1.111 sevan 6134: Please note that packages will be removed from pkgsrc when the distfiles are
1.33 wiz 6135: not distributable and cannot be obtained for a period of one full quarter
1.111 sevan 6136: branch. Packages with manual/interactive fetch must have a maintainer and it is
6137: his/her responsibility to ensure this.
1.33 wiz 6138:
1.154 rillig 6139: 21.1.5. Handling dependencies
1.1 dsieger 6140:
1.175 gutterid 6141: Your package may depend on some other package being present, and there are
6142: various ways of expressing this dependency. pkgsrc supports the DEPENDS,
6143: BUILD_DEPENDS, TOOL_DEPENDS, and TEST_DEPENDS definitions, the USE_TOOLS
6144: definition, as well as dependencies via buildlink3.mk, which is the preferred
6145: way to handle dependencies, and which uses the variables named above. See
1.184 rillig 6146: Chapter 18, Buildlink methodology for more information.
1.175 gutterid 6147:
6148: The basic difference is that the DEPENDS definition registers that
6149: pre-requisite in the binary package so it will be pulled in when the binary
6150: package is later installed, whilst the BUILD_DEPENDS, TOOL_DEPENDS, and
6151: TEST_DEPENDS definitions do not, marking a dependency that is only needed for
1.184 rillig 6152: building or testing the resulting package. See also Chapter 14, Creating a new
1.175 gutterid 6153: pkgsrc package from scratch for more information.
6154:
6155: This means that if you only need a package present whilst you are building or
6156: testing, it should be noted as a TOOL_DEPENDS, BUILD_DEPENDS, or TEST_DEPENDS.
6157: When cross-compiling, TOOL_DEPENDS are native packages, i.e. packages for the
6158: architecture where the package is built; BUILD_DEPENDS are target packages,
6159: i.e., packages for the architecture for which the package is built.
1.1 dsieger 6160:
1.175 gutterid 6161: The format for a DEPENDS, BUILD_DEPENDS, TOOL_DEPENDS, and TEST_DEPENDS
6162: definition is:
1.1 dsieger 6163:
6164: <pre-req-package-name>:../../<category>/<pre-req-package>
6165:
6166: Please note that the "pre-req-package-name" may include any of the wildcard
6167: version numbers recognized by pkg_info(1).
6168:
1.55 wiz 6169: 1. If your package needs another package's binaries or libraries to build and
1.1 dsieger 6170: run, and if that package has a buildlink3.mk file available, use it:
6171:
6172: .include "../../graphics/jpeg/buildlink3.mk"
6173:
1.55 wiz 6174: 2. If your package needs another package's binaries or libraries only for
6175: building, and if that package has a buildlink3.mk file available, use it:
6176:
6177: .include "../../graphics/jpeg/buildlink3.mk"
6178:
6179: but set BUILDLINK_DEPMETHOD.jpeg?=build to make it a build dependency only.
6180: This case is rather rare.
6181:
6182: 3. If your package needs binaries from another package to build, use the
1.156 leot 6183: TOOL_DEPENDS definition:
6184:
6185: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.1 dsieger 6186:
1.156 leot 6187: 4. If your package needs static libraries to link against, header files to
6188: include, etc. from another package to build, use the BUILD_DEPENDS
6189: definition.
1.1 dsieger 6190:
1.156 leot 6191: 5. If your package needs a library with which to link and there is no
1.26 spz 6192: buildlink3.mk file available, create one. Using DEPENDS won't be sufficient
6193: because the include files and libraries will be hidden from the compiler.
1.1 dsieger 6194:
1.156 leot 6195: 6. If your package needs some executable to be able to run correctly and if
1.26 spz 6196: there's no buildlink3.mk file, this is specified using the DEPENDS
6197: variable. The print/lyx package needs to be able to execute the latex
1.129 wiz 6198: binary from the tex-latex-bin package when it runs, and that is specified:
1.1 dsieger 6199:
1.129 wiz 6200: DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.1 dsieger 6201:
1.175 gutterid 6202: 7. If your package includes a test suite that has extra dependencies only
6203: required for this purpose (frequently this can be run as a "make test"
6204: target), use the TEST_DEPENDS variable.
6205:
6206: 8. You can use wildcards in package dependencies. Note that such wildcard
1.26 spz 6207: dependencies are retained when creating binary packages. The dependency is
6208: checked when installing the binary package and any package which matches
6209: the pattern will be used. Wildcard dependencies should be used with care.
1.1 dsieger 6210:
6211: The "-[0-9]*" should be used instead of "-*" to avoid potentially ambiguous
6212: matches such as "tk-postgresql" matching a "tk-*" DEPENDS.
6213:
6214: Wildcards can also be used to specify that a package will only build
6215: against a certain minimum version of a pre-requisite:
6216:
1.26 spz 6217: DEPENDS+= ImageMagick>=6.0:../../graphics/ImageMagick
1.1 dsieger 6218:
1.26 spz 6219: This means that the package will build using version 6.0 of ImageMagick or
6220: newer. Such a dependency may be warranted if, for example, the command line
6221: options of an executable have changed.
6222:
1.183 wiz 6223: If you need to depend on minimum versions of libraries, set
6224: BUILDLINK_API_DEPENDS.pkg to the appropriate pattern before including its
6225: buildlink3.mk file, e.g.
6226:
6227: BUILDLINK_API_DEPENDS.jpeg+= jpeg>=9.0
6228: .include "../../graphics/jpeg/buildlink3.mk"
1.1 dsieger 6229:
6230: For security fixes, please update the package vulnerabilities file. See
1.154 rillig 6231: Section 21.1.9, "Handling packages with security problems" for more
1.1 dsieger 6232: information.
6233:
6234: If your package needs files from another package to build, add the relevant
6235: distribution files to DISTFILES, so they will be extracted automatically. See
6236: the print/ghostscript package for an example. (It relies on the jpeg sources
6237: being present in source form during the build.)
6238:
1.154 rillig 6239: 21.1.6. Handling conflicts with other packages
1.1 dsieger 6240:
1.226 gutterid 6241: Your package may conflict with other packages users might already have
6242: installed on their system, e.g., if your package installs the same set of files
1.227 wiz 6243: as another package in the pkgsrc tree.
1.1 dsieger 6244:
1.142 leot 6245: For example, x11/libXaw3d and x11/Xaw-Xpm install the same shared library, thus
6246: you set in pkgsrc/x11/libXaw3d/Makefile:
1.1 dsieger 6247:
1.142 leot 6248: CONFLICTS= Xaw-Xpm-[0-9]*
1.1 dsieger 6249:
1.142 leot 6250: and in pkgsrc/x11/Xaw-Xpm/Makefile:
1.1 dsieger 6251:
1.142 leot 6252: CONFLICTS= libXaw3d-[0-9]*
1.1 dsieger 6253:
1.142 leot 6254: pkg_add(1) is able to detect attempts to install packages that conflict with
6255: existing packages and abort. However, in many situations this is too late in
6256: the process. Binary package managers will not know about the conflict until
6257: they attempt to install the package after already downloading it and all its
6258: dependencies. Users may also waste time building a package and its dependencies
6259: only to find out at the end that it conflicts with another package they have
6260: installed.
6261:
6262: To avoid these issues CONFLICTS entries should be added in all cases where it
6263: is known that packages conflict with each other. These CONFLICTS entries are
6264: exported in pkg_summary(5) files and consumed by binary package managers to
6265: inform users that packages cannot be installed onto the target system.
1.1 dsieger 6266:
1.154 rillig 6267: 21.1.7. Packages that cannot or should not be built
1.1 dsieger 6268:
6269: There are several reasons why a package might be instructed to not build under
6270: certain circumstances. If the package builds and runs on most platforms, the
1.83 dholland 6271: exceptions should be noted with BROKEN_ON_PLATFORM. If the package builds and
6272: runs on a small handful of platforms, set BROKEN_EXCEPT_ON_PLATFORM instead.
6273: Both BROKEN_ON_PLATFORM and BROKEN_EXCEPT_ON_PLATFORM are OS triples
6274: (OS-version-platform) that can use glob-style wildcards.
6275:
1.114 maya 6276: If a package is not appropriate for some platforms (as opposed to merely
1.83 dholland 6277: broken), a different set of variables should be used as this affects failure
6278: reporting and statistics. If the package is appropriate for most platforms, the
6279: exceptions should be noted with NOT_FOR_PLATFORM. If the package is appropriate
6280: for only a small handful of platforms (often exactly one), set
6281: ONLY_FOR_PLATFORM instead. Both ONLY_FOR_PLATFORM and NOT_FOR_PLATFORM are OS
6282: triples (OS-version-platform) that can use glob-style wildcards.
1.1 dsieger 6283:
6284: Some packages are tightly bound to a specific version of an operating system,
6285: e.g. LKMs or sysutils/lsof. Such binary packages are not backwards compatible
6286: with other versions of the OS, and should be uploaded to a version specific
6287: directory on the FTP server. Mark these packages by setting OSVERSION_SPECIFIC
6288: to "yes". This variable is not currently used by any of the package system
6289: internals, but may be used in the future.
6290:
6291: If the package should be skipped (for example, because it provides
6292: functionality already provided by the system), set PKG_SKIP_REASON to a
6293: descriptive message. If the package should fail because some preconditions are
6294: not met, set PKG_FAIL_REASON to a descriptive message.
6295:
1.154 rillig 6296: 21.1.8. Packages which should not be deleted, once installed
1.1 dsieger 6297:
6298: To ensure that a package may not be deleted, once it has been installed, the
6299: PKG_PRESERVE definition should be set in the package Makefile. This will be
1.25 wiz 6300: carried into any binary package that is made from this pkgsrc entry. A "
6301: preserved" package will not be deleted using pkg_delete(1) unless the "-f"
1.1 dsieger 6302: option is used.
6303:
1.154 rillig 6304: 21.1.9. Handling packages with security problems
1.1 dsieger 6305:
1.247 wiz 6306: When a vulnerability is found, this should be noted in pkgsrc/doc/
6307: pkg-vulnerabilities. Entries in that file consist of three parts:
1.205 wiz 6308:
6309: * package version pattern
6310:
6311: * type of vulnerability (please cut'n'paste an existing one where possible)
6312:
6313: * URL providing additional information about the issue
6314:
6315: For the package version pattern please always use `<' to mark an upper bound
6316: (not `<='!). This will avoid possible problems due unrelated PKGREVISION bumps
6317: not related to security fixes. Lower bounds can be added too, using '>' or '>=
1.206 wiz 6318: '. For example, "foo>=1<1.2" would mark versions 1.0 (included) to 1.2
1.205 wiz 6319: (excluded) of "foo" as affected by the security issue.
6320:
6321: Entries should always be added at the bottom of the file.
6322:
6323: When fixing packages, please modify the upper bound of the corresponding entry.
6324: To continue the previous example, if a fix was backported to version 1.1nb2,
1.206 wiz 6325: change the previous pattern to "foo>=1<1.1nb2".
1.205 wiz 6326:
6327: To locally test a package version pattern against a PKGNAME you can use the
6328: pkg_admin pmatch command.
6329:
6330: The URL should be as permanent as possible and provide as much information
6331: about the issue as possible. CVE entries are preferred.
6332:
6333: After committing that file, ask pkgsrc-security@NetBSD.org to update the file
6334: on ftp.NetBSD.org.
1.1 dsieger 6335:
6336: After fixing the vulnerability by a patch, its PKGREVISION should be increased
6337: (this is of course not necessary if the problem is fixed by using a newer
1.32 wiz 6338: release of the software), and the pattern in the pkg-vulnerabilities file must
6339: be updated.
1.1 dsieger 6340:
6341: Also, if the fix should be applied to the stable pkgsrc branch, be sure to
6342: submit a pullup request!
6343:
6344: Binary packages already on ftp.NetBSD.org will be handled semi-automatically by
6345: a weekly cron job.
6346:
1.205 wiz 6347: In case a security issue is disputed, please contact
6348: pkgsrc-security@NetBSD.org.
6349:
1.154 rillig 6350: 21.1.10. How to handle incrementing versions when fixing an existing package
1.1 dsieger 6351:
6352: When making fixes to an existing package it can be useful to change the version
6353: number in PKGNAME. To avoid conflicting with future versions by the original
6354: author, a "nb1", "nb2", ... suffix can be used on package versions by setting
6355: PKGREVISION=1 (2, ...). The "nb" is treated like a "." by the package tools.
6356: e.g.
6357:
6358: DISTNAME= foo-17.42
6359: PKGREVISION= 9
6360:
6361: will result in a PKGNAME of "foo-17.42nb9". If you want to use the original
6362: value of PKGNAME without the "nbX" suffix, e.g. for setting DIST_SUBDIR, use
6363: PKGNAME_NOREV.
6364:
6365: When a new release of the package is released, the PKGREVISION should be
6366: removed, e.g. on a new minor release of the above package, things should be
6367: like:
6368:
6369: DISTNAME= foo-17.43
6370:
6371: PKGREVISION should be incremented for any non-trivial change in the resulting
6372: binary package. Without a PKGREVISION bump, someone with the previous version
6373: installed has no way of knowing that their package is out of date. Thus,
6374: changes without increasing PKGREVISION are essentially labeled "this is so
6375: trivial that no reasonable person would want to upgrade", and this is the rough
6376: test for when increasing PKGREVISION is appropriate. Examples of changes that
6377: do not merit increasing PKGREVISION are:
6378:
1.14 jmcneill 6379: * Changing HOMEPAGE, MAINTAINER, OWNER, or comments in Makefile.
1.1 dsieger 6380:
6381: * Changing build variables if the resulting binary package is the same.
6382:
6383: * Changing DESCR.
6384:
6385: * Adding PKG_OPTIONS if the default options don't change.
6386:
6387: Examples of changes that do merit an increase to PKGREVISION include:
6388:
6389: * Security fixes
6390:
6391: * Changes or additions to a patch file
6392:
6393: * Changes to the PLIST
6394:
1.12 weinem 6395: * A dependency is changed or renamed.
6396:
1.1 dsieger 6397: PKGREVISION must also be incremented when dependencies have ABI changes.
6398:
1.154 rillig 6399: 21.1.11. Substituting variable text in the package files (the SUBST framework)
1.1 dsieger 6400:
1.180 rillig 6401: When you want to replace the same text in multiple files, or multiple times in
6402: the same file, it is cumbersome to maintain a patch file for this. This is
6403: where the SUBST framework steps in. It provides an easy-to-use interface for
6404: replacing text in files. It just needs the following information:
1.172 rillig 6405:
1.180 rillig 6406: * In which phase of the package build cycle should the replacement happen?
1.172 rillig 6407:
1.180 rillig 6408: * In which files should the replacement happen?
1.172 rillig 6409:
6410: * Which text should be replaced with what?
6411:
1.180 rillig 6412: This information is encoded in a block of SUBST variables. A minimal example
6413: is:
6414:
6415: SUBST_CLASSES+= paths
6416: SUBST_STAGE.paths= pre-configure
6417: SUBST_FILES.paths= src/*.c
6418: SUBST_SED.paths= -e 's,/usr/local,${PREFIX},g'
6419:
6420: Translated into English, it means: In the pre-configure stage (that is, after
6421: applying the patches from the patches/ directory and before running the
6422: configure script and the portability check), replace the text /usr/local with
6423: the content of the variable PREFIX.
6424:
6425: Each SUBST block starts by appending an identifier to SUBST_CLASSES (note the +
6426: =). This identifier can be chosen freely by the package. If there should ever
6427: be duplicate identifiers, the pkgsrc infrastructure will catch this and fail
6428: early, so don't worry about name collisions.
6429:
6430: Except for SUBST_CLASSES, all variables in a SUBST block are parameterized
6431: using this identifier. In the remainder of this section, these parameterized
6432: variables are written as SUBST_STAGE.*.
6433:
6434: SUBST_CLASSES+= paths
6435: SUBST_STAGE.paths= pre-configure
6436: SUBST_MESSAGE.paths= Fixing absolute paths.
6437: SUBST_FILES.paths= src/*.c
6438: SUBST_FILES.paths+= scripts/*.sh
6439: SUBST_SED.paths= -e 's,"/usr/local,"${PREFIX},g'
6440: SUBST_SED.paths+= -e 's,"/var/log,"${VARBASE}/log,g'
6441: SUBST_VARS.paths= LOCALBASE PREFIX PKGVERSION
6442:
6443: To get a complete picture about the SUBST substitutions, run bmake
6444: show-all-subst. If something doesn't work as expected, run pkglint on the
6445: package, which detects several typical mistakes surrounding the SUBST blocks.
6446: For any questions that might remain after this, have a look at mk/subst.mk.
6447:
6448: 21.1.11.1. Choosing the time where the substitutions happen
6449:
6450: The SUBST_STAGE.* is one of {pre,do,post}-
6451: {extract,patch,configure,build,test,install}. Of these, pre-configure is used
6452: most often, by far. The most popular stages are, in chronological order:
6453:
6454: post-extract
6455:
6456: The substitutions are applied immediately after the distfiles are
6457: extracted. Running bmake extract on the package will leave no traces of the
6458: original files.
6459:
6460: When the substitution applies to files for which there is also a patch in
6461: the patches/ directory, this means that the patches will be computed based
6462: on the result of the substitution. When these patches are sent to the
6463: upstream maintainer later, to be fixed in the upstream package, these
6464: patches may no longer match what the upstream author is used to. Because of
6465: this, pre-configure is often a better choice.
6466:
6467: pre-configure
6468:
6469: The substitutions are applied after the patches from the patches/
6470: directory. This makes it possible to run bmake patch on the package, after
6471: which the patches can be edited using the tools pkgvi and mkpatches from
6472: the pkgtools/pkgdiff package.
6473:
6474: When updating the patches, it is helpful to explicitly separate the bmake
6475: patch from the bmake configure, and to only edit the patches between these
6476: commands. Otherwise the substitutions from the SUBST block will end up in
6477: the patch file. When this happens in really obvious ways, pkglint will
6478: complain about patches that contain a hard-coded /usr/pkg instead of the
6479: correct and intended @PREFIX@, but it can only detect these really obvious
6480: cases.
6481:
6482: do-configure
6483:
6484: This stage should only be used if the package defines a pre-configure
6485: action itself, and the substitution must happen after that. Typical
6486: examples are packages that use the pre-configure stage to regenerate the
6487: GNU configure script from configure.ac.
6488:
6489: post-configure
6490:
6491: This stage is used to fix up any mistakes by the configure stage.
6492:
6493: pre-build
6494:
6495: This stage should only be used for substitutions that are clearly related
6496: to building the package, not for fixing the configuration. Substitutions
6497: for pathnames (such as replacing /usr/local with ${PREFIX}) or user names
6498: (such as replacing @MY_USER@ with the actual username) belong in
6499: pre-configure or post-configure instead.
6500:
6501: post-build
6502:
6503: Just as with pre-build, this stage should only be used for substitutions
6504: that are clearly related to building the package, not for fixing the
6505: configuration. Substitutions for pathnames (such as replacing /usr/local
6506: with ${PREFIX}) or user names (such as replacing @MY_USER@ with the actual
6507: username) belong in pre-configure or post-configure instead.
6508:
6509: A typical use is to update pkg-config files to include the rpath compiler
6510: options.
6511:
6512: pre-install
6513:
6514: In general, the install phase should be as simple as possible. As with the
6515: pre-build and post-build stages, it should not be used to fix pathnames or
6516: user names, these belong in pre-configure instead. There are only few
6517: legitimate use cases for applying substitutions in this stage.
6518:
1.181 rillig 6519: 21.1.11.2. Choosing the files where the substitutions happen
1.180 rillig 6520:
6521: The SUBST_FILES.* variable contains a list of filename patterns. These patterns
6522: are relative to WRKSRC since that is where most substitutions happen. A typical
6523: example is:
6524:
6525: SUBST_FILES.path= Makefile */Makefile */*/Makefile *.[ch]
6526:
6527: The above patterns, especially the last, are quite broad. The SUBST
6528: implementation checks that each filename pattern that is mentioned here has an
6529: effect. For example, if none of the */*/Makefile files contains the patterns to
6530: be found and substituted, that filename pattern is redundant and should be left
1.181 rillig 6531: out. By default, the SUBST framework will complain with an error message. If
6532: the text to be substituted occurs in some of the files from a single pattern,
6533: but not in all of them, that is totally ok, and the SUBST framework will only
6534: print an INFO message for those files.
1.180 rillig 6535:
6536: If there is a good reason for having redundant filename patterns, set
1.181 rillig 6537: SUBST_NOOP_OK.* to yes.
1.180 rillig 6538:
6539: Another popular way of choosing the files for the substitutions is via a shell
6540: command, like this:
6541:
1.181 rillig 6542: C_FILES_CMD= cd ${WRKSRC} && ${FIND} . -name '*.c'
1.180 rillig 6543: SUBST_FILES.path= ${C_FILES_CMD:sh}
6544:
6545: The variable name C_FILES_CMD in this example is freely chosen and independent
6546: of the SUBST framework.
6547:
6548: In this variant, the SUBST_FILES.* variable lists each file individually.
6549: Thereby chances are higher that there are filename patterns in which no
6550: substitution happens. Since the SUBST framework cannot know whether the
6551: filename patterns in SUBST_FILES.* have been explicitly listed in the Makefile
6552: (where any redundant filename pattern would be suspicious) or been generated by
6553: a shell command (in which redundant filename patterns are more likely and to be
6554: expected), it will complain about these redundant filename patterns. Therefore,
6555: SUBST blocks that use a shell command to generate the list of filename patterns
6556: often need to set SUBST_NOOP_OK.* to yes.
6557:
6558: 21.1.11.3. Choosing what to substitute
6559:
6560: In most cases, the substitutions are given using one or more sed(1) commands,
6561: like this:
6562:
6563: SUBST_SED.path= -e 's|/usr/local|${PREFIX}|g'
6564:
6565: Each of the sed commands needs to be preceded by the -e option and should be
6566: specified on a line of its own, to avoid hiding short sed commands at the end
6567: of a line.
6568:
6569: Since the sed commands often contain shell metacharacters as the separator (the
6570: | in the above example), it is common to enclose them in single quotes.
6571:
6572: A common substitution is to replace placeholders of the form @VARNAME@ with
6573: their pkgsrc counterpart variable ${VARNAME}. A typical example is:
6574:
6575: SUBST_VARS.path= PREFIX
6576:
1.181 rillig 6577: This type of substitutions is typically done by the GNU configure scripts
6578: during the do-configure stage, but in some cases these need to be overridden.
6579: The same pattern is also used when a package defines patches that replace
6580: previously hard-coded paths like /usr/local with a @PREFIX@ placeholder first,
6581: which then gets substituted by the actual ${PREFIX} in the pre-configure stage.
6582: In many of these cases, it works equally well to just use the SUBST framework
6583: to directly replace /usr/local with ${PREFIX}, thereby omitting the
6584: intermediate patch file.
1.180 rillig 6585:
6586: If the above is not flexible enough, it is possible to not use sed at all for
6587: the substitution but to specify an entirely different command, like this:
6588:
6589: SUBST_FILTER_CMD.path= LC_ALL=C ${TR} -d '\r'
1.1 dsieger 6590:
1.180 rillig 6591: This is used for the few remaining packages in which the distributed files use
6592: Windows-style line endings that need to be converted to UNIX-style line
6593: endings.
1.1 dsieger 6594:
1.180 rillig 6595: 21.1.11.4. Other SUBST variables
1.172 rillig 6596:
1.180 rillig 6597: When a SUBST block is applied during a package build, a message is logged. The
6598: default message is fine for most purposes but can be overridden by setting
6599: SUBST_MESSAGE.* to an individual message.
1.1 dsieger 6600:
1.154 rillig 6601: 21.2. The fetch phase
1.1 dsieger 6602:
1.154 rillig 6603: 21.2.1. Packages whose distfiles aren't available for plain downloading
1.1 dsieger 6604:
6605: If you need to download from a dynamic URL you can set DYNAMIC_MASTER_SITES and
6606: a make fetch will call files/getsite.sh with the name of each file to download
6607: as an argument, expecting it to output the URL of the directory from which to
6608: download it. graphics/ns-cult3d is an example of this usage.
6609:
6610: If the download can't be automated, because the user must submit personal
6611: information to apply for a password, or must pay for the source, or whatever,
6612: you can set FETCH_MESSAGE to a list of lines that are displayed to the user
6613: before aborting the build. Example:
6614:
6615: FETCH_MESSAGE= "Please download the files"
6616: FETCH_MESSAGE+= " "${DISTFILES:Q}
6617: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
6618:
1.154 rillig 6619: 21.2.2. How to handle modified distfiles with the 'old' name
1.1 dsieger 6620:
6621: Sometimes authors of a software package make some modifications after the
6622: software was released, and they put up a new distfile without changing the
6623: package's version number. If a package is already in pkgsrc at that time, the
6624: checksum will no longer match. The contents of the new distfile should be
6625: compared against the old one before changing anything, to make sure the
6626: distfile was really updated on purpose, and that no trojan horse or so crept
6627: in. Please mention that the distfiles were compared and what was found in your
1.54 rodent 6628: commit message.
6629:
6630: Then, the correct way to work around this is to set DIST_SUBDIR to a unique
1.109 wiz 6631: directory name, usually based on PKGNAME_NOREV (but take care with python or
6632: ruby packages, where PKGNAME includes a variable prefix). All DISTFILES and
6633: PATCHFILES for this package will be put in that subdirectory of the local
1.154 rillig 6634: distfiles directory. (See Section 21.1.10, "How to handle incrementing versions
1.109 wiz 6635: when fixing an existing package" for more details.) In case this happens more
6636: often, PKGNAME can be used (thus including the nbX suffix) or a date stamp can
6637: be appended, like ${PKGNAME_NOREV}-YYYYMMDD.
1.54 rodent 6638:
6639: DIST_SUBDIR is also used when a distfile's name does not contain a version and
6640: the distfile is apt to change. In cases where the likelihood of this is very
6641: small, DIST_SUBDIR might not be required. Additionally, DIST_SUBDIR must not be
6642: removed unless the distfile name changes, even if a package is being moved or
6643: renamed.
6644:
6645: Do not forget regenerating the distinfo file after that, since it contains the
6646: DIST_SUBDIR path in the filenames. Also, increase the PKGREVISION if the
6647: installed package is different. Furthermore, a mail to the package's authors
6648: seems appropriate telling them that changing distfiles after releases without
6649: changing the file names is not good practice.
1.1 dsieger 6650:
1.154 rillig 6651: 21.2.3. Packages hosted on github.com
1.88 tnn 6652:
1.90 tnn 6653: Helper methods exist for packages hosted on github.com which will often have
6654: distfile names that clash with other packages, for example 1.0.tar.gz. Use one
6655: of the three recipes from below:
1.88 tnn 6656:
1.154 rillig 6657: 21.2.3.1. Fetch based on a tagged release
1.88 tnn 6658:
1.189 bacon 6659: If your distfile URL looks similar to https://github.com/username/example/
6660: archive/v1.0.zip, then you are packaging a tagged release.
1.88 tnn 6661:
1.189 bacon 6662: DISTNAME= example-1.0
1.90 tnn 6663: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 6664: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 6665: GITHUB_TAG= v${PKGVERSION_NOREV}
1.88 tnn 6666: EXTRACT_SUFX= .zip
6667:
1.230 gutterid 6668: Here, DISTNAME combined with use of GITHUB_TAG leads the file fetching
6669: infrastructure to save the resulting file locally as example-1.0.zip.
6670:
1.189 bacon 6671: 21.2.3.2. Fetch based on a specific commit before the first release
6672:
6673: If your distfile looks similar to https://github.com/username/example/archive/
6674: 988881adc9fc3655077dc2d4d757d480b5ea0e11 and is from a commit before the first
6675: release, then set the package version to 0.0.0.N, where N is the number of
6676: commits to the repository, and set GITHUB_TAG to the commit hash. This will
6677: (almost) ensure that the first tagged release will have a version greater than
6678: this one so that package upgrades will function properly.
6679:
6680: DISTNAME= example-0.0.0.347
6681: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
6682: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
6683: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
6684:
6685: 21.2.3.3. Fetch based on a specific commit after a release
1.88 tnn 6686:
1.189 bacon 6687: If your distfile looks similar to https://github.com/username/example/archive/
6688: 988881adc9fc3655077dc2d4d757d480b5ea0e11 and is from a commit after a release,
6689: then include the last release version and the commit count since that release
6690: in the package version and set GITHUB_TAG to the commit hash. The latest
6691: release and commit count are shown in the output of "git describe --tags":
6692:
6693: # git clone https://github.com/username/example
6694: # cd example
6695: # git describe --tags
6696: 1.2.3-5-g988881a
1.88 tnn 6697:
1.189 bacon 6698: DISTNAME= example-1.2.3.5
6699: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
6700: #GITHUB_PROJECT= example # can be omitted if same as DISTNAME
1.90 tnn 6701: GITHUB_TAG= 988881adc9fc3655077dc2d4d757d480b5ea0e11
1.88 tnn 6702:
1.189 bacon 6703: 21.2.3.4. Fetch based on release
1.88 tnn 6704:
1.189 bacon 6705: If your distfile URL looks similar to https://github.com/username/example/
6706: releases/download/rel-1.6/offensive-1.6.zip, then you are packaging a release.
1.88 tnn 6707:
1.90 tnn 6708: DISTNAME= offensive-1.6
1.88 tnn 6709: PKGNAME= ${DISTNAME:S/offensive/proper/}
1.90 tnn 6710: MASTER_SITES= ${MASTER_SITE_GITHUB:=username/}
1.189 bacon 6711: GITHUB_PROJECT= example
1.90 tnn 6712: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
6713: EXTRACT_SUFX= .zip
1.88 tnn 6714:
1.154 rillig 6715: 21.3. The configure phase
1.1 dsieger 6716:
1.154 rillig 6717: 21.3.1. Shared libraries - libtool
1.1 dsieger 6718:
6719: pkgsrc supports many different machines, with different object formats like
6720: a.out and ELF, and varying abilities to do shared library and dynamic loading
6721: at all. To accompany this, varying commands and options have to be passed to
6722: the compiler, linker, etc. to get the Right Thing, which can be pretty annoying
6723: especially if you don't have all the machines at your hand to test things. The
6724: devel/libtool pkg can help here, as it just "knows" how to build both static
6725: and dynamic libraries from a set of source files, thus being
6726: platform-independent.
6727:
6728: Here's how to use libtool in a package in seven simple steps:
6729:
6730: 1. Add USE_LIBTOOL=yes to the package Makefile.
6731:
6732: 2. For library objects, use "${LIBTOOL} --mode=compile ${CC}" in place of "$
6733: {CC}". You could even add it to the definition of CC, if only libraries are
6734: being built in a given Makefile. This one command will build both PIC and
6735: non-PIC library objects, so you need not have separate shared and
6736: non-shared library rules.
6737:
6738: 3. For the linking of the library, remove any "ar", "ranlib", and "ld
6739: -Bshareable" commands, and instead use:
6740:
6741: ${LIBTOOL} --mode=link \
6742: ${CC} -o ${.TARGET:.a=.la} \
6743: ${OBJS:.o=.lo} \
6744: -rpath ${PREFIX}/lib \
6745: -version-info major:minor
6746:
6747: Note that the library is changed to have a .la extension, and the objects
6748: are changed to have a .lo extension. Change OBJS as necessary. This
6749: automatically creates all of the .a, .so.major.minor, and ELF symlinks (if
6750: necessary) in the build directory. Be sure to include "-version-info",
6751: especially when major and minor are zero, as libtool will otherwise strip
6752: off the shared library version.
6753:
6754: From the libtool manual:
6755:
6756: So, libtool library versions are described by three integers:
6757:
6758: CURRENT
6759: The most recent interface number that this library implements.
6760:
6761: REVISION
6762: The implementation number of the CURRENT interface.
6763:
6764: AGE
6765: The difference between the newest and oldest interfaces that
6766: this library implements. In other words, the library implements
6767: all the interface numbers in the range from number `CURRENT -
6768: AGE' to `CURRENT'.
6769:
6770: If two libraries have identical CURRENT and AGE numbers, then the
6771: dynamic linker chooses the library with the greater REVISION number.
6772:
6773: The "-release" option will produce different results for a.out and ELF
1.25 wiz 6774: (excluding symlinks) in only one case. An ELF library of the form "
6775: libfoo-release.so.x.y" will have a symlink of "libfoo.so.x.y" on an a.out
1.1 dsieger 6776: platform. This is handled automatically.
6777:
6778: The "-rpath argument" is the install directory of the library being built.
6779:
6780: In the PLIST, include only the .la file, the other files will be added
6781: automatically.
6782:
6783: 4. When linking shared object (.so) files, i.e. files that are loaded via
6784: dlopen(3), NOT shared libraries, use "-module -avoid-version" to prevent
6785: them getting version tacked on.
6786:
6787: The PLIST file gets the foo.so entry.
6788:
6789: 5. When linking programs that depend on these libraries before they are
6790: installed, preface the cc(1) or ld(1) line with "${LIBTOOL} --mode=link",
6791: and it will find the correct libraries (static or shared), but please be
6792: aware that libtool will not allow you to specify a relative path in -L
6793: (such as "-L../somelib"), because it expects you to change that argument to
6794: be the .la file. e.g.
6795:
6796: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
6797:
6798: should be changed to:
6799:
6800: ${LIBTOOL} --mode=link ${CC} -o someprog ../somelib/somelib.la
6801:
6802: and it will do the right thing with the libraries.
6803:
6804: 6. When installing libraries, preface the install(1) or cp(1) command with "$
6805: {LIBTOOL} --mode=install", and change the library name to .la. e.g.
6806:
1.23 jakllsch 6807: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.1 dsieger 6808:
6809: This will install the static .a, shared library, any needed symlinks, and
6810: run ldconfig(8).
6811:
6812: 7. In your PLIST, include only the .la file (this is a change from previous
6813: behaviour).
6814:
1.154 rillig 6815: 21.3.2. Using libtool on GNU packages that already support libtool
1.1 dsieger 6816:
6817: Add USE_LIBTOOL=yes to the package Makefile. This will override the package's
6818: own libtool in most cases. For older libtool using packages, libtool is made by
6819: ltconfig script during the do-configure step; you can check the libtool script
6820: location by doing make configure; find work*/ -name libtool.
6821:
6822: LIBTOOL_OVERRIDE specifies which libtool scripts, relative to WRKSRC, to
6823: override. By default, it is set to "libtool */libtool */*/libtool". If this
6824: does not match the location of the package's libtool script(s), set it as
6825: appropriate.
6826:
6827: If you do not need *.a static libraries built and installed, then use
6828: SHLIBTOOL_OVERRIDE instead.
6829:
6830: If your package makes use of the platform-independent library for loading
6831: dynamic shared objects, that comes with libtool (libltdl), you should include
6832: devel/libltdl/buildlink3.mk.
6833:
6834: Some packages use libtool incorrectly so that the package may not work or build
6835: in some circumstances. Some of the more common errors are:
6836:
6837: * The inclusion of a shared object (-module) as a dependent library in an
6838: executable or library. This in itself isn't a problem if one of two things
6839: has been done:
6840:
6841: 1. The shared object is named correctly, i.e. libfoo.la, not foo.la
6842:
6843: 2. The -dlopen option is used when linking an executable.
6844:
6845: * The use of libltdl without the correct calls to initialisation routines.
6846: The function lt_dlinit() should be called and the macro
6847: LTDL_SET_PRELOADED_SYMBOLS included in executables.
6848:
1.154 rillig 6849: 21.3.3. GNU Autoconf/Automake
1.1 dsieger 6850:
6851: If a package needs GNU autoconf or automake to be executed to regenerate the
1.223 nia 6852: configure script and Makefile.in makefile templates from configure.ac and
6853: Makefile.am, then they should be executed in a pre-configure target:
1.1 dsieger 6854:
1.223 nia 6855: USE_TOOLS+= autoconf automake autoreconf
6856: GNU_CONFIGURE= yes
1.1 dsieger 6857: ...
6858:
6859: pre-configure:
1.223 nia 6860: set -e; cd ${WRKSRC} && autoreconf -fi
1.1 dsieger 6861: ...
6862:
1.223 nia 6863: Packages which use GNU Automake will sometimes require GNU Make (gmake in
6864: USE_TOOLS), but not always. Note that autoreconf only needs to be executed if
6865: configure.ac or Makefiles are modified, or configure is not present.
1.1 dsieger 6866:
6867: There are times when the configure process makes additional changes to the
6868: generated files, which then causes the build process to try to re-execute the
6869: automake sequence. This is prevented by touching various files in the configure
6870: stage. If this causes problems with your package you can set AUTOMAKE_OVERRIDE=
6871: NO in the package Makefile.
6872:
1.223 nia 6873: 21.3.4. Meson / ninja
6874:
6875: Packages using Meson to configure need to include:
6876:
6877: .include "../../devel/meson/build.mk"
6878:
6879: In nearly all cases (any program with dependencies), pkg-config needs to be
6880: added to USE_TOOLS. If the package installs translation files for non-English
6881: languages, also add msgfmt and xgettext:
6882:
6883: USE_TOOLS+= pkg-config msgfmt xgettext
6884:
6885: If any options need to be passed to Meson, use MESON_ARGS instead of
6886: CONFIGURE_ARGS:
6887:
6888: MESON_ARGS+= -Dx11=false
6889:
1.154 rillig 6890: 21.4. Programming languages
1.1 dsieger 6891:
1.154 rillig 6892: 21.4.1. C, C++, and Fortran
1.1 dsieger 6893:
1.244 gutterid 6894: Compilers for the C and C++ languages come with the NetBSD base system. By
1.223 nia 6895: default, pkgsrc assumes that a package is written in C and will hide all other
6896: compilers (via the wrapper framework, see Chapter 18, Buildlink methodology).
1.1 dsieger 6897:
1.243 gutterid 6898: To declare which languages should be made available through pkgsrc's compiler
6899: wrappers, use the USE_LANGUAGES variable. Allowed values currently are:
1.212 wiz 6900:
1.244 gutterid 6901: c, c++, fortran, fortran77, java, objc, obj-c++, and ada.
1.212 wiz 6902:
6903: (and any combination). The default is "c". Packages using GNU configure
6904: scripts, even if written in C++, usually need a C compiler for the configure
1.244 gutterid 6905: phase.
1.243 gutterid 6906:
1.250 jnemeth 6907: To declare which features a package requires from the compiler, set either
1.243 gutterid 6908: USE_CC_FEATURES or USE_CXX_FEATURES. Allowed values for USE_CC_FEATURES are
6909: currently:
6910:
6911: c11, c99, has_include
6912:
6913: Allowed values for USE_CXX_FEATURES are currently:
6914:
6915: c++11, c++14, c++17, c++20, has_include, regex, filesystem,
6916: charconv, parallelism_ts, unique_ptr, put_time,
6917: is_trivially_copy_constructible
1.1 dsieger 6918:
1.251 gutterid 6919: Note at present these variables only affect use of GCC, not other compilers.
6920:
1.244 gutterid 6921: Language variants like gnu99 and c++11 can be specified in FORCE_C_STD and
6922: FORCE_CXX_STD if the package does not explicitly set -std=... when compiling
6923: (i.e. the package assumes the compiler defaults to C++11 or some other
6924: standard). This is a common bug in upstream build systems.
6925:
6926: Allowed values for FORCE_C_STD are currently:
6927:
6928: c90, c99, c11, gnu90, gnu99, gnu11
6929:
6930: Allowed values for FORCE_CXX_STD are currently:
6931:
6932: c++03, c++11, c++14, c++17, c++20,
6933: gnu++03, gnu++11, gnu++14, gnu++17, gnu++20
6934:
1.251 gutterid 6935: Note at present these variables only affect use of GCC and Clang.
6936:
1.154 rillig 6937: 21.4.2. Java
1.1 dsieger 6938:
6939: If a program is written in Java, use the Java framework in pkgsrc. The package
6940: must include ../../mk/java-vm.mk. This Makefile fragment provides the following
6941: variables:
6942:
6943: * USE_JAVA defines if a build dependency on the JDK is added. If USE_JAVA is
6944: set to "run", then there is only a runtime dependency on the JDK. The
6945: default is "yes", which also adds a build dependency on the JDK.
6946:
6947: * Set USE_JAVA2 to declare that a package needs a Java2 implementation. The
6948: supported values are "yes", "1.4", and "1.5". "yes" accepts any Java2
6949: implementation, "1.4" insists on versions 1.4 or above, and "1.5" only
6950: accepts versions 1.5 or above. This variable is not set by default.
6951:
1.25 wiz 6952: * PKG_JAVA_HOME is automatically set to the runtime location of the used Java
6953: implementation dependency. It may be used to set JAVA_HOME to a good value
6954: if the program needs this variable to be defined.
6955:
1.205 wiz 6956: 21.4.3. Go
6957:
6958: If a program is written in Go and has any dependencies on other Go modules,
6959: have the package include ../../lang/go/go-module.mk.
6960:
6961: 1. Generate a list of those dependencies with make clean && make patch && make
6962: show-go-modules > go-modules.mk.
6963:
1.223 nia 6964: 2. Prepend .include "go-modules.mk" to any other .includes.
6965:
6966: 3. Incorporate these modules in distinfo with make makesum.
1.205 wiz 6967:
1.223 nia 6968: 21.4.4. Rust
1.205 wiz 6969:
1.223 nia 6970: If a program is written in Rust and uses Cargo to build, have the package
6971: include ../../lang/rust/cargo.mk.
1.205 wiz 6972:
1.223 nia 6973: 1. Generate a list of those dependencies with make CARGO_ARGS="build
6974: --release" build && make print-cargo-depends > cargo-depends.mk.
1.205 wiz 6975:
1.223 nia 6976: 2. Prepend .include "cargo-depends.mk" to any other .includes.
1.205 wiz 6977:
6978: 3. Incorporate these modules in distinfo with make makesum.
6979:
1.223 nia 6980: 21.4.5. Packages containing Perl scripts
1.1 dsieger 6981:
1.203 nia 6982: If your package contains interpreted Perl scripts, add "perl" to the USE_TOOLS
1.1 dsieger 6983: variable and set REPLACE_PERL to ensure that the proper interpreter path is
6984: set. REPLACE_PERL should contain a list of scripts, relative to WRKSRC, that
1.74 wiz 6985: you want adjusted. Every occurrence of */bin/perl in a she-bang line will be
1.210 gutterid 6986: replaced with the full path to the Perl executable.
1.1 dsieger 6987:
1.210 gutterid 6988: If a particular version of Perl is needed, set the PERL5_REQD variable to the
1.1 dsieger 6989: version number. The default is "5.0".
6990:
1.203 nia 6991: See Section 21.6.6, "Packages installing Perl modules" for information about
1.210 gutterid 6992: handling Perl modules.
6993:
6994: There is also the REPLACE_PERL6 variable for the language now known as Raku.
1.1 dsieger 6995:
1.223 nia 6996: 21.4.6. Packages containing shell scripts
1.41 wiz 6997:
6998: REPLACE_SH, REPLACE_BASH, REPLACE_CSH, and REPLACE_KSH can be used to replace
1.225 gutterid 6999: shell she-bangs in files. Please use the appropriate one, preferring REPLACE_SH
7000: when this shell is sufficient. Each should contain a list of scripts, relative
7001: to WRKSRC, that you want adjusted. Every occurrence of the matching shell in a
7002: she-bang line will be replaced with the full path to the shell executable. When
7003: using REPLACE_BASH, don't forget to add bash to USE_TOOLS.
1.41 wiz 7004:
1.223 nia 7005: 21.4.7. Other programming languages
1.1 dsieger 7006:
1.210 gutterid 7007: There are further similar REPLACE variables available, e.g., REPLACE_AWK for
7008: packages containing awk scripts, and REPLACE_R for R. These two, like the
1.211 gutterid 7009: others noted above, have their actions defined centrally in mk/configure/
7010: replace-interpreter.mk. Other languages define the actions of these variables
7011: within their own dedicated part of the tree, e.g., REPLACE_PHP is actioned in
1.245 gutterid 7012: lang/php/replace.mk, and REPLACE_PYTHON is actioned in lang/python/
1.211 gutterid 7013: application.mk. For other languages, consult the mk files found within their
1.216 gutterid 7014: specific directories (the naming convention varies), or check the list found in
7015: Appendix E, Help topics.
1.210 gutterid 7016:
7017: Currently, special handling for other languages varies in pkgsrc. If a compiler
7018: package provides a buildlink3.mk file, include that, otherwise just add a
7019: (build) dependency on the appropriate compiler package.
1.1 dsieger 7020:
1.154 rillig 7021: 21.5. The build phase
1.1 dsieger 7022:
7023: The most common failures when building a package are that some platforms do not
7024: provide certain header files, functions or libraries, or they provide the
7025: functions in a library that the original package author didn't know. To work
7026: around this, you can rewrite the source code in most cases so that it does not
7027: use the missing functions or provides a replacement function.
7028:
1.154 rillig 7029: 21.5.1. Compiling C and C++ code conditionally
1.1 dsieger 7030:
7031: If a package already comes with a GNU configure script, the preferred way to
7032: fix the build failure is to change the configure script, not the code. In the
7033: other cases, you can utilize the C preprocessor, which defines certain macros
7034: depending on the operating system and hardware architecture it compiles for.
7035: These macros can be queried using for example #if defined(__i386). Almost every
7036: operating system, hardware architecture and compiler has its own macro. For
7037: example, if the macros __GNUC__, __i386__ and __NetBSD__ are all defined, you
7038: know that you are using NetBSD on an i386 compatible CPU, and your compiler is
7039: GCC.
7040:
7041: The list of the following macros for hardware and operating system depends on
7042: the compiler that is used. For example, if you want to conditionally compile
7043: code on Solaris, don't use __sun__, as the SunPro compiler does not define it.
7044: Use __sun instead.
7045:
1.154 rillig 7046: 21.5.1.1. C preprocessor macros to identify the operating system
1.1 dsieger 7047:
1.223 nia 7048: To distinguish between specific NetBSD versions, you should use the following
7049: code.
7050:
7051: #ifdef __NetBSD__
7052: #include <sys/param.h>
7053: #if __NetBSD_Prereq__(9,99,17)
7054: /* use a newer feature */
7055: #else
7056: /* older code */
7057: #endif
7058: #endif
7059:
7060: #ifndef _WIN32
7061: /* Unix-like specific code */
7062: #endif
7063:
1.1 dsieger 7064: To distinguish between 4.4 BSD-derived systems and the rest of the world, you
7065: should use the following code.
7066:
7067: #include <sys/param.h>
7068: #if (defined(BSD) && BSD >= 199306)
7069: /* BSD-specific code goes here */
7070: #else
7071: /* non-BSD-specific code goes here */
7072: #endif
7073:
1.223 nia 7074: You can also test for the following macros:
1.1 dsieger 7075:
1.46 obache 7076: Cygwin __CYGWIN__
7077: DragonFly __DragonFly__
1.1 dsieger 7078: FreeBSD __FreeBSD__
1.46 obache 7079: Haiku __HAIKU__
1.1 dsieger 7080: Interix __INTERIX
7081: IRIX __sgi (TODO: get a definite source for this)
1.223 nia 7082: Linux __linux
1.83 dholland 7083: Mac OS X __APPLE__
1.46 obache 7084: MirBSD __MirBSD__ (__OpenBSD__ is also defined)
7085: Minix3 __minix
1.1 dsieger 7086: NetBSD __NetBSD__
7087: OpenBSD __OpenBSD__
7088: Solaris sun, __sun
7089:
1.154 rillig 7090: 21.5.1.2. C preprocessor macros to identify the hardware architecture
1.1 dsieger 7091:
7092: i386 i386, __i386, __i386__
1.223 nia 7093: x86-64 __amd64__, __x86_64__
7094: ARM __arm__
1.1 dsieger 7095: MIPS __mips
7096: SPARC sparc, __sparc
1.223 nia 7097: PowerPC __powerpc
1.1 dsieger 7098:
1.154 rillig 7099: 21.5.1.3. C preprocessor macros to identify the compiler
1.1 dsieger 7100:
7101: GCC __GNUC__ (major version), __GNUC_MINOR__
7102: MIPSpro _COMPILER_VERSION (0x741 for MIPSpro 7.41)
7103: SunPro __SUNPRO_C (0x570 for Sun C 5.7)
7104: SunPro C++ __SUNPRO_CC (0x580 for Sun C++ 5.8)
7105:
1.154 rillig 7106: 21.5.2. How to handle compiler bugs
1.1 dsieger 7107:
7108: Some source files trigger bugs in the compiler, based on combinations of
7109: compiler version and architecture and almost always relation to optimisation
7110: being enabled. Common symptoms are gcc internal errors or never finishing
7111: compiling a file.
7112:
7113: Typically, a workaround involves testing the MACHINE_ARCH and compiler version,
1.87 tnn 7114: disabling optimisation for that combination of file, MACHINE_ARCH and compiler.
7115:
7116: This used to be a big problem in the past, but is rarely needed now as compiler
7117: technology has matured. If you still need to add a compiler specific
7118: workaround, please do so in the file hacks.mk and describe the symptom and
7119: compiler version as detailed as possible.
1.1 dsieger 7120:
1.172 rillig 7121: 21.5.3. No such file or directory
7122:
7123: Compilation sometimes fails with an error message like this:
7124:
7125: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
7126: fatal error: pango/pango.h: No such file or directory
7127:
7128: The proper way to fix this problem depends on the type of the header, which is
7129: described in the following sections.
7130:
7131: 21.5.3.1. Headers from other packages
7132:
7133: If the header name looks like it comes from a different package, that other
7134: package should be included via the buildlink3 framework.
7135:
7136: First, look whether the header is somewhere in the buildlink3 directory below
7137: WRKDIR. In the above case of the missing Pango header:
7138:
7139: $ find work/.buildlink/ -print | grep -F pango/pango.h
7140:
7141: In the case of Pango, the output is:
7142:
7143: work/.buildlink/include/pango-1.0/pango/pango.h
7144:
7145: If the pango/pango.h file were placed directly in the .buildlink directory, it
7146: would have been found automatically. There is an extra pango-1.0 path component
7147: though, which means that the compiler command line must contain an option of
7148: the form -I${BUILDLINK3_PREFIX.pango}/include/pango-1.0. In most cases this
7149: option is generated by the configure script, which can be examined using:
7150:
7151: $ $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
7152: -I/usr/pkg/include/pango-1.0
7153: -I/usr/pkg/include/pango-1.0
7154: -I/usr/pkg/include/pango-1.0
7155: -I/usr/pkg/include/pango-1.0
7156: -I/usr/pkg/include/pango-1.0
7157:
7158: This looks good. These options are transformed by the buildlink wrapper to
7159: refer to the correct path inside work/.buildlink.
7160:
7161: Since the compilation fails though, examine the compiler command lines in work
7162: /.work.log to see whether the -I option is included in the particular command
7163: line.
7164:
7165: To further analyze the situation, run bmake build-env, which sets up an
7166: interactive, realistic environment including all the pkgsrc wrapper commands
7167: and environment variables. From there, try to compile some simple example
7168: programs that use the header.
7169:
7170: 21.5.3.2. Headers generated during the build
7171:
7172: If the name of the header seems to come from the package itself, and if the
7173: build is run with parallel jobs, the package may have some undeclared
7174: dependencies between the .c and the .h files, and a C file is compiled before
7175: its required header is generated.
7176:
7177: To see whether the build runs with parallel jobs, run bmake show-all-build |
7178: grep JOBS. Its output looks like this:
7179:
7180: usr MAKE_JOBS= 7
7181: pkg MAKE_JOBS_SAFE # undefined
7182: def _MAKE_JOBS_N= 7
7183:
7184: In this case the pkgsrc user has asked pkgsrc to build packages with 7 jobs in
7185: parallel (MAKE_JOBS). The package could have disabled parallel builds by
7186: setting MAKE_JOBS_SAFE to no, but in this case it hasn't.
7187:
7188: To see whether the build failure is caused by parallel builds, first save the
7189: exact error message and a bit of context, maybe you need it later for reporting
7190: a bug. Next, run:
7191:
7192: MAKE_JOBS_SAFE=no bmake clean build
7193:
7194: If that succeeds, file a bug report against the pkgsrc package, including the
7195: exact error message and the contents of your mk.conf file.
7196:
1.173 rillig 7197: 21.5.3.3. Symlinks
7198:
7199: Pkgsrc does not work reliably if any of LOCALBASE, VARBASE or WRKDIR contains a
7200: symlink. Since 2019Q2, the pkgsrc bootstrap program prevents installing pkgsrc
7201: in symlink-based directories. Existing pkgsrc installations are not checked for
7202: symlinks though.
7203:
7204: The "No such file or directory" error messages are a typical symptom of
7205: symlinks, and it's quite difficult to find out that this is the actual cause.
7206:
7207: 21.5.3.4. Stale working directories
7208:
7209: When building a hierarchy of packages, it may happen that one package is built
7210: and then pkgsrc is updated. This situation can provoke various hard to diagnose
7211: build errors. To clean up the situation:
7212:
1.223 nia 7213: $ (cd ../../ && cat mk/bsd.pkg.mk >/dev/null && rm -rf */*/work)
1.173 rillig 7214:
1.223 nia 7215: (The only purpose of the bsd.pkg.mk is to prevent running this command in the
7216: wrong directory.)
1.173 rillig 7217:
7218: If you have set WRKOBJDIR in mk.conf, remove that directory as well.
7219:
7220: 21.5.3.5. Other possible reasons
7221:
7222: On platforms other than BSD, third-party packages are installed in /usr/
7223: include, together with the base system. This means that pkgsrc cannot
7224: distinguish between headers provided by the base system (which it needs) and
7225: headers from third-party packages (which are often included in pkgsrc as well).
7226: This can lead to subtle version mismatches.
7227:
7228: In pkgsrc installations that have been active for several years, it may happen
7229: that some files are manually deleted. To exclude this unlikely reason, run
7230: pkg_admin check.
7231:
7232: It may help to run pkg_admin rebuild-tree to check/fix dependencies.
7233:
7234: If all of the above doesn't help, see Chapter 2, Getting help for contact
7235: information. Be prepared to describe what you have tried so far and what any
7236: error messages were.
7237:
1.172 rillig 7238: 21.5.4. Undefined reference to "..."
1.1 dsieger 7239:
7240: This error message often means that a package did not link to a shared library
7241: it needs. The following functions are known to cause this error message over
7242: and over.
7243:
7244: +-----------------------------------------------------+
7245: | Function |Library |Affected platforms|
7246: |-------------------------+--------+------------------|
7247: |accept, bind, connect |-lsocket|Solaris |
7248: |-------------------------+--------+------------------|
7249: |crypt |-lcrypt |DragonFly, NetBSD |
7250: |-------------------------+--------+------------------|
7251: |dlopen, dlsym |-ldl |Linux |
7252: |-------------------------+--------+------------------|
7253: |gethost* |-lnsl |Solaris |
7254: |-------------------------+--------+------------------|
7255: |inet_aton |-lresolv|Solaris |
7256: |-------------------------+--------+------------------|
7257: |nanosleep, sem_*, timer_*|-lrt |Solaris |
7258: |-------------------------+--------+------------------|
7259: |openpty |-lutil |Linux |
7260: +-----------------------------------------------------+
7261:
1.223 nia 7262: To fix these linker errors, it is often sufficient to add LIBS.OperatingSystem+
7263: = -lfoo to the package Makefile and then run bmake clean; bmake.
1.1 dsieger 7264:
1.223 nia 7265: 21.5.4.1. The SunPro compiler and inline functions
1.1 dsieger 7266:
7267: When you are using the SunPro compiler, there is another possibility. That
7268: compiler cannot handle the following code:
7269:
7270: extern int extern_func(int);
7271:
7272: static inline int
7273: inline_func(int x)
7274: {
7275: return extern_func(x);
7276: }
7277:
7278: int main(void)
7279: {
7280: return 0;
7281: }
7282:
7283: It generates the code for inline_func even if that function is never used. This
7284: code then refers to extern_func, which can usually not be resolved. To solve
7285: this problem you can try to tell the package to disable inlining of functions.
7286:
1.228 gutterid 7287: 21.5.4.2. Missing atomic functions
7288:
7289: When building for older machine architectures (e.g., i386, PowerPC), builds may
7290: fail because the package expects modern 64-bit atomic functions which the
7291: underlying hardware either doesn't support, or will only support with specific
7292: compiler flags. This is generally handled via inclusion of mk/atomic64.mk.
7293:
1.172 rillig 7294: 21.5.5. Running out of memory
1.1 dsieger 7295:
7296: Sometimes packages fail to build because the compiler runs into an operating
7297: system specific soft limit. With the UNLIMIT_RESOURCES variable pkgsrc can be
1.223 nia 7298: told to unlimit the resources. The allowed values are any combination of "
7299: cputime", "datasize", "memorysize", "stacksize" and "virtualsize". Setting this
7300: variable is similar to running the shell builtin ulimit command to raise the
7301: maximum data segment size or maximum stack size of a process, respectively, to
7302: their hard limits.
1.1 dsieger 7303:
1.154 rillig 7304: 21.6. The install phase
1.1 dsieger 7305:
1.154 rillig 7306: 21.6.1. Creating needed directories
1.1 dsieger 7307:
7308: The BSD-compatible install supplied with some operating systems cannot create
7309: more than one directory at a time. As such, you should call ${INSTALL_*_DIR}
7310: like this:
7311:
7312: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
7313: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
7314:
1.223 nia 7315: Instead of running the install commands directly, you can also append "dir1
7316: dir2" to the INSTALLATION_DIRS variable, which will automatically do the right
7317: thing.
1.1 dsieger 7318:
1.154 rillig 7319: 21.6.2. Where to install documentation
1.1 dsieger 7320:
7321: In general, documentation should be installed into ${PREFIX}/share/doc/$
1.223 nia 7322: {PKGBASE} or ${PREFIX}/share/doc/${PKGNAME_NOREV} (the latter includes the
7323: version number of the package).
1.1 dsieger 7324:
7325: Many modern packages using GNU autoconf allow to set the directory where HTML
7326: documentation is installed with the "--with-html-dir" option. Sometimes using
7327: this flag is needed because otherwise the documentation ends up in ${PREFIX}/
1.223 nia 7328: share/doc/html or other places. In pkgsrc, the HTML documentation should go
7329: into the package-specific directory, just like any other documentation.
1.1 dsieger 7330:
7331: An exception to the above is that library API documentation generated with the
7332: textproc/gtk-doc tools, for use by special browsers (devhelp) should be left at
7333: their default location, which is ${PREFIX}/share/gtk-doc. Such documentation
7334: can be recognized from files ending in .devhelp or .devhelp2. (It is also
7335: acceptable to install such files in ${PREFIX}/share/doc/${PKGBASE} or ${PREFIX}
7336: /share/doc/${PKGNAME}; the .devhelp* file must be directly in that directory
7337: then, no additional subdirectory level is allowed in this case. This is usually
7338: achieved by using "--with-html-dir=${PREFIX}/share/doc". ${PREFIX}/share/
7339: gtk-doc is preferred though.)
7340:
1.154 rillig 7341: 21.6.3. Installing highscore files
1.1 dsieger 7342:
7343: Certain packages, most of them in the games category, install a score file that
7344: allows all users on the system to record their highscores. In order for this to
7345: work, the binaries need to be installed setgid and the score files owned by the
1.36 wiz 7346: appropriate group and/or owner (traditionally the "games" user/group). Set
7347: USE_GAMESGROUP to yes to support this. The following variables, documented in
7348: more detail in mk/defaults/mk.conf, control this behaviour: GAMEDATAMODE,
1.100 leot 7349: GAMEDIRMODE, GAMES_GROUP, GAMEMODE, GAME_USER. Other useful variables are:
7350: GAMEDIR_PERMS, GAMEDATA_PERMS and SETGID_GAMES_PERMS.
7351:
7352: An example that illustrates some of the variables described above is games/
7353: moon-buggy. OWN_DIRS_PERMS is used to properly set directory permissions of the
7354: directory where the scorefile is saved, REQD_FILES_PERMS is used to create a
7355: dummy scorefile (mbscore) with the proper permissions and SPECIAL_PERMS is used
7356: to install setgid the game binary:
7357:
7358: USE_GAMESGROUP= yes
7359:
7360: BUILD_DEFS+= VARBASE
7361:
7362: OWN_DIRS_PERMS+= ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
7363: REQD_FILES_PERMS+= /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
7364: SPECIAL_PERMS+= ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
7365:
7366: Various INSTALL_* variables are also available: INSTALL_GAME to install setgid
7367: game binaries, INSTALL_GAME_DIR to install game directories that are needed to
7368: be accessed by setgid games and INSTALL_GAME_DATA to install scorefiles.
1.1 dsieger 7369:
1.14 jmcneill 7370: A package should therefore never hard code file ownership or access permissions
1.100 leot 7371: but rely on *_PERMS as described above or alternatively on INSTALL_GAME,
7372: INSTALL_GAME_DATA and INSTALL_GAME_DIR to set these correctly.
1.1 dsieger 7373:
1.154 rillig 7374: 21.6.4. Adding DESTDIR support to packages
1.4 rillig 7375:
1.14 jmcneill 7376: DESTDIR support means that a package installs into a staging directory, not the
7377: final location of the files. Then a binary package is created which can be used
7378: for installation as usual. There are two ways: Either the package must install
1.25 wiz 7379: as root ("destdir") or the package can install as non-root user ("user-destdir"
7380: ).
1.14 jmcneill 7381:
1.113 leot 7382: * PKG_DESTDIR_SUPPORT has to be set to "destdir" or "user-destdir". By
7383: default PKG_DESTDIR_SUPPORT is set to "user-destdir" to help catching more
7384: potential packaging problems. If bsd.prefs.mk is included in the Makefile,
7385: PKG_DESTDIR_SUPPORT needs to be set before the inclusion.
1.14 jmcneill 7386:
1.4 rillig 7387: * All installation operations have to be prefixed with ${DESTDIR}.
7388:
7389: * automake gets this DESTDIR mostly right automatically. Many manual rules
7390: and pre/post-install often are incorrect; fix them.
7391:
1.17 imil 7392: * If files are installed with special owner/group use SPECIAL_PERMS.
1.4 rillig 7393:
7394: * In general, packages should support UNPRIVILEGED to be able to use DESTDIR.
7395:
1.154 rillig 7396: 21.6.5. Packages with hardcoded paths to other interpreters
1.1 dsieger 7397:
7398: Your package may also contain scripts with hardcoded paths to other
1.203 nia 7399: interpreters besides (or as well as) Perl. To correct the full pathname to the
1.1 dsieger 7400: script interpreter, you need to set the following definitions in your Makefile
7401: (we shall use tclsh in this example):
7402:
7403: REPLACE_INTERPRETER+= tcl
7404: REPLACE.tcl.old= .*/bin/tclsh
7405: REPLACE.tcl.new= ${PREFIX}/bin/tclsh
7406: REPLACE_FILES.tcl= # list of tcl scripts which need to be fixed,
7407: # relative to ${WRKSRC}, just as in REPLACE_PERL
7408:
1.203 nia 7409: 21.6.6. Packages installing Perl modules
1.1 dsieger 7410:
7411: Makefiles of packages providing perl5 modules should include the Makefile
7412: fragment ../../lang/perl5/module.mk. It provides a do-configure target for the
7413: standard perl configuration for such modules as well as various hooks to tune
7414: this configuration. See comments in this file for details.
7415:
7416: Perl5 modules will install into different places depending on the version of
7417: perl used during the build process. To address this, pkgsrc will append lines
7418: to the PLIST corresponding to the files listed in the installed .packlist file
7419: generated by most perl5 modules. This is invoked by defining PERL5_PACKLIST to
1.48 wiz 7420: a space-separated list of packlist files relative to PERL5_PACKLIST_DIR
7421: (PERL5_INSTALLVENDORARCH by default), e.g.:
1.1 dsieger 7422:
1.48 wiz 7423: PERL5_PACKLIST= auto/Pg/.packlist
1.1 dsieger 7424:
1.48 wiz 7425: The perl5 config variables installarchlib, installscript, installvendorbin,
7426: installvendorscript, installvendorarch, installvendorlib, installvendorman1dir,
7427: and installvendorman3dir represent those locations in which components of perl5
7428: modules may be installed, provided as variable with uppercase and prefixed with
7429: PERL5_, e.g. PERL5_INSTALLARCHLIB and may be used by perl5 packages that don't
7430: have a packlist. These variables are also substituted for in the PLIST as
7431: uppercase prefixed with PERL5_SUB_.
1.1 dsieger 7432:
1.254 wiz 7433: 21.6.7. Packages installing pkg-config files
7434:
7435: Some packages, usually those providing libraries, install pkg-config files so
7436: that their headers and libraries can easily be found. The file names end with
7437: .pc.
7438:
7439: Most of the time, these files only provide the linker flags for the library,
7440: but do not include the flags for setting the rpath so the libraries can also be
7441: found at runtime. Since this is so common, pkgsrc provides PKGCONFIG_OVERRIDE
7442: for this. Many packages generate the .pc from .pc.in, in that case add those
7443: files to the PKGCONFIG_OVERRIDE variable:
7444:
7445: PKGCONFIG_OVERRIDE+= foo.pc.in
7446:
7447:
7448: For packages using meson, the files are generated during build and you also
7449: need to change the phase in which the replacement is done. For example:
7450:
7451: PKGCONFIG_OVERRIDE+= output/meson-private/foo.pc
7452: PKGCONFIG_OVERRIDE_STAGE= post-build
7453:
7454:
7455: 21.6.8. Packages installing info files
1.1 dsieger 7456:
7457: Some packages install info files or use the "makeinfo" or "install-info"
7458: commands. INFO_FILES should be defined in the package Makefile so that INSTALL
7459: and DEINSTALL scripts will be generated to handle registration of the info
7460: files in the Info directory file. The "install-info" command used for the info
7461: files registration is either provided by the system, or by a special purpose
7462: package automatically added as dependency if needed.
7463:
7464: PKGINFODIR is the directory under ${PREFIX} where info files are primarily
7465: located. PKGINFODIR defaults to "info" and can be overridden by the user.
7466:
7467: The info files for the package should be listed in the package PLIST; however
7468: any split info files need not be listed.
7469:
7470: A package which needs the "makeinfo" command at build time must add "makeinfo"
7471: to USE_TOOLS in its Makefile. If a minimum version of the "makeinfo" command is
7472: needed it should be noted with the TEXINFO_REQD variable in the package
7473: Makefile. By default, a minimum version of 3.12 is required. If the system does
7474: not provide a makeinfo command or if it does not match the required minimum, a
7475: build dependency on the devel/gtexinfo package will be added automatically.
7476:
7477: The build and installation process of the software provided by the package
7478: should not use the install-info command as the registration of info files is
1.25 wiz 7479: the task of the package INSTALL script, and it must use the appropriate
1.1 dsieger 7480: makeinfo command.
7481:
7482: To achieve this goal, the pkgsrc infrastructure creates overriding scripts for
7483: the install-info and makeinfo commands in a directory listed early in PATH.
7484:
7485: The script overriding install-info has no effect except the logging of a
7486: message. The script overriding makeinfo logs a message and according to the
7487: value of TEXINFO_REQD either runs the appropriate makeinfo command or exit on
7488: error.
7489:
1.254 wiz 7490: 21.6.9. Packages installing man pages
1.1 dsieger 7491:
7492: All packages that install manual pages should install them into the same
7493: directory, so that there is one common place to look for them. In pkgsrc, this
7494: place is ${PREFIX}/${PKGMANDIR}, and this expression should be used in
1.25 wiz 7495: packages. The default for PKGMANDIR is "man". Another often-used value is "
7496: share/man".
1.1 dsieger 7497:
7498: Note
7499:
7500: The support for a custom PKGMANDIR is far from complete.
7501:
7502: The PLIST files can just use man/ as the top level directory for the man page
7503: file entries, and the pkgsrc framework will convert as needed. In all other
7504: places, the correct PKGMANDIR must be used.
7505:
7506: Packages that are configured with GNU_CONFIGURE set as "yes", by default will
7507: use the ./configure --mandir switch to set where the man pages should be
7508: installed. The path is GNU_CONFIGURE_MANDIR which defaults to ${PREFIX}/$
7509: {PKGMANDIR}.
7510:
7511: Packages that use GNU_CONFIGURE but do not use --mandir, can set
7512: CONFIGURE_HAS_MANDIR to "no". Or if the ./configure script uses a non-standard
7513: use of --mandir, you can set GNU_CONFIGURE_MANDIR as needed.
7514:
1.184 rillig 7515: See Section 19.5, "Man page compression" for information on installation of
1.1 dsieger 7516: compressed manual pages.
7517:
1.254 wiz 7518: 21.6.10. Packages installing X11 fonts
1.1 dsieger 7519:
7520: If a package installs font files, you will need to rebuild the fonts database
7521: in the directory where they get installed at installation and deinstallation
7522: time. This can be automatically done by using the pkginstall framework.
7523:
7524: You can list the directories where fonts are installed in the FONTS_DIRS.type
7525: variables, where type can be one of "ttf", "type1" or "x11". Also make sure
7526: that the database file fonts.dir is not listed in the PLIST.
7527:
7528: Note that you should not create new directories for fonts; instead use the
7529: standard ones to avoid that the user needs to manually configure his X server
7530: to find them.
7531:
1.254 wiz 7532: 21.6.11. Packages installing SGML or XML data
1.1 dsieger 7533:
7534: If a package installs SGML or XML data files that need to be registered in
7535: system-wide catalogs (like DTDs, sub-catalogs, etc.), you need to take some
7536: extra steps:
7537:
7538: 1. Include ../../textproc/xmlcatmgr/catalogs.mk in your Makefile, which takes
7539: care of registering those files in system-wide catalogs at installation and
7540: deinstallation time.
7541:
7542: 2. Set SGML_CATALOGS to the full path of any SGML catalogs installed by the
7543: package.
7544:
7545: 3. Set XML_CATALOGS to the full path of any XML catalogs installed by the
7546: package.
7547:
7548: 4. Set SGML_ENTRIES to individual entries to be added to the SGML catalog.
7549: These come in groups of three strings; see xmlcatmgr(1) for more
7550: information (specifically, arguments recognized by the 'add' action). Note
7551: that you will normally not use this variable.
7552:
7553: 5. Set XML_ENTRIES to individual entries to be added to the XML catalog. These
7554: come in groups of three strings; see xmlcatmgr(1) for more information
7555: (specifically, arguments recognized by the 'add' action). Note that you
7556: will normally not use this variable.
7557:
1.254 wiz 7558: 21.6.12. Packages installing extensions to the MIME database
1.1 dsieger 7559:
7560: If a package provides extensions to the MIME database by installing .xml files
7561: inside ${PREFIX}/share/mime/packages, you need to take some extra steps to
7562: ensure that the database is kept consistent with respect to these new files:
7563:
7564: 1. Include ../../databases/shared-mime-info/mimedb.mk (avoid using the
7565: buildlink3.mk file from this same directory, which is reserved for
7566: inclusion from other buildlink3.mk files). It takes care of rebuilding the
7567: MIME database at installation and deinstallation time, and disallows any
7568: access to it directly from the package.
7569:
1.25 wiz 7570: 2. Check the PLIST and remove any entries under the share/mime directory,
1.1 dsieger 7571: except for files saved under share/mime/packages. The former are handled
7572: automatically by the update-mime-database program, but the latter are
7573: package-dependent and must be removed by the package that installed them in
7574: the first place.
7575:
7576: 3. Remove any share/mime/* directories from the PLIST. They will be handled by
7577: the shared-mime-info package.
7578:
1.254 wiz 7579: 21.6.13. Packages using intltool
1.1 dsieger 7580:
7581: If a package uses intltool during its build, add intltool to the USE_TOOLS,
7582: which forces it to use the intltool package provided by pkgsrc, instead of the
7583: one bundled with the distribution file.
7584:
7585: This tracks intltool's build-time dependencies and uses the latest available
7586: version; this way, the package benefits of any bug fixes that may have appeared
7587: since it was released.
7588:
1.254 wiz 7589: 21.6.14. Packages installing startup scripts
1.1 dsieger 7590:
1.256 ! wiz 7591: If a package contains an rc.d script, it won't be copied into the startup
! 7592: directory (/etc/rc.d) by default, but you can enable copying by setting the
! 7593: option PKG_RCD_SCRIPTS=YES in mk.conf. With PKG_RCD_SCRIPTS=YES, rc.d scripts
! 7594: will be copied into /etc/rc.d when a package is installed, but only if the
! 7595: target does not already exist. Copies in /etc/rc.d will be automatically
! 7596: removed only if they have not been modified.
! 7597:
! 7598: Note that this alone does not enable the service: It must still be added to /
! 7599: etc/rc.conf.
1.1 dsieger 7600:
1.254 wiz 7601: 21.6.15. Packages installing TeX modules
1.1 dsieger 7602:
7603: If a package installs TeX packages into the texmf tree, the ls-R database of
7604: the tree needs to be updated.
7605:
7606: Note
7607:
1.23 jakllsch 7608: Except the main TeX packages such as kpathsea, packages should install files
7609: into ${PREFIX}/share/texmf-dist, not ${PREFIX}/share/texmf.
1.1 dsieger 7610:
1.23 jakllsch 7611: 1. Include ../../print/kpathsea/texmf.mk. This takes care of rebuilding the
7612: ls-R database at installation and deinstallation time.
1.1 dsieger 7613:
1.23 jakllsch 7614: 2. If your package installs files into a texmf tree other than the one at $
7615: {PREFIX}/share/texmf-dist, set TEX_TEXMF_DIRS to the list of all texmf
7616: trees that need database update.
1.1 dsieger 7617:
7618: If your package also installs font map files that need to be registered
1.30 dholland 7619: using updmap, include ../../print/tex-tetex/map.mk and set TEX_MAP_FILES
7620: and/or TEX_MIXEDMAP_FILES to the list of all such font map files. Then
7621: updmap will be run automatically at installation/deinstallation to enable/
7622: disable font map files for TeX output drivers.
1.1 dsieger 7623:
7624: 3. Make sure that none of ls-R databases are included in PLIST, as they will
1.30 dholland 7625: be removed only by the kpathsea package.
1.1 dsieger 7626:
1.254 wiz 7627: 21.6.16. Packages supporting running binaries in emulation
1.1 dsieger 7628:
7629: There are some packages that provide libraries and executables for running
7630: binaries from a one operating system on a different one (if the latter supports
7631: it). One example is running Linux binaries on NetBSD.
7632:
7633: The pkgtools/rpm2pkg helps in extracting and packaging Linux rpm packages.
7634:
7635: The CHECK_SHLIBS can be set to no to avoid the check-shlibs target, which tests
7636: if all libraries for each installed executable can be found by the dynamic
7637: linker. Since the standard dynamic linker is run, this fails for emulation
7638: packages, because the libraries used by the emulation are not in the standard
7639: directories.
7640:
1.254 wiz 7641: 21.6.17. Packages installing hicolor icons
1.1 dsieger 7642:
7643: If a package installs images under the share/icons/hicolor and/or updates the
7644: share/icons/hicolor/icon-theme.cache database, you need to take some extra
7645: steps to make sure that the shared theme directory is handled appropriately and
7646: that the cache database is rebuilt:
7647:
7648: 1. Include ../../graphics/hicolor-icon-theme/buildlink3.mk.
7649:
7650: 2. Check the PLIST and remove the entry that refers to the theme cache.
7651:
7652: 3. Ensure that the PLIST does not remove the shared icon directories from the
7653: share/icons/hicolor hierarchy because they will be handled automatically.
7654:
7655: The best way to verify that the PLIST is correct with respect to the last two
7656: points is to regenerate it using make print-PLIST.
7657:
1.254 wiz 7658: 21.6.18. Packages installing desktop files
1.1 dsieger 7659:
7660: If a package installs .desktop files under share/applications and these include
1.54 rodent 7661: MIME information (MimeType key), you need to take extra steps to ensure that
7662: they are registered into the MIME database:
1.1 dsieger 7663:
7664: 1. Include ../../sysutils/desktop-file-utils/desktopdb.mk.
7665:
7666: 2. Check the PLIST and remove the entry that refers to the share/applications/
7667: mimeinfo.cache file. It will be handled automatically.
7668:
7669: The best way to verify that the PLIST is correct with respect to the last point
7670: is to regenerate it using make print-PLIST.
7671:
1.154 rillig 7672: 21.7. Marking packages as having problems
1.1 dsieger 7673:
1.23 jakllsch 7674: In some cases one does not have the time to solve a problem immediately. In
7675: this case, one can plainly mark a package as broken. For this, one just sets
7676: the variable BROKEN to the reason why the package is broken (similar to the
1.162 rillig 7677: PKG_FAIL_REASON variable). A user trying to build the package will immediately
7678: be shown this message, and the build will not be even tried.
1.1 dsieger 7679:
1.23 jakllsch 7680: BROKEN packages are removed from pkgsrc in irregular intervals.
1.1 dsieger 7681:
1.184 rillig 7682: Chapter 22. GNOME packaging and porting
7683:
7684: Table of Contents
7685:
7686: 22.1. Meta packages
7687: 22.2. Packaging a GNOME application
7688: 22.3. Updating GNOME to a newer version
7689: 22.4. Patching guidelines
7690:
7691: Quoting GNOME's web site:
7692:
7693: The GNOME project provides two things: The GNOME desktop environment, an
7694: intuitive and attractive desktop for users, and the GNOME development
7695: platform, an extensive framework for building applications that integrate
7696: into the rest of the desktop.
7697:
7698: pkgsrc provides a seamless way to automatically build and install a complete
7699: GNOME environment under many different platforms. We can say with confidence
7700: that pkgsrc is one of the most advanced build and packaging systems for GNOME
7701: due to its included technologies buildlink3, the wrappers and tools framework
7702: and automatic configuration file management. Lots of efforts are put into
7703: achieving a completely clean deinstallation of installed software components.
7704:
7705: Given that pkgsrc is NetBSD's official packaging system, the above also means
7706: that great efforts are put into making GNOME work under this operating system.
7707:
7708: This chapter is aimed at pkgsrc developers and other people interested in
7709: helping our GNOME porting and packaging efforts. It provides instructions on
7710: how to manage the existing packages and some important information regarding
7711: their internals.
7712:
7713: 22.1. Meta packages
7714:
7715: pkgsrc includes three GNOME-related meta packages:
7716:
7717: * meta-pkgs/gnome-base: Provides the core GNOME desktop environment. It only
7718: includes the necessary bits to get it to boot correctly, although it may
7719: lack important functionality for daily operation. The idea behind this
7720: package is to let end users build their own configurations on top of this
7721: one, first installing this meta package to achieve a functional setup and
7722: then adding individual applications.
7723:
7724: * meta-pkgs/gnome: Provides a complete installation of the GNOME platform and
7725: desktop as defined by the GNOME project; this is based on the components
7726: distributed in the platform/x.y/x.y.z/sources and desktop/x.y/x.y.z/sources
7727: directories of the official FTP server. Developer-only tools found in those
7728: directories are not installed unless required by some other component to
7729: work properly. Similarly, packages from the bindings set (bindings/x.y/
7730: x.y.z/sources) are not pulled in unless required as a dependency for an
7731: end-user component. This package "extends" meta-pkgs/gnome-base.
7732:
7733: * meta-pkgs/gnome-devel: Installs all the tools required to build a GNOME
7734: component when fetched from the CVS repository. These are required to let
7735: the autogen.sh scripts work appropriately.
7736:
7737: In all these packages, the DEPENDS lines are sorted in a way that eases
7738: updates: a package may depend on other packages listed before it but not on any
7739: listed after it. It is very important to keep this order to ease updates so...
7740: do not change it to alphabetical sorting!
7741:
7742: 22.2. Packaging a GNOME application
7743:
7744: Almost all GNOME applications are written in C and use a common set of tools as
7745: their build system. Things get different with the new bindings to other
7746: languages (such as Python), but the following will give you a general idea on
7747: the minimum required tools:
7748:
7749: * Almost all GNOME applications use the GNU Autotools as their build system.
7750: As a general rule you will need to tell this to your package:
7751:
1.223 nia 7752: GNU_CONFIGURE= yes
7753: USE_LIBTOOL= yes
7754: USE_TOOLS+= gmake
1.184 rillig 7755:
7756: * If the package uses pkg-config to detect dependencies, add this tool to the
7757: list of required utilities:
7758:
1.223 nia 7759: USE_TOOLS+= pkg-config
1.184 rillig 7760:
7761: Also use pkgtools/verifypc at the end of the build process to ensure that
7762: you did not miss to specify any dependency in your package and that the
7763: version requirements are all correct.
7764:
7765: * If the package uses intltool, be sure to add intltool to the USE_TOOLS to
7766: handle dependencies and to force the package to use the latest available
7767: version.
7768:
7769: * If the package uses gtk-doc (a documentation generation utility), do not
7770: add a dependency on it. The tool is rather big and the distfile should come
7771: with pregenerated documentation anyway; if it does not, it is a bug that
7772: you ought to report. For such packages you should disable gtk-doc (unless
7773: it is the default):
7774:
1.223 nia 7775: CONFIGURE_ARGS+= --disable-gtk-doc
1.184 rillig 7776:
7777: The default location of installed HTML files (share/gtk-doc/<package-name>)
7778: is correct and should not be changed unless the package insists on
7779: installing them somewhere else. Otherwise programs as devhelp will not be
7780: able to open them. You can do that with an entry similar to:
1.1 dsieger 7781:
1.223 nia 7782: CONFIGURE_ARGS+= --with-html-dir=${PREFIX}/share/gtk-doc/...
1.1 dsieger 7783:
1.184 rillig 7784: GNOME uses multiple shared directories and files under the installation prefix
7785: to maintain databases. In this context, shared means that those exact same
7786: directories and files are used among several different packages, leading to
7787: conflicts in the PLIST. pkgsrc currently includes functionality to handle the
7788: most common cases, so you have to forget about using @unexec ${RMDIR} lines in
7789: your file lists and omitting shared files from them. If you find yourself doing
7790: those, your package is most likely incorrect.
1.1 dsieger 7791:
1.184 rillig 7792: The following table lists the common situations that result in using shared
7793: directories or files. For each of them, the appropriate solution is given.
7794: After applying the solution be sure to regenerate the package's file list with
7795: make print-PLIST and ensure it is correct.
1.1 dsieger 7796:
1.184 rillig 7797: Table 22.1. PLIST handling for GNOME packages
1.1 dsieger 7798:
1.184 rillig 7799: +-----------------------------------------------------------------------------+
7800: | If the package... | Then... |
7801: |-------------------------------------------+---------------------------------|
1.254 wiz 7802: |Installs icons under the share/icons/ |See Section 21.6.17, "Packages |
1.203 nia 7803: |hicolor hierarchy or updates share/icons/ |installing hicolor icons". |
1.184 rillig 7804: |hicolor/icon-theme.cache. | |
7805: |-------------------------------------------+---------------------------------|
1.254 wiz 7806: | |See Section 21.6.12, "Packages |
1.184 rillig 7807: |Installs files under share/mime/packages. |installing extensions to the MIME|
7808: | |database". |
7809: |-------------------------------------------+---------------------------------|
1.254 wiz 7810: |Installs .desktop files under share/ |See Section 21.6.18, "Packages |
1.184 rillig 7811: |applications and these include MIME |installing desktop files". |
7812: |information. | |
7813: +-----------------------------------------------------------------------------+
1.1 dsieger 7814:
7815:
1.184 rillig 7816: 22.3. Updating GNOME to a newer version
1.1 dsieger 7817:
1.184 rillig 7818: When seeing GNOME as a whole, there are two kinds of updates:
1.1 dsieger 7819:
1.184 rillig 7820: Major update
1.1 dsieger 7821:
1.184 rillig 7822: Given that there is still a very long way for GNOME 3 (if it ever appears),
7823: we consider a major update one that goes from a 2.X version to a 2.Y one,
7824: where Y is even and greater than X. These are hard to achieve because they
7825: introduce lots of changes in the components' code and almost all GNOME
7826: distfiles are updated to newer versions. Some of them can even break API
7827: and ABI compatibility with the previous major version series. As a result,
7828: the update needs to be done all at once to minimize breakage.
1.1 dsieger 7829:
1.184 rillig 7830: A major update typically consists of around 80 package updates and the
7831: addition of some new ones.
1.1 dsieger 7832:
1.184 rillig 7833: Minor update
1.1 dsieger 7834:
1.184 rillig 7835: We consider a minor update one that goes from a 2.A.X version to a 2.A.Y
7836: one where Y is greater than X. These are easy to achieve because they do
7837: not update all GNOME components, can be done in an incremental way and do
7838: not break API nor ABI compatibility.
1.1 dsieger 7839:
1.184 rillig 7840: A minor update typically consists of around 50 package updates, although
7841: the numbers here may vary a lot.
1.1 dsieger 7842:
1.184 rillig 7843: In order to update the GNOME components in pkgsrc to a new stable release
7844: (either major or minor), the following steps should be followed:
1.1 dsieger 7845:
1.184 rillig 7846: 1. Get a list of all the tarballs that form the new release by using the
7847: following commands. These will leave the full list of the components'
7848: distfiles into the list.txt file:
1.1 dsieger 7849:
1.184 rillig 7850: % echo ls "*.tar.bz2" | \
7851: ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
7852: awk '{ print $9 }' >list.txt
7853: % echo ls "*.tar.bz2" | \
7854: ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
7855: awk '{ print $9 }' >>list.txt
1.1 dsieger 7856:
1.184 rillig 7857: 2. Open each meta package's Makefile and bump their version to the release you
7858: are updating them to. The three meta packages should be always consistent
7859: with versioning. Obviously remove any PKGREVISIONs that might be in them.
1.1 dsieger 7860:
1.184 rillig 7861: 3. For each meta package, update all its DEPENDS lines to match the latest
7862: versions as shown by the above commands. Do not list any newer version
7863: (even if found in the FTP) because the meta packages are supposed to list
7864: the exact versions that form a specific GNOME release. Exceptions are
7865: permitted here if a newer version solves a serious issue in the overall
7866: desktop experience; these typically come in the form of a revision bump in
7867: pkgsrc, not in newer versions from the developers.
1.1 dsieger 7868:
1.184 rillig 7869: Packages not listed in the list.txt file should be updated to the latest
7870: version available (if found in pkgsrc). This is the case, for example, of
7871: the dependencies on the GNU Autotools in the meta-pkgs/gnome-devel meta
7872: package.
1.1 dsieger 7873:
1.184 rillig 7874: 4. Generate a patch from the modified meta packages and extract the list of
7875: "new" lines. This will provide you an outline on what packages need to be
7876: updated in pkgsrc and in what order:
1.1 dsieger 7877:
1.184 rillig 7878: % cvs diff -u gnome-devel gnome-base gnome | grep '^+D' >todo.txt
1.1 dsieger 7879:
1.184 rillig 7880: 5. For major desktop updates it is recommended to zap all your installed
7881: packages and start over from scratch at this point.
1.1 dsieger 7882:
1.184 rillig 7883: 6. Now comes the longest step by far: iterate over the contents of todo.txt
7884: and update the packages listed in it in order. For major desktop updates
7885: none of these should be committed until the entire set is completed because
7886: there are chances of breaking not-yet-updated packages.
1.1 dsieger 7887:
1.184 rillig 7888: 7. Once the packages are up to date and working, commit them to the tree one
7889: by one with appropriate log messages. At the end, commit the three meta
7890: package updates and all the corresponding changes to the doc/CHANGES-<YEAR>
7891: and pkgsrc/doc/TODO files.
1.1 dsieger 7892:
1.184 rillig 7893: 22.4. Patching guidelines
1.1 dsieger 7894:
1.184 rillig 7895: GNOME is a very big component in pkgsrc which approaches 100 packages. Please,
7896: it is very important that you always, always, always feed back any portability
7897: fixes you do to a GNOME package to the mainstream developers (see
7898: Section 12.3.5, "Feedback to the author"). This is the only way to get their
7899: attention on portability issues and to ensure that future versions can be built
7900: out-of-the box on NetBSD. The less custom patches in pkgsrc, the easier further
7901: updates are. Those developers in charge of issuing major GNOME updates will be
7902: grateful if you do that.
1.1 dsieger 7903:
1.200 cirnatda 7904: The most common places to report bugs are the GNOME's GitLab and the
7905: freedesktop.org's GitLab. Not all components use these to track bugs, but most
7906: of them do. Do not be short on your reports: always provide detailed
1.184 rillig 7907: explanations of the current failure, how it can be improved to achieve maximum
1.200 cirnatda 7908: portability and, if at all possible, provide a patch against the main Git
7909: branch. The more verbose you are, the higher chances of your patch being
7910: accepted.
1.1 dsieger 7911:
1.184 rillig 7912: Also, please avoid using preprocessor magic to fix portability issues. While
7913: the FreeBSD GNOME people are doing a great job in porting GNOME to their
7914: operating system, the official GNOME sources are now plagued by conditionals
7915: that check for __FreeBSD__ and similar macros. This hurts portability. Please
7916: see our patching guidelines (Section 12.3.4, "Patching guidelines") for more
7917: details.
1.1 dsieger 7918:
1.154 rillig 7919: Chapter 23. Submitting and Committing
1.1 dsieger 7920:
7921: Table of Contents
7922:
1.154 rillig 7923: 23.1. Submitting binary packages
7924: 23.2. Submitting source packages (for non-NetBSD-developers)
7925: 23.3. General notes when adding, updating, or removing packages
7926: 23.4. Commit Messages
7927: 23.5. Committing: Adding a package to CVS
7928: 23.6. Updating a package to a newer version
7929: 23.7. Renaming a package in pkgsrc
7930: 23.8. Moving a package in pkgsrc
1.1 dsieger 7931:
1.154 rillig 7932: 23.1. Submitting binary packages
1.1 dsieger 7933:
7934: Our policy is that we accept binaries only from pkgsrc developers to guarantee
7935: that the packages don't contain any trojan horses etc. This is not to annoy
7936: anyone but rather to protect our users! You're still free to put up your
7937: home-made binary packages and tell the world where to get them. NetBSD
1.154 rillig 7938: developers doing bulk builds and wanting to upload them please see Chapter 8,
1.66 asau 7939: Creating binary packages for everything in pkgsrc (bulk builds).
1.1 dsieger 7940:
1.154 rillig 7941: 23.2. Submitting source packages (for non-NetBSD-developers)
1.1 dsieger 7942:
1.218 nia 7943: Firstly, you can import new packages into pkgsrc-wip ("pkgsrc work-in-progress"
7944: ); see the homepage at https://pkgsrc.org/wip/ for details.
7945:
7946: Next, check that your package is complete, compiles and runs well; see
1.184 rillig 7947: Chapter 14, Creating a new pkgsrc package from scratch and the rest of this
1.218 nia 7948: document. Run the pkgtools/pkglint tool and fix any errors that appear.
7949:
7950: Finally, send a report to the pkgsrc bug tracking system, either with the
7951: send-pr(1) command, or if you don't have that, go to the web page https://
7952: www.NetBSD.org/support/send-pr.html, which contains some instructions and a
7953: link to a form where you can submit packages. The sysutils/gtk-send-pr package
7954: is also available as a substitute for either of the above two tools.
1.1 dsieger 7955:
7956: In the form of the problem report, the category should be "pkg", the synopsis
7957: should include the package name and version number, and the description field
7958: should contain a short description of your package (contents of the COMMENT
1.218 nia 7959: variable or DESCR file are OK).
1.1 dsieger 7960:
1.154 rillig 7961: 23.3. General notes when adding, updating, or removing packages
1.1 dsieger 7962:
7963: Please note all package additions, updates, moves, and removals in pkgsrc/doc/
7964: CHANGES-YYYY. It's very important to keep this file up to date and conforming
7965: to the existing format, because it will be used by scripts to automatically
7966: update pages on www.NetBSD.org and other sites. Additionally, check the pkgsrc/
7967: doc/TODO file and remove the entry for the package you updated or removed, in
7968: case it was mentioned there.
7969:
7970: When the PKGREVISION of a package is bumped, the change should appear in pkgsrc
7971: /doc/CHANGES-YYYY if it is security related or otherwise relevant. Mass bumps
7972: that result from a dependency being updated should not be mentioned. In all
7973: other cases it's the developer's decision.
7974:
7975: There is a make target that helps in creating proper CHANGES-YYYY entries: make
7976: changes-entry. It uses the optional CTYPE and NETBSD_LOGIN_NAME variables. The
7977: general usage is to first make sure that your CHANGES-YYYY file is up-to-date
7978: (to avoid having to resolve conflicts later-on) and then to cd to the package
7979: directory. For package updates, make changes-entry is enough. For new packages,
7980: or package moves or removals, set the CTYPE variable on the command line to
1.4 rillig 7981: "Added", "Moved", or "Removed". You can set NETBSD_LOGIN_NAME in mk.conf if
1.23 jakllsch 7982: your local login name is not the same as your NetBSD login name. The target
7983: also automatically removes possibly existing entries for the package in the
7984: TODO file. Don't forget to commit the changes, e.g. by using make
1.66 asau 7985: commit-changes-entry! If you are not using a checkout directly from
1.23 jakllsch 7986: cvs.NetBSD.org, but e.g. a local copy of the repository, you can set
7987: USE_NETBSD_REPO=yes. This makes the cvs commands use the main repository.
1.1 dsieger 7988:
1.154 rillig 7989: 23.4. Commit Messages
1.130 wiz 7990:
7991: For several years, there have been mirrors of pkgsrc in fossil, git, and hg.
7992: Standard practise when using these tools is to make the first line of a commit
7993: message function as a summary that can be read without the rest, such as is
7994: commonly done with "git log --oneline". For this reason, we have the following
7995: guidelines for pkgsrc commit messages:
7996:
1.131 wiz 7997: * Start the commit message with a line that explains the big picture in 65
1.130 wiz 7998: characters or less. When a commit is for one package, include the name of
7999: the package. For updates, include the version to which it is updated.
8000:
8001: * Leave the next line empty.
8002:
8003: * Then come the details for the commit (changes in that package, reason for a
8004: change) and any relevant PRs. Wrap this section.
8005:
8006: Here is an example:
8007:
1.238 wiz 8008: libxslt: update to 1.0.30
1.130 wiz 8009:
1.238 wiz 8010: Changes since 1.0.29:
8011: ...
1.130 wiz 8012:
8013: Here is another example:
8014:
1.238 wiz 8015: mk/bsd.pkg.mk: enable SSP by default on NetBSD
1.130 wiz 8016:
1.238 wiz 8017: (rationale)
1.130 wiz 8018:
8019: Commit messages are final: no "cvs admin" is allowed on the pkgsrc repository
8020: to change commit messages.
8021:
1.154 rillig 8022: 23.5. Committing: Adding a package to CVS
1.1 dsieger 8023:
8024: This section is only of interest for pkgsrc developers with write access to the
1.34 wiz 8025: pkgsrc repository.
8026:
8027: When the package is finished, "cvs add" the files. Start by adding the
8028: directory and then files in the directory. Don't forget to add the new package
8029: to the category's Makefile. Make sure you don't forget any files; you can check
8030: by running "cvs status". An example:
8031:
8032: $ cd .../pkgsrc/category
8033: $ cvs add pkgname
8034: $ cd pkgname
8035: $ cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
8036: $ cvs add patches/p*
8037: $ cvs status | less
1.35 wiz 8038: $ cvs commit
1.34 wiz 8039: $ cd ..
1.236 gutterid 8040: $ vi Makefile # add SUBDIR+=pkgname line
1.35 wiz 8041: $ cvs commit Makefile
1.66 asau 8042: $ cd pkgname
1.73 jnemeth 8043: $ make CTYPE=Added commit-changes-entry
1.1 dsieger 8044:
8045: The commit message of the initial import should include part of the DESCR file,
8046: so people reading the mailing lists know what the package is/does.
8047:
1.34 wiz 8048: Also mention the new package in pkgsrc/doc/CHANGES-20xx.
8049:
8050: Previously, "cvs import" was suggested, but it was much easier to get wrong
8051: than "cvs add".
1.1 dsieger 8052:
1.154 rillig 8053: 23.6. Updating a package to a newer version
1.1 dsieger 8054:
8055: Please always put a concise, appropriate and relevant summary of the changes
8056: between old and new versions into the commit log when updating a package. There
8057: are various reasons for this:
8058:
8059: * A URL is volatile, and can change over time. It may go away completely or
8060: its information may be overwritten by newer information.
8061:
8062: * Having the change information between old and new versions in our CVS
8063: repository is very useful for people who use either cvs or anoncvs.
8064:
8065: * Having the change information between old and new versions in our CVS
8066: repository is very useful for people who read the pkgsrc-changes mailing
8067: list, so that they can make tactical decisions about when to upgrade the
8068: package.
8069:
8070: Please also recognize that, just because a new version of a package has been
8071: released, it should not automatically be upgraded in the CVS repository. We
8072: prefer to be conservative in the packages that are included in pkgsrc -
8073: development or beta packages are not really the best thing for most places in
8074: which pkgsrc is used. Please use your judgement about what should go into
8075: pkgsrc, and bear in mind that stability is to be preferred above new and
8076: possibly untested features.
8077:
1.154 rillig 8078: 23.7. Renaming a package in pkgsrc
1.21 snj 8079:
8080: Renaming packages is not recommended.
8081:
1.175 gutterid 8082: When renaming packages, be sure to fix any references to the old name in other
1.21 snj 8083: Makefiles, options, buildlink files, etc.
8084:
1.175 gutterid 8085: Also, when renaming a package, please add the package name and version pattern
1.167 leot 8086: (s) of the previous package to SUPERSEDES. This may be repeated for multiple
8087: renames. The new package would be an exact replacement. Example:
8088:
8089: SUPERSEDES+= p5-IO-Compress-Zlib<2.017
8090: SUPERSEDES+= optcomp-[0-9]*
1.21 snj 8091:
8092: Note that "successor" in the CHANGES-YYYY file doesn't necessarily mean that it
8093: supersedes, as that successor may not be an exact replacement but is a
8094: suggestion for the replaced functionality.
8095:
1.154 rillig 8096: 23.8. Moving a package in pkgsrc
1.21 snj 8097:
8098: It is preferred that packages are not renamed or moved, but if needed please
8099: follow these steps.
1.1 dsieger 8100:
8101: 1. Make a copy of the directory somewhere else.
8102:
8103: 2. Remove all CVS dirs.
8104:
8105: Alternatively to the first two steps you can also do:
8106:
8107: % cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package
8108:
8109: and use that for further work.
8110:
1.25 wiz 8111: 3. Fix CATEGORIES and any DEPENDS paths that just did "../package" instead of
1.1 dsieger 8112: "../../category/package".
8113:
1.21 snj 8114: 4. In the modified package's Makefile, consider setting PREV_PKGPATH to the
8115: previous category/package pathname. The PREV_PKGPATH can be used by tools
8116: for doing an update using pkgsrc building; for example, it can search the
8117: pkg_summary(5) database for PREV_PKGPATH (if no SUPERSEDES) and then use
8118: the corresponding new PKGPATH for that moved package. Note that it may have
8119: multiple matches, so the tool should also check on the PKGBASE too. The
8120: PREV_PKGPATH probably has no value unless SUPERSEDES is not set, i.e.
8121: PKGBASE stays the same.
8122:
1.237 gutterid 8123: 5. cvs add the modified package in the new place.
1.1 dsieger 8124:
1.21 snj 8125: 6. Check if any package depends on it:
1.1 dsieger 8126:
8127: % cd /usr/pkgsrc
8128: % grep /package */*/Makefile* */*/buildlink*
8129:
1.21 snj 8130: 7. Fix paths in packages from step 5 to point to new location.
1.1 dsieger 8131:
1.21 snj 8132: 8. cvs rm (-f) the package at the old location.
1.1 dsieger 8133:
1.21 snj 8134: 9. Remove from oldcategory/Makefile.
1.1 dsieger 8135:
1.21 snj 8136: 10. Add to newcategory/Makefile.
1.1 dsieger 8137:
1.21 snj 8138: 11. Commit the changed and removed files:
1.1 dsieger 8139:
8140: % cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile
8141:
8142: (and any packages from step 5, of course).
8143:
1.154 rillig 8144: Chapter 24. Frequently Asked Questions
1.1 dsieger 8145:
8146: This section contains the answers to questions that may arise when you are
8147: writing a package. If you don't find your question answered here, first have a
8148: look in the other chapters, and if you still don't have the answer, ask on the
8149: pkgsrc-users mailing list.
8150:
1.154 rillig 8151: 24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
8152: 24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
8153: 24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
1.223 nia 8154: 24.4. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
8155: 24.5. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.232 gutterid 8156: the := inside it.
1.223 nia 8157: 24.6. Which mailing lists are there for package developers?
8158: 24.7. Where is the pkgsrc documentation?
8159: 24.8. I have a little time to kill. What shall I do?
1.1 dsieger 8160:
1.154 rillig 8161: 24.1. What is the difference between MAKEFLAGS, .MAKEFLAGS and MAKE_FLAGS?
1.1 dsieger 8162:
8163: MAKEFLAGS are the flags passed to the pkgsrc-internal invocations of make
1.223 nia 8164: (1).
8165:
8166: MAKE_FLAGS are the flags that are passed to the MAKE_PROGRAM when
8167: building the package.
8168:
8169: .MAKEFLAGS is an internal variable of bmake and should not be used by
8170: packages.
1.1 dsieger 8171:
1.154 rillig 8172: 24.2. What is the difference between MAKE, GMAKE and MAKE_PROGRAM?
1.1 dsieger 8173:
8174: MAKE is the path to the make(1) program that is used in the pkgsrc
1.223 nia 8175: infrastructure.
8176:
8177: GMAKE is the path to GNU Make, but you need to say USE_TOOLS+=gmake to
8178: use that.
8179:
8180: MAKE_PROGRAM is the path to the Make program that is used for building
8181: the package.
1.1 dsieger 8182:
1.154 rillig 8183: 24.3. What is the difference between CC, PKG_CC and PKGSRC_COMPILER?
1.1 dsieger 8184:
8185: CC is the path to the real C compiler, which can be configured by the
1.223 nia 8186: pkgsrc user.
1.1 dsieger 8187:
1.223 nia 8188: PKG_CC is the path to the compiler wrapper.
1.1 dsieger 8189:
1.223 nia 8190: PKGSRC_COMPILER is not a path to a compiler, but the type of compiler
8191: that should be used. See mk/compiler.mk for more information about the
8192: latter variable.
1.1 dsieger 8193:
1.223 nia 8194: 24.4. Why does make show-var VARNAME=BUILDLINK_PREFIX.foo say it's empty?
1.1 dsieger 8195:
1.25 wiz 8196: For optimization reasons, some variables are only available in the "
8197: wrapper" phase and later. To "simulate" the wrapper phase, append
1.1 dsieger 8198: PKG_PHASE=wrapper to the above command.
8199:
1.223 nia 8200: 24.5. What does ${MASTER_SITE_SOURCEFORGE:=package/} mean? I don't understand
1.1 dsieger 8201: the := inside it.
8202:
1.223 nia 8203: The := is not an assignment operator, even though it may look like one.
1.108 rillig 8204: Instead, it is a degenerate form of ${LIST:old_string=new_string}, which
8205: is documented in the make(1) man page and which is commonly used in the
8206: form ${SRCS:.c=.o}. In the case of MASTER_SITE_*, old_string is the empty
8207: string and new_string is package/. That's where the : and the = fall
8208: together.
1.1 dsieger 8209:
1.223 nia 8210: 24.6. Which mailing lists are there for package developers?
1.1 dsieger 8211:
8212: tech-pkg
8213:
8214: This is a list for technical discussions related to pkgsrc
8215: development, e.g. soliciting feedback for changes to pkgsrc
8216: infrastructure, proposed new features, questions related to porting
8217: pkgsrc to a new platform, advice for maintaining a package, patches
8218: that affect many packages, help requests moved from pkgsrc-users when
8219: an infrastructure bug is found, etc.
8220:
8221: pkgsrc-bugs
8222:
8223: All bug reports in category "pkg" sent with send-pr(1) appear here.
8224: Please do not report your bugs here directly; use one of the other
8225: mailing lists.
8226:
1.223 nia 8227: 24.7. Where is the pkgsrc documentation?
1.1 dsieger 8228:
8229: There are many places where you can find documentation about pkgsrc:
8230:
8231: * The pkgsrc guide (this document) is a collection of chapters that
8232: explain large parts of pkgsrc, but some chapters tend to be outdated.
8233: Which ones they are is hard to say.
8234:
1.174 leot 8235: * On the mailing list archives (see https://mail-index.NetBSD.org/),
8236: you can find discussions about certain features, announcements of new
1.1 dsieger 8237: parts of the pkgsrc infrastructure and sometimes even announcements
8238: that a certain feature has been marked as obsolete. The benefit here
8239: is that each message has a date appended to it.
8240:
8241: * Many of the files in the mk/ directory start with a comment that
8242: describes the purpose of the file and how it can be used by the
8243: pkgsrc user and package authors. An easy way to find this
8244: documentation is to run bmake help.
8245:
8246: * The CVS log messages are a rich source of information, but they tend
8247: to be highly abbreviated, especially for actions that occur often.
8248: Some contain a detailed description of what has changed, but they are
8249: geared towards the other pkgsrc developers, not towards an average
8250: pkgsrc user. They also only document changes, so if you don't know
8251: what has been before, these messages may not be worth too much to
8252: you.
8253:
8254: * Some parts of pkgsrc are only "implicitly documented", that is the
8255: documentation exists only in the mind of the developer who wrote the
8256: code. To get this information, use the cvs annotate command to see
8257: who has written it and ask on the tech-pkg mailing list, so that
8258: others can find your questions later (see above). To be sure that the
8259: developer in charge reads the mail, you may CC him or her.
8260:
1.223 nia 8261: 24.8. I have a little time to kill. What shall I do?
1.1 dsieger 8262:
8263: This is not really an FAQ yet, but here's the answer anyway.
8264:
8265: * Run pkg_chk -N (from the pkgtools/pkg_chk package). It will tell you
8266: about newer versions of installed packages that are available, but
8267: not yet updated in pkgsrc.
8268:
1.198 leot 8269: * Browse pkgsrc/doc/TODO -- it contains a list of suggested new
8270: packages and a list of cleanups and enhancements for pkgsrc that
8271: would be nice to have.
1.1 dsieger 8272:
1.71 wiz 8273: * Review packages for which review was requested on the tech-pkg
8274: mailing list.
1.1 dsieger 8275:
8276: Part III. The pkgsrc infrastructure internals
8277:
8278: This part of the guide deals with everything from the infrastructure that is
8279: behind the interfaces described in the developer's guide. A casual package
8280: maintainer should not need anything from this part.
8281:
8282: Table of Contents
8283:
1.184 rillig 8284: 25. Design of the pkgsrc infrastructure
8285: 25.1. The meaning of variable definitions
8286: 25.2. Avoiding problems before they arise
8287: 25.3. Variable evaluation
8288: 25.3.1. At load time
8289: 25.3.2. At runtime
8290: 25.4. How can variables be specified?
8291: 25.5. Designing interfaces for Makefile fragments
8292: 25.5.1. Procedures with parameters
8293: 25.5.2. Actions taken on behalf of parameters
8294: 25.6. The order in which files are loaded
8295: 25.6.1. The order in bsd.prefs.mk
8296: 25.6.2. The order in bsd.pkg.mk
8297: 26. Regression tests
8298: 26.1. Running the regression tests
8299: 26.2. Adding a new regression test
8300: 26.2.1. Overridable functions
8301: 26.2.2. Helper functions
8302: 27. Porting pkgsrc
8303: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8304:
1.184 rillig 8305: Chapter 25. Design of the pkgsrc infrastructure
1.1 dsieger 8306:
8307: Table of Contents
8308:
1.184 rillig 8309: 25.1. The meaning of variable definitions
8310: 25.2. Avoiding problems before they arise
8311: 25.3. Variable evaluation
8312: 25.3.1. At load time
8313: 25.3.2. At runtime
8314: 25.4. How can variables be specified?
8315: 25.5. Designing interfaces for Makefile fragments
8316: 25.5.1. Procedures with parameters
8317: 25.5.2. Actions taken on behalf of parameters
8318: 25.6. The order in which files are loaded
8319: 25.6.1. The order in bsd.prefs.mk
8320: 25.6.2. The order in bsd.pkg.mk
1.1 dsieger 8321:
8322: The pkgsrc infrastructure consists of many small Makefile fragments. Each such
8323: fragment needs a properly specified interface. This chapter explains how such
8324: an interface looks like.
8325:
1.184 rillig 8326: 25.1. The meaning of variable definitions
1.1 dsieger 8327:
8328: Whenever a variable is defined in the pkgsrc infrastructure, the location and
8329: the way of definition provide much information about the intended use of that
8330: variable. Additionally, more documentation may be found in a header comment or
8331: in this pkgsrc guide.
8332:
8333: A special file is mk/defaults/mk.conf, which lists all variables that are
8334: intended to be user-defined. They are either defined using the ?= operator or
8335: they are left undefined because defining them to anything would effectively
8336: mean "yes". All these variables may be overridden by the pkgsrc user in the
8337: MAKECONF file.
8338:
8339: Outside this file, the following conventions apply: Variables that are defined
8340: using the ?= operator may be overridden by a package.
8341:
8342: Variables that are defined using the = operator may be used read-only at
8343: run-time.
8344:
8345: Variables whose name starts with an underscore must not be accessed outside the
8346: pkgsrc infrastructure at all. They may change without further notice.
8347:
8348: Note
8349:
8350: These conventions are currently not applied consistently to the complete pkgsrc
8351: infrastructure.
8352:
1.184 rillig 8353: 25.2. Avoiding problems before they arise
1.1 dsieger 8354:
8355: All variables that contain lists of things should default to being empty. Two
8356: examples that do not follow this rule are USE_LANGUAGES and DISTFILES. These
8357: variables cannot simply be modified using the += operator in package Makefiles
8358: (or other files included by them), since there is no guarantee whether the
8359: variable is already set or not, and what its value is. In the case of
8360: DISTFILES, the packages "know" the default value and just define it as in the
8361: following example.
8362:
8363: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
8364:
8365: Because of the selection of this default value, the same value appears in many
8366: package Makefiles. Similarly for USE_LANGUAGES, but in this case the default
8367: value ("c") is so short that it doesn't stand out. Nevertheless it is mentioned
8368: in many files.
8369:
1.184 rillig 8370: 25.3. Variable evaluation
1.1 dsieger 8371:
1.184 rillig 8372: 25.3.1. At load time
1.1 dsieger 8373:
8374: Variable evaluation takes place either at load time or at runtime, depending on
8375: the context in which they occur. The contexts where variables are evaluated at
8376: load time are:
8377:
8378: * The right hand side of the := and != operators,
8379:
8380: * Make directives like .if or .for,
8381:
8382: * Dependency lines.
8383:
8384: A special exception are references to the iteration variables of .for loops,
8385: which are expanded inline, no matter in which context they appear.
8386:
8387: As the values of variables may change during load time, care must be taken not
8388: to evaluate them by accident. Typical examples for variables that should not be
8389: evaluated at load time are DEPENDS and CONFIGURE_ARGS. To make the effect more
8390: clear, here is an example:
8391:
8392: CONFIGURE_ARGS= # none
8393: CFLAGS= -O
8394: CONFIGURE_ARGS+= CFLAGS=${CFLAGS:Q}
8395:
8396: CONFIGURE_ARGS:= ${CONFIGURE_ARGS}
8397:
8398: CFLAGS+= -Wall
8399:
8400: This code shows how the use of the := operator can quickly lead to unexpected
8401: results. The first paragraph is fairly common code. The second paragraph
8402: evaluates the CONFIGURE_ARGS variable, which results in CFLAGS=-O. In the third
8403: paragraph, the -Wall is appended to the CFLAGS, but this addition will not
8404: appear in CONFIGURE_ARGS. In actual code, the three paragraphs from above
8405: typically occur in completely unrelated files.
8406:
1.184 rillig 8407: 25.3.2. At runtime
1.1 dsieger 8408:
8409: After all the files have been loaded, the values of the variables cannot be
8410: changed anymore. Variables that are used in the shell commands are expanded at
8411: this point.
8412:
1.184 rillig 8413: 25.4. How can variables be specified?
1.1 dsieger 8414:
8415: There are many ways in which the definition and use of a variable can be
8416: restricted in order to detect bugs and violations of the (mostly unwritten)
1.108 rillig 8417: policies. A package can be checked with pkglint -Wall to see whether it meets
8418: these rules.
1.1 dsieger 8419:
1.184 rillig 8420: 25.5. Designing interfaces for Makefile fragments
1.1 dsieger 8421:
8422: Most of the .mk files fall into one of the following classes. Cases where a
8423: file falls into more than one class should be avoided as it often leads to
8424: subtle bugs.
8425:
1.184 rillig 8426: 25.5.1. Procedures with parameters
1.1 dsieger 8427:
8428: In a traditional imperative programming language some of the .mk files could be
1.198 leot 8429: described as procedures. They take some input parameters and--after
8430: inclusion--provide a result in output parameters. Since all variables in
1.23 jakllsch 8431: Makefiles have global scope care must be taken not to use parameter names that
8432: have already another meaning. For example, PKGNAME is a bad choice for a
8433: parameter name.
1.1 dsieger 8434:
8435: Procedures are completely evaluated at preprocessing time. That is, when
8436: calling a procedure all input parameters must be completely resolvable. For
8437: example, CONFIGURE_ARGS should never be an input parameter since it is very
8438: likely that further text will be added after calling the procedure, which would
8439: effectively apply the procedure to only a part of the variable. Also,
1.108 rillig 8440: references to other variables will be modified after calling the procedure.
1.1 dsieger 8441:
8442: A procedure can declare its output parameters either as suitable for use in
8443: preprocessing directives or as only available at runtime. The latter
8444: alternative is for variables that contain references to other runtime
8445: variables.
8446:
8447: Procedures shall be written such that it is possible to call the procedure more
8448: than once. That is, the file must not contain multiple-inclusion guards.
8449:
8450: Examples for procedures are mk/bsd.options.mk and mk/buildlink3/bsd.builtin.mk.
8451: To express that the parameters are evaluated at load time, they should be
8452: assigned using the := operator, which should be used only for this purpose.
8453:
1.184 rillig 8454: 25.5.2. Actions taken on behalf of parameters
1.1 dsieger 8455:
8456: Action files take some input parameters and may define runtime variables. They
8457: shall not define loadtime variables. There are action files that are included
8458: implicitly by the pkgsrc infrastructure, while other must be included
8459: explicitly.
8460:
8461: An example for action files is mk/subst.mk.
8462:
1.184 rillig 8463: 25.6. The order in which files are loaded
1.1 dsieger 8464:
8465: Package Makefiles usually consist of a set of variable definitions, and include
8466: the file ../../mk/bsd.pkg.mk in the very last line. Before that, they may also
8467: include various other *.mk files if they need to query the availability of
8468: certain features like the type of compiler or the X11 implementation. Due to
8469: the heavy use of preprocessor directives like .if and .for, the order in which
8470: the files are loaded matters.
8471:
8472: This section describes at which point the various files are loaded and gives
8473: reasons for that order.
8474:
1.184 rillig 8475: 25.6.1. The order in bsd.prefs.mk
1.1 dsieger 8476:
8477: The very first action in bsd.prefs.mk is to define some essential variables
8478: like OPSYS, OS_VERSION and MACHINE_ARCH.
8479:
1.4 rillig 8480: Then, the user settings are loaded from the file specified in MAKECONF, which
8481: is usually mk.conf. After that, those variables that have not been overridden
8482: by the user are loaded from mk/defaults/mk.conf.
1.1 dsieger 8483:
8484: After the user settings, the system settings and platform settings are loaded,
8485: which may override the user settings.
8486:
8487: Then, the tool definitions are loaded. The tool wrappers are not yet in effect.
8488: This only happens when building a package, so the proper variables must be used
8489: instead of the direct tool names.
8490:
8491: As the last steps, some essential variables from the wrapper and the package
8492: system flavor are loaded, as well as the variables that have been cached in
8493: earlier phases of a package build.
8494:
1.184 rillig 8495: 25.6.2. The order in bsd.pkg.mk
1.1 dsieger 8496:
8497: First, bsd.prefs.mk is loaded.
8498:
8499: Then, the various *-vars.mk files are loaded, which fill default values for
8500: those variables that have not been defined by the package. These variables may
8501: later be used even in unrelated files.
8502:
8503: Then, the file bsd.pkg.error.mk provides the target error-check that is added
8504: as a special dependency to all other targets that use DELAYED_ERROR_MSG or
8505: DELAYED_WARNING_MSG.
8506:
8507: Then, the package-specific hacks from hacks.mk are included.
8508:
8509: Then, various other files follow. Most of them don't have any dependencies on
8510: what they need to have included before or after them, though some do.
8511:
8512: The code to check PKG_FAIL_REASON and PKG_SKIP_REASON is then executed, which
8513: restricts the use of these variables to all the files that have been included
8514: before. Appearances in later files will be silently ignored.
8515:
8516: Then, the files for the main targets are included, in the order of later
8517: execution, though the actual order should not matter.
8518:
8519: At last, some more files are included that don't set any interesting variables
8520: but rather just define make targets to be executed.
8521:
1.184 rillig 8522: Chapter 26. Regression tests
1.1 dsieger 8523:
8524: Table of Contents
8525:
1.184 rillig 8526: 26.1. Running the regression tests
8527: 26.2. Adding a new regression test
8528: 26.2.1. Overridable functions
8529: 26.2.2. Helper functions
1.1 dsieger 8530:
8531: The pkgsrc infrastructure consists of a large codebase, and there are many
8532: corners where every little bit of a file is well thought out, making pkgsrc
8533: likely to fail as soon as anything is changed near those parts. To prevent most
8534: changes from breaking anything, a suite of regression tests should go along
8535: with every important part of the pkgsrc infrastructure. This chapter describes
8536: how regression tests work in pkgsrc and how you can add new tests.
8537:
1.184 rillig 8538: 26.1. Running the regression tests
1.1 dsieger 8539:
1.25 wiz 8540: You first need to install the pkgtools/pkg_regress package, which provides the
1.1 dsieger 8541: pkg_regress command. Then you can simply run that command, which will run all
1.168 rillig 8542: tests in the regress/ directory.
1.1 dsieger 8543:
1.184 rillig 8544: 26.2. Adding a new regression test
1.1 dsieger 8545:
1.168 rillig 8546: Every directory in the regress/ directory that contains a file called spec is
1.1 dsieger 8547: considered a regression test. This file is a shell program that is included by
8548: the pkg_regress command. The following functions can be overridden to suit your
8549: needs.
8550:
1.184 rillig 8551: 26.2.1. Overridable functions
1.1 dsieger 8552:
1.108 rillig 8553: These functions do not take any parameters. Although they are called in "set -e
1.168 rillig 8554: " mode, they don't stop at the first failing command. See this Stack Overflow
1.108 rillig 8555: question for details.
1.1 dsieger 8556:
1.108 rillig 8557: do_setup
1.1 dsieger 8558:
8559: This function prepares the environment for the test. By default it does
8560: nothing.
8561:
1.108 rillig 8562: do_test
1.1 dsieger 8563:
8564: This function runs the actual test. By default, it calls TEST_MAKE with the
8565: arguments MAKEARGS_TEST and writes its output including error messages into
8566: the file TEST_OUTFILE.
8567:
1.108 rillig 8568: When defining this function, make sure that all output that needs to be
8569: checked is written to the correct output file. Example:
8570:
8571: do_test() {
8572: echo "Example output"
8573: } 1>$TEST_OUTFILE 2>&1
8574:
8575: check_result
1.1 dsieger 8576:
8577: This function is run after the test and is typically used to compare the
8578: actual output from the one that is expected. It can make use of the various
1.108 rillig 8579: helper functions from the next section. Example:
8580:
8581: check_result() {
8582: exit_status 0
8583: output_require "Example"
8584: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
8585: output_prohibit "no such file or directory"
1.169 rillig 8586: regress_fail "expected $expected but got $actual for input $input"
1.108 rillig 8587: }
1.1 dsieger 8588:
1.108 rillig 8589: do_cleanup
1.1 dsieger 8590:
8591: This function cleans everything up after the test has been run. By default
8592: it does nothing.
8593:
1.184 rillig 8594: 26.2.2. Helper functions
1.1 dsieger 8595:
1.168 rillig 8596: regress_fail message...
8597:
8598: This function makes the test fail with the given error message.
8599:
1.108 rillig 8600: exit_status expected
1.1 dsieger 8601:
1.108 rillig 8602: This function compares the exitcode of the do_test function with its first
8603: parameter. If they differ, the test will fail.
1.1 dsieger 8604:
1.108 rillig 8605: output_require regex...
1.1 dsieger 8606:
8607: This function checks for each of its parameters if the output from do_test
1.108 rillig 8608: matches the extended regular expression. If it does not, the test will
8609: fail. Example:
8610:
8611: output_require "looks fine"
8612: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.1 dsieger 8613:
1.177 leot 8614: output_prohibit regex...
1.1 dsieger 8615:
8616: This function checks for each of its parameters if the output from do_test
8617: () does not match the extended regular expression. If any of the regular
8618: expressions matches, the test will fail.
8619:
1.184 rillig 8620: Chapter 27. Porting pkgsrc
1.1 dsieger 8621:
8622: Table of Contents
8623:
1.184 rillig 8624: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8625:
8626: The pkgsrc system has already been ported to many operating systems, hardware
8627: architectures and compilers. This chapter explains the necessary steps to make
8628: pkgsrc even more portable.
8629:
1.184 rillig 8630: 27.1. Porting pkgsrc to a new operating system
1.1 dsieger 8631:
8632: To port pkgsrc to a new operating system (called MyOS in this example), you
8633: need to touch the following files:
8634:
8635: pkgtools/bootstrap-mk-files/files/mods/MyOS.sys.mk
8636:
8637: This file contains some basic definitions, for example the name of the C
8638: compiler.
8639:
8640: mk/bsd.prefs.mk
8641:
1.212 wiz 8642: Insert code that defines the variables OPSYS, OS_VERSION, OPSYS_VERSION,
1.1 dsieger 8643: LOWER_VENDOR, MACHINE_ARCH, OBJECT_FMT, APPEND_ELF, and the other variables
8644: that appear in this file.
8645:
8646: mk/platform/MyOS.mk
8647:
8648: This file contains the platform-specific definitions that are used by
8649: pkgsrc. Start by copying one of the other files and edit it to your needs.
8650:
8651: mk/tools/tools.MyOS.mk
8652:
8653: This file defines the paths to all the tools that are needed by one or the
8654: other package in pkgsrc, as well as by pkgsrc itself. Find out where these
8655: tools are on your platform and add them.
8656:
8657: Now, you should be able to build some basic packages, like lang/perl5, shells/
8658: bash.
8659:
8660: Appendix A. A simple example package: bison
8661:
8662: Table of Contents
8663:
8664: A.1. files
8665: A.1.1. Makefile
8666: A.1.2. DESCR
8667: A.1.3. PLIST
8668: A.1.4. Checking a package with pkglint
8669: A.2. Steps for building, installing, packaging
8670:
8671: We checked to find a piece of software that wasn't in the packages collection,
1.25 wiz 8672: and picked GNU bison. Quite why someone would want to have bison when Berkeley
1.1 dsieger 8673: yacc is already present in the tree is beyond us, but it's useful for the
8674: purposes of this exercise.
8675:
8676: A.1. files
8677:
8678: A.1.1. Makefile
8679:
1.2 rillig 8680: # $NetBSD$
1.1 dsieger 8681: #
8682:
8683: DISTNAME= bison-1.25
8684: CATEGORIES= devel
1.171 rillig 8685: MASTER_SITES= ${MASTER_SITE_GNU:=bison/}
1.1 dsieger 8686:
1.30 dholland 8687: MAINTAINER= pkgsrc-users@NetBSD.org
1.174 leot 8688: HOMEPAGE= https://www.gnu.org/software/bison/bison.html
1.1 dsieger 8689: COMMENT= GNU yacc clone
8690:
8691: GNU_CONFIGURE= yes
1.47 wiz 8692: INFO_FILES= yes
1.1 dsieger 8693:
8694: .include "../../mk/bsd.pkg.mk"
8695:
8696: A.1.2. DESCR
8697:
8698: GNU version of yacc. Can make re-entrant parsers, and numerous other
8699: improvements. Why you would want this when Berkeley yacc(1) is part
8700: of the NetBSD source tree is beyond me.
8701:
8702: A.1.3. PLIST
8703:
1.2 rillig 8704: @comment $NetBSD$
1.1 dsieger 8705: bin/bison
8706: man/man1/bison.1.gz
8707: share/bison.simple
8708: share/bison.hairy
8709:
8710: A.1.4. Checking a package with pkglint
8711:
8712: The NetBSD package system comes with pkgtools/pkglint which helps to check the
8713: contents of these files. After installation it is quite easy to use, just
1.171 rillig 8714: change to the directory of the package you wish to examine and run pkglint:
1.1 dsieger 8715:
8716: $ pkglint
1.171 rillig 8717: ERROR: Makefile: Each package must define its LICENSE.
8718: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
8719: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
8720: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
8721: 1 error, 2 warnings and 1 note found.
8722: (Run "pkglint -e" to show explanations.)
8723: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172 rillig 8724: (Run "pkglint -F" to automatically fix some issues.)
1.1 dsieger 8725:
8726: Depending on the supplied command line arguments (see pkglint(1)), more checks
1.170 rillig 8727: will be performed. Use e.g. pkglint -Wall for a very thorough check.
1.1 dsieger 8728:
8729: A.2. Steps for building, installing, packaging
8730:
8731: Create the directory where the package lives, plus any auxiliary directories:
8732:
8733: # cd /usr/pkgsrc/lang
8734: # mkdir bison
8735: # cd bison
8736: # mkdir patches
8737:
1.184 rillig 8738: Create Makefile, DESCR and PLIST (see Chapter 12, Package components - files,
1.1 dsieger 8739: directories and contents) then continue with fetching the distfile:
8740:
8741: # make fetch
8742: >> bison-1.25.tar.gz doesn't seem to exist on this system.
8743: >> Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
8744: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8745: ftp: Error retrieving file: 500 Internal error
8746:
8747: >> Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
8748: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8749: ftp: Error retrieving file: 500 Internal error
8750:
8751: >> Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
8752: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
8753: Successfully retrieved file.
8754:
8755: Generate the checksum of the distfile into distinfo:
8756:
8757: # make makedistinfo
8758:
8759: Now compile:
8760:
8761: # make
8762: >> Checksum OK for bison-1.25.tar.gz.
8763: ===> Extracting for bison-1.25
8764: ===> Patching for bison-1.25
8765: ===> Ignoring empty patch directory
8766: ===> Configuring for bison-1.25
8767: creating cache ./config.cache
8768: checking for gcc... cc
8769: checking whether we are using GNU C... yes
8770: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
8771: checking how to run the C preprocessor... cc -E
8772: checking for minix/config.h... no
8773: checking for POSIXized ISC... no
8774: checking whether cross-compiling... no
8775: checking for ANSI C header files... yes
8776: checking for string.h... yes
8777: checking for stdlib.h... yes
8778: checking for memory.h... yes
8779: checking for working const... yes
8780: checking for working alloca.h... no
8781: checking for alloca... yes
8782: checking for strerror... yes
8783: updating cache ./config.cache
8784: creating ./config.status
8785: creating Makefile
8786: ===> Building for bison-1.25
8787: 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
8788: 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
8789: 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
8790: 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
8791: 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
8792: 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
8793: 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
8794: 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
8795: 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
8796: 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
8797: 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
8798: 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
8799: 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
8800: 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
8801: 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
8802: 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
8803: 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
8804: 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
8805: 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
8806: 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
8807: 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
8808: 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
8809: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
8810: rm -f bison.s1
8811: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" < ./bison.simple > bison.s1
8812:
8813: Everything seems OK, so install the files:
8814:
8815: # make install
8816: >> Checksum OK for bison-1.25.tar.gz.
8817: ===> Installing for bison-1.25
8818: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share /usr/pkg/info /usr/pkg/man/man1
8819: rm -f /usr/pkg/bin/bison
8820: cd /usr/pkg/share; rm -f bison.simple bison.hairy
8821: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
8822: install -c -o bin -g bin -m 555 bison /usr/pkg/bin/bison
8823: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
8824: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
8825: cd .; for f in bison.info*; do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
8826: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
8827: ===> Registering installation for bison-1.25
8828:
8829: You can now use bison, and also - if you decide so - remove it with pkg_delete
8830: bison. Should you decide that you want a binary package, do this now:
8831:
8832: # make package
8833: >> Checksum OK for bison-1.25.tar.gz.
8834: ===> Building package for bison-1.25
8835: Creating package bison-1.25.tgz
8836: Registering depends:.
8837: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'
8838:
8839: Now that you don't need the source and object files any more, clean up:
8840:
8841: # make clean
8842: ===> Cleaning for bison-1.25
8843:
1.207 leot 8844: Appendix B. Security hardening
8845:
8846: Table of Contents
8847:
8848: B.1. Mechanisms
8849: B.1.1. Enabled by default
8850: B.1.2. Not enabled by default
8851: B.2. Caveats
8852: B.2.1. Problems with PKGSRC_MKPIE
8853: B.2.2. Problems with PKGSRC_USE_FORTIFY
8854: B.2.3. Problems with PKGSRC_USE_RELRO
8855: B.2.4. Problems with PKGSRC_USE_SSP
8856: B.3. Auditing the system
8857: B.3.1. Checking for PIE
8858: B.3.2. Checking for partial RELRO
8859: B.3.3. Checking for full RELRO
8860: B.3.4. Checking for SSP
8861:
8862: A number of mechanisms are available in pkgsrc to improve the security of the
8863: resulting system. This page describes the mechanisms, and gives hints about
8864: detecting and fixing problems.
8865:
8866: Mechanisms can be enabled individually in mk.conf, and are individually
8867: described below.
8868:
8869: Typically, a feature will cause some programs to fail to build or work when
8870: first enabled. This can be due to latent problems in the program, and can be
8871: due to other reasons. After enough testing to have confidence that user
8872: problems will be quite rare, individual mechanisms will be enabled by default.
8873:
8874: For each mechanism, see the Caveats section below for an explanation of what
8875: might go wrong at compile time and at run time, and how to notice and address
8876: these problems.
8877:
8878: B.1. Mechanisms
8879:
8880: B.1.1. Enabled by default
8881:
8882: B.1.1.1. PKGSRC_USE_FORTIFY
8883:
8884: This allows substitute wrappers to be used for some commonly used library
8885: functions that do not have built-in bounds checking - but could in some cases.
8886:
8887: Two mitigation levels are available:
8888:
8889: * "weak" only enables checks at compile-time.
8890:
8891: * "strong" enables checks at compile-time and runtime.
8892:
8893: "strong" has been enabled by default since pkgsrc-2017Q3.
8894:
8895: B.1.1.2. PKGSRC_USE_SSP
8896:
8897: This enables a stack-smashing protection mitigation. It is done by adding a
8898: guard variable to functions with vulnerable objects. The guards are initialized
8899: when a function is entered and then checked when the function exits. The guard
8900: check will fail and the program forcibly exited if the variable was modified in
8901: the meantime. This can happen in case of buffer overflows or memory corruption,
8902: and therefore exposing these bugs.
8903:
8904: Different mitigation levels are available:
8905:
8906: * "yes", which will only protect functions considered vulnerable by the
8907: compiler;
8908:
8909: * "all", which will protect every function;
8910:
8911: * "strong", the default, which will apply a better balance between the two
8912: settings above.
8913:
8914: This mitigation is supported by both GCC and clang. It may be supported in
8915: additional compilers, possibly under a different name. It is particularly
8916: useful for unsafe programming languages, such as C/C++.
8917:
8918: * "yes" is enabled by default where known supported since pkgsrc-2017Q3.
8919:
8920: * "strong" is enabled by default where known supported since pkgsrc-2021Q4.
8921:
8922: More details can be found here:
8923:
8924: * Buffer overflow protection on Wikipedia
8925:
8926: B.1.1.3. PKGSRC_MKPIE
8927:
8928: This requests the creation of PIE (Position Independent Executables) for all
8929: executables. The PIE mechanism is normally used for shared libraries, so that
8930: they can be loaded at differing addresses at runtime. PIE itself does not have
8931: useful security properties; however, it is necessary to fully leverage some,
8932: such as ASLR. Some operating systems support Address Space Layout Randomization
8933: (ASLR), which causes different addresses to be used each time a program is run.
8934: This makes it more difficult for an attacker to guess addresses and thus makes
8935: exploits harder to construct. With PIE, ASLR can really be applied to the
8936: entire program, instead of the stack and heap only.
8937:
8938: PIE executables will only be built for toolchains that are known to support
8939: PIE. Currently, this means NetBSD on x86, ARM, SPARC64, m68k, and MIPS.
8940:
8941: PKGSRC_MKPIE was enabled by default after the pkgsrc-2021Q3 branch.
8942:
1.219 nia 8943: B.1.1.4. PKGSRC_USE_RELRO
1.207 leot 8944:
8945: This also makes the exploitation of some security vulnerabilities more
8946: difficult in some cases.
8947:
8948: Two different mitigation levels are available:
8949:
1.219 nia 8950: * partial (the default): the ELF sections are reordered so that internal data
8951: sections precede the program's own data sections, and non-PLT GOT is
8952: read-only;
1.207 leot 8953:
8954: * full: in addition to partial RELRO, every relocation is performed
1.218 nia 8955: immediately when starting the program, allowing the entire GOT to be
8956: read-only. This can greatly slow down startup of large programs.
1.207 leot 8957:
8958: This is currently supported by GCC. Many software distributions now enable this
1.220 nia 8959: feature by default, at the "partial" level.
1.207 leot 8960:
8961: More details can be found here:
8962:
8963: * Hardening ELF binaries using Relocation Read-Only (RELRO)
8964:
1.219 nia 8965: B.1.2. Not enabled by default
8966:
8967: B.1.2.1. PKGSRC_MKREPRO
8968:
8969: With this option, pkgsrc will try to build packages reproducibly. This allows
8970: packages built from the same tree and with the same options, to produce
8971: identical results bit by bit. This option should be combined with ASLR and
8972: PKGSRC_MKPIE to avoid predictable address offsets for attackers attempting to
8973: exploit security vulnerabilities.
8974:
8975: More details can be found here:
8976:
8977: * Reproducible Builds - a set of software development practices that create
8978: an independently-verifiable path from source to binary code
8979:
8980: More work likely needs to be done before pkgsrc is fully reproducible.
8981:
8982: B.1.2.2. PKGSRC_USE_STACK_CHECK
1.207 leot 8983:
8984: This uses -fstack-check with GCC for another stack protection mitigation.
8985:
8986: It asks the compiler to generate code verifying that it does not corrupt the
8987: stack. According to GCC's manual page, this is really only useful for
8988: multi-threaded programs.
8989:
8990: B.2. Caveats
8991:
8992: B.2.1. Problems with PKGSRC_MKPIE
8993:
8994: B.2.1.1. Packages failing to build
8995:
8996: A number of packages may fail to build with this option enabled. The failures
8997: are often related to the absence of the -fPIC compilation flag when building
8998: libraries or executables (or ideally -fPIE in the latter case). This flag is
8999: added to the CFLAGS already, but requires the package to actually support it.
9000:
9001: B.2.1.1.1. How to fix
9002:
9003: These instructions are meant as a reference only; they likely need to be
9004: adapted for many packages individually.
9005:
9006: For packages using Makefiles:
9007:
9008: MAKE_FLAGS+= CFLAGS=${CFLAGS:Q}
9009: MAKE_FLAGS+= LDFLAGS=${LDFLAGS:Q}
9010:
9011: For packages using Imakefiles:
9012:
9013: MAKE_FLAGS+= CCOPTIONS=${CFLAGS:Q}
9014: MAKE_FLAGS+= LOCAL_LDFLAGS=${LDFLAGS:Q}
9015:
9016: B.2.1.2. Run-time crashes
9017:
9018: Some programs may fail to run, or crash at random times once built as PIE. Two
9019: scenarios are essentially possible. This is nearly always due to a bug in the
9020: program being exposed due to ASLR.
9021:
9022: B.2.1.3. Disabling PKGSRC_MKPIE on a per-package basis
9023:
9024: Ideally, packages should be fixed for compatibility with MKPIE. However, in
9025: some cases this is very difficult, due to complex build systems, packages using
9026: non-standard toolchains, or programming languages with odd bootstrapping
9027: mechanisms.
9028:
9029: To disable PKGSRC_MKPIE on a per-package basis, set MKPIE_SUPPORTED= no in the
9030: package's Makefile before bsd.prefs.mk is included.
9031:
9032: B.2.2. Problems with PKGSRC_USE_FORTIFY
9033:
9034: B.2.2.1. Packages failing to build
9035:
9036: This feature makes use of pre-processing directives to look for hardened,
9037: alternative implementations of essential library calls. Some programs may fail
9038: to build as a result; this usually happens for those trying too hard to be
9039: portable, or otherwise abusing definitions in the standard library.
9040:
9041: B.2.2.2. Run-time crashes
9042:
9043: This feature may cause some programs to crash, usually indicating an actual bug
9044: in the program. The fix will typically involve patching the original program's
9045: source code.
9046:
9047: B.2.2.3. Optimization is required
9048:
9049: At least in the case of GCC, FORTIFY will only be applied if optimization is
9050: applied while compiling. This means that the CFLAGS should also contain -O, -O2
9051: or another optimization level. This cannot easily be applied globally, as some
9052: packages may require specific optimization levels.
9053:
9054: B.2.2.4. Disabling FORTIFY on a per-package basis
9055:
9056: Note
9057:
9058: FORTIFY should not be disabled to work around runtime crashes in the program!
9059: This is a very bad idea and will expose you to security vulnerabilities.
9060:
9061: To disable FORTIFY on a per-package basis, set the following in the package's
9062: Makefile before bsd.prefs.mk is included:
9063:
9064: FORTIFY_SUPPORTED= no
9065:
9066: B.2.3. Problems with PKGSRC_USE_RELRO
9067:
9068: B.2.3.1. Performance impact
9069:
9070: For better protection, full RELRO requires every symbol to be resolved when the
9071: program starts, rather than simply when required at run-time. This will have
9072: more impact on programs using a lot of symbols, or linked to libraries exposing
9073: a lot of symbols. Therefore, daemons or programs otherwise running in
9074: background are affected only when started. Programs loading plug-ins at
9075: run-time are affected when loading the plug-ins.
9076:
9077: The impact is not expected to be noticeable on modern hardware, except in some
9078: cases for big programs.
9079:
9080: B.2.3.2. Run-time crashes
9081:
9082: Some programs handle plug-ins and dependencies in a way that conflicts with
9083: RELRO: for instance, with an initialization routine listing any other plug-in
9084: required. With full RELRO, the missing symbols are resolved before the
9085: initialization routine can run, and the dynamic loader will not be able to find
9086: them directly and abort as a result. Unfortunately, this is how Xorg loads its
9087: drivers. Partial RELRO can be applied instead in this case.
9088:
9089: B.2.3.3. Disabling RELRO on a per-package basis
9090:
9091: To disable RELRO on a per-package basis, set the following in the package's
9092: Makefile before bsd.prefs.mk is included:
9093:
9094: RELRO_SUPPORTED= no
9095:
1.209 nia 9096: It is also possible to at most enable partial RELRO, by setting RELRO_SUPPORTED
9097: to partial.
9098:
1.207 leot 9099: B.2.4. Problems with PKGSRC_USE_SSP
9100:
9101: B.2.4.1. Packages failing to build
9102:
9103: The stack-smashing protection provided by this option does not work for some
9104: programs. The most common situation in which this happens is when the program
9105: allocates variables on the stack, with the size determined at run-time.
9106:
9107: B.2.4.2. Run-time crashes
9108:
9109: Again, this feature may cause some programs to crash via a SIGABRT, usually
9110: indicating an actual bug in the program.
9111:
9112: On NetBSD LOG_CRIT level syslog messages are sent and - by default - appended
9113: to /var/log/messages, e.g.:
9114:
9115: Jan 6 15:42:51 hostname -: hostname program - - - buffer overflow detected; terminated
9116:
9117: (where hostname is the hostname(1) and program is the basename(1) of the
9118: program crashed).
9119:
9120: Patching the original program is then required.
9121:
9122: Rebuilding the package via:
9123:
9124: % env CFLAGS=-g INSTALL_UNSTRIPPED=yes make replace
9125:
9126: and inspecting the backtrace of the coredump via the debugger should point out
9127: the problematic call by inspecting the frame calling the _chk() (SSP) function.
9128:
9129: B.2.4.3. Performance impact
9130:
9131: The compiler emits extra code when using this feature: a check for buffer
9132: overflows is performed when entering and exiting functions, requiring an extra
9133: variable on the stack. The level of protection can otherwise be adjusted to
9134: affect only those functions considered more sensitive by the compiler (with
9135: -fstack-protector instead of -fstack-protector-all).
9136:
9137: The impact is not expected to be noticeable on modern hardware. However,
9138: programs with a hard requirement to run at the fastest possible speed should
9139: avoid using this feature, or using libraries built with this feature.
9140:
9141: B.2.4.4. Disabling SSP on a per-package basis
9142:
9143: Note
9144:
9145: SSP should not be disabled to work around runtime crashes in the program! This
9146: is a very bad idea and will expose you to security vulnerabilities.
9147:
9148: To disable SSP on a per-package basis, set the following in the package's
9149: Makefile before bsd.prefs.mk is included:
9150:
9151: SSP_SUPPORTED= no
9152:
9153: B.3. Auditing the system
9154:
9155: The illusion of security is worse than having no security at all. This section
9156: lists a number of ways to ensure the security features requested are actually
9157: effective.
9158:
9159: These instructions were obtained and tested on a system derived from NetBSD 7
9160: (amd64). YMMV.
9161:
9162: B.3.1. Checking for PIE
9163:
9164: The ELF executable type in use changes for binaries built as PIE; without:
9165:
9166: $ file /path/to/bin/ary
9167: /path/to/bin/ary: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), dynamically linked (uses shared libs), for NetBSD 7.0, not stripped
9168:
9169: as opposed to the following binary, built as PIE:
9170:
9171: $ file /path/to/pie/bin/ary
9172: /path/to/pie/bin/ary: ELF 64-bit LSB shared object, x86-64, version 1 (SYSV), dynamically linked (uses shared libs), for NetBSD 7.0, not stripped
9173:
9174: The latter result is then what is expected.
9175:
9176: B.3.2. Checking for partial RELRO
9177:
9178: The following command should list a section called RELRO:
9179:
9180: $ objdump -p /path/to/bin/ary
9181:
9182: /path/to/bin/ary: file format elf64-x86-64
9183:
9184: Program Header:
9185: [...]
9186: RELRO off 0x0000000000000d78 vaddr 0x0000000000600d78 paddr 0x0000000000600d78 align 2**0
9187:
9188: This check is now performed automatically if PKG_DEVELOPER is set and RELRO is
9189: enabled.
9190:
9191: B.3.3. Checking for full RELRO
9192:
9193: The dynamic loader will apply RELRO immediately when detecting the presence of
9194: the BIND_NOW flag:
9195:
9196: $ objdump -x /path/to/bin/ary
9197:
9198: /path/to/bin/ary: file format elf64-x86-64
9199:
9200: Dynamic Section:
9201: [...]
9202: BIND_NOW 0x0000000000000000
9203:
9204: This has to be combined with partial RELRO (see above) to be fully efficient.
9205:
9206: This check is now performed automatically (where supported) if PKG_DEVELOPER is
9207: set.
9208:
9209: B.3.4. Checking for SSP
9210:
1.208 nia 9211: Note
9212:
9213: Checking for SSP using this method only works where the operating system uses
9214: libssp. libssp is not used on recent NetBSD/FreeBSD/Linux versions.
9215:
1.207 leot 9216: Building objects, binaries and libraries with SSP will affect the presence of
9217: additional symbols in the resulting file:
9218:
9219: $ nm /path/to/bin/ary
9220: [...]
9221: U __stack_chk_fail
9222: 0000000000600ea0 B __stack_chk_guard
9223:
9224: This is an indicator that the program was indeed built with support for SSP.
9225:
9226: This check is now performed automatically (where supported) if PKG_DEVELOPER is
9227: set and SSP is enabled.
9228:
9229: Appendix C. Build logs
1.1 dsieger 9230:
9231: Table of Contents
9232:
1.207 leot 9233: C.1. Building figlet
9234: C.2. Packaging figlet
1.1 dsieger 9235:
1.207 leot 9236: C.1. Building figlet
1.1 dsieger 9237:
9238: # make
9239: ===> Checking for vulnerabilities in figlet-2.2.1nb2
9240: => figlet221.tar.gz doesn't seem to exist on this system.
9241: => Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
9242: => [172219 bytes]
9243: Connected to ftp.plig.net.
9244: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
9245: 331 Guest login ok, send your complete e-mail address as password.
9246: 230-You are user #5 of 500 simultaneous users allowed.
9247: 230-
9248: 230- ___ _ _ _
9249: 230- | _| |_ ___ ___| |_|___ ___ ___ ___
9250: 230- | _| _| . |_| . | | | . |_| . | _| . |
9251: 230- |_| |_| | _|_| _|_|_|_ |_|___|_| |_ |
9252: 230- |_| |_| |___| |___|
9253: 230-
9254: 230-** Welcome to ftp.plig.org **
9255: 230-
9256: 230-Please note that all transfers from this FTP site are logged. If you
9257: 230-do not like this, please disconnect now.
9258: 230-
1.19 snj 9259: 230-This archive is available via
1.1 dsieger 9260: 230-
9261: 230-HTTP: http://ftp.plig.org/
9262: 230-FTP: ftp://ftp.plig.org/ (max 500 connections)
9263: 230-RSYNC: rsync://ftp.plig.org/ (max 30 connections)
9264: 230-
9265: 230-Please email comments, bug reports and requests for packages to be
9266: 230-mirrored to ftp-admin@plig.org.
9267: 230-
9268: 230-
9269: 230 Logged in anonymously.
9270: Remote system type is UNIX.
9271: Using binary mode to transfer files.
9272: 200 Type okay.
9273: 250 "/pub" is new cwd.
9274: 250-"/pub/figlet" is new cwd.
9275: 250-
9276: 250-Welcome to the figlet archive at ftp.figlet.org
9277: 250-
9278: 250- ftp://ftp.figlet.org/pub/figlet/
9279: 250-
9280: 250-The official FIGlet web page is:
9281: 250- http://www.figlet.org/
9282: 250-
9283: 250-If you have questions, please mailto:info@figlet.org. If you want to
9284: 250-contribute a font or something else, you can email us.
9285: 250
9286: 250 "/pub/figlet/program" is new cwd.
9287: 250 "/pub/figlet/program/unix" is new cwd.
9288: local: figlet221.tar.gz remote: figlet221.tar.gz
9289: 502 Unimplemented command.
9290: 227 Entering Passive Mode (195,40,6,41,246,104)
9291: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
9292: 38% |************** | 65800 64.16 KB/s 00:01 ETA
9293: 226 Transfer completed.
9294: 172219 bytes received in 00:02 (75.99 KB/s)
9295: 221 Goodbye.
9296: => Checksum OK for figlet221.tar.gz.
9297: ===> Extracting for figlet-2.2.1nb2
9298: ===> Required installed package ccache-[0-9]*: ccache-2.3nb1 found
9299: ===> Patching for figlet-2.2.1nb2
9300: ===> Applying pkgsrc patches for figlet-2.2.1nb2
9301: ===> Overriding tools for figlet-2.2.1nb2
9302: ===> Creating toolchain wrappers for figlet-2.2.1nb2
9303: ===> Configuring for figlet-2.2.1nb2
9304: ===> Building for figlet-2.2.1nb2
9305: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\" -DDEFAULTFONTFILE=\"standard.flf\" figlet.c zipio.c crc.c inflate.c -o figlet
9306: chmod a+x figlet
9307: gcc -O2 -o chkfont chkfont.c
9308: => Unwrapping files-to-be-installed.
9309: #
9310: # make install
9311: ===> Checking for vulnerabilities in figlet-2.2.1nb2
9312: ===> Installing for figlet-2.2.1nb2
9313: install -d -o root -g wheel -m 755 /usr/pkg/bin
9314: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
9315: mkdir -p /usr/pkg/share/figlet
9316: cp figlet /usr/pkg/bin
9317: cp chkfont /usr/pkg/bin
9318: chmod 555 figlist showfigfonts
9319: cp figlist /usr/pkg/bin
9320: cp showfigfonts /usr/pkg/bin
9321: cp fonts/*.flf /usr/pkg/share/figlet
9322: cp fonts/*.flc /usr/pkg/share/figlet
9323: cp figlet.6 /usr/pkg/man/man6
9324: ===> Registering installation for figlet-2.2.1nb2
9325: #
9326:
1.207 leot 9327: C.2. Packaging figlet
1.1 dsieger 9328:
9329: # make package
9330: ===> Checking for vulnerabilities in figlet-2.2.1nb2
9331: ===> Packaging figlet-2.2.1nb2
9332: ===> Building binary package for figlet-2.2.1nb2
9333: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
9334: Using SrcDir value of /usr/pkg
9335: Registering depends:.
9336: #
9337:
1.207 leot 9338: Appendix D. Directory layout of the pkgsrc FTP server
1.1 dsieger 9339:
9340: Table of Contents
9341:
1.207 leot 9342: D.1. distfiles: The distributed source files
9343: D.2. misc: Miscellaneous things
9344: D.3. packages: Binary packages
9345: D.4. reports: Bulk build reports
9346: D.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 9347:
9348: As in other big projects, the directory layout of pkgsrc is quite complex for
9349: newbies. This chapter explains where you find things on the FTP server. The
9350: base directory on ftp.NetBSD.org is /pub/pkgsrc/. On other servers it may be
9351: different, but inside this directory, everything should look the same, no
9352: matter on which server you are. This directory contains some subdirectories,
9353: which are explained below.
9354:
1.207 leot 9355: D.1. distfiles: The distributed source files
1.1 dsieger 9356:
9357: The directory distfiles contains lots of archive files from all pkgsrc
9358: packages, which are mirrored here. The subdirectories are called after their
9359: package names and are used when the distributed files have names that don't
9360: explicitly contain a version number or are otherwise too generic (for example
9361: release.tar.gz).
9362:
1.207 leot 9363: D.2. misc: Miscellaneous things
1.1 dsieger 9364:
9365: This directory contains things that individual pkgsrc developers find worth
9366: publishing.
9367:
1.207 leot 9368: D.3. packages: Binary packages
1.1 dsieger 9369:
1.3 rillig 9370: This directory contains binary packages for the various platforms that are
9371: supported by pkgsrc. Each subdirectory is of the form OPSYS/ARCH/OSVERSION_TAG.
9372: The meaning of these variables is:
9373:
9374: * OPSYS is the name of the operating system for which the packages have been
1.9 rillig 9375: built. The name is taken from the output of the uname command, so it may
9376: differ from the one you are used to hear.
1.3 rillig 9377:
1.8 rillig 9378: * ARCH is the hardware architecture of the platform for which the packages
1.10 hubertf 9379: have been built. It also includes the ABI (Application Binary Interface)
9380: for platforms that have several of them.
1.3 rillig 9381:
1.255 wiz 9382: * OSVERSION is the version of the operating system. Typically it is the
9383: version defining an ABI, e.g. 9.0.
9384:
9385: * TAG is either 20YYQN for a stable branch, or current for packages built
9386: from the HEAD branch. The latter should only be used when the packages are
9387: updated on a regular basis.
9388:
9389: The rationale for this scheme is that users can first search by OPSYS and ARCH,
9390: since these are more or less unchangeable. After that, there is a management
9391: set of directories with OSVERSION and TAG.
9392:
9393: See also README.md in packages for more details, including about symlinks.
1.3 rillig 9394:
9395: In each of these directories, there is a whole binary packages collection for a
9396: specific platform. It has a directory called All which contains all binary
1.255 wiz 9397: packages.
1.1 dsieger 9398:
1.207 leot 9399: D.4. reports: Bulk build reports
1.8 rillig 9400:
9401: Here are the reports from bulk builds, for those who want to fix packages that
9402: didn't build on some of the platforms. The structure of subdirectories should
1.207 leot 9403: look like the one in Section D.3, "packages: Binary packages".
1.8 rillig 9404:
1.207 leot 9405: D.5. current, stable, pkgsrc-20xxQy: source packages
1.1 dsieger 9406:
9407: These directories contain the "real" pkgsrc, that is the files that define how
9408: to create binary packages from source archives.
9409:
1.149 leot 9410: Each of the current, stable and pkgsrc-20xxQy directories share the same
9411: structure. They each contain a pkgsrc directory and pkgsrc.tar.{bz,gz,xz} file.
9412:
1.1 dsieger 9413: The directory pkgsrc contains a snapshot of the CVS repository, which is
1.149 leot 9414: updated regularly. The file pkgsrc.tar.{bz,gz,xz} contains the same as the
9415: directory, ready to be downloaded as a whole.
1.1 dsieger 9416:
1.149 leot 9417: The current directory contains files related to the HEAD branch of the CVS
9418: repository. In this directory there is an additional file called
9419: pkgsrc-readmes.tar.{bz,gz,xz} that contains all pkgsrc READMEs with information
9420: about categories and packages.
9421:
9422: The stable directory is a symlink to the latest pkgsrc-20xxQy.
9423:
9424: The pkgsrc-20xxQy. directories contain files related to the -20xxQy stable
9425: branch of the CVS repository. In these directories there is an additional file
9426: called pkgsrc-20xxQy.tar.{bz,gz,xz}, which contains the state of pkgsrc when it
9427: was branched.
1.148 leot 9428:
1.207 leot 9429: Appendix E. Help topics
1.154 rillig 9430:
9431: The following list contains all help topics that are available when running
9432: bmake help topic=:index.
9433:
1.255 wiz 9434: #! -lintl
9435: 32bit 64bit
9436: ABI ACCEPTABLE_LICENSES
9437: ACROREAD_FONTPATH ADDITIONAL
9438: AFAIK AIX
9439: ALLOW_NETWORK_ACCESS ALLOW_NEWER_COMPILER
9440: ALLOW_VULNERABLE_PACKAGES ALL_ENV
9441: ALSA_PC ALTERNATIVES_SRC
9442: AMANDA_TMP AMANDA_USER
9443: AMANDA_VAR APACHE_GROUP
9444: APACHE_MODULE_NAME APACHE_MODULE_SRC
9445: APACHE_MODULE_SRCDIR APACHE_PKG_PREFIX
9446: APACHE_SUEXEC_CONFIGURE_ARGS APACHE_SUEXEC_DOCROOT
9447: APACHE_USER ARLA_CACHE
9448: AUDIT_PACKAGES_FLAGS AUTOCONF_REQD
9449: AUTOMAKE_OVERRIDE AUTOMAKE_REQD
9450: AUTO_MKDIRS AUX
9451: BDB185_DEFAULT BDBBASE
9452: BDB_ACCEPTED BDB_DEFAULT
9453: BDB_LIBS BDB_TYPE
9454: BINCIMAP_GROUP BINCIMAP_LOG_USER
9455: BINCIMAP_USER BIND_DIR
9456: BIND_GROUP BIND_USER
9457: BINOWN BINPKG_SITES
9458: BIN_INSTALL_FLAGS BISON_PKGDATADIR
9459: BLAS BLAS_ACCEPTED
9460: BLAS_C_INTERFACE BLAS_INCLUDES
9461: BLAS_INDEX64 BLAS_LIBS
9462: BLAS_PC BLAS_TYPE
9463: BOOTSTRAP_DEPENDS BROKEN
9464: BROKEN_EXCEPT_ON_PLATFORM BROKEN_ON_PLATFORM
9465: BSDSRCDIR BSDXSRCDIR
9466: BSD_MAKE_ENV BUILDLINK_AUTO_DIRS
9467: BUILDLINK_AUTO_VARS BUILDLINK_CFLAGS
9468: BUILDLINK_CONTENTS_FILTER BUILDLINK_CPPFLAGS
9469: BUILDLINK_DEPMETHOD BUILDLINK_FILES
9470: BUILDLINK_FILES_CMD BUILDLINK_FNAME_TRANSFORM
9471: BUILDLINK_LDFLAGS BUILDLINK_LIBS
9472: BUILDLINK_OPSYS_SUPPORT_PTHREAD BUILDLINK_PKGNAME
9473: BUILDLINK_PREFIX BUILDLINK_RPATHDIRS
9474: BUILDLINK_TREE BUILD_DEFS
9475: BUILD_DEFS_EFFECTS BUILD_DEPENDS
9476: BUILD_DIRS BUILD_ENV_SHELL
9477: BUILD_MAKE_CMD BUILD_MAKE_FLAGS
9478: BUILD_TARGET BUILTIN_FIND_FILES
9479: BUILTIN_FIND_FILES_VAR BUILTIN_FIND_GREP
9480: BUILTIN_FIND_HEADERS BUILTIN_FIND_HEADERS_VAR
9481: BUILTIN_FIND_PKGCONFIG BUILTIN_FIND_PKGCONFIG_VAR
9482: BUILTIN_PKG BUILTIN_TEST_CURSES_DEFINES
9483: BUILTIN_TEST_CURSES_FUNCS BUILTIN_VERSION_SCRIPT
9484: BUILTIN_X11_TYPE BUILTIN_X11_VERSION
9485: CACTI_GROUP CACTI_USER
9486: CANNA_GROUP CANNA_USER
9487: CAT CBLAS_LIBS
9488: CBLAS_PC CCACHE_BASE
9489: CCACHE_DIR CCACHE_LOGFILE
1.256 ! wiz 9490: CCACHE_RECACHE CC_VERSION
! 9491: CC_VERSION_STRING CDRECORD_CONF
! 9492: CDROM_PKG_URL_DIR CDROM_PKG_URL_HOST
! 9493: CHANGES CHECKOUT_DATE
! 9494: CHECK_COMPILER CHECK_FAKEHOME
! 9495: CHECK_FILES CHECK_FILES_ONLY_PREFIX
! 9496: CHECK_FILES_SKIP CHECK_FILES_STRICT
! 9497: CHECK_HEADERS CHECK_HEADERS_SKIP
! 9498: CHECK_INTERPRETER CHECK_INTERPRETER_SKIP
! 9499: CHECK_PERMS CHECK_PERMS_AUTOFIX
! 9500: CHECK_PERMS_SKIP CHECK_PIE
! 9501: CHECK_PIE_SKIP CHECK_PIE_SUPPORTED
! 9502: CHECK_PORTABILITY CHECK_PORTABILITY_EXPERIMENTAL
! 9503: CHECK_PORTABILITY_SKIP CHECK_RELRO
! 9504: CHECK_RELRO_SKIP CHECK_RELRO_SUPPORTED
! 9505: CHECK_SHLIBS CHECK_SHLIBS_SKIP
! 9506: CHECK_SHLIBS_SUPPORTED CHECK_SHLIBS_TOXIC
! 9507: CHECK_SSP CHECK_SSP_SKIP
! 9508: CHECK_SSP_SUPPORTED CHECK_STRIPPED
! 9509: CHECK_STRIPPED_SKIP CHECK_WRKREF
! 9510: CHECK_WRKREF_EXTRA_DIRS CHECK_WRKREF_SKIP
! 9511: CLAMAV_DBDIR CLAMAV_GROUP
! 9512: CLAMAV_USER CLANGBASE
! 9513: CLEANDEPENDS CLT
! 9514: CMAKE_DEPENDENCIES_REWRITE CMAKE_INSTALL_NAME_DIR
! 9515: CMAKE_INSTALL_PREFIX CMAKE_MODULE_PATH_OVERRIDE
! 9516: CMAKE_PKGSRC_BUILD_FLAGS CMAKE_PREFIX_PATH
! 9517: CMAKE_USE_GNU_INSTALL_DIRS COMMON_LISP_DOCFILES
! 9518: COMMON_LISP_EXAMPLES COMMON_LISP_EXTRAFILES
! 9519: COMMON_LISP_PACKAGES COMMON_LISP_SYSTEM
! 9520: COMPILER_RPATH_FLAG COMPILER_USE_SYMLINKS
! 9521: CONFIGURE_ARGS CONFIGURE_DIRS
! 9522: CONFIGURE_ENV CONFIGURE_ENV_SHELL
! 9523: CONFIGURE_HAS_INFODIR CONFIGURE_HAS_MANDIR
! 9524: CONFIGURE_SCRIPT CONFIG_SHELL
! 9525: CONFIG_SHELL_FLAGS CONF_FILES
! 9526: CONF_FILES_MODE CONF_FILES_PERMS
! 9527: CONSERVER_DEFAULTHOST CONSERVER_DEFAULTPORT
! 9528: CP CPE
! 9529: CPE_EDITION CPE_LANG
! 9530: CPE_OTHER CPE_PART
! 9531: CPE_PRODUCT CPE_SW_EDITION
! 9532: CPE_TARGET_HW CPE_TARGET_SW
! 9533: CPE_UPDATE CPE_URI
! 9534: CPE_VENDOR CPE_VERSION
! 9535: CPP CPP_PRECOMP_FLAGS
! 9536: CREATE_WRKDIR_SYMLINK CROSSBASE
! 9537: CTFCONVERT CTF_FILES_SKIP
! 9538: CTF_SUPPORTED CTYPE
! 9539: CUPS_GROUP CUPS_SYSTEM_GROUPS
! 9540: CUPS_USER CURSES_DEFAULT
! 9541: CURSES_TYPE CVS_EXTRACTDIR
! 9542: CVS_MODULE CVS_PROJECT
! 9543: CVS_REPOSITORIES CVS_ROOT
! 9544: CVS_ROOT_GNU CVS_ROOT_NONGNU
! 9545: CVS_ROOT_SOURCEFORGE CVS_TAG
! 9546: CXX CYRUS_GROUP
! 9547: CYRUS_IDLE CYRUS_USER
! 9548: DAEMONTOOLS_GROUP DAEMONTOOLS_LOG_USER
! 9549: DARWIN_NO_SYSTEM_LIBS DARWIN_REQUIRES_FILTER
! 9550: DBUS_GROUP DBUS_USER
! 9551: DEFANG_GROUP DEFANG_USER
! 9552: DEFAULT_ACCEPTABLE_LICENSES DEFAULT_DISTFILES
! 9553: DEFAULT_IRC_SERVER DEFAULT_SERIAL_DEVICE
! 9554: DEF_UMASK DEINSTALLDEPENDS
! 9555: DEINSTALL_SRC DEINSTALL_TEMPLATES
! 9556: DELAYED_ERROR_MSG DELAYED_WARNING_MSG
! 9557: DEPENDS DEPENDS_TARGET
! 9558: DEPENDS_TYPE DESTDIR
! 9559: DESTDIR_VARNAME DIALER_GROUP
! 9560: DIGEST_REQD DISTDIR
! 9561: DISTFILES DISTINFO_FILE
! 9562: DISTNAME DIST_PATH
! 9563: DIST_SUBDIR DJBDNS_AXFR_USER
! 9564: DJBDNS_CACHE_USER DJBDNS_DJBDNS_GROUP
! 9565: DJBDNS_LOG_USER DJBDNS_RBL_USER
! 9566: DJBDNS_TINY_USER DLOPEN_REQUIRE_PTHREADS
! 9567: DL_AUTO_VARS DL_CFLAGS
! 9568: DL_LDFLAGS DL_LIBS
! 9569: DNS DOCOWN
! 9570: DOWNLOADED_DISTFILE DQCACHE_GROUP
! 9571: DQCACHE_USER DT_LAYOUT
! 9572: DYNAMIC_SITES_CMD DYNAMIC_SITES_SCRIPT
! 9573: ECHO ECHO_N
! 9574: ELK_GUI EMACS_TYPE
! 9575: EMULDIR EMULSUBDIR
! 9576: EMULSUBDIRSLASH EMUL_ARCH
! 9577: EMUL_DISTRO EMUL_EXEC_FMT
! 9578: EMUL_IS_NATIVE EMUL_MODULES
! 9579: EMUL_OPSYS EMUL_PKG_FMT
! 9580: EMUL_PLATFORM EMUL_PLATFORMS
! 9581: EMUL_PREFER EMUL_REQD
! 9582: EMUL_TYPE ERROR_MSG
! 9583: EXIM_GROUP EXIM_USER
! 9584: EXPORT_SYMBOLS_LDFLAGS EXTRACTOR
! 9585: EXTRACT_CMD EXTRACT_CMD_DEFAULT
! 9586: EXTRACT_DIR EXTRACT_ELEMENTS
! 9587: EXTRACT_ENV EXTRACT_ONLY
! 9588: EXTRACT_OPTS EXTRACT_SUFX
! 9589: EXTRACT_USING FAIL
! 9590: FAILOVER_FETCH FAIL_MSG
! 9591: FAKE_NCURSES FAM
! 9592: FAM_ACCEPTED FAM_DEFAULT
! 9593: FAM_SERVER FCPATH
! 9594: FEATURE_CPPFLAGS FEATURE_LDFLAGS
! 9595: FEATURE_LIBS FETCH_AFTER_ARGS
! 9596: FETCH_BEFORE_ARGS FETCH_CMD
! 9597: FETCH_OUTPUT_ARGS FETCH_PROXY
! 9598: FETCH_RESUME_ARGS FETCH_TIMEOUT
! 9599: FETCH_USE_IPV4_ONLY FETCH_USING
! 9600: FILES_SUBST FILES_SUBST_SED
! 9601: FIX_SYSTEM_HEADERS FONTDIR
! 9602: FONTS_DIRS FONTS_VERBOSE
! 9603: FOO_HACKS_MK FORCE_CXX_STD
! 9604: FORCE_C_STD FOSSIL_EXTRACTDIR
! 9605: FOSSIL_REPO FOSSIL_REPOSITORIES
! 9606: FOSSIL_VERSION FOX_USE_XUNICODE
! 9607: FREEWNN_GROUP FREEWNN_USER
! 9608: FTP_PKG_URL_DIR FTP_PKG_URL_HOST
! 9609: GAMEDATAMODE GAMEDATA_PERMS
! 9610: GAMEDIRMODE GAMEDIR_PERMS
! 9611: GAMEGRP GAMEMODE
! 9612: GAMEOWN GAMES_GROUP
! 9613: GAMES_USER GCC
! 9614: GCCBASE GCC_REQD
! 9615: GCC_VERSION_SUFFIX GEM_BUILD
! 9616: GEM_CLEANBUILD GEM_CLEANBUILD_EXTENSIONS
! 9617: GEM_DOCDIR GEM_EXTSDIR
! 9618: GEM_HOME GEM_KEEPBUILD
! 9619: GEM_LIBDIR GEM_NAME
! 9620: GEM_PATH GEM_PLUGINSDIR
! 9621: GEM_SPECFILE GENERATE_PLIST
! 9622: GHC GHOSTSCRIPT_REQD
! 9623: GITHUB_PROJECT GITHUB_RELEASE
! 9624: GITHUB_SUBMODULES GITHUB_TAG
! 9625: GITHUB_TYPE GITLAB_PROJECT
! 9626: GITLAB_RELEASE GITLAB_SUBMODULES
! 9627: GITLAB_TAG GITLAB_TYPE
! 9628: GIT_BRANCH GIT_ENV
! 9629: GIT_EXTRACTDIR GIT_REPO
! 9630: GIT_REPOSITORIES GIT_REVISION
! 9631: GIT_TAG GNU
! 9632: GNU_CONFIGURE GNU_CONFIGURE_INFODIR
! 9633: GNU_CONFIGURE_MANDIR GNU_CONFIGURE_QUIET
! 9634: GNU_CONFIGURE_STRICT GODEP_REDIRECTS
! 9635: GO_BUILD_PATTERN GO_DEPS
! 9636: GO_DIST_BASE GO_EXTRA_MOD_DIRS
! 9637: GO_MODULE_EXTRACT GO_MODULE_FILES
1.255 wiz 9638: GO_SRCPATH GROUP_SPECIFIC_PKGS
9639: GRUB_NETWORK_CARDS GRUB_PRESET_COMMAND
9640: GRUB_SCAN_ARGS GZIP
9641: HASKELL_COMPILER HASKELL_DISABLE_EXECUTABLES
9642: HASKELL_DISABLE_LIBRARIES HASKELL_ENABLE_DYNAMIC_EXECUTABLE
9643: HASKELL_ENABLE_HADDOCK_DOCUMENTATION HASKELL_ENABLE_LIBRARY_PROFILING
9644: HASKELL_ENABLE_SHARED_LIBRARY HASKELL_ENABLE_TESTS
9645: HASKELL_OPTIMIZATION_LEVEL HASKELL_PKG_NAME
9646: HASKELL_UNRESTRICT_DEPENDENCIES HEADER_TEMPLATES
9647: HG_REPO HG_REPOSITORIES
9648: HG_TAG HOMEPAGE
9649: HOST_PKGTOOLS_ARGS HOST_SPECIFIC_PKGS
9650: HOWL_GROUP HOWL_USER
9651: ICCBASE ICECAST_CHROOTDIR
9652: ICON_THEMES IDOBASE
9653: IGNORE_CCACHE IGNORE_INFO_DIRS
9654: IGNORE_INTERACTIVE_FETCH IMAKE
9655: IMAKEOPTS IMAKE_MAKE
9656: IMAKE_MANINSTALL IMAP_UW_CCLIENT_MBOX_FMT
9657: IMDICTDIR INCOMPAT_CURSES
9658: INFO_DIR INFO_FILES
9659: INFO_MSG INIT_SYSTEM
9660: INN_DATA_DIR INN_GROUP
9661: INN_USER INSTALLATION_DIRS
9662: INSTALLATION_DIRS_FROM_PLIST INSTALL_ENV
9663: INSTALL_SH_OVERRIDE INSTALL_SRC
9664: INSTALL_TEMPLATES INSTALL_UNSTRIPPED
9665: IRCD_HYBRID_IRC_GROUP IRCD_HYBRID_IRC_USER
9666: IRCD_HYBRID_MAXCONN IRCD_HYBRID_NICLEN
9667: IRCD_HYBRID_SYSLOG_EVENTS IRCD_HYBRID_SYSLOG_FACILITY
9668: IRCD_HYBRID_TOPICLEN IRIX
9669: IRRD_USE_PGP JABBERD_GROUP
9670: JABBERD_LOGDIR JABBERD_PIDDIR
9671: JABBERD_SPOOLDIR JABBERD_USER
9672: JAVA_APP_PATH JAVA_APP_TARGETS
9673: JAVA_BINPREFIX JAVA_CLASSPATH
9674: JAVA_HOME JAVA_LD_LIBRARY_PATH
9675: JAVA_NAME JAVA_UNLIMIT
9676: JAVA_WRAPPERS JPEG_ACCEPTED
9677: JPEG_DEFAULT KERBEROS
9678: KERMIT_SUID_UUCP KJS_USE_PCRE
9679: KNEWS_DOMAIN_FILE KNEWS_DOMAIN_NAME
9680: KRB5_ACCEPTED KRB5_DEFAULT
9681: LANGUAGES LAPACKE_LIBS
9682: LAPACKE_PC LAPACK_LIBS
9683: LAPACK_PC LATEX2HTML_ICONPATH
9684: LDCONFIG_ADD_CMD LDCONFIG_REMOVE_CMD
9685: LDD LEAFNODE_DATA_DIR
9686: LEAFNODE_GROUP LEAFNODE_USER
9687: LIBDVDCSS_HOMEPAGE LIBDVDCSS_MASTER_SITES
9688: LIBIMAGEQUANT_TYPE LIBRSVG_TYPE
9689: LIBTOOL LIBTOOLIZE_PLIST
9690: LIBTOOL_M4_OVERRIDE LIBUSB_TYPE
9691: LICENSE LINKER_RPATH_FLAG
9692: LINK_RPATH_FLAG LINUX_BASE_NODEPS
9693: LINUX_BASE_PREFERRED LINUX_BASE_REQUIRED
9694: LINUX_LOCALES LOCALBASE
9695: LOCALBASE_LOCKTYPE LOCALPATCHES
9696: LOVE_DATA LOVE_GAME
9697: LOVE_VERSION LOWER_OPSYS
9698: LOWER_OPSYS_VERSUFFIX LOWER_VARIANT_VERSION
9699: LOWER_VENDOR LP32PLATFORMS
9700: LP64PLATFORMS LUA_BUSTED_ARGS
9701: LUA_CDIR LUA_COMPILER
9702: LUA_DOCDIR LUA_EXAMPLESDIR
9703: LUA_INCDIR LUA_INTERPRETER
9704: LUA_LDIR LUA_LINKER_MAGIC
9705: LUA_PKGPREFIX LUA_SELF_CONFLICT
9706: LUA_USE_BUSTED LUA_VERSIONS_ACCEPTED
9707: LUA_VERSIONS_INCOMPATIBLE LUA_VERSION_DEFAULT
9708: LUA_VERSION_REQD Lua
9709: MACHINE_PLATFORM MAILAGENT_DOMAIN
9710: MAILAGENT_EMAIL MAILAGENT_FQDN
9711: MAILAGENT_ORGANIZATION MAJORDOMO_HOMEDIR
9712: MAJOR_OS_VERSION MAKEINFO_ARGS
9713: MAKE_DIRS MAKE_DIRS_PERMS
9714: MAKE_ENV MAKE_FILE
9715: MAKE_FLAGS MAKE_JOBS
9716: MAKE_JOBS_SAFE MAKE_PROGRAM
9717: MANCOMPRESSED_IF_MANZ MANINSTALL
9718: MANZ MARIADB_VERSIONS_ALL
9719: MASTER_SITES MASTER_SITE_BACKUP
9720: MASTER_SITE_LOCAL MASTER_SITE_MOZILLA
9721: MASTER_SITE_OVERRIDE MASTER_SITE_PERL_CPAN
9722: MASTER_SORT MASTER_SORT_RANDOM
9723: MASTER_SORT_REGEX MECAB_CHARSET
9724: MEDIATOMB_GROUP MEDIATOMB_USER
9725: MIPSPROBASE MIREDO_GROUP
9726: MIREDO_USER MISSING_FEATURES
9727: MKDIR MKPIE_SUPPORTED
9728: MLDONKEY_GROUP MLDONKEY_HOME
9729: MLDONKEY_USER MONOTONE_GROUP
9730: MONOTONE_USER MOTIFBASE
9731: MOTIF_TYPE MOTIF_TYPE_DEFAULT
9732: MPI_TYPE MSGFMT_STRIP_MSGCTXT
9733: MSGFMT_STRIP_MSGID_PLURAL MTOOLS_ENABLE_FLOPPYD
9734: MUST MV
9735: MYSQL_CHARSET MYSQL_DATADIR
9736: MYSQL_EXTRA_CHARSET MYSQL_GROUP
9737: MYSQL_USER MYSQL_VERSION
9738: MYSQL_VERSIONS_ACCEPTED MYSQL_VERSION_DEFAULT
9739: NAGIOSCMD_GROUP NAGIOSDIR
9740: NAGIOS_GROUP NAGIOS_USER
9741: NATIVE_EXEC_FMT NATIVE_LOWER_OPSYS
9742: NATIVE_LOWER_VENDOR NATIVE_MACHINE_PLATFORM
1.256 ! wiz 9743: NATIVE_OBJECT_FMT NATIVE_OPSYS_VERSION
! 9744: NATIVE_OS_VARIANT NATIVE_OS_VERSION
! 9745: NBPAX_PROGRAM_PREFIX NETBSD_LOGIN_NAME
! 9746: NMH_EDITOR NMH_MTA
! 9747: NMH_PAGER NODE_VERSIONS_ACCEPTED
! 9748: NODE_VERSIONS_INCOMPATIBLE NODE_VERSION_DEFAULT
! 9749: NODE_VERSION_REQD NOLOGIN
! 9750: NOTE NOT_FOR_PLATFORM
! 9751: NOT_PAX_ASLR_SAFE NOT_PAX_MPROTECT_SAFE
! 9752: NO_BUILD NO_CHECKSUM
! 9753: NO_CONFIGURE NO_SKIP
! 9754: NS_PREFERRED NULLMAILER_GROUP
! 9755: NULLMAILER_USER OBJECT_FMT
! 9756: OBJHOSTNAME OBJMACHINE
! 9757: OCAML_FINDLIB_DIRS OCAML_FINDLIB_REGISTER
! 9758: OCAML_FINDLIB_REGISTER_VERBOSE OCAML_SITELIBDIR
! 9759: OMF ONLY_FOR_COMPILER
! 9760: ONLY_FOR_PLATFORM OPENSSH_CHROOT
! 9761: OPENSSH_GROUP OPENSSH_USER
! 9762: OPSYS OPSYS_EMULDIR
! 9763: OPSYS_VERSION OS
! 9764: OSS_TYPE OSX
! 9765: OSX_PATH_TO_M4 OSX_PATH_TO_YACC
! 9766: OS_HAVE_ALSA OS_HAVE_RCD
! 9767: OS_VARIANT OS_VERSION
! 9768: OTF_FONTS_DIR OVERRIDE_DIRDEPTH
! 9769: OVERRIDE_GEMSPEC OVERRIDE_GNU_CONFIG_SCRIPTS
! 9770: OVERRIDE_ROCKSPEC OWN_DIRS
! 9771: OWN_DIRS_PERMS P4GROUP
! 9772: P4PORT P4ROOT
! 9773: P4USER PACKAGES
! 9774: PALMOS_DEFAULT_SDK PAMBASE
! 9775: PAM_DEFAULT PAPERSIZE
! 9776: PASSIVE_FETCH PATCHDIR
! 9777: PATCHFILES PATCH_ARGS
! 9778: PATCH_DEBUG PATCH_DIST_ARGS
! 9779: PATCH_DIST_CAT PATCH_DIST_STRIP
! 9780: PATCH_FUZZ_FACTOR PATCH_STRIP
! 9781: PATH PCCBASE
! 9782: PEAR PEAR_CHANNEL
! 9783: PEAR_CHANNEL_ALIAS PEAR_CHANNEL_VERSION
! 9784: PEAR_CMD PEAR_LIB
! 9785: PEAR_PACKAGE_XML PERL5
! 9786: PERL5_CONFIGURE PERL5_CONFIGURE_DIRS
! 9787: PERL5_LDFLAGS PERL5_LICENSE
! 9788: PERL5_MODULE_TYPE PERL5_PACKLIST
! 9789: PERL5_PACKLIST_DIR PERL5_PERLBASE
! 9790: PERL5_SITEBASE PERL5_USE_PACKLIST
! 9791: PERL5_VENDORBASE PFCTL
! 9792: PFVAR_H PF_VERSION
! 9793: PGGROUP PGHOME
! 9794: PGPKGSRCDIR PGSQL_TYPE
! 9795: PGSQL_VERSION PGSQL_VERSIONS_ACCEPTED
! 9796: PGSQL_VERSION_DEFAULT PGUSER
! 9797: PG_LIB_EXT PHP
! 9798: PHPCOMMON_MK PHPPKGSRCDIR
! 9799: PHP_BASE_VERS PHP_CHECK_INSTALLED
! 9800: PHP_EXTENSION_DIR PHP_INITIAL_TEENY
! 9801: PHP_PKG_PREFIX PHP_VERSION
! 9802: PHP_VERSIONS_ACCEPTED PHP_VERSIONS_INCOMPATIBLE
! 9803: PHP_VERSION_DEFAULT PHP_VERSION_REQD
! 9804: PILRC_USE_GTK PKGCONFIG_BASE
! 9805: PKGCONFIG_FILE PKGCONFIG_OVERRIDE
! 9806: PKGCONFIG_OVERRIDE_STAGE PKGDIR
! 9807: PKGGNUDIR PKGINFODIR
! 9808: PKGLOCALEDIR PKGMANDIR
! 9809: PKGNAME PKGNAME_REQD
! 9810: PKGPATH PKGREVISION
! 9811: PKGSRC_BLAS_TYPES PKGSRC_CHANGES
! 9812: PKGSRC_COMPILER PKGSRC_KEEP_BIN_PKGS
! 9813: PKGSRC_LOCKTYPE PKGSRC_MAKE_ENV
! 9814: PKGSRC_MESSAGE_RECIPIENTS PKGSRC_MKPIE
! 9815: PKGSRC_MKREPRO PKGSRC_OVERRIDE_MKPIE
! 9816: PKGSRC_RUN_TEST PKGSRC_SETENV
! 9817: PKGSRC_SLEEPSECS PKGSRC_TODO
! 9818: PKGSRC_USE_CTF PKGSRC_USE_FORTIFY
! 9819: PKGSRC_USE_MKTOOLS PKGSRC_USE_RELRO
! 9820: PKGSRC_USE_SSP PKGSRC_USE_STACK_CHECK
! 9821: PKGTASKS_DATAFILE PKGTOOLS_ARGS
! 9822: PKGTOOLS_ENV PKG_ALTERNATIVES
! 9823: PKG_APACHE PKG_APACHE_ACCEPTED
! 9824: PKG_APACHE_DEFAULT PKG_BEST_EXISTS
! 9825: PKG_BUILD_OPTIONS PKG_COMPRESSION
! 9826: PKG_CONFIG PKG_CONFIG_PERMS
! 9827: PKG_CREATE_USERGROUP PKG_DBDIR
! 9828: PKG_DB_TMPDIR PKG_DEBUG_LEVEL
! 9829: PKG_DEFAULT_OPTIONS PKG_DESTDIR_SUPPORT
! 9830: PKG_DEVELOPER PKG_DISABLED_OPTIONS
! 9831: PKG_FATAL_ERRORS PKG_FC
! 9832: PKG_FILELIST_CMD PKG_GECOS
! 9833: PKG_GID PKG_GROUPS
! 9834: PKG_GROUPS_VARS PKG_HOME
! 9835: PKG_INIT_SCRIPTS PKG_JAVA_HOME
! 9836: PKG_JVM PKG_JVMS_ACCEPTED
! 9837: PKG_JVM_DEFAULT PKG_LEGACY_OPTIONS
! 9838: PKG_LIBTOOL PKG_MKSYMLINKS
! 9839: PKG_OPTIONS PKG_OPTIONS_DEPRECATED_WARNINGS
! 9840: PKG_OPTIONS_LEGACY_OPTS PKG_OPTIONS_LEGACY_VARS
! 9841: PKG_OPTIONS_NONEMPTY_SETS PKG_OPTIONS_OPTIONAL_GROUPS
! 9842: PKG_OPTIONS_REQUIRED_GROUPS PKG_OPTIONS_VAR
! 9843: PKG_PHP PKG_PHP_MAJOR_VERS
! 9844: PKG_PHP_VERSION PKG_RCD_SCRIPTS
! 9845: PKG_REFCOUNT_DBDIR PKG_REGISTER_SHELLS
! 9846: PKG_RESUME_TRANSFERS PKG_SHELL
! 9847: PKG_SUGGESTED_OPTIONS PKG_SUPPORTED_OPTIONS
! 9848: PKG_SYSCONFBASE PKG_SYSCONFBASEDIR
! 9849: PKG_SYSCONFDIR PKG_SYSCONFDIR_PERMS
! 9850: PKG_SYSCONFSUBDIR PKG_SYSCONFVAR
! 9851: PKG_TOOLS_BIN PKG_UID
! 9852: PKG_UPDATE_FONTS_DB PKG_USERS
! 9853: PKG_USERS_VARS PKG_VERBOSE
! 9854: PLEASE PLIST
! 9855: PLIST_AWK PLIST_AWK_ENV
! 9856: PLIST_SRC PLIST_SUBST
! 9857: PLIST_TYPE PLIST_VARS
! 9858: POPTOP_USE_MPPE POSSIBLE_GFORTRAN_VERSION
! 9859: POST_FETCH_HOOK PREFER
! 9860: PREFER_NATIVE PREFER_NATIVE_PTHREADS
! 9861: PREFER_PKGSRC PREFIX
! 9862: PREPEND_PATH PRE_ROOT_CMD
! 9863: PRIVILEGED_STAGES PS
! 9864: PTHREAD_AUTO_VARS PTHREAD_CFLAGS
! 9865: PTHREAD_LDFLAGS PTHREAD_LIBS
! 9866: PTHREAD_OPTS PTHREAD_TYPE
! 9867: PVM_SSH PYPKGPREFIX
! 9868: PYTHON_FOR_BUILD_ONLY PYTHON_SELF_CONFLICT
! 9869: PYTHON_VERSION PYTHON_VERSIONED_DEPENDENCIES
! 9870: PYTHON_VERSIONS_ACCEPTED PYTHON_VERSIONS_INCOMPATIBLE
! 9871: PYTHON_VERSION_DEFAULT PYTHON_VERSION_REQD
! 9872: PYVERSSUFFIX QMAILDIR
! 9873: QMAIL_ALIAS_USER QMAIL_DAEMON_USER
! 9874: QMAIL_LOG_USER QMAIL_NOFILES_GROUP
! 9875: QMAIL_PASSWD_USER QMAIL_QMAIL_GROUP
! 9876: QMAIL_QUEUE_DIR QMAIL_QUEUE_EXTRA
! 9877: QMAIL_QUEUE_USER QMAIL_REMOTE_USER
! 9878: QMAIL_ROOT_USER QMAIL_SEND_USER
! 9879: QORE_LATEST_MODULE_API QORE_MODULE_API
! 9880: QORE_MODULE_DIR QORE_USER_MODULE_DIR
! 9881: QORE_VERSION QPOPPER_FAC
! 9882: QPOPPER_SPOOL_DIR QPOPPER_USER
! 9883: RAKE_NAME RASMOL_DEPTH
! 9884: RCD_DIR RCD_ORDER
! 9885: RCD_SCRIPTS RCD_SCRIPTS_DIR
! 9886: RCD_SCRIPTS_EXAMPLEDIR RCD_SCRIPTS_MODE
! 9887: RCD_SCRIPTS_SHELL RCD_SCRIPT_SRC
! 9888: RCD_SUBR RDOC
! 9889: READLINE_DEFAULT READLINE_TYPE
! 9890: REAL_ROOT_GROUP REAL_ROOT_USER
! 9891: RECURSIVE_MAKE RELAY_CTRL_DIR
! 9892: RELRO_SUPPORTED REPLACE_AWK
! 9893: REPLACE_BASH REPLACE_CSH
! 9894: REPLACE_KSH REPLACE_LUA
! 9895: REPLACE_NODEJS REPLACE_OCTAVE
! 9896: REPLACE_PERL REPLACE_PERL6
! 9897: REPLACE_PHP REPLACE_PYTHON
! 9898: REPLACE_QORE REPLACE_R
! 9899: REPLACE_RUBY REPLACE_RUBY_DIRS
! 9900: REPLACE_RUBY_PAT REPLACE_SH
! 9901: REPLACE_TEXLUA REPLACE_TOOL_PYTHON
! 9902: REPLACE_WISH REQD_DIRS
! 9903: REQD_DIRS_PERMS REQD_FILES
! 9904: REQD_FILES_MODE REQD_FILES_PERMS
! 9905: RESOLV_AUTO_VARS RESOLV_LDFLAGS
! 9906: RESOLV_LIBS RM
! 9907: ROCKSPEC_NAME ROCKSPEC_SPECFILE
! 9908: ROOT_CMD ROOT_GROUP
! 9909: ROOT_USER RPCGEN
! 9910: RPM RPM2PKG_PLIST
! 9911: RPM2PKG_PREFIX RPM2PKG_STAGE
! 9912: RPM2PKG_STRIP RPM2PKG_SUBPREFIX
! 9913: RPMFILES RPMIGNOREPATH
! 9914: RPM_DB_PREFIX RSSH_CVS_PATH
! 9915: RSSH_RDIST_PATH RSSH_RSYNC_PATH
! 9916: RSSH_SCP_PATH RSSH_SFTP_SERVER_PATH
! 9917: RUBY RUBYGEM
! 9918: RUBYGEM_MANPAGES RUBYGEM_NAME
! 9919: RUBYGEM_OPTIONS RUBYGEM_USE_MANPAGES
! 9920: RUBYGEM_VERBOSE RUBY_ABI_VERSION
! 9921: RUBY_ARCH RUBY_ARCHINC
! 9922: RUBY_ARCHLIB RUBY_BASE
! 9923: RUBY_BASERIDIR RUBY_BUILD_DOCUMENT
! 9924: RUBY_DLEXT RUBY_DOC
! 9925: RUBY_DYNAMIC_DIRS RUBY_EG
! 9926: RUBY_ENCODING_ARG RUBY_EXTCONF
! 9927: RUBY_EXTCONF_CHECK RUBY_EXTCONF_DEBUG
! 9928: RUBY_EXTCONF_MAKEFILE RUBY_GEM_ARCH
! 9929: RUBY_GEM_BASE RUBY_INC
! 9930: RUBY_LIB RUBY_LIB_BASE
! 9931: RUBY_NAME RUBY_NOVERSION
! 9932: RUBY_PKGPREFIX RUBY_RAILS
! 9933: RUBY_RAILS61_VERSION RUBY_RAILS70_VERSION
! 9934: RUBY_RAILS71_VERSION RUBY_RAILS_ACCEPTED
! 9935: RUBY_RAILS_DEFAULT RUBY_RAILS_REQD
! 9936: RUBY_RAILS_STRICT_DEP RUBY_RIDIR
! 9937: RUBY_SETUP RUBY_SHLIB
! 9938: RUBY_SHLIBALIAS RUBY_SHLIBVER
! 9939: RUBY_SIMPLE_INSTALL RUBY_SITEARCHLIB
! 9940: RUBY_SITELIB RUBY_SITELIB_BASE
! 9941: RUBY_SITERIDIR RUBY_SLEXT
! 9942: RUBY_SRCDIR RUBY_STATICLIB
! 9943: RUBY_SUFFIX RUBY_SYSRIDIR
! 9944: RUBY_USE_PTHREAD RUBY_VENDORARCHLIB
! 9945: RUBY_VENDORLIB RUBY_VENDORLIB_BASE
! 9946: RUBY_VER RUBY_VERSION
! 9947: RUBY_VERSIONS_ACCEPTED RUBY_VERSIONS_INCOMPATIBLE
! 9948: RUBY_VERSION_DEFAULT RUBY_VERSION_REQD
! 9949: RUBY_VER_DIR RUN
! 9950: RUN_LDCONFIG RUST_TYPE
! 9951: SCO SCREWS_GROUP
! 9952: SCREWS_USER SCRIPTS_ENV
! 9953: SCROLLKEEPER_DATADIR SCROLLKEEPER_REBUILDDB
! 9954: SCROLLKEEPER_UPDATEDB SDIST_PAWD
! 9955: SDL12_TYPE SERIAL_DEVICES
! 9956: SETGIDGAME SETGID_GAMES_PERMS
! 9957: SETUID_ROOT_PERMS SH
! 9958: SHLIB SHORTNAME
! 9959: SIGN_PACKAGES SILC_CLIENT_WITH_PERL
! 9960: SITE_SPECIFIC_PKGS SKIP_DEPENDS
! 9961: SMF_INSTANCES SMF_MANIFEST
! 9962: SMF_METHODS SMF_METHOD_SHELL
! 9963: SMF_METHOD_SRC SMF_NAME
! 9964: SMF_PREFIX SMF_SRCDIR
! 9965: SNIPROXY_GROUP SNIPROXY_USER
! 9966: SOURCE_BUFFSIZE SPECIAL_PERMS
! 9967: SPECIFIC_PKGS SSH_SUID
! 9968: SSP_SUPPORTED SSYNC_PAWD
! 9969: STEP_MSG STRIP
! 9970: STRIP_DBG STRIP_DEBUG
! 9971: STRIP_DEBUG_SUPPORTED STRIP_FILES_SKIP
! 9972: SU SUBDIR
! 9973: SUBST SUBST_CLASSES
! 9974: SUBST_FILES SUBST_FILTER_CMD
! 9975: SUBST_MESSAGE SUBST_NOOP_OK
! 9976: SUBST_SED SUBST_SHOW_DIFF
! 9977: SUBST_SKIP_TEXT_CHECK SUBST_STAGE
! 9978: SUBST_VARS SUNWSPROBASE
! 9979: SUSE_PREFER SU_CMD
! 9980: SVN_EXTRACTDIR SVN_REPO
! 9981: SVN_REPOSITORIES SVN_REVISION
! 9982: SYSCONFBASE TARGET_MACHINE_ARCH
! 9983: TBL TERMCAP_TYPE
! 9984: TERMINFO_DEFAULT TERMINFO_TYPE
! 9985: TEST TEST_DEPENDS
! 9986: TEST_DIRS TEST_ENV
! 9987: TEST_ENV_SHELL TEST_MAKE_CMD
! 9988: TEST_MAKE_FLAGS TEST_TARGET
! 9989: TEXLIVE_IGNORE_PATTERNS TEXLIVE_REV
! 9990: TEXLIVE_UNVERSIONED TEXMFSITE
! 9991: TEX_FORMATS TEX_HYPHEN_DAT
! 9992: TEX_HYPHEN_DEF TEX_TEXMF_DIRS
! 9993: THTTPD_LOG_FACILITY TINYDYN_USER
! 9994: TLSWRAPPER_CHROOT TO
! 9995: TOOLDIR TOOLS_ALIASES
! 9996: TOOLS_ALWAYS_WRAP TOOLS_ARGS
! 9997: TOOLS_BROKEN TOOLS_CMD
! 9998: TOOLS_CMDLINE_SED TOOLS_CREATE
! 9999: TOOLS_CROSS_DESTDIR TOOLS_DIR
! 10000: TOOLS_FAIL TOOLS_GNU_MISSING
! 10001: TOOLS_LDCONFIG TOOLS_NOOP
! 10002: TOOLS_PATH TOOLS_SCRIPT
! 10003: TOOLS_USE_CROSS_COMPILE TOOL_DEPENDS
! 10004: TTF_FONTDIR TTF_FONTS_DIR
! 10005: TYPE UAC_REQD_EXECS
! 10006: UCSPI_SSL_GROUP UCSPI_SSL_USER
! 10007: UNLIMIT_RESOURCES UNPRIVILEGED
! 10008: UNPRIVILEGED_GROUP UNPRIVILEGED_GROUPS
! 10009: UNPRIVILEGED_USER UNWRAP_FILES
! 10010: UNWRAP_PATTERNS UPDATE_GEMSPEC
! 10011: UPDATE_TARGET URI
! 10012: USERGROUP_PHASE USERPPP_GROUP
! 10013: USER_SPECIFIC_PKGS USE_ABI_DEPENDS
! 10014: USE_APR USE_BSD_MAKEFILE
! 10015: USE_BUILTIN USE_CC_FEATURES
! 10016: USE_CROSS_COMPILE USE_CURSES
! 10017: USE_CWRAPPERS USE_CXX_FEATURES
! 10018: USE_DB185 USE_FEATURES
! 10019: USE_GAMESGROUP USE_GCC_RUNTIME
! 10020: USE_IMAKE USE_JAVA
! 10021: USE_JAVA2 USE_LANGUAGES
! 10022: USE_LIBTOOL USE_NATIVE_GCC
! 10023: USE_NETBSD_REPO USE_PKGSRC_GCC
! 10024: USE_PKGSRC_GCC_RUNTIME USE_PKGTASKS
! 10025: USE_PKG_ADMIN_DIGEST USE_RUBY_EXTCONF
! 10026: USE_RUBY_INSTALL USE_RUBY_SETUP
! 10027: USE_RUBY_SETUP_PKG USE_TOOLS
! 10028: UUCP_GROUP UUCP_USER
! 10029: VARBASE VARNAME
! 10030: VIM_EXTRA_OPTS WARNING_MSG
! 10031: WCALC_CGIDIR WCALC_CGIPATH
! 10032: WCALC_HTMLDIR WCALC_HTMLPATH
! 10033: WDM_MANAGERS WRAPPER_CC
! 10034: WRAPPER_REORDER_CMDS WRKDIR
! 10035: WRKDIR_BASENAME WRKDIR_LOCKTYPE
! 10036: WRKLOG WRKOBJDIR
! 10037: WRKSRC X10_PORT
! 10038: X11 X11BASE
! 10039: X11_PKGSRCDIR X11_TYPE
! 10040: X509_CERTIFICATE X509_KEY
! 10041: XAW_TYPE XLOCK_DEFAULT_MODE
! 10042: XMKMF XMKMF_FLAGS
! 10043: XXX XXXX
! 10044: YES ZSH_STATIC
! 10045: __stdc__ _vargroups
! 10046: accept acquire-localbase-lock
! 10047: acquire-lock add
! 10048: added administrator
! 10049: alloca alternatives
! 10050: aslr asprintf
! 10051: atlas autoconf
! 10052: automake autoreconf
! 10053: awk bash
! 10054: big-endian bin-install
! 10055: bind binpkg-list
! 10056: blas bootstrap-depends
! 10057: broken broken_on_platform
! 10058: bsd bsd.prog.mk
! 10059: build build-env
! 10060: buildlink-directories buildlink-oss-soundcard-h
! 10061: built-in builtin
! 10062: c c++
! 10063: ccache cce
! 10064: cdefs ceil
! 10065: changes changes-entry
! 10066: changes-entry-noupdate check
! 10067: check-clean check-files
! 10068: check-files-clean check-hackage
! 10069: check-vulnerable checksum
! 10070: checksum-phase clean
! 10071: clean-depends cleandir
! 10072: commit commit-changes-entry
! 10073: compact compiler
! 10074: conf config.guess
! 10075: config.sub configuration
! 10076: configure configure-env
! 10077: configure-help configure_args
! 10078: connect cos
! 10079: cpe cputime
! 10080: create-usergroup csh
! 10081: ctf cvs
! 10082: debug declaration
! 10083: declare defined
! 10084: depend dependencies
! 10085: depends depends-checksum
! 10086: depends-fetch deps
! 10087: describe destdir
! 10088: disable distclean
! 10089: distinfo dl
! 10090: dlopen do-buildlink
! 10091: do-clean do-configure
! 10092: do-configure-post-hook do-extract
! 10093: do-fetch do-install
! 10094: download emul
! 10095: emul-distinfo emul-fetch
! 10096: emulation emulator
! 10097: enable endian
! 10098: endif enomem
! 10099: ensurepip err
! 10100: errx etc
! 10101: exp extract-rpm
! 10102: fabs feature
! 10103: features fetch
! 10104: fetch-list follows
! 10105: forbids form
! 10106: format fortify
! 10107: fortify_source fossil
! 10108: friend fts
! 10109: fts_close fts_open
! 10110: fts_read fts_set
! 10111: gcc gethostbyaddr
! 10112: gethostbyname gethostbyname2
! 10113: getopt_long getprogname
! 10114: getservbyname getservbyport
! 10115: getservent gettext
! 10116: git github
! 10117: gitlab glob
! 10118: gnu gnu_configure_strict
! 10119: go go-deps
! 10120: golang guess-license
! 10121: hashbang heimdal
! 10122: help hg
! 10123: imake in-tree
! 10124: increment indirect
! 10125: inet_aton interp
! 10126: interpreter intl
! 10127: ip4 ip6
! 10128: ipv4 ipv6
! 10129: iso kerberos
! 10130: krb krb5
! 10131: ksh lapack
! 10132: latex libintl_bindtextdomain
! 10133: libintl_gettext libintl_textdomain
! 10134: libnbcompat libs
! 10135: libtool licence
! 10136: license lintl
! 10137: little-endian lock
! 10138: locking lua
! 10139: lvalue make
! 10140: makesum memory
! 10141: mercurial meta
! 10142: meta-package meta_package
! 10143: mit-krb5 mk.conf
! 10144: mkl mount
! 10145: move moved
! 10146: mprotect mremap
! 10147: native nb
! 10148: nbcompat netlib
! 10149: network node
! 10150: node.js nodejs
! 10151: obstack obstack_ptr_grow
! 10152: occurs only
! 10153: openblas options
! 10154: options.mk order
! 10155: override override-intltool
! 10156: override-message-intltool package
! 10157: parallel path
! 10158: pax paxctl
! 10159: pbulk-index pc
! 10160: perl perl5
! 10161: perms php
! 10162: pkg-build-options pkg-config
! 10163: pkg_build_options pkgsrc
! 10164: platform plist
! 10165: post-extract post-fetch
! 10166: post-wrapper pre-build-checks-hook
! 10167: pre-configure-checks-hook pre-extract
! 10168: pre-fetch print-go-deps
! 10169: print-plist print-summary-data
! 10170: privileged-install-hook pypi
! 10171: python r
! 10172: readme-all recursive
! 10173: recv recvfrom
! 10174: regcomp release-localbase-lock
! 10175: release-lock relro
! 10176: remove removed
! 10177: rename renamed
! 10178: reorder replace
! 10179: replace_interpreter reproducible
! 10180: resolv root
! 10181: ruby send
! 10182: sendfile sendto
! 10183: setenv setgid
! 10184: setprogname setuid
! 10185: sh shebang
! 10186: show show-all
! 10187: show-build-defs show-depends
! 10188: show-depends-dirs show-depends-pkgpaths
! 10189: show-depends-recursive show-deps
! 10190: show-distfiles show-downlevel
! 10191: show-subdir-var show-tools
! 10192: show-var show-vars
! 10193: snprintf socket
! 10194: ssp st_mode
! 10195: stage-install strcasestr
! 10196: strict strip
! 10197: strndup strnlen
! 10198: strsep subst
! 10199: substitutions subversion
! 10200: sun sunpro
! 10201: sunwspro svn
! 10202: symlink test
! 10203: test-env tex
! 10204: texlive tmp
! 10205: todo tool
! 10206: tools tools-libtool-m4-override
! 10207: transitive type
! 10208: ulimit undefined
! 10209: undo-replace unlimit
! 10210: unprivileged unprivileged-install-hook
! 10211: unstripped update
! 10212: updated upload
! 10213: upload-distfiles use_tools
! 10214: user utimes
! 10215: vasprintf verbose
! 10216: vsnprintf warn
! 10217: warning warnings
! 10218: warnx wattr_off
! 10219: wattr_on work
! 10220: wrapper wrkdir
1.154 rillig 10221:
1.207 leot 10222: Appendix F. Editing guidelines for the pkgsrc guide
1.1 dsieger 10223:
10224: Table of Contents
10225:
1.207 leot 10226: F.1. Make targets
10227: F.2. Procedure
1.1 dsieger 10228:
10229: This section contains information on editing the pkgsrc guide itself.
10230:
1.207 leot 10231: F.1. Make targets
1.1 dsieger 10232:
10233: The pkgsrc guide's source code is stored in pkgsrc/doc/guide/files, and several
10234: files are created from it:
10235:
10236: * pkgsrc/doc/pkgsrc.txt
10237:
10238: * pkgsrc/doc/pkgsrc.html
10239:
1.174 leot 10240: * https://www.NetBSD.org/docs/pkgsrc/
1.1 dsieger 10241:
1.174 leot 10242: * https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf: The PDF version of the
10243: pkgsrc guide.
1.1 dsieger 10244:
1.174 leot 10245: * https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps: PostScript version of the
1.2 rillig 10246: pkgsrc guide.
1.1 dsieger 10247:
1.207 leot 10248: F.2. Procedure
1.1 dsieger 10249:
10250: The procedure to edit the pkgsrc guide is:
10251:
1.190 bacon 10252: 1. Make sure you have checked out the htdocs repository into a sibling
10253: directory of your pkgsrc directory. You will need the ability to commit
10254: from both pkgsrc and htdocs.
10255:
10256: 2. Make sure you have the packages needed to regenerate the pkgsrc guide (and
1.46 obache 10257: other XML-based NetBSD documentation) installed. These are automatically
10258: installed when you install the meta-pkgs/pkgsrc-guide-tools package.
1.1 dsieger 10259:
1.190 bacon 10260: 3. Run cd doc/guide to get to the right directory. All further steps will take
1.1 dsieger 10261: place here.
10262:
1.190 bacon 10263: 4. Edit the XML file(s) in files/.
1.1 dsieger 10264:
1.190 bacon 10265: 5. Run bmake to check the pkgsrc guide for valid XML and to build the final
1.1 dsieger 10266: output files. If you get any errors at this stage, you can just edit the
10267: files, as there are only symbolic links in the working directory, pointing
10268: to the files in files/.
10269:
1.190 bacon 10270: 6. (cd files && cvs commit)
1.1 dsieger 10271:
1.190 bacon 10272: 7. Run bmake clean && bmake to regenerate the output files with the proper RCS
1.1 dsieger 10273: Ids.
10274:
1.190 bacon 10275: 8. Run bmake regen to install and commit the files in both pkgsrc/doc and
1.1 dsieger 10276: htdocs.
10277:
10278: Note
10279:
10280: If you have added, removed or renamed some chapters, you need to
10281: synchronize them using cvs add or cvs delete in the htdocs directory.
10282:
CVSweb <webmaster@jp.NetBSD.org>