docs/grml-live.txt

   1 grml-live(8)
   2 ============
   3
   4 Name
   5 ----
   6 grml-live - generate a grml (based) live-cd
   7
   8 Synopsis
   9 --------
  10 grml-live [ todo...]
  11
  12 *******************************************************************************
  13 Important! grml-live is under heavy construction and everything but ready yet.
  14 *******************************************************************************
  15
  16 Introduction
  17 ------------
  18
  19 grml-live provides the build system for creating a grml (based) live-cd.  The
  20 build system is based on link:http://www.informatik.uni-koeln.de/fai/[FAI]
  21 (Fully Automatic Installation). If you are familiar with FAI already it is very
  22 easy to get a live-cd, if you don't know FAI yet don't despair: it's still very
  23 easy. :)
  24
  25 FAI uses a class based system. This gives you the flexibility to choose the
  26 packages you would like to include on your very own live-cd without having to
  27 deal with all the details in the core of the system.
  28
  29 How to get your own live-cd - the easy, fast and simple way
  30 -----------------------------------------------------------
  31
  32 To get a small, Debian-stable and grml based live-cd:
  33
  34   # TARGET="/grml/chroot/grml_uncompressed" ; mkdir -p $TARGET
  35   # fai -v -C /etc/grml/fai -cGRML dirinstall $TARGET
  36   # mksquashfs $TARGET/* /grml/chroot/grml_cd/live/grml.squashfs -noappend
  37   # cd /grml/chroot/grml_cd/
  38   # mkisofs -V "my personal grml" -l -r -J -no-emul-boot -boot-load-size 4 \
  39             -boot-info-table -c boot/isolinux/boot.cat \
  40             -b boot/isolinux/isolinux.bin -o /grml/grml.iso .
  41
  42 (TODO: provide the contenct of /grml/chroot/grml_cd through the package
  43 grml-live, in the meanwhil get the content from a current grml-ISO)
  44
  45 Files
  46 -----
  47
  48 Notice that grml-live ships FAI configuration files that do not use the same
  49 namespace as the FAI packages itself.  This ensures that grml-live does not
  50 clash with your usual FAI configuration, so instead of /etc/fai/fai.conf
  51 (package fai-client) grml uses /etc/grml/fai/fai.conf instead. For more details
  52 see below. To get an idea how another configuration or example files could look
  53 like check out /usr/share/doc/fai-doc/examples/simple/ (provided by Debian package
  54 fai-doc). /usr/share/doc/fai-doc/fai-guide.html/ch-config.html also provides
  55 documentation regarding configuration possibilities.
  56
  57   /etc/grml/fai/fai.conf
  58
  59 Main configuration file which specifies where all the configuration files and
  60 scripts for FAI/grml-live can be found. By default it is
  61 FAI_CONFIGDIR=/etc/grml/fai/config, a directory shipped by grml-live
  62 out-of-the-box so you shouldn't have to configure anything in this file.
  63
  64   /etc/grml/fai/config/
  65
  66 The main directory for configuration of FAI/grml-live. More details below.
  67
  68   /etc/grml/fai/config/class/
  69
  70 This directory contains files which specify main configuration variables for the
  71 FAI classes.
  72
  73   /etc/grml/fai/config/debconf/
  74
  75 This directory provides the files for presseding/configuration of debconf
  76 through files.
  77
  78   /etc/grml/fai/config/hooks/
  79
  80 This directory provides files for customizing the build process through hooks.
  81 Hooks are user defined programs or scripts, which are called during the
  82 installation process.
  83
  84   /etc/grml/fai/config/package_config/
  85
  86 File with lists of software packages to be installed or removed.  The different
  87 classes describe what should find its way to your ISO.  When running 'fai -v
  88 -cGRML dirinstall ...' only the files from the directory GRML/ will be taken, if
  89 you use 'fai -v -cGRML,FOOBAR dirinstall ...' then the files of GRML/ **plus**
  90 the files from FOOBAR/ will be taken. So just create a new class to adjust it to
  91 your needs. Please notice that the directory GRML contains a package list
  92 defining a minimum but still reasonable package configuration.
  93
  94   /etc/grml/fai/config/scripts/
  95
  96 Scripts for customising the ISO within build process.
  97
  98 Bugs
  99 ----
 100 Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes link:http://grml.org/contact/[to us]!
 101
 102 Authors
 103 -------
 104 Michael Prokop <mika@grml.org>.