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* <`/path/to/config`>::
  56         Use an alternate config file instead of the `/etc/makepkg.conf` default;
  57
  58 *-d, \--nodeps*::
  59         Do not perform any dependency checks. This will let you override and
  60         ignore any dependencies required. There is a good chance this option
  61         will break the build process if all of the dependencies are not
  62         installed.
  63
  64 *-e, \--noextract*::
  65         Do not extract source files; use whatever source already exists in the
  66         src/ directory. This is handy if you want to go into src/ and manually
  67         patch or tweak code, then make a package out of the result. Keep in mind
  68         that creating a patch may be a better solution to allow others to use
  69         your PKGBUILD.
  70
  71 *-f, \--force*::
  72         makepkg will not build a package if a built package already exists in
  73         the `PKGDEST` (set in linkman:makepkg.conf[5]) directory, which may
  74         default to the current directory. This allows the built package to be
  75         overwritten.
  76
  77 *--forcever*::
  78         This is a hidden option that should *not* be used unless you really know
  79         what you are doing. makepkg uses this internally when calling itself to
  80         set the new development pkgver of the package.
  81
  82 *-g, \--geninteg*::
  83         For each source file in the source array of PKGBUILD, download the file
  84         if required and generate integrity checks. The integrity checks
  85         generated are determined by the value of the INTEGRITY_CHECK array in
  86         linkman:makepkg.conf[5]. This output can be redirected into your
  87         PKGBUILD for source validation using "`makepkg -g >> PKGBUILD`".
  88
  89 *-h, \--help*::
  90         Output syntax and command line options.
  91
  92 *\--holdver*::
  93         Useful when building development versions of packages. Prevents makepkg
  94         from automatically bumping the pkgver to the latest revision number in
  95         the package's development tree.
  96
  97 *-i, \--install*::
  98         Install or upgrade the package after a successful build using
  99         linkman:pacman[8].
 100
 101 *-L, \--log*::
 102         Enable makepkg build logging. This will use the *tee* program to send
 103         output of the `build()` function to both the console and to a text file in
 104         the build directory named `pkgname-pkgver-pkgrel-arch.log`. As mentioned
 105         above, the build log will be localized so you may want to set your locale
 106         accordingly if sharing the log output with others.
 107
 108 *-m, \--nocolor*::
 109         Disable color in output messages.
 110
 111 *-o, \--nobuild*::
 112         Download and extract files only, but do not build them. Useful with the
 113         `\--noextract` option if you wish to tweak the files in src/ before
 114         building.
 115
 116 *-p* <`buildscript`>::
 117         Read the package script `buildscript` instead of the `PKGBUILD` default;
 118         see linkman:PKGBUILD[5].
 119
 120 *-r, \--rmdeps*::
 121         Upon successful build, remove any dependencies installed by makepkg
 122         during dependency auto-resolution and installation when using `-s`.
 123
 124 *-R, \--repackage*::
 125         Repackage contents of the package without rebuilding the package. This
 126         is useful if you forgot a depend or install file in your PKGBUILD and
 127         the build itself will not change.
 128
 129 *-s, \--syncdeps*::
 130         Install missing dependencies using pacman. When build-time or run-time
 131         dependencies are not found, pacman will try to resolve them. If
 132         successful, the missing packages will be downloaded and installed.
 133
 134 *\--allsource*::
 135         Do not actually build the package, but build a source-only tarball that
 136         includes all sources, including those that are normally download via
 137         makepkg. This is useful for passing a single tarball to another program
 138         such as a chroot or remote builder. It will also satisfy requirements of
 139         the GPL when distributing binary packages.
 140
 141 *\--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.
 146
 147 *\--noconfirm*::
 148         (Passed to pacman) Prevent pacman from waiting for user input before
 149         proceeding with operations.
 150
 151 *\--noprogressbar*::
 152         (Passed to pacman) Prevent pacman from displaying a progress bar;
 153         useful if you are redirecting makepkg output to file.
 154
 155
 156 Additional Features
 157 -------------------
 158 makepkg supports building development versions of packages without having to
 159 manually update the pkgver in the PKGBUILD. This was formerly done using the
 160 separate utility 'versionpkg'. See linkman:PKGBUILD[5] for details on how to
 161 set up a development PKGBUILD.
 162
 163
 164 Configuration
 165 -------------
 166 See linkman:makepkg.conf[5] for more details on configuring makepkg using the
 167 'makepkg.conf' file.
 168
 169
 170 See Also
 171 --------
 172 linkman:makepkg.conf[5], linkman:PKGBUILD[5], linkman:pacman[8]
 173
 174 include::footer.txt[]