Drop .sp workaround, fix some typos in manpages and remove duplicated text

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

diff --git a/doc/grml-autoconfig.current.txt b/doc/grml-autoconfig.current.txt
index e519be1..b775a58 100644 (file)
--- a/doc/grml-autoconfig.current.txt
+++ b/doc/grml-autoconfig.current.txt
@@ -13,10 +13,12 @@ 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
-(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 automaitcally executed on
+automatically unpacked and DCSDIR/scripts/grml.sh is automatically executed on
 system startup. The 'noautoconfig' boot parameter disables this automatic
 behavior.
 
@@ -32,7 +34,14 @@ myconfig::
    device. Usage examples:
 
   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::
 
@@ -69,9 +78,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
-    $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::
@@ -86,10 +97,10 @@ 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. Usage examples:
 
   scripts               =>   run script DCSDIR/scripts/grml.sh
   scripts=foobar.sh     =>   run script foobar.sh in DCSDIR
@@ -125,8 +136,8 @@ debnet::
 noautoconfig::
 
     Deactivate automounting. By default the scripts try to mount a device with
-    label 'GRMLCFG'. If you specify the noautoconfig bootparam this automounting
-    will be deactivated.
+    label 'GRMLCFG'. If you specify the noautoconfig boot parameter this
+    automounting will be deactivated.
 
   noautoconfig            => disables auto mounting of label 'GRMLCFG'
 
@@ -137,7 +148,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
-/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).