Adjust logfile handling for new FAI; support grml2ram bootoption

[grml-live.git] / docs / grml-live.txt

diff --git a/docs/grml-live.txt b/docs/grml-live.txt
index 2a746e5..b36947d 100644 (file)
--- a/docs/grml-live.txt
+++ b/docs/grml-live.txt
@@ -12,7 +12,7 @@ Synopsis
 
 grml-live [-a <architecture>] [-c <classe[s]>] [-g <grml_name>] [-i <iso_name> ]
 [-o <output_directory>] [-r <release_name>] [-s <suite>] [-t
-<template_directory>] [-v <version_number>] [-FVh]
+<template_directory>] [-v <version_number>] [-FVhu]
 
 *******************************************************************************
 Important! This document is growing as requested. If you have questions which
@@ -110,6 +110,11 @@ Specify the Debian suite you want to use for your live-system.  Defaults to
 Specify place of the templates used for building the ISO. By default 
 (and if not manually specified) this is /usr/share/grml-live/templates/.
 
+  -u::
+
+Update existing chroot instead of rebuilding it from scratch. This option is
+based on the softupdate feature of FAI.
+
   -v **VERSION_NUMBER**::
 
 Specify version number of the release.
@@ -198,7 +203,7 @@ FAI itself (being available at /usr/share/doc/fai-doc/).
 Available classes
 -----------------
 
-To be done...
+Documentation to be done...
 
 Files
 -----
@@ -294,6 +299,20 @@ files please refer to the source of the scripts.
 This directory provides the files used for building the initramfs/initrd via
 live-initramfs(8).
 
+Available log files
+-------------------
+
+grml-live itself logs to /var/log/grml-live.log. Unless you set ZERO_LOGFILE in
+/etc/grml/grml-live.conf the output is appended to the file. If you set the
+ZERO_LOGFILE configuration option the logfile will be truncated on each new
+invocation of grml-live.
+
+The FAI part of grml-live logs to /var/log/fai/$HOSTNAME/ - so the
+default being /var/log/fai/grml/.
+
+If you are using the grml-live buildd you will find the logs of the grml-live
+run at /var/log/grml-buildd.stdout and /var/log/grml-buildd.stderr.
+
 Requirements for the build system
 ---------------------------------
 
@@ -317,9 +336,10 @@ FAQ
 Help, I'm using Debian etch and I don't have FAI version >3.2
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-  wget http://www.informatik.uni-koeln.de/fai/download/etch/fai-client_3.2.1_all.deb \
-       http://www.informatik.uni-koeln.de/fai/download/etch/fai-server_3.2.1_all.deb
-  dpkg -i fai-client_3.2.1_all.deb fai-server_3.2.1_all.deb
+  wget http://www.informatik.uni-koeln.de/fai/download/etch/fai-client_3.2.3_all.deb \ 
+       http://www.informatik.uni-koeln.de/fai/download/etch/fai-server_3.2.3_all.deb \
+       http://www.informatik.uni-koeln.de/fai/download/etch/fai-doc_3.2.3_all.deb
+  dpkg -i fai-client_3.2.3_all.deb fai-server_3.2.3_all.deb fai-doc_3.2.3_all.deb
 
 or check out the link:http://www.informatik.uni-koeln.de/fai/[FAI-homepage] for
 further details.
@@ -327,14 +347,14 @@ further details.
 I've problems with the build process. How to start debugging?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Check out the logs inside /var/log/fai/dirinstall/... If you don't have the time
-to debug the problem in further detail or don't know how to proceed just send a
-copy of your config, logs and the commandline with a short problem description
-to <mika@grml.org>:
+Check out the logs inside /var/log/fai/... If you don't have the time to debug
+the problem in further detail or don't know how to proceed just send a copy of
+your config, logs and the commandline with a short problem description to
+<mika@grml.org>:
 
   # history | grep grml-live > /etc/grml/grml_live.cmdline
   # tar zcf grml_live_problem.tar.gz /etc/grml/grml-live.conf \
-            /var/log/fai/dirinstall /etc/grml/fai
+            /etc/grml/grml-buildd.conf /var/log/fai /etc/grml/fai
 
 Can I use my own (local) Debian mirror?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -345,7 +365,7 @@ your needs. Please don't forget that you should use the grml servers as well
 (see default configuration) so all the grml packages can be downloaded as well.
 
 If you want to use a local (for example NFS mount) mirror additionally, just
-adjust MIRROR_DIRECTORY and MIRROR_SOURCES insede /etc/grml/grml-live.conf as
+adjust MIRROR_DIRECTORY and MIRROR_SOURCES inside /etc/grml/grml-live.conf as
 well.
 
 Unless you specify GRML_LIVE_SOURCES and/or FAI_DEBOOTSTRAP the default from
@@ -410,8 +430,12 @@ So as /grml/fai/nfsroot is your NFSROOT place the file under
 
   mv base.tgz /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz
 
+or even better use /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz instead.
+Use I386 as $CLASSNAME for i386 builds and AMD64 for amd64 builds.
+
 Now running "grml-live ..." will use this file as main system instead of
-executing debootstrap. Check out the output for the following lines:
+executing debootstrap. Check out the output for the following lines if using
+NFSROOT:
 
   [...]
   Calling task_extrbase
@@ -420,11 +444,12 @@ executing debootstrap. Check out the output for the following lines:
   Calling task_mirror
   [...]
 
-[NOTE]
+or if using /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz for:
 
-Notice that you can also use /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz if
-you prefer to use /etc as the main configuration directory instead of
-/path/to/nfsroot/.... (Thanks to Thomas Lange for the tip.)
+  [...]
+  ftar: extracting /etc/grml/fai/config/basefiles///AMD64.tar.gz to
+  /grml-live/grml-live_20071029.22138/grml_chroot//
+  [...]
 
 Set up apt-cacher for use with grml-live
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~