Update doc/pycallgraph.png
[grml2usb.git] / grml2usb.8.txt
index d790eb4..4c8942e 100644 (file)
@@ -77,17 +77,21 @@ Force any (possible dangerous) actions requiring manual interaction (like --fat1
 
 Display usage information and exit.
 
+//////////////////////////////////////////////////////////////////////////
   *--initrd=...*::
 
 Install specified initrd instead of the default. You might want to specify
 option *--kernel* as well. (Be aware when using multiboot setup.)
 [Notice: not implemented yet.]
+//////////////////////////////////////////////////////////////////////////
 
+//////////////////////////////////////////////////////////////////////////
   *--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=...*::
 
@@ -123,23 +127,25 @@ Install syslinux bootloader instead of the default (being grub).
   *--syslinux-mbr*::
 
 Install syslinux master boot record (MBR) instead of the default one.  By
-default a very compatible MBR is installed, if you can encounter any problems
+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.
 
-[NOTE]
-When using the --syslinux-mbr option also lilo is executed so the according
-partitions are set active.
-
+//////////////////////////////////////////////////////////////////////////
   *--squashfs=*::
 
 Install specified squashfs file instead of the default.
 [Notice: not implemented yet.]
+//////////////////////////////////////////////////////////////////////////
 
+//////////////////////////////////////////////////////////////////////////
   *--uninstall*::
 
 Uninstall grml ISO files.
 [Notice: not implemented yet.]
+//////////////////////////////////////////////////////////////////////////
 
   *-v*, *--version*::
 
@@ -218,18 +224,16 @@ Directory layout on usb device
             `-- logo.png
 
   live/
-    |-- filesystem.module      [file specifying which squashfs should be used by default]
-    |-- grml.squashfs          [squashfs file]
-    |-- grml-medium.module     [module specifying which squashfs should be used for grml-medium]
-    |-- grml-medium.squashfs   [squashfs file for grml-medium]
-    |-- grml-small.module      [...]
-    |-- grml-small.squashfs
-    |-- grml64.module
-    |-- grml64.squashfs
-    |-- grml64-medium.module
-    |-- grml64-medium.squashfs
-    |-- grml64-small.module
-    `-- grml64-small.squashfs
+    |-- grml/
+    |   |-- filesystem.module    [module specifying which squashfs should be used for grml]
+    |   `-- grml.squashfs        [squashfs file for grml]
+    |-- grml-medium/
+    |   |-- filesystem.module    [module specifying which squashfs should be used for grml-medium]
+    |   `-- grml-medium.squashfs [squashfs file for grml-medium]
+    |-- grml-small/
+    |   |-- filesystem.module    [module specifying which squashfs should be used for grml-medium]
+    |   `-- grml-small.squashfs  [squashfs file for grml-small]
+    `-- ...
 
 Grabbing the source
 ~~~~~~~~~~~~~~~~~~~
@@ -333,6 +337,13 @@ Providing both files allows grml2usb to install grub on the target device
 no matter which grub version is available on the host where grml2usb is
 executed on.
 
+grub-install fails with 'The file ../boot/grub/stage1 not read correctly"?!
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Check whether the partition has the right partition type. For example do NOT use
+FAT16 (partition type 6) when using a ext3 filesystem on the partition but
+instead use the correct partition type ('83' - Linux) then.
+
 Why do I have to use a FAT16 filesystem?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -344,7 +355,10 @@ but use the default bootloader (grub) instead.
 I think I've got a really cool idea!
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Please <<X7,report it to the author>>. Or even better: send us a patch. :)
+Great! Please check out
+link:http://git.grml.org/?p=grml2usb.git;a=blob;f=TODO;hb=HEAD[the TODO file].
+Feel free to <<X7,report your wishes to the author>>. Patches highly
+appreciated.
 
 I've problems with booting from USB.
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -382,6 +396,7 @@ FAT16 filesystem.
 Install specified ISO on device /dev/sdb1 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/sdb1
 
@@ -390,6 +405,7 @@ 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/sdb1
+/////////////////////////////////////////////////////////////////
 
 Install specified ISO on device /dev/sdb1 but use given squashfs
 file instead of the one provided by the ISO.