6 grml2usb - install grml ISO(s) on usb device for booting
10 grml2usb [ options ] <ISO[s]> <device>
12 *******************************************************************************
13 Important! The grml team does not take responsibility for loss of any data!
14 *******************************************************************************
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).
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')
30 and grub is being used as default bootloader. Avoid installation of the
31 default MBR using the --skip-mbr option or if you encounter any problems
32 with the default MBR consider using --syslinux-mbr instead. If bootloader
33 grub doesn't work for you check out the --syslinux option.
39 The ISO[s] should be the path to one or multiple grml-ISOs and/or the path to
40 the currently running live-system (being /live/image).
42 The device either might be a device name like /dev/sdX1 or a directory. When
43 specifying a device name the device is mounted automatically. When specifying a
44 directory grml2usb is assuming that you did set up a bootloader on your own (or
45 don't need one) and a bootloader won't be installed automatically.
47 The following options are supported:
49 *\--bootoptions=...*::
51 Use specified bootoptions as default.
53 *\--bootloader-only*::
55 Do *not* copy files but instead just install a bootloader. Note that the boot
56 addons are copied to /boot/addons at this stage as well. If you want to skip
57 copying the boot addons consider using the --skip-addons option.
61 Copy files only but do *not* install a bootloader.
65 Avoid executing commands, instead show what would be executed.
66 Warning: please notice that the ISO has to be mounted anyway, otherwise
67 identifying the grml flavour would not be possible.
71 Format specified partition with FAT16.
72 **Important:** this will destroy any existing data on the specified partition!
76 Force any (possible dangerous) actions requiring manual interaction (like --fat16).
80 Install grub into MBR (Master Boot Record) instead of PBR (Partition Boot
81 Record). This option sadly had to be introduced because grub2 can not be
82 installed to partitions (PBR) instead of MBR anymore. Check out <<mbr-vs-pbr,the
83 'mbr-vs-pbr' section in the FAQ of this document>> for further details.
87 Display usage information and exit.
89 //////////////////////////////////////////////////////////////////////////
92 Install specified initrd instead of the default. You might want to specify
93 option *--kernel* as well. (Be aware when using multiboot setup.)
94 [Notice: not implemented yet.]
95 //////////////////////////////////////////////////////////////////////////
97 //////////////////////////////////////////////////////////////////////////
100 Install specified kernel instead of the default. You might want to specify
101 option *--initrd* as well. (Be aware when using multiboot setup.)
102 [Notice: not implemented yet.]
103 //////////////////////////////////////////////////////////////////////////
105 *\--lilo-binary=...*::
107 Use specified lilo executable for installing master boot record (MBR) when using
108 the --syslinux-mbr option. By default any system wide (from $PATH) lilo
109 executable is taken. If there can not be find any lilo executable the
110 statically compiled version of the grml2usb Debian package (see
111 /usr/share/grml2usb/lilo/lilo.static.[amd64|i386]) is taken.
115 Install master boot record (MBR) with integrated boot menu: interactively choose
116 the partition to boot from, with a timeout to load the default partition, or
117 boot from floppy. When NOT using the --mbr-menu option a MBR with LBA and large
118 disc support but without an integrated boot menu is installed (so it's not
119 visible at all but instead directly jumps to the bootloader - being grub or
120 syslinux). Note: This options is available only when using the default MBR and
121 won't have any effect if you're using the --syslinux-mbr option.
125 Do not output anything but just errors on console.
129 Do not install /boot/addons/ files (like dos, grub, memdisk,...).
131 *\--skip-grub-config*::
133 Skip generation of grub configuration files. By default the configuration
134 files for syslinux *and* grub will be written so you've a working configuration
135 file no matter whether you're using grub or syslinux as bootloader.
139 Do not touch/install the master boot record (MBR).
141 *\--skip-syslinux-config*::
143 Skip generation of syslinux configuration files. By default the configuration
144 files for syslinux *and* grub will be written so you've a working configuration
145 file no matter whether you're using grub or syslinux as bootloader.
149 Install syslinux bootloader instead of the default one (being grub).
153 Install syslinux' master boot record (MBR, which is booting from the partition
154 with the "active" flag set) instead of the default one. If you encounter any
155 problems with the default MBR you can try using the syslinux MBR instead. If
156 that works for you please <<author,let us know>> so we can adjust our default
157 MBR accordingly. Note: When using the --syslinux-mbr option lilo is executed
158 before the MBR is installed so the according partitions are set active.
160 //////////////////////////////////////////////////////////////////////////
163 Install specified squashfs file instead of the default.
164 [Notice: not implemented yet.]
165 //////////////////////////////////////////////////////////////////////////
167 //////////////////////////////////////////////////////////////////////////
170 Uninstall grml ISO files.
171 [Notice: not implemented yet.]
172 //////////////////////////////////////////////////////////////////////////
176 Return version and exit.
186 Directory layout on usb device
187 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
191 | |-- allinone.img [grub - all in one image]
192 | |-- bsd4grml/ [MirBSD]
193 | |-- balder10.imz [FreeDOS]
194 | |-- memdisk [chainloading helper]
195 | |-- memtest [memtest86+]
198 | | |-- linux26 [Kernel]
199 | | |-- initrd.gz [initramfs]
201 | | |-- linux26 [Kernel]
202 | | |-- initrd.gz [initramfs]
204 | | |-- linux26 [...]
216 | |-- grml.png [splash screen for grub2]
217 | |-- grub.cfg [configuration file for grub2]
218 | |-- menu.lst [configuration file for grub1]
219 | |-- splash.xpm.gz [splash screen for grub1]
221 |-- boot.msg [boot splash for syslinux]
222 |-- f1 [screen when pressing f1]
223 |-- f2 [screen when pressing f2]
232 |-- logo.16 [graphical part of boot splash]
233 `-- syslinux.cfg [configuration file for syslinux]
236 |-- grml2usb.txt [not yet implemented]
237 |-- grml-cheatcodes.txt [list of bootoptions for grml]
238 |-- grml-version.txt [file containing information about grml-version]
239 |-- LICENSE.txt [license information]
240 |-- md5sums [md5sums of original ISO]
241 |-- README.txt [informational text]
242 `-- web/ [browser related files]
253 | |-- filesystem.module [module specifying which squashfs should be used for grml]
254 | `-- grml.squashfs [squashfs file for grml]
256 | |-- filesystem.module [module specifying which squashfs should be used for grml-medium]
257 | `-- grml-medium.squashfs [squashfs file for grml-medium]
259 | |-- filesystem.module [module specifying which squashfs should be used for grml-medium]
260 | `-- grml-small.squashfs [squashfs file for grml-small]
267 % git clone git://git.grml.org/grml2usb.git
270 Developers Debugging Hints
271 ~~~~~~~~~~~~~~~~~~~~~~~~~~
273 To play with grml2usb you can avoid using a real device via a loopback file
276 # dd if=/dev/zero of=~/loopback bs=1M count=100 # adjust size to your needs
277 # losetup /dev/loop1 ~/loopback
279 Then create according partitions either running for example:
281 # echo -en "n\np\n1\n\n\nt\n6\na\n1\n w\n" | fdisk /dev/loop1
285 # parted /dev/loop1 -s "mkpart primary fat16 0 -1s mkfs 1 fat16"
287 Finally create a filesystem and execute grml2usb as needed:
289 # mkfs.vfat /dev/loop1
290 # grml2usb --bootloader-only /grml/isos/grml-small_2009.05.iso /dev/loop1
292 [[performance-tracing]]
296 # blktrace -d /dev/sdX -o - | blkparse -i -
297 # grml2usb grml_2009.05.iso /dev/sdX1
300 Troubleshooting and Pitfalls when booting
301 -----------------------------------------
303 Here is a list of common error messages from BIOS/bootloader when trying to boot
306 ///////////////////////////////////////////////////////////
307 TODO: better list type for the error message / reason part?
308 See http://www.methods.co.nz/asciidoc/userguide.html
309 ///////////////////////////////////////////////////////////
312 *Error message*:: ran out of input data. System halted
314 *Reason*:: Everything OK, except for the filesystem used on your usb device. So
315 instead of fat16 you are using for example fat32. Fix: use the appropriate
316 filesystem (fat16 for usb pens usually). The Bootsplash might be displayed, the
317 kernel loads but you very soon get the error message.
319 *Error message*:: Invalid operating system
321 *Reason*:: the partition layout is not ok. Very probably there's no primary
322 partition (/dev/sdX{1..4}) or none has the flag 'bootable' set.
324 *Error message*:: No operating system found.
326 *Reason*:: you forgot to set the boot-flag on the partition. Or there really isn't
327 any operating system at all. :)
329 *Error message*:: kernel-panic: unable to mount root-fs...
331 *Reason*:: Kernel boots but fails to find the root filesystem. The root=
332 argument in your kernel commandline is pointing to the wrong device. Adjust
333 root=..., consider using root=UUID=....
335 *Error message*:: Could not find kernel image: ...
337 *Reason*:: either a broken isolinux/syslinux version or a broken BIOS. Check out
338 whether the vendor provides a BIOS update or if using bootloader grub instead of
339 isolinux/syslinux fixes the problem.
342 Frequently Asked Questions (FAQ)
343 --------------------------------
346 Where can I get grml2usb?
347 ~~~~~~~~~~~~~~~~~~~~~~~~~
349 grml2usb is available as Debian package via link:http://deb.grml.org/[the
350 grml-testing Debian repository].
352 If you do not want to (or can't) use the grml2usb Debian package you can either
353 use the grml2usb git tree running:
355 git clone git://git.grml.org/grml2usb.git
360 or download the provided
361 link:http://grml.org/grml2usb/grml2usb.tgz[http://grml.org/grml2usb/grml2usb.tgz]
362 (link:http://grml.org/grml2usb/grml2usb.tgz.md5.asc[gpg signed md5 hash]).
363 Download and extract the tarball and execute the provided script 'install.sh'.
366 It is *NOT* enough to have just the grml2usb script itself without the according
367 files provided either via the Debian package, the git tree or the file
370 [[grml2hd-vs-grml2usb]]
371 What's the difference between grml2hd and grml2usb?
372 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
374 grml2hd installs a running grml system to a harddisk. When rebooting the
375 harddisk installation can be modified and changes will find their way to the
376 harddisk immediately. grml2usb copies just the compressed chroot filesystem
377 (being the squashfs file), some further informational files and a bootloader to
378 your device. This way you don't need as much space as with a harddisk
379 installation (just a USB device with >=ISO size) and when rebooting the system
380 your changes will be lost (unless you are using the persistency feature, see
381 link:http://wiki.grml.org/doku.php?id=persistency[http://wiki.grml.org/doku.php?id=persistency]).
382 Think of using a better CD version: booting is (usually) faster, you don't need
383 to burn a new CD when a new ISO version arrives (just install the new ISO using
384 grml2usb) and you can carry additional files on a writable medium with yourself.
387 Why can't I just dd the ISO to a USB device?
388 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
393 Note that ANY existing data on your USB device will be destroyed when
394 using the dd approach.
396 Grab a recent grml ISO and use
397 link:http://syslinux.zytor.com/wiki/index.php/Doc/isolinux#HYBRID_CD-ROM.2FHARD_DISK_MODE[isohybrid
398 from the syslinux project]:
400 % isohybrid grml_2009.05.iso
402 This allows you to dd the grml ISO to your USB device (use for example
403 link:http://www.chrysocome.net/rawwrite[rawwrite] if you've just a Windows
404 system available) running:
406 % dd if=grml_2009.05.iso of=/dev/sdX
408 where /dev/sdX is your USB device.
411 Upcoming stable versions of grml will provide dd-able ISOs straight
412 out-of-the-box (and current link:http://daily.grml.org/[daily snapshots] already
413 do) using a so called manifold boot method.
416 What's the difference between grml2usb and just using dd?
417 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
419 grml2usb does not remove any data from your USB device and does not alter the
420 partition table at all. grml2usb provides multi-ISO support, support for adding
421 default bootoptions and selecting the bootloader (grub vs. syslinux) without
422 having to manually touch the ISO at all.
428 grml2iso is a script which uses grml2usb to generate a multiboot ISO out of
429 several grml ISOs. See 'man grml2iso' for further details.
432 Why is there a menu.lst and a grub.cfg inside /boot/grub/?
433 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
435 grml2usb supports grub version 1 (grub1) as well as grub version 2 (grub2).
436 Whereas grub1 uses menu.lst the new version grub2 needs grub.cfg.
437 Providing both files allows grml2usb to install grub on the target device
438 no matter which grub version is available on the host where grml2usb is
442 grub-install fails with 'The file ../boot/grub/stage1 not read correctly"?!
443 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
445 Check whether the partition has the right partition type. For example do NOT use
446 FAT16 (partition type 6) when using a ext3 filesystem on the partition but
447 instead use the correct partition type ('83' - Linux) then.
449 [[grub-install-xfs_freeze]]
450 grub-install complains about /sbin/grub-install and/or xfs_freeze?!
451 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
453 The following message:
455 You shouldn't call /sbin/grub-install. Please call /usr/sbin/grub-install instead!
456 xfs_freeze: specified file ["/tmp/tmpqaBK6z/boot/grub"] is not on an XFS filesystem
458 This is "normal". grub-install sends those messages to stderr. To avoid hiding any
459 possible real error messages grml2usb doesn't ignore those messages.
462 grub-install complains about /boot/grub/device.map?!
463 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
465 The following message:
467 grub-probe: error: Cannot open `/boot/grub/device.map'
469 This is "normal" (at least with grub1). This isn't a problem, because the
470 device.map file will be generated on the target device anyway.
473 grub-install complains about a unary operator?!
474 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
476 The following message:
478 '/usr/sbin/grub-install: line 374: [: =: unary operator expected'
480 This is "normal". Just ignore it. (It usually doesn't appear
481 on the second invocation on the same device.)
483 [[unknown-filesystem]]
484 grub-install fails with grub-probe: error: unknown filesystem?!
485 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
487 The following message:
489 grub-probe: error: unknown filesystem
490 Auto-detection of a filesystem module failed.
491 Please specify the module with the option `--modules' explicitly.
493 usually means that the device partition table says something else than the
494 filesystem on the device. For example using FAT16 as filesystem type and
495 using FAT32 as filesystem on the partition will not work. Either set filesystem
496 type to FAT32 or format the partition using FAT16. It is essential that
497 device partition table and filesystem use the same filesystem type.
500 grub-setup fails after Attempting to install GRUB to a partition instead of the MBR?!
501 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
503 The following message:
505 grub-setup: warn: Attempting to install GRUB to a partition instead of the MBR. This is a BAD idea.
506 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.
507 grub-setup: error: Cannot read `/grub/core.img' correctly
509 appears because recent grub2 versions sadly introduced a regression which avoids
510 that grub is being installed into a partition (PBR, Partition Boot Record)
511 instead of MBR (Master Boot Record).
513 To work around this issue you can install grub into the MBR (Master Boot Record)
514 using the '--grub-mbr' option of grml2usb or switch to syslinux as bootmanager
515 (using the '--syslinux' option).
517 To fix this issue manually you can also execute (adjust '/dev/sdX' to your
520 mount /dev/sdX1 /mnt/test
521 grub-install --force --recheck --no-floppy --root-directory=/mnt/test /dev/sdX
526 I'm getting something like "Error: /usr/share/grml2usb/grub/splash.xpm.gz can not be read"!?
527 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
529 Looks like you've only the grml2usb script itself available. Please make sure
530 you've the grml2usb Debian package installed. The most resent stable version is
531 available via link:http://deb.grml.org/[the grml-testing Debian repository]. If
532 you do not have a Debian system please see section <<download,Where can I get
533 grml2usb?>> in this FAQ.
536 Why do I have to use a FAT16 filesystem?
537 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
539 You have to use a FAT16 filesystem only if you consider using syslinux. Syslinux
540 (currently) does not support any other filesystems. If you want to use another
541 filesystem (like ext2/3) just don't use syslinux (drop the \--syslinux option)
542 but use the default bootloader (grub) instead.
545 I think I've got a really cool idea!
546 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
548 Great! Please check out
549 link:http://git.grml.org/?p=grml2usb.git;a=blob;f=TODO;hb=HEAD[the TODO file].
550 Feel free to <<author,report your wishes to the author>>. Patches highly
554 I've problems with booting from USB.
555 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
557 Check out <<troubleshooting,Troubleshooting and Pitfalls when booting>>.
563 Please <<author,report it to the author>>. Please provide usage examples and output
564 of your grml2usb commandline (consider using the "\--verbose" option).
570 # grml2usb /home/grml/grml_2009.05.iso /dev/sdX1
572 Install specified ISO on device /dev/sdX1.
574 # grml2usb /home/grml/grml_2009.05.iso /home/grml/grml_small_2009.05.iso /dev/sdX1
576 Install specified ISOs on device /dev/sdX1 for multibooting ISOs.
577 Note: boot "grml" as usual, for booting grml-small use "grml-small on the
578 bootprompt, for grml64 use "grml64" and so on... The *first* specified ISO is
579 the one being the default (when just pressing enter or waiting until the timeout
582 # grml2usb /live/image /dev/sdX1
584 Install currently running grml live system on device /dev/sdX1.
586 # grml2usb /live/image /home/grml/grml_2009.05.iso /dev/sdX1
588 Install currently running grml live system and the specified
589 ISO on device /dev/sdX1 for multibooting.
591 # grml2usb --fat16 /home/grml/grml_2009.05.iso /dev/sdX1
593 Install specified ISO on device /dev/sdX1 and format partition /dev/sdX1 with
596 # grml2usb --syslinux /home/grml/grml_2009.05.iso /dev/sdX1
598 Install specified ISO on device /dev/sdX1 and use syslinux as bootloader
599 (instead of grub being the default).
601 ///////////////////////////////////////////////////////////////////////////////////////
602 # grml2usb --kernel=/boot/vmlinuz-2.6.28-grml --initrd=/boot/initrd.img-2.6.28-grml \
603 /home/grml/grml_2009.05.iso /dev/sdX1
605 Install specified ISO on device /dev/sdX1 but use given kernel and initrd
606 instead of the ones provided by the ISO.
608 # grml2usb --squashfs=/grml/grml-live/grml_cd/live/grml.squashfs \
609 /home/grml/grml_2009.05.iso /dev/sdX1
611 Install specified ISO on device /dev/sdX1 but use given squashfs
612 file instead of the one provided by the ISO.
613 ///////////////////////////////////////////////////////////////////////////////////////
615 # grml2usb --bootoptions="lang=de ssh=mysecret" grml_2009.05.iso /dev/sdX1
617 Install specified ISO on device /dev/sdX1 and use "lang=de ssh=mysecret" as
624 Check out the link:http://grml.org/grml2usb/[grml2usb webpage] and the
625 link:http://git.grml.org/?p=grml2usb.git[grml2usb git repository].
630 Please report feedback, bugreports and wishes <<author,to the author>>.
635 Michael Prokop <mika@grml.org>
637 /////////////////////////////////////////////////////////////////
638 http://wiki.grml.org/doku.php?id=tips#multiboot_usb_pen
639 http://www.startx.ro/sugar/isotostick.sh
640 https://help.ubuntu.com/community/Installation/FromUSBStick
641 http://unetbootin.sourceforge.net/
642 http://www.tux.org/pub/people/kent-robotti/looplinux/rip/mkusb.sh
643 https://fedorahosted.org/liveusb-creator/
644 /////////////////////////////////////////////////////////////////