- spelling
[oweals/busybox.git] / archival / Config.in
1 #
2 # For a description of the syntax of this configuration file,
3 # see scripts/kbuild/config-language.txt.
4 #
5
6 menu "Archival Utilities"
7
8 config CONFIG_AR
9         bool "ar"
10         default n
11         help
12           ar is an archival utility program used to create, modify, and
13           extract contents from archives.  An archive is a single file holding
14           a collection of other files in a structure that makes it possible to
15           retrieve the original individual files (called archive members).
16           The original files' contents, mode (permissions), timestamp, owner,
17           and group are preserved in the archive, and can be restored on
18           extraction.
19
20           The stored filename is limited to 15 characters. (for more information
21           see long filename support).
22           ar has 60 bytes of overheads for every stored file.
23
24           This implementation of ar can extract archives, it cannot create or
25           modify them.
26           On an x86 system, the ar applet adds about 1K.
27
28           Unless you have a specific application which requires ar, you should
29           probably say N here.
30
31 config CONFIG_FEATURE_AR_LONG_FILENAMES
32         bool "Enable support for long filenames (not need for debs)"
33         default n
34         depends on CONFIG_AR
35         help
36           By default the ar format can only store the first 15 characters of the
37           filename, this option removes that limitation.
38           It supports the GNU ar long filename method which moves multiple long
39           filenames into a the data section of a new ar entry.
40
41 config CONFIG_BUNZIP2
42         bool "bunzip2"
43         default n
44         help
45           bunzip2 is a compression utility using the Burrows-Wheeler block
46           sorting text compression algorithm, and Huffman coding.  Compression
47           is generally considerably better than that achieved by more
48           conventional LZ77/LZ78-based compressors, and approaches the
49           performance of the PPM family of statistical compressors.
50
51           The BusyBox bunzip2 applet is limited to de-compression only.
52           On an x86 system, this applet adds about 11K.
53
54           Unless you have a specific application which requires bunzip2, you
55           should probably say N here.
56
57 config CONFIG_CPIO
58         bool "cpio"
59         default n
60         help
61           cpio is an archival utility program used to create, modify, and extract
62           contents from archives.
63           cpio has 110 bytes of overheads for every stored file.
64
65           This implementation of cpio can extract cpio archives created in the
66           "newc" or "crc" format, it cannot create or modify them.
67
68           Unless you have a specific application which requires cpio, you should
69           probably say N here.
70
71 config CONFIG_DPKG
72         bool "dpkg"
73         default n
74         help
75           dpkg is a medium-level tool to install, build, remove and manage Debian packages.
76
77           This implementation of dpkg has a number of limitations, you should use the
78           official dpkg if possible.
79
80 config CONFIG_DPKG_DEB
81         bool "dpkg_deb"
82         default n
83         help
84           dpkg-deb packs, unpacks and provides information about Debian archives.
85
86           This implementation of dpkg-deb cannot pack archives.
87
88           Unless you have a specific application which requires dpkg-deb, you should
89           probably say N here.
90
91 config CONFIG_FEATURE_DPKG_DEB_EXTRACT_ONLY
92         bool "extract only (-x)"
93         default n
94         depends on CONFIG_DPKG_DEB
95         help
96           This reduces dpkg-deb to the equivalent of "ar -p <deb> data.tar.gz | tar -zx".
97           However it saves space as none of the extra dpkg-deb, ar or tar options are
98           needed, they are linked to internally.
99
100 config CONFIG_GUNZIP
101         bool "gunzip"
102         default n
103         help
104           gunzip is used to decompress archives created by gzip.
105           You can use the `-t' option to test the integrity of
106           an archive, without decompressing it.
107
108 config CONFIG_FEATURE_GUNZIP_UNCOMPRESS
109         bool "Uncompress support"
110         default n
111         depends on CONFIG_GUNZIP
112         help
113           Enable if you want gunzip to have the ability to decompress
114           archives created by the program compress (not much
115           used anymore).
116
117 config CONFIG_GZIP
118         bool "gzip"
119         default n
120         help
121           gzip is used to compress files.
122           It's probably the most widely used UNIX compression program.
123
124 config CONFIG_RPM2CPIO
125         bool "rpm2cpio"
126         default n
127         help
128           Converts an RPM file into a CPIO archive.
129
130 config CONFIG_RPM
131         bool "rpm"
132         default n
133         help
134           Mini RPM applet - queries and extracts
135
136 config CONFIG_TAR
137         bool "tar"
138         default n
139         help
140           tar is an archiving program. It's commonly used with gzip to
141           create compressed archives. It's probably the most widely used
142           UNIX archive program.
143
144 config CONFIG_FEATURE_TAR_CREATE
145         bool "Enable archive creation"
146         default y
147         depends on CONFIG_TAR
148         help
149           If you enable this option you'll be able to create
150           tar archives using the `-c' option.
151
152 config CONFIG_FEATURE_TAR_BZIP2
153         bool "Enable -j option to handle .tar.bz2 files"
154         default n
155         depends on CONFIG_TAR
156         help
157           If you enable this option you'll be able to extract
158           archives compressed with bzip2.
159
160 config CONFIG_FEATURE_TAR_LZMA
161         bool "Enable -a option to handle .tar.lzma files"
162         default n
163         depends on CONFIG_TAR
164         help
165           If you enable this option you'll be able to extract
166           archives compressed with lzma.
167
168 config CONFIG_FEATURE_TAR_FROM
169         bool "Enable -X (exclude from) and -T (include from) options)"
170         default n
171         depends on CONFIG_TAR
172         help
173           If you enable this option you'll be able to specify
174           a list of files to include or exclude from an archive.
175
176 config CONFIG_FEATURE_TAR_GZIP
177         bool "Enable -z option"
178         default y
179         depends on CONFIG_TAR
180         help
181           If you enable this option tar will be able to call gzip,
182           when creating or extracting tar gziped archives.
183
184 config CONFIG_FEATURE_TAR_COMPRESS
185         bool "Enable -Z option"
186         default n
187         depends on CONFIG_TAR
188         help
189           If you enable this option tar will be able to call uncompress,
190           when extracting .tar.Z archives.
191
192 config CONFIG_FEATURE_TAR_OLDGNU_COMPATIBILITY
193         bool "Enable support for old tar header format"
194         default N
195         depends on CONFIG_TAR
196         help
197           This option is required to unpack archives created in
198           the old GNU format; help to kill this old format by
199           repacking your ancient archives with the new format.
200
201 config CONFIG_FEATURE_TAR_GNU_EXTENSIONS
202         bool "Enable support for some GNU tar extensions"
203         default y
204         depends on CONFIG_TAR
205         help
206           With this option busybox supports GNU long filenames and
207           linknames.
208
209 config CONFIG_FEATURE_TAR_LONG_OPTIONS
210         bool "Enable long options"
211         default n
212         depends on CONFIG_TAR && CONFIG_GETOPT_LONG
213         help
214                 Enable use of long options, increases size by about 400 Bytes
215
216 config CONFIG_UNCOMPRESS
217         bool "uncompress"
218         default n
219         help
220           uncompress is used to decompress archives created by compress.
221           Not much used anymore, replaced by gzip/gunzip.
222
223 config CONFIG_UNLZMA
224         bool "unlzma"
225         default n
226         help
227           unlzma is a compression utility using the Lempel-Ziv-Markov chain
228           compression algorithm, and range coding.  Compression
229           is generally considerably better than that achieved by the bzip2
230           compressors.
231
232           The BusyBox unlzma applet is limited to de-compression only.
233           On an x86 system, this applet adds about 4K.
234
235           Unless you have a specific application which requires unlzma, you
236           should probably say N here.
237
238 config CONFIG_FEATURE_LZMA_FAST
239         bool "Optimze unlzma for speed"
240         default n
241         depends on CONFIG_UNLZMA
242         help
243           This option reduces decompression time by about 33% at the cost of
244           a 2K bigger binary.
245
246 config CONFIG_UNZIP
247         bool "unzip"
248         default n
249         help
250           unzip will list or extract files from a ZIP archive,
251           commonly found on DOS/WIN systems. The default behavior
252           (with no options) is to extract the archive into the
253           current directory. Use the `-d' option to extract to a
254           directory of your choice.
255
256 comment "Common options for cpio and tar"
257         depends on CONFIG_CPIO || CONFIG_TAR
258
259 config CONFIG_FEATURE_UNARCHIVE_TAPE
260         bool "Enable tape drive support"
261         default n
262         depends on CONFIG_CPIO || CONFIG_TAR
263         help
264           I don't think this is needed anymore.
265
266 comment "Common options for dpkg and dpkg_deb"
267         depends on CONFIG_DPKG || CONFIG_DPKG_DEB
268
269 config CONFIG_FEATURE_DEB_TAR_GZ
270         bool "gzip debian packages (normal)"
271         default y if CONFIG_DPKG || CONFIG_DPKG_DEB
272         depends on CONFIG_DPKG || CONFIG_DPKG_DEB
273         help
274           This is the default compression method inside the debian ar file.
275
276           If you want compatibility with standard .deb's you should say yes here.
277
278 config CONFIG_FEATURE_DEB_TAR_BZ2
279         bool "bzip2 debian packages"
280         default n
281         depends on CONFIG_DPKG || CONFIG_DPKG_DEB
282         help
283           This allows dpkg and dpkg-deb to extract deb's that are compressed internally
284           with bzip2 instead of gzip.
285
286           You only want this if you are creating your own custom debian packages that
287           use an internal control.tar.bz2 or data.tar.bz2.
288
289 config CONFIG_FEATURE_DEB_TAR_LZMA
290         bool "lzma debian packages"
291         default n
292         depends on CONFIG_DPKG || CONFIG_DPKG_DEB
293         help
294           This allows dpkg and dpkg-deb to extract deb's that are compressed
295           internally with lzma instead of gzip.
296
297           You only want this if you are creating your own custom debian
298           packages that use an internal control.tar.lzma or data.tar.lzma.
299
300 endmenu