]>
Commit | Line | Data |
---|---|---|
e412ac19 DM |
1 | ///// |
2 | vim:set ts=4 sw=4 syntax=asciidoc noet: | |
3 | ///// | |
be0a472c AF |
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 | ----------- | |
889fccd5 DM |
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 | |
b3c6bdda | 22 | linkman:PKGBUILD[5] for details on creating your own build scripts. |
be0a472c AF |
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 | |
c9189f54 DM |
28 | customizations, generate meta-info, and package the whole thing up for pacman |
29 | to use. | |
be0a472c | 30 | |
a7a9f375 DM |
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 | ||
be0a472c AF |
36 | Options |
37 | ------- | |
e93b0a2f DM |
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 | ||
c9189f54 DM |
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 | |
e37ecbe8 | 46 | outdated and not updated with an `arch=('yourarch')` field. |
c9189f54 | 47 | |
c9189f54 | 48 | *-c, \--clean*:: |
be0a472c AF |
49 | Clean up leftover work files and directories after a successful build. |
50 | ||
c9189f54 | 51 | *-C, \--cleancache*:: |
c2603924 | 52 | Removes all cached source files from the directory specified in `SRCDEST` |
b3c6bdda | 53 | in linkman:makepkg.conf[5]. |
be0a472c | 54 | |
4b183bf9 | 55 | *--config* <`/path/to/config`>:: |
05f0a289 | 56 | Use an alternate config file instead of the `{sysconfdir}/makepkg.conf` default; |
4b183bf9 | 57 | |
c9189f54 | 58 | *-d, \--nodeps*:: |
be0a472c AF |
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 | ||
c9189f54 | 64 | *-e, \--noextract*:: |
be0a472c | 65 | Do not extract source files; use whatever source already exists in the |
aea45a8b | 66 | src/ directory. This is handy if you want to go into src/ and manually |
be0a472c AF |
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 | ||
c9189f54 | 71 | *-f, \--force*:: |
be0a472c | 72 | makepkg will not build a package if a built package already exists in |
c2603924 | 73 | the `PKGDEST` (set in linkman:makepkg.conf[5]) directory, which may |
be0a472c AF |
74 | default to the current directory. This allows the built package to be |
75 | overwritten. | |
76 | ||
11692e0e | 77 | *--forcever*:: |
e93b0a2f DM |
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 | ||
c9189f54 | 82 | *-g, \--geninteg*:: |
be0a472c | 83 | For each source file in the source array of PKGBUILD, download the file |
79987c92 XC |
84 | if required and generate integrity checks. The integrity checks generated |
85 | are determined by the checks present in the PKGBUILD, falling back to the | |
86 | value of the INTEGRITY_CHECK array in makepkg.conf(5) if these are absent | |
87 | This output can be redirected into your PKGBUILD for source validation | |
88 | using "`makepkg -g >> PKGBUILD`". | |
be0a472c | 89 | |
82522dd8 | 90 | *--skipinteg*:: |
2ce444ee | 91 | Do not perform any integrity checks, just print a warning instead. |
82522dd8 | 92 | |
c9189f54 | 93 | *-h, \--help*:: |
be0a472c AF |
94 | Output syntax and command line options. |
95 | ||
e93b0a2f DM |
96 | *\--holdver*:: |
97 | Useful when building development versions of packages. Prevents makepkg | |
98 | from automatically bumping the pkgver to the latest revision number in | |
99 | the package's development tree. | |
100 | ||
c9189f54 DM |
101 | *-i, \--install*:: |
102 | Install or upgrade the package after a successful build using | |
b3c6bdda | 103 | linkman:pacman[8]. |
be0a472c | 104 | |
a7a9f375 DM |
105 | *-L, \--log*:: |
106 | Enable makepkg build logging. This will use the *tee* program to send | |
107 | output of the `build()` function to both the console and to a text file in | |
108 | the build directory named `pkgname-pkgver-pkgrel-arch.log`. As mentioned | |
109 | above, the build log will be localized so you may want to set your locale | |
110 | accordingly if sharing the log output with others. | |
111 | ||
c9189f54 | 112 | *-m, \--nocolor*:: |
be0a472c AF |
113 | Disable color in output messages. |
114 | ||
c9189f54 | 115 | *-o, \--nobuild*:: |
be0a472c | 116 | Download and extract files only, but do not build them. Useful with the |
c9189f54 | 117 | `\--noextract` option if you wish to tweak the files in src/ before |
be0a472c AF |
118 | building. |
119 | ||
c9189f54 | 120 | *-p* <`buildscript`>:: |
aea45a8b | 121 | Read the package script `buildscript` instead of the `PKGBUILD` default; |
b3c6bdda | 122 | see linkman:PKGBUILD[5]. |
be0a472c | 123 | |
c9189f54 | 124 | *-r, \--rmdeps*:: |
be0a472c | 125 | Upon successful build, remove any dependencies installed by makepkg |
89b0a76b | 126 | during dependency auto-resolution and installation when using `-s`. |
be0a472c | 127 | |
c9189f54 | 128 | *-R, \--repackage*:: |
5e32928a AM |
129 | Repackage contents of the package without rebuilding the package. This |
130 | is useful if you forgot a depend or install file in your PKGBUILD and | |
131 | the build itself will not change. | |
be0a472c | 132 | |
c9189f54 | 133 | *-s, \--syncdeps*:: |
aea45a8b SH |
134 | Install missing dependencies using pacman. When build-time or run-time |
135 | dependencies are not found, pacman will try to resolve them. If | |
be0a472c AF |
136 | successful, the missing packages will be downloaded and installed. |
137 | ||
692ea728 DM |
138 | *\--allsource*:: |
139 | Do not actually build the package, but build a source-only tarball that | |
140 | includes all sources, including those that are normally download via | |
141 | makepkg. This is useful for passing a single tarball to another program | |
142 | such as a chroot or remote builder. It will also satisfy requirements of | |
143 | the GPL when distributing binary packages. | |
144 | ||
c9189f54 | 145 | *\--source*:: |
692ea728 DM |
146 | Do not actually build the package, but build a source-only tarball that |
147 | does not include sources that can be fetched via a download URL. This is | |
148 | useful for passing a single tarball to another program such as a chroot, | |
814cd7ae XC |
149 | remote builder, or a tarball upload. Because integrity checks are verified, |
150 | all source files of the package need to be present or downloadable. | |
c9189f54 | 151 | |
f2c9e51e AM |
152 | *\--pkg <`list`>*:: |
153 | Only build listed packages from a split package. The use of quotes is | |
154 | necessary when specifying multiple packages. e.g. `--pkg "pkg1 pkg3"` | |
155 | ||
0c29eb43 AM |
156 | *\--check*:: |
157 | Run the check() function in the PKGBUILD, overriding the setting in | |
158 | linkman:makepkg.conf[5]. | |
159 | ||
160 | *\--nocheck*:: | |
161 | Do not run the check() function in the PKGBUILD or handle the checkdepends. | |
162 | ||
c9189f54 | 163 | *\--noconfirm*:: |
be0a472c AF |
164 | (Passed to pacman) Prevent pacman from waiting for user input before |
165 | proceeding with operations. | |
166 | ||
c9189f54 | 167 | *\--noprogressbar*:: |
be0a472c AF |
168 | (Passed to pacman) Prevent pacman from displaying a progress bar; |
169 | useful if you are redirecting makepkg output to file. | |
170 | ||
171 | ||
aea45a8b SH |
172 | Additional Features |
173 | ------------------- | |
174 | makepkg supports building development versions of packages without having to | |
175 | manually update the pkgver in the PKGBUILD. This was formerly done using the | |
b3c6bdda | 176 | separate utility 'versionpkg'. See linkman:PKGBUILD[5] for details on how to |
aea45a8b SH |
177 | set up a development PKGBUILD. |
178 | ||
179 | ||
66c6d288 CS |
180 | Environment Variables |
181 | --------------------- | |
182 | *PACMAN*:: | |
183 | The command that will be used to check for missing dependencies and to | |
ccbef232 AM |
184 | install and remove packages. Pacman's -Qq, -Rns, -S, -T, and -U |
185 | operations must be supported by this command. If the variable is not | |
186 | set or empty, makepkg will fall back to `pacman'. | |
66c6d288 | 187 | |
eee61a0b CS |
188 | **PKGDEST=**"/path/to/folder":: |
189 | Folder where the resulting packages will be stored. Overrides the | |
190 | corresponding value defined in linkman:makepkg.conf[5]. | |
191 | ||
192 | **SRCDEST=**"/path/to/folder":: | |
193 | Folder where the downloaded sources will be stored. Overrides the | |
194 | corresponding value defined in linkman:makepkg.conf[5]. | |
195 | ||
66c6d288 | 196 | |
be0a472c AF |
197 | Configuration |
198 | ------------- | |
b3c6bdda | 199 | See linkman:makepkg.conf[5] for more details on configuring makepkg using the |
c9189f54 | 200 | 'makepkg.conf' file. |
be0a472c AF |
201 | |
202 | ||
203 | See Also | |
204 | -------- | |
b3c6bdda | 205 | linkman:makepkg.conf[5], linkman:PKGBUILD[5], linkman:pacman[8] |
be0a472c AF |
206 | |
207 | include::footer.txt[] |