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') and
30 grub is being used as default bootloader. Avoid installation of the default MBR
31 using the '--skip-mbr' option or if you encounter any problems with the default
32 MBR consider using '--syslinux-mbr' instead.
38 The ISO[s] should be the path to one or multiple grml-ISOs and/or the path to
39 the currently running live-system (being /live/image).
41 The device either might be a device name like /dev/sdX1 or a directory. When
42 specifying a device name the device is mounted automatically. When specifying a
43 directory grml2usb is assuming that you did set up a bootloader on your own (or
44 don't need one) and a bootloader won't be installed automatically.
46 The following options are supported:
48 *\--bootoptions=...*::
50 Use specified bootoptions as default.
52 *\--bootloader-only*::
54 Do *not* copy files but instead just install a bootloader. Note that the boot
55 addons are copied to /boot/addons at this stage as well. If you want to skip
56 copying the boot addons consider using the --skip-addons option.
60 Copy files only but do *not* install a bootloader.
64 Avoid executing commands, instead show what would be executed.
65 Warning: please notice that the ISO has to be mounted anyway, otherwise
66 identifying the grml flavour would not be possible.
70 Format specified partition with FAT16.
71 **Important:** this will destroy any existing data on the specified partition!
75 Force any (possible dangerous) actions requiring manual interaction (like --fat16).
79 Install grub into MBR (Master Boot Record) instead of PBR (Partition Boot
80 Record). This option sadly had to be introduced because grub2 can not be
81 installed to partitions (PBR) instead of MBR anymore. Check out <<mbr-vs-pbr,the
82 'mbr-vs-pbr' section in the FAQ of this document>> for further details.
86 Display usage information and exit.
88 //////////////////////////////////////////////////////////////////////////
91 Install specified initrd instead of the default. You might want to specify
92 option *--kernel* as well. (Be aware when using multiboot setup.)
93 [Notice: not implemented yet.]
94 //////////////////////////////////////////////////////////////////////////
96 //////////////////////////////////////////////////////////////////////////
99 Install specified kernel instead of the default. You might want to specify
100 option *--initrd* as well. (Be aware when using multiboot setup.)
101 [Notice: not implemented yet.]
102 //////////////////////////////////////////////////////////////////////////
104 *\--lilo-binary=...*::
106 Use specified lilo executable for installing master boot record (MBR) when using
107 the '--syslinux-mbr' option. By default any system wide (from $PATH) lilo
108 executable is taken. If there can not be find any lilo executable the
109 statically compiled version of the grml2usb Debian package (see
110 /usr/share/grml2usb/lilo/lilo.static.[amd64|i386]) is taken.
114 Install master boot record (MBR) with integrated boot menu: interactively choose
115 the partition to boot from, with a timeout to load the default partition, or
116 boot from floppy. When NOT using the --mbr-menu option a MBR with LBA and large
117 disc support but without an integrated boot menu is installed (so it's not
118 visible at all but instead directly jumps to the bootloader - being grub or
119 syslinux). Note: This options is available only when using the default MBR and
120 won't have any effect if you're using the '--syslinux-mbr' option.
124 Do not output anything but just errors on console.
128 Do not install /boot/addons/ files (like dos, grub, memdisk,...).
130 *\--skip-grub-config*::
132 Skip generation of grub configuration files. By default the configuration
133 files for syslinux *and* grub will be written so you've a working configuration
134 file no matter whether you're using grub or syslinux as bootloader.
138 Do not touch/install the master boot record (MBR).
140 *\--skip-syslinux-config*::
142 Skip generation of syslinux configuration files. By default the configuration
143 files for syslinux *and* grub will be written so you've a working configuration
144 file no matter whether you're using grub or syslinux as bootloader.
148 This option is deprecated and is being left only for backwards compability
149 reasons. Syslinux is the default bootloader of grml2usb and therefore the
150 '--syslinux' option doesn't have any effects. If you do not want to use syslinux
151 as bootloader consider using the '--grub' option.
155 Install syslinux' master boot record (MBR, which is booting from the partition
156 with the "active" flag set) instead of the default one. If you encounter any
157 problems with the default MBR you can try using the syslinux MBR instead. If
158 that works for you please <<author,let us know>> so we can adjust our default
159 MBR accordingly. Note: When using the '--syslinux-mbr' option lilo is executed
160 before the MBR is installed so the according partitions are set active.
162 //////////////////////////////////////////////////////////////////////////
165 Install specified squashfs file instead of the default.
166 [Notice: not implemented yet.]
167 //////////////////////////////////////////////////////////////////////////
169 //////////////////////////////////////////////////////////////////////////
172 Uninstall grml ISO files.
173 [Notice: not implemented yet.]
174 //////////////////////////////////////////////////////////////////////////
178 Return version and exit.
188 Directory layout on usb device
189 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
193 | |-- allinone.img [grub - all in one image]
194 | |-- bsd4grml/ [MirBSD]
195 | |-- balder10.imz [FreeDOS]
196 | |-- memdisk [chainloading helper]
197 | |-- memtest [memtest86+]
200 | | |-- linux26 [Kernel]
201 | | |-- initrd.gz [initramfs]
203 | | |-- linux26 [Kernel]
204 | | |-- initrd.gz [initramfs]
206 | | |-- linux26 [...]
218 | |-- grml.png [splash screen for grub2]
219 | |-- grub.cfg [configuration file for grub2]
220 | |-- menu.lst [configuration file for grub1]
221 | |-- splash.xpm.gz [splash screen for grub1]
223 |-- boot.msg [boot splash for syslinux]
224 |-- f1 [screen when pressing f1]
225 |-- f2 [screen when pressing f2]
234 |-- logo.16 [graphical part of boot splash]
235 `-- syslinux.cfg [configuration file for syslinux]
238 |-- grml2usb.txt [not yet implemented]
239 |-- grml-cheatcodes.txt [list of bootoptions for grml]
240 |-- grml-version.txt [file containing information about grml-version]
241 |-- LICENSE.txt [license information]
242 |-- md5sums [md5sums of original ISO]
243 |-- README.txt [informational text]
244 `-- web/ [browser related files]
255 | |-- filesystem.module [module specifying which squashfs should be used for grml]
256 | `-- grml.squashfs [squashfs file for grml]
258 | |-- filesystem.module [module specifying which squashfs should be used for grml-medium]
259 | `-- grml-medium.squashfs [squashfs file for grml-medium]
261 | |-- filesystem.module [module specifying which squashfs should be used for grml-medium]
262 | `-- grml-small.squashfs [squashfs file for grml-small]
269 % git clone git://git.grml.org/grml2usb.git
272 Developers Debugging Hints
273 ~~~~~~~~~~~~~~~~~~~~~~~~~~
275 To play with grml2usb you can avoid using a real device via a loopback file
278 # dd if=/dev/zero of=~/loopback bs=1M count=100 # adjust size to your needs
279 # losetup /dev/loop1 ~/loopback
281 Then create according partitions either running for example:
283 # echo -en "n\np\n1\n\n\nt\n6\na\n1\n w\n" | fdisk /dev/loop1
287 # parted /dev/loop1 -s "mkpart primary fat16 0 -1s mkfs 1 fat16"
289 Finally create a filesystem and execute grml2usb as needed:
291 # mkfs.vfat /dev/loop1
292 # grml2usb --bootloader-only /grml/isos/grml-small_2009.05.iso /dev/loop1
294 [[performance-tracing]]
298 # blktrace -d /dev/sdX -o - | blkparse -i -
299 # grml2usb grml_2009.05.iso /dev/sdX1
302 Troubleshooting and Pitfalls when booting
303 -----------------------------------------
305 Here is a list of common error messages from BIOS/bootloader when trying to boot
308 ///////////////////////////////////////////////////////////
309 TODO: better list type for the error message / reason part?
310 See http://www.methods.co.nz/asciidoc/userguide.html
311 ///////////////////////////////////////////////////////////
314 *Error message*:: ran out of input data. System halted
316 *Reason*:: Everything OK, except for the filesystem used on your usb device. So
317 instead of fat16 you are using for example fat32. Fix: use the appropriate
318 filesystem (fat16 for usb pens usually). The Bootsplash might be displayed, the
319 kernel loads but you very soon get the error message.
321 *Error message*:: Invalid operating system
323 *Reason*:: the partition layout is not ok. Very probably there's no primary
324 partition (/dev/sdX{1..4}) or none has the flag 'bootable' set.
326 *Error message*:: No operating system found.
328 *Reason*:: you forgot to set the boot-flag on the partition. Or there really isn't
329 any operating system at all. :)
331 *Error message*:: kernel-panic: unable to mount root-fs...
333 *Reason*:: Kernel boots but fails to find the root filesystem. The root=
334 argument in your kernel commandline is pointing to the wrong device. Adjust
335 root=..., consider using root=UUID=....
337 *Error message*:: Could not find kernel image: ...
339 *Reason*:: either a broken isolinux/syslinux version or a broken BIOS. Check out
340 whether the vendor provides a BIOS update or if using bootloader grub instead of
341 isolinux/syslinux fixes the problem.
344 Frequently Asked Questions (FAQ)
345 --------------------------------
348 Where can I get grml2usb?
349 ~~~~~~~~~~~~~~~~~~~~~~~~~
351 grml2usb is available as Debian package via link:http://deb.grml.org/[the
352 grml-testing Debian repository].
354 If you do not want to (or can't) use the grml2usb Debian package you can either
355 use the grml2usb git tree running:
357 git clone git://git.grml.org/grml2usb.git
362 or download the provided
363 link:http://grml.org/grml2usb/grml2usb.tgz[http://grml.org/grml2usb/grml2usb.tgz]
364 (link:http://grml.org/grml2usb/grml2usb.tgz.md5.asc[gpg signed md5 hash]).
365 Download and extract the tarball and execute the provided script 'install.sh'.
368 It is *NOT* enough to have just the grml2usb script itself without the according
369 files provided either via the Debian package, the git tree or the file
372 [[grml2hd-vs-grml2usb]]
373 What's the difference between grml2hd and grml2usb?
374 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
376 grml2hd installs a running grml system to a harddisk. When rebooting the
377 harddisk installation can be modified and changes will find their way to the
378 harddisk immediately. grml2usb copies just the compressed chroot filesystem
379 (being the squashfs file), some further informational files and a bootloader to
380 your device. This way you don't need as much space as with a harddisk
381 installation (just a USB device with >=ISO size) and when rebooting the system
382 your changes will be lost (unless you are using the persistency feature, see
383 link:http://wiki.grml.org/doku.php?id=persistency[http://wiki.grml.org/doku.php?id=persistency]).
384 Think of using a better CD version: booting is (usually) faster, you don't need
385 to burn a new CD when a new ISO version arrives (just install the new ISO using
386 grml2usb) and you can carry additional files on a writable medium with yourself.
389 Why can't I just dd the ISO to a USB device?
390 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
395 Note that ANY existing data on your USB device will be destroyed when
396 using the dd approach.
398 Grab a recent grml ISO and use
399 link:http://syslinux.zytor.com/wiki/index.php/Doc/isolinux#HYBRID_CD-ROM.2FHARD_DISK_MODE[isohybrid
400 from the syslinux project]:
402 % isohybrid grml_2009.05.iso
404 This allows you to dd the grml ISO to your USB device (use for example
405 link:http://www.chrysocome.net/rawwrite[rawwrite] if you've just a Windows
406 system available) running:
408 % dd if=grml_2009.05.iso of=/dev/sdX
410 where /dev/sdX is your USB device.
413 Upcoming stable versions of grml will provide dd-able ISOs straight
414 out-of-the-box (and current link:http://daily.grml.org/[daily snapshots] already
415 do) using a so called manifold boot method.
418 What's the difference between grml2usb and just using dd?
419 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
421 grml2usb does not remove any data from your USB device and does not alter the
422 partition table at all. grml2usb provides multi-ISO support, support for adding
423 default bootoptions and selecting the bootloader (grub vs. syslinux) without
424 having to manually touch the ISO at all.
430 grml2iso is a script which uses grml2usb to generate a multiboot ISO out of
431 several grml ISOs. See 'man grml2iso' for further details.
434 Why is there a menu.lst and a grub.cfg inside /boot/grub/?
435 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
437 grml2usb supports grub version 1 (grub1) as well as grub version 2 (grub2).
438 Whereas grub1 uses menu.lst the new version grub2 needs grub.cfg.
439 Providing both files allows grml2usb to install grub on the target device
440 no matter which grub version is available on the host where grml2usb is
444 grub-install fails with 'The file ../boot/grub/stage1 not read correctly"?!
445 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
447 Check whether the partition has the right partition type. For example do NOT use
448 FAT16 (partition type 6) when using a ext3 filesystem on the partition but
449 instead use the correct partition type ('83' - Linux) then.
451 [[grub-install-xfs_freeze]]
452 grub-install complains about /sbin/grub-install and/or xfs_freeze?!
453 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
455 The following message:
457 You shouldn't call /sbin/grub-install. Please call /usr/sbin/grub-install instead!
458 xfs_freeze: specified file ["/tmp/tmpqaBK6z/boot/grub"] is not on an XFS filesystem
460 This is "normal". grub-install sends those messages to stderr. To avoid hiding any
461 possible real error messages grml2usb doesn't ignore those messages.
464 grub-install complains about /boot/grub/device.map?!
465 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
467 The following message:
469 grub-probe: error: Cannot open `/boot/grub/device.map'
471 This is "normal" (at least with grub1). This isn't a problem, because the
472 device.map file will be generated on the target device anyway.
475 grub-install complains about a unary operator?!
476 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
478 The following message:
480 '/usr/sbin/grub-install: line 374: [: =: unary operator expected'
482 This is "normal". Just ignore it. (It usually doesn't appear
483 on the second invocation on the same device.)
485 [[unknown-filesystem]]
486 grub-install fails with grub-probe: error: unknown filesystem?!
487 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
489 The following message:
491 grub-probe: error: unknown filesystem
492 Auto-detection of a filesystem module failed.
493 Please specify the module with the option `--modules' explicitly.
495 usually means that the device partition table says something else than the
496 filesystem on the device. For example using FAT16 as filesystem type and
497 using FAT32 as filesystem on the partition will not work. Either set filesystem
498 type to FAT32 or format the partition using FAT16. It is essential that
499 device partition table and filesystem use the same filesystem type.
502 grub-setup fails after Attempting to install GRUB to a partition instead of the MBR?!
503 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
505 The following message:
507 grub-setup: warn: Attempting to install GRUB to a partition instead of the MBR. This is a BAD idea.
508 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.
509 grub-setup: error: Cannot read `/grub/core.img' correctly
511 appears because recent grub2 versions sadly introduced a regression which avoids
512 that grub is being installed into a partition (PBR, Partition Boot Record)
513 instead of MBR (Master Boot Record).
515 To work around this issue you can install grub into the MBR (Master Boot Record)
516 using the '--grub-mbr' option of grml2usb or switch to syslinux as bootmanager
517 (just drop the '--grub' option).
519 To fix this issue manually you can also execute (adjust '/dev/sdX' to your
522 mount /dev/sdX1 /mnt/test
523 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/FAT32 filesystem?
537 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
539 Syslinux (currently) does not support any other filesystems besides FAT16/FAT32
540 (though that's a sane default if you want to share your files with other
541 (operating) systems). If you want to use a different filesystem (like ext2/3)
542 use the bootloader grub instead using grml2usb's '--grub' option.
545 FAT32 is supported since syslinux version 3.0.
548 I think I've got a really cool idea!
549 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
551 Great! Please check out
552 link:http://git.grml.org/?p=grml2usb.git;a=blob;f=TODO;hb=HEAD[the TODO file].
553 Feel free to <<author,report your wishes to the author>>. Patches highly
557 I've problems with booting from USB.
558 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
560 Check out <<troubleshooting,Troubleshooting and Pitfalls when booting>>.
566 Please <<author,report it to the author>>. Please provide usage examples and output
567 of your grml2usb commandline (consider using the "\--verbose" option).
573 # grml2usb /home/grml/grml_2009.05.iso /dev/sdX1
575 Install specified ISO on device /dev/sdX1.
577 # grml2usb /home/grml/grml_2009.05.iso /home/grml/grml_small_2009.05.iso /dev/sdX1
579 Install specified ISOs on device /dev/sdX1 for multibooting ISOs.
580 Note: boot "grml" as usual, for booting grml-small use "grml-small on the
581 bootprompt, for grml64 use "grml64" and so on... The *first* specified ISO is
582 the one being the default (when just pressing enter or waiting until the timeout
585 # grml2usb /live/image /dev/sdX1
587 Install currently running grml live system on device /dev/sdX1.
589 # grml2usb /live/image /home/grml/grml_2009.05.iso /dev/sdX1
591 Install currently running grml live system and the specified
592 ISO on device /dev/sdX1 for multibooting.
594 # grml2usb --fat16 /home/grml/grml_2009.05.iso /dev/sdX1
596 Install specified ISO on device /dev/sdX1 and format partition /dev/sdX1 with
599 # grml2usb --grub --grub-mbr /home/grml/grml_2009.05.iso /dev/sdX1
601 Install specified ISO on device /dev/sdX1 and use grub as bootloader (instead of
602 syslinux being the default) and install a master boot record (MBR) to the MBR of
605 ///////////////////////////////////////////////////////////////////////////////////////
606 # grml2usb --kernel=/boot/vmlinuz-2.6.28-grml --initrd=/boot/initrd.img-2.6.28-grml \
607 /home/grml/grml_2009.05.iso /dev/sdX1
609 Install specified ISO on device /dev/sdX1 but use given kernel and initrd
610 instead of the ones provided by the ISO.
612 # grml2usb --squashfs=/grml/grml-live/grml_cd/live/grml.squashfs \
613 /home/grml/grml_2009.05.iso /dev/sdX1
615 Install specified ISO on device /dev/sdX1 but use given squashfs
616 file instead of the one provided by the ISO.
617 ///////////////////////////////////////////////////////////////////////////////////////
619 # grml2usb --bootoptions="lang=de ssh=mysecret" grml_2009.05.iso /dev/sdX1
621 Install specified ISO on device /dev/sdX1 and use "lang=de ssh=mysecret" as
628 Check out the link:http://grml.org/grml2usb/[grml2usb webpage] and the
629 link:http://git.grml.org/?p=grml2usb.git[grml2usb git repository].
634 Please report feedback, bugreports and wishes <<author,to the author>>.
639 Michael Prokop <mika@grml.org>
641 /////////////////////////////////////////////////////////////////
642 http://wiki.grml.org/doku.php?id=tips#multiboot_usb_pen
643 http://www.startx.ro/sugar/isotostick.sh
644 https://help.ubuntu.com/community/Installation/FromUSBStick
645 http://unetbootin.sourceforge.net/
646 http://www.tux.org/pub/people/kent-robotti/looplinux/rip/mkusb.sh
647 https://fedorahosted.org/liveusb-creator/
648 /////////////////////////////////////////////////////////////////