yum-software-management yum-software-management-en.xml,1.6,1.7
Paul W. Frields (pfrields)
fedora-docs-commits at redhat.com
Sun Jul 17 17:28:56 UTC 2005
Author: pfrields
Update of /cvs/docs/yum-software-management
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv13921
Modified Files:
yum-software-management-en.xml
Log Message:
Began editing process; kicking back for more authorial attention
Index: yum-software-management-en.xml
===================================================================
RCS file: /cvs/docs/yum-software-management/yum-software-management-en.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- yum-software-management-en.xml 9 Jul 2005 15:06:36 -0000 1.6
+++ yum-software-management-en.xml 17 Jul 2005 17:28:53 -0000 1.7
@@ -46,55 +46,57 @@
<section id="sn-introduction">
<title>Introduction</title>
&DRAFTNOTICE;
+ <section id="sn-purpose">
+ <title>Purpose</title>
+
+ <para>
+ This tutorial presents basic concepts of software management on
+ &FED; systems. It outlines the major functions of
+ <command>yum</command>, the recommended software management tool
+ for &FED;.
+ </para>
+ </section>
+
<section id="sn-software-management-audience">
<title>Audience</title>
<para>
- The <command>yum</command> utility is currently the recommended
- method for managing software on &FED; systems. All &FED; users
- responsible for maintaining their own systems will find
- <command>yum</command> an essential tool.
+ This tutorial is intended for &FED; users of all experience
+ levels.
</para>
+
</section>
<section id="sn-software-management-usingdoc">
<title>Using This Document</title>
<para>
- This document is a reference for using <command>yum</command>.
You may wish to read some or all of the sections, depending upon
- your needs and level of experience.
+ your needs and level of experience. If you are a new user, read
+ <xref linkend="sn-software-management-concepts"/> before using
+ <command>yum</command> for the first time. If you are an
+ experienced Linux user, start with <xref
+ linkend="sn-updating-your-system"/>.
</para>
<para>
- If you are a new user, read the
- <xref
- linkend="sn-software-management-concepts"/> before
- using <command>yum</command> for the first time.
- </para>
-
- <para>
- Experienced Linux users should start with
- <xref linkend="sn-updating-your-system"/>.
- </para>
-
- <para>
- Anyone with several &FED; systems on a network may benefit from
- setting up their own software repositories to manage the process
- of installation and updates. The details of maintaining your own
- repositories are explained in
- <xref linkend="sn-managing-repositories"/>.
+ If you have several &FED; systems on a network, you may benefit
+ from setting up your own software repositories to manage the
+ process of installation and updates. Refer to
+ <xref linkend="sn-managing-repositories"/> for details of
+ maintaining your own repositories.
</para>
<para>
Most of the examples in this document use the package
- <filename>tsclient</filename>, which is included with &FC; to
- provide an application for remote desktop access. If it is
- installed successfully you may start the application by choosing
- <menuchoice><guimenu>Applications</guimenu><guisubmenu>Internet</guisubmenu><guimenuitem>Terminal
- Server Client</guimenuitem></menuchoice>. To use the examples,
- substitute the name of the relevant package for
- <filename>tsclient</filename>.
+ <filename>tsclient</filename>, which is included with &FC;. The
+ <filename>tsclient</filename> package provides an application
+ for remote desktop access. If you install it successfully, you
+ may start the application by choosing
+ <menuchoice><guimenu>Applications</guimenu><guisubmenu>Internet</guisubmenu><guimenuitem>Terminal
+ Server Client</guimenuitem></menuchoice>. To use the
+ examples, substitute the name of the relevant package for
+ <filename>tsclient</filename>.
</para>
<important>
@@ -102,10 +104,10 @@
<para>
You do not need to log in with the root account in order to
- manage your &FC; system. All of the commands shown in this
- tutorial that require root access will prompt you for the root
- password. The example terminal commands use <command>su
- <option>-c</option></command> to provide this facility.
+ manage your &FC; system. Any commands in this tutorial which
+ require root access will prompt you for the root password. The
+ procedures use the command <command>su
+ <option>-c</option></command> to provide this facility.
</para>
</important>
</section>
@@ -113,45 +115,45 @@
<section id="sn-yum-additional-resources">
<title>Additional Resources</title>
<indexterm>
- <primary>yum, documentation</primary>
+ <primary>yum</primary>
+ <secondary>documentation</secondary>
</indexterm>
<indexterm>
- <primary>yum, man pages</primary>
+ <primary>yum</primary>
+ <secondary>man pages</secondary>
</indexterm>
<para>
The <command>yum</command> utility has features and options that
- are not discussed in this document. Read the
- <command>man</command> pages for <command>yum(8)</command> and
- <filename>yum.conf(5)</filename> to learn more.
- </para>
- <indexterm>
- <primary>yum, Websites</primary>
- </indexterm>
- <para>
- The official Website for <command>yum</command> is:
- </para>
-
- <para>
- <ulink url="http://linux.duke.edu/projects/yum/">http://linux.duke.edu/projects/yum/</ulink>
- </para>
- <indexterm>
- <primary>yum, mailing lists</primary>
- </indexterm>
- <para>
- The official mailing list for <command>yum</command> users is:
- </para>
-
- <para>
- <ulink url="https://lists.dulug.duke.edu/mailman/listinfo/yum">https://lists.dulug.duke.edu/mailman/listinfo/yum</ulink>
- </para>
-
- <para>
- The archive for the <command>yum</command> development mailing
- list is here:
- </para>
-
- <para>
- <ulink url="https://lists.dulug.duke.edu/pipermail/yum-devel/">https://lists.dulug.duke.edu/pipermail/yum-devel/</ulink>
+ are not discussed in this document. Read the
+ <command>man</command> pages for <command>yum(8)</command> and
+ <filename>yum.conf(5)</filename> to learn more, using the
+ following commands:
+ </para>
+
+ <screen>
+ <userinput>man yum man yum.conf</userinput>
+ </screen>
+
+ <remark role="fixme">If you want to use a para for the next bit,
+ use sentences and graft them together. Otherwise, you can use a
+ variablelist, or an itemizedlist. [PWF]</remark>
+
+ <indexterm>
+ <primary>yum</primary>
+ <secondary>home page</secondary>
+ </indexterm>
+ <para>
+ The official home page for <command>yum</command> on the World
+ Wide Web is <ulink url="http://linux.duke.edu/projects/yum/"/>.
+ <indexterm>
+ <primary>yum</primary>
+ <secondary>mailing lists</secondary>
+ </indexterm> The official mailing list for
+ <command>yum</command> users is at <ulink
+ url="https://lists.dulug.duke.edu/mailman/listinfo/yum/"/>.
+ The archive for the <command>yum</command> development mailing
+ list is at <ulink
+ url="https://lists.dulug.duke.edu/pipermail/yum-devel/"/>.
</para>
</section>
</section>
@@ -162,82 +164,88 @@
<section id="sn-about-packages">
<title>About Packages</title>
<indexterm>
- <primary>packages, defined</primary>
+ <primary>packages</primary>
+ <secondary>defined</secondary>
</indexterm>
<para>
- All of the software and documentation prepared for use with
- &FED; is supplied in the form of files called RPM
- <firstterm>packages</firstterm>. Each package is a compressed
- archive containing product information, program files, icons,
- documentation and management scripts. These files are used by
- management applications to safely locate, install, update and
- remove software. For example, the &FED; installation process
- uses the packages supplied with &FC; to build or upgrade a
- system to your requirements.
+ &FED; software and documentation is supplied in the form of RPM
+ <firstterm>packages</firstterm>. Each package is a compressed
+ archive which contains product information, program files,
+ icons, documentation and management scripts. Management
+ applications use these files to safely locate, install, update
+ and remove software. For example, the &FED; installation process
+ uses the packages supplied with &FC; to build or upgrade a
+ system to your requirements.
</para>
<para>
Packages also include a digital signature to prove their source.
- This digital signature is verified by software management
- utilities by using a GPG <firstterm>public key</firstterm>. Both
- the <command>yum</command> and <command>rpm</command> utilities
- share a common <firstterm>keyring</firstterm> that stores all of
- the public keys for the package sources approved by the system
- administrator.
+ Software management utilities verify this digital signature with
+ a GPG <firstterm>public key</firstterm>. The
+ <command>yum</command> and <command>rpm</command> utilities
+ share a common <firstterm>keyring</firstterm> which stores all
+ public keys for the package sources approved by the system
+ administrator.
</para>
</section>
<section id="sn-about-repositories">
<title>About Repositories</title>
<indexterm>
- <primary>repositories, defined</primary>
+ <primary>repositories</primary>
+ <secondary>defined</secondary>
</indexterm>
<para>
- Software management utilities like <command>yum</command>
- automatically locate and obtain the correct RPM packages for an
- application from <firstterm>repositories</firstterm>, which are
- prepared directories or Websites. This method frees you from
- having to manually find and install new applications or updates:
- you may use a single command to update all of the software that
- makes up your system, or to search for new software by
- specifying criteria. In each case the management utility
- connects to the repositories that it is configured to use, and
- checks the indexes that they provide to find the correct
- packages.
+ A <firstterm>repository</firstterm> is a directory which
+ contains prepared files which refer to software packages.
+ Software management utilities such as <command>yum</command>
+ automatically locate and obtain the correct RPM packages for an
+ application from these <firstterm>repositories</firstterm>. This
+ method frees you from having to manually find and install new
+ applications or updates. You may use a single command to update
+ all of your system's software, or search for new software by
+ specifying criteria. In each case, the management utility
+ connects to the configured repositories and checks files in each
+ one to find the correct packages.
</para>
<para>
- Using repositories also ensures also that you always receive the
- current version of the software. If several versions of the same
- package are available then your management utility automatically
- selects the latest version.
+ If you use repositories, you always receive the current version
+ of the software. If several versions of the same package are
+ available, your management utility automatically selects the
+ latest version.
</para>
<para>
- For these reasons you should only manually install software when
- you are confident that there is no repository that can currently
- provide it. If a piece of software on your system is not
- available from a repository then no update feature can
- automatically find or install newer versions, and you must keep
- that product updated yourself.
+ For these reasons, you should only manually install software
+ when you are confident that no repository can currently provide
+ it. If a piece of installed software is not available from a
+ repository, you cannot automatically find or install newer
+ versions. You must keep that product updated manually.
</para>
<para>
The package management utilities in &FC; are automatically
- configured to use the network of repository servers maintained
- by the &FP;. These repositories hold both the software included
- with &FC;, and a large selection of additional software, known
- as &FEX;. Third-party software developers also provide
- repositories for their &FED; compatible packages.
+ configured to use the network of repository servers maintained
+ by the &FP;. These repositories contain the software included
+ with &FC;, and a large selection of additional software known as
+ &FEX;. Third-party software developers also provide repositories
+ for their &FED; compatible packages.
</para>
+ <remark role="fixme">Use the terminology from the &FP; web site.
+ Personally, I have no quibble with "free" vs. "open source"
+ software, but rule #1 is to be consistent across the whole
+ project. Since the web site says "open source," let's use
+ that. [PWF]</remark>
+
<note>
- <title>All &FED; Packages are Free Software</title>
+ <title>Open Source Software</title>
<para>
- All of the software provided by the &FP; is Free Software, or
- Open Source, and can therefore be downloaded and installed
- from the network of &FED; repositories without restrictions.
+ All of the software provided by the &FP; is open source
+ software. For more information about open source software,
+ refer to <ulink url="http://www.opensource.org/"/>.
</para>
</note>
</section>
@@ -245,36 +253,40 @@
<section id="sn-about-dependencies">
<title>About Dependencies</title>
<indexterm>
- <primary>dependencies, defined</primary>
+ <primary>dependencies</primary>
+ <secondary>defined</secondary>
</indexterm>
<para>
You must consider package <firstterm>dependencies</firstterm>
- when manually installing software. To avoid conflicts and
- inconsistencies Linux distributions supply program library files
- as separate packages to the applications that use their
- functions. Many libraries and command-line utilities are used by
- multiple applications.
+ when manually installing software. For RPM software, a
+ dependency is a capability provided by one package on which
+ other packages rely. Some programs rely on external shared
+ <firstterm>libraries</firstterm> to run properly. If a library
+ is provided by an external package, that package may be a
+ dependency for numerous other packages.
</para>
<para>
Management tools like <command>yum</command> use the information
- on dependencies stored within packages to ensure that all of the
- requirements are met when you install an application. The
- packages for any supporting software are automatically be
- installed first, if they are not already present on your system.
- If a new application has requirements that conflict with
- existing software then the installation process safely aborts
- without making any changes to your system.
+ on dependencies stored within packages to ensure that all of the
+ requirements are met when you install an application. The
+ <command>yum</command> utility installs all required packages
+ which are not already present on your system. If a new
+ application has requirements that conflict with existing
+ software, <command>yum</command> aborts without making any
+ changes to your system.
</para>
</section>
<section id="sn-package-names">
<title>Understanding Package Names</title>
<indexterm>
- <primary>packages, hardware compatibility</primary>
+ <primary>packages</primary>
+ <secondary>hardware compatibility</secondary>
</indexterm>
<indexterm>
- <primary>packages, naming</primary>
+ <primary>packages</primary>
+ <secondary>naming</secondary>
</indexterm>
<para>
Each package file has a long name that indicates several key
@@ -285,17 +297,19 @@
<filename>tsclient-0.132-4.i386.rpm</filename>
</screen>
<para>
- Use just the name of the package itself with
- <command>yum</command>, except when it is necessary to specify
- the exact version or type. To specify the exact version of the
- application, use <filename>name-version</filename>. The package
- listings provided by <command>yum</command> itself use the
- format <filename>name.architecture</filename>, to specify the
- type of computer that the package is intended for.
+ Use only the name of the package itself with
+ <command>yum</command>, except when it is necessary to specify
+ the exact version or type. <remark role="fixme">When exactly is
+ that necessary? Make this clear. [PWF]</remark> To specify the exact
+ version of the application, use
+ <filename>name-version</filename>. The package listings provided
+ by <command>yum</command> use the format
+ <filename>name.architecture</filename>, to specify the type of
+ computer for which the package is intended.
</para>
<para>
- These are valid for the file shown above:
+ These properties are valid for the file shown above:
</para>
<itemizedlist>
@@ -320,23 +334,24 @@
<para>
The hardware architecture is the <emphasis>minimum</emphasis>
- type of machine required for that specific package. Packages
- with <option>i386</option> run on any current Intel-compatible
- computer. Packages for PowerPC machines, such as Apple Macs, are
- indicated with <option>ppc</option>. Packages with
- <option>noarch</option> have no architecture requirement.
+ type of machine required for that specific package. Packages
+ with architecture <option>i386</option> run on any current
+ Intel-compatible computer. Packages for PowerPC machines, such
+ as Apple Macs, are indicated with <option>ppc</option>. Packages
+ with architecture <option>noarch</option> have no architecture
+ requirement.
</para>
<para>
Some software can be optimized for particular types of
- Intel-compatible machine, and separate packages are provided for
- <option>i386</option>, <option>i586</option>,
- <option>i686</option> and <option>x86_64</option>. A computer
- with at least an Intel Pentium, VIA C3 or compatible chip is an
- <option>i586</option>. Computers with an Intel Pentium II and
- above, or a current model of AMD chip, are <option>i686</option>
- machines. 64-bit PCs use <option>x86_64</option> packages for
- full 64-bit support.
+ Intel-compatible machine, and separate packages may be provided
+ for <option>i386</option>, <option>i586</option>,
+ <option>i686</option> and <option>x86_64</option>. A computer
+ with at least an Intel Pentium, VIA C3 or compatible CPU is an
+ <option>i586</option>. Computers with an Intel Pentium II or
+ later, or a current model of AMD chip, are <option>i686</option>
+ machines. 64-bit PCs use <option>x86_64</option> packages for
+ full 64-bit support.
</para>
<note>
@@ -356,7 +371,7 @@
<primary>Add/Remove Applications utility</primary>
</indexterm>
<indexterm>
- <primary>alert icon</primary>
+ <primary>Alert Icon</primary>
</indexterm>
<indexterm>
<primary>up2date</primary>
@@ -368,40 +383,54 @@
</para>
<para>
- On your desktop is an <application>alert icon</application> that
+ On your desktop is an <application>Alert Icon</application> that
keeps you informed about package updates. Until your system is
- updated this appears as a red circle with a flashing exclamation
- mark. The alert icon is integrated with
- <application>up2date</application>, which enables you to easily
- install updates for your system.
+ updated, the icon appears as a red circle with a flashing
+ exclamation mark. The <application>Alert Icon</application> is
+ integrated with <application>up2date</application>, which enables
+ you to easily install updates for your system.
</para>
<para>
Both <application>up2date</application> and <command>yum</command>
are configured to use official &FED; repositories. If you add
- other repositories to <command>yum</command> then for consistency
+ other repositories to <command>yum</command>, for consistency
you should also configure <application>up2date</application> to
use them.
</para>
+ <note>
+ <title>Repository Configuration</title>
+ <para>
+ In &FC; 4 and beyond, <application>up2date</application> is
+ configured to automatically use repositories configured for
+ <command>yum</command>. If you configure any new repositories
+ for <command>yum</command>, <application>up2date</application>
+ will use them also.
+ </para>
+ </note>
+
<para>
Also included in &FC; is
- <application>system-config-packages</application>. From the main
- menu, this is <menuchoice><guimenu>System
- Settings</guimenu><guimenuitem>Add/Remove
- Applications</guimenuitem></menuchoice>. Unlike
- <application>up2date</application> and <command>yum</command>, it
- installs software packages from your &FC; installation discs, and
- does not use repositories. You may find this application useful
- for systems that do not have a network connection.
+ <application>system-config-packages</application>. To run this
+ utility, rom the <guilabel>Main Menu</guilabel>, select
+ <menuchoice><guimenu>System
+ Settings</guimenu><guimenuitem>Add/Remove
+ Applications</guimenuitem></menuchoice>. Unlike
+ <application>up2date</application> and <command>yum</command>,
+ this utility installs software packages from your &FC;
+ installation discs, and does not use repositories. This
+ application is used on systems that do not have a network
+ connection.
</para>
<para>
The <command>rpm</command> command-line utility has many functions
- for working with individual RPM packages, and can also be used to
- manually install and remove packages from your system. Installing
- software with the <command>rpm</command> utility can be difficult,
- and is not recommended.
+ for working with individual RPM packages. The
+ <command>rpm</command> command can also be used to manually
+ install and remove packages from your system. Installing software
+ with the <command>rpm</command> utility can be difficult for
+ novices, and is not recommended.
</para>
<caution>
@@ -419,28 +448,42 @@
<section id="sn-updating-your-system">
<title>Updating Your System with <command>yum</command></title>
<indexterm>
- <primary>updating, full system</primary>
+ <primary>updating</primary>
+ <secondary>full system</secondary>
</indexterm>
<indexterm>
- <primary>yum, updating full system</primary>
+ <primary>yum</primary>
+ <secondary>updating full system</secondary>
</indexterm>
- <para>
- You may update all of the software that makes up your &FC; system
- in a single operation. This is done with the
- <option>update</option> function.
- </para>
-
- <para>
- To carry out a full system update, type this command in a terminal
- window:
+
+ <remark role="fixme">Your original paragraph below was: "You may
+ update all of the software that makes up your &FC; system in a
+ single operation. This is done with the <option>update</option>
+ function." Remember this should be a procedural tutorial, so focus
+ on telling the user what to do. In technical docs "To ABC, do XYZ"
+ is much more effective than "You may do XYZ if you want to ABC."
+ It's also easier to translate, and keeps you from slipping into
+ passive voice. [PWF]</remark>
+
+ <para>
+ To update all of your &FED; system's software in a single
+ operation, select <menuchoice>
+ <guimenu>Applications</guimenu>
+ <guisubmenu>System Tools</guisubmenu>
+ <guimenuitem>Terminal</guimenuitem>
+ </menuchoice> and type:
</para>
<screen>
<userinput>su -c 'yum update'</userinput>
</screen>
<para>
- Enter the root password when prompted.
+ Enter the password for the <systemitem
+ class="username">root</systemitem> account when prompted.
</para>
+<!-- MARKER - LAST EDITS - PWF -->
+<!-- start worrying about passive voice below! -->
+
<para>
Data files are downloaded from each of the repositories that
<command>yum</command> is configured to use. These index and
@@ -1465,3 +1508,10 @@
<index id="generated-index"></index>
</article>
+
+<!--
+Local variables:
+mode: xml
+fill-column: 72
+End:
+-->
More information about the docs-commits
mailing list