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] is the path to one or multiple grml-ISOs.
  38 /////////////////////////////////////////////////////////////////////////////
  39 TODO:
  40 as well as the path to the currently running live-system (being /live/image).
  41 /////////////////////////////////////////////////////////////////////////////
  42
  43 The device either might be a device name like /dev/sdx1 or a directory. When
  44 specifying a device name the device is mounted automatically. When specifying a
  45 directory grml2usb is assuming that you did set up a bootloader on your own (or
  46 don't need one) and a bootloader won't be installed automatically.
  47
  48 The following options are supported:
  49
  50   *--bootoptions=...*::
  51
  52 Use specified bootoptions as default.
  53
  54   *--bootloader-only*::
  55
  56 Do *not* copy files but instead just install a bootloader.  Note that the boot
  57 addons are copied to /boot/addons at this stage as well.  If you want to skip
  58 copying the boot addons consider using the --skip-addons option.
  59
  60   *--copy-only*::
  61
  62 Copy files only but do *not* install a bootloader.
  63
  64   *--dry-run*::
  65
  66 Avoid executing commands, instead show what would be executed.
  67 Warning: please notice that the ISO has to be mounted anyway, otherwise
  68 identifying the grml flavour would not be possible.
  69
  70   *--fat16*::
  71
  72 Format specified partition with FAT16.
  73 **Important:** this will destroy any existing data on the specified partition!
  74
  75   *--force*::
  76
  77 Force any (possible dangerous) actions requiring manual interaction (like --fat16).
  78
  79   *--help*::
  80
  81 Display usage information and exit.
  82
  83 //////////////////////////////////////////////////////////////////////////
  84   *--initrd=...*::
  85
  86 Install specified initrd instead of the default. You might want to specify
  87 option *--kernel* as well. (Be aware when using multiboot setup.)
  88 [Notice: not implemented yet.]
  89 //////////////////////////////////////////////////////////////////////////
  90
  91 //////////////////////////////////////////////////////////////////////////
  92   *--kernel=...*::
  93
  94 Install specified kernel instead of the default. You might want to specify
  95 option *--initrd* as well. (Be aware when using multiboot setup.)
  96 [Notice: not implemented yet.]
  97 //////////////////////////////////////////////////////////////////////////
  98
  99   *--lilo-binary=...*::
 100
 101 Use specified lilo executable for installing master boot record (MBR) when using
 102 the --syslinux-mbr option. By default any system wide (from $PATH) lilo
 103 executable is taken.  If there can not be find any lilo executable the
 104 statically compiled version of the grml2usb Debian package (see
 105 /usr/share/grml2usb/lilo/lilo.static.[amd64|i386]) is taken.
 106
 107   *--mbr-manager=...*::
 108
 109 Install master boot record (MBR) with integrated boot manager, providing a
 110 simple selection for specifying the device for booting from. This options is
 111 available only when using the default MBR and won't work if using the
 112 --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) instead of the default one.  By
 133 default a very compatible MBR is installed, if you encounter any problems
 134 with it you can try using the syslinux MBR instead. If that works for you please
 135 <<X7,let us know>> so we can adjust our default MBR accordingly.
 136 Note: When using the --syslinux-mbr option lilo is executed before the MBR
 137 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_2008.11.iso /dev/loop1
 267
 268 Performance tracing
 269 ~~~~~~~~~~~~~~~~~~~
 270
 271   # blktrace -d /dev/sdx -o - | blkparse -i -
 272   # grml2usb grml_2008.11.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 What's the difference between grml2hd and grml2usb?
 320 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 321
 322 grml2hd installs a running grml system to a harddisk. When rebooting the
 323 harddisk installation can be modified and changes will find their way to the
 324 harddisk immediately.  grml2usb copies just the compressed chroot filesystem
 325 (being the squashfs file), some further informational files and a bootloader to
 326 your device. This way you don't need as much space as with a harddisk
 327 installation (just a USB device with >=ISO size) and when rebooting the system
 328 your changes will be lost (even though a persistent root feature is
 329 work-in-progress). Think of using a better CD version: booting is (usually)
 330 faster, you don't need to burn a new CD when a new ISO version arrives (just
 331 install the new ISO using grml2usb) and you can carry additional files on a
 332 writable medium with yourself.
 333
 334 Why is there a menu.lst and a grub.cfg inside /boot/grub/?
 335 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 336
 337 grml2usb supports grub version 1 (grub1) as well as grub version 2 (grub2).
 338 Whereas grub1 uses menu.lst the new version grub2 needs grub.cfg.
 339 Providing both files allows grml2usb to install grub on the target device
 340 no matter which grub version is available on the host where grml2usb is
 341 executed on.
 342
 343 grub-install fails with 'The file ../boot/grub/stage1 not read correctly"?!
 344 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 345
 346 Check whether the partition has the right partition type. For example do NOT use
 347 FAT16 (partition type 6) when using a ext3 filesystem on the partition but
 348 instead use the correct partition type ('83' - Linux) then.
 349
 350 Why do I have to use a FAT16 filesystem?
 351 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 352
 353 You have to use a FAT16 filesystem only if you consider using syslinux, Syslinux
 354 (currently) does not support any other filesystems. If you want to use another
 355 filesystem (like ext2/3) just don't use syslinux (drop the --syslinux option)
 356 but use the default bootloader (grub) instead.
 357
 358 I think I've got a really cool idea!
 359 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 360
 361 Great! Please check out
 362 link:http://git.grml.org/?p=grml2usb.git;a=blob;f=TODO;hb=HEAD[the TODO file].
 363 Feel free to <<X7,report your wishes to the author>>. Patches highly
 364 appreciated.
 365
 366 I've problems with booting from USB.
 367 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 368
 369 Check out <<X6,Troubleshooting and Pitfalls when booting>>.
 370
 371 I've found a bug!
 372 ~~~~~~~~~~~~~~~~~
 373
 374 Please <<X7,report it to the author>>. Please provide usage examples and output
 375 of your grml2usb commandline (consider using the "--verbose" option).
 376
 377 Usage examples
 378 --------------
 379
 380   # grml2usb /home/grml/grml_2008.11.iso /dev/sdx1
 381
 382 Install specified ISO on device /dev/sdx1.
 383
 384   # grml2usb /home/grml/grml_2008.11.iso /home/grml/grml_small_2008.11.iso /dev/sdx1
 385
 386 Install specified ISOs on device /dev/sdx1 for multibooting ISOs.
 387 Note: boot "grml" as usual, for booting grml-small use "grml-small on the
 388 bootprompt, for grml64 use "grml64" and so on... The *first* specified ISO is
 389 the one being the default (when just pressing enter or waiting until the timeout
 390 is reached).
 391
 392   # grml2usb --fat16 /home/grml/grml_2008.11.iso /dev/sdx1
 393
 394 Install specified ISO on device /dev/sdx1 and format partition /dev/sdx1 with
 395 FAT16 filesystem.
 396
 397   # grml2usb --syslinux /home/grml/grml_2008.11.iso /dev/sdx1
 398
 399 Install specified ISO on device /dev/sdx1 and use syslinux as bootloader
 400 (instead of grub being the default).
 401
 402 /////////////////////////////////////////////////////////////////
 403   # grml2usb --kernel=/boot/vmlinuz-2.6.28-grml --initrd=/boot/initrd.img-2.6.28-grml \
 404              /home/grml/grml_2008.11.iso /dev/sdx1
 405
 406 Install specified ISO on device /dev/sdx1 but use given kernel and initrd
 407 instead of the ones provided by the ISO.
 408
 409   # grml2usb --squashfs=/grml/grml-live/grml_cd/live/grml.squashfs \
 410              /home/grml/grml_2008.11.iso /dev/sdx1
 411 /////////////////////////////////////////////////////////////////
 412
 413 Install specified ISO on device /dev/sdx1 but use given squashfs
 414 file instead of the one provided by the ISO.
 415
 416   # grml2usb --bootoptions="lang=de ssh=mysecret" grml_2008.11.iso /dev/sdx1
 417
 418 Install specified ISO on device /dev/sdx1 and use "lang=de ssh=mysecret" as
 419 default bootoptions.
 420
 421 Online Ressources
 422 -----------------
 423
 424 Check out the link:http://grml.org/grml2usb/[grml2usb webpage] and the
 425 link:http://git.grml.org/?p=grml2usb.git[grml2usb git repository].
 426
 427 Bugs
 428 ----
 429 Please report feedback, bugreports and wishes <<X7,to the author>>.
 430
 431 [[X7]]
 432 Author
 433 ------
 434 Michael Prokop <mika@grml.org>
 435
 436 /////////////////////////////////////////////////////////////////
 437 http://wiki.grml.org/doku.php?id=tips#multiboot_usb_pen
 438 http://www.startx.ro/sugar/isotostick.sh
 439 https://help.ubuntu.com/community/Installation/FromUSBStick
 440 http://unetbootin.sourceforge.net/
 441 http://www.tux.org/pub/people/kent-robotti/looplinux/rip/mkusb.sh
 442 https://fedorahosted.org/liveusb-creator/
 443 /////////////////////////////////////////////////////////////////