Further adaptions regarding new /lib/live directory

[grml-autoconfig.git] / doc / grml-autoconfig.current.txt

diff --git a/doc/grml-autoconfig.current.txt b/doc/grml-autoconfig.current.txt
index 6806309..2e36d1f 100644 (file)
--- a/doc/grml-autoconfig.current.txt
+++ b/doc/grml-autoconfig.current.txt
@@ -13,7 +13,9 @@ The DCS directory defaults to the root directory of the GRML live image. If a
 file system labeled GRMLCFG is found, the DCS directory is the root directory of
 that file system. Alternatively, the myconfig boot parameter can be used to
 directly specify a device which is then taken as DCS directory
 file system labeled GRMLCFG is found, the DCS directory is the root directory of
 that file system. Alternatively, the myconfig boot parameter can be used to
 directly specify a device which is then taken as DCS directory

-(myconfig=/dev/sda1, for example).
+(myconfig=/dev/sda1, for example). If your device is labeled different to
+GRMLCFG the proper label can be set via the autoconfig boot parameter
+(autoconfig=SOMELABEL, for example).

 
 Without any additional boot parameters, the GCA at DCSDIR/config.tbz is
 automatically unpacked and DCSDIR/scrips/grml.sh is automatically executed on
 
 Without any additional boot parameters, the GCA at DCSDIR/config.tbz is
 automatically unpacked and DCSDIR/scrips/grml.sh is automatically executed on


@@ -34,6 +36,14 @@ myconfig::
   myconfig=/dev/sda1                        => read DCS from usb-device
   myconfig=/dev/fd0                         => read DCS from floppy-disk
 
   myconfig=/dev/sda1                        => read DCS from usb-device
   myconfig=/dev/fd0                         => read DCS from floppy-disk
 

+autoconfig::
+
+   This parameter specifies the label used to determine the DCS device.
+   If undefined the label GRMLCFG is used to find the DCS device.
+
+  autoconfig=SOMELABEL      => search for device labeled SOMELABEL to use as
+                               DCS device.
+

 home::
 
     This parameter is for setting a specific partition as home directory.  Usage
 home::
 
     This parameter is for setting a specific partition as home directory.  Usage


@@ -69,9 +79,11 @@ netscript::
     Use this parameter to download and run a script from specified destination:
     You can also add variables to change the file name depending on the host
     configuration. Predefined and useful variables are $ARCH, $HOSTNAME and
     Use this parameter to download and run a script from specified destination:
     You can also add variables to change the file name depending on the host
     configuration. Predefined and useful variables are $ARCH, $HOSTNAME and

-    $KERNEL. Usage example:
+    $KERNEL. The environment variable NETSCRIPT is set to the specified URI.
+    This can be used to detect if the script is executed via the netscript bootoption.
+    Usage example:

 
 

-  netcript=server.tld/path/to/script       =>   download and run script/executable from server
+  netscript=server.tld/path/to/script      =>   download and run script/executable from server

   netscript=server.tld/script-$HOSTNAME    =>   download and run script/executable for specific host
 
 extract::
   netscript=server.tld/script-$HOSTNAME    =>   download and run script/executable for specific host
 
 extract::


@@ -89,9 +101,7 @@ scripts::
     relative to DCSDIR. If the path points to a file, this single file is
     executed. If no path is given, it defaults to scripts/grml.sh.
     If the given name points to a directory, all scripts inside it are
     relative to DCSDIR. If the path points to a file, this single file is
     executed. If no path is given, it defaults to scripts/grml.sh.
     If the given name points to a directory, all scripts inside it are

-    executed, but the run-parts name restrictions apply: script names must
-    consist entirely of upper and lower case letters, digits, underscores,
-    and hyphens. Usage examples:
+    executed. Usage examples:

 
   scripts               =>   run script DCSDIR/scripts/grml.sh
   scripts=foobar.sh     =>   run script foobar.sh in DCSDIR
 
   scripts               =>   run script DCSDIR/scripts/grml.sh
   scripts=foobar.sh     =>   run script foobar.sh in DCSDIR


@@ -139,7 +149,7 @@ Permanently adjust boot parameters
 As you probably know you can adjust boot parameters on the bootprompt.  You want
 to set some boot parameters permanently? That's possible via adding a directory
 named 'bootparams' to the Grml ISO which has to be located at the root-directory
 As you probably know you can adjust boot parameters on the bootprompt.  You want
 to set some boot parameters permanently? That's possible via adding a directory
 named 'bootparams' to the Grml ISO which has to be located at the root-directory

-/bootparams/ (note: the directory is known as /live/image/bootparams/ on a
+/bootparams/ (note: the directory is known as /lib/live/mount/medium/bootparams/ on a

 _running_ Grml system then). Place a textfile inside the directory containing
 the boot parameters which should be appended to default ones (this corresponds
 to booting without any special parameters).
 _running_ Grml system then). Place a textfile inside the directory containing
 the boot parameters which should be appended to default ones (this corresponds
 to booting without any special parameters).