Next: , Previous: Obtaining Muse, Up: Top

4 Compiling and Installing Muse

Muse may be compiled and installed on your machine.


This is an optional step, since Emacs Lisp source code does not necessarily have to be byte-compiled. Byte-compilation may yield a very slight speed increase.

A working copy of Emacs or XEmacs is needed in order to compile Emacs Muse. By default, the program that is installed with the name emacs will be used.

If you want to use the xemacs binary to perform the compilation, you must copy Makefile.defs.default to Makefile.defs in the top-level directory, and then edit Makefile.defs as follows. You can put either a full path to an Emacs or XEmacs binary or just the command name, as long as it is in the PATH.

     EMACS    = xemacs
     SITEFLAG = -no-site-file
     # Edit the section as necessary
     install_info = install-info --section "XEmacs 21.4" $(1).info \
             $(INFODIR)/dir || :

Running make in the top-level directory should compile the Muse source files in the lisp directory, and generate an autoloads file in lisp/muse-autoloads.el.


Muse may be installed into your file hierarchy by doing the following.

Copy Makefile.defs.default to Makefile.defs in the top-level directory, if you haven't done so already. Then edit the Makefile.defs file so that ELISPDIR points to where you want the source and compiled Muse files to be installed and INFODIR indicates where to put the Muse manual. You may use a combination of DESTDIR and PREFIX to further determine where the installed files should be placed. As mentioned earlier, you will want to edit EMACS and SITEFLAG as shown in the Compilation section if you are using XEmacs.

If you are installing Muse on a Debian or Ubuntu system, you might want to change the value of INSTALLINFO as specified in Makefile.defs.

If you wish to install Muse to different locations than the defaults specify, edit Makefile.defs accordingly.

Run make as a normal user, if you haven't done so already.

Run make install as the root user if you have chosen installation locations that require root permissions.


For those used to installing software packages, there will be a muse package available in the Emacs Lisp Package Archive (abbreviated “ELPA”) as of the 3.10 release of Muse. This package will be compiled and installed automatically in a user-specific location. For more information on ELPA, see