diff options
author | Achim Gottinger <achim@gentoo.org> | 2001-03-21 07:45:09 +0000 |
---|---|---|
committer | Achim Gottinger <achim@gentoo.org> | 2001-03-21 07:45:09 +0000 |
commit | e1322650c57caaebd61079acafd45efd6203d716 (patch) | |
tree | 4897967a3b3fcd7e1c2f3ddaea110e2c0beb36a7 /app-doc/gentoo-doc | |
parent | *** empty log message *** (diff) | |
download | gentoo-2-e1322650c57caaebd61079acafd45efd6203d716.tar.gz gentoo-2-e1322650c57caaebd61079acafd45efd6203d716.tar.bz2 gentoo-2-e1322650c57caaebd61079acafd45efd6203d716.zip |
*** empty log message ***
Diffstat (limited to 'app-doc/gentoo-doc')
-rw-r--r-- | app-doc/gentoo-doc/files/ebuild.sgml | 426 | ||||
-rwxr-xr-x | app-doc/gentoo-doc/files/install.docbook | 6 | ||||
-rw-r--r-- | app-doc/gentoo-doc/files/refentry/ebuild-1.sgml | 273 | ||||
-rw-r--r-- | app-doc/gentoo-doc/files/refentry/ebuild-5.sgml | 25 |
4 files changed, 725 insertions, 5 deletions
diff --git a/app-doc/gentoo-doc/files/ebuild.sgml b/app-doc/gentoo-doc/files/ebuild.sgml new file mode 100644 index 000000000000..9b9f3288ad43 --- /dev/null +++ b/app-doc/gentoo-doc/files/ebuild.sgml @@ -0,0 +1,426 @@ +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ + <!ENTITY ebuild1 SYSTEM "refentry/ebuild-1.sgml"> + <!ENTITY ebuild5 SYSTEM "refentry/ebuild-5.sgml"> +]> + +<book id="ebuild"> + <bookinfo> + <title>The Ebuild System</title> + <pubdate>21 March 2001</pubdate> + <legalnotice> + <para>Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation License, + Version 1.1 or any later version published by the Free Software + Foundation. A copy of the license is included in the section + entitled "GNU Free Documentation License".</para> + </legalnotice> + + <abstract> + <para>This documentation describes the ebuild system version 1.4</para> </abstract> + + <authorgroup> + <author> + <firstname>Daniel</firstname><surname>Robbins</surname> + <affiliation> + <address><email>drobbins@gentoo.org</email></address> + </affiliation> + </author> + <author> + <firstname>Achim</firstname><surname>Gottinger</surname> + <affiliation> + <address><email>achim@gentoo.org</email></address> + </affiliation> + </author> + </authorgroup> + + </bookinfo> + <chapter id="introduction"> + <title>Introduction</title> + <para>TODO</para> + </chapter> + <chapter id="Commands"> + <title>Command Reference</title> + <sect1> + <title>ebuild</title> + <para><citerefentry> <refentrytitle>ebuild</refentrytitle> + <manvolnum>1</manvolnum> </citerefentry></para> + +&ebuild1; + + </sect1> + <sect1> + <title>ebuild helper apps</title> + <para><citerefentry> <refentrytitle>ebuild</refentrytitle> + <manvolnum>5</manvolnum> </citerefentry></para> + +&ebuild5; + + </sect1> + + </chapter> + <chapter id="fdl"> + <title>GNU Free Documentation License</title> + + <para> + <literallayout> + GNU Free Documentation License + Version 1.1, March 2000 + + Copyright (C) 2000 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + +0. PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +written document "free" in the sense of freedom: to assure everyone +the effective freedom to copy and redistribute it, with or without +modifying it, either commercially or noncommercially. Secondarily, +this License preserves for the author and publisher a way to get +credit for their work, while not being considered responsible for +modifications made by others. + +This License is a kind of "copyleft", which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + + +1. APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work that contains a +notice placed by the copyright holder saying it can be distributed +under the terms of this License. The "Document", below, refers to any +such manual or work. Any member of the public is a licensee, and is +addressed as "you". + +A "Modified Version" of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A "Secondary Section" is a named appendix or a front-matter section of +the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall subject +(or to related matters) and contains nothing that could fall directly +within that overall subject. (For example, if the Document is in part a +textbook of mathematics, a Secondary Section may not explain any +mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The "Invariant Sections" are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. + +The "Cover Texts" are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. + +A "Transparent" copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, whose contents can be viewed and edited directly and +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup has been designed to thwart or discourage +subsequent modification by readers is not Transparent. A copy that is +not "Transparent" is called "Opaque". + +Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, LaTeX input format, SGML +or XML using a publicly available DTD, and standard-conforming simple +HTML designed for human modification. Opaque formats include +PostScript, PDF, proprietary formats that can be read and edited only +by proprietary word processors, SGML or XML for which the DTD and/or +processing tools are not generally available, and the +machine-generated HTML produced by some word processors for output +purposes only. + +The "Title Page" means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, "Title Page" means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + + +2. VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + + +3. COPYING IN QUANTITY + +If you publish printed copies of the Document numbering more than 100, +and the Document's license notice requires Cover Texts, you must enclose +the copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a publicly-accessible computer-network location containing a complete +Transparent copy of the Document, free of added material, which the +general network-using public has access to download anonymously at no +charge using public-standard network protocols. If you use the latter +option, you must take reasonably prudent steps, when you begin +distribution of Opaque copies in quantity, to ensure that this +Transparent copy will remain thus accessible at the stated location +until at least one year after the last time you distribute an Opaque +copy (directly or through your agents or retailers) of that edition to +the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. + + +4. MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +A. Use in the Title Page (and on the covers, if any) a title distinct + from that of the Document, and from those of previous versions + (which should, if there were any, be listed in the History section + of the Document). You may use the same title as a previous version + if the original publisher of that version gives permission. +B. List on the Title Page, as authors, one or more persons or entities + responsible for authorship of the modifications in the Modified + Version, together with at least five of the principal authors of the + Document (all of its principal authors, if it has less than five). +C. State on the Title page the name of the publisher of the + Modified Version, as the publisher. +D. Preserve all the copyright notices of the Document. +E. Add an appropriate copyright notice for your modifications + adjacent to the other copyright notices. +F. Include, immediately after the copyright notices, a license notice + giving the public permission to use the Modified Version under the + terms of this License, in the form shown in the Addendum below. +G. Preserve in that license notice the full lists of Invariant Sections + and required Cover Texts given in the Document's license notice. +H. Include an unaltered copy of this License. +I. Preserve the section entitled "History", and its title, and add to + it an item stating at least the title, year, new authors, and + publisher of the Modified Version as given on the Title Page. If + there is no section entitled "History" in the Document, create one + stating the title, year, authors, and publisher of the Document as + given on its Title Page, then add an item describing the Modified + Version as stated in the previous sentence. +J. Preserve the network location, if any, given in the Document for + public access to a Transparent copy of the Document, and likewise + the network locations given in the Document for previous versions + it was based on. These may be placed in the "History" section. + You may omit a network location for a work that was published at + least four years before the Document itself, or if the original + publisher of the version it refers to gives permission. +K. In any section entitled "Acknowledgements" or "Dedications", + preserve the section's title, and preserve in the section all the + substance and tone of each of the contributor acknowledgements + and/or dedications given therein. +L. Preserve all the Invariant Sections of the Document, + unaltered in their text and in their titles. Section numbers + or the equivalent are not considered part of the section titles. +M. Delete any section entitled "Endorsements". Such a section + may not be included in the Modified Version. +N. Do not retitle any existing section as "Endorsements" + or to conflict in title with any Invariant Section. + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section entitled "Endorsements", provided it contains +nothing but endorsements of your Modified Version by various +parties--for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + + +5. COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections entitled "History" +in the various original documents, forming one section entitled +"History"; likewise combine any sections entitled "Acknowledgements", +and any sections entitled "Dedications". You must delete all sections +entitled "Endorsements." + + +6. COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. + +You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. + + + +7. AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, does not as a whole count as a Modified Version +of the Document, provided no compilation copyright is claimed for the +compilation. Such a compilation is called an "aggregate", and this +License does not apply to the other self-contained works thus compiled +with the Document, on account of their being thus compiled, if they +are not themselves derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one quarter +of the entire aggregate, the Document's Cover Texts may be placed on +covers that surround only the Document within the aggregate. +Otherwise they must appear on covers around the whole aggregate. + + +8. TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License provided that you also include the +original English version of this License. In case of a disagreement +between the translation and the original English version of this +License, the original English version will prevail. + + +9. TERMINATION + +You may not copy, modify, sublicense, or distribute the Document except +as expressly provided for under this License. Any other attempt to +copy, modify, sublicense or distribute the Document is void, and will +automatically terminate your rights under this License. However, +parties who have received copies, or rights, from you under this +License will not have their licenses terminated so long as such +parties remain in full compliance. + + +10. FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +http:///www.gnu.org/copyleft/. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. + + +ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + + Copyright (c) YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.1 + or any later version published by the Free Software Foundation; + with the Invariant Sections being LIST THEIR TITLES, with the + Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. + A copy of the license is included in the section entitled "GNU + Free Documentation License". + +If you have no Invariant Sections, write "with no Invariant Sections" +instead of saying which ones are invariant. If you have no +Front-Cover Texts, write "no Front-Cover Texts" instead of +"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. + + </literallayout> + </para> + </chapter> +</book>
\ No newline at end of file diff --git a/app-doc/gentoo-doc/files/install.docbook b/app-doc/gentoo-doc/files/install.docbook index dbe32b8febaf..e7864a31cc45 100755 --- a/app-doc/gentoo-doc/files/install.docbook +++ b/app-doc/gentoo-doc/files/install.docbook @@ -1,8 +1,4 @@ -<?xml version="1.0" encoding="utf-8"?> -<!DOCTYPE article - PUBLIC "-//Norman Walsh//DTD Simplified DocBk XML V4.1.2.4//EN" - "/usr/share/sgml/docbook/simplified/4.1.2.4/sdocbook.dtd"> - +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <article> diff --git a/app-doc/gentoo-doc/files/refentry/ebuild-1.sgml b/app-doc/gentoo-doc/files/refentry/ebuild-1.sgml new file mode 100644 index 000000000000..adfcd3e44ef4 --- /dev/null +++ b/app-doc/gentoo-doc/files/refentry/ebuild-1.sgml @@ -0,0 +1,273 @@ +<refentry id="ebuild.1"> + + <refmeta> + <refentrytitle><application>ebuild</application></refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo>ebuild 1.4</refmiscinfo> + </refmeta> + + <refnamediv> + <refname><application>ebuild</application></refname> + <refpurpose>manual page for the ebuild program, the main user interface to the Portage system</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>ebuild</command> + <arg choice="req"><replaceable class="parameter">file</replaceable></arg> + <arg rep="repeat"><replaceable class="parameter">command</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>DESCRIPTION</title> + <para> + The <command>ebuild</command> program is the heart of the current + implementation of the Portage system. Accepting an ebuild script + and one or more commands as arguments, the ebuild program will parse + the ebuild script and execute 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. + </para> + </refsect1> + + <refsect1> + <title>OPTIONS</title> + <variablelist> + <varlistentry> + <term><replaceable class="parameter">file</replaceable></term> + <listitem> + <para> + This must be a valid ebuild script. For further information + read ebuild(5). + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>COMMANDS</title> + <variablelist> + + <varlistentry> + <term><replaceable class="parameter">check</replaceable></term> + <listitem> + <para> + Checks to see if all build dependencies are satisfied. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">clean</replaceable></term> + <listitem> + <para> + Cleans the temporary build directory that Portage + has created for 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 + <envar>BUILD_PREFIX</envar> variable in + <filename>/etc/make.defaults</filename> (it + defaults to <filename>/tmp/portage</filename>). + If you'd like to override the <envar>BUILD_PREFIX</envar>, add + the appropriate line to <filename>/etc/make.conf</filename> + (where all your particular customizations are supposed to go.) + </para> + <note><para> + Currently, Portage doesn't clean up after a + package has been created or merged. This means that + the <envar>BUILD_PREFIX</envar> directory will accumulate lots of + things you probably don't want and should be manually + cleaned regularly (<command>rm -rf /tmp/portage/*</command> + will take care of this). As Portage matures, a + <filename>make.conf</filename> option will be added + that will allow you to control whether <envar>BUILD_PREFIX</envar> + gets cleaned automatically or gets left as is. + </para></note> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">fetch</replaceable></term> + <listitem> + <para> + Checks to see if all the sources specified in <envar>SRC_URI</envar> + are available in <envar>DISTDIR</envar> (defined in <filename>/etc/make.defaults</filename> + as <filename>/usr/portage/distfiles</filename>) and have a valid md5 checksum. + If the sources aren't available, an attempt is made to download them + from the locations specified in <envar>SRC_URI</envar>. If multiple download locations + are listed for a particular file, Portage pings each location to see + which location is closer. The Gentoo Linux mirror at + <ulink url="ftp://ftp.ibiblio.org"></ulink> + is always considered as a possible download location. If for some + reason the current or just-downloaded sources' md5 digests don't + match those recorded in <filename>files/digest-[package]-[version-rev]</filename>, + a warning is printed and ebuild exits with an error code of 1. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">unpack</replaceable></term> + <listitem> + <para> + Extracts the sources to a subdirectory in the build directory (<envar>BUILD_PREFIX</envar>) + by running the <function>src_unpack()</function> function in the ebuild file. If no <function>src_unpack()</function> + function has been specified, a default <function>src_unpack()</function> function is used that extracts + all the files specified in <envar>SRC_URI</envar>. The sources are normally extracted to + <filename>${BUILD_PREFIX}/[package]-[version-rev]/work</filename>. This particular directory can be + referenced by using the <envar>WORKDIR</envar> variable. If you're creating an ebuild, you'll want + to make sure that the <envar>S</envar> (source directory) variable defined at at the top of your + ebuild script points to the directory that contains your extracted sources. Normally, this directory + is <filename>${WORKDIR}/${P}</filename>. + </para><para> + The <function>src_unpack()</function> function is also responsible for making the appropriate patches + to the sources so that they're ready for compilation. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">compile</replaceable></term> + <listitem> + <para> + Compiles the extracted sources by running the the <function>src_compile()</function> function specified + in the ebuild file. When <function>src_compile()</function> starts, the current working directory will + be set to <envar>S</envar>. When <function>src_compile()</function> completes, the sources should be + fully compiled. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">install</replaceable></term> + <listitem> + <para> + Installs the package to the temporary "install directory" + by running the <function>src_install()</function> function. When + completed, the "install directory" + (<filename>${BUILD_PREFIX}/[package]-[version-rev]/image</filename>) + will contain all the files that should either be merged to the local + file system or included in a binary package. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">qmerge</replaceable></term> + <listitem> + <para> + This function installs all the files in the "install directory" + to the live filesystem. The process works as follows: first, the + <function>pkg_preinst()</function> function (if specified) is run. + Then, the files are merged into the live filesystem, and the installed + files' md5 digests are recorded in <filename>/var/db/pkg/[category]/[package]-[version-rev]/CONTENTS</filename> + . After all the files have been merged, the <function>pkg_postinst()</function> + function (if specified) is executed. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">merge</replaceable></term> + <listitem> + <para> + Normally, to merge an ebuild, you need to <command>fetch</command>, <command>unpack</command>, + <command>compile</command>, <command>install</command> and <command>qmerge</command>. + If you're simply interested in merging the ebuild, you can use this command, which will + perform all these steps for you, stopping along the way if a particular step doesn't complete successfully. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">remerge</replaceable></term> + <listitem> + <para> + Normally, you're not allowed to merge an ebuild when you have the exact same version + (down to the revision) already installed. This command performs the same function + as the <command>merge</command> command, with the exception that it allows + you to merge even if the exact same package is already on the system. + </para> + <note><para>Obsolte/dropped in portage 1.5</para></note> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">unmerge</replaceable></term> + <listitem> + <para> + This function first executes the <function>pkg_prerm</function> 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 <function>pkg_postrm</function> 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. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">package</replaceable></term> + <listitem> + <para> + This command is a lot like the <command>merge</command> command, except that after fetching, + unpacking, compiling and installing, a <filename>.tbz2</filename> binary package tarball is + created and stored in <filename>${PKGDIR}/All</filename> (<envar>PKGDIR</envar> defaults to + <filename>/usr/portage/packages</filename>). + </para><para> + A symbolic link is created in <filename>${PKGDIR}/[category]</filename> that points to the + package in <filename>${PKGDIR}/All</filename>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">rpm</replaceable></term> + <listitem> + <para> + Builds a RedHat RPM package from the files in the temporary "install directory". + At the moment, the ebuild's dependency information is not incorporated into the RPM. + </para> + </listitem> + </varlistentry> + + </variablelist> + </refsect1> + <refsect1> + <title>AUTHORS</title> + <para> + <author> + <firstname>Achim</firstname> + <surname>Gottinger</surname> + <affiliation><address><email>achim@gentoo.org</email></address></affiliation> + </author> + </para><para> + <author> + <firstname>Daniel</firstname> + <surname>Robbins</surname> + <affiliation><address><email>drobbins@gentoo.org</email></address></affiliation> + </author> + </para> + </refsect1> + <refsect1> + <title>SEE ALSO</title> + <para>ebuild(5) make.defaults(5) make.conf(5)</para> + <para>The <filename>/usr/sbin/ebuild</filename> script</para> + </refsect1> + <refsect1> + <title>FILES</title> + <para><filename>/etc/make.conf</filename> + Contains variables for the build-process and overwrites those in make.default + </para> + <para><filename>/etc/make.defaults</filename> + Contains the default variables for the build-process, you should edit <filename>/etc/make.conf</filename> instead. + </para> + </refsect1> +</refentry> + diff --git a/app-doc/gentoo-doc/files/refentry/ebuild-5.sgml b/app-doc/gentoo-doc/files/refentry/ebuild-5.sgml new file mode 100644 index 000000000000..5d69a588b51d --- /dev/null +++ b/app-doc/gentoo-doc/files/refentry/ebuild-5.sgml @@ -0,0 +1,25 @@ +<refentry id="ebuild.5"> + + <refmeta> + <refentrytitle><application>ebuild</application></refentrytitle> + <manvolnum>5</manvolnum> + <refmiscinfo>ebuild 1.4</refmiscinfo> + </refmeta> + + <refnamediv> + <refname><application>ebuild</application></refname> + <refpurpose>the internal format, variables and functions in an ebuild script</refpurpose> + </refnamediv> + + <refsect1> + <title>DESCRIPTION</title> + <para> + The <command>ebuild</command> (1) program accepts a single ebuild script as an argument. + This script contains variables and commands that specify how to download, unpack, + patch, compile, install and merge a particular software package from its original + sources. In addition to all this, the ebuild script can also contain + pre/post install/remove commands, as required. + </para> + </refsect1> +</refentry> + |