X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/58d4a28e10d689ccbf3087c870be0fc2d2a37ee1..81cf16a26fa162ac672b084a88148b822e645665:/doc/apt-ftparchive.1.xml
diff --git a/doc/apt-ftparchive.1.xml b/doc/apt-ftparchive.1.xml
index b08ebe80f..84b5f4135 100644
--- a/doc/apt-ftparchive.1.xml
+++ b/doc/apt-ftparchive.1.xml
@@ -1,6 +1,6 @@
-
%aptent;
@@ -18,7 +18,7 @@
&apt-email;
&apt-product;
- 17 August 2009
+ 2009-08-17T00:00:00Z
@@ -33,29 +33,8 @@
Utility to generate index files
-
-
-
- apt-ftparchive
-
-
-
-
-
-
-
-
-
- packagespathoverridepathprefix
- sourcespathoverridepathprefix
- contents path
- release path
- generate config-filesection
- clean config-file
-
-
-
-
+ &synopsis-command-apt-ftparchive;
+
Descriptionapt-ftparchive is the command line tool that generates the index
files that APT uses to access a distribution source. The index files should
@@ -72,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,
@@ -86,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,
@@ -98,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,
@@ -110,7 +89,7 @@
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 uncompressed
@@ -133,7 +112,7 @@
- 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
@@ -142,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.
@@ -162,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 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.
@@ -194,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
@@ -208,51 +187,51 @@
'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.
- 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
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.
- LongDescription
+
Sets if long descriptions should be included in the Packages file or split
out into a master Translation-en file.
@@ -260,21 +239,21 @@
- 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
@@ -285,45 +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 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
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
@@ -332,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
@@ -360,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
@@ -384,51 +363,51 @@ for i in Sections do
- 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.
- 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
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
@@ -436,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.
@@ -526,7 +505,7 @@ 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.