Support generating small iso images with grml2iso.
[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 [[introduction]]
17 Introduction
18 ------------
19
20 grml2usb installs grml on a given partition of your usb device and makes it
21 bootable. It provides multi-iso support, meaning you can specify several grml
22 ISOs on the command line at once and select the grml flavour you would like to
23 boot on the bootprompt then. Note that the *first* ISO specified on the grml2usb
24 command line will become the default one (that's the one that will boot when
25 just pressing enter on the bootprompt or wait until the boot timeout matches).
26
27 [IMPORTANT]
28 By default a compatible master boot record (MBR) is installed on the device
29 (being for example /dev/sdX when executing 'grml2usb grml.iso /dev/sdX1') and
30 syslinux is being used as default bootloader. Avoid installation of the default
31 MBR using the '--skip-mbr' option or if you encounter any problems with the
32 default MBR consider using '--syslinux-mbr' instead.
33
34 [NOTE]
35 Whereas grml2usb is the script to install recent grml ISOs (>=2009.10) the
36 script grml2usb-compat supports older grml releases (<2009.10) as well.
37
38 [[options]]
39 Options
40 -------
41
42 The ISO[s] should be the path to one or multiple grml-ISOs and/or the path to
43 the currently running live-system (being /live/image).
44
45 The device either might be a device name like /dev/sdX1 or a directory. When
46 specifying a device name the device is mounted automatically. When specifying a
47 directory grml2usb is assuming that you did set up a bootloader on your own (or
48 don't need one) and a bootloader won't be installed automatically.
49
50 The following options are supported:
51
52   *\--bootoptions=...*::
53
54 Use specified bootoptions as default. To use flavour name as a argument for a
55 boot parameter use %flavour which will be expanded to the flavour name. To add
56 multiple bootoptions you can specify the option multiple time.
57
58   *\--bootloader-only*::
59
60 Do *not* copy files but instead just install a bootloader.  Note that the boot
61 addons are copied to /boot/addons at this stage as well.  If you want to skip
62 copying the boot addons consider using the --skip-addons option.
63
64   *\--copy-only*::
65
66 Copy files only but do *not* install a bootloader.
67
68   *\--dry-run*::
69
70 Avoid executing commands, instead show what would be executed.
71 Warning: please notice that the ISO has to be mounted anyway, otherwise
72 identifying the grml flavour would not be possible.
73
74   *\--fat16*::
75
76 Format specified partition with FAT16.
77 **Important:** this will destroy any existing data on the specified partition!
78
79   *\--force*::
80
81 Force any (possible dangerous) actions requiring manual interaction (like --fat16).
82
83   *\--grub*::
84
85 Install grub bootloader instead of (default) syslinux.
86
87   *\--grub-mbr*::
88
89 Install grub into MBR (Master Boot Record) instead of PBR (Partition Boot
90 Record). Check out <<mbr-vs-pbr,the 'mbr-vs-pbr' section in the FAQ of this
91 document>> for further details.
92
93   *\--help*::
94
95 Display usage information and exit.
96
97 //////////////////////////////////////////////////////////////////////////
98   *\--initrd=...*::
99
100 Install specified initrd instead of the default. You might want to specify
101 option *--kernel* as well. (Be aware when using multiboot setup.)
102 [Notice: not implemented yet.]
103 //////////////////////////////////////////////////////////////////////////
104
105 //////////////////////////////////////////////////////////////////////////
106   *\--kernel=...*::
107
108 Install specified kernel instead of the default. You might want to specify
109 option *--initrd* as well. (Be aware when using multiboot setup.)
110 [Notice: not implemented yet.]
111 //////////////////////////////////////////////////////////////////////////
112
113   *\--lilo-binary=...*::
114
115 Use specified lilo executable for installing master boot record (MBR) when using
116 the '--syslinux-mbr' option. By default any system wide (from $PATH) lilo
117 executable is taken.  If there can not be find any lilo executable the
118 statically compiled version of the grml2usb Debian package (see
119 /usr/share/grml2usb/lilo/lilo.static.[amd64|i386]) is taken.
120
121   *\--mbr-menu*::
122
123 Install master boot record (MBR) with integrated boot menu: interactively choose
124 the partition to boot from, with a timeout to load the default partition, or
125 boot from floppy. When NOT using the --mbr-menu option a MBR with LBA and large
126 disc support but without an integrated boot menu is installed (so it's not
127 visible at all but instead directly jumps to the bootloader - being grub or
128 syslinux). Note: This options is available only when using the default MBR and
129 won't have any effect if you're using the '--syslinux-mbr' option.
130
131   *\--quiet*::
132
133 Do not output anything but just errors on console.
134
135   *\--skip-addons*::
136
137 Do not install /boot/addons/ files (like dos, grub, memdisk,...).
138
139   *\--remove-bootoption=...*::
140
141 Remove specified bootoption (could be a regex) from existing boot options. Use
142 multiple entries for removing different bootoptions at once. (Note: this option
143 is not support in grml2usb-compat.)
144
145   *\--skip-grub-config*::
146
147 Skip generation of grub configuration files. By default the configuration
148 files for syslinux *and* grub will be written so you've a working configuration
149 file no matter whether you're using grub or syslinux as bootloader.
150
151   *\--skip-mbr*::
152
153 Do not touch/install the master boot record (MBR).
154
155   *\--skip-syslinux-config*::
156
157 Skip generation of syslinux configuration files. By default the configuration
158 files for syslinux *and* grub will be written so you've a working configuration
159 file no matter whether you're using grub or syslinux as bootloader.
160
161   *\--syslinux*::
162
163 This option is deprecated and is being left only for backwards compatibility
164 reasons. Syslinux is the default bootloader of grml2usb and therefore the
165 '--syslinux' option doesn't have any effects. If you do not want to use syslinux
166 as bootloader consider using the '--grub' option.
167
168   *\--syslinux-mbr*::
169
170 Install syslinux' master boot record (MBR, which is booting from the partition
171 with the "active" flag set) instead of the default one.  If you encounter any
172 problems with the default MBR you can try using the syslinux MBR instead. If
173 that works for you please <<author,let us know>> so we can adjust our default
174 MBR accordingly. Note: When using the '--syslinux-mbr' option lilo is executed
175 before the MBR is installed so the according partitions are set active.
176
177 //////////////////////////////////////////////////////////////////////////
178   *\--squashfs=*::
179
180 Install specified squashfs file instead of the default.
181 [Notice: not implemented yet.]
182 //////////////////////////////////////////////////////////////////////////
183
184 //////////////////////////////////////////////////////////////////////////
185   *\--uninstall*::
186
187 Uninstall grml ISO files.
188 [Notice: not implemented yet.]
189 //////////////////////////////////////////////////////////////////////////
190
191   *-v*, *\--version*::
192
193 Return version and exit.
194
195   *\--verbose*::
196
197 Enable verbose mode.
198
199 Developers Corner
200 -----------------
201
202 [[directory-layout]]
203 Directory layout on usb device
204 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
205
206   boot/ ->
207     |-- addons/
208     |   |-- allinone.img     [grub - all in one image]
209     |   |-- bsd4grml/        [MirBSD]
210     |   |-- balder10.imz     [FreeDOS]
211     |   |-- memdisk          [chainloading helper]
212     |   |-- memtest          [memtest86+]
213     |-- release/
214     |   |-- grml/
215     |   |   |-- linux26      [Kernel]
216     |   |   |-- initrd.gz    [initramfs]
217     |   |-- grml64
218     |   |   |-- linux26      [Kernel]
219     |   |   |-- initrd.gz    [initramfs]
220     |   |-- grml-medium
221     |   |   |-- linux26      [...]
222     |   |   |-- initrd.gz
223     |   |-- grml64-medium
224     |   |   |-- linux26
225     |   |   |-- initrd.gz
226     |   |-- grml-small
227     |   |   |-- linux26
228     |   |   |-- initrd.gz
229     |   `-- grml64-small
230     |       |-- linux26
231     |       |-- initrd.gz
232     |-- grub/
233     |   |-- grml.png         [graphical bootsplash background image for grub2]
234     |   |-- grub.cfg         [configuration file for grub2]
235     |   |-- menu.lst         [configuration file for grub1]
236     |   |-- splash.xpm.gz    [splash screen for grub1]
237     `-- syslinux/
238         |-- grml.png         [graphical bootsplash background image for syslinux]
239         |-- syslinux.cfg     [main configuration file for syslinux]
240         `-- [....]           [several further config files for syslinux]
241
242   grml/
243     |-- grml2usb.txt         [not yet implemented]
244     |-- grml-cheatcodes.txt  [list of bootoptions for grml]
245     |-- grml-version.txt     [file containing information about grml-version]
246     |-- LICENSE.txt          [license information]
247     |-- md5sums              [md5sums of original ISO]
248     |-- README.txt           [informational text]
249     `-- web/                 [browser related files]
250         |-- index.html
251         |-- style.css
252         `-- images/
253             |-- button.png
254             |-- favicon.png
255             |-- linux.jpg
256             `-- logo.png
257
258   live/
259     |-- grml/
260     |   |-- filesystem.module    [module specifying which squashfs should be used for grml]
261     |   `-- grml.squashfs        [squashfs file for grml]
262     |-- grml-medium/
263     |   |-- filesystem.module    [module specifying which squashfs should be used for grml-medium]
264     |   `-- grml-medium.squashfs [squashfs file for grml-medium]
265     |-- grml-small/
266     |   |-- filesystem.module    [module specifying which squashfs should be used for grml-medium]
267     |   `-- grml-small.squashfs  [squashfs file for grml-small]
268     `-- ...
269
270 [[source]]
271 Grabbing the source
272 ~~~~~~~~~~~~~~~~~~~
273
274   % git clone git://git.grml.org/grml2usb.git
275
276 [[debugging]]
277 Developers Debugging Hints
278 ~~~~~~~~~~~~~~~~~~~~~~~~~~
279
280 To play with grml2usb you can avoid using a real device via a loopback file
281 setup, like:
282
283   # dd if=/dev/zero of=~/loopback bs=1M count=100 # adjust size to your needs
284   # losetup /dev/loop1 ~/loopback
285
286 Then create according partitions either running for example:
287
288   # echo -en "n\np\n1\n\n\nt\n6\na\n1\n w\n" | fdisk /dev/loop1
289
290 or:
291
292   # parted /dev/loop1 -s "mkpart primary fat16 0 -1s mkfs 1 fat16"
293
294 Finally create a filesystem and execute grml2usb as needed:
295
296   # mkfs.vfat /dev/loop1
297   # grml2usb --bootloader-only /grml/isos/grml-small_2009.10.iso /dev/loop1
298
299 [[performance-tracing]]
300 Performance tracing
301 ~~~~~~~~~~~~~~~~~~~
302
303   # blktrace -d /dev/sdX -o - | blkparse -i -
304   # grml2usb grml_2009.10.iso /dev/sdX1
305
306 [[troubleshooting]]
307 Troubleshooting and Pitfalls when booting
308 -----------------------------------------
309
310 Here is a list of common error messages from BIOS/bootloader when trying to boot
311 from USB.
312
313 ///////////////////////////////////////////////////////////
314 TODO: better list type for the error message / reason part?
315 See http://www.methods.co.nz/asciidoc/userguide.html
316 ///////////////////////////////////////////////////////////
317
318 [horizontal]
319 *Error message*:: ran out of input data. System halted
320
321 *Reason*:: Everything OK, except for the filesystem used on your usb device. So
322 instead of fat16 you are using for example fat32. Fix: use the appropriate
323 filesystem (fat16 for usb pens usually). The Bootsplash might be displayed, the
324 kernel loads but you very soon get the error message.
325
326 *Error message*:: Invalid operating system
327
328 *Reason*:: the partition layout is not ok. Very probably there's no primary
329   partition (/dev/sdX{1..4}) or none has the flag 'bootable' set.
330
331 *Error message*:: Boot error.
332
333 *Reason*:: Some BIOSses offer different modes for USB booting. The proper mode
334 to boot a USB stick is USB-HDD. If that doesn’t work or is not supported by your
335 system, you need to format your USB-Stick as USB-ZIP.  To do this, syslinux
336 contains an utility called mkdiskimage, which you can use to re-format your USB
337 stick in USB-ZIP format running 'mkdiskimage -4 /dev/sdX 1 64 32'. Please be
338 aware that this procedure will erase all data on your stick.  After executing
339 mkdiskimage just continue installing as usual (grml2usb ...  /dev/sdX4). Note
340 that this is not going to work for any device larger than 8 GB, since
341 mkdiskimage only supports 1024c 256h 63s. For a more detailed explanation, refer
342 to /usr/share/doc/syslinux-common/usbkey.txt.
343
344 *Error message*:: No operating system found.
345
346 *Reason*:: you forgot to set the boot-flag on the partition. Or there really isn't
347 any operating system at all. :)
348
349 *Error message*:: kernel-panic: unable to mount root-fs...
350
351 *Reason*:: Kernel boots but fails to find the root filesystem. The root=
352 argument in your kernel commandline is pointing to the wrong device. Adjust
353 root=..., consider using root=UUID=....
354
355 *Error message*::  Could not find kernel image: ...
356
357 *Reason*:: either a broken isolinux/syslinux version or a broken BIOS. Check out
358 whether the vendor provides a BIOS update or if using bootloader grub instead of
359 isolinux/syslinux fixes the problem.
360
361 [[faq]]
362 Frequently Asked Questions (FAQ)
363 --------------------------------
364
365 [[download]]
366 Where can I get grml2usb?
367 ~~~~~~~~~~~~~~~~~~~~~~~~~
368
369 grml2usb is available as Debian package via link:http://deb.grml.org/[the
370 grml-testing Debian repository].
371
372 If you do not want to (or can't) use the grml2usb Debian package you can either
373 use the grml2usb git tree running:
374
375   git clone git://git.grml.org/grml2usb.git
376   cd grml2usb
377   make -C mbr
378   sudo ./grml2usb ...
379
380 or download the provided
381 link:http://grml.org/grml2usb/grml2usb.tgz[http://grml.org/grml2usb/grml2usb.tgz]
382 (link:http://grml.org/grml2usb/grml2usb.tgz.md5.asc[gpg signed md5 hash]).
383 Download and extract the tarball and execute the provided script 'install.sh'.
384
385 [NOTE]
386 It is *NOT* enough to have just the grml2usb script itself without the according
387 files provided either via the Debian package, the git tree or the file
388 grml2usb.tgz.
389
390 [[grml2hd-vs-grml2usb]]
391 What's the difference between grml2hd and grml2usb?
392 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
393
394 grml2hd installs a running grml system to a harddisk. When rebooting the
395 harddisk installation can be modified and changes will find their way to the
396 harddisk immediately.  grml2usb copies just the compressed chroot filesystem
397 (being the squashfs file), some further informational files and a bootloader to
398 your device. This way you don't need as much space as with a harddisk
399 installation (just a USB device with >=ISO size) and when rebooting the system
400 your changes will be lost (unless you are using the persistency feature, see
401 link:http://wiki.grml.org/doku.php?id=persistency[http://wiki.grml.org/doku.php?id=persistency]).
402 Think of using a better CD version: booting is (usually) faster, you don't need
403 to burn a new CD when a new ISO version arrives (just install the new ISO using
404 grml2usb) and you can carry additional files on a writable medium with yourself.
405
406 [[dd]]
407 Why can't I just dd the ISO to a USB device?
408 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
409
410 Well, you can. :) Starting with grml 2009.10 the ISOs are dd-able straight out-of-the-box.
411
412 [IMPORTANT]
413 Note that ANY existing data on your USB device will be destroyed when
414 using the dd approach.
415
416 ///////////////////////////////////////////////////////////////////////////////////////////////////
417 Grab a recent grml ISO and use
418 link:http://syslinux.zytor.com/wiki/index.php/Doc/isolinux#HYBRID_CD-ROM.2FHARD_DISK_MODE[isohybrid
419 from the syslinux project]:
420
421   % isohybrid grml_2009.10.iso
422 ///////////////////////////////////////////////////////////////////////////////////////////////////
423
424 This allows you to dd the Grml ISO to your USB device (use for example
425 link:http://www.chrysocome.net/rawwrite[rawwrite] if you've just a Windows
426 system available) running:
427
428   % dd if=grml_2009.10.iso of=/dev/sdX
429
430 where /dev/sdX is your USB device. Of course this doesn't provide such a
431 flexible system like with grml2usb (no multi-ISO setup, no additional default
432 bootoptions,...) but it's a nice way to get a working USB boot setup if you
433 don't have grml2usb available.
434
435 [[grml2usb-vs-dd]]
436 What's the difference between grml2usb and just using dd?
437 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
438
439 grml2usb does not remove any data from your USB device and does not alter the
440 partition table at all. grml2usb provides multi-ISO support, support for adding
441 default bootoptions and selecting the bootloader (syslinux vs. grub) without
442 having to manually touch the ISO at all.
443
444 [[grml2iso]]
445 What's grml2iso?
446 ~~~~~~~~~~~~~~~~
447
448 grml2iso is a script which uses grml2usb to generate a multiboot ISO out of
449 several grml ISOs. See 'man grml2iso' for further details.
450
451 [[grml2usb-compat]]
452 grml2usb fails with "Fatal: file default.cfg could not be found."
453 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
454
455 If you are trying to install an older grml ISO (older than grml 2009.10) with a
456 recent version of grml2usb then you might notice:
457
458   Fatal: file default.cfg could not be found.
459   Note:  this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...
460          ... either use grml releases >=2009.10 or switch to an older grml2usb version.
461          Please visit http://grml.org/grml2usb/#grml2usb-compat for further information
462   Fatal: a critical error happend during execution (not a grml ISO?), giving up
463
464 Breaking the backward compatibility was necessary to avoid maintainability hell.
465 If you want to install older grml ISOs please use the grml2usb-compat script
466 which provides support for older releases.
467
468 [[menu-lst]]
469 Why is there a menu.lst and a grub.cfg inside /boot/grub/?
470 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
471
472 grml2usb supports grub version 1 (grub1) as well as grub version 2 (grub2).
473 Whereas grub1 uses menu.lst the new version grub2 needs grub.cfg.
474 Providing both files allows grml2usb to install grub on the target device
475 no matter which grub version is available on the host where grml2usb is
476 executed on.
477
478 [[stage1]]
479 grub-install fails with 'The file ../boot/grub/stage1 not read correctly"?!
480 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
481
482 Check whether the partition has the right partition type. For example do NOT use
483 FAT16 (partition type 6) when using a ext3 filesystem on the partition but
484 instead use the correct partition type ('83' - Linux) then.
485
486 [[grub-install-xfs_freeze]]
487 grub-install complains about /sbin/grub-install and/or xfs_freeze?!
488 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
489
490 The following message:
491
492   You shouldn't call /sbin/grub-install. Please call /usr/sbin/grub-install instead!
493   xfs_freeze: specified file ["/tmp/tmpqaBK6z/boot/grub"] is not on an XFS filesystem
494
495 This is "normal". grub-install sends those messages to stderr. To avoid hiding any
496 possible real error messages grml2usb doesn't ignore those messages.
497
498 [[device-map]]
499 grub-install complains about /boot/grub/device.map?!
500 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
501
502 The following message:
503
504   grub-probe: error: Cannot open `/boot/grub/device.map'
505
506 This is "normal" (at least with grub1). This isn't a problem, because the
507 device.map file will be generated on the target device anyway.
508
509 [[unary-operator]]
510 grub-install complains about a unary operator?!
511 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
512
513 The following message:
514
515   '/usr/sbin/grub-install: line 374: [: =: unary operator expected'
516
517 This is "normal". Just ignore it. (It usually doesn't appear
518 on the second invocation on the same device.)
519
520 [[unknown-filesystem]]
521 grub-install fails with grub-probe: error: unknown filesystem?!
522 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
523
524 The following message:
525
526   grub-probe: error: unknown filesystem
527   Auto-detection of a filesystem module failed.
528   Please specify the module with the option `--modules' explicitly.
529
530 usually means that the device partition table says something else than the
531 filesystem on the device. For example using FAT16 as filesystem type and
532 using FAT32 as filesystem on the partition will not work. Either set filesystem
533 type to FAT32 or format the partition using FAT16. It is essential that
534 device partition table and filesystem use the same filesystem type.
535
536 [[mbr-vs-pbr]]
537 grub-setup fails after Attempting to install GRUB to a partition instead of the MBR?!
538 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
539
540 The following message:
541
542   grub-setup: warn: Attempting to install GRUB to a partition instead of the MBR.  This is a BAD idea.
543   grub-setup: warn: Embedding is not possible.  GRUB can only be installed in this setup by using blocklists.  However, blocklists are UNRELIABLE and its use is discouraged.
544   grub-setup: error: Cannot read `/grub/core.img' correctly
545
546 appears when using grub2 versions older than 1.98 as those version introduced a
547 regression which avoids that grub is being installed into a partition (PBR,
548 Partition Boot Record) instead of MBR (Master Boot Record).
549
550 To work around this issue you can either 1) upgrade to grub versions >=1.98, 2)
551 install grub into the MBR (Master Boot Record) using the '--grub-mbr' option of
552 grml2usb or 3) switch to syslinux as bootmanager (just drop the '--grub'
553 option).
554
555 [[splash-xpm]]
556 I'm getting something like "Error: /usr/share/grml2usb/grub/splash.xpm.gz can not be read"!?
557 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
558
559 Looks like you've only the grml2usb script itself available. Please make sure
560 you've the grml2usb Debian package installed. The most resent stable version is
561 available via link:http://deb.grml.org/[the grml-testing Debian repository].  If
562 you do not have a Debian system please see section <<download,Where can I get
563 grml2usb?>> in this FAQ.
564
565 [[fat16]]
566 Why do I have to use a FAT16/FAT32 filesystem?
567 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
568
569 Syslinux (currently) does not support any other filesystems besides FAT16/FAT32
570 (though that's a sane default if you want to share your files with other
571 (operating) systems). If you want to use a different filesystem (like ext2/3)
572 use the bootloader grub instead using grml2usb's '--grub' option.
573
574 [NOTE]
575 FAT32 is supported since syslinux version 3.0.
576
577 [[cool-idea]]
578 I think I've got a really cool idea!
579 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
580
581 Great! Please check out
582 link:http://git.grml.org/?p=grml2usb.git;a=blob;f=TODO;hb=HEAD[the TODO file].
583 Feel free to <<author,report your wishes to the author>>. Patches highly
584 appreciated.
585
586 [[booting-from-usb]]
587 I've problems with booting from USB.
588 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
589
590 Check out <<troubleshooting,Troubleshooting and Pitfalls when booting>>.
591
592 [[found-a-bug]]
593 I've found a bug!
594 ~~~~~~~~~~~~~~~~~
595
596 Please <<author,report it to the author>>. Please provide usage examples and output
597 of your grml2usb commandline (consider using the "\--verbose" option).
598
599 [[usage-examples]]
600 Usage examples
601 --------------
602
603   # grml2usb /home/grml/grml_2009.10.iso /dev/sdX1
604
605 Install specified ISO on device /dev/sdX1.
606
607   # grml2usb /home/grml/grml_2009.10.iso /home/grml/grml_small_2009.10.iso /dev/sdX1
608
609 Install specified ISOs on device /dev/sdX1 for multibooting ISOs.
610
611   # grml2usb /live/image /dev/sdX1
612
613 Install currently running grml live system on device /dev/sdX1.
614
615   # grml2usb /live/image /home/grml/grml_2009.10.iso /dev/sdX1
616
617 Install currently running grml live system and the specified
618 ISO on device /dev/sdX1 for multibooting.
619
620   # grml2usb --fat16 /home/grml/grml_2009.10.iso /dev/sdX1
621
622 Install specified ISO on device /dev/sdX1 and format partition /dev/sdX1 with
623 FAT16 filesystem.
624
625   # grml2usb --grub --grub-mbr /home/grml/grml_2009.10.iso /dev/sdX1
626
627 Install specified ISO on device /dev/sdX1 and use grub as bootloader (instead of
628 syslinux being the default) and install a master boot record (MBR) to the MBR of
629 /dev/sdX.
630
631   # grml2usb-compat /home/grml/grml_2009.05.iso /dev/sdX1
632
633 Install older grml ISO on device /dev/sdX1.
634
635 ///////////////////////////////////////////////////////////////////////////////////////
636   # grml2usb --kernel=/boot/vmlinuz-2.6.28-grml --initrd=/boot/initrd.img-2.6.28-grml \
637              /home/grml/grml_2009.10.iso /dev/sdX1
638
639 Install specified ISO on device /dev/sdX1 but use given kernel and initrd
640 instead of the ones provided by the ISO.
641
642   # grml2usb --squashfs=/grml/grml-live/grml_cd/live/grml.squashfs \
643              /home/grml/grml_2009.10.iso /dev/sdX1
644
645 Install specified ISO on device /dev/sdX1 but use given squashfs
646 file instead of the one provided by the ISO.
647 ///////////////////////////////////////////////////////////////////////////////////////
648
649   # grml2usb --bootoptions="lang=de ssh=mysecret" grml_2009.10.iso /dev/sdX1
650   # grml2usb --bootoptions="lang=de" --bootoptions="ssh=mysecret" grml_2009.10.iso /dev/sdX1
651
652 Install specified ISO on device /dev/sdX1 and use "lang=de ssh=mysecret" as
653 default bootoptions.
654
655
656   # grml2usb --remove-bootoption="vga=791" --remove-bootoption="quiet" grml_2009.10.iso /dev/sdX1
657
658 Install specified ISO on device /dev/sdX1 remove vga=791 and quiet from existing bootoptions.
659
660   # grml2usb --bootoptions="persistent-path=%flavour_name" grml64_2010.04.iso grml_2010.04.iso /dev/sdX1
661
662 Install specified Isos on device /dev/sdx and add parameter persisten-path
663 to every menu entry. %flavour_name will be expanded to the flavour of the specific
664 iso, e.g. grml64 and grml.
665
666 [[ressources]]
667 Online Ressources
668 -----------------
669
670 Check out the link:http://grml.org/grml2usb/[grml2usb webpage] and the
671 link:http://git.grml.org/?p=grml2usb.git[grml2usb git repository].
672
673 [[bugs]]
674 Bugs
675 ----
676 Please report feedback, bugreports and wishes <<author,to the author>>.
677
678 [[author]]
679 Author
680 ------
681 Michael Prokop <mika@grml.org>
682
683 /////////////////////////////////////////////////////////////////
684 http://wiki.grml.org/doku.php?id=tips#multiboot_usb_pen
685 http://www.startx.ro/sugar/isotostick.sh
686 https://help.ubuntu.com/community/Installation/FromUSBStick
687 http://unetbootin.sourceforge.net/
688 http://www.tux.org/pub/people/kent-robotti/looplinux/rip/mkusb.sh
689 https://fedorahosted.org/liveusb-creator/
690 /////////////////////////////////////////////////////////////////