gen_build_files.sh uses bashism, document it
[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 FEATURE_SEAMLESS_LZMA
9         bool "Make tar, rpm, modprobe etc understand .lzma data"
10         default n
11         help
12           Make tar, rpm, modprobe etc understand .lzma data.
13
14 config FEATURE_SEAMLESS_BZ2
15         bool "Make tar, rpm, modprobe etc understand .bz2 data"
16         default n
17         help
18           Make tar, rpm, modprobe etc understand .bz2 data.
19
20 config FEATURE_SEAMLESS_GZ
21         bool "Make tar, rpm, modprobe etc understand .gz data"
22         default n
23         help
24           Make tar, rpm, modprobe etc understand .gz data.
25
26 config FEATURE_SEAMLESS_Z
27         bool "Make tar and gunzip understand .Z data"
28         default n
29         help
30           Make tar and gunzip understand .Z data.
31
32 config AR
33         bool "ar"
34         default n
35         help
36           ar is an archival utility program used to create, modify, and
37           extract contents from archives. An archive is a single file holding
38           a collection of other files in a structure that makes it possible to
39           retrieve the original individual files (called archive members).
40           The original files' contents, mode (permissions), timestamp, owner,
41           and group are preserved in the archive, and can be restored on
42           extraction.
43
44           The stored filename is limited to 15 characters. (for more information
45           see long filename support).
46           ar has 60 bytes of overheads for every stored file.
47
48           This implementation of ar can extract archives, it cannot create or
49           modify them.
50           On an x86 system, the ar applet adds about 1K.
51
52           Unless you have a specific application which requires ar, you should
53           probably say N here.
54
55 config FEATURE_AR_LONG_FILENAMES
56         bool "Support for long filenames (not needed for debs)"
57         default n
58         depends on AR
59         help
60           By default the ar format can only store the first 15 characters
61           of the filename, this option removes that limitation.
62           It supports the GNU ar long filename method which moves multiple long
63           filenames into a the data section of a new ar entry.
64
65 config FEATURE_AR_CREATE
66         bool "Support archive creation"
67         default n
68         depends on AR
69         help
70           This enables archive creation (-c and -r) with busybox ar.
71
72 config BUNZIP2
73         bool "bunzip2"
74         default n
75         help
76           bunzip2 is a compression utility using the Burrows-Wheeler block
77           sorting text compression algorithm, and Huffman coding. Compression
78           is generally considerably better than that achieved by more
79           conventional LZ77/LZ78-based compressors, and approaches the
80           performance of the PPM family of statistical compressors.
81
82           Unless you have a specific application which requires bunzip2, you
83           should probably say N here.
84
85 config BZIP2
86         bool "bzip2"
87         default n
88         help
89           bzip2 is a compression utility using the Burrows-Wheeler block
90           sorting text compression algorithm, and Huffman coding. Compression
91           is generally considerably better than that achieved by more
92           conventional LZ77/LZ78-based compressors, and approaches the
93           performance of the PPM family of statistical compressors.
94
95           Unless you have a specific application which requires bzip2, you
96           should probably say N here.
97
98 config CPIO
99         bool "cpio"
100         default n
101         help
102           cpio is an archival utility program used to create, modify, and
103           extract contents from archives.
104           cpio has 110 bytes of overheads for every stored file.
105
106           This implementation of cpio can extract cpio archives created in the
107           "newc" or "crc" format, it cannot create or modify them.
108
109           Unless you have a specific application which requires cpio, you
110           should probably say N here.
111
112 config FEATURE_CPIO_O
113         bool "Support for archive creation"
114         default n
115         depends on CPIO
116         help
117           This implementation of cpio can create cpio archives in the "newc"
118           format only.
119
120 config FEATURE_CPIO_P
121         bool "Support for passthrough mode"
122         default n
123         depends on FEATURE_CPIO_O
124         help
125           Passthrough mode. Rarely used.
126
127 config DPKG
128         bool "dpkg"
129         default n
130         select FEATURE_SEAMLESS_GZ
131         help
132           dpkg is a medium-level tool to install, build, remove and manage
133           Debian packages.
134
135           This implementation of dpkg has a number of limitations,
136           you should use the official dpkg if possible.
137
138 config DPKG_DEB
139         bool "dpkg_deb"
140         default n
141         select FEATURE_SEAMLESS_GZ
142         help
143           dpkg-deb unpacks and provides information about Debian archives.
144
145           This implementation of dpkg-deb cannot pack archives.
146
147           Unless you have a specific application which requires dpkg-deb,
148           say N here.
149
150 config FEATURE_DPKG_DEB_EXTRACT_ONLY
151         bool "Extract only (-x)"
152         default n
153         depends on DPKG_DEB
154         help
155           This reduces dpkg-deb to the equivalent of
156           "ar -p <deb> data.tar.gz | tar -zx". However it saves space as none
157           of the extra dpkg-deb, ar or tar options are needed, they are linked
158           to internally.
159
160 config GUNZIP
161         bool "gunzip"
162         default n
163         help
164           gunzip is used to decompress archives created by gzip.
165           You can use the `-t' option to test the integrity of
166           an archive, without decompressing it.
167
168 config GZIP
169         bool "gzip"
170         default n
171         help
172           gzip is used to compress files.
173           It's probably the most widely used UNIX compression program.
174
175 config FEATURE_GZIP_LONG_OPTIONS
176         bool "Enable long options"
177         default n
178         depends on GZIP && LONG_OPTS
179         help
180           Enable use of long options, increases size by about 106 Bytes
181
182 config LZOP
183         bool "lzop"
184         default n
185         help
186           Lzop compression/decompresion.
187
188 config LZOP_COMPR_HIGH
189         bool "lzop complession levels 7,8,9 (not very useful)"
190         default n
191         depends on LZOP
192         help
193           High levels (7,8,9) of lzop compression. These levels
194           are actually slower than gzip at equivalent compression ratios
195           and take up 3.2K of code.
196
197 config RPM2CPIO
198         bool "rpm2cpio"
199         default n
200         help
201           Converts an RPM file into a CPIO archive.
202
203 config RPM
204         bool "rpm"
205         default n
206         help
207           Mini RPM applet - queries and extracts RPM packages.
208
209 config TAR
210         bool "tar"
211         default n
212         help
213           tar is an archiving program. It's commonly used with gzip to
214           create compressed archives. It's probably the most widely used
215           UNIX archive program.
216
217 config FEATURE_TAR_CREATE
218         bool "Enable archive creation"
219         default y
220         depends on TAR
221         help
222           If you enable this option you'll be able to create
223           tar archives using the `-c' option.
224
225 config FEATURE_TAR_AUTODETECT
226         bool "Autodetect compressed tarballs"
227         default n
228         depends on TAR && (FEATURE_SEAMLESS_Z || FEATURE_SEAMLESS_GZ || FEATURE_SEAMLESS_BZ2 || FEATURE_SEAMLESS_LZMA)
229         help
230           With this option tar can automatically detect compressed
231           tarballs. Currently it works only on files (not pipes etc).
232
233 config FEATURE_TAR_FROM
234         bool "Enable -X (exclude from) and -T (include from) options)"
235         default n
236         depends on TAR
237         help
238           If you enable this option you'll be able to specify
239           a list of files to include or exclude from an archive.
240
241 config FEATURE_TAR_OLDGNU_COMPATIBILITY
242         bool "Support for old tar header format"
243         default N
244         depends on TAR || DPKG
245         help
246           This option is required to unpack archives created in
247           the old GNU format; help to kill this old format by
248           repacking your ancient archives with the new format.
249
250 config FEATURE_TAR_OLDSUN_COMPATIBILITY
251         bool "Enable untarring of tarballs with checksums produced by buggy Sun tar"
252         default N
253         depends on TAR || DPKG
254         help
255           This option is required to unpack archives created by some old
256           version of Sun's tar (it was calculating checksum using signed
257           arithmetic). It is said to be fixed in newer Sun tar, but "old"
258           tarballs still exist.
259
260 config FEATURE_TAR_GNU_EXTENSIONS
261         bool "Support for GNU tar extensions (long filenames)"
262         default y
263         depends on TAR || DPKG
264         help
265           With this option busybox supports GNU long filenames and
266           linknames.
267
268 config FEATURE_TAR_LONG_OPTIONS
269         bool "Enable long options"
270         default n
271         depends on TAR && LONG_OPTS
272         help
273           Enable use of long options, increases size by about 400 Bytes
274
275 config FEATURE_TAR_UNAME_GNAME
276         bool "Enable use of user and group names"
277         default n
278         depends on TAR
279         help
280           Enables use of user and group names in tar. This affects contents
281           listings (-t) and preserving permissions when unpacking (-p).
282           +200 bytes.
283
284 config FEATURE_TAR_NOPRESERVE_TIME
285         bool "Enable -m (do not preserve time) option"
286         default n
287         depends on TAR
288         help
289           With this option busybox supports GNU tar -m
290           (do not preserve time) option.
291
292 config FEATURE_TAR_SELINUX
293         bool "Support for extracting SELinux labels"
294         default n
295         depends on TAR && SELINUX
296         help
297           With this option busybox supports restoring SELinux labels
298           when extracting files from tar archives.
299
300 config UNCOMPRESS
301         bool "uncompress"
302         default n
303         help
304           uncompress is used to decompress archives created by compress.
305           Not much used anymore, replaced by gzip/gunzip.
306
307 config UNLZMA
308         bool "unlzma"
309         default n
310         help
311           unlzma is a compression utility using the Lempel-Ziv-Markov chain
312           compression algorithm, and range coding. Compression
313           is generally considerably better than that achieved by the bzip2
314           compressors.
315
316           The BusyBox unlzma applet is limited to de-compression only.
317           On an x86 system, this applet adds about 4K.
318
319           Unless you have a specific application which requires unlzma, you
320           should probably say N here.
321
322 config FEATURE_LZMA_FAST
323         bool "Optimize unlzma for speed"
324         default n
325         depends on UNLZMA
326         help
327           This option reduces decompression time by about 25% at the cost of
328           a 1K bigger binary.
329
330 config UNZIP
331         bool "unzip"
332         default n
333         help
334           unzip will list or extract files from a ZIP archive,
335           commonly found on DOS/WIN systems. The default behavior
336           (with no options) is to extract the archive into the
337           current directory. Use the `-d' option to extract to a
338           directory of your choice.
339
340 endmenu