Synopsis
--------
-grml-live [-c <classe[s]>] [-t <target_directory>] [-s <suite>] [-Fvh]
+grml-live [-c <classe[s]>] [-i <iso_name> ] [-r <release_name>]
+[-s <suite>] [-t <target_directory>] [-v <version_number>] [-Fvh]
*******************************************************************************
Important! This document is growing as requested. If you have questions which
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.
+
+ -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. (Notice: the output of the release name is limited
+to 30 characters.)
+
-s **SUITE**::
Specify the Debian suite you want to use for your live-system. Defaults to
ISO are located, including the compressed squashfs file), grml_chroot (the
chroot system) and grml_isos (where the resulting ISO is stored).
- -F::
-
-Force execution and do not prompt for acknowledgment of configuration.
-
- -h::
+ -v **VERSION_NUMBER**::
-Display short usage information and exit.
+Specify version number of the release. (Notice: the output of the version number
+is limited to 5 characters. So "1.0-1" is fine, but "1.0.0.1" will be stripped
+to "1.0.0" then.)
- -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:
# 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
Don't hesitate to ask on IRC (channel #grml on irc.freenode.org) or just drop me
a mail: <mika@grml.org>
-Known TODOs
------------
-
-* "fai dirinstall" does not seem to always exit according to what happend during
-the build; make sure to exit on any error (check logs for stuff like "dpkg:
-error processing" [software.log], "FAILED with exit code" [shell.log],...)
-
-* 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
-
-* 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)
-
-* support setting stuff like ISO name, version,... on-the-fly (especially for
-stuff inside boot/isolinux/*)
-
-* 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
-
-* support hooks to allow further customisation of the build process
-
-Long term goals
----------------
-
-* Provide all upcoming grml releases based on grml-live.
-
-* Provide a console interface (using dialog) for easy and common use of
-grml-live.
-
-* Provide a graphical interface (for example using pygtk) for easy and common
-use of grml-live.
-
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
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
----