2:37 p.m.
Author: elliss
Update of /cvs/docs/yum-software-management/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv22636/en_US
Modified Files:
yum-software-management.xml
Log Message:
- Removed "Maintaining Yum" section, and migrated content to other sections.
- Minor polishing.
Index: yum-software-management.xml
===================================================================
RCS file: /cvs/docs/yum-software-management/en_US/yum-software-management.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- yum-software-management.xml 19 Mar 2006 22:01:30 -0000 1.4
+++ yum-software-management.xml 24 Mar 2006 20:37:28 -0000 1.5
@@ -92,6 +92,32 @@
<option>-c</option></command> to provide this facility.
</para>
</important>
+
+ <para>
+ &FC; includes a <command>yum</command> configuration that is
+ suitable for independent systems with Internet access. You may
+ use <command>yum</command> and related software on such systems
+ without any additional configuration.
+ </para>
+
+ <para>
+ If your system is part of a managed network, consult your
+ network administrators for advice. You may need to configure
+ <command>yum</command> to use a network proxy server.
+ <xref linkend="sn-yum-proxy-server"/> explains how to configure
+ <command>yum</command> to use a proxy server. Administrators may
+ also suggest or require that <command>yum</command> clients use
+ specific package repositories. Refer to
+ <xref linkend="sn-using-repositories"/> for instructions on how
+ to configure access to repositories.
+ </para>
+
+ <para>
+ To improve performance and enable disconnected operations,
+ activate the <command>yum</command> caches on your system. Refer
+ to <xref linkend="sn-yum-caching"/> for more information on the
+ caching option.
+ </para>
</section>
<section id="sn-yum-additional-resources">
@@ -117,7 +143,7 @@
</screen>
<indexterm>
<primary>yum</primary>
- <secondary>web sites</secondary>
+ <secondary>Web sites</secondary>
</indexterm>
<indexterm>
<primary>yum</primary>
@@ -131,7 +157,7 @@
<variablelist>
<varlistentry>
<term>
- Project web site
+ Project Web site
</term>
<listitem>
<para>
@@ -1135,7 +1161,7 @@
</section>
<section id="sn-using-repositories">
- <title>Using Other Software Repositories</title>
+ <title>Configuring Access to Software Repositories</title>
<indexterm>
<primary>&FEX;</primary>
</indexterm>
@@ -1329,6 +1355,123 @@
</para>
</tip>
</section>
+
+ <section id="sn-removing-sources">
+ <title>Disabling or Removing Package Sources</title>
+ <indexterm>
+ <primary>repositories</primary>
+ <secondary>disabling in yum</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>repositories</primary>
+ <secondary>removing from yum</secondary>
+ </indexterm>
+ <para>
+ Set <command>enable=0</command> in a definition file to prevent
+ <command>yum</command> from using that repository. The
+ <command>yum</command> utility ignores any definition file with
+ this setting.
+ </para>
+
+ <para>
+ To completely remove access to a repository:
+ </para>
+ <procedure>
+ <step>
+ <para>
+ Delete the relevant file from
+ <filename>/etc/yum.repos.d/</filename>.
+ </para>
+ </step>
+ <step>
+ <para>
+ Delete the cache directory from
+ <filename>/var/cache/yum/</filename>.
+ </para>
+ </step>
+ </procedure>
+<!-- What with the "web of trust," removing GPG keys is not really -->
+<!-- something we should encourage. Having an extra GPG key in the RPM -->
+<!-- database is not a vulnerability, nor does it hamper the system in -->
+<!-- any way. These are probably a couple of reasons Seth didn't build -->
+<!-- this function into yum as part of "clean all," for example. Since
-->
+<!-- we just had several admonitions against people running the rpm -->
+<!-- command on its own anyway, I would just omit this part -->
+<!-- completely. [PWF] -->
+<!--
+
+ <important>
+ <title>Remove Unneeded Public Keys</title>
+
+ <para>
+ If you will not be using any further packages from a provider,
+ remove their public key from the <command>rpm</command>
+ keyring using the procedure described in
+ <xref linkend="sn-removing-publickeys" />.
+ </para>
+ </important>
+ </section>
+
+ <section id="sn-removing-publickeys">
+ <title>Removing Public Keys</title>
+ <indexterm>
+ <primary>public keys, removing</primary>
+ </indexterm>
+ <para>
+ To remove a public key from the keyring you first must determine
+ the full name of the key, as it registered in
+ <command>rpm</command>. Run this command to view the details of
+ the public keys on the <command>rpm</command> keyring:
+ </para>
+<screen>
+<userinput>rpm -qi gpg-pubkey-*</userinput>
+</screen>
+ <para>
+ Locate the heading for the relevant public key. The public key
+ headings follow this format:
+ </para>
+
+ <example id="publickey-header-format">
+ <title>Format of <command>rpm</command> Public Key
Headers</title>
+<screen>
+<computeroutput>Name : gpg-pubkey Relocations: (not
relocatable)
+Version : 4f2a6fd2 Vendor: (none)
+Release : 3f9d9d3b Build Date: Wed 15 Jun 2005 09:55:33 PM BST
+Install Date: Wed 15 Jun 2005 09:55:33 PM BST Build Host: localhost
+Group : Public Keys Source RPM: (none)
+Size : 0 License: pubkey
+Signature : (none)
+Summary : gpg(Fedora Project &lt;fedora(a)redhat.com&gt;)
+Description :</computeroutput>
+</screen>
+ </example>
+
+ <para>
+ Add the <option>Version</option> and
<option>Release</option>
+ attributes to <option>gpg-pubkey-</option> to make the complete
+ name of the key, in the form
+ <option>gpg-pubkey-Version_number-Release_number</option>. The
+ <command>rpm</command> identification for the &FP; public key
+ shown above is: <option>gpg-pubkey-4f2a6fd2-3f9d9d3b</option>.
+ </para>
+
+ <para>
+ Once you know the identification name of the key, use the
+ command <command>rpm <option>-e</option></command> to
remove it.
+ To remove the &FP; public key shown above the exact command
+ would be:
+ </para>
+<screen>
+<userinput>su -c 'rpm -e
<replaceable>gpg-pubkey-4f2a6fd2-3f9d9d3b</replaceable>'</userinput>
+</screen>
+ <para>
+ Enter the password for the
+ <systemitem class="username">root</systemitem> account
when
+ prompted.
+ </para>
+
+-->
+ </section>
</section>
<section id="sn-yum-installing-frompackage">
@@ -1414,7 +1557,7 @@
new features to <command>yum</command>.
</para>
- <section id="sn-yum-configfile">
+ <section id="sn-yum-configfiles">
<title>Editing the <command>yum</command>
Configuration</title>
<indexterm>
<primary>configuration files</primary>
@@ -1508,9 +1651,9 @@
<tip>
<title>Plugin File Extension</title>
<para>
- The names of <command>yum</command> plugins end with
- <filename>.py</filename>, the standard extension for
- Python files.
+ The names of <command>yum</command> plugin files end with
+ <filename>.py</filename>, the standard extension for Python
+ scripts.
</para>
</tip>
<para>
@@ -1612,7 +1755,7 @@
<filename>exampleplugin</filename>:
</para>
<screen>
-<userinput>su -c 'rm -f /etc/yum/pluginconf.d/exampleplugin.conf; rm -f
/usr/lib/yum-plugins/exampleplugin.p*'</userinput>
+<userinput>su -c 'rm -f /etc/yum/pluginconf.d/exampleplugin.conf; rm -f
/usr/lib/yum-plugins/exampleplugin.py*'</userinput>
</screen>
<para>
Enter the password for the
@@ -1622,8 +1765,8 @@
</section>
</section>
- <section id="sn-yum-enabling-caching">
- <title>Enabling the Caches</title>
+ <section id="sn-yum-caching">
+ <title>Working with <command>yum</command> Caching</title>
<indexterm>
<primary>caching</primary>
</indexterm>
@@ -1635,26 +1778,20 @@
By default, current versions of <command>yum</command> delete the
data files and packages that they download, after these have been
successfully used for an operation. This minimizes the amount of
- storage space that <command>yum</command> uses. To configure
- <command>yum</command> to retain downloaded files rather than
- discarding them, set the <command>keepcache</command> option in
- <filename>/etc/yum.conf</filename> to
<userinput>1</userinput>:
+ storage space that <command>yum</command> uses. You may enable
+ caching, so that <command>yum</command> retains the files that it
+ downloads in cache directories.
</para>
-<screen>
-<computeroutput>
-keepcache=1
-</computeroutput>
-</screen>
+
<para>
- Enabling this option provides three advantages:
+ Caches provide three advantages:
</para>
<para>
<itemizedlist>
<listitem>
<para>
- Performance increases, as cached files may be reused, rather
- than being downloaded for each operation that requires them
+ The performance of <command>yum</command> increases
</para>
</listitem>
<listitem>
@@ -1673,28 +1810,6 @@
</para>
<para>
- To carry out a <command>yum</command> command without a network
- connection, add the <option>-C</option> option. This causes
- <command>yum</command> to proceed without checking any network
- repositories, and use only cached files. In this mode,
- <command>yum</command> may only install packages that have been
- downloaded and cached by a previous operation.
- </para>
-
- <para>
- To search for the package <filename>tsclient</filename> without
- using a network connection, enter the command:
- </para>
-<screen>
-<userinput>su -c 'yum -C list
<replaceable>tsclient</replaceable>'</userinput>
-</screen>
- <para>
- Enter the password for the
- <systemitem class="username">root</systemitem> account when
- prompted.
- </para>
-
- <para>
By default, <command>yum</command> stores temporary files under
the directory <filename>/var/cache/yum/</filename>, with one
subdirectory for each configured repository. The
@@ -1717,6 +1832,117 @@
If you remove a package from the cache, you do not affect the copy
of the software installed on your system.
</para>
+
+ <section id="sn-yum-enabling-caching">
+ <title>Enabling the Caches</title>
+ <indexterm>
+ <primary>caching</primary>
+ <secondary>enabling</secondary>
+ </indexterm>
+ <para>
+ To configure <command>yum</command> to retain downloaded files
+ rather than discarding them, set the
+ <command>keepcache</command> option in
+ <filename>/etc/yum.conf</filename> to
<userinput>1</userinput>:
+ </para>
+<screen>
+<computeroutput>
+keepcache=1
+</computeroutput>
+</screen>
+ <para>
+ Refer to <xref linkend="sn-yum-configfiles"/> for more
+ information on editing the <command>yum</command> configuration
+ file.
+ </para>
+
+ <para>
+ Once you enable caching, every <command>yum</command> operation
+ may download package data from the configured repositories. To
+ ensure that the caches have a set of package data, carry out an
+ operation after you enable caching. Use a <option>list</option>
+ or <option>search</option> query to download package data
+ without modifying your system.
+ </para>
+ </section>
+
+ <section id="sn-yum-using-cacheonly">
+ <title>Using <command>yum</command> in Cache-only
Mode</title>
+ <indexterm>
+ <primary>yum</primary>
+ <secondary>cache-only mode</secondary>
+ </indexterm>
+ <para>
+ To carry out a <command>yum</command> command without a network
+ connection, add the <option>-C</option> option. This causes
+ <command>yum</command> to proceed without checking any network
+ repositories, and use only cached files. In this mode,
+ <command>yum</command> may only install packages that have been
+ downloaded and cached by a previous operation.
+ </para>
+
+ <para>
+ To search for the package <filename>tsclient</filename> without
+ using a network connection, enter the command:
+ </para>
+<screen>
+<userinput>su -c 'yum -C list
<replaceable>tsclient</replaceable>'</userinput>
+</screen>
+ <para>
+ Enter the password for the
+ <systemitem class="username">root</systemitem> account
when
+ prompted.
+ </para>
+
+ <note>
+ <title>Cache-only Mode Requires Cached Data</title>
+
+ <para>
+ Cache-only mode requires package data to exist in the caches.
+ If you enable caching, every <command>yum</command> operation
+ may update the data files, unless cache-only mode is specified
+ for the operation.
+ </para>
+ </note>
+ </section>
+
+ <section id="sn-yum-clearance">
+ <title>Clearing the <command>yum</command> Caches</title>
+ <indexterm>
+ <primary>caching</primary>
+ <secondary>cleaning caches</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>yum</primary>
+ <secondary>cleaning caches</secondary>
+ </indexterm>
+ <para>
+ If you configure it to do so, <command>yum</command> retains the
+ packages and package data files that it downloads, so that they
+ may be reused in future operations without being downloaded
+ again. To purge the package data files, use this command:
+ </para>
+<screen>
+<userinput>su -c 'yum clean headers'</userinput>
+</screen>
+ <para>
+ Run this command to remove all of the packages held in the
+ caches:
+ </para>
+<screen>
+<userinput>su -c 'yum clean packages'</userinput>
+</screen>
+ <para>
+ When using these commands, at the prompt, enter the password for
+ the <systemitem class="username">root</systemitem>
account.
+ </para>
+
+ <para>
+ Purging cached files causes those files to downloaded again the
+ next time that they are required. This increases the amount of
+ time required to complete the operation.
+ </para>
+ </section>
</section>
<section id="sn-yum-proxy-server">
@@ -1850,170 +2076,6 @@
</section>
</section>
- <section id="sn-yum-maintenance">
- <title>Maintaining <command>yum</command></title>
-
- <para>
- The <command>yum</command> system does not require any routine
- maintenance. To ensure that <command>yum</command> operations are
- carried out at optimal speed, disable or remove repository
- definitions which you no longer require. You may also clear the
- files from the <command>yum</command> caches in order to recover
- disk space.
- </para>
-
- <section id="sn-removing-sources">
- <title>Disabling or Removing Package Sources</title>
- <indexterm>
- <primary>repositories</primary>
- <secondary>disabling in yum</secondary>
- </indexterm>
- <indexterm>
- <primary>repositories</primary>
- <secondary>removing from yum</secondary>
- </indexterm>
- <para>
- Set <command>enable=0</command> in a definition file to prevent
- <command>yum</command> from using that repository. The
- <command>yum</command> utility ignores any definition file with
- this setting.
- </para>
-
- <para>
- To completely remove access to a repository:
- </para>
- <procedure>
- <step>
- <para>
- Delete the relevant file from
- <filename>/etc/yum.repos.d/</filename>.
- </para>
- </step>
- <step>
- <para>
- Delete the cache directory from
- <filename>/var/cache/yum/</filename>.
- </para>
- </step>
- </procedure>
-<!-- What with the "web of trust," removing GPG keys is not really -->
-<!-- something we should encourage. Having an extra GPG key in the RPM -->
-<!-- database is not a vulnerability, nor does it hamper the system in -->
-<!-- any way. These are probably a couple of reasons Seth didn't build -->
-<!-- this function into yum as part of "clean all," for example. Since
-->
-<!-- we just had several admonitions against people running the rpm -->
-<!-- command on its own anyway, I would just omit this part -->
-<!-- completely. [PWF] -->
-<!--
-
- <important>
- <title>Remove Unneeded Public Keys</title>
-
- <para>
- If you will not be using any further packages from a provider,
- remove their public key from the <command>rpm</command>
- keyring using the procedure described in
- <xref linkend="sn-removing-publickeys" />.
- </para>
- </important>
- </section>
-
- <section id="sn-removing-publickeys">
- <title>Removing Public Keys</title>
- <indexterm>
- <primary>public keys, removing</primary>
- </indexterm>
- <para>
- To remove a public key from the keyring you first must determine
- the full name of the key, as it registered in
- <command>rpm</command>. Run this command to view the details of
- the public keys on the <command>rpm</command> keyring:
- </para>
-<screen>
-<userinput>rpm -qi gpg-pubkey-*</userinput>
-</screen>
- <para>
- Locate the heading for the relevant public key. The public key
- headings follow this format:
- </para>
-
- <example id="publickey-header-format">
- <title>Format of <command>rpm</command> Public Key
Headers</title>
-<screen>
-<computeroutput>Name : gpg-pubkey Relocations: (not
relocatable)
-Version : 4f2a6fd2 Vendor: (none)
-Release : 3f9d9d3b Build Date: Wed 15 Jun 2005 09:55:33 PM BST
-Install Date: Wed 15 Jun 2005 09:55:33 PM BST Build Host: localhost
-Group : Public Keys Source RPM: (none)
-Size : 0 License: pubkey
-Signature : (none)
-Summary : gpg(Fedora Project &lt;fedora(a)redhat.com&gt;)
-Description :</computeroutput>
-</screen>
- </example>
-
- <para>
- Add the <option>Version</option> and
<option>Release</option>
- attributes to <option>gpg-pubkey-</option> to make the complete
- name of the key, in the form
- <option>gpg-pubkey-Version_number-Release_number</option>. The
- <command>rpm</command> identification for the &FP; public key
- shown above is: <option>gpg-pubkey-4f2a6fd2-3f9d9d3b</option>.
- </para>
-
- <para>
- Once you know the identification name of the key, use the
- command <command>rpm <option>-e</option></command> to
remove it.
- To remove the &FP; public key shown above the exact command
- would be:
- </para>
-<screen>
-<userinput>su -c 'rpm -e
<replaceable>gpg-pubkey-4f2a6fd2-3f9d9d3b</replaceable>'</userinput>
-</screen>
- <para>
- Enter the password for the
- <systemitem class="username">root</systemitem> account
when
- prompted.
- </para>
-
--->
- </section>
-
- <section id="sn-yum-clearance">
- <title>Clearing the <command>yum</command> Caches</title>
- <indexterm>
- <primary>yum</primary>
- <secondary>cleaning caches</secondary>
- </indexterm>
- <para>
- If you configure it to do so, <command>yum</command> retains the
- packages and package data files that it downloads, so that they
- may be reused in future operations without being downloaded
- again. To purge the package data files, use this command:
- </para>
-<screen>
-<userinput>su -c 'yum clean headers'</userinput>
-</screen>
- <para>
- Run this command to remove all of the packages held in the
- caches:
- </para>
-<screen>
-<userinput>su -c 'yum clean packages'</userinput>
-</screen>
- <para>
- When using these commands, at the prompt, enter the password for
- the <systemitem class="username">root</systemitem>
account.
- </para>
-
- <para>
- Purging cached files causes those files to downloaded again the
- next time that they are required. This increases the amount of
- time required to complete the operation.
- </para>
- </section>
- </section>
-
<!-- SE: This is at the end of the document, since it looks out of place in section 1
-->
<section id="sn-acknowledgments">