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 ------------
  18
  19 grml2usb installs grml on a given partition of your usb device and makes it
  20 bootable. It provides multi-iso support, meaning you can specify several grml
  21 ISOs on the command line at once and select the grml flavour you would like to
  22 boot on the bootbrompt then. Note that the *first* ISO specified on the grml2usb
  23 command line will become the default one (that's the one that will boot when
  24 just pressing enter on the bootprompt or wait until the boot timeout matches).
  25
  26 [IMPORTANT]
  27 By default a compatible master boot record (MBR) is installed on the device
  28 (being for example /dev/sdx when executing 'grml2usb grml.iso /dev/sdx1')
  29 and grub is being used as default bootloader. Avoid installation of the
  30 default MBR using the --skip-mbr option or if you encounter any problems
  31 with the default MBR consider using --syslinux-mbr instead. If bootloader
  32 grub doesn't work for you check out the --syslinux option.
  33
  34 Options
  35 -------
  36
  37 The ISO[s] should be the path to one or multiple grml-ISOs and/or the path to
  38 the currently running live-system (being /live/image).
  39
  40 The device either might be a device name like /dev/sdx1 or a directory. When
  41 specifying a device name the device is mounted automatically. When specifying a
  42 directory grml2usb is assuming that you did set up a bootloader on your own (or
  43 don't need one) and a bootloader won't be installed automatically.
  44
  45 The following options are supported:
  46
  47   *\--bootoptions=...*::
  48
  49 Use specified bootoptions as default.
  50
  51   *\--bootloader-only*::
  52
  53 Do *not* copy files but instead just install a bootloader.  Note that the boot
  54 addons are copied to /boot/addons at this stage as well.  If you want to skip
  55 copying the boot addons consider using the --skip-addons option.
  56
  57   *\--copy-only*::
  58
  59 Copy files only but do *not* install a bootloader.
  60
  61   *\--dry-run*::
  62
  63 Avoid executing commands, instead show what would be executed.
  64 Warning: please notice that the ISO has to be mounted anyway, otherwise
  65 identifying the grml flavour would not be possible.
  66
  67   *\--fat16*::
  68
  69 Format specified partition with FAT16.
  70 **Important:** this will destroy any existing data on the specified partition!
  71
  72   *\--force*::
  73
  74 Force any (possible dangerous) actions requiring manual interaction (like --fat16).
  75
  76   *\--help*::
  77
  78 Display usage information and exit.
  79
  80 //////////////////////////////////////////////////////////////////////////
  81   *\--initrd=...*::
  82
  83 Install specified initrd instead of the default. You might want to specify
  84 option *--kernel* as well. (Be aware when using multiboot setup.)
  85 [Notice: not implemented yet.]
  86 //////////////////////////////////////////////////////////////////////////
  87
  88 //////////////////////////////////////////////////////////////////////////
  89   *\--kernel=...*::
  90
  91 Install specified kernel instead of the default. You might want to specify
  92 option *--initrd* as well. (Be aware when using multiboot setup.)
  93 [Notice: not implemented yet.]
  94 //////////////////////////////////////////////////////////////////////////
  95
  96   *\--lilo-binary=...*::
  97
  98 Use specified lilo executable for installing master boot record (MBR) when using
  99 the --syslinux-mbr option. By default any system wide (from $PATH) lilo
 100 executable is taken.  If there can not be find any lilo executable the
 101 statically compiled version of the grml2usb Debian package (see
 102 /usr/share/grml2usb/lilo/lilo.static.[amd64|i386]) is taken.
 103
 104   *\--mbr-menu*::
 105
 106 Install master boot record (MBR) with integrated boot menu: interactively choose
 107 the partition to boot from, with a timeout to load the default partition, or
 108 boot from floppy. When NOT using the --mbr-menu option a MBR with LBA and large
 109 disc support but without an integrated boot menu is installed (so it's not
 110 visible at all but instead directly jumps to the bootloader - being grub or
 111 syslinux). Note: This options is available only when using the default MBR and
 112 won't have any effect if you're using the --syslinux-mbr option.
 113
 114   *\--quiet*::
 115
 116 Do not output anything but just errors on console.
 117
 118   *\--skip-addons*::
 119
 120 Do not install /boot/addons/ files (like dos, grub, memdisk,...).
 121
 122   *\--skip-mbr*::
 123
 124 Do not touch/install the master boot record (MBR).
 125
 126   *\--syslinux*::
 127
 128 Install syslinux bootloader instead of the default (being grub).
 129
 130   *\--syslinux-mbr*::
 131
 132 Install syslinux' master boot record (MBR, which is booting from the partition
 133 with the "active" flag set) instead of the default one.  If you encounter any
 134 problems with the default MBR you can try using the syslinux MBR instead. If
 135 that works for you please <<X7,let us know>> so we can adjust our default MBR
 136 accordingly.  Note: When using the --syslinux-mbr option lilo is executed before
 137 the MBR is installed so the according partitions are set active.
 138
 139 //////////////////////////////////////////////////////////////////////////
 140   *\--squashfs=*::
 141
 142 Install specified squashfs file instead of the default.
 143 [Notice: not implemented yet.]
 144 //////////////////////////////////////////////////////////////////////////
 145
 146 //////////////////////////////////////////////////////////////////////////
 147   *\--uninstall*::
 148
 149 Uninstall grml ISO files.
 150 [Notice: not implemented yet.]
 151 //////////////////////////////////////////////////////////////////////////
 152
 153   *-v*, *\--version*::
 154
 155 Return version and exit.
 156
 157   *\--verbose*::
 158
 159 Enable verbose mode.
 160
 161 Developers Corner
 162 -----------------
 163
 164 Directory layout on usb device
 165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 166
 167   boot/ ->
 168     |-- addons/
 169     |   |-- allinone.img     [grub - all in one image]
 170     |   |-- bsd4grml/        [MirBSD]
 171     |   |-- balder10.imz     [FreeDOS]
 172     |   |-- memdisk          [chainloading helper]
 173     |   |-- memtest          [memtest86+]
 174     |-- release/
 175     |   |-- grml/
 176     |   |   |-- linux26      [Kernel]
 177     |   |   |-- initrd.gz    [initramfs]
 178     |   |-- grml64
 179     |   |   |-- linux26      [Kernel]
 180     |   |   |-- initrd.gz    [initramfs]
 181     |   |-- grml-medium
 182     |   |   |-- linux26      [...]
 183     |   |   |-- initrd.gz
 184     |   |-- grml64-medium
 185     |   |   |-- linux26
 186     |   |   |-- initrd.gz
 187     |   |-- grml-small
 188     |   |   |-- linux26
 189     |   |   |-- initrd.gz
 190     |   `-- grml64-small
 191     |       |-- linux26
 192     |       |-- initrd.gz
 193     |-- grub/
 194     |   |-- grml.png         [splash screen for grub2]
 195     |   |-- grub.cfg         [configuration file for grub2]
 196     |   |-- menu.lst         [configuration file for grub1]
 197     |   |-- splash.xpm.gz    [splash screen for grub1]
 198     `-- syslinux/
 199         |-- boot.msg         [boot splash for syslinux]
 200         |-- f1               [screen when pressing f1]
 201         |-- f2               [screen when pressing f2]
 202         |-- f3               [...]
 203         |-- f4
 204         |-- f5
 205         |-- f6
 206         |-- f7
 207         |-- f8
 208         |-- f9
 209         |-- f10
 210         |-- logo.16          [graphical part of boot splash]
 211         `-- syslinux.cfg     [configuration file for syslinux]
 212
 213   grml/
 214     |-- grml2usb.txt         [not yet implemented]
 215     |-- grml-cheatcodes.txt  [list of bootoptions for grml]
 216     |-- grml-version.txt     [file containing information about grml-version]
 217     |-- LICENSE.txt          [license information]
 218     |-- md5sums              [md5sums of original ISO]
 219     |-- README.txt           [informational text]
 220     `-- web/                 [browser related files]
 221         |-- index.html
 222         |-- style.css
 223         `-- images/
 224             |-- button.png
 225             |-- favicon.png
 226             |-- linux.jpg
 227             `-- logo.png
 228
 229   live/
 230     |-- grml/
 231     |   |-- filesystem.module    [module specifying which squashfs should be used for grml]
 232     |   `-- grml.squashfs        [squashfs file for grml]
 233     |-- grml-medium/
 234     |   |-- filesystem.module    [module specifying which squashfs should be used for grml-medium]
 235     |   `-- grml-medium.squashfs [squashfs file for grml-medium]
 236     |-- grml-small/
 237     |   |-- filesystem.module    [module specifying which squashfs should be used for grml-medium]
 238     |   `-- grml-small.squashfs  [squashfs file for grml-small]
 239     `-- ...
 240
 241 Grabbing the source
 242 ~~~~~~~~~~~~~~~~~~~
 243
 244   % git clone git://git.grml.org/grml2usb.git
 245
 246 Developers Debugging Hints
 247 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 248
 249 To play with grml2usb you can avoid using a real device via a loopback file
 250 setup, like:
 251
 252   # dd if=/dev/zero of=~/loopback bs=1M count=100 # adjust size to your needs
 253   # losetup /dev/loop1 ~/loopback
 254
 255 Then create according partitions either running for example:
 256
 257   # echo -en "n\np\n1\n\n\nt\n6\na\n1\n w\n" | fdisk /dev/loop1
 258
 259 or:
 260
 261   # parted /dev/loop1 -s "mkpart primary fat16 0 -1s mkfs 1 fat16"
 262
 263 Finally create a filesystem and execute grml2usb as needed:
 264
 265   # mkfs.vfat /dev/loop1
 266   # grml2usb --bootloader-only /grml/isos/grml-small_2009.05.iso /dev/loop1
 267
 268 Performance tracing
 269 ~~~~~~~~~~~~~~~~~~~
 270
 271   # blktrace -d /dev/sdx -o - | blkparse -i -
 272   # grml2usb grml_2009.05.iso /dev/sdx1
 273
 274 [[X6]]
 275 Troubleshooting and Pitfalls when booting
 276 -----------------------------------------
 277
 278 Here is a list of common error messages from BIOS/bootloader when trying to boot
 279 from USB.
 280
 281 ///////////////////////////////////////////////////////////
 282 TODO: better list type for the error message / reason part?
 283 See http://www.methods.co.nz/asciidoc/userguide.html
 284 ///////////////////////////////////////////////////////////
 285
 286 [horizontal]
 287 *Error message*:: ran out of input data. System halted
 288
 289 *Reason*:: Everything OK, except for the filesystem used on your usb device. So
 290 instead of fat16 you are using for example fat32. Fix: use the appropriate
 291 filesystem (fat16 for usb pens usually). The Bootsplash might be displayed, the
 292 kernel loads but you very soon get the error message.
 293
 294 *Error message*:: Invalid operating system
 295
 296 *Reason*:: the partition layout is not ok. Very probably there's no primary
 297   partition (/dev/sdX{1..4}) or none has the flag 'bootable' set.
 298
 299 *Error message*:: No operating system found.
 300
 301 *Reason*:: you forgot to set the boot-flag on the partition. Or there really isn't
 302 any operating system at all. :)
 303
 304 *Error message*:: kernel-panic: unable to mount root-fs...
 305
 306 *Reason*:: Kernel boots but fails to find the root filesystem. The root=
 307 argument in your kernel commandline is pointing to the wrong device. Adjust
 308 root=..., consider using root=UUID=....
 309
 310 *Error message*::  Could not find kernel image: ...
 311
 312 *Reason*:: either a broken isolinux/syslinux version or a broken BIOS. Check out
 313 whether the vendor provides a BIOS update or if using bootloader grub instead of
 314 isolinux/syslinux fixes the problem.
 315
 316 Frequently Asked Questions (FAQ)
 317 --------------------------------
 318
 319 [[X5]]
 320 Where can I get grml2usb?
 321 ~~~~~~~~~~~~~~~~~~~~~~~~~
 322
 323 grml2usb is available as Debian package via link:http://deb.grml.org/[the
 324 grml-testing Debian repository]. Please make sure you really have the Debian
 325 package installed as having just the grml2usb script available is definitely
 326 *NOT* enough!
 327
 328 If you do NOT have a Debian based system but still want to be able to use
 329 grml2usb you can use the provided
 330 link:http://grml.org/grml2usb/grml2usb.tgz[http://grml.org/grml2usb/grml2usb.tgz]
 331 (link:http://grml.org/grml2usb/grml2usb.tgz.md5.asc[gpg signed md5 hash]).
 332 Download and extract the tarball and execute the provided script 'install.sh'.
 333
 334 What's the difference between grml2hd and grml2usb?
 335 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 336
 337 grml2hd installs a running grml system to a harddisk. When rebooting the
 338 harddisk installation can be modified and changes will find their way to the
 339 harddisk immediately.  grml2usb copies just the compressed chroot filesystem
 340 (being the squashfs file), some further informational files and a bootloader to
 341 your device. This way you don't need as much space as with a harddisk
 342 installation (just a USB device with >=ISO size) and when rebooting the system
 343 your changes will be lost (unless you are using the persistency feature, see
 344 link:http://wiki.grml.org/doku.php?id=persistency[http://wiki.grml.org/doku.php?id=persistency]).
 345 Think of using a better CD version: booting is (usually) faster, you don't need
 346 to burn a new CD when a new ISO version arrives (just install the new ISO using
 347 grml2usb) and you can carry additional files on a writable medium with yourself.
 348
 349 Why is there a menu.lst and a grub.cfg inside /boot/grub/?
 350 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 351
 352 grml2usb supports grub version 1 (grub1) as well as grub version 2 (grub2).
 353 Whereas grub1 uses menu.lst the new version grub2 needs grub.cfg.
 354 Providing both files allows grml2usb to install grub on the target device
 355 no matter which grub version is available on the host where grml2usb is
 356 executed on.
 357
 358 grub-install fails with 'The file ../boot/grub/stage1 not read correctly"?!
 359 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 360
 361 Check whether the partition has the right partition type. For example do NOT use
 362 FAT16 (partition type 6) when using a ext3 filesystem on the partition but
 363 instead use the correct partition type ('83' - Linux) then.
 364
 365 grub-install complains about /sbin/grub-install and/or xfs_freeze?!
 366 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 367
 368 The following message:
 369
 370   You shouldn't call /sbin/grub-install. Please call /usr/sbin/grub-install instead!
 371   xfs_freeze: specified file ["/tmp/tmpqaBK6z/boot/grub"] is not on an XFS filesystem
 372
 373 ... is "normal". grub-install sends those messages to stderr. To avoid hiding any
 374 possible real error messages grml2usb doesn't ignore those messages.
 375
 376 grub-install complains about /boot/grub/device.map?!
 377 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 378
 379 The following message:
 380
 381   grub-probe: error: Cannot open `/boot/grub/device.map'
 382
 383 ... is "normal" (at least with grub1). This isn't a problem, because the
 384 device.map file will be generated on the target device anyway.
 385
 386 grub-install complains about a unary operator?!
 387 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 388
 389 The following message:
 390
 391   '/usr/sbin/grub-install: line 374: [: =: unary operator expected'
 392
 393 ... is "normal". Just ignore it.
 394
 395 I'm getting something like "Error: /usr/share/grml2usb/grub/splash.xpm.gz can not be read"!?
 396 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 397
 398 Looks like you've only the grml2usb script itself available. Please make sure
 399 you've the grml2usb Debian package installed. The most resent stable version is
 400 available via link:http://deb.grml.org/[the grml-testing Debian repository].  If
 401 you do not have a Debian system please see section <<X5,Where can I get
 402 grml2usb?>> in this FAQ.
 403
 404 Why do I have to use a FAT16 filesystem?
 405 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 406
 407 You have to use a FAT16 filesystem only if you consider using syslinux. Syslinux
 408 (currently) does not support any other filesystems. If you want to use another
 409 filesystem (like ext2/3) just don't use syslinux (drop the \--syslinux option)
 410 but use the default bootloader (grub) instead.
 411
 412 I think I've got a really cool idea!
 413 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 414
 415 Great! Please check out
 416 link:http://git.grml.org/?p=grml2usb.git;a=blob;f=TODO;hb=HEAD[the TODO file].
 417 Feel free to <<X7,report your wishes to the author>>. Patches highly
 418 appreciated.
 419
 420 I've problems with booting from USB.
 421 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 422
 423 Check out <<X6,Troubleshooting and Pitfalls when booting>>.
 424
 425 I've found a bug!
 426 ~~~~~~~~~~~~~~~~~
 427
 428 Please <<X7,report it to the author>>. Please provide usage examples and output
 429 of your grml2usb commandline (consider using the "\--verbose" option).
 430
 431 Usage examples
 432 --------------
 433
 434   # grml2usb /home/grml/grml_2009.05.iso /dev/sdx1
 435
 436 Install specified ISO on device /dev/sdx1.
 437
 438   # grml2usb /home/grml/grml_2009.05.iso /home/grml/grml_small_2009.05.iso /dev/sdx1
 439
 440 Install specified ISOs on device /dev/sdx1 for multibooting ISOs.
 441 Note: boot "grml" as usual, for booting grml-small use "grml-small on the
 442 bootprompt, for grml64 use "grml64" and so on... The *first* specified ISO is
 443 the one being the default (when just pressing enter or waiting until the timeout
 444 is reached).
 445
 446   # grml2usb /live/image /dev/sdx1
 447
 448 Install currently running grml live system on device /dev/sdx1.
 449
 450   # grml2usb /live/image /home/grml/grml_2009.05.iso /dev/sdx1
 451
 452 Install currently running grml live system and the specified
 453 ISO on device /dev/sdx1 for multibooting.
 454
 455   # grml2usb --fat16 /home/grml/grml_2009.05.iso /dev/sdx1
 456
 457 Install specified ISO on device /dev/sdx1 and format partition /dev/sdx1 with
 458 FAT16 filesystem.
 459
 460   # grml2usb --syslinux /home/grml/grml_2009.05.iso /dev/sdx1
 461
 462 Install specified ISO on device /dev/sdx1 and use syslinux as bootloader
 463 (instead of grub being the default).
 464
 465 ///////////////////////////////////////////////////////////////////////////////////////
 466   # grml2usb --kernel=/boot/vmlinuz-2.6.28-grml --initrd=/boot/initrd.img-2.6.28-grml \
 467              /home/grml/grml_2009.05.iso /dev/sdx1
 468
 469 Install specified ISO on device /dev/sdx1 but use given kernel and initrd
 470 instead of the ones provided by the ISO.
 471
 472   # grml2usb --squashfs=/grml/grml-live/grml_cd/live/grml.squashfs \
 473              /home/grml/grml_2009.05.iso /dev/sdx1
 474
 475 Install specified ISO on device /dev/sdx1 but use given squashfs
 476 file instead of the one provided by the ISO.
 477 ///////////////////////////////////////////////////////////////////////////////////////
 478
 479   # grml2usb --bootoptions="lang=de ssh=mysecret" grml_2009.05.iso /dev/sdx1
 480
 481 Install specified ISO on device /dev/sdx1 and use "lang=de ssh=mysecret" as
 482 default bootoptions.
 483
 484 Online Ressources
 485 -----------------
 486
 487 Check out the link:http://grml.org/grml2usb/[grml2usb webpage] and the
 488 link:http://git.grml.org/?p=grml2usb.git[grml2usb git repository].
 489
 490 Bugs
 491 ----
 492 Please report feedback, bugreports and wishes <<X7,to the author>>.
 493
 494 [[X7]]
 495 Author
 496 ------
 497 Michael Prokop <mika@grml.org>
 498
 499 /////////////////////////////////////////////////////////////////
 500 http://wiki.grml.org/doku.php?id=tips#multiboot_usb_pen
 501 http://www.startx.ro/sugar/isotostick.sh
 502 https://help.ubuntu.com/community/Installation/FromUSBStick
 503 http://unetbootin.sourceforge.net/
 504 http://www.tux.org/pub/people/kent-robotti/looplinux/rip/mkusb.sh
 505 https://fedorahosted.org/liveusb-creator/
 506 /////////////////////////////////////////////////////////////////