diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/PKGBUILD.5.txt | 26 | ||||
| -rw-r--r-- | doc/makepkg.8.txt | 13 | ||||
| -rw-r--r-- | doc/pacman.8.txt | 9 | ||||
| -rw-r--r-- | doc/pacman.conf.5.txt | 17 |
5 files changed, 50 insertions, 19 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index de2c5eec..fcbcab88 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -85,12 +85,12 @@ ASCIIDOC_OPTS = \ -a pacman_version="$(REAL_PACKAGE_VERSION)" \ -a pacman_date="`date +%Y-%m-%d`" \ -a sysconfdir=$(sysconfdir) + A2X_OPTS = \ --no-xmllint \ -d manpage \ -f manpage \ - --xsltproc-opts='-param man.endnotes.list.enabled 0' \ - --xsltproc-opts='-param man.endnotes.are.numbered 0' + --xsltproc-opts='-param man.endnotes.list.enabled 0 -param man.endnotes.are.numbered 0' # These rules are due to the includes and files of the asciidoc text $(ASCIIDOC_MANS): asciidoc.conf footer.txt diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt index 83cebcdb..2d6589b2 100644 --- a/doc/PKGBUILD.5.txt +++ b/doc/PKGBUILD.5.txt @@ -79,6 +79,12 @@ similar to `$_basekernver`. be copied into the package by makepkg. It does not need to be included in the source array (e.g. `install=pkgname.install`). +*changelog*:: + Specifies a changelog file that is to be included in the package. + This file should reside in the same directory as the PKGBUILD, and will + be copied into the package by makepkg. It does not need to be included + in the source array (e.g. `changelog=$pkgname.changelog`). + *source (array)*:: An array of source files required to build the package. Source files must either reside in the same directory as the PKGBUILD file, or be a @@ -145,7 +151,7 @@ name. The syntax is: `source=('filename::url')`. base functionality, but may be necessary to make full use of the contents of this package. optdepends are currently for informational purposes only and are not utilized by pacman during dependency resolution. The format - should be similar to the following: + for specifying optdepends is: optdepends=('fakeroot: for makepkg usage as normal user') @@ -227,10 +233,10 @@ name. The syntax is: `source=('filename::url')`. build() Function ---------------- -In addition to the above directives, the build() bash function comprises the -remainder of the PKGBUILD. This is directly sourced and executed by makepkg, so -anything that bash or the system has available is available for use here. Be -sure any exotic commands used are covered by `makedepends`. +In addition to the above directives, the optional build() bash function usually +comprises the remainder of the PKGBUILD. This is directly sourced and executed by +makepkg, so anything that bash or the system has available is available for use +here. Be sure any exotic commands used are covered by `makedepends`. All of the above variables such as `pkgname` and `pkgver` are available for use in the build function. In addition, makepkg defines three variables for your @@ -257,8 +263,8 @@ 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. +usage will be limited to running the packaging stage. An existing build() function +will be run as the user calling makepkg. Package Splitting ----------------- @@ -269,9 +275,9 @@ name of the split package. All options and directives for the split packages default to the global values given within the PKGBUILD. However, some of these can be overridden within each split -package's packaging function. The following variables can be overridden: `pkgdesc`, -`license`, `groups`, `depends`, `optdepends`, `provides`, `conflicts`, `replaces`, -`backup`, `options` and `install`. +package's packaging function. The following variables can be overridden: `pkgver`, +`pkgrel`, `pkgdesc`, `arch`, `license`, `groups`, `depends`, `optdepends`, +`provides`, `conflicts`, `replaces`, `backup`, `options`, `install` and `changelog`. An optional global directive is available when building a split package: diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt index 198aa954..7e89fa27 100644 --- a/doc/makepkg.8.txt +++ b/doc/makepkg.8.txt @@ -149,6 +149,10 @@ Options remote builder, or a tarball upload. Because integrity checks are verified, all source files of the package need to be present or downloadable. +*\--pkg <`list`>*:: + Only build listed packages from a split package. The use of quotes is + necessary when specifying multiple packages. e.g. `--pkg "pkg1 pkg3"` + *\--noconfirm*:: (Passed to pacman) Prevent pacman from waiting for user input before proceeding with operations. @@ -166,6 +170,15 @@ separate utility 'versionpkg'. See linkman:PKGBUILD[5] for details on how to set up a development PKGBUILD. +Environment Variables +--------------------- +*PACMAN*:: + The command that will be used to check for missing dependencies and to + install and remove packages. Pacman's -U, -T, -S and -Rns operations + must be supported by this command. If the variable is not set or + empty, makepkg will fall back to `pacman'. + + Configuration ------------- See linkman:makepkg.conf[5] for more details on configuring makepkg using the diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt index b288a592..7f92ec71 100644 --- a/doc/pacman.8.txt +++ b/doc/pacman.8.txt @@ -82,7 +82,8 @@ to determine which packages need upgrading. This behavior operates as follows: "bash>=3.2"`. *-U, \--upgrade*:: - Upgrade or add package(s) to the system. Either a URL or file path can be + Upgrade or add package(s) to the system and install the required + dependencies from sync repos. Either a URL or file path can be specified. This is a ``remove-then-add'' process. See <<HCF,Handling Config Files>> for an explanation on how pacman takes care of config files. @@ -166,6 +167,8 @@ Options If an install scriptlet exists, do not execute it. Do not use this unless you know what you are doing. +*\--arch* <'arch'>:: + Specify an alternate architecture. Query Options[[QO]] ------------------- @@ -330,7 +333,9 @@ linkman:pacman.conf[5]. necessary. Pass this option twice to enable package downgrade; in this case pacman will select sync packages whose version does not match with the local version. This can be useful when the user switches from a testing - repo to a stable one. + repo to a stable one. Additional targets can also be specified manually, so + that '-Su foo' will do a system upgrade and install/upgrade the foo package in + the same operation. *-w, \--downloadonly*:: Retrieve all packages from the server, but do not install/upgrade diff --git a/doc/pacman.conf.5.txt b/doc/pacman.conf.5.txt index 3e361102..89c22a12 100644 --- a/doc/pacman.conf.5.txt +++ b/doc/pacman.conf.5.txt @@ -100,6 +100,14 @@ Options Include another config file. This file can include repositories or general configuration options. +*Architecture =* auto | i686 | x86_64 | ...:: + If set, pacman will only allow installation of packages of the given + architecture (e.g. 'i686', 'x86_64', etc). The special value 'auto' will + use the system architecture, provided by in ``uname -m''. If unset, no + architecture checks are made. *NOTE*: packages with the special + architecture 'any' can always be installed, as they are meant to be + architecture independent. + *XferCommand =* /path/to/command %u:: If set, an external program will be used to download all remote files. All instances of `%u` will be replaced with the download URL. If present, @@ -111,9 +119,6 @@ Options http/ftp support, or need the more advanced proxy support that comes with utilities like wget. -*NoPassiveFtp*:: - Disables passive ftp connections when downloading packages. (aka Active Mode) - *NoUpgrade =* file ...:: All files listed with a `NoUpgrade` directive will never be touched during a package install/upgrade, and the new files will be installed with a @@ -179,10 +184,12 @@ Include = /etc/pacman.d/mirrorlist During parsing, pacman will define the `$repo` variable to the name of the current section. This is often utilized in files specified using the 'Include' -directive so all repositories can use the same mirrorfile. +directive so all repositories can use the same mirrorfile. pacman also defines +the `$arch` variable to the value of `Architecture`, so the same mirrorfile can +even be used for different architectures. -------- -Server = ftp://ftp.archlinux.org/$repo/os/arch +Server = ftp://ftp.archlinux.org/$repo/os/$arch -------- The order of repositories in the configuration files matters; repositories |