- only build documentation in maintainer-mode, include prebuilt manuals
[apt.git] / doc / apt-cdrom.8
1 .\" This manpage has been automatically generated by docbook2man 
2 .\" from a DocBook document.  This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "APT-CDROM" "8" "29 May 2006" "" ""
7
8 .SH NAME
9 apt-cdrom \- APT CDROM management utility
10 .SH SYNOPSIS
11
12 \fBapt-cdrom\fR [ \fB-hvrmfan\fR ] [ \fB-d=\fIcdrom mount point\fB\fR ] [ \fB-o=\fIconfig string\fB\fR ] [ \fB-c=\fIfile\fB\fR ] { \fBadd\fR | \fBident\fR }
13
14 .SH "DESCRIPTION"
15 .PP
16 \fBapt-cdrom\fR is used to add a new CDROM to APTs list of available 
17 sources. \fBapt-cdrom\fR takes care of determining the structure of 
18 the disc as well as correcting for several possible mis-burns and 
19 verifying the index files.   
20 .PP
21 It is necessary to use \fBapt-cdrom\fR to add CDs to the APT system, 
22 it cannot be done by hand. Furthermore each disk in a multi-cd set must be
23 inserted and scanned separately to account for possible mis-burns.
24 .PP
25 Unless the \fB-h\fR, or \fB--help\fR option is given one of the
26 commands below must be present.
27 .TP
28 \fBadd\fR
29 add is used to add a new disc to the source list. It will unmount the
30 CDROM device, prompt for a disk to be inserted and then procceed to 
31 scan it and copy the index files. If the disc does not have a proper
32 \fI\&.disk/\fR directory you will be prompted for a descriptive 
33 title.
34
35 APT uses a CDROM ID to track which disc is currently in the drive and
36 maintains a database of these IDs in 
37 \fI/var/lib/apt/cdroms.list\fR
38 .TP
39 \fBident\fR
40 A debugging tool to report the identity of the current disc as well
41 as the stored file name
42 .SH "OPTIONS"
43 .PP
44 All command line options may be set using the configuration file, the
45 descriptions indicate the configuration option to set. For boolean
46 options you can override the config file by using something like 
47 \fB-f-\fR,\fB--no-f\fR, \fB-f=no\fR or several other variations.
48 .TP
49 \fB-d\fR
50 .TP
51 \fB--cdrom\fR
52 Mount point; specify the location to mount the cdrom. This mount 
53 point must be listed in \fI/etc/fstab\fR and properly configured.
54 Configuration Item: Acquire::cdrom::mount\&.
55 .TP
56 \fB-r\fR
57 .TP
58 \fB--rename\fR
59 Rename a disc; change the label of a disk or override the disks 
60 given label. This option will cause \fBapt-cdrom\fR to prompt for 
61 a new label.
62 Configuration Item: APT::CDROM::Rename\&.
63 .TP
64 \fB-m\fR
65 .TP
66 \fB--no-mount\fR
67 No mounting; prevent \fBapt-cdrom\fR from mounting and unmounting 
68 the mount point.
69 Configuration Item: APT::CDROM::NoMount\&.
70 .TP
71 \fB-f\fR
72 .TP
73 \fB--fast\fR
74 Fast Copy; Assume the package files are valid and do not check 
75 every package. This option should be used only if
76 \fBapt-cdrom\fR has been run on this disc before and did not detect 
77 any errors.
78 Configuration Item: APT::CDROM::Fast\&.
79 .TP
80 \fB-a\fR
81 .TP
82 \fB--thorough\fR
83 Thorough Package Scan; This option may be needed with some old 
84 Debian 1.1/1.2 discs that have Package files in strange places. It 
85 takes much longer to scan the CD but will pick them all up.
86 .TP
87 \fB-n\fR
88 .TP
89 \fB--just-print\fR
90 .TP
91 \fB--recon\fR
92 .TP
93 \fB--no-act\fR
94 No Changes; Do not change the \fB\fIsources.list\fB\fR(5) file and do not 
95 write index files. Everything is still checked however.
96 Configuration Item: APT::CDROM::NoAct\&.
97 .TP
98 \fB-h\fR
99 .TP
100 \fB--help\fR
101 Show a short usage summary.
102 .TP
103 \fB-v\fR
104 .TP
105 \fB--version\fR
106 Show the program version.
107 .TP
108 \fB-c\fR
109 .TP
110 \fB--config-file\fR
111 Configuration File; Specify a configuration file to use. 
112 The program will read the default configuration file and then this 
113 configuration file. See \fB\fIapt.conf\fB\fR(5) for syntax information.     
114 .TP
115 \fB-o\fR
116 .TP
117 \fB--option\fR
118 Set a Configuration Option; This will set an arbitrary configuration 
119 option. The syntax is \fB-o Foo::Bar=bar\fR\&.
120 .SH "SEE ALSO"
121 .PP
122 \fB\fIapt.conf\fB\fR(5), \fBapt-get\fR(8), \fB\fIsources.list\fB\fR(5)
123 .SH "DIAGNOSTICS"
124 .PP
125 \fBapt-cdrom\fR returns zero on normal operation, decimal 100 on error.
126 .SH "BUGS"
127 .PP
128 See the APT bug page <URL:http://bugs.debian.org/src:apt>\&.  
129 If you wish to report a bug in APT, please see
130 \fI/usr/share/doc/debian/bug-reporting.txt\fR or the \fBreportbug\fR(1) command.
131 .SH "AUTHOR"
132 .PP
133 APT was written by the APT team <apt@packages.debian.org>\&.