It was a bit unclear that both pkgver and pkgrel were included in the passed version strings; clarify this fact in the manpage. Also include epoch in the mix now that it exists.
Also make two other minor consistency touchups to code-print variables in text. Signed-off-by: Dan McGee <[email protected]> --- Round two, including epoch this time. doc/PKGBUILD.5.txt | 36 +++++++++++++++++++++--------------- 1 files changed, 21 insertions(+), 15 deletions(-) diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt index c0fa594..c400d03 100644 --- a/doc/PKGBUILD.5.txt +++ b/doc/PKGBUILD.5.txt @@ -99,7 +99,7 @@ similar to `$_basekernver`. 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 fully-qualified URL that makepkg will use to download the file. In order - to make the PKGBUILD as useful as possible, use the $pkgname and $pkgver + to make the PKGBUILD as useful as possible, use the `$pkgname` and `$pkgver` variables if possible when specifying the download location. Any files that are compressed will automatically be extracted, unless found in the noextract array listed below. @@ -255,7 +255,7 @@ use here. The function is run in `bash -e` mode, meaning any command that exits with a non-zero status will cause the function to exit. Be sure any exotic commands used are covered by `makedepends`. -All of the above variables such as `pkgname` and `pkgver` are available for use +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 use during the build and install process. These three variables are as follows: @@ -321,31 +321,37 @@ Pacman has the ability to store and execute a package-specific script when it installs, removes, or upgrades a package. This allows a package to configure itself after installation and perform an opposite action upon removal. -The exact time the script is run varies with each operation: +The exact time the script is run varies with each operation, and should be +self-explanatory. Note that during an upgrade operation, none of the install or +remove scripts will be called. + +Scripts are passed either one or two ``full version strings'', where a full +version string is 'pkgver-pkgrel', or 'epoch:pkgver-pkgrel' if epoch is +non-zero. *pre_install*:: - script is run right before files are extracted. One argument is passed: - new package version. + Run right before files are extracted. One argument is passed: + new package full version string. *post_install*:: - script is run right after files are extracted. One argument is passed: - new package version. + Run right after files are extracted. One argument is passed: + new package full version string. *pre_upgrade*:: - script is run right before files are extracted. Two arguments are passed - in the following order: new package version, old package version. + Run right before files are extracted. Two arguments are passed in this + order: new package full version string, old package full version string. *post_upgrade*:: - script is run after files are extracted. Two arguments are passed - in the following order: new package version, old package version. + Run after files are extracted. Two arguments are passed in this order: + new package full version string, old package full version string. *pre_remove*:: - script is run right before files are removed. One argument is passed: - old package version. + Run right before files are removed. One argument is passed: + old package full version string. *post_remove*:: - script is run right after files are removed. One argument is passed: - old package version. + Run right after files are removed. One argument is passed: + old package full version string. To use this feature, create a file such as 'pkgname.install' and put it in the same directory as the PKGBUILD script. Then use the install directive: -- 1.7.6
