Mercurial > hg > xemacs-beta

comparison modules/README @ 996:25e260cb7994

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[xemacs-hg @ 2002-09-10 15:27:02 by james] Enable unloading of dynamic modules. Create the first two internal XEmacs modules: LDAP and postgreSQL. Update the sample directory to contain a sample internal XEmacs module and a sample external XEmacs module. Improve support for autoloading modules. Make internal module code compile into the XEmacs binary if XEmacs is configured without module support. Make the internal module directories self-contained so that they can be distributed separately from XEmacs.
author james
date Tue, 10 Sep 2002 15:27:39 +0000
parents aabb7f5b1c81
children da1365dd3f07
comparison
equal deleted inserted replaced
995:4575a219af58 996:25e260cb7994
1 This directory contains a number of sample Emacs dynamic modules. 1 This directory contains a number of XEmacs dynamic modules. These
2 These modules can be loaded with the command 'M-x load-module'. 2 modules can be loaded directly with the command 'M-x load-module'.
3 However, the preferred method of loading a module is to issue a
4 "(require 'module-name)" command to the Lisp interpreter. This will
5 store information so that a later "(unload-feature 'module-name)" can
6 succeed.
3 7
4 To compile one of these modules, simply enter the desired directory 8 To compile one of these modules, simply enter the desired directory,
5 and type 'make'. Then, from within Emacs, load the module by 9 type 'configure', and then 'make'. If you are building the module for
6 specifying the path to the directory which contains the compiled 10 an installed XEmacs, then 'make install' will place the module in the
7 module. 11 appropriate directory for XEmacs to find it later (assuming you have
12 permission to write to that directory). A subsequent 'load-module' or
13 'require' will then load the module, as described above.
8 14
9 Each of these samples describes different features and limitations 15 Each of these demonstrates different features and limitations of the
10 of the Emacs module loading technology. Please refer to the README 16 XEmacs module loading technology. For a complete discussion on XEmacs
11 files in each directory for a brief discussion on what the sample 17 dynamic modules, please consult the XEmacs Module Writers Guide, which
12 in that directory is demonstrating. For a complete discussion on 18 can be found in the ../info directory.
13 Emacs dynamic modules, please consult the Emacs Module Writers Guide,
14 which can be found in the ../info directory.
15 19
16 NOTE: As this technology matures, this directory will eventually contain 20 For those wanting to get started with module writing, please see the
17 large parts of XEmacs itself, which will be loaded in as required. 21 'sample' directory. It contains two subdirectories: internal and
22 external. The 'internal' subdirectory contains the framework needed to
23 migrate some core piece of XEmacs functionality into code that can
24 either be compiled into the core or built as a separate module. The
25 'external' subdirectory contains the somewhat simpler framework needed
26 to build a module separately from XEmacs. These should be considered
27 starting places for module writing.