r1536: *** empty log message ***

diff --git a/doc/ref.sgml b/doc/ref.sgml
index 2fbf5ddcf6d70b28e52246815abb7f60a408a30a..6b794780a597b65a281d9797d9656b44053be9bc 100644 (file)
--- a/doc/ref.sgml
+++ b/doc/ref.sgml
@@ -330,15 +330,86 @@ always need to have memory for them.
 
     <sect1>
       <title>Libraries</title>
-      <sect2>
-       <title>load-foreign-library</title>
-       <para>
-         This function loads foreign libraries. It has checks to
-         ensure that a library is loaded only once during a session.
-       </para>
-      </sect2>
-    </sect1>
-
+      <refentry id="load-foreign-library">
+       <refnamediv>
+         <refname>load-foreign-library</refname>
+       <refpurpose>Loads a foreign library. 
+       </refpurpose>
+       <refclass>Function</refclass>
+      </refnamediv>
+      <refsect1>
+       <title>Syntax</title>
+<synopsis>
+         <function>load-foreign-library</function> <replaceable>filename module supporting-libraries</replaceable> => <returnvalue>success</returnvalue>
+</synopsis>
+      </refsect1>
+      <refsect1>
+       <title>Arguments and Values</title>
+       <variablelist>
+         <varlistentry>
+           <term><parameter>filename</parameter></term>
+           <listitem>
+             <para>A string or pathname specifying the library location
+in the filesystem.
+             </para>
+           </listitem>
+         </varlistentry>
+         <varlistentry>
+           <term><parameter>module</parameter></term>
+           <listitem>
+             <para>A string designating the name of the module to apply
+to functions in this library. (Required for Lispworks)
+             </para>
+           </listitem>
+         </varlistentry>
+         <varlistentry>
+           <term><parameter>supporting-libraries</parameter></term>
+           <listitem>
+             <para>A list of strings naming the libraries required to
+link the foreign library. (Required by CMUCL)
+             </para>
+           </listitem>
+         </varlistentry>
+         <varlistentry>
+           <term><returnvalue>success</returnvalue></term>
+           <listitem>
+             <para>A boolean flag, &t; if the library was able to be
+loaded successfully or if the library has been previously loaded,
+otherwise &nil;.
+             </para>
+           </listitem>
+         </varlistentry>
+       </variablelist>
+      </refsect1>
+      <refsect1>
+       <title>Description</title>
+       <para>Loads a foreign library. Applies a module name to functions
+within the library. Ensures that a library is only loaded once during
+a session.
+       </para>
+      </refsect1>
+      <refsect1>
+       <title>Examples</title>
+       <programlisting>
+  (load-foreign-library #p"/usr/lib/libmysqlclient.so" "mysql" '("c"))
+    => T
+       </programlisting>
+      </refsect1>
+      <refsect1>
+       <title>Side Effects</title>
+       <para>Loads the foreign code into the Lisp system.
+       </para>
+      </refsect1>
+      <refsect1>
+       <title>Affected by</title>
+       <para>Ability to load the file.</para>
+      </refsect1>
+      <refsect1>
+       <title>Exceptional Situations</title>
+       <para>None.</para>
+      </refsect1>
+    </refentry>
+  </sect1>
   </chapter>