summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/PKGBUILD.5.txt14
-rw-r--r--doc/makepkg.8.txt3
-rw-r--r--doc/makepkg.conf.5.txt42
3 files changed, 44 insertions, 15 deletions
diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt
index c1ad4df8..f8ed7f26 100644
--- a/doc/PKGBUILD.5.txt
+++ b/doc/PKGBUILD.5.txt
@@ -187,8 +187,8 @@ name. The syntax is: `$$source=('filename::url')$$`
disable this option.
*docs*;;
- Save doc and info directories. If you wish to delete doc and
- info directories, specify `!docs` in the array.
+ Save doc directories. If you wish to delete doc directories,
+ specify `!docs` in the array.
*libtool*;;
Leave libtool (.la) files in packages. Specify `!libtool` to
@@ -198,7 +198,7 @@ name. The syntax is: `$$source=('filename::url')$$`
Leave empty directories in packages.
*zipman*;;
- Compress man pages with gzip.
+ Compress man and info pages with gzip.
*ccache*;;
Allow the use of ccache during build. More useful in its negative
@@ -256,6 +256,14 @@ If you create any variables of your own in the build function, it is
recommended to use the bash `local` keyword to scope the variable to inside
the build function.
+package() Function
+------------------
+An optional package() function can be specified in addition to the build() function.
+This function is run immediately after the build() function. When specified in
+combination with the fakeroot BUILDENV option in linkman:makepkg.conf[5], fakeroot
+usage will be limited to running the packaging stage. The build() function will be
+run as the user calling makepkg.
+
Install/Upgrade/Remove Scripting
--------------------------------
Pacman has the ability to store and execute a package-specific script when it
diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt
index 74285aaf..4bb37808 100644
--- a/doc/makepkg.8.txt
+++ b/doc/makepkg.8.txt
@@ -52,6 +52,9 @@ Options
Removes all cached source files from the directory specified in `SRCDEST`
in linkman:makepkg.conf[5].
+*--config* <`/path/to/config`>::
+ Use an alternate config file instead of the `/etc/makepkg.conf` default;
+
*-d, \--nodeps*::
Do not perform any dependency checks. This will let you override and
ignore any dependencies required. There is a good chance this option
diff --git a/doc/makepkg.conf.5.txt b/doc/makepkg.conf.5.txt
index 9fd52e64..704dccc4 100644
--- a/doc/makepkg.conf.5.txt
+++ b/doc/makepkg.conf.5.txt
@@ -61,11 +61,16 @@ Options
**CXXFLAGS=**"cxxflags"::
Flags used for the C++ compiler; see CFLAGS for more info.
+**LDFLAGS=**"ldflags"::
+ Flags used for the linker. Several options may be specified with common
+ usage resembling ``-Wl,--hash-style=gnu''. Read ld(1) for more details on
+ available linker flags.
+
**MAKEFLAGS=**"makeflags"::
This is often used to set the number of jobs used, for example, `-j2`.
Other flags that make accepts can also be passed.
-**BUILDENV=(**fakeroot !distcc color !ccache !xdelta**)**::
+**BUILDENV=(**fakeroot !distcc color !ccache**)**::
This array contains options that affect the build environment, the defaults
are shown here. All options should always be left in the array; to enable
or disable an option simply remove or place an ``!'' at the front of the
@@ -88,17 +93,12 @@ Options
be disabled for individual packages by placing `!ccache` in the
PKGBUILD options array.
- *xdelta*;;
- Generate an xdelta binary patch from previous to current package. The
- previous package must be available in the makepkg cache directory for
- this to occur.
-
**DISTCC_HOSTS=**"host1 ..."::
If using DistCC, this is used to specify a space-delimited list of hosts
running in the DistCC cluster. In addition, you will want to modify your
`MAKEFLAGS`.
-**OPTIONS=(**strip docs libtool emptydirs zipman**)**::
+**OPTIONS=(**strip !docs libtool emptydirs zipman**)**::
This array contains options that affect the default packaging. They are
equivalent to options that can be placed in the PKGBUILD; the defaults are
shown here. All options should always be left in the array; to enable or
@@ -111,8 +111,9 @@ Options
option.
*docs*;;
- Save doc and info directories. If you wish to delete doc and info
- directories, specify `!docs` in the array.
+ Save doc directories. If you wish to delete doc directories, specify
+ `!docs` in the array. The directories affected are specified by the
+ `DOC_DIRS` variable.
*libtool*;;
Leave libtool (.la) files in packages. Specify `!libtool` to remove
@@ -122,14 +123,26 @@ Options
Leave empty directories in packages.
*zipman*;;
- Compress man pages with gzip.
+ Compress manual (man and info) pages with gzip. The directories
+ affected are specified by the `MAN_DIRS` variable.
+
+ *purge*;;
+ Remove files specified by the `PURGE_TARGETS` variable from the
+ package.
**INTEGRITY_CHECK=(**check1 ...**)**::
File integrity checks to use. Multiple checks may be specified; this
affects both generation and checking. The current valid options are:
`md5`, `sha1`, `sha256`, `sha384`, and `sha512`.
-**DOC_DIRS=(**usr/{,share/}{info,doc} ...**)**::
+**MAN_DIRS=(**{usr{,/local}{,/share},opt/*}/{man,info} ...**)**::
+ If `zipman` is specified in the OPTIONS array, this variable will
+ instruct makepkg where to look to compress manual (man and info)
+ pages. If you build packages that are located in opt/, you may need
+ to add the directory to this array. *NOTE:* Do not add the leading
+ slash to the directory name.
+
+**DOC_DIRS=(**usr/{,share/}{doc,gtk-doc} ...**)**::
If `!docs` is specified in the OPTIONS array, this variable will
instruct makepkg where to look to remove docs. If you build packages
that are located in opt/, you may need to add the directory to this
@@ -142,6 +155,11 @@ Options
to this array. *NOTE:* Do not add the leading slash to the directory
name.
+**PURGE_TARGETS=(**usr/{,share}/info/dir .podlist *.pod...**)**::
+ If `purge` is specified in the OPTIONS array, this variable will
+ instruct makepkg which files to remove from the package. This is
+ useful for index files that are added by multiple packages.
+
**PKGDEST=**"/path/to/folder"::
If this value is not set, packages will by default be placed in the
current directory (location of the linkman:PKGBUILD[5]). Many people
@@ -157,7 +175,7 @@ Options
This value is used when querying a package to see who was the builder.
It is recommended you change this to your name and email address.
-*BUILDSCRIPT*, *PKGEXT*, *SRCEXT*, *DB_COMPRESSION*, *DB_CHECKSUMS*::
+*PKGEXT*, *SRCEXT*::
Do not touch these unless you know what you are doing.