doc/makepkg.conf.5.txt

   1 /////
   2 vim:set ts=4 sw=4 syntax=asciidoc noet:
   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 manlink:PKGBUILD[5] file. Options can be specified for each command as
  37         well; the download URL is placed on the end of the command. This is more
  38         flexible than the former `FTPAGENT` variable, as any protocol can have a
  39         download agent. Several examples are provided in the default makepkg.conf.
  40
  41 **CARCH=**"carch"::
  42         Specifies your computer architecture; possible values include such things
  43         as ``i686'', ``x86_64'', ``ppc'', etc. This should be automatically set on
  44         installation.
  45
  46 **CHOST=**"chost"::
  47         A string such as ``i686-pc-linux-gnu'', do not touch unless you know what
  48         you are doing. This can be commented out by most users if desired.
  49
  50 **CFLAGS=**"cflags"::
  51         Flags used for the C compiler. This is a key part to the use of makepkg.
  52         Usually several options are specified, and the most common string resembles
  53         something like this: ``-march=i686 -O2 -pipe''. Another useful option may
  54         be `-mcpu` in place of `-march`. Read gcc(1) for more details on the wide
  55         variety of compiler flags available.
  56
  57 **CXXFLAGS=**"cxxflags"::
  58         Flags used for the C++ compiler; see CFLAGS for more info.
  59
  60 **MAKEFLAGS=**"makeflags"::
  61         This is often used to set the number of jobs used, for example, `-j2`.
  62         Other flags that make accepts can also be passed.
  63
  64 **BUILDENV=(**fakeroot !distcc color !ccache !xdelta**)**::
  65         This array contains options that affect the build environment, the defaults
  66         are shown here. All options should always be left in the array; to enable
  67         or disable an option simply remove or place an ``!'' at the front of the
  68         option. Each works as follows:
  69
  70         *fakeroot*;;
  71                 Allow building packages as a non-root user. This is highly recommended.
  72
  73         *distcc*;;
  74                 Use the distributed C/C++/ObjC compiler to spread compilation among
  75                 multiple machines. If this is enabled, `DISTCC_HOSTS` must be specified
  76                 as well.
  77
  78         *color*;;
  79                 Colorize output messages, making output easier to read.
  80
  81         *ccache*;;
  82                 Use ccache to cache compilation by default. This allows for faster
  83                 compiles if you are continuously recompiling the same packages. It can
  84                 be disabled for individual packages by placing `!ccache` in the
  85                 PKGBUILD options array.
  86
  87         *xdelta*;;
  88                 Generate an xdelta binary patch from previous to current package. The
  89                 previous package must be available in the makepkg cache directory for
  90                 this to occur.
  91
  92 **DISTCC_HOSTS=**"host1 ..."::
  93         If using DistCC, this is used to specify a space-delimited list of hosts
  94         running in the DistCC cluster. In addition, you will want to modify your
  95         `MAKEFLAGS`.
  96
  97 **OPTIONS=(**strip !docs libtool emptydirs**)**::
  98         This array contains options that affect the default packaging. All four are
  99         equivalent to options that can be placed in the PKGBUILD; the defaults are
 100         shown here. All options should always be left in the array; to enable or
 101         disable an option simply remove or place an ``!'' at the front of the
 102         option. Each works as follows:
 103
 104         *strip*;;
 105                 Strip symbols from binaries and libraries. If you frequently use a
 106                 debugger on programs or libraries, it may be helpful to disable this
 107                 option.
 108
 109         *docs*;;
 110                 Save doc and info directories. If you wish to delete doc and info
 111                 directories, specify `!docs' in the array.
 112
 113         *libtool*;;
 114                 Leave libtool (.la) files in packages. Specify `!libtool' to remove
 115                 them.
 116
 117         *emptydirs*;;
 118                 Leave empty directories in packages.
 119
 120 **INTEGRITY_CHECK=(**check1 ...**)**::
 121         File integrity checks to use. Multiple checks may be specified; this
 122         affects both generation and checking. The current valid options are:
 123         `md5`, `sha1`, `sha256`, `sha384`, and `sha512`.
 124
 125 **DOC_DIRS=(**usr/{,share/}{info,doc} ...**)**::
 126         If "!docs" is specified in the OPTIONS array, this variable will
 127         instruct makepkg where to look to remove docs. If you build packages
 128         that are located in opt/, you may need to add the directory to this
 129         array. *NOTE:* Do not add the leading slash to the directory name.
 130
 131 **PKGDEST=**"/path/to/folder"::
 132         If this value is not set, packages will by default be placed in the
 133         current directory (location of the manlink:PKGBUILD[5]). Many people
 134         like to keep all their packages in one place so this option allows
 135         this behavior. A common location is ``/home/packages''.
 136
 137 **SRCDEST=**"/path/to/folder"::
 138         If this value is not set, downloaded source files will only be stored
 139         in the current directory. Many people like to keep all source files in
 140         a central location for easy cleanup, so this path can be set here.
 141
 142 **PACKAGER=**"John Doe <john@doe.com>"::
 143         This value is used when querying a package to see who was the builder.
 144         It is recommended you change this to your name and email address.
 145
 146 *BUILDSCRIPT*, *PKGEXT*, *SRCEXT*, *DB_COMPRESSION*, *DB_CHECKSUMS*::
 147         Do not touch these unless you know what you are doing.
 148
 149
 150 See Also
 151 --------
 152 manlink:makepkg[8], manlink:pacman[8], manlink:PKGBUILD[5]
 153
 154 include::footer.txt[]