Update redesign docs

diff --git a/Makefile b/Makefile
index d3db345..0d5b480 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -5,14 +5,12 @@ doc: doc_man doc_html
 doc_html: html-stamp
 
 html-stamp: grml2usb.8.txt
-       sed -i 's/^include::releasetable-man.txt\[\]/include::releasetable.txt\[\]/' grml2usb.8.txt
        asciidoc -b xhtml11 -a icons grml2usb.8.txt
        touch html-stamp
 
 doc_man: man-stamp
 
 man-stamp: grml2usb.8.txt
-       sed -i 's/^include::releasetable.txt\[\]/include::releasetable-man.txt\[\]/' grml2usb.8.txt
        asciidoc -d manpage -b docbook grml2usb.8.txt
        sed -i 's/<emphasis role="strong">/<emphasis role="bold">/' grml2usb.8.xml
        xsltproc /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl grml2usb.8.xml

diff --git a/grml2usb.8 b/grml2usb.8
deleted file mode 100644 (file)
index 8ab0863..0000000
--- a/grml2usb.8
+++ /dev/null
@@ -1,54 +0,0 @@
-.TH GRML2USB 8
-.SH NAME
-grml2usb \- install grml on external usb device
-.SH SYNOPSIS
-.B grml2usb
-.RI "<path-to-the-iso-file> <path-to-the-mountpoint>"
-.SH DESCRIPTION
-This manual page documents briefly the
-.B grml2usb
-command.
-.PP
-\fBgrml2usb\fP is a program that lets you boot grml from an external usb device
-(typically an usb pen) like from CD. Whereas grml2hd installs the main system to
-a given partition, grml2usb just copies the files from the grml-iso to the usb
-device. You do not need as much space as the grml2hd installation would take
-but just the size of the iso itself (about 700MB for grml, using a 1GB usb
-pen works fine therefore).
-.SH OPTIONS
-grml2usb requires and supports exactly two options:
-.TP
-.B <path-to-the-iso-file>
-The path where the iso you want to use for installation is available.
-That's something like for example /home/mika/grml_0.9.iso.
-The path could als be a block device or a plain directory (which contains all
-files of the iso).
-.TP
-.B <path-to-the-mountpoint>
-This option specifies the mountpoint for your usb device, using the setup in
-/etc/fstab. grml2usb copies the iso to this mountpoint and runs syslinux (the
-bootloader for the usb device so it can boot at all) on the device later on.
-.SH NOTES
-Booting via USB might be tricky as you have to take care of several pitfals.
-First of all make sure the BIOS of your system is capable of booting from USB
-devices at all. You need a primary partition on your usb device with the
-bootflag enabled (see 'cfdisk /dev/ice') and with filesystem type vfat
-(run 'mkfs.vfat -F 16 -v /dev/ice1' to create it).
-.SH USAGE EXAMPLES
-.TP
-.B grml2usb /home/mika/grml_0.9.iso /mnt/usb-sda1
-This will install the iso grml_0.9.iso to the device behind mountpoint
-/mnt/usb-sda1 set up via  /etc/fstab.
-.TP
-.B grml2usb /cdrom /mnt/external1
-Install currently running grml to usb-device on /mnt/external1.
-.SH SEE ALSO
-.BR "http://wiki.grml.org/doku.php?id=usb " and
-.BR grml2hd (8)
-.SH BUGREPORTS
-Please report any bugs you notice to the author.
-.SH AUTHOR
-grml2usb was written by Michael Prokop <mika@grml.org>.
-.PP
-This manual page was written by Michael Prokop <mika@grml.org>
-for the grml project (but may be used by others).

diff --git a/grml2usb.8.txt b/grml2usb.8.txt
index 125e048..2ee0d7f 100644 (file)
--- a/grml2usb.8.txt
+++ b/grml2usb.8.txt
@@ -3,7 +3,7 @@ grml2usb(8)
 
 Name
 ----
-grml2usb - install grml on usb device
+grml2usb - install grml ISO(s) on usb device for booting
 
 Synopsis
 --------
@@ -16,27 +16,59 @@ Important! The grml team does not take responsibility for loss of any data!
 Options
 -------
 
+  *--bootoptions=...*::
+
+Use specified bootoptions as default.
+
+  *--dry-run*::
+
+Do not actually execute any commands, instead just show what would be executed.
+
   *--fat16*::
 
-Format specified partition with FAT16.
+Format specified partition with FAT16. **Important:** this will defstroy any existing
+data on the specified partition!
+
+  *--force*::
+
+Force any actions requiring manual interaction (like --fat16, --mbr).
 
   *--grub*::
 
 Install grub bootloader instead of syslinux.
 
+  *--help*::
+
+Display usage information and exit.
+
+  *--initrd=...*::
+
+Install specified initrd instead of the default. You might want to specify
+option *--kernel* as well.
+
+  *--kernel=...*::
+
+Install specified kernel instead of the default. You might want to specify
+option *--initrd* as well. (Be aware when using multiboot setup.)
+
   *--mbr*::
 
-Install master boot record (MBR) on the device.
+Install master boot record (MBR) on the device. **Important:** this will destroy any
+existing data on the device!
+
+  *--squashfs=*::
+
+Install specified squashfs file as the default.
 
   *--syslinux*::
 
 Install syslinux bootloader (default, requires FAT16 filesystem on the specified partition).
 
-  *-v*::
+  *-v*, *--version*::
 
 Return version and exit.
 
-  *-V*::
+  *--verbose*::
 
 Enable verbose mode.
 
@@ -58,34 +90,34 @@ Directory layout on usb device
     |   `-- menu.c32
     |-- release/
     |   |-- grml/
-    |       |-- linux26
-    |       |-- initrd.gz
+    |   |   |-- linux26
+    |   |   |-- initrd.gz
     |   |-- grml64
-    |       |-- linux26
-    |       |-- initrd.gz
+    |   |   |-- linux26
+    |   |   |-- initrd.gz
     |   |-- grml-medium
-    |       |-- linux26
-    |       |-- initrd.gz
+    |   |   |-- linux26
+    |   |   |-- initrd.gz
     |   |-- grml64-medium
-    |       |-- linux26
-    |       |-- initrd.gz
+    |   |   |-- linux26
+    |   |   |-- initrd.gz
     |   |-- grml-small
-    |       |-- linux26
-    |       |-- initrd.gz
-    |   |-- grml64-small
+    |   |   |-- linux26
+    |   |   |-- initrd.gz
+    |   `-- grml64-small
     |       |-- linux26
     |       |-- initrd.gz
     |-- grub/
     |   |-- menu.lst
     |   |-- splash.xpm.gz
-    |   |-- stage2_eltorito
+    |   `-- stage2_eltorito
     |-- isolinux/
     |   |-- boot.msg
     |   |-- boot-beep.msg
     |   |-- logo.16
     |   |-- isolinux-main.cfg
     |   |-- isolinux.cfg
-    |   |-- syslinux.cfg
+    |   `-- syslinux.cfg
     `-- bootsplashes/
         |-- f1
         |-- f2
@@ -105,7 +137,7 @@ Directory layout on usb device
     |-- LICENSE.txt
     |-- md5sums
     |-- README.txt
-    |-- web/
+    `-- web/
         |-- index.html
         |-- style.css
         `-- images/
@@ -131,12 +163,56 @@ Directory layout on usb device
 Usage examples
 --------------
 
-TODO
+  # grml2usb /home/grml/grml_2008.11.iso /dev/usb-sdb1
+
+Install specified ISOs on device /dev/usb-sdb1.
+
+  # grml2usb /home/grml/grml_2008.11.iso /home/grml/grml_small_2008.11.iso /dev/usb-sdb1
+
+Install specified ISOs on device /dev/usb-sdb1 for multibooting ISOs.
+Note: boot "grml" as usual, for booting grml-small use "grml-small on the
+bootprompt, for grml64 use "grml64" and so on...
+
+  # grml2usb --fat16 --mbr /home/grml/grml_2008.11.iso /dev/usb-sdb1
+
+Install specified ISO on device /dev/usb-sdb1, install MBR on /dev/usb-sdb and
+format partition /dev/usb-sdb1 with FAT16 filesystem.
+
+  # grml2usb --grub /home/grml/grml_2008.11.iso /dev/usb-sdb1
+
+Install specified ISO on device /dev/usb-sdb1 and use Grub as bootloader
+(instead of syslinux 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/usb-sdb1
+
+Install specified ISO on device /dev/usb-sdb1 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_2008.11.iso /dev/usb-sdb1
+
+Install specified ISO on device /dev/usb-sdb1 but use given squashfs
+file instead of the one provided by the ISO.
+
+  # grml2usb --bootoptions="lang=de ssh=mysecret" grml_2008.11.iso /dev/usb-sdb1
+
+Install specified ISO on device /dev/usb-sdb1 and use "lang=de ssh=mysecret" as
+default bootoptions.
 
 Bugs
 ----
-Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes link:http://grml.org/contact/[to us]!
+Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes link:http://grml.org/contact/[to the grml-team].
 
 Author
 ------
 Michael Prokop <mika@grml.org>
+
+/////////////////////////////////////////////////////////////////
+http://git.grml.org/?p=grml2usb.git
+http://wiki.grml.org/doku.php?id=tips#multiboot_usb_pen
+http://www.startx.ro/sugar/isotostick.sh
+https://help.ubuntu.com/community/Installation/FromUSBStick
+http://unetbootin.sourceforge.net/
+http://www.tux.org/pub/people/kent-robotti/looplinux/rip/mkusb.sh
+/////////////////////////////////////////////////////////////////