summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorMike Frysinger <vapier@gentoo.org>2006-08-07 23:53:36 +0000
committerMike Frysinger <vapier@gentoo.org>2006-08-07 23:53:36 +0000
commit43dc33c77e1c842bebb27fb427777b5e7897db91 (patch)
treeb541210f1663825b03aee10090cb5733bc8fbca9 /man
parentWhen performing expansion of USE_EXPAND variables, display warnings about inv... (diff)
downloadportage-idfetch-43dc33c77e1c842bebb27fb427777b5e7897db91.tar.gz
portage-idfetch-43dc33c77e1c842bebb27fb427777b5e7897db91.tar.bz2
portage-idfetch-43dc33c77e1c842bebb27fb427777b5e7897db91.zip
fixups from Benno Schulenberg #143079
svn path=/main/trunk/; revision=4189
Diffstat (limited to 'man')
-rw-r--r--man/ebuild.160
1 files changed, 29 insertions, 31 deletions
diff --git a/man/ebuild.1 b/man/ebuild.1
index d056b258..cdac99e3 100644
--- a/man/ebuild.1
+++ b/man/ebuild.1
@@ -1,7 +1,6 @@
.TH "EBUILD" "1" "Dec 2005" "Portage 2.1" "Portage"
.SH "NAME"
-ebuild \- manual page for the ebuild program, a low level interface to
-the Portage system.
+ebuild \- a low level interface to the Portage system
.SH "SYNOPSIS"
.B ebuild
.I file command [command]\fR...
@@ -9,9 +8,9 @@ the Portage system.
The ebuild program is a direct interface to the Portage system. It
allows for direct action upon an ebuild with specific subcommands or
groups of commands to perform in a specific ebuild's context and
-functions. Accepting an ebuild script and one or more commands
+functions. Accepting an ebuild script and one or more commands
as arguments, the ebuild program parses the ebuild script and
-execute the specified commands. Commands exist to fetch sources,
+executes the specified commands. Commands exist to fetch sources,
unpack sources, compile sources, install object files into a temporary
directory "image", merge the image to the local filesystem, create a
bzipped tarball package out of the image, and more.
@@ -21,11 +20,11 @@ This must be a valid ebuild script. For further information read
.SH "COMMANDS"
.TP
.BR help
-Show a condensed form of the man page along with a lot of package
+Shows a condensed form of this man page along with a lot of package
specific information.
.TP
.BR setup
-Run all package specific setup actions and exotic system checks.
+Runs all package-specific setup actions and exotic system checks.
.TP
.BR clean
Cleans the temporary build directory that Portage has created for
@@ -38,12 +37,11 @@ on what this variable is, run \fIemerge [\-v] info\fR, or to override
this variable, see \fBmake.conf\fR(5).
Note: Portage cleans up almost everything after a package has been
-successfully merged unless FEATURES contains 'noclean'. Adding noclean
+successfully merged unless FEATURES contains 'noclean'. Adding noclean
to FEATURES will cause a lot of files to remain and will consume large
-amounts of space, very quickly. It is not recommended to leave this on
-unless you have use for the sources post\-merge. Optionally one may,
-manual clean \fIrm \-rf /var/tmp/portage\fR will take care of all
-of these files.
+amounts of space, very quickly. It is not recommended to leave this on,
+unless you have use for the sources post\-merge. Optionally, one may
+manually clean these files with \fIrm \-rf /var/tmp/portage\fR.
.TP
.BR fetch
Checks to see if all the sources specified in SRC_URI are available in
@@ -53,15 +51,15 @@ 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
+always considered first. If for some reason the current or
just\-downloaded sources' md5 digests 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
-md5sum's of all the files found in the SRC_URI. If the fetched source
+/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.
.TP
.BR manifest
@@ -75,29 +73,29 @@ Extracts the sources to a subdirectory in the \fIbuild directory\fR
file. If no src_unpack() function has been specified, a default
src_unpack() function is used that extracts all the files specified in
SRC_URI. The sources are normally extracted to
-${BUILD_PREFIX}/[package]\-[version\-rev]/work. This particular directory
+${BUILD_PREFIX}/[package]\-[version\-rev]/work. This particular directory
can be referenced by using the ${WORKDIR} variable.
If you're creating an ebuild, you'll want to make sure that the S
-(source directory) variable defined at at the top of your ebuild script
-points to the directory that contains your extracted sources. This
+(source directory) variable defined at the top of your ebuild script
+points to the directory that contains your extracted sources. This
directory is defined by default to be ${WORKDIR}/${P}, so it is not
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 compile
-Compiles the extracted sources by running the the \fIsrc_compile()\fR
+Compiles the extracted sources by running the \fIsrc_compile()\fR
function specified in the ebuild file. When src_compile() starts, the
current working directory will be set to ${S}. When src_compile()
completes, the sources should be fully compiled.
.TP
.BR test
-Run package specific test cases to verify that everything was built
+Runs package-specific test cases to verify that everything was built
properly.
.TP
.BR preinst
-Run package specific actions that need to be done before the package
+Runs package-specific actions that need to be done before the package
is installed into the live filesystem.
.TP
.BR install
@@ -105,16 +103,16 @@ Installs the package to the temporary \fIinstall directory\fR by running
the \fIsrc_install()\fR function. When completed, the
\fIinstall directory\fR (${BUILD_PREFIX}/[package]\-[version\-rev]/image)
will contain all the files that should either be merged to the local
-file system or included in a binary package.
+filesystem or included in a binary package.
.TP
.BR postinst
-Run package specific actions that need to be done after the package
+Runs package-specific actions that need to be done after the package
is installed into the live filesystem. Usually helpful messages are
shown here.
.TP
.BR qmerge
This function installs all the files in the \fIinstall directory\fR
-to the live filesystem. The process works as follows: first, the
+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
@@ -130,26 +128,26 @@ will perform all these steps for you, stopping along the way if a
particular step doesn't complete successfully.
.TP
.BR unmerge
-This function first executes the \fIpkg_prerm\fR function (if specified).
+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
checksum and mtime in the package contents file. Any empty directories
-are recursively removed. Finally, it runs \fIpkg_postrm\fR function (if
+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
then unmerge the old one. In fact, this is the recommended package
upgrade method.
.TP
.BR prerm
-Run package specific actions that need to be executed before the package is
+Runs package-specific actions that need to be executed before the package is
removed from the filesystem. See also \fIunmerge\fR.
.TP
.BR postrm
-Run package specific actions that need to be executed after the package is
+Runs package-specific actions that need to be executed after the package is
removed from the filesystem. See also \fIunmerge\fR.
.TP
.BR config
-Run package specific actions needed to be executed after the emerge
-process has completed. This usually entails configuration file
-setup or other similar setups that the user may wish to run.
+Runs package-specific actions that need to be executed after the emerge
+process has completed. This usually entails setup of configuration files
+or other similar setups that the user may wish to run.
.TP
.BR package
This command is a lot like the \fImerge\fR command, except that after
@@ -160,7 +158,7 @@ ${PKGDIR}/${CATEGORY} that points to the package in ${PKGDIR}/All.
.TP
.BR rpm
Builds a RedHat RPM package from the files in the temporary
-\fIinstall directory\fR. At the moment, the ebuild's dependency
+\fIinstall directory\fR. At the moment, the ebuild's dependency
information is not incorporated into the RPM.
.SH "REPORTING BUGS"
Please report bugs via http://bugs.gentoo.org/