doc/apt-cdrom.8.xml

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