xref: /emacs/
Name Date Size

..13-Jul-20204 KiB

.clang-formatH A D24-Sep-2017628

.dir-locals.elH A D02-Nov-20191.3 KiB

.gitattributesH A D01-Jan-20202.8 KiB

.gitignoreH A D04-Aug-20205 KiB

.gitlab-ci.ymlH A D03-Jan-20202.3 KiB

admin/H12-Aug-20204 KiB

autogen.shH A D01-Jan-202010.8 KiB

BUGSH A D14-Sep-2017932

build-aux/H30-Jul-20204 KiB

ChangeLog.1H A D01-Jan-2020467.4 KiB

ChangeLog.2H A D01-Jan-20201.2 MiB

ChangeLog.3H A DToday4.8 MiB

config.batH A D01-Jan-202014.5 KiB

configure.acH A D12-Aug-2020195.4 KiB

CONTRIBUTEH A D22-Jul-202018.2 KiB

COPYINGH A D02-Oct-201734.3 KiB

doc/H18-Aug-20174 KiB

etc/HToday4 KiB

GNUmakefileH A D01-Jan-20204.3 KiB

INSTALLH A D28-Jan-202031.2 KiB

INSTALL.REPOH A D01-Jan-20204.1 KiB

leim/H01-Jan-20204 KiB

lib/HToday4 KiB

lib-src/H13-Aug-20204 KiB

lisp/HToday12 KiB

lwlib/H01-Jan-20204 KiB

m4/HToday4 KiB

make-distH A D01-Jan-202014.5 KiB

Makefile.inH A D09-Aug-202044.7 KiB

modules/H01-Jan-20204 KiB

msdos/H01-Jan-20204 KiB

nextstep/H01-Jan-20204 KiB

nt/H28-Jun-20204 KiB

oldXMenu/H01-Jan-20204 KiB

READMEH A D01-Jan-20206 KiB

src/HToday12 KiB

test/H04-Aug-20204 KiB

README

1Copyright (C) 2001-2020 Free Software Foundation, Inc.
2See the end of the file for license conditions.
3
4
5This directory tree holds version 28.0.50 of GNU Emacs, the extensible,
6customizable, self-documenting real-time display editor.
7
8The file INSTALL in this directory says how to build and install GNU
9Emacs on various systems, once you have unpacked or checked out the
10entire Emacs file tree.
11
12See the file etc/NEWS for information on new features and other
13user-visible changes in recent versions of Emacs.
14
15The file etc/PROBLEMS contains information on many common problems that
16occur in building, installing and running Emacs.
17
18The file CONTRIBUTE contains information on contributing to Emacs as a
19developer.
20
21You may encounter bugs in this release.  If you do, please report
22them; your bug reports are valuable contributions to the FSF, since
23they allow us to notice and fix problems on machines we don't have, or
24in code we don't use often.  Please send bug reports to the mailing
25list bug-gnu-emacs@gnu.org.  If possible, use M-x report-emacs-bug.
26
27See the "Bugs" section of the Emacs manual for more information on how
28to report bugs.  (The file 'BUGS' in this directory explains how you
29can find and read that section using the Info files that come with
30Emacs.)  For a list of mailing lists related to Emacs, see
31<https://savannah.gnu.org/mail/?group=emacs>.  For the complete
32list of GNU mailing lists, see <https://lists.gnu.org/>.
33
34The 'etc' subdirectory contains several other files, named in capital
35letters, which you might consider looking at when installing GNU
36Emacs.
37
38The file 'configure' is a shell script to acclimate Emacs to the
39oddities of your processor and operating system.  It creates the file
40'Makefile' (a script for the 'make' program), which automates the
41process of building and installing Emacs.  See INSTALL for more
42detailed information.
43
44The file 'configure.ac' is the input used by the autoconf program to
45construct the 'configure' script.
46
47The shell script 'autogen.sh' generates 'configure' and other files by
48running Autoconf (which in turn uses GNU m4), and configures files in
49the .git subdirectory if you are using Git.  If you want to use it,
50you will need to install recent versions of these build tools.  This
51should be needed only if you edit files like 'configure.ac' that
52specify Emacs's autobuild procedure.
53
54The file 'Makefile.in' is a template used by 'configure' to create
55'Makefile'.
56
57The file 'make-dist' is a shell script to build a distribution tar
58file from the current Emacs tree, containing only those files
59appropriate for distribution.  If you make extensive changes to Emacs,
60this script will help you distribute your version to others.
61
62There are several subdirectories:
63
64'src'       holds the C code for Emacs (the Emacs Lisp interpreter and
65            its primitives, the redisplay code, and some basic editing
66            functions).
67'lisp'      holds the Emacs Lisp code for Emacs (most everything else).
68'leim'      holds the original source files for the generated files
69            in lisp/leim.  These form the library of Emacs input methods,
70            required to type international characters that can't be
71            directly produced by your keyboard.
72'lib'       holds source code for libraries used by Emacs and its utilities
73'lib-src'   holds the source code for some utility programs for use by or
74            with Emacs, like movemail and etags.
75'lwlib'     holds the sources of the Lucid Widget Library used on X.
76'oldXMenu'  source files from X11R2 XMenu library, used in non-toolkit builds.
77'etc'       holds miscellaneous architecture-independent data files Emacs
78            uses, like the tutorial text and tool bar images.
79            The contents of the 'lisp', 'leim', 'info', and 'doc'
80            subdirectories are architecture-independent too.
81'info'      holds the Info documentation tree for Emacs.
82'doc/emacs' holds the source code for the Emacs Manual.  If you modify the
83            manual sources, you will need the 'makeinfo' program to produce
84            an updated manual.  'makeinfo' is part of the GNU Texinfo
85            package; you need a suitably recent version of Texinfo.
86'doc/lispref'   holds the source code for the Emacs Lisp reference manual.
87'doc/lispintro' holds the source code for the Introduction to Programming
88                in Emacs Lisp manual.
89'msdos'     holds configuration files for compiling Emacs under MS-DOS.
90'nextstep'  holds instructions and some other files for compiling the
91            Nextstep port of Emacs, for GNUstep and macOS Cocoa.
92'nt'        holds code and documentation for building Emacs on MS-Windows.
93'test'      holds tests for various aspects of Emacs's functionality.
94'modules'   holds the modhelp.py helper script.
95'admin'     holds files used by Emacs developers, and Unicode data files.
96'build-aux' holds auxiliary files used during the build.
97'm4'        holds Autoconf macros used for generating the configure script.
98
99   Building Emacs on non-Posix platforms requires tools that aren't part
100of the standard distribution of the OS.  The platform-specific README
101files and installation instructions should list the required tools.
102
103
104NOTE ON COPYRIGHT YEARS
105
106In copyright notices where the copyright holder is the Free Software
107Foundation, then where a range of years appears, this is an inclusive
108range that applies to every year in the range.  For example: 2005-2008
109represents the years 2005, 2006, 2007, and 2008.
110
111
112This file is part of GNU Emacs.
113
114GNU Emacs is free software: you can redistribute it and/or modify
115it under the terms of the GNU General Public License as published by
116the Free Software Foundation, either version 3 of the License, or
117(at your option) any later version.
118
119GNU Emacs is distributed in the hope that it will be useful,
120but WITHOUT ANY WARRANTY; without even the implied warranty of
121MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
122GNU General Public License for more details.
123
124You should have received a copy of the GNU General Public License
125along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
126