docs: mention FOOBAR class in usage example via /etc/grml/grml-live.local

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

diff --git a/docs/grml-live.txt b/docs/grml-live.txt
index 0874fdd..51a1554 100644 (file)
--- a/docs/grml-live.txt
+++ b/docs/grml-live.txt
@@ -81,11 +81,17 @@ really know that you do not want to update the chroot.
 Specify the CLASSES to be used for building the ISO via FAI.  By default only
 the classes GRMLBASE, GRML_MEDIUM and I386 are assumed, resulting in a small base
 system (being about ~180MB total ISO size). If using a non-I386 system (like
 Specify the CLASSES to be used for building the ISO via FAI.  By default only
 the classes GRMLBASE, GRML_MEDIUM and I386 are assumed, resulting in a small base
 system (being about ~180MB total ISO size). If using a non-I386 system (like

-amd64) you should specify the appropriate architecture as well. Additionally you
+AMD64) you should specify the appropriate architecture as well. Additionally you

 can specify a class providing a grml-kernel (see
 <<classes,the 'CLASSES' section in this document>> for details about available classes).
 So instead of GRML_MEDIUM you can also use GRML_SMALL and GRML_FULL.
 
 can specify a class providing a grml-kernel (see
 <<classes,the 'CLASSES' section in this document>> for details about available classes).
 So instead of GRML_MEDIUM you can also use GRML_SMALL and GRML_FULL.
 

+[IMPORTANT]
+All class names should be written in uppercase letters. Do not use a dash, use
+an underscore. So do not use "amd64" but "AMD64", do not use "FOO BAR" but
+"FOO_BAR".
+
+

   -C **CONFIGURATION_FILE**::
 
 The specified file is used as configuration file for grml-live. By default
   -C **CONFIGURATION_FILE**::
 
 The specified file is used as configuration file for grml-live. By default


@@ -164,7 +170,8 @@ Specify name of the release.
 Specify the Debian suite you want to use for your live-system.  Defaults to
 "lenny" (being current Debian/stable). Supported values are: etch, lenny, sid.
 Debian "squeeze" (current Debian/testing) requires base.tgz
 Specify the Debian suite you want to use for your live-system.  Defaults to
 "lenny" (being current Debian/stable). Supported values are: etch, lenny, sid.
 Debian "squeeze" (current Debian/testing) requires base.tgz

-(/etc/grml/fai/config/basefiles/....tar.gz) or a recent version of debootstrap.
+(/etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz) or a recent version of
+debootstrap.

 
   -t **TEMPLATE_DIRECTORY**::
 
 
   -t **TEMPLATE_DIRECTORY**::
 


@@ -266,8 +273,8 @@ files/directories.
 If you want to use your own configuration, extend an existing configuration
 and/or add additional packages to your ISO just invent a new class (or extend an
 existing one). For example if you want to use your own class named "FOOBAR" just
 If you want to use your own configuration, extend an existing configuration
 and/or add additional packages to your ISO just invent a new class (or extend an
 existing one). For example if you want to use your own class named "FOOBAR" just

-set CLASSES="GRMLBASE,GRML_SMALL,I386" inside /etc/grml/grml-live.local or
-invoke grml-live using the classes option: "grml-live -c
+set CLASSES="GRMLBASE,GRML_SMALL,I386,FOOBAR" inside /etc/grml/grml-live.local
+or invoke grml-live using the classes option: "grml-live -c

 GRMLBASE,GRML_SMALL,I386,FOOBAR ...".
 
 More details regarding the class concept can be found in the documentation of
 GRMLBASE,GRML_SMALL,I386,FOOBAR ...".
 
 More details regarding the class concept can be found in the documentation of


@@ -347,7 +354,7 @@ configuration instead.
   /etc/grml/grml-live.local
 
 All the local configuration should go to this file. This file overrides any
   /etc/grml/grml-live.local
 
 All the local configuration should go to this file. This file overrides any

-defaults of grml-live. Configurations via /etc/grml/grml-live.local are prefered
+defaults of grml-live. Configurations via /etc/grml/grml-live.local are preferred

 over the ones from /etc/grml/grml-live.conf. If you want to override settings
 from /etc/grml/grml-live.local as well you have to specify them on the grml-live
 commandline.
 over the ones from /etc/grml/grml-live.conf. If you want to override settings
 from /etc/grml/grml-live.local as well you have to specify them on the grml-live
 commandline.


@@ -532,6 +539,7 @@ ZLIB compression. Just use the defaults for enabling LZMA or use grml-live's
 * Kernel 2.6.26-grml[64]: does not work
 * Kernel 2.6.28-grml[64]: does not work
 * Kernel 2.6.31-grml[64]: works
 * Kernel 2.6.26-grml[64]: does not work
 * Kernel 2.6.28-grml[64]: does not work
 * Kernel 2.6.31-grml[64]: works

+* Kernel 2.6.33-grml[64]: works

 
 [NOTE]
 
 
 [NOTE]
 


@@ -559,6 +567,7 @@ Grml's squashfs-lzma-tools (see section above) instead.
 * Kernel 2.6.26-grml[64]: does not work
 * Kernel 2.6.28-grml[64]: does not work
 * Kernel 2.6.31-grml[64]: works
 * Kernel 2.6.26-grml[64]: does not work
 * Kernel 2.6.28-grml[64]: does not work
 * Kernel 2.6.31-grml[64]: works

+* Kernel 2.6.33-grml[64]: works

 
 [NOTE]
 Please use squashfs-tools >=1:4.0-1 only if you want to remaster grml releases
 
 [NOTE]
 Please use squashfs-tools >=1:4.0-1 only if you want to remaster grml releases


@@ -684,13 +693,15 @@ Instructions
   apt-get update
   apt-get --allow-unauthenticated install grml-debian-keyring
 
   apt-get update
   apt-get --allow-unauthenticated install grml-debian-keyring
 

-  # install basefile so we don't have to build basic chroot from scratch:
-  mkdir -p /etc/grml/fai/config/basefiles/
-  mv base.tgz /etc/grml/fai/config/basefiles/I386.tar.gz
+  # optionally(!) install basefile so we don't have to build basic
+  # chroot from scratch, grab from http://daily.grml.org/
+  # mkdir -p /etc/grml/fai/config/basefiles/
+  # mv base.tgz /etc/grml/fai/config/basefiles/I386.tar.gz
+  # mv base64.tgz /etc/grml/fai/config/basefiles/AMD64.tar.gz

 
   # install relevant tools
   # please check out http://grml.org/grml-live/#current_state when encountering problems!
 
   # install relevant tools
   # please check out http://grml.org/grml-live/#current_state when encountering problems!

-  apt-get -o APT::Install-Recommends=false install grml-live squashfs-lzma-tools
+  apt-get -o APT::Install-Recommends=false install grml-live squashfs-tools squashfs-lzma-tools

 
   # adjust grml-live configuration for our needs:
   cat > /etc/grml/grml-live.local << EOF
 
   # adjust grml-live configuration for our needs:
   cat > /etc/grml/grml-live.local << EOF


@@ -832,7 +843,7 @@ taken. If you customise the variables in /etc/grml/grml-live.conf then the two
 files will be adjusted during runtime automatically.
 
 If MIRROR_DIRECTORY and MIRROR_SOURCES are specified the local mirror will be
 files will be adjusted during runtime automatically.
 
 If MIRROR_DIRECTORY and MIRROR_SOURCES are specified the local mirror will be

-taken as first entry in the generated sources.list so it's prefered over
+taken as first entry in the generated sources.list so it's preferred over

 non-local mirrors. Using a fallback mirror (via providing several mirrors in
 GRML_LIVE_SOURCES as used by default) is a recommended setting.
 
 non-local mirrors. Using a fallback mirror (via providing several mirrors in
 GRML_LIVE_SOURCES as used by default) is a recommended setting.
 


@@ -912,6 +923,9 @@ or if using /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz for:
   /grml-live/grml-live_20071029.22138/grml_chroot//
   [...]
 
   /grml-live/grml-live_20071029.22138/grml_chroot//
   [...]
 

+[TIP]
+Existing base.tgz can be found at http://daily.grml.org/
+

 [[apt-cacher]]
 Set up apt-cacher / apt-cacher-ng for use with grml-live
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 [[apt-cacher]]
 Set up apt-cacher / apt-cacher-ng for use with grml-live
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~