yum-software-management yum-software-management-en.xml,1.1.1.1,1.2

Stuart Ellis (elliss) fedora-docs-commits at redhat.com
Sun Jun 12 10:48:14 UTC 2005


Author: elliss

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

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

- Added explanation of the example package to the introduction
- Added using package attributes to the Search section
- Reworked section on using Proxy Servers
- Minor style edits
- Bumped version to 0.4.2 



Index: yum-software-management-en.xml
===================================================================
RCS file: /cvs/docs/yum-software-management/yum-software-management-en.xml,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -r1.1.1.1 -r1.2
--- yum-software-management-en.xml	1 Jun 2005 21:31:25 -0000	1.1.1.1
+++ yum-software-management-en.xml	12 Jun 2005 10:48:11 -0000	1.2
@@ -4,7 +4,7 @@
 <!ENTITY % FEDORA-ENTITIES-EN SYSTEM "../common/fedora-entities-en.ent">
 %FEDORA-ENTITIES-EN;
 
-<!ENTITY BOOKID "yum-software-management-0.4 (2005-06-01)"> <!-- change version of manual and date here -->
+<!ENTITY BOOKID "yum-software-management-0.4.2 (2005-06-12)"> <!-- change version of manual and date here -->
 
 <!ENTITY LEGALNOTICE SYSTEM "../common/legalnotice-en.xml">
 
@@ -39,7 +39,7 @@
            Initial import into CVS.
           </para>
 	</revdescription>
-      </revision>
+       </revision>
     </revhistory>
     </articleinfo>
 
@@ -79,6 +79,15 @@
       updates.  The details of maintaining your own repositories are explained
       in <xref linkend="sn-managing-repositories"></xref>.
     </para>
+    <para>
+	 Most of the examples 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>.
+    </para>
      <important>
       <title>Avoid Logging in with the Root Account</title>
 	  <para>
@@ -95,18 +104,19 @@
     <section id="sn-yum-additional-resources">
      <title>Additional Resources</title>
      <indexterm>
-      <primary>Yum, documentation</primary>
+      <primary>yum, documentation</primary>
      </indexterm>
      <indexterm>
-      <primary>Yum, man pages</primary>
+      <primary>yum, man pages</primary>
      </indexterm>
     <para>
       The <command>yum</command> utility has features and options that
-      are not discussed in this document.  You can learn more by reading the
-      <command>man</command> pages for <command>yum(8)</command> and <filename>yum.conf(5)</filename>.
+      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>
+      <primary>yum, Websites</primary>
      </indexterm>
      <para>
 	The official Website for <command>yum</command> is:
@@ -240,8 +250,9 @@
     </indexterm>
        <para>
 	Each package file has a long name that indicates several key pieces of
-	information.  <command>Yum</command> can use just the name of the
-	software, or you can specify other items as well.
+	information.  The <command>yum</command> utility may use just the name
+	of the package itself, but you may also use other attributes in the file
+	name to make queries more specific.
       </para>
       <para>
       For example, this is the full name of a package supplied with &FC;:
@@ -255,7 +266,8 @@
 	 <filename>tsclient-0.132</filename>.   Add the hardware architecture to
 	 the short name and use <filename>tsclient.i386</filename> to specify
 	 packages for your type of computer.  The package listings provided by
-	 <command>yum</command> itself use the format <filename>name.architecture</filename>.
+	 <command>yum</command> itself use the format
+	 <filename>name.architecture</filename>.
       </para>
       <tip>
       <title>Specifying Packages</title>
@@ -396,15 +408,14 @@
    <section id="sn-updating-your-system">
     <title>Updating Your System with <command>yum</command></title>
     <indexterm>
-     <primary>system updating</primary>
+     <primary>updating, full system</primary>
     </indexterm>
     <indexterm>
-     <primary>yum, updating system</primary>
+     <primary>yum, updating full system</primary>
     </indexterm>
      <para>
-	Like <application>up2date</application>, <command>yum</command> can
-	update all of the software that makes up your &FC; system in a single
-	operation.  This is done by the <option>update</option> function.
+	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:
@@ -493,6 +504,20 @@
 <screen>
 <userinput>yum list <replaceable>tsclient</replaceable></userinput>
 </screen>
+<para>
+	To make your queries more specific, add other package attributes.  For example,
+	to search for version 0.132 of the application the command would be:
+        </para>
+<screen>
+<userinput>yum list <replaceable>tsclient-0.132</replaceable></userinput>
+</screen>
+     <note>
+      <title>Package Attributes</title>
+	<para>
+	See <xref linkend="sn-package-names"></xref> for information on
+	package attributes.
+      </para>
+     </note>
      <para>
 	If you do not know the name of the package, use either the
 	<option>search</option> or <option>provides</option> options.
@@ -634,8 +659,7 @@
 	the package that you specified.  
     </para>
     <para>
-	  To install the package <filename>tsclient</filename> you should enter
-	  the command:
+	  To install the package <filename>tsclient</filename>, enter the command:
     </para>
 <screen>
 <userinput>su -c 'yum install <replaceable>tsclient</replaceable>'</userinput>
@@ -1106,8 +1130,8 @@
 	  <para>
 	    The <command>createrepo</command> utility makes no changes to the
 	    directory other than adding a <filename>repo-data/</filename>
-	    sub-directory.  Other utilities may also add their own index
-	    files to the directory.
+	    sub-directory.  Adding index files for other utilities does not
+	    interfere with <command>yum</command>.
           </para>
       </tip>
    </section>
@@ -1140,49 +1164,86 @@
       <primary>yum, using a proxy server</primary>
      </indexterm>
       <para>
-	If your system is connected to the Internet through a Web proxy server,
-	the server must be specified in the environment variable
-	<command>http_proxy</command>.  This variable must specify the proxy
-	server as a complete URL, including the port number.  For example:
+      Repositories may be accessed through standard proxy servers.  If your
+	system is connected to the Internet through a Web proxy server, specify
+	the details of the server in <filename>/etc/yum.conf</filename>.  The
+	<command>proxy</command> setting must specify the proxy server as a
+	complete URL, including the TCP port number.   If your proxy server
+	requires a username and password, specify these by adding
+	<command>proxy_username</command> and <command>proxy_password</command> settings. 
+     </para>
+
+     <para> 
+      For example, the settings below enable <command>yum</command> to use the
+      proxy server <command>mycache.mydomain.com</command>, connecting to port
+      <command>3128</command>, with the username <command>yum-user</command> and the password <command>qwerty</command>.
      </para>
-<screen>
-<userinput>http_proxy="<replaceable>http://mycache.mydomain.com:3128</replaceable>"</userinput>
-</screen>
-     <para>
-	The URL may include a username and password, for proxy servers that
-	require them.  If the server in the previous example required the
-	username <command>yum-user</command> and the password
-	<command>qwerty</command> the complete variable would be:
-     </para>
-<screen>
-<userinput>http_proxy="<replaceable>http://yum-user:qwerty@mycache.mydomain.com:3128</replaceable>"</userinput>
-</screen>
+
+         <example id="config-file-httpproxy">
+      <title>Configuration File Settings for Using A Proxy Server</title>
+      <programlisting>
+       <![CDATA[
+         # The proxy server - proxy server:port number
+         proxy=http://mycache.mydomain.com:3128
+         # The account details for yum connections
+         proxy_username=yum-user
+         proxy_password=qwerty
+       ]]>
+      </programlisting>
+     </example>
+
+     <note>
+      <title>Global Settings</title>
+      <para>
+	Defining a proxy server in <filename>/etc/yum.conf</filename> means that
+	<emphasis>all</emphasis> users connect to the proxy server with those
+	details when using <command>yum</command>.
+      </para>
+     </note>
+
      <para>
-	To enable proxy access for all users, create a new file called
-	<filename>proxy.sh</filename> in the directory
-	<filename>/etc/profile.d/</filename>, containing these two lines:
+	To enable proxy access for a specific user, add the lines in the
+	example box below to their shell profile.  For the default
+	<command>bash</command> shell, the profile is the file
+	<filename>.bash_profile</filename>.  The settings below enable <command>yum</command> to
+	use the proxy server <command>mycache.mydomain.com</command>, connecting to port <command>3128</command>.
      </para>
      <example id="profile-script-httpproxy">
-      <title>Profile Script for Setting the Proxy Server</title>
+      <title>Profile Settings for Using A Proxy Server</title>
       <programlisting>
        <![CDATA[
+         # The Web proxy server used by this account
          http_proxy="http://mycache.mydomain.com:3128"
          export http_proxy
        ]]>
       </programlisting>
      </example>
-      <para>
-	This means that any user that logs in automatically has the environment variable set for them.
-      </para>
+
+     <para>
+      If the proxy server requires a username and password then add these to the
+      URL.  For example, to include the username
+      <command>yum-user</command> and the password <command>qwerty</command>:
+     </para>
+     <example id="profile-script-httpproxy-withpassword">
+      <title>Profile Settings for A Secured Proxy Server</title>
+      <programlisting>
+       <![CDATA[
+         # The Web proxy server, with the username and password for this account
+         http_proxy="http://yum-user:qwerty@mycache.mydomain.com:3128"
+         export http_proxy
+       ]]>
+      </programlisting>
+     </example>
        <note>
-        <title>http_proxy Variable with Other Utilities</title>
+        <title><command>http_proxy</command> Variable with Other Utilities</title>
         <para>
 	  The <command>http_proxy</command> variable is also used by <command>curl</command> and
-	  other utilities.  <command>Yum</command> itself can use <command>http_proxy</command> in
-	  either upper-case or lower-case, but <command>curl</command> requires
+	  other utilities.  Although <command>yum</command> itself may use <command>http_proxy</command> in
+	  either upper-case or lower-case, <command>curl</command> requires
 	  the name of the variable to be in lower-case.
         </para>
        </note>
+
    </section>
 
 




More information about the Fedora-docs-commits mailing list