Copyright (C) 2001-2015 Free Software Foundation, Inc. See the end of the file for license conditions.

This directory tree holds version 24.5 of GNU Emacs, the extensible, customizable, self-documenting real-time display editor.

The file INSTALL

Bookmark: INSTALL The file INSTALL in this directory says how to build and install GNU Emacs on various systems, once you have unpacked or checked out the entire Emacs file tree.

the file etc/NEWS

See the file etc/NEWS for information on new features and other user-visible changes in recent versions of Emacs.

file etc/PROBLEMS

The file etc/PROBLEMS contains information on many common problems that occur in building, installing and running Emacs.

bug reports

You may encounter bugs in this release. If you do, please report them; your bug reports are valuable contributions to the FSF, since they allow us to notice and fix problems on machines we don’t have, or in code we don’t use often. Please send bug reports to the mailing list [email protected]. If possible, use M-x report-emacs-bug.

See the “Bugs” section of the Emacs manual for more information on how to report bugs. (The file `BUGS’ in this directory explains how you can find and read that section using the Info files that come with Emacs.) For a list of mailing lists related to Emacs, see http://savannah.gnu.org/mail/?group=emacs. For the complete list of GNU mailing lists, see http://lists.gnu.org/.

The `etc’ subdirectory

The `etc’ subdirectory contains several other files, named in capital letters, which you might consider looking at when installing GNU Emacs.

The file `configure.ac’

http://tetralet.luna.com.tw/?op=ViewArticle&articleId=200&blogId=1 The file `configure.ac’ is the input used by the autoconf program to construct the `configure’ script. Since Emacs has some configuration requirements that autoconf can’t meet directly, and for historical reasons, `configure.ac’ uses an unholy marriage of custom-baked configuration code and autoconf macros.

The shell script `autogen.sh’ + `configure.ac’ + autoconf/automake = `configure’

The shell script `autogen.sh’ generates ‘configure’ and other files by running the GNU build tools autoconf and automake, which in turn use GNU m4 and Perl. If you want to use it, you will need to install recent versions of these build tools. This should be needed only if you edit files like `configure.ac’ that specify Emacs’s autobuild procedure.

The file `Makefile.in’ + `configure’ = Makefile

The file `Makefile.in’ is a template used by `configure’ to create `Makefile’.

Bookmark: All object files linked into temacs

ALLOBJS = $(FIRSTFILE_OBJ) $(VMLIMIT_OBJ) $(obj) $(otherobj)

FIRSTFILE_OBJ=@FIRSTFILE_OBJ@

## vm-limit.o if !SYSTEM_MALLOC, else empty.

VMLIMIT_OBJ=@VMLIMIT_OBJ@

obj = $(base_obj) $(NS_OBJC_OBJ)

base_obj = dispnew.o frame.o scroll.o xdisp.o menu.o $(XMENU_OBJ) window.o \ charset.o coding.o category.o ccl.o character.o chartab.o bidi.o \ $(CM_OBJ) term.o terminal.o xfaces.o $(XOBJ) $(GTK_OBJ) $(DBUS_OBJ) \ emacs.o keyboard.o macros.o keymap.o sysdep.o \ buffer.o filelock.o insdel.o marker.o \ minibuf.o fileio.o dired.o \ cmds.o casetab.o casefiddle.o indent.o search.o regex.o undo.o \ alloc.o data.o doc.o editfns.o callint.o \ eval.o floatfns.o fns.o font.o print.o lread.o \ syntax.o $(UNEXEC_OBJ) bytecode.o \ process.o gnutls.o callproc.o \ region-cache.o sound.o atimer.o \ doprnt.o intervals.o textprop.o composite.o xml.o $(NOTIFY_OBJ) \ profiler.o decompress.o \ $(MSDOS_OBJ) $(MSDOS_X_OBJ) $(NS_OBJ) $(CYGWIN_OBJ) $(FONT_OBJ) \ $(W32_OBJ) $(WINDOW_SYSTEM_OBJ) $(XGSELOBJ)

## List of object files that make-docfile should not be told about.

otherobj= $(TERMCAP_OBJ) $(PRE_ALLOC_OBJ) $(GMALLOC_OBJ) $(RALLOC_OBJ) \ $(POST_ALLOC_OBJ) $(WIDGET_OBJ) $(LIBOBJS)

cflow

call graph

cflow –cpp -b -l –emacs -T \ -I. -I../lib -I./../lib -I/usr/include/gtk-3.0 -I/usr/include/atk-1.0 -I/usr/include/at-spi2-atk/2.0 -I/usr/include/pango-1.0 -I/usr/include/gio-unix-2.0/ -I/usr/include/cairo -I/usr/include/gdk-pixbuf-2.0 -I/usr/include/glib-2.0 -I/usr/lib/x86_64-linux-gnu/glib-2.0/include -I/usr/include/harfbuzz -I/usr/include/freetype2 -I/usr/include/pixman-1 -I/usr/include/libpng12 -I/usr/include/freetype2 -I/usr/include/libxml2 -I/usr/include/dbus-1.0 -I/usr/lib/x86_64-linux-gnu/dbus-1.0/include -pthread -I/usr/include/glib-2.0 -I/usr/lib/x86_64-linux-gnu/glib-2.0/include -I/usr/include/glib-2.0 -I/usr/lib/x86_64-linux-gnu/glib-2.0/include -I/usr/include/freetype2 -I/usr/include/freetype2 -I/usr/include/p11-kit-1 -I/usr/include/glib-2.0 -I/usr/lib/x86_64-linux-gnu/glib-2.0/include \ vm-limit.c dispnew.c frame.c scroll.c xdisp.c menu.c xmenu.c window.c charset.c coding.c category.c ccl.c character.c chartab.c bidi.c cm.c term.c terminal.c xfaces.c xterm.c xfns.c xselect.c xrdb.c xsmfns.c xsettings.c gtkutil.c emacsgtkfixed.c dbusbind.c emacs.c keyboard.c macros.c keymap.c sysdep.c buffer.c filelock.c insdel.c marker.c minibuf.c fileio.c dired.c cmds.c casetab.c casefiddle.c indent.c search.c regex.c undo.c alloc.c data.c doc.c editfns.c callint.c eval.c floatfns.c fns.c font.c print.c lread.c syntax.c unexelf.c bytecode.c process.c gnutls.c callproc.c region-cache.c sound.c atimer.c doprnt.c intervals.c textprop.c composite.c xml.c gfilenotify.c profiler.c decompress.c xfont.c ftfont.c xftfont.c ftxfont.c fontset.c fringe.c image.c xgselect.c terminfo.c lastfile.c \ -o emacs.b.cflow

Bookmark: cflow.txt

reverse call graph

cflow –cpp -r -d2 \ -I. -I../lib -I./../lib -I/usr/include/gtk-3.0 -I/usr/include/atk-1.0 -I/usr/include/at-spi2-atk/2.0 -I/usr/include/pango-1.0 -I/usr/include/gio-unix-2.0/ -I/usr/include/cairo -I/usr/include/gdk-pixbuf-2.0 -I/usr/include/glib-2.0 -I/usr/lib/x86_64-linux-gnu/glib-2.0/include -I/usr/include/harfbuzz -I/usr/include/freetype2 -I/usr/include/pixman-1 -I/usr/include/libpng12 -I/usr/include/freetype2 -I/usr/include/libxml2 -I/usr/include/dbus-1.0 -I/usr/lib/x86_64-linux-gnu/dbus-1.0/include -pthread -I/usr/include/glib-2.0 -I/usr/lib/x86_64-linux-gnu/glib-2.0/include -I/usr/include/glib-2.0 -I/usr/lib/x86_64-linux-gnu/glib-2.0/include -I/usr/include/freetype2 -I/usr/include/freetype2 -I/usr/include/p11-kit-1 -I/usr/include/glib-2.0 -I/usr/lib/x86_64-linux-gnu/glib-2.0/include \ vm-limit.c dispnew.c frame.c scroll.c xdisp.c menu.c xmenu.c window.c charset.c coding.c category.c ccl.c character.c chartab.c bidi.c cm.c term.c terminal.c xfaces.c xterm.c xfns.c xselect.c xrdb.c xsmfns.c xsettings.c gtkutil.c emacsgtkfixed.c dbusbind.c emacs.c keyboard.c macros.c keymap.c sysdep.c buffer.c filelock.c insdel.c marker.c minibuf.c fileio.c dired.c cmds.c casetab.c casefiddle.c indent.c search.c regex.c undo.c alloc.c data.c doc.c editfns.c callint.c eval.c floatfns.c fns.c font.c print.c lread.c syntax.c unexelf.c bytecode.c process.c gnutls.c callproc.c region-cache.c sound.c atimer.c doprnt.c intervals.c textprop.c composite.c xml.c gfilenotify.c profiler.c decompress.c xfont.c ftfont.c xftfont.c ftxfont.c fontset.c fringe.c image.c xgselect.c terminfo.c lastfile.c \ -o emacs.reverse.d2.cflow

cflow –cpp -r -b –emacs -T \ -I. -I../lib -I./../lib -I/usr/include/gtk-3.0 -I/usr/include/atk-1.0 -I/usr/include/at-spi2-atk/2.0 -I/usr/include/pango-1.0 -I/usr/include/gio-unix-2.0/ -I/usr/include/cairo -I/usr/include/gdk-pixbuf-2.0 -I/usr/include/glib-2.0 -I/usr/lib/x86_64-linux-gnu/glib-2.0/include -I/usr/include/harfbuzz -I/usr/include/freetype2 -I/usr/include/pixman-1 -I/usr/include/libpng12 -I/usr/include/freetype2 -I/usr/include/libxml2 -I/usr/include/dbus-1.0 -I/usr/lib/x86_64-linux-gnu/dbus-1.0/include -pthread -I/usr/include/glib-2.0 -I/usr/lib/x86_64-linux-gnu/glib-2.0/include -I/usr/include/glib-2.0 -I/usr/lib/x86_64-linux-gnu/glib-2.0/include -I/usr/include/freetype2 -I/usr/include/freetype2 -I/usr/include/p11-kit-1 -I/usr/include/glib-2.0 -I/usr/lib/x86_64-linux-gnu/glib-2.0/include \ vm-limit.c dispnew.c frame.c scroll.c xdisp.c menu.c xmenu.c window.c charset.c coding.c category.c ccl.c character.c chartab.c bidi.c cm.c term.c terminal.c xfaces.c xterm.c xfns.c xselect.c xrdb.c xsmfns.c xsettings.c gtkutil.c emacsgtkfixed.c dbusbind.c emacs.c keyboard.c macros.c keymap.c sysdep.c buffer.c filelock.c insdel.c marker.c minibuf.c fileio.c dired.c cmds.c casetab.c casefiddle.c indent.c search.c regex.c undo.c alloc.c data.c doc.c editfns.c callint.c eval.c floatfns.c fns.c font.c print.c lread.c syntax.c unexelf.c bytecode.c process.c gnutls.c callproc.c region-cache.c sound.c atimer.c doprnt.c intervals.c textprop.c composite.c xml.c gfilenotify.c profiler.c decompress.c xfont.c ftfont.c xftfont.c ftxfont.c fontset.c fringe.c image.c xgselect.c terminfo.c lastfile.c \ -o emacs.reverse.b.cflow

function list

perl -ne ‘$names{$1}=++$$count if ([a-zA-Z_0-9]+)\(\);map {print “$_\n”} sort keys %names if eof;prin’ emacs.b.cflow > emacs.function.list.txt

macro list

perl -ne ‘$names{$1}=++$$count if -([A-Z_0-9]+)\(\);map {print “$_\n”} sort keys %names if eof;prin’ emacs.b.cflow > emacs.macro.list.txt

external function list

perl -ne ‘$names{$1}=++$$count if -([a-zA-Z_0-9]+)\(\)$;map {print “$_\n” if not ^[A-Z_0-9]+$} sort keys %names if eof;prin’ emacs.b.cflow > emacs.extern.list.txt

main() @ emacs.c

Bookmark: emacs.c

Frecursive_edit

* Enter editor command loop. This never returns. *

emacs_open

emacs -t #terminal mode

message_dolog

clear logging

lisp parsing

lread.c

syntax.c

The file `configure’ => `Makefile’

The file `configure’ is a shell script to acclimate Emacs to the oddities of your processor and operating system. It creates the file `Makefile’ (a script for the `make’ program), which automates the process of building and installing Emacs. See INSTALL for more detailed information.

The file `make-dist’: build a distribution tar

The file `make-dist’ is a shell script to build a distribution tar file from the current Emacs tree, containing only those files appropriate for distribution. If you make extensive changes to Emacs, this script will help you distribute your version to others.

Misc: src, lisp, lib

There are several subdirectories:

`src’ holds the C code for Emacs (the Emacs Lisp interpreter and its primitives, the redisplay code, and some basic editing functions). Bookmark: src `lisp’ holds the Emacs Lisp code for Emacs (most everything else). Bookmark: lisp `leim’ holds the original source files for the generated files in lisp/leim. These form the library of Emacs input methods, required to type international characters that can’t be directly produced by your keyboard. `lib’ holds source code for libraries used by Emacs and its utilities Bookmark: lib `lib-src’ holds the source code for some utility programs for use by or with Emacs, like movemail and etags. `etc’ holds miscellaneous architecture-independent data files Emacs uses, like the tutorial text and tool bar images. The contents of the `lisp’, `leim’, `info’, and `doc’ subdirectories are architecture-independent too. `info’ holds the Info documentation tree for Emacs. `doc/emacs’ holds the source code for the Emacs Manual. If you modify the manual sources, you will need the `makeinfo’ program to produce an updated manual. `makeinfo’ is part of the GNU Texinfo package; you need a suitably recent version of Texinfo. `doc/lispref’ holds the source code for the Emacs Lisp reference manual. `doc/lispintro’ holds the source code for the Introduction to Programming in Emacs Lisp manual. `msdos’ holds configuration files for compiling Emacs under MSDOG. `nextstep’ holds instructions and some other files for compiling the Nextstep port of Emacs, for GNUstep and Mac OS X Cocoa. `nt’ holds various command files and documentation files that pertain to building and running Emacs on Windows 9X/ME/NT/2000/XP. `test’ holds tests for various aspects of Emacs’s functionality.

Building Emacs on non-Posix platforms requires tools that aren’t part of the standard distribution of the OS. The platform-specific README files and installation instructions should list the required tools.

NOTE ON COPYRIGHT YEARS

In copyright notices where the copyright holder is the Free Software Foundation, then where a range of years appears, this is an inclusive range that applies to every year in the range. For example: 2005-2008 represents the years 2005, 2006, 2007, and 2008.

This file is part of GNU Emacs.

GNU Emacs is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

GNU Emacs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with GNU Emacs. If not, see http://www.gnu.org/licenses/.