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 *\--remove-bootoption=...*::
132 Remove specified bootoption (could be a regex) from existing boot options. Use
133 multiple entries for removing different bootoptions at once.
135 *\--skip-grub-config*::
137 Skip generation of grub configuration files. By default the configuration
138 files for syslinux *and* grub will be written so you've a working configuration
139 file no matter whether you're using grub or syslinux as bootloader.
143 Do not touch/install the master boot record (MBR).
145 *\--skip-syslinux-config*::
147 Skip generation of syslinux 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.
153 This option is deprecated and is being left only for backwards compatibility
154 reasons. Syslinux is the default bootloader of grml2usb and therefore the
155 '--syslinux' option doesn't have any effects. If you do not want to use syslinux
156 as bootloader consider using the '--grub' option.
160 Install syslinux' master boot record (MBR, which is booting from the partition
161 with the "active" flag set) instead of the default one. If you encounter any
162 problems with the default MBR you can try using the syslinux MBR instead. If
163 that works for you please <<author,let us know>> so we can adjust our default
164 MBR accordingly. Note: When using the '--syslinux-mbr' option lilo is executed
165 before the MBR is installed so the according partitions are set active.
167 //////////////////////////////////////////////////////////////////////////
170 Install specified squashfs file instead of the default.
171 [Notice: not implemented yet.]
172 //////////////////////////////////////////////////////////////////////////
174 //////////////////////////////////////////////////////////////////////////
177 Uninstall grml ISO files.
178 [Notice: not implemented yet.]
179 //////////////////////////////////////////////////////////////////////////
183 Return version and exit.
193 Directory layout on usb device
194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198 | |-- allinone.img [grub - all in one image]
199 | |-- bsd4grml/ [MirBSD]
200 | |-- balder10.imz [FreeDOS]
201 | |-- memdisk [chainloading helper]
202 | |-- memtest [memtest86+]
205 | | |-- linux26 [Kernel]
206 | | |-- initrd.gz [initramfs]
208 | | |-- linux26 [Kernel]
209 | | |-- initrd.gz [initramfs]
211 | | |-- linux26 [...]
223 | |-- grml.png [graphical bootsplash background image for grub2]
224 | |-- grub.cfg [configuration file for grub2]
225 | |-- menu.lst [configuration file for grub1]
226 | |-- splash.xpm.gz [splash screen for grub1]
228 |-- grml.png [graphical bootsplash background image for syslinux]
229 |-- syslinux.cfg [main configuration file for syslinux]
230 `-- [....] [several further config files for syslinux]
233 |-- grml2usb.txt [not yet implemented]
234 |-- grml-cheatcodes.txt [list of bootoptions for grml]
235 |-- grml-version.txt [file containing information about grml-version]
236 |-- LICENSE.txt [license information]
237 |-- md5sums [md5sums of original ISO]
238 |-- README.txt [informational text]
239 `-- web/ [browser related files]
250 | |-- filesystem.module [module specifying which squashfs should be used for grml]
251 | `-- grml.squashfs [squashfs file for grml]
253 | |-- filesystem.module [module specifying which squashfs should be used for grml-medium]
254 | `-- grml-medium.squashfs [squashfs file for grml-medium]
256 | |-- filesystem.module [module specifying which squashfs should be used for grml-medium]
257 | `-- grml-small.squashfs [squashfs file for grml-small]
264 % git clone git://git.grml.org/grml2usb.git
267 Developers Debugging Hints
268 ~~~~~~~~~~~~~~~~~~~~~~~~~~
270 To play with grml2usb you can avoid using a real device via a loopback file
273 # dd if=/dev/zero of=~/loopback bs=1M count=100 # adjust size to your needs
274 # losetup /dev/loop1 ~/loopback
276 Then create according partitions either running for example:
278 # echo -en "n\np\n1\n\n\nt\n6\na\n1\n w\n" | fdisk /dev/loop1
282 # parted /dev/loop1 -s "mkpart primary fat16 0 -1s mkfs 1 fat16"
284 Finally create a filesystem and execute grml2usb as needed:
286 # mkfs.vfat /dev/loop1
287 # grml2usb --bootloader-only /grml/isos/grml-small_2009.05.iso /dev/loop1
289 [[performance-tracing]]
293 # blktrace -d /dev/sdX -o - | blkparse -i -
294 # grml2usb grml_2009.05.iso /dev/sdX1
297 Troubleshooting and Pitfalls when booting
298 -----------------------------------------
300 Here is a list of common error messages from BIOS/bootloader when trying to boot
303 ///////////////////////////////////////////////////////////
304 TODO: better list type for the error message / reason part?
305 See http://www.methods.co.nz/asciidoc/userguide.html
306 ///////////////////////////////////////////////////////////
309 *Error message*:: ran out of input data. System halted
311 *Reason*:: Everything OK, except for the filesystem used on your usb device. So
312 instead of fat16 you are using for example fat32. Fix: use the appropriate
313 filesystem (fat16 for usb pens usually). The Bootsplash might be displayed, the
314 kernel loads but you very soon get the error message.
316 *Error message*:: Invalid operating system
318 *Reason*:: the partition layout is not ok. Very probably there's no primary
319 partition (/dev/sdX{1..4}) or none has the flag 'bootable' set.
321 *Error message*:: No operating system found.
323 *Reason*:: you forgot to set the boot-flag on the partition. Or there really isn't
324 any operating system at all. :)
326 *Error message*:: kernel-panic: unable to mount root-fs...
328 *Reason*:: Kernel boots but fails to find the root filesystem. The root=
329 argument in your kernel commandline is pointing to the wrong device. Adjust
330 root=..., consider using root=UUID=....
332 *Error message*:: Could not find kernel image: ...
334 *Reason*:: either a broken isolinux/syslinux version or a broken BIOS. Check out
335 whether the vendor provides a BIOS update or if using bootloader grub instead of
336 isolinux/syslinux fixes the problem.
339 Frequently Asked Questions (FAQ)
340 --------------------------------
343 Where can I get grml2usb?
344 ~~~~~~~~~~~~~~~~~~~~~~~~~
346 grml2usb is available as Debian package via link:http://deb.grml.org/[the
347 grml-testing Debian repository].
349 If you do not want to (or can't) use the grml2usb Debian package you can either
350 use the grml2usb git tree running:
352 git clone git://git.grml.org/grml2usb.git
357 or download the provided
358 link:http://grml.org/grml2usb/grml2usb.tgz[http://grml.org/grml2usb/grml2usb.tgz]
359 (link:http://grml.org/grml2usb/grml2usb.tgz.md5.asc[gpg signed md5 hash]).
360 Download and extract the tarball and execute the provided script 'install.sh'.
363 It is *NOT* enough to have just the grml2usb script itself without the according
364 files provided either via the Debian package, the git tree or the file
367 [[grml2hd-vs-grml2usb]]
368 What's the difference between grml2hd and grml2usb?
369 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
371 grml2hd installs a running grml system to a harddisk. When rebooting the
372 harddisk installation can be modified and changes will find their way to the
373 harddisk immediately. grml2usb copies just the compressed chroot filesystem
374 (being the squashfs file), some further informational files and a bootloader to
375 your device. This way you don't need as much space as with a harddisk
376 installation (just a USB device with >=ISO size) and when rebooting the system
377 your changes will be lost (unless you are using the persistency feature, see
378 link:http://wiki.grml.org/doku.php?id=persistency[http://wiki.grml.org/doku.php?id=persistency]).
379 Think of using a better CD version: booting is (usually) faster, you don't need
380 to burn a new CD when a new ISO version arrives (just install the new ISO using
381 grml2usb) and you can carry additional files on a writable medium with yourself.
384 Why can't I just dd the ISO to a USB device?
385 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
387 Well, you can. :) Starting with grml 2009.10 the ISOs are dd-able straight out-of-the-box.
390 Note that ANY existing data on your USB device will be destroyed when
391 using the dd approach.
393 ///////////////////////////////////////////////////////////////////////////////////////////////////
394 Grab a recent grml ISO and use
395 link:http://syslinux.zytor.com/wiki/index.php/Doc/isolinux#HYBRID_CD-ROM.2FHARD_DISK_MODE[isohybrid
396 from the syslinux project]:
398 % isohybrid grml_2009.05.iso
399 ///////////////////////////////////////////////////////////////////////////////////////////////////
401 This allows you to dd the Grml ISO to your USB device (use for example
402 link:http://www.chrysocome.net/rawwrite[rawwrite] if you've just a Windows
403 system available) running:
405 % dd if=grml_2009.10.iso of=/dev/sdX
407 where /dev/sdX is your USB device. Of course this doesn't provide such a
408 flexible system like with grml2usb (no multi-ISO setup, no additional default
409 bootoptions,...) but it's a nice way to get a working USB boot setup if you
410 don't have grml2usb available.
413 What's the difference between grml2usb and just using dd?
414 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
416 grml2usb does not remove any data from your USB device and does not alter the
417 partition table at all. grml2usb provides multi-ISO support, support for adding
418 default bootoptions and selecting the bootloader (syslinux vs. grub) without
419 having to manually touch the ISO at all.
425 grml2iso is a script which uses grml2usb to generate a multiboot ISO out of
426 several grml ISOs. See 'man grml2iso' for further details.
429 grml2usb fails with "Fatal: file default.cfg could not be found."
430 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
432 If you are trying to install an older grml ISO (older than grml 2009.10) with a
433 recent version of grml2usb then you might notice:
435 Fatal: file default.cfg could not be found.
436 Note: this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...
437 ... either use grml releases >=2009.10 or switch to an older grml2usb version.
438 Please visit http://grml.org/grml2usb/#grml2usb-compat for further information
439 Fatal: a critical error happend during execution (not a grml ISO?), giving up
441 Breaking the backward compatibility was necessary to avoid maintainability hell.
442 If you want to install older grml ISOs please grab the grml2usb-compat Debian
443 package which provides support for older releases or the
444 link:http://grml.org/grml2usb/grml2usb-compat.tgz[grml2usb-compat tarball]
445 (link:http://grml.org/grml2usb/grml2usb-compat.tgz.md5.asc[gpg signature/md5]).
448 Why is there a menu.lst and a grub.cfg inside /boot/grub/?
449 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
451 grml2usb supports grub version 1 (grub1) as well as grub version 2 (grub2).
452 Whereas grub1 uses menu.lst the new version grub2 needs grub.cfg.
453 Providing both files allows grml2usb to install grub on the target device
454 no matter which grub version is available on the host where grml2usb is
458 grub-install fails with 'The file ../boot/grub/stage1 not read correctly"?!
459 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
461 Check whether the partition has the right partition type. For example do NOT use
462 FAT16 (partition type 6) when using a ext3 filesystem on the partition but
463 instead use the correct partition type ('83' - Linux) then.
465 [[grub-install-xfs_freeze]]
466 grub-install complains about /sbin/grub-install and/or xfs_freeze?!
467 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
469 The following message:
471 You shouldn't call /sbin/grub-install. Please call /usr/sbin/grub-install instead!
472 xfs_freeze: specified file ["/tmp/tmpqaBK6z/boot/grub"] is not on an XFS filesystem
474 This is "normal". grub-install sends those messages to stderr. To avoid hiding any
475 possible real error messages grml2usb doesn't ignore those messages.
478 grub-install complains about /boot/grub/device.map?!
479 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
481 The following message:
483 grub-probe: error: Cannot open `/boot/grub/device.map'
485 This is "normal" (at least with grub1). This isn't a problem, because the
486 device.map file will be generated on the target device anyway.
489 grub-install complains about a unary operator?!
490 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
492 The following message:
494 '/usr/sbin/grub-install: line 374: [: =: unary operator expected'
496 This is "normal". Just ignore it. (It usually doesn't appear
497 on the second invocation on the same device.)
499 [[unknown-filesystem]]
500 grub-install fails with grub-probe: error: unknown filesystem?!
501 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
503 The following message:
505 grub-probe: error: unknown filesystem
506 Auto-detection of a filesystem module failed.
507 Please specify the module with the option `--modules' explicitly.
509 usually means that the device partition table says something else than the
510 filesystem on the device. For example using FAT16 as filesystem type and
511 using FAT32 as filesystem on the partition will not work. Either set filesystem
512 type to FAT32 or format the partition using FAT16. It is essential that
513 device partition table and filesystem use the same filesystem type.
516 grub-setup fails after Attempting to install GRUB to a partition instead of the MBR?!
517 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
519 The following message:
521 grub-setup: warn: Attempting to install GRUB to a partition instead of the MBR. This is a BAD idea.
522 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.
523 grub-setup: error: Cannot read `/grub/core.img' correctly
525 appears because recent grub2 versions sadly introduced a regression which avoids
526 that grub is being installed into a partition (PBR, Partition Boot Record)
527 instead of MBR (Master Boot Record).
529 To work around this issue you can install grub into the MBR (Master Boot Record)
530 using the '--grub-mbr' option of grml2usb or switch to syslinux as bootmanager
531 (just drop the '--grub' option).
533 To fix this issue manually you can also execute (adjust '/dev/sdX' to your
536 mount /dev/sdX1 /mnt/test
537 grub-install --force --recheck --no-floppy --root-directory=/mnt/test /dev/sdX
540 I'm getting something like "Error: /usr/share/grml2usb/grub/splash.xpm.gz can not be read"!?
541 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
543 Looks like you've only the grml2usb script itself available. Please make sure
544 you've the grml2usb Debian package installed. The most resent stable version is
545 available via link:http://deb.grml.org/[the grml-testing Debian repository]. If
546 you do not have a Debian system please see section <<download,Where can I get
547 grml2usb?>> in this FAQ.
550 Why do I have to use a FAT16/FAT32 filesystem?
551 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
553 Syslinux (currently) does not support any other filesystems besides FAT16/FAT32
554 (though that's a sane default if you want to share your files with other
555 (operating) systems). If you want to use a different filesystem (like ext2/3)
556 use the bootloader grub instead using grml2usb's '--grub' option.
559 FAT32 is supported since syslinux version 3.0.
562 I think I've got a really cool idea!
563 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
565 Great! Please check out
566 link:http://git.grml.org/?p=grml2usb.git;a=blob;f=TODO;hb=HEAD[the TODO file].
567 Feel free to <<author,report your wishes to the author>>. Patches highly
571 I've problems with booting from USB.
572 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
574 Check out <<troubleshooting,Troubleshooting and Pitfalls when booting>>.
580 Please <<author,report it to the author>>. Please provide usage examples and output
581 of your grml2usb commandline (consider using the "\--verbose" option).
587 # grml2usb /home/grml/grml_2009.05.iso /dev/sdX1
589 Install specified ISO on device /dev/sdX1.
591 # grml2usb /home/grml/grml_2009.05.iso /home/grml/grml_small_2009.05.iso /dev/sdX1
593 Install specified ISOs on device /dev/sdX1 for multibooting ISOs.
594 Note: boot "grml" as usual, for booting grml-small use "grml-small on the
595 bootprompt, for grml64 use "grml64" and so on... The *first* specified ISO is
596 the one being the default (when just pressing enter or waiting until the timeout
599 # grml2usb /live/image /dev/sdX1
601 Install currently running grml live system on device /dev/sdX1.
603 # grml2usb /live/image /home/grml/grml_2009.05.iso /dev/sdX1
605 Install currently running grml live system and the specified
606 ISO on device /dev/sdX1 for multibooting.
608 # grml2usb --fat16 /home/grml/grml_2009.05.iso /dev/sdX1
610 Install specified ISO on device /dev/sdX1 and format partition /dev/sdX1 with
613 # grml2usb --grub --grub-mbr /home/grml/grml_2009.05.iso /dev/sdX1
615 Install specified ISO on device /dev/sdX1 and use grub as bootloader (instead of
616 syslinux being the default) and install a master boot record (MBR) to the MBR of
619 ///////////////////////////////////////////////////////////////////////////////////////
620 # grml2usb --kernel=/boot/vmlinuz-2.6.28-grml --initrd=/boot/initrd.img-2.6.28-grml \
621 /home/grml/grml_2009.05.iso /dev/sdX1
623 Install specified ISO on device /dev/sdX1 but use given kernel and initrd
624 instead of the ones provided by the ISO.
626 # grml2usb --squashfs=/grml/grml-live/grml_cd/live/grml.squashfs \
627 /home/grml/grml_2009.05.iso /dev/sdX1
629 Install specified ISO on device /dev/sdX1 but use given squashfs
630 file instead of the one provided by the ISO.
631 ///////////////////////////////////////////////////////////////////////////////////////
633 # grml2usb --bootoptions="lang=de ssh=mysecret" grml_2009.05.iso /dev/sdX1
635 Install specified ISO on device /dev/sdX1 and use "lang=de ssh=mysecret" as
639 # grml2usb --remove-bootoption="vga=791" --remove-bootoption="quiet" grml_2009.05.iso /dev/sdX1
641 Install specified ISO on device /dev/sdX1 remove vga=791 and quiet from existing bootoptions.
647 Check out the link:http://grml.org/grml2usb/[grml2usb webpage] and the
648 link:http://git.grml.org/?p=grml2usb.git[grml2usb git repository].
653 Please report feedback, bugreports and wishes <<author,to the author>>.
658 Michael Prokop <mika@grml.org>
660 /////////////////////////////////////////////////////////////////
661 http://wiki.grml.org/doku.php?id=tips#multiboot_usb_pen
662 http://www.startx.ro/sugar/isotostick.sh
663 https://help.ubuntu.com/community/Installation/FromUSBStick
664 http://unetbootin.sourceforge.net/
665 http://www.tux.org/pub/people/kent-robotti/looplinux/rip/mkusb.sh
666 https://fedorahosted.org/liveusb-creator/
667 /////////////////////////////////////////////////////////////////