X-Git-Url: https://git.grml.org/?p=grml-live.git;a=blobdiff_plain;f=docs%2Fgrml-live.txt;h=00ce4c2cde329ada33b44e8775119f7218690038;hp=0b21b58cf1259eae6cb82ca064844cac1c79407c;hb=4f8937bce96f552121e525eb927a2daea4dfae88;hpb=f684e9577f54be351e2c3dcdbc4414101433bb10 diff --git a/docs/grml-live.txt b/docs/grml-live.txt index 0b21b58..00ce4c2 100644 --- a/docs/grml-live.txt +++ b/docs/grml-live.txt @@ -10,7 +10,8 @@ Linux Live system (CD/ISO) Synopsis -------- -grml-live [-c ] [-t ] [-s ] [-Fvh] +grml-live [-c ] [-g ] [-i ] [-r ] +[-s ] [-t ] [-v ] [-FVh] ******************************************************************************* Important! This document is growing as requested. If you have questions which @@ -57,6 +58,27 @@ 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). + -F:: + +Force execution and do not prompt for acknowledgment of configuration. + + -g **GRML_NAME**:: + +Set the grml flavour name. Common usage examples: grml, grml-small, grml64. + + -h:: + +Display short usage information and exit. + + -i **ISO_NAME**:: + +Specify name of ISO which will be available inside $TARGET_DIRECTORY/grml_isos +by default. + + -r **RELEASENAME**:: + +Specify name of the release. + -s **SUITE**:: Specify the Debian suite you want to use for your live-system. Defaults to @@ -70,20 +92,16 @@ 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). - -F:: + -v **VERSION_NUMBER**:: -Force execution and do not prompt for acknowledgment of configuration. +Specify version number of the release. - -h:: - -Display short usage information and exit. - - -v:: + -V:: Increase verbosity in the build process. -How to get your own Live-CD - the easy, fast and simple way ------------------------------------------------------------ +Usage examples +-------------- To get a small, Debian-stable and grml-based Live-CD using /grml/grml-live as build and output directory just run: @@ -95,6 +113,12 @@ To get a small Debian-unstable and grml-small based Live-CD using # grml-live -c GRMLBASE,GRML_SMALL,I386 -t /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,I386 -s sid -i grml_0.0-3.iso + [NOTE] If you have about 700MB of free space inside /dev/shm (being a tmpfs, usually @@ -371,70 +395,44 @@ executing debootstrap. Check out the output for the following lines: Calling task_mirror [...] -I've a question which isn't answered by this document -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Don't hesitate to ask on IRC (channel #grml on irc.freenode.org) or just drop me -a mail: - -Known TODOs ------------ - -* support something like a directory /etc/grml/fai/packages to install -additional Debian packages without the need for a Debian repository - -* document the available classes in more detail (GRMLBASE, LATEX_CLEANUP, -NO_ONLINE, REMOVE_DOCS, GRML_SMALL,...) - -* add a check to make sure $TARGET is mounted rw,suid,dev? - -* 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 and grml-small (done), each for x86, amd64 and ppc) - -* support signed apt repositories (currently it's deactivated via FAI's -FAI_ALLOW_UNSIGNED=1 for some packages in the toolchain) +Set up approx for use with grml-live +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* support setting stuff like ISO name, version,... on-the-fly (especially for -stuff inside boot/isolinux/*) +Make sure /etc/grml/grml-live.conf provides according GRML_LIVE_SOURCES and +FAI_DEBOOTSTRAP: -* support "final builds" (including stuff like generating md5sums, gpg,... - -create a grml_release-directory including all the details about the build -process like dpkg selection, logs,...) - -* the grml-live class(es) should send output to stdout and stderr as used inside -FAI as well (so it's not as verbose unless you specify it, make it configurable -though); check for errors inside the logs then as well - -* provide possibility for cleanup of all created build directories and -a smart summary of the buildprocess (including "took ... minutes/seconds to -build...") - -* check out how FAI_DEBMIRROR of /etc/grml/fai/fai.conf could be merged with our -MIRROR_DIRECTORY and MIRROR_SOURCES feature of /etc/grml/grml-live.conf + # cat /etc/grml/grml-live.conf + [...] + GRML_LIVE_SOURCES=" + deb http://localhost:9999/grml grml-stable main + deb http://localhost:9999/grml grml-testing main + deb http://localhost:9999/debian etch main contrib non-free + " + FAI_DEBOOTSTRAP="etch http://localhost:9999/debian" -* support hooks to allow further customisation of the build process +Configure approx: -Long term goals ---------------- + # cat /etc/approx/approx.conf + [...] + debian http://ftp.at.debian.org/debian + grml http://deb.grml.org/ -* Provide all upcoming grml releases based on grml-live. +Don't forget to restart approx (/etc/init.d/approx restart). That's it. +All downloaded files will be cached in /var/cache/approx now. -* Provide a console interface (using dialog) for easy and common use of -grml-live. +I've a question which isn't answered by this document +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* Provide a graphical interface (for example using pygtk) for easy and common -use of grml-live. +Don't hesitate to ask on IRC (channel #grml on irc.freenode.org) or just drop me +a mail: Download / install grml-live as a Debian package ------------------------------------------------ -Debian packages will be available through the grml-repository at -link:http://deb.grml.org/[http://deb.grml.org/] as soon as the grml-team -considers grml-live as stable enough. In the meantime just build the package on -your own: +Debian packages are available through the grml-repository at +link:http://deb.grml.org/pool/main/g/grml-live/[deb.grml.org]. If you want to +build a Debian package on your own (using for example a specific version or the +current development tree), just execute: hg clone http://hg.grml.org/grml-live cd grml-live @@ -446,6 +444,12 @@ Source The source of grml-live is available at link:http://hg.grml.org/grml-live/[http://hg.grml.org/grml-live/] +TODO list +--------- + +Check out link:http://wiki.grml.org/doku.php?id=grml-live[grml-live@grml-wiki] +for details. + Bugs ----