Micro GNU Emacs-like text editor for Linux and UNIX
Switch branches/tags
Clone or download
troglobit Fix --with-startup=foo and --disable-all for startup file
The --disable-all should always disable all features, regardless of any
other option.

Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
Latest commit 38505bf Oct 14, 2018

README.md

Micro Emacs

License Badge Travis Status Coverity Status

Mg is a public domain Micro Emacs derivative. Created in 1986 based on the original MicroEMACS released by Dave Conroy in 1985.

The intention is to be a small, fast, and portable Emacs-like editor for users who cannot, or do not want to, run the real Emacs for one reason or another. Compatibility with GNU Emacs is key for Mg, separating it from other ErsatzEmacs clones, because there should never be any reason to learn more than one Emacs flavor.

The size constraints and target audience pose challenging limitations on the feature set of Mg. It is not scriptable or extensible like a true Emacs, although a startup file is supported, and not all features are available.

Feature patches are of course most welcome, as long as they remain in the spirit of Mg -- to be small, fast, and portable.

Supported Platforms

This project has been extensively tested on Debian GNU/Linux, Ubuntu, CentOS, Fedora, Alpine Linux, FreeBSD, NetBSD, OpenBSD, DragonFly BSD, Apple macOS >= 10.10, Cygwin, as well as a few embedded Linux systems.

Note: the official portable Mg project, used by Debian and other GNU/Linux distributions, is maintained by Han Boetes. Unlike this project, which is stand-alone, it uses libbsd to maintain portability and follows the OpenBSD version very closely.

Building

This project maintains a set of patches on top of OpenBSD Mg, one of which is a standard GNU configure script to simplify building on various UNIX systems, as well as cross compilation to different targets.

The project is almost completely self hosting, you need a 3rd party termcap library, or ncurses, to provide terminal manipulation APIs like setupterm(), tgoto(), and tputs().

On Debian/Ubuntu based systems libtinfo-dev can be used:

sudo apt install libtinfo-dev

On other systems you may have to install ncurses instead, on RHEL, CentOS, and Fedora:

sudo yum install ncurses-devel

or

sudo dnf install ncurses-devel

On macOS you need the Xcode command line toolls and headers.

 xcode-select --install

Then build Mg from the unpacked release tarball:

./configure
make
sudo make install

Users who checked out the source from GitHub must run ./autogen.sh first to create the configure script. This requires GNU autotools to be installed on the build system.

There are several options to the configure script to disable features, e.g., to reduce the size, or remove features if you want to be on par with the official Mg. By default, all below features are enabled:

./configure --help
[..]
--disable-autoexec   Disable auto-execute support
--disable-cmode      Disable C-mode support
--disable-compile    Disable C compile & grep mode, used by C-mode
--disable-cscope     Disable Cscope support
--disable-ctags      Disable ctags(1) support, required by Cscope
--disable-dired      Disable directory editor
--disable-notab      Disable notab mode support (not in OpenBSD)
--disable-regexp     Disable full regexp search
--disable-togglenl   Disable toggle-newline-prompt extension (not in OpenBSD)
--disable-all        Disable all optional features
[..]
--with-startup=FILE  Init file to run at startup if ~/.mg is missing

To build the smallest possible mg, with many features removed:

./configure --disable-all --enable-size-optimizations
make
sudo make install-strip

To build a completely static mg with all features:

./configure LDFLAGS="-static"
make
sudo make install-strip

History

The history is long and intertwined with other MicroEMACS spin-offs but goes something like this:

  • Nov 16, 1986: First release to mod.sources
  • Mar 3, 1987: First Release (mg1a) via comp.sources.unix
  • May 26, 1988: Second release: (mg2a) via comp.sources.misc
  • Jan 26, 1992: Linux port released by Charles Hedrick. This version later makes its way onto tsx-11, Infomagic, and various other Linux repositories.
  • Feb 25, 2000: First import into the OpenBSD tree, where it is currently maintained with contributions from many others.
  • May 8, 2016: First import from OpenBSD 5.9 to GitHub
  • May 15, 2016: First major release from GitHub
  • Jul 22, 2018: Second major release from GitHub, now standalone!
  • Aug 26, 2018: Third major release from GitHub, now portable!

See the source distribution for the list of AUTHORS.

Origin and References

This project is derived from OpenBSD Mg, which is the best (maintained) source of the original Micro Emacs. The intention of this project is to track all clones, and unlike the OpenBSD version, enable as much of its hidden features as possible using a standard GNU configure script, while being friendly to porting to resource constrained systems.

Currently merged, and continously tracked, clones:

Please report any bugs and problems with the packaging and porting to the GitHub issue tracker https://github.com/troglobit/mg/issues