More minimization (now 15.9 MB)
[febootstrap.git] / febootstrap.pod
index eac9573..32b1828 100644 (file)
@@ -11,7 +11,7 @@ febootstrap - Bootstrap a basic Fedora system (like Debian debootstrap)
  febootstrap fedora-10 /tmp/f10
  febootstrap rawhide /tmp/rawhide
  febootstrap rawhide /tmp/rawhide http://mymirror/rawhide/x86_64/os
- febootstrap --groupinstall="Mail Server" rawhide /tmp/rawhide
+ febootstrap --groupinstall="Mail Server" fedora-10 /tmp/mailserver
 
 =head1 DESCRIPTION
 
@@ -21,12 +21,12 @@ I<TARGET>.  Optionally I<MIRROR> can point to a local mirror
 (otherwise the public Fedora mirrors are used).  I<REPO> names are
 C<fedora-I<VERSION>> (eg. C<fedora-10>) or C<rawhide>.
 
-febootstrap does not need to be run as root.  If for some reason you
-do run it as root, then it works slightly differently and may have
+febootstrap does I<not> need to be run as root.  If for some reason
+you do run it as root, then it works slightly differently and may have
 side effects such as stopping or starting system daemons.
 
-For more advanced needs, take a look at L<mock(1)> and
-C<livecd-creator>.
+For more advanced needs, take a look at L<mock(1)>, C<livecd-creator>
+and I<thincrust.net>'s C<appliance-creator>.
 
 The normal output is a root directory located at I<TARGET> and
 a fakeroot logfile at C<I<TARGET>/fakeroot.log>.
@@ -35,21 +35,45 @@ a fakeroot logfile at C<I<TARGET>/fakeroot.log>.
 
 =over 4
 
-=item B<--install="list of packages separated by commas">
+=item B<-i package>
 
-=item B<--groupinstall="list of groups separated by commas">
+=item B<--install=package>
 
-Specify the list of packages or groups to install.  These are passed
-directly to C<yum install> or C<yum groupinstall> commands, and thus
-any dependencies are also resolved by yum.  You can also use shell
-globs and filenames here, as with ordinary yum.
+=item B<-g "group">
+
+=item B<--groupinstall="group">
+
+Specify the package or group to install.  To list multiple packages or
+groups, you must give multiple C<-i> or C<-g> options.  Group names
+can contain spaces, so use quotes where necessary.
+
+These are passed directly to C<yum install> or C<yum groupinstall>
+commands, and thus any dependencies are also resolved by yum.  You can
+also use shell globs and filenames here, as with ordinary yum.
 
 If no packages or groups are given, then we install the C<Core> group
 which is the smallest working Fedora installation.  Use C<yum
 groupinfo Core> to list the packages currently in the C<Core> group.
 
+=item B<--no-clean>
+
+Normally febootstrap will clean up the yum repository
+(C</var/cache/yum> inside the image).  This contains the downloaded
+RPMs and metadata.  However if you give the C<--no-clean> option, then
+the yum repository is left.  This is useful if you want to run further
+yum commands inside the filesystem by hand.
+
 =back
 
+=head1 REPOSITORIES
+
+You can list available repositories by visiting this URL:
+
+L<http://mirrors.fedoraproject.org/mirrorlist?repo=help&arch=i386>
+
+(If necessary replace C<i386> with your architecture, but it seems
+unlikely that this list will change based on architecture).
+
 =head1 FAKEROOT LOGFILE
 
 When febootstrap is run as non-root (the normal case) we use fakeroot
@@ -68,13 +92,13 @@ command with the faked file permissions.
 
 =item *
 
-Generate an initrd (cpio) file containing the correct permissions
-using the tool C<febootstrap-to-initrd>.
+Generate an initramfs (compressed cpio) file containing the correct
+permissions using the tool C<febootstrap-to-initramfs>.
 
 =item *
 
-Apply the permissions to the target directory using the tool
-C<febootstrap-fix-root> (requires root).
+Apply the permissions to the target directory using the forthcoming
+tool C<febootstrap-fix-root> (requires root).
 
 =back
 
@@ -110,14 +134,18 @@ linked.  We have examined what this binary does, and it is not really
 necessary for installs.  If it makes you happier, you can run it the
 first time you boot the new system.
 
+febootstrap recreates the repository anew each time, and this causes
+yum to download all the RPMs every time.  This is very wasteful, and
+we should provide a way to cache the repository.
+
 =head1 HOME PAGE
 
 L<http://et.redhat.com/~rjones/febootstrap>
 
 =head1 SEE ALSO
 
-L<febootstrap-to-initrd(8)>,
-L<febootstrap-fix-root(8)>,
+L<febootstrap-to-initramfs(8)>,
+L<febootstrap-minimize(8)>,
 L<fakeroot(1)>,
 L<fakechroot(1)>,
 L<yum(8)>,
@@ -127,7 +155,9 @@ L<rpm(8)>.
 
 L<mock(1)>,
 L<http://fedoraproject.org/wiki/FedoraLiveCD/LiveCDHowTo>,
-L<debootstrap(8)>.
+L<http://thincrust.net/>,
+L<debootstrap(8)>,
+C<ubuntu-vm-builder>.
 
 =head1 AUTHORS