Adding upstream version 2.2.4.upstream/2.2.4upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 161 insertions, 0 deletions

diff --git a/doc/apt-cdrom.8.xml b/doc/apt-cdrom.8.xml
new file mode 100644
index 0000000..8f883c1
--- /dev/null
+++ b/doc/apt-cdrom.8.xml
@@ -0,0 +1,161 @@
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
+<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
+<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;
+]>
+
+<refentry>
+
+ <refentryinfo>
+   &apt-author.jgunthorpe;
+   &apt-author.team;
+   &apt-email;
+   &apt-product;
+   <date>2013-11-30T00:00:00Z</date>
+ </refentryinfo>
+
+ <refmeta>
+   <refentrytitle>apt-cdrom</refentrytitle>
+   <manvolnum>8</manvolnum>
+   <refmiscinfo class="manual">APT</refmiscinfo>
+ </refmeta>
+ 
+ <!-- Man page title -->
+ <refnamediv>
+    <refname>apt-cdrom</refname>
+    <refpurpose>APT CD-ROM management utility</refpurpose>
+ </refnamediv>
+
+ &synopsis-command-apt-cdrom;
+
+ <refsect1><title>Description</title>
+   <para><command>apt-cdrom</command> is used to add a new CD-ROM to APT's list
+    of available sources. <command>apt-cdrom</command> takes care of
+   determining the structure of
+   the disc as well as correcting for several possible mis-burns and 
+   verifying the index files.   
+   </para>
+
+   <para>It is necessary to use <command>apt-cdrom</command> to add CDs to the
+   APT system;
+   it cannot be done by hand. Furthermore each disc in a multi-CD set must be
+   inserted and scanned separately to account for possible mis-burns.
+   </para>
+
+   <para>Unless the <option>-h</option>, or <option>--help</option> option is
+   given, one of the commands below must be present.</para>
+
+    <variablelist>
+     <varlistentry><term><option>add</option></term>
+     <listitem><para><literal>add</literal> is used to add a new disc to the
+     source list. It will unmount the
+     CD-ROM device, prompt for a disc to be inserted and then proceed to 
+     scan it and copy the index files. If the disc does not have a proper
+     <filename>.disk</filename> directory you will be prompted for a descriptive 
+     title.
+     </para>
+
+     <para>APT uses a CD-ROM ID to track which disc is currently in the drive and
+     maintains a database of these IDs in 
+     <filename>&statedir;/cdroms.list</filename>
+     </para>
+     </listitem>
+     </varlistentry>
+     
+     <varlistentry><term><option>ident</option></term>
+     <listitem><para>A debugging tool to report the identity of the current
+      disc as well as the stored file name
+     </para>
+     </listitem>
+     </varlistentry>
+    </variablelist>
+ </refsect1>
+
+ <refsect1><title>Options</title>
+   &apt-cmdblurb;
+   
+   <variablelist>
+     <varlistentry><term><option>--no-auto-detect</option></term><term><option>--cdrom</option></term>
+     <listitem><para>Do not try to auto-detect the CD-ROM path. Usually combined with the <option>--cdrom</option> option.
+      Configuration Item: <literal>Acquire::cdrom::AutoDetect</literal>.
+     </para>
+     </listitem>
+     </varlistentry>
+     
+
+     <varlistentry><term><option>-d</option></term><term><option>--cdrom</option></term>
+     <listitem><para>Mount point; specify the location to mount the CD-ROM. This
+      mount point must be listed in <filename>/etc/fstab</filename> and
+      properly configured.
+      Configuration Item: <literal>Acquire::cdrom::mount</literal>.
+     </para>
+     </listitem>
+     </varlistentry>
+     
+     <varlistentry><term><option>-r</option></term><term><option>--rename</option></term>
+     <listitem><para>Rename a disc; change the label of a disc or override the
+      disc's given label. This option will cause <command>apt-cdrom</command> to
+      prompt for a new label.
+     Configuration Item: <literal>APT::CDROM::Rename</literal>.
+     </para>
+     </listitem>
+     </varlistentry>
+     
+     <varlistentry><term><option>-m</option></term><term><option>--no-mount</option></term>
+     <listitem><para>No mounting; prevent <command>apt-cdrom</command> from
+      mounting and unmounting the mount point.
+     Configuration Item: <literal>APT::CDROM::NoMount</literal>.
+     </para>
+     </listitem>
+     </varlistentry>
+     
+     <varlistentry><term><option>-f</option></term><term><option>--fast</option></term>
+     <listitem><para>Fast Copy; Assume the package files are valid and do not
+      check every package. This option should be used only if
+     <command>apt-cdrom</command> has been run on this disc before and did not
+     detect any errors.
+     Configuration Item: <literal>APT::CDROM::Fast</literal>.
+     </para>
+     </listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>-a</option></term><term><option>--thorough</option></term>
+     <listitem><para>Thorough Package Scan; This option may be needed with some
+      old Debian 1.1/1.2 discs that have Package files in strange places. It 
+      takes much longer to scan the CD but will pick them all up.
+     </para>
+     </listitem>
+     </varlistentry>
+     
+     <varlistentry><term><option>-n</option></term>
+                   <term><option>--just-print</option></term>
+                   <term><option>--recon</option></term>
+                   <term><option>--no-act</option></term>
+     <listitem><para>No Changes; Do not change the &sources-list; file and do
+     not write index files. Everything is still checked however.
+     Configuration Item: <literal>APT::CDROM::NoAct</literal>.
+     </para>
+     </listitem>
+     </varlistentry> 
+
+     &apt-commonoptions;
+
+   </variablelist>
+ </refsect1>
+
+ <refsect1><title>See Also</title>
+   <para>&apt-conf;, &apt-get;, &sources-list;
+   </para>
+ </refsect1>
+
+ <refsect1><title>Diagnostics</title>
+   <para><command>apt-cdrom</command> returns zero on normal operation, decimal 100 on error.
+   </para>
+ </refsect1>
+
+ &manbugs;
+
+</refentry>
+