yum-software-management yum-software-management-en.xml,1.14,1.15
by fedora-docs-commits＠redhat.com
Author: elliss
Update of /cvs/docs/yum-software-management
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv15532
Modified Files:
yum-software-management-en.xml
Log Message:
- Added example public key header.
- Change example transaction to an <example>
- Removed superfluous paragraph from the Tools overview.
Index: yum-software-management-en.xml
===================================================================
RCS file: /cvs/docs/yum-software-management/yum-software-management-en.xml,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- yum-software-management-en.xml 19 Jul 2005 02:36:04 -0000 1.14
+++ yum-software-management-en.xml 19 Jul 2005 19:42:22 -0000 1.15
@@ -1,4 +1,4 @@
- <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % FEDORA-ENTITIES-EN SYSTEM "../docs-common/common/fedora-entities-en.ent">
@@ -110,8 +110,8 @@
<para>
You do not need to log in with the
<systemitem class="username">root</systemitem> account in
- order to manage your &FED; system. All of the commands shown in
- this tutorial that require
+ order to manage your &FED; system. All of the commands shown
+ in this tutorial that require
<systemitem class="username">root</systemitem> access will
prompt you for the
<systemitem class="username">root</systemitem> password. The
@@ -432,14 +432,6 @@
</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
- you should also configure <application>up2date</application> to
- use them.
- </para>
-
- <para>
Also included in &FC; is
<application>system-config-packages</application>. From the main
menu, this is <menuchoice><guimenu>System
@@ -543,8 +535,11 @@
As an example, this is the transaction for installing
<filename>tsclient</filename>:
</para>
-<screen>
-<computeroutput>
+
+ <example id="yum-transaction-format">
+ <title>Format of <command>yum</command> Transaction Reports</title>
+<programlisting>
+ <![CDATA[
=============================================================================
Package Arch Version Repository Size
=============================================================================
@@ -560,8 +555,10 @@
Remove 0 Package(s)
Total download size: 355 k
Is this ok [y/N]:
-</computeroutput>
-</screen>
+ ]]>
+ </programlisting>
+ </example>
+
<para>
Review the list of changes before pressing
<userinput>y</userinput> to accept and begin the process. No
@@ -630,8 +627,8 @@
configure a new service to run on bootup, choose <menuchoice>
<guimenu>Desktop</guimenu><guisubmenu>System
Settings</guisubmenu> <guisubmenu>Server Settings</guisubmenu>
- <guimenuitem>Services</guimenuitem></menuchoice>, or run
- <command>chkconfig</command> in a terminal window.
+ <guimenuitem>Services</guimenuitem></menuchoice>, or use the
+ <command>chkconfig</command> command-line utility.
</para>
</important>
</section>
@@ -1162,11 +1159,34 @@
<userinput>rpm -qi gpg-pubkey-*</userinput>
</screen>
<para>
- The identification name for a key is
- <option>gpg-pubkey-Version_number-Release_number</option>. For
- example, the &FP; public key is currently version 4f2a6fd2,
- release 3f9d9d3b. The <command>rpm</command> identification for
- this key is <option>gpg-pubkey-4f2a6fd2-3f9d9d3b</option>.
+ 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>
+<programlisting>
+ <![CDATA[
+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 <fedora(a)redhat.com>)
+Description :
+ ]]>
+ </programlisting>
+ </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>
18 years, 11 months
- 1
- 0
release-notes/FC4 kernel.xml,1.11,1.12
by fedora-docs-commits＠redhat.com
Author: pfrields
Update of /cvs/docs/release-notes/FC4
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv5721
Modified Files:
kernel.xml
Log Message:
Very minor changes - ispell is your friend
Index: kernel.xml
===================================================================
RCS file: /cvs/docs/release-notes/FC4/kernel.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- kernel.xml 19 Jul 2005 04:24:07 -0000 1.11
+++ kernel.xml 19 Jul 2005 12:02:01 -0000 1.12
@@ -90,16 +90,17 @@
</section>
<!--
<tip>
- <title>Using <command>yum</command> to Uninstall Kernel
+ <title>Using <command>yum</command> to Remove Kernel
Packages</title>
<para>
&FC; &LOCALVER; contains support for clustering systems using CMAN and GFS.
These kernels require assistance from some user-space packages.
- These packages are not removed when using <command>rpm -e</command> to uninstall older versions of the kernel packages.
+ These packages are not removed when using <command>rpm
+ -e</command> to remove older versions of the kernel packages.
</para>
<para>
- When using <command>rpm -e kernel-<replaceable><version></replaceable> </command> to uninstall the kernel, you must also remove the assisting user-space packages. You may wish to consider a dependecy resolving tool such as <command>yum remove kernel-<replaceable><version></replaceable> </command>.
- This automatically removes any dependant packages.
+ When using <command>rpm -e kernel-<replaceable><version></replaceable> </command> to remove the kernel, you must also remove the assisting user-space packages. You may wish to consider a dependency resolving tool such as <command>yum remove kernel-<replaceable><version></replaceable> </command>.
+ This automatically removes any dependent packages.
</para>
</tip>
-->
@@ -236,7 +237,7 @@
<para>to this:</para>
<screen width="60">EXTRAVERSION = -1.234_FC4</screen>
<para>
- that is, substitude everything from the final dash onward.
+ that is, substitute everything from the final dash onward.
</para>
</step>
<step>
@@ -279,7 +280,7 @@
</para>
</section>
<section id="sn-kernel-coop">
- <title>Userspace Dependancies on the Kernel</title>
+ <title>User Space Dependencies on the Kernel</title>
<para>
&DISTRO; adds support for clustered systems. This requires a
special kernel that works in conjunction with some user-space
@@ -287,14 +288,14 @@
such a kernel, perhaps after an update, you
<emphasis>cannot</emphasis> simply use the <command>rpm -e
kernel-<replaceable><version></replaceable></command>
- command as in earlier distributions because these userspace
+ command as in earlier distributions because these user space
packages depend on the kernel package. You may either list both
- the kernel package and its userspace dependant packages on the
+ the kernel package and its user space dependent packages on the
<command>rpm -e</command> command, or you may wish to use the
<command>yum remove
kernel-<replaceable><version></replaceable></command>
command instead since <command>yum</command> automatically removes
- dependant packages if necesssary.
+ dependent packages if necessary.
</para>
</section>
</section>
18 years, 11 months
- 1
- 0
docs-common/common cvs-en.xml,1.4,1.5
by fedora-docs-commits＠redhat.com
Author: jtr
Update of /cvs/docs/docs-common/common
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv28008
Modified Files:
cvs-en.xml
Log Message:
Tidy bowl normalization.
Index: cvs-en.xml
===================================================================
RCS file: /cvs/docs/docs-common/common/cvs-en.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- cvs-en.xml 14 May 2005 20:00:15 -0000 1.4
+++ cvs-en.xml 19 Jul 2005 04:59:38 -0000 1.5
@@ -1,4 +1,5 @@
<!-- $Id: -->
+
<!--
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
@@ -9,108 +10,126 @@
]>
-->
+
<chapter id="ch-cvs">
<title>CVS</title>
-
<para>
- The Concurrent Versions System (<application>CVS</application>) provides a framework where multiple users can edit the same files.
- As you can imagine, if a group of users edits the files in a single directory, chaos would reign.
- Using <application>CVS</application>, however, a group of people can safely work on the same set of files.
- <application>CVS</application> keeps the master copy of the files, and it records who changed what and when in a central repository.
- If conflicts arise, <application>CVS</application> lets you know.
- <application>CVS</application> is often used so that programmers can share code, but it also works well for documentation.
- </para>
-
+ The Concurrent Versions System (<application>CVS</application>)
+ provides a framework where multiple users can edit the same files.
+ As you can imagine, if a group of users edits the files in a single
+ directory, chaos would reign. Using <application>CVS</application>,
+ however, a group of people can safely work on the same set of files.
+ <application>CVS</application> keeps the master copy of the files,
+ and it records who changed what and when in a central repository. If
+ conflicts arise, <application>CVS</application> lets you know.
+ <application>CVS</application> is often used so that programmers can
+ share code, but it also works well for documentation.
+ </para>
<indexterm>
<primary>cvs</primary>
</indexterm>
-
<section id="sn-cvs-overview">
<title>How CVS Works</title>
-
<indexterm>
<primary>cvs</primary>
<secondary>how it works</secondary>
</indexterm>
-
<indexterm>
<primary>cvs</primary>
<secondary>overview</secondary>
</indexterm>
-
<para>
- In most cases, each set of files that make up a package or project is stored as a <firstterm>module</firstterm> on the CVS server.
+ In most cases, each set of files that make up a package or project
+ is stored as a <firstterm>module</firstterm> on the CVS server.
</para>
<para>
- When working with files from <application>CVS</application>, you <firstterm>checkout</firstterm> a copy of the module on your local file system.
- After modifying one or more files, you <firstterm>commit</firstterm> them back to the central <application>CVS</application> repository server.
+ When working with files from <application>CVS</application>, you
+ <firstterm>checkout</firstterm> a copy of the module on your local
+ file system. After modifying one or more files, you
+ <firstterm>commit</firstterm> them back to the central
+ <application>CVS</application> repository server.
</para>
<para>
- With <application>CVS</application> you may edit a file without first getting permission or locking the file.
- The <wordasword>concurrent</wordasword> part of the <application>CVS</application> name comes from its ability to allow several different people to edit different parts of the same file.
- As long as none of the changes overlap, <application>CVS</application> can correctly record their changes.
- In case of duplicate changes, they are clearly marked in the files and the authors must resolve the issue among themselves.
+ With <application>CVS</application> you may edit a file without
+ first getting permission or locking the file. The
+ <wordasword>concurrent</wordasword> part of the
+ <application>CVS</application> name comes from its ability to
+ allow several different people to edit different parts of the same
+ file. As long as none of the changes overlap,
+ <application>CVS</application> can correctly record their changes.
+ In case of duplicate changes, they are clearly marked in the files
+ and the authors must resolve the issue among themselves.
</para>
<para>
- When you commit changes, only changes to files the server knows about are committed.
- In other words, if you created a file in your local checkout of a module, the new file is not automatically uploaded to the server.
- You must <firstterm>add</firstterm> the file to the repository and then commit it.
- If you remove a file from your local checkout of a module, you must specify that you want to remove it from the repository on the CVS server and then commit the removal of the file.
+ When you commit changes, only changes to files the server knows
+ about are committed. In other words, if you created a file in your
+ local checkout of a module, the new file is not automatically
+ uploaded to the server. You must <firstterm>add</firstterm> the
+ file to the repository and then commit it. If you remove a file
+ from your local checkout of a module, you must specify that you
+ want to remove it from the repository on the CVS server and then
+ commit the removal of the file.
</para>
<para>
- The specific commands to perform these actions are discussed in <xref linkend="sn-cvs-cvscommands"></xref>.
+ The specific commands to perform these actions are discussed in
+ <xref linkend="sn-cvs-cvscommands"></xref>.
</para>
<para>
- If someone has modified the file between the last time you grabbed the file from CVS and when you try to commit a change, <application>CVS</application> will try to merge the changes into the master copy of the <application>CVS</application> server.
- If the content you changed is in a different location in the file than the content changed by someone else, chances are, the commit action will go through without a <firstterm>conflict</firstterm>.
- If someone modified the same content as the content you just changed and tried to commit, you will see a message that a file conflict has occurred.
- Thus, you need to <firstterm>update</firstterm> your files frequently.
- It is a good practice to update them right before you start modifying a file.
- Refer to <xref linkend="sn-cvs-cvscommands-conflicts"></xref> for instructions on resolving conflicts.
- </para>
-
+ If someone has modified the file between the last time you grabbed
+ the file from CVS and when you try to commit a change,
+ <application>CVS</application> will try to merge the changes into
+ the master copy of the <application>CVS</application> server. If
+ the content you changed is in a different location in the file
+ than the content changed by someone else, chances are, the commit
+ action will go through without a <firstterm>conflict</firstterm>.
+ If someone modified the same content as the content you just
+ changed and tried to commit, you will see a message that a file
+ conflict has occurred. Thus, you need to
+ <firstterm>update</firstterm> your files frequently. It is a good
+ practice to update them right before you start modifying a file.
+ Refer to <xref linkend="sn-cvs-cvscommands-conflicts"></xref> for
+ instructions on resolving conflicts.
+ </para>
</section>
-
<section id="sn-cvs-preparation">
<title>Preparing For CVS Use</title>
-
<indexterm>
<primary>cvs</primary>
<secondary>preparing for use</secondary>
</indexterm>
-
<para>
- Before using <application>CVS</application>, you need to establish an account with the <application>CVS</application> server.
- After getting an account, you do not need to perform these actions again.
+ Before using <application>CVS</application>, you need to establish
+ an account with the <application>CVS</application> server. After
+ getting an account, you do not need to perform these actions
+ again.
</para>
<section id="sn-cvs-rpm-check">
<title>Is CVS Installed On Your System</title>
-
<indexterm>
<primary>cvs</primary>
<secondary>RPM installation</secondary>
</indexterm>
-
<para>
You must have the <application>CVS</application>
- <abbrev>RPM</abbrev> package installed.
- Verify its presence by typing the command:
+ <abbrev>RPM</abbrev> package installed. Verify its presence by
+ typing the command:
</para>
-
- <screen><prompt>$ </prompt><command>rpm -q cvs</command></screen>
-
+<screen><prompt>$ </prompt><command>rpm -q cvs</command></screen>
<para>
- If you see output similar to <computeroutput>cvs-1.11.19-1</computeroutput>, then the package is installed.
- A message similar to <computeroutput>package cvs is not installed</computeroutput> means you must install the <application>cvs</application> package before continuing.
- If you do not know how to do this, consult your system administrator who can install it for you.
+ If you see output similar to
+ <computeroutput>cvs-1.11.19-1</computeroutput>, then the package
+ is installed. A message similar to <computeroutput>package cvs
+ is not installed</computeroutput> means you must install the
+ <application>cvs</application> package before continuing. If you
+ do not know how to do this, consult your system administrator
+ who can install it for you.
</para>
-
</section>
<section id="sn-cvs-generate-keys">
@@ -119,348 +138,382 @@
<primary>OpenSSH</primary>
<secondary>authorization keys</secondary>
</indexterm>
-
<para>
- The <application>CVS</application> server uses <application>SSH</application> Protocol 2 keys to authenticate users.
- Thus, you need to generate a pair of keys before applying for a <application>CVS</application> account.
- If you already have an <application>SSH</application>
- <abbrev>DSA</abbrev> key, you may skip this step.
+ The <application>CVS</application> server uses
+ <application>SSH</application> Protocol 2 keys to authenticate
+ users. Thus, you need to generate a pair of keys before applying
+ for a <application>CVS</application> account. If you already
+ have an <application>SSH</application> <abbrev>DSA</abbrev> key,
+ you may skip this step.
</para>
-
<tip>
<title>Tip</title>
<para>
- You already have a <abbrev>DSA</abbrev> key if you have the file <filename>~/.ssh/id_dsa.pub</filename> on the system.
+ You already have a <abbrev>DSA</abbrev> key if you have the
+ file <filename>~/.ssh/id_dsa.pub</filename> on the system.
</para>
<para>
- If your existing <abbrev>DSA</abbrev> key does not require a <wordasword>passphrase</wordasword>, you are strongly urged to generate one that does require a passphrase.
+ If your existing <abbrev>DSA</abbrev> key does not require a
+ <wordasword>passphrase</wordasword>, you are strongly urged to
+ generate one that does require a passphrase.
</para>
</tip>
-
<para>
- Use the following steps to generate a <abbrev>DSA</abbrev> key used by <application>SSH</application> Protocol 2.
- It is required for an <computeroutput>cvs.fedora.redhat.com</computeroutput>
+ Use the following steps to generate a <abbrev>DSA</abbrev> key
+ used by <application>SSH</application> Protocol 2. It is
+ required for an
+ <computeroutput>cvs.fedora.redhat.com</computeroutput>
<application>CVS</application> account.
</para>
<orderedlist>
<indexterm>
<primary>OpenSSH</primary>
- <secondary>
- <command>ssh-keygen</command>
+ <secondary><command>ssh-keygen</command>
</secondary>
</indexterm>
<indexterm>
- <primary>
- <command>ssh-keygen</command>
+ <primary><command>ssh-keygen</command>
</primary>
</indexterm>
<listitem>
<para>
- To generate a <acronym>DSA</acronym> key to work with version 2.0 protocol, at a shell prompt, type the command:
+ To generate a
+ <acronym>DSA</acronym>
+ key to work with version 2.0 protocol, at a shell prompt,
+ type the command:
</para>
- <screen><prompt>$ </prompt><command>ssh-keygen -t dsa</command></screen>
+<screen><prompt>$ </prompt><command>ssh-keygen -t dsa</command></screen>
<para>
- Accept the default file location of <filename>~/.ssh/id_dsa</filename>.
- You are strongly urged to define and use a <firstterm>passphrase</firstterm> to enhance the security of your key.
- Enter a passphrase different than your account password and confirm it by entering it again.
+ Accept the default file location of
+ <filename>~/.ssh/id_dsa</filename>. You are strongly urged
+ to define and use a <firstterm>passphrase</firstterm> to
+ enhance the security of your key. Enter a passphrase
+ different than your account password and confirm it by
+ entering it again.
</para>
</listitem>
<listitem>
<para>
- Copy your new key to the correct file by typing the following at a shell prompt.
+ Copy your new key to the correct file by typing the
+ following at a shell prompt.
</para>
- <screen><prompt>$ </prompt><command>cat ~/.ssh/id_dsa.pub>>~/.ssh/authorized_keys</command></screen>
+<screen><prompt>$ </prompt><command>cat ~/.ssh/id_dsa.pub>>~/.ssh/authorized_keys</command></screen>
<note>
<para>
- Check this command carefully before you press the <guibutton>ENTER</guibutton> key.
- If <filename>~/.ssh/authorized_keys</filename> already exists, the contents of <filename>~/.ssh/id_dsa.pub</filename> will be appended to the end of the <filename>~/.ssh/authorized_keys</filename> file.
+ Check this command carefully before you press the
+ <guibutton>ENTER</guibutton>
+ key. If <filename>~/.ssh/authorized_keys</filename>
+ already exists, the contents of
+ <filename>~/.ssh/id_dsa.pub</filename> will be appended to
+ the end of the <filename>~/.ssh/authorized_keys</filename>
+ file.
</para>
</note>
</listitem>
<listitem>
<para>
- Change the permissions of your <filename>~/.ssh</filename> directory and your keys with the commands:
- </para>
- <screen><prompt>$ </prompt><command>chmod 755 ~/.ssh</command>
+ Change the permissions of your <filename>~/.ssh</filename>
+ directory and your keys with the commands:
+ </para>
+<screen><prompt>$ </prompt><command>chmod 755 ~/.ssh</command>
<prompt>$ </prompt><command>chmod 644 ~/.ssh/authorized_keys</command></screen>
</listitem>
</orderedlist>
-
<tip>
<title>Tip</title>
<para>
- You can have your system remember your passphrase so that you do not have to type it every time you access the <application>CVS</application> server.
- Refer to the documentation of the <application>ssh-add</application> program.
+ You can have your system remember your passphrase so that you
+ do not have to type it every time you access the
+ <application>CVS</application> server. Refer to the
+ documentation of the <application>ssh-add</application>
+ program.
</para>
</tip>
</section>
-
</section>
-
<section id="sn-cvs-config">
<title>Configuring For CVS Access</title>
-
<indexterm>
<primary>cvs</primary>
<secondary>configuring for access</secondary>
</indexterm>
-
<indexterm>
<primary>cvs</primary>
<secondary>CVSROOT</secondary>
</indexterm>
-
<indexterm>
<primary>cvs</primary>
<secondary>CVS_RSH</secondary>
</indexterm>
-
<indexterm>
<primary>CVSROOT</primary>
</indexterm>
-
<indexterm>
<primary>CVS_RSH</primary>
</indexterm>
-
<indexterm>
<primary>cvs</primary>
- <secondary>
- <filename>.cvsrc</filename>
+ <secondary><filename>.cvsrc</filename>
</secondary>
</indexterm>
<indexterm>
- <primary>
- <filename>.cvsrc</filename>
+ <primary><filename>.cvsrc</filename>
</primary>
</indexterm>
-
<section id="sn-cvs-config-cvsrc">
<title>Avoiding Repetitive Typing</title>
-
<indexterm>
<primary>cvs</primary>
<secondary>avoiding repetitive typing</secondary>
</indexterm>
-
<para>
- Many <application>CVS</application> commands need certain command line switches to operate consistently.
- Rather than typing them every time that command is used, you can save the switches in a file that <application>CVS</application> will read before executing your command line.
+ Many <application>CVS</application> commands need certain
+ command line switches to operate consistently. Rather than
+ typing them every time that command is used, you can save the
+ switches in a file that <application>CVS</application> will read
+ before executing your command line.
</para>
<para>
- Create a file named <filename>~/.cvsrc</filename> in your home directory.
- It should contain the following commands, one per line:
+ Create a file named <filename>~/.cvsrc</filename> in your home
+ directory. It should contain the following commands, one per
+ line:
<screen><computeroutput>cvs -z3
diff -uNp
rdiff -uNp
update -dP</computeroutput></screen>
</para>
-
</section>
<section id="sn-cvs-config-anon">
<title>Configuring for Read-Only CVS Access</title>
-
<indexterm>
<primary>cvs</primary>
<secondary>configuring read-only access</secondary>
</indexterm>
-
<indexterm>
<primary>cvs</primary>
<secondary>anonymous access</secondary>
</indexterm>
-
<para>
- If your goal is to download the various &FC; documents and to render them on your system, you only need read-only access to the <application>CVS</application> repository.
- Follow the instructions in this section and then skip directly to <xref linkend="sn-cvs-cvscommands-co"/>.
+ If your goal is to download the various &FC; documents and to
+ render them on your system, you only need read-only access to
+ the <application>CVS</application> repository. Follow the
+ instructions in this section and then skip directly to
+ <xref linkend="sn-cvs-cvscommands-co"/>.
</para>
<para>
- Change directories to where you want your files from <application>CVS</application> to be located, and execute the following commands:
+ Change directories to where you want your files from
+ <application>CVS</application> to be located, and execute the
+ following commands:
</para>
- <screen><prompt>$ </prompt><command>export CVSROOT=:pserver:cvs.fedora.redhat.com:/cvs/docs</command>
+<screen><prompt>$ </prompt><command>export CVSROOT=:pserver:cvs.fedora.redhat.com:/cvs/docs</command>
<prompt>$ </prompt><command>cvs login</command>
<prompt>$ </prompt><command>cvs checkout docs-setup</command> <replaceable>module-name</replaceable>
<prompt>$ </prompt><command>cvs checkout</command> <replaceable>module-name</replaceable>
<prompt>$ </prompt><command>cd</command> <replaceable>module-name</replaceable></screen>
-
<para>
- Once you have checked the module out, it doesn't matter what your <envar>CVSROOT</envar> is set to because it is stored in the file <filename>CVS/Root</filename> for each directory in your local repository.
- As long as your current working directory has a <filename>CVS/</filename> directory, the <application>CVS</application> program will automatically locate the &FC; repository.
- </para>
-
+ Once you have checked the module out, it doesn't matter what
+ your
+ <envar>CVSROOT</envar>
+ is set to because it is stored in the file
+ <filename>CVS/Root</filename> for each directory in your local
+ repository. As long as your current working directory has a
+ <filename>CVS/</filename> directory, the
+ <application>CVS</application> program will automatically locate
+ the &FC; repository.
+ </para>
</section>
<section id="sn-cvs-config-author">
<title>Configuring Read/Write CVS Access</title>
-
<indexterm>
<primary>cvs</primary>
<secondary>configuring read/write access</secondary>
</indexterm>
-
<indexterm>
<primary>cvs</primary>
<secondary>configuring access for authors</secondary>
</indexterm>
-
<para>
- To author a new document or to change an existing one, you must obtain full read/write access to the &FC; Docs <application>CVS</application> repository.
- For the full details on this process, refer to the <ulink url="http://fedoraproject.org/wiki/DocsProject/NewWriters"><filename>http://fedoraproject.org/wiki/DocsProject/NewWriters</filename>
- </ulink> web site.
- Below is a summary:
+ To author a new document or to change an existing one, you must
+ obtain full read/write access to the &FC; Docs
+ <application>CVS</application> repository. For the full details
+ on this process, refer to the
+ <ulink url="http://fedoraproject.org/wiki/DocsProject/NewWriters"><filename>http://fedoraproject.org/wiki/DocsProject/NewWriters</filename>
+ </ulink> web site. Below is a summary:
</para>
<itemizedlist>
<listitem>
<para>
- Subscribe to the <ulink url="https://listman.redhat.com/mailman/listinfo/fedora-docs-list"><filename>fedora-docs-list</filename>
+ Subscribe to the
+ <ulink url="https://listman.redhat.com/mailman/listinfo/fedora-docs-list"><filename>fedora-docs-list</filename>
</ulink>, which is the main forum for the project.
- </para>
+ </para>
</listitem>
<listitem>
<para>
- Generate a GNU Privacy Guard (<abbrev>GPG</abbrev>) key to identify yourself to the project.
- </para>
+ Generate a GNU Privacy Guard (<abbrev>GPG</abbrev>) key to
+ identify yourself to the project.
+ </para>
</listitem>
<listitem>
<para>
- Register for a <ulink url="http://bugzilla.redhat.com/"><filename>Bugzilla</filename>
+ Register for a
+ <ulink url="http://bugzilla.redhat.com/"><filename>Bugzilla</filename>
</ulink> account, if you do not have one already.
- <filename>Bugzilla</filename> is how we keep track of bugs, changes and projects.
- </para>
+ <filename>Bugzilla</filename> is how we keep track of bugs,
+ changes and projects.
+ </para>
</listitem>
<listitem>
<para>
- Post a <ulink url="http://fedoraproject.org/wiki/DocsProject_2fSelfIntroduction">self introduction</ulink> to the list.
- </para>
+ Post a
+ <ulink url="http://fedoraproject.org/wiki/DocsProject_2fSelfIntroduction">self
+ introduction</ulink> to the list.
+ </para>
</listitem>
</itemizedlist>
<para>
- After your <ulink url="http://fedoraproject.org/wiki/DocsProject_2fSelfIntroduction">self introduction</ulink> has been approved your <application>CVS</application> access will be granted.
+ After your
+ <ulink url="http://fedoraproject.org/wiki/DocsProject_2fSelfIntroduction">self
+ introduction</ulink> has been approved your
+ <application>CVS</application> access will be granted.
</para>
<para>
- Every author, and that includes you once your self introduction has been received, has a unique <envar>$CVSROOT</envar> to access the <application>CVS</application> repository:
+ Every author, and that includes you once your self introduction
+ has been received, has a unique
+ <envar>$CVSROOT</envar>
+ to access the <application>CVS</application> repository:
</para>
-
- <screen><prompt>$ </prompt><command>export CVSROOT=:ext:</command><replaceable>yourname</replaceable><command>@cvs.fedora.redhat.com:/cvs/docs</command>
+<screen><prompt>$ </prompt><command>export CVSROOT=:ext:</command><replaceable>yourname</replaceable><command>@cvs.fedora.redhat.com:/cvs/docs</command>
<prompt>$ </prompt><command>export CVS_RSH=/usr/bin/ssh</command></screen>
-
- <para>
- With the <envar>$CVSROOT</envar> and <envar>$CVS_RSH</envar> environment variables in place, you can access the repository:
- </para>
-
- <screen><prompt>$ </prompt><command>cvs co -c</command></screen>
-
<para>
- You will be asked for the passphrase for your <application>SSH</application> key.
- Press <guibutton>ENTER</guibutton> and you should receive a list of modules already in the repository.
+ With the
+ <envar>$CVSROOT</envar>
+ and
+ <envar>$CVS_RSH</envar>
+ environment variables in place, you can access the repository:
+ </para>
+<screen><prompt>$ </prompt><command>cvs co -c</command></screen>
+ <para>
+ You will be asked for the passphrase for your
+ <application>SSH</application> key. Press
+ <guibutton>ENTER</guibutton>
+ and you should receive a list of modules already in the
+ repository.
</para>
</section>
-
- </section>
-
- <section id="sn-cvs-cvscommands">
- <title>Basic CVS Commands</title>
-
+ </section>
+ <section id="sn-cvs-cvscommands">
+ <title>Basic CVS Commands</title>
+ <indexterm>
+ <primary>cvs</primary>
+ <secondary>commands</secondary>
+ </indexterm>
+ <para>
+ After configuring your system to work with CVS, checkout the
+ modules you will be working on.
+ </para>
+ <tip>
+ <title>Tip</title>
+ <para>
+ To see if you need a correctly-set
+ <envar>$CVSROOT</envar>
+ variable, or the <option>-m </option>
+ <replaceable>repository</replaceable> command line switch, see
+ if you have a <filename>CVS/</filename> subdirectory in your
+ working directory.
+ </para>
+ <para>
+ If you have a <filename>CVS/</filename> directory,
+ <application>CVS</application> ignores any
+ <envar>$CVSROOT</envar>
+ or <option>-m</option> command line switch.
+ </para>
+ </tip>
+ <section id="sn-cvs-cvscommands-co">
+ <title>Checking Out Modules</title>
<indexterm>
<primary>cvs</primary>
- <secondary>commands</secondary>
+ <secondary>checking out modules</secondary>
</indexterm>
-
<para>
- After configuring your system to work with CVS, checkout the modules you will be working on.
- </para>
-
- <tip>
- <title>Tip</title>
- <para>
- To see if you need a correctly-set <envar>$CVSROOT</envar> variable, or the <option>-m </option>
- <replaceable>repository</replaceable> command line switch, see if you have a <filename>CVS/</filename> subdirectory in your working directory.
- </para>
- <para>
- If you have a <filename>CVS/</filename> directory, <application>CVS</application> ignores any <envar>$CVSROOT</envar> or <option>-m</option> command line switch.
- </para>
- </tip>
-
- <section id="sn-cvs-cvscommands-co">
- <title>Checking Out Modules</title>
-
- <indexterm>
- <primary>cvs</primary>
- <secondary>checking out modules</secondary>
- </indexterm>
-
- <para>
- You only need to checkout a module once. After a local copy of the module is on your system, it is on your system.
+ You only need to checkout a module once. After a local copy of
+ the module is on your system, it is on your system.
</para>
- <para>
+ <para>
To checkout a module, use the following command:
</para>
-
- <screen><prompt>$ </prompt><command>cvs co</command> <replaceable><module-name></replaceable></screen>
-
- <para>
- For example, to checkout the <computeroutput>example-tutorial</computeroutput> module, change to your work directory, and execute the following command:
+<screen><prompt>$ </prompt><command>cvs co</command> <replaceable><module-name></replaceable></screen>
+ <para>
+ For example, to checkout the
+ <computeroutput>example-tutorial</computeroutput> module, change
+ to your work directory, and execute the following command:
</para>
-
- <screen><prompt>$ </prompt><command>cvs co example-tutorial</command></screen>
-
- <para>
- A directory called <filename>example-tutorial/</filename> is created in the current directory.
+<screen><prompt>$ </prompt><command>cvs co example-tutorial</command></screen>
+ <para>
+ A directory called <filename>example-tutorial/</filename> is
+ created in the current directory.
</para>
- <para>
- If a branch name is not specified when checking out a module, it is referred to as the <firstterm>HEAD</firstterm> of the <application>CVS</application> module.
+ <para>
+ If a branch name is not specified when checking out a module, it
+ is referred to as the <firstterm>HEAD</firstterm> of the
+ <application>CVS</application> module.
</para>
- <section id="sn-cvs-cvscommands-co-branch">
- <title>Checking Out Branches of Modules</title>
-
- <indexterm>
- <primary>cvs</primary>
- <secondary>check out modules</secondary>
- <tertiary>checking out branches</tertiary>
- </indexterm>
-
- <para>
- Think of a <application>CVS</application> branch as a version of the files for a particular version of a manual or package.
+ <section id="sn-cvs-cvscommands-co-branch">
+ <title>Checking Out Branches of Modules</title>
+ <indexterm>
+ <primary>cvs</primary>
+ <secondary>check out modules</secondary>
+ <tertiary>checking out branches</tertiary>
+ </indexterm>
+ <para>
+ Think of a <application>CVS</application> branch as a version
+ of the files for a particular version of a manual or package.
</para>
- <para>
+ <para>
To checkout a branch of a module, use the following command:
</para>
-
- <screen><prompt>$ </prompt><command>cvs co</command> <option>-d</option> <replaceable><directory></replaceable> <option>-r</option> <replaceable><branchname></replaceable> <replaceable><module-name></replaceable></screen>
-
- <para>
- A directory named <replaceable><directory></replaceable> is created, and the files for the <replaceable><branchname></replaceable> branch of the <replaceable><module-name></replaceable> module are copied in the directory.
+<screen><prompt>$ </prompt><command>cvs co</command> <option>-d</option> <replaceable><directory></replaceable> <option>-r</option> <replaceable><branchname></replaceable> <replaceable><module-name></replaceable></screen>
+ <para>
+ A directory named <replaceable><directory></replaceable>
+ is created, and the files for the
+ <replaceable><branchname></replaceable> branch of the
+ <replaceable><module-name></replaceable> module are
+ copied in the directory.
</para>
- <para>
- For example, to checkout a branch named BRANCH-VERSION-1.2 from the <computeroutput>mymodule</computeroutput> module, use the command:
+ <para>
+ For example, to checkout a branch named BRANCH-VERSION-1.2
+ from the <computeroutput>mymodule</computeroutput> module, use
+ the command:
</para>
-
- <screen><prompt>$ </prompt><command>cvs co -d mymodule-1.2 -r BRANCH-VERSION-1.2 mymodule</command></screen>
-
- <para>
- The BRANCH-VERSION-1.2 branch of the module is checked out in the <filename>mymodule-1.2</filename> directory on your system.
+<screen><prompt>$ </prompt><command>cvs co -d mymodule-1.2 -r BRANCH-VERSION-1.2 mymodule</command></screen>
+ <para>
+ The BRANCH-VERSION-1.2 branch of the module is checked out in
+ the <filename>mymodule-1.2</filename> directory on your
+ system.
</para>
- <para>
- To determine which branches and tags exist for a file, use the command:
+ <para>
+ To determine which branches and tags exist for a file, use the
+ command:
</para>
- <screen><prompt>$ </prompt><command>cvs status</command> <option>-v</option> <replaceable><filename></replaceable></screen>
-
- <para>
- For example, the status of the file <filename>foo.sgml</filename> is as follows:
- </para>
- <screen>
+<screen><prompt>$ </prompt><command>cvs status</command> <option>-v</option> <replaceable><filename></replaceable></screen>
+ <para>
+ For example, the status of the file
+ <filename>foo.sgml</filename> is as follows:
+ </para>
+<screen>
<computeroutput>
===================================================================
File: foo.sgml Status: Up-to-date
@@ -475,264 +528,333 @@
BRANCH-VERSION-1.2 (branch: 1.25.2)
</computeroutput>
</screen>
-
- <para>
- Only tags marked as branches in the second column under the <computeroutput>Existing Tags</computeroutput> section can be checked out as a branch.
+ <para>
+ Only tags marked as branches in the second column under the
+ <computeroutput>Existing Tags</computeroutput> section can be
+ checked out as a branch.
</para>
-
- </section>
-
</section>
+ </section>
- <section id="sn-cvs-cvscommands-up">
- <title>Updating Files</title>
-
- <indexterm>
- <primary>cvs</primary>
- <secondary>updating files</secondary>
- </indexterm>
-
- <para>
- To retrieve the latest versions of the files in a module, change to the directory that contains the files for the module and execute the command:
+ <section id="sn-cvs-cvscommands-up">
+ <title>Updating Files</title>
+ <indexterm>
+ <primary>cvs</primary>
+ <secondary>updating files</secondary>
+ </indexterm>
+ <para>
+ To retrieve the latest versions of the files in a module, change
+ to the directory that contains the files for the module and
+ execute the command:
+ </para>
+<screen><command>cvs update</command></screen>
+ <para>
+ The latest versions of all the files in the module are
+ downloaded into your local copy. If you notice a file conflict,
+ refer to <xref linkend="sn-cvs-cvscommands-conflicts"></xref>.
</para>
- <screen><command>cvs update</command></screen>
+ </section>
- <para>
- The latest versions of all the files in the module are downloaded into your local copy.
- If you notice a file conflict, refer to <xref linkend="sn-cvs-cvscommands-conflicts"></xref>.
+ <section id="sn-cvs-cvscommands-commit">
+ <title>Committing Files</title>
+ <indexterm>
+ <primary>cvs</primary>
+ <secondary>committing files</secondary>
+ </indexterm>
+ <para>
+ After modifying files in your local version of a module, commit
+ them to save the changes on the <application>CVS</application>
+ server:
</para>
-
- </section>
-
- <section id="sn-cvs-cvscommands-commit">
- <title>Committing Files</title>
-
- <indexterm>
- <primary>cvs</primary>
- <secondary>committing files</secondary>
- </indexterm>
-
+<screen><prompt>$ </prompt><command>cvs commit</command> <option>-m</option> "<replaceable>some log message</replaceable>" <replaceable>filename</replaceable></screen>
+ <note>
<para>
- After modifying files in your local version of a module, commit them to save the changes on the <application>CVS</application> server:
- </para>
- <screen><prompt>$ </prompt><command>cvs commit</command> <option>-m</option> "<replaceable>some log message</replaceable>" <replaceable>filename</replaceable></screen>
-
- <note>
- <para>
- If you would prefer to write your log message with your favorite text editor, as defined by the $VISUAL or the $EDITOR environment variable, just omit the <userinput>-m "some log message"</userinput>.
- The buffer will already contain comments describing the change; you do not need to delete them as you enter your own text.
+ If you would prefer to write your log message with your
+ favorite text editor, as defined by the $VISUAL or the $EDITOR
+ environment variable, just omit the <userinput>-m "some
+ log message"</userinput>. The buffer will already contain
+ comments describing the change; you do not need to delete them
+ as you enter your own text.
</para>
- </note>
+ </note>
- <para>
- The log message should be as descriptive as possible so that you and anyone else working on the module understands what changed.
- Using a log message such as <userinput>updated some files</userinput> does not accurately describe what has changed and will not help you in the future.
- If you are correcting a bug, use the <application>Bugzilla</application> reference.
+ <para>
+ The log message should be as descriptive as possible so that you
+ and anyone else working on the module understands what changed.
+ Using a log message such as <userinput>updated some
+ files</userinput> does not accurately describe what has changed
+ and will not help you in the future. If you are correcting a
+ bug, use the <application>Bugzilla</application> reference.
</para>
- <para>
- The <replaceable><filename></replaceable> can be one filename, a series of filenames separated by spaces, or a group of filenames specified using wildcards such as <filename>*.png</filename> or <filename>foo-*.sgml</filename>.
+ <para>
+ The <replaceable><filename></replaceable> can be one
+ filename, a series of filenames separated by spaces, or a group
+ of filenames specified using wildcards such as
+ <filename>*.png</filename> or <filename>foo-*.sgml</filename>.
</para>
- <para>
- If no filename or group of filenames is specified in the <command>commit</command> command, all outstanding changes of any kind are committed to the server.
- The command is recursive and will include changes in any subdirectories of the module.
- Use caution when issuing the <command>commit</command> command without any filenames because you might not remember exactly what files changed.
+ <para>
+ If no filename or group of filenames is specified in the
+ <command>commit</command> command, all outstanding changes of
+ any kind are committed to the server. The command is recursive
+ and will include changes in any subdirectories of the module.
+ Use caution when issuing the <command>commit</command> command
+ without any filenames because you might not remember exactly
+ what files changed.
</para>
- <para>
- If you notice a file conflict, refer to <xref linkend="sn-cvs-cvscommands-conflicts"></xref>.
+ <para>
+ If you notice a file conflict, refer to
+ <xref linkend="sn-cvs-cvscommands-conflicts"></xref>.
</para>
+ </section>
- </section>
-
-
- <section id="sn-cvs-cvscommands-add">
- <title>Adding Files</title>
-
- <indexterm>
- <primary>cvs</primary>
- <secondary>adding files</secondary>
- </indexterm>
-
- <para>
- To add a file to a module, create the file in your local copy then execute the following command:
+ <section id="sn-cvs-cvscommands-add">
+ <title>Adding Files</title>
+ <indexterm>
+ <primary>cvs</primary>
+ <secondary>adding files</secondary>
+ </indexterm>
+ <para>
+ To add a file to a module, create the file in your local copy
+ then execute the following command:
</para>
- <screen><prompt>$ </prompt><command>cvs add</command> <replaceable>file-to-add</replaceable></screen>
-
- <para>
- After adding the file, you must <command>commit</command> the <command>add</command> to copy it to the server:
+<screen><prompt>$ </prompt><command>cvs add</command> <replaceable>file-to-add</replaceable></screen>
+ <para>
+ After adding the file, you must <command>commit</command> the
+ <command>add</command> to copy it to the server:
</para>
+<screen><prompt>$ </prompt><command>cvs commit</command> <option>-m</option> "<replaceable>some log message</replaceable>" <replaceable>file-to-add</replaceable></screen>
+ </section>
- <screen><prompt>$ </prompt><command>cvs commit</command> <option>-m</option> "<replaceable>some log message</replaceable>" <replaceable>file-to-add</replaceable></screen>
-
- </section>
-
- <section id="sn-cvs-cvscommands-rm">
- <title>Removing Files</title>
-
- <indexterm>
- <primary>cvs</primary>
- <secondary>removing files</secondary>
- </indexterm>
+ <section id="sn-cvs-cvscommands-admin">
+ <title>Managing Binary Files</title>
+ <indexterm>
+ <primary>cvs</primary>
+ <secondary>binary files</secondary>
+ </indexterm>
+ <para>
+ The most commonly-archived files are simple text files but
+ sometimes binary files are also archived. The
+ <application>cvs</application> program recognizes most common
+ filename extentions such as <filename>.png</filename> or
+ <filename>.jpg</filename>, so <application>cvs</application>
+ usually "does the right thing".
+ </para>
- <para>
- If a file is no longer needed in the module, use the <command>remove</command> command to remove it from your local copy and then <command>commit</command> the removal to the server.
- Even though the file is removed from current version of the module, an archived copy is still kept on the server and can be retrieved at any time with the <command>add</command> command.
- </para>
- <screen><prompt>$ </prompt><command>cvs rm -f</command> <replaceable>file-to-remove</replaceable></screen>
+ <para>
+ When a copy of a file is checked out of the repository,
+ <application>cvs</application> scans it for special keywords,
+ such as "<computeroutput>$id:$</computeroutput>" and
+ replaces the string with a generated value, such as the file
+ version number.
+ </para>
+ <para>
+ This keyword substitution usually corrupts binary files, so it
+ must be turned off if <application>cvs</application> does not
+ recognize your file as binary. To mark your file as being
+ binary, and thus needing the keyword expansion turned off, use
+ the command:
+ </para>
+<screen width="60"><prompt>$ </prompt><command>cvs</command> <option>admin</option> <option>-kk</option> <replaceable>filename</replaceable></screen>
+ <para>
+ Note that the file must already be checked in to the
+ <abbrev>CVS</abbrev> repository before the
+ <option>admin</option> command can be used. This is OK, since
+ the keyword expansion is done as the file is checked out and
+ copied to the local directory, not when the file is committed to
+ the repository.
+ </para>
+ <tip>
+ <title>Recovering a binary file</title>
<para>
- After removing the file, you must <command>commit</command> the removal:
- </para>
-
- <screen><prompt>$ </prompt><command>cvs commit</command> <option>-m</option>"<replaceable>some log message</replaceable>" <replaceable>file-to-remove</replaceable></screen>
+ If you check a binary file into the repository and then find
+ it corrupted when it is checked out, do not panic. Simply use
+ the <option>admin</option> command as described above, delete
+ your local file copy, and check it out again.
+ </para>
+ </tip>
+ </section>
- <para>
- You can not use wildcards in the <command>commit</command> command to identify removed files.
- They must be specified with a exact filename.
+ <section id="sn-cvs-cvscommands-rm">
+ <title>Removing Files</title>
+ <indexterm>
+ <primary>cvs</primary>
+ <secondary>removing files</secondary>
+ </indexterm>
+ <para>
+ If a file is no longer needed in the module, use the
+ <command>remove</command> command to remove it from your local
+ copy and then <command>commit</command> the removal to the
+ server. Even though the file is removed from current version of
+ the module, an archived copy is still kept on the server and can
+ be retrieved at any time with the <command>add</command>
+ command.
+ </para>
+<screen><prompt>$ </prompt><command>cvs rm -f</command> <replaceable>file-to-remove</replaceable></screen>
+ <para>
+ After removing the file, you must <command>commit</command> the
+ removal:
+ </para>
+<screen><prompt>$ </prompt><command>cvs commit</command> <option>-m</option>"<replaceable>some log message</replaceable>" <replaceable>file-to-remove</replaceable></screen>
+ <para>
+ You can not use wildcards in the <command>commit</command>
+ command to identify removed files. They must be specified with a
+ exact filename.
</para>
- <para>
- If you need to rename a file, it is best to rename the file on the <application>CVS</application> server so that the history of the file is preserved.
- If you need to rename a file, send an email to
+ <para>
+ If you need to rename a file, it is best to rename the file on
+ the <application>CVS</application> server so that the history of
+ the file is preserved. If you need to rename a file, send an
+ email to
<ulink url="mailto:cvsdocs-administrator@fedora.redhat.com"><filename>cvsdocs-administrator(a)fedora.redhat.com</filename>
- </ulink> asking to have the file renamed.
- </para>
-
- </section>
-
- <section id="sn-cvs-cvscommands-status">
- <title>Status of Files</title>
-
- <indexterm>
- <primary>cvs</primary>
- <secondary>status of files</secondary>
- </indexterm>
-
- <para>
- Sometimes it is necessary to view the <firstterm>status</firstterm> of a file in a <application>CVS</application> module.
- To view the status of a file, use the command:
+ </ulink> asking to have the file renamed.
</para>
+ </section>
- <screen><prompt>$ </prompt><command>cvs status</command> <replaceable>filename</replaceable></screen>
-
- <para>
+ <section id="sn-cvs-cvscommands-status">
+ <title>Status of Files</title>
+ <indexterm>
+ <primary>cvs</primary>
+ <secondary>status of files</secondary>
+ </indexterm>
+ <para>
+ Sometimes it is necessary to view the
+ <firstterm>status</firstterm> of a file in a
+ <application>CVS</application> module. To view the status of a
+ file, use the command:
+ </para>
+<screen><prompt>$ </prompt><command>cvs status</command> <replaceable>filename</replaceable></screen>
+ <para>
The status report of a repository file is as follows:
- </para>
- <variablelist>
- <varlistentry>
- <term>
- <computeroutput>Up-to-date</computeroutput>
- </term>
- <listitem>
- <para>
- Your revision of the file is identical to the latest revision on the <application>CVS</application> server.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <computeroutput>Locally Modified</computeroutput>
- </term>
- <listitem>
- <para>
- You have updated to the latest revision from the server, but then you modified the file on your system.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <computeroutput>Locally Added</computeroutput>
- </term>
- <listitem>
- <para>
- You added the file with the <command>cvs add</command> command but have not yet committed the addition of the file.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term><computeroutput>Up-to-date</computeroutput></term>
+ <listitem>
+ <para>
+ Your revision of the file is identical to the latest
+ revision on the <application>CVS</application> server.
</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <computeroutput>Locally Removed</computeroutput>
- </term>
- <listitem>
- <para>
- You removed the file with the <command>cvs remove</command> command but have not yet committed the removal.
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><computeroutput>Locally Modified</computeroutput></term>
+ <listitem>
+ <para>
+ You have updated to the latest revision from the server,
+ but then you modified the file on your system.
</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <computeroutput>Needs Checkout</computeroutput>
- </term>
- <listitem>
- <para>
- A newer version of the file is on the server and needs to be retrieved.
- Even though the status includes the word checkout, it really means that you need to update your files with the <command>cvs update</command> command.
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><computeroutput>Locally Added</computeroutput></term>
+ <listitem>
+ <para>
+ You added the file with the <command>cvs add</command>
+ command but have not yet committed the addition of the
+ file.
</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <computeroutput>Needs Patch</computeroutput>
- </term>
- <listitem>
- <para>
- The revision in your local checkout needs a patch to be the latest revision from the server.
- Issue the <command>cvs update</command> command to resolve.
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><computeroutput>Locally Removed</computeroutput></term>
+ <listitem>
+ <para>
+ You removed the file with the <command>cvs
+ remove</command> command but have not yet committed the
+ removal.
</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <computeroutput>Needs Merge</computeroutput>
- </term>
- <listitem>
- <para>
- A newer revision exists on the server and your local version contains modification not yet committed.
- This status usually occurs if you don't have the latest revision of the file and edit it anyway.
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><computeroutput>Needs Checkout</computeroutput></term>
+ <listitem>
+ <para>
+ A newer version of the file is on the server and needs to
+ be retrieved. Even though the status includes the word
+ checkout, it really means that you need to update your
+ files with the <command>cvs update</command> command.
</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <computeroutput>File had conflicts on merge</computeroutput>
- </term>
- <listitem>
- <para>
- Similar to <computeroutput>Needs Merge</computeroutput>, except when you tried to issue the <command>cvs update</command> command, the differences could not be resolved automatically.
- Refer to <xref linkend="sn-cvs-cvscommands-conflicts"></xref> for more information on resolving conflicts.
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><computeroutput>Needs Patch</computeroutput></term>
+ <listitem>
+ <para>
+ The revision in your local checkout needs a patch to be
+ the latest revision from the server. Issue the
+ <command>cvs update</command> command to resolve.
</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <computeroutput>Unknown</computeroutput>
- </term>
- <listitem>
- <para>
- The <application>CVS</application> server does not know anything about this file.
- It has neither been added nor removed locally and has never been committed to the server.
- This status usually occurs for files you should not commit to <application>CVS</application> such as <filename>generated-index.sgml</filename> or for files that you want to add to the repository but have not yet issued the <command>cvs add</command> command.</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ </listitem>
+ </varlistentry>
- </section>
+ <varlistentry>
+ <term><computeroutput>Needs Merge</computeroutput></term>
+ <listitem>
+ <para>
+ A newer revision exists on the server and your local
+ version contains modification not yet committed. This
+ status usually occurs if you don't have the latest
+ revision of the file and edit it anyway.
+ </para>
+ </listitem>
+ </varlistentry>
- <section id="sn-cvs-cvscommands-conflicts">
- <title>Resolving Conflicts</title>
+ <varlistentry>
+ <term><computeroutput>File had conflicts on merge</computeroutput></term>
+ <listitem>
+ <para>
+ Similar to <computeroutput>Needs Merge</computeroutput>,
+ except when you tried to issue the <command>cvs
+ update</command> command, the differences could not be
+ resolved automatically. Refer to
+ <xref linkend="sn-cvs-cvscommands-conflicts"></xref> for
+ more information on resolving conflicts.
+ </para>
+ </listitem>
+ </varlistentry>
- <indexterm>
- <primary>cvs</primary>
- <secondary>resolving conflicts</secondary>
- </indexterm>
+ <varlistentry>
+ <term><computeroutput>Unknown</computeroutput></term>
+ <listitem>
+ <para>
+ The <application>CVS</application> server does not know
+ anything about this file. It has neither been added nor
+ removed locally and has never been committed to the
+ server. This status usually occurs for files you should
+ not commit to <application>CVS</application> such as
+ <filename>generated-index.sgml</filename> or for files
+ that you want to add to the repository but have not yet
+ issued the <command>cvs add</command> command.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
- <para>
- If you modify a file and the same region is modified by someone else and committed first, you will probably see a message similar to the following when committing the file or updating your local copy of the module:
+ <section id="sn-cvs-cvscommands-conflicts">
+ <title>Resolving Conflicts</title>
+ <indexterm>
+ <primary>cvs</primary>
+ <secondary>resolving conflicts</secondary>
+ </indexterm>
+ <para>
+ If you modify a file and the same region is modified by someone
+ else and committed first, you will probably see a message
+ similar to the following when committing the file or updating
+ your local copy of the module:
</para>
-
- <screen>
+<screen>
<computeroutput>
RCS file: /cvs/docs/module-name/filename.sgml,v
retrieving revision 1.12
@@ -743,12 +865,13 @@
C filename.sgml
</computeroutput>
</screen>
-
- <para>
- To resolve the conflict, open the file, search for <computeroutput><<<<<<<</computeroutput> and determine which version of the content is correct.
- For example:
- </para>
- <screen>
+ <para>
+ To resolve the conflict, open the file, search for
+ <computeroutput><<<<<<<</computeroutput>
+ and determine which version of the content is correct. For
+ example:
+ </para>
+<screen>
<computeroutput>
<para>
Some sentence.
@@ -760,150 +883,132 @@
</para>
</computeroutput>
</screen>
+ <para>
+ The content between the
+ <computeroutput><<<<<<<</computeroutput>,
+ and the <computeroutput>=======</computeroutput> is the content
+ from your working copy. The content between the
+ <computeroutput>=======</computeroutput> and the
+ <computeroutput>>>>>>>></computeroutput> is
+ the content from the server.
+ </para>
- <para>
- The content between the <computeroutput><<<<<<<</computeroutput>, and the <computeroutput>=======</computeroutput> is the content from your
- working copy.
- The content between the <computeroutput>=======</computeroutput> and the <computeroutput>>>>>>>></computeroutput> is the content from the server.
- </para>
-
- <para>
+ <para>
Resolve the conflict by editing your copy, and commit the file.
</para>
+ </section>
- </section>
-
-
- <section id="sn-cvs-cvscommands-summary">
- <title>Summary</title>
-
- <indexterm>
- <primary>cvs</primary>
- <secondary>commands</secondary>
- <tertiary>summary of</tertiary>
- </indexterm>
-
- <para>
- All commands assume you are in the proper directory for the <application>CVS</application> module.
+ <section id="sn-cvs-cvscommands-summary">
+ <title>Summary</title>
+ <indexterm>
+ <primary>cvs</primary>
+ <secondary>commands</secondary>
+ <tertiary>summary of</tertiary>
+ </indexterm>
+ <para>
+ All commands assume you are in the proper directory for the
+ <application>CVS</application> module.
</para>
-
- <table frame="all" id="tb-cvs-basic-commands">
- <title>Basic CVS Commands</title>
- <tgroup cols="2">
- <colspec colnum="1" colname="shortcut" colwidth="30"/>
- <colspec colnum="2" colname="description" colwidth="60"/>
- <thead>
- <row>
- <entry>Command</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- <command>cvs checkout
- <replaceable><module-name></replaceable>
- </command>
- or <command>cvs co <replaceable><module-name></replaceable>
- </command>
- </entry>
- <entry>Creates a directory called
+ <table frame="all" id="tb-cvs-basic-commands">
+ <title>Basic CVS Commands</title>
+ <tgroup cols="2">
+ <colspec colnum="1" colname="shortcut" colwidth="30"/>
+ <colspec colnum="2" colname="description" colwidth="60"/>
+ <thead>
+ <row>
+ <entry>Command</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><command>cvs checkout
+ <replaceable><module-name></replaceable></command>
+ or <command>cvs co <replaceable><module-name></replaceable></command>
+ </entry>
+ <entry>Creates a directory called
<replaceable><module-name></replaceable> with the contents of the
module in the directory</entry>
- </row>
- <row>
- <entry>
- <command>cvs co -d <replaceable><directory></replaceable> -r <replaceable><branchname></replaceable>
- <replaceable><module-name></replaceable>
- </command>
- </entry>
- <entry>Creates the <replaceable><directory></replaceable> directory
+ </row>
+ <row>
+ <entry><command>cvs co -d <replaceable><directory></replaceable> -r <replaceable><branchname></replaceable><replaceable><module-name></replaceable></command>
+ </entry>
+ <entry>Creates the <replaceable><directory></replaceable> directory
with the contents of the <replaceable><branchname></replaceable>
branch of the <replaceable><module-name></replaceable> module</entry>
- </row>
- <row>
- <entry>
- <command>cvs update</command> or <command>cvs up</command>
- </entry>
- <entry>Update your files with the latest files from the CVS server</entry>
- </row>
- <row>
- <entry>
- <command>cvs add <replaceable><filename></replaceable>
- </command>
- </entry>
- <entry>Add a new file "filename" to the CVS server</entry>
- </row>
- <row>
- <entry>
- <command>cvs commit -m "My message"
- <replaceable><filename></replaceable>
- </command>
- </entry>
- <entry>Update file <replaceable><filename></replaceable> with the
+ </row>
+ <row>
+ <entry><command>cvs update</command> or <command>cvs up</command>
+ </entry>
+ <entry>Update your files with the latest files from the CVS server</entry>
+ </row>
+ <row>
+ <entry><command>cvs add <replaceable><filename></replaceable></command>
+ </entry>
+ <entry>Add a new file "filename" to the CVS server</entry>
+ </row>
+ <row>
+ <entry><command>cvs commit -m "My message"
+ <replaceable><filename></replaceable></command>
+ </entry>
+ <entry>Update file <replaceable><filename></replaceable> with the
latest copy from your computer</entry>
- </row>
- <row>
- <entry>
- <command>cvs log <replaceable><filename></replaceable>
- </command>
- </entry>
- <entry>View the commit messages for the file <replaceable><filename></replaceable>
- </entry>
- </row>
- <row>
- <entry>
- <command>cvs status <replaceable><filename></replaceable>
- </command>
- </entry>
- <entry>View status of the file, such as <computeroutput>Locally
+ </row>
+ <row>
+ <entry><command>cvs log <replaceable><filename></replaceable></command>
+ </entry>
+ <entry>View the commit messages for the file <replaceable><filename></replaceable>
+ </entry>
+ </row>
+ <row>
+ <entry><command>cvs status <replaceable><filename></replaceable></command>
+ </entry>
+ <entry>View status of the file, such as <computeroutput>Locally
Modified</computeroutput>
- </entry>
- </row>
- <row>
- <entry>
- <command>cvs status -v <replaceable><filename></replaceable>
- </command>
- </entry>
- <entry>View existing tags and branches for file</entry>
- </row>
- <row>
- <entry>
- <command>cvs diff <replaceable><filename></replaceable>
- </command>
- </entry>
- <entry>Show diff of the working copy of the file and the latest
+ </entry>
+ </row>
+ <row>
+ <entry><command>cvs status -v <replaceable><filename></replaceable></command>
+ </entry>
+ <entry>View existing tags and branches for file</entry>
+ </row>
+ <row>
+ <entry><command>cvs diff <replaceable><filename></replaceable></command>
+ </entry>
+ <entry>Show diff of the working copy of the file and the latest
version of the file for the branch</entry>
- </row>
- <row>
- <entry>
- <command>cvs diff -r1.1 -r1.2 <replaceable><filename></replaceable>
- </command>
- </entry>
- <entry>Show diff of version 1.1 and 1.2 for file</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <para>
- For more information, read the CVS manual available on your system at <filename>/usr/share/doc/cvs-<replaceable><version-number></replaceable>/cvs.ps</filename> (the CVS version might vary) and visit the CVS webpage available at <ulink url="http://www.cvshome.org/">http://www.cvshome.org/</ulink>.
+ </row>
+ <row>
+ <entry><command>cvs diff -r1.1 -r1.2 <replaceable><filename></replaceable></command>
+ </entry>
+ <entry>Show diff of version 1.1 and 1.2 for file</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>
+ For more information, read the CVS manual available on your
+ system at
+ <filename>/usr/share/doc/cvs-<replaceable><version-number></replaceable>/cvs.ps</filename>
+ (the CVS version might vary) and visit the CVS webpage available
+ at
+ <ulink url="http://www.cvshome.org/">http://www.cvshome.org/</ulink>.
</para>
-
- <tip>
- <title>Tip</title>
- <para>
- Since <application>CVS</application> is using <application>ssh</application> to connect to the <application>CVS</application> server, you will be prompted your password before performing your <application>CVS</application> request.
- If you want to configure your machine so that you do not have to enter a password, refer to the
- <ulink url="http://redhat.com/docs/manuals/linux/RHL-9-Manual/custom-guide/s1-openssh..."><citetitle>&RH; Linux 9 Customization Guide</citetitle>
- </ulink>
- for details about using
- <command>ssh-agent</command>.
- </para>
- </tip>
-
- </section>
-
+ <tip>
+ <title>Tip</title>
+ <para>
+ Since <application>CVS</application> is using
+ <application>ssh</application> to connect to the
+ <application>CVS</application> server, you will be prompted
+ your password before performing your
+ <application>CVS</application> request. If you want to
+ configure your machine so that you do not have to enter a
+ password, refer to the
+ <ulink url="http://redhat.com/docs/manuals/linux/RHL-9-Manual/custom-guide/s1-openssh..."><citetitle>&RH;
+ Linux 9 Customization Guide</citetitle> </ulink> for details
+ about using <command>ssh-agent</command>.
+ </para>
+ </tip>
</section>
-
- </chapter>
+ </section>
+</chapter>
18 years, 11 months
- 1
- 0
release-notes/FC4 kernel.xml,1.10,1.11
by fedora-docs-commits＠redhat.com
Author: kwade
Update of /cvs/docs/release-notes/FC4
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv27765
Modified Files:
kernel.xml
Log Message:
Small edits for clarity. I notice that tidy-bowl has not been run on this before check-in, you might want to do that manually, there was a lot of whitespace diff because of non-standard indenting in the last check-in.
Index: kernel.xml
===================================================================
RCS file: /cvs/docs/release-notes/FC4/kernel.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- kernel.xml 19 Jul 2005 03:56:19 -0000 1.10
+++ kernel.xml 19 Jul 2005 04:24:07 -0000 1.11
@@ -225,10 +225,12 @@
This is the value the <command>uname -r</command> command displays.
The kernel name is defined by the first four lines of the kernel <filename>Makefile</filename>.
To protect the innocent, the <filename>Makefile</filename> has been changed to generate a kernel with a different name from that of the running kernel.
- Before a module will be accepted by the running kernel, that module must have been compiled for a kernel with the correct name.
+ Before a module can be accepted by the running kernel, that
+ module must have been compiled for a kernel with the correct
+ name. To do this, you must edit the kernel <filename>Makefile</filename>
</para>
<para>
- Assume that <command>uname -r</command> returns the string <systemitem class="osname">2.6.11-1.234_FC4</systemitem> and correct the kernel name by editing the kernel <filename>Makefile</filename>, changing the <systemitem class="macro">EXTRAVERSION</systemitem> definition from this:
+ For example, if the <command>uname -r</command> returns the string <systemitem class="osname">2.6.11-1.234_FC4</systemitem>, change the <systemitem class="macro">EXTRAVERSION</systemitem> definition from this:
</para>
<screen width="60">EXTRAVERSION = -prep</screen>
<para>to this:</para>
18 years, 11 months
- 1
- 0
release-notes/FC4 kernel.xml,1.9,1.10
by fedora-docs-commits＠redhat.com
Author: jtr
Update of /cvs/docs/release-notes/FC4
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv26603
Modified Files:
kernel.xml
Log Message:
Added instructions to set the kernel Makefile variable EXTRAVERSION to
match the running kernel.
Index: kernel.xml
===================================================================
RCS file: /cvs/docs/release-notes/FC4/kernel.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- kernel.xml 22 Jun 2005 18:43:07 -0000 1.9
+++ kernel.xml 19 Jul 2005 03:56:19 -0000 1.10
@@ -23,7 +23,7 @@
features. For this reason, the &FC; kernel may not be
line-for-line equivalent to the so-called vanilla kernel from the
<ulink
- url="http://www.kernel.org"><filename>kernel.org</filename></ulink>
+ url="http://www.kernel.org"><filename>kernel.org</filename></ulink>
web site.
</para>
<para>
@@ -42,12 +42,12 @@
<listitem>
<para>
Native kernel, in both uniprocessor and <abbrev>SMP</abbrev>
- varieties.
+ varieties.
</para>
<para>
Configured sources are available in the
- <filename>kernel-devel-<replaceable><version></replaceable>.<replaceable><arch></replaceable>.rpm</filename>
- package.
+ <filename>kernel-devel-<replaceable><version></replaceable>.<replaceable><arch></replaceable>.rpm</filename>
+ package.
</para>
</listitem>
<listitem>
@@ -56,19 +56,19 @@
</para>
<para>
Configured sources are available in the
- <filename>kernel-xen0-devel-<replaceable><version></replaceable>.<replaceable><arch></replaceable>.rpm</filename>
- package.
+ <filename>kernel-xen0-devel-<replaceable><version></replaceable>.<replaceable><arch></replaceable>.rpm</filename>
+ package.
</para>
</listitem>
</itemizedlist>
<para>
Sources for both kernel flavors may be installed at the same time.
The files will be installed into the
- <filename>/usr/src/kernels/<replaceable><version></replaceable>[-xen0]-<replaceable><arch></replaceable>/</filename>
+ <filename>/usr/src/kernels/<replaceable><version></replaceable>[-xen0]-<replaceable><arch></replaceable>/</filename>
tree. Use the command:
</para>
<screen width="56">
-<command>rpm <parameter class="option">-Uvh</parameter> <filename>kernel-devel[-xen0]-<replaceable><version></replaceable>.<replaceable><arch></replaceable>.rpm</filename></command>
+<command>rpm <parameter class="option">-Uvh</parameter> <filename>kernel-devel[-xen0]-<replaceable><version></replaceable>.<replaceable><arch></replaceable>.rpm</filename></command>
</screen>
<para>
as appropriate.
@@ -77,11 +77,11 @@
<title>Following Generic Textbooks</title>
<para>
Many of the tutorials, examples, and textbooks about Linux
- kernel development assume the kernel sources are installed under
- the <filename>/usr/src/linux</filename> directory. If you make a
- symbolic link, as shown below, you should be able to use those
- learning materials with the &FC; packages. Install the
- appropriate kernel sources, as shown earlier, and then:
+ kernel development assume the kernel sources are installed under
+ the <filename>/usr/src/linux</filename> directory. If you make a
+ symbolic link, as shown below, you should be able to use those
+ learning materials with the &FC; packages. Install the
+ appropriate kernel sources, as shown earlier, and then:
</para>
<screen width="56">
<command>ln <parameter class="option">-s</parameter> <filename>/usr/src/kernels/kernel-<replaceable><all-the-rest></replaceable></filename> <filename>/usr/src/linux</filename></command>
@@ -112,7 +112,7 @@
<filename>kernel-source</filename> package provided by older
versions. Instead, configured sources are available as described
in <xref
- linkend="sn-kernel-flavors"/>. Users that require access to &FC;
+ linkend="sn-kernel-flavors"/>. Users that require access to &FC;
original kernel sources can find them in the
<filename>kernel</filename> <filename>.src.rpm</filename> package.
To create an exploded source tree from this file, perform the
@@ -121,12 +121,12 @@
<important>
<title>These Instructions Refer to the Currently-running Kernel!</title>
<para>
- To simplify the following directions, we have assumed that you
- want to configure the kernel sources to match your
- currently-running kernel. In the steps below, you must
- understand that the phrase
- <replaceable><version></replaceable> refers to the kernel
- version shown by this command:
+ To simplify the following directions, we have assumed that you
+ want to configure the kernel sources to match your
+ currently-running kernel. In the steps below, you must
+ understand that the phrase
+ <replaceable><version></replaceable> refers to the kernel
+ version shown by this command:
</para>
<screen width="56">
<command>uname <parameter class="option">-r</parameter></command>
@@ -136,15 +136,15 @@
<step>
<para>
Obtain the
- <filename>kernel-<replaceable><version></replaceable>.src.rpm</filename>
- file from one of the following sources:
+ <filename>kernel-<replaceable><version></replaceable>.src.rpm</filename>
+ file from one of the following sources:
</para>
<itemizedlist>
<listitem>
<para>
- The <filename>SRPMS</filename> directory on the
- appropriate <wordasword>SRPMS</wordasword>
- <abbrev>CD</abbrev> <filename>iso</filename> image.
+ The <filename>SRPMS</filename> directory on the
+ appropriate <wordasword>SRPMS</wordasword>
+ <abbrev>CD</abbrev> <filename>iso</filename> image.
</para>
</listitem>
<listitem>
@@ -165,16 +165,16 @@
<step>
<para>
Install
- <filename>kernel-<replaceable><version></replaceable>.src.rpm</filename>
- using the command:
+ <filename>kernel-<replaceable><version></replaceable>.src.rpm</filename>
+ using the command:
</para>
<screen width="56">
<command>rpm <parameter class="option">-Uvh</parameter> <filename>kernel-<replaceable><version></replaceable>.src.rpm</filename></command>
</screen>
<para>
This writes the <abbrev>RPM</abbrev> contents into
- <filename>/usr/src/redhat/SOURCES</filename> and
- <filename>/usr/src/redhat/SPECS</filename>.
+ <filename>/usr/src/redhat/SOURCES</filename> and
+ <filename>/usr/src/redhat/SPECS</filename>.
</para>
</step>
<step>
@@ -187,12 +187,12 @@
</screen>
<para>
The kernel source tree will be located in the
- <filename>/usr/src/redhat/BUILD/kernel-</filename><replaceable><version></replaceable>
- directory. It is common practice to move the resulting
- <filename>linux-</filename><replaceable><version></replaceable>
- directory to the <filename>/usr/src</filename> tree; while not
- strictly necessary, we suggest that you do this to match the
- generally-available documentation.
+ <filename>/usr/src/redhat/BUILD/kernel-</filename><replaceable><version></replaceable>
+ directory. It is common practice to move the resulting
+ <filename>linux-</filename><replaceable><version></replaceable>
+ directory to the <filename>/usr/src</filename> tree; while not
+ strictly necessary, we suggest that you do this to match the
+ generally-available documentation.
</para>
<screen width="56">
<command>cd <filename>/usr/src/redhat/BUILD/kernel-<replaceable><version></replaceable></filename> <filename>/usr/src/</filename></command>
@@ -205,16 +205,37 @@
<step>
<para>
The configurations for the specific kernels shipped in
- &DISTRO; &DISTROVER; are in the <filename>configs/</filename>
- directory. For example, the i686 SMP configuration file is
- named
- <filename>configs/kernel-<replaceable><version></replaceable>-i686-smp.config</filename>.
- Issue the following command to place the desired configuration
- file in the proper place for building:
+ &DISTRO; &DISTROVER; are in the <filename>configs/</filename>
+ directory. For example, the i686 SMP configuration file is
+ named
+ <filename>configs/kernel-<replaceable><version></replaceable>-i686-smp.config</filename>.
+ Issue the following command to place the desired configuration
+ file in the proper place for building:
</para>
<screen width="56">
<command>cp <filename>configs/<replaceable><desired-config-file></replaceable></filename> <filename>.config</filename></command>
</screen>
+ <para>
+ You can also find the <filename>.config</filename> file that matches your current kernel configuration in the <filename>/lib/modules/</filename><replaceable><version></replaceable><filename>/build/.config</filename> file.
+ </para>
+ </step>
+ <step>
+ <para>
+ Every kernel gets a name based on its version number.
+ This is the value the <command>uname -r</command> command displays.
+ The kernel name is defined by the first four lines of the kernel <filename>Makefile</filename>.
+ To protect the innocent, the <filename>Makefile</filename> has been changed to generate a kernel with a different name from that of the running kernel.
+ Before a module will be accepted by the running kernel, that module must have been compiled for a kernel with the correct name.
+ </para>
+ <para>
+ Assume that <command>uname -r</command> returns the string <systemitem class="osname">2.6.11-1.234_FC4</systemitem> and correct the kernel name by editing the kernel <filename>Makefile</filename>, changing the <systemitem class="macro">EXTRAVERSION</systemitem> definition from this:
+ </para>
+ <screen width="60">EXTRAVERSION = -prep</screen>
+ <para>to this:</para>
+ <screen width="60">EXTRAVERSION = -1.234_FC4</screen>
+ <para>
+ that is, substitude everything from the final dash onward.
+ </para>
</step>
<step>
<para>
@@ -263,13 +284,13 @@
utilities, such as management daemons. Consequently, to remove
such a kernel, perhaps after an update, you
<emphasis>cannot</emphasis> simply use the <command>rpm -e
- kernel-<replaceable><version></replaceable></command>
+ kernel-<replaceable><version></replaceable></command>
command as in earlier distributions because these userspace
packages depend on the kernel package. You may either list both
the kernel package and its userspace dependant packages on the
<command>rpm -e</command> command, or you may wish to use the
<command>yum remove
- kernel-<replaceable><version></replaceable></command>
+ kernel-<replaceable><version></replaceable></command>
command instead since <command>yum</command> automatically removes
dependant packages if necesssary.
</para>
18 years, 11 months
- 1
- 0
yum-software-management yum-software-management-en.xml,1.13,1.14
by fedora-docs-commits＠redhat.com
Author: elliss
Update of /cvs/docs/yum-software-management
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv25117
Modified Files:
yum-software-management-en.xml
Log Message:
More style fixes.
Index: yum-software-management-en.xml
===================================================================
RCS file: /cvs/docs/yum-software-management/yum-software-management-en.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- yum-software-management-en.xml 18 Jul 2005 21:39:27 -0000 1.13
+++ yum-software-management-en.xml 19 Jul 2005 02:36:04 -0000 1.14
@@ -1,10 +1,10 @@
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+ <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!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-18)"> <!-- change version of manual and date here -->
+<!ENTITY BOOKID "yum-software-management-0.5.0 (2005-07-19)"> <!-- 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-18</date>
+ <date>2005-07-19</date>
<authorinitials>StuartEllis</authorinitials>
<revdescription>
<para>
@@ -99,7 +99,9 @@
<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>. The &FED; package group
+ <filename>MySQL Database</filename> is used for the package
+ group examples.
</para>
<important>
@@ -108,7 +110,7 @@
<para>
You do not need to log in with the
<systemitem class="username">root</systemitem> account in
- order to manage your &FC; system. All of the commands shown in
+ order to manage your &FED; system. All of the commands shown in
this tutorial that require
<systemitem class="username">root</systemitem> access will
prompt you for the
@@ -261,6 +263,17 @@
these groups, or provide their packages as additional groups.
</para>
<!-- SE: Some repositories use groups and some don't: I've tried to put this nicely. -->
+<!-- SE: Using the admonition for this is not optimal, it just doesn't fit anywhere else. -->
+ <note>
+ <title>Available Package Groups</title>
+
+ <para>
+ To view a list of all of the available package groups for your
+ &FED; system, run the command <command>yum
+ <option>grouplist</option></command>.
+ </para>
+ </note>
+
<para>
Using repositories ensures that you always receive the current
version of the software. If several versions of the same package
@@ -276,6 +289,18 @@
find or install newer versions. You must keep that product
updated yourself.
</para>
+
+ <note>
+ <title>Manual Package Installation</title>
+
+ <para>
+ The <command>yum</command> commands shown in this document use
+ repositories as package sources. Refer to
+ <xref linkend="sn-yum-installing-frompackage"/> for details of
+ using <command>yum</command> to manually install software from
+ a package file.
+ </para>
+ </note>
</section>
<section id="sn-about-dependencies">
@@ -711,7 +736,7 @@
</section>
<section id="sn-searching-packages">
- <title>Searching with <command>yum</command></title>
+ <title>Searching for Packages with <command>yum</command></title>
<indexterm>
<primary>packages, locating</primary>
</indexterm>
@@ -790,7 +815,7 @@
<para>
To search for all packages that include files called
- <filename>libneon</filename> you type:
+ <filename>libneon</filename>, type:
</para>
<screen>
<userinput>yum provides <replaceable>libneon</replaceable></userinput>
@@ -866,14 +891,14 @@
<primary>automatic updating</primary>
</indexterm>
<para>
- If your system is permanently connected to the network then
- updates can be performed at any time. The
- <filename>yum</filename> package includes scripts that can
- automatically carry out full updates every day.
+ If your &FED; system is permanently connected to the network
+ then updates may be performed at any time. The
+ <filename>yum</filename> package includes scripts to
+ automatically carry out full system updates every day.
</para>
<para>
- To activate automatic daily updating, type this line:
+ To activate automatic daily updating, enter this command:
</para>
<screen>
<userinput>su -c '/sbin/chkconfig --level 345 yum on; /sbin/service yum start'</userinput>
@@ -921,7 +946,7 @@
<title>&FEX; Repositories for Previous Versions of &FC;</title>
<para>
- You must manually configure &FC; 3 systems to use &FEX;, using
+ You must manually configure &FED; 3 systems to use &FEX;, using
the instructions at:
<ulink url="http://fedora.redhat.com/projects/extras/">http://fedora.redhat.com/projects/extras/</ulink>.
Refer to this Website for additional packages for &FC; 1 and
@@ -1025,16 +1050,6 @@
<screen>
<userinput>su -c 'rpm --import <replaceable>http://www.therepository.com/GPG-PUB-KEY.asc</replaceable>'</userinput>
</screen>
- <note>
- <title>Public Keys and <application>up2date</application></title>
-
- <para>
- The <application>up2date</application> utility automatically
- uses the public key for &FED; packages. It does not add the
- public key to the keyring that is used by both
- <command>yum</command> and the <command>rpm</command> utility.
- </para>
- </note>
</section>
<section id="sn-compat-repositories">
@@ -1192,8 +1207,8 @@
<userinput>su -c 'yum clean packages'</userinput>
</screen>
<para>
- In both cases, enter the
- <systemitem class="username">root</systemitem> password when
+ In both cases, enter the password for the
+ <systemitem class="username">root</systemitem> account when
prompted.
</para>
</section>
18 years, 11 months
- 1
- 0
securing-filesystems/images - New directory
by fedora-docs-commits＠redhat.com
Author: trjones
Update of /cvs/docs/securing-filesystems/images
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv19939/images
Log Message:
Directory /cvs/docs/securing-filesystems/images added to the repository
18 years, 11 months
- 1
- 0
securing-filesystems - Imported sources
by fedora-docs-commits＠redhat.com
Author: trjones
Update of /cvs/docs/securing-filesystems
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv19891
Log Message:
Securing Filesystems Documentation
Status:
Vendor Tag: trjones
Release Tags: devel
No conflicts created by this import
18 years, 11 months
- 1
- 0
yum-software-management yum-software-management-en.xml,1.12,1.13
by fedora-docs-commits＠redhat.com
Author: elliss
Update of /cvs/docs/yum-software-management
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv18638
Modified Files:
yum-software-management-en.xml
Log Message:
- Removed repository creation/managment material, so that this document focuses on the use of yum itself.
- More style fixes.
- Moved localinstall and proxy server sections to the end, since they aren't standard usages.
Index: yum-software-management-en.xml
===================================================================
RCS file: /cvs/docs/yum-software-management/yum-software-management-en.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- yum-software-management-en.xml 18 Jul 2005 19:25:35 -0000 1.12
+++ yum-software-management-en.xml 18 Jul 2005 21:39:27 -0000 1.13
@@ -91,14 +91,6 @@
</para>
<para>
- 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;. The
<filename>tsclient</filename> package provides an application
@@ -265,9 +257,8 @@
<para>
You may also manage related packages as sets by using the
<firstterm>package groups</firstterm> provided by the &FED;
- repositories. Third-party repositories may add packages to these
- groups, or provide packages in additional groups where
- necessary.
+ repositories. Some third-party repositories add packages to
+ these groups, or provide their packages as additional groups.
</para>
<!-- SE: Some repositories use groups and some don't: I've tried to put this nicely. -->
<para>
@@ -909,110 +900,6 @@
</section>
</section>
- <section id="sn-yum-proxy-server">
- <title>Using <command>yum</command> with a Proxy Server</title>
- <indexterm>
- <primary>proxy server, with yum</primary>
- </indexterm>
- <indexterm>
- <primary>yum, using a proxy server</primary>
- </indexterm>
- <para>
- Repositories may be accessed through standard Web 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>
-
- <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 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 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>
- 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><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. 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>
-
<section id="sn-using-repositories">
<title>Using Other Software Repositories</title>
<indexterm>
@@ -1025,9 +912,9 @@
<primary>searching for repositories</primary>
</indexterm>
<para>
- &FC; automatically uses the &FED; repositories. These include
- &FEX;, the default source of packages for software that is not
- included with &FC;.
+ &FED; systems automatically use the &FP; repositories. These
+ include &FEX;, the default source of packages for software that is
+ not included with &FC;.
</para>
<note>
@@ -1044,8 +931,8 @@
</note>
<para>
- If the &FED; project does not provide packages for a specific
- piece of software, the manufacturer of the software may provide or
+ If the &FP; does not provide packages for a specific piece of
+ software, the manufacturer of the software may provide or
recommend a separate repository. Members of the community also
maintain repositories to provide packages for &FED; systems.
Third-party repositories provide information on their Websites.
@@ -1100,10 +987,10 @@
<title>Repositories and <application>up2date</application> Channels</title>
<para>
- On &FC; &FCLOCALVER; systems <command>yum</command>
+ On &FED; &FCLOCALVER; systems <command>yum</command>
repositories are automatically used as
<application>up2date</application> channels. Repositories must
- be separately configured as channels on &FC; 3 and earlier
+ be separately configured as channels on &FED; 3 and earlier
systems.
</para>
</note>
@@ -1143,7 +1030,7 @@
<para>
The <application>up2date</application> utility automatically
- uses the public key for &FC; packages. It does not add the
+ uses the public key for &FED; packages. It does not add the
public key to the keyring that is used by both
<command>yum</command> and the <command>rpm</command> utility.
</para>
@@ -1167,28 +1054,27 @@
<para>
Before attempting to use a repository, read the Website for
- information on package compatibility. . Repositories often
- provide packages that are specifically intended for use with
- packages that are supplied by other repositories. In some cases
- separate third-party repository providers may each offer
- different versions of the same software, preventing those
- repositories from being safely used together by your &FC;
- system.
+ information on package compatibility. Repositories often provide
+ packages that are specifically intended for use with packages
+ that are supplied by other repositories. In some cases separate
+ third-party repository providers may each offer different
+ versions of the same software, preventing those repositories
+ from being safely used together by your &FED; system.
</para>
<para>
- Packages that have been made for one version of &FC; are usually
- not compatible with other versions of &FC;. The Website of the
- provider should specifically state which versions of &FC; they
- support.
+ Packages that have been made for one version of &FED; are
+ usually not compatible with other versions of &FED;. The Website
+ of the provider should specifically state which versions of
+ &FED; they support.
</para>
<tip>
<title>Old Versions of <command>yum</command> and Current Repositories</title>
<para>
The data format for repository indexes changed with version
2.11 of <command>yum</command>. This was the version supplied
- with &FC; 3. Repository providers should specify the versions
- of &FC; that they support. To confirm that an unlabeled
+ with &FED; 3. Repository providers should specify the versions
+ of &FED; that they support. To confirm that an unlabeled
repository is compatible with current versions of
<command>yum</command>, check that it has a sub-directory
called <filename>repo-data/</filename>.
@@ -1197,56 +1083,6 @@
</section>
</section>
- <section id="sn-yum-installing-frompackage">
- <title>Manually Installing Software</title>
- <indexterm>
- <primary>installing software with yum (from a package)</primary>
- </indexterm>
- <indexterm>
- <primary>software, installing from a package</primary>
- </indexterm>
- <para>
- Use repositories and the standard <command>yum</command> commands
- to install new software, unless the software is only available as
- a package. In these cases, use the <option>localinstall</option>
- option to install the software from the package file without
- connecting to any repository.
- </para>
-
- <important>
- <title>Public Key is Required</title>
-
- <para>
- You must ensure that the public key for the package source has
- been imported before installing a package without a repository.
- Refer to <xref linkend="sn-authorizing-package-sources"/>
- </para>
- </important>
-
- <para>
- As an example, enter this command to install the package
- <filename>tsclient-0.132-4.i386.rpm</filename>:
- </para>
-<screen>
-<userinput>su -c 'yum localinstall <replaceable>tsclient-0.132-4.i386.rpm</replaceable>'</userinput>
-</screen>
- <para>
- Enter the <systemitem class="username">root</systemitem> password
- when prompted.
- </para>
-
- <important>
- <title>Dependencies Must Be Met</title>
-
- <para>
- You must ensure that all of the dependencies are already
- installed on your system, as <command>yum</command> cannot
- download additional packages to complete the installation in
- this mode.
- </para>
- </important>
- </section>
-
<section id="sn-yum-maintenance">
<title>Maintaining <command>yum</command></title>
@@ -1255,8 +1091,8 @@
maintenance. It is useful to disable or remove repository
definitions that are no longer required, as each repository that
is defined and enabled is checked for every operation. You may
- also wish to periodically remove files relating to unwanted
- packages, in order to save disk space.
+ also remove files relating to unwanted packages, in order to
+ recover disk space.
</para>
<section id="sn-removing-sources">
@@ -1363,371 +1199,161 @@
</section>
</section>
- <section id="sn-managing-repositories">
- <title>Managing <command>yum</command> Repositories</title>
-<!-- SE: This section is NOT finished. There is a case for not trying to cover repository administration at all in this document, in which this whole section can go to live in it's own tutorial. -->
+<!-- SE: The sections below are important, but only for certain situations - they do not represent the normal use of yum. Perhaps they should be explicitly marked as appendices ? -->
+
+ <section id="sn-yum-installing-frompackage">
+ <title>Manually Installing Software</title>
+ <indexterm>
+ <primary>installing software with yum (from a package)</primary>
+ </indexterm>
+ <indexterm>
+ <primary>software, installing from a package</primary>
+ </indexterm>
<para>
- You may wish to create your own software repositories, or maintain
- a copy of another repository.
+ Use repositories and the standard <command>yum</command> commands
+ to install new software, unless the software is only available as
+ a package. In these cases, use the <option>localinstall</option>
+ function to install the software from the package file. The
+ <option>localinstall</option> function does not connect to any
+ repository.
</para>
- <caution>
- <title>Old versions of yum use a different repository utility</title>
-
- <para>
- 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
- versions of <command>yum</command>.
- </para>
- </caution>
+ <important>
+ <title>Public Key is Required</title>
- <section id="sn-creating-repository">
- <title>Creating a New Repository</title>
- <indexterm>
- <primary>repositories, creating</primary>
- </indexterm>
<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>. 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.
+ You must ensure that the public key for the package source has
+ been imported before installing a package without a repository.
+ Refer to <xref linkend="sn-authorizing-package-sources"/>
</para>
+ </important>
- <note>
- <title>Creating Repositories Requires an Extra Package</title>
-
- <para>
- You must install the <filename>createrepo</filename> package
- from &FC; in order to be able to make repositories.
- </para>
- </note>
-<!-- SE: The instructions below won't work as is and need amending, since the example directory can only be accessed with root privileges by default. -->
- <para>
- To make a directory into a <command>yum</command> repository,
- carry the following tasks. These instructions assume that the
- repository is the directory
- <filename>/var/www/repository/</filename>, and that the package
- group index file is called <filename>groups.xml</filename>:
- <orderedlist>
- <listitem>
- <para>
- Copy the RPM packages that you are distributing into the
- directory.
- </para>
- </listitem>
- <listitem>
- <para>
- Create a groups file, as explained in
- <xref linkend="sn-writing-groupfiles"/>
- </para>
- </listitem>
- <listitem>
- <para>
- Open a terminal window.
- </para>
- </listitem>
- <listitem>
- <para>
- In the terminal window type: <userinput>createrepo
- <replaceable>/var/www/repository</replaceable></userinput>.
- </para>
- </listitem>
- <listitem>
- <para>
- In the terminal window type: <userinput>createrepo -g
- <replaceable>/var/www/repository/groups.xml</replaceable>
- <replaceable>/var/www/repository/</replaceable></userinput>.
- </para>
- </listitem>
- <listitem>
- <para>
- In the terminal window type: <userinput>chmod a+x
- <replaceable>/var/www/repository/repodata/</replaceable></userinput>.
- </para>
- </listitem>
- <listitem>
- <para>
- Ensure that the directory is available with your chosen
- network protocols (HTTP, FTP, or NFS).
- </para>
- </listitem>
- </orderedlist>
- </para>
+ <para>
+ As an example, enter this command to install the package
+ <filename>tsclient-0.132-4.i386.rpm</filename>:
+ </para>
+<screen>
+<userinput>su -c 'yum localinstall <replaceable>tsclient-0.132-4.i386.rpm</replaceable>'</userinput>
+</screen>
+ <para>
+ Enter the <systemitem class="username">root</systemitem> password
+ when prompted.
+ </para>
- <para>
- The repository is now ready for use.
- </para>
+ <important>
+ <title>Dependencies Must Be Met</title>
<para>
- Create a definition file for this new repository. If you are
- distributing packages that you have created yourself then you
- also need to make the GPG public key for your signature
- available, so that others are able to verify the packages. The
- simplest way to make these files available is to put the public
- key and repository definition files on the same Website or FTP
- site as the repository.
+ You must ensure that all of the dependencies are already
+ installed on your system, as <command>yum</command> cannot
+ download additional packages to complete the installation when
+ performing a <option>localinstall</option> operation.
</para>
+ </important>
+ </section>
- <para>
- Creating a definition file is described in
- <xref
- linkend="sn-writing-repodefs"/>. Packaging building is
- beyond the scope of this document.
- </para>
- <tip>
- <title>Repositories and Management Utilities</title>
- <para>
- The <command>createrepo</command> utility makes no changes to
- the directory other than adding a
- <filename>repo-data/</filename> sub-directory. Adding index
- files for other utilities does not interfere with
- <command>yum</command>.
- </para>
- </tip>
- </section>
+ <section id="sn-yum-proxy-server">
+ <title>Using <command>yum</command> with a Proxy Server</title>
+ <indexterm>
+ <primary>proxy server, with yum</primary>
+ </indexterm>
+ <indexterm>
+ <primary>yum, using a proxy server</primary>
+ </indexterm>
+ <para>
+ Repositories may be accessed through standard Web 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>
- <section id="sn-writing-groupfiles">
- <title>Package Group Index Files</title>
-<!-- SE: This section is NOT finished. -->
- <indexterm>
- <primary>package group index files, creating</primary>
- </indexterm>
- <indexterm>
- <primary>package group index files, editing</primary>
- </indexterm>
- <para>
- Create and edit package group files with a text editor.
- Definition files are XML with a standard format:
- </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>
- <example id="yum-groupsfile-format">
- <title>Format of <command>yum</command> Group Index Files</title>
+ <example id="config-file-httpproxy">
+ <title>Configuration File Settings for Using A Proxy Server</title>
<programlisting>
- <![CDATA[
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE comps PUBLIC "-//Red Hat, Inc.//DTD Comps info//EN" "comps.dtd">
-<comps>
- <group>
- <id>group-id</id>
- <name>Group Name</name>
- <description>Descriptive Text.</description>
- <default>true</default> or <default>false</default>
- <uservisible>true</uservisible> or <uservisible>false</uservisible>
- <grouplist>
- <groupreq>group-name</groupreq>
- </grouplist>
- <packagelist>
- <packagereq type="default">package-name</packagereq> or <packagereq type="optional">package-name</packagereq>
- </packagelist>
- </group>
- <grouphierarchy>
- <category>
- <name>Category Name</name>
- <subcategories>
- <subcategory>Name of Member Group</subcategory>
- </subcategories>
- </category>
- </grouphierarchy>
-</comps>
- ]]>
- </programlisting>
- </example>
-
- <para>
- The <command>id</command> and <command>name</command> that
- identify each group must either match those of a &FED; package
- group, or be unique. If the group matches a &FED; package group
- then systems using the repository add the the listed packages to
- that group when carrying out <command>yum</command> operations.
- </para>
-<!-- SE: The explanations of the XML tags need completion. The only other documentation I've found so far that actually defines the "comps" XML format is three years old, and written for RH8. Joy ! -->
- <para>
- The example group file shown below defines the package groups
- <filename>Base</filename> and <filename>Site Custom Application
- Packages</filename>. The <filename>Base</filename> package group
- adds extra mandatory packages to the &FED; package group for the
- systems using the repository. <filename>Site Custom Application
- Packages</filename> provides three packages.
- </para>
+ <![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>
- <example id="yum-groupsfile-example">
- <title>Example <command>yum</command> Group Index File</title>
-<programlisting>
- <![CDATA[
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE comps PUBLIC "-//Red Hat, Inc.//DTD Comps info//EN" "comps.dtd">
-<comps>
- <group>
- <id>base</id>
- <name>Base</name>
- <description>Additional packages for the Fedora Base package group.</description>
- <default>true</default>
- <uservisible>true</uservisible>
- <packagelist>
- <packagereq type="default">my-customadminpackage</packagereq>
- <packagereq type="default">my-othercustomadminpackage</packagereq>
- </group>
- <group>
- <id>site-apps</id>
- <name>Site Custom Application Packages</name>
- <description>Custom group for the site-specific applications.</description>
- <default>false</default>
- <uservisible>true</uservisible>
- <grouplist>
- <groupreq>base</groupreq>
- </grouplist>
- <packagelist>
- <packagereq type="default">my-customapplication</packagereq>
- <packagereq type="optional">my-othercustomapplication</packagereq>
- <packagereq type="optional">my-optionalcustomapplication</packagereq>
- </group>
- <grouphierarchy>
- <category>
- <name>Site Custom Packages</name>
- <subcategories>
- <subcategory>Site Custom Application Packages</subcategory>
- </subcategories>
- </category>
- </grouphierarchy>
-</comps>
- ]]>
- </programlisting>
- </example>
- </section>
+ <note>
+ <title>Global Settings</title>
- <section id="sn-writing-repodefs">
- <title>Repository Definition Files</title>
- <indexterm>
- <primary>repository definition files, creating</primary>
- </indexterm>
- <indexterm>
- <primary>repository definition files, editing</primary>
- </indexterm>
<para>
- Create and edit repository definition files with a text editor.
- Definition files are plain-text with a standard format:
+ 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>
- <example id="yum-repo-format">
- <title>Format of <command>yum</command> Repository Definition Files</title>
-<programlisting>
- <![CDATA[
- [serverid]
- name=Some longer name and description for this repository
- baseurl=url://path/to/repository-copy-1/
- url://path/to/repository-copy-2/
- enable=(0 to disable this file, or 1 to enable it)
- gpgcheck=(0 to disable checking signatures of packages from this repository, or 1 to enable checking)
- gpgkey=url://path/to/gpg-key-file
- ]]>
- </programlisting>
- </example>
-
- <para>
- The <command>baseurl</command> must specify the complete URL for
- the <systemitem class="username">root</systemitem> directory of
- the repository, including the <command>http://</command>,
- <command>https://</command> or <command>ftp://</command> prefix.
- You may also specify a directory on your system, by using the
- prefix <command>file://</command> in the
- <command>baseurl</command>.
- </para>
- <tip>
- <title>Logging in to Protected Repositories</title>
- <para>
- To use a password-protected repository, include the correct
- username and password in the <command>baseurl</command>. For
- example,
- <wordasword>ftp://user:password@myrepository.com/$releasever/mypackages/</wordasword>.
- </para>
- </tip>
- <para>
- If possible, list more than one directory or server that holds a
- copy of the repository. This enables <command>yum</command> to
- use another repository if the first is unavailable. By default,
- <command>yum</command> randomly selects repositories from the
- <command>baseurl</command> list. To force <command>yum</command>
- to use them in sequence, add the option
- <command>failovermethod=priority</command>.
- </para>
+ <para>
+ 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>
- <para>
- Write the URL with variables, such as
- <command>$releasever</command>, rather than specifying fixed
- values for these attributes. Using variables enables the same
- definition to function when your system is upgraded to a later
- version, or if the configuration is copied to another machine.
- The available variables are listed on the <command>man</command>
- page for <filename>yum.conf</filename>.
- </para>
+ <example id="profile-script-httpproxy">
+ <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>
- The definition file shown below uses all of these features. In
- this example, copies of the repository are held in the directory
- <filename>/srv/software/&FED;/&FCVER;/mypackages/</filename> on
- the system itself, in the directory
- <filename>software/&FED;/&FCVER;/mypackages/</filename> on the
- Web server <wordasword>www.my-repository.com/</wordasword>, and
- in the directory
- <filename>pub/software/&FED;/&FCVER;/mypackages/</filename> on
- the FTP server
- <wordasword>server.another-repository.org</wordasword>. Here,
- <command>yum</command> will access the FTP server with the
- username <command>yum-user</command> and the password
- <command>qwerty</command>. The <command>failovermethod</command>
- ensures that <command>yum</command> checks the copy on the local
- system, before trying the servers in sequence.
- </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="yum-repo-multidir-example">
- <title>A <command>yum</command> Repository Definition File with Failover</title>
+ <example id="profile-script-httpproxy-withpassword">
+ <title>Profile Settings for a Secured Proxy Server</title>
<programlisting>
- <![CDATA[
- [MyPackages]
- name=Some packages for Fedora $releasever
- baseurl=file:///srv/software/fedora/$releasever/mypackages/
- http://www.my-repository.com/software/fedora/$releasever/mypackages/
- ftp://yum-user:qwerty@anotherserver.another-repository.org/pub/software/fedora/$releasever/mypackages/
- failovermethod=priority
- enable=1
- gpgcheck=1
- gpgkey=http://www.my-repository.com/software/fedora/keys/RPM-GPG-KEY.asc
- ]]>
- </programlisting>
- </example>
-
- <para>
- To use a list of servers, substitute
- <command>mirrorlist</command> for <command>baseurl</command>.
- </para>
+ <![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>
- <para>
- Set <command>gpgcheck=0</command> if it is necessary to disable
- signature checking for the packages provided by this repository.
- Avoid distributing or installing unsigned packages.
- </para>
- </section>
+ <note>
+ <title><command>http_proxy</command> Variable with Other Utilities</title>
- <section id="sn-updating-repository">
- <title>Updating a Repository</title>
- <indexterm>
- <primary>repositories, updating</primary>
- </indexterm>
<para>
- Whenever a package is added, or replaced with a different
- version, you must run <command>createrepo</command> again to
- update the index files. If you are mirroring an existing
- repository then add <command>createrepo</command> to your
- synchronization scripts, even though the original copy may have
- index files. This ensures that the indexes on your copy of the
- site are accurate.
+ The <command>http_proxy</command> variable is also used by
+ <command>curl</command> and 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>
- </section>
+ </note>
</section>
<index id="generated-index"></index>
18 years, 11 months
- 1
- 0
yum-software-management yum-software-management-en.xml,1.11,1.12
by fedora-docs-commits＠redhat.com
Author: elliss
Update of /cvs/docs/yum-software-management
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv15747
Modified Files:
yum-software-management-en.xml
Log Message:
Style fixes.
Index: yum-software-management-en.xml
===================================================================
RCS file: /cvs/docs/yum-software-management/yum-software-management-en.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- yum-software-management-en.xml 18 Jul 2005 00:07:57 -0000 1.11
+++ yum-software-management-en.xml 18 Jul 2005 19:25:35 -0000 1.12
@@ -158,33 +158,33 @@
<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>
+ <listitem>
+ <para>
+ <ulink url="http://linux.duke.edu/projects/yum/">http://linux.duke.edu/projects/yum/</ulink>
+ </para>
+ </listitem>
</varlistentry>
<varlistentry>
- <term>
+ <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>
+ <listitem>
+ <para>
+ <ulink url="https://lists.dulug.duke.edu/mailman/listinfo/yum/">https://lists.dulug.duke.edu/mailman/listinfo/yum/</ulink>
+ </para>
+ </listitem>
</varlistentry>
<varlistentry>
-<term>
+ <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>
+ <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>
@@ -265,7 +265,9 @@
<para>
You may also manage related packages as sets by using the
<firstterm>package groups</firstterm> provided by the &FED;
- repositories. Third-party repositories may add packages to these groups, or provide packages in additional groups where necessary.
+ repositories. Third-party repositories may add packages to these
+ groups, or provide packages in additional groups where
+ necessary.
</para>
<!-- SE: Some repositories use groups and some don't: I've tried to put this nicely. -->
<para>
@@ -331,11 +333,12 @@
<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.
+ the exact version or type. For example, use
+ <filename>name-version</filename> to specify the exact version
+ of the application. 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.
</para>
<para>
@@ -642,7 +645,7 @@
<title>New Software Versions Require Reloading</title>
<para>
- If a piece of software is use whilst it is updated then the
+ If a piece of software is in use whilst it is updated then the
old version remains active until the software is next loaded.
Services are reloaded by restarting the service. Kernel
updates take effect the next time that the system is booted.
@@ -725,10 +728,10 @@
<primary>searching for packages</primary>
</indexterm>
<para>
- You may use <command>yum</command> to find software that is
- available from the defined repositories, or is already installed
- on your system. Searches automatically include both installed and
- available packages.
+ Use the search features of <command>yum</command> to find software
+ that is available from the defined repositories, or is already
+ installed on your system. Searches automatically include both
+ installed and available packages.
</para>
<note>
@@ -775,6 +778,9 @@
<para>
If you do not know the name of the package, use either the
<option>search</option> or <option>provides</option> options.
+ </para>
+
+ <para>
<option>Search</option> checks the names, descriptions,
summaries and listed package maintainers of all of the available
packages to find those that match. For example, to search for
@@ -1160,14 +1166,14 @@
</para>
<para>
- You should always check the Website of the provider for
- compatibility information before attempting to use a repository.
- Repositories often provide packages that are specifically
- intended for use with packages that are supplied by other
- repositories. In some cases separate third-party repository
- providers may each offer different versions of the same
- software, preventing those repositories from being safely used
- together by your &FC; system.
+ Before attempting to use a repository, read the Website for
+ information on package compatibility. . Repositories often
+ provide packages that are specifically intended for use with
+ packages that are supplied by other repositories. In some cases
+ separate third-party repository providers may each offer
+ different versions of the same software, preventing those
+ repositories from being safely used together by your &FC;
+ system.
</para>
<para>
@@ -1291,12 +1297,15 @@
<primary>public keys, removing</primary>
</indexterm>
<para>
- If you will not be using any more packages from that source then
- you should also remove their public key from the
- <command>rpm</command> keyring. To remove a public key you first
- need to know the identification name used by
- <command>rpm</command>. You may view the details of all public
- keys with the command:
+ In addition, remove the public key for the package provider from
+ the <command>rpm</command> keyring, if you will not be using any
+ more packages from that source.
+ </para>
+
+ <para>
+ To remove a public key from the keyring you must know the
+ identification name used by <command>rpm</command>. Run this
+ command to view the details of the public keys on the keyring:
</para>
<screen>
<userinput>rpm -qi gpg-pubkey-*</userinput>
@@ -1397,9 +1406,7 @@
from &FC; in order to be able to make repositories.
</para>
</note>
-
<!-- SE: The instructions below won't work as is and need amending, since the example directory can only be accessed with root privileges by default. -->
-
<para>
To make a directory into a <command>yum</command> repository,
carry the following tasks. These instructions assume that the
@@ -1433,7 +1440,8 @@
<listitem>
<para>
In the terminal window type: <userinput>createrepo -g
- <replaceable>/var/www/repository/groups.xml</replaceable> <replaceable>/var/www/repository/</replaceable></userinput>.
+ <replaceable>/var/www/repository/groups.xml</replaceable>
+ <replaceable>/var/www/repository/</replaceable></userinput>.
</para>
</listitem>
<listitem>
@@ -1459,10 +1467,10 @@
Create a definition file for this new repository. If you are
distributing packages that you have created yourself then you
also need to make the GPG public key for your signature
- available, so that others can verify the packages. The simplest
- way to make these files available is to put the public key and
- repository definition files on the same Website or FTP site as
- the repository.
+ available, so that others are able to verify the packages. The
+ simplest way to make these files available is to put the public
+ key and repository definition files on the same Website or FTP
+ site as the repository.
</para>
<para>
@@ -1641,7 +1649,7 @@
<para>
If possible, list more than one directory or server that holds a
copy of the repository. This enables <command>yum</command> to
- use another repository if the first is unavailable. By default
+ use another repository if the first is unavailable. By default,
<command>yum</command> randomly selects repositories from the
<command>baseurl</command> list. To force <command>yum</command>
to use them in sequence, add the option
@@ -1649,13 +1657,13 @@
</para>
<para>
- It is also good practice to use variables like
- <command>$releasever</command> in the URL, rather than setting
- these to a specific value. The available variables are listed on
- the <command>man</command> page for
- <filename>yum.conf</filename>. Using variables enables the same
+ Write the URL with variables, such as
+ <command>$releasever</command>, rather than specifying fixed
+ values for these attributes. Using variables enables the same
definition to function when your system is upgraded to a later
version, or if the configuration is copied to another machine.
+ The available variables are listed on the <command>man</command>
+ page for <filename>yum.conf</filename>.
</para>
<para>
@@ -1672,8 +1680,8 @@
<command>yum</command> will access the FTP server with the
username <command>yum-user</command> and the password
<command>qwerty</command>. The <command>failovermethod</command>
- ensures that <command>yum</command> will check the copy on the
- local machine, before trying the servers in sequence.
+ ensures that <command>yum</command> checks the copy on the local
+ system, before trying the servers in sequence.
</para>
<example id="yum-repo-multidir-example">
@@ -1712,12 +1720,12 @@
</indexterm>
<para>
Whenever a package is added, or replaced with a different
- version, you must run <command>createrepo</command> again for
- the index files to be updated. If you are mirroring an existing
- repository then you may assume that the site administrator
- updates the indexes, but for safety you should add this to your
- synchronization scripts. The <command>createrepo</command>
- utility can be run as frequently as you wish.
+ version, you must run <command>createrepo</command> again to
+ update the index files. If you are mirroring an existing
+ repository then add <command>createrepo</command> to your
+ synchronization scripts, even though the original copy may have
+ index files. This ensures that the indexes on your copy of the
+ site are accurate.
</para>
</section>
</section>
18 years, 11 months
- 1
- 0