[apt-legacy.git] / doc / apt-cdrom.8

.\"     Title: apt\-cdrom
.\"    Author: Jason Gunthorpe
.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
.\"      Date: 14 February 2004
.\"    Manual: 
.\"    Source: Linux
.\"
.TH "APT\-CDROM" "8" "14 February 2004" "Linux" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
apt\-cdrom \- APT CDROM management utility
.SH "SYNOPSIS"
.HP 10
\fBapt\-cdrom\fR [\fB\-hvrmfan\fR] [\fB\-d=\fR\fB\fIcdrom\ mount\ point\fR\fR] [\fB\-o=\fR\fB\fIconfig\ string\fR\fR] [\fB\-c=\fR\fB\fIfile\fR\fR] [[add] | [ident]]
.SH "DESCRIPTION"
.PP
\fBapt\-cdrom\fR
is used to add a new CDROM to APTs list of available sources.
\fBapt\-cdrom\fR
takes care of determining the structure of the disc as well as correcting for several possible mis\-burns and verifying the index files.
.PP
It is necessary to use
\fBapt\-cdrom\fR
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.
.PP
Unless the
\fB\-h\fR, or
\fB\-\-help\fR
option is given one of the commands below must be present.
.PP
add
.RS 3n
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
\fIdisk\fR
directory you will be prompted for a descriptive title.
.sp
APT uses a CDROM ID to track which disc is currently in the drive and maintains a database of these IDs in
\fI/var/lib/apt/cdroms.list\fR
.RE
.PP
ident
.RS 3n
A debugging tool to report the identity of the current disc as well as the stored file name
.RE
.SH "OPTIONS"
.PP
All command line options may be set using the configuration file, the descriptions indicate the configuration option to set. For boolean options you can override the config file by using something like
\fB\-f\-\fR,\fB\-\-no\-f\fR,
\fB\-f=no\fR
or several other variations.
.PP
\fB\-d\fR, \fB\-\-cdrom\fR
.RS 3n
Mount point; specify the location to mount the cdrom. This mount point must be listed in
\fI/etc/fstab\fR
and properly configured. Configuration Item:
Acquire::cdrom::mount.
.RE
.PP
\fB\-r\fR, \fB\-\-rename\fR
.RS 3n
Rename a disc; change the label of a disk or override the disks given label. This option will cause
\fBapt\-cdrom\fR
to prompt for a new label. Configuration Item:
APT::CDROM::Rename.
.RE
.PP
\fB\-m\fR, \fB\-\-no\-mount\fR
.RS 3n
No mounting; prevent
\fBapt\-cdrom\fR
from mounting and unmounting the mount point. Configuration Item:
APT::CDROM::NoMount.
.RE
.PP
\fB\-f\fR, \fB\-\-fast\fR
.RS 3n
Fast Copy; Assume the package files are valid and do not check every package. This option should be used only if
\fBapt\-cdrom\fR
has been run on this disc before and did not detect any errors. Configuration Item:
APT::CDROM::Fast.
.RE
.PP
\fB\-a\fR, \fB\-\-thorough\fR
.RS 3n
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.
.RE
.PP
\fB\-n\fR, \fB\-\-just\-print\fR, \fB\-\-recon\fR, \fB\-\-no\-act\fR
.RS 3n
No Changes; Do not change the
\fBsources.list\fR(5)
file and do not write index files. Everything is still checked however. Configuration Item:
APT::CDROM::NoAct.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 3n
Show a short usage summary.
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 3n
Show the program version.
.RE
.PP
\fB\-c\fR, \fB\-\-config\-file\fR
.RS 3n
Configuration File; Specify a configuration file to use. The program will read the default configuration file and then this configuration file. See
\fBapt.conf\fR(5)
for syntax information.
.RE
.PP
\fB\-o\fR, \fB\-\-option\fR
.RS 3n
Set a Configuration Option; This will set an arbitary configuration option. The syntax is
\fB\-o Foo::Bar=bar\fR.
.RE
.SH "SEE ALSO"
.PP
\fBapt.conf\fR(5),
\fBapt\-get\fR(8),
\fBsources.list\fR(5)
.SH "DIAGNOSTICS"
.PP
\fBapt\-cdrom\fR
returns zero on normal operation, decimal 100 on error.
.SH "BUGS"
.PP
[1]\&\fIAPT bug page\fR. If you wish to report a bug in APT, please see
\fI/usr/share/doc/debian/bug\-reporting.txt\fR
or the
\fBreportbug\fR(1)
command.
.SH "AUTHORS"
.PP
\fBJason Gunthorpe\fR
.sp -1n
.IP "" 3n
Author.
.PP
\fBAPT team\fR
.sp -1n
.IP "" 3n
Author.
.SH "REFERENCES"
.TP 3
1.\ APT bug page
\%http://bugs.debian.org/src:apt
Commit	Line	Data
da6ee469 JF	1	.\" Title: apt\-cdrom
	2	.\" Author: Jason Gunthorpe
	3	.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
	4	.\" Date: 14 February 2004
	5	.\" Manual:
	6	.\" Source: Linux
	7	.\"
	8	.TH "APT\-CDROM" "8" "14 February 2004" "Linux" ""
	9	.\" disable hyphenation
	10	.nh
	11	.\" disable justification (adjust text to left margin only)
	12	.ad l
	13	.SH "NAME"
	14	apt\-cdrom \- APT CDROM management utility
	15	.SH "SYNOPSIS"
	16	.HP 10
	17	\fBapt\-cdrom\fR [\fB\-hvrmfan\fR] [\fB\-d=\fR\fB\fIcdrom\ mount\ point\fR\fR] [\fB\-o=\fR\fB\fIconfig\ string\fR\fR] [\fB\-c=\fR\fB\fIfile\fR\fR] [[add] \| [ident]]
	18	.SH "DESCRIPTION"
	19	.PP
	20	\fBapt\-cdrom\fR
	21	is used to add a new CDROM to APTs list of available sources.
	22	\fBapt\-cdrom\fR
	23	takes care of determining the structure of the disc as well as correcting for several possible mis\-burns and verifying the index files.
	24	.PP
	25	It is necessary to use
	26	\fBapt\-cdrom\fR
	27	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.
	28	.PP
	29	Unless the
	30	\fB\-h\fR, or
	31	\fB\-\-help\fR
	32	option is given one of the commands below must be present.
	33	.PP
	34	add
	35	.RS 3n
	36	add
	37	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
	38	\fIdisk\fR
	39	directory you will be prompted for a descriptive title.
	40	.sp
	41	APT uses a CDROM ID to track which disc is currently in the drive and maintains a database of these IDs in
	42	\fI/var/lib/apt/cdroms.list\fR
	43	.RE
	44	.PP
	45	ident
	46	.RS 3n
	47	A debugging tool to report the identity of the current disc as well as the stored file name
	48	.RE
	49	.SH "OPTIONS"
	50	.PP
	51	All command line options may be set using the configuration file, the descriptions indicate the configuration option to set. For boolean options you can override the config file by using something like
	52	\fB\-f\-\fR,\fB\-\-no\-f\fR,
	53	\fB\-f=no\fR
	54	or several other variations.
	55	.PP
	56	\fB\-d\fR, \fB\-\-cdrom\fR
	57	.RS 3n
	58	Mount point; specify the location to mount the cdrom. This mount point must be listed in
	59	\fI/etc/fstab\fR
	60	and properly configured. Configuration Item:
	61	Acquire::cdrom::mount.
	62	.RE
	63	.PP
	64	\fB\-r\fR, \fB\-\-rename\fR
65	.RS 3n
66	Rename a disc; change the label of a disk or override the disks given label. This option will cause
67	\fBapt\-cdrom\fR
68	to prompt for a new label. Configuration Item:
69	APT::CDROM::Rename.
70	.RE
71	.PP
72	\fB\-m\fR, \fB\-\-no\-mount\fR
73	.RS 3n
74	No mounting; prevent
75	\fBapt\-cdrom\fR
76	from mounting and unmounting the mount point. Configuration Item:
77	APT::CDROM::NoMount.
78	.RE
79	.PP
80	\fB\-f\fR, \fB\-\-fast\fR
81	.RS 3n
82	Fast Copy; Assume the package files are valid and do not check every package. This option should be used only if
83	\fBapt\-cdrom\fR
84	has been run on this disc before and did not detect any errors. Configuration Item:
85	APT::CDROM::Fast.
86	.RE
87	.PP
88	\fB\-a\fR, \fB\-\-thorough\fR
89	.RS 3n
90	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.
91	.RE
92	.PP
93	\fB\-n\fR, \fB\-\-just\-print\fR, \fB\-\-recon\fR, \fB\-\-no\-act\fR
94	.RS 3n
95	No Changes; Do not change the
96	\fBsources.list\fR(5)
97	file and do not write index files. Everything is still checked however. Configuration Item:
98	APT::CDROM::NoAct.
99	.RE
100	.PP
101	\fB\-h\fR, \fB\-\-help\fR
102	.RS 3n
103	Show a short usage summary.
104	.RE
105	.PP
106	\fB\-v\fR, \fB\-\-version\fR
107	.RS 3n
108	Show the program version.
109	.RE
110	.PP
111	\fB\-c\fR, \fB\-\-config\-file\fR
112	.RS 3n
113	Configuration File; Specify a configuration file to use. The program will read the default configuration file and then this configuration file. See
114	\fBapt.conf\fR(5)
115	for syntax information.
116	.RE
117	.PP
118	\fB\-o\fR, \fB\-\-option\fR
119	.RS 3n
120	Set a Configuration Option; This will set an arbitary configuration option. The syntax is
121	\fB\-o Foo::Bar=bar\fR.
122	.RE
123	.SH "SEE ALSO"
124	.PP
125	\fBapt.conf\fR(5),
126	\fBapt\-get\fR(8),
127	\fBsources.list\fR(5)
128	.SH "DIAGNOSTICS"
129	.PP
130	\fBapt\-cdrom\fR
131	returns zero on normal operation, decimal 100 on error.
132	.SH "BUGS"
133	.PP
134	[1]\&\fIAPT bug page\fR. If you wish to report a bug in APT, please see
135	\fI/usr/share/doc/debian/bug\-reporting.txt\fR
136	or the
137	\fBreportbug\fR(1)
138	command.
139	.SH "AUTHORS"
140	.PP
141	\fBJason Gunthorpe\fR
142	.sp -1n
143	.IP "" 3n
144	Author.
145	.PP
146	\fBAPT team\fR
147	.sp -1n
148	.IP "" 3n
149	Author.
150	.SH "REFERENCES"
151	.TP 3
152	1.\ APT bug page
153	\%http://bugs.debian.org/src:apt