From: Michal Vaner <vorner@ucw.cz>
Date: Sun, 5 Oct 2008 08:51:22 +0000 (+0200)
Subject: Free dist.: Update installation documentation
X-Git-Tag: holmes-import~227^2~5^2~29
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=03862eabf5db1365c908c86ecea05dcee43dc06e;p=libucw.git

Free dist.: Update installation documentation

Mention installation of the library
---

diff --git a/ucw/doc/configure.txt b/ucw/doc/configure.txt
index 15624c82..0348b878 100644
--- a/ucw/doc/configure.txt
+++ b/ucw/doc/configure.txt
@@ -27,7 +27,7 @@ a Makefile which refers to the original source tree.
 How to configure
 ----------------
 To set up compilation, possibly overriding default compile-time
-options, just run
+options, just run:
 
 	./configure [<option> | -<option> | <option>=<value> ...]
 
@@ -46,9 +46,29 @@ to specify the other options in this way, it probably won't have the desired
 effect, because configure also generates C include files containing the
 options.
 
+Installation options
+--------------------
+By default, the package is compiled to be installed and it chooses a
+place where it will install. If you want to place it somewhere else,
+set the `PREFIX` option:
+
+	./configure PREFIX=/where/to/install
+
+[[local_build]]
+You can create a local compilation, which does not need to be
+installed. All paths are set relative to a `run` directory and
+programs expect to have current working directory set to it. However,
+you can move the `run` directory around your filesystem as you like.
+To compile it that way, turn on the `CONFIG_LOCAL` option (and do not
+set `PREFIX`):
+
+	./configure CONFIG_LOCAL
+
 Examples
 --------
   - `./configure -CONFIG_SHARED` will build the libraries statically.
   - `./configure -CONFIG_IMAGES` avoids building the image library.
   - `./configure CONFIG_UCW_ONLY -CONFIG_UCW_UTILS` compiles only the
     libucw library without its util programs.
+  - `./configure CONFIG_XML PREFIX=$HOME/sherlock` includes a xml
+    library and installs into your home directory.
diff --git a/ucw/doc/install.txt b/ucw/doc/install.txt
index 917126f3..db07873c 100644
--- a/ucw/doc/install.txt
+++ b/ucw/doc/install.txt
@@ -29,13 +29,11 @@ The defaults determined by the configure script should be correct on Linux/i386,
 on other architectures you will probably need to tweak the CPU detection section
 in `ucw/autoconf.cfg` and possibly also the typedefs in `ucw/config.h`.
 
-Then run
+Then run:
 
 	make
 
-which builds the whole package in the `run` directory and you can play there.
-If you want to install it anywhere else, just use
+It compiles the package. You need to install it (unless you specified
+a <<configure:local_build,local build>>). To do so, execute:
 
-//TODO Implement the installation
-
-	make install INSTALL_DIR=/where/to/install
+	make install