From 7aa836ae0ed934a6317a01703ff76e37a7f7f27b Mon Sep 17 00:00:00 2001 From: rillig Date: Thu, 12 Jan 2006 11:25:27 +0000 Subject: regen. --- doc/pkgsrc.html | 1072 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 663 insertions(+), 409 deletions(-) (limited to 'doc/pkgsrc.html') diff --git a/doc/pkgsrc.html b/doc/pkgsrc.html index 89ec1590d99..ca461bbf914 100644 --- a/doc/pkgsrc.html +++ b/doc/pkgsrc.html @@ -1,7 +1,7 @@ + "HTML Tidy for NetBSD (vers 1st August 2004), see www.w3.org" /> @@ -15,12 +15,12 @@ -
+
-

The - pkgsrc guide

+

The pkgsrc guide

@@ -1070,11 +1070,11 @@ alink="#0000FF">
-
+
-

Chapter 1. What is pkgsrc?

@@ -1099,11 +1099,12 @@ alink="#0000FF">
-
+

1.1. Introduction

@@ -1236,12 +1237,12 @@ alink="#0000FF">
-
+

1.2. Overview

+ "overview" id="overview">1.2. Overview
@@ -1282,11 +1283,12 @@ alink="#0000FF">
-
+

1.3. Terminology

@@ -1381,11 +1383,12 @@ alink="#0000FF">
-
+

1.4. Typography

@@ -1401,11 +1404,11 @@ alink="#0000FF">
-
+
-

Part I. The pkgsrc user's guide

@@ -1688,11 +1691,11 @@ alink="#0000FF">
-
+
-

Chapter 2. Where to get pkgsrc and how to keep it up-to-date

@@ -1721,12 +1724,13 @@ alink="#0000FF"> file, via SUP, or via CVS. All three ways are described here.

-
+

2.1. As tar file

+ "as-tar-file" id="as-tar-file">2.1. As tar + file
@@ -1739,12 +1743,12 @@ alink="#0000FF"> class="filename">/usr/pkgsrc.

-
+

2.2. Via SUP

+ "via-sup" id="via-sup">2.2. Via SUP
@@ -1766,12 +1770,12 @@ alink="#0000FF"> /path/to/your/supfile.

-
+

2.3. Via CVS

+ "via-cvs" id="via-cvs">2.3. Via CVS
@@ -1813,11 +1817,12 @@ alink="#0000FF"> all work is done relatively within the pkgsrc tree.

-
+

2.4. Keeping pkgsrc up-to-date via CVS

@@ -1850,11 +1855,11 @@ alink="#0000FF">
-
+
-

Chapter 3. Using pkgsrc on systems other than NetBSD

@@ -1900,11 +1905,12 @@ alink="#0000FF">
-
+

3.1. Bootstrapping pkgsrc

@@ -1972,7 +1978,7 @@ alink="#0000FF">

See - Chapter 2, Where to get pkgsrc and how to keep it + Chapter 2, Where to get pkgsrc and how to keep it up-to-date for other ways to get pkgsrc before bootstrapping. The given bootstrap command will use the @@ -2010,11 +2016,12 @@ alink="#0000FF">

-
+

3.2. Platform-specific notes

@@ -2024,11 +2031,11 @@ alink="#0000FF">

Here are some platform-specific notes you should be aware of.

-
+
-

3.2.1. Darwin (Mac OS X)

@@ -2069,13 +2076,13 @@ alink="#0000FF"> be case-sensitive, and HFS+ is not.

-
+
-

3.2.1.1. Using a - disk image

+

3.2.1.1. Using + a disk image

@@ -2095,12 +2102,12 @@ alink="#0000FF">

That's it!

-
+
-

3.2.1.2. Using a +

3.2.1.2. Using a UFS partition

@@ -2162,11 +2169,11 @@ alink="#0000FF">
-
+
-

3.2.2. FreeBSD

@@ -2224,11 +2231,11 @@ alink="#0000FF">
-
+
-

3.2.3. Interix

@@ -2249,11 +2256,12 @@ alink="#0000FF"> officially supported. (The main difference in 3.0/3.1 is lack of pthreads.)

-
+

3.2.3.1. When installing Interix/SFU

@@ -2316,11 +2324,12 @@ alink="#0000FF"> "_top">http://www.duh.org/interix/hotfixes.php.

-
+

3.2.3.2. What to do if Interix/SFU is already installed

@@ -2370,11 +2379,12 @@ alink="#0000FF">
-
+

3.2.3.3. Important notes for using pkgsrc

@@ -2413,11 +2423,12 @@ alink="#0000FF">
-
+

3.2.3.4. Limitations of the Interix platform

@@ -2530,11 +2541,12 @@ alink="#0000FF">
-
+

3.2.3.5. Known issues for pkgsrc on Interix

@@ -2562,11 +2574,11 @@ alink="#0000FF">
-
+
-

3.2.4. IRIX

@@ -2650,11 +2662,11 @@ alink="#0000FF"> pass the '--preserve-path' flag.

-
+
-

3.2.5. Linux

@@ -2731,11 +2743,11 @@ alink="#0000FF"> libtool.

-
+
-

3.2.6. OpenBSD

@@ -2804,11 +2816,11 @@ alink="#0000FF">
-
+
-

3.2.7. Solaris

@@ -2849,13 +2861,13 @@ alink="#0000FF"> not supported.

-
+
-

3.2.7.1. If you are - using gcc

+

3.2.7.1. If you + are using gcc

@@ -2880,11 +2892,12 @@ alink="#0000FF"> "_top">http://www.sun.com/bigadmin/common/freewareSearch.html.

-
+

3.2.7.2. If you are using Sun WorkShop

@@ -2947,11 +2960,11 @@ alink="#0000FF">
-
+
-

Chapter 4. Using pkgsrc

@@ -3005,11 +3018,12 @@ alink="#0000FF">
-
+

4.1. Working with binary packages

@@ -3020,11 +3034,12 @@ alink="#0000FF"> install a precompiled binary package that someone else already prepared for your type of machine.

-
+

4.1.1. Where to get binary packages

@@ -3061,11 +3076,12 @@ alink="#0000FF"> documentation for the exact location.

-
+

4.1.2. How to use binary packages

@@ -3135,11 +3151,11 @@ alink="#0000FF"> just installed program.

-
+
-

4.1.3. A word of warning

@@ -3155,14 +3171,21 @@ alink="#0000FF"> packages which you did not create yourself, and the security holes that can be introduced onto your system by indiscriminate adding of such files.

+ +

The same warning of course applies to every package + you install from source when you haven't completely + read and understood the source code of the package, the + compiler that is used to build the package and all the + other tools that are involved.

-
+

4.2. Building packages from source

@@ -3175,11 +3198,11 @@ alink="#0000FF"> “The pkgsrc developer's guide” for instructions how to create your own packages.

-
+
-

4.2.1. Requirements

@@ -3195,12 +3218,12 @@ alink="#0000FF"> required, too.

-
+
-

4.2.2. Fetching +

4.2.2. Fetching distfiles

@@ -3238,11 +3261,12 @@ alink="#0000FF"> "filename">/usr/pkgsrc/distfiles.

-
+

4.2.3. How to build and install

@@ -3290,8 +3314,8 @@ alink="#0000FF">

Taking the figlet utility as an example, we can install it on our system by building as shown in Appendix B, - Build logs.

+ "Appendix B. Build logs">Appendix B, Build + logs.

The program is installed under the default root of the packages tree - "varname">LOCALBASE.

-
+

4.2.4. Selecting the compiler

@@ -3519,11 +3544,11 @@ alink="#0000FF">
-
+
-

Chapter 5. Configuring pkgsrc

@@ -3552,11 +3577,12 @@ alink="#0000FF">
-
+

5.1. General configuration

@@ -3638,11 +3664,12 @@ alink="#0000FF">
-
+

5.2. Variables affecting the build process

@@ -3714,11 +3741,12 @@ alink="#0000FF">
-
+

5.3. Developer/advanced settings

@@ -3796,11 +3824,12 @@ alink="#0000FF">
-
+

5.4. Selecting Build Options

@@ -3902,11 +3931,11 @@ alink="#0000FF">
-
+
-

Chapter 6. Creating binary packages

@@ -3977,11 +4006,12 @@ alink="#0000FF">
-
+

6.1. Building a single binary package

@@ -4019,7 +4049,7 @@ alink="#0000FF"> "http://www.w3.org/TR/xhtml1/transitional" class= "filename">/usr/pkgsrc/packages, in the form of a gzipped tar file. See Section B.2, + "B.2. Packaging figlet">Section B.2, “Packaging figlet” for a continuation of the above "filename">misc/figlet example.

See Chapter 17, - Submitting and Committing for information on - how to submit such a binary package.

+ "Chapter 17. Submitting and Committing">Chapter + 17, Submitting and Committing for information + on how to submit such a binary package.

-
+

6.2. Settings for creation of binary packages

@@ -4049,13 +4080,13 @@ alink="#0000FF"> “Other helpful targets”.

-
+

6.3. Doing a bulk build of all - packages

+ "bulkbuild" id="bulkbuild">6.3. Doing a + bulk build of all packages
@@ -4077,21 +4108,23 @@ alink="#0000FF"> sure to not actually compile on NFS storage, as this slows things down a lot.

-
+
-

6.3.1. Configuration

-
+

6.3.1.1. build.conf

@@ -4116,11 +4149,11 @@ alink="#0000FF"> the comments in that file.

-
+
-

6.3.1.2. /etc/mk.conf

@@ -4183,13 +4216,38 @@ alink="#0000FF">
+ +

Some other options are scattered in the pkgsrc + infrastructure:

+ +
+
    +
  • +

    CHECK_FILES can + be set to “yes” to check that the + installed set of files matches the PLIST.

    +
    • + +
  • +

    CHECK_INTERPRETER can be set + to “yes” + to check that the installed “#!”-scripts will find + their interpreter.

    +
    • +
+
-
+
-

6.3.1.3. pre-build.local

@@ -4225,11 +4283,12 @@ alink="#0000FF">
-
+

6.3.2. Other environmental considerations

@@ -4271,11 +4330,11 @@ alink="#0000FF"> warned! :)

-
+
-

6.3.3. Operation

@@ -4320,11 +4379,11 @@ alink="#0000FF"> class="filename">build.conf file.

-
+
-

6.3.4. What it does

@@ -4384,11 +4443,12 @@ alink="#0000FF"> these broken package builds later.

-
+

6.3.5. Disk space requirements

@@ -4427,13 +4487,13 @@ alink="#0000FF"> recompiling.

-
+
-

6.3.6. Setting up - a sandbox for chrooted builds

+

6.3.6. Setting + up a sandbox for chrooted builds

@@ -4644,11 +4704,12 @@ alink="#0000FF"> (wherever that points/mounts to/from).

-
+

6.3.7. Building a partial set of packages

@@ -4698,11 +4759,11 @@ alink="#0000FF"> needed.

-
+
-

6.3.8. Uploading results of a bulk build

@@ -4848,11 +4909,12 @@ nbftp% chmod 755 .
-
+

6.4. Creating a multiple CD-ROM packages collection

@@ -4873,11 +4935,11 @@ nbftp% chmod 755 . all the dependencies for a given package on the same CD as that package.

-
+
-

6.4.1. Example of cdpack

@@ -4943,11 +5005,11 @@ nbftp% chmod 755 .
-
+
-

Chapter 7. Frequently Asked Questions

@@ -5026,11 +5088,12 @@ nbftp% chmod 755 . for in the previous chapters, and it contains items for both pkgsrc users and developers.

-
+

7.1. Are there any mailing lists for pkg-related discussion?

@@ -5085,11 +5148,12 @@ nbftp% chmod 755 . "_top">http://mail-index.NetBSD.org/.

-
+

7.2. Where's the pkgviews documentation?

@@ -5102,11 +5166,12 @@ nbftp% chmod 755 . "filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG.

-
+

7.3. Utilities for package management (pkgtools)

@@ -5361,11 +5426,12 @@ nbftp% chmod 755 .
-
+

7.4. How to use pkgsrc as non-root

@@ -5403,11 +5469,12 @@ nbftp% chmod 755 . finer tuning of the tree layout.

-
+

7.5. How to resume transfers when fetching distfiles?

@@ -5446,11 +5513,12 @@ nbftp% chmod 755 .
-
+

7.6. How can I install/use XFree86 from pkgsrc?

@@ -5471,11 +5539,12 @@ nbftp% chmod 755 .
-
+

7.7. How can I install/use X.org from pkgsrc?

@@ -5496,11 +5565,12 @@ nbftp% chmod 755 .
-
+

7.8. How to fetch files from behind a firewall

@@ -5521,13 +5591,13 @@ nbftp% chmod 755 .
-
+

7.9. How do I tell - make + "passive-ftp" id="passive-ftp">7.9. How do + I tell make fetch to do passive FTP?

@@ -5572,11 +5642,12 @@ nbftp% chmod 755 . active transfers.

-
+

7.10. How to fetch all distfiles at once

@@ -5647,11 +5718,12 @@ nbftp% chmod 755 .
-
+

7.11. What does “Don't know how to make /usr/share/tmac/tmac.andoc” mean?

@@ -5683,11 +5755,12 @@ nbftp% chmod 755 . class="filename">/etc/mk.conf.

-
+

7.12. What does “Could not find bsd.own.mk” mean?

@@ -5716,11 +5789,12 @@ nbftp% chmod 755 . -r).

-
+

7.13. Using 'sudo' with pkgsrc

@@ -5751,13 +5825,13 @@ nbftp% chmod 755 .
-
+

7.14. How do I change the - location of configuration files?

+ "faq.conf" id="faq.conf">7.14. How do I + change the location of configuration files?
@@ -5795,11 +5869,12 @@ nbftp% chmod 755 . rebuild and reinstall any affected packages.

-
+

7.15. Automated security checks

@@ -5872,11 +5947,11 @@ nbftp% chmod 755 .
-
+
-

Part II. The pkgsrc developer's guide

@@ -6039,8 +6114,8 @@ nbftp% chmod 755 .
11.2.2. Updating BUILDLINK_DEPENDS.pkg - in BUILDLINK_DEPENDS. + pkg in buildlink3.mk files
@@ -6485,11 +6560,11 @@ nbftp% chmod 755 .
-
+
-

Chapter 8. Package components - files, directories and contents

@@ -6535,11 +6610,12 @@ nbftp% chmod 755 . of files involved which are described in the following sections.

-
+

8.1. Makefile

@@ -6855,11 +6931,12 @@ nbftp% chmod 755 .
-
+

8.2. distinfo

@@ -6908,11 +6985,12 @@ nbftp% chmod 755 . information is not lost.

-
+

8.3. patches/*

@@ -7016,11 +7094,12 @@ nbftp% chmod 755 . after pkgsrc patches are applied.

-
+

8.4. Other mandatory files

@@ -7060,11 +7139,12 @@ nbftp% chmod 755 .
-
+

8.5. Optional files

@@ -7148,12 +7228,12 @@ nbftp% chmod 755 .
-
+

8.6. 8.6. work*

@@ -7176,11 +7256,12 @@ nbftp% chmod 755 . OBJMACHINE is set.

-
+

8.7. files/*

@@ -7201,11 +7282,11 @@ nbftp% chmod 755 .
-
+
-

Chapter 9. Programming in chmod 755 . "filename">Makefiles, including the pitfalls that come along with them.

-
+

9.1. Makefile variables

@@ -7398,11 +7480,12 @@ nbftp% chmod 755 .
-
+

9.1.1. Naming conventions

@@ -7438,11 +7521,12 @@ nbftp% chmod 755 .
-
+

9.2. Code snippets

@@ -7453,11 +7537,11 @@ nbftp% chmod 755 . appropriate here, you should test your code and add it here.

-
+
-

9.2.1. Adding things to a list

@@ -7483,11 +7567,12 @@ nbftp% chmod 755 . are correctly interpreted in both lists.

-
+

9.2.2. Converting an internal list into an external list

@@ -7508,11 +7593,12 @@ nbftp% chmod 755 . "varname">"" is explained below.

-
+

9.2.3. Passing variables to a shell command

@@ -7570,11 +7656,11 @@ nbftp% chmod 755 . there is no example for it.

-
+
-

9.2.4. Quoting guideline

@@ -7695,11 +7781,12 @@ nbftp% chmod 755 .
-
+

9.2.5. Workaround for a bug in BSD Make

@@ -7726,11 +7813,11 @@ nbftp% chmod 755 .
-
+
-

Chapter 10. PLIST issues

@@ -7791,12 +7878,12 @@ nbftp% chmod 755 . "http://www.w3.org/TR/xhtml1/transitional" class= "filename">PLIST file (or files, see below!).

-
+

10.1. RCS ID

+ "rcs-id" id="rcs-id">10.1. RCS ID

@@ -7809,11 +7896,12 @@ nbftp% chmod 755 .
-
+

10.2. Semi-automatic chmod 755 . information on this target.

-
+

10.3. Tweaking output of make print-PLIST

@@ -7879,11 +7968,12 @@ nbftp% chmod 755 .
-
+

10.4. Variable substitution in PLIST

@@ -8008,11 +8098,12 @@ nbftp% chmod 755 . “somevalue”.

-
+

10.5. Man page compression

@@ -8037,11 +8128,12 @@ nbftp% chmod 755 . class="filename">PLIST itself.

-
+

10.6. Changing PLIST source with PLIST_SRC

@@ -8061,11 +8153,12 @@ nbftp% chmod 755 . things is important.

-
+

10.7. Platform-specific and differing PLISTs

@@ -8112,11 +8205,12 @@ nbftp% chmod 755 .
-
+

10.8. Sharing directories between packages

@@ -8204,11 +8298,11 @@ nbftp% chmod 755 .
-
+
-

Chapter 11. Buildlink methodology

@@ -8307,11 +8401,12 @@ nbftp% chmod 755 . buildlink3 is designed to insulate the package build from non-system-supplied software.

-
+

11.1. Converting packages to use buildlink3

@@ -8480,11 +8575,12 @@ nbftp% chmod 755 . complete description of how to use them properly.

-
+

11.2. Writing chmod 755 . "prompt">% createbuildlink >buildlink3.mk -
+
-

11.2.1. Anatomy of a +

11.2.1. Anatomy of a buildlink3.mk file

@@ -8650,9 +8746,9 @@ nbftp% chmod 755 . "varname">BUILDLINK_INCDIRS.pkg and BUILDLINK_LIBDIRS.pkg - (not shown above) are lists of subdirectories of - BUILDLINK_LIBDIRS. + pkg (not shown above) + are lists of subdirectories of ${BUILDLINK_PREFIX.pkg} to @@ -8789,15 +8885,16 @@ nbftp% chmod 755 . included.

-
+

11.2.2. Updating + "updating-buildlink-depends" id= + "updating-buildlink-depends">11.2.2. Updating BUILDLINK_DEPENDS.pkg - in BUILDLINK_DEPENDS. + pkg in buildlink3.mk files

@@ -8848,21 +8945,21 @@ nbftp% chmod 755 . want to cause unneeded package deletions and rebuilds. In many cases, new versions of packages work just fine with older dependencies. See Section 15.1.4, - “Handling dependencies” for more - information about dependencies on other packages, + title="15.1.4. Handling dependencies">Section + 15.1.4, “Handling dependencies” for + more information about dependencies on other packages, including the BUILDLINK_RECOMMENDED and RECOMMENDED definitions.

-
+

11.3. Writing chmod 755 .

-
+
-

11.3.1. Anatomy of a chmod 755 . "replaceable">pkg).

-
+

11.3.2. Global preferences for native or pkgsrc software

@@ -9096,11 +9195,11 @@ nbftp% chmod 755 .
-
+
-

Chapter 12. The pkginstall framework

@@ -9244,11 +9343,12 @@ nbftp% chmod 755 . by means of the installation scripts, which are automatically generated by pkginstall.

-
+

12.1. Files and directories outside the installation prefix

@@ -9284,11 +9384,12 @@ nbftp% chmod 755 . "filename">Makefile. The rest of this section describes these variables.

-
+
-

12.1.1. Directory manipulation

@@ -9334,12 +9435,12 @@ nbftp% chmod 755 .
-
+
-

12.1.2. File +

12.1.2. File manipulation

@@ -9401,11 +9502,12 @@ nbftp% chmod 755 .
-
+

12.2. Configuration files

@@ -9426,12 +9528,12 @@ nbftp% chmod 755 . This ensures that administrators never lose any custom changes they may have made.

-
+
-

12.2.1. How +

12.2.1. How PKG_SYSCONFDIR is set

@@ -9556,11 +9658,12 @@ nbftp% chmod 755 . means.

-
+
-

12.2.2. Telling the software where configuration files are

@@ -9585,11 +9688,12 @@ nbftp% chmod 755 . unfortunately).

-
+
-

12.2.3. Patching installations

@@ -9645,12 +9749,12 @@ nbftp% chmod 755 . outside it.

-
+
-

12.2.4. Disabling +

12.2.4. Disabling handling of configuration files

@@ -9663,11 +9767,12 @@ nbftp% chmod 755 .
-
+

12.3. System startup scripts

@@ -9750,11 +9855,12 @@ nbftp% chmod 755 .
-
+
-

12.3.1. Disabling handling of system startup scripts

@@ -9772,11 +9878,12 @@ nbftp% chmod 755 .
-
+

12.4. System users and groups

@@ -9822,12 +9929,13 @@ nbftp% chmod 755 . numeric identifier is optional.

-
+

12.5. System shells

+ "shells" id="shells">12.5. System + shells

@@ -9854,12 +9962,12 @@ nbftp% chmod 755 . PKG_SHELL= ${PREFIX}/bin/zsh -
+
-

12.5.1. Disabling shell +

12.5.1. Disabling shell registration

@@ -9873,12 +9981,12 @@ nbftp% chmod 755 .
-
+

12.6. Fonts

+ "fonts" id="fonts">12.6. Fonts
@@ -9910,13 +10018,13 @@ nbftp% chmod 755 . FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF -
+
-

12.6.1. Disabling - automatic update of the fonts databases

+

12.6.1. Disabling automatic + update of the fonts databases

@@ -9930,11 +10038,11 @@ nbftp% chmod 755 .
-
+
-

Chapter 13. Options handling

@@ -9970,11 +10078,12 @@ nbftp% chmod 755 . sets of options will be built into a package or to allow a set of global default options apply.

-
+

13.1. Global default options

@@ -9989,11 +10098,12 @@ nbftp% chmod 755 . class="filename">/etc/mk.conf.

-
+

13.2. Converting packages to use chmod 755 .

PKG_OPTIONS_LEGACY_VARS is a list of “USE_VARIABLE:option” - pairs that map legacy USE_VARIABLE: + option” pairs that + map legacy /etc/mk.conf variables to their option counterparts. Pairs should be added with @@ -10150,9 +10261,10 @@ nbftp% chmod 755 .

PKG_OPTIONS_LEGACY_OPTS is a list of “old-option:new-option” - pairs that map options that have been renamed to - their new counterparts. Pairs should be added with + "replaceable">old-option: + new-option” pairs + that map options that have been renamed to their + new counterparts. Pairs should be added with “+=” to keep the listing of global legacy options. A warning will be issued if the user uses a legacy @@ -10217,11 +10329,12 @@ nbftp% chmod 755 .

-
+

13.3. Option Names

@@ -10258,11 +10371,11 @@ nbftp% chmod 755 .
-
+
-

Chapter 14. The build process

@@ -10337,11 +10450,12 @@ nbftp% chmod 755 .
-
+

14.1. Introduction

@@ -10355,7 +10469,7 @@ nbftp% chmod 755 . "varname">install), all of which are described in the following sections. Each phase is splitted into so-called stages, - which take the name of the containing stage, prefixed by + which take the name of the containing phase, prefixed by one of pre-, do- or post-. (Examples are chmod 755 .

The basic steps for building a program are always the same. First the program's source (distfile) must be brought to - the local system and then extracted. After any patches to - compile properly on NetBSD are applied, the software can - be configured, then built (usually by compiling), and - finally the generated binaries, etc. can be put into - place on the system. These are exactly the steps - performed by the NetBSD package system, which is - implemented as a series of targets in a central Makefile, - pkgsrc/mk/bsd.pkg.mk.

+ the local system and then extracted. After any + pkgsrc-specific patches to compile properly are applied, + the software can be configured, then built (usually by + compiling), and finally the generated binaries, etc. can + be put into place on the system.

-
+

14.2. Program location

@@ -10562,11 +10673,12 @@ nbftp% chmod 755 .
-
+

14.3. Directories used during the build process

@@ -10584,14 +10696,12 @@ nbftp% chmod 755 . "varname">PKGSRCDIR/PKGPATH is used for directories that are pkgsrc-specific. WRKSRC is used for directories inside - the package itself. The permissions after each variable - indicate whether the variable may be changed by the - package Makefile.

+ the package itself.

PKGSRCDIR (read-only)
+ "varname">PKGSRCDIR

This is an absolute pathname that points to the @@ -10600,7 +10710,7 @@ nbftp% chmod 755 .

PKGPATH (read-only)
+ "varname">PKGPATH

This is a pathname relative to chmod 755 .

WRKDIR (read-only)
+ "varname">WRKDIR

This is an absolute pathname pointing to the @@ -10623,24 +10733,28 @@ nbftp% chmod 755 .

WRKSRC (read-write)
+ "varname">WRKSRC

This is an absolute pathname pointing to the directory where the distfiles are extracted. It is usually a direct subdirectory of WRKDIR, and often it's the only - directory entry that isn't hidden.

+ directory entry that isn't hidden. This variable + may be changed by a package Makefile.

-
+

14.4. Running a phase

@@ -10657,13 +10771,14 @@ nbftp% chmod 755 . will be built, but not installed.

-
+

14.5. The fetch phase

+ "build.fetch" id="build.fetch">14.5. The + fetch + phase
@@ -10695,11 +10810,12 @@ nbftp% chmod 755 . "varname">MASTER_SORT_REGEX.

-
+

14.6. The checksum phase

@@ -10715,11 +10831,12 @@ nbftp% chmod 755 . master distribution site or network lossage.

-
+

14.7. The extract phase

@@ -10787,13 +10904,14 @@ nbftp% chmod 755 .
-
+

14.8. The patch phase

+ "build.patch" id="build.patch">14.8. The + patch + phase
@@ -10835,13 +10953,14 @@ nbftp% chmod 755 . there.

-
+

14.9. The tools phase

+ "build.tools" id="build.tools">14.9. The + tools + phase
@@ -10849,11 +10968,12 @@ nbftp% chmod 755 .

[TODO]

-
+

14.10. The wrapper phase

@@ -10863,11 +10983,12 @@ nbftp% chmod 755 .

[TODO]

-
+

14.11. The configure phase

@@ -10922,13 +11043,14 @@ nbftp% chmod 755 . "varname">USE_X11BASE instead.)

-
+

14.12. The build phase

+ "build.build" id="build.build">14.12. The + build + phase
@@ -10968,13 +11090,14 @@ nbftp% chmod 755 . “all”.

-
+

14.13. The test phase

+ "build.test" id="build.test">14.13. The + test + phase
@@ -10982,11 +11105,12 @@ nbftp% chmod 755 .

[TODO]

-
+

14.14. The install phase

@@ -10996,21 +11120,122 @@ nbftp% chmod 755 .

Once the build stage has completed, the final step is to install the software in public directories, so users can access the programs and files. As in the - build-target, $MAKE_PROGRAM - is invoked on $MAKEFILE - here, but with the $INSTALL_TARGET instead, the latter - defaulting to “MAKE_PROGRAM + is invoked on MAKEFILE here, + but with the INSTALL_TARGET + instead, the latter defaulting to “install” (plus “install.man”, if USE_IMAKE is set).

+ +

In the install + phase, the following variables are useful. They are all + variations of the + install(1) command that + have the owner, group and permissions preset. + INSTALL is the plain install + command. The specialized variants, together with their + intended use, are:

+ +
+
+
INSTALL_PROGRAM_DIR
+ +
+

directories that contain binaries

+
+ +
INSTALL_SCRIPT_DIR
+ +
+

directories that contain scripts

+
+ +
INSTALL_LIB_DIR
+ +
+

directories that contain shared and static + libraries

+
+ +
INSTALL_DATA_DIR
+ +
+

directories that contain data files

+
+ +
INSTALL_MAN_DIR
+ +
+

directories that contain man pages

+
+ +
INSTALL_PROGRAM
+ +
+

binaries that can be stripped from debugging + symbols

+
+ +
INSTALL_SCRIPT
+ +
+

binaries that cannot be unstripped

+
+ +
INSTALL_GAME
+ +
+

game binaries

+
+ +
INSTALL_LIB
+ +
+

shared and static libraries

+
+ +
INSTALL_DATA
+ +
+

data files

+
+ +
INSTALL_GAME_DATA
+ +
+

data files for games

+
+ +
INSTALL_MAN
+ +
+

man pages

+
+
+
-
+

14.15. The package phase

@@ -11020,11 +11245,12 @@ nbftp% chmod 755 .

[TODO]

-
+

14.16. Other helpful targets

@@ -11560,11 +11786,11 @@ nbftp% chmod 755 .
-
+
-

Chapter 15. Making your package work

@@ -11766,22 +11992,24 @@ nbftp% chmod 755 .
-
+

15.1. General operation

-
+

15.1.1. How to pull in variables from /etc/mk.conf

@@ -11845,11 +12073,12 @@ nbftp% chmod 755 . interested in optimization for the current CPU.

-
+

15.1.2. Where to install documentation

@@ -11865,11 +12094,12 @@ nbftp% chmod 755 . package).

-
+
-

15.1.3. Restricted packages

@@ -11944,11 +12174,11 @@ nbftp% chmod 755 . binary packages!

-
+
-

15.1.4. Handling dependencies

@@ -12122,8 +12352,8 @@ nbftp% chmod 755 . RECOMMENDED, see - Section 15.1.8, “Handling packages - with security problems” for more + Section 15.1.8, “Handling packages with + security problems” for more information.

@@ -12199,11 +12429,11 @@ nbftp% chmod 755 . "filename">devel/gettext-m4 package.

-
+
-

15.1.5. Handling conflicts with other packages

@@ -12251,11 +12481,12 @@ nbftp% chmod 755 . "quote">Xaw3d-1.3”.

-
+
-

15.1.6. Packages that cannot or should not be built

@@ -12284,11 +12515,12 @@ nbftp% chmod 755 . message.

-
+
-

15.1.7. Packages which should not be deleted, once installed

@@ -12309,11 +12541,11 @@ nbftp% chmod 755 . is used.

-
+
-

15.1.8. Handling packages with security problems

@@ -12348,11 +12580,11 @@ nbftp% chmod 755 . handled semi-automatically by a weekly cron job.

-
+
-

15.1.9. How to handle compiler bugs

@@ -12375,12 +12607,12 @@ nbftp% chmod 755 . number of examples!

-
+
-

15.1.10. How to +

15.1.10. How to handle incrementing versions when fixing an existing package

@@ -12416,11 +12648,12 @@ nbftp% chmod 755 .
-
+

15.1.11. Portability of packages

@@ -12433,11 +12666,11 @@ nbftp% chmod 755 . portable. There are some particular details you should pay attention to while working on pkgsrc.

-
+
-

15.1.11.1. ${INSTALL}, ${INSTALL_DATA_DIR}, ...

@@ -12458,22 +12691,23 @@ nbftp% chmod 755 .
-
+

15.2. Possible downloading issues

-
+
-

15.2.1. Packages whose distfiles aren't available for plain downloading

@@ -12543,11 +12777,12 @@ nbftp% chmod 755 . with them.

-
+

15.2.2. How to handle modified distfiles with the 'old' name

@@ -12585,22 +12820,23 @@ nbftp% chmod 755 .
-
+

15.3. Configuration gotchas

-
+
-

15.3.1. Shared libraries - libtool

@@ -12825,11 +13061,11 @@ nbftp% chmod 755 .
-
+
-

15.3.2. Using libtool on GNU packages that already support libtool

@@ -12908,11 +13144,11 @@ nbftp% chmod 755 .
-
+
-

15.3.3. GNU Autoconf/Automake

@@ -12965,22 +13201,23 @@ nbftp% chmod 755 .
-
+

15.4. Building the package

-
+
-

15.4.1. CPP defines

@@ -13011,11 +13248,12 @@ nbftp% chmod 755 . that you are using NetBSD on an i386 compatible CPU, and your compiler is GCC.

-
+

15.4.1.1. CPP defines for operating systems

@@ -13047,12 +13285,12 @@ nbftp% chmod 755 .
-
+
-

15.4.1.2. CPP +

15.4.1.2. CPP defines for CPUs

@@ -13064,11 +13302,12 @@ nbftp% chmod 755 .
-
+

15.4.1.3. CPP defines for compilers

@@ -13081,11 +13320,11 @@ nbftp% chmod 755 .
-
+
-

15.4.2. Examples of CPP defines for some platforms

@@ -13149,11 +13388,11 @@ nbftp% chmod 755 .
-
+
-

15.4.3. Getting a list of CPP defines

@@ -13174,22 +13413,23 @@ nbftp% chmod 755 .
-
+

15.5. Package specific actions

-
+
-

15.5.1. User interaction

@@ -13236,11 +13476,11 @@ nbftp% chmod 755 .
-
+
-

15.5.2. Handling licenses

@@ -13335,11 +13575,12 @@ nbftp% chmod 755 . pkgsrc that a fee has been paid.

-
+

15.5.3. Installing score files

@@ -13374,11 +13615,11 @@ nbftp% chmod 755 . these correctly.

-
+
-

15.5.4. Packages containing perl scripts

@@ -13393,11 +13634,11 @@ nbftp% chmod 755 . "varname">WRKSRC, that you want adjusted.

-
+
-

15.5.5. Packages with hardcoded paths to other interpreters

@@ -13422,11 +13663,11 @@ nbftp% chmod 755 .
-
+
-

15.5.6. Packages installing perl modules

@@ -13471,11 +13712,11 @@ nbftp% chmod 755 . "filename">PLIST.

-
+
-

15.5.7. Packages installing info files

@@ -13575,11 +13816,11 @@ nbftp% chmod 755 . error.

-
+
-

15.5.8. Packages installing man pages

@@ -13643,11 +13884,11 @@ nbftp% chmod 755 . on installation of compressed manual pages.

-
+
-

15.5.9. Packages installing GConf2 data files

@@ -13732,11 +13973,12 @@ nbftp% chmod 755 .
-
+

15.5.10. Packages installing scrollkeeper data files

@@ -13782,11 +14024,11 @@ nbftp% chmod 755 .
-
+
-

15.5.11. Packages installing X11 fonts

@@ -13819,11 +14061,11 @@ nbftp% chmod 755 . them.

-
+
-

15.5.12. Packages installing GTK2 modules

@@ -13893,11 +14135,11 @@ nbftp% chmod 755 .
-
+
-

15.5.13. Packages installing SGML or XML data

@@ -13957,11 +14199,11 @@ nbftp% chmod 755 .
-
+
-

15.5.14. Packages installing extensions to the MIME database

@@ -14024,11 +14266,11 @@ nbftp% chmod 755 .
-
+
-

15.5.15. Packages using intltool

@@ -14049,11 +14291,11 @@ nbftp% chmod 755 . appeared since it was released.

-
+
-

15.5.16. Packages installing startup scripts

@@ -14073,11 +14315,11 @@ nbftp% chmod 755 . when the package is deinstalled.

-
+
-

15.5.17. Packages installing TeX modules

@@ -14150,11 +14392,12 @@ nbftp% chmod 755 .
-
+

15.6. Feedback to the author

@@ -14174,11 +14417,11 @@ nbftp% chmod 755 .
-
+
-

Chapter 16. Debugging

@@ -14390,11 +14633,11 @@ nbftp% chmod 755 .
-
+
-

Chapter 17. Submitting and Committing

@@ -14426,11 +14669,12 @@ nbftp% chmod 755 .
-
+

17.1. Submitting your packages

@@ -14495,11 +14739,12 @@ nbftp% chmod 755 .
-
+

17.2. General notes when adding, updating, or removing packages

@@ -14548,11 +14793,12 @@ nbftp% chmod 755 . "filename">pkgsrc/doc/CHANGES!

-
+

17.3. Committing: Importing a package into CVS

@@ -14597,11 +14843,12 @@ nbftp% chmod 755 . consistent tag.

-
+

17.4. Updating a package to a newer version

@@ -14648,11 +14895,12 @@ nbftp% chmod 755 . preferred above new and possibly untested features.

-
+

17.5. Moving a package in pkgsrc

@@ -14741,11 +14989,11 @@ nbftp% chmod 755 .
-
+
-

Appendix A. A simple example package: bison

@@ -14790,21 +15038,22 @@ nbftp% chmod 755 . present in the tree is beyond us, but it's useful for the purposes of this exercise.

-
+

A.1. files

-
+
-

A.1.1. Makefile

@@ -14828,11 +15077,11 @@ nbftp% chmod 755 .
-
+
-

A.1.2. DESCR

@@ -14845,11 +15094,11 @@ nbftp% chmod 755 .
-
+
-

A.1.3. PLIST

@@ -14863,11 +15112,12 @@ nbftp% chmod 755 .
-
+

A.1.4. Checking a package with pkglint

@@ -14898,11 +15148,12 @@ looks fine.
-
+

A.2. Steps for building, installing, packaging

@@ -14930,8 +15181,8 @@ looks fine. "http://www.w3.org/TR/xhtml1/transitional" class= "filename">PLIST (see - Chapter 8, Package components - files, directories - and contents) then continue with fetching the + Chapter 8, Package components - files, directories and + contents) then continue with fetching the distfile:

 #
-
+
-

Appendix B. Build logs

@@ -15078,11 +15329,12 @@ Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'
-
+

B.1. Building figlet

@@ -15181,11 +15433,12 @@ cp figlet.6 /usr/pkg/man/man6
-
+

B.2. Packaging figlet

@@ -15204,11 +15457,11 @@ Registering depends:.
-
+
-

Appendix C. Layout of the FTP server's package archive

@@ -15283,8 +15536,8 @@ Registering depends:.

  1. Run bulk build, see Section 6.3, - “Doing a bulk build of all + "6.3. Doing a bulk build of all packages">Section + 6.3, “Doing a bulk build of all packages”

    2. @@ -15307,11 +15560,11 @@ Registering depends:.
-
+
-

Appendix D. Editing guidelines for the pkgsrc guide

@@ -15333,12 +15586,12 @@ Registering depends:.

This section contains information on editing the pkgsrc guide itself.

-
+

D.1. Targets

+ "targets" id="targets">D.1. Targets
@@ -15390,11 +15643,12 @@ Registering depends:.
-
+

D.2. Procedure

-- cgit v1.2.3