doc/makepkg.conf.5.txt

   1 /////
   2 vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
   3 /////
   4 makepkg.conf(5)
   5 ===============
   6
   7 Name
   8 ----
   9 makepkg.conf - makepkg configuration file
  10
  11
  12 Synopsis
  13 --------
  14 {sysconfdir}/makepkg.conf, ~/.makepkg.conf
  15
  16
  17 Description
  18 -----------
  19 Configuration options for makekpg are stored in makepkg.conf. This file is
  20 sourced, so you can include any special compiler flags you wish to use. This is
  21 helpful for building for different architectures, or with different
  22 optimizations. However, only the variables described below are exported to the
  23 build environment.
  24
  25 NOTE: This does not guarantee that all package Makefiles will use your exported
  26 variables. Some of them are non-standard.
  27
  28 The default file is fairly well commented, so it may be easiest to simply
  29 follow directions given there for customization.
  30
  31
  32 Options
  33 -------
  34 **DLAGENTS=(**\'protocol::/path/to/command [options]' ...**)**::
  35         Sets the download agents used to fetch source files specified with a URL in
  36         the linkman:PKGBUILD[5] file. Options can be specified for each command as
  37         well, and any protocol can have a download agent. Several examples are provided
  38         in the default makepkg.conf.
  39         +
  40         If present, `%u` will be replaced with the download URL. Otherwise, the
  41         download URL will be placed on the end of the command. If present, `%o` will
  42         be replaced with the local filename, plus a ``.part'' extension, which allows
  43         makepkg to handle resuming file downloads.
  44
  45 **CARCH=**"carch"::
  46         Specifies your computer architecture; possible values include such things
  47         as ``i686'', ``x86_64'', ``ppc'', etc. This should be automatically set on
  48         installation.
  49
  50 **CHOST=**"chost"::
  51         A string such as ``i686-pc-linux-gnu'', do not touch unless you know what
  52         you are doing. This can be commented out by most users if desired.
  53
  54 **CFLAGS=**"cflags"::
  55         Flags used for the C compiler. This is a key part to the use of makepkg.
  56         Usually several options are specified, and the most common string resembles
  57         something like this: ``-march=i686 -O2 -pipe''. Another useful option may
  58         be `-mcpu` in place of `-march`. Read gcc(1) for more details on the wide
  59         variety of compiler flags available.
  60
  61 **CXXFLAGS=**"cxxflags"::
  62         Flags used for the C++ compiler; see CFLAGS for more info.
  63
  64 **LDFLAGS=**"ldflags"::
  65         Flags used for the linker. Several options may be specified with common
  66         usage resembling ``-Wl,--hash-style=gnu''. Read ld(1) for more details on
  67         available linker flags.
  68
  69 **MAKEFLAGS=**"makeflags"::
  70         This is often used to set the number of jobs used, for example, `-j2`.
  71         Other flags that make accepts can also be passed.
  72
  73 **BUILDENV=(**fakeroot !distcc color !ccache check !sign**)**::
  74         This array contains options that affect the build environment, the defaults
  75         are shown here. All options should always be left in the array; to enable
  76         or disable an option simply remove or place an ``!'' at the front of the
  77         option. Each works as follows:
  78
  79         *fakeroot*;;
  80                 Allow building packages as a non-root user. This is highly recommended.
  81
  82         *distcc*;;
  83                 Use the distributed C/C++/ObjC compiler to spread compilation among
  84                 multiple machines. If this is enabled, `DISTCC_HOSTS` must be specified
  85                 as well.
  86
  87         *color*;;
  88                 Colorize output messages, making output easier to read.
  89
  90         *ccache*;;
  91                 Use ccache to cache compilation by default. This allows for faster
  92                 compiles if you are continuously recompiling the same packages. It can
  93                 be disabled for individual packages by placing `!ccache` in the
  94                 PKGBUILD options array.
  95
  96         *check*;;
  97                 Run the check() function if present in the PKGBUILD. This can be
  98                 enabled or disabled for individual packages through the use of
  99                 makepkg's '\--check' and '\--nocheck' options respectively.
 100
 101         *sign*;;
 102                 Generate a PGP signature file using GnuPG. This will execute `gpg
 103                 --detach-sign --use-agent` on the built package to generate a detached
 104                 signature file, using the GPG agent if it is available. The signature
 105                 file will be the entire filename of the package with a ``.sig''
 106                 extension.
 107
 108 **DISTCC_HOSTS=**"host1 ..."::
 109         If using DistCC, this is used to specify a space-delimited list of hosts
 110         running in the DistCC cluster. In addition, you will want to modify your
 111         `MAKEFLAGS`.
 112
 113 **BUILDDIR=**"/path/to/folder"::
 114         If this value is not set, packages will by default be built in
 115         subdirectories of the directory that makepkg is called from.  This
 116         option allows setting the build location to another folder.
 117         Incorrect use of `$startdir` in a PKGBUILD may cause building with
 118         this option to fail.
 119
 120
 121 **GPGKEY=**""::
 122         Specify a key to use for gpg signing instead of the default key in the
 123         keyring. Can be overridden with makepkg's '\--key' option.
 124
 125 **OPTIONS=(**strip docs libtool emptydirs zipman purge !upx**)**::
 126         This array contains options that affect the default packaging. They are
 127         equivalent to options that can be placed in the PKGBUILD; the defaults are
 128         shown here. All options should always be left in the array; to enable or
 129         disable an option simply remove or place an ``!'' at the front of the
 130         option. Each works as follows:
 131
 132         *strip*;;
 133                 Strip symbols from binaries and libraries. If you frequently use a
 134                 debugger on programs or libraries, it may be helpful to disable this
 135                 option.
 136
 137         *docs*;;
 138                 Save doc directories. If you wish to delete doc directories, specify
 139                 `!docs` in the array. The directories affected are specified by the
 140                 `DOC_DIRS` variable.
 141
 142         *libtool*;;
 143                 Leave libtool (.la) files in packages. Specify `!libtool` to remove
 144                 them.
 145
 146         *emptydirs*;;
 147                 Leave empty directories in packages.
 148
 149         *zipman*;;
 150                 Compress manual (man and info) pages with gzip. The directories
 151                 affected are specified by the `MAN_DIRS` variable.
 152
 153         *purge*;;
 154                 Remove files specified by the `PURGE_TARGETS` variable from the
 155                 package.
 156
 157         *upx*;;
 158                 Compress binary executable files using UPX.  Additional options
 159                 can be passed to UPX by specifying the `UPXFLAGS` variable.
 160
 161 **INTEGRITY_CHECK=(**check1 ...**)**::
 162         File integrity checks to use. Multiple checks may be specified; this
 163         affects both generation and checking. The current valid options are:
 164         `md5`, `sha1`, `sha256`, `sha384`, and `sha512`.
 165
 166 **STRIP_BINARIES=**"--strip-all"::
 167         Options to be used when stripping binaries. See linkman:strip[1]
 168         for details.
 169
 170 **STRIP_SHARED=**"--strip-unneeded"::
 171         Options to be used when stripping shared libraries. See linkman:strip[1]
 172         for details.
 173
 174 **STRIP_STATIC=**"--strip-debug"::
 175         Options to be used when stripping static libraries. See  linkman:strip[1]
 176         for details.
 177
 178 **MAN_DIRS=(**{usr{,/local}{,/share},opt/*}/{man,info} ...**)**::
 179         If `zipman` is specified in the OPTIONS array, this variable will
 180         instruct makepkg where to look to compress manual (man and info)
 181         pages. If you build packages that are located in opt/, you may need
 182         to add the directory to this array. *NOTE:* Do not add the leading
 183         slash to the directory name.
 184
 185 **DOC_DIRS=(**usr/{,share/}{doc,gtk-doc} ...**)**::
 186         If `!docs` is specified in the OPTIONS array, this variable will
 187         instruct makepkg where to look to remove docs. If you build packages
 188         that are located in opt/, you may need to add the directory to this
 189         array. *NOTE:* Do not add the leading slash to the directory name.
 190
 191 **PURGE_TARGETS=(**usr/{,share}/info/dir .podlist *.pod...**)**::
 192         If `purge` is specified in the OPTIONS array, this variable will
 193         instruct makepkg which files to remove from the package. This is
 194         useful for index files that are added by multiple packages.
 195
 196 **PKGDEST=**"/path/to/folder"::
 197         If this value is not set, packages will by default be placed in the
 198         current directory (location of the linkman:PKGBUILD[5]). Many people
 199         like to keep all their packages in one place so this option allows
 200         this behavior. A common location is ``/home/packages''.
 201
 202 **SRCDEST=**"/path/to/folder"::
 203         If this value is not set, downloaded source files will only be stored
 204         in the current directory. Many people like to keep all source files in
 205         a central location for easy cleanup, so this path can be set here.
 206
 207 **SRCPKGDEST=**"/path/to/folder"::
 208         If this value is not set, source package files will be stored in
 209         in the current directory. Many people like to keep all source package files
 210         in a central location for easy cleanup, so this path can be set here.
 211
 212 **PACKAGER=**"John Doe <john@example.com>"::
 213         This value is used when querying a package to see who was the builder.
 214         It is recommended you change this to your name and email address.
 215
 216 **COMPRESSGZ=**"(gzip -c -f -n)", **COMPRESSBZ2=**"(bzip2 -c -f)", **COMPRESSXZ=**"(xz -c -z -)", **COMPRESSZ=**"(compress -c -f)"::
 217         Sets the command and options used when compressing compiled or source
 218         packages in the named format.
 219
 220 **PKGEXT=**".pkg.tar.gz", **SRCEXT=**".src.tar.gz"::
 221         Sets the compression used when making compiled or source packages. The
 222         current valid suffixes are `.tar`, `.tar.gz`, `.tar.bz2`, `.tar.xz`, and
 223         `.tar.Z`.
 224         Do not touch these unless you know what you are doing.
 225
 226 See Also
 227 --------
 228 linkman:makepkg[8], linkman:pacman[8], linkman:PKGBUILD[5]
 229
 230 include::footer.txt[]