Release new version 0.19.4
[grml-autoconfig.git] / doc / grml-autoconfig.1.txt
index 75f087b..ab79e3d 100644 (file)
@@ -38,55 +38,15 @@ starting from the root-directory '/' so it is easy to handle. You can generate
 configuration archives manually as well. save-config is just a frontend which
 should make it easier to use.
 
-The grml-autoconfig code has been re-worked in August 2009. This document
-handles both the behavior of Grml releases up to 2009.05  (see
-<<up-to-200905,section 'Behavior up to grml 2009.05'>>) and the current behavior
-(see <<current-versions,section 'Behavior in current Grml versions'>>). Great
-care has been taken to provide maximum backwards compatibility during the
-rewrite.
-
 [IMPORTANT]
-Starting with grml release 2009.05 its possible to use root persistency on grml.
+Starting with Grml release 2009.05 its possible to use root persistency on grml.
 This means you can store your settings and reuse them on reboot, without having
 to deal with this config framework. Visit
-link:http://wiki.grml.org/doku.php?id=persistency for further information.
+link:http://wiki.grml.org/doku.php?id=persistency[] for further information.
 
 [[current-versions]]
 include::grml-autoconfig.current.txt[]
 
-[[up-to-200905]]
-include::grml-autoconfig.200905.txt[]
-
-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).
-
-  mkdir bootparams
-  echo lang=de > bootparams/my_bootparams
-
-Then burn a multisession CD where directory bootparams is located in the root
-directory of the CD.
-
-[NOTE]
-Not all boot parameters can be used via /bootparams/. This is a limitation of
-the way the kernel and userspace retrieve boot parameters. Boot parameter
-regarding the kernel definitely do *NOT* work. Boot parameter related to
-grml-autoconfig (the main part of the boot process in Grml running in userspace,
-being all the stuff after startup of udev) are expected to work. Boot parameter
-related to initrd/initramfs (the part between 'Searching for GRML file' and
-startup of udev) are *NOT* covered by /bootparams/ as well yet.
-
-TIP: the application k3b (not available on the live-CD but available through the
-Debian repositories) provides an easy to use interface for doing the
-multisession task.
-
 [[X7]]
 Usage scenarios
 ---------------
@@ -96,7 +56,7 @@ Personal configuration files
 
 You are a fan of the editor vim? Great. You probably have your own ~/.vimrc and
 want to use it on the Grml system. You also don't like the default zsh
-configuration and want to use your own ~/.zshrc?  How to procede? Copy your
+configuration and want to use your own ~/.zshrc?  How to proceed? Copy your
 .vimrc and .zshrc to $HOME of user 'grml'.  Place additional files in
 $HOME/config. Now create a configuration for your files running:
 
@@ -108,12 +68,8 @@ reboot using the following commandline on bootprompt:
 
   grml netconfig=server.tld/path/to/config.tbz
 
-You don't have network access but own a floppy drive? Copy the file to a floppy
-disk and boot with:
-
-  grml myconfig=/dev/fd0
-
-Floppy is to small or to slow? Ok, let's use a usb device:
+You don't have network access but own a USB device? Copy the file to a USB
+device and boot with something like:
 
   grml myconfig=/dev/sda1
 
@@ -127,17 +83,13 @@ the following command as user root:
   save-config -etc
 
 Now you should have a file named config.tbz containing your configuration files.
-If you want to use it with a floppy disk copy the file to a floppy and boot via
-using the following command on bootprompt:
-
-  grml myconfig=/dev/fd0
-
-Floppy is to small or to slow? Ok, let's use a usb device:
+If you want to use it with a USB device copy the file to it and boot via
+using the following command on boot prompt:
 
   grml myconfig=/dev/sda1
 
 You do have an existing harddisk installation and want to use its configuration?
-Let's say the debian system is located in /dev/sda2. You want to use the
+Let's say the Debian system is located in /dev/sda2. You want to use the
 directory /etc/network. This directory is activated by default in
 /etc/grml/partconf so we don't have to do any further work.  We just need to
 activate it via using the following commandline on bootprompt:
@@ -160,7 +112,7 @@ Now create a directory named debs and place foobar.deb in it:
 
   mkdir debs/ && cp foobar.deb debs/
 
-Notice: This directory will be located in /live/image after burning the second
+Notice: This directory will be located in /run/live/medium after burning the second
 session.
 
 Now create the second session containing this directory:
@@ -182,31 +134,32 @@ Now boot from your new personalized Grml CD using the debs parameter:
 Run your own commands on startup
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-You know that booting with 'grml service=foobar' executes /etc/init.d/foobar
-when booting Grml. But you want to setup a more complex network configuration,
-adjust some other stuff and so on on your own? Just write a script named grml.sh
-which does the job and use own of the mentioned bootparams. Let's say you have
-placed grml.sh on your usb device (usb stick) then use the following commandline
-on bootprompt:
+You know that booting with 'grml services=foobar' executes
+/etc/init.d/foobar when booting Grml. But you want to setup a more
+complex network configuration, adjust some other stuff and so on, on
+your own? Just write a script named grml.sh which does the job and use
+one of the mentioned boot parameters. Let's say you have placed grml.sh
+on your usb device (usb stick) then use the following commandline on
+bootprompt:
 
   grml myconfig=/dev/sda1
 
-Or even better: create a floppy disk with label GRMLCFG running:
+Or even better: create a device with label GRMLCFG running (adjust /dev/sdX1
+according to your needs):
 
-  fdformat /dev/fd0   # format the floppy disk if not done already
-  mkfs.ext2 -L GRMLCFG /dev/fd0   # now create ext2 filesystem with label GRMLCFG on it:
+  mkfs.ext3 -L GRMLCFG /dev/sdX1  # warning: this destroys all data on /dev/sdX1
 
 TIP: several filesystems provide the possibility to provide a label.  For
 example FAT provides this through: 'mkfs.vfat -n GRMLCFG /dev/sda1' (attention:
 this will destroy data on /dev/sda1 of course!). Take a look at the
 documentation/manpage of the filesystem you want to use.
 
-Now place your configuration archive (see save-config and the other usage
-scenarios) and the script grml.sh on the floppy disk. Now you can boot your
-system without specifying any bootparameters on bootprompt because devices
-labeled with GRMLCFG are mounted readonly and used by default. If you did not
-label your device you can use the device anyway using 'grml myconfig=/dev/ice'
-on the bootprompt.
+Now place your configuration archive (see save-config and the other
+usage scenarios) and the script grml.sh on the device. Now you can boot
+your system without specifying any boot parameters on bootprompt because
+devices labeled with GRMLCFG are mounted readonly and used by default.
+If you did not label your device you can use the device anyway using
+'grml myconfig=/dev/sdX' (adjust /dev/sdX) on the bootprompt.
 
 Debug remote systems
 ~~~~~~~~~~~~~~~~~~~~
@@ -225,16 +178,16 @@ copies files defined in /etc/grml/partconf from /dev/sda2 to the Grml system. As
 /dev/sda2 will be taken.
 
 Or you use a standard Grml medium and have grml read IP address, netmask and
-default gateway from another medium like a floppy or an USB stick. Take a look
-at the script saveconfig and the boot parameter myconfig.
+default gateway from another medium like a USB stick. Take a look at the script
+saveconfig and the boot parameter myconfig.
 
 Or you put a grml.iso file on your hard disk (maybe in /boot/grml) or on an USB
 stick, use grub to boot from there and place debs, configuration scripts or Grml
-configuraton archives alongside the .iso.
+configuration archives alongside the .iso.
 
 Bugs
 ----
-If you find a bug please report it. See link:http://grml.org/bugs/ for details
+If you find a bug please report it. See link:http://grml.org/bugs/[] for details
 about how to report bugs.
 
 See also