lix-project/lix
20
57
Fork 31
Code Issues 347 Code Review (Gerrit) Projects 3 Releases Wiki Activity

* Start of manual; installation instructions.

Browse source
This commit is contained in:
Eelco Dolstra 2003-08-07 14:17:18 +00:00
parent f8035d06f2
commit 74867e72f2
2 changed files with 107 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/manual/Makefile
View file

@ -1,10 +1,11 @@
DOCBOOK_DTD = /nix/current/xml/dtd/docbook 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: check:
SP_CHARSET_FIXED=YES SP_ENCODING=XML \ 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: html:
mkdir -p out xsltproc --output book.html $(DOCBOOK_XSL)/html/docbook.xsl book.xml
xsltproc --output out/book.html $(DOCBOOK_XSL)/html/docbook.xsl book.xml

102
doc/manual/book.xml Normal file
View file

@ -0,0 +1,102 @@
<?xml version="1.0"?>
<!DOCTYPE book SYSTEM "/nix/current/xml/dtd/docbook/docbookx.dtd"
[
]>
<book>
<title>Nix: The Manual</title>
<!--======================================================================-->
<chapter>
<title>Introduction</title>
<para>
Nix is a system for the automatic creation and distribution of data, such
as computer programs and other software artifacts.
</para>
</chapter>
<!--======================================================================-->
<chapter>
<title>Installation</title>
<sect1>
<title>Prerequisites</title>
<para>
Nix uses Sleepycat's Berkeley DB and CWI's ATerm library. However,
these are fetched automatically as part of the build process.
</para>
<para>
Other than that, you need a good C++ compiler. GCC 2.95 does not
appear to work; please use GCC 3.x.
</para>
</sect1>
<sect1>
<title>Obtaining Nix</title>
<para>
Nix can be obtained from its <ulink
url='http://losser.st-lab.cs.uu.nl:12080/repos/trace/nix/trunk'>Subversion
repository</ulink>. For example, the following command will check
out the latest revision into a directory called
<filename>nix</filename>:
</para>
<screen>
$ svn checkout http://losser.st-lab.cs.uu.nl:12080/repos/trace/nix/trunk nix</screen>
<para>
Likewise, specific releases can be obtained from the <ulink
url='http://losser.st-lab.cs.uu.nl:12080/repos/trace/nix/tags'>tags
directory</ulink> of the repository. If you don't have Subversion,
you can download a <ulink
url='http://losser.st-lab.cs.uu.nl:12080/dist/trace/'>compressed
tar-file</ulink> of the latest revision of the repository.
</para>
</sect1>
<sect1>
<title>Building Nix</title>
<para>
To build Nix, do the following:
</para>
<screen>
$ autoreconf -i
$ ./configure <replaceable>options...</replaceable>
$ make
$ make install</screen>
<para>
Currently, the only useful switch for <command>configure</command> is
<option>--prefix=<replaceable>prefix</replaceable></option> to specify
where Nix is to be installed. The default installation directory is
<filename>/nix</filename>. You can change this to any location you
like. You should ensure that you have write permission to the
installation prefix.
</para>
<warning>
<para>
It is advisable <emphasis>not</emphasis> to change the installation
prefix, since doing so will in all likelihood make it impossible to
use derivates built on other systems.
</para>
</warning>
</sect1>
</chapter>
</book>