New option -b for build-only

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

diff --git a/docs/grml-live.txt b/docs/grml-live.txt
index b36947d..94a22d4 100644 (file)
--- a/docs/grml-live.txt
+++ b/docs/grml-live.txt
@@ -12,12 +12,12 @@ 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>] [-FVhu]
+<template_directory>] [-v <version_number>] [-bFVhuz]
 
 *******************************************************************************
 Important! This document is growing as requested. If you have questions which
 aren't answered by this document yet please let me know: <mika@grml.org>!
-This document currently applies to grml-live version 0.0.6.
+This document currently applies to grml-live version 0.0.13.
 *******************************************************************************
 
 Description
@@ -62,6 +62,14 @@ allows building a 32bit system on a 64bit host. Please notice that real
 crosscompiling (like building a ppc system on x86) isn't possible due to the
 nature and the need of working in a chroot.
 
+  -b::
+
+Build the ISO without updating the chroot via FAI. This option is useful for
+example when working on stable releases: if you have a working base
+system/chroot and do not want to execute any further updates (via "-u" option)
+but intend to only build the ISO. (Notice: This option requires a feature within
+FAI which is not yet part of the official FAI release yet.)
+
   -c **CLASSES**::
 
 Specify the CLASSES to be used for building the ISO via FAI.  By default only
@@ -72,6 +80,22 @@ can specify a class providing a grml-kernel (see
 /etc/grml/fai/config/package_config/ for a full list).  So instead of GRML_SMALL
 you can also use GRML_MEDIUM and GRML_FULL instead.
 
+  -C **CONFIGURATION_FILE**::
+
+The specified file is used as configuration file for grml-live. By default
+/etc/grml/grml-live.conf is used for main configuration. If a file named
+/etc/grml/grml-live.local exists it is used as well (sourced after reading
+/etc/grml/grml-live.conf to allow overriding settings). As a last option the
+specified configuration file is sourced so it is possible to override settings
+of /etc/grml/grml-live.conf as well as of /etc/grml/grml-live.local. Please
+notice that all configuration files have to be adjusted during execution of
+grml-live, so please make sure you use /etc/grml/grml-live.conf as a base for
+your own configuration file. Please also notice that the configuration file
+specified via this option is **not** (yet) supported inside the
+scripts/hooks/classes at /etc/grml/fai/config. Instead use
+/etc/grml/grml-live.conf and/or /etc/grml/grml-live.local for configuration
+stuff used inside /etc/grml/fai/config.
+
   -F::
 
 Force execution and do not prompt for acknowledgment of configuration.
@@ -107,7 +131,7 @@ Specify the Debian suite you want to use for your live-system.  Defaults to
 
   -t **TEMPLATE_DIRECTORY**::
 
-Specify place of the templates used for building the ISO. By default 
+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::
@@ -123,6 +147,10 @@ Specify version number of the release.
 
 Increase verbosity in the build process.
 
+  -z::
+
+Use ZLIB instead of LZMA compression in mksquashfs part of the build process.
+
 Usage examples
 --------------
 
@@ -336,7 +364,7 @@ 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.3_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