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.
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.
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).
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.
50 The following options are supported:
52 *\--bootoptions=...*::
54 Use specified bootoptions as default.
56 *\--bootloader-only*::
58 Do *not* copy files but instead just install a bootloader. Note that the boot
59 addons are copied to /boot/addons at this stage as well. If you want to skip
60 copying the boot addons consider using the --skip-addons option.
64 Copy files only but do *not* install a bootloader.
68 Avoid executing commands, instead show what would be executed.
69 Warning: please notice that the ISO has to be mounted anyway, otherwise
70 identifying the grml flavour would not be possible.
74 Format specified partition with FAT16.
75 **Important:** this will destroy any existing data on the specified partition!
79 Force any (possible dangerous) actions requiring manual interaction (like --fat16).
83 Install grub into MBR (Master Boot Record) instead of PBR (Partition Boot
84 Record). This option sadly had to be introduced because grub2 can not be
85 installed to partitions (PBR) instead of MBR anymore. Check out <<mbr-vs-pbr,the
86 'mbr-vs-pbr' section in the FAQ of this document>> for further details.
90 Display usage information and exit.
92 //////////////////////////////////////////////////////////////////////////
95 Install specified initrd instead of the default. You might want to specify
96 option *--kernel* as well. (Be aware when using multiboot setup.)
97 [Notice: not implemented yet.]
98 //////////////////////////////////////////////////////////////////////////
100 //////////////////////////////////////////////////////////////////////////
103 Install specified kernel instead of the default. You might want to specify
104 option *--initrd* as well. (Be aware when using multiboot setup.)
105 [Notice: not implemented yet.]
106 //////////////////////////////////////////////////////////////////////////
108 *\--lilo-binary=...*::
110 Use specified lilo executable for installing master boot record (MBR) when using
111 the '--syslinux-mbr' option. By default any system wide (from $PATH) lilo
112 executable is taken. If there can not be find any lilo executable the
113 statically compiled version of the grml2usb Debian package (see
114 /usr/share/grml2usb/lilo/lilo.static.[amd64|i386]) is taken.
118 Install master boot record (MBR) with integrated boot menu: interactively choose
119 the partition to boot from, with a timeout to load the default partition, or
120 boot from floppy. When NOT using the --mbr-menu option a MBR with LBA and large
121 disc support but without an integrated boot menu is installed (so it's not
122 visible at all but instead directly jumps to the bootloader - being grub or
123 syslinux). Note: This options is available only when using the default MBR and
124 won't have any effect if you're using the '--syslinux-mbr' option.
128 Do not output anything but just errors on console.
132 Do not install /boot/addons/ files (like dos, grub, memdisk,...).
134 *\--remove-bootoption=...*::
136 Remove specified bootoption (could be a regex) from existing boot options. Use
137 multiple entries for removing different bootoptions at once.
139 *\--skip-grub-config*::
141 Skip generation of grub configuration files. By default the configuration
142 files for syslinux *and* grub will be written so you've a working configuration
143 file no matter whether you're using grub or syslinux as bootloader.
147 Do not touch/install the master boot record (MBR).
149 *\--skip-syslinux-config*::
151 Skip generation of syslinux configuration files. By default the configuration
152 files for syslinux *and* grub will be written so you've a working configuration
153 file no matter whether you're using grub or syslinux as bootloader.
157 This option is deprecated and is being left only for backwards compatibility
158 reasons. Syslinux is the default bootloader of grml2usb and therefore the
159 '--syslinux' option doesn't have any effects. If you do not want to use syslinux
160 as bootloader consider using the '--grub' option.
164 Install syslinux' master boot record (MBR, which is booting from the partition
165 with the "active" flag set) instead of the default one. If you encounter any
166 problems with the default MBR you can try using the syslinux MBR instead. If
167 that works for you please <<author,let us know>> so we can adjust our default
168 MBR accordingly. Note: When using the '--syslinux-mbr' option lilo is executed
169 before the MBR is installed so the according partitions are set active.
171 //////////////////////////////////////////////////////////////////////////
174 Install specified squashfs file instead of the default.
175 [Notice: not implemented yet.]
176 //////////////////////////////////////////////////////////////////////////
178 //////////////////////////////////////////////////////////////////////////
181 Uninstall grml ISO files.
182 [Notice: not implemented yet.]
183 //////////////////////////////////////////////////////////////////////////
187 Return version and exit.
197 Directory layout on usb device
198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
202 | |-- allinone.img [grub - all in one image]
203 | |-- bsd4grml/ [MirBSD]
204 | |-- balder10.imz [FreeDOS]
205 | |-- memdisk [chainloading helper]
206 | |-- memtest [memtest86+]
209 | | |-- linux26 [Kernel]
210 | | |-- initrd.gz [initramfs]
212 | | |-- linux26 [Kernel]
213 | | |-- initrd.gz [initramfs]
215 | | |-- linux26 [...]
227 | |-- grml.png [graphical bootsplash background image for grub2]
228 | |-- grub.cfg [configuration file for grub2]
229 | |-- menu.lst [configuration file for grub1]
230 | |-- splash.xpm.gz [splash screen for grub1]
232 |-- grml.png [graphical bootsplash background image for syslinux]
233 |-- syslinux.cfg [main configuration file for syslinux]
234 `-- [....] [several further config files for syslinux]
237 |-- grml2usb.txt [not yet implemented]
238 |-- grml-cheatcodes.txt [list of bootoptions for grml]
239 |-- grml-version.txt [file containing information about grml-version]
240 |-- LICENSE.txt [license information]
241 |-- md5sums [md5sums of original ISO]
242 |-- README.txt [informational text]
243 `-- web/ [browser related files]
254 | |-- filesystem.module [module specifying which squashfs should be used for grml]
255 | `-- grml.squashfs [squashfs file for grml]
257 | |-- filesystem.module [module specifying which squashfs should be used for grml-medium]
258 | `-- grml-medium.squashfs [squashfs file for grml-medium]
260 | |-- filesystem.module [module specifying which squashfs should be used for grml-medium]
261 | `-- grml-small.squashfs [squashfs file for grml-small]
268 % git clone git://git.grml.org/grml2usb.git
271 Developers Debugging Hints
272 ~~~~~~~~~~~~~~~~~~~~~~~~~~
274 To play with grml2usb you can avoid using a real device via a loopback file
277 # dd if=/dev/zero of=~/loopback bs=1M count=100 # adjust size to your needs
278 # losetup /dev/loop1 ~/loopback
280 Then create according partitions either running for example:
282 # echo -en "n\np\n1\n\n\nt\n6\na\n1\n w\n" | fdisk /dev/loop1
286 # parted /dev/loop1 -s "mkpart primary fat16 0 -1s mkfs 1 fat16"
288 Finally create a filesystem and execute grml2usb as needed:
290 # mkfs.vfat /dev/loop1
291 # grml2usb --bootloader-only /grml/isos/grml-small_2009.10.iso /dev/loop1
293 [[performance-tracing]]
297 # blktrace -d /dev/sdX -o - | blkparse -i -
298 # grml2usb grml_2009.10.iso /dev/sdX1
301 Troubleshooting and Pitfalls when booting
302 -----------------------------------------
304 Here is a list of common error messages from BIOS/bootloader when trying to boot
307 ///////////////////////////////////////////////////////////
308 TODO: better list type for the error message / reason part?
309 See http://www.methods.co.nz/asciidoc/userguide.html
310 ///////////////////////////////////////////////////////////
313 *Error message*:: ran out of input data. System halted
315 *Reason*:: Everything OK, except for the filesystem used on your usb device. So
316 instead of fat16 you are using for example fat32. Fix: use the appropriate
317 filesystem (fat16 for usb pens usually). The Bootsplash might be displayed, the
318 kernel loads but you very soon get the error message.
320 *Error message*:: Invalid operating system
322 *Reason*:: the partition layout is not ok. Very probably there's no primary
323 partition (/dev/sdX{1..4}) or none has the flag 'bootable' set.
325 *Error message*:: No operating system found.
327 *Reason*:: you forgot to set the boot-flag on the partition. Or there really isn't
328 any operating system at all. :)
330 *Error message*:: kernel-panic: unable to mount root-fs...
332 *Reason*:: Kernel boots but fails to find the root filesystem. The root=
333 argument in your kernel commandline is pointing to the wrong device. Adjust
334 root=..., consider using root=UUID=....
336 *Error message*:: Could not find kernel image: ...
338 *Reason*:: either a broken isolinux/syslinux version or a broken BIOS. Check out
339 whether the vendor provides a BIOS update or if using bootloader grub instead of
340 isolinux/syslinux fixes the problem.
343 Frequently Asked Questions (FAQ)
344 --------------------------------
347 Where can I get grml2usb?
348 ~~~~~~~~~~~~~~~~~~~~~~~~~
350 grml2usb is available as Debian package via link:http://deb.grml.org/[the
351 grml-testing Debian repository].
353 If you do not want to (or can't) use the grml2usb Debian package you can either
354 use the grml2usb git tree running:
356 git clone git://git.grml.org/grml2usb.git
361 or download the provided
362 link:http://grml.org/grml2usb/grml2usb.tgz[http://grml.org/grml2usb/grml2usb.tgz]
363 (link:http://grml.org/grml2usb/grml2usb.tgz.md5.asc[gpg signed md5 hash]).
364 Download and extract the tarball and execute the provided script 'install.sh'.
367 It is *NOT* enough to have just the grml2usb script itself without the according
368 files provided either via the Debian package, the git tree or the file
371 [[grml2hd-vs-grml2usb]]
372 What's the difference between grml2hd and grml2usb?
373 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
375 grml2hd installs a running grml system to a harddisk. When rebooting the
376 harddisk installation can be modified and changes will find their way to the
377 harddisk immediately. grml2usb copies just the compressed chroot filesystem
378 (being the squashfs file), some further informational files and a bootloader to
379 your device. This way you don't need as much space as with a harddisk
380 installation (just a USB device with >=ISO size) and when rebooting the system
381 your changes will be lost (unless you are using the persistency feature, see
382 link:http://wiki.grml.org/doku.php?id=persistency[http://wiki.grml.org/doku.php?id=persistency]).
383 Think of using a better CD version: booting is (usually) faster, you don't need
384 to burn a new CD when a new ISO version arrives (just install the new ISO using
385 grml2usb) and you can carry additional files on a writable medium with yourself.
388 Why can't I just dd the ISO to a USB device?
389 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
391 Well, you can. :) Starting with grml 2009.10 the ISOs are dd-able straight out-of-the-box.
394 Note that ANY existing data on your USB device will be destroyed when
395 using the dd approach.
397 ///////////////////////////////////////////////////////////////////////////////////////////////////
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.10.iso
403 ///////////////////////////////////////////////////////////////////////////////////////////////////
405 This allows you to dd the Grml ISO to your USB device (use for example
406 link:http://www.chrysocome.net/rawwrite[rawwrite] if you've just a Windows
407 system available) running:
409 % dd if=grml_2009.10.iso of=/dev/sdX
411 where /dev/sdX is your USB device. Of course this doesn't provide such a
412 flexible system like with grml2usb (no multi-ISO setup, no additional default
413 bootoptions,...) but it's a nice way to get a working USB boot setup if you
414 don't have grml2usb available.
417 What's the difference between grml2usb and just using dd?
418 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
420 grml2usb does not remove any data from your USB device and does not alter the
421 partition table at all. grml2usb provides multi-ISO support, support for adding
422 default bootoptions and selecting the bootloader (syslinux vs. grub) without
423 having to manually touch the ISO at all.
429 grml2iso is a script which uses grml2usb to generate a multiboot ISO out of
430 several grml ISOs. See 'man grml2iso' for further details.
433 grml2usb fails with "Fatal: file default.cfg could not be found."
434 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
436 If you are trying to install an older grml ISO (older than grml 2009.10) with a
437 recent version of grml2usb then you might notice:
439 Fatal: file default.cfg could not be found.
440 Note: this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...
441 ... either use grml releases >=2009.10 or switch to an older grml2usb version.
442 Please visit http://grml.org/grml2usb/#grml2usb-compat for further information
443 Fatal: a critical error happend during execution (not a grml ISO?), giving up
445 Breaking the backward compatibility was necessary to avoid maintainability hell.
446 If you want to install older grml ISOs please use the grml2usb-compat script
447 which provides support for older releases.
450 Why is there a menu.lst and a grub.cfg inside /boot/grub/?
451 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
453 grml2usb supports grub version 1 (grub1) as well as grub version 2 (grub2).
454 Whereas grub1 uses menu.lst the new version grub2 needs grub.cfg.
455 Providing both files allows grml2usb to install grub on the target device
456 no matter which grub version is available on the host where grml2usb is
460 grub-install fails with 'The file ../boot/grub/stage1 not read correctly"?!
461 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
463 Check whether the partition has the right partition type. For example do NOT use
464 FAT16 (partition type 6) when using a ext3 filesystem on the partition but
465 instead use the correct partition type ('83' - Linux) then.
467 [[grub-install-xfs_freeze]]
468 grub-install complains about /sbin/grub-install and/or xfs_freeze?!
469 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
471 The following message:
473 You shouldn't call /sbin/grub-install. Please call /usr/sbin/grub-install instead!
474 xfs_freeze: specified file ["/tmp/tmpqaBK6z/boot/grub"] is not on an XFS filesystem
476 This is "normal". grub-install sends those messages to stderr. To avoid hiding any
477 possible real error messages grml2usb doesn't ignore those messages.
480 grub-install complains about /boot/grub/device.map?!
481 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
483 The following message:
485 grub-probe: error: Cannot open `/boot/grub/device.map'
487 This is "normal" (at least with grub1). This isn't a problem, because the
488 device.map file will be generated on the target device anyway.
491 grub-install complains about a unary operator?!
492 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
494 The following message:
496 '/usr/sbin/grub-install: line 374: [: =: unary operator expected'
498 This is "normal". Just ignore it. (It usually doesn't appear
499 on the second invocation on the same device.)
501 [[unknown-filesystem]]
502 grub-install fails with grub-probe: error: unknown filesystem?!
503 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
505 The following message:
507 grub-probe: error: unknown filesystem
508 Auto-detection of a filesystem module failed.
509 Please specify the module with the option `--modules' explicitly.
511 usually means that the device partition table says something else than the
512 filesystem on the device. For example using FAT16 as filesystem type and
513 using FAT32 as filesystem on the partition will not work. Either set filesystem
514 type to FAT32 or format the partition using FAT16. It is essential that
515 device partition table and filesystem use the same filesystem type.
518 grub-setup fails after Attempting to install GRUB to a partition instead of the MBR?!
519 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
521 The following message:
523 grub-setup: warn: Attempting to install GRUB to a partition instead of the MBR. This is a BAD idea.
524 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.
525 grub-setup: error: Cannot read `/grub/core.img' correctly
527 appears because recent grub2 versions sadly introduced a regression which avoids
528 that grub is being installed into a partition (PBR, Partition Boot Record)
529 instead of MBR (Master Boot Record).
531 To work around this issue you can install grub into the MBR (Master Boot Record)
532 using the '--grub-mbr' option of grml2usb or switch to syslinux as bootmanager
533 (just drop the '--grub' option).
535 To fix this issue manually you can also execute (adjust '/dev/sdX' to your
538 mount /dev/sdX1 /mnt/test
539 grub-install --force --recheck --no-floppy --root-directory=/mnt/test /dev/sdX
542 I'm getting something like "Error: /usr/share/grml2usb/grub/splash.xpm.gz can not be read"!?
543 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
545 Looks like you've only the grml2usb script itself available. Please make sure
546 you've the grml2usb Debian package installed. The most resent stable version is
547 available via link:http://deb.grml.org/[the grml-testing Debian repository]. If
548 you do not have a Debian system please see section <<download,Where can I get
549 grml2usb?>> in this FAQ.
552 Why do I have to use a FAT16/FAT32 filesystem?
553 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
555 Syslinux (currently) does not support any other filesystems besides FAT16/FAT32
556 (though that's a sane default if you want to share your files with other
557 (operating) systems). If you want to use a different filesystem (like ext2/3)
558 use the bootloader grub instead using grml2usb's '--grub' option.
561 FAT32 is supported since syslinux version 3.0.
564 I think I've got a really cool idea!
565 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
567 Great! Please check out
568 link:http://git.grml.org/?p=grml2usb.git;a=blob;f=TODO;hb=HEAD[the TODO file].
569 Feel free to <<author,report your wishes to the author>>. Patches highly
573 I've problems with booting from USB.
574 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
576 Check out <<troubleshooting,Troubleshooting and Pitfalls when booting>>.
582 Please <<author,report it to the author>>. Please provide usage examples and output
583 of your grml2usb commandline (consider using the "\--verbose" option).
589 # grml2usb /home/grml/grml_2009.10.iso /dev/sdX1
591 Install specified ISO on device /dev/sdX1.
593 # grml2usb /home/grml/grml_2009.10.iso /home/grml/grml_small_2009.10.iso /dev/sdX1
595 Install specified ISOs on device /dev/sdX1 for multibooting ISOs.
597 # grml2usb /live/image /dev/sdX1
599 Install currently running grml live system on device /dev/sdX1.
601 # grml2usb /live/image /home/grml/grml_2009.10.iso /dev/sdX1
603 Install currently running grml live system and the specified
604 ISO on device /dev/sdX1 for multibooting.
606 # grml2usb --fat16 /home/grml/grml_2009.10.iso /dev/sdX1
608 Install specified ISO on device /dev/sdX1 and format partition /dev/sdX1 with
611 # grml2usb --grub --grub-mbr /home/grml/grml_2009.10.iso /dev/sdX1
613 Install specified ISO on device /dev/sdX1 and use grub as bootloader (instead of
614 syslinux being the default) and install a master boot record (MBR) to the MBR of
617 # grml2usb-compat /home/grml/grml_2009.05.iso /dev/sdX1
619 Install older grml ISO on device /dev/sdX1.
621 ///////////////////////////////////////////////////////////////////////////////////////
622 # grml2usb --kernel=/boot/vmlinuz-2.6.28-grml --initrd=/boot/initrd.img-2.6.28-grml \
623 /home/grml/grml_2009.10.iso /dev/sdX1
625 Install specified ISO on device /dev/sdX1 but use given kernel and initrd
626 instead of the ones provided by the ISO.
628 # grml2usb --squashfs=/grml/grml-live/grml_cd/live/grml.squashfs \
629 /home/grml/grml_2009.10.iso /dev/sdX1
631 Install specified ISO on device /dev/sdX1 but use given squashfs
632 file instead of the one provided by the ISO.
633 ///////////////////////////////////////////////////////////////////////////////////////
635 # grml2usb --bootoptions="lang=de ssh=mysecret" grml_2009.10.iso /dev/sdX1
637 Install specified ISO on device /dev/sdX1 and use "lang=de ssh=mysecret" as
641 # grml2usb --remove-bootoption="vga=791" --remove-bootoption="quiet" grml_2009.10.iso /dev/sdX1
643 Install specified ISO on device /dev/sdX1 remove vga=791 and quiet from existing bootoptions.
649 Check out the link:http://grml.org/grml2usb/[grml2usb webpage] and the
650 link:http://git.grml.org/?p=grml2usb.git[grml2usb git repository].
655 Please report feedback, bugreports and wishes <<author,to the author>>.
660 Michael Prokop <mika@grml.org>
662 /////////////////////////////////////////////////////////////////
663 http://wiki.grml.org/doku.php?id=tips#multiboot_usb_pen
664 http://www.startx.ro/sugar/isotostick.sh
665 https://help.ubuntu.com/community/Installation/FromUSBStick
666 http://unetbootin.sourceforge.net/
667 http://www.tux.org/pub/people/kent-robotti/looplinux/rip/mkusb.sh
668 https://fedorahosted.org/liveusb-creator/
669 /////////////////////////////////////////////////////////////////