Changeset 4978

Timestamp:

Sep 8, 2005, 11:20:52 AM (21 years ago)

Author:

desonia

Message:

updated linking subsection.

File:

• trunk/psLib/src/mainpage.dox (modified) (4 diffs)

trunk/psLib/src/mainpage.dox

@@ -4 +4 @@
  *  @author Robert Daniel DeSonia, MHPCC
  *
- *  @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-09-08 02:06:02 $
+ *  @version $Revision: 1.16 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-09-08 21:20:52 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -111 +111 @@
 
 
-@section build How to Build, Test, and Link the psLib library
+@section build How to Build and Test
 
 The source uses autoconf/automake to build control the build process.  If, and
@@ -131 +131 @@
 </pre>
 <i>This builds, tests, and installs the library.</i>
-
-For linking to psLib:
-<pre>
-$ cd psLib/bin
-$ ./pslib-config --libs
-$ ./pslib-config --cflags
-</pre>
-<i>This outputs the libaries to link in configuration and the cflags to include
- in compiling.</i>
 
 The configure step allows users to specify specific locations for the third
@@ -162 +153 @@
 </pre>
 
+@section usage Building and Linking your code to the psLib library
+
+To assist the use of the library with your own code, a configuration tool is part
+of the psLib library package.  This tool, pslib-config, is installed in the BIN
+directory, according to the options given to the configure script.
+
+The required CFLAG options for the compiler stage of code that uses psLib can be
+obtained via 'pslib-config --cflags'.  This outputs the cc options that supplies
+include path(s) required to find the psLib headers.
+
+The required linking options, can be obtained via 'pslib-config --libs'.  This
+outputs the ld options that supplies the library paths and files required to
+link to the pslib library.
 
 @section doc How to Create Code Documentation