Fix list of environment variables for configure. Remove some variables
authorPeter Eisentraut <peter_e@gmx.net>
Mon, 23 Oct 2006 14:13:43 +0000 (14:13 +0000)
committerPeter Eisentraut <peter_e@gmx.net>
Mon, 23 Oct 2006 14:13:43 +0000 (14:13 +0000)
that are almost never used.  Put documentation-related variables into the
documentation chapter.

doc/src/sgml/docguide.sgml
doc/src/sgml/installation.sgml

index 8bce902023924c7f70867c82f8f1dea06586db4c..eaac915367d6e5b5502a84a67c613040d99cc7d7 100644 (file)
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/docguide.sgml,v 1.57 2006/09/16 00:30:12 momjian Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/docguide.sgml,v 1.58 2006/10/23 14:13:43 petere Exp $ -->
 
 <appendix id="docguide">
  <title>Documentation</title>
@@ -502,12 +502,15 @@ checking for sgmlspl... sgmlspl
    If neither <filename>onsgmls</filename> nor
    <filename>nsgmls</filename> were found then you will not see the
    remaining 4 lines.  <filename>nsgmls</filename> is part of the Jade
-   package.  If <quote>DocBook V4.2</quote> was not found then you did
-   not install the DocBook DTD kit in a place where jade can find it,
-   or you have not set up the catalog files correctly.  See the
-   installation hints above.  The DocBook stylesheets are looked for
-   in a number of relatively standard places, but if you have them
-   some other place then you should set the environment variable
+   package.  You can pass the environment variables
+   <envar>JADE</envar> and <envar>NSGMLS</envar> to configure to point
+   to the programs if they are not found automatically.  If
+   <quote>DocBook V4.2</quote> was not found then you did not install
+   the DocBook DTD kit in a place where Jade can find it, or you have
+   not set up the catalog files correctly.  See the installation hints
+   above.  The DocBook stylesheets are looked for in a number of
+   relatively standard places, but if you have them some other place
+   then you should set the environment variable
    <envar>DOCBOOKSTYLE</envar> to the location and rerun
    <filename>configure</filename> afterwards.
   </para>
index 533e5c18c936111fffddbf087452e45dde1b4690..f6a87171cf92e9301abfbfc5ba17afec7b0d7bec 100644 (file)
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/installation.sgml,v 1.264 2006/10/12 18:49:32 neilc Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/installation.sgml,v 1.265 2006/10/23 14:13:43 petere Exp $ -->
 
 <chapter id="installation">
  <title><![%standalone-include[<productname>PostgreSQL</>]]>
@@ -1064,269 +1064,129 @@ su - postgres
     </para>
 
     <para>
-    Here's a list of the significant environment variables:
-    </para>
-
-    <para>
+     Here is a list of the significant variables that can be set in
+     this manner:
      <variablelist>
-
-      <varlistentry>
-       <term><option>AWK=<replaceable>/path/to/awk</></option></term>
-       <listitem>
-        <para>
-         <replaceable>/path/to/awk</> is the full path to <application>awk</>.
-        </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term><option>CC=<replaceable>/path/to/cc</></option></term>
-       <listitem>
-        <para>
-         <replaceable>/path/to/cc</> is the full path to your C compiler, such
-         as <application>gcc</>.
-        </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term><option>CFLAGS=<replaceable>FLAGS</></option></term>
-       <listitem>
-        <para>
-         <replaceable>FLAGS</> is the a list of flags to pass to the C
-         compiler.
-        </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term><option>COLLATEINDEX</option></term>
-       <listitem>
-        <para>
-         Used for building the SGML documentation.
-        </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term><option>CPP=<replaceable>/path/to/cpp</></option></term>
-       <listitem>
-        <para>
-         <replaceable>/path/to/cpp</> is the full path to your C preprocessor,
-         such as <application>gcc</>.
-        </para>
-       </listitem>
-      </varlistentry>
-
       <varlistentry>
-       <term><option>CPPFLAGS=<replaceable>FLAGS</></option></term>
+       <term><envar>CC</envar></term>
        <listitem>
         <para>
-         <replaceable>FLAGS</> is the a list of flags to pass to the C
-         preprocessor.
+         C compiler
         </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term><option>DOCBOOKSTYLE</option></term>
+       <term><envar>CFLAGS</envar></term>
        <listitem>
         <para>
-         Used for building the SGML documentation.
+         options to pass to the C compiler
         </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term><option>DTRACE=<replaceable>/path/to/dtrace</></option></term>
+       <term><envar>CPP</envar></term>
        <listitem>
         <para>
-         Specifies the location of the <command>dtrace</command> program.
+         C preprocessor
         </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term><option>DTRACEFLAGS=<replaceable>FLAGS</></option></term>
+       <term><envar>CPPFLAGS</envar></term>
        <listitem>
         <para>
-         <replaceable>FLAGS</> is the a list of flags to pass to the
-         <command>dtrace</command> program.
+         options to pass to the C preprocessor
         </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term><option>JADE</option></term>
+       <term><envar>DTRACE</envar></term>
        <listitem>
         <para>
-         Used for building the SGML documentation.
+         location of the <command>dtrace</command> program
         </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term><option>LDFLAGS=<replaceable>FLAGS</></option></term>
+       <term><envar>DTRACEFLAGS</envar></term>
        <listitem>
         <para>
-         <replaceable>FLAGS</> is the a list of flags to pass to the link file
-         editor.
+         options to pass to the <command>dtrace</command> program
         </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term><option>LDFLAGS_SL</option></term>
+       <term><envar>LDFLAGS</envar></term>
        <listitem>
         <para>
-         Used for shared library linking.
+         options to pass to the link editor
         </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term><option>LORDER=<replaceable>/path/to/lorder</></option></term>
+       <term><envar>LDFLAGS_SL</envar></term>
        <listitem>
         <para>
-         <replaceable>/path/to/lorder</> is the full path to your dependency
-         listing program.
+         linker options for shared library linking
         </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term><option>MSGFMT</option></term>
+       <term><envar>MSGFMT</envar></term>
        <listitem>
         <para>
-         Used for Native Language Support (NLS).
+         <command>msgfmt</command> program for native language support
         </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term><option>MSGMERGE</option></term>
+       <term><envar>PERL</envar></term>
        <listitem>
         <para>
-         Used for Native Language Support (NLS).
+         Full path to the Perl interpreter.  This will be used to
+         determine the dependencies for building PL/Perl.
         </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term><option>NSGMLS</option></term>
+       <term><envar>PYTHON</envar></term>
        <listitem>
         <para>
-         Used for building the SGML documentation.
+         Full path to the Python interpreter.  This will be used to
+         determine the dependencies for building PL/Python.
         </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term><option>PERL=<replaceable>/path/to/perl</></option></term>
+       <term><envar>TCLSH</envar></term>
        <listitem>
         <para>
-         <replaceable>/path/to/perl</> is the full path to your Perl 5
-         interpreter. Note that this wil be used to determine the dependencies
-         for building PL/Perl.
+         Full path to the Tcl interpreter.  This wil be used to
+         determine the dependencies for building PL/Tcl.
         </para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term><option>PTHREAD_CC</option></term>
+       <term><envar>YACC</envar></term>
        <listitem>
         <para>
-         Used for adding thread-safety flags.
+         Yacc program (<literal>bison -y</literal> if using Bison)
         </para>
        </listitem>
       </varlistentry>
-
-      <varlistentry>
-       <term><option>PYTHON=<replaceable>/path/to/python</></option></term>
-       <listitem>
-        <para>
-         <replaceable>/path/to/python</> is the full path to your Python
-         interpreter. Note that this wil be used to determine the dependencies
-         for building PL/Python.
-        </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term><option>RANLIB=<replaceable>/path/to/ranlib</></option></term>
-       <listitem>
-        <para>
-         <replaceable>/path/to/ranlib</> is the full path to your archive
-         library table of contents editor.
-        </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term><option>SGMLSPL</option></term>
-       <listitem>
-        <para>
-         Used for building the SGML documentation.
-        </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term><option>STRIP=<replaceable>/path/to/strip</></option></term>
-       <listitem>
-        <para>
-         <replaceable>/path/to/strip</> is the full path to your strip program.
-        </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term><option>TCL=<replaceable>/path/to/tcl</></option></term>
-       <listitem>
-        <para>
-         <replaceable>/path/to/tcl</> is the full path to your TCL
-         interpreter. Note that this wil be used to determine the dependencies
-         for building PL/TCL.
-        </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term><option>TAR=<replaceable>/path/to/tar</></option></term>
-       <listitem>
-        <para>
-         <replaceable>/path/to/tar</> is the full path to your tar program.
-        </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term><option>TCLISH=<replaceable>/path/to/tclish</></option></term>
-       <listitem>
-        <para>
-         <replaceable>/path/to/tclish</> is the full path to your tclish program.
-        </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term><option>XGETTEXT=<replaceable>/path/to/xgettext</></option></term>
-       <listitem>
-        <para>
-         <replaceable>/path/to/xgettext</> is the full path to your xgettext program.
-        </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term><option>YACC=<replaceable>/path/to/yacc</></option></term>
-       <listitem>
-        <para>
-         <replaceable>/path/to/yacc</> is the full path to your yacc program.
-        </para>
-       </listitem>
-      </varlistentry>
-
      </variablelist>
     </para>
    </step>