2
2
This is the README file for Emacs Muse.
4
The terms "Emacs Muse", and "Muse" are used interchangeably throughout
5
this document to refer to this software.
4
The terms "Emacs Muse", "Emacs-Muse", and "Muse" are used
5
interchangeably throughout this document to refer to this software.
48
48
You need either Emacs (21.1 or greater), XEmacs (21.4 or greater), or
49
49
SXEmacs (warning: Muse has not been tested with SXEmacs). The current
50
maintainer recommend using Emacs.
50
maintainer recommends using Emacs.
55
55
This is an optional step, since Emacs Lisp source code does not
56
necessarily have to be byte-compiled. It will yield a speed increase,
56
necessarily have to be byte-compiled. It may yield a slight speed
59
59
A working copy of Emacs or XEmacs is needed in order to compile the
60
60
Emacs Muse. By default, the program that is installed with the name
61
61
`emacs' will be used.
63
63
If you want to use the `xemacs' binary to perform the compilation, you
64
would need to edit `Makefile.defs' in the top-level directory as
65
follows. You can put either a full path to an Emacs or XEmacs binary
66
or just the command name, as long as it is in the PATH.
64
must copy `Makefile.defs.default' to `Makefile.defs' in the top-level
65
directory, and then edit `Makefile.defs' as follows. You can put
66
either a full path to an Emacs or XEmacs binary or just the command
67
name, as long as it is in the PATH. Depending on your setup, changes
68
to the PREFIX, ELISPDIR, and/or INFODIR variables may also need to be
69
72
SITEFLAG = -no-site-file
73
# Edit the section as necessary
74
install_info = install-info --section "XEmacs 21.4" $(1).info \
71
Running `make' should compile the Muse source files in the `lisp'
77
Running `make' in the top-level directory should compile the Muse
78
source files in the `lisp' directory, and generate an autoloads
79
file in `lisp/muse-autoloads.el'.
77
84
Muse may be installed into your file hierarchy by doing the following.
79
Edit the `Makefile.defs' file so that ELISPDIR points to where you
80
want the source and compiled Muse files to be installed and INFODIR
81
indicates where to put the Muse manual. Of course, you will want to
86
Copy `Makefile.defs.default' to `Makefile.defs' in the top-level
87
directory, if you haven't done so already. Then edit the
88
`Makefile.defs' file so that ELISPDIR points to where you want the
89
source and compiled Muse files to be installed and INFODIR indicates
90
where to put the Muse manual. As mentioned earlier, you will want to
82
91
edit EMACS and SITEFLAG as shown in the Compilation section if you are
89
98
If you wish to install Muse to different locations than the defaults
90
99
specify, edit `Makefile.defs' accordingly.
92
Run `make' as a normal user.
101
Run `make' as a normal user, if you haven't done so already.
94
103
Run `make install' as the root user if you have chosen installation
95
104
locations that require this.
125
134
This manual is also available online in several forms.
127
- PDF: http://www.mwolson.org/static/doc/muse.pdf
128
- HTML (single file): http://www.mwolson.org/static/doc/muse.html
129
- HTML (multiple files): http://www.mwolson.org/static/doc/muse/
136
- PDF: http://mwolson.org/static/doc/muse.pdf
137
- HTML (single file): http://mwolson.org/static/doc/muse.html
138
- HTML (multiple files): http://mwolson.org/static/doc/muse/
157
166
The current maintainer's webpage for Muse is at
158
http://www.mwolson.org/projects/EmacsMuse.html.
167
http://mwolson.org/projects/EmacsMuse.html.
169
If you wish to participate in the development of Muse, or track the
170
latest development changes, please read the `Development' section of
171
the Muse manual (in the `Obtaining Muse' chapter) for instructions.
212
225
Emacs Muse is free software; you can redistribute it and/or modify it
213
226
under the terms of the GNU General Public License as published by the
214
Free Software Foundation; either version 2, or (at your option) any
227
Free Software Foundation; either version 3, or (at your option) any
217
230
Emacs Muse is distributed in the hope that it will be useful, but
236
249
The PNG images included in the examples/ directory may be used,
237
250
distributed, and modified without restriction.
252
The contents of the contrib/blosxom and contrib/pyblosxom directories
253
are available under the terms of other licenses. Please consult the
254
header of each file for the appropriate license text.
added
removed
README
