8d02d5df4f16b336cabd814b3b3b42ebf84ad152
[febootstrap.git] / febootstrap-minimize.pod
1 =head1 NAME
2
3 febootstrap-minimize - Minimize an febootstrap image
4
5 =head1 SYNOPSIS
6
7  febootstrap-minimize [--options] DIR
8
9 =head1 DESCRIPTION
10
11 I<febootstrap-minimize> minimizes an L<febootstrap(8)>-created
12 filesystem.  This means that unneeded files and cruft are removed from
13 the image.
14
15 If no options are given, the default is to minimize the image as much
16 as possible.  This means, for example, that locales are removed so the
17 image will only be usable in US-English, there will be no
18 documentation or manual pages, and the image will only work in a UTC
19 timezone.
20
21 Note that image minimization involves deleting files that have been
22 installed by RPM.  Thus after minimization, it is no longer guaranteed
23 that RPM will function correctly on the image.  You should only do
24 this as a final step for "throwaway" appliances that do not need to be
25 modified or upgraded in future.
26
27 =head1 OPTIONS
28
29 =over 4
30
31 =item B<--all>
32
33 Perform all minimization operations, to produce the smallest possible
34 image.  Note in particular that locales are discarded.
35
36 You can perform all minimization operations I<except> X, Y and Z by
37 doing:
38
39  febootstrap-minimize --all --keep-X --keep-Y --keep-Z ...
40
41 (C<--all> can be omitted since it is the default).
42
43 =item B<--none>
44
45 Start with no minimization operations.  You can specify I<only>
46 minimization operations X, Y and Z like this:
47
48  febootstrap-minimize --none --drop-X --drop-Y --drop-Z ...
49
50 =item B<--keep-locales>
51
52 =item B<--drop-locales>
53
54 Keep or drop locale support.
55
56 =item B<--keep-docs>
57
58 =item B<--drop-docs>
59
60 Keep or drop documentation and man pages.
61
62 =item B<--keep-yum-cache>
63
64 =item B<--drop-yum-cache>
65
66 Keep or drop the yum cache.
67
68 =item B<--keep-cracklib>
69
70 =item B<--drop-cracklib>
71
72 Keep or drop cracklib libraries.
73
74 =item B<--keep-i18n>
75
76 =item B<--drop-i18n>
77
78 Keep or drop C</usr/share/i18n>.
79
80 =item B<--keep-zoneinfo>
81
82 =item B<--drop-zoneinfo>
83
84 Keep or drop all timezones (except UTC which is never deleted).
85
86 =back
87
88 =head1 SEE ALSO
89
90 L<febootstrap(8)>.
91
92 =head1 AUTHORS
93
94 Richard W.M. Jones <rjones @ redhat . com>
95
96 =head1 COPYRIGHT
97
98 (C) Copyright 2009 Red Hat Inc.,
99 L<http://et.redhat.com/~rjones/febootstrap>.
100
101 This program is free software; you can redistribute it and/or modify
102 it under the terms of the GNU General Public License as published by
103 the Free Software Foundation; either version 2 of the License, or
104 (at your option) any later version.
105
106 This program is distributed in the hope that it will be useful,
107 but WITHOUT ANY WARRANTY; without even the implied warranty of
108 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
109 GNU General Public License for more details.
110
111 You should have received a copy of the GNU General Public License
112 along with this program; if not, write to the Free Software
113 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.