fa621e75df399b6726732b3182317885f3375b79
[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/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   *--bootloader-only*::
34
35 Do *not* copy files but instead just install a bootloader.
36
37   *--copy-only*::
38
39 Copy files only but do *not* install a bootloader.
40
41   *--dry-run*::
42
43 Avoid executing commands, instead show what would be executed.
44 Warning: please notice that the ISO has to be mounted anyway, otherwise
45 identifying the grml flavour would not be possible.
46
47   *--fat16*::
48
49 Format specified partition with FAT16.
50 **Important:** this will destroy any existing data on the specified partition!
51
52   *--force*::
53
54 Force any (possible dangerous) actions requiring manual interaction (like --fat16).
55
56   *--grub*::
57
58 Install grub bootloader instead of syslinux. [Notice: not implemented yet.]
59
60   *--help*::
61
62 Display usage information and exit.
63
64   *--initrd=...*::
65
66 Install specified initrd instead of the default. You might want to specify
67 option *--kernel* as well. (Be aware when using multiboot setup.)
68 [Notice: not implemented yet.]
69
70   *--kernel=...*::
71
72 Install specified kernel instead of the default. You might want to specify
73 option *--initrd* as well. (Be aware when using multiboot setup.)
74 [Notice: not implemented yet.]
75
76   *--lilo=...*::
77
78 Use specified lilo executable to for installing master boot record (MBR)
79 instead of the default, being /usr/share/grml2usb/lilo/lilo.static.
80
81   *--mbr*::
82
83 Install a default master boot record (MBR) on the device.
84
85   *--quiet*::
86
87 Do not output anything but just errors on console.
88
89   *--squashfs=*::
90
91 Install specified squashfs file instead of the default.
92 [Notice: not implemented yet.]
93
94   *--uninstall*::
95
96 Uninstall grml ISO files.
97 [Notice: not implemented yet.]
98
99   *-v*, *--version*::
100
101 Return version and exit.
102
103   *--verbose*::
104
105 Enable verbose mode.
106
107 Introduction
108 ------------
109
110 grml2usb installs grml on a given partition of your usb device and makes it
111 bootable.
112
113 grml2usb provides multi-iso support, meaning you can specify several grml ISOs
114 on the command line at once and select the grml flavour you would like to boot
115 on the bootbrompt then. Notice that the default ISO (that's when pressing just
116 enter on the bootprompt or wait until the timeout matches) will be the *first*
117 one specified on the grml2usb command line.
118
119 Directory layout on usb device
120 ------------------------------
121
122   boot/ ->
123     |-- addons/
124     |   |-- allinone.img
125     |   |-- balder10.imz
126     |   |-- chain.c32
127     |   |-- memdisk
128     |   `-- menu.c32
129     |-- release/
130     |   |-- grml/
131     |   |   |-- linux26
132     |   |   |-- initrd.gz
133     |   |-- grml64
134     |   |   |-- linux26
135     |   |   |-- initrd.gz
136     |   |-- grml-medium
137     |   |   |-- linux26
138     |   |   |-- initrd.gz
139     |   |-- grml64-medium
140     |   |   |-- linux26
141     |   |   |-- initrd.gz
142     |   |-- grml-small
143     |   |   |-- linux26
144     |   |   |-- initrd.gz
145     |   `-- grml64-small
146     |       |-- linux26
147     |       |-- initrd.gz
148     |-- grub/
149     |   |-- menu.lst
150     |   |-- splash.xpm.gz
151     |   `-- stage2_eltorito
152     `-- syslinux/
153         |-- boot.msg
154         |-- f1
155         |-- f2
156         |-- f3
157         |-- f4
158         |-- f5
159         |-- f6
160         |-- f7
161         |-- f8
162         |-- f9
163         |-- f10
164         |-- logo.16
165         `-- syslinux.cfg
166
167   grml/
168     |-- grml2usb.txt
169     |-- grml-cheatcodes.txt
170     |-- grml-version.txt
171     |-- LICENSE.txt
172     |-- md5sums
173     |-- README.txt
174     `-- web/
175         |-- index.html
176         |-- style.css
177         `-- images/
178             |-- button.png
179             |-- favicon.png
180             |-- linux.jpg
181             `-- logo.png
182
183   live/
184     |-- filesystem.module
185     |-- grml.squashfs
186     |-- grml-medium.module
187     |-- grml-medium.squashfs
188     |-- grml-small.module
189     |-- grml-small.squashfs
190     |-- grml64.module
191     |-- grml64.squashfs
192     |-- grml64-medium.module
193     |-- grml64-medium.squashfs
194     |-- grml64-small.module
195     `-- grml64-small.squashfs
196
197 Usage examples
198 --------------
199
200   # grml2usb /home/grml/grml_2008.11.iso /dev/sdb1
201
202 Install specified ISO on device /dev/sdb1.
203
204   # grml2usb /home/grml/grml_2008.11.iso /home/grml/grml_small_2008.11.iso /dev/sdb1
205
206 Install specified ISOs on device /dev/sdb1 for multibooting ISOs.
207 Note: boot "grml" as usual, for booting grml-small use "grml-small on the
208 bootprompt, for grml64 use "grml64" and so on... The *first* specified ISO is
209 the one being the default (when just pressing enter or waiting until the timeout
210 is reached).
211
212   # grml2usb --fat16 --mbr /home/grml/grml_2008.11.iso /dev/sdb1
213
214 Install specified ISO on device /dev/sdb1, install MBR on /dev/sdb and
215 format partition /dev/sdb1 with FAT16 filesystem.
216
217   # grml2usb --grub /home/grml/grml_2008.11.iso /dev/sdb1
218
219 Install specified ISO on device /dev/sdb1 and use Grub as bootloader
220 (instead of syslinux being the default).
221
222   # grml2usb --kernel=/boot/vmlinuz-2.6.28-grml --initrd=/boot/initrd.img-2.6.28-grml \
223              /home/grml/grml_2008.11.iso /dev/sdb1
224
225 Install specified ISO on device /dev/sdb1 but use given kernel and initrd
226 instead of the ones provided by the ISO.
227
228   # grml2usb --squashfs=/grml/grml-live/grml_cd/live/grml.squashfs \
229              /home/grml/grml_2008.11.iso /dev/sdb1
230
231 Install specified ISO on device /dev/sdb1 but use given squashfs
232 file instead of the one provided by the ISO.
233
234   # grml2usb --bootoptions="lang=de ssh=mysecret" grml_2008.11.iso /dev/sdb1
235
236 Install specified ISO on device /dev/sdb1 and use "lang=de ssh=mysecret" as
237 default bootoptions.
238
239 Bugs
240 ----
241 Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes link:http://grml.org/contact/[to the grml-team].
242
243 Author
244 ------
245 Michael Prokop <mika@grml.org>
246
247 /////////////////////////////////////////////////////////////////
248 http://git.grml.org/?p=grml2usb.git
249 http://wiki.grml.org/doku.php?id=tips#multiboot_usb_pen
250 http://www.startx.ro/sugar/isotostick.sh
251 https://help.ubuntu.com/community/Installation/FromUSBStick
252 http://unetbootin.sourceforge.net/
253 http://www.tux.org/pub/people/kent-robotti/looplinux/rip/mkusb.sh
254 /////////////////////////////////////////////////////////////////