Document which functions are in libXmu vs. libXmuu

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>

1 files changed, 56 insertions, 18 deletions

diff --git a/doc/Xmu.xml b/doc/Xmu.xml
index f0d6a05..9e3815b 100644
--- a/doc/Xmu.xml
+++ b/doc/Xmu.xml
@@ -5,7 +5,7 @@
 
 <article id='xmu'>
   <articleinfo>
-    <title>Xmu Library</title>
+    <title>Xmu and Xmuu Library API Reference</title>
     <abstract><para>&ldquo;Don't ask.&rdquo;</para></abstract>
 
     <legalnotice>
@@ -55,6 +55,24 @@ utility functions that have been useful in building various applications
 and widgets.  This library is required by the Athena Widgets.
     </para>
 
+    <para>
+Starting in XFree86 4.1.0, and incorporated into X11R6.7 and later releases,
+a subset of the functions that do not rely on the Athena Widgets (libXaw)
+or X Toolkit Instrinsics (libXt) are provided in a second library, libXmuu.
+    </para>
+
+    <para>
+Programs using either of these libraries are encouraged to determine the
+correct compiler and linker options via the <userinput>xmu</userinput> or
+<userinput>xmuu</userinput> module names for <command>pkg-config</command>,
+such as:
+
+      <screen>
+cc -c xapplication.c `pkg-config --cflags xmu`
+cc -o xapplication xapplication.o `pkg-config --libs xmu`
+      </screen>
+    </para>
+
   </sect1>
 
   <sect1 id='atom_functions'>
@@ -63,7 +81,8 @@ and widgets.  This library is required by the Athena Widgets.
     <para>
 To use the functions and macros defined in this section, you should include
 the header file
-&lt;<filename class='headerfile'>X11/Xmu/Atoms.h</filename>&gt;.
+&lt;<filename class='headerfile'>X11/Xmu/Atoms.h</filename>&gt;
+and link against the libXmu library.
     </para>
 
     <funcsynopsis>
@@ -331,7 +350,8 @@ The caller is responsible for preallocating the array pointed at by atoms.
     <para>
 To use the functions defined in this section, you should include the header
 file
-&lt;<filename class='headerfile'>X11/Xmu/Error.h</filename>&gt;.
+&lt;<filename class='headerfile'>X11/Xmu/Error.h</filename>&gt;
+and link against the libXmu or libXmuu library.
     </para>
 
     <para>
@@ -417,7 +437,8 @@ and 0 if the caller should not exit.
     <para>
 To use the functions defined in this section, you should include the header
 file
-&lt;<filename class='headerfile'>X11/Xmu/SysUtil.h</filename>&gt;.
+&lt;<filename class='headerfile'>X11/Xmu/SysUtil.h</filename>&gt;
+and link against the libXmu or libXmuu library.
     </para>
 
     <para>
@@ -491,6 +512,9 @@ in software that needs to continue to support non-Unix98 compliant platforms.
 To use the functions defined in this section, you should include the header
 file
 &lt;<filename class='headerfile'>X11/Xmu/WinUtil.h</filename>&gt;.
+To use <function>XmuClientWindow</function>, you may link against either the
+libXmu or libXmuu libraries.   The other functions in this section require
+linking against the libXmu library.
     </para>
 
     <para>
@@ -611,7 +635,8 @@ is returned.
     <para>
 To use the functions defined in this section, you should include the header
 file
-&lt;<filename class='headerfile'>X11/Xmu/CurUtil.h</filename>&gt;.
+&lt;<filename class='headerfile'>X11/Xmu/CurUtil.h</filename>&gt;
+and link against the libXmu or libXmuu library.
     </para>
 
     <para>
@@ -645,7 +670,8 @@ manual.
     <para>
 To use the functions defined in this section, you should include the header
 file
-&lt;<filename class='headerfile'>X11/Xmu/Drawing.h</filename>&gt;.
+&lt;<filename class='headerfile'>X11/Xmu/Drawing.h</filename>&gt;
+and link against the libXmu library.
     </para>
 
     <para>
@@ -1233,7 +1259,8 @@ The created pixmap is returned.
     <para>
 To use the functions defined in this section, you should include the header
 file
-&lt;<filename class='headerfile'>X11/Xmu/StdSel.h</filename>&gt;.
+&lt;<filename class='headerfile'>X11/Xmu/StdSel.h</filename>&gt;
+and link against the libXmu library.
     </para>
 
     <para>
@@ -1316,7 +1343,8 @@ if the conversion was successful, else it returns
     <para>
 To use the functions defined in this section, you should include the header
 file
-&lt;<filename class='headerfile'>X11/Xmu/Converters.h</filename>&gt;.
+&lt;<filename class='headerfile'>X11/Xmu/Converters.h</filename>&gt;
+and link against the libXmu library.
     </para>
 
     <para>
@@ -2108,7 +2136,8 @@ XtSetTypeConverter(XtRString, XtRWidget, XmuNewCvtStringToWidget,
 <para>
 To use the functions defined in this section, you should include the header
 file
-&lt;<filename class='headerfile'>X11/Xmu/CharSet.h</filename>&gt;.
+&lt;<filename class='headerfile'>X11/Xmu/CharSet.h</filename>&gt;
+and link against the libXmu or libXmuu library.
 </para>
 
     <warning><para>
@@ -2293,11 +2322,12 @@ less than second.  The two strings are assumed to be encoded using ISO
   <sect1 id='keyboard_event'>
     <title>Keyboard Event Translation Functions</title>
 
-<para>
+    <para>
 To use the functions defined in this section, you should include the header
 file
 &lt;<filename class='headerfile'>X11/Xmu/Lookup.h</filename>&gt;.
-</para>
+and link against the libXmu library.
+    </para>
 
     <warning><para>
 The functions in this section are <emphasis remap='B'>deprecated</emphasis> because they don't work
@@ -2866,7 +2896,8 @@ except that it maps a key event to an APL string.
 The functions defined in this section are for parsing Compound Text strings,
 decomposing them into individual segments. Definitions needed to use these
 routines are in the include file
-&lt;<filename class='headerfile'>X11/Xmu/Xct.h</filename>&gt;.
+&lt;<filename class='headerfile'>X11/Xmu/Xct.h</filename>&gt;
+and link against the libXmu library.
     </para>
 
     <warning><para>
@@ -3204,7 +3235,8 @@ structure.
     <para>
 To use the functions defined in this section, you should include the header
 file
-&lt;<filename class='headerfile'>X11/Xmu/CloseHook.h</filename>&gt;.
+&lt;<filename class='headerfile'>X11/Xmu/CloseHook.h</filename>&gt;
+and link against the libXmu library.
     </para>
 
     <para>
@@ -3365,8 +3397,10 @@ if a matching callback exists, else returns
     <para>
 To use the functions and types defined in this section, you should include the
 header file
-&lt;<filename class='headerfile'>X11/Xmu/DisplayQue.h</filename>&gt;.
-It defines the following types:
+&lt;<filename class='headerfile'>X11/Xmu/DisplayQue.h</filename>&gt;
+and link against the libXmu library.
+<filename class='headerfile'>DisplayQue.h</filename> defines the following
+types:
 
       <synopsis>
 typedef int (*XmuCloseDisplayQueueProc)(XmuDisplayQueue *queue,
@@ -3604,7 +3638,8 @@ is not called on the display.
     <para>
 To use the functions defined in this section, you should include the header
 file
-&lt;<filename class='headerfile'>X11/Xmu/Initer.h</filename>&gt;.
+&lt;<filename class='headerfile'>X11/Xmu/Initer.h</filename>&gt;
+and link against the libXmu library.
     </para>
 
     <para>
@@ -3672,7 +3707,8 @@ Otherwise, this function does nothing.
     <para>
 To use the functions defined in this section, you should include the header
 file
-&lt;<filename class='headerfile'>X11/Xmu/StdCmap.h</filename>&gt;.
+&lt;<filename class='headerfile'>X11/Xmu/StdCmap.h</filename>&gt;
+and link against the libXmu library.
     </para>
 
     <para>
@@ -4190,6 +4226,7 @@ widget set itself.
     <para>
 The definitions needed to use these interfaces are in the header file
 &lt;<filename class='headerfile'>X11/Xmu/WidgetNode.h</filename>&gt;.
+To call these functions, you need to link against the libXmu library.
 The following function must be called before any of the others described
 below:
 
@@ -4338,7 +4375,8 @@ widget name or widget class name.  If no match is found, it returns
     <para>
 To participate in the editres protocol, applications which are not based
 on the Athena widget set should include the header file
-&lt;<filename class='headerfile'>X11/Xmu/Editres.h</filename>&gt;.
+&lt;<filename class='headerfile'>X11/Xmu/Editres.h</filename>&gt;
+and link against the libXmu library.
     </para>
 
     <para>