summaryrefslogtreecommitdiff
path: root/doc/apt-ftparchive.1.xml
diff options
context:
space:
mode:
authorDavid Kalnischkies <kalnischkies@gmail.com>2012-05-21 04:40:48 +0200
committerDavid Kalnischkies <kalnischkies@gmail.com>2012-05-21 04:40:48 +0200
commit2b9b27c395d75a0c06e7eca65746e5567e459dac (patch)
tree1924767c38949beb45a7ca61cd208e02579b5e7c /doc/apt-ftparchive.1.xml
parent527df5a20dbe8ce98fcbf1ffe28bb37ff2257a97 (diff)
in <term> mark all options with <option> and mark <term><option>
as untranslated for po4a removing ~200 unless "translateable" strings
Diffstat (limited to 'doc/apt-ftparchive.1.xml')
-rw-r--r--doc/apt-ftparchive.1.xml100
1 files changed, 50 insertions, 50 deletions
diff --git a/doc/apt-ftparchive.1.xml b/doc/apt-ftparchive.1.xml
index 93b109af1..fbc3afb10 100644
--- a/doc/apt-ftparchive.1.xml
+++ b/doc/apt-ftparchive.1.xml
@@ -55,7 +55,7 @@
commands below must be present.</para>
<variablelist>
- <varlistentry><term>packages</term>
+ <varlistentry><term><option>packages</option></term>
<listitem><para>
The packages command generates a package file from a directory tree. It
takes the given directory and recursively searches it for .deb files,
@@ -65,7 +65,7 @@
<para>The option <option>--db</option> can be used to specify a binary caching DB.</para></listitem>
</varlistentry>
- <varlistentry><term>sources</term>
+ <varlistentry><term><option>sources</option></term>
<listitem><para>
The <literal>sources</literal> command generates a source index file from a directory tree.
It takes the given directory and recursively searches it for .dsc files,
@@ -77,7 +77,7 @@
used to change the source override file that will be used.</para></listitem>
</varlistentry>
- <varlistentry><term>contents</term>
+ <varlistentry><term><option>contents</option></term>
<listitem><para>
The <literal>contents</literal> command generates a contents file from a directory tree. It
takes the given directory and recursively searches it for .deb files,
@@ -89,7 +89,7 @@
The option <option>--db</option> can be used to specify a binary caching DB.</para></listitem>
</varlistentry>
- <varlistentry><term>release</term>
+ <varlistentry><term><option>release</option></term>
<listitem><para>
The <literal>release</literal> command generates a Release file from a
directory tree. It recursively searches the given directory for uncompressed
@@ -112,7 +112,7 @@
</varlistentry>
- <varlistentry><term>generate</term>
+ <varlistentry><term><option>generate</option></term>
<listitem><para>
The <literal>generate</literal> command is designed to be runnable from a cron script and
builds indexes according to the given config file. The config language
@@ -121,7 +121,7 @@
required settings.</para></listitem>
</varlistentry>
- <varlistentry><term>clean</term>
+ <varlistentry><term><option>clean</option></term>
<listitem><para>
The <literal>clean</literal> command tidies the databases used by the given
configuration file by removing any records that are no longer necessary.</para></listitem>
@@ -148,24 +148,24 @@
directories are prepended certain relative paths defined in later
sections to produce a complete an absolute path.</para>
<variablelist>
- <varlistentry><term>ArchiveDir</term>
+ <varlistentry><term><option>ArchiveDir</option></term>
<listitem><para>
Specifies the root of the FTP archive, in a standard
Debian configuration this is the directory that contains the
<filename>ls-LR</filename> and dist nodes.</para></listitem>
</varlistentry>
- <varlistentry><term>OverrideDir</term>
+ <varlistentry><term><option>OverrideDir</option></term>
<listitem><para>
Specifies the location of the override files.</para></listitem>
</varlistentry>
- <varlistentry><term>CacheDir</term>
+ <varlistentry><term><option>CacheDir</option></term>
<listitem><para>
Specifies the location of the cache files</para></listitem>
</varlistentry>
- <varlistentry><term>FileListDir</term>
+ <varlistentry><term><option>FileListDir</option></term>
<listitem><para>
Specifies the location of the file list files,
if the <literal>FileList</literal> setting is used below.</para></listitem>
@@ -179,7 +179,7 @@
that control the operation of the generator. Other sections may override
these defaults with a per-section setting.</para>
<variablelist>
- <varlistentry><term>Packages::Compress</term>
+ <varlistentry><term><option>Packages::Compress</option></term>
<listitem><para>
Sets the default compression schemes to use
for the Package index files. It is a string that contains a space
@@ -187,51 +187,51 @@
'bzip2'. The default for all compression schemes is '. gzip'.</para></listitem>
</varlistentry>
- <varlistentry><term>Packages::Extensions</term>
+ <varlistentry><term><option>Packages::Extensions</option></term>
<listitem><para>
Sets the default list of file extensions that are package files.
This defaults to '.deb'.</para></listitem>
</varlistentry>
- <varlistentry><term>Sources::Compress</term>
+ <varlistentry><term><option>Sources::Compress</option></term>
<listitem><para>
This is similar to <literal>Packages::Compress</literal>
except that it controls the compression for the Sources files.</para></listitem>
</varlistentry>
- <varlistentry><term>Sources::Extensions</term>
+ <varlistentry><term><option>Sources::Extensions</option></term>
<listitem><para>
Sets the default list of file extensions that are source files.
This defaults to '.dsc'.</para></listitem>
</varlistentry>
- <varlistentry><term>Contents::Compress</term>
+ <varlistentry><term><option>Contents::Compress</option></term>
<listitem><para>
This is similar to <literal>Packages::Compress</literal>
except that it controls the compression for the Contents files.</para></listitem>
</varlistentry>
- <varlistentry><term>Translation::Compress</term>
+ <varlistentry><term><option>Translation::Compress</option></term>
<listitem><para>
This is similar to <literal>Packages::Compress</literal>
except that it controls the compression for the Translation-en master file.</para></listitem>
</varlistentry>
- <varlistentry><term>DeLinkLimit</term>
+ <varlistentry><term><option>DeLinkLimit</option></term>
<listitem><para>
Specifies the number of kilobytes to delink (and
replace with hard links) per run. This is used in conjunction with the
per-section <literal>External-Links</literal> setting.</para></listitem>
</varlistentry>
- <varlistentry><term>FileMode</term>
+ <varlistentry><term><option>FileMode</option></term>
<listitem><para>
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.</para></listitem>
</varlistentry>
- <varlistentry><term>LongDescription</term>
+ <varlistentry><term><option>LongDescription</option></term>
<listitem><para>
Sets if long descriptions should be included in the Packages file or split
out into a master Translation-en file.</para></listitem>
@@ -246,14 +246,14 @@
$(SECTION) and $(ARCH) replaced with their respective values.</para>
<variablelist>
- <varlistentry><term>MaxContentsChange</term>
+ <varlistentry><term><option>MaxContentsChange</option></term>
<listitem><para>
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.</para></listitem>
</varlistentry>
- <varlistentry><term>ContentsAge</term>
+ <varlistentry><term><option>ContentsAge</option></term>
<listitem><para>
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,45 +264,45 @@
the units are in days.</para></listitem>
</varlistentry>
- <varlistentry><term>Directory</term>
+ <varlistentry><term><option>Directory</option></term>
<listitem><para>
Sets the top of the .deb directory tree. Defaults to
<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename></para></listitem>
</varlistentry>
- <varlistentry><term>SrcDirectory</term>
+ <varlistentry><term><option>SrcDirectory</option></term>
<listitem><para>
Sets the top of the source package directory tree. Defaults to
<filename>$(DIST)/$(SECTION)/source/</filename></para></listitem>
</varlistentry>
- <varlistentry><term>Packages</term>
+ <varlistentry><term><option>Packages</option></term>
<listitem><para>
Sets the output Packages file. Defaults to
<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename></para></listitem>
</varlistentry>
- <varlistentry><term>Sources</term>
+ <varlistentry><term><option>Sources</option></term>
<listitem><para>
Sets the output Sources file. Defaults to
<filename>$(DIST)/$(SECTION)/source/Sources</filename></para></listitem>
</varlistentry>
- <varlistentry><term>Translation</term>
+ <varlistentry><term><option>Translation</option></term>
<listitem><para>
Set the output Translation-en master file with the long descriptions if they
should be not included in the Packages file. Defaults to
<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename></para></listitem>
</varlistentry>
- <varlistentry><term>InternalPrefix</term>
+ <varlistentry><term><option>InternalPrefix</option></term>
<listitem><para>
Sets the path prefix that causes a symlink to be
considered an internal link instead of an external link. Defaults to
<filename>$(DIST)/$(SECTION)/</filename></para></listitem>
</varlistentry>
- <varlistentry><term>Contents</term>
+ <varlistentry><term><option>Contents</option></term>
<listitem><para>
Sets the output Contents file. Defaults to
<filename>$(DIST)/Contents-$(ARCH)</filename>. If this setting causes multiple
@@ -311,25 +311,25 @@
together automatically.</para></listitem>
</varlistentry>
- <varlistentry><term>Contents::Header</term>
+ <varlistentry><term><option>Contents::Header</option></term>
<listitem><para>
Sets header file to prepend to the contents output.</para></listitem>
</varlistentry>
- <varlistentry><term>BinCacheDB</term>
+ <varlistentry><term><option>BinCacheDB</option></term>
<listitem><para>
Sets the binary cache database to use for this
section. Multiple sections can share the same database.</para></listitem>
</varlistentry>
- <varlistentry><term>FileList</term>
+ <varlistentry><term><option>FileList</option></term>
<listitem><para>
Specifies that instead of walking the directory tree,
<command>apt-ftparchive</command> should read the list of files from the given
file. Relative files names are prefixed with the archive directory.</para></listitem>
</varlistentry>
- <varlistentry><term>SourceFileList</term>
+ <varlistentry><term><option>SourceFileList</option></term>
<listitem><para>
Specifies that instead of walking the directory tree,
<command>apt-ftparchive</command> should read the list of files from the given
@@ -363,44 +363,44 @@ for i in Sections do
</programlisting></para>
<variablelist>
- <varlistentry><term>Sections</term>
+ <varlistentry><term><option>Sections</option></term>
<listitem><para>
This is a space separated list of sections which appear
under the distribution, typically this is something like
<literal>main contrib non-free</literal></para></listitem>
</varlistentry>
- <varlistentry><term>Architectures</term>
+ <varlistentry><term><option>Architectures</option></term>
<listitem><para>
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.</para></listitem>
</varlistentry>
- <varlistentry><term>LongDescription</term>
+ <varlistentry><term><option>LongDescription</option></term>
<listitem><para>
Sets if long descriptions should be included in the Packages file or split
out into a master Translation-en file.</para></listitem>
</varlistentry>
- <varlistentry><term>BinOverride</term>
+ <varlistentry><term><option>BinOverride</option></term>
<listitem><para>
Sets the binary override file. The override file
contains section, priority and maintainer address information.</para></listitem>
</varlistentry>
- <varlistentry><term>SrcOverride</term>
+ <varlistentry><term><option>SrcOverride</option></term>
<listitem><para>
Sets the source override file. The override file
contains section information.</para></listitem>
</varlistentry>
- <varlistentry><term>ExtraOverride</term>
+ <varlistentry><term><option>ExtraOverride</option></term>
<listitem><para>
Sets the binary extra override file.</para></listitem>
</varlistentry>
- <varlistentry><term>SrcExtraOverride</term>
+ <varlistentry><term><option>SrcExtraOverride</option></term>
<listitem><para>
Sets the source extra override file.</para></listitem>
</varlistentry>
@@ -415,53 +415,53 @@ for i in Sections do
section with no substitution variables or
<literal>Section</literal><literal>Architecture</literal> settings.</para>
<variablelist>
- <varlistentry><term>Packages</term>
+ <varlistentry><term><option>Packages</option></term>
<listitem><para>
Sets the Packages file output.</para></listitem>
</varlistentry>
- <varlistentry><term>Sources</term>
+ <varlistentry><term><option>Sources</option></term>
<listitem><para>
Sets the Sources file output. At least one of
<literal>Packages</literal> or <literal>Sources</literal> is required.</para></listitem>
</varlistentry>
- <varlistentry><term>Contents</term>
+ <varlistentry><term><option>Contents</option></term>
<listitem><para>
Sets the Contents file output. (optional)</para></listitem>
</varlistentry>
- <varlistentry><term>BinOverride</term>
+ <varlistentry><term><option>BinOverride</option></term>
<listitem><para>
Sets the binary override file.</para></listitem>
</varlistentry>
- <varlistentry><term>SrcOverride</term>
+ <varlistentry><term><option>SrcOverride</option></term>
<listitem><para>
Sets the source override file.</para></listitem>
</varlistentry>
- <varlistentry><term>ExtraOverride</term>
+ <varlistentry><term><option>ExtraOverride</option></term>
<listitem><para>
Sets the binary extra override file.</para></listitem>
</varlistentry>
- <varlistentry><term>SrcExtraOverride</term>
+ <varlistentry><term><option>SrcExtraOverride</option></term>
<listitem><para>
Sets the source extra override file.</para></listitem>
</varlistentry>
- <varlistentry><term>BinCacheDB</term>
+ <varlistentry><term><option>BinCacheDB</option></term>
<listitem><para>
Sets the cache DB.</para></listitem>
</varlistentry>
- <varlistentry><term>PathPrefix</term>
+ <varlistentry><term><option>PathPrefix</option></term>
<listitem><para>
Appends a path to all the output paths.</para></listitem>
</varlistentry>
- <varlistentry><term>FileList, SourceFileList</term>
+ <varlistentry><term><option>FileList</option></term><term><option>SourceFileList</option></term>
<listitem><para>
Specifies the file list file.</para></listitem>
</varlistentry>
@@ -505,7 +505,7 @@ for i in Sections do
&apt-cmdblurb;
<variablelist>
- <varlistentry><term><option>--md5</option>, <option>--sha1</option>, <option>--sha256</option></term>
+ <varlistentry><term><option>--md5</option></term><term><option>--sha1</option></term><term><option>--sha256</option></term>
<listitem><para>
Generate the given checksum. These options default to on, when turned off the generated
index files will not have the checksum fields where possible.