helper/febootstrap-supermin-helper.pod

   1 =head1 NAME
   2
   3 febootstrap-supermin-helper - Reconstruct initramfs from supermin appliance.
   4
   5 =head1 SYNOPSIS
   6
   7  febootstrap-supermin-helper supermin.img hostfiles.txt host_cpu kernel initrd
   8  febootstrap-supermin-helper input [...] host_cpu kernel initrd
   9
  10 =head1 DESCRIPTION
  11
  12 I<febootstrap-supermin-helper> reconstructs a bootable kernel and
  13 initramfs from a supermin appliance.  First you should be familiar
  14 with L<febootstrap(8)>, L<febootstrap-to-initramfs(8)> and
  15 L<febootstrap-to-supermin(8)>.
  16
  17 =head1 PARAMETERS
  18
  19 Of the four or five required parameters, the first few are I<input>
  20 files, and the last two are I<output> files.
  21
  22 C<supermin.img> and C<hostfiles.txt> are the input files which
  23 describe the supermin appliance.  (You can also use a directory name
  24 here which is searched for files).
  25
  26 C<host_cpu> should be the host CPU, eg. C<x86_64> or C<i686>.
  27
  28 C<kernel> and C<initrd> are the temporary output files that this
  29 script produces.  These output files are meant to be used just for
  30 booting the appliance, and should be deleted straight afterwards.
  31
  32 =head1 OPTIONS
  33
  34 =over 4
  35
  36 =item B<-f cpio> | B<--format cpio>
  37
  38 Select the output format.  The default, and only possible output
  39 format, is C<cpio> (ie. a Linux initramfs).
  40
  41 =item B<-k file> | B<--kmods file>
  42
  43 If this option is specified, then C<file> should be a list of
  44 wildcards matching kernel module names, eg:
  45
  46  virtio*.ko
  47  scsi*.ko
  48  piix.ko
  49
  50 In this case, only kernel modules matching those wildcards will be
  51 included in the output appliance.  Note: You must resolve any
  52 dependencies yourself as this does not pull in dependent modules
  53 automatically.
  54
  55 If this option is not specified, then every kernel module from the
  56 host will be included.  This is safer, but can produce rather large
  57 appliances which need a lot more memory to boot.
  58
  59 =back
  60
  61 =head1 SPEED
  62
  63 In libguestfs, on a mid-range Intel-based PC, we reconstruct the
  64 initramfs using this script in around 1/5th of a second (assuming a
  65 "hot cache" - it's rather slower when run the first time on a cold
  66 cache).
  67
  68 Some tips to improve performance:
  69
  70 =over 4
  71
  72 =item *
  73
  74 Use a kernel module whitelist (the C<--kmods> option), and only
  75 list the kernel modules you really need.
  76
  77 =item *
  78
  79 Minimize the appliance, removing as much extraneous junk as possible.
  80
  81 As well as using L<febootstrap-minimize(8)> it is worth checking for
  82 anything that is not necessary for your particular application and
  83 removing it by hand.
  84
  85 =back
  86
  87 =head1 SEE ALSO
  88
  89 L<febootstrap(8)>,
  90 L<febootstrap-to-initramfs(8)>,
  91 L<febootstrap-to-supermin(8)>.
  92
  93 =head1 AUTHORS
  94
  95 Richard W.M. Jones <rjones @ redhat . com>
  96
  97 =head1 COPYRIGHT
  98
  99 (C) Copyright 2009-2010 Red Hat Inc.,
 100 L<http://people.redhat.com/~rjones/febootstrap>.
 101
 102 This program is free software; you can redistribute it and/or modify
 103 it under the terms of the GNU General Public License as published by
 104 the Free Software Foundation; either version 2 of the License, or
 105 (at your option) any later version.
 106
 107 This program is distributed in the hope that it will be useful,
 108 but WITHOUT ANY WARRANTY; without even the implied warranty of
 109 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 110 GNU General Public License for more details.
 111
 112 You should have received a copy of the GNU General Public License
 113 along with this program; if not, write to the Free Software
 114 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.