Accumulated documentation changes.

1 files changed, 72 insertions, 0 deletions

diff --git a/doc/user/parseconfig.sgml b/doc/user/parseconfig.sgml
new file mode 100644
index 0000000..067ef37
--- /dev/null
+++ b/doc/user/parseconfig.sgml
@@ -0,0 +1,72 @@
+<!--
+
+  __COPYRIGHT__
+
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  "Software"), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+
+  The above copyright notice and this permission notice shall be included
+  in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+  KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+-->
+
+ <para>
+
+ Configuring the right options to build programs to work with the
+ libraries--especially shared libraries--installed on a POSIX system
+ can be very complicated.
+ Various utilies with names that end in <filename>config</filename>
+ can return command-line options for the
+ GNU Compiler Collection
+
+ </para>
+
+ <para>
+
+ &SCons; construction environments have a &ParseConfig; method
+ that executes a utility and configures
+ the appropriate construction variables
+ in the environment
+ based on the command-line options
+ returned by the specified command.
+
+ </para>
+
+ </para>
+
+ <programlisting>
+    env = Environment()
+    env.ParseConfig("pkg-config")
+ </programlisting>
+
+ <para>
+
+ &SCons; will execute the specified command string
+ and XXX
+
+ </para>
+
+ <screen>
+    % <userinput>scons -Q</userinput>
+    scons: `.' is up to date.
+    Must specify package names on the command line
+ </screen>
+
+ <para>
+
+ XXX
+
+ </para>