yum-software-management yum-software-management-en.xml,1.9,1.10

Stuart Ellis (elliss) fedora-docs-commits at redhat.com
Sun Jul 17 23:57:55 UTC 2005


Author: elliss

Update of /cvs/docs/yum-software-management
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv21778

Modified Files:
	yum-software-management-en.xml 
Log Message:

Amendments, per P. Frields editing.



Index: yum-software-management-en.xml
===================================================================
RCS file: /cvs/docs/yum-software-management/yum-software-management-en.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- yum-software-management-en.xml	17 Jul 2005 21:39:41 -0000	1.9
+++ yum-software-management-en.xml	17 Jul 2005 23:57:52 -0000	1.10
@@ -4,7 +4,7 @@
 <!ENTITY % FEDORA-ENTITIES-EN SYSTEM "../docs-common/common/fedora-entities-en.ent">
 %FEDORA-ENTITIES-EN;
 
-<!ENTITY BOOKID "yum-software-management-0.5.0 (2005-07-17)"> <!-- change version of manual and date here -->
+<!ENTITY BOOKID "yum-software-management-0.5.0 (2005-07-18)"> <!-- change version of manual and date here -->
 
 <!ENTITY LEGALNOTICE SYSTEM "../docs-common/common/legalnotice-en.xml">
 
@@ -42,7 +42,7 @@
       </revision>
       <revision>
         <revnumber>0.5</revnumber>
-        <date>2005-07-17</date>
+        <date>2005-07-18</date>
         <authorinitials>StuartEllis</authorinitials>
         <revdescription>
           <para>
@@ -56,14 +56,23 @@
   <section id="sn-introduction">
     <title>Introduction</title>
     &DRAFTNOTICE;
+    <section id="sn-purpose">
+      <title>Purpose</title>
+
+      <para>
+        This document 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 document is intended for &FED; users of all levels of
+        experience.
       </para>
     </section>
 
@@ -73,34 +82,28 @@
       <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.
-      </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>
+        your needs and level of experience. If you are a new user, read
+        the <xref
+      linkend="sn-software-management-concepts"/>
+        before using <command>yum</command> for the first time.
         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 their own software repositories to manage the
+        process of installation and updates. Refer to
+        <xref linkend="sn-managing-repositories"/> for the 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
+        <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
@@ -136,37 +139,54 @@
         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.
+        <filename>yum.conf(5)</filename> to learn more, using the
+        following commands:
       </para>
+<screen>
+<userinput>
+man yum man yum.conf
+</userinput>
+</screen>
       <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>
+      <variablelist>
+        <varlistentry>
+          <term>
+          The Website for <command>yum</command> is:
+	  </term>
+         <listitem>
+          <para>
+            <ulink url="http://linux.duke.edu/projects/yum/">http://linux.duke.edu/projects/yum/</ulink>
+          </para>
+	 </listitem>
+        </varlistentry>
 
-      <para>
-        The archive for the <command>yum</command> development mailing
-        list is here:
-      </para>
+        <varlistentry>
+         <term>
+  The mailing list for <command>yum</command> users is:
+         </term>
+<listitem>
+          <para>
+            <ulink url="https://lists.dulug.duke.edu/mailman/listinfo/yum/">https://lists.dulug.duke.edu/mailman/listinfo/yum/</ulink>
+          </para>
+</listitem>
+        </varlistentry>
 
-      <para>
-        <ulink url="https://lists.dulug.duke.edu/pipermail/yum-devel/">https://lists.dulug.duke.edu/pipermail/yum-devel/</ulink>
-      </para>
+        <varlistentry>
+<term>
+The archive for the <command>yum</command> development mailing list is:
+</term>
+	  <listitem>
+          <para>
+	    <ulink url="https://lists.dulug.duke.edu/pipermail/yum-devel/">https://lists.dulug.duke.edu/pipermail/yum-devel/</ulink>
+          </para>
+	  </listitem>
+        </varlistentry>
+      </variablelist>
     </section>
   </section>
 
@@ -183,18 +203,18 @@
         &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.
+        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
+        utilities by using a GPG <firstterm>public key</firstterm>. 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.
@@ -207,17 +227,17 @@
         <primary>repositories, defined</primary>
       </indexterm>
       <para>
+        A <firstterm>repository</firstterm> is a prepared directory or
+        Website that contains software packages and index files.
         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.
+        automatically locate and obtain the correct RPM packages from
+        these repositories. 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.
       </para>
 
       <para>
@@ -230,14 +250,15 @@
       </para>
 
       <note>
-        <title>All &FED; Packages are Free Software</title>
+        <title>All &FED; Packages are 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
+          All of the software provided by the &FP; is Open Source
+          software, or and can therefore be downloaded and installed
           from the network of &FED; repositories without restrictions.
         </para>
       </note>
+<!-- SE: The key point here is that users can install Fedora packages as many times as they like on as many systems as they like, as opposed to widely prevalent no-cost but not freely redistributable software -->
       <indexterm>
         <primary>package groups, defined</primary>
       </indexterm>
@@ -259,9 +280,9 @@
         For all of 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.
+        is not available from a repository then you cannot automatically
+        find or install newer versions. You must keep that product
+        updated yourself.
       </para>
     </section>
 
@@ -289,6 +310,7 @@
         existing software then the installation process safely aborts
         without making any changes to your system.
       </para>
+<!-- SE: Note that this is a generality: the behaviour described is standard for rpm, up2date etc.-->
     </section>
 
     <section id="sn-package-names">
@@ -318,7 +340,7 @@
       </para>
 
       <para>
-        These are valid for the file shown above:
+        These naming conventions are valid for the file shown above:
       </para>
 
       <itemizedlist>
@@ -353,13 +375,14 @@
       <para>
         Some software may be optimized for particular types of
         Intel-compatible machine. For these products, separate packages
-        are provided for <option>i386</option>, <option>i586</option>,
-        <option>i686</option> and <option>x86_64</option> computers. A
-        machine 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.
+        may be provided for <option>i386</option>,
+        <option>i586</option>, <option>i686</option> and
+        <option>x86_64</option> computers. A machine with at least an
+        Intel Pentium, VIA C3 or compatible CPU 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.
       </para>
     </section>
   </section>
@@ -370,7 +393,7 @@
       <primary>Add/Remove Applications utility</primary>
     </indexterm>
     <indexterm>
-      <primary>alert icon</primary>
+      <primary>Alert Icon</primary>
     </indexterm>
     <indexterm>
       <primary>up2date</primary>
@@ -382,7 +405,7 @@
     </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
@@ -406,16 +429,18 @@
       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.
+      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 may also be used to
+      for working with individual RPM packages. It may also be used to
       manually install and remove packages from your system. Installing
       software with the <command>rpm</command> utility requires you to
-      manually check and install the dependencies of the software.
+      manually check and install the dependencies of the software. For
+      this reason, using the <command>rpm</command> utility to manage
+      software is not recommended.
     </para>
 
     <caution>
@@ -561,8 +586,9 @@
 <userinput>su -c 'yum install <replaceable>tsclient</replaceable>'</userinput>
 </screen>
       <para>
-        Enter the <systemitem class="username">root</systemitem>
-        password when prompted.
+        Enter the password for the
+        <systemitem class="username">root</systemitem> account when
+        prompted.
       </para>
 
       <para>
@@ -573,8 +599,9 @@
 <userinput>su -c 'yum groupinstall "<replaceable>MySQL Database</replaceable>"'</userinput>
 </screen>
       <para>
-        Enter the <systemitem class="username">root</systemitem>
-        password when prompted.
+        Enter the password for the
+        <systemitem class="username">root</systemitem> account when
+        prompted.
       </para>
 
       <important>
@@ -607,8 +634,9 @@
 <userinput>su -c 'yum update <replaceable>tsclient</replaceable>'</userinput>
 </screen>
       <para>
-        Enter the <systemitem class="username">root</systemitem>
-        password when prompted.
+        Enter the password for the
+        <systemitem class="username">root</systemitem> account when
+        prompted.
       </para>
 
       <important>
@@ -630,8 +658,9 @@
 <userinput>su -c 'yum groupupdate "<replaceable>MySQL Database</replaceable>"'</userinput>
 </screen>
       <para>
-        Enter the <systemitem class="username">root</systemitem>
-        password when prompted.
+        Enter the password for the
+        <systemitem class="username">root</systemitem> account when
+        prompted.
       </para>
 
       <note>
@@ -668,8 +697,9 @@
 <userinput>su -c 'yum remove <replaceable>tsclient</replaceable>'</userinput>
 </screen>
       <para>
-        Enter the <systemitem class="username">root</systemitem>
-        password when prompted.
+        Enter the password for the
+        <systemitem class="username">root</systemitem> account when
+        prompted.
       </para>
 
       <para>
@@ -680,8 +710,9 @@
 <userinput>su -c 'yum groupremove "<replaceable>MySQL Database</replaceable>"'</userinput>
 </screen>
       <para>
-        Enter the <systemitem class="username">root</systemitem>
-        password when prompted.
+        Enter the password for the
+        <systemitem class="username">root</systemitem> account when
+        prompted.
       </para>
     </section>
   </section>
@@ -823,8 +854,7 @@
     </para>
 
     <para>
-      To carry out a full system update, type this command in a terminal
-      window:
+      To carry out a full system update, type this command:
     </para>
 <screen>
 <userinput>su -c 'yum update'</userinput>
@@ -853,8 +883,9 @@
 <userinput>su -c '/sbin/chkconfig --level 345 yum on; /sbin/service yum start'</userinput>
 </screen>
       <para>
-        Enter the <systemitem class="username">root</systemitem>
-        password when prompted.
+        Enter the password for the
+        <systemitem class="username">root</systemitem> account when
+        prompted.
       </para>
 
       <note>
@@ -1046,8 +1077,9 @@
 <userinput>su -c 'cp example.repo /etc/yum.repos.d/'</userinput>
 </screen>
       <para>
-        Enter the <systemitem class="username">root</systemitem>
-        password when prompted.
+        Enter the password for the
+        <systemitem class="username">root</systemitem> account when
+        prompted.
       </para>
 
       <para>
@@ -1087,8 +1119,9 @@
 <userinput>su -c 'rpm --import <replaceable>GPG-PUB-KEY.asc</replaceable>'</userinput>
 </screen>
       <para>
-        Enter the <systemitem class="username">root</systemitem>
-        password when prompted.
+        Enter the password for the
+        <systemitem class="username">root</systemitem> account when
+        prompted.
       </para>
 
       <para>
@@ -1287,8 +1320,9 @@
 <userinput>su -c 'rpm -e <replaceable>gpg-pubkey-4f2a6fd2-3f9d9d3b</replaceable>'</userinput>
 </screen>
       <para>
-        Enter the <systemitem class="username">root</systemitem>
-        password when prompted.
+        Enter the password for the
+        <systemitem class="username">root</systemitem> account when
+        prompted.
       </para>
     </section>
 
@@ -1333,7 +1367,7 @@
       <title>Old versions of yum use a different repository utility</title>
 
       <para>
-        These procedures are for repositories that are compatible with
+        These procedures create repositories that are compatible with
         version 2.11 of <command>yum</command> and above. You must use
         the <command>yum-arch</command> utility that was included with
         <command>yum</command> 2.10 to enable repositories for older
@@ -1349,11 +1383,11 @@
       <para>
         A software repository is simply a directory containing package
         files, with a sub-directory for the package index files used by
-        <command>yum</command>. Other types of files can be held in the
-        main directory without interfering with use of the repository.
-        The <filename>data/</filename> sub-directory and the XML files
-        it contains are created and updated with the
-        <command>createrepo</command> utility
+        <command>yum</command>. The main directory may also contain
+        other types of file without interfering with the use of the
+        repository. Do not modify the <filename>data/</filename>
+        sub-directory and the XML files within it. These are created and
+        updated with the <command>createrepo</command> utility.
       </para>
 
       <note>




More information about the docs-commits mailing list