X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/a2ec4d22dd77a363cd5b1f8b55ed34ba88331396..b176de3af77f686a512dec04a98e8fa6ce6af908:/doc/apt-ftparchive.1.xml diff --git a/doc/apt-ftparchive.1.xml b/doc/apt-ftparchive.1.xml index de7e5f7a3..84b5f4135 100644 --- a/doc/apt-ftparchive.1.xml +++ b/doc/apt-ftparchive.1.xml @@ -1,10 +1,13 @@ - %aptent; + +%aptverbatiment; + ]> @@ -15,12 +18,13 @@ &apt-email; &apt-product; - 29 February 2004 + 2009-08-17T00:00:00Z apt-ftparchive 1 + APT @@ -29,28 +33,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 @@ -67,11 +51,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, @@ -81,7 +65,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, @@ -93,7 +77,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, @@ -105,13 +89,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 the 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 a MD5, SHA1 and SHA256 digest for each file. Values for the additional metadata fields in the Release file are @@ -120,11 +107,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 @@ -133,7 +121,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. @@ -153,31 +141,31 @@ The generate configuration has 4 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 to certain relative paths defined in later + 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 - FileListDir + Specifies the location of the file list files, if the FileList setting is used below. @@ -185,13 +173,13 @@ - 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 @@ -199,61 +187,73 @@ '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. + + + + Sets if 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 @@ -264,38 +264,45 @@ 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 Packages file. Defaults to + Sets the output Sources file. Defaults to $(DIST)/$(SECTION)/source/Sources - - InternalPrefix + + + + Set 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 @@ -304,25 +311,25 @@ 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 @@ -332,7 +339,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 @@ -342,59 +349,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. 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 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 + + + + Sets if 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 @@ -402,53 +415,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) - 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. @@ -492,11 +505,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. @@ -541,8 +558,36 @@ 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 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 multiply versions/builds of a package with the same versionnumber, so in theory + nobody will have these problems and therefore all these extra checks are useless. + + + + + + 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 the Translation-en + master file can only be created in the generate command. + + + &apt-commonoptions;