Add info on debian package installation of sgml toolkits.

This commit is contained in:
Thomas G. Lockhart 2000-02-02 16:22:45 +00:00
parent fd54baa945
commit acaa064fa8

View File

@ -1,5 +1,5 @@
<!-- <!--
$Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.24 2000/01/18 06:10:54 momjian Exp $ $Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.25 2000/02/02 16:22:45 thomas Exp $
Documentation Guide Documentation Guide
Thomas Lockhart Thomas Lockhart
@ -250,6 +250,7 @@ happen to all documents at the same time. To ease the transition, and
to help guide developers and writers, we have defined a transition roadmap. to help guide developers and writers, we have defined a transition roadmap.
</para> </para>
<!--
<para> <para>
Here is the documentation plan for v6.5: Here is the documentation plan for v6.5:
@ -292,6 +293,7 @@ available in .gif and .ps, and should be redrawn or removed.
</itemizedlist> </itemizedlist>
</para> </para>
-->
<sect2> <sect2>
<title>Document Structure</title> <title>Document Structure</title>
@ -367,14 +369,15 @@ The Administrator's Guide. Include installation and release notes.
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</para> </para>
</sect2>
<!-- <!--
Disable for the hardcopy production release. Disable for the hardcopy production release.
Too much tabular info and not very helpful in hardcopy. Too much tabular info and not very helpful in hardcopy.
- thomas 1998-10-27 - thomas 1998-10-27
--> -->
</sect2>
<!--
<sect2> <sect2>
<title>Documentation Files</title> <title>Documentation Files</title>
@ -677,83 +680,6 @@ Status
<row><entry> ./src/interfaces/python/tutorial/pgtools.pyc </entry><entry> Not converted </entry></row> <row><entry> ./src/interfaces/python/tutorial/pgtools.pyc </entry><entry> Not converted </entry></row>
<row><entry> ./src/interfaces/python/tutorial/syscat.py </entry><entry> Not converted </entry></row> <row><entry> ./src/interfaces/python/tutorial/syscat.py </entry><entry> Not converted </entry></row>
<row><entry> ./src/interfaces/python/tutorial/syscat.pyc </entry><entry> Not converted </entry></row> <row><entry> ./src/interfaces/python/tutorial/syscat.pyc </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/README </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/abort.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/alter_table.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/alter_user.l </entry><entry> Split into Reference and Admin Guide </entry></row>
<row><entry> ./src/man/begin.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/catalogs.3 </entry><entry> Catalog synopsis. Move to Programmer's Guide? </entry></row>
<row><entry> ./src/man/cleardbdir.1 </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/close.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/cluster.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/commit.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/copy.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/create_aggregate.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/create_database.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/create_function.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/create_index.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/create_language.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/create_operator.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/create_rule.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/create_sequence.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/create_table.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/create_trigger.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/create_type.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/create_user.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/create_version.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/create_view.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/createdb.1 </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/createuser.1 </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/declare.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/delete.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/destroydb.1 </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/destroyuser.1 </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/drop.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/drop_aggregate.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/drop_database.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/drop_function.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/drop_index.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/drop_language.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/drop_operator.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/drop_rule.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/drop_sequence.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/drop_table.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/drop_trigger.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/drop_type.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/drop_user.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/drop_view.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/end.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/ecpg.1 </entry><entry> Short man page. Retain </entry></row>
<row><entry> ./src/man/explain.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/fetch.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/grant.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/initdb.1 </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/initlocation.1 </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/insert.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/ipcclean.1 </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/listen.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/load.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/lock.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/move.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/notify.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/pg_dump.1 </entry><entry> Assimilate into Admin Guide </entry></row>
<row><entry> ./src/man/pg_dumpall.1 </entry><entry> Assimilate into Admin Guide </entry></row>
<row><entry> ./src/man/pg_upgrade.1 </entry><entry> Assimilate into Admin Guide </entry></row>
<row><entry> ./src/man/pg_hba.conf.5 </entry><entry> Assimilate into Admin Guide </entry></row>
<row><entry> ./src/man/pg_passwd.1 </entry><entry> Assimilate into Admin Guide </entry></row>
<row><entry> ./src/man/pgintro.1 </entry><entry> Assimilate into User's Guide? </entry></row>
<row><entry> ./src/man/postgres.1 </entry><entry> Assimilate into User's, Admin Guides </entry></row>
<row><entry> ./src/man/postmaster.1 </entry><entry> Assimilate into User's, Admin Guides </entry></row>
<row><entry> ./src/man/psql.1 </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/reset.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/revoke.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/rollback.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/select.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/set.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/show.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/sql.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/update.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/man/vacuum.l </entry><entry> Not converted </entry></row>
<row><entry> ./src/pl/tcl/INSTALL </entry><entry> Not converted </entry></row> <row><entry> ./src/pl/tcl/INSTALL </entry><entry> Not converted </entry></row>
<row><entry> ./src/pl/tcl/modules/README </entry><entry> Not converted </entry></row> <row><entry> ./src/pl/tcl/modules/README </entry><entry> Not converted </entry></row>
<row><entry> ./src/pl/tcl/license.terms </entry><entry> Not converted </entry></row> <row><entry> ./src/pl/tcl/license.terms </entry><entry> Not converted </entry></row>
@ -788,6 +714,8 @@ Status
</para> </para>
</sect2> </sect2>
-->
<sect2> <sect2>
<title>Styles and Conventions</title> <title>Styles and Conventions</title>
@ -862,7 +790,9 @@ check markup consistancy.
</para> </para>
<para> <para>
Put the following in your <filename>~/.emacs</filename> environment file: Put the following in your <filename>~/.emacs</filename>
environment file (adjusting the path names to be appropriate for
your system):
<programlisting> <programlisting>
; ********** for SGML mode (psgml) ; ********** for SGML mode (psgml)
@ -900,7 +830,7 @@ sgml-indent-data:t
sgml-parent-document:nil sgml-parent-document:nil
sgml-default-dtd-file:"./reference.ced" sgml-default-dtd-file:"./reference.ced"
sgml-exposed-tags:nil sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog" sgml-local-catalogs:("/usr/lib/sgml/catalog")
sgml-local-ecat-files:nil sgml-local-ecat-files:nil
End: End:
--</sgmltag> --</sgmltag>
@ -955,8 +885,8 @@ YFLAGS+= -v
# documentation # documentation
HSTYLE= /home/tgl/SGML/db107.d/docbook/html HSTYLE= /home/lockhart/SGML/db143.d/docbook/html
PSTYLE= /home/tgl/SGML/db107.d/docbook/print PSTYLE= /home/lockhart/SGML/db143.d/docbook/print
</programlisting> </programlisting>
where HSTYLE and PSTYLE determine the path to where HSTYLE and PSTYLE determine the path to
@ -995,36 +925,6 @@ PSTYLE= /home/tgl/SGML/db107.d/docbook/print
% make install % make install
</programlisting> </programlisting>
</para> </para>
<sect2>
<title>FreeBSD specific howto</title>
<para>
To build the documentation on FreeBSD a number of ports will need to
be installed.
<programlisting>
% cd /usr/ports/devel/gmake && make install
% cd /usr/ports/textproc/docproj && make install
% cd /usr/ports/textproc/docbook && make install
% cd /usr/ports/textproc/dsssl-docbook-modular && make install
</programlisting>
Some enviornment variables need to be set (assumes you are running a sh
based shell):
<programlisting>
export SMGL_ROOT=/usr/local/share/sgml
SGML_CATALOG_FILES=/usr/local/share/sgml/jade/catalog
SGML_CATALOG_FILES=/usr/local/share/sgml/html/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/local/share/sgml/iso8879/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/local/share/sgml/transpec/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/local/share/sgml/docbook/catalog:$SGML_CATALOG_FILES
export SGML_CATALOG_FILES </programlisting>
Make needs some special arguments, or these need to be added to your
Makefile.custom:
<programlisting>
HSTYLE=/usr/local/share/sgml/docbook/dsssl/modular/html/
PSTYLE=/usr/local/share/sgml/docbook/dsssl/modular/print/
</programlisting>
Of course you'll need to use gmake rather than just plain 'make' to build.
</para>
</sect2>
</sect1> </sect1>
<sect1> <sect1>
@ -1203,8 +1103,9 @@ $ make man
<title>Postscript Hardcopy</title> <title>Postscript Hardcopy</title>
<para> <para>
Several items must be addressed in generating Postscript Several areas are addressed while generating Postscript
hardcopy:</para> hardcopy.
</para>
<procedure> <procedure>
<title>Applixware <acronym>RTF</acronym> Cleanup</title> <title>Applixware <acronym>RTF</acronym> Cleanup</title>
@ -1314,34 +1215,193 @@ $ make man
<title>Toolsets</title> <title>Toolsets</title>
<para> <para>
We have documented experience with two installation methods for the We have documented experience with three installation methods for the
various tools that are needed to process the documentation. One is various tools that are needed to process the documentation. One is
installation from <acronym>RPM</acronym>s on installation from <acronym>RPM</acronym>s on
<productname>Linux</productname>, the other is a general installation <productname>Linux</productname>, the second is installation from
from original distributions of the individual tools. Both will be FreeBSD <firstterm>port</firstterm>, and the last is a general installation
from original distributions of the individual tools. These will be
described below. described below.
</para> </para>
<para> <para>
We understand that there are some other packaged distributions for There may be some other packaged distributions for
these tools. <productname>FreeBSD</productname> seems to have them these tools. Please report package status to the docs mailing list and
available. Please report package status to the docs mailing list and
we will include that information here. we will include that information here.
</para> </para>
<sect2> <sect2>
<title><acronym>RPM</acronym> installation on <title><productname>Linux</productname> <acronym>RPM</acronym> Installation</title>
<productname>Linux</productname></title>
<para>
The simplest installation for a RedHat-compatible Linux system
uses the <acronym>RPM</acronym> set developed by Mark Galassi at
Cygnus. It should also be possible to install from sources, as
described in a subsequent section.
</para>
<procedure>
<title>Installing RPMs</title>
<step performance="required">
<para> <para>
Install <ulink url="ftp://ftp.cygnus.com/pub/home/rosalia/"> Install <ulink url="ftp://ftp.cygnus.com/pub/home/rosalia/">
<acronym>RPM</acronym>s</ulink> for <productname>Jade</productname> <acronym>RPM</acronym>s</ulink> for <productname>Jade</productname>
and related packages. and related packages.
</para> </para>
</step>
<step performance="optional">
<para>
Install Norm Walsh's latest style sheets. Depending on the age
of the RPMs, the latest style sheets may be substantially
improved from those contained in the <acronym>RPM</acronym>s.
</para>
</step>
<step performance="required">
<para>
Update your <filename>src/Makefile.custom</filename> to include
HSTYLE and PSTYLE definitions pointing to the style sheets.
</para>
</step>
</procedure>
</sect2> </sect2>
<sect2> <sect2>
<title>Manual installation of tools</title> <title>FreeBSD Installation</title>
<para>
There is a full set of <firstterm>ports</firstterm> of the
documentation tools available on FreeBSD. In fact, postgresql.org,
on which documentation is automatically updated every evening, is
a FreeBSD machine.
</para>
<procedure>
<title>Installing FreeBSD Ports</title>
<step performance="required">
<para>
To build the documentation on FreeBSD a number of ports will need to
be installed.
<programlisting>
% cd /usr/ports/devel/gmake && make install
% cd /usr/ports/textproc/docproj && make install
% cd /usr/ports/textproc/docbook && make install
% cd /usr/ports/textproc/dsssl-docbook-modular && make install
</programlisting>
</para>
</step>
<step performance="optional">
<para>
Set environment variables
to access the <application>jade</application>
toolset.
<note>
<para>
This was not required for the FreeBSD machine at
postgresql.org, so you may not have to do this.
</para>
</note>
<programlisting>
export SMGL_ROOT=/usr/local/share/sgml
SGML_CATALOG_FILES=/usr/local/share/sgml/jade/catalog
SGML_CATALOG_FILES=/usr/local/share/sgml/html/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/local/share/sgml/iso8879/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/local/share/sgml/transpec/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/local/share/sgml/docbook/catalog:$SGML_CATALOG_FILES
export SGML_CATALOG_FILES
</programlisting>
(this is sh/bash syntax; adjust accordingly for csh/tcsh).
</para>
</step>
<step performance="required">
<para>
Make needs some special arguments, or these need to be added to your
Makefile.custom:
<programlisting>
HSTYLE=/usr/local/share/sgml/docbook/dsssl/modular/html/
PSTYLE=/usr/local/share/sgml/docbook/dsssl/modular/print/
</programlisting>
Of course you'll need to use gmake rather than just plain 'make' to build.
</para>
</step>
</procedure>
</sect2>
<sect2>
<title>Debian Installation</title>
<para>
There is a full set of packages of the
documentation tools available for Debian.
</para>
<procedure>
<title>Installing Debian Packages</title>
<step performance="required">
<para>
Install jade, docbook, and unzip:
<programlisting>
apt-get install jade
apt-get install docbook
apt-get install docbook-stylesheets
</programlisting>
</para>
</step>
<step performance="optional">
<para>
Install the latest style sheets.
</para>
<substeps>
<step performance="optional">
<para>
Verify that <application>unzip</application> is installed, or
install the package:
<programlisting>
apt-get install unzip
</programlisting>
</para>
</step>
<step performance="required">
<para>
Grab the latest stylesheet zipballs from
<ulink url="http://www.nwalsh.com/docbook/dsssl">http://www.nwalsh.com/docbook/dsssl</ulink>
and unzip it somewhere (possibly /usr/share).
</para>
</step>
</substeps>
</step>
<step performance="required">
<para>
Edit src/Makefile.custom to add appropriate HSTYLE and PSTYLE
definitions:
<programlisting>
HSTYLE= /usr/share/docbook/html
PSTYLE= /usr/share/docbook/print
</programlisting>
</para>
</step>
</procedure>
</sect2>
<sect2>
<title>Manual Installation of Tools</title>
<para> <para>
This is a brief run-through of the process of obtaining and This is a brief run-through of the process of obtaining and
@ -1882,10 +1942,8 @@ dvips postgres.dvi
<para> <para>
<productname>sgml-tools</productname> v2.x <productname>sgml-tools</productname> v2.x
now supports <application>jade</application> supports <application>jade</application>
and <productname>DocBook</productname>. It may be the preferred toolset and <productname>DocBook</productname>.
for working with <acronym>SGML</acronym> but we have not had a chance to
evaluate the new package.
</para> </para>
<!-- <!--
@ -1954,6 +2012,7 @@ Run <productname>texhash</productname> to update the tex database.
</para></sect2></sect1> </para></sect2></sect1>
--> -->
</sect1> </sect1>
</appendix> </appendix>
@ -1969,7 +2028,7 @@ sgml-indent-data:t
sgml-parent-document:nil sgml-parent-document:nil
sgml-default-dtd-file:"./reference.ced" sgml-default-dtd-file:"./reference.ced"
sgml-exposed-tags:nil sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog" sgml-local-catalogs:("/usr/lib/sgml/catalog")
sgml-local-ecat-files:nil sgml-local-ecat-files:nil
End: End:
--> -->