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