diff options
author | Neil Jerram <neil@ossau.uklinux.net> | 2001-11-11 15:01:52 +0000 |
---|---|---|
committer | Neil Jerram <neil@ossau.uklinux.net> | 2001-11-11 15:01:52 +0000 |
commit | 9401323e63278a7053c54565e8d688f6cbe34f54 (patch) | |
tree | 01e0840bac67d78e974b03200f9cf16f894fea37 /libguile/extensions.c | |
parent | a0a9b9ad4263e129e46e31a8c0c2e7775b037ee9 (diff) | |
download | guile-9401323e63278a7053c54565e8d688f6cbe34f54.tar.gz |
* Documentation work.
Diffstat (limited to 'libguile/extensions.c')
-rw-r--r-- | libguile/extensions.c | 64 |
1 files changed, 34 insertions, 30 deletions
diff --git a/libguile/extensions.c b/libguile/extensions.c index b549f0fc7..48e39420c 100644 --- a/libguile/extensions.c +++ b/libguile/extensions.c @@ -117,36 +117,40 @@ scm_c_load_extension (const char *lib, const char *init) SCM_DEFINE (scm_load_extension, "load-extension", 2, 0, 0, (SCM lib, SCM init), - "Load and initilize the extension designated by LIB and INIT." -"When there is no pre-registered function for LIB/INIT, this is " -"equivalent to " -" " -" (dynamic-call INIT (dynamic-link LIB)) " -" " -"When there is a pre-registered function, that function is called " -"instead. " -" " -"Normally, there is no pre-registered function. This option exists " -"only for situations where dynamic linking is unavailable or unwanted. " -"In that case, you would statically link your program with the desired " -"library, and register its init function right after Guile has been " -"initialized. " -" " -"LIB should be a string denoting a shared library without any file type " -"suffix such as \".so\". The suffix is provided automatically. It " -"should also not contain any directory components. Libraries that " -"implement Guile Extensions should be put into the normal locations for " -"shared libraries. We recommend to use the naming convention " -"libguile-bla-blum for a extension related to a module `(bla blum)'. " -" " -"The normal way for a extension to be used is to write a small Scheme " -"file that defines a module, and to load the extension into this " -"module. When the module is auto-loaded, the extension is loaded as " -"well. For example, " -" " -" (define-module (bla blum)) " -" " -" (load-extension \"libguile-bla-blum\" \"bla_init_blum\")") + "Load and initilize the extension designated by LIB and INIT.\n" + "When there is no pre-registered function for LIB/INIT, this is\n" + "equivalent to\n" + "\n" + "@lisp\n" + "(dynamic-call INIT (dynamic-link LIB))\n" + "@end lisp\n" + "\n" + "When there is a pre-registered function, that function is called\n" + "instead.\n" + "\n" + "Normally, there is no pre-registered function. This option exists\n" + "only for situations where dynamic linking is unavailable or unwanted.\n" + "In that case, you would statically link your program with the desired\n" + "library, and register its init function right after Guile has been\n" + "initialized.\n" + "\n" + "LIB should be a string denoting a shared library without any file type\n" + "suffix such as \".so\". The suffix is provided automatically. It\n" + "should also not contain any directory components. Libraries that\n" + "implement Guile Extensions should be put into the normal locations for\n" + "shared libraries. We recommend to use the naming convention\n" + "libguile-bla-blum for a extension related to a module `(bla blum)'.\n" + "\n" + "The normal way for a extension to be used is to write a small Scheme\n" + "file that defines a module, and to load the extension into this\n" + "module. When the module is auto-loaded, the extension is loaded as\n" + "well. For example,\n" + "\n" + "@lisp\n" + "(define-module (bla blum))\n" + "\n" + "(load-extension \"libguile-bla-blum\" \"bla_init_blum\")\n" + "@end lisp") #define FUNC_NAME s_scm_load_extension { SCM_VALIDATE_STRING (1, lib); |