summaryrefslogtreecommitdiffstats
path: root/common
diff options
context:
space:
mode:
authorTommy Reynolds <Tommy.Reynolds@MegaCoder.com>2006-03-02 23:06:38 +0000
committerTommy Reynolds <Tommy.Reynolds@MegaCoder.com>2006-03-02 23:06:38 +0000
commit32e1656ffdc1d2a5023849275e41303739f7cd17 (patch)
treeb611b029b86fb94042a25cde0db67fabd11521ad /common
parent7ffecadfc52a941184f2860fb7b5cd250b1a4f01 (diff)
downloadfedora-doc-utils-32e1656ffdc1d2a5023849275e41303739f7cd17.tar.gz
fedora-doc-utils-32e1656ffdc1d2a5023849275e41303739f7cd17.tar.xz
fedora-doc-utils-32e1656ffdc1d2a5023849275e41303739f7cd17.zip
Replaced references to "-en.xml" to "-en_US.xml", including in the
<DOCTYPE> areas.
Diffstat (limited to 'common')
-rw-r--r--common/bugreporting-en_US.xml17
-rw-r--r--common/cvs-en_US.xml1014
-rw-r--r--common/deprecatednotice-en_US.xml29
-rw-r--r--common/draftnotice-en_US.xml8
-rw-r--r--common/fedora-entities-en_US.ent76
-rw-r--r--common/legacynotice-en_US.xml17
-rw-r--r--common/legalnotice-content-en_US.xml71
-rw-r--r--common/legalnotice-content-p1-en_US.xml16
-rw-r--r--common/legalnotice-content-p2-en_US.xml16
-rw-r--r--common/legalnotice-content-p3-en_US.xml15
-rw-r--r--common/legalnotice-content-p4-en_US.xml14
-rw-r--r--common/legalnotice-content-p5-en_US.xml14
-rw-r--r--common/legalnotice-content-p6-en_US.xml15
-rw-r--r--common/legalnotice-en_US.xml22
-rw-r--r--common/legalnotice-opl-en_US.xml240
-rw-r--r--common/legalnotice-relnotes-en_US.xml37
-rw-r--r--common/legalnotice-section-en_US.xml40
-rw-r--r--common/obsoletenotice-en_US.xml14
18 files changed, 1675 insertions, 0 deletions
diff --git a/common/bugreporting-en_US.xml b/common/bugreporting-en_US.xml
new file mode 100644
index 0000000..470f6b7
--- /dev/null
+++ b/common/bugreporting-en_US.xml
@@ -0,0 +1,17 @@
+<tip>
+ <title>Reporting Document Errors</title>
+
+ <para>
+ To report an error or omission in this document, file a bug report in &BZ;
+ at &BZ-URL;. When you file your bug, select "&BZ-PROD;" as the
+ <systemitem>Product</systemitem>, and select the title of this document as
+ the <systemitem>Component</systemitem>. The version of this document is
+ &DOCID;.
+ </para>
+
+ <para>
+ The maintainers of this document will automatically receive your bug report.
+ On behalf of the entire &FED; community, thank you for helping us make
+ improvements.
+ </para>
+</tip>
diff --git a/common/cvs-en_US.xml b/common/cvs-en_US.xml
new file mode 100644
index 0000000..4bf39a5
--- /dev/null
+++ b/common/cvs-en_US.xml
@@ -0,0 +1,1014 @@
+<!-- $Id: -->
+
+<!--
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+ <!ENTITY BOILERPLATE "This header makes editing XML easier" >
+ <!ENTITY FC "Fedora Core" >
+ <!ENTITY RH "Red Hat" >
+
+]>
+-->
+
+<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>
+ <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.
+ </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.
+ </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.
+ </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.
+ </para>
+
+ <para>
+ 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>
+ </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.
+ </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:
+ </para>
+<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.
+ </para>
+ </section>
+
+ <section id="sn-cvs-generate-keys">
+ <title>Generating SSH Keys</title>
+ <indexterm>
+ <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.
+ </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.
+ </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.
+ </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>
+ <application>CVS</application> account.
+ </para>
+ <orderedlist>
+ <indexterm>
+ <primary>OpenSSH</primary>
+ <secondary><command>ssh-keygen</command>
+ </secondary>
+ </indexterm>
+ <indexterm>
+ <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:
+ </para>
+<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.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ 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&gt;&gt;~/.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.
+ </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>
+<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.
+ </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>
+ </indexterm>
+ <indexterm>
+ <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.
+ </para>
+
+ <para>
+ 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"/>.
+ </para>
+
+ <para>
+ 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>
+<prompt>$ </prompt><command>cvs login</command>
+<prompt>$ </prompt><command>cvs checkout docs-common</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>
+ </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:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ <listitem>
+ <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>
+ </ulink> account, if you do not have one already.
+ <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>
+ </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.
+ </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:
+ </para>
+<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.
+ </para>
+ </section>
+ </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>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.
+ </para>
+
+ <para>
+ To checkout a module, use the following command:
+ </para>
+<screen><prompt>$ </prompt><command>cvs co</command> <replaceable>&lt;module-name&gt;</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.
+ </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>
+
+ <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>
+ To checkout a branch of a module, use the following command:
+ </para>
+<screen><prompt>$ </prompt><command>cvs co</command> <option>-d</option> <replaceable>&lt;directory&gt;</replaceable> <option>-r</option> <replaceable>&lt;branchname&gt;</replaceable> <replaceable>&lt;module-name&gt;</replaceable></screen>
+ <para>
+ A directory named <replaceable>&lt;directory&gt;</replaceable>
+ is created, and the files for the
+ <replaceable>&lt;branchname&gt;</replaceable> branch of the
+ <replaceable>&lt;module-name&gt;</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>
+<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>
+<screen><prompt>$ </prompt><command>cvs status</command> <option>-v</option> <replaceable>&lt;filename&gt;</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
+
+ Working revision: 1.47
+ Repository revision: 1.47 /cvs/docs/custom-guide/rhl-cg-en_US.sgml,v
+ Sticky Tag: (none)
+ Sticky Date: (none)
+ Sticky Options: (none)
+
+ Existing Tags:
+ 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>
+ </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:
+ </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>
+ </section>
+
+ <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>
+<screen><prompt>$ </prompt><command>cvs commit</command> <option>-m</option> &quot;<replaceable>some log message</replaceable>&quot; <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 &quot;some
+ log message&quot;</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>
+
+ <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>&lt;filename&gt;</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>
+
+ <para>
+ If you notice a file conflict, refer to
+ <xref linkend="sn-cvs-cvscommands-conflicts"></xref>.
+ </para>
+ </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:
+ </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:
+ </para>
+<screen><prompt>$ </prompt><command>cvs commit</command> <option>-m</option> &quot;<replaceable>some log message</replaceable>&quot; <replaceable>file-to-add</replaceable></screen>
+ </section>
+
+ <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 &quot;does the right thing&quot;.
+ </para>
+
+ <para>
+ When a copy of a file is checked out of the repository,
+ <application>cvs</application> scans it for special keywords,
+ such as &quot;<computeroutput>$id:$</computeroutput>&quot; 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>
+ 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>
+
+ <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>&quot;<replaceable>some log message</replaceable>&quot; <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
+ <ulink url="mailto:cvsdocs-administrator@fedora.redhat.com"><filename>cvsdocs-administrator@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:
+ </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>
+ </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 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>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>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>
+
+ <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>
+
+ <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>
+
+ <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>
+<computeroutput>
+RCS file: /cvs/docs/module-name/filename.sgml,v
+retrieving revision 1.12
+retrieving revision 1.13
+Merging differences between 1.12 and 1.13 into filename.sgml
+rcsmerge: warning: conflicts during merge
+cvs server: conflicts found in filename.sgml
+C filename.sgml
+</computeroutput>
+</screen>
+ <para>
+ To resolve the conflict, open the file, search for
+ <computeroutput>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</computeroutput>
+ and determine which version of the content is correct. For
+ example:
+ </para>
+<screen>
+<computeroutput>
+&lt;para&gt;
+Some sentence.
+&lt;&lt;&lt;&lt;&lt;&lt;&lt; filename.sgml
+A sentence that was changed in the working copy.
+=======
+A same sentence that was changed differently and committed.
+&gt;&gt;&gt;&gt;&gt;&gt;&gt; 1.13
+&lt;/para&gt;
+</computeroutput>
+</screen>
+ <para>
+ The content between the
+ <computeroutput>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</computeroutput>,
+ and the <computeroutput>=======</computeroutput> is the content
+ from your working copy. The content between the
+ <computeroutput>=======</computeroutput> and the
+ <computeroutput>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</computeroutput> is
+ the content from the server.
+ </para>
+
+ <para>
+ Resolve the conflict by editing your copy, and commit the file.
+ </para>
+ </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.
+ </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>&lt;module-name&gt;</replaceable></command>
+ or <command>cvs co <replaceable>&lt;module-name&gt;</replaceable></command>
+ </entry>
+ <entry>Creates a directory called
+ <replaceable>&lt;module-name&gt;</replaceable> with the contents of the
+ module in the directory</entry>
+ </row>
+ <row>
+ <entry><command>cvs co -d <replaceable>&lt;directory&gt;</replaceable> -r <replaceable>&lt;branchname&gt;</replaceable><replaceable>&lt;module-name&gt;</replaceable></command>
+ </entry>
+ <entry>Creates the <replaceable>&lt;directory&gt;</replaceable> directory
+ with the contents of the <replaceable>&lt;branchname&gt;</replaceable>
+ branch of the <replaceable>&lt;module-name&gt;</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>&lt;filename&gt;</replaceable></command>
+ </entry>
+ <entry>Add a new file "filename" to the CVS server</entry>
+ </row>
+ <row>
+ <entry><command>cvs commit -m "My message"
+ <replaceable>&lt;filename&gt;</replaceable></command>
+ </entry>
+ <entry>Update file <replaceable>&lt;filename&gt;</replaceable> with the
+ latest copy from your computer</entry>
+ </row>
+ <row>
+ <entry><command>cvs log <replaceable>&lt;filename&gt;</replaceable></command>
+ </entry>
+ <entry>View the commit messages for the file <replaceable>&lt;filename&gt;</replaceable>
+ </entry>
+ </row>
+ <row>
+ <entry><command>cvs status <replaceable>&lt;filename&gt;</replaceable></command>
+ </entry>
+ <entry>View status of the file, such as <computeroutput>Locally
+ Modified</computeroutput>
+ </entry>
+ </row>
+ <row>
+ <entry><command>cvs status -v <replaceable>&lt;filename&gt;</replaceable></command>
+ </entry>
+ <entry>View existing tags and branches for file</entry>
+ </row>
+ <row>
+ <entry><command>cvs diff <replaceable>&lt;filename&gt;</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>&lt;filename&gt;</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>&lt;version-number&gt;</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-client-config.html"><citetitle>&RH;
+ Linux 9 Customization Guide</citetitle> </ulink> for details
+ about using <command>ssh-agent</command>.
+ </para>
+ </tip>
+ </section>
+ </section>
+</chapter>
diff --git a/common/deprecatednotice-en_US.xml b/common/deprecatednotice-en_US.xml
new file mode 100644
index 0000000..0eeca61
--- /dev/null
+++ b/common/deprecatednotice-en_US.xml
@@ -0,0 +1,29 @@
+<note>
+ <title>DEPRECATED DOCUMENT</title>
+ <para>
+ This document is no longer supported by the &FDP;. One or more of the
+ following situations may have occurred:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Changes in Fedora may have made this document inaccurate.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A more relevant document may be available.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ This document may have been subsumed in a different document.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ Refer to the revision history for more information.
+ </para>
+</note>
diff --git a/common/draftnotice-en_US.xml b/common/draftnotice-en_US.xml
new file mode 100644
index 0000000..30a39a8
--- /dev/null
+++ b/common/draftnotice-en_US.xml
@@ -0,0 +1,8 @@
+<note>
+ <title>DRAFT</title>
+ <para>
+ This is a draft version of the document. It is subject to change at any time
+ and may not have been tested for technical accuracy yet. If you find any
+ errors, please report them via Bugzilla in bug &BUG-NUM;.
+ </para>
+</note>
diff --git a/common/fedora-entities-en_US.ent b/common/fedora-entities-en_US.ent
new file mode 100644
index 0000000..662f98f
--- /dev/null
+++ b/common/fedora-entities-en_US.ent
@@ -0,0 +1,76 @@
+<!-- $Id: fedora-entities-en_US.ent,v 1.1 2006/03/02 23:06:38 jtr Exp $ -->
+
+<!--
+ These common entities are useful shorthand
+ terms and names, which may be subject to
+ change at anytime. This is an important
+ value the entity provides, a single location
+ to update terms and common names.
+-->
+
+<!-- *************** Fedora common entities *************** -->
+<!ENTITY FED "Fedora"> <!-- Generic root term -->
+<!ENTITY CORE "Core"> <!-- Generic root term -->
+<!ENTITY FC "&FED; &CORE;"> <!-- Generic main project name -->
+<!ENTITY DISTRO "&FC;"> <!-- Legacy entity -->
+<!ENTITY FCX "FC"> <!-- Short project name -->
+<!ENTITY FP "&FED; Project"> <!-- Generic overall project name -->
+<!ENTITY FDP "&FED; Documentation Project"> <!-- Generic docs project name -->
+<!ENTITY FDPX "&FED; Docs Project"> <!-- Short docs project name -->
+<!ENTITY EX "Extras"> <!-- cf. Core -->
+<!ENTITY FEX "&FED; &EX;"> <!-- cf. Fedora Core -->
+
+<!ENTITY FP-URL "<ulink url='http://fedora.redhat.com/'>http://fedora.redhat.com/</ulink>"> <!-- Fedora Project URL -->
+<!ENTITY FDP-URL "<ulink url='http://fedora.redhat.com/projects/docs/'>http://fedora.redhat.com/projects/docs/</ulink>"> <!-- Fedora Docs Project URL -->
+<!ENTITY FDPDOCS-URL "<ulink url='http://fedora.redhat.com/docs/'>http://fedora.redhat.com/docs/</ulink>"> <!-- Fedora Documentation (repository) URL -->
+
+<!ENTITY BZ "Bugzilla"> <!-- Bugzilla -->
+<!ENTITY BZ-URL "<ulink url='http://bugzilla.redhat.com/'>http://bugzilla.redhat.com/</ulink>"> <!-- Bugzilla URL -->
+<!ENTITY BZ-PROD "&FED; Documentation"> <!-- Bugzilla product for Fedora docs -->
+
+<!-- *************** Fedora version numbers *************** -->
+<!ENTITY FCVER "4"> <!-- Current release version of main project -->
+<!ENTITY TESTVER "test3"> <!-- Current test number of main project -->
+<!ENTITY FCTESTVER "5 &TESTVER;"> <!-- Current test version of main project -->
+
+
+<!-- ************** other common names *********** -->
+<!ENTITY RH "Red Hat"> <!-- The generic term "Red Hat" -->
+<!ENTITY FORMAL-RHI "&RH;, Inc."> <!-- The generic term "Red Hat, Inc. -->
+<!ENTITY RHL "&RH; Linux"> <!-- The generic term "Red Hat Linux" -->
+<!ENTITY RHN "&RH; Network"> <!-- The generic term "Red Hat Network" -->
+<!ENTITY RHEL "&RH; Enterprise Linux"> <!-- The generic term "Red Hat Enterprise Linux" -->
+
+<!-- ************** technology terms *********** -->
+<!ENTITY SEL "SELinux"> <!-- Generic technology term -->
+
+<!-- ************** common doc files *********** -->
+<!ENTITY LEGALNOTICE SYSTEM "./legalnotice-en_US.xml">
+<!ENTITY LEGALNOTICE-CONTENT SYSTEM "./legalnotice-content-en_US.xml">
+<!ENTITY LEGALNOTICE-OPL SYSTEM "./legalnotice-opl-en_US.xml">
+<!ENTITY LEGALNOTICE-OPL-CONTENT SYSTEM "./opl.xml">
+<!ENTITY LEGALNOTICE-RELNOTES SYSTEM "./legalnotice-relnotes-en_US.xml">
+<!ENTITY LEGALNOTICE-SECTION SYSTEM "./legalnotice-section-en_US.xml">
+<!ENTITY BUG-REPORTING SYSTEM "./bugreporting-en_US.xml">
+
+<!-- ************** common applications? *********** -->
+
+<!-- ************** required by build scripts *********** -->
+
+<!ENTITY PROJECT "&FP;">
+
+<!-- ************** tutorial titles ********** -->
+
+<!ENTITY IG "Installation Guide">
+<!ENTITY DOCG "Documentation Guide">
+
+<!-- ************** tutorial URLs *********** -->
+
+<!ENTITY IG-URL "<ulink url='http://fedora.redhat.com/docs/fedora-install-guide-en/'/>">
+<!ENTITY DOCG-URL "<ulink url='http://fedora.redhat.com/participate/documentation-guide/'/>">
+
+<!-- ************** status notices ************* -->
+<!ENTITY DRAFTNOTICE SYSTEM "./draftnotice-en_US.xml">
+<!ENTITY LEGACYNOTICE SYSTEM "./legacynotice-en_US.xml">
+<!ENTITY OBSOLETENOTICE SYSTEM "./obsoletenotice-en_US.xml">
+<!ENTITY DEPRECATEDNOTICE SYSTEM "./deprecatednotice-en_US.xml">
diff --git a/common/legacynotice-en_US.xml b/common/legacynotice-en_US.xml
new file mode 100644
index 0000000..e7e140c
--- /dev/null
+++ b/common/legacynotice-en_US.xml
@@ -0,0 +1,17 @@
+<note>
+ <title>LEGACY DOCUMENT</title>
+ <para>
+ This document relates to a version of &FC; that is no longer
+ supported by the &FP;. Changes in later versions of &FC; may have
+ made this document inaccurate. Please check the &FDP; website at
+ &FDPDOCS-URL; for a current version before you continue reading this
+ document.
+ </para>
+
+ <para>
+ This version of the document will not be changed or amended, except
+ to correct errors that may result in data loss or a system security
+ weakness. If you believe that you have found such an error, please
+ report it via &BZ; in bug &BUG-NUM;.
+ </para>
+</note>
diff --git a/common/legalnotice-content-en_US.xml b/common/legalnotice-content-en_US.xml
new file mode 100644
index 0000000..c6cba56
--- /dev/null
+++ b/common/legalnotice-content-en_US.xml
@@ -0,0 +1,71 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- $Id: -->
+<!--
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.docbook.org/xml/4.4/docbookx.dtd"[
+
+<!ENTITY % FEDORA-ENTITIES SYSTEM "fedora-entities-en_US.ent">
+%FEDORA-ENTITIES;
+
+]>
+
+<section id="sn-legalnotice-content">
+ <title>Legal Notice</title> -->
+
+ <para>
+ Copyright (c) 2006 by Fedora Foundation and others. This material may be
+ distributed only subject to the terms and conditions set forth in the Open
+ Publication License, v1.0, available at <ulink
+ url="http://www.opencontent.org/openpub/"/>.
+ </para>
+
+ <para>
+ Garrett LeSage created the admonition graphics (note, tip, important,
+ caution, and warning).
+ Tommy Reynolds <email>Tommy.Reynolds@MegaCoder.com</email> created the callout graphics.
+ They all may be freely redistributed with documentation
+ produced for the <!-- &PROJECT; --> Fedora Project.
+ </para>
+<!--
+ <para>
+ &DOCID;
+ </para>
+-->
+<!--
+ <para>
+ &RH; and the &RH; "Shadow Man" logo are registered trademarks of
+ &FORMAL-RHI; in the United States and other countries.
+ </para>
+-->
+ <para>
+ FEDORA, FEDORA PROJECT, and the Fedora Logo are trademarks of Red Hat, Inc.,
+ are registered or pending registration in the U.S. and other countries, and
+ are used here under license to the Fedora Foundation.
+ </para>
+
+ <para>
+ Red Hat and the Red Hat "Shadow Man" logo are registered trademarks of
+ Red Hat, Inc. in the United States and other countries.
+ </para>
+
+ <para>
+ All other trademarks and copyrights referred to are the property of their
+ respective owners.
+ </para>
+
+ <para>
+ Documentation, as with software itself, may be subject to export control.
+ Read about Fedora Project export controls at <ulink
+ url="http://fedoraproject.org/wiki/Legal/Export" />.
+ </para>
+<!-- </section> -->
+<!--
+
+
+
+
+
+
+
+
+-->
diff --git a/common/legalnotice-content-p1-en_US.xml b/common/legalnotice-content-p1-en_US.xml
new file mode 100644
index 0000000..92e546f
--- /dev/null
+++ b/common/legalnotice-content-p1-en_US.xml
@@ -0,0 +1,16 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- $Id: -->
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.docbook.org/xml/4.4/docbookx.dtd"[
+
+<!ENTITY % FEDORA-ENTITIES SYSTEM "fedora-entities-en_US.ent">
+%FEDORA-ENTITIES;
+
+]>
+
+ <para>
+ Copyright (c) 2006 by Fedora Foundation and others. This material may be
+ distributed only subject to the terms and conditions set forth in the Open
+ Publication License, v1.0, available at <ulink
+ url="http://www.opencontent.org/openpub/"/>.
+ </para>
diff --git a/common/legalnotice-content-p2-en_US.xml b/common/legalnotice-content-p2-en_US.xml
new file mode 100644
index 0000000..67d7789
--- /dev/null
+++ b/common/legalnotice-content-p2-en_US.xml
@@ -0,0 +1,16 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- $Id: -->
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.docbook.org/xml/4.4/docbookx.dtd"[
+
+<!ENTITY % FEDORA-ENTITIES SYSTEM "fedora-entities-en_US.ent">
+%FEDORA-ENTITIES;
+
+]>
+
+<para>
+ Garrett LeSage created the admonition graphics (note, tip, important, caution,
+ and warning). Tommy Reynolds <email>Tommy.Reynolds@MegaCoder.com</email>
+ created the callout graphics. They all may be freely redistributed with
+ documentation produced for the <!-- &PROJECT; --> Fedora Project.
+</para>
diff --git a/common/legalnotice-content-p3-en_US.xml b/common/legalnotice-content-p3-en_US.xml
new file mode 100644
index 0000000..300797a
--- /dev/null
+++ b/common/legalnotice-content-p3-en_US.xml
@@ -0,0 +1,15 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- $Id: -->
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.docbook.org/xml/4.4/docbookx.dtd"[
+
+<!ENTITY % FEDORA-ENTITIES SYSTEM "fedora-entities-en_US.ent">
+%FEDORA-ENTITIES;
+
+]>
+
+<para>
+ FEDORA, FEDORA PROJECT, and the Fedora Logo are trademarks of Red Hat, Inc.,
+ are registered or pending registration in the U.S. and other countries, and
+ are used here under license to the Fedora Foundation.
+</para>
diff --git a/common/legalnotice-content-p4-en_US.xml b/common/legalnotice-content-p4-en_US.xml
new file mode 100644
index 0000000..22d17c1
--- /dev/null
+++ b/common/legalnotice-content-p4-en_US.xml
@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- $Id: -->
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.docbook.org/xml/4.4/docbookx.dtd"[
+
+<!ENTITY % FEDORA-ENTITIES SYSTEM "fedora-entities-en_US.ent">
+%FEDORA-ENTITIES;
+
+]>
+
+<para>
+ &RH; and the &RH; "Shadow Man" logo are registered trademarks of &FORMAL-RHI;
+ in the United States and other countries.
+</para>
diff --git a/common/legalnotice-content-p5-en_US.xml b/common/legalnotice-content-p5-en_US.xml
new file mode 100644
index 0000000..5b07163
--- /dev/null
+++ b/common/legalnotice-content-p5-en_US.xml
@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- $Id: -->
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.docbook.org/xml/4.4/docbookx.dtd"[
+
+<!ENTITY % FEDORA-ENTITIES SYSTEM "fedora-entities-en_US.ent">
+%FEDORA-ENTITIES;
+
+]>
+
+<para>
+ All other trademarks and copyrights referred to are the property of their
+ respective owners.
+</para>
diff --git a/common/legalnotice-content-p6-en_US.xml b/common/legalnotice-content-p6-en_US.xml
new file mode 100644
index 0000000..bc31a09
--- /dev/null
+++ b/common/legalnotice-content-p6-en_US.xml
@@ -0,0 +1,15 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- $Id: -->
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.docbook.org/xml/4.4/docbookx.dtd"[
+
+<!ENTITY % FEDORA-ENTITIES SYSTEM "fedora-entities-en_US.ent">
+%FEDORA-ENTITIES;
+
+]>
+
+<para>
+ Documentation, as with software itself, may be subject to export control.
+ Read about Fedora Project export controls at <ulink
+ url="http://fedoraproject.org/wiki/Legal/Export">http://fedoraproject.org/wiki/Legal/Export</ulink>.
+</para>
diff --git a/common/legalnotice-en_US.xml b/common/legalnotice-en_US.xml
new file mode 100644
index 0000000..d549c65
--- /dev/null
+++ b/common/legalnotice-en_US.xml
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- $Id: -->
+<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!ENTITY % FEDORA-ENTITIES SYSTEM "fedora-entities-en_US.ent">
+%FEDORA-ENTITIES;
+
+]>
+
+<legalnotice id="legalnotice">
+ <xi:include href="legalnotice-content-p1-en_US.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="legalnotice-content-p2-en_US.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="legalnotice-content-p3-en_US.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="legalnotice-content-p4-en_US.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="legalnotice-content-p5-en_US.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+</legalnotice>
diff --git a/common/legalnotice-opl-en_US.xml b/common/legalnotice-opl-en_US.xml
new file mode 100644
index 0000000..605c0be
--- /dev/null
+++ b/common/legalnotice-opl-en_US.xml
@@ -0,0 +1,240 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- $Id: -->
+<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!ENTITY % FEDORA-ENTITIES SYSTEM "fedora-entities-en_US.ent">
+%FEDORA-ENTITIES;
+
+]>
+
+<!--
+
+ To use the content of this legal notice in another document, simply
+ use the XInclude standard. Logically there are only two elements
+ you need to reference, as follows:
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+ href="legalnotice-opl-en_US.xml"
+ xpointer="element(opl.permission)"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+ href="legalnotice-opl-en_US.xml" xpointer="element(opl.require)"/>
+
+ You may insert these includes in any element which can contain a
+ <para> and an <orderedlist> element.
+
+-->
+
+
+<legalnotice id="legalnotice-opl">
+ <para id="opl.permission">
+ Permission is granted to copy, distribute, and/or modify this
+ document under the terms of the Open Publication Licence, Version
+ 1.0, or any later version. The terms of the OPL are set out below.
+ </para>
+ <orderedlist numeration="upperroman" id="opl.terms">
+ <listitem id="opl.require">
+ <bridgehead>REQUIREMENTS ON BOTH UNMODIFIED AND MODIFIED
+ VERSIONS</bridgehead>
+ <para>
+ Open Publication works may be reproduced and distributed in
+ whole or in part, in any medium physical or electronic, provided
+ that the terms of this license are adhered to, and that this
+ license or an incorporation of it by reference (with any options
+ elected by the author(s) and/or publisher) is displayed in the
+ reproduction.
+ </para>
+
+ <para>
+ Proper form for an incorporation by reference is as follows:
+ </para>
+
+ <para>
+ Copyright (c) &lt;year&gt; by &lt;author's name or designee&gt;.
+ This material may be distributed only subject to the terms and
+ conditions set forth in the Open Publication License, vX.Y or
+ later (the latest version is presently available at <ulink
+ url="http://www.opencontent.org/openpub/"/>).
+ </para>
+
+ <para>
+ The reference must be immediately followed with any options
+ elected by the author(s) and/or publisher of the document (see
+ section VI). Commercial redistribution of Open
+ Publication-licensed material is permitted. Any publication in
+ standard (paper) book form shall require the citation of the
+ original publisher and author. The publisher and author's names
+ shall appear on all outer surfaces of the book. On all outer
+ surfaces of the book the original publisher's name shall be as
+ large as the title of the work and cited as possessive with
+ respect to the title.
+ </para>
+ </listitem>
+ <listitem id="opl.copyright">
+ <bridgehead>COPYRIGHT</bridgehead>
+ <para>
+ The copyright to each Open Publication is owned by its author(s)
+ or designee.
+ </para>
+ </listitem>
+ <listitem id="opl.scope">
+ <bridgehead>SCOPE OF LICENSE</bridgehead>
+
+ <para>
+ The following license terms apply to all Open Publication works,
+ unless otherwise explicitly stated in the document.
+ </para>
+
+ <para>
+ Mere aggregation of Open Publication works or a portion of an
+ Open Publication work with other works or programs on the same
+ media shall not cause this license to apply to those other
+ works. The aggregate work shall contain a notice specifying the
+ inclusion of the Open Publication material and appropriate
+ copyright notice.
+ </para>
+
+ <para>
+ SEVERABILITY. If any part of this license is found to be
+ unenforceable in any jurisdiction, the remaining portions of the
+ license remain in force.
+ </para>
+
+ <para>
+ NO WARRANTY. Open Publication works are licensed and provided
+ "as is" without warranty of any kind, express or implied,
+ including, but not limited to, the implied warranties of
+ merchantability and fitness for a particular purpose or a
+ warranty of non-infringement.
+ </para>
+ </listitem>
+ <listitem id="opl.modified.works">
+ <bridgehead>REQUIREMENTS ON MODIFIED WORKS</bridgehead>
+
+ <para>
+ All modified versions of documents covered by this license,
+ including translations, anthologies, compilations and partial
+ documents, must meet the following requirements:
+ </para>
+
+ <orderedlist>
+ <listitem>
+ <para>
+ The modified version must be labeled as such.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The person making the modifications must be identified and
+ the modifications dated.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Acknowledgement of the original author and publisher if
+ applicable must be retained according to normal academic
+ citation practices.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The location of the original unmodified document must be
+ identified.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The original author's (or authors') name(s) may not be used
+ to assert or imply endorsement of the resulting document
+ without the original author's (or authors') permission.
+ </para>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ <listitem id="opl.good-practice">
+ <bridgehead>GOOD-PRACTICE RECOMMENDATIONS</bridgehead>
+
+ <para>
+ In addition to the requirements of this license, it is requested
+ from and strongly recommended of redistributors that:
+ </para>
+
+ <orderedlist>
+ <listitem>
+ <para>
+ If you are distributing Open Publication works on hardcopy
+ or CD-ROM, you provide email notification to the authors of
+ your intent to redistribute at least thirty days before your
+ manuscript or media freeze, to give the authors time to
+ provide updated documents. This notification should describe
+ modifications, if any, made to the document.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ All substantive modifications (including deletions) be
+ either clearly marked up in the document or else described
+ in an attachment to the document.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Finally, while it is not mandatory under this license, it is
+ considered good form to offer a free copy of any hardcopy
+ and CD-ROM expression of an Open Publication-licensed work
+ to its author(s).
+ </para>
+ </listitem>
+ </orderedlist>
+
+ </listitem>
+ <listitem id="opl.options">
+ <bridgehead>LICENSE OPTIONS</bridgehead>
+
+ <para>
+ The author(s) and/or publisher of an Open Publication-licensed
+ document may elect certain options by appending language to the
+ reference to or copy of the license. These options are
+ considered part of the license instance and must be included
+ with the license (or its incorporation by reference) in derived
+ works.
+ </para>
+
+ <para>
+ A. To prohibit distribution of substantively modified versions
+ without the explicit permission of the author(s). "Substantive
+ modification" is defined as a change to the semantic content of
+ the document, and excludes mere changes in format or
+ typographical corrections.
+ </para>
+
+ <para>
+ To accomplish this, add the phrase 'Distribution of
+ substantively modified versions of this document is prohibited
+ without the explicit permission of the copyright holder.' to the
+ license reference or copy.
+ </para>
+
+ <para>
+ B. To prohibit any publication of this work or derivative works
+ in whole or in part in standard (paper) book form for commercial
+ purposes is prohibited unless prior permission is obtained from
+ the copyright holder.
+ </para>
+
+ <para>
+ To accomplish this, add the phrase 'Distribution of the work or
+ derivative of the work in any standard (paper) book form is
+ prohibited unless prior permission is obtained from the
+ copyright holder.' to the license reference or copy.
+ </para>
+ </listitem>
+ </orderedlist>
+</legalnotice>
+
+<!--
+Local variables:
+mode: xml
+fill-column: 72
+End:
+-->
diff --git a/common/legalnotice-relnotes-en_US.xml b/common/legalnotice-relnotes-en_US.xml
new file mode 100644
index 0000000..73545f8
--- /dev/null
+++ b/common/legalnotice-relnotes-en_US.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- $Id: -->
+<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!ENTITY % FEDORA-ENTITIES SYSTEM "fedora-entities-en_US.ent">
+%FEDORA-ENTITIES;
+
+]>
+
+<!--
+
+ Use this legalnotice for no-chunks/single-page HTML output. It is an optional
+ usage to move the bulk of the legalnotice to another location in the document.
+
+ If you use this legalnotice, you must include a call to the
+ LEGALNOTICE-SECTION entity, or include a similar <section> in your document.
+ The call to LEGALNOTICE-SECTION must happen where a <section> is otherwise
+ allowed. One good location is immediately following an introduction.
+
+ -->
+
+<legalnotice id="legalnotice">
+ <para>
+ This document is released under the terms of the Open Publication License.
+ For more details, read the full legalnotice in <xref
+ linkend="sn-legalnotice" />.
+ </para>
+ <tip>
+ <title>Latest Release Notes on the Web</title>
+ <para>
+ These release notes may be updated. Visit <ulink
+ url="http://fedora.redhat.com/docs/release-notes/"/> to view the latest
+ release notes for Fedora Core 5.
+ </para>
+ </tip>
+</legalnotice>
diff --git a/common/legalnotice-section-en_US.xml b/common/legalnotice-section-en_US.xml
new file mode 100644
index 0000000..190fe63
--- /dev/null
+++ b/common/legalnotice-section-en_US.xml
@@ -0,0 +1,40 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- $Id: -->
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.docbook.org/xml/4.4/docbookx.dtd" [
+
+<!-- *************** COMMON FDP entities *************** -->
+ <!ENTITY % FEDORA-ENTITIES SYSTEM "./fedora-entities-en_US.ent">
+ %FEDORA-ENTITIES;
+
+]>
+<!--
+
+ Use this legalnotice for no-chunks/single-page HTML output. It is an optional
+ usage to move the bulk of the legalnotice to another location in the document.
+
+ If you use this legalnotice, you must include a call to the
+ LEGALNOTICE-NOCHUNKS or LEGALNOTICE-RELNOTES. This gets the legal material in
+ the proper <legalnotice /> container.SECTION entity, or include a similar
+ <section> in your document. The call to LEGALNOTICE-SECTION must happen where
+ a <section> is otherwise allowed. One good location is immediately following
+ an introduction.
+
+-->
+
+<section id="sn-legalnotice">
+ <title>Legal Notice</title>
+ <xi:include href="legalnotice-content-p1-en_US.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="legalnotice-content-p2-en_US.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="legalnotice-content-p3-en_US.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="legalnotice-content-p4-en_US.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="legalnotice-content-p5-en_US.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="legalnotice-content-p6-en_US.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+</section>
+
diff --git a/common/obsoletenotice-en_US.xml b/common/obsoletenotice-en_US.xml
new file mode 100644
index 0000000..b00c915
--- /dev/null
+++ b/common/obsoletenotice-en_US.xml
@@ -0,0 +1,14 @@
+<note>
+ <title>OBSOLETE DOCUMENT</title>
+ <para>
+ This document relates to a version of &FC; that is no longer
+ supported. Changes in later versions of &FC; may have made this
+ document inaccurate. Please check the &FDP; website at
+ &FDPDOCS-URL; for a current version before you continue reading this
+ document.
+ </para>
+
+ <para>
+ This version of the document will not be changed or amended.
+ </para>
+</note>