summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan McGee <dan@archlinux.org>2007-02-09 15:37:20 +0000
committerDan McGee <dan@archlinux.org>2007-02-09 15:37:20 +0000
commit4e0b649c3af6deeb6fcf765deaa3dc9b2f68452d (patch)
tree10c38ac107cadaaf73ffabf8e6ca9a150cb67d5d
parent41a8621ba0c8eda65a10e111a979d2d751bf4adc (diff)
downloadpacman-4e0b649c3af6deeb6fcf765deaa3dc9b2f68452d.tar.xz
Man pages, man pages, man pages. Just a few more additions and clarifications,
ensured force option was still documented in PKGBUILD.5.
-rw-r--r--TODO.dan7
-rw-r--r--doc/PKGBUILD.534
-rw-r--r--doc/makepkg.conf.516
3 files changed, 43 insertions, 14 deletions
diff --git a/TODO.dan b/TODO.dan
index eecb6ad1..a56917df 100644
--- a/TODO.dan
+++ b/TODO.dan
@@ -93,3 +93,10 @@ Refine makepkg error codes. Each kind of failure could have its own code:
--failed integ checks
--failed build
--etc.
+
+Add utility function to either frontend or backend to convert sizes: e.g. bytes
+to KB, MB, GB.
+
+Revamp the downloadprog function a bit. Seems kind of messy.
+
+Add localized pkgdesc variables to makepkg.
diff --git a/doc/PKGBUILD.5 b/doc/PKGBUILD.5
index 8e07e4e1..00ee8f7b 100644
--- a/doc/PKGBUILD.5
+++ b/doc/PKGBUILD.5
@@ -144,12 +144,34 @@ though the package has moved.
.TP
.B options \fI(array)\fP
-This array allows you to override some of \fBmakepkg\fP's default behavior
-when building packages. To set an option, just include the option name
-in the \fBoptions\fP array.
-See
-.BR makepkg (8)
-for details on the options array.
+This array allows you to override some of \fBmakepkg\fP's default behavior when
+building packages. To set an option, just include the option name in the
+\fBoptions\fP array. To reverse the default behavior, place an "!" at the front
+of the option. Only specify the options you specifically want to override, the
+rest will be taken from \fBmakepkg.conf\fP. NOTE: 'force' is a special option
+only used in \fB\*(PB\fPs, do not use it unless you know what you are doing.
+.RS
+.TP
+.B strip
+Strip symbols from binaries and libraries. If you frequently use a debugger on
+programs or libraries, it may be helpful to disable this option.
+.TP
+.B docs
+Save doc and info directories. If you wish to delete doc and info directories,
+specify "!docs" in the array.
+.TP
+.B libtool
+Leave libtool (.la) files in packages. Specify "!libtool" to remove them.
+.TP
+.B emptydirs
+Leave empty directories in packages.
+.TP
+.B force
+Force the package to be upgraded by a \fBpacman\fP system upgrade operation,
+even if the version number would normally not trigger such an upgrade. This is
+useful when the version numbering scheme of a package changes (or is
+alphanumeric).
+.RE
.SH INSTALL/UPGRADE/REMOVE SCRIPTING
\fBPacman\fP has the ability to store and execute a package-specific script
diff --git a/doc/makepkg.conf.5 b/doc/makepkg.conf.5
index f5714c21..3c6a2980 100644
--- a/doc/makepkg.conf.5
+++ b/doc/makepkg.conf.5
@@ -55,17 +55,17 @@ enable or disable an option simply remove or place an "!" at the front of the
option. Each works as follows:
.RS
.TP
-fakeroot
+.B fakeroot
Allow building packages as a non-root user. This is \fIhighly\fP recommended.
.TP
-distcc
+.B distcc
Use the distributed C/C++/ObjC compiler to spread compilation among multiple
machines. If this is enabled, \fBDISTCC_HOSTS\fP must be specified as well.
.TP
-color
+.B color
Colorize output messages, making output easier to read.
.TP
-ccache
+.B ccache
Use ccache to cache compilation by default. This allows for faster compiles if
you are continuously recompiling the same packages. It can be disabled for
individual packages by passing the \fB-B\fP or \fB--noccache\fP flag to
@@ -85,18 +85,18 @@ disable an option simply remove or place an "!" at the front of the option.
Each works as follows:
.RS
.TP
-strip
+.B strip
Strip symbols from binaries and libraries. If you frequently use a debugger on
programs or libraries, it may be helpful to disable this option.
.TP
-docs
+.B docs
Save doc and info directories. If you wish to delete doc and info directories,
specify "!docs" in the array.
.TP
-libtool
+.B libtool
Leave libtool (.la) files in packages. Specify "!libtool" to remove them.
.TP
-emptydirs
+.B emptydirs
Leave empty directories in packages.
.RE
.TP