From: Michael Prokop <mika@grml.org>
Date: Thu, 8 Jan 2009 14:28:40 +0000 (+0100)
Subject: Redesign grml2usb
X-Git-Tag: v0.9.2~65
X-Git-Url: https://git.grml.org/?p=grml2usb.git;a=commitdiff_plain;h=c9500a5fad503b1ed1e74b1ae8d4f6e003b0dfa2;hp=ebb198b6a481a5aa84932945b96c865a9cffb64d

Redesign grml2usb
---

diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..d3db345
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,34 @@
+all: doc
+
+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
+	# ugly hack to avoid duplicate empty lines in manpage
+	# notice: docbook-xsl 1.71.0.dfsg.1-1 is broken! make sure you use 1.68.1.dfsg.1-0.2!
+	cp grml2usb.8 grml2usb.8.tmp
+	uniq grml2usb.8.tmp > grml2usb.8
+	# ugly hack to avoid '.sp' at the end of a sentence or paragraph:
+	sed -i 's/\.sp//' grml2usb.8
+	rm grml2usb.8.tmp
+	touch man-stamp
+
+online: all
+	scp grml2usb.8.html grml:/var/www/grml/grml2usb/index.html
+	scp images/icons/*          grml:/var/www/grml/grml2usb/images/icons/
+	scp images/screenshot.png   grml:/var/www/grml/grml2usb/images/
+
+clean:
+	rm -rf grml2usb.8.html grml2usb.8.xml grml2usb.8 html-stamp man-stamp
diff --git a/grml2usb.8.txt b/grml2usb.8.txt
new file mode 100644
index 0000000..125e048
--- /dev/null
+++ b/grml2usb.8.txt
@@ -0,0 +1,142 @@
+grml2usb(8)
+==========
+
+Name
+----
+grml2usb - install grml on usb device
+
+Synopsis
+--------
+grml2usb [ options ] <ISO[s]> <device>
+
+*******************************************************************************
+Important! The grml team does not take responsibility for loss of any data!
+*******************************************************************************
+
+Options
+-------
+
+  *--fat16*::
+
+Format specified partition with FAT16.
+
+  *--grub*::
+
+Install grub bootloader instead of syslinux.
+
+  *--mbr*::
+
+Install master boot record (MBR) on the device.
+
+  *--syslinux*::
+
+Install syslinux bootloader (default, requires FAT16 filesystem on the specified partition).
+
+  *-v*::
+
+Return version and exit.
+
+  *-V*::
+
+Enable verbose mode.
+
+Introduction
+------------
+
+grml2usb installs grml on a given partition on your usb device and makes it
+bootable.
+
+Directory layout on usb device
+------------------------------
+
+  boot/ ->
+    |-- addons/
+    |   |-- allinone.img
+    |   |-- balder10.imz
+    |   |-- chain.c32
+    |   |-- memdisk
+    |   `-- menu.c32
+    |-- release/
+    |   |-- grml/
+    |       |-- linux26
+    |       |-- initrd.gz
+    |   |-- grml64
+    |       |-- linux26
+    |       |-- initrd.gz
+    |   |-- grml-medium
+    |       |-- linux26
+    |       |-- initrd.gz
+    |   |-- grml64-medium
+    |       |-- linux26
+    |       |-- initrd.gz
+    |   |-- grml-small
+    |       |-- linux26
+    |       |-- initrd.gz
+    |   |-- grml64-small
+    |       |-- linux26
+    |       |-- initrd.gz
+    |-- grub/
+    |   |-- menu.lst
+    |   |-- splash.xpm.gz
+    |   |-- stage2_eltorito
+    |-- isolinux/
+    |   |-- boot.msg
+    |   |-- boot-beep.msg
+    |   |-- logo.16
+    |   |-- isolinux-main.cfg
+    |   |-- isolinux.cfg
+    |   |-- syslinux.cfg
+    `-- bootsplashes/
+        |-- f1
+        |-- f2
+        |-- f3
+        |-- f4
+        |-- f5
+        |-- f6
+        |-- f7
+        |-- f8
+        |-- f9
+        `-- f10
+
+  grml/
+    |-- grml2usb.txt
+    |-- grml-cheatcodes.txt
+    |-- grml-version.txt
+    |-- LICENSE.txt
+    |-- md5sums
+    |-- README.txt
+    |-- web/
+        |-- index.html
+        |-- style.css
+        `-- images/
+            |-- button.png
+            |-- favicon.png
+            |-- linux.jpg
+            `-- logo.png
+
+  live/
+    |-- filesystem.module
+    |-- grml.squashfs
+    |-- grml-medium.module
+    |-- grml-medium.squashfs
+    |-- grml-small.module
+    |-- grml-small.squashfs
+    |-- grml64.module
+    |-- grml64.squashfs
+    |-- grml64-medium.module
+    |-- grml64-medium.squashfs
+    |-- grml64-small.module
+    `-- grml64-small.squashfs
+
+Usage examples
+--------------
+
+TODO
+
+Bugs
+----
+Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes link:http://grml.org/contact/[to us]!
+
+Author
+------
+Michael Prokop <mika@grml.org>