Add first version of the febootstrap-minimize script.

[febootstrap.git] / febootstrap-minimize.pod

diff --git a/febootstrap-minimize.pod b/febootstrap-minimize.pod
new file mode 100644 (file)
index 0000000..8d02d5d
--- /dev/null
+++ b/febootstrap-minimize.pod
@@ -0,0 +1,113 @@
+=head1 NAME
+
+febootstrap-minimize - Minimize an febootstrap image
+
+=head1 SYNOPSIS
+
+ febootstrap-minimize [--options] DIR
+
+=head1 DESCRIPTION
+
+I<febootstrap-minimize> minimizes an L<febootstrap(8)>-created
+filesystem.  This means that unneeded files and cruft are removed from
+the image.
+
+If no options are given, the default is to minimize the image as much
+as possible.  This means, for example, that locales are removed so the
+image will only be usable in US-English, there will be no
+documentation or manual pages, and the image will only work in a UTC
+timezone.
+
+Note that image minimization involves deleting files that have been
+installed by RPM.  Thus after minimization, it is no longer guaranteed
+that RPM will function correctly on the image.  You should only do
+this as a final step for "throwaway" appliances that do not need to be
+modified or upgraded in future.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<--all>
+
+Perform all minimization operations, to produce the smallest possible
+image.  Note in particular that locales are discarded.
+
+You can perform all minimization operations I<except> X, Y and Z by
+doing:
+
+ febootstrap-minimize --all --keep-X --keep-Y --keep-Z ...
+
+(C<--all> can be omitted since it is the default).
+
+=item B<--none>
+
+Start with no minimization operations.  You can specify I<only>
+minimization operations X, Y and Z like this:
+
+ febootstrap-minimize --none --drop-X --drop-Y --drop-Z ...
+
+=item B<--keep-locales>
+
+=item B<--drop-locales>
+
+Keep or drop locale support.
+
+=item B<--keep-docs>
+
+=item B<--drop-docs>
+
+Keep or drop documentation and man pages.
+
+=item B<--keep-yum-cache>
+
+=item B<--drop-yum-cache>
+
+Keep or drop the yum cache.
+
+=item B<--keep-cracklib>
+
+=item B<--drop-cracklib>
+
+Keep or drop cracklib libraries.
+
+=item B<--keep-i18n>
+
+=item B<--drop-i18n>
+
+Keep or drop C</usr/share/i18n>.
+
+=item B<--keep-zoneinfo>
+
+=item B<--drop-zoneinfo>
+
+Keep or drop all timezones (except UTC which is never deleted).
+
+=back
+
+=head1 SEE ALSO
+
+L<febootstrap(8)>.
+
+=head1 AUTHORS
+
+Richard W.M. Jones <rjones @ redhat . com>
+
+=head1 COPYRIGHT
+
+(C) Copyright 2009 Red Hat Inc.,
+L<http://et.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
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.