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