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  &apt-docinfo;
  13
  14  <refmeta>
  15    <refentrytitle>apt-cdrom</refentrytitle>
  16    <manvolnum>8</manvolnum>
  17  </refmeta>
  18
  19  <!-- Man page title -->
  20  <refnamediv>
  21     <refname>apt-cdrom</refname>
  22     <refpurpose>APT CDROM management utility</refpurpose>
  23  </refnamediv>
  24
  25  <!-- Arguments -->
  26  <refsynopsisdiv>
  27    <cmdsynopsis>
  28       <command>apt-cdrom</command>
  29       <arg><option>-hvrmfan</option></arg>
  30       <arg><option>-d=<replaceable>cdrom mount point</replaceable></option></arg>
  31       <arg><option>-o=<replaceable>config string</replaceable></option></arg>
  32       <arg><option>-c=<replaceable>file</replaceable></option></arg>
  33       <group>
  34          <arg>add</arg>
  35          <arg>ident</arg>
  36       </group>
  37    </cmdsynopsis>
  38  </refsynopsisdiv>
  39
  40  <refsect1><title>Description</title>
  41    <para><command>apt-cdrom</command> is used to add a new CDROM to APTs list
  42     of available sources. <command>apt-cdrom</command> takes care of
  43    determining the structure of
  44    the disc as well as correcting for several possible mis-burns and
  45    verifying the index files.
  46    </para>
  47
  48    <para>It is necessary to use <command>apt-cdrom</command> to add CDs to the
  49    APT system,
  50    it cannot be done by hand. Furthermore each disk in a multi-cd set must be
  51    inserted and scanned separately to account for possible mis-burns.
  52    </para>
  53
  54    <para>Unless the <option>-h</option>, or <option>--help</option> option is
  55     given one of the commands below must be present.
  56
  57     <variablelist>
  58      <varlistentry><term>add</term>
  59      <listitem><para><literal>add</literal> is used to add a new disc to the
  60      source list. It will unmount the
  61      CDROM device, prompt for a disk to be inserted and then procceed to
  62      scan it and copy the index files. If the disc does not have a proper
  63      <filename>disk</filename> directory you will be prompted for a descriptive
  64      title.
  65      </para>
  66
  67      <para>APT uses a CDROM ID to track which disc is currently in the drive and
  68      maintains a database of these IDs in
  69      <filename>&statedir;/cdroms.list</filename>
  70      </para>
  71      </listitem>
  72      </varlistentry>
  73
  74      <varlistentry><term>ident</term>
  75      <listitem><para>A debugging tool to report the identity of the current
  76       disc as well as the stored file name
  77      </para>
  78      </listitem>
  79      </varlistentry>
  80     </variablelist>
  81    </para>
  82  </refsect1>
  83
  84  <refsect1><title>Options</title>
  85    &apt-cmdblurb;
  86
  87    <variablelist>
  88      <varlistentry><term><option>-d</option></term><term><option>--cdrom</option></term>
  89      <listitem><para>Mount point; specify the location to mount the cdrom. 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 disk or override the
  99       disks 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  &manauthor;
 160
 161 </refentry>
 162