GNU Emacs - Emacs Tutorial

GNU Emacs is the most popular and most ported Emacs text editor. It was created by GNU Project founder Richard Stallman. In common with other varieties of Emacs, GNU Emacs is extensible using a Turing complete programming language. GNU Emacs has been called "the most powerful text editor available today." With proper support from the underlying system, GNU Emacs is able to display files in multiple character sets, and has been able to simultaneously display most human languages since at least 1999. Throughout its history, GNU Emacs has been a central component of the GNU project, and a flagship of the free software movement. GNU Emacs is sometimes abbreviated as GNUMACS, especially to differentiate it from other EMACS variants. The tag line for GNU Emacs is "the exte nsible self-documenting text editor".

History

In 1976, Stallman wrote the first Emacs (â€œEditor MACroSâ€), and in 1984, began work on GNU Emacs, to produce a free software alternative to the proprietary Gosling Emacs. GNU Emacs was initially based on Gosling Emacs, but Stallman's replacement of its Mocklisp interpreter with a true Lisp interpreter required that nearly all of its code be rewritten. This became the first program released by the nascent GNU Project. GNU Emacs is written in C and provides Emacs Lisp, also implemented in C, as an extension language. Version 13, the first public release, was made on March 20, 1985. The first widely distributed version of GNU Emacs was version 15.34, released later in 1985. Early versions of GNU Emacs were numbered as "1.x.x," with the initial digit denoting the version of the C core. The "1" was dropped after version 1.12 as it was thought that the major number would never change, and thus the major version skipped from "1" to "13". A new third version number was added to represe nt changes made by user sites. In the current numbering scheme, a number with two components signifies a release version, with development versions having three components.

GNU Emacs was later ported to Unix. It offered more features than Gosling Emacs, in particular a full-featured Lisp as its extension language, and soon replaced Gosling Emacs as the de facto Unix Emacs editor. Markus Hess exploited a security flaw in GNU Emacs' email subsystem in his 1986 cracking spree, in which he gained superuser access to Unix computers.

Although users commonly submitted patches and Elisp code to the net.emacs newsgroup, participation in GNU Emacs development was relatively restricted until 1999, and was used as an example of the "Cathedral" development style in The Cathedral and the Bazaar. The project has since adopted a public development mailing list and anonymous CVS access. Development took place in a single CVS trunk until 2008, and today uses the Git DVCS.

Richard Stallman has remained the principal maintainer of GNU Emacs, but he has stepped back from the role at times. Stefan Monnier and Chong Yidong have overseen maintenance since 2008. On September 21, 2015 Monnier announced that he would be stepping down as maintainer effective with the feature freeze of Emacs 25. Longtime contributor John Wiegley was announced as the new maintainer on November 5, 2015

Licensing

The terms of the GNU General Public License (GPL) state that the Emacs source code, including both the C and Emacs Lisp components, are freely available for examination, modification, and redistribution.

Older versions of the GNU Emacs documentation appeared under an ad-hoc license that required the inclusion of certain text in any modified copy. In the GNU Emacs user's manual, for example, this included instructions for obtaining GNU Emacs and Richard Stallman's essay The GNU Manifesto. The XEmacs manuals, which were inherited from older GNU Emacs manuals when the fork occurred, have the same license. Newer versions of the documentation use the GNU Free Documentation License with "invariant sections" that require the inclusion of the same documents and that the manuals proclaim themselves as GNU Manuals.

For GNU Emacs, like many other GNU packages, it remains policy to accept significant code contributions only if the copyright holder executes a suitable disclaimer or assignment of their copyright interest to the Free Software Foundation. Bug fixes and minor code contributions of fewer than 10 lines are exempt. This policy is in place so that the FSF can defend the software in court if its copyleft license is violated.

In 2011 it was noticed that GNU Emacs had been violating the GPL for two years. Richard Stallman described this incident as "a very bad mistake", which was promptly fixed.

Using GNU Emacs

Commands

In its normal editing mode, GNU Emacs behaves like other text editors and allows the user to insert characters with the corresponding keys and to move the editing point with the arrow keys. Escape key sequences or pressing the control key and/or the meta key, alt key or super keys in conjunction with a regular key produces modified keystrokes that invoke functions from the Emacs Lisp environment. Commands such as save-buffer and save-buffers-kill-emacs combine multiple modified keystrokes.

Some GNU Emacs commands work by invoking an external program, such as ispell for spell-checking or GNU Compiler Collection (gcc) for program compilation, parsing the program's output, and displaying the result in GNU Emacs. Emacs also supports "inferior processes"â€"long-lived processes that interact with an Emacs buffer. This is used to implement shell-mode, running a Unix shell as inferior process, as well as REPL modes for various programming languages. Emacs' support for external processes makes it an attractive environment for interactive programming along the lines of Interlisp or Smalltalk.

Users who prefer IBM Common User Access-style keys can use cua-mode, a package that originally was a third-party add-on but has been included in GNU Emacs since version 22.

Minibuffer

Emacs uses the "minibuffer," normally the bottommost line, to present status and request informationâ€"the functions that would typically be performed by dialog boxes in most GUIs. The minibuffer holds information such as text to target in a search or the name of a file to read or save. When applicable, command line completion is available using the tab and space keys.

File management and display

Emacs keeps text in data structures known as buffers. Buffers may or may not be displayed onscreen, and all buffer features are accessible to an Emacs Lisp program and to the user interface. The user can create new buffers and dismiss unwanted ones, and several buffers can exist at the same time. There is no upper limit on the number of buffers Emacs allows, other than hardware memory limits. Advanced users may amass hundreds of open buffers of various types relating to their current work.

Some buffers contain text loaded from text files, which the user can edit and save back to permanent storage. These buffers are said to be "visiting" files. Buffers also serve to display other data, such as the output of Emacs commands, dired directory listings, documentation strings displayed by the "help" library and notification messages that in other editors would be displayed in a dialog box. These notifications are displayed briefly in the minubuffer, and GNU Emacs provides a *Messages* buffer that keeps a history of the most recent notifications of this type. Buffers can also serve as input and output areas for an external process such as a shell or REPL. Buffers which Emacs creates on its own are typically named with asterisks on each end, to distinguish from user buffers. The list of open buffers is itself displayed in this type of buffer.

Most Emacs key sequences remain functional in any buffer. For example, the standard Ctrl-s isearch function can be used to search filenames in dired buffers, and the file list can be saved to a text file just as any other buffer. dired buffers can be switched to a writable mode, in which filenames and attributes can be edited textually; when the buffer is saved, the changes are written to the filesystem. This allows multiple files to be renamed using the search and replace features of Emacs. When so equipped, Emacs displays image files in buffers. Emacs is binary safe and 8-bit clean.

Emacs can split the editing area into separate sections called "windows," a feature that has been available since 1975, predating the graphical user interface in common use. In Emacs terminology, "Windows" are similar to what other systems call "frames" or "panes" - a rectangular portion of the program's display that can be updated and interacted with independently. Each Emacs window has a status bar called the "mode line" displayed by default at the bottom edge of the window. Emacs windows are available both in text-terminal and graphical modes and allow more than one buffer, or several parts of a buffer, to be displayed at once. Common applications are to display a dired buffer along with the contents of files in the current directory (there are special modes to make the file buffer follow the file highlighted in dired), to display the source code of a program in one window while another displays a shell buffer with the results of compiling the program, to run a debugger along w ith a shell buffer running the program, to work on code while displaying a man page or other documentation (possibly loaded over the World Wide Web using one of Emacs' built-in web browsers) or simply to display multiple files for editing at once such as a header along with its implementation file for C-based languages. In addition, there is follow-mode, a minor mode that chains windows to display non-overlapping portions of a buffer. Using follow-mode, a single file can be displayed in multiple side-by-side windows that update appropriately when scrolled. Emacs windows are tiled and cannot appear "above" or "below" their companions. Emacs can launch multiple "frames", which are displayed as individual windows in a graphical environment. On a text terminal, multiple frames are displayed stacked filling the entire terminal, and can be switched using the standard Emacs commands.

Major modes

GNU Emacs can edit a variety of different types of text and adapts its behavior by entering add-on modes called "major modes." Defined major modes exist for many different file types including ordinary text files, the source code of many programming languages, HTML documents, and TeX and LaTeX documents. Each major mode involves an Emacs Lisp program that extends the editor to behave more conveniently for the specified type of text. Major modes typically provide some or all of the following common features:

Syntax highlighting ("font lock"): combinations of fonts and colors, termed "faces," that differentiate between document elements such as keywords and comments.
Automatic indentation to maintain consistent formatting within a file.
The automatic insertion of elements required by the structure of the document, such as spaces, newlines, and parentheses.
Special editing commands, such as commands to jump to the beginning or the end of a function while editing a programming file or commands to validate documents or insert closing tags while working with markup languages such as XML.

Minor modes

The use of "minor modes" enables further customization. A GNU Emacs editing buffer can use only one major mode at a time, but multiple minor modes can operate simultaneously. These may operate directly on documents, as in the way the major mode for the C programming language defines a separate minor mode for each of its popular indent styles, or they may alter the editing environment. Examples of the latter include a mode that adds the ability to undo changes to the window configuration and one that performs on-the-fly syntax checking. There is also a minor mode that allows multiple major modes to be used in a single file, for convenience when editing a document in which multiple programming languages are embedded.

"Batch mode"

GNU Emacs supports the capability to use it as an interpreter for the Emacs Lisp language without displaying the text editor user interface. In batch mode, user configuration is not loaded and the terminal interrupt characters C-c and C-z will have their usual effect of exiting the program or suspending execution instead of invoking Emacs keybindings. GNU Emacs has command line options to specify either a file to load and execute, or an Emacs Lisp function may be passed in from the command line. Emacs will start up, execute the passed-in file or function, print the results, then exit. The shebang line #!/usr/bin/emacs --script allows the creation of standalone scripts in Emacs Lisp. Batch mode is not an Emacs mode per se, but describes an alternate execution mode for the Emacs program.

Manuals

Apart from the built-in documentation, GNU Emacs has an unusually long and detailed manual. An electronic copy of the GNU Emacs Manual, written by Richard Stallman, is bundled with GNU Emacs and can be viewed with the built-in info browser. Two additional manuals, the Emacs Lisp Reference Manual by Bil Lewis, Richard Stallman, and Dan Laliberte and An Introduction to Programming in Emacs Lisp by Robert Chassell, are included. All three manuals are also published in book form by the Free Software Foundation. The XEmacs manual is similar to the GNU Emacs Manual, from which it forked at the same time that the XEmacs software forked from GNU Emacs.

Internationalization

GNU Emacs has support for many alphabets, scripts, writing systems, and cultural conventions and provides spell-checking for many languages by calling external programs such as ispell. Version 24 added support for bidirectional text and left-to-right and right-to-left writing direction for languages such as Arabic, Persian and Hebrew.

Many character encoding systems, including UTF-8, are supported. GNU Emacs uses UTF-8 for its encoding as of GNU 23, while prior versions used their own encoding internally and performed conversion upon load and save. The internal encoding used by XEmacs is similar to that of GNU Emacs but differs in details.

The GNU Emacs user interface originated in English and, with the exception of the beginners' tutorial, has not been translated into any other language.

A subsystem called Emacspeak enables visually impaired and blind users to control the editor through audio feedback.

Extensibility

The behavior of GNU Emacs can be modified and extended almost without limit by incorporating Emacs Lisp programs that define new commands, new buffer modes, new keymaps, add command-line options, and so on. Many extensions providing user-facing functionality define a major mode (either for a new file type or to build a non-text-editing user interface); others define only commands or minor modes, or provide functions that enhance another extension.

Many extensions are bundled with the GNU Emacs installation; others used to be downloaded as loose files (the Usenet newsgroup gnu.emacs.sources was a traditional source) but there has been a development of managed packages and package download sites since version 24, with a built-in package manager (itself an extension) to download, install, and keep them up to date.

A few examples include:

AUCTeX, tools to edit and process TeX and LaTeX documents
Calc, a powerful RPN numerical calculator
Calendar-mode, for keeping appointment calendars and diaries
dired, a file manager
Dissociated press, a Racter-like text generator
Doctor, a psychoanalysis simulation inspired by ELIZA
Dunnet, a text adventure
Ediff and Emerge, for comparing and combining files interactively.
Emacs/W3, a text-based web browser written in Emacs Lisp, primarily by William M. Perry. Emacs/W3 is part of the Sumo package for XEmacs, and the submodule for fetching a URL is currently part of the GNU Emacs CVS repository. Dave Raggett was supported by Emacs/W3 and by tkWWW while working on a successor to HTML 2 called HTML+.
ERC and rcirc and Circe, IRC clients
Emacs Speaks Statistics (ESS) modes for editing statistical languages like R and SAS
Emacs Web Wowser (EWW), a built-in web browser
Eshell, a command line shell written in Emacs Lisp. This allows closer integration with the Emacs environment than standard shells such as bash or PowerShell, which are also available from within Emacs.
Exwm, an X window manager allowing X11 apps to be run in an Emacs window.
Gnus, a full-featured news client (newsreader) and email client and early evidence for Zawinski's Law
MULtilingual Enhancement to Emacs (MULE) allows editing of text in multiple languages in a manner somewhat analogous to Unicode
Org-mode for keeping notes, maintaining various types of lists, planning and measuring projects, and composing documents in many formats (such as PDF, HTML, or OpenDocument formats). There are static site generators using org mode, as well as an extension, Babel, allowing it to be used for literate programming.
Texinfo (Info), an online help-browser
Planner, a personal information manager
Simple Emacs Spreadsheet (SES), a spreadsheet
SQL Interaction Mode, a mode for interacting with various flavours of SQL database servers.
Superior Lisp Interaction Mode for Emacs (SLIME) extends GNU Emacs into a development environment for Common Lisp. With SLIME (written in Emacs Lisp) the GNU Emacs editor communicates with a Common Lisp system (using the SWANK backend) over a special communication protocol and provides such tools as a readâ€"evalâ€"print loop, a data inspector and a debugger.
Viper, a vi emulation layer; also, Evil, a Vim emulation layer
View Mail (VM), another full-featured email client
W3M, another web browser, this based on and using the w3m standalone browser.
Wanderlust, a versatile email and news client
Mediawiki-mode for editing pages on MediaWiki projects
Zone, a display hack mode incorporating various text effects.

Performance

GNU Emacs often ran noticeably slower than rival text editors on the systems in which it was first implemented, because the loading and interpreting of its Lisp-based code incurs a performance overhead. Modern computers are powerful enough to run GNU Emacs without slowdowns, but versions prior to 19.29 (released in 1995) couldn't edit files larger than 8 MB. The file size limit was raised in successive versions, and 32 bit versions after GNU Emacs 23.2 can edit files up to 512 MB in size. Emacs compiled on a 64-bit machine can handle much larger buffers.

Platforms

GNU Emacs has become one of the most-ported non-trivial computer programs and runs on a wide variety of operating systems, including DOS, Windows and OpenVMS. Support for some "obsolete platforms was removed in Emacs 23.1", such as VMS and most Unix variants (except those based on Linux). It is available for most Unix-like operating systems, such as Linux, the various BSDs, Solaris, AIX, HP-UX and macOS, and is often included with their system installation packages. Native ports of GNU Emacs exist for Android and Nokia's Maemo.

GNU Emacs runs both on text terminals and in graphical user interface (GUI) environments. On Unix-like operating systems, GNU Emacs can use the X Window System to produce its GUI either directly using Athena widgets or by using a "widget toolkit" such as Motif, LessTif, or GTK+. GNU Emacs can also use the graphics systems native to macOS and Windows to provide menubars, toolbars, scrollbars and context menus conforming more closely to each platform's look and feel.

Forks

XEmacs

Lucid Emacs, based on an early version of GNU Emacs 19, was developed beginning in 1991 by Jamie Zawinski and others at Lucid Inc. One of the best-known forks in free software development occurred when the codebases of the two Emacs versions diverged and the separate development teams ceased efforts to merge them back into a single program. After Lucid filed for bankruptcy, Lucid Emacs was renamed XEmacs and remains the second most popular variety of Emacs, after GNU Emacs. XEmacs development has slowed, with the most recent stable version 21.4.22 released in January 2009, while GNU Emacs has implemented many formerly XEmacs-only features. This has led some users to proclaim XEmacs' death.

Other forks of GNU Emacs

Other forks, less known than XEmacs, include:

Meadow â€" a Japanese version for Microsoft Windows
SXEmacs â€" Steve Youngs' fork of XEmacs
Aquamacs â€" a version which focuses on integrating with the Apple Macintosh user interface

Release history

Changes in each Emacs release are listed in a NEWS file distributed with Emacs. Changes brought about by downgrading to the previous release are listed in an "Antinews" file

References

External links

Official website

Qindas Nanda