Don't check diskspace when using --dbonly
[pacman-ng.git] / doc / PKGBUILD.5.txt
blobfad93e5c03a2619cbbf1fb29f14af1d88430108d
1 /////
2 vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
3 /////
4 PKGBUILD(5)
5 ===========
7 Name
8 ----
9 PKGBUILD - Arch Linux package build description file
12 Synopsis
13 --------
14 PKGBUILD
17 Description
18 -----------
19 This manual page describes general rules about PKGBUILDs. Once a
20 PKGBUILD is written, the actual package is built using makepkg and installed
21 with pacman.
23 NOTE: An example PKGBUILD, useful for reference, is located in '{pkgdatadir}'
24 along with other example files such as a ChangeLog and an install
25 script. You can copy the provided PKGBUILD.proto file to a new package build
26 directory and make customizations to suit your needs.
29 Options and Directives
30 ----------------------
31 The following is a list of standard options and directives available for use
32 in a PKGBUILD. These are all understood and interpreted by makepkg, and most
33 of them will be directly transferred to the built package.
35 If you need to create any custom variables for use in your build process, it is
36 recommended to prefix their name with an '_' (underscore).
37 This will prevent any possible name clashes with internal makepkg variables.
38 For example, to store the base kernel version in a variable, use something
39 similar to `$_basekernver`.
41 *pkgname (array)*::
42         Either the name of the package or an array of names for split packages.
43         Because it will be used in the package filename, this has to be unix-friendly.
44         Members of the array are not allowed to start with hyphens.
46 *pkgver*::
47         The version of the software as released from the author (e.g., '2.7.1').
48         The variable is not allowed to contain colons or hyphens.
50 *pkgrel*::
51         This is the release number specific to the Arch Linux release. This
52         allows package maintainers to make updates to the package's configure
53         flags, for example. This is typically set to '1' for each new upstream
54         software release and incremented for intermediate PKGBUILD updates. The
55         variable is not allowed to contain hyphens.
57 *pkgdesc*::
58         This should be a brief description of the package and its functionality.
59         Try to keep the description to one line of text and not use the package's name.
61 *epoch*::
62         Used to force the package to be seen as newer than any previous versions
63         with a lower epoch, even if the version number would normally not trigger
64         such an upgrade. This value is required to be a positive integer; the
65         default value if left unspecified is '0'. This is useful when the version
66         numbering scheme of a package changes (or is alphanumeric), breaking normal
67         version comparison logic. See linkman:pacman[8] for more information on
68         version comparisons.
70 *url*::
71         This field contains a URL that is associated with the software being
72         packaged. Typically the project's website.
74 *license (array)*::
75         This field specifies the license(s) that apply to the package.
76         Commonly used licenses can be found in '/usr/share/licenses/common'. If you
77         see the package's license there, simply reference it in the license
78         field (e.g., `license=('GPL')`). If the package provides a license not
79         available in '/usr/share/licenses/common', then you should include it
80         in the package itself and set `license=('custom')` or
81         `license=('custom:LicenseName')`. The license should be placed in
82         '$pkgdir/usr/share/licenses/$pkgname/' when building the package. If
83         multiple licenses are applicable, list all of them:
84         `license=('GPL' 'FDL')`.
86 *install*::
87         Specifies a special install script that is to be included in the package.
88         This file should reside in the same directory as the PKGBUILD, and will
89         be copied into the package by makepkg. It does not need to be included
90         in the source array (e.g., `install=$pkgname.install`).
92 *changelog*::
93         Specifies a changelog file that is to be included in the package.
94         This file should reside in the same directory as the PKGBUILD, and will
95         be copied into the package by makepkg. It does not need to be included
96         in the source array (e.g., `changelog=$pkgname.changelog`).
98 *source (array)*::
99         An array of source files required to build the package. Source files
100         must either reside in the same directory as the PKGBUILD, or be a
101         fully-qualified URL that makepkg can use to download the file.
102         To make the PKGBUILD as useful as possible, use the `$pkgname` and `$pkgver`
103         variables if possible when specifying the download location. Compressed files
104         will be extracted automatically unless found in
105         the noextract array described below.
107 It is also possible to change the name of the downloaded file, which is helpful
108 with weird URLs and for handling multiple source files with the same
109 name. The syntax is: `source=('filename::url')`.
111 Files in the source array with extensions `.sig`, `.sign` or `.asc` are recognized by
112 makepkg as PGP signatures and will be automatically used to verify the integrity
113 of the corresponding source file.
115 *noextract (array)*::
116         An array of filenames corresponding to those from the source array. Files
117         listed here will not be extracted with the rest of the source files. This
118         is useful for packages that use compressed data directly.
120 *md5sums (array)*::
121         This array contains an MD5 hash for every source file specified in the
122         source array (in the same order). makepkg will use this to verify source
123         file integrity during subsequent builds. To easily generate md5sums, run
124         `makepkg -g >> PKGBUILD`. If desired, move the md5sums line to an
125         appropriate location.
127 *sha1sums, sha256sums, sha384sums, sha512sums (arrays)*::
128         Alternative integrity checks that makepkg supports; these all behave
129         similar to the md5sums option described above. To enable use and generation
130         of these checksums, be sure to set up the `INTEGRITY_CHECK` option in
131         linkman:makepkg.conf[5].
133 *groups (array)*::
134         An array of symbolic names that represent groups of packages, allowing
135         you to install multiple packages by requesting a single target. For
136         example, one could install all KDE packages by installing the 'kde' group.
138 *arch (array)*::
139         Defines on which architectures the given package is available (e.g.,
140         `arch=('i686' 'x86_64')`). Packages that contain no architecture specific
141         files should use `arch=('any')`.
143 *backup (array)*::
144         An array of filenames, without preceding slashes, that
145         should be backed up if the package is removed or upgraded. This is
146         commonly used for packages placing configuration files in /etc. See
147         Handling Config Files in linkman:pacman[8] for more information.
149 *depends (array)*::
150         An array of packages this package depends on to run. Entries in
151         this list should be surrounded with single quotes and contain at least
152         the package name. Entries can also include a version requirement of the
153         form 'name<>version', where `<>` is one of five comparisons: `>=` (greater
154         than or equal to), `<=` (less than or equal to), `=` (equal to), `>`
155         (greater than), or `<` (less than).
157 If the dependency name appears to be a library (ends with .so), makepkg will
158 try to find a binary that depends on the library in the built package and
159 append the version needed by the binary. Appending the version yourself
160 disables auto detection.
162 *makedepends (array)*::
163         An array of packages this package depends on to build but are not
164         needed at runtime. Packages in this list follow the same format as
165         depends.
167 *checkdepends (array)*::
168         An array of packages this package depends on to run its test suite
169         but are not needed at runtime. Packages in this list follow the same
170         format as depends. These dependencies are only considered when the
171         check() function is present and is to be run by makepkg.
173 *optdepends (array)*::
174         An array of packages (and accompanying reasons) that are not essential for
175         base functionality, but may be necessary to make full use of the contents
176         of this package. optdepends are currently for informational purposes only
177         and are not utilized by pacman during dependency resolution. The format
178         for specifying optdepends is:
180         optdepends=('fakeroot: for makepkg usage as normal user')
182 *conflicts (array)*::
183         An array of packages that will conflict with this package (i.e. they
184         cannot both be installed at the same time). This directive follows the
185         same format as depends. Versioned conflicts are supported using the
186         operators as described in `depends`.
188 *provides (array)*::
189         An array of ``virtual provisions'' this package provides. This allows
190         a package to provide dependencies other than its own package name. For
191         example, the dcron package can provide 'cron', which allows packages to
192         depend on 'cron' rather than 'dcron OR fcron'.
194 Versioned provisions are also possible, in the 'name=version' format. For
195 example, dcron can provide 'cron=2.0' to satisfy the 'cron>=2.0' dependency of
196 other packages. Provisions involving the `>` and `<` operators are invalid as
197 only specific versions of a package may be provided.
199 If the provision name appears to be a library (ends with .so), makepkg will
200 try to find the library in the built package and append the correct
201 version. Appending the version yourself disables auto detection.
203 *replaces (array)*::
204         An array of packages this package should replace. This can be used
205         to handle renamed/combined packages. For example, if the 'j2re' package
206         is renamed to 'jre', this directive allows future upgrades to continue
207         as expected even though the package has moved. Versioned replaces are
208         supported using the operators as described in `depends`.
210 Sysupgrade is currently the only pacman operation that utilizes this field.
211 A normal sync or upgrade will not use its value.
213 *options (array)*::
214         This array allows you to override some of makepkg's default behavior
215         when building packages. To set an option, just include the option name
216         in the options array. To reverse the default behavior, place an ``!'' at
217         the front of the option. Only specify the options you specifically want
218         to override, the rest will be taken from linkman:makepkg.conf[5].
219         *NOTE:* 'force' is a now-removed option in favor of the top level 'epoch'
220         variable.
222         *strip*;;
223                 Strip symbols from binaries and libraries. If you frequently
224                 use a debugger on programs or libraries, it may be helpful to
225                 disable this option.
227         *docs*;;
228                 Save doc directories. If you wish to delete doc directories,
229                 specify `!docs` in the array.
231         *libtool*;;
232                 Leave libtool (.la) files in packages. Specify `!libtool` to
233                 remove them.
235         *emptydirs*;;
236                 Leave empty directories in packages.
238         *zipman*;;
239                 Compress man and info pages with gzip.
241         *upx*;;
242                 Compress binary executable files using UPX.
244         *ccache*;;
245                 Allow the use of ccache during build. More useful in its negative
246                 form `!ccache` with select packages that have problems building
247                 with ccache.
249         *distcc*;;
250                 Allow the use of distcc during build. More useful in its negative
251                 form `!distcc` with select packages that have problems building
252                 with distcc.
254         *buildflags*;;
255                 Allow the use of user-specific buildflags (CFLAGS, CXXFLAGS, LDFLAGS)
256                 during build as specified in linkman:makepkg.conf[5]. More useful in
257                 its negative form `!buildflags` with select packages that have problems
258                 building with custom buildflags.
260         *makeflags*;;
261                 Allow the use of user-specific makeflags during build as specified
262                 in linkman:makepkg.conf[5]. More useful in its negative form
263                 `!makeflags` with select packages that have problems building with
264                 custom makeflags such as `-j2` (or higher).
267 build() Function
268 ----------------
269 In addition to the above directives, the optional build() function usually
270 comprises the remainder of the PKGBUILD. This is directly sourced and executed
271 by makepkg, so anything that bash or the system has available is available for
272 use here. The function is run in `bash -e` mode, meaning any command that exits
273 with a non-zero status will cause the function to exit. Be sure any exotic
274 commands used are covered by `makedepends`.
276 All of the above variables such as `$pkgname` and `$pkgver` are available for use
277 in the build function. In addition, makepkg defines the following three
278 variables for use during the build and install process:
280 *startdir*::
281         This contains the absolute path to the directory where the PKGBUILD is
282         located, which is usually the output of `$(pwd)` when makepkg is started.
283         Use of this variable is deprecated and strongly discouraged.
285 *srcdir*::
286         This contains the directory where makepkg extracts, or copies, all source
287         files.
289 *pkgdir*::
290         This contains the directory where makepkg bundles the installed package
291         (this directory will become the root directory of your built package).
293 If you create any variables of your own in the build function, it is
294 recommended to use the bash `local` keyword to scope the variable to inside
295 the build function.
297 check() Function
298 ----------------
299 An optional check() function can be specified in which a packages test-suite
300 may be run. This function is run between the build() and package() functions.
301 The function is run in `bash -e` mode, meaning any command that exits with a
302 non-zero status will cause the function to exit. Be sure any exotic commands
303 used are covered by `checkdepends`.
305 package() Function
306 ------------------
307 An optional package() function can be specified in addition to the build()
308 function. This function is run after the build() and check() functions. The
309 function is run in `bash -e` mode, meaning any command that exits with a
310 non-zero status will cause the function to exit. When specified in combination
311 with the fakeroot BUILDENV option in linkman:makepkg.conf[5], fakeroot usage
312 will be limited to running the packaging stage. An existing build() function
313 will be run as the user calling makepkg.
315 Package Splitting
316 -----------------
317 makepkg supports building multiple packages from a single PKGBUILD. This is
318 achieved by assigning an array of package names to the `pkgname` directive.
319 Each split package uses a corresponding packaging function with name
320 `package_foo()`, where `foo` is the name of the split package.
322 All options and directives for the split packages default to the global values
323 given in the PKGBUILD. Nevertheless, the following ones can be overridden within
324 each split package's packaging function:
325 `pkgver`, `pkgrel`, `epoch`, `pkgdesc`, `arch`, `license`, `groups`, `depends`,
326 `optdepends`, `provides`, `conflicts`, `replaces`, `backup`, `options`,
327 `install` and `changelog`.
329 An optional global directive is available when building a split package:
331 *pkgbase*::
332         The name used to refer to the group of packages in the output of makepkg
333         and in the naming of source-only tarballs.  If not specified, the first
334         element in the `pkgname` array is used.  The variable is not allowed to
335         begin with a hyphen.
337 Install/Upgrade/Remove Scripting
338 --------------------------------
339 Pacman has the ability to store and execute a package-specific script when it
340 installs, removes, or upgrades a package. This allows a package to configure
341 itself after installation and perform an opposite action upon removal.
343 The exact time the script is run varies with each operation, and should be
344 self-explanatory. Note that during an upgrade operation, none of the install
345 or remove scripts will be called.
347 Scripts are passed either one or two ``full version strings'', where a full
348 version string is either 'pkgver-pkgrel' or 'epoch:pkgver-pkgrel' if epoch is
349 non-zero.
351 *pre_install*::
352         Run right before files are extracted. One argument is passed:
353         new package full version string.
355 *post_install*::
356         Run right after files are extracted. One argument is passed:
357         new package full version string.
359 *pre_upgrade*::
360         Run right before files are extracted. Two arguments are passed in this
361         order: new package full version string, old package full version string.
363 *post_upgrade*::
364         Run after files are extracted. Two arguments are passed in this order:
365         new package full version string, old package full version string.
367 *pre_remove*::
368         Run right before files are removed. One argument is passed:
369         old package full version string.
371 *post_remove*::
372         Run right after files are removed. One argument is passed:
373         old package full version string.
375 To use this feature, create a file such as 'pkgname.install' and put it in the
376 same directory as the PKGBUILD script. Then use the install directive:
378         install=pkgname.install
380 The install script does not need to be specified in the source array. A
381 template install file is available in '{pkgdatadir}' as 'proto.install' for
382 reference with all of the available functions defined.
385 Development Directives
386 ----------------------
387 makepkg supports building development versions of packages without having to
388 manually update the pkgver in the PKGBUILD. This was formerly done using the
389 separate utility 'versionpkg'. In order to utilize this functionality, your
390 PKGBUILD must use correct variable names depending on the SCM being fetched
391 from (e.g., 'makepkg-git', 'mplayer-svn').
393 *CVS*::
394         The generated pkgver will be the date the package is built.
396         *_cvsroot*;;
397                 The root of the CVS repository.
399         *_cvsmod*;;
400                 The CVS module to fetch.
402 *SVN*::
403         The generated pkgver will be the latest SVN revision number.
405         *_svntrunk*;;
406                 The trunk of the SVN repository.
408         *_svnmod*;;
409                 The SVN module to fetch.
411 *Git*::
412         The generated pkgver will be the date the package is built.
414         *_gitroot*;;
415                 The URL (all protocols supported) to the GIT repository.
417         *_gitname*;;
418                 GIT tag or branch to use.
420 *Mercurial*::
421         The generated pkgver will be the hg tip revision number.
423         *_hgroot*;;
424                 The URL of the mercurial repository.
426         *_hgrepo*;;
427                 The repository to follow.
429 *Darcs*::
430         The generated pkgver will be the date the package is built.
432         *_darcstrunk*;;
433                 URL to the repository trunk.
435         *_darcsmod*;;
436                 Darcs module to use.
438 *Bazaar*::
439         The generated pkgver will be the latest Bazaar revision number (revno).
441         *_bzrtrunk*;;
442                 URL to the bazaar repository.
444         *_bzrmod*;;
445                 Bazaar module to use.
448 Example
449 -------
450 The following is an example PKGBUILD for the 'patch' package. For more
451 examples, look through the build files of your distribution's packages. For
452 those using Arch Linux, consult the ABS tree.
454 [source,sh]
455 -------------------------------
456 include::PKGBUILD-example.txt[]
457 -------------------------------
459 See Also
460 --------
461 linkman:makepkg[8], linkman:pacman[8], linkman:makepkg.conf[5]
463 include::footer.txt[]