make.conf.5: better examples for ACCEPT_LICENSE
[portage.git] / man / ebuild.1
index 5fa2f8116b819eee788dc13cf0088656e60994a9..600fed3f4b80a7849ed88fca0486047833b1902f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "EBUILD" "1" "Jun 2007" "Portage 2.1.3" "Portage"
+.TH "EBUILD" "1" "Jan 2013" "Portage VERSION" "Portage"
 .SH "NAME"
 ebuild \- a low level interface to the Portage system
 .SH "SYNOPSIS"
@@ -39,8 +39,8 @@ this particular ebuild file.  The temporary build directory normally
 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
@@ -53,13 +53,13 @@ manually clean these files with \fIrm \-rf /var/tmp/portage\fR.
 .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
@@ -93,6 +93,18 @@ often required.  The src_unpack() function is also responsible for
 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
@@ -123,8 +135,8 @@ shown here.
 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.
@@ -138,7 +150,7 @@ particular step doesn't complete successfully.
 .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
@@ -161,9 +173,7 @@ or other similar setups that the user may wish to run.
 .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
@@ -171,11 +181,26 @@ Builds a RedHat RPM package from the files in the temporary
 information is not incorporated into the RPM.
 .SH OPTIONS
 .TP
-\fB--force\fR
+.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"
@@ -187,7 +212,7 @@ Mike Frysinger <vapier@gentoo.org>
 .fi
 .SH "FILES"
 .TP
-.B /etc/make.conf 
+.B /etc/portage/make.conf
 Contains variables for the build\-process and overwrites those
 in make.globals.
 .TP