Bump Standards-Version to 3.9.1.
[grml-autoconfig.git] / doc / grml-autoconfig.current.txt
index 3266839..9c7e8fe 100644 (file)
@@ -16,7 +16,7 @@ directly specify a device which is then taken as DCS directory
 (myconfig=/dev/sda1, for example).
 
 Without any additional boot parameters, the GCA at DCSDIR/config.tbz is
-automatically unpacked and DCSDIR/scrips/grml.sh is automaitcally executed on
+automatically unpacked and DCSDIR/scrips/grml.sh is automatically executed on
 system startup. The 'noautoconfig' boot parameter disables this automatic
 behavior.
 
@@ -69,7 +69,9 @@ 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
-    $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/script-$HOSTNAME    =>   download and run script/executable for specific host
@@ -86,10 +88,12 @@ extract::
 scripts::
 
     This parameter executes scripts. If an optional path is given, it is
-    relative to DCSDIR. If it points to a directory, all scripts inside this
-    directory are executed. If the path points to a file, this single file is
-    executed. If no path is given, it defaults to scripts/grml.sh. Usage
-    examples:
+    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:
 
   scripts               =>   run script DCSDIR/scripts/grml.sh
   scripts=foobar.sh     =>   run script foobar.sh in DCSDIR
@@ -117,6 +121,10 @@ debs::
   debs=*.deb        =>   install all debian packages (suffix .deb) from directory DCSDIR/debs/
   debs=foo/01*.deb  =>   install all debian packages (suffix .deb) starting with 01 in the filename from directory DCSDIR/foo
 
+debnet::
+
+    Search all local partitions and dm devices for file /etc/network/interfaces and
+    copy the directory /etc/network to the grml system and restart networking.
 
 noautoconfig::