changes merged from 2.9.8 -- clarified license usage, new options var in PKGBUILDs, --noprogressbar pacman switch...

doc/makepkg.8.in

@@ -1,4 +1,4 @@
-.TH makepkg 8 "August 3, 2004" "@PACKAGE_VERSION@" ""
+.TH makepkg 8 "January 30, 2006" "makepkg #VERSION#" ""
 .SH NAME
 makepkg \- package build utility
 .SH SYNOPSIS
@@ -236,9 +236,26 @@ This is the release number specific to Arch Linux packages.
 This should be a brief description of the package and its functionality.
 
 .TP
-.B force
+.B options
-This is used to force the package to be upgraded by \fB--sysupgrade\fP, even
+This array allows you to override some of makepkg's default behaviour
+when building packages.  To set an option, just include the option name
+in the \fBoptions\fP array.
+.TP
+.RS
+\fIAvailable Options:\fP
+.RS
+.TP
+.B FORCE
+force the package to be upgraded by \fB--sysupgrade\fP, even
 if its an older version.
+.TP
+.B KEEPDOCS
+do not remove /usr/share/doc and /usr/share/info directories.
+.TP
+.B NOSTRIP
+do not strip debugging symbols from binaries and libraries.
+.RE
+.RE
 
 .TP
 .B url
@@ -247,8 +264,17 @@ being packaged.  This is typically the project's website.
 
 .TP
 .B license
-Sets the license type (eg, "GPL", "BSD", "NON-FREE").  (\fBNote\fP: This
+This field specifies the license(s) that apply to the package.  Commonly-used
-option is still in development and may change in the future)
+licenses are typically found in \fI/usr/share/licenses/common\fP.  If you
+see the package's license there, simply reference it in the license field
+(eg, \fBlicense="GPL"\fP).  If the package provides a license not found in
+\fI/usr/share/licenses/common\fP, then you should include the license in
+the package itself and set \fBlicense="custom"\fP or \fBlicense="custom:LicenseName"\fP.
+The license itself should be placed in a directory called
+\fI$startdir/pkg/usr/share/licenses/$pkgname\fP.
+.TP
+.RE
+If multiple licenses are applied, use the array form: \fBlicenses=('GPL' 'FDL')\fP
 
 .TP
 .B install
@@ -331,6 +357,9 @@ $ABSROOT (set in your /etc/makepkg.conf).  If it finds them it will
 run another copy of makepkg to build and install the missing dependencies.
 The child makepkg calls will be made with the \fB-b\fP and \fB-i\fP options.
 .TP
+.B "\-B, \-\-noccache"
+Do not use ccache during build.
+.TP
 .B "\-c, \-\-clean"
 Clean up leftover work files/directories after a successful build.
 .TP
@@ -342,6 +371,11 @@ Do not perform any dependency checks.  This will let you override/ignore any
 dependencies required.  There's a good chance this option will break the build
 process if all of the dependencies aren't installed.
 .TP
+.B "\-e, \-\-noextract"
+Do not extract source files.  Instead, use whatever already exists in the
+src/ directory.  This is handy if you want to go into src and manually
+patch/tweak code, then make a package out of the result.
+.TP
 .B "\-f, \-\-force"
 \fBmakepkg\fP will not build a package if a \fIpkgname-pkgver-pkgrel.pkg.tar.gz\fP
 file already exists in the build directory.  You can override this behaviour with
@@ -384,9 +418,23 @@ or run-time dependencies, it will run pacman to try and resolve them.  If succes
 pacman will download the missing packages from a package repository and
 install them for you.
 .TP
+.B "\-S, \-\-sudosync"
+Install missing dependencies using pacman and sudo. This is the same as \fB-s\fP
+except that makepkg will call pacman with sudo. This means you don't have to
+build as root to use dependency auto-resolution.
+.TP
 .B "\-w <destdir>"
 Write the resulting package file to the directory \fI<destdir>\fP instead of the
 current working directory.
+.TP
+.B "\-\-noconfirm"
+When calling pacman to resolve dependencies or conflicts, makepkg can pass
+the \fI--noconfirm\fP option to it so it does not wait for any user
+input before proceeding with operations.
+.TP
+.B "\-\-noprogressbar"
+When calling pacman, makepkg can pass the \fI--noprogressbar\fP option to it.
+This is useful if one is directing makepkg's output to a non-terminal (ie, a file).
 
 .SH CONFIGURATION
 Configuration options are stored in \fI/etc/makepkg.conf\fP.  This file is parsed

doc/pacman.8.in

@@ -1,4 +1,4 @@
-.TH pacman 8 "September 17, 2004" "pacman @PACKAGE_VERSION@" ""
+.TH pacman 8 "January 21, 2006" "pacman #VERSION#" ""
 .SH NAME
 pacman \- package manager utility
 .SH SYNOPSIS
@@ -81,8 +81,12 @@ Output more status and error messages.
 Specify an alternate configuration file.
 .TP
 .B "\-\-noconfirm"
-Bypass any and all "Are you sure?" messages.  It's not a good to do this
+Bypass any and all "Are you sure?" messages.  It's not a good idea to do this
 unless you want to run pacman from a script.
+.TP
+.B "\-\-noprogressbar"
+Do not show a progress bar when downloading files.  This can be useful for
+scripts that call pacman and capture the output.
 .SH SYNC OPTIONS
 .TP
 .B "\-c, \-\-clean"
@@ -105,18 +109,14 @@ dependencies, conflicts, etc.
 List all files in the specified repositories.  Multiple repositories can
 be specified on the command line.
 .TP
-.B "\-m, \-\-foreign"
-List all packages that were not found in the sync database(s). Typically these
-are packages that were downloaded manually and installed with --add.
-.TP
 .B "\-p, \-\-print-uris"
-Print out URIs for each specified package and its dependencies.  These
+Print out URIs for each package that will be installed, including any
-can be piped to a file and downloaded at a later time, using a program
+dependencies that have yet to be installed.  These can be piped to a
-like wget.
+file and downloaded at a later time, using a program like wget.
 .TP
-.B "\-s, \-\-search <string>"
+.B "\-s, \-\-search <regexp>"
 This will search each package in the package list for names or descriptions
-that contains <string>.
+that matches <regexp>.
 .TP
 .B "\-u, \-\-sysupgrade"
 Upgrades all packages that are out of date.  pacman will examine every
@@ -158,7 +158,7 @@ removed.
 For each target specified, remove it and all its dependencies, provided
 that (A) they are not required by other packages; and (B) they were not
 explicitly installed by the user.
-This option is analogous to a backwards --sync operation.
+This option is analagous to a backwards --sync operation.
 .SH QUERY OPTIONS
 .TP
 .B "\-e, \-\-orphans"
@@ -178,6 +178,10 @@ option then the .PKGINFO file will be printed.
 List all files owned by <package>.  Multiple packages can be specified on
 the command line.
 .TP
+.B "\-m, \-\-foreign"
+List all packages that were not found in the sync database(s). Typically these
+are packages that were downloaded manually and installed with --add.
+.TP
 .B "\-o, \-\-owns <file>"
 Search for the package that owns <file>.
 .TP
@@ -186,9 +190,9 @@ Tells pacman that the package supplied on the command line is a
 file, not an entry in the database.  Pacman will decompress the
 file and query it.  This is useful with \fB--info\fP and \fB--list\fP.
 .TP
-.B "\-s, \-\-search <string>"
+.B "\-s, \-\-search <regexp>"
 This will search each locally-installed package for names or descriptions
-that contains <string>.
+that matches <regexp>.
 .SH HANDLING CONFIG FILES
 pacman uses the same logic as rpm to determine action against files
 that are designated to be backed up.  During an upgrade, it uses 3
@@ -214,9 +218,9 @@ original=\fBX\fP, current=\fBY\fP, new=\fBY\fP
 The new one is identical to the current one.  Win win.  Install the new file.
 .TP
 original=\fBX\fP, current=\fBY\fP, new=\fBZ\fP
-All three files are different.  So we install the new file, but back up the
+All three files are different, so we install the new file with a .pacnew
-old one to a .pacsave extension.  This way the user can move the old configuration
+extension and warn the user, so she can manually move the file into place
-file back into place if he wishes.
+after making any necessary customizations.
 .SH CONFIGURATION
 pacman will attempt to read \fI/etc/pacman.conf\fP each time it is invoked.  This
 configuration file is divided into sections or \fIrepositories\fP.  Each section
@@ -244,10 +248,6 @@ Server = file:///home/pkgs
 Overrides the default location of the toplevel database directory.  The default is
 \fIvar/lib/pacman\fP.
 .TP
-.B "CacheDir = path/to/cache/dir"
-Overrides the default location of the package cache directory.  The default is
-\fIvar/cache/pacman\fP.
-.TP
 .B "HoldPkg = <package> [package] ..."
 If a user tries to \fB--remove\fP a package that's listed in HoldPkg, pacman
 will ask for confirmation before proceeding.
@@ -280,6 +280,13 @@ Disables passive ftp connections when downloading packages. (aka Active Mode)
 All files listed with a \fBNoUpgrade\fP directive will never be touched during a package
 install/upgrade.  \fINote:\fP do not include the leading slash when specifying files.
 .TP
+.B "NoExtract = <file> [file] ..."
+All files listed with a \fBNoExtract\fP directive will never be extracted from
+a package into the filesystem.  This can be useful when you don't want part of
+a package to be installed.  For example, if your httpd root uses an index.php,
+then you would not want the index.html file to be extracted from the apache
+package.
+.TP
 .B "UseSyslog"
 Log action messages through syslog().  This will insert pacman log entries into your
 /var/log/messages or equivalent.