[deployment-guide/comm-rel: 60/727] Yum: fix QA BZ#561603; alphabetize Yum.conf opts; add more
Jaromir Hradilek
jhradile at fedoraproject.org
Tue Oct 19 12:29:09 UTC 2010
commit dd2e992b1b4142e813796993b54f2a6a68b98ccb
Author: Douglas Silas <dhensley at redhat.com>
Date: Mon Jul 19 13:09:30 2010 +0200
Yum: fix QA BZ#561603; alphabetize Yum.conf opts; add more
en-US/Yum.xml | 162 ++++++++++++++++++++++++++++++++++++++++++---------------
1 files changed, 119 insertions(+), 43 deletions(-)
---
diff --git a/en-US/Yum.xml b/en-US/Yum.xml
index 685c2b0..1f27450 100644
--- a/en-US/Yum.xml
+++ b/en-US/Yum.xml
@@ -513,7 +513,7 @@ Filename : /usr/sbin/named
<primary>Yum</primary>
<secondary>installing a package group with Yum</secondary>
</indexterm>
- <para>A package group is similar to a package: it is not useful by itsself, but installing one pulls a group of dependent packages that serve a common purpose. A package group has a name and a groupid. The <command>yum grouplist -v</command> command lists the names of all package groups, and, next to each of them, their <firstterm>groupid</firstterm> in parentheses. The groupid is always the term in the last pair of parentheses, such as <literal>kde-desktop</literal> and <literal>kde-software-development</literal> in this example:</para>
+ <para>A package group is similar to a package: it is not useful by itself, but installing one pulls a group of dependent packages that serve a common purpose. A package group has a name and a groupid. The <command>yum grouplist -v</command> command lists the names of all package groups, and, next to each of them, their <firstterm>groupid</firstterm> in parentheses. The groupid is always the term in the last pair of parentheses, such as <literal>kde-desktop</literal> and <literal>kde-software-development</literal> in this example:</para>
<important>
<title>Not all packages used in examples may be available on RHN</title>
<para>Some of the software packages—or package groups—queried for and installed with <application>Yum</application> in this chapter may not be available from Red Hat Network. Their use in examples is purely to demonstrate <application>Yum</application>'s command usage.</para>
@@ -667,72 +667,147 @@ installonly_limit=3
<para>Here is a list of the most commonly-used options in the <literal>[main]</literal> section, and descriptions for each:</para>
<variablelist>
<varlistentry>
- <term>
- cachedir=<filename>cachedir=/var/cache/yum/<envar>$basearch</envar>/<envar>$releasever</envar>
- </filename>
+ <term>assumeyes=<replaceable><value></replaceable>
</term>
<listitem>
- <para>This option specifies the directory where <application>Yum</application> should store its cache and database files. By default, <application>Yum</application>'s cache directory is cachedir=<filename>cachedir=/var/cache/yum/<envar>$basearch</envar>/<envar>$releasever</envar>
- </filename>. See <xref
+ <para>...where <replaceable><value></replaceable> is one of:</para>
+ <para>
+ <constant>0</constant> — <command>yum</command> should prompt for confirmation of critical actions it performs. This is the default.</para>
+ <para>
+ <constant>1</constant> — Do not prompt for confirmation of critical <command>yum</command> actions. If <literal>assumeyes=1</literal> is set, <command>yum</command> behaves in the same way that the command line option <option>-y</option> does.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>cachedir=<filename>/var/cache/yum/$basearch/$releasever</filename>
+ </term>
+ <listitem>
+ <para>This option specifies the directory where <application>Yum</application> should store its cache and database files. By default, <application>Yum</application>'s cache directory is <filename>/var/cache/yum/$basearch/$releasever</filename>. See <xref
linkend="sec-Using_Yum_Variables"/> for descriptions of the <envar>$basearch</envar> and <envar>$releasever</envar>
<application>Yum</application> variables.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>
- keepcache=<1 or 0>
+ <term>debuglevel=<replaceable>value</replaceable>
</term>
<listitem>
- <para>Setting <literal>keepcache=1</literal> instructs <command>yum</command> to keep the cache of headers and packages after a successful installation. <literal>keepcache=1</literal> is the default.</para>
+ <para>...where <replaceable><value></replaceable> is an integer between <constant>1</constant> and <constant>10</constant>. Setting a higher <literal>debuglevel</literal> value causes <command>yum</command> to display more detailed debugging output. <literal>debuglevel=0</literal> disables debugging output, while <literal>debuglevel=2</literal> is the default.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>
- reposdir=<absolute path to directory of .repo files>
+ <term>exactarch=<replaceable><value></replaceable>
</term>
<listitem>
- <para>This option allows you to specify a directory where <filename>.repo</filename> files are located. <filename>.repo</filename> files contain repository information (similar to the [<replaceable>repository</replaceable>] section(s) of <filename>/etc/yum.conf</filename>). <command>yum</command> collects all repository information from <filename>.repo</filename> files and the [<replaceable>repository</replaceable>] section of the <filename>/etc/yum.conf</filename> file to create a master list of repositories to use for transactions. Refer to <xref
- linkend="sec-Setting_repository_Options"/> for more information about options you can use for both the [<replaceable>repository</replaceable>] section and <filename>.repo</filename> files. If <literal>reposdir</literal> is not set, <command>yum</command> uses the default directory <filename>/etc/yum.repos.d/</filename>.</para>
+ <para>...where <replaceable><value></replaceable> is one of:</para>
+ <para>
+ <constant>0</constant> — Do not take into account the exact architecture when updating packages.</para>
+ <para>
+ <constant>1</constant> — Consider the exact architecture when updating packages. With this setting, <command>yum</command> will not install an i686 package to update an i386 package already installed on the system. This is the default.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>
- gpgcheck=<1 or 0>
+ <term>exclude=<replaceable><package_name></replaceable> <optional><replaceable>more_package_names</replaceable>
+ </optional>
+ </term>
+ <listitem>
+ <para>This option allows you to exclude packages by keyword during installation/updates. Listing multiple packages for exclusion can be accomplished by quoting a space-delimited list of packages. Shell globs using wildcards (for example, <literal>*</literal> and <literal>?</literal>) are allowed.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>gpgcheck=<replaceable><value></replaceable>
</term>
<listitem>
- <para>This enables or disables GPG signature checking on packages in all repositories, including local package installation. The default is <literal>gpgcheck=0</literal>, which disables GPG-checking. If this option is set in the <literal>[main]</literal> section of the <filename>/etc/yum.conf</filename> file, it sets the GPG-checking rule for all repositories. However, you can also set this on individual repositories instead; i.e., you can enable GPG-checking on one repository while disabling it on another. Setting <literal>gpgcheck=</literal> for individual repositories overrides the default if it is present in <filename>/etc/yum.conf</filename>. Refer to <xref
+ <para>...where <replaceable><value></replaceable> is one of:</para>
+ <para>
+ <constant>0</constant> — Disable GPG signature-checking on packages in all repositories, including local package installation.</para>
+ <para>
+ <constant>1</constant> — Enable GPG signature-checking on all packages in all repositories, including local package installation. <literal>gpgcheck=1</literal> is the default, and thus all packages' signatures are checked.</para>
+ <para>If this option is set in the <literal>[main]</literal> section of the <filename>/etc/yum.conf</filename> file, it sets the GPG-checking rule for all repositories. However, you can also set <literal>gpgcheck=</literal>
+ <replaceable><value></replaceable> for individual repositories instead; i.e., you can enable GPG-checking on one repository while disabling it on another. Setting <literal>gpgcheck=<replaceable><value></replaceable>
+ </literal> for an individual repository in its correpsonding <filename>.repo</filename> file overrides the default if it is present in <filename>/etc/yum.conf</filename>. Refer to <xref
linkend="s1-check-rpm-sig"/> for further information on GPG signature-checking.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>
- assumeyes=<1 or 0>
+ <term>groupremove_leaf_only=<replaceable><value></replaceable>
</term>
<listitem>
- <para>This determines whether or not <command>yum</command> should prompt for confirmation of critical actions. The default is <literal>assumeyes=0</literal>, which means <command>yum</command> will prompt you for confirmation. If <literal>assumeyes=1</literal> is set, <command>yum</command> behaves in the same way that the command line option <option>-y</option> does.</para>
+ <para>...where <replaceable><value></replaceable> is one of:</para>
+ <para>
+ <constant>0</constant> — <command>yum</command> should <emphasis>not</emphasis> check the dependencies of each package when removing a package group. With this setting, <command>yum</command> removes all packages in a package group, regardless of whether those packages are required by other packages or groups. <literal>groupremove_leaf_only=0</literal> is the default.</para>
+ <para>
+ <constant>1</constant> — <command>yum</command> should check the dependencies of each package when removing a package group, and remove only those packages which are not not required by any other package or group.</para>
+ <para>For more information on removing packages, refer to <xref
+ linkend="important-Smart_package_group_removal"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>
- exclude="<package_name> [<replaceable>more_names</replaceable>]"
+ <term>installonlypkgs=<replaceable><space></replaceable> <replaceable><separated></replaceable> <replaceable><list></replaceable> <replaceable><of></replaceable> <replaceable><packages></replaceable>
</term>
<listitem>
- <para>This option allows you to exclude packages by keyword during installation/updates. Listing multiple packages for exclusion can be accomplished by quoting a space-delimited list of packages. Shell globs using wildcards (for example, <literal>*</literal> and <literal>?</literal>) are allowed.</para>
+ <para>Here you can provide a space-separated list of packages which <command>yum</command> can <emphasis>install</emphasis>, but will never <emphasis>update</emphasis>. <remark>I think we should say "refer to man.conf for the list of default installonlypkgs. Also, I assume that putting this directive in /etc/yum.conf and setting it to anything—even listing nothing—overrides the default. So we should put a warning here that users should list the defaults in man yum.conf unless they are really sure they want to disable them.</remark></para>
</listitem>
</varlistentry>
<varlistentry>
- <term>
- retries=<number_of_retries>
+ <term>installonly_limit=<replaceable><value></replaceable></term>
+ <listitem>
+ <para>...where <replaceable><value></replaceable> is an integer representing the maximum number of versions that can be installed simultaneously for any single package listed in the <literal>installonlypkgs</literal> directive. The defaults for the <literal>installonlypkgs</literal> directive include several different kernel packages, so be aware that changing the value of <literal>installonly_limit</literal> will also affect the maximum number of installed versions of any single kernel package. The default is therefore <literal>installonly_limit=3</literal>, and it is not recommended to decrease this value, particularly below <constant>2</constant>.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>keepcache=<replaceable><value></replaceable>
+ </term>
+ <listitem>
+ <para>...where value is one of:</para>
+ <para>
+ <constant>0</constant> — Do not retain the cache of headers and packages after a successful installation. This is the default.</para>
+ <para>
+ <constant>1</constant> — Retain the cache after a successful installation.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>logfile=<filename>/var/log/yum.log</filename>
</term>
<listitem>
- <para>This sets the number of times <command>yum</command> should attempt to retrieve a file before returning an error. Setting this to <constant>0</constant> makes <command>yum</command> retry forever. The default value is <constant>6</constant>.</para>
+ <para>This option specifies where <command>yum</command> should send its logging output. By default, <command>yum</command> logs to <filename>/var/log/yum.log</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>groupremove_leaf_only=<1 or 0></term>
+ <term>obsoletes=<replaceable><value></replaceable>
+ </term>
<listitem>
- <para>Setting this option to <constant>1</constant> causes <command>yum</command> to check the dependencies of each package when removing a package group, and to remove only those packages which are not not required by any other package or group. The default value for this directive is <constant>0</constant>, which means that removing a package group will remove all packages in that group regardless of whether they are required by other packages or groups. For more information on removing packages, refer to <xref
- linkend="important-Smart_package_group_removal"/>.</para>
+ <para>...where <replaceable><value></replaceable> is one of:</para>
+ <para>
+ <constant>0</constant> — Disable <command>yum</command>'s obsoletes processing logic when performing updates.</para>
+ <para>
+ <constant>1</constant> — Enable <command>yum</command>'s obsoletes processing logic when performing updates. When one package declares in its spec file that it <firstterm>obsoletes</firstterm> another package, the latter package will be replaced by the former package when the former package is installed. Obsoletes are declared, for example, when a package is renamed. <literal>obsoletes=1</literal> the default.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>plugins=<replaceable><value></replaceable>
+ </term>
+ <listitem>
+ <para>...where <replaceable><value></replaceable> is one of:</para>
+ <para>
+ <constant>0</constant> — Disable all <application>Yum</application> plugins globally.</para>
+ <para>
+ <constant>1</constant> — Enable all <application>Yum</application> plugins globally. With <literal>plugins=1</literal>, you can still disable a specific <application>Yum</application> plugin by setting <literal>enabled=0</literal> in that plugin's configuration file. Refer to <xref
+ linkend="sec-Yum_Plugins"/> for more information about various <application>Yum</application> plugins, or to <xref
+ linkend="sec-Enabling_Configuring_and_Disabling_Yum_Plugins"/> for further information on controlling plugins.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>reposdir=<replaceable></absolute/path/to/directory/containing/repo/files></replaceable>
+ </term>
+ <listitem>
+ <para>This option allows you to specify a directory where <filename>.repo</filename> files are located. All <filename>.repo</filename> files contain repository information (similar to the [<replaceable>repository</replaceable>] section(s) of <filename>/etc/yum.conf</filename>). <command>yum</command> collects all repository information from <filename>.repo</filename> files and the [<replaceable>repository</replaceable>] section of the <filename>/etc/yum.conf</filename> file to create a master list of repositories to use for transactions. Refer to <xref
+ linkend="sec-Setting_repository_Options"/> for more information about options you can use for both the [<replaceable>repository</replaceable>] section and <filename>.repo</filename> files. If <literal>reposdir</literal> is not set, <command>yum</command> uses the default directory <filename>/etc/yum.repos.d/</filename>.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>retries=<replaceable><value></replaceable>
+ </term>
+ <listitem>
+ <para>...where <replaceable><value></replaceable> is an integer <constant>0</constant> or greater. This value sets the number of times <command>yum</command> should attempt to retrieve a file before returning an error. Setting this to <constant>0</constant> makes <command>yum</command> retry forever. The default value is <constant>10</constant>.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -755,29 +830,26 @@ baseurl=http://path/to/repo or ftp://path/to/repo or file://path/to/local/repo
<variablelist>
<varlistentry>
<term>
- [repository_ID]
+ [<replaceable>repository_ID</replaceable>]
</term>
<listitem>
<para>The repository ID is a unique, one-word (no spaces; underscores are allowed) string of characters (enclosed by brackets) that serves as a repository identifier.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>
- name=<My Repository Name>
+ <term>name=<replaceable><My Repository Name></replaceable>
</term>
<listitem>
<para>This is a human-readable string describing the repository.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>
- baseurl=http://path/to/repo, ftp://path/to/repo, file://path/to/local/repo
- </term>
+ <term>baseurl=http://path/to/repo, ftp://path/to/repo, file://path/to/local/repo</term>
<listitem>
<para>This is a URL to the directory where the repodata directory of a repository is located. Usually this URL is an HTTP link, such as:</para>
<screen>baseurl=http://path/to/repo/releases/$releasever/server/$basearch/os/</screen>
<para>
- <application>Yum</application> always expands the $releasever, $arch and $basearch variables in URLs. See the following section for explanations of all <application>Yum</application> variables: <xref
+ <application>Yum</application> always expands the <envar>$releasever</envar>, <envar>$arch</envar> and <envar>$basearch</envar> variables in URLs. See the following section for explanations of all <application>Yum</application> variables: <xref
linkend="sec-Using_Yum_Variables"/>.</para>
<itemizedlist>
<listitem>
@@ -787,25 +859,29 @@ baseurl=http://path/to/repo or ftp://path/to/repo or file://path/to/local/repo
<para>If the repository is local to the machine, use file://path/to/local/repo</para>
</listitem>
<listitem>
- <para>If a specific online repository requires basic HTTP authentication, you can specify your username and password in the <command>baseurl= line</command> by prepending it as <command>username:password at link</command>. For example, if a repository on http://www.example.com/repo/ requires a username of "user" and a password of "password", then the baseurl link can be specified as <command>baseurl=http://user:password@www.example.com/repo/</command>
- </para>
+ <para>If a specific online repository requires basic HTTP authentication, you can specify your username and password in the <literal>http://path/to/repo</literal> by prepending it as <command>username:password at link</command>. For example, if a repository on http://www.example.com/repo/ requires a username of "user" and a password of "password", then the <literal>baseurl</literal> link could be specified as:</para>
+ <screen>baseurl=http://<userinput>user</userinput>:<userinput>password</userinput>@www.example.com/repo/</screen>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
- <para>Here are some other useful-but-optional [<replaceable>repository</replaceable>] options:</para>
+ <para>Here is another useful-but-optional [<replaceable>repository</replaceable>] options:</para>
<variablelist>
<varlistentry>
- <term>
- enabled=<1 or 0>
+ <term>enabled=<replaceable><value></replaceable>
</term>
<listitem>
- <para>Setting <literal>enabled=0</literal> instructs <command>yum</command> not to include that repository as a package source when performing updates and installs. This is an easy way of quickly turning repositories on and off, which is useful when you desire a single package from a repository that you do not want to enable for updates, etc. Turning repositories on and off can also be performed quickly by passing either the <option>--enablerepo=<<replaceable>repo_name</replaceable>></option> or <option>--disablerepo=<<replaceable>repo_name</replaceable>></option> option to <command>yum</command>, or easily through <application>PackageKit</application>'s <guilabel>Add/Remove Software</guilabel> window.</para>
+ <para>...where <replaceable><value></replaceable> is one of:</para>
+ <para>
+ <constant>0</constant> — do not include this repository as a package source when performing updates and installs. This is an easy way of quickly turning repositories on and off, which is useful when you desire a single package from a repository that you do not want to enable for updates or installs.</para>
+ <para>
+ <constant>1</constant> — include this repository as a package source.</para>
+ <para>Turning repositories on and off can also be performed quickly by passing either the <option>--enablerepo=<<replaceable>repo_name</replaceable>></option> or <option>--disablerepo=<<replaceable>repo_name</replaceable>></option> option to <command>yum</command>, or easily through <application>PackageKit</application>'s <guilabel>Add/Remove Software</guilabel> window.</para>
</listitem>
</varlistentry>
</variablelist>
- <para>Many more [<replaceable>repository</replaceable>] options exist. Refer to the <literal>[repository] OPTIONS</literal> section of <command>man yum.conf</command> for the exhaustive list.</para>
+ <para>Many more [<replaceable>repository</replaceable>] options exist. Refer to the <literal>[repository] OPTIONS</literal> section of <command>man yum.conf</command> for the exhaustive list and descriptions for each.</para>
</section>
<section
id="sec-Using_Yum_Variables">
@@ -979,7 +1055,7 @@ enabled=1
<secondary>plugins</secondary>
<tertiary>PackageKit-yum-plugin</tertiary>
</indexterm>
- <para>This plugin updates metadata for <application>PackageKit</application> whenever <application>yum</application> is run. The <application>refresh-packagkit</application> plugin is installed by default.</para>
+ <para>This plugin updates metadata for <application>PackageKit</application> whenever <application>yum</application> is run. The <application>refresh-packagekit</application> plugin is installed by default.</para>
<bridgehead
id="bh-security_yum-plugin-security">security (yum-plugin-security)</bridgehead>
<indexterm>
More information about the docs-commits
mailing list