From a7dbe4635b4af9b5bd927ec0e7a211d1f6c1b0f2 Mon Sep 17 00:00:00 2001 From: Jelle van der Waa Date: Sat, 13 Jan 2018 16:43:12 +0100 Subject: Add BUILDINFO man page Add a new man page which describes the structure of a BUILDINFO file included in a package produced by makepkg. Signed-off-by: Jelle van der Waa Signed-off-by: Allan McRae --- doc/BUILDINFO.5.txt | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 doc/BUILDINFO.5.txt (limited to 'doc/BUILDINFO.5.txt') diff --git a/doc/BUILDINFO.5.txt b/doc/BUILDINFO.5.txt new file mode 100644 index 00000000..b7a72831 --- /dev/null +++ b/doc/BUILDINFO.5.txt @@ -0,0 +1,67 @@ +///// +vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us: +///// +BUILDINFO(5) +============ + +Name +---- +BUILDINFO - Makepkg package build information file + + +Synopsis +-------- +This manual page describes the format of a BUILDINFO file found in the root of +a package created by makepkg. The file contains a description of the package's +build environment. The information is formatted in key-value pairs separated by +a '=', one value per line. Arrays are represented multiple keys with the same +value. + + +Description +----------- + +This is a description of the contents of version '1' of the +BUILDINFO file format. + +*format*:: + Denotes the file format version, represented by a plain positive integer. + +*pkgname*:: + The name of the package. + +*pkgbase*:: + + The base name of a package, usually the same as the pkgname except for + split packages. + +*pkgver*:: + The version of the package including pkgrel and epoch. + +*pkgbuild_sha256sum*:: + The sha256sum in hex format of the PKGBUILD used to build the package. + +*packager*:: + The details of the packager that built the package. + +*builddate*:: + The build date of the package in epoch. + +*builddir*:: + The directory where the package was built. + +*buildenv (array)*:: + The build environment specified in makepkg.conf. + +*options (array)*:: + The options set specified when building the package. + +*installed (array)*:: + The installed packages at build time including the version information of + the package. Formatted as "$pkgname-$pkgver-$pkgrel". + +See Also +-------- +linkman:makepkg[8], linkman:pacman[8], linkman:makepkg.conf[5] + +include::footer.txt[] -- cgit v1.2.3-70-g09d2