cp -p ../graphics/$@.

.PHONY: INSTALL

INSTALL: INSTALL.html

INSTALLHISTORY:% :%.html

@echo"|";\

@rm -f tempfile.html tempfile.sgml

INSTALL.html: tempfile.html

sed -e's/Chapter 1. *//g'<$<>$@

tempfile.html: tempfile.sgml

jade -d$(HDSL) -V nochunks -t sgml$<>$@

INSTALL.htmlHISTORY.html:%.html : tempfile_%.html

sed's/Chapter 1. *//g'$<>$@

tempfile_INSTALL.htmltempfile_HISTORY.html: tempfile_%.html : tempfile_%.sgml

jade -d$(HDSL) -V nochunks -t sgml$<>$@

tempfile_INSTALL.sgml: standalone-install.sgml installation.sgml

cat$+>$@

tempfile_HISTORY.sgml: release.sgml

(echo'<!doctype chapter PUBLIC "-//OASIS//DTD DocBook V3.1//EN">'; \

cat$< )>$@

tempfile.sgml: standalone-install.sgml installation.sgml

cat$+>$@

.INTERMEDIATE: tempfile_INSTALL.html tempfile_HISTORY.html tempfile_INSTALL.sgml tempfile_HISTORY.sgml

<!--

$Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.27 2000/09/29 20:21:33 petere Exp $

$Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.28 2000/10/17 15:26:40 petere Exp $

Documentation Guide

Thomas Lockhart

-->

</row>

<row>

<entry>./INSTALL</entry>

<entry>Installation instructions (text from sgml->rtf->text)</entry>

<entry>Installation instructions</entry>

</row>

<row>

<entry>./README</entry>

</sect2>

</sect1>

<sect1 id="doc-build">

<title>Building Documentation</title>

% make install

</programlisting>

</para>

</sect1>

<sect1 id="doc-manpages">

<sect2 id="doc-manpages">

<title>Manpages</title>

<para>

</para>

</step>

</procedure>

</sect1>

</sect2>

<sect1 id="doc-hardcopy">

<sect2 id="doc-hardcopy">

<title>Hardcopy Generation for v7.0</title>

<para>

</para>

-->

<sect2>

<title>Text Hardcopy</title>

<para>

<filename>INSTALL</filename> and <filename>HISTORY</filename> are

updated for each release. For historical reasons, these files are

in plain text, but are derived from the newer

<acronym>SGML</acronym> sources.

</para>

<procedure>

<title>Plain Text Generation</title>

<para>

Both <filename>INSTALL</filename> and

<filename>HISTORY</filename> are generated from existing

<acronym>SGML</acronym> sources. They are extracted from the same

intermediate <acronym>RTF</acronym> file.

</para>

<step performance="required">

<para>

Generate <acronym>RTF</acronym> by typing:

<programlisting>

% cd doc/src/sgml

% make installation.rtf

</programlisting>

</para>

</step>

<step performance="required">

<para>

Import <filename>installation.rtf</filename> into

<productname>Applix Words</productname>.

</para>

</step>

<step performance="required">

<para>

Set the page width and margins.

</para>

<substeps>

<step performance="required">

<para>

Adjust the page width in File.PageSetup to 10 inches.

</para>

</step>

<step performance="required">

<para>

Select all text.

Adjust the right margin using the ruler to 9.5 inches. This

will give a maximum column width of 79 characters, within the

80 columns upper limit goal.

</para>

</step>

</substeps>

</step>

<step performance="required">

<para>

Lop off the parts of the document which are not needed.

</para>

<para>

For <filename>INSTALL</filename>, remove all release notes from

the end of the text, except for those from the current release.

For <filename>HISTORY</filename>, remove all text up to the

release notes, preserving and modifying the title and ToC.

</para>

</step>

<step performance="required">

<para>

Export the result as "ASCII Layout".

</para>

</step>

<step performance="required">

<para>

Using emacs or vi, clean up the tabular information in

<filename>INSTALL</filename>. Remove the "mailto"

<acronym>URLs</acronym> for the porting contributors to shrink

the column heights.

</para>

</step>

</procedure>

</sect2>

<sect2>

<title>Postscript Hardcopy</title>

<para>

Several areas are addressed while generating Postscript

hardcopy, including RTF repair, ToC generation, and page break

</para>

</step>

</procedure>

</sect2>

<sect2>

<title>Plain Text Files</title>

<para>

Several files are distributed as plain text, for reading during

the installation process. The <filename>INSTALL</filename> file

corresponds to the chapter in the <citetitle>Administrator's

Guide</citetitle>, with some minor changes to account for the

different context. To recreate the file, change to the directory

<filename>doc/src/sgml</filename> and enter <userinput>gmake

INSTALL</userinput>. This will create a file

<filename>INSTALL.html</filename> that can be saved as text with

<productname>Netscape Navigator</productname> and put into the

place of the existing file. <productname>Netscape</productname>

seems to offer the best quality for <acronym>HTML</acronym> to

text conversions (over <application>lynx</application> and

<application>w3m</application>).

</para>

<para>

The file <filename>HISTORY</filename> can be created similarly,

using the command <userinput>gmake HISTORY</userinput>. The table

of contents should be removed manually from the resulting text

file.

</para>

<para>

Since it does not change very often, the generation of the file

<filename>src/test/regress/README</filename> is not fully

automated. After building the <acronym>HTML</acronym> version of

the <citetitle>Administrator's Guide</citetitle>, convert the

resulting files <filename>regress.htm</filename> and

<filename>regress-platform.htm</filename> to text, using

<productname>Netscape</productname>. Then paste the text files

together and edit them to taste (e.g., remove the navigation

bars, remove the references to other chapters).

</para>

<!--

* This is how you can create text files via RTF and ApplixWare,

* for historical reference.

<procedure>

<title>Plain Text Generation</title>

<para>

Both <filename>INSTALL</filename> and

<filename>HISTORY</filename> are generated from existing

<acronym>SGML</acronym> sources. They are extracted from the same

intermediate <acronym>RTF</acronym> file.

</para>

<step performance="required">

<para>

Generate <acronym>RTF</acronym> by typing:

<programlisting>

% cd doc/src/sgml

% make installation.rtf

</programlisting>

</para>

</step>

<step performance="required">

<para>

Import <filename>installation.rtf</filename> into

<productname>Applix Words</productname>.

</para>

</step>

<step performance="required">

<para>

Set the page width and margins.

</para>

<substeps>

<step performance="required">

<para>

Adjust the page width in File.PageSetup to 10 inches.

</para>

</step>

<step performance="required">

<para>

Select all text.

Adjust the right margin using the ruler to 9.5 inches. This

will give a maximum column width of 79 characters, within the

80 columns upper limit goal.

</para>

</step>

</substeps>

</step>

<step performance="required">

<para>

Lop off the parts of the document which are not needed.

</para>

<para>

For <filename>INSTALL</filename>, remove all release notes from

the end of the text, except for those from the current release.

For <filename>HISTORY</filename>, remove all text up to the

release notes, preserving and modifying the title and ToC.

</para>

</step>

<step performance="required">

<para>

Export the result as "ASCII Layout".

</para>

</step>

<step performance="required">

<para>

Using emacs or vi, clean up the tabular information in

<filename>INSTALL</filename>. Remove the "mailto"

<acronym>URLs</acronym> for the porting contributors to shrink

the column heights.

</para>

</step>

</procedure>

-->

</sect2>

</sect1>

<sect1 id="doc-toolsets">

<title>Toolsets</title>

<!-- $Header: /cvsroot/pgsql/doc/src/sgml/installation.sgml,v 1.24 2000/10/16 03:25:16 momjian Exp $ -->

<!-- $Header: /cvsroot/pgsql/doc/src/sgml/installation.sgml,v 1.25 2000/10/17 15:26:40 petere Exp $ -->

<chapter id="installation">

<title><![%flattext-install-include[<productname>PostgreSQL</> ]]>Installation Instructions</title>

<para>

If you want to test the newly built server before you install it,

you can run the regression tests at this point. The regression

tests are a test suite to verify that <productname>PostgreSQL</> runs on your machine

in the way the developers expected it to. Type

tests are a test suite to verify that <productname>PostgreSQL</>

runs on your machine in the way the developers expected it

to. Type

<screen>

<userinput>gmake -C src/test/regress all runcheck</userinput>

<!-- XXX How about just `gmake check'? -->

<userinput>gmake check</userinput>

</screen>

It is possible that some tests fail, due to differences in error

message wording or floating point results. The file

<filename>src/test/regress/README</> and

<![%flattext-install-include[the <citetitle>Administrator's Guide</citetitle>]]>

<![%flattext-install-ignore[<xref linkend="regress">]]>

information about interpreting the test results. You can repeat

this test at any later time by issuing the same command.

message wording or floating point results.

<![%flattext-install-include[The file

<filename>src/test/regress/README</> and the

<citetitle>Administrator's Guide</citetitle> contain]]>

detailedinformation about interpreting the test results. You can

repeatthis test at any later time by issuing the same command.

</para>

</step>