diff --git a/doc/manual/Makefile b/doc/manual/Makefile index 95b472eee5..52f17c65aa 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -1,10 +1,11 @@ DOCBOOK_DTD = /nix/current/xml/dtd/docbook -DOCBOOK_XSL =/nix/current/xml/xsl/docbook/ +DOCBOOK_XSL = /nix/current/xml/xsl/docbook + +all: check html check: SP_CHARSET_FIXED=YES SP_ENCODING=XML \ - nsgmls -wxml -c /usr/share/sgml/opensp/xml.soc -c $(DOCBOOK_DTD)/docbook.cat -ges book.xml + nsgmls -wxml -c /usr/share/doc/packages/sp/html-xml/xml.soc -c $(DOCBOOK_DTD)/docbook.cat -ges book.xml html: - mkdir -p out - xsltproc --output out/book.html $(DOCBOOK_XSL)/html/docbook.xsl book.xml + xsltproc --output book.html $(DOCBOOK_XSL)/html/docbook.xsl book.xml diff --git a/doc/manual/book.xml b/doc/manual/book.xml new file mode 100644 index 0000000000..51fddadf17 --- /dev/null +++ b/doc/manual/book.xml @@ -0,0 +1,102 @@ + + + + + Nix: The Manual + + + + + + Introduction + + + Nix is a system for the automatic creation and distribution of data, such + as computer programs and other software artifacts. + + + + + + + + + Installation + + + Prerequisites + + + Nix uses Sleepycat's Berkeley DB and CWI's ATerm library. However, + these are fetched automatically as part of the build process. + + + + Other than that, you need a good C++ compiler. GCC 2.95 does not + appear to work; please use GCC 3.x. + + + + + Obtaining Nix + + + Nix can be obtained from its Subversion + repository. For example, the following command will check + out the latest revision into a directory called + nix: + + + +$ svn checkout http://losser.st-lab.cs.uu.nl:12080/repos/trace/nix/trunk nix + + + Likewise, specific releases can be obtained from the tags + directory of the repository. If you don't have Subversion, + you can download a compressed + tar-file of the latest revision of the repository. + + + + + + Building Nix + + + To build Nix, do the following: + + + +$ autoreconf -i +$ ./configure options... +$ make +$ make install + + + Currently, the only useful switch for configure is + to specify + where Nix is to be installed. The default installation directory is + /nix. You can change this to any location you + like. You should ensure that you have write permission to the + installation prefix. + + + + + It is advisable not to change the installation + prefix, since doing so will in all likelihood make it impossible to + use derivates built on other systems. + + + + + + + + +