summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Kalnischkies <david@kalnischkies.de>2015-07-10 00:07:37 +0200
committerDavid Kalnischkies <david@kalnischkies.de>2015-08-10 17:27:17 +0200
commitc2a4a8dded2dfb56dbcab9689b6cb4b96c9999b6 (patch)
treeee4679a839124bd5ea0f487dd2d3408b9d57a173 /doc
parent0d5b9da9f597fecae9b912d37d4e58bc903bdd4f (diff)
rename 'apt-get files' to 'apt-get indextargets'
'files' is a bit too generic as a name for a command usually only used programmatically (if at all) by developers, so instead of "wasting" this generic name for this we use "indextargets" which is actually the name of the datastructure the displayed data is stored in. Along with this rename the config options are renamed accordingly.
Diffstat (limited to 'doc')
-rw-r--r--doc/acquire-additional-files.txt18
-rw-r--r--doc/apt-get.8.xml24
-rw-r--r--doc/sources.list.5.xml2
3 files changed, 23 insertions, 21 deletions
diff --git a/doc/acquire-additional-files.txt b/doc/acquire-additional-files.txt
index f9a16318d..71ce7b0cb 100644
--- a/doc/acquire-additional-files.txt
+++ b/doc/acquire-additional-files.txt
@@ -26,7 +26,7 @@ they would be written in a configuration file the configuration
instructing the Acquire system to download the Packages files would look
like this (see also apt.conf(5) manpage for configuration file syntax):
- APT::Acquire::Targets::deb::Packages {
+ Acquire::IndexTargets::deb::Packages {
MetaKey "$(COMPONENT)/binary-$(ARCHITECTURE)/Packages";
ShortDescription "Packages";
Description "$(SITE) $(RELEASE)/$(COMPONENT) $(ARCHITECTURE) Packages";
@@ -38,7 +38,7 @@ like this (see also apt.conf(5) manpage for configuration file syntax):
};
All files which should be downloaded (nicknamed 'Targets') are mentioned
-below the APT::Acquire::Targets scope. 'deb' is here the type of the
+below the Acquire::IndexTargets scope. 'deb' is here the type of the
sources.list entry the file should be acquired for. The only other
supported value is hence 'deb-src'. Beware: You can't specify multiple
types here and you can't download the same (evaluated) MetaKey from
@@ -47,7 +47,7 @@ multiple types!
After the type you can pick any valid and unique string which preferable
refers to the file it downloads (In the example we picked 'Packages').
This string is used as identifier for the target class and accessible as
-'Created-By' e.g. in the "apt-get files" output as detailed below.
+'Created-By' e.g. in the "apt-get indextargets" output as detailed below.
All targets have three main properties you can define:
* MetaKey: The identifier of the file to be downloaded as used in the
@@ -92,7 +92,7 @@ NO properties have to be set to enable this.
The stanzas for Translation-* files as well as for Sources files would
look like this:
-APT::Acquire::Targets {
+Acquire::IndexTargets {
deb::Translations {
MetaKey "$(COMPONENT)/i18n/Translation-$(LANGUAGE)";
ShortDescription "Translation-$(LANGUAGE)";
@@ -152,7 +152,7 @@ design so multiple applications can download and use the same file
rather than each and every one of them potentially downloads and uses
its own copy somewhere on disk.
-"apt-get files" can be used to get the location as well as other
+"apt-get indextargets" can be used to get the location as well as other
information about all files downloaded (aka: you will see Packages,
Sources and Translation-* files here as well). Provide a line of the
default output format as parameter to filter out all entries which do
@@ -161,12 +161,16 @@ own output style. The variables are what you see in the output, just all
uppercase and wrapped in $(), as in the configuration file.
To get all the filenames of all Translation-en files you can e.g. call:
- apt-get files --format '$(FILENAME)' "Created-By: Translations" "Language: en"
+ apt-get indextargets --format '$(FILENAME)' "Created-By: Translations" "Language: en"
+
+The line-based filtering and the formating is rather crude and feature-
+less by design, so it is recommend to use dedicated and more powerful
+tools like 'grep-dctrl'.
Accessing this information via libapt is done by reading the
sources.lists (pkgSourceList), iterating over the metaIndex objects this
creates and calling GetIndexTargets() on them. See the sourcecode of
-"apt-get files" for a complete example.
+"apt-get indextargets" for a complete example.
Note that by default targets are not listed if they weren't downloaded.
If you want to see all targets, you can use the --no-release-info, which
diff --git a/doc/apt-get.8.xml b/doc/apt-get.8.xml
index b0fe390df..81a9036c4 100644
--- a/doc/apt-get.8.xml
+++ b/doc/apt-get.8.xml
@@ -239,9 +239,9 @@
</listitem>
</varlistentry>
- <varlistentry><term><option>files</option></term>
+ <varlistentry><term><option>indextargets</option></term>
<listitem><para>Displays by default a deb822 formatted listing of
- information about all data files <command>apt-get
+ information about all data files (aka index targets) <command>apt-get
update</command> would download. Supports a
<option>--format</option> option to modify the output format as
well as accepts lines of the default output to filter the records
@@ -327,17 +327,15 @@
<term><option>--dry-run</option></term>
<term><option>--recon</option></term>
<term><option>--no-act</option></term>
- <listitem><para>No action; perform a simulation of events that would occur but do not
- actually change the system.
- Configuration Item: <literal>APT::Get::Simulate</literal>.</para>
-
- <para>Simulated runs performed as a user will automatically deactivate locking
- (<literal>Debug::NoLocking</literal>), and if the option
- <literal>APT::Get::Show-User-Simulation-Note</literal> is set
- (as it is by default) a notice will also be displayed indicating that
- this is only a simulation. Runs performed as root do not trigger either
- NoLocking or the notice - superusers should know what they are doing
- without further warnings from <literal>apt-get</literal>.</para>
+ <listitem><para>No action; perform a simulation of events that would occur
+ based on the current system state but do not actually change the
+ system. Locking will be disabled (<option>Debug::NoLocking</option>)
+ so the system state could change while <command>apt-get</command> is
+ running. Simulations can also be executed by non-root users which might
+ not have read access to all apt configuration distorting the simulation.
+ A notice expressing this warning is also shown by default for non-root
+ users (<option>APT::Get::Show-User-Simulation-Note</option>).
+ Configuration Item: <literal>APT::Get::Simulate</literal>.</para>
<para>Simulated runs print out a series of lines, each representing a <command>dpkg</command>
operation: configure (<literal>Conf</literal>), remove (<literal>Remv</literal>)
diff --git a/doc/sources.list.5.xml b/doc/sources.list.5.xml
index 12a7773f5..3bc8a94ac 100644
--- a/doc/sources.list.5.xml
+++ b/doc/sources.list.5.xml
@@ -221,7 +221,7 @@ deb-src [ option1=value1 option2=value2 ] uri suite [component1] [component2] [.
(<option>target</option>) is a multivalue option defining
which download targets apt will try to acquire from this
source. If not specified, the default set is defined by the
- <option>APT::Acquire::Targets</option> configuration scope.
+ <option>Acquire::IndexTargets</option> configuration scope.
</para></listitem>
</itemizedlist>