gen_build_files.sh uses bashism, document it
[oweals/busybox.git] / archival / Config.in
index ecef07f7ce192dc3a344d27864dac1b9ab7ca1b0..deacc28222289afc1250fd009e0ee973461c52c9 100644 (file)
 
 menu "Archival Utilities"
 
-config CONFIG_AR
+config FEATURE_SEAMLESS_LZMA
+       bool "Make tar, rpm, modprobe etc understand .lzma data"
+       default n
+       help
+         Make tar, rpm, modprobe etc understand .lzma data.
+
+config FEATURE_SEAMLESS_BZ2
+       bool "Make tar, rpm, modprobe etc understand .bz2 data"
+       default n
+       help
+         Make tar, rpm, modprobe etc understand .bz2 data.
+
+config FEATURE_SEAMLESS_GZ
+       bool "Make tar, rpm, modprobe etc understand .gz data"
+       default n
+       help
+         Make tar, rpm, modprobe etc understand .gz data.
+
+config FEATURE_SEAMLESS_Z
+       bool "Make tar and gunzip understand .Z data"
+       default n
+       help
+         Make tar and gunzip understand .Z data.
+
+config AR
        bool "ar"
        default n
        help
-         Please submit a patch to add help text for this item.
+         ar is an archival utility program used to create, modify, and
+         extract contents from archives. An archive is a single file holding
+         a collection of other files in a structure that makes it possible to
+         retrieve the original individual files (called archive members).
+         The original files' contents, mode (permissions), timestamp, owner,
+         and group are preserved in the archive, and can be restored on
+         extraction.
+
+         The stored filename is limited to 15 characters. (for more information
+         see long filename support).
+         ar has 60 bytes of overheads for every stored file.
+
+         This implementation of ar can extract archives, it cannot create or
+         modify them.
+         On an x86 system, the ar applet adds about 1K.
+
+         Unless you have a specific application which requires ar, you should
+         probably say N here.
+
+config FEATURE_AR_LONG_FILENAMES
+       bool "Support for long filenames (not needed for debs)"
+       default n
+       depends on AR
+       help
+         By default the ar format can only store the first 15 characters
+         of the filename, this option removes that limitation.
+         It supports the GNU ar long filename method which moves multiple long
+         filenames into a the data section of a new ar entry.
 
-config CONFIG_FEATURE_AR_LONG_FILENAMES
-       bool "  Enable support for long filenames (not need for debs)"
+config FEATURE_AR_CREATE
+       bool "Support archive creation"
        default n
-       depends on CONFIG_AR
+       depends on AR
        help
-         Please submit a patch to add help text for this item.
+         This enables archive creation (-c and -r) with busybox ar.
 
-config CONFIG_BUNZIP2
+config BUNZIP2
        bool "bunzip2"
        default n
        help
-         Please submit a patch to add help text for this item.
+         bunzip2 is a compression utility using the Burrows-Wheeler block
+         sorting text compression algorithm, and Huffman coding. Compression
+         is generally considerably better than that achieved by more
+         conventional LZ77/LZ78-based compressors, and approaches the
+         performance of the PPM family of statistical compressors.
+
+         Unless you have a specific application which requires bunzip2, you
+         should probably say N here.
+
+config BZIP2
+       bool "bzip2"
+       default n
+       help
+         bzip2 is a compression utility using the Burrows-Wheeler block
+         sorting text compression algorithm, and Huffman coding. Compression
+         is generally considerably better than that achieved by more
+         conventional LZ77/LZ78-based compressors, and approaches the
+         performance of the PPM family of statistical compressors.
+
+         Unless you have a specific application which requires bzip2, you
+         should probably say N here.
 
-config CONFIG_CPIO
+config CPIO
        bool "cpio"
        default n
        help
-         Please submit a patch to add help text for this item.
+         cpio is an archival utility program used to create, modify, and
+         extract contents from archives.
+         cpio has 110 bytes of overheads for every stored file.
 
-config CONFIG_DPKG
+         This implementation of cpio can extract cpio archives created in the
+         "newc" or "crc" format, it cannot create or modify them.
+
+         Unless you have a specific application which requires cpio, you
+         should probably say N here.
+
+config FEATURE_CPIO_O
+       bool "Support for archive creation"
+       default n
+       depends on CPIO
+       help
+         This implementation of cpio can create cpio archives in the "newc"
+         format only.
+
+config FEATURE_CPIO_P
+       bool "Support for passthrough mode"
+       default n
+       depends on FEATURE_CPIO_O
+       help
+         Passthrough mode. Rarely used.
+
+config DPKG
        bool "dpkg"
        default n
+       select FEATURE_SEAMLESS_GZ
        help
-         Please submit a patch to add help text for this item.
+         dpkg is a medium-level tool to install, build, remove and manage
+         Debian packages.
+
+         This implementation of dpkg has a number of limitations,
+         you should use the official dpkg if possible.
 
-config CONFIG_DPKG_DEB
+config DPKG_DEB
        bool "dpkg_deb"
        default n
+       select FEATURE_SEAMLESS_GZ
        help
-         Please submit a patch to add help text for this item.
+         dpkg-deb unpacks and provides information about Debian archives.
+
+         This implementation of dpkg-deb cannot pack archives.
+
+         Unless you have a specific application which requires dpkg-deb,
+         say N here.
 
-config CONFIG_FEATURE_DPKG_DEB_EXTRACT_ONLY
-       bool "  extract only (-x)"
+config FEATURE_DPKG_DEB_EXTRACT_ONLY
+       bool "Extract only (-x)"
        default n
-       depends on CONFIG_DPKG_DEB
+       depends on DPKG_DEB
        help
-         Please submit a patch to add help text for this item.
+         This reduces dpkg-deb to the equivalent of
+         "ar -p <deb> data.tar.gz | tar -zx". However it saves space as none
+         of the extra dpkg-deb, ar or tar options are needed, they are linked
+         to internally.
 
-config CONFIG_FEATURE_DEB_TAR_GZ
-       bool "  gzip debian packages (normal)"
-       default y if CONFIG_DPKG || CONFIG_DPKG_DEB
-       depends on CONFIG_DPKG || CONFIG_DPKG_DEB
+config GUNZIP
+       bool "gunzip"
+       default n
        help
-         Please submit a patch to add help text for this item.
+         gunzip is used to decompress archives created by gzip.
+         You can use the `-t' option to test the integrity of
+         an archive, without decompressing it.
 
-config CONFIG_FEATURE_DEB_TAR_BZ2
-       bool "  bzip2 debian packages"
+config GZIP
+       bool "gzip"
        default n
-       depends on CONFIG_DPKG || CONFIG_DPKG_DEB
        help
-         Please submit a patch to add help text for this item.
+         gzip is used to compress files.
+         It's probably the most widely used UNIX compression program.
 
-config CONFIG_GUNZIP
-       bool "gunzip"
+config FEATURE_GZIP_LONG_OPTIONS
+       bool "Enable long options"
        default n
+       depends on GZIP && LONG_OPTS
        help
-         Please submit a patch to add help text for this item.
+         Enable use of long options, increases size by about 106 Bytes
 
-config CONFIG_FEATURE_GUNZIP_UNCOMPRESS
-       bool "  Uncompress support"
+config LZOP
+       bool "lzop"
        default n
-       depends on CONFIG_GUNZIP
        help
-         Please submit a patch to add help text for this item.
+         Lzop compression/decompresion.
 
-config CONFIG_GZIP
-       bool "gzip"
+config LZOP_COMPR_HIGH
+       bool "lzop complession levels 7,8,9 (not very useful)"
        default n
+       depends on LZOP
        help
-         Please submit a patch to add help text for this item.
+         High levels (7,8,9) of lzop compression. These levels
+         are actually slower than gzip at equivalent compression ratios
+         and take up 3.2K of code.
 
-config CONFIG_RPM2CPIO
+config RPM2CPIO
        bool "rpm2cpio"
        default n
        help
-         Please submit a patch to add help text for this item.
+         Converts an RPM file into a CPIO archive.
+
+config RPM
+       bool "rpm"
+       default n
+       help
+         Mini RPM applet - queries and extracts RPM packages.
 
-config CONFIG_TAR
+config TAR
        bool "tar"
        default n
        help
-         Please submit a patch to add help text for this item.
+         tar is an archiving program. It's commonly used with gzip to
+         create compressed archives. It's probably the most widely used
+         UNIX archive program.
 
-config CONFIG_FEATURE_TAR_CREATE
-       bool "  Enable archive creation"
+config FEATURE_TAR_CREATE
+       bool "Enable archive creation"
        default y
-       depends on CONFIG_TAR
+       depends on TAR
        help
-         Please submit a patch to add help text for this item.
+         If you enable this option you'll be able to create
+         tar archives using the `-c' option.
 
-config CONFIG_FEATURE_TAR_BZIP2
-       bool "  Enable -j option to handle .tar.bz2 files"
+config FEATURE_TAR_AUTODETECT
+       bool "Autodetect compressed tarballs"
        default n
-       depends on CONFIG_TAR
+       depends on TAR && (FEATURE_SEAMLESS_Z || FEATURE_SEAMLESS_GZ || FEATURE_SEAMLESS_BZ2 || FEATURE_SEAMLESS_LZMA)
        help
-         Please submit a patch to add help text for this item.
+         With this option tar can automatically detect compressed
+         tarballs. Currently it works only on files (not pipes etc).
 
-config CONFIG_FEATURE_TAR_EXCLUDE
-       bool "  Enable -X and --exclude options (exclude files)"
+config FEATURE_TAR_FROM
+       bool "Enable -X (exclude from) and -T (include from) options)"
        default n
-       depends on CONFIG_TAR
+       depends on TAR
        help
-         Please submit a patch to add help text for this item.
+         If you enable this option you'll be able to specify
+         a list of files to include or exclude from an archive.
 
-config CONFIG_FEATURE_TAR_GZIP
-       bool "  Enable -z option"
+config FEATURE_TAR_OLDGNU_COMPATIBILITY
+       bool "Support for old tar header format"
+       default N
+       depends on TAR || DPKG
+       help
+         This option is required to unpack archives created in
+         the old GNU format; help to kill this old format by
+         repacking your ancient archives with the new format.
+
+config FEATURE_TAR_OLDSUN_COMPATIBILITY
+       bool "Enable untarring of tarballs with checksums produced by buggy Sun tar"
+       default N
+       depends on TAR || DPKG
+       help
+         This option is required to unpack archives created by some old
+         version of Sun's tar (it was calculating checksum using signed
+         arithmetic). It is said to be fixed in newer Sun tar, but "old"
+         tarballs still exist.
+
+config FEATURE_TAR_GNU_EXTENSIONS
+       bool "Support for GNU tar extensions (long filenames)"
        default y
-       depends on CONFIG_TAR
+       depends on TAR || DPKG
        help
-         Please submit a patch to add help text for this item.
+         With this option busybox supports GNU long filenames and
+         linknames.
 
-config CONFIG_FEATURE_TAR_OLD_FORMAT
-       bool "  Enable support for old tar header format"
+config FEATURE_TAR_LONG_OPTIONS
+       bool "Enable long options"
        default n
-       depends on CONFIG_TAR
+       depends on TAR && LONG_OPTS
        help
-         Please submit a patch to add help text for this item.
+         Enable use of long options, increases size by about 400 Bytes
 
-config CONFIG_FEATURE_GNUTAR_LONG_FILENAME
-       bool "  Enable support for GNU long filenames"
-       default y
-       depends on CONFIG_TAR
+config FEATURE_TAR_UNAME_GNAME
+       bool "Enable use of user and group names"
+       default n
+       depends on TAR
        help
-         Please submit a patch to add help text for this item.
+         Enables use of user and group names in tar. This affects contents
+         listings (-t) and preserving permissions when unpacking (-p).
+         +200 bytes.
 
-config CONFIG_FEATURE_UNARCHIVE_TAPE
-       bool "  Enable tape drive support"
+config FEATURE_TAR_NOPRESERVE_TIME
+       bool "Enable -m (do not preserve time) option"
        default n
-       depends on CONFIG_TAR || CONFIG_CPIO
+       depends on TAR
        help
-         Please submit a patch to add help text for this item.
+         With this option busybox supports GNU tar -m
+         (do not preserve time) option.
 
-config CONFIG_UNCOMPRESS
+config FEATURE_TAR_SELINUX
+       bool "Support for extracting SELinux labels"
+       default n
+       depends on TAR && SELINUX
+       help
+         With this option busybox supports restoring SELinux labels
+         when extracting files from tar archives.
+
+config UNCOMPRESS
        bool "uncompress"
        default n
        help
-         Please submit a patch to add help text for this item.
+         uncompress is used to decompress archives created by compress.
+         Not much used anymore, replaced by gzip/gunzip.
+
+config UNLZMA
+       bool "unlzma"
+       default n
+       help
+         unlzma is a compression utility using the Lempel-Ziv-Markov chain
+         compression algorithm, and range coding. Compression
+         is generally considerably better than that achieved by the bzip2
+         compressors.
+
+         The BusyBox unlzma applet is limited to de-compression only.
+         On an x86 system, this applet adds about 4K.
+
+         Unless you have a specific application which requires unlzma, you
+         should probably say N here.
+
+config FEATURE_LZMA_FAST
+       bool "Optimize unlzma for speed"
+       default n
+       depends on UNLZMA
+       help
+         This option reduces decompression time by about 25% at the cost of
+         a 1K bigger binary.
 
-config CONFIG_UNZIP
+config UNZIP
        bool "unzip"
        default n
        help
-         Please submit a patch to add help text for this item.
+         unzip will list or extract files from a ZIP archive,
+         commonly found on DOS/WIN systems. The default behavior
+         (with no options) is to extract the archive into the
+         current directory. Use the `-d' option to extract to a
+         directory of your choice.
 
 endmenu