Project:GNU Emacs/Developer guide

What is Emacs?
Emacs is the extensible, customizable, self-documenting real-time display editor. Large parts are written in the Lisp dialect Emacs Lisp, with which extensions can be easily developed. Apart from its editing features, GNU Emacs provides a whole environment to manage your system, mail, IRC chats and texts (be it correspondence or programming).

Available versions
Currently the following Emacs versions are available:

Locations of files
The following files are installed in different locations or under a different name (as compared to vanilla GNU Emacs):


 * Emacs executable:, where suffix is normally equal to the Emacs major version
 * Auxiliary programs (e.g., ):
 * Man pages are named accordingly
 * Info files of Emacs are installed in directory

The programs are symlinked to their original names by the Emacs eselect module, apart from  and   which have their own modules.

USE flags
Emacs has many USE flags, most are easy to understand what they are good for, others have some hidden “features” one should know about. The slot for version 18 has no USE flags at all, so if nothing else is noted, version 21 onwards is described.

Depending on a specific Emacs version
A minimum version of GNU Emacs required by a package can be specified by assigning  before inheriting. The given version number must be available as an ebuild in. Without such an assignment, the package will by default depend on. Packages that have optional support for GNU Emacs (via USE flags) can check for a minimum version of GNU Emacs at build time with the  function.

The site-lisp directory and package loading
The regular location for Emacs lisp packages in Gentoo is. All Elisp files and compiled Elisp files  should go there.

Emacs packages normally need to be activated or loaded when a certain condition is met (like c-mode for C source files).

In Gentoo every package has a site initialisation file that holds the needed commands. The file is located in  and starts with a two-digit number, followed by the package name and. The  function puts this file in the directory.

When calling  in an ebuild, the global site file  is regenerated, which holds the contents of all individual site init files in one. They are read in alphabetical order, so the numbers determine which comes first, the lowest is to be found at the beginning. That means: Packages depending on each other need to have rising order for site initialisation, too.

Formerly, all those initialisations were directly added to, which is executed at Emacs start-up. Today there is another level of indirection, i.e. initialisations are in which can either be loaded from  (the default), or it can be individually loaded from users’  files by adding a line like:

(require 'site-gentoo)

Historically site-init files were read from the directory, which is still supported by the eclasses, but a remerge/update will put them in the  subdirectory. Package installs a script that checks for needed rebuilds, called.

Eclasses
Packages that have support for or rely on GNU Emacs can use two eclasses to do some recurring tasks in a simple way. The documentation of the functions are provided in the eclasses, so they are not repeated here! Format of documentation is to allow man-page generation from source with the package.

Emacs eselect module
Having several Emacs versions simultaneously installed on a system, needs some caution by maintainers. Usual pitfalls are file collisions and installations of one slot using data from another. As described earlier, the executables are suffixed with their corresponding version number. All data files go to similar directories, also distinguished by a version suffix.

To be independent of the installed version, the eselect module from guarantees that  always points to the Emacs you want. All ebuilds for the editor check if the symlink is set, and change it to the highest available in the case where it does not exist. If no GNU Emacs is found, but XEmacs, all helper programs are symlinked to the variants shipped with XEmacs.

The module file has some comments about how the code works. For more information how an eselect module is set up, consult the eselect developer guide.

Provided virtuals
Sometimes the same functionality is available through different packages. To not force a subjective choice the maintainer made, virtuals check if one of the alternatives is installed on the user’s system.


 * Just makes sure you have an editing capability available on your system, Emacs is one choice out of many.
 * Just makes sure you have an editing capability available on your system, Emacs is one choice out of many.


 * This gives you the choice between several version of Emacs. Elisp packages can choose which virtual version is the minimum they need through the.
 * This gives you the choice between several version of Emacs. Elisp packages can choose which virtual version is the minimum they need through the.


 * The Collection of Emacs Development Environment Tools was traditionally available as a separate package . It is also shipped with Emacs versions from 23.2 on.
 * The Collection of Emacs Development Environment Tools was traditionally available as a separate package . It is also shipped with Emacs versions from 23.2 on.


 * There are several libraries that provide encoding functions for other packages. If they are compatible to, they should provide the  virtual.
 * There are several libraries that provide encoding functions for other packages. If they are compatible to, they should provide the  virtual.

Where Emacs team is upstream
Not all packages maintained by the Emacs team are developed by people from outside the Gentoo project (they are usually called upstream). Most of those exceptions are for proper operation of GNU Emacs in the Gentoo environment.

Sources of these packages are kept in the Emacs-Tools Git repository. They are released and brought to the Emacs overlay or to the Portage tree when they have proven stable.

A sample ebuild
We present an ebuild that introduces the canonical form regarding variable ordering in global scope and implementation along an example.


 * 1) Copyright 1999-2013 Gentoo Foundation
 * 2) Distributed under the terms of the GNU General Public License v2
 * 3) $Header: $

EAPI=5

inherit elisp

DESCRIPTION="ReStructuredText support for Emacs" HOMEPAGE="http://www.emacswiki.org/cgi-bin/wiki/reStructuredText" SRC_URI="mirror://sourceforge/docutils/docutils-${PV}.tar.gz"

LICENSE="GPL-2+" SLOT="0" KEYWORDS="alpha amd64 arm hppa ia64 ppc ppc64 s390 sh sparc ~sparc-fbsd x86 ~x86-fbsd"

S="${WORKDIR}/docutils-${PV}/tools/editors/emacs" DOCS="README.txt" ELISP_PATCHES="${P}-lazy-lock-mode-fix.patch" SITEFILE="50${PN}-gentoo.el"

The first lines from  to   are standard Gentoo ebuild variables and thus outside the scope of this text.