Don't suggest /dev/shm as a build location

[grml-live.git] / docs / grml-live.txt

diff --git a/docs/grml-live.txt b/docs/grml-live.txt
index 380ca9e..8d421e5 100644 (file)
--- a/docs/grml-live.txt
+++ b/docs/grml-live.txt
@@ -10,9 +10,10 @@ Linux Live system (CD/ISO)
 Synopsis
 --------
 
-grml-live [-a <architecture>] [-c <classe[s]>] [-C <configfile>] [-g
-<grml_name>] [-i <iso_name> ] [-o <output_directory>] [-r <release_name>] [-s
-<suite>] [-t <template_directory>] [-v <version_number>] [-U <username>] [
+grml-live [-a <architecture>] [-c <classe[s]>] [-C <configfile>] [
+-e <extract_iso_name>] [-g <grml_name>] [-i <iso_name>] [
+-o <output_directory>] [-r <release_name>] [-s <suite>] [
+-t <template_directory>] [-v <version_number>] [-U <username>] [
 -AbBFnNqQuVz]
 
 Description
@@ -53,8 +54,8 @@ Options
 
   -A::
 
-Clean up output directories before attempting the build. Packs the chroot
-into a tar archive, and removes chroot and ISO build directories before exiting.
+Clean up all output directories before running the build process. After finishing,
+clean up the Chroot target and Build target directories.
 
   -a **ARCHITECTURE**::
 
@@ -132,6 +133,11 @@ grml-live this option provides you the option to use your own configuration
 directory. This directory is what's being referred to as ${GRML_FAI_CONFIG}
 throughout this documentation.
 
+  -e **EXTRACT_ISO_NAME**::
+
+The squashfs inside the specified ISO will be extracted and used as the chroot.
+This option is useful for remastering, in combination with -A and -b or -u.
+
   -F::
 
 Force execution and do not prompt for acknowledgment of configuration.
@@ -208,11 +214,6 @@ debootstrap.
 Specify place of the templates used for building the ISO. By default
 (and if not manually specified) this is /usr/share/grml-live/templates/.
 
-  -T **CHROOT_ARCHIVE**::
-
-Unpack chroot tar archive before starting. Most useful in combination with
--A and -b or -u.
-
   -u::
 
 Update existing chroot instead of rebuilding it from scratch. This option is
@@ -251,12 +252,10 @@ system:
 
 [NOTE]
 
-If you have enough 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 use another directory for $CHROOT_OUTPUT,
-$BUILD_OUTPUT and $ISO_OUTPUT if you plan to create more persistent output. :)
+If you have enough RAM, just run "mount -t tmpfs none /mnt/ramdisk" to get a
+tmpfs ("RAMDISK"), and use /mnt/ramdisk as build and output directory - this
+results in a very fast build process. Note that these files will be gone when
+rebooting.
 
 [[main-features]]
 Main features of grml-live