Mercurial > hg > xemacs-beta

annotate modules/README @ 5436:da1365dd3f07

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added GPLv3 or later license to modules/README.
author Mats Lidell <matsl@xemacs.org>
date Sat, 13 Nov 2010 00:15:58 +0100
parents 25e260cb7994
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5436
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
1 This file is part of XEmacs.
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
2
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
3 XEmacs is free software: you can redistribute it and/or modify it
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
4 under the terms of the GNU General Public License as published by the
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
5 Free Software Foundation, either version 3 of the License, or (at your
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
6 option) any later version.
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
7
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
8 XEmacs is distributed in the hope that it will be useful, but WITHOUT
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
9 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
10 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
11 for more details.
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
12
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
13 You should have received a copy of the GNU General Public License
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
14 along with XEmacs. If not, see <http://www.gnu.org/licenses/>.
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
15
da1365dd3f07 Added GPLv3 or later license to modules/README.
Mats Lidell <matsl@xemacs.org>
parents: 996
diff changeset
16
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
17 This directory contains a number of XEmacs dynamic modules. These
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
18 modules can be loaded directly with the command 'M-x load-module'.
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
19 However, the preferred method of loading a module is to issue a
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
20 "(require 'module-name)" command to the Lisp interpreter. This will
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
21 store information so that a later "(unload-feature 'module-name)" can
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
22 succeed.
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
23
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
24 To compile one of these modules, simply enter the desired directory,
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
25 type 'configure', and then 'make'. If you are building the module for
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
26 an installed XEmacs, then 'make install' will place the module in the
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
27 appropriate directory for XEmacs to find it later (assuming you have
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
28 permission to write to that directory). A subsequent 'load-module' or
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
29 'require' will then load the module, as described above.
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
30
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
31 Each of these demonstrates different features and limitations of the
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
32 XEmacs module loading technology. For a complete discussion on XEmacs
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
33 dynamic modules, please consult the XEmacs Module Writers Guide, which
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
34 can be found in the ../info directory.
388
aabb7f5b1c81 Import from CVS: tag r21-2-9
cvs
parents:
diff changeset
35
996
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
36 For those wanting to get started with module writing, please see the
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
37 'sample' directory. It contains two subdirectories: internal and
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
38 external. The 'internal' subdirectory contains the framework needed to
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
39 migrate some core piece of XEmacs functionality into code that can
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
40 either be compiled into the core or built as a separate module. The
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
41 'external' subdirectory contains the somewhat simpler framework needed
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
42 to build a module separately from XEmacs. These should be considered
25e260cb7994 [xemacs-hg @ 2002-09-10 15:27:02 by james]
james
parents: 388
diff changeset
43 starting places for module writing.