pep8 cleanups
[grml2usb.git] / grml2usb.8.txt
index e246c7c..769f42e 100644 (file)
@@ -31,16 +31,12 @@ syslinux is being used as default bootloader. Avoid installation of the default
 MBR using the '--skip-mbr' option or if you encounter any problems with the
 default MBR consider using '--syslinux-mbr' instead.
 
-[NOTE]
-Whereas grml2usb is the script to install recent grml ISOs (>=2009.10) the
-script grml2usb-compat supports older grml releases (<2009.10) as well.
-
 [[options]]
 Options
 -------
 
 The ISO[s] should be the path to one or multiple grml-ISOs and/or the path to
-the currently running live-system (being /live/image).
+the currently running live-system (being /lib/live/mount/medium).
 
 The device either might be a device name like /dev/sdX1 or a directory. When
 specifying a device name the device is mounted automatically. When specifying a
@@ -131,8 +127,7 @@ Do not install /boot/addons/ files (like dos, grub, memdisk,...).
   *\--remove-bootoption=...*::
 
 Remove specified bootoption (could be a regex) from existing boot options. Use
-multiple entries for removing different bootoptions at once. (Note: this option
-is not support in grml2usb-compat.)
+multiple entries for removing different bootoptions at once.
 
   *\--skip-grub-config*::
 
@@ -285,14 +280,14 @@ or:
 Finally create a filesystem and execute grml2usb as needed:
 
   # mkfs.vfat /dev/loop1
-  # grml2usb --bootloader-only /grml/isos/grml-small_2009.10.iso /dev/loop1
+  # grml2usb --bootloader-only /grml/isos/grml-small_2013.01.iso /dev/loop1
 
 [[performance-tracing]]
 Performance tracing
 ~~~~~~~~~~~~~~~~~~~
 
   # blktrace -d /dev/sdX -o - | blkparse -i -
-  # grml2usb grml_2009.10.iso /dev/sdX1
+  # grml2usb grml_2013.01.iso /dev/sdX1
 
 [[troubleshooting]]
 Troubleshooting and Pitfalls when booting
@@ -378,22 +373,6 @@ It is *NOT* enough to have just the grml2usb script itself without the according
 files provided either via the Debian package, the git tree or the file
 grml2usb.tgz.
 
-[[grml2hd-vs-grml2usb]]
-What's the difference between grml2hd and grml2usb?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-grml2hd installs a running grml system to a harddisk. When rebooting the
-harddisk installation can be modified and changes will find their way to the
-harddisk immediately.  grml2usb copies just the compressed chroot filesystem
-(being the squashfs file), some further informational files and a bootloader to
-your device. This way you don't need as much space as with a harddisk
-installation (just a USB device with >=ISO size) and when rebooting the system
-your changes will be lost (unless you are using the persistency feature, see
-link:http://wiki.grml.org/doku.php?id=persistency[http://wiki.grml.org/doku.php?id=persistency]).
-Think of using a better CD version: booting is (usually) faster, you don't need
-to burn a new CD when a new ISO version arrives (just install the new ISO using
-grml2usb) and you can carry additional files on a writable medium with yourself.
-
 [[dd]]
 Why can't I just dd the ISO to a USB device?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -416,7 +395,7 @@ This allows you to dd the Grml ISO to your USB device (use for example
 link:http://www.chrysocome.net/rawwrite[rawwrite] if you've just a Windows
 system available) running:
 
-  % dd if=grml_2009.10.iso of=/dev/sdX
+  % dd if=grml_2013.01.iso of=/dev/sdX
 
 where /dev/sdX is your USB device. Of course this doesn't provide such a
 flexible system like with grml2usb (no multi-ISO setup, no additional default
@@ -439,23 +418,6 @@ What's grml2iso?
 grml2iso is a script which uses grml2usb to generate a multiboot ISO out of
 several grml ISOs. See 'man grml2iso' for further details.
 
-[[grml2usb-compat]]
-grml2usb fails with "Fatal: file default.cfg could not be found."
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-If you are trying to install an older grml ISO (older than grml 2009.10) with a
-recent version of grml2usb then you might notice:
-
-  Fatal: file default.cfg could not be found.
-  Note:  this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...
-         ... either use grml releases >=2009.10 or switch to an older grml2usb version.
-         Please visit http://grml.org/grml2usb/#grml2usb-compat for further information
-  Fatal: a critical error happend during execution (not a grml ISO?), giving up
-
-Breaking the backward compatibility was necessary to avoid maintainability hell.
-If you want to install older grml ISOs please use the grml2usb-compat script
-which provides support for older releases.
-
 [[menu-lst]]
 Why is there a menu.lst and a grub.cfg inside /boot/grub/?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -599,62 +561,58 @@ of your grml2usb commandline (consider using the "\--verbose" option).
 Usage examples
 --------------
 
-  # grml2usb /home/grml/grml_2009.10.iso /dev/sdX1
+  # grml2usb /home/grml/grml_2013.01.iso /dev/sdX1
 
 Install specified ISO on device /dev/sdX1.
 
-  # grml2usb /home/grml/grml_2009.10.iso /home/grml/grml_small_2009.10.iso /dev/sdX1
+  # grml2usb /home/grml/grml_2013.01.iso /home/grml/grml_small_2013.01.iso /dev/sdX1
 
 Install specified ISOs on device /dev/sdX1 for multibooting ISOs.
 
-  # grml2usb /live/image /dev/sdX1
+  # grml2usb /lib/live/mount/medium /dev/sdX1
 
-Install currently running grml live system on device /dev/sdX1.
+Install currently running Grml live system on device /dev/sdX1.
 
-  # grml2usb /live/image /home/grml/grml_2009.10.iso /dev/sdX1
+  # grml2usb /lib/live/mount/medium /home/grml/grml_2013.01.iso /dev/sdX1
 
-Install currently running grml live system and the specified
+Install currently running Grml live system and the specified
 ISO on device /dev/sdX1 for multibooting.
 
-  # grml2usb --fat16 /home/grml/grml_2009.10.iso /dev/sdX1
+  # grml2usb --fat16 /home/grml/grml_2013.01.iso /dev/sdX1
 
 Install specified ISO on device /dev/sdX1 and format partition /dev/sdX1 with
 FAT16 filesystem.
 
-  # grml2usb --grub --grub-mbr /home/grml/grml_2009.10.iso /dev/sdX1
+  # grml2usb --grub --grub-mbr /home/grml/grml_2013.01.iso /dev/sdX1
 
 Install specified ISO on device /dev/sdX1 and use grub as bootloader (instead of
 syslinux being the default) and install a master boot record (MBR) to the MBR of
 /dev/sdX.
 
-  # grml2usb-compat /home/grml/grml_2009.05.iso /dev/sdX1
-
-Install older grml ISO on device /dev/sdX1.
-
 ///////////////////////////////////////////////////////////////////////////////////////
   # grml2usb --kernel=/boot/vmlinuz-2.6.28-grml --initrd=/boot/initrd.img-2.6.28-grml \
-             /home/grml/grml_2009.10.iso /dev/sdX1
+             /home/grml/grml_2013.01.iso /dev/sdX1
 
 Install specified ISO on device /dev/sdX1 but use given kernel and initrd
 instead of the ones provided by the ISO.
 
   # grml2usb --squashfs=/grml/grml-live/grml_cd/live/grml.squashfs \
-             /home/grml/grml_2009.10.iso /dev/sdX1
+             /home/grml/grml_2013.01.iso /dev/sdX1
 
 Install specified ISO on device /dev/sdX1 but use given squashfs
 file instead of the one provided by the ISO.
 ///////////////////////////////////////////////////////////////////////////////////////
 
-  # grml2usb --bootoptions="lang=de ssh=mysecret" grml_2009.10.iso /dev/sdX1
-  # grml2usb --bootoptions="lang=de" --bootoptions="ssh=mysecret" grml_2009.10.iso /dev/sdX1
+  # grml2usb --bootoptions="lang=de ssh=mysecret" grml_2013.01.iso /dev/sdX1
+  # grml2usb --bootoptions="lang=de" --bootoptions="ssh=mysecret" grml_2013.01.iso /dev/sdX1
 
 Install specified ISO on device /dev/sdX1 and use "lang=de ssh=mysecret" as
 default bootoptions.
 
 
-  # grml2usb --remove-bootoption="vga=791" --remove-bootoption="quiet" grml_2009.10.iso /dev/sdX1
+  # grml2usb --remove-bootoption="vga=791" --remove-bootoption="nomce" grml_2013.01.iso /dev/sdX1
 
-Install specified ISO on device /dev/sdX1 remove vga=791 and quiet from existing bootoptions.
+Install specified ISO on device /dev/sdX1 remove vga=791 and nomce from existing bootoptions.
 
   # grml2usb --bootoptions="persistent-path=%flavour_name" grml64_2010.04.iso grml_2010.04.iso /dev/sdX1