test-indexes.sh: EXFAIL: file:/ URIs currently decompress even with the GzipIndexes...

[apt.git] / doc / apt-cdrom.8.xml

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

]>

<refentry>

 <refentryinfo>
   &apt-author.jgunthorpe;
   &apt-author.team;
   &apt-email;
   &apt-product;
   <date>14 February 2004</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 CDROM management utility</refpurpose>
 </refnamediv>

 <!-- Arguments -->
 <refsynopsisdiv>
   <cmdsynopsis>
      <command>apt-cdrom</command>
      <arg><option>-hvrmfan</option></arg>
      <arg><option>-d=<replaceable>cdrom mount point</replaceable></option></arg>
      <arg><option>-o=<replaceable>config string</replaceable></option></arg>
      <arg><option>-c=<replaceable>file</replaceable></option></arg>
      <group>
         <arg>add</arg>
         <arg>ident</arg>
      </group>   
   </cmdsynopsis>
 </refsynopsisdiv>

 <refsect1><title>Description</title>
   <para><command>apt-cdrom</command> is used to add a new CDROM to APTs 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 disk 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.
   
    <variablelist>
     <varlistentry><term>add</term>
     <listitem><para><literal>add</literal> is used to add a new disc to the
     source list. It will unmount the
     CDROM device, prompt for a disk 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 CDROM 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>ident</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>
   </para>
 </refsect1>

 <refsect1><title>Options</title>
   &apt-cmdblurb;
   
   <variablelist>
     <varlistentry><term><option>-d</option></term><term><option>--cdrom</option></term>
     <listitem><para>Mount point; specify the location to mount the cdrom. 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 disk or override the
      disks 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>