Rename -t option to -o; add iscsitarget, disable mdadm in initrd

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

diff --git a/docs/grml-live.txt b/docs/grml-live.txt
index 00ce4c2..c7cb2c5 100644 (file)
--- a/docs/grml-live.txt
+++ b/docs/grml-live.txt
@@ -10,8 +10,9 @@ Linux Live system (CD/ISO)
 Synopsis
 --------
 
 Synopsis
 --------
 

-grml-live [-c <classe[s]>] [-g <grml_name>] [-i <iso_name> ] [-r <release_name>]
-[-s <suite>] [-t <target_directory>] [-v <version_number>] [-FVh]
+grml-live [-c <classe[s]>] [-g <grml_name>] [-i <iso_name> ] [-o
+<output_directory>] [-r <release_name>] [-s <suite>] [-t <template_directory>]
+[-v <version_number>] [-FVh]

 
 *******************************************************************************
 Important! This document is growing as requested. If you have questions which
 
 *******************************************************************************
 Important! This document is growing as requested. If you have questions which


@@ -55,8 +56,12 @@ Options
   -c **CLASSES**::
 
 Specify the CLASSES to be used for building the ISO via FAI.  By default only
   -c **CLASSES**::
 
 Specify the CLASSES to be used for building the ISO via FAI.  By default only

-the classes GRMLBASE and I386 are assumed, resulting in a small base system
-(being about ~150MB total ISO size) for x86 (32bit).
+the classes GRMLBASE, GRML_SMALL and I386 are assumed, resulting in a small base
+system (being about ~150MB total ISO size). If using a non-I386 system (like
+amd64) you should specify the appropriate architecture as well. Additionally you
+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.

 
   -F::
 
 
   -F::
 


@@ -72,9 +77,16 @@ Display short usage information and exit.
 
   -i **ISO_NAME**::
 
 
   -i **ISO_NAME**::
 

-Specify name of ISO which will be available inside $TARGET_DIRECTORY/grml_isos
+Specify name of ISO which will be available inside $OUTPUT_DIRECTORY/grml_isos

 by default.
 
 by default.
 

+  -o **OUTPUT_DIRECTORY**::
+
+Main output directory of the build process of FAI.  Some directories are created
+inside this target directory, being: grml_cd (where the files for creating the
+ISO are located, including the compressed squashfs file), grml_chroot (the
+chroot system) and grml_isos (where the resulting ISO is stored).
+

   -r **RELEASENAME**::
 
 Specify name of the release.
   -r **RELEASENAME**::
 
 Specify name of the release.


@@ -82,15 +94,12 @@ Specify name of the release.
   -s **SUITE**::
 
 Specify the Debian suite you want to use for your live-system.  Defaults to
   -s **SUITE**::
 
 Specify the Debian suite you want to use for your live-system.  Defaults to

-"etch" (being current Debian/stable). Supported values are: etch, lenny, sid,
-stable, testing, unstable.
+"etch" (being current Debian/stable). Supported values are: etch, lenny, sid.

 
 

-  -t **TARGET_DIRECTORY**::
+  -t **TEMPLATE_DIRECTORY**::

 
 

-Main output directory of the build process of FAI.  Some directories are created
-inside this target directory, being: grml_cd (where the files for creating the
-ISO are located, including the compressed squashfs file), grml_chroot (the
-chroot system) and grml_isos (where the resulting ISO is stored).
+Specify place of the templates used for building the ISO. By default 
+(and if not manually specified) this is /usr/share/grml-live/templates/.

 
   -v **VERSION_NUMBER**::
 
 
   -v **VERSION_NUMBER**::
 


@@ -111,13 +120,13 @@ as build and output directory just run:
 To get a small Debian-unstable and grml-small based Live-CD using
 /home/mika/grml-live as build and output directory just use:
 
 To get a small Debian-unstable and grml-small based Live-CD using
 /home/mika/grml-live as build and output directory just use:
 

-  # grml-live -c GRMLBASE,GRML_SMALL,I386 -t /home/mika/grml-live
+  # grml-live -c GRMLBASE,GRML_SMALL,I386 -o /home/mika/grml-live

 
 To get a small, Debian-unstable and grml-based Live-CD using /tmp as build and
 output directory and use grml_0.0-3.iso as ISO name (placed inside
 /tmp/grml_isos) just invoke:
 
 
 To get a small, Debian-unstable and grml-based Live-CD using /tmp as build and
 output directory and use grml_0.0-3.iso as ISO name (placed inside
 /tmp/grml_isos) just invoke:
 

-  # grml-live -t /tmp -c GRMLBASE,I386 -s sid -i grml_0.0-3.iso
+  # grml-live -o /tmp -c GRMLBASE,GRML_SMALL,I386 -s sid -i grml_0.0-3.iso

 
 [NOTE]
 
 
 [NOTE]
 


@@ -125,8 +134,8 @@ If you have about 700MB of free space inside /dev/shm (being a tmpfs, usually
 you should have >=1GB of RAM) just run "mount -o remount,suid,dev,rw /dev/shm"
 and use /dev/shm as build and output directory - resulting in very fast build
 process.  But please be aware of the fact that rebooting your system will result
 you should have >=1GB of RAM) just run "mount -o remount,suid,dev,rw /dev/shm"
 and use /dev/shm as build and output directory - resulting in very fast build
 process.  But please be aware of the fact that rebooting your system will result

-in an empty /dev/shm, so please another directory for $CHROOT_TARGET,
-$BUILD_TARGET and $ISO_TARGET if you plan to create more persistent output. :)
+in an empty /dev/shm, so please another directory for $CHROOT_OUTPUT,
+$BUILD_OUTPUT and $ISO_OUTPUT if you plan to create more persistent output. :)

 
 Main features of grml-live
 --------------------------
 
 Main features of grml-live
 --------------------------


@@ -153,9 +162,10 @@ losing the simplicity in the build process.
 
 The main and base class provided by grml-live is named GRMLBASE. It's strongly
 recommended to **always** use the class GRMLBASE when building an ISO using
 
 The main and base class provided by grml-live is named GRMLBASE. It's strongly
 recommended to **always** use the class GRMLBASE when building an ISO using

-grml-live, as well as the architecture dependend class which provides the kernel
-(being 'I386' for x86_32 currently only). The following files and directories
-are relevant for class GRMLBASE by default:
+grml-live, as well as the architecture dependent class which provides the kernel
+(being 'I386' for x86_32 and 'AMD64' for x86_64) and a GRML_* class (like
+GRML_SMALL, GRML_MEDIUM or GRML_FULL). The following files and directories are
+relevant for class GRMLBASE by default:

 
   /etc/grml/fai/config/scripts/GRMLBASE/
   /etc/grml/fai/config/debconf/GRMLBASE
 
   /etc/grml/fai/config/scripts/GRMLBASE/
   /etc/grml/fai/config/debconf/GRMLBASE


@@ -169,9 +179,9 @@ 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

-extend CLASSES="GRMLBASE,I386" inside /etc/grml/grml-live.conf to
-CLASSES="GRMLBASE,I386,FOOBAR" or invoke grml-live using the classes option:
-"grml-live -c GRMLBASE,I386,FOOBAR ...".
+extend CLASSES="GRMLBASE,GRML_SMALL,I386" inside /etc/grml/grml-live.conf to
+CLASSES="GRMLBASE,GRML_SMALL,I386,FOOBAR" 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
 FAI itself (being available at /usr/share/doc/fai-doc/).
 
 More details regarding the class concept can be found in the documentation of
 FAI itself (being available at /usr/share/doc/fai-doc/).


@@ -247,12 +257,13 @@ installation process.
 
 Directory with lists of software packages to be installed or removed.  The
 different classes describe what should find its way to your ISO.  When running
 
 Directory with lists of software packages to be installed or removed.  The
 different classes describe what should find its way to your ISO.  When running

-"grml-live -c GRMLBASE,I386 ..." only the files from the directories GRMLBASE
-and I386 will be taken, if you use 'grml-live -c GRMLBASE,I386,FOOBAR ...' then
-the files of GRMLBASE, I386 **plus** the files from FOOBAR will be taken. So
-just create a new class to adjust the package selection according to your needs.
-Please notice that the directory GRMLBASE contains a package list defining a
-minimum but still reasonable package configuration.
+"grml-live -c GRMLBASE,GRML_SMALL,I386 ..." only the configuration of GRMLBASE,
+GRML_SMALL and and I386 will be taken. If you use 'grml-live -c
+GRMLBASE,GRML_SMALL,I386,FOOBAR ...' then the files of GRMLBASE, GRML_SMALL,
+I386 **plus** the files from FOOBAR will be taken. So just create a new class to
+adjust the package selection according to your needs.  Please notice that the
+directory GRMLBASE contains a package list defining a minimum but still
+reasonable package configuration.

 
   /etc/grml/fai/config/scripts/
 
 
   /etc/grml/fai/config/scripts/
 


@@ -277,8 +288,8 @@ send us a bug report then) [a usual link:http://grml.org/grml2hd/[grml2hd]
 harddisk installation ships all you need]
 
 * enough free disk space; at least 800MB are required for a minimal grml-live
 harddisk installation ships all you need]
 
 * enough free disk space; at least 800MB are required for a minimal grml-live

-run (\~400MB for the chroot [$CHROOT_TARGET], \~150MB for the build target
-[$BUILD_TARGET] and \~150MB for the resulting ISO [$ISO_TARGET] plus some
+run (\~400MB for the chroot [$CHROOT_OUTPUT], \~150MB for the build target
+[$BUILD_OUTPUT] and \~150MB for the resulting ISO [$ISO_OUTPUT] plus some

 temporary files), if you plan to use GRML_FULL you should have at least 4GB of
 total free disk space
 
 temporary files), if you plan to use GRML_FULL you should have at least 4GB of
 total free disk space
 


@@ -348,7 +359,7 @@ Just create a new class (using the package_config directory):
 
 and specify it when invoking grml-live then:
 
 
 and specify it when invoking grml-live then:
 

-  # grml-live -c GRMLBASE,I386,MIKA
+  # grml-live -c GRMLBASE,GRML_SMALL,I386,MIKA

 
 I fscked up my grml-live configuration. How do I reset it to the defaults?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 I fscked up my grml-live configuration. How do I reset it to the defaults?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~