Release new version 0.14.10
[grml2usb.git] / grml2usb.8.txt
index 933c84e..f40fcaa 100644 (file)
@@ -3,44 +3,41 @@ grml2usb(8)
 
 Name
 ----
-grml2usb - install grml ISO(s) on usb device for booting
+grml2usb - install Grml ISO(s) on usb device for booting
 
 Synopsis
 --------
 grml2usb [ options ] <ISO[s]> <device>
 
 *******************************************************************************
-Important! The grml team does not take responsibility for loss of any data!
+Important! The Grml team does not take responsibility for loss of any data!
 *******************************************************************************
 
 [[introduction]]
 Introduction
 ------------
 
-grml2usb installs grml on a given partition of your usb device and makes it
-bootable. It provides multi-iso support, meaning you can specify several grml
-ISOs on the command line at once and select the grml flavour you would like to
-boot on the bootprompt then. Note that the *first* ISO specified on the grml2usb
-command line will become the default one (that's the one that will boot when
-just pressing enter on the bootprompt or wait until the boot timeout matches).
+grml2usb installs Grml on a given partition of your usb device and makes
+it bootable. It provides multiboot ISO support, meaning you can specify
+several Grml ISOs on the command line at once and select the Grml
+flavour you would like to boot on the bootprompt then. Note that the
+*first* ISO specified on the grml2usb command line will become the
+default one (that's the one that will boot when just pressing enter on
+the bootprompt or wait until the boot timeout matches).
 
 [IMPORTANT]
 By default a compatible master boot record (MBR) is installed on the device
 (being for example /dev/sdX when executing 'grml2usb grml.iso /dev/sdX1') and
-grub 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.
+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.
 
 [[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).
+ISO[s] should be the path to one or multiple grml-ISOs and/or the path to
+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
@@ -51,7 +48,9 @@ The following options are supported:
 
   *\--bootoptions=...*::
 
-Use specified bootoptions as default.
+Use specified bootoptions as default. To use flavour name as a argument for a
+boot parameter use %flavour which will be expanded to the flavour name. To add
+multiple bootoptions you can specify the option multiple time.
 
   *\--bootloader-only*::
 
@@ -67,7 +66,7 @@ Copy files only but do *not* install a bootloader.
 
 Avoid executing commands, instead show what would be executed.
 Warning: please notice that the ISO has to be mounted anyway, otherwise
-identifying the grml flavour would not be possible.
+identifying the Grml flavour would not be possible.
 
   *\--fat16*::
 
@@ -78,6 +77,10 @@ Format specified partition with FAT16.
 
 Force any (possible dangerous) actions requiring manual interaction (like --fat16).
 
+  *\--grub*::
+
+Install grub bootloader instead of (default) syslinux.
+
   *\--grub-mbr*::
 
 Install grub into MBR (Master Boot Record) instead of PBR (Partition Boot
@@ -104,14 +107,6 @@ option *--initrd* as well. (Be aware when using multiboot setup.)
 [Notice: not implemented yet.]
 //////////////////////////////////////////////////////////////////////////
 
-  *\--lilo-binary=...*::
-
-Use specified lilo executable for installing master boot record (MBR) when using
-the '--syslinux-mbr' option. By default any system wide (from $PATH) lilo
-executable is taken.  If there can not be find any lilo executable the
-statically compiled version of the grml2usb Debian package (see
-/usr/share/grml2usb/lilo/lilo.static.[amd64|i386]) is taken.
-
   *\--mbr-menu*::
 
 Install master boot record (MBR) with integrated boot menu: interactively choose
@@ -133,8 +128,11 @@ 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-bootflag*::
+
+Do not check for presence of bootflag on target device.
 
   *\--skip-grub-config*::
 
@@ -165,8 +163,7 @@ Install syslinux' master boot record (MBR, which is booting from the partition
 with the "active" flag set) instead of the default one.  If you encounter any
 problems with the default MBR you can try using the syslinux MBR instead. If
 that works for you please <<author,let us know>> so we can adjust our default
-MBR accordingly. Note: When using the '--syslinux-mbr' option lilo is executed
-before the MBR is installed so the according partitions are set active.
+MBR accordingly.
 
 //////////////////////////////////////////////////////////////////////////
   *\--squashfs=*::
@@ -178,7 +175,7 @@ Install specified squashfs file instead of the default.
 //////////////////////////////////////////////////////////////////////////
   *\--uninstall*::
 
-Uninstall grml ISO files.
+Uninstall Grml ISO files.
 [Notice: not implemented yet.]
 //////////////////////////////////////////////////////////////////////////
 
@@ -235,7 +232,7 @@ Directory layout on usb device
 
   grml/
     |-- grml2usb.txt         [not yet implemented]
-    |-- grml-cheatcodes.txt  [list of bootoptions for grml]
+    |-- grml-cheatcodes.txt  [list of bootoptions for Grml]
     |-- grml-version.txt     [file containing information about grml-version]
     |-- LICENSE.txt          [license information]
     |-- md5sums              [md5sums of original ISO]
@@ -288,14 +285,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
@@ -381,34 +378,18 @@ 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?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Well, you can. :) Starting with grml 2009.10 the ISOs are dd-able straight out-of-the-box.
+Well, you can. :) Starting with Grml 2009.10 the ISOs are dd-able straight out-of-the-box.
 
 [IMPORTANT]
 Note that ANY existing data on your USB device will be destroyed when
 using the dd approach.
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////
-Grab a recent grml ISO and use
+Grab a recent Grml ISO and use
 link:http://syslinux.zytor.com/wiki/index.php/Doc/isolinux#HYBRID_CD-ROM.2FHARD_DISK_MODE[isohybrid
 from the syslinux project]:
 
@@ -419,7 +400,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
@@ -442,23 +423,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/?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -568,6 +532,14 @@ use the bootloader grub instead using grml2usb's '--grub' option.
 [NOTE]
 FAT32 is supported since syslinux version 3.0.
 
+[[hdt-hangs]]
+Addons -> Hardware Detection Tool freezes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This usually means that the machine you ran grml2usb on had syslinux 3.x
+installed. The version of hdt (Hardware detection tool) shipping with Grml
+2010.12 and newer requires syslinux 4.x.
+
 [[cool-idea]]
 I think I've got a really cool idea!
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -594,61 +566,64 @@ 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 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 nomce from existing bootoptions.
+
+  # grml2usb --bootoptions="persistent-path=%flavour_name" grml64_2010.04.iso grml_2010.04.iso /dev/sdX1
 
-Install specified ISO on device /dev/sdX1 remove vga=791 and quiet from existing bootoptions.
+Install specified ISOs on device /dev/sdx and add parameter persistent-path
+to every menu entry. %flavour_name will be expanded to the flavour of the specific
+iso, e.g. grml64 and grml.
 
 [[ressources]]
 Online Ressources