apt-ftparchive - Man Page

apt-ftparchive [-dsq] [--md5] [--delink] [--readonly] [--contents] [--arch architecture] [-o=config_string] [-c=config_file] {packages path [override-file [pathprefix]]  | sources path [override-file [pathprefix]]  | contents path  | release path  | generate config_file section...  | clean config_file  | {-v | --version} | {-h | --help}}

apt-ftparchive is the command line tool that generates the index files that APT uses to access a distribution source. The index files should be generated on the origin site based on the content of that site.

apt-ftparchive is a superset of the dpkg-scanpackages(1) program, incorporating its entire functionality via the packages command. It also contains a contents file generator, contents, and an elaborate means to 'script' the generation process for a complete archive.

Internally apt-ftparchive can make use of binary databases to cache the contents of a .deb file and it does not rely on any external programs aside from gzip(1). When doing a full generate it automatically performs file-change checks and builds the desired compressed output files.

Unless the -h, or --help option is given, one of the commands below must be present.

packages

The packages command generates a package file from a directory tree. It takes the given directory and recursively searches it for .deb files, emitting a package record to stdout for each. This command is approximately equivalent to dpkg-scanpackages(1).

The option --db can be used to specify a binary caching DB.

sources

The sources command generates a source index file from a directory tree. It takes the given directory and recursively searches it for .dsc files, emitting a source record to stdout for each. This command is approximately equivalent to dpkg-scansources(1).

If an override file is specified then a source override file will be looked for with an extension of .src. The --source-override option can be used to change the source override file that will be used.

contents

The contents command generates a contents file from a directory tree. It takes the given directory and recursively searches it for .deb files, and reads the file list from each file. It then sorts and writes to stdout the list of files matched to packages. Directories are not written to the output. If multiple packages own the same file then each package is separated by a comma in the output.

The option --db can be used to specify a binary caching DB.

release

The release command generates a Release file from a directory tree. It recursively searches the given directory for uncompressed and compressed Packages, Sources, Contents, Components and icons files as well as Release, Index and md5sum.txt files by default (APT::FTPArchive::Release::Default-Patterns). Additional filename patterns can be added by listing them in APT::FTPArchive::Release::Patterns. It then writes to stdout a Release file containing (by default) an MD5, SHA1, SHA256 and SHA512 digest for each file.

Values for the additional metadata fields in the Release file are taken from the corresponding variables under APT::FTPArchive::Release, e.g. APT::FTPArchive::Release::Origin. The supported fields are Origin, Label, Suite, Version, Codename, Date, NotAutomatic, ButAutomaticUpgrades, Acquire-By-Hash, Valid-Until, Signed-By, Architectures, Components and Description.

generate

The generate command is designed to be runnable from a cron script and builds indexes according to the given config file. The config language provides a flexible means of specifying which index files are built from which directories, as well as providing a simple means of maintaining the required settings.

clean

The clean command tidies the databases used by the given configuration file by removing any records that are no longer necessary.

The generate command uses a configuration file to describe the archives that are going to be generated. It follows the typical ISC configuration format as seen in ISC tools like bind 8 and dhcpd. apt.conf(5) contains a description of the syntax. Note that the generate configuration is parsed in sectional manner, but apt.conf(5) is parsed in a tree manner. This only effects how the scope tag is handled.

The generate configuration has four separate sections, each described below.

for i in Sections do 
   for j in Architectures do
      Generate for DIST=scope SECTION=i ARCH=j

The binary override file is fully compatible with dpkg-scanpackages(1). It contains four fields separated by spaces. The first field is the package name, the second is the priority to force that package to, the third is the section to force that package to and the final field is the maintainer permutation field.

The general form of the maintainer field is:

old [// oldn]* => new

or simply,

new

The first form allows a double-slash separated list of old email addresses to be specified. If any of those are found then new is substituted for the maintainer field. The second form unconditionally substitutes the maintainer field.

The source override file is fully compatible with dpkg-scansources(1). It contains two fields separated by spaces. The first field is the source package name, the second is the section to assign it.

The extra override file allows any arbitrary tag to be added or replaced in the output. It has three columns, the first is the package, the second is the tag and the remainder of the line is the new value.

All command line options may be set using the configuration file, the descriptions indicate the configuration option to set. For boolean options you can override the config file by using something like -f-,--no-f, -f=no or several other variations.

--md5,  --sha1,  --sha256,  --sha512

Generate the given checksum. These options default to on, when turned off the generated index files will not have the checksum fields where possible. Configuration Items: APT::FTPArchive::Checksum and APT::FTPArchive::Index::Checksum where Index can be Packages, Sources or Release and Checksum can be MD5, SHA1, SHA256 or SHA512.

-d,  --db

Use a binary caching DB. This has no effect on the generate command. Configuration Item: APT::FTPArchive::DB.

-q,  --quiet

Quiet; produces output suitable for logging, omitting progress indicators. More q's will produce more quiet up to a maximum of 2. You can also use -q=# to set the quiet level, overriding the configuration file. Configuration Item: quiet.

--delink

Perform Delinking. If the External-Links setting is used then this option actually enables delinking of the files. It defaults to on and can be turned off with --no-delink. Configuration Item: APT::FTPArchive::DeLinkAct.

--contents

Perform contents generation. When this option is set and package indexes are being generated with a cache DB then the file listing will also be extracted and stored in the DB for later use. When using the generate command this option also allows the creation of any Contents files. The default is on. Configuration Item: APT::FTPArchive::Contents.

-s,  --source-override

Select the source override file to use with the sources command. Configuration Item: APT::FTPArchive::SourceOverride.

--readonly

Make the caching databases read only. Configuration Item: APT::FTPArchive::ReadOnlyDB.

-a,  --arch

Accept in the packages and contents commands only package files matching *_arch.deb or *_all.deb instead of all package files in the given path. Configuration Item: APT::FTPArchive::Architecture.

APT::FTPArchive::AlwaysStat

apt-ftparchive(1) caches as much as possible of metadata in a cachedb. If packages are recompiled and/or republished with the same version again, this will lead to problems as the now outdated cached metadata like size and checksums will be used. With this option enabled this will no longer happen as it will be checked if the file was changed. Note that this option is set to "false" by default as it is not recommend to upload multiple versions/builds of a package with the same version number, so in theory nobody will have these problems and therefore all these extra checks are useless.

APT::FTPArchive::LongDescription

This configuration option defaults to "true" and should only be set to "false" if the Archive generated with apt-ftparchive(1) also provides Translation files. Note that the Translation-en master file can only be created in the generate command.

-h,  --help

Show a short usage summary.

-v,  --version

Show the program version.

--audit

Show audit (and notice) messages. This overrides the quiet option, but only for notice messages, not progress ones.

-c,  --config-file

Configuration File; Specify a configuration file to use. The program will read the default configuration file and then this configuration file. If configuration settings need to be set before the default configuration files are parsed specify a file with the APT_CONFIG environment variable. See apt.conf(5) for syntax information.

-o,  --option

Set a Configuration Option; This will set an arbitrary configuration option. The syntax is -o Foo::Bar=bar. -o and --option can be used multiple times to set different options.

--no-color,  --color

Turn colors on or off. Colors are on by default on supported terminals for apt(8) and can also be disabled using the NO_COLOR or APT_NO_COLOR environment variables, or further configured by the APT::Color configuration option and scope, see apt.conf(5) for information on that.

To create a compressed Packages file for a directory containing binary packages (.deb):

apt-ftparchive packages directory | gzip > Packages.gz

apt.conf(5)

apt-ftparchive returns zero on normal operation, decimal 100 on error.

APT bug page^[1]. If you wish to report a bug in APT, please see /usr/share/doc/debian/bug-reporting.txt or the reportbug(1) command.

Jason Gunthorpe

APT team

1.

APT bug page
https://bugs.debian.org/src:apt

apt-secure(8), deb-extra-override(5), deb-override(5).