-.TH "EBUILD" "1" "Dec 2005" "Portage 2.1" "Portage"
+.TH "EBUILD" "1" "Jan 2013" "Portage VERSION" "Portage"
.SH "NAME"
ebuild \- a low level interface to the Portage system
.SH "SYNOPSIS"
This must be a valid ebuild script. For further information read
\fBebuild\fR(5).
.SH "COMMANDS"
+By default, portage will execute all the functions in order up to the
+one actually specified. For example, simply issuing the command \fBcompile\fR
+will trigger the functions before it to also be run (such as \fBsetup\fR
+and \fBunpack\fR). If you wish to only have the specified command run, then
+you should use the \fInoauto\fR option in the \fBFEATURES\fR environment
+variable. See the \fBmake.conf\fR(5) man page for more information.
+
.TP
.BR help
Shows a condensed form of this man page along with a lot of package
contains the extracted source files as well as a possible
"install image" (all the files that will be merged to the local
filesystem or stored in a package). The location of the build
-directory is set by the BUILD_PREFIX variable. For information
-on what this variable is, run \fIemerge [\-v] info\fR, or to override
+directory is set by the PORTAGE_TMPDIR variable. For information
+on what this variable is, run \fIemerge \-\-info\fR, or to override
this variable, see \fBmake.conf\fR(5).
Note: Portage cleans up almost everything after a package has been
.BR fetch
Checks to see if all the sources specified in SRC_URI are available in
DISTDIR (see \fBmake.conf\fR(5) for more information) and have a valid
-md5 checksum. If the sources aren't available, an attempt is made to
+checksum. If the sources aren't available, an attempt is made to
download them from the locations specified in SRC_URI. If multiple
download locations are listed for a particular file, Portage pings
each location to see which location is closer. (May not be true
presently.) The Gentoo Linux mirrors defined by GENTOO_MIRRORS is
always considered first. If for some reason the current or
-just\-downloaded sources' md5 digests don't match those recorded
+just\-downloaded sources' checksums don't match those recorded
in files/digest\-[package]\-[version\-rev], a warning is printed
and ebuild exits with an error code of 1.
.TP
.BR digest
-Creates a digest file for the package in
-/usr/portage/[category]/[package]/files/. This digest file lists the
-md5sums of all the files found in the SRC_URI. If the fetched source
-of the package is corrupt/bogus in some way, the md5sum will catch this.
+This is now equivalent to the \fImanifest\fR command.
.TP
.BR manifest
-Updates the manifest file for the package. This performs the second half
-of the digest command, creating md5sums for the files in the files
-directory as well as the ebuild.
+Updates the manifest file for the package. This creates checksums for all
+of the files found in the same directory as the current ebuild as well as
+the recursive contents of the files subdirectory. It also creates checksums
+for all of the files listed in SRC_URI for each ebuild. For further
+information regarding the behavior of this command, see the documentation for
+the \fIassume\-digests\fR value of the \fBFEATURES\fR variable in
+\fBmake.conf\fR(5). See the \fB\-\-force\fR option if you would like to
+prevent digests from being assumed.
.TP
.BR unpack
Extracts the sources to a subdirectory in the \fIbuild directory\fR
making the appropriate patches to the sources so that they're ready
for compilation.
.TP
+.BR prepare
+Prepares the extracted sources by running the \fIsrc_prepare()\fR
+function specified in the ebuild file. When src_prepare() starts, the
+current working directory will be set to ${S}. This function is supported
+beginning with \fBEAPI 2\fR.
+.TP
+.BR configure
+Configures the extracted sources by running the \fIsrc_configure()\fR
+function specified in the ebuild file. When src_configure() starts, the
+current working directory will be set to ${S}. This function is supported
+beginning with \fBEAPI 2\fR.
+.TP
.BR compile
Compiles the extracted sources by running the \fIsrc_compile()\fR
function specified in the ebuild file. When src_compile() starts, the
This function installs all the files in the \fIinstall directory\fR
to the live filesystem. The process works as follows: first, the
\fIpkg_preinst()\fR function (if specified) is run. Then, the files
-are merged into the live filesystem, and the installed files' md5
-digests are recorded in
+are merged into the live filesystem, and the installed files'
+checksums are recorded in
\fI/var/db/pkg/${CATEGORY}/${PN}\-${PVR}/CONTENTS\fR. After
all the files have been merged, the \fIpkg_postinst()\fR function
(if specified) is executed.
.TP
.BR unmerge
This function first executes the \fIpkg_prerm()\fR function (if specified).
-Then it removes all files from the live filesystem that have a valid md5
+Then it removes all files from the live filesystem that have a valid
checksum and mtime in the package contents file. Any empty directories
are recursively removed. Finally, it runs \fIpkg_postrm()\fR function (if
specified). It is safe to merge a new version of a package first and
.BR package
This command is a lot like the \fImerge\fR command, except that after
fetching, unpacking, compiling and installing, a .tbz2 binary package
-tarball is created and stored in ${PKGDIR}/All (${PKGDIR} defaults to
-/usr/portage/packages). A symbolic link is created in
-${PKGDIR}/${CATEGORY} that points to the package in ${PKGDIR}/All.
+tarball is created and stored in \fBPKGDIR\fR (see \fBmake.conf\fR(5)).
.TP
.BR rpm
Builds a RedHat RPM package from the files in the temporary
\fIinstall directory\fR. At the moment, the ebuild's dependency
information is not incorporated into the RPM.
+.SH OPTIONS
+.TP
+.BR "\-\-debug"
+Run bash with the \-x option, causing it to output verbose debugging
+information to stdout.
+.TP
+.BR "\-\-color < y | n >"
+Enable or disable color output. This option will override \fINOCOLOR\fR
+(see \fBmake.conf\fR(5)) and may also be used to force color output when stdout
+is not a tty (by default, color is disabled unless stdout is a tty).
+.TP
+.BR "\-\-force"
+When used together with the digest or manifest command,
+this option forces regeneration of
+digests for all distfiles associated with the current ebuild. Any distfiles
+that do not already exist in ${DISTDIR} will be automatically fetched.
+.TP
+.BR "\-\-ignore\-default\-opts"
+Do not use the \fIEBUILD_DEFAULT_OPTS\fR environment variable.
+.TP
+.BR "\-\-skip\-manifest"
+Skip all manifest checks.
.SH "REPORTING BUGS"
Please report bugs via http://bugs.gentoo.org/
.SH "AUTHORS"
.fi
.SH "FILES"
.TP
-\fB/etc/make.conf\fR
+.B /etc/portage/make.conf
Contains variables for the build\-process and overwrites those
in make.globals.
+.TP
+.B /etc/portage/color.map
+Contains variables customizing colors.
.SH "SEE ALSO"
.BR emerge (1),
.BR ebuild (5),
-.BR make.conf (5)
+.BR make.conf (5),
+.BR color.map (5)
.TP
The \fI/usr/sbin/ebuild.sh\fR script.
.TP
projects / portage.git / blobdiff