X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/b28fad8f6834fd98481b19d1cf54a2c65e25c6d1..32854ff6954903a6562f28a325d42b9c66de23a9:/doc/apt-ftparchive.1.xml diff --git a/doc/apt-ftparchive.1.xml b/doc/apt-ftparchive.1.xml index 5d538c2c6..6482b4632 100644 --- a/doc/apt-ftparchive.1.xml +++ b/doc/apt-ftparchive.1.xml @@ -1,10 +1,15 @@ - %aptent; + +%aptverbatiment; + + +%aptvendor; ]> @@ -15,7 +20,7 @@ &apt-email; &apt-product; - 17 August 2009 + 2012-06-09T00:00:00Z @@ -30,28 +35,8 @@ Utility to generate index files - - - - apt-ftparchive - - - - - - - - - packagespathoverridepathprefix - sourcespathoverridepathprefix - contents path - release path - generate config-file section - clean config-file - - - - + &synopsis-command-apt-ftparchive; + Description apt-ftparchive is the command line tool that generates the index files that APT uses to access a distribution source. The index files should @@ -68,11 +53,11 @@ programs aside from &gzip;. When doing a full generate it automatically performs file-change checks and builds the desired compressed output files. - Unless the , or option is given one of the - commands below must be present. + Unless the , or 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, @@ -82,7 +67,7 @@ The option 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, @@ -94,7 +79,7 @@ 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, @@ -106,13 +91,16 @@ The option 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 - Packages, Packages.gz, Packages.bz2, Sources, Sources.gz, - Sources.bz2, Release and md5sum.txt files. It then writes to - stdout a Release file containing an MD5 digest and SHA1 digest + directory tree. It recursively searches the given directory for uncompressed + Packages and Sources files and ones + compressed with gzip, bzip2 or lzma + as well as Release 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 an MD5, SHA1 and SHA256 digest for each file. Values for the additional metadata fields in the Release file are @@ -121,11 +109,12 @@ e.g. APT::FTPArchive::Release::Origin. The supported fields are: Origin, Label, Suite, Version, Codename, Date, - Architectures, Components, Description. + Valid-Until, Architectures, + Components, 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 @@ -134,7 +123,7 @@ required settings. - clean + The clean command tidies the databases used by the given configuration file by removing any records that are no longer necessary. @@ -152,33 +141,33 @@ tree manner. This only effects how the scope tag is handled. - The generate configuration has 4 separate sections, each described below. + The generate configuration has four separate sections, each described below. - Dir Section + <literal>Dir</literal> Section The Dir section defines the standard directories needed to locate the files required during the generation process. These directories are prepended certain relative paths defined in later sections to produce a complete an absolute path. - ArchiveDir + Specifies the root of the FTP archive, in a standard Debian configuration this is the directory that contains the ls-LR and dist nodes. - OverrideDir + Specifies the location of the override files. - CacheDir + - Specifies the location of the cache files + Specifies the location of the cache files. - FileListDir + Specifies the location of the file list files, if the FileList setting is used below. @@ -186,75 +175,87 @@ - Default Section + <literal>Default</literal> Section The Default section specifies default values, and settings that control the operation of the generator. Other sections may override these defaults with a per-section setting. - Packages::Compress + Sets the default compression schemes to use - for the Package index files. It is a string that contains a space + for the package index files. It is a string that contains a space separated list of at least one of: '.' (no compression), 'gzip' and 'bzip2'. The default for all compression schemes is '. gzip'. - Packages::Extensions + Sets the default list of file extensions that are package files. This defaults to '.deb'. - Sources::Compress + This is similar to Packages::Compress except that it controls the compression for the Sources files. - Sources::Extensions + Sets the default list of file extensions that are source files. This defaults to '.dsc'. - Contents::Compress + This is similar to Packages::Compress except that it controls the compression for the Contents files. - - DeLinkLimit + + + + This is similar to Packages::Compress + except that it controls the compression for the Translation-en master file. + + + Specifies the number of kilobytes to delink (and replace with hard links) per run. This is used in conjunction with the per-section External-Links setting. - FileMode + Specifies the mode of all created index files. It defaults to 0644. All index files are set to this mode with no regard to the umask. + + + + Specifies whether long descriptions should be included in the Packages file or split + out into a master Translation-en file. + - TreeDefault Section + <literal>TreeDefault</literal> Section Sets defaults specific to Tree sections. All of these variables are substitution variables and have the strings $(DIST), $(SECTION) and $(ARCH) replaced with their respective values. - MaxContentsChange + Sets the number of kilobytes of contents files that are generated each day. The contents files are round-robined so that over several days they will all be rebuilt. - ContentsAge + Controls the number of days a contents file is allowed to be checked without changing. If this limit is passed the mtime of the @@ -265,65 +266,72 @@ the units are in days. - Directory + Sets the top of the .deb directory tree. Defaults to $(DIST)/$(SECTION)/binary-$(ARCH)/ - SrcDirectory + Sets the top of the source package directory tree. Defaults to $(DIST)/$(SECTION)/source/ - Packages + Sets the output Packages file. Defaults to $(DIST)/$(SECTION)/binary-$(ARCH)/Packages - Sources + Sets the output Sources file. Defaults to $(DIST)/$(SECTION)/source/Sources - - InternalPrefix + + + + Sets the output Translation-en master file with the long descriptions if they + should be not included in the Packages file. Defaults to + $(DIST)/$(SECTION)/i18n/Translation-en + + + Sets the path prefix that causes a symlink to be considered an internal link instead of an external link. Defaults to $(DIST)/$(SECTION)/ - Contents + Sets the output Contents file. Defaults to - $(DIST)/Contents-$(ARCH). If this setting causes multiple - Packages files to map onto a single Contents file (such as the default) + $(DIST)/$(SECTION)/Contents-$(ARCH). If this setting causes multiple + Packages files to map onto a single Contents file (as is the default) then apt-ftparchive will integrate those package files together automatically. - Contents::Header + Sets header file to prepend to the contents output. - BinCacheDB + Sets the binary cache database to use for this section. Multiple sections can share the same database. - FileList + Specifies that instead of walking the directory tree, apt-ftparchive should read the list of files from the given file. Relative files names are prefixed with the archive directory. - SourceFileList + Specifies that instead of walking the directory tree, apt-ftparchive should read the list of files from the given @@ -333,7 +341,7 @@ - Tree Section + <literal>Tree</literal> Section The Tree section defines a standard Debian file tree which consists of a base directory, then multiple sections in that base @@ -343,59 +351,65 @@ The Tree section takes a scope tag which sets the $(DIST) variable and defines the root of the tree (the path is prefixed by ArchiveDir). - Typically this is a setting such as dists/woody. + Typically this is a setting such as dists/&stable-codename;. All of the settings defined in the TreeDefault section can be - use in a Tree section as well as three new variables. + used in a Tree section as well as three new variables. When processing a Tree section apt-ftparchive performs an operation similar to: - + for i in Sections do for j in Architectures do Generate for DIST=scope SECTION=i ARCH=j - + - Sections + This is a space separated list of sections which appear - under the distribution, typically this is something like + under the distribution; typically this is something like main contrib non-free - Architectures + This is a space separated list of all the architectures that appear under search section. The special architecture 'source' is used to indicate that this tree has a source archive. - - BinOverride + + + + Specifies whether long descriptions should be included in the Packages file or split + out into a master Translation-en file. + + + Sets the binary override file. The override file contains section, priority and maintainer address information. - SrcOverride + Sets the source override file. The override file contains section information. - ExtraOverride + Sets the binary extra override file. - SrcExtraOverride + Sets the source extra override file. - BinDirectory Section + <literal>BinDirectory</literal> Section The bindirectory section defines a binary directory tree with no special structure. The scope tag specifies the location of @@ -403,53 +417,53 @@ for i in Sections do section with no substitution variables or SectionArchitecture settings. - Packages + Sets the Packages file output. - Sources + Sets the Sources file output. At least one of Packages or Sources is required. - Contents + - Sets the Contents file output. (optional) + Sets the Contents file output (optional). - BinOverride + Sets the binary override file. - SrcOverride + Sets the source override file. - ExtraOverride + Sets the binary extra override file. - SrcExtraOverride + Sets the source extra override file. - BinCacheDB + Sets the cache DB. - PathPrefix + Appends a path to all the output paths. - FileList, SourceFileList + Specifies the file list file. @@ -460,8 +474,8 @@ for i in Sections do The Binary Override File The binary override file is fully compatible with &dpkg-scanpackages;. It - contains 4 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 + 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: @@ -478,14 +492,14 @@ for i in Sections do The Source Override File The source override file is fully compatible with &dpkg-scansources;. It - contains 2 fields separated by spaces. The first fields is the source + 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 The extra override file allows any arbitrary tag to be added or replaced - in the output. It has 3 columns, the first is the package, the second is + 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. @@ -493,11 +507,15 @@ for i in Sections do &apt-cmdblurb; - + - Generate MD5 sums. This defaults to on, when turned off the generated - index files will not have MD5Sum fields where possible. - Configuration Item: APT::FTPArchive::MD5 + 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 or SHA256. @@ -542,11 +560,18 @@ for i in Sections do Make the caching databases read only. Configuration Item: APT::FTPArchive::ReadOnlyDB. - + + + + 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; caches as much as possible of metadata in it is cachedb. If packages + &apt-ftparchive; 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. @@ -560,8 +585,8 @@ for i in Sections do This configuration option defaults to "true" and should only be set to "false" if the Archive generated with &apt-ftparchive; also provides - Translation files. Note that it is currently not possible to create these - files with apt-ftparchive. + Translation files. Note that the Translation-en + master file can only be created in the generate command.