projects
/
grml-live.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Added some patches against FAI for initial version of chroot update
[grml-live.git]
/
docs
/
grml-live.txt
diff --git
a/docs/grml-live.txt
b/docs/grml-live.txt
index
9c0d88a
..
d4c81ae
100644
(file)
--- a/
docs/grml-live.txt
+++ b/
docs/grml-live.txt
@@
-10,7
+10,8
@@
Linux Live system (CD/ISO)
Synopsis
--------
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
*******************************************************************************
Important! This document is growing as requested. If you have questions which
@@
-57,6
+58,24
@@
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).
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
-s **SUITE**::
Specify the Debian suite you want to use for your live-system. Defaults to
@@
-70,20
+89,18
@@
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).
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.
+ -v **VERSION_NUMBER**::
- -h::
+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.)
-Display short usage information and exit.
-
- -v::
+ -V::
Increase verbosity in the build process.
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:
To get a small, Debian-stable and grml-based Live-CD using /grml/grml-live
as build and output directory just run:
@@
-95,6
+112,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
# 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
[NOTE]
If you have about 700MB of free space inside /dev/shm (being a tmpfs, usually
@@
-255,7
+278,8
@@
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
* 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
-temporary files)
+temporary files), if you plan to use GRML_FULL you should have at least 4GB of
+total free disk space
* fast network access for retreiving the Debian packages used for creating the
chroot (check out "local mirror" and "NFSROOT" to workaround this problem as far
* fast network access for retreiving the Debian packages used for creating the
chroot (check out "local mirror" and "NFSROOT" to workaround this problem as far
@@
-379,10
+403,14
@@
a mail: <mika@grml.org>
Known TODOs
-----------
Known TODOs
-----------
-*
"fai dirinstall" does not seem to always exit according to what happend during
-the build; make sure to exit on any error
+*
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
+* provide hooks/options for updating an existing chroot/squashfs-file/ISO
+(work in progress, see patches directory inside source)
+
+* 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 a check to make sure $TARGET is mounted rw,suid,dev?
@@
-395,9
+423,6
@@
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 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,...)
* 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,...)
@@
-429,10
+454,9
@@
use of grml-live.
Download / install grml-live as a Debian package
------------------------------------------------
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 of the most current version on your own, just execute:
hg clone http://hg.grml.org/grml-live
cd grml-live
hg clone http://hg.grml.org/grml-live
cd grml-live