add an FAQ regarding to HDT hangs [Closes: issue976]
[grml2usb.git] / grml2usb.8.txt
index 8f3d776..0d2bebb 100644 (file)
@@ -27,9 +27,9 @@ 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.
+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
@@ -51,7 +51,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*::
 
@@ -78,12 +80,15 @@ 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
-Record).  This option sadly had to be introduced because grub2 can not be
-installed to partitions (PBR) instead of MBR anymore. Check out <<mbr-vs-pbr,the
-'mbr-vs-pbr' section in the FAQ of this document>> for further details.
+Record). Check out <<mbr-vs-pbr,the 'mbr-vs-pbr' section in the FAQ of this
+document>> for further details.
 
   *\--help*::
 
@@ -323,6 +328,19 @@ kernel loads but you very soon get the error message.
 *Reason*:: the partition layout is not ok. Very probably there's no primary
   partition (/dev/sdX{1..4}) or none has the flag 'bootable' set.
 
+*Error message*:: Boot error.
+
+*Reason*:: Some BIOSses offer different modes for USB booting. The proper mode
+to boot a USB stick is USB-HDD. If that doesn’t work or is not supported by your
+system, you need to format your USB-Stick as USB-ZIP.  To do this, syslinux
+contains an utility called mkdiskimage, which you can use to re-format your USB
+stick in USB-ZIP format running 'mkdiskimage -4 /dev/sdX 1 64 32'. Please be
+aware that this procedure will erase all data on your stick.  After executing
+mkdiskimage just continue installing as usual (grml2usb ...  /dev/sdX4). Note
+that this is not going to work for any device larger than 8 GB, since
+mkdiskimage only supports 1024c 256h 63s. For a more detailed explanation, refer
+to /usr/share/doc/syslinux-common/usbkey.txt.
+
 *Error message*:: No operating system found.
 
 *Reason*:: you forgot to set the boot-flag on the partition. Or there really isn't
@@ -525,19 +543,14 @@ The following message:
   grub-setup: warn: Embedding is not possible.  GRUB can only be installed in this setup by using blocklists.  However, blocklists are UNRELIABLE and its use is discouraged.
   grub-setup: error: Cannot read `/grub/core.img' correctly
 
-appears because recent grub2 versions sadly introduced a regression which avoids
-that grub is being installed into a partition (PBR, Partition Boot Record)
-instead of MBR (Master Boot Record).
-
-To work around this issue you can install grub into the MBR (Master Boot Record)
-using the '--grub-mbr' option of grml2usb or switch to syslinux as bootmanager
-(just drop the '--grub'  option).
+appears when using grub2 versions older than 1.98 as those version introduced a
+regression which avoids that grub is being installed into a partition (PBR,
+Partition Boot Record) instead of MBR (Master Boot Record).
 
-To fix this issue manually you can also execute (adjust '/dev/sdX' to your
-device of course):
-
-  mount /dev/sdX1 /mnt/test
-  grub-install --force --recheck --no-floppy --root-directory=/mnt/test /dev/sdX
+To work around this issue you can either 1) upgrade to grub versions >=1.98, 2)
+install grub into the MBR (Master Boot Record) using the '--grub-mbr' option of
+grml2usb or 3) switch to syslinux as bootmanager (just drop the '--grub'
+option).
 
 [[splash-xpm]]
 I'm getting something like "Error: /usr/share/grml2usb/grub/splash.xpm.gz can not be read"!?
@@ -561,6 +574,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!
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -634,6 +655,7 @@ 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
 
 Install specified ISO on device /dev/sdX1 and use "lang=de ssh=mysecret" as
 default bootoptions.
@@ -643,6 +665,12 @@ default bootoptions.
 
 Install specified ISO on device /dev/sdX1 remove vga=791 and quiet from existing bootoptions.
 
+  # grml2usb --bootoptions="persistent-path=%flavour_name" grml64_2010.04.iso grml_2010.04.iso /dev/sdX1
+
+Install specified Isos on device /dev/sdx and add parameter persisten-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
 -----------------