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