b49bce96b3178f1f1cb1a4c9a56bdc47cdbdc794
[grml2usb.git] / grml2usb.8.txt
1 grml2usb(8)
2 ==========
3
4 Name
5 ----
6 grml2usb - install grml ISO(s) on usb device for booting
7
8 Synopsis
9 --------
10 grml2usb [ options ] <ISO[s]> <device>
11
12 *******************************************************************************
13 Important! The grml team does not take responsibility for loss of any data!
14 *******************************************************************************
15
16 Options
17 -------
18
19 The ISO[s] might be the path to one or multiple grml-ISOs as well as the path to
20 the currently running live-system (being /live/image).
21
22 The device either might be a device name like /dev/usb-sda1 or a directory. When
23 specifying a device name the device is mounted automatically. When specifying a
24 directory it won't be touched but instead grml2usb is assuming that you did set
25 up a bootloader on your own and a bootloader won't be installed automatically.
26
27 The following options are supported:
28
29   *--bootoptions=...*::
30
31 Use specified bootoptions as default.
32
33   *--dry-run*::
34
35 Do not actually execute any commands, instead just show what would be executed.
36
37   *--fat16*::
38
39 Format specified partition with FAT16. **Important:** this will defstroy any existing
40 data on the specified partition!
41
42   *--force*::
43
44 Force any actions requiring manual interaction (like --fat16, --mbr).
45
46   *--grub*::
47
48 Install grub bootloader instead of syslinux.
49
50   *--help*::
51
52 Display usage information and exit.
53
54   *--initrd=...*::
55
56 Install specified initrd instead of the default. You might want to specify
57 option *--kernel* as well.
58
59   *--kernel=...*::
60
61 Install specified kernel instead of the default. You might want to specify
62 option *--initrd* as well. (Be aware when using multiboot setup.)
63
64   *--mbr*::
65
66 Install master boot record (MBR) on the device.
67
68   *--squashfs=*::
69
70 Install specified squashfs file as the default.
71
72   *--syslinux*::
73
74 Install syslinux bootloader (default, requires FAT16 filesystem on the specified partition).
75
76   *--uninstall*::
77
78 Uninstall grml ISO files.
79
80   *-v*, *--version*::
81
82 Return version and exit.
83
84   *--verbose*::
85
86 Enable verbose mode.
87
88 Introduction
89 ------------
90
91 grml2usb installs grml on a given partition on your usb device and makes it
92 bootable.
93
94 Directory layout on usb device
95 ------------------------------
96
97   boot/ ->
98     |-- addons/
99     |   |-- allinone.img
100     |   |-- balder10.imz
101     |   |-- chain.c32
102     |   |-- memdisk
103     |   `-- menu.c32
104     |-- release/
105     |   |-- grml/
106     |   |   |-- linux26
107     |   |   |-- initrd.gz
108     |   |-- grml64
109     |   |   |-- linux26
110     |   |   |-- initrd.gz
111     |   |-- grml-medium
112     |   |   |-- linux26
113     |   |   |-- initrd.gz
114     |   |-- grml64-medium
115     |   |   |-- linux26
116     |   |   |-- initrd.gz
117     |   |-- grml-small
118     |   |   |-- linux26
119     |   |   |-- initrd.gz
120     |   `-- grml64-small
121     |       |-- linux26
122     |       |-- initrd.gz
123     |-- grub/
124     |   |-- menu.lst
125     |   |-- splash.xpm.gz
126     |   `-- stage2_eltorito
127     `-- isolinux/
128         |-- boot.msg
129         |-- boot-beep.msg
130         |-- f1
131         |-- f2
132         |-- f3
133         |-- f4
134         |-- f5
135         |-- f6
136         |-- f7
137         |-- f8
138         |-- f9
139         |-- f10
140         |-- logo.16
141         |-- isolinux-main.cfg
142         |-- isolinux.cfg
143         `-- syslinux.cfg
144
145   grml/
146     |-- grml2usb.txt
147     |-- grml-cheatcodes.txt
148     |-- grml-version.txt
149     |-- LICENSE.txt
150     |-- md5sums
151     |-- README.txt
152     `-- web/
153         |-- index.html
154         |-- style.css
155         `-- images/
156             |-- button.png
157             |-- favicon.png
158             |-- linux.jpg
159             `-- logo.png
160
161   live/
162     |-- filesystem.module
163     |-- grml.squashfs
164     |-- grml-medium.module
165     |-- grml-medium.squashfs
166     |-- grml-small.module
167     |-- grml-small.squashfs
168     |-- grml64.module
169     |-- grml64.squashfs
170     |-- grml64-medium.module
171     |-- grml64-medium.squashfs
172     |-- grml64-small.module
173     `-- grml64-small.squashfs
174
175 Usage examples
176 --------------
177
178   # grml2usb /home/grml/grml_2008.11.iso /dev/usb-sdb1
179
180 Install specified ISOs on device /dev/usb-sdb1.
181
182   # grml2usb /home/grml/grml_2008.11.iso /home/grml/grml_small_2008.11.iso /dev/usb-sdb1
183
184 Install specified ISOs on device /dev/usb-sdb1 for multibooting ISOs.
185 Note: boot "grml" as usual, for booting grml-small use "grml-small on the
186 bootprompt, for grml64 use "grml64" and so on...
187
188   # grml2usb --fat16 --mbr /home/grml/grml_2008.11.iso /dev/usb-sdb1
189
190 Install specified ISO on device /dev/usb-sdb1, install MBR on /dev/usb-sdb and
191 format partition /dev/usb-sdb1 with FAT16 filesystem.
192
193   # grml2usb --grub /home/grml/grml_2008.11.iso /dev/usb-sdb1
194
195 Install specified ISO on device /dev/usb-sdb1 and use Grub as bootloader
196 (instead of syslinux being the default).
197
198   # grml2usb --kernel=/boot/vmlinuz-2.6.28-grml --initrd=/boot/initrd.img-2.6.28-grml \
199              /home/grml/grml_2008.11.iso /dev/usb-sdb1
200
201 Install specified ISO on device /dev/usb-sdb1 but use given kernel and initrd
202 instead of the ones provided by the ISO.
203
204   # grml2usb --squashfs=/grml/grml-live/grml_cd/live/grml.squashfs \
205              /home/grml/grml_2008.11.iso /dev/usb-sdb1
206
207 Install specified ISO on device /dev/usb-sdb1 but use given squashfs
208 file instead of the one provided by the ISO.
209
210   # grml2usb --bootoptions="lang=de ssh=mysecret" grml_2008.11.iso /dev/usb-sdb1
211
212 Install specified ISO on device /dev/usb-sdb1 and use "lang=de ssh=mysecret" as
213 default bootoptions.
214
215 Bugs
216 ----
217 Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes link:http://grml.org/contact/[to the grml-team].
218
219 Author
220 ------
221 Michael Prokop <mika@grml.org>
222
223 /////////////////////////////////////////////////////////////////
224 http://git.grml.org/?p=grml2usb.git
225 http://wiki.grml.org/doku.php?id=tips#multiboot_usb_pen
226 http://www.startx.ro/sugar/isotostick.sh
227 https://help.ubuntu.com/community/Installation/FromUSBStick
228 http://unetbootin.sourceforge.net/
229 http://www.tux.org/pub/people/kent-robotti/looplinux/rip/mkusb.sh
230 /////////////////////////////////////////////////////////////////