doc/apt-cdrom.8.sgml

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