diff modules/README @ 996:25e260cb7994

[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
line wrap: on
line diff
--- a/modules/README	Mon Sep 09 21:53:43 2002 +0000
+++ b/modules/README	Tue Sep 10 15:27:39 2002 +0000
@@ -1,17 +1,27 @@
-This directory contains a number of sample Emacs dynamic modules.
-These modules can be loaded with the command 'M-x load-module'.
+This directory contains a number of XEmacs dynamic modules.  These
+modules can be loaded directly with the command 'M-x load-module'.
+However, the preferred method of loading a module is to issue a
+"(require 'module-name)" command to the Lisp interpreter.  This will
+store information so that a later "(unload-feature 'module-name)" can
+succeed.
 
-To compile one of these modules, simply enter the desired directory
-and type 'make'. Then, from within Emacs, load the module by
-specifying the path to the directory which contains the compiled
-module.
+To compile one of these modules, simply enter the desired directory,
+type 'configure', and then 'make'.  If you are building the module for
+an installed XEmacs, then 'make install' will place the module in the
+appropriate directory for XEmacs to find it later (assuming you have
+permission to write to that directory).  A subsequent 'load-module' or
+'require' will then load the module, as described above.
 
-Each of these samples describes different features and limitations
-of the Emacs module loading technology. Please refer to the README
-files in each directory for a brief discussion on what the sample
-in that directory is demonstrating.  For a complete discussion on
-Emacs dynamic modules, please consult the Emacs Module Writers Guide,
-which can be found in the ../info directory.
+Each of these demonstrates different features and limitations of the
+XEmacs module loading technology.  For a complete discussion on XEmacs
+dynamic modules, please consult the XEmacs Module Writers Guide, which
+can be found in the ../info directory.
 
-NOTE: As this technology matures, this directory will eventually contain
-large parts of XEmacs itself, which will be loaded in as required.
+For those wanting to get started with module writing, please see the
+'sample' directory.  It contains two subdirectories: internal and
+external.  The 'internal' subdirectory contains the framework needed to
+migrate some core piece of XEmacs functionality into code that can
+either be compiled into the core or built as a separate module.  The
+'external' subdirectory contains the somewhat simpler framework needed
+to build a module separately from XEmacs.  These should be considered
+starting places for module writing.