r11764: 2007-07-22 Kevin Rosenberg (kevin@rosenberg.net)

[uffi.git] / doc / ref_func_libr.xml

diff --git a/doc/ref_func_libr.xml b/doc/ref_func_libr.xml
index 358abe6b01dc15b50ce57e184a20b6a47f7ed673..da8b9b73c87a600dd371985a3b26fb56ca716d34 100644 (file)
--- a/doc/ref_func_libr.xml
+++ b/doc/ref_func_libr.xml
@@ -1,7 +1,7 @@
-<?xml version='1.0' ?>   <!-- Mode: Docbook --> 
+<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-               "file:///usr/share/sgml/docbook/dtd/xml/4.2/docbookx.dtd" [
-<!ENTITY % myents SYSTEM "entities.xml">
+               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY % myents SYSTEM "entities.inc">
 %myents;
 ]>
 
@@ -61,12 +61,12 @@ foreign function. If <constant>:void</constant> indicates module does not return
       </refsect1>
       <refsect1>
        <title>Examples</title>
-       <programlisting>
+       <screen>
 (def-function "gethostname" 
   ((name (* :unsigned-char))
    (len :int))
   :returning :int)
-       </programlisting>
+       </screen>
       </refsect1>
       <refsect1>
        <title>Side Effects</title>
@@ -103,7 +103,10 @@ foreign function. If <constant>:void</constant> indicates module does not return
            <listitem>
              <para>A string or pathname specifying the library location
 in the filesystem. At least one implementation (&lw;) can not
-accept a logical pathname.
+accept a logical pathname.  If this parameter denotes a pathname without a
+directory component then most of the supported Lisp implementations will be
+able to find the library themselves if it is located in one of the standard
+locations as defined by the underlying operating system.
              </para>
            </listitem>
          </varlistentry>
@@ -135,7 +138,6 @@ link the foreign library. (Required by CMUCL)
            <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>
@@ -150,12 +152,12 @@ a session. A library can be reloaded by using the <symbol>:force-load</symbol> k
       </refsect1>
       <refsect1>
        <title>Examples</title>
-       <programlisting>
+       <screen>
   (load-foreign-library #p"/usr/lib/libmysqlclient.so" 
                         :module "mysql" 
                         :supporting-libraries '("c"))
     => T
-       </programlisting>
+       </screen>
       </refsect1>
       <refsect1>
        <title>Side Effects</title>
@@ -168,7 +170,7 @@ a session. A library can be reloaded by using the <symbol>:force-load</symbol> k
       </refsect1>
       <refsect1>
        <title>Exceptional Situations</title>
-       <para>None.</para>
+       <para>An error will be signaled if the library is unable to be loaded.</para>
       </refsect1>
     </refentry>
 
@@ -234,13 +236,13 @@ the path of the first found file.
       </refsect1>
       <refsect1>
        <title>Examples</title>
-       <programlisting>
+       <screen>
 (find-foreign-library '("libmysqlclient" "libmysql")
     '("/opt/mysql/lib/mysql/" "/usr/local/lib/" "/usr/lib/" "/mysql/lib/opt/")
     :types '("so" "dll")
     :drive-letters '("C" "D" "E"))
 => #P"D:\\mysql\\lib\\opt\\libmysql.dll"
-       </programlisting>
+       </screen>
       </refsect1>
       <refsect1>
        <title>Side Effects</title>