- ./COPYRIGHTCopyright notice
- ./INSTALLInstallation instructions (text from sgml->rtf->text)
- ./READMEIntroductory info
- ./register.txtRegistration message during make
- ./doc/bug.templateBug report template
-
./doc/postgres.tar.gzIntegrated docs (HTML)
- ./doc/programmer.ps.gzProgrammer's Guide (Postscript)
-
./doc/programmer.tar.gzProgrammer's Guide (HTML)
- ./doc/reference.ps.gzReference Manual (Postscript)
-
./doc/reference.tar.gzReference Manual (HTML)
- ./doc/tutorial.ps.gzIntroduction (Postscript)
-
./doc/tutorial.tar.gzIntroduction (HTML)
- ./doc/user.ps.gzUser's Guide (Postscript)
-
./doc/user.tar.gzUser's Guide (HTML)
+ |
+ ./COPYRIGHTCopyright notice
+
+ |
+ ./INSTALL
+ Installation instructions (text from sgml->rtf->text)
+
+ |
+ ./README
+ Introductory info
+
+ |
+ ./register.txt
+ Registration message during make
+
+ |
+ ./doc/bug.template
+ Bug report template
+
+ |
+ ./doc/postgres.tar.gz
+
+ |
+ ./doc/programmer.ps.gz
+ Programmer's Guide (Postscript)
+
+ |
+ ./doc/programmer.tar.gz
+
Programmer's Guide (HTML)
+
+ |
+ ./doc/reference.ps.gz
+ Reference Manual (Postscript)
+
+ |
+ ./doc/reference.tar.gz
+
Reference Manual (HTML)
+
+ |
+ ./doc/tutorial.ps.gz
+ Introduction (Postscript)
+
+ |
+ ./doc/tutorial.tar.gz
+
+ |
+ ./doc/user.ps.gz
+ User's Guide (Postscript)
+ |
+ ./doc/user.tar.gz
+
- There are man pages available for installation, as well as a large number
+ There are man pages available, as well as a large number
of plain-text README-type files throughout the
Postgres
source tree.
See
-
Introduction to DocBook
+ Introduction to DocBook
for a nice "quickstart" summary of DocBook features.
+ DocBook Elements
provides a powerful cross-reference for features of
This documentation set is constructed using several tools, including
James Clark's
and Norm Walsh's
-
Modular DocBook Stylesheets.
+ Modular DocBook Stylesheets.
TeX is a supported format for
-
jade output, but
was not used at this time
+
jade output, but
is not used at this time
for several reasons, including the inability to make minor format
fixes before committing to hardcopy and generally inadequate table
-->
+
Text Hardcopy
+
+ INSTALL and HISTORY are
+ updated for each release. For historical reasons, these files are
+ in plain text, but are derived from the newer
+
+
+
Plain Text Generation
+
+ Both INSTALL and
+ HISTORY are generated from existing
+
SGML sources. They are extracted from the same
+
+
+
+ Generate
RTF by typing:
+% cd doc/src/sgml
+% make installation.rtf
+
+
+
+
+
+ Import installation.rtf into
+
+
+
+
+ Set the page width and margins.
+
+
+
+
+ Adjust the page width in File.PageSetup to 10 inches.
+
+
+
+
+ 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.
+
+
+
+
+
+
+ Lop off the parts of the document which are not needed.
+
+
+ For INSTALL, remove all release notes from
+ the end of the text, except for those from the current release.
+ For HISTORY, remove all text up to the
+ release notes, preserving and modifying the title and ToC.
+
+
+
+
+ Export the result as ASCII Layout
.
+
+
+
+
+ Using emacs or vi, clean up the tabular information in
+ INSTALL. Remove the mailto
+
URLs for the porting contributors to shrink
+ the column heights.
+
+
+
+
+
+
+
Postscript Hardcopy
Several items must be addressed in generating Postscript
- Generate the
RTF input by typing
+ Generate the
RTF input by typing
(for example):
% cd doc/src/sgml
% make tutorial.rtf
Not all documents have figures.
You can grep the
SGML source files for
- the string Graphic
to identify those parts of the
+ the string graphic
to identify those parts of the
documentation which may have figures. A few figures are replicated in
various parts of the documentation.
- Export the document to a file in Postscript format.
+ Print
the document
+ to a file in Postscript format.