| 1 | <?xml version="1.0" encoding="utf-8" standalone="no"?> |
| 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ |
| 4 | |
| 5 | <!ENTITY % aptent SYSTEM "apt.ent"> |
| 6 | %aptent; |
| 7 | |
| 8 | <!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> |
| 9 | %aptverbatiment; |
| 10 | |
| 11 | <!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> |
| 12 | %aptvendor; |
| 13 | ]> |
| 14 | |
| 15 | <refentry> |
| 16 | |
| 17 | <refentryinfo> |
| 18 | &apt-author.jgunthorpe; |
| 19 | &apt-author.team; |
| 20 | &apt-email; |
| 21 | &apt-product; |
| 22 | <date>2012-06-09T00:00:00Z</date> |
| 23 | </refentryinfo> |
| 24 | |
| 25 | <refmeta> |
| 26 | <refentrytitle>apt-cdrom</refentrytitle> |
| 27 | <manvolnum>8</manvolnum> |
| 28 | <refmiscinfo class="manual">APT</refmiscinfo> |
| 29 | </refmeta> |
| 30 | |
| 31 | <!-- Man page title --> |
| 32 | <refnamediv> |
| 33 | <refname>apt-cdrom</refname> |
| 34 | <refpurpose>APT CD-ROM management utility</refpurpose> |
| 35 | </refnamediv> |
| 36 | |
| 37 | &synopsis-command-apt-cdrom; |
| 38 | |
| 39 | <refsect1><title>Description</title> |
| 40 | <para><command>apt-cdrom</command> is used to add a new CD-ROM to APT's list |
| 41 | of available sources. <command>apt-cdrom</command> takes care of |
| 42 | determining the structure of |
| 43 | the disc as well as correcting for several possible mis-burns and |
| 44 | verifying the index files. |
| 45 | </para> |
| 46 | |
| 47 | <para>It is necessary to use <command>apt-cdrom</command> to add CDs to the |
| 48 | APT system; |
| 49 | it cannot be done by hand. Furthermore each disc in a multi-CD set must be |
| 50 | inserted and scanned separately to account for possible mis-burns. |
| 51 | </para> |
| 52 | |
| 53 | <para>Unless the <option>-h</option>, or <option>--help</option> option is |
| 54 | given, one of the commands below must be present.</para> |
| 55 | |
| 56 | <variablelist> |
| 57 | <varlistentry><term><option>add</option></term> |
| 58 | <listitem><para><literal>add</literal> is used to add a new disc to the |
| 59 | source list. It will unmount the |
| 60 | CD-ROM device, prompt for a disc to be inserted and then proceed to |
| 61 | scan it and copy the index files. If the disc does not have a proper |
| 62 | <filename>.disk</filename> directory you will be prompted for a descriptive |
| 63 | title. |
| 64 | </para> |
| 65 | |
| 66 | <para>APT uses a CD-ROM ID to track which disc is currently in the drive and |
| 67 | maintains a database of these IDs in |
| 68 | <filename>&statedir;/cdroms.list</filename> |
| 69 | </para> |
| 70 | </listitem> |
| 71 | </varlistentry> |
| 72 | |
| 73 | <varlistentry><term><option>ident</option></term> |
| 74 | <listitem><para>A debugging tool to report the identity of the current |
| 75 | disc as well as the stored file name |
| 76 | </para> |
| 77 | </listitem> |
| 78 | </varlistentry> |
| 79 | </variablelist> |
| 80 | </refsect1> |
| 81 | |
| 82 | <refsect1><title>Options</title> |
| 83 | &apt-cmdblurb; |
| 84 | |
| 85 | <variablelist> |
| 86 | <varlistentry><term><option>--no-auto-detect</option></term><term><option>--cdrom</option></term> |
| 87 | <listitem><para>Do not try to auto-detect the CD-ROM path. Usually combined with the <option>--cdrom</option> option. |
| 88 | Configuration Item: <literal>Acquire::cdrom::AutoDetect</literal>. |
| 89 | </para> |
| 90 | </listitem> |
| 91 | </varlistentry> |
| 92 | |
| 93 | |
| 94 | <varlistentry><term><option>-d</option></term><term><option>--cdrom</option></term> |
| 95 | <listitem><para>Mount point; specify the location to mount the CD-ROM. This |
| 96 | mount point must be listed in <filename>/etc/fstab</filename> and |
| 97 | properly configured. |
| 98 | Configuration Item: <literal>Acquire::cdrom::mount</literal>. |
| 99 | </para> |
| 100 | </listitem> |
| 101 | </varlistentry> |
| 102 | |
| 103 | <varlistentry><term><option>-r</option></term><term><option>--rename</option></term> |
| 104 | <listitem><para>Rename a disc; change the label of a disc or override the |
| 105 | disc's given label. This option will cause <command>apt-cdrom</command> to |
| 106 | prompt for a new label. |
| 107 | Configuration Item: <literal>APT::CDROM::Rename</literal>. |
| 108 | </para> |
| 109 | </listitem> |
| 110 | </varlistentry> |
| 111 | |
| 112 | <varlistentry><term><option>-m</option></term><term><option>--no-mount</option></term> |
| 113 | <listitem><para>No mounting; prevent <command>apt-cdrom</command> from |
| 114 | mounting and unmounting the mount point. |
| 115 | Configuration Item: <literal>APT::CDROM::NoMount</literal>. |
| 116 | </para> |
| 117 | </listitem> |
| 118 | </varlistentry> |
| 119 | |
| 120 | <varlistentry><term><option>-f</option></term><term><option>--fast</option></term> |
| 121 | <listitem><para>Fast Copy; Assume the package files are valid and do not |
| 122 | check every package. This option should be used only if |
| 123 | <command>apt-cdrom</command> has been run on this disc before and did not |
| 124 | detect any errors. |
| 125 | Configuration Item: <literal>APT::CDROM::Fast</literal>. |
| 126 | </para> |
| 127 | </listitem> |
| 128 | </varlistentry> |
| 129 | |
| 130 | <varlistentry><term><option>-a</option></term><term><option>--thorough</option></term> |
| 131 | <listitem><para>Thorough Package Scan; This option may be needed with some |
| 132 | old Debian 1.1/1.2 discs that have Package files in strange places. It |
| 133 | takes much longer to scan the CD but will pick them all up. |
| 134 | </para> |
| 135 | </listitem> |
| 136 | </varlistentry> |
| 137 | |
| 138 | <varlistentry><term><option>-n</option></term> |
| 139 | <term><option>--just-print</option></term> |
| 140 | <term><option>--recon</option></term> |
| 141 | <term><option>--no-act</option></term> |
| 142 | <listitem><para>No Changes; Do not change the &sources-list; file and do |
| 143 | not write index files. Everything is still checked however. |
| 144 | Configuration Item: <literal>APT::CDROM::NoAct</literal>. |
| 145 | </para> |
| 146 | </listitem> |
| 147 | </varlistentry> |
| 148 | |
| 149 | &apt-commonoptions; |
| 150 | |
| 151 | </variablelist> |
| 152 | </refsect1> |
| 153 | |
| 154 | <refsect1><title>See Also</title> |
| 155 | <para>&apt-conf;, &apt-get;, &sources-list; |
| 156 | </para> |
| 157 | </refsect1> |
| 158 | |
| 159 | <refsect1><title>Diagnostics</title> |
| 160 | <para><command>apt-cdrom</command> returns zero on normal operation, decimal 100 on error. |
| 161 | </para> |
| 162 | </refsect1> |
| 163 | |
| 164 | &manbugs; |
| 165 | |
| 166 | </refentry> |
| 167 | |