many pervasive clean-ups

[feisty_meow.git] / doc / clam_manual / clam_docs.html

diff --git a/doc/clam_manual/clam_docs.html b/doc/clam_manual/clam_docs.html
index cce1f29288bfa9016ffbda98a748d3cedaf906b8..6872a4e19a6173f5a3ae9aae20e4b07d96d98c21 100644 (file)
--- a/doc/clam_manual/clam_docs.html
+++ b/doc/clam_manual/clam_docs.html
@@ -165,9 +165,11 @@
         <small> </small><big> </big><small> </small>
         <ol>
           <small> </small><big> </big><small> </small>
+
+<big>DEPRECATED</big>
           <li><big> **REVISE** out of date... This variable has been needed
               since clam became
-              part of the YETIcode project (at <a href="http://yeticode.org/">http://yeticode.org</a>).</big></li>
+              part of the YETIcode project (at <a href="http://feistymeow.org/">http://feistymeow.org</a>).</big></li>
           <small> </small>
           <li><big>The default location for clam is under the FEISTY_MEOW_SCRIPTS directory in a
               folder named clam.<br>
@@ -295,7 +297,7 @@
         <small> </small><big> </big><small> </small>
         <ol>
           <small> </small><big> </big><small> </small>
-          <li><big>The hoople/bin directory in the archive has
+          <li><big>The CLAM_BINARIES directory in the archive has
               pre-built
               versions of tools used by clam during a build.<br>
             </big></li>
@@ -365,12 +367,12 @@
           <small> </small><big> </big><small> </small>
           <li><big>The standard source code repository is a directory
               called
-              "hoople"
-              in the user's home directory. &nbsp;If you decompress the hoople
+              "feisty_meow"
+              in the user's home directory. &nbsp;If you decompress the feisty_meow
               library archive in your home directory, you should be all set to
               perform a build.</big></li>
           <small> </small><big> </big><small> </small>
-          <li><big>See the HOOPLE website for more details about
+          <li><big>See the Feisty Meow Concerns Ltdwebsite for more details about
               downloading that codebase (<a href="http://feistymeow.org">http://feistymeow.org</a>).<br>
             </big></li>
           <small> </small><big> </big><small> </small>
@@ -600,13 +602,13 @@
     <h3><big><a name="TUT_IMPORTANT_VARS"></a>Important Variables</big></h3>
     <big>&nbsp;&nbsp;&nbsp;&nbsp;
       The clam root directory is pointed to by an internal variable called
-      "CLAM_DIR",
+      "CLAM_SCRIPTS",
       defined in $/variables.def.&nbsp; This variable is used by the clam
       system
       to find extra files that might be needed by derived makefile
       support.&nbsp;
       It is important to change this to the appropriate value when you are
-      using the system in a different location. &nbsp;The CLAM_DIR variable
+      using the system in a different location. &nbsp;The CLAM_SCRIPTS variable
       can either
       be directly edited in $/variables.def, or it can be overridden in the
       environment
@@ -644,7 +646,7 @@
         are
         generated.&nbsp; All files generated by compilation are stored in the
         repository
-        directory (by default, either "~/hoople" in Linux or "l:\" in
+        directory (by default, either "~/feisty_meow" in Linux or "l:\" in
         win32).&nbsp; There are three TYPEs supported so far: </big></p>
     <ul>
       <small> </small><big> </big><small> </small>
@@ -661,10 +663,15 @@
           programs.</big></li>
       <small> </small><small></small>
     </ul>
-    <big>&nbsp;&nbsp;&nbsp; &nbsp;Projects of the "library" type will
+
+<big>DEPRECATED</big>
+    <big>
+
+&nbsp;&nbsp;&nbsp; &nbsp;Projects of the "library" type will
       be given
       an include directory named after the project, such as
-      "~/hoople/include/basis".
+
+      "~/feisty_meow/include/basis".
       &nbsp;The include directory is created as a copy of the headers in the
       project's
       directory .&nbsp; Library projects will also have their final products
@@ -673,12 +680,16 @@
       &nbsp;&nbsp;&nbsp; &nbsp;Projects that are of type "application" will
       have their executables
       copied to the executable directory in the repository (such as
-      "~/hoople/exe").<br>
+      "~/hoople/exe").
+
+<br>
       &nbsp; &nbsp; &nbsp;The "test" type of project
       will be promoted to a subdirectory named after the PROJECT that resides
       under the test hierarchy in the repository (such as
       "~/hoople/tests/turbodog").
     </big>
+
+<big>DEPRECATED</big>
     <p><big>&nbsp;&nbsp;&nbsp;&nbsp; SOURCE is a list of files that
         are to be
         compiled
@@ -867,7 +878,7 @@
     <blockquote><big>MIDL is also a provided macro; it executes the
         Microsoft
         IDL compiler. </big></blockquote>
-    <big>$(HIDESH) $(CLAM_DIR)/postconditions.sh<br>
+    <big>$(HIDESH) $(CLAM_SCRIPTS)/postconditions.sh<br>
     </big>
     <blockquote><big>This runs a shell script that handles the end
         portion of a
@@ -983,11 +994,11 @@
       but this will trap errors it sees and play the build error
       CLAM_ERROR_SOUND.<br>
     </big>
-    <h4><big>CLAM_BINARY_DIR</big></h4>
+    <h4><big>CLAM_BINARIES</big></h4>
     <big>&nbsp;&nbsp;&nbsp;&nbsp; This is a folder where the helper
       binaries for the CLAM makefile system are located.  <br>
     </big>
-    <h4><big>CLAM_DIR</big></h4>
+    <h4><big>CLAM_SCRIPTS</big></h4>
     <big>&nbsp;&nbsp;&nbsp;&nbsp; This variable points at the location
       where the&nbsp; definitions and helper scripts are located.&nbsp; The
       default is
@@ -1132,7 +1143,7 @@
       repository
       is also where source code and final products of compilation reside,
       unless
-      the default is over-ridden (see TARGETS_DIR).<br>
+      the default is over-ridden (see TARGETS_STORE).<br>
     </big>
     <h4><big>SH &amp; SHELL</big></h4>
     <big>&nbsp;&nbsp;&nbsp;&nbsp; These variables both point at a
@@ -1171,7 +1182,7 @@
       Instead,
       a generated variable called ACTUAL_TARGETS is used.<br>
     </big>
-    <h4><big>TARGETS_DIR</big></h4>
+    <h4><big>TARGETS_STORE</big></h4>
     <big>&nbsp;&nbsp;&nbsp;&nbsp; This folder is where all generated
       files are
       to
@@ -1712,12 +1723,14 @@
       for C++ header files (files ending in ?.h?).
     </big>
     <h4><big>HOOPLE_HEADERS</big></h4>
+<big>DEPRECATED</big>
     <big>&nbsp;&nbsp;&nbsp;&nbsp; The two standard places to look for
       headers
       (the repository and the third party directory) are listed in this
       variable.
     </big>
     <h4><big>HOOPLE_LIBRARIES</big></h4>
+<big>DEPRECATED</big>
     <big>&nbsp;&nbsp;&nbsp;&nbsp; This is where our libraries are
       located.&nbsp; It is usually a subdirectory called "lib" under the
       repository
@@ -2285,7 +2298,7 @@
     <big>&nbsp;&nbsp;&nbsp;&nbsp; The most frequent cause of this
       problem is a
       directory
-      not being on your path.&nbsp; The compilation tools bin (~/hoople/bin)
+      not being on your path.&nbsp; The compilation tools bin (CLAM_BINARIES)
       directory must be in
       the PATH variable.
       <br>