gno/doc
2012-09-02 11:36:35 -06:00
..
describe updated rm(1) entry from Dave Tribby 1999-07-04 18:56:52 +00:00
etc reworking doc build 2012-08-26 02:27:36 +00:00
refs reworking doc build 2012-08-26 02:27:36 +00:00
refs.aug96 reworking doc build 2012-08-26 02:27:36 +00:00
.cvsignore reworking doc build 2012-08-26 02:27:36 +00:00
GNUmakefile nothing substantive; testing commit email 2012-09-02 11:36:35 -06:00
README reworking doc build 2012-08-26 02:27:36 +00:00

Unlike the rest of the source, we don't build the docs under
the GS itself.  Currently (summer 2012) the build machine is
a CentOS 5.x server.  (The GS cannot handle the tool chain
currently used to build docs.)  Incidentally, this is why the
makefiles in this hierarchy are called GNUmakefile instead of
Makefile; there is no GNU make for the GS, so you can't 
accidentally trigger a make in this directory on a GS (or if
you do, it won't get very far.

CONFIGURATION
=============

Create the file etc/constpriv.mk and add this line:
	GNO_PUBLIC_HTML = /home/myname/public_html/gno

Of course, change that to whereever you prefer.  This file is
ignored by the repository, so you will not see it checked in.

DOCUMENT BUILD
==============

To build the documents, you will need to have installed:
	GNU make
	docbook
	tetex-latex
	latex-dvips
	latex2html

In order to build the reference manuals, do the following:
	make

That will cause the documentation to be generated into the 'gen'
hierarchy.

DOCUMENT INSTALLATION
=====================

This should normally only be done for the official GNO web server.

To install the reference manuals:
	make install