Move febootstrap-supermin-helper into helper/ subdirectory.

[febootstrap.git] / febootstrap.pod

diff --git a/febootstrap.pod b/febootstrap.pod
index 26035b1..b1e512b 100644 (file)
--- a/febootstrap.pod
+++ b/febootstrap.pod
@@ -70,6 +70,30 @@ yum commands inside the filesystem by hand.
 
 URL to the proxy server that yum should use.
 
 
 URL to the proxy server that yum should use.
 

+=item B<-u source>
+
+=item B<--updates=source>
+
+Pull in updates from an additional updates repository.  The possible
+sources are:
+
+=over 4
+
+=item -u C<http://...> (a URL)
+
+Get updates from the specific URL.
+
+=item -u C<updates-released-fN> (an updates repository name)
+
+Get updates from the public mirrors of the named repository
+(eg. C<updates-released-f10>).  See REPOSITORIES below.
+
+=item -u C<none> (default)
+
+Don't add an updates repository.  This is the default.
+
+=back
+

 =back
 
 =head1 REPOSITORIES
 =back
 
 =head1 REPOSITORIES


@@ -105,8 +129,8 @@ so that yum thinks it is running as root.  Fakeroot keeps track of
 directory as C<I<TARGET>/fakeroot.log>.
 
 This logfile is indexed by inode number, which makes certain
 directory as C<I<TARGET>/fakeroot.log>.
 
 This logfile is indexed by inode number, which makes certain

-operations safe and other operations unsafe.  For example, deleting
-files is usually safe.  Files should be replaced only by doing:
+operations safe and other operations unsafe.
+Files should be replaced only by doing:

 
  echo updated-content > old-file
 
 
  echo updated-content > old-file
 


@@ -115,9 +139,12 @@ files is usually safe.  Files should be replaced only by doing:
 Deleting files and then creating new ones (even with a different name)
 is usually unsafe, because the new files might reuse inodes claimed by
 the old files, and so appear with peculiar permissions
 Deleting files and then creating new ones (even with a different name)
 is usually unsafe, because the new files might reuse inodes claimed by
 the old files, and so appear with peculiar permissions

-(eg. unreadable, or as a symbolic link).  (XXX We need an
-C<febootstrap-install> utility to automate installing new files safely
-into a filesystem).
+(eg. unreadable, or as a symbolic link).
+
+Deleting files is also usually unsafe, although the reasons are more
+subtle.  If you just use C<rm> then the inode number is not deleted
+from C<fakeroot.log> which means it can be reused by another file
+later on.

 
 In most cases it's usually safest to use C<febootstrap-run>.
 
 
 In most cases it's usually safest to use C<febootstrap-run>.
 


@@ -132,11 +159,21 @@ permissions.
 
 =item *
 
 
 =item *
 

+Use L<febootstrap-install(8)> to install a file with permissions
+in the root filesystem.
+
+=item *
+

 Generate an initramfs (compressed cpio) file containing the correct
 permissions using the tool C<febootstrap-to-initramfs>.
 
 =item *
 
 Generate an initramfs (compressed cpio) file containing the correct
 permissions using the tool C<febootstrap-to-initramfs>.
 
 =item *
 

+Generate a supermin appliance using the tool
+C<febootstrap-to-supermin>.
+
+=item *
+

 Apply the permissions to the target directory using the forthcoming
 tool C<febootstrap-fix-root> (requires root).
 
 Apply the permissions to the target directory using the forthcoming
 tool C<febootstrap-fix-root> (requires root).
 


@@ -187,13 +224,15 @@ we should provide a way to cache the repository.
 
 =head1 HOME PAGE
 
 
 =head1 HOME PAGE
 

-L<http://et.redhat.com/~rjones/febootstrap>
+L<http://people.redhat.com/~rjones/febootstrap>

 
 =head1 SEE ALSO
 
 L<febootstrap-to-initramfs(8)>,
 L<febootstrap-minimize(8)>,
 L<febootstrap-run(8)>,
 
 =head1 SEE ALSO
 
 L<febootstrap-to-initramfs(8)>,
 L<febootstrap-minimize(8)>,
 L<febootstrap-run(8)>,

+L<febootstrap-install(8)>,
+L<febootstrap-to-supermin(8)>,

 L<fakeroot(1)>,
 L<fakechroot(1)>,
 L<yum(8)>,
 L<fakeroot(1)>,
 L<fakechroot(1)>,
 L<yum(8)>,


@@ -214,7 +253,7 @@ Richard W.M. Jones <rjones @ redhat . com>
 =head1 COPYRIGHT
 
 (C) Copyright 2009 Red Hat Inc.,
 =head1 COPYRIGHT
 
 (C) Copyright 2009 Red Hat Inc.,

-L<http://et.redhat.com/~rjones/febootstrap>.
+L<http://people.redhat.com/~rjones/febootstrap>.

 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by