Mention the grml2usb.tgz in the docs, enable TOC
[grml2usb.git] / grml2usb.8.txt
index 8e8cce1..75d3662 100644 (file)
@@ -47,41 +47,41 @@ don't need one) and a bootloader won't be installed automatically.
 
 The following options are supported:
 
-  *--bootoptions=...*::
+  *\--bootoptions=...*::
 
 Use specified bootoptions as default.
 
-  *--bootloader-only*::
+  *\--bootloader-only*::
 
 Do *not* copy files but instead just install a bootloader.  Note that the boot
 addons are copied to /boot/addons at this stage as well.  If you want to skip
 copying the boot addons consider using the --skip-addons option.
 
-  *--copy-only*::
+  *\--copy-only*::
 
 Copy files only but do *not* install a bootloader.
 
-  *--dry-run*::
+  *\--dry-run*::
 
 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.
 
-  *--fat16*::
+  *\--fat16*::
 
 Format specified partition with FAT16.
 **Important:** this will destroy any existing data on the specified partition!
 
-  *--force*::
+  *\--force*::
 
 Force any (possible dangerous) actions requiring manual interaction (like --fat16).
 
-  *--help*::
+  *\--help*::
 
 Display usage information and exit.
 
 //////////////////////////////////////////////////////////////////////////
-  *--initrd=...*::
+  *\--initrd=...*::
 
 Install specified initrd instead of the default. You might want to specify
 option *--kernel* as well. (Be aware when using multiboot setup.)
@@ -89,14 +89,14 @@ option *--kernel* as well. (Be aware when using multiboot setup.)
 //////////////////////////////////////////////////////////////////////////
 
 //////////////////////////////////////////////////////////////////////////
-  *--kernel=...*::
+  *\--kernel=...*::
 
 Install specified kernel instead of the default. You might want to specify
 option *--initrd* as well. (Be aware when using multiboot setup.)
 [Notice: not implemented yet.]
 //////////////////////////////////////////////////////////////////////////
 
-  *--lilo-binary=...*::
+  *\--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
@@ -104,57 +104,60 @@ 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-manager=...*::
+  *\--mbr-menu*::
 
-Install master boot record (MBR) with integrated boot manager, providing a
-simple selection for specifying the device for booting from. This options is
-available only when using the default MBR and won't work if using the
---syslinux-mbr option.
+Install master boot record (MBR) with integrated boot menu: interactively choose
+the partition to boot from, with a timeout to load the default partition, or
+boot from floppy. When NOT using the --mbr-menu option a MBR with LBA and large
+disc support but without an integrated boot menu is installed (so it's not
+visible at all but instead directly jumps to the bootloader - being grub or
+syslinux). Note: This options is available only when using the default MBR and
+won't have any effect if you're using the --syslinux-mbr option.
 
-  *--quiet*::
+  *\--quiet*::
 
 Do not output anything but just errors on console.
 
-  *--skip-addons*::
+  *\--skip-addons*::
 
 Do not install /boot/addons/ files (like dos, grub, memdisk,...).
 
-  *--skip-mbr*::
+  *\--skip-mbr*::
 
 Do not touch/install the master boot record (MBR).
 
-  *--syslinux*::
+  *\--syslinux*::
 
 Install syslinux bootloader instead of the default (being grub).
 
-  *--syslinux-mbr*::
+  *\--syslinux-mbr*::
 
-Install syslinux master boot record (MBR) instead of the default one.  By
-default a very compatible MBR is installed, if you encounter any problems
-with it you can try using the syslinux MBR instead. If that works for you please
-<<X7,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.
+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 <<X7,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.
 
 //////////////////////////////////////////////////////////////////////////
-  *--squashfs=*::
+  *\--squashfs=*::
 
 Install specified squashfs file instead of the default.
 [Notice: not implemented yet.]
 //////////////////////////////////////////////////////////////////////////
 
 //////////////////////////////////////////////////////////////////////////
-  *--uninstall*::
+  *\--uninstall*::
 
 Uninstall grml ISO files.
 [Notice: not implemented yet.]
 //////////////////////////////////////////////////////////////////////////
 
-  *-v*, *--version*::
+  *-v*, *\--version*::
 
 Return version and exit.
 
-  *--verbose*::
+  *\--verbose*::
 
 Enable verbose mode.
 
@@ -316,6 +319,20 @@ isolinux/syslinux fixes the problem.
 Frequently Asked Questions (FAQ)
 --------------------------------
 
+Where can I get grml2usb?
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+grml2usb is available as Debian package via link:http://deb.grml.org/[the
+grml-testing Debian repository]. Please make sure you really have the Debian
+package installed as having just the grml2usb script available is definitely
+*NOT* enough!
+
+If you do NOT have a Debian based system but still want to be able to use
+grml2usb you can use the provided
+link:http://grml.org/grml2usb/grml2usb.tgz[http://grml.org/grml2usb/grml2usb.tgz]
+(link:http://grml.org/grml2usb/grml2usb.tgz.md5.asc[gpg signed md5 hash]).
+Download and extract the tarball and execute the provided script 'install.sh'.
+
 What's the difference between grml2hd and grml2usb?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -358,12 +375,19 @@ The following message:
 ... is "normal". grub-install sends those messages to stderr. To avoid hiding any
 possible real error messages grml2usb doesn't ignore those messages.
 
+I'm getting something like "Error: /usr/share/grml2usb/grub/splash.xpm.gz can not be read"!?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Looks like you've just the grml2usb script available. Please make sure you've
+the grml2usb Debian package installed. It's available via
+link:http://deb.grml.org/[the grml-testing Debian repository].
+
 Why do I have to use a FAT16 filesystem?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-You have to use a FAT16 filesystem only if you consider using syslinux, Syslinux
+You have to use a FAT16 filesystem only if you consider using syslinux. Syslinux
 (currently) does not support any other filesystems. If you want to use another
-filesystem (like ext2/3) just don't use syslinux (drop the --syslinux option)
+filesystem (like ext2/3) just don't use syslinux (drop the \--syslinux option)
 but use the default bootloader (grub) instead.
 
 I think I've got a really cool idea!
@@ -383,7 +407,7 @@ I've found a bug!
 ~~~~~~~~~~~~~~~~~
 
 Please <<X7,report it to the author>>. Please provide usage examples and output
-of your grml2usb commandline (consider using the "--verbose" option).
+of your grml2usb commandline (consider using the "\--verbose" option).
 
 Usage examples
 --------------
@@ -410,7 +434,7 @@ FAT16 filesystem.
 Install specified ISO on device /dev/sdx1 and use syslinux as bootloader
 (instead of grub being the default).
 
-/////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////////////////////////////////////////////
   # grml2usb --kernel=/boot/vmlinuz-2.6.28-grml --initrd=/boot/initrd.img-2.6.28-grml \
              /home/grml/grml_2008.11.iso /dev/sdx1
 
@@ -419,10 +443,10 @@ instead of the ones provided by the ISO.
 
   # grml2usb --squashfs=/grml/grml-live/grml_cd/live/grml.squashfs \
              /home/grml/grml_2008.11.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_2008.11.iso /dev/sdx1