Add grml2iso manpage; update Makefile and tarball.sh for grml2iso
authorMichael Prokop <mika@grml.org>
Sun, 7 Jun 2009 23:29:15 +0000 (01:29 +0200)
committerMichael Prokop <mika@grml.org>
Sun, 7 Jun 2009 23:29:15 +0000 (01:29 +0200)
Makefile
grml2iso.8.txt [new file with mode: 0644]
tarball.sh

index ac3b498..f697d83 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -4,13 +4,15 @@ doc: doc_man doc_html
 
 doc_html: html-stamp
 
-html-stamp: grml2usb.8.txt
+html-stamp: grml2usb.8.txt grml2iso.8.txt
        asciidoc -b xhtml11 -a icons -a toc -a numbered grml2usb.8.txt
+       asciidoc -b xhtml11 -a icons -a toc -a numbered grml2iso.8.txt
        touch html-stamp
 
 doc_man: man-stamp
 
-man-stamp: grml2usb.8.txt
+man-stamp: grml2usb.8.txt grml2iso.8.txt
+       # grml2usb:
        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
@@ -21,6 +23,18 @@ man-stamp: grml2usb.8.txt
        # ugly hack to avoid '.sp' at the end of a sentence or paragraph:
        sed -i 's/\.sp//' grml2usb.8
        rm grml2usb.8.tmp
+       # grml2iso:
+       asciidoc -d manpage -b docbook grml2iso.8.txt
+       sed -i 's/<emphasis role="strong">/<emphasis role="bold">/' grml2iso.8.xml
+       xsltproc /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl grml2iso.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 grml2iso.8 grml2iso.8.tmp
+       uniq grml2iso.8.tmp > grml2iso.8
+       # ugly hack to avoid '.sp' at the end of a sentence or paragraph:
+       sed -i 's/\.sp//' grml2iso.8
+       rm grml2iso.8.tmp
+       # we're done
        touch man-stamp
 
 online: all
@@ -35,7 +49,10 @@ tarball-online: all
        scp grml2usb.tgz grml2usb.tgz.md5.asc grml:/var/www/grml/grml2usb/
 
 clean:
-       rm -rf grml2usb.8.html grml2usb.8.xml grml2usb.8 html-stamp man-stamp grml2usb.tar.gz
+       rm -rf grml2usb.8.html grml2usb.8.xml grml2usb.8
+       rm -rf grml2iso.8.html grml2iso.8.xml grml2iso.8
+       rm -rf html-stamp man-stamp grml2usb.tar.gz grml2usb.tgz grml2usb.tgz.md5.asc
+       #
 
 codecheck:
        pylint --include-ids=y --max-line-length=120 grml2usb
diff --git a/grml2iso.8.txt b/grml2iso.8.txt
new file mode 100644 (file)
index 0000000..eed39bb
--- /dev/null
@@ -0,0 +1,69 @@
+grml2iso(8)
+==========
+
+Name
+----
+grml2iso - create a multiboot grml ISO using grml2usb
+
+Synopsis
+--------
+grml2iso -o <target.iso> <ISO[s]>
+
+*******************************************************************************
+Important! The grml team does not take responsibility for loss of any data!
+*******************************************************************************
+
+Introduction
+------------
+
+grml2iso allows you to create a multiboot grml ISO. You can specify
+two or more grml ISOs and will get one single multiboot ISO as a result.
+grml2iso requires and uses grml2usb for this task and installs grub2
+as bootmanager on the multiboot ISO.
+
+Options
+-------
+
+grml2iso supports the environment variables GRML2USB and WRKDIR.
+GRML2USB specifies the path to the grml2usb script you'd like to use.
+WRKDIR specifies the work directory for creating the filesystem.
+The work directory needs at least as much free disk space as the sum
+of all specified ISOs.
+
+  *\--o <target.iso>*::
+
+This option is mandatory and specifies where the resulting multiboot grml ISO
+should be placed. Note that (to avoid any possible data loss) grml2iso will exit
+if the specified target.iso exists already.
+
+Usage examples
+--------------
+
+  # grml2iso -o /tmp/grml.iso grml_2009.05.iso grml64_2009.05.iso
+
+Create multiboot ISO /tmp/grml.iso with grml_2009.05.iso and grml64_2009.05.iso.
+
+  # GRML2USB=/srv/git/grml2usb grml2iso -o /srv/grml.iso /srv/grml/grml_2009.05.iso /srv/grml/grml64-medium_2009.05.iso
+
+Create multiboot ISO /srv/grml.iso with grml_2009.05.iso and
+grml64-medium_2009.05.iso using /srv/git/grml2usb as grml2usb script.
+
+  # WRKDIR=/mnt/test/grml-tmp grml2iso -o /mnt/test/grml.iso grml_2009.05.iso grml64_2009.05.iso
+
+Use /mnt/test/grml-tmp as working directory for creating the multiboot ISO
+/mnt/test/grml.iso with grml_2009.05.iso and grml64_2009.05.iso.
+
+Online Ressources
+-----------------
+
+Check out the link:http://grml.org/grml2usb/[grml2usb webpage] and the
+link:http://git.grml.org/?p=grml2usb.git[grml2usb git repository].
+
+Bugs
+----
+Please report feedback, bugreports and wishes <<X7,to the author>>.
+
+[[X7]]
+Authors
+-------
+Michael Prokop <mika@grml.org> and Thorsten Glaser <tg@mirbsd.org>
index 4afc431..05c6f49 100755 (executable)
@@ -55,6 +55,9 @@ printf "Installing files:\n"
 printf "  - /usr/sbin/grml2usb\n"
 install -m 755 \${BASE}/grml2usb /usr/sbin/grml2usb
 
+printf "  - /usr/sbin/grml2iso\n"
+install -m 755 \${BASE}/grml2iso /usr/sbin/grml2iso
+
 [ -d /usr/share/grml2usb/grub ] || mkdir -p /usr/share/grml2usb/grub
 printf "  - /usr/share/grml2usb/grub/splash.xpm.gz\n"
 install -m 644 \${BASE}/splash.xpm.gz /usr/share/grml2usb/grub/splash.xpm.gz
@@ -94,6 +97,7 @@ fi
 
 for file in \\
   /usr/sbin/grml2usb \\
+  /usr/sbin/grml2iso \\
   /usr/share/grml2usb/grub/splash.xpm.gz \\
   /usr/share/grml2usb/grub/grml.png \\
   /usr/share/grml2usb/lilo/lilo.static.amd64 \\
@@ -113,11 +117,14 @@ fakeroot debian/rules build
 
 # manpage
 cp grml2usb.8.txt grml2usb-$VERSION/
+cp grml2iso.8.txt grml2usb-$VERSION/
 gzip -9 --to-stdout grml2usb-$VERSION/grml2usb.8.txt > grml2usb-$VERSION/grml2usb.8.gz
+gzip -9 --to-stdout grml2usb-$VERSION/grml2iso.8.txt > grml2usb-$VERSION/grml2iso.8.gz
 rm grml2usb-$VERSION/grml2usb.8.txt
+rm grml2usb-$VERSION/grml2iso.8.txt
 
 # binaries, grub, lilo
-cp grml2usb mbr/mbrldr mbr/mbrmgr grub/* lilo/lilo.static.* grml2usb-$VERSION/
+cp grml2usb grml2iso mbr/mbrldr mbr/mbrmgr grub/* lilo/lilo.static.* grml2usb-$VERSION/
 
 tar zcf grml2usb.tgz "${DIR}"