- initial import of revision 374 from cnc
[apt.git] / 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 management 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><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><para>
49    Unless the <option/-h/, or <option/--help/ option is given one of the
50    commands below 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      </Para><Para>
61      APT uses a CDROM ID to track which disc is currently in the drive and
62      maintains a database of these IDs in 
63      <filename>&statedir;/cdroms.list</>
64      </Para></ListItem>
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      </Para></ListItem>
72      </VarListEntry>
73    </VariableList>
74    </para>
75  </RefSect1>
76
77  <RefSect1><Title>Options</>
78    &apt-cmdblurb;
79    
80    <VariableList>
81      <VarListEntry><term><option/-d/</><term><option/--cdrom/</>
82      <ListItem><Para>
83      Mount point; specify the location to mount the cdrom. This mount 
84      point must be listed in <filename>/etc/fstab</> and properly configured.
85      Configuration Item: <literal/Acquire::cdrom::mount/.
86      </Para></ListItem>
87      </VarListEntry>
88      
89      <VarListEntry><term><option/-r/</><term><option/--rename/</>
90      <ListItem><Para>
91      Rename a disc; change the label of a disk or override the disks 
92      given label. This option will cause <command/apt-cdrom/ to prompt for 
93      a new label.
94      Configuration Item: <literal/APT::CDROM::Rename/.
95      </Para></ListItem>
96      </VarListEntry>
97      
98      <VarListEntry><term><option/-m/</><term><option/--no-mount/</>
99      <ListItem><Para>
100      No mounting; prevent <command/apt-cdrom/ from mounting and unmounting 
101      the mount point.
102      Configuration Item: <literal/APT::CDROM::NoMount/.
103      </Para></ListItem>
104      </VarListEntry>
105      
106      <VarListEntry><term><option/-f/</><term><option/--fast/</>
107      <ListItem><Para>
108      Fast Copy; Assume the package files are valid and do not check 
109      every package. This option should be used only if
110      <command/apt-cdrom/ has been run on this disc before and did not detect 
111      any errors.
112      Configuration Item: <literal/APT::CDROM::Fast/.
113      </Para></ListItem>
114      </VarListEntry>
115      
116      <VarListEntry><term><option/-a/</><term><option/--thorough/</>
117      <ListItem><Para>
118      Thorough Package Scan; This option may be needed with some old 
119      Debian 1.1/1.2 discs that have Package files in strange places. It 
120      takes much longer to scan the CD but will pick them all up.
121      </Para></ListItem>
122      </VarListEntry>
123      
124      <VarListEntry><term><option/-n/</>
125                    <term><option/--just-print/</>
126                    <term><option/--recon/</>
127                    <term><option/--no-act/</>
128      <ListItem><Para>
129      No Changes; Do not change the &sources-list; file and do not 
130      write index files. Everything is still checked however.
131      Configuration Item: <literal/APT::CDROM::NoAct/.
132      </Para></ListItem>
133      </VarListEntry> 
134  
135      &apt-commonoptions;
136      
137    </VariableList>
138  </RefSect1>
139
140  <RefSect1><Title>See Also</>
141    <para>
142    &apt-conf;, &apt-get;, &sources-list;
143    </para>
144  </RefSect1>
145
146  <RefSect1><Title>Diagnostics</>
147    <para>
148    <command/apt-cdrom/ returns zero on normal operation, decimal 100 on error.
149    </para>
150  </RefSect1>
151
152  &manbugs;
153  &manauthor;
154
155 </refentry>
156