EBOOK.ECLASSSection: portage (5)Updated: Aug 2004 |
NAME
ebook - easy installation of ebooksDESCRIPTION
The ebook eclass makes writing ebuilds for ebooks a trivial task.VARIABLES
NOTE: the following variables should be set BEFORE inheriting the ebook eclass:- DESCRIPTION
- Package description. Defaults to "${P} ebook based on ebook eclass".
- RDEPEND
- Run-time dependencies. Defaults to ">=dev-util/devhelp-0.6".
- EBOOKNAME
- The name of the ebook. This variable must be set.
- EBOOKVERSION
- The version of the ebook. This variable must be set, even if there is no version. See the ${NOVERSION} variable below for more information.
- SRC
- The name of the file to download, minus the file extension. This variable defaults to ${EBOOKNAME}-${EBOOKVERSION}.
- SRC_URI
- The ebook URI to download. Defaults to "http://lidn.sourceforge.net/books_download/${SRC}.${EBOOKEXT}".
- EBOOKEXT
- The file name extension of ${SRC}. Defaults to tar.gz.
- EBOOKDESTDIR
- The directory inside ${DEVHELPROOT}/books/${EBOOKDIR} in which the ebook will be installed. This variable defaults to ${EBOOKNAME}-${EBOOKVERSION} or ${EBOOKNAME} if the ${NOVERSION} variable is set.
- EBOOKFROMDIR
- The directory in which the ebook's HTML files are located after unpacking ${SRC_URI}. This directory is relative to ${WORKDIR}. This variable defaults to ${EBOOKNAME}-${EBOOKVERSION} or ${EBOOKNAME} if the ${NOVERSION} variable is set.
- BOOKDEVHELPFILE
- The file name that the ebook's book.devhelp will be installed as. This variable defaults to ${EBOOKNAME}-${EBOOKVERSION}.devhelp or ${EBOOKNAME}.devhelp if the ${NOVERSION} variable is set.
- BOOKDESTDIR
- The directory in which the ebook's HTML will be installed into. Defaults to ${EBOOKNAME}-${EBOOKVERSION} or ${EBOOKNAME} is the ${NOVERSION} variable is set.
- NOVERSION
- If this variable is not empty, all instances of ${EBOOKVERSION} will be removed from all variables.
- DEVHELPROOT
- The location of devhelp's data directory. Defaults to usr/share/devhelp.
FUNCTIONS
NOTE: the following functions will be used as the defaults should they be omitted from the ebuild.- ebook_src_install
- Installs ${BOOKDEVHELPFILE} and all HTML files into ${DEVHELPROOT}/books/${EBOOKDESTDIR}.
REPORTING BUGS
Please report bugs via http://bugs.gentoo.org/SEE ALSO
ebuild(5)FILES
/usr/portage/eclass/ebook.eclassAUTHORS
Aaron Walker <ka0ttic@gentoo.org>CVS HEADER
$Header: /var/cvsroot/gentoo-src/portage/man/ebook.eclass.5,v 1.2 2004/09/29 12:55:49 vapier Exp $