doc/makepkg.8.txt

   1 /////
   2 vim:set ts=4 sw=4 syntax=asciidoc noet:
   3 /////
   4 makepkg(8)
   5 ==========
   6
   7 Name
   8 ----
   9 makepkg - package build utility
  10
  11
  12 Synopsis
  13 --------
  14 'makepkg' [options]
  15
  16
  17 Description
  18 -----------
  19 'makepkg' is a script to automate the building of packages. The requirements for
  20 using the script are a build-capable \*nix platform and a custom build script
  21 for each package you wish to build (known as a PKGBUILD). See
  22 linkman:PKGBUILD[5] for details on creating your own build scripts.
  23
  24 The advantage to a script-based build is that the work is only done once. Once
  25 you have the build script for a package, 'makepkg' will do the rest: download and
  26 validate source files, check dependencies, configure the build-time settings,
  27 build the package, install the package into a temporary root, make
  28 customizations, generate meta-info, and package the whole thing up for pacman
  29 to use.
  30
  31 NOTE: 'makepkg' uses your current locale by default and does not unset it when
  32 building packages. If you wish to share your build output with others when
  33 seeking help or for other purposes, you may wish to run "`LC_ALL=C makepkg`" so
  34 your logs and output are not localized.
  35
  36 Options
  37 -------
  38 *\--asroot*::
  39         Allow makepkg to run as root. This is for security purposes as it is
  40         normally dangerous to do so. This will also disable use of fakeroot and
  41         sudo.
  42
  43 *-A, \--ignorearch*::
  44         Ignore a missing or incomplete arch field in the build script. This is
  45         for rebuilding packages from source when the PKGBUILD may be slightly
  46         outdated and not updated with an `arch=('yourarch')` field.
  47
  48 *-c, \--clean*::
  49         Clean up leftover work files and directories after a successful build.
  50
  51 *\--config* <file>::
  52         Use an alternate config file instead of the +{sysconfdir}/makepkg.conf+
  53         default.
  54
  55 *-d, \--nodeps*::
  56         Do not perform any dependency checks. This will let you override and
  57         ignore any dependencies required. There is a good chance this option
  58         will break the build process if all of the dependencies are not
  59         installed.
  60
  61 *-e, \--noextract*::
  62         Do not extract source files; use whatever source already exists in the
  63         src/ directory. This is handy if you want to go into src/ and manually
  64         patch or tweak code, then make a package out of the result. Keep in mind
  65         that creating a patch may be a better solution to allow others to use
  66         your PKGBUILD.
  67
  68 *-f, \--force*::
  69         makepkg will not build a package if a built package already exists in
  70         the `PKGDEST` (set in linkman:makepkg.conf[5]) directory, which may
  71         default to the current directory. This allows the built package to be
  72         overwritten.
  73
  74 *--forcever*::
  75         This is a hidden option that should *not* be used unless you really know
  76         what you are doing. makepkg uses this internally when calling itself to
  77         set the new development pkgver of the package.
  78
  79 *-g, \--geninteg*::
  80         For each source file in the source array of PKGBUILD, download the file
  81         if required and generate integrity checks. The integrity checks generated
  82         are determined by the checks present in the PKGBUILD, falling back to the
  83         value of the INTEGRITY_CHECK array in makepkg.conf(5) if these are absent
  84         This output can be redirected into your PKGBUILD for source validation
  85         using "`makepkg -g >> PKGBUILD`".
  86
  87 *--skipinteg*::
  88         Do not perform any integrity checks, just print a warning instead.
  89
  90 *-h, \--help*::
  91         Output syntax and command line options.
  92
  93 *\--holdver*::
  94         Useful when building development versions of packages. Prevents makepkg
  95         from automatically bumping the pkgver to the latest revision number in
  96         the package's development tree.
  97
  98 *-i, \--install*::
  99         Install or upgrade the package after a successful build using
 100         linkman:pacman[8].
 101
 102 *-L, \--log*::
 103         Enable makepkg build logging. This will use the *tee* program to send
 104         output of the `build()` function to both the console and to a text file in
 105         the build directory named `pkgname-pkgver-pkgrel-arch.log`. As mentioned
 106         above, the build log will be localized so you may want to set your locale
 107         accordingly if sharing the log output with others.
 108
 109 *-m, \--nocolor*::
 110         Disable color in output messages.
 111
 112 *-o, \--nobuild*::
 113         Download and extract files only, but do not build them. Useful with the
 114         `\--noextract` option if you wish to tweak the files in src/ before
 115         building.
 116
 117 *-p* <buildscript>::
 118         Read the package script `buildscript` instead of the `PKGBUILD` default;
 119         see linkman:PKGBUILD[5].
 120
 121 *-r, \--rmdeps*::
 122         Upon successful build, remove any dependencies installed by makepkg
 123         during dependency auto-resolution and installation when using `-s`.
 124
 125 *-R, \--repackage*::
 126         Repackage contents of the package without rebuilding the package. This
 127         is useful if you forgot a depend or install file in your PKGBUILD and
 128         the build itself will not change.
 129
 130 *-s, \--syncdeps*::
 131         Install missing dependencies using pacman. When build-time or run-time
 132         dependencies are not found, pacman will try to resolve them. If
 133         successful, the missing packages will be downloaded and installed.
 134
 135 *\--allsource*::
 136         Do not actually build the package, but build a source-only tarball that
 137         includes all sources, including those that are normally download via
 138         makepkg. This is useful for passing a single tarball to another program
 139         such as a chroot or remote builder. It will also satisfy requirements of
 140         the GPL when distributing binary packages.
 141
 142 *\--source*::
 143         Do not actually build the package, but build a source-only tarball that
 144         does not include sources that can be fetched via a download URL. This is
 145         useful for passing a single tarball to another program such as a chroot,
 146         remote builder, or a tarball upload. Because integrity checks are verified,
 147         all source files of the package need to be present or downloadable.
 148
 149 *\--pkg <list>*::
 150         Only build listed packages from a split package. The use of quotes is
 151         necessary when specifying multiple packages. e.g. `--pkg "pkg1 pkg3"`
 152
 153 *\--check*::
 154         Run the check() function in the PKGBUILD, overriding the setting in
 155         linkman:makepkg.conf[5].
 156
 157 *\--nocheck*::
 158         Do not run the check() function in the PKGBUILD or handle the checkdepends.
 159
 160 *\--sign*::
 161         Sign the resulting package with gpg, overriding the setting in
 162         linkman:makepkg.conf[5].
 163
 164 *\--nosign*::
 165         Do not create a signature for the built package.
 166
 167 *\--key* <key>::
 168         Specify a key to use when signing packages, overriding the GPGKEY setting
 169         in linkman:makepkg.conf[5]. If not specified in either location, the
 170         default key from the keyring will be used.
 171
 172 *\--noconfirm*::
 173         (Passed to pacman) Prevent pacman from waiting for user input before
 174         proceeding with operations.
 175
 176 *\--noprogressbar*::
 177         (Passed to pacman) Prevent pacman from displaying a progress bar;
 178         useful if you are redirecting makepkg output to file.
 179
 180
 181 Additional Features
 182 -------------------
 183 makepkg supports building development versions of packages without having to
 184 manually update the pkgver in the PKGBUILD. This was formerly done using the
 185 separate utility 'versionpkg'. See linkman:PKGBUILD[5] for details on how to
 186 set up a development PKGBUILD.
 187
 188
 189 Environment Variables
 190 ---------------------
 191 *PACMAN*::
 192         The command that will be used to check for missing dependencies and to
 193         install and remove packages. Pacman's -Qq, -Rns, -S, -T, and -U
 194         operations must be supported by this command. If the variable is not
 195         set or empty, makepkg will fall back to `pacman'.
 196
 197 **PKGDEST=**"/path/to/folder"::
 198         Folder where the resulting packages will be stored. Overrides the
 199         corresponding value defined in linkman:makepkg.conf[5].
 200
 201 **SRCDEST=**"/path/to/folder"::
 202         Folder where the downloaded sources will be stored. Overrides the
 203         corresponding value defined in linkman:makepkg.conf[5].
 204
 205 **BUILDDIR=**"/path/to/folder"::
 206         Folder where the package will be built. Overrides the corresponding
 207         value defined in linkman:makepkg.conf[5].
 208
 209 Configuration
 210 -------------
 211 See linkman:makepkg.conf[5] for more details on configuring makepkg using the
 212 'makepkg.conf' file.
 213
 214
 215 See Also
 216 --------
 217 linkman:makepkg.conf[5], linkman:PKGBUILD[5], linkman:pacman[8]
 218
 219 include::footer.txt[]