2ee0d7f947ee876a808a4d6c01de22c8df071e75
[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   *-v*, *--version*::
68
69 Return version and exit.
70
71   *--verbose*::
72
73 Enable verbose mode.
74
75 Introduction
76 ------------
77
78 grml2usb installs grml on a given partition on your usb device and makes it
79 bootable.
80
81 Directory layout on usb device
82 ------------------------------
83
84   boot/ ->
85     |-- addons/
86     |   |-- allinone.img
87     |   |-- balder10.imz
88     |   |-- chain.c32
89     |   |-- memdisk
90     |   `-- menu.c32
91     |-- release/
92     |   |-- grml/
93     |   |   |-- linux26
94     |   |   |-- initrd.gz
95     |   |-- grml64
96     |   |   |-- linux26
97     |   |   |-- initrd.gz
98     |   |-- grml-medium
99     |   |   |-- linux26
100     |   |   |-- initrd.gz
101     |   |-- grml64-medium
102     |   |   |-- linux26
103     |   |   |-- initrd.gz
104     |   |-- grml-small
105     |   |   |-- linux26
106     |   |   |-- initrd.gz
107     |   `-- grml64-small
108     |       |-- linux26
109     |       |-- initrd.gz
110     |-- grub/
111     |   |-- menu.lst
112     |   |-- splash.xpm.gz
113     |   `-- stage2_eltorito
114     |-- isolinux/
115     |   |-- boot.msg
116     |   |-- boot-beep.msg
117     |   |-- logo.16
118     |   |-- isolinux-main.cfg
119     |   |-- isolinux.cfg
120     |   `-- syslinux.cfg
121     `-- bootsplashes/
122         |-- f1
123         |-- f2
124         |-- f3
125         |-- f4
126         |-- f5
127         |-- f6
128         |-- f7
129         |-- f8
130         |-- f9
131         `-- f10
132
133   grml/
134     |-- grml2usb.txt
135     |-- grml-cheatcodes.txt
136     |-- grml-version.txt
137     |-- LICENSE.txt
138     |-- md5sums
139     |-- README.txt
140     `-- web/
141         |-- index.html
142         |-- style.css
143         `-- images/
144             |-- button.png
145             |-- favicon.png
146             |-- linux.jpg
147             `-- logo.png
148
149   live/
150     |-- filesystem.module
151     |-- grml.squashfs
152     |-- grml-medium.module
153     |-- grml-medium.squashfs
154     |-- grml-small.module
155     |-- grml-small.squashfs
156     |-- grml64.module
157     |-- grml64.squashfs
158     |-- grml64-medium.module
159     |-- grml64-medium.squashfs
160     |-- grml64-small.module
161     `-- grml64-small.squashfs
162
163 Usage examples
164 --------------
165
166   # grml2usb /home/grml/grml_2008.11.iso /dev/usb-sdb1
167
168 Install specified ISOs on device /dev/usb-sdb1.
169
170   # grml2usb /home/grml/grml_2008.11.iso /home/grml/grml_small_2008.11.iso /dev/usb-sdb1
171
172 Install specified ISOs on device /dev/usb-sdb1 for multibooting ISOs.
173 Note: boot "grml" as usual, for booting grml-small use "grml-small on the
174 bootprompt, for grml64 use "grml64" and so on...
175
176   # grml2usb --fat16 --mbr /home/grml/grml_2008.11.iso /dev/usb-sdb1
177
178 Install specified ISO on device /dev/usb-sdb1, install MBR on /dev/usb-sdb and
179 format partition /dev/usb-sdb1 with FAT16 filesystem.
180
181   # grml2usb --grub /home/grml/grml_2008.11.iso /dev/usb-sdb1
182
183 Install specified ISO on device /dev/usb-sdb1 and use Grub as bootloader
184 (instead of syslinux being the default).
185
186   # grml2usb --kernel=/boot/vmlinuz-2.6.28-grml --initrd=/boot/initrd.img-2.6.28-grml \
187              /home/grml/grml_2008.11.iso /dev/usb-sdb1
188
189 Install specified ISO on device /dev/usb-sdb1 but use given kernel and initrd
190 instead of the ones provided by the ISO.
191
192   # grml2usb --squashfs=/grml/grml-live/grml_cd/live/grml.squashfs \
193              /home/grml/grml_2008.11.iso /dev/usb-sdb1
194
195 Install specified ISO on device /dev/usb-sdb1 but use given squashfs
196 file instead of the one provided by the ISO.
197
198   # grml2usb --bootoptions="lang=de ssh=mysecret" grml_2008.11.iso /dev/usb-sdb1
199
200 Install specified ISO on device /dev/usb-sdb1 and use "lang=de ssh=mysecret" as
201 default bootoptions.
202
203 Bugs
204 ----
205 Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes link:http://grml.org/contact/[to the grml-team].
206
207 Author
208 ------
209 Michael Prokop <mika@grml.org>
210
211 /////////////////////////////////////////////////////////////////
212 http://git.grml.org/?p=grml2usb.git
213 http://wiki.grml.org/doku.php?id=tips#multiboot_usb_pen
214 http://www.startx.ro/sugar/isotostick.sh
215 https://help.ubuntu.com/community/Installation/FromUSBStick
216 http://unetbootin.sourceforge.net/
217 http://www.tux.org/pub/people/kent-robotti/looplinux/rip/mkusb.sh
218 /////////////////////////////////////////////////////////////////