X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/2b9b27c395d75a0c06e7eca65746e5567e459dac..d27daedb6a0bf672508072100f20233d08ccf0e0:/doc/apt-ftparchive.1.xml diff --git a/doc/apt-ftparchive.1.xml b/doc/apt-ftparchive.1.xml index fbc3afb10..523b1853b 100644 --- a/doc/apt-ftparchive.1.xml +++ b/doc/apt-ftparchive.1.xml @@ -1,13 +1,9 @@ - -%aptent; - - -%aptverbatiment; - + %aptent; + %aptverbatiment; + %aptvendor; ]> @@ -18,7 +14,7 @@ &apt-email; &apt-product; - 17 August 2009 + 2015-09-13T00:00:00Z @@ -51,8 +47,8 @@ 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. @@ -93,13 +89,13 @@ The release command generates a Release file from a directory tree. It recursively searches the given directory for uncompressed - Packages and Sources files and the ones + 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 a MD5, SHA1 and SHA256 digest - for each file. + 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 @@ -139,9 +135,9 @@ 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 @@ -162,7 +158,7 @@ - Specifies the location of the cache files + Specifies the location of the cache files. @@ -173,7 +169,7 @@ - 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 @@ -182,7 +178,7 @@ 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'. @@ -233,13 +229,13 @@ - Sets if long descriptions should be included in the Packages file or split - out into a master Translation-en file. + 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), @@ -290,7 +286,7 @@ - Set the output Translation-en master file with the long descriptions if they + 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 @@ -305,8 +301,8 @@ 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. @@ -339,7 +335,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 @@ -352,7 +348,7 @@ 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: @@ -366,21 +362,25 @@ for i in Sections do 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 - 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. + 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. The architecture 'all' signals that + architecture specific files like Packages should not + include information about architecture all packages in + all files as they will be available in a dedicated file. + - Sets if long descriptions should be included in the Packages file or split - out into a master Translation-en file. + Specifies whether long descriptions should be included in the Packages file or split + out into a master Translation-en file. @@ -407,7 +407,7 @@ for i in Sections do - 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 @@ -428,7 +428,7 @@ for i in Sections do - Sets the Contents file output. (optional) + Sets the Contents file output (optional). @@ -472,8 +472,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: @@ -490,14 +490,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. @@ -505,7 +505,11 @@ for i in Sections do &apt-cmdblurb; - + + + + + Generate the given checksum. These options default to on, when turned off the generated index files will not have the checksum fields where possible. @@ -513,7 +517,7 @@ for i in Sections do APT::FTPArchive::Index::Checksum where Index can be Packages, Sources or Release and Checksum can be MD5, - SHA1 or SHA256. + SHA1, SHA256 or SHA512. @@ -589,7 +593,7 @@ for i in Sections do &apt-commonoptions; - +