Rename class GRML into GRMLBASE and update all files according.

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

diff --git a/docs/grml-live.txt b/docs/grml-live.txt
index ac8ebd3..9bb6948 100644 (file)
--- a/docs/grml-live.txt
+++ b/docs/grml-live.txt
@@ -47,8 +47,8 @@ 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 GRML and I386 are assumed, resulting in a small base system (being
-about ~150MB ISO size).
+the classes GRMLBASE and I386 are assumed, resulting in a small base system
+(being about ~150MB ISO size).

 
   -t **TARGET_DIRECTORY**::
 
 
   -t **TARGET_DIRECTORY**::
 


@@ -87,26 +87,26 @@ grml-live uses FAI and its class based concept for adjusting configuration
 according to your needs. This gives you flexibility and strength without losing
 the simplicity in the build process.
 
 according to your needs. This gives you flexibility and strength without losing
 the simplicity in the build process.
 

-The main and base class provided by grml-live is named GRML. It's strongly
-recommended to **always** use the class GRML 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 (being 'I386' for x86_32
 currently only). The following files and directories are relevant for class GRML
 by default:
 
 grml-live as well as the architecture dependend class (being 'I386' for x86_32
 currently only). The following files and directories are relevant for class GRML
 by default:
 

-  /etc/grml/fai/config/scripts/GRML/
-  /etc/grml/fai/config/debconf/GRML
-  /etc/grml/fai/config/class/GRML.var
-  /etc/grml/fai/config/hooks/instsoft.GRML
-  /etc/grml/fai/config/package_config/GRML
+  /etc/grml/fai/config/scripts/GRMLBASE/
+  /etc/grml/fai/config/debconf/GRMLBASE
+  /etc/grml/fai/config/class/GRMLBASE.var
+  /etc/grml/fai/config/hooks/instsoft.GRMLBASE
+  /etc/grml/fai/config/package_config/GRMLBASE

 
 Take a look at the next section for information about the concept of those
 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. For example
 
 Take a look at the next section for information about the concept of those
 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. For example

-if you want to use your own class named "FOOBAR" just extend CLASSES="GRML" inside
-/etc/grml/grml-live.conf to CLASSES="GRML,FOOBAR" or invoke grml-live using
-the classes option: "grml-live -c GRML,FOOBAR ...".
+if you want to use your own class named "FOOBAR" just extend CLASSES="GRMLBASE"
+inside /etc/grml/grml-live.conf to CLASSES="GRMLBASE,FOOBAR" or invoke grml-live
+using the classes option: "grml-live -c GRMLBASE,FOOBAR ...".

 
 More details regarding the class concept can be found in the documentation of
 FAI (available at /usr/share/doc/fai-doc/).
 
 More details regarding the class concept can be found in the documentation of
 FAI (available at /usr/share/doc/fai-doc/).


@@ -173,17 +173,23 @@ installation process.
 
 File with lists of software packages to be installed or removed.  The different
 classes describe what should find its way to your ISO.  When running 'fai -v -C
 
 File with lists of software packages to be installed or removed.  The different
 classes describe what should find its way to your ISO.  When running 'fai -v -C

-/etc/grml/fai -cGRML dirinstall ...' only the files from the directory GRML/
-will be taken, if you use 'fai -v -C /etc/grml/fai -cGRML,FOOBAR dirinstall ...'
-then the files of GRML/ **plus** the files from FOOBAR/ will be taken. So just
-create a new class to adjust it to your needs. Please notice that the directory
-GRML contains a package list defining a minimum but still reasonable package
-configuration.
+/etc/grml/fai -cGRMLBASE dirinstall ...' only the files from the directory GRML/
+will be taken, if you use 'fai -v -C /etc/grml/fai -cGRMLBASE,FOOBAR dirinstall
+...' then the files of GRML/ **plus** the files from FOOBAR/ will be taken. So
+just create a new class to adjust it to your needs. Please notice that the
+directory GRML contains a package list defining a minimum but still reasonable
+package configuration.

 
   /etc/grml/fai/config/scripts/
 
 Scripts for customising the ISO within build process.
 
 
   /etc/grml/fai/config/scripts/
 
 Scripts for customising the ISO within build process.
 

+  /etc/grml/fai/files/
+
+This directory provides files used inside the scripts of
+/etc/grml/fai/config/scripts/*. For a full documentation what happens with the
+files please refer to the source of the scripts.
+

   /etc/grml/fai/live-initramfs/
 
 This directory provides the files used for building the initramfs/initrd via
   /etc/grml/fai/live-initramfs/
 
 This directory provides the files used for building the initramfs/initrd via


@@ -207,32 +213,38 @@ as possiblbe)
 Known TODOs
 -----------
 
 Known TODOs
 -----------
 

-* extend the grml-live wrapper script so it runs all the necessary command in a
-single run (boot/isolinux, mksquashfs and mkisofs stuff is missing currently)
+* do not use /dev/shm/ als default target directory (which one do we want to use
+instead?)
+
+* add support for amd64 [gebi?] + ppc [formorer?] (and identify all packages
+that are arch specific so we have a clean package list in all classes)
+
+* support different grml-flavours through classes right out-of-the-box (being:
+grml, grml64, grml-small for at least x86, amd64 and ppc)

 
 

-* really support signed apt repositories
+* support setting grml-live configuration on the command line to provide
+different flavours using the commandline only
+
+* really support signed apt repositories (currently it's deactivated via fai's
+dirinstall for some packages)

 
 * explain (and provide configuration for) the use of NFSROOT
 
 * support setting stuff like ISO name, version,... (especially for stuff inside
 x86_files/boot/isolinux)
 
 
 * explain (and provide configuration for) the use of NFSROOT
 
 * support setting stuff like ISO name, version,... (especially for stuff inside
 x86_files/boot/isolinux)
 

-* identify all packages that are arch specific
-
-* support different flavours and architectures of Debian (currently it defaults
-to Debian/stable x86_32)
+* support "final builds" (including stuff like md5sums)

 
 

-* use hooks of FAI in grml-live script?
+* use hooks of FAI as far as possible in all grml-live scripts

 
 

-* the GRML class(es) should send output as used inside FAI as well (so it's not
-as verbose unless you specify it)
+* the grml-live class(es) should send output as used inside FAI as well (so it's
+not as verbose unless you specify it, make it configurable)

 
 * provide possibility for cleanup of all created build directories
 
 
 * provide possibility for cleanup of all created build directories
 

-* support nocolor-option for /etc/grml/fai/grml/grml_cleanup_chroot
+* support hooks to further allow customisation of the build process

 
 

-* copy files from $FAI_CONFIGDIR/... instead of using 'cat > $FILE << EOF ...'
-inside the  /etc/grml/fai/config/scripts/GRML/-scripts
+* support nocolor-option for /etc/grml/fai/grml/grml_cleanup_chroot

 
 Bugs
 ----
 
 Bugs
 ----