From ArchWiki
Revision as of 20:12, 27 April 2011 by Kosava (Talk | contribs) (Created page with "Category:About Arch (Српски) Category:Package development (Српски) Category:Guidelines (Српски) {{i18n|PKGBUILD}} fr:PKGBUILD {{Article summary...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This template has only maintenance purposes. For linking to local translations please use interlanguage links, see Help:i18n#Interlanguage links.

Local languages: Català – Dansk – English – Español – Esperanto – Hrvatski – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Norsk Bokmål – Polski – Português – Slovenský – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – العربية – ไทย – 日本語 – 正體中文 – 简体中文 – 한국어

External languages (all articles in these languages should be moved to the external wiki): Deutsch – Français – Română – Suomi – Svenska – Tiếng Việt – Türkçe – فارسی

Template:Article summary start

Template:Article summary text Template:Article summary heading Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary wiki Template:Article summary heading Template:Article summary link Template:Article summary end

A Template:Filename is an Arch Linux package build description file used when creating packages. This article describes possible Template:Filename variables.

Building packages

Packages in Arch Linux are built using the makepkg utility and information stored in a Template:Filename file. When Template:Codeline is run, it searches for a Template:Filename in the current directory and follows the instructions therein to either compile or otherwise acquire the required files to be packaged within a package file (Template:Filename). The resulting package contains binary files and installation instructions; readily installed with pacman.



The following are variables that can be filled out in the Template:Filename file:

The name of the package. It should consist of alphanumeric characters and dashes ('-') and all letters should be lowercase. For the sake of consistency, Template:Codeline should match the name of the source tarball of the software you are packaging. For instance, if the software is in Template:Filename, the Template:Codeline value should be foobar. The present working directory the Template:Filename file is in should also match the Template:Codeline.
The version of the package. The value should be the same as the version released by the author of the package. It can contain letters, numbers and periods but CANNOT contain a hyphen. If the author of the package uses a hyphen in their version numbering scheme, replace it with an underscore. For instance, if the version is 0.99-10, it should be changed to 0.99_10. If the pkgver variable is used later in the PKGBUILD then the underscore can easily be substituted for a dash on usage e.g.:
The release number of the package specific to Arch Linux. This value allows users to differentiate between consecutive builds of the same version of a package. When a new package version is first released, the release number starts at 1. As fixes and optimizations are made to the Template:Filename file, the package will be re-released and the release number will increment by 1. When a new version of the package comes out, the release number resets to 1.
An integer value, specific to Arch Linux, representing what 'lifetime' to compare version numbers against. This value allows overrides of the normal version comparison rules for packages that have inconsistent version numbering, require a downgrade, change numbering schemes, etc. By default, packages are assumed to have an epoch value of 0. Do not use this unless you know what you are doing.
The description of the package. The description should be about 80 characters or less and should not include the package name in a self-referencing way. For instance, "Nedit is a text editor for X11" should be written as "A text editor for X11."
An array of architectures that the Template:Filename file is known to build and work on. Currently, it should contain i686 and/or x86_64, Template:Codeline. The value any can also be used for architechture-independent packages. You can access this value with the variable Template:Codeline during the build.
The URL of the official site of the software being packaged.
The license under which the software is distributed. A Template:Package Official package has been created in Template:Codeline that stores common licenses in Template:Filename, i.e. Template:Filename. If a package is licensed under one of these licenses, the value should be set to the directory name, e.g. Template:Codeline. If the appropriate license is not included in the official Template:Package Official package, several things must be done:
  1. The license file(s) should be included in: Template:Filename, e.g. Template:Filename.
  2. If the source tarball does NOT contain the license details and the license is only displayed elsewhere, e.g. a website, then you need to copy the license to a file and include it.
  3. Add custom to the Template:Codeline array. Optionally, you can replace custom with custom:name of license. Once a license is used in two or more packages in an official repository (including Template:Codeline), it becomes a part of the Template:Package Official package.
  • The BSD, MIT, zlib/png and Python licenses are special cases and could not be included in the Template:Package Official package. For the sake of the Template:Codeline array, it is treated as a common license (Template:Codeline, Template:Codeline, Template:Codeline and Template:Codeline) but technically each one is a custom license because each one has its own copyright line. Any packages licensed under these four should have its own unique license stored in Template:Filename. Some packages may not be covered by a single license. In these cases, multiple entries may be made in the license array, e.g. Template:Codeline.
  • Additionally, the (L)GPL has many versions and permutations of those versions. For (L)GPL software, the convention is:
    • (L)GPL - (L)GPLv2 or any later version
    • (L)GPL2 - (L)GPL2 only
    • (L)GPL3 - (L)GPL3 or any later version
The group the package belongs in. For instance, when you install the Template:Package Official package, it installs all packages that belong in the kde group.
An array of package names that must be installed before this software can be run. If a software requires a minimum version of a dependency, the >= operator should be used to point this out, e.g. Template:Codeline. You do not need to list packages that your software depends on if other packages your software depends on already have those packages listed in their dependency. For instance, gtk2 depends on glib2 and glibc. However, glibc does not need to be listed as a dependency for gtk2 because it is a dependency for glib2.
An array of package names that must be installed to build the software but unnecessary for using the software after installation. You can specify the minimum version dependency of the packages in the same format as the Template:Codeline array.
Warning: The group "base-devel" is assumed already installed when building with makepkg . Members of "base-devel" should not be included in makedepends arrays.
An array of package names that are not needed for the software to function but provides additional features. A short description of what each package provides should also be noted. An Template:Codeline may look like this:
optdepends=('cups: printing support'
'sane: scanners support'
'libgphoto2: digital cameras support'
'alsa-lib: sound support'
'giflib: GIF images support'
'libjpeg: JPEG images support'
'libpng: PNG images support')
An array of package names that this package provides the features of (or a virtual package such as cron or sh). If you use this variable, you should add the version (Template:Codeline and perhaps the Template:Codeline) that this package will provide if dependencies may be affected by it. For instance, if you are providing a modified qt package named qt-foobar version 3.3.8 which provides qt then the Template:Codeline array should look like Template:Codeline. Putting Template:Codeline will cause to fail those dependencies that require a specific version of qt. Do not add Template:Codeline to your provides array, this is done automatically.
An array of package names that may cause problems with this package if installed. You can also specify the version properties of the conflicting packages in the same format as the Template:Codeline array.
An array of obsolete package names that are replaced by this package, e.g. Template:Codeline for the Template:Package Official package. After syncing with Template:Codeline, it will immediately replace an installed package upon encountering another package with the matching Template:Codeline in the repositories. If you are providing an alternate version of an already existing package, use the Template:Codeline variable which is only evaluated when actually installing the conflicting package.
An array of files to be backed up as Template:Filename when the package is removed. This is commonly used for packages placing configuration files in Template:Filename. The file paths in this array should be relative paths (e.g. Template:Filename) not absolute paths (e.g. Template:Filename).
This array allows you to override some of the default behavior of Template:Codeline. To set an option, include the option name in the array. To reverse the default behavior, place an ! at the front of the option. The following options may be placed in the array:
The name of the Template:Filename script to be included in the package. pacman has the ability to store and execute a package-specific script when it installs, removes or upgrades a package. The script contains the following functions which run at different times:
  • pre_install - The script is run right before files are extracted. One argument is passed: new package version.
  • post_install - The script is run right after files are extracted. One argument is passed: new package version.
  • pre_upgrade - The script is run right before files are extracted. Two arguments are passed in the following order: new package version, old package version.
  • post_upgrade - The script is run after files are extracted. Two arguments are passed in the following order: new package version, old package version.
  • pre_remove - The script is run right before files are removed. One argument is passed: old package version.
  • post_remove - The script is run right after files are removed. One argument is passed: old package version.
Each function is run chrooted inside the pacman install directory. See this thread.
Tip: A prototype Template:Filename is provided at Template:Filename.
An array of files which are needed to build the package. It must contain the location of the software source, which in most cases is a full HTTP or FTP URL. The previously set variables Template:Codeline and Template:Codeline can be used effectively here (e.g. Template:Codeline)
Note: If you need to supply files which are not downloadable on the fly, e.g. self-made patches, you simply put those into the same directory where your Template:Filename file is in and add the filename to this array. Any paths you add here are resolved relative to the directory where the Template:Filename lies. Before the actual build process is started, all of the files referenced in this array will be downloaded or checked for existence, and Template:Codeline will not proceed if any are missing.
Note: You can specify a different name for the downloaded file - if the downloaded file has a different name for some reason like the url had a GET parameter - using the following syntax: <filename>::<fileuri>, do not include the '<' and '>' characters
An array of files listed under the Template:Codeline array which should not be extracted from their archive format by Template:Codeline. This most commonly applies to certain zip files which cannot be handled by bsdtar because libarchive processes all files as streams rather than random access as unzip does. In these situations unzip should be added in the Template:Codeline array and the first line of the Template:Codeline function should contain:
cd $srcdir/$pkgname-$pkgver
unzip [source].zip
An array of MD5 checksums of the files listed in the Template:Codeline array. Once all files in the Template:Codeline array are available, an MD5 hash of each file will be automatically generated and compared with the values of this array in the same order they appear in the Template:Codeline array. While the order of the source files itself does not matter, it is important that it matches the order of this array since Template:Codeline cannot guess which checksum belongs to what source file. You can generate this array quickly and easily using the command Template:Codeline in the directory that contains the Template:Filename file. Note that the MD5 algorithm is known to have weaknesses, so you should consider using a stronger alternative.
An array of SHA-1 160-bit checksums. This is an alternative to md5sums described above, but is also known to have weaknesses, so you should consider using a stronger alternative. To enable use and generation of these checksums, be sure to set up the INTEGRITY_CHECK option in makepkg.conf. See man makepkg.conf.
An array of SHA-2 checksums with digest sizes 256, 384 and 512 bits respectively. These are alternatives to md5sums described above and are generally believed to be stronger. To enable use and generation of these checksums, be sure to set up the INTEGRITY_CHECK option in makepkg.conf. See man makepkg.conf.

It is common practice to preserve the order of the Template:Filename variables as shown above. However, this is not mandatory, as the only requirement in this context is correct Bash syntax.

See also