doc/makepkg.8.txt

   1 /////
   2 vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
   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 or run the prepare() function (if present);
  63         use whatever source already exists in the $srcdir/ directory. This is
  64         handy if you want to go into $srcdir/ and manually patch or tweak code,
  65         then make a package out of the result. Keep in mind that creating a
  66         patch may be a better solution to allow others to use 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 (checksum and PGP) on source files.
  89
  90 *\--skipchecksums*::
  91         Do not verify checksums of source files.
  92
  93 *\--skippgpcheck*::
  94         Do not verify PGP signatures of source files.
  95
  96 *-h, \--help*::
  97         Output syntax and command line options.
  98
  99 *\--holdver*::
 100         Useful when building development versions of packages. Prevents makepkg
 101         from automatically bumping the pkgver to the latest revision number in
 102         the package's development tree.
 103
 104 *-i, \--install*::
 105         Install or upgrade the package after a successful build using
 106         linkman:pacman[8].
 107
 108 *-L, \--log*::
 109         Enable makepkg build logging. This will use the *tee* program to send
 110         output of the `build()` function to both the console and to a text file in
 111         the build directory named `pkgname-pkgver-pkgrel-arch.log`. As mentioned
 112         above, the build log will be localized so you may want to set your locale
 113         accordingly if sharing the log output with others.
 114
 115 *-m, \--nocolor*::
 116         Disable color in output messages.
 117
 118 *-o, \--nobuild*::
 119         Download and extract files, run the prepare() function, but do not build
 120         them. Useful with the '\--noextract' option if you wish to tweak the files
 121         in $srcdir/ before building.
 122
 123 *-p* <buildscript>::
 124         Read the package script `buildscript` instead of the `PKGBUILD` default;
 125         see linkman:PKGBUILD[5].
 126
 127 *-r, \--rmdeps*::
 128         Upon successful build, remove any dependencies installed by makepkg
 129         during dependency auto-resolution and installation when using `-s`.
 130
 131 *-R, \--repackage*::
 132         Repackage contents of the package without rebuilding the package. This
 133         is useful if you forgot a depend or install file in your PKGBUILD and
 134         the build itself will not change.
 135
 136 *-s, \--syncdeps*::
 137         Install missing dependencies using pacman. When build-time or run-time
 138         dependencies are not found, pacman will try to resolve them. If
 139         successful, the missing packages will be downloaded and installed.
 140
 141 *-S, \--source*::
 142         Do not actually build the package, but build a source-only tarball that
 143         does not include sources that can be fetched via a download URL. This is
 144         useful for passing a single tarball to another program such as a chroot,
 145         remote builder, or a tarball upload. Because integrity checks are verified,
 146         all source files of the package need to be present or downloadable.
 147
 148 *\--allsource*::
 149         Do not actually build the package, but build a source-only tarball that
 150         includes all sources, including those that are normally download via
 151         makepkg. This is useful for passing a single tarball to another program
 152         such as a chroot or remote builder. It will also satisfy requirements of
 153         the GPL when distributing binary packages.
 154
 155 *\--pkg* <list>::
 156         Only build listed packages from a split package. Multiple packages should
 157         be comma separated in the list. This option can be specified multiple times.
 158
 159 *\--check*::
 160         Run the check() function in the PKGBUILD, overriding the setting in
 161         linkman:makepkg.conf[5].
 162
 163 *\--nocheck*::
 164         Do not run the check() function in the PKGBUILD or handle the checkdepends.
 165
 166 *\--sign*::
 167         Sign the resulting package with gpg, overriding the setting in
 168         linkman:makepkg.conf[5].
 169
 170 *\--nosign*::
 171         Do not create a signature for the built package.
 172
 173 *\--key* <key>::
 174         Specify a key to use when signing packages, overriding the GPGKEY setting
 175         in linkman:makepkg.conf[5]. If not specified in either location, the
 176         default key from the keyring will be used.
 177
 178 *\--noconfirm*::
 179         (Passed to pacman) Prevent pacman from waiting for user input before
 180         proceeding with operations.
 181
 182 *\--asdeps*::
 183         (Passed to pacman) Install packages as non-explicitly installed (used
 184         with -i / --install).
 185
 186 *\--noprogressbar*::
 187         (Passed to pacman) Prevent pacman from displaying a progress bar;
 188         useful if you are redirecting makepkg output to file.
 189
 190
 191 Additional Features
 192 -------------------
 193 makepkg supports building development versions of packages without having to
 194 manually update the pkgver in the PKGBUILD. This was formerly done using the
 195 separate utility 'versionpkg'. See linkman:PKGBUILD[5] for details on how to
 196 set up a development PKGBUILD.
 197
 198
 199 Environment Variables
 200 ---------------------
 201 *PACMAN*::
 202         The command that will be used to check for missing dependencies and to
 203         install and remove packages. Pacman's -Qq, -Rns, -S, -T, and -U
 204         operations must be supported by this command. If the variable is not
 205         set or empty, makepkg will fall back to `pacman'.
 206
 207 **PKGDEST=**"/path/to/folder"::
 208         Folder where the resulting packages will be stored. Overrides the
 209         corresponding value defined in linkman:makepkg.conf[5].
 210
 211 **SRCDEST=**"/path/to/folder"::
 212         Folder where the downloaded sources will be stored. Overrides the
 213         corresponding value defined in linkman:makepkg.conf[5].
 214
 215 **PACKAGER=**"John Doe <john@doe.com>"::
 216         String to identify the creator of the resulting package. Overrides
 217         the corresponding value defined in linkman:makepkg.conf[5].
 218
 219 **BUILDDIR=**"/path/to/folder"::
 220         Folder where the package will be built. Overrides the corresponding
 221         value defined in linkman:makepkg.conf[5].
 222
 223 Configuration
 224 -------------
 225 See linkman:makepkg.conf[5] for more details on configuring makepkg using the
 226 'makepkg.conf' file.
 227
 228
 229 See Also
 230 --------
 231 linkman:makepkg.conf[5], linkman:PKGBUILD[5], linkman:pacman[8]
 232
 233 include::footer.txt[]