Also remove gnome-help directory.
[febootstrap.git] / febootstrap.pod
index a756464..dfc93fc 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>.
@@ -52,8 +52,17 @@ 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.
+which is a small working Fedora installation (but by no means
+minimal).  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
 
@@ -79,18 +88,24 @@ You can use the fakeroot logfile in a number of ways:
 
 =item *
 
-Run C<fakeroot -i fakeroot.log I<command>> in order to run a
-command with the faked file permissions.
+Run
+
+ fakeroot -i fakeroot.log command
+
+in order to run a command with the faked file permissions.  If the
+command will make updates, then do:
+
+ fakeroot -i fakeroot.log -s fakeroot.log command
 
 =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
 
@@ -136,8 +151,8 @@ 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)>,
@@ -147,7 +162,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