summaryrefslogtreecommitdiff
path: root/doc/pkgsrc.txt
diff options
context:
space:
mode:
authorrillig <rillig@pkgsrc.org>2007-08-15 20:54:20 +0000
committerrillig <rillig@pkgsrc.org>2007-08-15 20:54:20 +0000
commit8719404467d3a053563f96d8d18d7cee5c16a586 (patch)
tree5cdc47682cecc931f98dfaa5b8048137f96d4cee /doc/pkgsrc.txt
parent7d8b7c659605c793ffb6780ee2ceb4c07c06b2aa (diff)
downloadpkgsrc-8719404467d3a053563f96d8d18d7cee5c16a586.tar.gz
regen
Diffstat (limited to 'doc/pkgsrc.txt')
-rw-r--r--doc/pkgsrc.txt128
1 files changed, 62 insertions, 66 deletions
diff --git a/doc/pkgsrc.txt b/doc/pkgsrc.txt
index 741f568a00e..4ed03e01740 100644
--- a/doc/pkgsrc.txt
+++ b/doc/pkgsrc.txt
@@ -12,9 +12,9 @@ Hubert Feyrer
The pkgsrc Developers
-Copyright 1994-2006 The NetBSD Foundation, Inc
+Copyright 1994-2007 The NetBSD Foundation, Inc
-$NetBSD: pkgsrc.xml,v 1.24 2006/11/11 05:39:09 rillig Exp $
+$NetBSD: pkgsrc.xml,v 1.25 2007/08/15 06:32:38 rillig Exp $
Abstract
@@ -1153,8 +1153,8 @@ with the FreeBSD userland tools. There are several steps:
# mv pkg_info pkg_info.orig
- 3. An example /etc/mk.conf file will be placed in /etc/mk.conf.example file
- when you use the bootstrap script.
+ 3. An example mk.conf file will be placed in /etc/mk.conf.example file when
+ you use the bootstrap script.
3.3.3. Interix
@@ -1341,9 +1341,8 @@ ABI. If you start out using "abi=n32", that's what all your packages will be
built with.
Therefore, please make sure that you have no conflicting CFLAGS in your
-environment or the /etc/mk.conf. Particularly, make sure that you do not try to
-link n32 object files with lib64 or vice versa. Check your /etc/
-compiler.defaults!
+environment or the mk.conf. Particularly, make sure that you do not try to link
+n32 object files with lib64 or vice versa. Check your /etc/compiler.defaults!
If you have the actual pkgsrc tree mounted via NFS from a different host,
please make sure to set WRKOBJDIR to a local directory, as it appears that IRIX
@@ -1360,7 +1359,7 @@ If you are using SGI's MIPSPro compiler, please set
PKGSRC_COMPILER= mipspro
-in /etc/mk.conf. Otherwise, pkgsrc will assume you are using gcc and may end up
+in mk.conf. Otherwise, pkgsrc will assume you are using gcc and may end up
passing invalid flags to the compiler. Note that bootstrap should create an
appropriate mk.conf.example by default.
@@ -1394,14 +1393,14 @@ side-effect of breaking many of the Linux header files, which cannot be
compiled properly without __attribute__. The test must be overridden so that
__attribute__ is assumed supported by the compiler.
-After bootstrapping, you should set PKGSRC_COMPILER in /etc/mk.conf:
+After bootstrapping, you should set PKGSRC_COMPILER in mk.conf:
PKGSRC_COMPILER= icc
The default installation directory for icc is /opt/intel_cc_80, which is also
the pkgsrc default. If you have installed it into a different directory, set
-ICCBASE in /etc/mk.conf:
+ICCBASE in mk.conf:
ICCBASE= /opt/icc
@@ -1437,10 +1436,10 @@ with the OpenBSD userland tools. There are several steps:
# mv pkg_info pkg_info.orig
- 3. An example /etc/mk.conf file will be placed in /etc/mk.conf.example file
- when you use the bootstrap script. OpenBSD's make program uses /etc/mk.conf
- as well. You can work around this by enclosing all the pkgsrc-specific
- parts of the file with:
+ 3. An example mk.conf file will be placed in /etc/mk.conf.example file when
+ you use the bootstrap script. OpenBSD's make program uses mk.conf as well.
+ You can work around this by enclosing all the pkgsrc-specific parts of the
+ file with:
.ifdef BSD_PKG_MK
# pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
@@ -1770,7 +1769,7 @@ priority than MASTER_SORT. Have a look at pkgsrc/mk/defaults/mk.conf to find
some examples. This may save some of your bandwidth and time.
You can change these settings either in your shell's environment, or, if you
-want to keep the settings, by editing the /etc/mk.conf file, and adding the
+want to keep the settings, by editing the mk.conf file, and adding the
definitions there.
If a package depends on many other packages (such as meta-pkgs/kde3), the build
@@ -1841,10 +1840,10 @@ pkgsrc/) below the LOCALBASE tree. This is to prevent possible conflicts
between programs and other files installed by the package system and whatever
else may have been installed there.
-Some packages look in /etc/mk.conf to alter some configuration options at build
+Some packages look in mk.conf to alter some configuration options at build
time. Have a look at pkgsrc/mk/defaults/mk.conf to get an overview of what will
be set there by default. Environment variables such as LOCALBASE can be set in
-/etc/mk.conf to save having to remember to set them each time you want to use
+mk.conf to save having to remember to set them each time you want to use
pkgsrc.
Occasionally, people want to "look under the covers" to see what is going on
@@ -2103,14 +2102,14 @@ mutually exclusive, run make show-options, for example:
These options are enabled by default: firefox
These options are currently enabled: mozilla ssl
-The following variables can be defined in /etc/mk.conf to select which options
-to enable for a package: PKG_DEFAULT_OPTIONS, which can be used to select or
+The following variables can be defined in mk.conf to select which options to
+enable for a package: PKG_DEFAULT_OPTIONS, which can be used to select or
disable options for all packages that support them, and PKG_OPTIONS.pkgbase,
which can be used to select or disable options specifically for package pkgbase
. Options listed in these variables are selected, options preceded by "-" are
disabled. A few examples:
-$ grep "PKG.*OPTION" /etc/mk.conf
+$ grep "PKG.*OPTION" mk.conf
PKG_DEFAULT_OPTIONS= -arts -dvdread -esound
PKG_OPTIONS.kdebase= debug -sasl
PKG_OPTIONS.apache= suexec
@@ -2133,11 +2132,11 @@ option from a required group of options is selected, and building the package
will fail.
Before the options framework was introduced, build options were selected by
-setting a variable (often named USE_FOO) in /etc/mk.conf for each option. To
-ease transition to the options framework for the user, these legacy variables
-are converted to the appropriate options setting (PKG_OPTIONS.pkgbase)
-automatically. A warning is issued to prompt the user to update /etc/mk.conf to
-use the options framework directly. Support for the legacy variables will be
+setting a variable (often named USE_FOO) in mk.conf for each option. To ease
+transition to the options framework for the user, these legacy variables are
+converted to the appropriate options setting (PKG_OPTIONS.pkgbase)
+automatically. A warning is issued to prompt the user to update mk.conf to use
+the options framework directly. Support for the legacy variables will be
removed eventually.
Chapter 6. Creating binary packages
@@ -2212,12 +2211,12 @@ find an annotated example file in pkgsrc/mk/bulk/build.conf-example. To use it,
copy build.conf-example to build.conf and edit it, following the comments in
that file.
-6.3.1.2. /etc/mk.conf
+6.3.1.2. mk.conf
-You may want to set variables in /etc/mk.conf. Look at pkgsrc/mk/defaults/
-mk.conf for details of the default settings. You will want to ensure that
+You may want to set variables in mk.conf. Look at pkgsrc/mk/defaults/mk.conf
+for details of the default settings. You will want to ensure that
ACCEPTABLE_LICENSES meet your local policy. As used in this example,
-_ACCEPTABLE=yes accepts all licenses.
+_ACCEPTABLE=yes completely bypasses the license check.
PACKAGES?= ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
WRKOBJDIR?= /usr/tmp/pkgsrc # build here instead of in pkgsrc
@@ -2428,7 +2427,7 @@ src/etc, be sure the following items are present and properly configured:
10. Make /usr/sandbox/usr/pkgsrc/packages and .../distfiles point somewhere
appropriate. NFS- and/or nullfs-mounts may come in handy!
-11. Edit /etc/mk.conf, see Section 6.3.1.2, "/etc/mk.conf".
+11. Edit mk.conf, see Section 6.3.1.2, "mk.conf".
12. Adjust mk/bulk/build.conf to suit your needs.
@@ -2448,7 +2447,7 @@ from).
In addition to building a complete set of all packages in pkgsrc, the pkgsrc/mk
/bulk/build script may be used to build a subset of the packages contained in
-pkgsrc. By setting SPECIFIC_PKGS in /etc/mk.conf, the variables
+pkgsrc. By setting SPECIFIC_PKGS in mk.conf, the variables
* SITE_SPECIFIC_PKGS
@@ -2873,9 +2872,8 @@ the script, as well as some others that allow finer tuning of the tree layout.
8.5. How to resume transfers when fetching distfiles?
By default, resuming transfers in pkgsrc is disabled, but you can enable this
-feature by adding the option PKG_RESUME_TRANSFERS=YES into /etc/mk.conf. If,
-during a fetch step, an incomplete distfile is found, pkgsrc will try to resume
-it.
+feature by adding the option PKG_RESUME_TRANSFERS=YES into mk.conf. If, during
+a fetch step, an incomplete distfile is found, pkgsrc will try to resume it.
You can also use a different program than the default ftp(1) by changing the
FETCH_CMD variable. Don't forget to set FETCH_RESUME_ARGS and FETCH_OUTPUT_ARGS
@@ -2892,8 +2890,8 @@ FETCH_OUTPUT_ARGS= -O
8.6. How can I install/use modular X.org from pkgsrc?
If you want to use modular X.org from pkgsrc instead of your system's own X11
-(/usr/X11R6, /usr/openwin, ...) you will have to add the following line into /
-etc/mk.conf:
+(/usr/X11R6, /usr/openwin, ...) you will have to add the following line into
+mk.conf:
X11_TYPE=modular
@@ -2924,7 +2922,7 @@ FETCH_CMD is assigned the first available command from the following list:
On a default NetBSD installation, this will be /usr/bin/ftp, which
automatically tries passive connections first, and falls back to active
connections if the server refuses to do passive. For the other tools, add the
-following to your /etc/mk.conf file: PASSIVE_FETCH=1.
+following to your mk.conf file: PASSIVE_FETCH=1.
Having that option present will prevent /usr/bin/ftp from falling back to
active transfers.
@@ -2972,7 +2970,7 @@ that you don't have installed the "text" set (nroff, ...) from the NetBSD base
distribution on your machine. It is recommended to do that to format man pages.
In the case of the pkgtools/pkg_install package, you can get away with setting
-NOMAN=YES either in the environment or in /etc/mk.conf.
+NOMAN=YES either in the environment or in mk.conf.
8.11. What does "Could not find bsd.own.mk" mean?
@@ -2991,8 +2989,8 @@ When installing packages as non-root user and using the just-in-time su(1)
feature of pkgsrc, it can become annoying to type in the root password for each
required package installed. To avoid this, the sudo package can be used, which
does password caching over a limited time. To use it, install sudo (either as
-binary package or from security/sudo) and then put the following into your /etc
-/mk.conf, somewhere after the definition of the LOCALBASE variable:
+binary package or from security/sudo) and then put the following into your
+mk.conf, somewhere after the definition of the LOCALBASE variable:
.if exists(${LOCALBASE}/bin/sudo)
SU_CMD= ${LOCALBASE}/bin/sudo /bin/sh -c
@@ -3007,8 +3005,8 @@ expectations (e.g., a read-only, NFS-exported PREFIX with a need of per-machine
configuration of the provided packages).
In order to change the defaults, you can modify the PKG_SYSCONFBASE variable
-(in /etc/mk.conf) to point to your preferred configuration directory; some
-common examples include /etc or /etc/pkg.
+(in mk.conf) to point to your preferred configuration directory; some common
+examples include /etc or /etc/pkg.
Furthermore, you can change this value on a per-package basis by setting the
PKG_SYSCONFDIR.${PKG_SYSCONFVAR} variable. PKG_SYSCONFVAR's value usually
@@ -3733,8 +3731,8 @@ Other variables that affect the build:
the same pkgsrc tree for building different kinds of binary packages, you
can change the variable according to your needs. Two other variables handle
common cases of setting WRKDIR_BASENAME individually. If OBJHOSTNAME is
- defined in /etc/mk.conf, the first component of the host's name is attached
- to the directory name. If OBJMACHINE is defined, the platform name is
+ defined in mk.conf, the first component of the host's name is attached to
+ the directory name. If OBJMACHINE is defined, the platform name is
attached, which might look like work.i386 or work.sparc.
Please pay attention to the following gotchas:
@@ -5204,7 +5202,7 @@ options apply.
Global default options are listed in PKG_DEFAULT_OPTIONS, which is a list of
the options that should be built into every package if that option is
-supported. This variable should be set in /etc/mk.conf.
+supported. This variable should be set in mk.conf.
15.2. Converting packages to use bsd.options.mk
@@ -5287,7 +5285,7 @@ supported by the package, and any default options settings if needed.
default.
7. PKG_OPTIONS_LEGACY_VARS is a list of "USE_VARIABLE:option" pairs that map
- legacy /etc/mk.conf variables to their option counterparts. Pairs should be
+ legacy mk.conf variables to their option counterparts. Pairs should be
added with "+=" to keep the listing of global legacy variables. A warning
will be issued if the user uses a legacy variable.
@@ -5955,7 +5953,7 @@ update
tree remains unchanged. If the source code for one of the packages to be
updated has been changed, resuming make update will most certainly fail!
- The following variables can be used either on the command line or in /etc/
+ The following variables can be used either on the command line or in
mk.conf to alter the behaviour of make update:
UPDATE_TARGET
@@ -6010,7 +6008,7 @@ clean-update
# make update
- The following variables can be used either on the command line or in /etc/
+ The following variables can be used either on the command line or in
mk.conf to alter the behaviour of make clean-update:
CLEAR_DIRLIST
@@ -6115,7 +6113,7 @@ check-shlibs
After a package is installed, check all its binaries and (on ELF platforms)
shared libraries to see if they find the shared libs they need. Run by
- default if PKG_DEVELOPER is set in /etc/mk.conf.
+ default if PKG_DEVELOPER is set in mk.conf.
print-PLIST
@@ -6334,10 +6332,10 @@ attention to while working on pkgsrc.
18.1.2. How to pull in user-settable variables from mk.conf
The pkgsrc user can configure pkgsrc by overriding several variables in the
-file pointed to by MAKECONF, which is /etc/mk.conf by default. When you want to
-use those variables in the preprocessor directives of make(1) (for example .if
-or .for), you need to include the file ../../mk/bsd.prefs.mk before, which in
-turn loads the user preferences.
+file pointed to by MAKECONF, which is mk.conf by default. When you want to use
+those variables in the preprocessor directives of make(1) (for example .if or
+.for), you need to include the file ../../mk/bsd.prefs.mk before, which in turn
+loads the user preferences.
But note that some variables may not be completely defined after ../../mk/
bsd.prefs.mk has been included, as they may contain references to variables
@@ -6435,7 +6433,7 @@ a license which has not been placed in the ACCEPTABLE_LICENSES variable:
The license can be viewed with make show-license, and if the user so chooses,
-the line printed above can be added to /etc/mk.conf to convey to pkgsrc that it
+the line printed above can be added to mk.conf to convey to pkgsrc that it
should not in the future fail because of that license:
ACCEPTABLE_LICENSES+=xv-license
@@ -7504,9 +7502,9 @@ since it was released.
If a package contains a rc.d script, it won't be copied into the startup
directory by default, but you can enable it, by adding the option
-PKG_RCD_SCRIPTS=YES in /etc/mk.conf. This option will copy the scripts into /
-etc/rc.d when a package is installed, and it will automatically remove the
-scripts when the package is deinstalled.
+PKG_RCD_SCRIPTS=YES in mk.conf. This option will copy the scripts into /etc/
+rc.d when a package is installed, and it will automatically remove the scripts
+when the package is deinstalled.
18.6.17. Packages installing TeX modules
@@ -7605,7 +7603,7 @@ To check out all the gotchas when building a package, here are the steps that I
do in order to get a package working. Please note this is basically the same as
what was explained in the previous sections, only with some debugging aids.
- * Be sure to set PKG_DEVELOPER=1 in /etc/mk.conf
+ * Be sure to set PKG_DEVELOPER=yes in mk.conf.
* Install pkgtools/url2pkg, create a directory for a new package, change into
it, then run url2pkg:
@@ -7744,9 +7742,9 @@ general usage is to first make sure that your CHANGES-YYYY file is up-to-date
(to avoid having to resolve conflicts later-on) and then to cd to the package
directory. For package updates, make changes-entry is enough. For new packages,
or package moves or removals, set the CTYPE variable on the command line to
-"Added", "Moved", or "Removed". You can set NETBSD_LOGIN_NAME in /etc/mk.conf
-if your local login name is not the same as your NetBSD login name. Don't
-forget to commit the changes to pkgsrc/doc/CHANGES-YYYY!
+"Added", "Moved", or "Removed". You can set NETBSD_LOGIN_NAME in mk.conf if
+your local login name is not the same as your NetBSD login name. Don't forget
+to commit the changes to pkgsrc/doc/CHANGES-YYYY!
20.4. Committing: Importing a package into CVS
@@ -8428,11 +8426,9 @@ reasons for that order.
The very first action in bsd.prefs.mk is to define some essential variables
like OPSYS, OS_VERSION and MACHINE_ARCH.
-Then, the user settings are loaded from the file specified in MAKECONF. If the
-bmake command from pkgsrc is used, MAKECONF defaults to ${prefix}/etc/mk.conf.
-With the native make(1) command on NetBSD, it defaults to /etc/mk.conf. After
-that, those variables that have not been overridden by the user are loaded from
-mk/defaults/mk.conf.
+Then, the user settings are loaded from the file specified in MAKECONF, which
+is usually mk.conf. After that, those variables that have not been overridden
+by the user are loaded from mk/defaults/mk.conf.
After the user settings, the system settings and platform settings are loaded,
which may override the user settings.