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