]> git.saurik.com Git - apt.git/blame_incremental - doc/apt-cdrom.8.sgml
Include Otavio's email address at his request
[apt.git] / doc / apt-cdrom.8.sgml
... / ...
CommitLineData
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
49 <para>
50 Unless the <option/-h/, or <option/--help/ option is given one of the
51 commands below must be present.
52
53 <VariableList>
54 <VarListEntry><Term>add</Term>
55 <ListItem><Para>
56 <literal/add/ is used to add a new disc to the source list. It will unmount the
57 CDROM device, prompt for a disk to be inserted and then procceed to
58 scan it and copy the index files. If the disc does not have a proper
59 <filename>.disk/</> directory you will be prompted for a descriptive
60 title.
61
62 <para>
63 APT uses a CDROM ID to track which disc is currently in the drive and
64 maintains a database of these IDs in
65 <filename>&statedir;/cdroms.list</>
66 </VarListEntry>
67
68 <VarListEntry><Term>ident</Term>
69 <ListItem><Para>
70 A debugging tool to report the identity of the current disc as well
71 as the stored file name
72 </VarListEntry>
73 </VariableList>
74 </RefSect1>
75
76 <RefSect1><Title>Options</>
77 &apt-cmdblurb;
78
79 <VariableList>
80 <VarListEntry><term><option/-d/</><term><option/--cdrom/</>
81 <ListItem><Para>
82 Mount point; specify the location to mount the cdrom. This mount
83 point must be listed in <filename>/etc/fstab</> and propely configured.
84 Configuration Item: <literal/Acquire::cdrom::mount/.
85 </VarListEntry>
86
87 <VarListEntry><term><option/-r/</><term><option/--rename/</>
88 <ListItem><Para>
89 Rename a disc; change the label of a disk or override the disks
90 given label. This option will cause <command/apt-cdrom/ to prompt for
91 a new label.
92 Configuration Item: <literal/APT::CDROM::Rename/.
93 </VarListEntry>
94
95 <VarListEntry><term><option/-m/</><term><option/--no-mount/</>
96 <ListItem><Para>
97 No mounting; prevent <command/apt-cdrom/ from mounting and unmounting
98 the mount point.
99 Configuration Item: <literal/APT::CDROM::NoMount/.
100 </VarListEntry>
101
102 <VarListEntry><term><option/-f/</><term><option/--fast/</>
103 <ListItem><Para>
104 Fast Copy; Assume the package files are valid and do not check
105 every package. This option should be used only if
106 <command/apt-cdrom/ has been run on this disc before and did not detect
107 any errors.
108 Configuration Item: <literal/APT::CDROM::Fast/.
109 </VarListEntry>
110
111 <VarListEntry><term><option/-a/</><term><option/--thorough/</>
112 <ListItem><Para>
113 Thorough Package Scan; This option may be needed with some old
114 Debian 1.1/1.2 discs that have Package files in strange places. It
115 takes much longer to scan the CD but will pick them all up.
116 </VarListEntry>
117
118 <VarListEntry><term><option/-n/</>
119 <term><option/--just-print/</>
120 <term><option/--recon/</>
121 <term><option/--no-act/</>
122 <ListItem><Para>
123 No Changes; Do not change the &sources-list; file and do not
124 write index files. Everything is still checked however.
125 Configuration Item: <literal/APT::CDROM::NoAct/.
126 </VarListEntry>
127
128 &apt-commonoptions;
129
130 </VariableList>
131 </RefSect1>
132
133 <RefSect1><Title>See Also</>
134 <para>
135 &apt-conf;, &apt-get;, &sources-list;
136 </RefSect1>
137
138 <RefSect1><Title>Diagnostics</>
139 <para>
140 <command/apt-cdrom/ returns zero on normal operation, decimal 100 on error.
141 </RefSect1>
142
143 &manbugs;
144 &manauthor;
145
146</refentry>
147