X-Git-Url: http://git.grml.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fgrml-live.txt;h=2a746e56efe7ca1382d87cf2754664eb20797e8c;hb=5332d22f4acc07403d4cb17d6258542703a8f8d3;hp=38fa84d300c61443f5b0523961442bfceafd1708;hpb=dc72132b00ae3c559a8efc552111b78b14407649;p=grml-live.git diff --git a/docs/grml-live.txt b/docs/grml-live.txt index 38fa84d..2a746e5 100644 --- a/docs/grml-live.txt +++ b/docs/grml-live.txt @@ -10,12 +10,14 @@ Linux Live system (CD/ISO) Synopsis -------- -grml-live [-c ] [-g ] [-i ] [-r ] -[-s ] [-t ] [-v ] [-FVh] +grml-live [-a ] [-c ] [-g ] [-i ] +[-o ] [-r ] [-s ] [-t +] [-v ] [-FVh] ******************************************************************************* Important! This document is growing as requested. If you have questions which aren't answered by this document yet please let me know: ! +This document currently applies to grml-live version 0.0.6. ******************************************************************************* Description @@ -46,12 +48,20 @@ packages will be downloaded and installed via network. If you want to use a local mirror (strongly recommended if you plan to use grml-live more than once) checkout mkdebmirror (see /usr/share/doc/grml-live/examples/mkdebmirror), debmirror(1), reprepro(1) (see /usr/share/doc/grml-live/examples/reprepro/ for a -sample configuration) and approx(8). To avoid downloading the base system again -and again check out FAI's NFSROOT (see FAQ of this document for details). +sample configuration), apt-cacher(1) and approx(8). To avoid downloading the +base system again and again check out FAI's NFSROOT (see FAQ of this document +for details). Options ------- + -a **ARCHITECTURE**:: + +Use the specified architecture instead of the currently running one. This +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. + -c **CLASSES**:: Specify the CLASSES to be used for building the ISO via FAI. By default only @@ -76,9 +86,16 @@ Display short usage information and exit. -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. + -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. @@ -88,12 +105,10 @@ Specify name of the release. 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. - -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**:: @@ -114,13 +129,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: - # 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: - # grml-live -t /tmp -c GRMLBASE,GRML_SMALL,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] @@ -128,8 +143,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 -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 -------------------------- @@ -180,6 +195,11 @@ 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/). +Available classes +----------------- + +To be done... + Files ----- @@ -282,8 +302,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 -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 @@ -400,6 +420,31 @@ executing debootstrap. Check out the output for the following lines: Calling task_mirror [...] +[NOTE] + +Notice that you can also use /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz if +you prefer to use /etc as the main configuration directory instead of +/path/to/nfsroot/.... (Thanks to Thomas Lange for the tip.) + +Set up apt-cacher for use with grml-live +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Make sure /etc/grml/grml-live.conf provides according GRML_LIVE_SOURCES and +FAI_DEBOOTSTRAP: + + # cat /etc/grml/grml-live.conf + [...] + GRML_LIVE_SOURCES=" + deb http://localhost:3142/deb.grml.org grml-stable main + deb http://localhost:3142/deb.grml.org grml-testing main + deb http://localhost:3142/ftp.de.debian.org/debian etch main contrib non-free + " + [...] + FAI_DEBOOTSTRAP="etch http://localhost:3142/ftp.de.debian.org/debian etch main contrib non-free" + +Make sure apt-cacher is running (/etc/init.d/apt-cacher restart). That's it. +All downloaded files will be cached in /var/cache/apt-cacher/ now. + Set up approx for use with grml-live ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~