summaryrefslogtreecommitdiff
path: root/doc/apt-cdrom.8.sgml
blob: ce8e4aad41e4a4af19ee9c8837e83864df00ecee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<!-- -*- mode: sgml; mode: fold -*- -->
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

]>

<refentry>
 &apt-docinfo;
 
 <refmeta>
   <refentrytitle>apt-cdrom</>
   <manvolnum>8</>
 </refmeta>
 
 <!-- Man page title -->
 <refnamediv>
    <refname>apt-cdrom</>
    <refpurpose>APT CDROM managment utility</>
 </refnamediv>

 <!-- Arguments -->
 <refsynopsisdiv>
   <cmdsynopsis>
      <command>apt-cdrom</>
      <arg><option>-hvrmfan</></arg>
      <arg><option>-d=<replaceable/cdrom mount point/</></arg>
      <arg><option>-o=<replaceable/config string/</></arg>
      <arg><option>-c=<replaceable/file/</></arg>
      <group choice=req>
         <arg>add</>
         <arg>ident</>
      </group>   
   </cmdsynopsis>
 </refsynopsisdiv>

 <RefSect1><Title>Description</>
   <para>
   <command/apt-cdrom/ is used to add a new CDROM to APTs list of available 
   sources. <command/apt-cdrom/ takes care of determining the structure of 
   the disc as well as correcting for several possible mis-burns and 
   verifying the index files.   
   <para>
   It is necessary to use <command/apt-cdrom/ to add CDs to the APT system, 
   it cannot be done by hand. Furthermore each disk in a multi-cd set must be
   inserted and scanned separately to account for possible mis-burns.

   <para>
   Unless the <option/-h/, or <option/--help/ option is given one of the
   commands below must be present.
   
   <VariableList>
     <VarListEntry><Term>add</Term>
     <ListItem><Para>
     <literal/add/ is used to add a new disc to the source list. It will unmount the
     CDROM device, prompt for a disk to be inserted and then procceed to 
     scan it and copy the index files. If the disc does not have a proper
     <filename>.disk/</> directory you will be prompted for a descriptive 
     title.

     <para>
     APT uses a CDROM ID to track which disc is currently in the drive and
     maintains a database of these IDs in 
     <filename>&statedir;/cdroms.list</>
     </VarListEntry>
     
     <VarListEntry><Term>ident</Term>
     <ListItem><Para>
     A debugging tool to report the identity of the current disc as well
     as the stored file name
     </VarListEntry>
   </VariableList>
 </RefSect1>

 <RefSect1><Title>Options</>
   &apt-cmdblurb;
   
   <VariableList>
     <VarListEntry><term><option/-d/</><term><option/--cdrom/</>
     <ListItem><Para>
     Mount point; specify the location to mount the cdrom. This mount 
     point must be listed in <filename>/etc/fstab</> and propely configured.
     Configuration Item: <literal/Acquire::cdrom::mount/.
     </VarListEntry>
     
     <VarListEntry><term><option/-r/</><term><option/--rename/</>
     <ListItem><Para>
     Rename a disc; change the label of a disk or override the disks 
     given label. This option will cause <command/apt-cdrom/ to prompt for 
     a new label.
     Configuration Item: <literal/APT::CDROM::Rename/.
     </VarListEntry>
     
     <VarListEntry><term><option/-m/</><term><option/--no-mount/</>
     <ListItem><Para>
     No mounting; prevent <command/apt-cdrom/ from mounting and unmounting 
     the mount point.
     Configuration Item: <literal/APT::CDROM::NoMount/.
     </VarListEntry>
     
     <VarListEntry><term><option/-f/</><term><option/--fast/</>
     <ListItem><Para>
     Fast Copy; Assume the package files are valid and do not check 
     every package. This option should be used only if
     <command/apt-cdrom/ has been run on this disc before and did not detect 
     any errors.
     Configuration Item: <literal/APT::CDROM::Fast/.
     </VarListEntry>
     
     <VarListEntry><term><option/-a/</><term><option/--thorough/</>
     <ListItem><Para>
     Thorough Package Scan; This option may be needed with some old 
     Debian 1.1/1.2 discs that have Package files in strange places. It 
     takes much longer to scan the CD but will pick them all up.
     </VarListEntry>
     
     <VarListEntry><term><option/-n/</>
                   <term><option/--just-print/</>
                   <term><option/--recon/</>
                   <term><option/--no-act/</>
     <ListItem><Para>
     No Changes; Do not change the &sources-list; file and do not 
     write index files. Everything is still checked however.
     Configuration Item: <literal/APT::CDROM::NoAct/.
     </VarListEntry> 
 
     &apt-commonoptions;
     
   </VariableList>
 </RefSect1>

 <RefSect1><Title>See Also</>
   <para>
   &apt-conf;, &apt-get;, &sources-list;
 </RefSect1>

 <RefSect1><Title>Diagnostics</>
   <para>
   <command/apt-cdrom/ returns zero on normal operation, decimal 100 on error.
 </RefSect1>

 &manbugs;
 &manauthor;

</refentry>