X-Git-Url: https://git.grml.org/?p=grml-autoconfig.git;a=blobdiff_plain;f=doc%2Fgrml-autoconfig.current.txt;h=71ac363f8adfef06f10f9a717df48d3e993f3f73;hp=80f4eaee1f7070d28501f6d591192c29dbc57d58;hb=79b3fa623f0f25e88a0bbdbea0bfa8de078f8f5d;hpb=9c5f2ccd4226bca0e1066a7fd14e34314b3d43c7 diff --git a/doc/grml-autoconfig.current.txt b/doc/grml-autoconfig.current.txt index 80f4eae..71ac363 100644 --- a/doc/grml-autoconfig.current.txt +++ b/doc/grml-autoconfig.current.txt @@ -1,7 +1,7 @@ Behavior in current Grml versions --------------------------------- -This section applies to all Grml versions newer than release 2009.05. +This section applies to all Grml versions newer than release 2013.02. The central concept of grml-autoconfig is the DCS directory which holds debs, configuration and scripts which are used during system startup. @@ -9,14 +9,17 @@ configuration and scripts which are used during system startup. Determination of DCS directory ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -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). +The DCS directory defaults to the root directory of the GRML live image +(Note: the directory is known as /lib/live/mount/medium/ on a _running_ +Grml system then!). 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). 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 +automatically unpacked and DCSDIR/scripts/grml.sh is automatically executed on system startup. The 'noautoconfig' boot parameter disables this automatic behavior. @@ -32,7 +35,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 +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,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 +137,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' @@ -134,13 +146,14 @@ noautoconfig:: 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 -_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). +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 /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). mkdir bootparams echo lang=de > bootparams/my_bootparams