doc/apt-cdrom.8.xml

   1 <?xml version="1.0" encoding="utf-8" standalone="no"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4
   5 <!ENTITY % aptent SYSTEM "apt.ent">
   6 %aptent;
   7
   8 ]>
   9
  10 <refentry>
  11
  12  <refentryinfo>
  13    &apt-author.jgunthorpe;
  14    &apt-author.team;
  15    &apt-email;
  16    &apt-product;
  17    <date>14 February 2004</date>
  18  </refentryinfo>
  19
  20  <refmeta>
  21    <refentrytitle>apt-cdrom</refentrytitle>
  22    <manvolnum>8</manvolnum>
  23  </refmeta>
  24
  25  <!-- Man page title -->
  26  <refnamediv>
  27     <refname>apt-cdrom</refname>
  28     <refpurpose>APT CDROM management utility</refpurpose>
  29  </refnamediv>
  30
  31  <!-- Arguments -->
  32  <refsynopsisdiv>
  33    <cmdsynopsis>
  34       <command>apt-cdrom</command>
  35       <arg><option>-hvrmfan</option></arg>
  36       <arg><option>-d=<replaceable>cdrom mount point</replaceable></option></arg>
  37       <arg><option>-o=<replaceable>config string</replaceable></option></arg>
  38       <arg><option>-c=<replaceable>file</replaceable></option></arg>
  39       <group>
  40          <arg>add</arg>
  41          <arg>ident</arg>
  42       </group>
  43    </cmdsynopsis>
  44  </refsynopsisdiv>
  45
  46  <refsect1><title>Description</title>
  47    <para><command>apt-cdrom</command> is used to add a new CDROM to APTs list
  48     of available sources. <command>apt-cdrom</command> takes care of
  49    determining the structure of
  50    the disc as well as correcting for several possible mis-burns and
  51    verifying the index files.
  52    </para>
  53
  54    <para>It is necessary to use <command>apt-cdrom</command> to add CDs to the
  55    APT system,
  56    it cannot be done by hand. Furthermore each disk in a multi-cd set must be
  57    inserted and scanned separately to account for possible mis-burns.
  58    </para>
  59
  60    <para>Unless the <option>-h</option>, or <option>--help</option> option is
  61     given one of the commands below must be present.
  62
  63     <variablelist>
  64      <varlistentry><term>add</term>
  65      <listitem><para><literal>add</literal> is used to add a new disc to the
  66      source list. It will unmount the
  67      CDROM device, prompt for a disk to be inserted and then procceed to
  68      scan it and copy the index files. If the disc does not have a proper
  69      <filename>disk</filename> directory you will be prompted for a descriptive
  70      title.
  71      </para>
  72
  73      <para>APT uses a CDROM ID to track which disc is currently in the drive and
  74      maintains a database of these IDs in
  75      <filename>&statedir;/cdroms.list</filename>
  76      </para>
  77      </listitem>
  78      </varlistentry>
  79
  80      <varlistentry><term>ident</term>
  81      <listitem><para>A debugging tool to report the identity of the current
  82       disc as well as the stored file name
  83      </para>
  84      </listitem>
  85      </varlistentry>
  86     </variablelist>
  87    </para>
  88  </refsect1>
  89
  90  <refsect1><title>Options</title>
  91    &apt-cmdblurb;
  92
  93    <variablelist>
  94      <varlistentry><term><option>-d</option></term><term><option>--cdrom</option></term>
  95      <listitem><para>Mount point; specify the location to mount the cdrom. This
  96       mount point must be listed in <filename>/etc/fstab</filename> and
  97       properly configured.
  98       Configuration Item: <literal>Acquire::cdrom::mount</literal>.
  99      </para>
 100      </listitem>
 101      </varlistentry>
 102
 103      <varlistentry><term><option>-r</option></term><term><option>--rename</option></term>
 104      <listitem><para>Rename a disc; change the label of a disk or override the
 105       disks given label. This option will cause <command>apt-cdrom</command> to
 106       prompt for a new label.
 107      Configuration Item: <literal>APT::CDROM::Rename</literal>.
 108      </para>
 109      </listitem>
 110      </varlistentry>
 111
 112      <varlistentry><term><option>-m</option></term><term><option>--no-mount</option></term>
 113      <listitem><para>No mounting; prevent <command>apt-cdrom</command> from
 114       mounting and unmounting the mount point.
 115      Configuration Item: <literal>APT::CDROM::NoMount</literal>.
 116      </para>
 117      </listitem>
 118      </varlistentry>
 119
 120      <varlistentry><term><option>-f</option></term><term><option>--fast</option></term>
 121      <listitem><para>Fast Copy; Assume the package files are valid and do not
 122       check every package. This option should be used only if
 123      <command>apt-cdrom</command> has been run on this disc before and did not
 124      detect any errors.
 125      Configuration Item: <literal>APT::CDROM::Fast</literal>.
 126      </para>
 127      </listitem>
 128      </varlistentry>
 129
 130      <varlistentry><term><option>-a</option></term><term><option>--thorough</option></term>
 131      <listitem><para>Thorough Package Scan; This option may be needed with some
 132       old Debian 1.1/1.2 discs that have Package files in strange places. It
 133       takes much longer to scan the CD but will pick them all up.
 134      </para>
 135      </listitem>
 136      </varlistentry>
 137
 138      <varlistentry><term><option>-n</option></term>
 139                    <term><option>--just-print</option></term>
 140                    <term><option>--recon</option></term>
 141                    <term><option>--no-act</option></term>
 142      <listitem><para>No Changes; Do not change the &sources-list; file and do
 143      not write index files. Everything is still checked however.
 144      Configuration Item: <literal>APT::CDROM::NoAct</literal>.
 145      </para>
 146      </listitem>
 147      </varlistentry>
 148
 149      &apt-commonoptions;
 150
 151    </variablelist>
 152  </refsect1>
 153
 154  <refsect1><title>See Also</title>
 155    <para>&apt-conf;, &apt-get;, &sources-list;
 156    </para>
 157  </refsect1>
 158
 159  <refsect1><title>Diagnostics</title>
 160    <para><command>apt-cdrom</command> returns zero on normal operation, decimal 100 on error.
 161    </para>
 162  </refsect1>
 163
 164  &manbugs;
 165
 166 </refentry>
 167