From 8ba088c4d655fd9388ab9782c85e2c65b48f68e0 Mon Sep 17 00:00:00 2001 From: rillig Date: Fri, 2 Sep 2005 19:12:37 +0000 Subject: Various fixes for typos and grammar by Leonard Schmidt. --- doc/guide/files/binary.xml | 20 ++++++++++---------- doc/guide/files/build.xml | 32 ++++++++++++++++---------------- doc/guide/files/buildlink.xml | 14 +++++++------- doc/guide/files/components.xml | 16 ++++++++-------- doc/guide/files/configuring.xml | 8 ++++---- doc/guide/files/editing.xml | 6 +++--- doc/guide/files/examples.xml | 4 ++-- doc/guide/files/faq.xml | 21 ++++++++------------- doc/guide/files/fixes.xml | 34 +++++++++++++++++----------------- doc/guide/files/introduction.xml | 6 +++--- doc/guide/files/makefile.xml | 22 +++++++++++----------- doc/guide/files/options.xml | 4 ++-- doc/guide/files/pkginstall.xml | 17 ++++++++--------- doc/guide/files/platforms.xml | 20 ++++++++++---------- doc/guide/files/plist.xml | 18 +++++++++--------- doc/guide/files/using.xml | 24 ++++++++++++------------ 16 files changed, 130 insertions(+), 136 deletions(-) (limited to 'doc/guide') diff --git a/doc/guide/files/binary.xml b/doc/guide/files/binary.xml index 2d8a47a699f..afe1daa3789 100644 --- a/doc/guide/files/binary.xml +++ b/doc/guide/files/binary.xml @@ -1,4 +1,4 @@ - + Creating binary packages @@ -9,7 +9,7 @@ Once you have built and installed a package, you can create a binary package which can be installed on - another system with &man.pkg.add.1; This saves having to build + another system with &man.pkg.add.1;. This saves having to build the same package on a group of hosts and wasting CPU time. It also provides a simple means for others to install your package, should you distribute it. @@ -99,7 +99,7 @@ _ACCEPTABLE= yes <filename>pre-build.local</filename> It is possible to configure the bulk build to perform - certain site specific tasks at the end of the pre-build + certain site-specific tasks at the end of the pre-build stage. If the file pre-build.local exists in /usr/pkgsrc/mk/bulk, it will be executed @@ -269,7 +269,7 @@ fi - Setting up a sandbox for chroot'ed builds + Setting up a sandbox for chrooted builds If you don't want all the packages nuked from a machine @@ -393,7 +393,7 @@ fi - When the chroot sandbox is setup, you can start + When the chroot sandbox is set up, you can start the build with the following steps: &rprompt; cd /usr/sandbox/usr/pkgsrc @@ -413,7 +413,7 @@ fi 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 defining SPECIFIC_PKGS + pkgsrc. By setting SPECIFIC_PKGS in /etc/mk.conf, the variables @@ -468,7 +468,7 @@ fi RSYNC_DST=$CVS_USER@ftp.NetBSD.org:/pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload - Please use appropviate values for "pkgsrc-200xQy", + Please use appropriate values for "pkgsrc-200xQy", "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org is different from CVS_USER, write your login directly into the variable, e.g. my local @@ -494,7 +494,7 @@ fi Before uploading the binary pkgs, ssh authentication needs to - be set up. This example shows how to setup temporary keys + be set up. This example shows how to set up temporary keys for the root account inside the sandbox (assuming that no keys should be present there usually): @@ -569,7 +569,7 @@ nbftp% chmod 755 . pkgtools/cdpack package provides a simple tool for creating the ISO 9660 images. cdpack arranges the packages on the CD-ROMs in a - way that keeps all the dependencies for given package on the same + way that keeps all the dependencies for a given package on the same CD as that package. @@ -578,7 +578,7 @@ nbftp% chmod 755 . Complete documentation for cdpack is found in the cdpack(1) - manpage. The following short example assumes that the binary + man page. The following short example assumes that the binary packages are left in /usr/pkgsrc/packages/All and that sufficient disk space exists in /u2 to diff --git a/doc/guide/files/build.xml b/doc/guide/files/build.xml index 635b5e5494a..334dca88795 100644 --- a/doc/guide/files/build.xml +++ b/doc/guide/files/build.xml @@ -1,4 +1,4 @@ - + The build process @@ -55,8 +55,8 @@ - X11 based are special in that they may be installed in either - X11BASE or LOCALBASE. + X11-based packages are special in that they may be installed in + either X11BASE or LOCALBASE. Usually, X11 packages should be installed under LOCALBASE whenever possible. Note that you will @@ -202,8 +202,8 @@ CONFIGURE_ARGS+= --with-guile-prefix=${LOCALBASE} \ .shar.Z, .shar, .Z, .bz2 and .gz; see the definition of the - various DECOMPRESS_CMD variables - bsd.pkg.mk for a complete + various DECOMPRESS_CMD variables in + bsd.pkg.extract.mk for a complete list). Here's an example on how to use the other variables for a program that comes with a compressed shell archive whose name ends in .msg.gz: @@ -409,7 +409,7 @@ make build updating in case a previous make update was interrupted for some reason. However, in this case, make sure you don't call make clean or otherwise remove the list of dependent - packages in WRKDIR. Otherwise you lose the + packages in WRKDIR. Otherwise, you lose the ability to automatically update the current package along with the dependent packages you have installed. @@ -489,10 +489,10 @@ make build make update and only if you have a dirty package tree (e.g., if you used NOCLEAN). - If you unsure about whether your tree is clean you can either perform - a make clean at the top of the tree, or use the - following sequence of commands from the directory of the package you - want to update (before running + If you are unsure about whether your tree is clean, you can either + perform a make clean at the top of the tree, or use + the following sequence of commands from the directory of the package + you want to update (before running make update for the first time, otherwise you lose all the packages you wanted to update!): @@ -669,10 +669,10 @@ make build Used to do bulk builds. If an appropriate binary package already exists, no action is taken. If not, this target will compile, install and - package it (and it's depends, if PKG_DEPENDS is - set properly. See . + package it (and its depends, if PKG_DEPENDS is + set properly. See ). After creating the binary - package, the sources, the just-installed package and it's required + package, the sources, the just-installed package and its required packages are removed, preserving free disk space. Beware that this target may deinstall all @@ -685,11 +685,11 @@ make build Used during bulk-installs to install required packages. If an - upto-date binary package is available, it will be installed via + up-to-date binary package is available, it will be installed via &man.pkg.add.1;. If not, make bulk-package will be executed, - but the installed binary not be removed. + but the installed binary won't be removed. - A binary package is considered upto-date to be + A binary package is considered up-to-date to be installed via &man.pkg.add.1; if: diff --git a/doc/guide/files/buildlink.xml b/doc/guide/files/buildlink.xml index 740d34913b3..1aa3d93705b 100644 --- a/doc/guide/files/buildlink.xml +++ b/doc/guide/files/buildlink.xml @@ -1,4 +1,4 @@ - + Buildlink methodology @@ -88,7 +88,7 @@ - curses.buildlink3.mk If the system + curses.buildlink3.mk: If the system comes with neither Curses nor NCurses, this will take care to install the devel/ncurses package. @@ -106,13 +106,13 @@ for a system-provided Motif installation or adds a dependency on x11/lesstif or - x11/openmotif; + x11/openmotif. ossaudio.buildlink3.mk defines several variables that may be used by packages that use the - Open Sound System (OSS) API; + Open Sound System (OSS) API. @@ -125,7 +125,7 @@ pthread.buildlink3.mk uses the value of PTHREAD_OPTS and checks for native pthreads or adds a dependency on devel/pth as needed; + role="pkg">devel/pth as needed. @@ -234,7 +234,7 @@ BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//} BUILDLINK_PKGSRCDIR.pkg is the location of the pkg - pkgsrc directory; + pkgsrc directory. @@ -359,7 +359,7 @@ BUILDLINK_DEPTH:= ${BUILDLINK_DEPTH:S/+$//} if the sonames (major number of the library version) - of any installed shared libraries change; + of any installed shared libraries change. diff --git a/doc/guide/files/components.xml b/doc/guide/files/components.xml index e12b833067b..829bdc45fa0 100644 --- a/doc/guide/files/components.xml +++ b/doc/guide/files/components.xml @@ -1,4 +1,4 @@ - + Package components - files, directories and contents @@ -100,9 +100,9 @@ converters games mbone print x11 If the package has multiple DISTFILES or multiple PATCHFILES from different - sites, set SITES_foo to a list of URI's + sites, set SITES_foo to a list of URIs where file foo may be - found. foo includes the suffix, e.g. + found. foo includes the suffix, e.g.: DISTFILES= ${DISTNAME}${EXTRACT_SUFX} DISTFILES+= foo-file.tar.gz SITES_foo-file.tar.gz=http://www.somewhere.com/somehow/ \ @@ -131,7 +131,7 @@ SITES_foo-file.tar.gz=http://www.somewhere.com/somehow/ \ The second section contains information about separately downloaded patches, if any. - PATCHFILES + PATCHFILES: Name(s) of additional files that contain distribution patches. There is no default. pkgsrc will look for them at PATCH_SITES. @@ -187,7 +187,7 @@ SITES_foo-file.tar.gz=http://www.somewhere.com/somehow/ \ - Add MANCOMPRESSED if manpages are installed in + Add MANCOMPRESSED if man pages are installed in compressed form by the package; see comment in bsd.pkg.mk. @@ -258,7 +258,7 @@ SITES_foo-file.tar.gz=http://www.somewhere.com/somehow/ \ problems. (To force patches to apply with fuzz you can set PATCH_FUZZ_FACTOR=-F2). Furthermore, do not put changes for more than one file into a single - patch-file, as this will make future modifications more difficult. + patch file, as this will make future modifications more difficult. Similar, a file should be patched at most once, not several times by several different patches. If a file needs several patches, they should @@ -300,7 +300,7 @@ SITES_foo-file.tar.gz=http://www.somewhere.com/somehow/ \ category/package structure as pkgsrc, and patches are expected to be stored inside these dirs (also known as $LOCALPATCHES/$PKGPATH). For - example if you want to keep a private patch for + example, if you want to keep a private patch for pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All files in the named directory are expected to be patch files, and @@ -392,7 +392,7 @@ SITES_foo-file.tar.gz=http://www.somewhere.com/somehow/ \ <filename>work*</filename> - When you type make the distribution files are + When you type make, the distribution files are unpacked into the directory denoted by WRKDIR. It can be removed by running make clean. Besides the sources, this diff --git a/doc/guide/files/configuring.xml b/doc/guide/files/configuring.xml index 0db70dfc73e..482bc309025 100644 --- a/doc/guide/files/configuring.xml +++ b/doc/guide/files/configuring.xml @@ -1,4 +1,4 @@ - + Configuring pkgsrc @@ -6,9 +6,9 @@ General configuration - In this section you can find some variables that apply all - pkgsrc packages. The preferred method of setting them is by - setting them in /etc/mk.conf. + In this section, you can find some variables that apply to all + pkgsrc packages. The preferred method of setting these variables + is by setting them in /etc/mk.conf. LOCALBASE: Where packages will be installed. The default is diff --git a/doc/guide/files/editing.xml b/doc/guide/files/editing.xml index ddf471077d4..28214296797 100644 --- a/doc/guide/files/editing.xml +++ b/doc/guide/files/editing.xml @@ -1,4 +1,4 @@ - + Editing guidelines for the pkgsrc guide @@ -69,8 +69,8 @@ Make sure you have the packages needed to re-generate the pkgsrc guide (and other XML-based NetBSD documentation) installed. These are netbsd-doc for creating the - ASCII- and HTML-version, and - netbsd-doc-printfor the PostScript- and PDF + ASCII and HTML version, and + netbsd-doc-print for the PostScript and PDF version. You will need both packages installed, to make sure documentation is consistent across all formats. The packages can be found in diff --git a/doc/guide/files/examples.xml b/doc/guide/files/examples.xml index cbcdc216897..24a07747252 100644 --- a/doc/guide/files/examples.xml +++ b/doc/guide/files/examples.xml @@ -1,4 +1,4 @@ - + A simple example package: bison @@ -63,7 +63,7 @@ share/bison.hairy &uprompt; pkglint looks fine. - Depending on the supplied command line arguments (see pkglint(1)) + Depending on the supplied command line arguments (see pkglint(1)), more verbose checks will be performed. Use e.g. pkglint -v for a very verbose check. diff --git a/doc/guide/files/faq.xml b/doc/guide/files/faq.xml index f83ece27410..81bb741dd2d 100644 --- a/doc/guide/files/faq.xml +++ b/doc/guide/files/faq.xml @@ -1,4 +1,4 @@ - + Frequently Asked Questions @@ -206,16 +206,11 @@ etc: -Utilities for people maintaining pkgsrc (or more obscure pkg +Utilities for people maintaining pkgsrc (or: more obscure pkg utilities) - - pkgtools/pkgconflict: Find - packages that conflict but aren't marked as such. - - pkgtools/pkg_comp: Build packages in a chrooted area. @@ -262,7 +257,7 @@ that allow finer tuning of the tree layout. How to resume transfers when fetching distfiles? -By default resuming transfers in pkgsrc is disabled, but you can +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 @@ -318,7 +313,7 @@ you will have to add the following line into If you are sitting behind a firewall which does not allow direct connections to Internet hosts (i.e. non-NAT), you may specify the relevant proxy hosts. This is done using an environment variable in the -form of a URL e.g. in Amdahl, the machine +form of a URL, e.g. in Amdahl, the machine orpheus.amdahl.com is one of the firewalls, and it uses port 80 as the proxy port number. So the proxy environment variables are: @@ -371,7 +366,7 @@ url="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/">ftp.NetBSD.org but downloading the entire directory may not be appropriate. The answer here is to do a make fetch-list in -/usr/pkgsrc or one of it's subdirectories, carry the +/usr/pkgsrc or one of its subdirectories, carry the resulting list to your machine at work/school and use it there. If you don't have a NetBSD-compatible &man.ftp.1; (like lukemftp) at work, don't forget to set FETCH_CMD to something that fetches a @@ -417,7 +412,7 @@ package, you get the error from make that it doesn't know how to make /usr/share/tmac/tmac.andoc? This indicates 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 manpages. +that to format man pages. In the case of the pkgtools/pkg_install package, you @@ -432,7 +427,7 @@ environment or in /etc/mk.conf. What does <quote>Could not find bsd.own.mk</quote> mean? You didn't install the compiler set, comp.tgz, -when you installed your NetBSD machine. Please get it and install it, by +when you installed your NetBSD machine. Please get and install it, by extracting it in /: # cd / @@ -487,7 +482,7 @@ setting the PKG_SYSCONFDIR.${PKG_SYSCONFVAR} variable. package you would like to modify, that is, the contents of PKGBASE. -Note that, after changing these settings, you must rebuild and +Note that after changing these settings, you must rebuild and reinstall any affected packages. diff --git a/doc/guide/files/fixes.xml b/doc/guide/files/fixes.xml index 11bb80acb7f..c23ca6868f7 100644 --- a/doc/guide/files/fixes.xml +++ b/doc/guide/files/fixes.xml @@ -1,4 +1,4 @@ - + Notes on fixes for packages @@ -12,14 +12,14 @@ The problem with package-defined variables that can be overridden via MAKECONF or /etc/mk.conf is that &man.make.1; expands a - variable as it is used, but evaluates preprocessor like + variable as it is used, but evaluates preprocessor-like statements (.if, .ifdef and .ifndef) as they are read. So, to use any variable (which may be set in /etc/mk.conf) in one of the .if* statements, the file /etc/mk.conf must be included before that .if* statement. - Rather than have a number of ad-hoc ways of including + Rather than having a number of ad-hoc ways of including /etc/mk.conf, should it exist, or MAKECONF, should it exist, include the pkgsrc/mk/bsd.prefs.mk file in the package @@ -33,7 +33,7 @@ .endif If you wish to set the CFLAGS variable - in /etc/mk.conf please make sure to use: + in /etc/mk.conf, please make sure to use: CFLAGS+= -your -flags @@ -299,12 +299,12 @@ pkgsrc tree. In this case you can set CONFLICTS to a - space separated list of packages (including version string) your + space-separated list of packages (including version string) your package conflicts with. - For example x11/Xaw3d + For example, x11/Xaw3d and x11/Xaw-Xpm - install provide the same shared library, thus you set in + install the same shared library, thus you set in pkgsrc/x11/Xaw3d/Makefile: CONFLICTS= Xaw-Xpm-[0-9]* @@ -391,7 +391,7 @@ are gcc internal errors or never finishing compiling a file. - Typically a workaround involves testing the + Typically, a workaround involves testing the MACHINE_ARCH and compiler version, disabling optimisation for that file/MACHINE_ARCH/compiler combination, and @@ -418,7 +418,7 @@ foo-17.42nb9. When a new release of the package is released, the - PKGREVISION should be removed. e.g. on a new + PKGREVISION should be removed, e.g. on a new minor release of the above package, things should be like: @@ -528,7 +528,7 @@ ${INSTALL_DATA_DIR} ${PREFIX}/dir2 devel/libtool pkg can help here, as it just knows how to build both static and dynamic libraries from a set of source files, - thus being platform independent. + thus being platform-independent. Here's how to use libtool in a pkg in seven simple steps: @@ -677,7 +677,7 @@ dynamic linker chooses the library with the greater REVISION number. SHLIBTOOL_OVERRIDE instead. - If your package makes use of the platform independent library + If your package makes use of the platform-independent library for loading dynamic shared objects, that comes with libtool (libltdl), you should include devel/libltdl/buildlink3.mk. @@ -788,7 +788,7 @@ pre-configure: Please use the __NetBSD__ definition sparingly - it should only apply to features of &os; that are not present in other - 4.4-lite derived BSDs. + 4.4-lite-derived BSDs. @@ -822,7 +822,7 @@ pre-configure: The INTERACTIVE_STAGE definition is provided to notify the pkgsrc mechanism of an interactive stage which will be needed, and - this should be set in the package's Makefile. e.g. + this should be set in the package's Makefile, e.g.: INTERACTIVE_STAGE= build @@ -1051,7 +1051,7 @@ pre-configure: INSTALL script, and it must use the appropriate makeinfo command. - To achieve this goal the pkgsrc infrastructure creates + To achieve this goal, the pkgsrc infrastructure creates overriding scripts for the install-info and makeinfo commands in a directory listed early in PATH. @@ -1178,7 +1178,7 @@ pre-configure: Packages installing GTK2 modules - If a package installs gtk2 immodules or loaders, you need to + If a package installs GTK2 immodules or loaders, you need to take some extra steps to get them registered in the GTK2 database properly: @@ -1201,7 +1201,7 @@ pre-configure: - Patch the package to not touch any of the gtk2 databases directly. + Patch the package to not touch any of the GTK2 databases directly. These are: @@ -1295,7 +1295,7 @@ pre-configure: except for files saved under share/mime/packages. The former are handled automatically by - the update-mime-database program, but the later are + the update-mime-database program, but the latter are package-dependent and must be removed by the package that installed them in the first place. diff --git a/doc/guide/files/introduction.xml b/doc/guide/files/introduction.xml index cfc25e1cc14..bd41cbc8744 100644 --- a/doc/guide/files/introduction.xml +++ b/doc/guide/files/introduction.xml @@ -1,4 +1,4 @@ - + Introduction @@ -6,7 +6,7 @@ Introduction - There is a lot of software freely available for Unix based + There is a lot of software freely available for Unix-based systems, which usually runs on NetBSD and other Unix-flavoured systems, too, sometimes with some modifications. The NetBSD Packages Collection (pkgsrc) incorporates any such changes @@ -221,7 +221,7 @@ The piece of software to be installed which will be constructed from - all the files in the Distfile by the actions defined in the + all the files in the distfile by the actions defined in the corresponding package. diff --git a/doc/guide/files/makefile.xml b/doc/guide/files/makefile.xml index d0922385090..00183417808 100644 --- a/doc/guide/files/makefile.xml +++ b/doc/guide/files/makefile.xml @@ -1,4 +1,4 @@ - + + @@ -161,7 +161,7 @@ including bsd.options.mk. If none of PKG_SUPPORTED_OPTIONS, PKG_OPTIONS_OPTIONAL_GROUPS, and PKG_OPTIONS_REQUIRED_GROUPS are defined (as can -happen with platform specific options if none of them is supported on +happen with platform-specific options if none of them is supported on the current platform), PKG_OPTIONS is set to the empty list and the package is otherwise treated as not using the options framework. diff --git a/doc/guide/files/pkginstall.xml b/doc/guide/files/pkginstall.xml index 23942fcde41..266af15584c 100644 --- a/doc/guide/files/pkginstall.xml +++ b/doc/guide/files/pkginstall.xml @@ -1,4 +1,4 @@ - + The pkginstall framework @@ -33,7 +33,7 @@ The following sections inspect each of the above points in detail. -Note that, in order to use any of the described functionalities, you must +Note that in order to use any of the described functionalities, you must add the following to your package's Makefile: USE_PKGINSTALL=YES @@ -64,11 +64,11 @@ to install files outside this location; e.g., under The only way to achieve this is to create such files during installation time by using the installation scripts. These scripts can run arbitrary commands, so they have the potential to create and manage files -anywhere in the filesystem. Here is where pkginstall comes into play: it +anywhere in the file system. Here is where pkginstall comes into play: it provides generic scripts to abstract the manipulation of such files and directories based on variables set in the package's -Makefile. The rest of this section describes which -these variables are. +Makefile. The rest of this section describes these +variables. @@ -76,7 +76,7 @@ these variables are. Directory manipulation The following variables can be set to request the creation of -directories anywhere in the filesystem: +directories anywhere in the file system: @@ -196,8 +196,7 @@ set based upon the following variables: PKG_SYSCONFBASE under which the configuration files for the package being built shall be installed. The definition of this variable only makes sense in the package's - Makefile (i.e., it is not user - customizable). + Makefile (i.e., it is not user-customizable). As an example, consider the Apache package, www/apache2, which places its @@ -265,7 +264,7 @@ linkend="dirs-outside-prefix" /> what this means. known place, you need to teach each package where it shall install its files. In some cases you will have to patch the package Makefiles to achieve it. If you are lucky, though, it may be as easy as passing an -extra flag to the configuration script; this is the case of GNU Autoconf +extra flag to the configuration script; this is the case of GNU Autoconf- generated files: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR} diff --git a/doc/guide/files/platforms.xml b/doc/guide/files/platforms.xml index e58d041211c..7e9ce93c47c 100644 --- a/doc/guide/files/platforms.xml +++ b/doc/guide/files/platforms.xml @@ -1,4 +1,4 @@ - + Using pkgsrc on systems other than &os; @@ -75,7 +75,7 @@ - Platform specific notes + Platform-specific notes Here are some platform-specific notes you should be aware of. @@ -102,7 +102,7 @@ You cannot use a HFS+ file system for pkgsrc, because pkgsrc currently - requires the filesystem to be case-sensitive, and HFS+ is not. + requires the file system to be case-sensitive, and HFS+ is not. @@ -200,7 +200,7 @@ Interix - Interix is a POSIX compatible subsystem for the Windows NT kernel, + Interix is a POSIX-compatible subsystem for the Windows NT kernel, providing a Unix-like environment with a tighter kernel integration than available with Cygwin. It is part of the Windows Services for Unix package, available for free for any licensed copy of Windows 2000, XP @@ -254,7 +254,7 @@ Add or Remove, then uncheck Utilities->UNIX Perl. - To enable case-sensitivity for the filesystem, run REGEDIT.EXE, and + To enable case-sensitivity for the file system, run REGEDIT.EXE, and change the following registry key: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel Set the DWORD value "obcaseinsensitive" to 0; then reboot. @@ -322,7 +322,7 @@ 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 linker occasionally runs into issues when trying to - link over a network mounted filesystem. + link over a network-mounted file system. The bootstrapping process should set all the right options for programs such as imake(1), but you may want to set some options depending on your local @@ -429,7 +429,7 @@ /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 + as well. You can work around this by enclosing all the pkgsrc-specific parts of the file with: .ifdef BSD_PKG_MK @@ -516,20 +516,20 @@ You should set CC, CXX and optionally, CPP in /etc/mk.conf, - eg. + e.g.: CC= cc CXX= CC CPP= /usr/ccs/lib/cpp - You may also want to build 64-bit binaries, eg. + You may also want to build 64-bit binaries, e.g.: CFLAGS= -xtarget=ultra -xarch=v9 Whichever compiler you use, please ensure the compiler tools and your $prefix are in your PATH. This includes /usr/ccs/{bin,lib} - and eg. /usr/pkg/{bin,sbin}. + and e.g. /usr/pkg/{bin,sbin}. diff --git a/doc/guide/files/plist.xml b/doc/guide/files/plist.xml index 86ae145db12..f8aec02bfc6 100644 --- a/doc/guide/files/plist.xml +++ b/doc/guide/files/plist.xml @@ -1,4 +1,4 @@ - + PLIST issues @@ -7,7 +7,7 @@ packing list, i.e. a list of files that belong to the package (relative to the ${PREFIX} directory it's been installed in) plus some additional statements - - see the &man.pkg.create.1; manpage for a full list. + - see the &man.pkg.create.1; man page for a full list. This chapter addresses some issues that need attention when dealing with the PLIST file (or files, see below!). @@ -84,7 +84,7 @@ Some packages like emacs and perl embed information about which architecture they were built on into the - pathnames where they install their file. To handle this + pathnames where they install their files. To handle this case, PLIST will be preprocessed before actually used, and the symbol ${MACHINE_ARCH} will be @@ -92,7 +92,7 @@ same is done if the string ${MACHINE_GNU_ARCH} is embedded in PLIST somewhere - use this on packages that have GNU - autoconf created configure scripts. + autoconf-created configure scripts. Legacy note @@ -163,13 +163,13 @@ - Manpage-compression + Man page-compression - Manpages should be installed in compressed form if + Man pages should be installed in compressed form if MANZ is set (in bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the suffix .gz is - appended/removed automatically for manpages according to + appended/removed automatically for man pages according to MANZ and MANCOMPRESSED being set or not, see above for details. This modification of the PLIST file is done on a copy of it, not @@ -189,7 +189,7 @@ - Platform specific and differing PLISTs + Platform-specific and differing PLISTs Some packages decide to install a different set of files based on the operating system being used. These differences can be @@ -286,7 +286,7 @@ print-PLIST, you should get the right (commented out) lines. - Note that, even if your package is using + Note that even if your package is using $X11BASE, it must not depend on the *-x11-dirs packages. Just specify the name without that part and pkgsrc (in particular, mk/dirs.mk) will take diff --git a/doc/guide/files/using.xml b/doc/guide/files/using.xml index 4a0885a4636..3fd0195cf82 100644 --- a/doc/guide/files/using.xml +++ b/doc/guide/files/using.xml @@ -1,4 +1,4 @@ - + Using pkgsrc @@ -27,17 +27,17 @@ layout as in /usr/pkgsrc/packages). - This same directory layout applies for CDROM + This same directory layout applies for CD-ROM distributions, only that the directory may be rooted somewhere else, probably somewhere below - /cdrom. Please consult your CDROMs + /cdrom. Please consult your CD-ROMs documentation for the exact location. How to use binary packages - If you have the files on a CDROM or downloaded them to + If you have the files on a CD-ROM or downloaded them to your hard disk, you can install them with the following command (be sure to su to root first): @@ -55,9 +55,9 @@ present where you install from. To save some typing, you can set the - PKG_PATH environment variable to a semicolon - separated list of paths (including remote URLs); trailing - slashes are not allowed. + PKG_PATH environment variable to a semicolon-separated + list of paths (including remote URLs); trailing slashes are not allowed. + Additionally to the All directory there exists a vulnerable directory to @@ -66,7 +66,7 @@ use these packages, add the vulnerable directory to your PKG_PATH. However, you should run security/audit-packages regularly, - and especially after installing new packages, and verify that the + especially after installing new packages, and verify that the vulnerabilities are acceptable for your configuration. An example PKG_PATH would be: ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/All;ftp://ftp.NetBSD.org/pub/NetBSD/packages/<OSVERSION>/<ARCH>/vulnerable @@ -103,7 +103,7 @@ To build packages from source on a NetBSD system the comp and the text distribution - sets must be installed. If you want to build X11 related + sets must be installed. If you want to build X11-related packages the xbase and xcomp distribution sets are required, too. @@ -140,7 +140,7 @@ How to build and install Assuming that the distfile has been fetched (see previous section), become - root and change into the relevant directory and running + root and change into the relevant directory and run make. For example, type &cprompt; cd misc/figlet @@ -167,7 +167,7 @@ your packages tree. So, to use /usr/local, set LOCALBASE=/usr/local in your environment. Please note that you should use a directory which is - dedicated to packages and not shared with other programs (ie, do not try + dedicated to packages and not shared with other programs (i.e., do not try and use LOCALBASE=/usr). Also, you should not try to add any of your own files or directories (such as src/, obj/, or pkgsrc/) below the @@ -225,7 +225,7 @@ into BIN_INSTALL_FLAGS. See pkgsrc/mk/defaults/mk.conf for more details. - A final word of warning: If you setup a system that has a non-standard + A final word of warning: If you set up a system that has a non-standard setting for LOCALBASE, be sure to set that before any packages are installed, as you can not use several directories for the same purpose. Doing so will result in pkgsrc not being able to -- cgit v1.2.3