]> wolfpit.net Git - tool/Arch-pacman/.git/blob - doc/makepkg.8.txt
makepkg.8: fix typo in usage
[tool/Arch-pacman/.git] / doc / makepkg.8.txt
1 /////
2 vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
3 /////
4 makepkg(8)
5 ==========
7 Name
8 ----
9 makepkg - package build utility
12 Synopsis
13 --------
14 'makepkg' [options] [ENVVAR=value] [ENVVAR+=value] ...
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.
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.
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.
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.
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.
48 *-c, \--clean*::
49 Clean up leftover work files and directories after a successful build.
51 *\--config* <file>::
52 Use an alternate config file instead of the +{sysconfdir}/makepkg.conf+
53 default.
55 *-d, \--nodeps*::
56 Do not perform any dependency checks. This will let you override and
57 ignore any dependencies required. There is a good chance this option
58 will break the build process if all of the dependencies are not
59 installed.
61 *-e, \--noextract*::
62 Do not extract source files or run the prepare() function (if present);
63 use whatever source already exists in the $srcdir/ directory. This is
64 handy if you want to go into $srcdir/ and manually patch or tweak code,
65 then make a package out of the result. Keep in mind that creating a
66 patch may be a better solution to allow others to use your PKGBUILD.
68 *\--verifysource*::
69 For each source file in the source array of PKGBUILD, download the file
70 if required and perform the integrity checks. No extraction or build is
71 performed. Useful for performing subsequent offline builds.
73 *-f, \--force*::
74 makepkg will not build a package if a built package already exists in
75 the `PKGDEST` (set in linkman:makepkg.conf[5]) directory, which may
76 default to the current directory. This allows the built package to be
77 overwritten.
79 *-g, \--geninteg*::
80 For each source file in the source array of PKGBUILD, download the file
81 if required and generate integrity checks. The integrity checks generated
82 are determined by the checks present in the PKGBUILD, falling back to the
83 value of the INTEGRITY_CHECK array in makepkg.conf(5) if these are absent
84 This output can be redirected into your PKGBUILD for source validation
85 using "`makepkg -g >> PKGBUILD`".
87 *--skipinteg*::
88 Do not perform any integrity checks (checksum and PGP) on source files.
90 *\--skipchecksums*::
91 Do not verify checksums of source files.
93 *\--skippgpcheck*::
94 Do not verify PGP signatures of source files.
96 *-h, \--help*::
97 Output syntax and command line options.
99 *--holdver*::
100 When using VCS sources (linkman:PKGBUILD[5]) any currently checked out source
101 will not be updated to the latest revision.
103 *-i, \--install*::
104 Install or upgrade the package after a successful build using
105 linkman:pacman[8].
107 *-L, \--log*::
108 Enable makepkg build logging. This will use the *tee* program to send
109 output of the `build()` function to both the console and to a text file in
110 the build directory named `pkgname-pkgver-pkgrel-arch.log`. As mentioned
111 above, the build log will be localized so you may want to set your locale
112 accordingly if sharing the log output with others.
114 *-m, \--nocolor*::
115 Disable color in output messages.
117 *-o, \--nobuild*::
118 Download and extract files, run the prepare() function, but do not build
119 them. Useful with the '\--noextract' option if you wish to tweak the files
120 in $srcdir/ before building.
122 *-p* <buildscript>::
123 Read the package script `buildscript` instead of the `PKGBUILD` default;
124 see linkman:PKGBUILD[5].
126 *-r, \--rmdeps*::
127 Upon successful build, remove any dependencies installed by makepkg
128 during dependency auto-resolution and installation when using `-s`.
130 *-R, \--repackage*::
131 Repackage contents of the package without rebuilding the package. This
132 is useful if you forgot a depend or install file in your PKGBUILD and
133 the build itself will not change.
135 *-s, \--syncdeps*::
136 Install missing dependencies using pacman. When build-time or run-time
137 dependencies are not found, pacman will try to resolve them. If
138 successful, the missing packages will be downloaded and installed.
140 *-S, \--source*::
141 Do not actually build the package, but build a source-only tarball that
142 does not include sources that can be fetched via a download URL. This is
143 useful for passing a single tarball to another program such as a chroot,
144 remote builder, or a tarball upload. Because integrity checks are verified,
145 all source files of the package need to be present or downloadable.
147 *-V, \--version*::
148 Display version information.
150 *\--allsource*::
151 Do not actually build the package, but build a source-only tarball that
152 includes all sources, including those that are normally download via
153 makepkg. This is useful for passing a single tarball to another program
154 such as a chroot or remote builder. It will also satisfy requirements of
155 the GPL when distributing binary packages.
157 *\--pkg* <list>::
158 Only build listed packages from a split package. Multiple packages should
159 be comma separated in the list. This option can be specified multiple times.
161 *\--check*::
162 Run the check() function in the PKGBUILD, overriding the setting in
163 linkman:makepkg.conf[5].
165 *\--nocheck*::
166 Do not run the check() function in the PKGBUILD or handle the checkdepends.
168 *\--noprepare*::
169 Do not run the prepare() function in the PKGBUILD.
171 *\--sign*::
172 Sign the resulting package with gpg, overriding the setting in
173 linkman:makepkg.conf[5].
175 *\--nosign*::
176 Do not create a signature for the built package.
178 *\--key* <key>::
179 Specify a key to use when signing packages, overriding the GPGKEY setting
180 in linkman:makepkg.conf[5]. If not specified in either location, the
181 default key from the keyring will be used.
183 *\--noconfirm*::
184 (Passed to pacman) Prevent pacman from waiting for user input before
185 proceeding with operations.
187 *\--needed*::
188 (Passed to pacman) Tell pacman not to reinstall a target if it is already
189 up to date. (used with -i / --install).
191 *\--asdeps*::
192 (Passed to pacman) Install packages as non-explicitly installed (used
193 with -i / --install).
195 *\--noprogressbar*::
196 (Passed to pacman) Prevent pacman from displaying a progress bar;
197 useful if you are redirecting makepkg output to file.
200 Additional Features
201 -------------------
202 makepkg supports building development versions of packages without having to
203 manually update the pkgver in the PKGBUILD. This was formerly done using the
204 separate utility 'versionpkg'. See linkman:PKGBUILD[5] for details on how to
205 set up a development PKGBUILD.
208 Environment Variables
209 ---------------------
210 *PACMAN*::
211 The command that will be used to check for missing dependencies and to
212 install and remove packages. Pacman's -Qq, -Rns, -S, -T, and -U
213 operations must be supported by this command. If the variable is not
214 set or empty, makepkg will fall back to `pacman'.
216 **PKGDEST=**"/path/to/folder"::
217 Folder where the resulting packages will be stored. Overrides the
218 corresponding value defined in linkman:makepkg.conf[5].
220 **SRCDEST=**"/path/to/folder"::
221 Folder where the downloaded sources will be stored. Overrides the
222 corresponding value defined in linkman:makepkg.conf[5].
224 **PACKAGER=**"John Doe <john@doe.com>"::
225 String to identify the creator of the resulting package. Overrides
226 the corresponding value defined in linkman:makepkg.conf[5].
228 **BUILDDIR=**"/path/to/folder"::
229 Folder where the package will be built. Overrides the corresponding
230 value defined in linkman:makepkg.conf[5].
232 **CARCH=**"(i686|x86_64)"::
233 Force build for a specific architecture. Useful for cross-compiling.
234 Overrides the corresponding value defined in linkman:makepkg.conf[5].
236 Configuration
237 -------------
238 See linkman:makepkg.conf[5] for more details on configuring makepkg using the
239 'makepkg.conf' file.
242 See Also
243 --------
244 linkman:makepkg.conf[5], linkman:PKGBUILD[5], linkman:pacman[8]
246 include::footer.txt[]