X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/366cff695ae0a228300817e278c7ddf62ca52c34..ed0dc1384078765b117f72a0def4fd28a1c7e72b:/doc/apt-ftparchive.1.xml diff --git a/doc/apt-ftparchive.1.xml b/doc/apt-ftparchive.1.xml index 7131303ae..8e5df1f36 100644 --- a/doc/apt-ftparchive.1.xml +++ b/doc/apt-ftparchive.1.xml @@ -5,6 +5,9 @@ %aptent; + +%aptverbatiment; + ]> @@ -15,7 +18,7 @@ &apt-email; &apt-product; - 29 February 2004 + 17 August 2009 @@ -39,7 +42,8 @@ - + + packagespathoverridepathprefix @@ -109,10 +113,13 @@ 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 @@ -121,7 +128,8 @@ e.g. APT::FTPArchive::Release::Origin. The supported fields are: Origin, Label, Suite, Version, Codename, Date, - Architectures, Components, Description. + Valid-Until, Architectures, + Components, Description. @@ -158,7 +166,7 @@ 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 @@ -223,7 +231,13 @@ This is similar to Packages::Compress except that it controls the compression for the Contents files. - + + Translation::Compress + + This is similar to Packages::Compress + except that it controls the compression for the Translation-en master file. + + DeLinkLimit Specifies the number of kilobytes to delink (and @@ -237,6 +251,12 @@ defaults to 0644. All index files are set to this mode with no regard to the umask. + + LongDescription + + Sets if long descriptions should be included in the Packages file or split + out into a master Translation-en file. + @@ -285,10 +305,17 @@ Sources - Sets the output Packages file. Defaults to + Sets the output Sources file. Defaults to $(DIST)/$(SECTION)/source/Sources - + + Translation + + 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 + + InternalPrefix Sets the path prefix that causes a symlink to be @@ -343,18 +370,18 @@ 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 @@ -370,7 +397,13 @@ for i in Sections do architectures that appear under search section. The special architecture 'source' is used to indicate that this tree has a source archive. - + + LongDescription + + Sets if long descriptions should be included in the Packages file or split + out into a master Translation-en file. + + BinOverride Sets the binary override file. The override file @@ -493,11 +526,14 @@ 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,8 +578,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;