Added tag 0.7.4 for changeset 2c83a2fcbc53506a8e3668a9d3f12b6bec287381
[grml2usb.git] / 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 .TP
25 .B <path-to-the-mountpoint>
26 This option specifies the mountpoint for your usb device, using the setup in
27 /etc/fstab. grml2usb copies the iso to this mountpoint and runs syslinux (the
28 bootloader for the usb device so it can boot at all) on the device later on.
29 .SH NOTES
30 Booting via USB might be tricky as you have to take care of several pitfals.
31 First of all make sure the BIOS of your system is capable of booting from USB
32 devices at all. You need a primary partition on your usb device with the
33 bootflag enabled (see 'cfdisk /dev/ice') and with filesystem type vfat
34 (run 'mkfs.vfat -F 16 -v /dev/ice1' to create it).
35 .SH USAGE EXAMPLES
36 .TP
37 .B grml2usb /home/mika/grml_0.9.iso /mnt/usb-sda1
38 This will install the iso grml_0.9.iso to the device behind mountpoint
39 /mnt/usb-sda1 set up via  /etc/fstab.
40 .SH SEE ALSO
41 .BR "http://wiki.grml.org/doku.php?id=usb " and
42 .BR grml2hd (8)
43 .SH BUGREPORTS
44 Please report any bugs you notice to the author.
45 .SH AUTHOR
46 grml2usb was written by Michael Prokop <mika@grml.org>.
47 .PP
48 This manual page was written by Michael Prokop <mika@grml.org>
49 for the grml project (but may be used by others).