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