X-Git-Url: https://git.grml.org/?p=grml-autoconfig.git;a=blobdiff_plain;f=doc%2Fgrml-autoconfig.current.txt;h=350ccc742ed3f5f6c6c17d402a525c26f1a4c0ef;hp=e519be1b465d5cf9a896d7eabd9bca342721ab1e;hb=1de4d8f15c3c889d5005b47b6a5bfddd910a480a;hpb=563484dc05d042cf88b0fbfeb0e0073f90609af5 diff --git a/doc/grml-autoconfig.current.txt b/doc/grml-autoconfig.current.txt index e519be1..350ccc7 100644 --- 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/scrips/grml.sh is automatically executed on system startup. The 'noautoconfig' boot parameter disables this automatic behavior. @@ -34,6 +36,14 @@ myconfig:: 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 @@ -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 - $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 +98,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