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