EBUILD(5) portage EBUILD(5) NAME ebuild - the internal format, variables, and functions in an ebuild script DESCRIPTION The ebuild(1) program accepts a single ebuild script as an argument. This script contains variables and commands that specify how to down- load, unpack, patch, compile, install and merge a particular software package from its original sources. In addition to all of this, the ebuild script can also contain pre/post install/remove commands, as required. EXAMPLES Here's a simple example ebuild: # Copyright 1999-2004 Gentoo Foundation # Distributed under the terms of the GNU General Public License v2 # $Header: inherit some_eclass another_eclass DESCRIPTION="Super-useful stream editor (sed)" HOMEPAGE="http://www.gnu.org/software/sed/sed.html" SRC_URI="ftp://alpha.gnu.org/pub/gnu/sed/${P}.tar.gz" LICENSE="GPL-2" SLOT="0" KEYWORDS="~x86" IUSE="" DEPEND="virtual/libc" RDEPEND="virtual/libc" src_compile() { econf || die "could not configure" emake || die "emake failed" } src_install() { into /usr doinfo doc/sed.info doman doc/sed.1 into / dobin sed/sed dodir /usr/bin dosym /bin/sed /usr/bin/sed dodoc NEWS README* THANKS TODO AUTHORS BUGS ANNOUNCE } VARIABLES MISC USAGE NOTES - PORTAGE* and PORTDIR* variables may be found in make.conf(5). - When assigning values to variables in ebuilds, you cannot have a space between the variable name and the equal sign. P This variable contains the package name without the ebuild revi- sion. This variable must NEVER be modified. xfree-4.2.1-r2.ebuild --> $P=='xfree-4.2.1' PN Contains the name of the script without the version number. xfree-4.2.1-r2.ebuild --> $PN=='xfree' PV Contains the version number without the revision. xfree-4.2.1-r2.ebuild --> $PV=='4.2.1' PR Contains the revision number or 'r0' if no revision number exists. xfree-4.2.1-r2.ebuild --> $PR=='r2' PVR Contains the version number with the revision. xfree-4.2.1-r2.ebuild --> $PVR=='4.2.1-r2' PF Contains the full package name [PN]-[PVR] xfree-4.2.1-r2.ebuild --> $PF=='xfree-4.2.1-r2' A Contains all source files required for the package. This vari- able must not be defined. It is autogenerated from the SRC_URI variables. WORKDIR = "${PORTAGE_TMPDIR}/portage/${PF}/work" Contains the path to the package build root. Do not modify this variable. FILESDIR = "${PORTDIR}/${CATEGORY}/${PN}/files" Contains the path to the 'files' sub folder in the package spe- cific location in the portage tree. Do not modify this vari- able. S = "${WORKDIR}/${P}" Contains the path to the temporary build directory. This vari- able is used by the functions src_compile and src_install. Both are executed with S as the current directory. This variable may be modified to match the extraction directory of a tarball for the package. T = "${PORTAGE_TMPDIR}/portage/${PF}/temp" Contains the path to a temporary directory. You may use this for whatever you like. D = "${PORTAGE_TMPDIR}/portage/${PF}/image" Contains the path to the temporary install directory. Every write operation that does not involve the helper tools and func- tions (found below) should be prefixed with ${D}. Do not modify this variable. DESCRIPTION = "A happy little package" Should contain a short description of the package. SRC_URI = "http://happy.com/little/${P}.tar.gz" Contains a list of URI's for the required source files. It can contain multiple URI's for a single source file. The fastest location is chosen if the file was not found at GENTOO_MIRROR. HOMEPAGE = "http://happy.com/" Should contain a list of URL's for the sources main sites and other further package dependent information. KEYWORDS = [-~][x86,ppc,sparc,mips,alpha,arm,hppa] Should contain appropriate list of arches that the ebuild is know to work/not work. By default if you do not know if an ebuild runs under a particular arch simply omit that KEYWORD. If the ebuild will not work on that arch include it as -ppc for example. If the ebuild is being submitted for inclusion, it must have ~arch set for architectures where it has been PROVEN TO WORK. (Packages KEYWORDed this way may be unmasked for test- ing by setting ACCEPT_KEYWORDS="~arch" on the command line, or in make.conf(5)) For an authoritative list please review /usr/portage/profiles/arch.list. SLOT This sets the SLOT for packages that may need to co-exist. By default you should set SLOT="0" unless you know what you are doing and need to do otherwise. This value should NEVER be left undefined. LICENSE This should be a space delimited list of licenses that the pack- age falls under. This _must_ be set to a matching license in /usr/portage/licenses/. If the license does not exist in portage yet you must add it first. IUSE This should be a list of any and all USE flags that are lever- aged within your build script. The only USE flags that should not be listed here are arch related flags (see KEYWORDS). DEPEND This should contain a list of all packages that are required for the program to compile. DEPEND Atoms A depend atom is simply a dependency that is used by portage when calculating relationships between packages. Please note that if the atom has not already been emerged, then the latest version available is matched. Atom Bases The base atom is just a full category/package- name. Hence, these are base atoms: sys-apps/sed sys-libs/zlib net-misc/dhcp Atom Versions It is nice to be more specific and say that only certain versions of atoms are acceptable. Note that versions must be combined with a prefix (see below). Hence you may add a version number as a postfix to the base: sys-apps/sed-4.0.5 sys-libs/zlib-1.1.4-r1 net-misc/dhcp-3.0_p2 Versions are normally made up of two or three numbers separated by periods, such as 1.2 or 4.5.2. This string may be followed by a charac- ter such as 1.2a or 4.5.2z. Note that this let- ter is not meant to indicate alpha, beta, etc... status. For that, use the optional suffix; either _alpha, _beta, _pre (pre-release), _rc (release candidate), or _p (patch). This means for the 3rd pre-release of a package, you would use something like 1.2_pre3. Atom Prefix Operators [> >= = <= <] Sometimes you want to be able to depend on gen- eral versions rather than specifying exact ver- sions all the time. Hence we provide standard boolean operators: >media-libs/libgd-1.6 >=media-libs/libgd-1.6 =media-libs/libgd-1.6 <=media-libs/libgd-1.6 If USE item is in the USE variable, USE item will be echoed and the function will return 0. If USE item is not in the USE vari- able, the function will return 1. useq is a non-echoing version of use. Example: if useq gnome ; then guiconf="--enable-gui=gnome --with-x" elif useq gtk ; then guiconf="--enable-gui=gtk --with-x" elif useq X ; then guiconf="--enable-gui=athena --with-x" else # No gui version will be built guiconf="" fi use_with [configure option] Useful for creating custom options to pass to a configure script. If USE item is in the USE variable, then the string --with-[configure option] will be echoed. If USE item is not in the USE variable, then the string --without-[configure option] will be echoed. If configure option is not specified, than USE item will be used in its place. Example: USE="jpeg" myconf="$(use_with jpeg libjpeg)" (myconf now has the value "--with-libjpeg") USE="" myconf="$(use_with jpeg libjpeg)" (myconf now has the value "--without-libjpeg") USE="opengl" myconf="$(use_with opengl") (myconf now has the value "--with-opengl") use_enable [configure option] Useful for creating custom options to pass to a configure script. If USE item is in the USE variable, then the string --enable-[configure option] will be echoed. If USE item is not in the USE variable, then the string --disable-[configure option] will be echoed. If configure option is not specified, than USE item will be used in its place. See use_with for an example. has If item is in item list, then item is echoed and has returns 0. Otherwise, nothing is echoed and 1 is returned. As indicated with use, there is a non-echoing version hasq. Please use hasq in all places where output is to be disregarded. Never use the output for calculation. The item list is delimited by the IFS variable. This variable has a default value of ' ', or a space. It is a bash(1) set- ting. has_version Check to see if category/package-version is installed on the system. The parameter accepts all values that are acceptable in the DEPEND variable. The function returns 0 if category/pack- age-version is installed, 1 otherwise. best_version This function will look up package name in the database of cur- rently installed programs and echo the "best version" of the package that is currently installed. The function returns 0 if there is a package that matches package name. Otherwise, the function will return 1. Example: VERINS="$(best_version net-ftp/glftpd)" (VERINS now has the value "net-ftp/glftpd-1.27" if glftpd-1.27 is installed) HELPER FUNCTIONS: OUTPUT einfo "informative message" If you need to display an message that you wish the user to read and take notice of, then use einfo. It works just like echo(1), but adds a little more to the output so as to catch the user's eye. ewarn "warning message" Same as einfo, but should be used when showing a warning to the user. eerror "error message" Same as einfo, but should be used when showing an error to the user. HELPER FUNCTIONS: UNPACK unpack [list of more sources] This function uncompresses and/or untars a list of sources into the current directory. The function will append source to the DISTDIR variable. HELPER FUNCTIONS: COMPILE econf [configure options] This is used as a replacement for configure. Performs: configure \ --prefix=/usr \ --host=${CHOST} \ --mandir=/usr/share/man \ --infodir=/usr/share/info \ --datadir=/usr/share \ --sysconfdir=/etc \ --localstatedir=/var/lib \ ${EXTRA_ECONF} \ configure options Note that the EXTRA_ECONF is for users only, not for ebuild writers. If you wish to pass more options to configure, just pass the extra arguements to econf. emake [make options] This is used as a replacement for make. Performs default is MAKEOPTS="-j2". ***warning*** if you are going to use emake, make sure your build is happy with parallel makes (make -j2). It should be tested thoroughly as parallel makes are notorious for failing _sometimes_ but not always. HELPER FUNCTIONS: INSTALL einstall [make options] This is used as a replacement for make install. Performs: make \ prefix=${D}/usr \ datadir=${D}/usr/share \ infodir=${D}/usr/share/info \ localstatedir=${D}/var/lib \ mandir=${D}/usr/share/man \ sysconfdir=${D}/etc \ ${EXTRA_EINSTALL} \ make options install Please do not use this in place of 'make install DESTDIR=${D}'. That is the preferred way of installing make-based packages. Also, do not utilize the EXTRA_EINSTALL variable since it is for users. prepall prepalldocs prepallinfo prepallman prepallstrip Useful for when a package installs into ${D} via scripts (i.e. makefiles). If you want to be sure that libraries are exe- cutable, aclocal files are installed into the right place, doc/info/man files are all compressed, and that executables are all stripped of debugging symbols, then use these suite of func- tions. prepall: Runs prepallman, prepallinfo, prepallstrip, sets libraries +x, and then checks aclocal directories. Please note this does *not* run prepalldocs. prepalldocs: Compresses all doc files in ${D}/usr/share/doc. prepallinfo: Compresses all info files in ${D}/usr/share/info. prepallman: Compresses all man files in ${D}/usr/share/man. prepallstrip: Strips all executable files of debugging symboles. This includes libraries. prepinfo [dir] preplib [dir] preplib.so [dir] prepman [dir] prepstrip [dir] Similiar to the prepall functions, these are subtle in their differences. prepinfo: If a dir is not specified, then prepinfo will assume the dir usr. prepinfo will then compress all the files in ${D}/dir/info. preplib: If a dir is not specified, then preplib will assume the dir usr. preplib will then run 'ldconfig -n -N' on ${D}/dir/lib. preplib.so: All the files with '.so' in their name and are found in ${D}/dir will be stripped of their debug symbols. You may specify multiple directories. prepman: If a dir is not specified, then prepman will assume the dir usr. prepman will then compress all the files in ${D}/dir/man/*/. prepstrip: All the files found in ${D}/dir will be stripped. You may specify multiple directories. dopython Performs commands with python and returns the result. dosed "s:orig:change:g" Performs sed (including cp/mv filename) on filename. 'dosed "s:/usr/local:/usr:g" /usr/bin/some-script' runs sed on ${D}/usr/bin/some-script dodir Creates a directory inside of ${D}. 'dodir /usr/lib/apache' creates ${D}/usr/lib/apache. Note that the do* functions will run dodir for you. diropts [options for install(1)] Can be used to define options for the install function used in dodir. The default is -m0755. into Sets the root (DESTTREE) for other functions like dobin, dosbin, doman, doinfo, dolib. The default root is /usr. keepdir Tells portage to leave a directory behind even if it is empty. Functions the same as dodir. dobin [list of more binaries] Installs a binary or a list of binaries into DESTTREE/bin. Cre- ates all necessary dirs. dosbin [list of more binaries] Installs a binary or a list of binaries into DESTTREE/sbin. Creates all necessary dirs. doinitd [list of more init.d scripts] Install Gentoo init.d scripts. They will be installed into the correct location for Gentoo init.d scripts (/etc/init.d/). Cre- ates all necessary dirs. doconfd [list of more conf.d file] Install Gentoo conf.d files. They will be installed into the correct location for Gentoo conf.d files (/etc/conf.d/). Cre- ates all necessary dirs. doenvd [list of more env.d entries] Install Gentoo env.d entries. They will be installed into the correct location for Gentoo env.d entries (/etc/env.d/). Cre- ates all necessary dirs. dolib [list of more libraries] dolib.a [list of more libraries] dolib.so [list of more libraries] Installs a library or a list of libraries into DESTTREE/lib. Creates all necessary dirs. libopts [options for install(1)] Can be used to define options for the install function used in the dolib functions. The default is -m0644. doman [list of more man-pages] Installs manual-pages into /usr/share/man/man[1-8n] depending on the manual file ending. The files are gzipped if they are not already. Creates all necessary dirs. dohard dosym Performs the ln command as either a hard link or symlink. dohtml [-a filetypes] [-r] [-x list-of-dirs-to-ignore] [list-of-files-and-dirs] Installs the files in the list of files (space-separated list) into /usr/share/doc/${PF}/html provided the file ends in .html, .png, .js, -A appends to the default list, setting -x sets which dirs to exclude (CVS excluded by default), -r sets recursive. doinfo [list of more info-files] Installs info-pages into DESTDIR/info. Files are automatically gzipped. Creates all necessary dirs. dojar [list of more jar files] Installs jar files into /usr/share/${PN}/lib and adds them to /usr/share/${PN}/classpath.env. domo [list of more locale-files] Installs locale-files into DESTDIR/usr/share/locale/[LANG] depending on local-file's ending. Creates all necessary dirs. fowners [files] fperms [files] Performs chown (fowners) or chmod (fperms), applying permissions to files. insinto [path] Sets the root (INSDESTTREE) for the doins function. The default root is /. insopts [options for install(1)] Can be used to define options for the install function used in doins. The default is -m0644. doins [list of more files] Installs files into INSDESTTREE. This function uses install(1). Creates all necessary dirs. exeinto [path] Sets the root (EXEDESTTREE) for the doexe function. The default root is /. exeopts [options for install(1)] Can be used to define options for the install function used in doexe. The default is -m0755. doexe [list of more executables] Installs a executable or a list of executable into EXEDESTTREE. This function uses install(1). Creates all necessary dirs. docinto [path] Sets the relative subdir (DOCDESTTREE) used by dodoc. dodoc [list of more documents] Installs a document or a list of document into /usr/share/doc/${PF}/DOCDESTTREE. Files are automatically gzipped. Creates all necessary dirs. newbin newsbin newinitd newconfd newenvd newlib newlib.so newlib.a newman newinfo newins newexe newdoc All these functions act like the do* functions, but they only work with one file and the file is installed as [new filename]. REPORTING BUGS Please report bugs via http://bugs.gentoo.org/ SEE ALSO ebuild(1), make.conf(5) The /usr/sbin/ebuild.sh script. The helper apps in /usr/lib/portage/bin. FILES /etc/make.conf Contains variables for the build-process and overwrites those in make.defaults. /etc/make.globals Contains the default variables for the build-process, you should edit /etc/make.conf instead. AUTHORS Achim Gottinger Mark Guertin Nicholas Jones Mike Frysinger CVS HEADER $Header: /var/cvsroot/gentoo-src/portage/man/ebuild.5,v 1.73 2004/10/16 20:15:48 vapier Exp $ Portage 2.0.51 Feb 2003 EBUILD(5)