[doc] update doc, add doc for kcl vars

3 files changed, 66 insertions, 21 deletions

diff --git a/doc/kcl_config_vars b/doc/kcl_config_vars
new file mode 100644
index 00000000..66166299
--- /dev/null
+++ b/doc/kcl_config_vars
@@ -0,0 +1,28 @@
+Following variables can be used as KCL parameters at boot time:
+
+slxsrv=     - A list of openslx server
+slxbase=    - Base directory for resources, such as the config, config.tgz and addons
+
+For a splash screen during boot following commands have to be appended:
+vga=current - Sets the screen resolution 
+splash      - triggers the splash screen (module 'splash-openslx' must have been build)
+quiet       - don't display kernel messages
+
+For debug shells during stage31 set following option:
+debug={1..4}
+
+Level:
+4 - Debug shell before Network is up
+3 - Debug shell after Network is up and before Configuration is fetched
+2 - Debug shell after configuration has been fetched and before stage32 is mounted
+1 - Debug shell after stage32 mount and before switch_root
+
+Following a sample pxe-menu entry for a system:
+
+LABEL u1304x64
+    MENU LABEL Ubuntu 13.04 x64 Curitiba
+        KERNEL http://10.254.221.6/u1304x64/kernel
+        INITRD http://10.254.221.6/u1304x64/initramfs-stage31
+        APPEND slxsrv=10.254.221.6 slxbase=u1304x64 vga=current splash quiet
+        IPAPPEND 3
+
diff --git a/doc/setup_dnbd3 b/doc/setup_dnbd3
index 3af8f4a7..9ccf65e0 100644
--- a/doc/setup_dnbd3
+++ b/doc/setup_dnbd3
@@ -1,15 +1,20 @@
 dnbd3-Setup
 
-1. Sources
+1. Fetch Sources
 
 The git repository is: http://git.openslx.org/dnbd3.git/. Please take care to 
-check out the 'simon' branch. Compileing as usual.
+check out the 'simon' branch. (git checkout origin simon)
 
+2. Required Libs
 
-Compilieren wie gewöhnlich, Konfiguration des Servers erfolgt nun über ein  
-Config-Verzeichnis, das man auf der command line angibt:
+Zlib: 
+    Ubuntu: zlib1g-dev
 
-2. Configuration
+3. Compilation
+
+Run ./build.sh
+
+4. Configuration
 
 To ease debugging it is possible to start the server not as a daemon via 
 the '-n' option.
@@ -60,7 +65,7 @@ but will be user for uplink connections.
 "+" is the opposite; will be sent to clients, but not be used by the server.
 
 
-2.3 Image configuration
+4.3 Image configuration
 
 Images do not need any configuration, as the relative directory tree below
 basePath directly reflects image names. These names are not case sensitive,
@@ -75,7 +80,7 @@ RPC is not available currently, but a rescan of basePath can be triggered by
 SIGUSR1.
 
 
-3. CRC checks
+5. CRC checks
 
 CRC checks are used for consistency checks and debugging purposes. Before a
 rescan a crc file can be generated by following command
@@ -85,7 +90,7 @@ This will be used for consistency checking when replicating via proxies (in
 blocks of 16MiB).
 
 
-4. Client connection
+6. Client connection
 
 A client can be connected via
 # ./dnbd3-client -d /dev/dnbd0 -h [IP of server] -i stage4/ubuntu.sqfs [-r 5]
diff --git a/doc/setup_howto b/doc/setup_howto
index e520973e..00dc012d 100644
--- a/doc/setup_howto
+++ b/doc/setup_howto
@@ -194,12 +194,34 @@ will be defined here. These parameters are documented in doc/boot_config_vars.
 The file config.tgz holds localization information for specific environments, 
 e.g. specific local authentification, home directories, shares and the like. 
 If there is no pre-formatted localization available it's perhaps a good 
-idea to just touch config.tgz or pack an empty archive of that name. Example 
-localizations may be listed at [path to tm-scripts]/server/configs.
+idea to just touch config.tgz or pack an empty archive of that name. 
+
+Example localizations may be listed at [path to tm-scripts]/server/configs.
+As with the stages, the configs are based on modules. That way you can easily
+link to existing modules and add own configuration modules to 
+[path to tm-scripts]/server/modules if needed.
+
+To automatically pack one of the configs under [path to tm-scripts]/server/configs 
+run the openslx script as follows:
+
+# ./openslx <IP of build machine> -k <config_name>
+
+An archive will be created under [path to tm-scripts]/server/boot/[IP or local]/config.tgz
+As mentioned above you can link or copy it into your webroot dir.
 
 
 10. iPXE: TODO
 
+Currently we use iPXE to deliver kernel and initramfs at boot time via HTTP.
+That is also the reason why kernel and initramfs are provided on a webroot instead of a 
+classical tftp directory. 
+
+iPXE can be downloaded here: http://ipxe.org/
+Download and compile the source as described on the homepage.  
+
+
+
+
 This will be most probably not being required in the future, as relevant 
 features are available in recent Syslinux versions (6.0.0+).
 
@@ -217,18 +239,8 @@ will be accessed client-side by nfs. Please keep in mind that
 "./mltk -n" has to be executed on the build machine before cloning 
 Stage 4.
 
-Then, be sure all builds are synced to the server machine, if that has not 
-happened before:
-# ./openslx <IP of build machine> -s
-
-... or, if wanted, sync just some parts, if you know what you're doing. 
-Stage31 makes most sense so far, so to say. So, for example:
-# ./openslx <IP> stage31 -e cpio -s
-etc.
-
 Well, then do the cloning work:
-# ./scripts/clone_stage4 [IP of build machine] stage32 \
-	/path/to/your/nfs/share/stage4     # (this is one line!)
+# ./scripts/clone_stage4 [IP of build machine] /path/to/your/nfs/share/stage4
 
 To use Stage 4 the clients need the nfs mount information. This is handled via 
 a configuration variable (please consult doc/boot_config_vars for a full