grml2usb.8

   1 .TH GRML2USB 8
   2 .SH NAME
   3 grml2usb \- install grml on external usb device
   4 .SH SYNOPSIS
   5 .B grml2usb
   6 .RI "<path-to-the-iso-file> <path-to-the-mountpoint>"
   7 .SH DESCRIPTION
   8 This manual page documents briefly the
   9 .B grml2usb
  10 command.
  11 .PP
  12 \fBgrml2usb\fP is a program that lets you boot grml from an external usb device
  13 (typically an usb pen) like from CD. Whereas grml2hd installs the main system to
  14 a given partition, grml2usb just copies the files from the grml-iso to the usb
  15 device. You do not need as much space as the grml2hd installation would take
  16 but just the size of the iso itself (about 700MB for grml, using a 1GB usb
  17 pen works fine therefore).
  18 .SH OPTIONS
  19 grml2usb requires and supports exactly two options:
  20 .TP
  21 .B <path-to-the-iso-file>
  22 The path where the iso you want to use for installation is available.
  23 That's something like for example /home/mika/grml_0.9.iso.
  24 The path could als be a block device or a plain directory (which contains all
  25 files of the iso).
  26 .TP
  27 .B <path-to-the-mountpoint>
  28 This option specifies the mountpoint for your usb device, using the setup in
  29 /etc/fstab. grml2usb copies the iso to this mountpoint and runs syslinux (the
  30 bootloader for the usb device so it can boot at all) on the device later on.
  31 .SH NOTES
  32 Booting via USB might be tricky as you have to take care of several pitfals.
  33 First of all make sure the BIOS of your system is capable of booting from USB
  34 devices at all. You need a primary partition on your usb device with the
  35 bootflag enabled (see 'cfdisk /dev/ice') and with filesystem type vfat
  36 (run 'mkfs.vfat -F 16 -v /dev/ice1' to create it).
  37 .SH USAGE EXAMPLES
  38 .TP
  39 .B grml2usb /home/mika/grml_0.9.iso /mnt/usb-sda1
  40 This will install the iso grml_0.9.iso to the device behind mountpoint
  41 /mnt/usb-sda1 set up via  /etc/fstab.
  42 .TP
  43 .B grml2usb /cdrom /mnt/external1
  44 Install currently running grml to usb-device on /mnt/external1.
  45 .SH SEE ALSO
  46 .BR "http://wiki.grml.org/doku.php?id=usb " and
  47 .BR grml2hd (8)
  48 .SH BUGREPORTS
  49 Please report any bugs you notice to the author.
  50 .SH AUTHOR
  51 grml2usb was written by Michael Prokop <mika@grml.org>.
  52 .PP
  53 This manual page was written by Michael Prokop <mika@grml.org>
  54 for the grml project (but may be used by others).