Author: pfrields
Update of /cvs/fedora/web/html/docs/documentation-guide
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv32663
Modified Files:
acknowledgments.php ch-cvs.php ch-emacs.php
ch-getting-files.php ch-intro.php ch-tutorial.php ch-vim.php
ch-xml-tags.php generated-index.php index.php
sn-cvs-config.php sn-cvs-cvscommands.php
sn-cvs-preparation.php
Log Message:
Publish new version, even though it is still a WIP. Release early, release often. I will
try to have this done by the end of the week.
Index: acknowledgments.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/acknowledgments.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- acknowledgments.php 6 Dec 2005 19:37:14 -0000 1.1
+++ acknowledgments.php 23 Jun 2007 05:42:10 -0000 1.2
@@ -2,13 +2,13 @@
include("site.inc");
$template = new Page;
-$template->initCommon();
+$template->initCommon();
$template->displayHeader();
?>
-<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Chapter 11. Acknowledgments</th></tr><tr><td
width="20%" align="left"><a accesskey="p"
href="sn-cvs-cvscommands.php">Prev</a> </td><th
width="60%" align="center"> </th><td
width="20%" align="right"> <a accesskey="n"
href="generated-index.php">Next</a></td></tr></table><hr></div><div
class="chapter" lang="en"><div
class="titlepage"><div><div><h2
class="title"><a
name="acknowledgments"></a>Chapter 11. Acknowledgments</h2></div></div><div></div></div><p>
- This document is based on the a document started by Tammy Fox (tfox at
+<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Chapter��9.��Acknowledgments</th></tr><tr><td
width="20%" align="left"><a accesskey="p"
href="sn-cvs-cvscommands.php">Prev</a>��</td><th
width="60%" align="center">��</th><td
width="20%" align="right">��<a accesskey="n"
href="generated-index.php">Next</a></td></tr></table><hr></div><div
class="chapter" lang="en-US" id="acknowledgments"><div
class="titlepage"><div><div><h2
class="title"><a
name="acknowledgments"></a>Chapter��9.��Acknowledgments</h2></div></div></div><p>
+ This document is based on a document started by Tammy Fox (tfox at
redhat.com) and contributed to by Sandra Moore (smoore at
redhat.com) and
Johnray Fuller (jrfuller at
redhat.com).
</p><p>
@@ -17,20 +17,22 @@
commits.
</p><p>
Patches from Gavin Henry (ghenry at
suretecsystems.com) have been applied
- to add the trailing slashes to the <tt
class="command">figure</tt> tag example
- in <tt class="filename">docs-xml-tags.xml</tt> and to add
<a href="ch-emacs-nxml.php" title="Chapter 4. Emacs
and nXML Mode">Chapter 4, <i>Emacs and nXML
Mode</i></a>.
+ to add the trailing slashes to the <code
class="command">figure</code> tag example
+ in <code class="filename">docs-xml-tags.xml</code>.
</p><p>
A patch from Joshua Daniel Franklin (joshuadfranklin at
yahoo.com) has been
- applied to add <a href="ch-vim.php"
title="Chapter 5. VIM and DocBook">Chapter 5,
<i>VIM and DocBook</i></a>.
+ applied to add <a href="ch-vim.php" title="Chapter��5.��VIM and
DocBook">Chapter��5, <i>VIM and DocBook</i></a>.
</p><p>
A patch from Karsten Wade (kwade at
redhat.com) has been applied to add
- <a href="s1-screenshots.php"
title="2.4. Screenshots">Section 2.4,
“Screenshots”</a>. It was edited by Paul
- W. Frields (stickstr5 at
hotmail.com).
+ <a href="sn-screenshots.php"
title="3.4.��Screenshots">Section��3.4, ���Screenshots���</a>. It was
edited by Paul
+ W. Frields (stickster at
gmail.com).
</p><p>
- A patch from Paul W. Frields (stickstr5 at
hotmail.com) has been applied
- to add more explanation of the <tt
class="command">screen</tt> tag set to <a
href="s1-xml-tags-screen.php"
title="6.22. screen">Section 6.22,
“screen”</a>.
- </p></div><div class="navfooter"><hr><table
width="100%" summary="Navigation footer"><tr><td
width="40%" align="left"><a accesskey="p"
href="sn-cvs-cvscommands.php">Prev</a> </td><td
width="20%" align="center"><a accesskey="u"
href="index.php">Up</a></td><td width="40%"
align="right"> <a accesskey="n"
href="generated-index.php">Next</a></td></tr><tr><td
width="40%" align="left"
valign="top">10.4. Basic CVS Commands </td><td
width="20%" align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right"
valign="top"> Index</td></tr></table></div>
-
+ A patch from Paul W. Frields (stickster at
gmail.com) has been applied
+ to add more explanation of the <code
class="command">screen</code> tag set to <a
href="sn-xml-tags-screen.php" title="6.22.��screen">Section��6.22,
���<code class="command">screen</code>���</a>.
+ </p><p>
+ A patch from Tommy Reynolds (Tommy.Reynolds at
MegaCoder.com) has been
+ applied to more fully explaing the document building system.
+ </p></div><div class="navfooter"><hr><table
width="100%" summary="Navigation footer"><tr><td
width="40%" align="left"><a accesskey="p"
href="sn-cvs-cvscommands.php">Prev</a>��</td><td
width="20%" align="center">��</td><td
width="40%" align="right">��<a accesskey="n"
href="generated-index.php">Next</a></td></tr><tr><td
width="40%" align="left" valign="top">8.4.��Basic CVS
Commands��</td><td width="20%" align="center"><a
accesskey="h" href="index.php">Home</a></td><td
width="40%" align="right"
valign="top">��Index</td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: ch-cvs.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/ch-cvs.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ch-cvs.php 6 Dec 2005 19:37:14 -0000 1.1
+++ ch-cvs.php 23 Jun 2007 05:42:10 -0000 1.2
@@ -2,70 +2,69 @@
include("site.inc");
$template = new Page;
-$template->initCommon();
+$template->initCommon();
$template->displayHeader();
?>
-<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Chapter 10. CVS</th></tr><tr><td
width="20%" align="left"><a accesskey="p"
href="ch-converting.php">Prev</a> </td><th
width="60%" align="center"> </th><td
width="20%" align="right"> <a accesskey="n"
href="sn-cvs-preparation.php">Next</a></td></tr></table><hr></div><div
class="chapter" lang="en"><div
class="titlepage"><div><div><h2
class="title"><a
name="ch-cvs"></a>Chapter 10. CVS</h2></div></div><div></div></div><p>
- The Concurrent Versions System (<span><b
class="application">CVS</b></span>)
+<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Chapter��8.��CVS</th></tr><tr><td
width="20%" align="left"><a accesskey="p"
href="sn-tutorial-metadata.php">Prev</a>��</td><th
width="60%" align="center">��</th><td
width="20%" align="right">��<a accesskey="n"
href="sn-cvs-preparation.php">Next</a></td></tr></table><hr></div><div
class="chapter" lang="en-US" id="ch-cvs"><div
class="titlepage"><div><div><h2
class="title"><a
name="ch-cvs"></a>Chapter��8.��CVS</h2></div></div></div><p>
+ The Concurrent Versions System (<span><strong
class="application">CVS</strong></span>)
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 <span><b
class="application">CVS</b></span>,
+ directory, chaos would reign. Using <span><strong
class="application">CVS</strong></span>,
however, a group of people can safely work on the same set of files.
- <span><b class="application">CVS</b></span> keeps
the master copy of the files,
+ <span><strong
class="application">CVS</strong></span> keeps the master copy of
the files,
and it records who changed what and when in a central repository. If
- conflicts arise, <span><b
class="application">CVS</b></span> lets you know.
- <span><b class="application">CVS</b></span> is
often used so that programmers can
+ conflicts arise, <span><strong
class="application">CVS</strong></span> lets you know.
+ <span><strong
class="application">CVS</strong></span> is often used so that
programmers can
share code, but it also works well for documentation.
- </p><a class="indexterm"
name="id2970063"></a><div class="section"
lang="en"><div class="titlepage"><div><div><h2
class="title" style="clear: both"><a
name="sn-cvs-overview"></a>10.1. How CVS
Works</h2></div></div><div></div></div><a
class="indexterm" name="id2970081"></a><a
class="indexterm" name="id2970093"></a><p>
+ </p><a class="indexterm"
name="id3036978"></a><div class="section"
lang="en-US"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="sn-cvs-overview"></a>8.1.��How CVS
Works</h2></div></div></div><a class="indexterm"
name="id3011436"></a><a class="indexterm"
name="id3033872"></a><p>
In most cases, each set of files that make up a package or project
- is stored as a <i class="firstterm">module</i> on the CVS
server.
+ is stored as a <em class="firstterm">module</em> on the CVS
server.
</p><p>
- When working with files from <span><b
class="application">CVS</b></span>, you
- <i class="firstterm">checkout</i> a copy of the module on
your local
+ When working with files from <span><strong
class="application">CVS</strong></span>, you
+ <em class="firstterm">checkout</em> a copy of the module on
your local
file system. After modifying one or more files, you
- <i class="firstterm">commit</i> them back to the central
- <span><b class="application">CVS</b></span>
repository server.
+ <em class="firstterm">commit</em> them back to the central
+ <span><strong
class="application">CVS</strong></span> repository server.
</p><p>
- With <span><b class="application">CVS</b></span>
you may edit a file without
+ With <span><strong
class="application">CVS</strong></span> you may edit a file
without
first getting permission or locking the file. The
- <i class="wordasword">concurrent</i> part of the
- <span><b class="application">CVS</b></span> name
comes from its ability to
+ <em class="wordasword">concurrent</em> part of the
+ <span><strong
class="application">CVS</strong></span> 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,
- <span><b class="application">CVS</b></span> can
correctly record their changes.
+ <span><strong
class="application">CVS</strong></span> 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.
</p><p>
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 <i class="firstterm">add</i>
the
+ uploaded to the server. You must <em
class="firstterm">add</em> 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.
</p><p>
The specific commands to perform these actions are discussed in
- <a href="sn-cvs-cvscommands.php" title="10.4. Basic CVS
Commands">Section 10.4, “Basic CVS
Commands”</a>.
+ <a href="sn-cvs-cvscommands.php" title="8.4.��Basic CVS
Commands">Section��8.4, ���Basic CVS Commands���</a>.
</p><p>
If someone has modified the file between the last time you grabbed
the file from CVS and when you try to commit a change,
- <span><b class="application">CVS</b></span> will
try to merge the changes into
- the master copy of the <span><b
class="application">CVS</b></span> server. If
+ <span><strong
class="application">CVS</strong></span> will try to merge the
changes into
+ the master copy of the <span><strong
class="application">CVS</strong></span> 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 <i
class="firstterm">conflict</i>.
+ action will go through without a <em
class="firstterm">conflict</em>.
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
- <i class="firstterm">update</i> your files frequently. It is
a good
+ <em class="firstterm">update</em> your files frequently. It
is a good
practice to update them right before you start modifying a file.
- Refer to <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts"
title="10.4.8. Resolving Conflicts">Section 10.4.8,
“Resolving Conflicts”</a> for
+ Refer to <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts"
title="8.4.8.��Resolving Conflicts">Section��8.4.8, ���Resolving
Conflicts���</a> for
instructions on resolving conflicts.
- </p></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="ch-converting.php">Prev</a> </td><td
width="20%" align="center"><a accesskey="u"
href="index.php">Up</a></td><td width="40%"
align="right"> <a accesskey="n"
href="sn-cvs-preparation.php">Next</a></td></tr><tr><td
width="40%" align="left"
valign="top">Chapter 9. Converting to HTML and
PDF </td><td width="20%" align="center"><a
accesskey="h" href="index.php">Home</a></td><td
width="40%" align="right"
valign="top"> 10.2. Preparing For CVS
Use</td></tr></table></div>
-
+ </p></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="sn-tutorial-metadata.php">Prev</a>��</td><td
width="20%" align="center">��</td><td
width="40%" align="right">��<a accesskey="n"
href="sn-cvs-preparation.php">Next</a></td></tr><tr><td
width="40%" align="left" valign="top">7.2.��The
Metadata��</td><td width="20%" align="center"><a
accesskey="h" href="index.php">Home</a></td><td
width="40%" align="right" valign="top">��8.2.��Preparing
For CVS Use</td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: ch-emacs.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/ch-emacs.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ch-emacs.php 6 Dec 2005 19:37:14 -0000 1.1
+++ ch-emacs.php 23 Jun 2007 05:42:10 -0000 1.2
@@ -2,172 +2,16 @@
include("site.inc");
$template = new Page;
-$template->initCommon();
+$template->initCommon();
$template->displayHeader();
?>
-<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Chapter 3. Emacs and PSGML
Mode</th></tr><tr><td width="20%"
align="left"><a accesskey="p"
href="s1-diagrams-images.php">Prev</a> </td><th
width="60%" align="center"> </th><td
width="20%" align="right"> <a accesskey="n"
href="s1-emacs-colors.php">Next</a></td></tr></table><hr></div><div
class="chapter" lang="en"><div
class="titlepage"><div><div><h2
class="title"><a
name="ch-emacs"></a>Chapter 3. Emacs and PSGML
Mode</h2></div></div><div></div></div><a
class="indexterm" name="id2943411"></a><a
class="indexterm" name="id2943419"></a><a
class="indexterm" name="id2943428"></a><p>
+<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Chapter��4.��Emacs and PSGML
Mode</th></tr><tr><td width="20%"
align="left"><a accesskey="p"
href="sn-screenshots.php">Prev</a>��</td><th
width="60%" align="center">��</th><td
width="20%" align="right">��<a accesskey="n"
href="sn-emacs-file.php">Next</a></td></tr></table><hr></div><div
class="chapter" lang="en-US" id="ch-emacs"><div
class="titlepage"><div><div><h2
class="title"><a name="ch-emacs"></a>Chapter��4.��Emacs
and PSGML Mode</h2></div></div></div><a
class="indexterm" name="id3084919"></a><a
class="indexterm" name="id3024952"></a><a
class="indexterm" name="id3016375"></a><p>
You can use the PSGML mode available for Emacs to make it easier to write
in XML format. PSGML mode provides syntax-highlighting, tag completion,
and more.
- </p><div class="sect1" lang="en"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="s1-emacs-file"></a>3.1. Setting Up Your <tt
class="filename">.emacs</tt>
File</h2></div></div><div></div></div><a
class="indexterm" name="id2944034"></a><a
class="indexterm" name="id2944046"></a><p>
- For Emacs to parse your DocBook documents correctly, you must have a
- <tt class="filename">.emacs</tt> file. Cut and paste the
following into your
- existing <tt class="filename">.emacs</tt> file or create a new one
that
- contains the following lines:
-
-</p><pre class="screen">
-<tt class="computeroutput">
-;; turn on auto-fill in `text-mode' and derived modes
-;;(mail, news, etc)
-(add-hook 'text-mode-hook 'turn-on-auto-fill)
-
-;;
-;;MODES
-;;
-
-(setq auto-mode-alist (cons '("\\.sgml$" . sgml-mode) auto-mode-alist))
-(setq auto-mode-alist (cons '("\\.sgm$" . sgml-mode) auto-mode-alist))
-
-;;
-;;XML!!
-;;
-;;#############################################################
-
-;;
-;;PSGML mode stuff
-;;
-
-(autoload 'sgml-mode "psgml" "My Most Major Mode" t)
-
-(setq sgml-mode-hook '(lambda () "Defaults for XML mode."
(turn-on-auto-fill)
-(setq fill-column 80)))
-
-(defun My-XML-keymap ()
- (local-set-key [(alt i)]
- '(lambda ()
- (interactive)
- (sgml-indent-line)
- (sgml-insert-element 'item)
- (sgml-indent-line)))
- (local-set-key [(alt l)]
- '(lambda ()
- (interactive)
- (sgml-insert-element 'list)
- (sgml-insert-element 'item)
- (sgml-indent-line)))
- (local-set-key [(alt p)]
- '(lambda ()
- (interactive)
- (sgml-indent-line)
- (sgml-insert-element 'para)
- (sgml-indent-line)))
- (local-set-key [(alt -)]
- '(lambda ()
- (interactive)
- (insert "—"))))
-
-(add-hook 'sgml-mode-hook 'My-XML-keymap)
-
-;;
-;; Fix up indentation of data...
-;;
-
-(setq-default sgml-indent-data t)
-
-;;
-;; XML markup faces.
-;;
-
-(setq-default sgml-set-face t)
-
-
-(make-face 'sgml-comment-face)
-(make-face 'sgml-doctype-face)
-(make-face 'sgml-end-tag-face)
-(make-face 'sgml-entity-face)
-(make-face 'sgml-ignored-face)
-(make-face 'sgml-ms-end-face)
-(make-face 'sgml-ms-start-face)
-(make-face 'sgml-pi-face)
-(make-face 'sgml-sgml-face)
-(make-face 'sgml-short-ref-face)
-(make-face 'sgml-start-tag-face)
-
-(set-face-foreground 'sgml-comment-face "maroon")
-(set-face-foreground 'sgml-doctype-face "dark green")
-(set-face-foreground 'sgml-end-tag-face "blue2")
-(set-face-foreground 'sgml-entity-face "red2")
-(set-face-foreground 'sgml-ignored-face "maroon")
-(set-face-background 'sgml-ignored-face "gray90")
-(set-face-foreground 'sgml-ms-end-face "maroon")
-(set-face-foreground 'sgml-ms-start-face "maroon")
-(set-face-foreground 'sgml-pi-face "maroon")
-(set-face-foreground 'sgml-sgml-face "maroon")
-(set-face-foreground 'sgml-short-ref-face "goldenrod")
-(set-face-foreground 'sgml-start-tag-face "blue2")
-
-(setq-default sgml-markup-faces
- '((comment . sgml-comment-face)
- (doctype . sgml-doctype-face)
- (end-tag . sgml-end-tag-face)
- (entity . sgml-entity-face)
- (ignored . sgml-ignored-face)
- (ms-end . sgml-ms-end-face)
- (ms-start . sgml-ms-start-face)
- (pi . sgml-pi-face)
- (sgml . sgml-sgml-face)
- (short-ref . sgml-short-ref-face)
- (start-tag . sgml-start-tag-face)))
-
-
-(defun docbook-mode ()
- (sgml-mode)
- )
-
-
-
-;;
-;;END XML STUFF
-;;
-;;##################################################################
-
-;PO mode stuff
-
-(setq auto-mode-alist
- (cons '("\\.pox?\\'" . po-mode) auto-mode-alist))
-(autoload 'po-mode "po-mode")
-
-
- (global-set-key [(f1)] (lambda () (interactive) (manual-
- entry (current-word))))
-
-</tt>
-</pre><p>
-
- </p><p>
- Do you have a cool wheel mouse? If so, you can add the following to your
- <tt class="filename">.emacs</tt> file so your wheel will work in
- <span><b class="application">Emacs</b></span> (must
be
- <span><b class="application">Emacs</b></span> version
21):
- </p><pre class="screen">
-<tt class="computeroutput">
-;; Enable wheelmouse support by default for emacs 21
-(cond (window-system
-(mwheel-install)
-))
-</tt>
-</pre><p>
- If you are using the older version 20 of
- <span><b class="application">Emacs</b></span>, add the
following instead:
- </p><pre class="screen">
-<tt class="computeroutput">
-;; Enable wheelmouse support by default
-(require 'mwheel)
-</tt>
-</pre></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="s1-diagrams-images.php">Prev</a> </td><td
width="20%" align="center"><a accesskey="u"
href="index.php">Up</a></td><td width="40%"
align="right"> <a accesskey="n"
href="s1-emacs-colors.php">Next</a></td></tr><tr><td
width="40%" align="left"
valign="top">2.5. Diagrams and Images </td><td
width="20%" align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right" valign="top"> 3.2. Customizing
Emacs</td></tr></table></div>
-
+ </p><div class="section" lang="en-US"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="sn-installing-psgml"></a>4.1.��Installing
PSGML</h2></div></div></div><p>To install PSGML, use the
<code class="command">yum</code> command:</p><pre
class="screen"><strong class="userinput"><code>yum
install psgml</code></strong></pre></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="sn-screenshots.php">Prev</a>��</td><td
width="20%" align="center">��</td><td
width="40%" align="right">��<a accesskey="n"
href="sn-emacs-file.php">Next</a></td></tr><tr><td
width="40%" align="left"
valign="top">3.4.��Screenshots��</td><td width="20%"
align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right" valign="top">��4.2.��Setting Up Your <code
class="filename">.emacs</code>
File</td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: ch-getting-files.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/ch-getting-files.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ch-getting-files.php 6 Dec 2005 19:37:14 -0000 1.1
+++ ch-getting-files.php 23 Jun 2007 05:42:10 -0000 1.2
@@ -2,50 +2,28 @@
include("site.inc");
$template = new Page;
-$template->initCommon();
+$template->initCommon();
$template->displayHeader();
?>
-<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Chapter 1. Getting the
Files</th></tr><tr><td width="20%"
align="left"><a accesskey="p"
href="ch-intro.php">Prev</a> </td><th
width="60%" align="center"> </th><td
width="20%" align="right"> <a accesskey="n"
href="ch-rh-guidelines.php">Next</a></td></tr></table><hr></div><div
class="chapter" lang="en"><div
class="titlepage"><div><div><h2
class="title"><a
name="ch-getting-files"></a>Chapter 1. Getting the
Files</h2></div></div><div></div></div><p>
- To start working on the Docs Project, you will need the appropriate
- DocBook XML files, stylesheets, and scripts. The following packages are
- required:
- </p><div class="itemizedlist"><ul
type="disc"><li><p><tt
class="filename">xmlto</tt> — for producing HTML and PDF
outputs</p></li><li><p><tt
class="filename">docbook-style-xsl</tt> — for the default
XSLT stylesheets we
- build on</p></li><li><p><tt
class="filename">docbook-dtds</tt> — XML versions of the
DocBook DTD</p></li></ul></div><p>
- The custom scripts and stylesheets used are all stored in CVS on the
- <tt class="computeroutput">cvs.fedora.redhat.com</tt> CVS
server.
- You need to check them out along with the DocBook XML files for the
- existing docs.
- </p><p>
- You should perform these steps only once, when you first make a checkout
- from docs CVS. When you see the password prompt, press the
- <span><b class="keycap">Enter</b></span> key.
+<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Chapter��1.��Prerequisites</th></tr><tr><td
width="20%" align="left"><a accesskey="p"
href="ch-intro.php">Prev</a>��</td><th width="60%"
align="center">��</th><td width="20%"
align="right">��<a accesskey="n"
href="ch-getting-files-fdp.php">Next</a></td></tr></table><hr></div><div
class="chapter" lang="en-US"
id="ch-getting-files"><div
class="titlepage"><div><div><h2
class="title"><a
name="ch-getting-files"></a>Chapter��1.��Prerequisites</h2></div></div></div><p>
+ To work on official Fedora documentation you need to install the required
+ tools. Follow the directions below to configure your system.
+ </p><div class="section" lang="en-US"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="ch-getting-files-system-packages"></a>1.1.��System
Packages</h2></div></div></div><p>
+ Install the "Authoring and Publishing" package group, which contains
+ required DocBook XML files, stylesheets and scripts:
</p><pre class="screen">
-<b class="userinput"><tt>mkdir my-fedora-docs
-cd my-fedora-docs
-export CVSROOT=:pserver:anonymous@cvs.fedora.redhat.com:/cvs/docs
-cvs login
-cvs co docs-common
-cvs co example-tutorial</tt></b>
+<strong class="userinput"><code>su -c 'yum groupinstall
"Authoring and Publishing"'</code></strong>
</pre><p>
- When you perform an anonymous CVS checkout, you can view the files and
- retreive the latest versions. You cannot add (commit) any updates or new
- files back to the repository. To commit changes to CVS, you must have
- <span class="abbrev">CVS</span> write access. Refer to <a
href="http://fedoraproject.org/wiki/DocsProject/NewWriters"
target="_top">http://fedoraproject.org/wiki/DocsProject/NewW...
to learn
- about getting write access to <span class="abbrev">CVS</span>.
- </p><p>
- To see a list of the available documents:
- </p><pre class="screen"><b
class="userinput"><tt>cvs co
-c</tt></b></pre><p>
- Pick your document of interest and then download it to your working directory:
- </p><pre class="screen"><b
class="userinput"><tt>cvs co
example-tutorial</tt></b></pre><p>
- Except for the <i class="citetitle">Installation Guide</i>,
all documentation in CVS must
- be tutorials written in DocBook XML article format using the template in
- the <tt class="filename">example-tutorial</tt> directory.
Each tutorial
- <span class="emphasis"><em>must</em></span> be in
its own directory. No XML files should be
- in the root directory.
- </p></div><div class="navfooter"><hr><table
width="100%" summary="Navigation footer"><tr><td
width="40%" align="left"><a accesskey="p"
href="ch-intro.php">Prev</a> </td><td
width="20%" align="center"><a accesskey="u"
href="index.php">Up</a></td><td width="40%"
align="right"> <a accesskey="n"
href="ch-rh-guidelines.php">Next</a></td></tr><tr><td
width="40%" align="left"
valign="top">Introduction </td><td width="20%"
align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right"
valign="top"> Chapter 2. Red Hat Documentation
Guidelines</td></tr></table></div>
-
+ Next, install the <code class="filename">cvs</code> package,
which is used to
+ handle revision control on files in the official repository:
+ </p><pre class="screen">
+<strong class="userinput"><code>su -c 'yum install
cvs'</code></strong>
+</pre><p>If you plan to use <span><strong
class="application">Emacs</strong></span> to edit
+ DocBook XML documentation, install <span
class="package">psgml</span>, which
+ adds helpful and time-saving functionality to maximize editing
+ efficiency:</p><pre class="screen"><strong
class="userinput"><code>su -c 'yum install
psgml'</code></strong></pre></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="ch-intro.php">Prev</a>��</td><td width="20%"
align="center">��</td><td width="40%"
align="right">��<a accesskey="n"
href="ch-getting-files-fdp.php">Next</a></td></tr><tr><td
width="40%" align="left"
valign="top">Introduction��</td><td width="20%"
align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right" valign="top">��1.2.��Fedora Documentation
Tools</td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: ch-intro.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/ch-intro.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ch-intro.php 6 Dec 2005 19:37:14 -0000 1.1
+++ ch-intro.php 23 Jun 2007 05:42:10 -0000 1.2
@@ -2,26 +2,28 @@
include("site.inc");
$template = new Page;
-$template->initCommon();
+$template->initCommon();
$template->displayHeader();
?>
-<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Introduction</th></tr><tr><td
width="20%" align="left"><a accesskey="p"
href="index.php">Prev</a> </td><th
width="60%" align="center"> </th><td
width="20%" align="right"> <a accesskey="n"
href="ch-getting-files.php">Next</a></td></tr></table><hr></div><div
class="preface" lang="en"><div
class="titlepage"><div><div><h2
class="title"><a
name="ch-intro"></a>Introduction</h2></div></div><div></div></div><p>
- The goal of the Docs Project is to create easy-to-follow, task-based
- documentation for Fedora Core users and developers. Other than the
- <i class="citetitle">Installation Guide</i>, each tutorial
should be in DocBook XML
- article format, with one article per topic. This way, writers can
- contribute documentation about a specific topic without having to worry
- about how it fits into a manual or how it flows with other topics.
- </p><p>
- The following tools are used:
- </p><div class="itemizedlist"><ul
type="disc"><li><p>DocBook XML
v4.1</p></li><li><p>Custom XSLT stylesheets for both print and
HTML versions</p></li><li><p>Custom scripts to generate PDF and
HTML output (use <tt
class="command">xmlto</tt>)</p></li><li><p>Emacs
with PSGML mode (optional, but recommended)</p></li><li><p>Emacs
with nXML mode (optional, but also
recommended)</p></li></ul></div><p>
- The purpose of this document is to explain the tools used by the Docs
- Project as well as to provide writing and tagging guidelines so that the
- documentation is consistent and easy-to-follow.
- </p></div><div class="navfooter"><hr><table
width="100%" summary="Navigation footer"><tr><td
width="40%" align="left"><a accesskey="p"
href="index.php">Prev</a> </td><td
width="20%" align="center"><a accesskey="u"
href="index.php">Up</a></td><td width="40%"
align="right"> <a accesskey="n"
href="ch-getting-files.php">Next</a></td></tr><tr><td
width="40%" align="left" valign="top">Fedora Project
Documentation Guide </td><td width="20%"
align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right"
valign="top"> Chapter 1. Getting the
Files</td></tr></table></div>
-
+<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Introduction</th></tr><tr><td
width="20%" align="left"><a accesskey="p"
href="index.php">Prev</a>��</td><th width="60%"
align="center">��</th><td width="20%"
align="right">��<a accesskey="n"
href="ch-getting-files.php">Next</a></td></tr></table><hr></div><div
class="preface" lang="en-US" id="ch-intro"><div
class="titlepage"><div><div><h2
class="title"><a
name="ch-intro"></a>Introduction</h2></div></div></div><p>
+ The goal of the Fedora Documentation Project is to create easy-to-follow, task-based
+ documentation for Fedora users and developers. Other than the
+ <em class="citetitle">Installation Guide</em>, each tutorial
should be in DocBook XML
+ article format, with one article per topic. This way, writers can
+ contribute documentation about a specific topic without having to
+ worry about how it fits into a manual or how it flows with other
+ topics.
+ </p><p>
+ The following tools are used:
+ </p><div class="itemizedlist"><ul
type="disc"><li><p>DocBook XML
v4.4</p></li><li><p>Custom XSLT stylesheets for both print and
HTML
+ versions</p></li><li><p>Custom scripts to generate HTML output
(use
+ <code
class="command">xmlto</code>)</p></li><li><p>Emacs
with PSGML mode (optional, but
recommended)</p></li></ul></div><p>
+ This document explains the tools used by the Fedora Documentation Project and
provides
+ writing and tagging guidelines to make Fedora documentation is
+ consistent and easy-to-follow.
+ </p></div><div class="navfooter"><hr><table
width="100%" summary="Navigation footer"><tr><td
width="40%" align="left"><a accesskey="p"
href="index.php">Prev</a>��</td><td width="20%"
align="center">��</td><td width="40%"
align="right">��<a accesskey="n"
href="ch-getting-files.php">Next</a></td></tr><tr><td
width="40%" align="left" valign="top">Fedora
Documentation Guide��</td><td width="20%"
align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right"
valign="top">��Chapter��1.��Prerequisites</td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: ch-tutorial.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/ch-tutorial.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ch-tutorial.php 6 Dec 2005 19:37:14 -0000 1.1
+++ ch-tutorial.php 23 Jun 2007 05:42:10 -0000 1.2
@@ -2,74 +2,41 @@
include("site.inc");
$template = new Page;
-$template->initCommon();
+$template->initCommon();
$template->displayHeader();
?>
-<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Chapter 7. The Layout of a
Tutorial</th></tr><tr><td width="20%"
align="left"><a accesskey="p"
href="s1-xml-tags-xref.php">Prev</a> </td><th
width="60%" align="center"> </th><td
width="20%" align="right"> <a accesskey="n"
href="s1-tutorial-license.php">Next</a></td></tr></table><hr></div><div
class="chapter" lang="en"><div
class="titlepage"><div><div><h2
class="title"><a
name="ch-tutorial"></a>Chapter 7. The Layout of a
Tutorial</h2></div></div><div></div></div><p>
- In this chapter, you will find an example of a Fedora Project documentation
- parent file. This example is specific to the way the Docs Project uses
- DocBook XML. The parent file contains the main structural format of the
- book, a link to the entities file that contain common entities that should
- be used, and an entity to change the version and date of the tutorial.
- </p><div class="sect1" lang="en"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="s1-tutorial-parent"></a>7.1. The Parent
File</h2></div></div><div></div></div><p>
- Below is a sample parent file:
- </p><pre class="screen">
-<tt class="computeroutput">
-<!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
"../common/fedora-entities-en.xml">
-%FEDORA-ENTITIES-EN;
-
-<!ENTITY VERSION "0.1"> <!-- change version of tutorial
here -->
-
-<!ENTITY BOOKID "example-tutorial-&VERSION;
(2003-07-07)"> <!-- change last modified date here -->
-
-<!ENTITY LEGALNOTICE SYSTEM "../common/legalnotice-en.xml">
+<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Chapter��7.��The Layout of a
Tutorial</th></tr><tr><td width="20%"
align="left"><a accesskey="p"
href="sn-xml-tags-xref.php">Prev</a>��</td><th
width="60%" align="center">��</th><td
width="20%" align="right">��<a accesskey="n"
href="sn-tutorial-metadata.php">Next</a></td></tr></table><hr></div><div
class="chapter" lang="en-US" id="ch-tutorial"><div
class="titlepage"><div><div><h2
class="title"><a
name="ch-tutorial"></a>Chapter��7.��The Layout of a
Tutorial</h2></div></div></div><p>In this chapter, you will
find an example of a very short tutorial
+ as used by the Fedora Documentation Project. This example is specific to the way the
Docs
+ Project uses DocBook XML. The example consists of a set of files
+ used to hold the content and metadata for the tutorial.</p><div
class="section" lang="en-US"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="sn-tutorial-article"></a>7.1.��The
Article</h2></div></div></div><a class="indexterm"
name="id3028746"></a><p>Below is a sample
article:</p><pre class="screen"><!DOCTYPE article PUBLIC
"-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+<!ENTITY % FEDORA-ENTITIES SYSTEM "fdp-entities.ent">
+%FEDORA-ENTITIES;
]>
-<article id="example-tutorial" lang="en">
- <articleinfo>
- <title>Example Tutorial</title>
- <copyright>
- <year>2003</year>
- <holder>Red Hat, Inc.</holder>
- <holder>Tammy Fox</holder>
- </copyright>
- <authorgroup>
- <author>
- <surname>Fox</surname>
- <firstname>Tammy</firstname>
- </author>
- </authorgroup>
- &LEGALNOTICE;
- </articleinfo>
-
+<article id="sample-tutorial" lang="en_US">
+ <xi:include
xmlns:xi="http://www.w3.org/2001/XInclude"
+ href="fdp-info.xml"/>
<section id="some-section">
<title>Some Section</title>
-
<para>
- This is an example section. You can also use sect1, sect2, etc.
+ This is an example section. You can nest sections or make
+ additional sections as needed.
</para>
-
<warning>
<title>Warning</title>
<para>
Example of an admonition.
</para>
</warning>
-
</section>
-
-<index id="generated-index"></index>
+<index id="generated-index"/>
</article>
-</tt>
-</pre></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="s1-xml-tags-xref.php">Prev</a> </td><td
width="20%" align="center"><a accesskey="u"
href="index.php">Up</a></td><td width="40%"
align="right"> <a accesskey="n"
href="s1-tutorial-license.php">Next</a></td></tr><tr><td
width="40%" align="left"
valign="top">6.29. xref </td><td
width="20%" align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right" valign="top"> 7.2. Including the
License Information</td></tr></table></div>
-
+</pre></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="sn-xml-tags-xref.php">Prev</a>��</td><td
width="20%" align="center">��</td><td
width="40%" align="right">��<a accesskey="n"
href="sn-tutorial-metadata.php">Next</a></td></tr><tr><td
width="40%" align="left" valign="top">6.29.��<code
class="command">xref</code>��</td><td width="20%"
align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right" valign="top">��7.2.��The
Metadata</td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: ch-vim.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/ch-vim.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ch-vim.php 6 Dec 2005 19:37:14 -0000 1.1
+++ ch-vim.php 23 Jun 2007 05:42:10 -0000 1.2
@@ -2,26 +2,25 @@
include("site.inc");
$template = new Page;
-$template->initCommon();
+$template->initCommon();
$template->displayHeader();
?>
-<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Chapter 5. VIM and
DocBook</th></tr><tr><td width="20%"
align="left"><a accesskey="p"
href="s1-emacs-nxml-readme.php">Prev</a> </td><th
width="60%" align="center"> </th><td
width="20%" align="right"> <a accesskey="n"
href="s1-vim-keymapping.php">Next</a></td></tr></table><hr></div><div
class="chapter" lang="en"><div
class="titlepage"><div><div><h2
class="title"><a
name="ch-vim"></a>Chapter 5. VIM and
DocBook</h2></div></div><div></div></div><a
class="indexterm" name="id2949325"></a><p>
+<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Chapter��5.��VIM and
DocBook</th></tr><tr><td width="20%"
align="left"><a accesskey="p"
href="sn-emacs-additional-resources.php">Prev</a>��</td><th
width="60%" align="center">��</th><td
width="20%" align="right">��<a accesskey="n"
href="sn-vim-keymapping.php">Next</a></td></tr></table><hr></div><div
class="chapter" lang="en-US" id="ch-vim"><div
class="titlepage"><div><div><h2
class="title"><a name="ch-vim"></a>Chapter��5.��VIM and
DocBook</h2></div></div></div><a class="indexterm"
name="id3068322"></a><p>
VIM has many features to help you write XML content such as DocBook,
including syntax highlighting and customizable key bindings.
Additionally, one can easily use external programs from VIM for features
such as spell-checking.
This chapter assumes you already know generally how to use VIM; if you
- want to learn how, try the <tt class="command">vimtutor</tt>
or by typing
- <b class="userinput"><tt>:help tutor</tt></b>
from inside VIM.
- </p><div class="sect1" lang="en"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="s1-vimrc-file"></a>5.1. Setting Up Your <tt
class="filename">.vimrc</tt>
File</h2></div></div><div></div></div><a
class="indexterm" name="id2949941"></a><p>
- Below is a short sample <tt class="filename">.vimrc</tt>
file that turns on
+ want to learn how, try the <code
class="command">vimtutor</code> or by typing
+ <strong class="userinput"><code>:help
tutor</code></strong> from inside VIM.
+ </p><div class="section" lang="en-US"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="sn-vimrc-file"></a>5.1.��Setting Up Your <code
class="filename">.vimrc</code>
File</h2></div></div></div><a class="indexterm"
name="id3031941"></a><p>
+ Below is a short sample <code
class="filename">.vimrc</code> file that turns on
some VIM features useful for editing SGML or XML content such as
DocBook:
</p><pre class="screen">
-<tt class="computeroutput">
-" Turn off vi compatibility settings like limited undo
+<code class="computeroutput">" Turn off vi compatibility settings
like limited undo
set nocompatible
" Syntax highlighting based on file extension
syntax on
@@ -30,19 +29,17 @@
" Automatically indent
set autoindent
" Match SGML tags with %
-source $VIMRUNTIME/macros/matchit.vim
-</tt>
+source $VIMRUNTIME/macros/matchit.vim</code>
</pre><p>
- </p><div class="note" style="margin-left: 0.5in;
margin-right: 0.5in;"><table border="0"
summary="Note"><tr><td rowspan="2"
align="center" valign="top" width="25"><img
alt="[Note]" src="./stylesheet-images/note.png"></td><th
align="left">Note</th></tr><tr><td colspan="2"
align="left" valign="top"><p>
- Some of these features require the <tt
class="filename">vim-enhanced</tt>
+ </p><div class="note" style="margin-left: 0.5in;
margin-right: 0.5in;"><table border="0"
summary="Note"><tr><td rowspan="2"
align="center" valign="top" width="25"><img
alt="[Note]" src="./stylesheet-images/note.png"></td><th
align="left">Note</th></tr><tr><td
align="left" valign="top"><p>
+ Some of these features require the <code
class="filename">vim-enhanced</code>
package to be installed. If you are using or the
- <tt class="filename">vim-minimal</tt> package, or if you are
using an older
+ <code class="filename">vim-minimal</code> package, or if you
are using an older
version of VIM, you may not have the
- <tt class="filename">$VIMRUNTIME/macros/matchit.vim</tt>
file. You can still
+ <code class="filename">$VIMRUNTIME/macros/matchit.vim</code>
file. You can still
download <a
href="http://vim.org/scripts/script.php?script_id=39"
target="_top">matchit.zip from
Vim.org</a> and load it separately.
-
</p></td></tr></table></div></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="s1-emacs-nxml-readme.php">Prev</a> </td><td
width="20%" align="center"><a accesskey="u"
href="index.php">Up</a></td><td width="40%"
align="right"> <a accesskey="n"
href="s1-vim-keymapping.php">Next</a></td></tr><tr><td
width="40%" align="left" valign="top">4.4. nXML
README File </td><td width="20%"
align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right" valign="top"> 5.2. Keymapping with
VIM</td></tr></table></div>
-
+
</p></td></tr></table></div></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="sn-emacs-additional-resources.php">Prev</a>��</td><td
width="20%" align="center">��</td><td
width="40%" align="right">��<a accesskey="n"
href="sn-vim-keymapping.php">Next</a></td></tr><tr><td
width="40%" align="left" valign="top">4.6.��Additional
Resources��</td><td width="20%" align="center"><a
accesskey="h" href="index.php">Home</a></td><td
width="40%" align="right" valign="top">��5.2.��Keymapping
with VIM</td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: ch-xml-tags.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/ch-xml-tags.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ch-xml-tags.php 6 Dec 2005 19:37:14 -0000 1.1
+++ ch-xml-tags.php 23 Jun 2007 05:42:10 -0000 1.2
@@ -2,12 +2,12 @@
include("site.inc");
$template = new Page;
-$template->initCommon();
+$template->initCommon();
$template->displayHeader();
?>
-<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Chapter 6. DocBook XML
Tags</th></tr><tr><td width="20%"
align="left"><a accesskey="p"
href="s1-vim-additional-resources.php">Prev</a> </td><th
width="60%" align="center"> </th><td
width="20%" align="right"> <a accesskey="n"
href="s1-xml-tags-application.php">Next</a></td></tr></table><hr></div><div
class="chapter" lang="en"><div
class="titlepage"><div><div><h2
class="title"><a
name="ch-xml-tags"></a>Chapter 6. DocBook XML
Tags</h2></div></div><div></div></div><a
class="indexterm" name="id2949754"></a><p>Please read
this chapter carefully. This chapter describes the tags
+<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Chapter��6.��DocBook XML
Tags</th></tr><tr><td width="20%"
align="left"><a accesskey="p"
href="sn-vim-additional-resources.php">Prev</a>��</td><th
width="60%" align="center">��</th><td
width="20%" align="right">��<a accesskey="n"
href="sn-xml-tags-application.php">Next</a></td></tr></table><hr></div><div
class="chapter" lang="en-US" id="ch-xml-tags"><div
class="titlepage"><div><div><h2
class="title"><a
name="ch-xml-tags"></a>Chapter��6.��DocBook XML
Tags</h2></div></div></div><a class="indexterm"
name="id3057582"></a><p>Please read this chapter carefully. This
chapter describes the tags
used by the Docs Project. Some of the rules described are specific to the
project.
</p><p>If these tags are used appropriately, document searches will
provide
@@ -15,47 +15,50 @@
information relevant to the search request. Another benefit is that all
Fedora Project documents will have a similar look and feel (however, they will
have
some differences depending upon the output format).
- </p><a class="indexterm"
name="id2949583"></a><p>All tags in XML must have an opening and
closing tag Additionally,
+ </p><a class="indexterm"
name="id3026242"></a><p>Most tags in XML must have an opening and
closing tag. A few
+ tags, such as <code
class="sgmltag-emptytag"><xref/></code>, have no
+ content and close themselves. Additionally,
proper XML conventions say that there must be a unique identifier for
sections, chapters, figures, tables, and so on, so that they may be
correctly identified, and cross referenced if needed.</p><p>Although
XML is capable of handling many document types, the format
discussed here is the article format.</p><p>
- This chapter only discusses tags used for documentation for the Fedora Project,
- not all available DocBook XML tags. For the complete list, refer to:
- </p><pre class="screen">
-<tt class="computeroutput">
-<a
href="http://www.docbook.org/tdg/en/html/docbook.html"
target="_top">http://www.docbook.org/tdg/en/html/docbook.htm...
-</tt>
-</pre><div class="sect1" lang="en"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="s1-xml-tags-caveats"></a>6.1. Tags and Entities
Caveats</h2></div></div><div></div></div><a
class="indexterm" name="id2950683"></a><p>
+ This chapter only discusses tags used for documentation for the
+ Fedora Project, not all available DocBook XML tags. For the complete
+ list, refer to <a
href="http://www.docbook.org/tdg/en/html/docbook.html"
target="_top">http://www.docbook.org/tdg/en/html/docbook.htm...;.
+ </p><div class="section" lang="en-US"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="sn-xml-tags-caveats"></a>6.1.��Tags and Entities
Caveats</h2></div></div></div><a class="indexterm"
name="id3065445"></a><p>
It is very important that you remember the caveats in this section. Even
though they are more strict than valid DocBook XML, these rules exist
- so that both the HTML and PDF outputs look proper.
- </p><div class="variablelist"><dl><dt><span
class="term">Do Not Use Trademark
Entities</span></dt><dd><p>Do not use the trademark entities
&trade;, &copy;, or
- &reg; because the do not produce HTML output that works for all
- charsets. The HTML output produces by these entities are declared in
- the DTD and cannot be changed via the stylesheet.</p><p>Instead, use the
<tt class="command">trademark</tt> tag and its
+ so that both the HTML and PDF outputs look proper.
+ </p><div class="variablelist"><dl><dt><span
class="term">Do Not Use Trademark
Entities</span></dt><dd><p>Do not use the trademark entities
<code class="sgmltag-genentity">&trade;</code>, <code
class="sgmltag-genentity">&copy;</code>, or <code
class="sgmltag-genentity">&reg;</code> because they do not
produce
+ HTML output that works for all charsets. The HTML output
+ produces by these entities are declared in the DTD and
+ cannot be changed via the stylesheet.</p><p>Instead, use the <code
class="sgmltag-element">trademark</code> tag and its
associates classes as follows:
- </p><div class="itemizedlist"><ul
type="disc"><li><p><trademark>trademark symbol
after me</trademark>
- </p></li><li><p><trademark
class="registered">registered trademark symbol after
me</trademark>
- </p></li><li><p><trademark
class="copyright">copyright symbol after
me</trademark></p></li></ul></div></dd><dt><span
class="term">Content inside <tt
class="command">para</tt>
tags</span></dt><dd><p>Do not use <tt
class="command">para</tt> tags around anything other
- than a simple paragraph. Doing so will create additional white space
- within the text itself in the PDF version.
- </p><p>Specifically, do not use <tt
class="command">para</tt> tags around
- the following (or, to put this another way, do not embed the
- following within <tt class="command">para</tt> tags):
- </p><div class="itemizedlist"><ul
type="disc"><li><p><screen></p></li><li><p><itemizedlist></p></li><li><p><orderedlist></p></li><li><p><variablelist></p></li><li><p><table></p></li></ul></div></dd><dt><span
class="term">Content inside <tt
class="command">para</tt> tags within
- <tt class="command">listitem</tt>
tags</span></dt><dd><p>Content inside <tt
class="command">para</tt> tags within
- <tt class="command">listitem</tt> tags <span
class="emphasis"><em>must</em></span> start
- immediately after the beginning <para> tag to avoid extra
- white space in the PDF version.
- </p></dd><dt><span class="term">Content inside
<tt class="command">screen</tt>
tags</span></dt><dd><p>The <tt
class="command">screen</tt> tags (<screen> and
- </screen>) <span
class="emphasis"><em>must</em></span> be flush left in the
- XML file, and all the content inside the
- <tt class="command">screen</tt> tags must be flush left as
well unless
- the white space in intentional; otherwise, the extraneous
- whitespace will appear in the HTML version.
- </p></dd></dl></div></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="s1-vim-additional-resources.php">Prev</a> </td><td
width="20%" align="center"><a accesskey="u"
href="index.php">Up</a></td><td width="40%"
align="right"> <a accesskey="n"
href="s1-xml-tags-application.php">Next</a></td></tr><tr><td
width="40%" align="left"
valign="top">5.3. Additional VIM
Resources </td><td width="20%"
align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right"
valign="top"> 6.2. application</td></tr></table></div>
-
+ </p><div class="itemizedlist"><ul
type="disc"><li><p><code
class="sgmltag-starttag"><trademark></code>trademark
symbol after
+ me<code
class="sgmltag-endtag"></trademark></code>
+ </p></li><li><p><code
class="sgmltag-starttag"><trademark
+ class="registered"></code>registered trademark symbol
+ after me<code
class="sgmltag-endtag"></trademark></code>
+ </p></li><li><p><code
class="sgmltag-starttag"><trademark
+ class="copyright"></code>copyright symbol after
+ me<code
class="sgmltag-endtag"></trademark></code></p></li></ul></div></dd><dt><span
class="term">Content inside <code
class="sgmltag-element">para</code>
tags</span></dt><dd><p>Do not use <code
class="sgmltag-element">para</code> tags around
+ anything other than a simple paragraph. Doing so will create
+ additional white space within the text itself in the PDF
+ version.
+ </p><p>Specifically, do not use <code
class="sgmltag-element">para</code> tags
+ around the following (or, to put this another way, do not
+ embed the following within <code
class="sgmltag-element">para</code> tags):
+ </p><div class="itemizedlist"><ul
type="disc"><li><p><code
class="sgmltag-element">screen</code></p></li><li><p><code
class="sgmltag-element">itemizedlist</code></p></li><li><p><code
class="sgmltag-element">orderedlist</code></p></li><li><p><code
class="sgmltag-element">variablelist</code></p></li><li><p><code
class="sgmltag-element">table</code></p></li></ul></div></dd><dt><span
class="term">Content inside <code
class="sgmltag-element">para</code> tags within
+ <code class="sgmltag-element">listitem</code>
tags</span></dt><dd><p>Content inside <code
class="sgmltag-element">para</code> tags within
+ <code class="sgmltag-element">listitem</code> tags <span
class="emphasis"><em>must</em></span>
+ start immediately after the beginning <code
class="sgmltag-starttag"><para></code> tag to avoid extra
white
+ space in the PDF version.
+ </p></dd><dt><span class="term">Content inside
<code class="sgmltag-element">screen</code>
tags</span></dt><dd><p>The content inside <code
class="sgmltag-element">screen</code> tags
+ (<code class="sgmltag-starttag"><screen></code>
and <code class="sgmltag-endtag"></screen></code>)
+ <span class="emphasis"><em>must</em></span> be
flush left in the XML file;
+ otherwise, the extraneous whitespace will appear in the HTML
+ version.
+ </p></dd></dl></div></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="sn-vim-additional-resources.php">Prev</a>��</td><td
width="20%" align="center">��</td><td
width="40%" align="right">��<a accesskey="n"
href="sn-xml-tags-application.php">Next</a></td></tr><tr><td
width="40%" align="left" valign="top">5.3.��Additional
VIM Resources��</td><td width="20%" align="center"><a
accesskey="h" href="index.php">Home</a></td><td
width="40%" align="right" valign="top">��6.2.��<code
class="sgmltag-element">application</code></td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: generated-index.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/generated-index.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- generated-index.php 6 Dec 2005 19:37:14 -0000 1.1
+++ generated-index.php 23 Jun 2007 05:42:10 -0000 1.2
@@ -2,21 +2,25 @@
include("site.inc");
$template = new Page;
-$template->initCommon();
+$template->initCommon();
$template->displayHeader();
?>
-<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Index</th></tr><tr><td
width="20%" align="left"><a accesskey="p"
href="acknowledgments.php">Prev</a> </td><th
width="60%" align="center"> </th><td
width="20%"
align="right"> </td></tr></table><hr></div><div
class="index"><div
class="titlepage"><div><div><h2
class="title"><a
name="generated-index"></a>Index</h2></div></div><div></div></div><div
class="index"><div
class="indexdiv"><h3>Symbols</h3><dl><dt>.cvsrc
- , <a href="sn-cvs-config.php">Configuring For CVS
Access</a></dt><dt>.emacs, <a
href="ch-emacs.php#s1-emacs-file">Setting Up Your .emacs
File</a></dt><dt>.Xresources, <a
href="s1-emacs-colors.php">Customizing
Emacs</a></dt></dl></div><div
class="indexdiv"><h3>A</h3><dl><dt>admonitions, <a
href="s1-xml-admon.php">Admonitions</a></dt></dl></div><div
class="indexdiv"><h3>B</h3><dl><dt>Beer, <a
href="s1-xml-tags-indexing.php">Index
Entries</a></dt></dl></div><div
class="indexdiv"><h3>C</h3><dl><dt>cvs, <a
href="ch-cvs.php">CVS</a></dt><dd><dl><dt>.cvsrc
- , <a href="sn-cvs-config.php">Configuring For CVS
Access</a></dt><dt>adding files, <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-add">Adding
Files</a></dt><dt>anonymous access, <a
href="sn-cvs-config.php#sn-cvs-config-anon">Configuring for Read-Only CVS
Access</a></dt><dt>avoiding repetitive typing, <a
href="sn-cvs-config.php#sn-cvs-config-cvsrc">Avoiding Repetitive
Typing</a></dt><dt>binary files, <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-admin">Managing Binary
Files</a></dt><dt>check out
modules</dt><dd><dl><dt>checking out branches, <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co-branch">Checking Out
Branches of Modules</a></dt></dl></dd><dt>checking out
modules, <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co">Checking
Out Modules</a></dt><dt>commands, <a
href="sn-cvs-cvscommands.php">Basic CVS
Commands</a></dt><dd><dl><dt>summary of, <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-summary">Summary</a></dt></dl></dd><dt>committing
file!
s, <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-commit">Committing
Files</a></dt><dt>configuring access for authors, <a
href="sn-cvs-config.php#sn-cvs-config-author">Configuring Read/Write CVS
Access</a></dt><dt>configuring for access, <a
href="sn-cvs-config.php">Configuring For CVS
Access</a></dt><dt>configuring read-only access, <a
href="sn-cvs-config.php#sn-cvs-config-anon">Configuring for Read-Only CVS
Access</a></dt><dt>configuring read/write access, <a
href="sn-cvs-config.php#sn-cvs-config-author">Configuring Read/Write CVS
Access</a></dt><dt>CVSROOT, <a
href="sn-cvs-config.php">Configuring For CVS
Access</a></dt><dt>CVS_RSH, <a
href="sn-cvs-config.php">Configuring For CVS
Access</a></dt><dt>how it works, <a
href="ch-cvs.php#sn-cvs-overview">How CVS
Works</a></dt><dt>overview, <a
href="ch-cvs.php#sn-cvs-overview">How CVS
Works</a></dt><dt>preparing for use, <a
href="sn-cvs-preparation.php">Preparing For CVS
Use</a></dt><dt>removing files, <a href="sn-cvs-cvscomm!
ands.php#sn-cvs-cvscommands-rm">Removing
Files</a></dt><dt>res!
olving
nflicts, <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts">Resolving
Conflicts</a></dt><dt>RPM installation, <a
href="sn-cvs-preparation.php#sn-cvs-rpm-check">Is CVS Installed On Your
System</a></dt><dt>status of files, <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-status">Status of
Files</a></dt><dt>updating files, <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-up">Updating
Files</a></dt></dl></dd><dt>CVSROOT, <a
href="sn-cvs-config.php">Configuring For CVS
Access</a></dt><dt>CVS_RSH, <a
href="sn-cvs-config.php">Configuring For CVS
Access</a></dt></dl></div><div
class="indexdiv"><h3>D</h3><dl><dt>diagrams</dt><dd><dl><dt>creating,
<a href="s1-diagrams-images.php">Diagrams and
Images</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>E</h3><dl><dt>Emacs, <a
href="ch-emacs.php">Emacs and PSGML Mode</a>, <a
href="ch-emacs-nxml.php">Emacs and nXML
Mode</a></dt><dd><dl><dt>colors, <a
href="s1-emacs-colors.php">Customizing
Emacs</a></dt><dt>configuration !
file, <a href="ch-emacs.php#s1-emacs-file">Setting Up Your .emacs
File</a></dt><dt>customizing, <a
href="s1-emacs-colors.php">Customizing
Emacs</a></dt><dt>font, <a
href="s1-emacs-colors.php">Customizing
Emacs</a></dt><dt>geometry, <a
href="s1-emacs-colors.php">Customizing
Emacs</a></dt><dt>nXML mode, <a
href="ch-emacs-nxml.php">Emacs and nXML
Mode</a></dt><dt>PSGML mode, <a
href="ch-emacs.php">Emacs and PSGML
Mode</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>F</h3><dl><dt>foo</dt><dd><dl><dt>bar,
<a href="s1-xml-tags-indexing.php">Index
Entries</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>G</h3><dl><dt>Guinness (see
Beer)</dt></dl></div><div
class="indexdiv"><h3>H</h3><dl><dt>humor</dt><dd><dl><dt>RTFM,
<a href="ch-rh-guidelines.php">Red Hat Documentation
Guidelines</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>I</h3><dl><dt>images, <a
href="s1-diagrams-images.php">Diagrams and
Images</a></dt><dt>indexing, <a
href="s1-xml-tags-indexing.php">Ind!
ex Entries</a></dt><dd><dl><dt>see tag, <a
href="s1-xml-tags-i!
ndexin
hp">Index Entries</a></dt><dt>seealso tag, <a
href="s1-xml-tags-indexing.php">Index
Entries</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>L</h3><dl><dt>lists</dt><dd><dl><dt>creating,
<a
href="s1-xml-tags-lists.php">Lists</a></dt><dt>glosslist,
<a
href="s1-xml-tags-lists.php#s2-xml-tags-glossary">glosslist</a></dt><dt>itemizedlist,
<a
href="s1-xml-tags-lists.php#s2-xml-tags-itemizedlist">itemizedlist</a></dt><dt>orderedlist,
<a
href="s1-xml-tags-lists.php#s2-xml-tags-orderedlist">OrderedList</a></dt><dt>simplelist,
<a href="s1-xml-tags-lists.php#s2-xml-tags-simplelist">Creating a List
Within a Table Using Simplelist</a></dt><dt>variablelist, <a
href="s1-xml-tags-lists.php#s2-xml-tags-varlist">Variablelist</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>N</h3><dl><dt>naming
conventions, <a href="ch-rh-guidelines.php#s1-xml-guidelines-naming">ID
Naming Conventions</a></dt><dd><dl><dt>rules for defining an
ID, <a href="ch-rh-guidelines.php#s1-xml-guidelines-nami!
ng">ID Naming
Conventions</a></dt></dl></dd><dt>nXML, <a
href="ch-emacs-nxml.php">Emacs and nXML
Mode</a></dt><dd><dl><dt>RPM, <a
href="ch-emacs-nxml.php#s1-nxml-rpm">Getting the nXML
RPM</a></dt></dl></dd><dt>nXML RPM, <a
href="ch-emacs-nxml.php#s1-nxml-rpm">Getting the nXML
RPM</a></dt></dl></div><div
class="indexdiv"><h3>O</h3><dl><dt>OpenSSH</dt><dd><dl><dt>authorization
keys, <a href="sn-cvs-preparation.php#sn-cvs-generate-keys">Generating SSH
Keys</a></dt><dt>ssh-keygen
- , <a
href="sn-cvs-preparation.php#sn-cvs-generate-keys">Generating SSH
Keys</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>P</h3><dl><dt>parts, <a
href="s1-xml-tags-part.php">part</a></dt><dt>PSGML, <a
href="ch-emacs.php">Emacs and PSGML
Mode</a></dt></dl></div><div
class="indexdiv"><h3>R</h3><dl><dt>recursion (see
recursion)</dt><dt>RTFM</dt><dd><dl><dt>read the
f*'ing manual, <a href="ch-rh-guidelines.php">Red Hat Documentation
Guidelines</a></dt><dd><dl><dt>(see also
humor)</dt></dl></dd></dl></dd></dl></div><div
class="indexdiv"><h3>S</h3><dl><dt>Salutations, <a
href="s1-xml-tags-indexing.php">Index
Entries</a></dt><dt>screen captures (see
screenshots)</dt><dt>screen grabs (see
screenshots)</dt><dt>screenshots</dt><dd><dl><dt>how
to take, <a
href="s1-screenshots.php">Screenshots</a></dt></dl></dd><dt>sections,
<a
href="s1-xml-tags-sections.php">Sections</a></dt><dt>ssh-keygen
- , <a
href="sn-cvs-preparation.php#sn-cvs-generate-keys">Generating SSH
Keys</a></dt><dt>style, <a
href="ch-style.php#sn-intro-to-style">Why Style Is
Important</a></dt><dt>SWAK, <a
href="s1-xml-tags-indexing.php">Index
Entries</a></dt><dd><dl><dt>(see also
Salutations)</dt></dl></dd></dl></div><div
class="indexdiv"><h3>T</h3><dl><dt>tables</dt><dd><dl><dt>creating
a list within a table</dt><dd><dl><dt>simplelist, <a
href="s1-xml-tags-lists.php#s2-xml-tags-simplelist">Creating a List Within a
Table Using
Simplelist</a></dt></dl></dd></dl></dd><dt>tutorial
layout</dt><dd><dl><dt>license, <a
href="s1-tutorial-license.php">Including the License
Information</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>V</h3><dl><dt>VIM, <a
href="ch-vim.php">VIM and
DocBook</a></dt><dd><dl><dt>configuration file, <a
href="ch-vim.php#s1-vimrc-file">Setting Up Your .vimrc
File</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>X</h3><dl><dt>XML</dt><dd><dl><dt>general
tag inf!
ormation, <a href="ch-xml-tags.php">DocBook XML
Tags</a></dt><dt>tags (see XML
tags)</dt></dl></dd><dt>XML
tags</dt><dd><dl><dt>admonitions</dt><dd><dl><dt>caution,
<a
href="s1-xml-admon.php">Admonitions</a></dt><dt>important,
<a href="s1-xml-admon.php">Admonitions</a></dt><dt>note,
<a href="s1-xml-admon.php">Admonitions</a></dt><dt>tip,
<a
href="s1-xml-admon.php">Admonitions</a></dt><dt>warning,
<a
href="s1-xml-admon.php">Admonitions</a></dt></dl></dd><dt>application,
<a
href="s1-xml-tags-application.php">application</a></dt><dt>caution,
<a href="s1-xml-admon.php">Admonitions</a>, <a
href="s1-xml-admon.php#s2-xml-notesetc">Creating Notes, Tips, Cautions,
Importants, and Warnings</a></dt><dt>chapter, <a
href="s1-xml-tags-chapter.php">chapter</a></dt><dt>citetitle,
<a
href="s1-xml-tags-citetitle.php">citetitle</a></dt><dt>command,
<a
href="s1-xml-tags-command.php">command</a></dt><dt>computeroutput,
<a
href="s1-xml-tags-compoutput.php">computeroutput</a></dt><dt>emphasis,
<a!
href="s1-xml-tags-emphasis.php">emphasis</a></dt><dt>example,!
<a hr
"s1-xml-tags-example.php">example</a></dt><dt>figure, <a
href="s1-xml-tags-figure.php">figure</a></dt><dt>filename,
<a
href="s1-xml-tags-filename.php">filename</a></dt><dt>firstterm,
<a
href="s1-xml-tags-firstterm.php">firstterm</a></dt><dt>footnote,
<a
href="s1-xml-tags-footnote.php">footnote</a></dt><dt>glosslist,
<a
href="s1-xml-tags-lists.php#s2-xml-tags-glossary">glosslist</a></dt><dt>GUI
tags, <a href="s1-xml-tags-gui.php">GUI
Tags</a></dt><dd><dl><dt>guibutton, <a
href="s1-xml-tags-gui.php#s2-xml-tags-guibutton">guibutton</a></dt><dt>guiicon,
<a
href="s1-xml-tags-gui.php#s2-xml-tags-guiicon">guiicon</a></dt><dt>guilabel,
<a
href="s1-xml-tags-gui.php#s2-xml-tags-guilabel">guilabel</a></dt><dt>guimenu,
<a href="s1-xml-tags-gui.php#s2-xml-tags-guimenu">guimenu and
- guimenuitem</a></dt><dt>guimenuitem, <a
href="s1-xml-tags-gui.php#s2-xml-tags-guimenu">guimenu and
- guimenuitem</a></dt></dl></dd><dt>guibutton, <a
href="s1-xml-tags-gui.php#s2-xml-tags-guibutton">guibutton</a></dt><dt>guiicon,
<a
href="s1-xml-tags-gui.php#s2-xml-tags-guiicon">guiicon</a></dt><dt>guilabel,
<a
href="s1-xml-tags-gui.php#s2-xml-tags-guilabel">guilabel</a></dt><dt>guimenu,
<a href="s1-xml-tags-gui.php#s2-xml-tags-guimenu">guimenu and
- guimenuitem</a></dt><dt>guimenuitem, <a
href="s1-xml-tags-gui.php#s2-xml-tags-guimenu">guimenu and
- guimenuitem</a></dt><dt>important, <a
href="s1-xml-admon.php">Admonitions</a>, <a
href="s1-xml-admon.php#s2-xml-notesetc">Creating Notes, Tips, Cautions,
Importants, and Warnings</a></dt><dt>indexing, <a
href="s1-xml-tags-indexing.php">Index
Entries</a></dt><dt>itemizedlist, <a
href="s1-xml-tags-lists.php#s2-xml-tags-itemizedlist">itemizedlist</a></dt><dt>keycap,
<a
href="s1-xml-tags-keycap.php">keycap</a></dt><dt>keycombo,
<a
href="s1-xml-tags-keycap.php#s2-xml-tags-keycombo">keycombo</a></dt><dt>lists</dt><dd><dl><dt>glosslist,
<a
href="s1-xml-tags-lists.php#s2-xml-tags-glossary">glosslist</a></dt><dt>itemizedlist,
<a
href="s1-xml-tags-lists.php#s2-xml-tags-itemizedlist">itemizedlist</a></dt><dt>orderedlist,
<a
href="s1-xml-tags-lists.php#s2-xml-tags-orderedlist">OrderedList</a></dt><dt>simplelist,
<a href="s1-xml-tags-lists.php#s2-xml-tags-simplelist">Creating a List
Within a Table Using Simplelist</a></dt><dt>variablelist, <a
href="s1-xml-tags-lists.php#s2-xml-tags-v!
arlist">Variablelist</a></dt></dl></dd><dt>menuchoice,
<a
href="s1-xml-tags-keycap.php#s2-xml-tags-menuchoice">menuchoice</a></dt><dt>naming
conventions, <a href="ch-rh-guidelines.php#s1-xml-guidelines-naming">ID
Naming Conventions</a></dt><dt>note, <a
href="s1-xml-admon.php">Admonitions</a>, <a
href="s1-xml-admon.php#s2-xml-notesetc">Creating Notes, Tips, Cautions,
Importants, and Warnings</a></dt><dt>option, <a
href="s1-xml-tags-option.php">option</a></dt><dt>orderedlist,
<a
href="s1-xml-tags-lists.php#s2-xml-tags-orderedlist">OrderedList</a></dt><dt>para,
<a href="s1-xml-tags-para.php">para</a></dt><dt>part,
<a href="s1-xml-tags-part.php">part</a></dt><dt>prompt,
<a
href="s1-xml-tags-prompt.php">prompt</a></dt><dt>replaceable,
<a
href="s1-xml-tags-replaceable.php">replaceable</a></dt><dt>rules
for defining an ID, <a
href="ch-rh-guidelines.php#s1-xml-guidelines-naming">ID Naming
Conventions</a></dt><dt>screen, <a
href="s1-xml-tags-screen.php">screen</a></dt><dt>sections,
!
<a
href="s1-xml-tags-sections.php">Sections</a></dt><dt>simple!
list,
href="s1-xml-tags-lists.php#s2-xml-tags-simplelist">Creating a List Within a
Table Using Simplelist</a></dt><dt>table, <a
href="s1-xml-tags-table.php">table</a></dt><dd><dl><dt>list
within a table, <a
href="s1-xml-tags-table.php#s2-xml-tags-listintable">Creating a List Within a
Table</a></dt></dl></dd><dt>tip, <a
href="s1-xml-admon.php">Admonitions</a>, <a
href="s1-xml-admon.php#s2-xml-notesetc">Creating Notes, Tips, Cautions,
Importants, and Warnings</a></dt><dt>trademark, <a
href="s1-xml-tags-trademark.php">trademark</a></dt><dt>ulink,
<a
href="s1-xml-tag-sulink.php">ulink</a></dt><dt>userinput,
<a
href="s1-xml-tags-userinput.php">userinput</a></dt><dt>variablelist,
<a
href="s1-xml-tags-lists.php#s2-xml-tags-varlist">Variablelist</a></dt><dt>warning,
<a href="s1-xml-admon.php">Admonitions</a>, <a
href="s1-xml-admon.php#s2-xml-notesetc">Creating Notes, Tips, Cautions,
Importants, and Warnings</a></dt><dt>wordasword, <a
href="s1-xml-tags-wordasword.php">wordasword</a></dt><d!
t>xref, <a
href="s1-xml-tags-xref.php">xref</a></dt></dl></dd><dt>xml
tags</dt><dd><dl><dt>caveats, <a
href="ch-xml-tags.php#s1-xml-tags-caveats">Tags and Entities
Caveats</a></dt></dl></dd></dl></div></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="acknowledgments.php">Prev</a> </td><td
width="20%" align="center"><a accesskey="u"
href="index.php">Up</a></td><td width="40%"
align="right"> </td></tr><tr><td
width="40%" align="left"
valign="top">Chapter 11. Acknowledgments </td><td
width="20%" align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right"
valign="top"> </td></tr></table></div>
-
+<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Index</th></tr><tr><td
width="20%" align="left"><a accesskey="p"
href="acknowledgments.php">Prev</a>��</td><th
width="60%" align="center">��</th><td
width="20%"
align="right">��</td></tr></table><hr></div><div
class="index" id="generated-index"><div
class="titlepage"><div><div><h2
class="title"><a
name="generated-index"></a>Index</h2></div></div></div><div
class="index"><div
class="indexdiv"><h3>Symbols</h3><dl><dt>.cvsrc
+ , <a href="sn-cvs-config.php">Configuring For CVS
Access</a></dt><dt>.emacs, <a
href="sn-emacs-file.php">Setting Up Your .emacs
File</a></dt><dt>.Xresources, <a
href="sn-emacs-colors.php">Customizing
Emacs</a></dt></dl></div><div
class="indexdiv"><h3>A</h3><dl><dt>admonitions, <a
href="sn-xml-admon.php">Admonitions</a></dt></dl></div><div
class="indexdiv"><h3>B</h3><dl><dt>Beer, <a
href="sn-xml-tags-indexing.php">Index
Entries</a></dt></dl></div><div
class="indexdiv"><h3>C</h3><dl><dt>cvs, <a
href="ch-cvs.php">CVS</a></dt><dd><dl><dt>.cvsrc
+ , <a href="sn-cvs-config.php">Configuring For CVS
Access</a></dt><dt>adding files, <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-add">Adding
Files</a></dt><dt>anonymous access, <a
href="sn-cvs-config.php#sn-cvs-config-anon">Configuring for Read-Only CVS
Access</a></dt><dt>avoiding repetitive typing, <a
href="sn-cvs-config.php#sn-cvs-config-cvsrc">Avoiding Repetitive
Typing</a></dt><dt>binary files, <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-admin">Managing Binary
Files</a></dt><dt>check out
modules</dt><dd><dl><dt>checking out branches, <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co-branch">Checking Out
Branches of Modules</a></dt></dl></dd><dt>checking out
modules, <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co">Checking
Out Modules</a></dt><dt>commands, <a
href="sn-cvs-cvscommands.php">Basic CVS
Commands</a></dt><dd><dl><dt>summary of, <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-summary">Summary</a></dt></dl></dd><dt>committing
file!
s, <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-commit">Committing
Files</a></dt><dt>configuring access for authors, <a
href="sn-cvs-config.php#sn-cvs-config-author">Configuring Read/Write CVS
Access</a></dt><dt>configuring for access, <a
href="sn-cvs-config.php">Configuring For CVS
Access</a></dt><dt>configuring read-only access, <a
href="sn-cvs-config.php#sn-cvs-config-anon">Configuring for Read-Only CVS
Access</a></dt><dt>configuring read/write access, <a
href="sn-cvs-config.php#sn-cvs-config-author">Configuring Read/Write CVS
Access</a></dt><dt>CVSROOT, <a
href="sn-cvs-config.php">Configuring For CVS
Access</a></dt><dt>CVS_RSH, <a
href="sn-cvs-config.php">Configuring For CVS
Access</a></dt><dt>how it works, <a
href="ch-cvs.php#sn-cvs-overview">How CVS
Works</a></dt><dt>overview, <a
href="ch-cvs.php#sn-cvs-overview">How CVS
Works</a></dt><dt>preparing for use, <a
href="sn-cvs-preparation.php">Preparing For CVS
Use</a></dt><dt>removing files, <a href="sn-cvs-cvscomm!
ands.php#sn-cvs-cvscommands-rm">Removing
Files</a></dt><dt>res!
olving
nflicts, <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts">Resolving
Conflicts</a></dt><dt>RPM installation, <a
href="sn-cvs-preparation.php#sn-cvs-rpm-check">Is CVS Installed On Your
System</a></dt><dt>status of files, <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-status">Status of
Files</a></dt><dt>updating files, <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-up">Updating
Files</a></dt></dl></dd><dt>CVSROOT, <a
href="sn-cvs-config.php">Configuring For CVS
Access</a></dt><dt>CVS_RSH, <a
href="sn-cvs-config.php">Configuring For CVS
Access</a></dt></dl></div><div
class="indexdiv"><h3>E</h3><dl><dt>Emacs, <a
href="ch-emacs.php">Emacs and PSGML
Mode</a></dt><dd><dl><dt>colors, <a
href="sn-emacs-colors.php">Customizing
Emacs</a></dt><dt>configuration file, <a
href="sn-emacs-file.php">Setting Up Your .emacs
File</a></dt><dt>customizing, <a
href="sn-emacs-colors.php">Customizing
Emacs</a></dt><dt>font, <a
href="sn-emacs-colors.php">Customizing Emacs</a></dt><!
dt>geometry, <a href="sn-emacs-colors.php">Customizing
Emacs</a></dt><dt>PSGML mode, <a
href="ch-emacs.php">Emacs and PSGML
Mode</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>F</h3><dl><dt>foo</dt><dd><dl><dt>bar,
<a href="sn-xml-tags-indexing.php">Index
Entries</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>G</h3><dl><dt>Guinness (see
Beer)</dt></dl></div><div
class="indexdiv"><h3>H</h3><dl><dt>humor</dt><dd><dl><dt>RTFM,
<a href="ch-writing-guidelines.php">Fedora Documentation
Guidelines</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>I</h3><dl><dt>indexing, <a
href="sn-xml-tags-indexing.php">Index
Entries</a></dt><dd><dl><dt>see tag, <a
href="sn-xml-tags-indexing.php">Index
Entries</a></dt><dt>seealso tag, <a
href="sn-xml-tags-indexing.php">Index
Entries</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>L</h3><dl><dt>lists</dt><dd><dl><dt>creating,
<a
href="sn-xml-tags-lists.php">Lists</a></dt><dt>glosslist,
<a href="sn-xml-tags-lists.php#sn-!
xml-tags-glossary">glosslist</a></dt><dt>itemizedlist, <a
href!
="sn-x
tags-lists.php#sn-xml-tags-itemizedlist">itemizedlist</a></dt><dt>orderedlist,
<a
href="sn-xml-tags-lists.php#sn-xml-tags-orderedlist">OrderedList</a></dt><dt>simplelist,
<a href="sn-xml-tags-lists.php#sn-xml-tags-simplelist">Creating a List
Within a Table Using Simplelist</a></dt><dt>variablelist, <a
href="sn-xml-tags-lists.php#sn-xml-tags-varlist">Variablelist</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>N</h3><dl><dt>naming
conventions, <a
href="ch-writing-guidelines.php#sn-id-naming-conventions">ID Naming
Conventions</a></dt><dd><dl><dt>rules for defining an ID,
<a href="ch-writing-guidelines.php#sn-id-naming-conventions">ID Naming
Conventions</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>O</h3><dl><dt>OpenSSH</dt><dd><dl><dt>authorization
keys, <a href="sn-cvs-preparation.php#sn-cvs-generate-keys">Generating SSH
Keys</a></dt><dt>ssh-keygen
+ , <a
href="sn-cvs-preparation.php#sn-cvs-generate-keys">Generating SSH
Keys</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>P</h3><dl><dt>parts, <a
href="sn-xml-tags-part.php">part</a></dt><dt>PSGML, <a
href="ch-emacs.php">Emacs and PSGML
Mode</a></dt></dl></div><div
class="indexdiv"><h3>R</h3><dl><dt>recursion (see
recursion)</dt><dt>RTFM</dt><dd><dl><dt>read the fine
manual, <a href="ch-writing-guidelines.php">Fedora Documentation
Guidelines</a></dt><dd><dl><dt>(see also
humor)</dt></dl></dd></dl></dd></dl></div><div
class="indexdiv"><h3>S</h3><dl><dt>Salutations, <a
href="sn-xml-tags-indexing.php">Index
Entries</a></dt><dt>screen captures (see
screenshots)</dt><dt>screen grabs (see
screenshots)</dt><dt>screenshots</dt><dd><dl><dt>how
to take, <a
href="sn-screenshots.php">Screenshots</a></dt></dl></dd><dt>sections,
<a
href="sn-xml-tags-sections.php">Sections</a></dt><dt>ssh-keygen
+ , <a
href="sn-cvs-preparation.php#sn-cvs-generate-keys">Generating SSH
Keys</a></dt><dt>SWAK, <a
href="sn-xml-tags-indexing.php">Index
Entries</a></dt><dd><dl><dt>(see also
Salutations)</dt></dl></dd></dl></div><div
class="indexdiv"><h3>T</h3><dl><dt>tables</dt><dd><dl><dt>creating
a list within a table</dt><dd><dl><dt>simplelist, <a
href="sn-xml-tags-lists.php#sn-xml-tags-simplelist">Creating a List Within a
Table Using
Simplelist</a></dt></dl></dd></dl></dd><dt>tutorial
layout</dt><dd><dl><dt>article, <a
href="ch-tutorial.php#sn-tutorial-article">The
Article</a></dt><dt>metadata, <a
href="sn-tutorial-metadata.php">The
Metadata</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>V</h3><dl><dt>VIM, <a
href="ch-vim.php">VIM and
DocBook</a></dt><dd><dl><dt>configuration file, <a
href="ch-vim.php#sn-vimrc-file">Setting Up Your .vimrc
File</a></dt></dl></dd></dl></div><div
class="indexdiv"><h3>X</h3><dl><dt>XML</dt><dd><dl><dt>general
tag information, <a href="ch-x!
ml-tags.php">DocBook XML Tags</a></dt><dt>tags (see XML
tags)</dt></dl></dd><dt>XML
tags</dt><dd><dl><dt>admonitions</dt><dd><dl><dt>caution,
<a
href="sn-xml-admon.php">Admonitions</a></dt><dt>important,
<a href="sn-xml-admon.php">Admonitions</a></dt><dt>note,
<a href="sn-xml-admon.php">Admonitions</a></dt><dt>tip,
<a
href="sn-xml-admon.php">Admonitions</a></dt><dt>warning,
<a
href="sn-xml-admon.php">Admonitions</a></dt></dl></dd><dt>application,
<a
href="sn-xml-tags-application.php">application</a></dt><dt>caution,
<a href="sn-xml-admon.php">Admonitions</a>, <a
href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
+ tip, caution, important, or warning</a></dt><dt>chapter, <a
href="sn-xml-tags-chapter.php">chapter</a></dt><dt>citetitle,
<a
href="sn-xml-tags-citetitle.php">citetitle</a></dt><dt>command,
<a
href="sn-xml-tags-command.php">command</a></dt><dt>computeroutput,
<a
href="sn-xml-tags-compoutput.php">computeroutput</a></dt><dt>emphasis,
<a
href="sn-xml-tags-emphasis.php">emphasis</a></dt><dt>example,
<a
href="sn-xml-tags-example.php">example</a></dt><dt>figure,
<a
href="sn-xml-tags-figure.php">figure</a></dt><dt>filename,
<a
href="sn-xml-tags-filename.php">filename</a></dt><dt>firstterm,
<a
href="sn-xml-tags-firstterm.php">firstterm</a></dt><dt>footnote,
<a
href="sn-xml-tags-footnote.php">footnote</a></dt><dt>glosslist,
<a
href="sn-xml-tags-lists.php#sn-xml-tags-glossary">glosslist</a></dt><dt>GUI
tags, <a href="sn-xml-tags-gui.php">GUI
Tags</a></dt><dd><dl><dt>guibutton, <a
href="sn-xml-tags-gui.php#sn-xml-tags-guibutton">guibutton</a></dt><dt>guiicon,
<a href="sn-xml-tags-gui.!
php#sn-xml-tags-guiicon">guiicon</a></dt><dt>guilabel, <a
href="sn-xml-tags-gui.php#sn-xml-tags-guilabel">guilabel</a></dt><dt>guimenu,
<a href="sn-xml-tags-gui.php#sn-xml-tags-guimenu">guimenu and
+ guimenuitem</a></dt><dt>guimenuitem, <a
href="sn-xml-tags-gui.php#sn-xml-tags-guimenu">guimenu and
+ guimenuitem</a></dt></dl></dd><dt>guibutton, <a
href="sn-xml-tags-gui.php#sn-xml-tags-guibutton">guibutton</a></dt><dt>guiicon,
<a
href="sn-xml-tags-gui.php#sn-xml-tags-guiicon">guiicon</a></dt><dt>guilabel,
<a
href="sn-xml-tags-gui.php#sn-xml-tags-guilabel">guilabel</a></dt><dt>guimenu,
<a href="sn-xml-tags-gui.php#sn-xml-tags-guimenu">guimenu and
+ guimenuitem</a></dt><dt>guimenuitem, <a
href="sn-xml-tags-gui.php#sn-xml-tags-guimenu">guimenu and
+ guimenuitem</a></dt><dt>important, <a
href="sn-xml-admon.php">Admonitions</a>, <a
href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
+ tip, caution, important, or warning</a></dt><dt>indexing, <a
href="sn-xml-tags-indexing.php">Index
Entries</a></dt><dt>itemizedlist, <a
href="sn-xml-tags-lists.php#sn-xml-tags-itemizedlist">itemizedlist</a></dt><dt>keycap,
<a
href="sn-xml-tags-keycap.php">keycap</a></dt><dt>keycombo,
<a
href="sn-xml-tags-keycap.php#sn-xml-tags-keycombo">keycombo</a></dt><dt>lists</dt><dd><dl><dt>glosslist,
<a
href="sn-xml-tags-lists.php#sn-xml-tags-glossary">glosslist</a></dt><dt>itemizedlist,
<a
href="sn-xml-tags-lists.php#sn-xml-tags-itemizedlist">itemizedlist</a></dt><dt>orderedlist,
<a
href="sn-xml-tags-lists.php#sn-xml-tags-orderedlist">OrderedList</a></dt><dt>simplelist,
<a href="sn-xml-tags-lists.php#sn-xml-tags-simplelist">Creating a List
Within a Table Using Simplelist</a></dt><dt>variablelist, <a
href="sn-xml-tags-lists.php#sn-xml-tags-varlist">Variablelist</a></dt></dl></dd><dt>menuchoice,
<a
href="sn-xml-tags-keycap.php#sn-xml-tags-menuchoice">menuchoice</a></dt><dt>naming
conv!
entions, <a href="ch-writing-guidelines.php#sn-id-naming-conventions">ID
Naming Conventions</a></dt><dt>note, <a
href="sn-xml-admon.php">Admonitions</a>, <a
href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
+ tip, caution, important, or warning</a></dt><dt>option, <a
href="sn-xml-tags-option.php">option</a></dt><dt>orderedlist,
<a
href="sn-xml-tags-lists.php#sn-xml-tags-orderedlist">OrderedList</a></dt><dt>para,
<a href="sn-xml-tags-para.php">para</a></dt><dt>part,
<a href="sn-xml-tags-part.php">part</a></dt><dt>prompt,
<a
href="sn-xml-tags-prompt.php">prompt</a></dt><dt>replaceable,
<a
href="sn-xml-tags-replaceable.php">replaceable</a></dt><dt>rules
for defining an ID, <a
href="ch-writing-guidelines.php#sn-id-naming-conventions">ID Naming
Conventions</a></dt><dt>screen, <a
href="sn-xml-tags-screen.php">screen</a></dt><dt>sections,
<a
href="sn-xml-tags-sections.php">Sections</a></dt><dt>simplelist,
<a href="sn-xml-tags-lists.php#sn-xml-tags-simplelist">Creating a List
Within a Table Using Simplelist</a></dt><dt>table, <a
href="sn-xml-tags-table.php">table</a></dt><dd><dl><dt>list
within a table, <a
href="sn-xml-tags-table.php#sn-xml-tags-listintable">Creating a List Within a
Ta!
ble</a></dt></dl></dd><dt>tip, <a
href="sn-xml-admon.php">Admonitions</a>, <a
href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
+ tip, caution, important, or warning</a></dt><dt>trademark, <a
href="sn-xml-tags-trademark.php">trademark</a></dt><dt>ulink,
<a
href="sn-xml-tag-sulink.php">ulink</a></dt><dt>userinput,
<a
href="sn-xml-tags-userinput.php">userinput</a></dt><dt>variablelist,
<a
href="sn-xml-tags-lists.php#sn-xml-tags-varlist">Variablelist</a></dt><dt>warning,
<a href="sn-xml-admon.php">Admonitions</a>, <a
href="sn-xml-admon.php#sn-xml-notesetc">Creating a note,
+ tip, caution, important, or warning</a></dt><dt>wordasword, <a
href="sn-xml-tags-wordasword.php">wordasword</a></dt><dt>xref,
<a
href="sn-xml-tags-xref.php">xref</a></dt></dl></dd><dt>xml
tags</dt><dd><dl><dt>caveats, <a
href="ch-writing-guidelines.php#sn-id-naming-conventions">ID Naming
Conventions</a>, <a href="ch-xml-tags.php#sn-xml-tags-caveats">Tags
and Entities
Caveats</a></dt></dl></dd></dl></div></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="acknowledgments.php">Prev</a>��</td><td
width="20%" align="center">��</td><td
width="40%" align="right">��</td></tr><tr><td
width="40%" align="left"
valign="top">Chapter��9.��Acknowledgments��</td><td
width="20%" align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right"
valign="top">��</td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: index.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/index.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.php 6 Dec 2005 19:37:14 -0000 1.1
+++ index.php 23 Jun 2007 05:42:10 -0000 1.2
@@ -2,15 +2,14 @@
include("site.inc");
$template = new Page;
-$template->initCommon();
+$template->initCommon();
$template->displayHeader();
?>
-<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Fedora Project Documentation
Guide</th></tr><tr><td width="20%"
align="left"> </td><th width="60%"
align="center"> </th><td width="20%"
align="right"> <a accesskey="n"
href="ch-intro.php">Next</a></td></tr></table><hr></div><div
class="book" lang="en"><div
class="titlepage"><div><div><h1
class="title"><a name="documentation-guide"></a>Fedora
Project Documentation Guide</h1></div><div><h2
class="subtitle">Version 0.2.6.3</h2></div><div><div
class="authorgroup"><div class="author"><h3
class="author"><span class="firstname">Tammy</span>
<span class="surname">Fox</span></h3></div><div
class="author"><h3 class="author"><span
class="firstname">Johnray</span> <span
class="surname">Fuller</span></h3></div><div
class="author"><h3 class="author"><span
class="firstname">Sandra</span> <span
class="surname">Moore</span></h3></div></div></div><div><p
class="copyright">!
Copyright © 2003,2004,2005 Red Hat, Inc., Tammy Fox, Johnray Fuller, Sandra
Moore</p></div><div><a href="ln-legalnotice.php">Legal
Notice</a></div></div><div></div><hr></div><div
class="toc"><p><b>Table of
Contents</b></p><dl><dt><span
class="preface"><a
href="ch-intro.php">Introduction</a></span></dt><dt><span
class="chapter"><a href="ch-getting-files.php">1. Getting the
Files</a></span></dt><dt><span
class="chapter"><a href="ch-rh-guidelines.php">2. Red Hat
Documentation
Guidelines</a></span></dt><dd><dl><dt><span
class="sect1"><a
href="ch-rh-guidelines.php#s1-xml-guidelines-naming">2.1. ID Naming
Conventions</a></span></dt><dt><span
class="sect1"><a href="s1-xml-guidelines-header.php">2.2.
File Header</a></span></dt><dt><span
class="sect1"><a href="s1-xml-admon.php">2.3.
Admonitions</a></span></dt><dd><dl><dt><span
class="sect2"><a
href="s1-xml-admon.php#s2-xml-notesetc">2.3.1. Creating Notes, Tips,
Cautions, Importants, and
Warnings</a></span></dt></dl></dd><dt><sp!
an class="sect1"><a href="s1-screenshots.php">2.4.
Screenshots!
</a></
n></dt><dt><span class="sect1"><a
href="s1-diagrams-images.php">2.5. Diagrams and
Images</a></span></dt></dl></dd><dt><span
class="chapter"><a href="ch-emacs.php">3. Emacs and PSGML
Mode</a></span></dt><dd><dl><dt><span
class="sect1"><a href="ch-emacs.php#s1-emacs-file">3.1.
Setting Up Your .emacs File</a></span></dt><dt><span
class="sect1"><a href="s1-emacs-colors.php">3.2. Customizing
Emacs</a></span></dt><dt><span class="sect1"><a
href="s1-emacs-cedfile.php">3.3. Create Recompiled DTD
Subset</a></span></dt><dt><span
class="sect1"><a href="s1-emacs-loadced.php">3.4. Load the
Parsed DTD</a></span></dt><dt><span
class="sect1"><a href="s1-emacs-basic-commands.php">3.5.
Basic Emacs Commands</a></span></dt><dt><span
class="sect1"><a href="s1-emacs-examples.php">3.6.
Examples</a></span></dt><dd><dl><dt><span
class="sect2"><a
href="s1-emacs-examples.php#s2-emacs-tag-completion">3.6.1. Tag
Completion</a></span></dt><dt><span
class="sect2"><a href="s1-emacs-examples.php#s2-emacs-ta!
g-closing">3.6.2. Tag Closure</a></span></dt><dt><span
class="sect2"><a
href="s1-emacs-examples.php#s2-emacs-other">3.6.3. Other Emacs
Tasks</a></span></dt></dl></dd><dt><span
class="sect1"><a
href="s1-emacs-additional-resources.php">3.7. Additional
Resources</a></span></dt></dl></dd><dt><span
class="chapter"><a href="ch-emacs-nxml.php">4. Emacs and nXML
Mode</a></span></dt><dd><dl><dt><span
class="sect1"><a href="ch-emacs-nxml.php#s1-nxml-rpm">4.1.
Getting the nXML RPM</a></span></dt><dt><span
class="sect1"><a href="s1-nxml-examples.php">4.2.
Examples</a></span></dt><dd><dl><dt><span
class="sect2"><a
href="s1-nxml-examples.php#s2-nxml-commands">4.2.1.
Commands</a></span></dt></dl></dd><dt><span
class="sect1"><a
href="s1-emacs-nxml-additional-resources.php">4.3. Additional
Resources</a></span></dt><dt><span
class="sect1"><a href="s1-emacs-nxml-readme.php">4.4. nXML
README File</a></span></dt></dl></dd><dt><span
class="chapter"><a href="ch-vim.php">5. VIM and
DocBook</a></sp!
an></dt><dd><dl><dt><span class="sect1"><a
href="ch-vim.php#s1!
-vimrc
le">5.1. Setting Up Your .vimrc
File</a></span></dt><dt><span class="sect1"><a
href="s1-vim-keymapping.php">5.2. Keymapping with
VIM</a></span></dt><dt><span class="sect1"><a
href="s1-vim-additional-resources.php">5.3. Additional VIM
Resources</a></span></dt></dl></dd><dt><span
class="chapter"><a href="ch-xml-tags.php">6. DocBook XML
Tags</a></span></dt><dd><dl><dt><span
class="sect1"><a
href="ch-xml-tags.php#s1-xml-tags-caveats">6.1. Tags and Entities
Caveats</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-application.php">6.2.
application</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-chapter.php">6.3.
chapter</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-citetitle.php">6.4.
citetitle</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-command.php">6.5.
command</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-compoutput.php">6.6.
computeroutput</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-emphasis.php!
">6.7. emphasis</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-example.php">6.8.
example</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-filename.php">6.9.
filename</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-firstterm.php">6.10.
firstterm</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-footnote.php">6.11.
footnote</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-figure.php">6.12.
figure</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-gui.php">6.13. GUI
Tags</a></span></dt><dd><dl><dt><span
class="sect2"><a
href="s1-xml-tags-gui.php#s2-xml-tags-guilabel">6.13.1.
guilabel</a></span></dt><dt><span
class="sect2"><a
href="s1-xml-tags-gui.php#s2-xml-tags-guibutton">6.13.2.
guibutton</a></span></dt><dt><span
class="sect2"><a
href="s1-xml-tags-gui.php#s2-xml-tags-guiicon">6.13.3.
guiicon</a></span></dt><dt><span
class="sect2"><a
href="s1-xml-tags-gui.php#s2-xml-tags-guimenu">6.13.4. guimenu and
- guimenuitem</a></span></dt></dl></dd><dt><span
class="sect1"><a href="s1-xml-tags-keycap.php">6.14.
keycap</a></span></dt><dd><dl><dt><span
class="sect2"><a
href="s1-xml-tags-keycap.php#s2-xml-tags-menuchoice">6.14.1.
menuchoice</a></span></dt><dt><span
class="sect2"><a
href="s1-xml-tags-keycap.php#s2-xml-tags-keycombo">6.14.2.
keycombo</a></span></dt></dl></dd><dt><span
class="sect1"><a href="s1-xml-tags-lists.php">6.15.
Lists</a></span></dt><dd><dl><dt><span
class="sect2"><a
href="s1-xml-tags-lists.php#s2-xml-tags-itemizedlist">6.15.1.
itemizedlist</a></span></dt><dt><span
class="sect2"><a
href="s1-xml-tags-lists.php#s2-xml-tags-orderedlist">6.15.2.
OrderedList</a></span></dt><dt><span
class="sect2"><a
href="s1-xml-tags-lists.php#s2-xml-tags-varlist">6.15.3.
Variablelist</a></span></dt><dt><span
class="sect2"><a
href="s1-xml-tags-lists.php#s2-xml-tags-simplelist">6.15.4. Creating a List
Within a Table Using Simplelist</a></span></dt><dt><span
class="sect2"><a href="s1-!
xml-tags-lists.php#s2-xml-tags-glossary">6.15.5.
glosslist</a></span></dt></dl></dd><dt><span
class="sect1"><a href="s1-xml-tags-option.php">6.16.
option</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-indexing.php">6.17. Index
Entries</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-para.php">6.18.
para</a></span></dt><dt><span class="sect1"><a
href="s1-xml-tags-part.php">6.19.
part</a></span></dt><dt><span class="sect1"><a
href="s1-xml-tags-prompt.php">6.20.
prompt</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-replaceable.php">6.21.
replaceable</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-screen.php">6.22.
screen</a></span></dt><dd><dl><dt><span
class="sect2"><a
href="s1-xml-tags-screen.php#s2-xml-tags-screen-inline-tags">6.22.1. Using
Inline Tags with
screen</a></span></dt></dl></dd><dt><span
class="sect1"><a href="s1-xml-tags-sections.php">6.23.
Sections</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-table!
.php">6.24.
table</a></span></dt><dd><dl><dt><span
class="sect!
2"><a
f="s1-xml-tags-table.php#s2-xml-tags-listintable">6.24.1. Creating a List
Within a Table</a></span></dt></dl></dd><dt><span
class="sect1"><a href="s1-xml-tags-trademark.php">6.25.
trademark</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-userinput.php">6.26.
userinput</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tag-sulink.php">6.27.
ulink</a></span></dt><dt><span class="sect1"><a
href="s1-xml-tags-wordasword.php">6.28.
wordasword</a></span></dt><dt><span
class="sect1"><a href="s1-xml-tags-xref.php">6.29.
xref</a></span></dt></dl></dd><dt><span
class="chapter"><a href="ch-tutorial.php">7. The Layout of a
Tutorial</a></span></dt><dd><dl><dt><span
class="sect1"><a
href="ch-tutorial.php#s1-tutorial-parent">7.1. The Parent
File</a></span></dt><dt><span class="sect1"><a
href="s1-tutorial-license.php">7.2. Including the License
Information</a></span></dt></dl></dd><dt><span
class="chapter"><a href="ch-style.php">8.
Style</a></span></dt><dd><dl><dt><span class!
="section"><a href="ch-style.php#sn-intro-to-style">8.1. Why
Style Is Important</a></span></dt><dt><span
class="section"><a href="sn-tech-docs-fundamentals.php">8.2.
Fundamental Concepts of Technical
Documentation</a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-tech-docs-fundamentals.php#sn-fundamentals-1">8.2.1. General Style
Requirements</a></span></dt><dt><span
class="section"><a
href="sn-tech-docs-fundamentals.php#sn-fundamentals-2">8.2.2. Golden
Rules</a></span></dt><dt><span
class="section"><a
href="sn-tech-docs-fundamentals.php#sn-fundamentals-3">8.2.3.
Tone</a></span></dt><dt><span
class="section"><a
href="sn-tech-docs-fundamentals.php#sn-fundamentals-4">8.2.4. Reaching the
Right Audience</a></span></dt><dt><span
class="section"><a
href="sn-tech-docs-fundamentals.php#sn-fundamentals-6">8.2.5. User
Motivation</a></span></dt><dt><span
class="section"><a
href="sn-tech-docs-fundamentals.php#sn-fundamentals-7">8.2.6. New
Users</a></span></dt><dt><span class=!
"section"><a href="sn-tech-docs-fundamentals.php#sn-fundamenta!
ls-8">
.7. Experienced Users</a></span></dt><dt><span
class="section"><a
href="sn-tech-docs-fundamentals.php#sn-fundamentals-9">8.2.8. Do Not Offend
Your Audience</a></span></dt></dl></dd><dt><span
class="section"><a href="sn-grammar-and-usage.php">8.3.
Grammar and Usage Guidelines</a></span></dt><dt><span
class="section"><a href="sn-composition-tips.php">8.4.
Composition Tips</a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-composition-tips.php#sn-misc-active-voice">8.4.1. Active
Voice</a></span></dt><dt><span
class="section"><a
href="sn-composition-tips.php#sn-present-tense">8.4.2. Present
Tense</a></span></dt><dt><span
class="section"><a
href="sn-composition-tips.php#sn-narrative-voice">8.4.3. Narrative
Voice</a></span></dt><dt><span
class="section"><a
href="sn-composition-tips.php#sn-misc-negative">8.4.4. Negative
Words</a></span></dt><dt><span
class="section"><a
href="sn-composition-tips.php#sn-misc-uncertainty">8.4.5.
Uncertainty</a></span></dt><dt><span class="se!
ction"><a href="sn-composition-tips.php#sn-misc-offtopic">8.4.6.
Redundant Coverage</a></span></dt><dt><span
class="section"><a
href="sn-composition-tips.php#sn-misc-importance">8.4.7. Self-referential
Value Judgments</a></span></dt><dt><span
class="section"><a
href="sn-composition-tips.php#sn-misc-precision">8.4.8. Precision of
Language</a></span></dt><dt><span
class="section"><a
href="sn-composition-tips.php#sn-misc-docbook-tips">8.4.9. DocBook
Tips</a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-composition-tips.php#sn-misc-admonitions">8.4.9.1.
Admonitions</a></span></dt><dt><span
class="section"><a
href="sn-composition-tips.php#sn-misc-replaceable">8.4.9.2. The replaceable
- Tag</a></span></dt><dt><span
class="section"><a
href="sn-composition-tips.php#sn-misc-entities">8.4.9.3. XML
Entities</a></span></dt></dl></dd></dl></dd></dl></dd><dt><span
class="chapter"><a href="ch-converting.php">9. Converting to
HTML and PDF</a></span></dt><dt><span
class="chapter"><a href="ch-cvs.php">10.
CVS</a></span></dt><dd><dl><dt><span
class="section"><a href="ch-cvs.php#sn-cvs-overview">10.1.
How CVS Works</a></span></dt><dt><span
class="section"><a href="sn-cvs-preparation.php">10.2.
Preparing For CVS
Use</a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-cvs-preparation.php#sn-cvs-rpm-check">10.2.1. Is CVS Installed On
Your System</a></span></dt><dt><span
class="section"><a
href="sn-cvs-preparation.php#sn-cvs-generate-keys">10.2.2. Generating SSH
Keys</a></span></dt></dl></dd><dt><span
class="section"><a href="sn-cvs-config.php">10.3. Configuring
For CVS Access</a></span></dt><dd><dl><dt><span
class="section"><a href="sn-cvs-config.php#sn-cvs-con!
fig-cvsrc">10.3.1. Avoiding Repetitive
Typing</a></span></dt><dt><span
class="section"><a
href="sn-cvs-config.php#sn-cvs-config-anon">10.3.2. Configuring for Read-Only
CVS Access</a></span></dt><dt><span
class="section"><a
href="sn-cvs-config.php#sn-cvs-config-author">10.3.3. Configuring Read/Write
CVS Access</a></span></dt></dl></dd><dt><span
class="section"><a href="sn-cvs-cvscommands.php">10.4. Basic
CVS Commands</a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co">10.4.1. Checking Out
Modules</a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co-branch">10.4.1.1. Checking
Out Branches of
Modules</a></span></dt></dl></dd><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-up">10.4.2. Updating
Files</a></span></dt><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-commit">10.4.3. Committing
Files</a></span></dt><dt><span cl!
ass="section"><a href="sn-cvs-cvscommands.php#sn-cvs-cvscomman!
ds-add
0.4.4. Adding Files</a></span></dt><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-admin">10.4.5. Managing
Binary Files</a></span></dt><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-rm">10.4.6. Removing
Files</a></span></dt><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-status">10.4.7. Status of
Files</a></span></dt><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts">10.4.8. Resolving
Conflicts</a></span></dt><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-summary">10.4.9.
Summary</a></span></dt></dl></dd></dl></dd><dt><span
class="chapter"><a href="acknowledgments.php">11.
Acknowledgments</a></span></dt><dt><span
class="index"><a
href="generated-index.php">Index</a></span></dt></dl></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"> </td><td width="2!
0%" align="center"> </td><td width="40%"
align="right"> <a accesskey="n"
href="ch-intro.php">Next</a></td></tr><tr><td
width="40%" align="left"
valign="top"> </td><td width="20%"
align="center"> </td><td width="40%"
align="right"
valign="top"> Introduction</td></tr></table></div>
-
+<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">Fedora Documentation
Guide</th></tr><tr><td width="20%"
align="left">��</td><th width="60%"
align="center">��</th><td width="20%"
align="right">��<a accesskey="n"
href="ch-intro.php">Next</a></td></tr></table><hr></div><div
class="book" lang="en-US"
id="documentation-guide"><div
class="titlepage"><div><div><h1
class="title"><a name="documentation-guide"></a>Fedora
Documentation Guide</h1></div><div><div
class="authorgroup"><div class="author"><h3
class="author"><span class="firstname">Fedora
Documentation</span> <span
class="surname">Project</span></h3></div></div></div><div><p
class="releaseinfo">Version 0.3.0
(2007-06-23)</p></div><div><p
class="copyright">Copyright �� 2003, 2004, 2005, 2006, 2007 Red Hat, Inc. and
others</p></div><div><a
href="ln-legalnotice-opl.php">Legal
Notice</a></div><div><a
href="rv-revhistory.php">Revision
History</a></div></div><hr></div><div!
class="toc"><dl><dt><span class="preface"><a
href="ch-intro.php">Introduction</a></span></dt><dt><span
class="chapter"><a href="ch-getting-files.php">1.
Prerequisites</a></span></dt><dd><dl><dt><span
class="section"><a
href="ch-getting-files.php#ch-getting-files-system-packages">1.1. System
Packages</a></span></dt><dt><span
class="section"><a href="ch-getting-files-fdp.php">1.2.
Fedora Documentation Tools</a></span></dt><dt><span
class="section"><a href="ch-getting-files-filenames.php">1.3.
Filename
Conventions</a></span></dt><dd><dl><dt><span
class="section"><a
href="ch-getting-files-filenames.php#ch-getting-files-filenames-doc">1.3.1.
Document
Filenames</a></span></dt></dl></dd></dl></dd><dt><span
class="chapter"><a href="ch-how-modules-work.php">2. How
Modules Work</a></span></dt><dd><dl><dt><span
class="section"><a
href="ch-how-modules-work.php#sn-module-struct">2.1. Structure of a
Module</a></span></dt><dt><span
class="section"><a href="sn-build-system.php">2.2. The D!
ocument Build
System</a></span></dt><dd><dl><dt><span
class="s!
ection
a href="sn-build-system.php#sn-makefile">2.2.1. The Document <code
class="filename">Makefile</code></a></span></dt><dt><span
class="section"><a
href="sn-build-system.php#sn-rpm-info">2.2.2. The Document <code
class="filename">rpm-info.xml</code></a></span></dt></dl></dd><dt><span
class="section"><a
href="ch-getting-files-build-system-targets.php">2.3. Build System
Actions</a></span></dt><dd><dl><dt><span
class="section"><a
href="ch-getting-files-build-system-targets.php#id3034162">2.3.1. Adding or
Changing Targets</a></span></dt><dt><span
class="section"><a
href="ch-getting-files-build-system-targets.php#ch-getting-files-build-system-images">2.3.2.
Using Document Image Files</a></span></dt><dt><span
class="section"><a
href="ch-getting-files-build-system-targets.php#id2963365">2.3.3. Adding a
New DocBook XML File</a></span></dt><dt><span
class="section"><a
href="ch-getting-files-build-system-targets.php#id3009232">2.3.4. Adding a
Translation</a></span></dt></dl></dd></dl></dd!
<dt><span class="chapter"><a
href="ch-writing-guidelines.php">3. Fedora Documentation
Guidelines</a></span></dt><dd><dl><dt><span
class="section"><a
href="ch-writing-guidelines.php#sn-id-naming-conventions">3.1. ID Naming
Conventions</a></span></dt><dt><span
class="section"><a href="sn-xml-guidelines-header.php">3.2.
File Header</a></span></dt><dt><span
class="section"><a href="sn-xml-admon.php">3.3.
Admonitions</a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-xml-admon.php#sn-xml-notesetc">3.3.1. Creating a <code
class="sgmltag-element">note</code>,
+ <code
class="sgmltag-element">tip</code>, <code
class="sgmltag-element">caution</code>, <code
class="sgmltag-element">important</code>, or <code
class="sgmltag-element">warning</code></a></span></dt></dl></dd><dt><span
class="section"><a href="sn-screenshots.php">3.4.
Screenshots</a></span></dt></dl></dd><dt><span
class="chapter"><a href="ch-emacs.php">4. Emacs and PSGML
Mode</a></span></dt><dd><dl><dt><span
class="section"><a
href="ch-emacs.php#sn-installing-psgml">4.1. Installing
PSGML</a></span></dt><dt><span
class="section"><a href="sn-emacs-file.php">4.2. Setting Up
Your <code class="filename">.emacs</code>
File</a></span></dt><dt><span
class="section"><a href="sn-emacs-colors.php">4.3.
Customizing Emacs</a></span></dt><dt><span
class="section"><a href="sn-emacs-basic-commands.php">4.4.
Basic Emacs Commands</a></span></dt><dt><span
class="section"><a href="sn-emacs-examples.php">4.5.
Examples</a></span></dt><dd><dl><dt><span
class="section"><a href="sn-emacs-examples.!
php#sn-emacs-tag-completion">4.5.1. Tag
Completion</a></span></dt><dt><span
class="section"><a
href="sn-emacs-examples.php#sn-emacs-tag-closing">4.5.2. Tag
Closure</a></span></dt><dt><span
class="section"><a
href="sn-emacs-examples.php#sn-emacs-other">4.5.3. Other Emacs
Tasks</a></span></dt></dl></dd><dt><span
class="section"><a
href="sn-emacs-additional-resources.php">4.6. Additional
Resources</a></span></dt></dl></dd><dt><span
class="chapter"><a href="ch-vim.php">5. VIM and
DocBook</a></span></dt><dd><dl><dt><span
class="section"><a href="ch-vim.php#sn-vimrc-file">5.1.
Setting Up Your <code class="filename">.vimrc</code>
File</a></span></dt><dt><span
class="section"><a href="sn-vim-keymapping.php">5.2.
Keymapping with VIM</a></span></dt><dt><span
class="section"><a
href="sn-vim-additional-resources.php">5.3. Additional VIM
Resources</a></span></dt></dl></dd><dt><span
class="chapter"><a href="ch-xml-tags.php">6. DocBook XML
Tags</a></span></dt><dd><dl><dt><span
class="sect!
ion"><a href="ch-xml-tags.php#sn-xml-tags-caveats">6.1. Tags a!
nd Ent
es Caveats</a></span></dt><dt><span
class="section"><a href="sn-xml-tags-application.php">6.2.
<code
class="sgmltag-element">application</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-chapter.php">6.3.
<code
class="sgmltag-element">chapter</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-citetitle.php">6.4.
<code
class="sgmltag-element">citetitle</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-command.php">6.5.
<code
class="sgmltag-element">command</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-compoutput.php">6.6.
<code
class="command">computeroutput</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-emphasis.php">6.7.
<code
class="command">emphasis</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-example.php">6.8.
<code
class="command">example</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-filename.php">6.9.
<code class="command">!
filename</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-firstterm.php">6.10.
<code
class="command">firstterm</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-footnote.php">6.11.
<code
class="command">footnote</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-figure.php">6.12.
<code
class="command">figure</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-gui.php">6.13. GUI
Tags</a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-xml-tags-gui.php#sn-xml-tags-guilabel">6.13.1. <code
class="command">guilabel</code></a></span></dt><dt><span
class="section"><a
href="sn-xml-tags-gui.php#sn-xml-tags-guibutton">6.13.2. <code
class="command">guibutton</code></a></span></dt><dt><span
class="section"><a
href="sn-xml-tags-gui.php#sn-xml-tags-guiicon">6.13.3. <code
class="command">guiicon</code></a></span></dt><dt><span
class="section"><a
href="sn-xml-tags-gui.php#sn-xml-tags-guimenu">6.13.4. <code c!
lass="command">guimenu</code> and
+ <code
class="command">guimenuitem</code></a></span></dt></dl></dd><dt><span
class="section"><a href="sn-xml-tags-keycap.php">6.14.
<code
class="command">keycap</code></a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-xml-tags-keycap.php#sn-xml-tags-menuchoice">6.14.1. <code
class="command">menuchoice</code></a></span></dt><dt><span
class="section"><a
href="sn-xml-tags-keycap.php#sn-xml-tags-keycombo">6.14.2. <code
class="command">keycombo</code></a></span></dt></dl></dd><dt><span
class="section"><a href="sn-xml-tags-lists.php">6.15.
Lists</a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-xml-tags-lists.php#sn-xml-tags-itemizedlist">6.15.1. <code
class="command">itemizedlist</code></a></span></dt><dt><span
class="section"><a
href="sn-xml-tags-lists.php#sn-xml-tags-orderedlist">6.15.2. <code
class="command">OrderedList</code></a></span></dt><dt><span
class="section"><a
href="sn-xml-tags-lists.php#sn-xml-tags-varlist">6.15.3. <code
class="command">Vari!
ablelist</code></a></span></dt><dt><span
class="section"><a
href="sn-xml-tags-lists.php#sn-xml-tags-simplelist">6.15.4. Creating a List
Within a Table Using <code
class="command">Simplelist</code></a></span></dt><dt><span
class="section"><a
href="sn-xml-tags-lists.php#sn-xml-tags-glossary">6.15.5. <code
class="command">glosslist</code></a></span></dt></dl></dd><dt><span
class="section"><a href="sn-xml-tags-option.php">6.16.
<code
class="command">option</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-indexing.php">6.17.
Index Entries</a></span></dt><dt><span
class="section"><a href="sn-xml-tags-para.php">6.18. <code
class="command">para</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-part.php">6.19. <code
class="command">part</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-prompt.php">6.20.
<code
class="command">prompt</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-replaceable.php">6.21.
<co!
de
class="command">replaceable</code></a></span></dt><dt><span!
class
ection"><a href="sn-xml-tags-screen.php">6.22. <code
class="command">screen</code></a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-xml-tags-screen.php#sn-xml-tags-screen-inline-tags">6.22.1. Using
Inline Tags with <code
class="command">screen</code></a></span></dt></dl></dd><dt><span
class="section"><a href="sn-xml-tags-sections.php">6.23.
Sections</a></span></dt><dt><span
class="section"><a href="sn-xml-tags-table.php">6.24.
<code
class="command">table</code></a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-xml-tags-table.php#sn-xml-tags-listintable">6.24.1. Creating a List
Within a Table</a></span></dt></dl></dd><dt><span
class="section"><a href="sn-xml-tags-trademark.php">6.25.
<code
class="command">trademark</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-userinput.php">6.26.
<code
class="command">userinput</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tag-sulink.php">6.27.
<code class="command">ulink</code>!
</a></span></dt><dt><span class="section"><a
href="sn-xml-tags-wordasword.php">6.28. <code
class="command">wordasword</code></a></span></dt><dt><span
class="section"><a href="sn-xml-tags-xref.php">6.29. <code
class="command">xref</code></a></span></dt></dl></dd><dt><span
class="chapter"><a href="ch-tutorial.php">7. The Layout of a
Tutorial</a></span></dt><dd><dl><dt><span
class="section"><a
href="ch-tutorial.php#sn-tutorial-article">7.1. The
Article</a></span></dt><dt><span
class="section"><a href="sn-tutorial-metadata.php">7.2. The
Metadata</a></span></dt></dl></dd><dt><span
class="chapter"><a href="ch-cvs.php">8.
CVS</a></span></dt><dd><dl><dt><span
class="section"><a href="ch-cvs.php#sn-cvs-overview">8.1. How
CVS Works</a></span></dt><dt><span
class="section"><a href="sn-cvs-preparation.php">8.2.
Preparing For CVS
Use</a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-cvs-preparation.php#sn-cvs-rpm-check">8.2.1. Is CVS Installed On
Your System</a></span></dt><d!
t><span class="section"><a
href="sn-cvs-preparation.php#sn-cvs!
-gener
-keys">8.2.2. Generating SSH
Keys</a></span></dt></dl></dd><dt><span
class="section"><a href="sn-cvs-config.php">8.3. Configuring
For CVS Access</a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-cvs-config.php#sn-cvs-config-cvsrc">8.3.1. Avoiding Repetitive
Typing</a></span></dt><dt><span
class="section"><a
href="sn-cvs-config.php#sn-cvs-config-anon">8.3.2. Configuring for Read-Only
CVS Access</a></span></dt><dt><span
class="section"><a
href="sn-cvs-config.php#sn-cvs-config-author">8.3.3. Configuring Read/Write
CVS Access</a></span></dt></dl></dd><dt><span
class="section"><a href="sn-cvs-cvscommands.php">8.4. Basic
CVS Commands</a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co">8.4.1. Checking Out
Modules</a></span></dt><dd><dl><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co-branch">8.4.1.1. Checking
Out Branches of
Modules</a></span></dt></dl></dd><dt><span
class="section"><a hre!
f="sn-cvs-cvscommands.php#sn-cvs-cvscommands-up">8.4.2. Updating
Files</a></span></dt><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-commit">8.4.3. Committing
Files</a></span></dt><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-add">8.4.4. Adding
Files</a></span></dt><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-admin">8.4.5. Managing Binary
Files</a></span></dt><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-rm">8.4.6. Removing
Files</a></span></dt><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-status">8.4.7. Status of
Files</a></span></dt><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts">8.4.8. Resolving
Conflicts</a></span></dt><dt><span
class="section"><a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-summary">8.4.9.
Summary</a></span></dt></dl></dd></dl></dd><dt><span
class="chapter">!
<a href="acknowledgments.php">9.
Acknowledgments</a></span></d!
t><dt>
an class="index"><a
href="generated-index.php">Index</a></span></dt></dl></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left">��</td><td width="20%"
align="center">��</td><td width="40%"
align="right">��<a accesskey="n"
href="ch-intro.php">Next</a></td></tr><tr><td
width="40%" align="left" valign="top">��</td><td
width="20%" align="center">��</td><td
width="40%" align="right"
valign="top">��Introduction</td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: sn-cvs-config.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/sn-cvs-config.php,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- sn-cvs-config.php 5 Jan 2007 00:47:12 -0000 1.2
+++ sn-cvs-config.php 23 Jun 2007 05:42:10 -0000 1.3
@@ -2,68 +2,68 @@
include("site.inc");
$template = new Page;
-$template->initCommon();
+$template->initCommon();
$template->displayHeader();
?>
-<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">10.3. Configuring For CVS
Access</th></tr><tr><td width="20%"
align="left"><a accesskey="p"
href="sn-cvs-preparation.php">Prev</a> </td><th
width="60%"
align="center">Chapter 10. CVS</th><td
width="20%" align="right"> <a accesskey="n"
href="sn-cvs-cvscommands.php">Next</a></td></tr></table><hr></div><div
class="section" lang="en"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="sn-cvs-config"></a>10.3. Configuring For CVS
Access</h2></div></div><div></div></div><a
class="indexterm" name="id2970850"></a><a
class="indexterm" name="id2970862"></a><a
class="indexterm" name="id2970874"></a><a
class="indexterm" name="id2970886"></a><a
class="indexterm" name="id2970895"></a><a
class="indexterm" name="id2970904"></a><a
class="indexterm" name="id2970921"></a><div
class="section" lang="en"><div
class="titlepage"><div><d!
iv><h3 class="title"><a
name="sn-cvs-config-cvsrc"></a>10.3.1. Avoiding Repetitive
Typing</h3></div></div><div></div></div><a
class="indexterm" name="id2970944"></a><p>
- Many <span><b
class="application">CVS</b></span> commands need certain
+<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">8.3.��Configuring For CVS
Access</th></tr><tr><td width="20%"
align="left"><a accesskey="p"
href="sn-cvs-preparation.php">Prev</a>��</td><th
width="60%" align="center">Chapter��8.��CVS</th><td
width="20%" align="right">��<a accesskey="n"
href="sn-cvs-cvscommands.php">Next</a></td></tr></table><hr></div><div
class="section" lang="en-US"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="sn-cvs-config"></a>8.3.��Configuring For CVS
Access</h2></div></div></div><a class="indexterm"
name="id3011059"></a><a class="indexterm"
name="id2998299"></a><a class="indexterm"
name="id3037051"></a><a class="indexterm"
name="id3058073"></a><a class="indexterm"
name="id3059606"></a><a class="indexterm"
name="id3023212"></a><a class="indexterm"
name="id3031239"></a><div class="section"
lang="en-US"><div
class="titlepage"><div><div><h3
class="title"><a name="sn!
-cvs-config-cvsrc"></a>8.3.1.��Avoiding Repetitive
Typing</h3></div></div></div><a class="indexterm"
name="id3020927"></a><p>
+ Many <span><strong
class="application">CVS</strong></span> 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 <span><b
class="application">CVS</b></span> will read
+ switches in a file that <span><strong
class="application">CVS</strong></span> will read
before executing your command line.
</p><p>
- Create a file named <tt class="filename">~/.cvsrc</tt> in
your home
+ Create a file named <code class="filename">~/.cvsrc</code>
in your home
directory. It should contain the following commands, one per
line:
-</p><pre class="screen"><tt
class="computeroutput">cvs -z3
+</p><pre class="screen"><code
class="computeroutput">cvs -z3
diff -uNp
rdiff -uNp
-update -dP</tt></pre><p>
- </p></div><div class="section"
lang="en"><div class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-config-anon"></a>10.3.2. Configuring for
Read-Only CVS
Access</h3></div></div><div></div></div><a
class="indexterm" name="id2971008"></a><a
class="indexterm" name="id2971020"></a><p>
- If your goal is to download the various Fedora Core documents and to
+update -dP</code></pre><p>
+ </p></div><div class="section"
lang="en-US"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-config-anon"></a>8.3.2.��Configuring for Read-Only CVS
Access</h3></div></div></div><a class="indexterm"
name="id3078328"></a><a class="indexterm"
name="id3078341"></a><p>
+ If your goal is to download the various Fedora documents and to
render them on your system, you only need read-only access to
- the <span><b class="application">CVS</b></span>
repository. Follow the
+ the <span><strong
class="application">CVS</strong></span> repository. Follow the
instructions in this section and then skip directly to
- <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co"
title="10.4.1. Checking Out Modules">Section 10.4.1,
“Checking Out Modules”</a>.
+ <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-co"
title="8.4.1.��Checking Out Modules">Section��8.4.1, ���Checking Out
Modules���</a>.
</p><p>
Change directories to where you want your files from
- <span><b class="application">CVS</b></span> to
be located, and execute the
+ <span><strong
class="application">CVS</strong></span> to be located, and
execute the
following commands:
- </p><pre class="screen"><tt class="prompt">$
</tt><tt class="command">export
CVSROOT=:pserver:anonymous@cvs.fedoraproject.org:/cvs/docs</tt>
-<tt class="prompt">$ </tt><tt class="command">cvs
login</tt>
-<tt class="prompt">$ </tt><tt class="command">cvs
checkout docs-common</tt> <i
class="replaceable"><tt>module-name</tt></i>
-<tt class="prompt">$ </tt><tt class="command">cvs
checkout</tt> <i
class="replaceable"><tt>module-name</tt></i>
-<tt class="prompt">$ </tt><tt
class="command">cd</tt> <i
class="replaceable"><tt>module-name</tt></i></pre><p>
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">export
CVSROOT=:pserver:anonymous@cvs.fedoraproject.org:/cvs/docs</code>
+<code class="prompt">$ </code><code
class="command">cvs login</code>
+<code class="prompt">$ </code><code
class="command">cvs checkout docs-common</code> <em
class="replaceable"><code>module-name</code></em>
+<code class="prompt">$ </code><code
class="command">cvs checkout</code> <em
class="replaceable"><code>module-name</code></em>
+<code class="prompt">$ </code><code
class="command">cd</code> <em
class="replaceable"><code>module-name</code></em></pre><p>
Once you have checked the module out, it doesn't matter what
your
- <tt class="envar">CVSROOT</tt>
+ <code class="envar">CVSROOT</code>
is set to because it is stored in the file
- <tt class="filename">CVS/Root</tt> for each directory in
your local
+ <code class="filename">CVS/Root</code> for each directory
in your local
repository. As long as your current working directory has a
- <tt class="filename">CVS/</tt> directory, the
- <span><b class="application">CVS</b></span>
program will automatically locate
- the Fedora Core repository.
- </p></div><div class="section"
lang="en"><div class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-config-author"></a>10.3.3. Configuring Read/Write
CVS Access</h3></div></div><div></div></div><a
class="indexterm" name="id2971171"></a><a
class="indexterm" name="id2971184"></a><p>
+ <code class="filename">CVS/</code> directory, the
+ <span><strong
class="application">CVS</strong></span> program will
automatically locate
+ the Fedora repository.
+ </p></div><div class="section"
lang="en-US"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-config-author"></a>8.3.3.��Configuring Read/Write CVS
Access</h3></div></div></div><a class="indexterm"
name="id3090151"></a><a class="indexterm"
name="id3090164"></a><p>
To author a new document or to change an existing one, you must
- obtain full read/write access to the Fedora Core Docs
- <span><b class="application">CVS</b></span>
repository. For the full details
+ obtain full read/write access to the Fedora Docs
+ <span><strong
class="application">CVS</strong></span> repository. For the full
details
on this process, refer to the
- <a
href="http://fedoraproject.org/wiki/DocsProject/NewWriters"
target="_top"><tt
class="filename">http://fedoraproject.org/wiki/DocsProject/N...
+ <a
href="http://fedoraproject.org/wiki/DocsProject/NewWriters"
target="_top"><code
class="filename">http://fedoraproject.org/wiki/DocsProject/N...
</a> web site. Below is a summary:
</p><div class="itemizedlist"><ul
type="disc"><li><p>
Subscribe to the
- <a
href="https://listman.redhat.com/mailman/listinfo/fedora-docs-list&q...
target="_top"><tt
class="filename">fedora-docs-list</tt>
+ <a
href="https://listman.redhat.com/mailman/listinfo/fedora-docs-list&q...
target="_top"><code
class="filename">fedora-docs-list</code>
</a>, which is the main forum for the project.
</p></li><li><p>
- Generate a GNU Privacy Guard (<span
class="abbrev">GPG</span>) key to
+ Generate a GNU Privacy Guard (<abbr
class="abbrev">GPG</abbr>) key to
identify yourself to the project.
</p></li><li><p>
Register for a
- <a
href="http://bugzilla.redhat.com/"
target="_top"><tt class="filename">Bugzilla</tt>
+ <a
href="http://bugzilla.redhat.com/"
target="_top"><code class="filename">Bugzilla</code>
</a> account, if you do not have one already.
- <tt class="filename">Bugzilla</tt> is how we keep track
of bugs,
+ <code class="filename">Bugzilla</code> is how we keep
track of bugs,
changes and projects.
</p></li><li><p>
Post a
@@ -73,27 +73,26 @@
After your
<a
href="http://fedoraproject.org/wiki/DocsProject_2fSelfIntroduction&q...
target="_top">self
introduction</a> has been approved your
- <span><b class="application">CVS</b></span>
access will be granted.
+ <span><strong
class="application">CVS</strong></span> access will be granted.
</p><p>
Every author, and that includes you once your self introduction
has been received, has a unique
- <tt class="envar">$CVSROOT</tt>
- to access the <span><b
class="application">CVS</b></span> repository:
- </p><pre class="screen"><tt class="prompt">$
</tt><tt class="command">export CVSROOT=:ext:</tt><i
class="replaceable"><tt>yourname</tt></i><tt
class="command">@cvs.fedora.redhat.com:/cvs/docs</tt>
-<tt class="prompt">$ </tt><tt
class="command">export CVS_RSH=/usr/bin/ssh</tt></pre><p>
+ <code class="envar">$CVSROOT</code>
+ to access the <span><strong
class="application">CVS</strong></span> repository:
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">export
CVSROOT=:ext:</code><em
class="replaceable"><code>yourname</code></em><code
class="command">@cvs.fedoraproject.org:/cvs/docs</code>
+<code class="prompt">$ </code><code
class="command">export
CVS_RSH=/usr/bin/ssh</code></pre><p>
With the
- <tt class="envar">$CVSROOT</tt>
+ <code class="envar">$CVSROOT</code>
and
- <tt class="envar">$CVS_RSH</tt>
+ <code class="envar">$CVS_RSH</code>
environment variables in place, you can access the repository:
- </p><pre class="screen"><tt class="prompt">$
</tt><tt class="command">cvs co -c</tt></pre><p>
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">cvs co
-c</code></pre><p>
You will be asked for the passphrase for your
- <span><b class="application">SSH</b></span>
key. Press
- <span><b class="guibutton">ENTER</b></span>
+ <span><strong
class="application">SSH</strong></span> key. Press
+ <span><strong
class="guibutton">ENTER</strong></span>
and you should receive a list of modules already in the
repository.
- </p></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="sn-cvs-preparation.php">Prev</a> </td><td
width="20%" align="center"><a accesskey="u"
href="ch-cvs.php">Up</a></td><td width="40%"
align="right"> <a accesskey="n"
href="sn-cvs-cvscommands.php">Next</a></td></tr><tr><td
width="40%" align="left"
valign="top">10.2. Preparing For CVS Use </td><td
width="20%" align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right" valign="top"> 10.4. Basic CVS
Commands</td></tr></table></div>
-
+ </p></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="sn-cvs-preparation.php">Prev</a>��</td><td
width="20%" align="center"><a accesskey="u"
href="ch-cvs.php">Up</a></td><td width="40%"
align="right">��<a accesskey="n"
href="sn-cvs-cvscommands.php">Next</a></td></tr><tr><td
width="40%" align="left" valign="top">8.2.��Preparing For
CVS Use��</td><td width="20%" align="center"><a
accesskey="h" href="index.php">Home</a></td><td
width="40%" align="right" valign="top">��8.4.��Basic CVS
Commands</td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: sn-cvs-cvscommands.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/sn-cvs-cvscommands.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- sn-cvs-cvscommands.php 6 Dec 2005 19:37:14 -0000 1.1
+++ sn-cvs-cvscommands.php 23 Jun 2007 05:42:10 -0000 1.2
@@ -2,244 +2,244 @@
include("site.inc");
$template = new Page;
-$template->initCommon();
+$template->initCommon();
$template->displayHeader();
?>
-<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">10.4. Basic CVS
Commands</th></tr><tr><td width="20%"
align="left"><a accesskey="p"
href="sn-cvs-config.php">Prev</a> </td><th
width="60%"
align="center">Chapter 10. CVS</th><td
width="20%" align="right"> <a accesskey="n"
href="acknowledgments.php">Next</a></td></tr></table><hr></div><div
class="section" lang="en"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="sn-cvs-cvscommands"></a>10.4. Basic CVS
Commands</h2></div></div><div></div></div><a
class="indexterm" name="id2971416"></a><p>
+<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">8.4.��Basic CVS Commands</th></tr><tr><td
width="20%" align="left"><a accesskey="p"
href="sn-cvs-config.php">Prev</a>��</td><th
width="60%" align="center">Chapter��8.��CVS</th><td
width="20%" align="right">��<a accesskey="n"
href="acknowledgments.php">Next</a></td></tr></table><hr></div><div
class="section" lang="en-US"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="sn-cvs-cvscommands"></a>8.4.��Basic CVS
Commands</h2></div></div></div><a class="indexterm"
name="id3007259"></a><p>
After configuring your system to work with CVS, checkout the
modules you will be working on.
- </p><div class="tip" style="margin-left: 0.5in; margin-right:
0.5in;"><table border="0" summary="Tip:
Tip"><tr><td rowspan="2" align="center"
valign="top" width="25"><img alt="[Tip]"
src="./stylesheet-images/tip.png"></td><th
align="left">Tip</th></tr><tr><td colspan="2"
align="left" valign="top"><p>
+ </p><div class="tip" style="margin-left: 0.5in; margin-right:
0.5in;"><table border="0" summary="Tip:
Tip"><tr><td rowspan="2" align="center"
valign="top" width="25"><img alt="[Tip]"
src="./stylesheet-images/tip.png"></td><th
align="left">Tip</th></tr><tr><td align="left"
valign="top"><p>
To see if you need a correctly-set
- <tt class="envar">$CVSROOT</tt>
- variable, or the <tt class="option">-m </tt>
- <i class="replaceable"><tt>repository</tt></i>
command line switch, see
- if you have a <tt class="filename">CVS/</tt> subdirectory
in your
+ <code class="envar">$CVSROOT</code>
+ variable, or the <code class="option">-m </code>
+ <em
class="replaceable"><code>repository</code></em> command
line switch, see
+ if you have a <code class="filename">CVS/</code>
subdirectory in your
working directory.
</p><p>
- If you have a <tt class="filename">CVS/</tt> directory,
- <span><b class="application">CVS</b></span>
ignores any
- <tt class="envar">$CVSROOT</tt>
- or <tt class="option">-m</tt> command line switch.
- </p></td></tr></table></div><div
class="section" lang="en"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-co"></a>10.4.1. Checking Out
Modules</h3></div></div><div></div></div><a
class="indexterm" name="id2971496"></a><p>
+ If you have a <code class="filename">CVS/</code>
directory,
+ <span><strong
class="application">CVS</strong></span> ignores any
+ <code class="envar">$CVSROOT</code>
+ or <code class="option">-m</code> command line switch.
+ </p></td></tr></table></div><div
class="section" lang="en-US"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-co"></a>8.4.1.��Checking Out
Modules</h3></div></div></div><a class="indexterm"
name="id3007338"></a><p>
You only need to checkout a module once. After a local copy of
the module is on your system, it is on your system.
</p><p>
To checkout a module, use the following command:
- </p><pre class="screen"><tt class="prompt">$
</tt><tt class="command">cvs co</tt> <i
class="replaceable"><tt><module-name></tt></i></pre><p>
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">cvs
co</code> <em
class="replaceable"><code><module-name></code></em></pre><p>
For example, to checkout the
- <tt class="computeroutput">example-tutorial</tt> module,
change
+ <code class="computeroutput">example-tutorial</code>
module, change
to your work directory, and execute the following command:
- </p><pre class="screen"><tt class="prompt">$
</tt><tt class="command">cvs co
example-tutorial</tt></pre><p>
- A directory called <tt
class="filename">example-tutorial/</tt> is
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">cvs co
example-tutorial</code></pre><p>
+ A directory called <code
class="filename">example-tutorial/</code> is
created in the current directory.
</p><p>
If a branch name is not specified when checking out a module, it
- is referred to as the <i class="firstterm">HEAD</i> of the
- <span><b class="application">CVS</b></span>
module.
- </p><div class="section" lang="en"><div
class="titlepage"><div><div><h4
class="title"><a
name="sn-cvs-cvscommands-co-branch"></a>10.4.1.1. Checking Out
Branches of
Modules</h4></div></div><div></div></div><a
class="indexterm" name="id2971598"></a><p>
- Think of a <span><b
class="application">CVS</b></span> branch as a version
+ is referred to as the <em class="firstterm">HEAD</em> of
the
+ <span><strong
class="application">CVS</strong></span> module.
+ </p><div class="section" lang="en-US"><div
class="titlepage"><div><div><h4
class="title"><a
name="sn-cvs-cvscommands-co-branch"></a>8.4.1.1.��Checking Out Branches
of Modules</h4></div></div></div><a class="indexterm"
name="id3090304"></a><p>
+ Think of a <span><strong
class="application">CVS</strong></span> branch as a version
of the files for a particular version of a manual or package.
</p><p>
To checkout a branch of a module, use the following command:
- </p><pre class="screen"><tt
class="prompt">$ </tt><tt class="command">cvs
co</tt> <tt class="option">-d</tt> <i
class="replaceable"><tt><directory></tt></i>
<tt class="option">-r</tt> <i
class="replaceable"><tt><branchname></tt></i>
<i
class="replaceable"><tt><module-name></tt></i></pre><p>
- A directory named <i
class="replaceable"><tt><directory></tt></i>
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">cvs
co</code> <code class="option">-d</code> <em
class="replaceable"><code><directory></code></em>
<code class="option">-r</code> <em
class="replaceable"><code><branchname></code></em>
<em
class="replaceable"><code><module-name></code></em></pre><p>
+ A directory named <em
class="replaceable"><code><directory></code></em>
is created, and the files for the
- <i
class="replaceable"><tt><branchname></tt></i>
branch of the
- <i
class="replaceable"><tt><module-name></tt></i>
module are
+ <em
class="replaceable"><code><branchname></code></em>
branch of the
+ <em
class="replaceable"><code><module-name></code></em>
module are
copied in the directory.
</p><p>
For example, to checkout a branch named BRANCH-VERSION-1.2
- from the <tt class="computeroutput">mymodule</tt> module,
use
+ from the <code class="computeroutput">mymodule</code>
module, use
the command:
- </p><pre class="screen"><tt
class="prompt">$ </tt><tt class="command">cvs co -d
mymodule-1.2 -r BRANCH-VERSION-1.2 mymodule</tt></pre><p>
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">cvs co -d
mymodule-1.2 -r BRANCH-VERSION-1.2 mymodule</code></pre><p>
The BRANCH-VERSION-1.2 branch of the module is checked out in
- the <tt class="filename">mymodule-1.2</tt> directory on
your
+ the <code class="filename">mymodule-1.2</code> directory
on your
system.
</p><p>
To determine which branches and tags exist for a file, use the
command:
- </p><pre class="screen"><tt
class="prompt">$ </tt><tt class="command">cvs
status</tt> <tt class="option">-v</tt> <i
class="replaceable"><tt><filename></tt></i></pre><p>
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">cvs
status</code> <code class="option">-v</code> <em
class="replaceable"><code><filename></code></em></pre><p>
For example, the status of the file
- <tt class="filename">foo.sgml</tt> is as follows:
+ <code class="filename">foo.sgml</code> is as follows:
</p><pre class="screen">
-<tt class="computeroutput">
+<code class="computeroutput">
===================================================================
File: foo.sgml Status: Up-to-date
Working revision: 1.47
- Repository revision: 1.47 /cvs/docs/custom-guide/rhl-cg-en.sgml,v
+ 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)
-</tt>
+</code>
</pre><p>
Only tags marked as branches in the second column under the
- <tt class="computeroutput">Existing Tags</tt> section can
be
+ <code class="computeroutput">Existing Tags</code> section
can be
checked out as a branch.
- </p></div></div><div class="section"
lang="en"><div class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-up"></a>10.4.2. Updating
Files</h3></div></div><div></div></div><a
class="indexterm" name="id2971794"></a><p>
+ </p></div></div><div class="section"
lang="en-US"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-up"></a>8.4.2.��Updating
Files</h3></div></div></div><a class="indexterm"
name="id3090503"></a><p>
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:
- </p><pre class="screen"><tt
class="command">cvs update</tt></pre><p>
+ </p><pre class="screen"><code
class="command">cvs update</code></pre><p>
The latest versions of all the files in the module are
downloaded into your local copy. If you notice a file conflict,
- refer to <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts"
title="10.4.8. Resolving Conflicts">Section 10.4.8,
“Resolving Conflicts”</a>.
- </p></div><div class="section"
lang="en"><div class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-commit"></a>10.4.3. Committing
Files</h3></div></div><div></div></div><a
class="indexterm" name="id2971845"></a><p>
+ refer to <a
href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts"
title="8.4.8.��Resolving Conflicts">Section��8.4.8, ���Resolving
Conflicts���</a>.
+ </p></div><div class="section"
lang="en-US"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-commit"></a>8.4.3.��Committing
Files</h3></div></div></div><a class="indexterm"
name="id3090553"></a><p>
After modifying files in your local version of a module, commit
- them to save the changes on the <span><b
class="application">CVS</b></span>
+ them to save the changes on the <span><strong
class="application">CVS</strong></span>
server:
- </p><pre class="screen"><tt class="prompt">$
</tt><tt class="command">cvs commit</tt> <tt
class="option">-m</tt> "<i
class="replaceable"><tt>some log message</tt></i>"
<i
class="replaceable"><tt>filename</tt></i></pre><div
class="note" style="margin-left: 0.5in; margin-right:
0.5in;"><table border="0"
summary="Note"><tr><td rowspan="2"
align="center" valign="top" width="25"><img
alt="[Note]" src="./stylesheet-images/note.png"></td><th
align="left">Note</th></tr><tr><td colspan="2"
align="left" valign="top"><p>
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">cvs
commit</code> <code class="option">-m</code> "<em
class="replaceable"><code>some log
message</code></em>" <em
class="replaceable"><code>filename</code></em></pre><div
class="note" style="margin-left: 0.5in; margin-right:
0.5in;"><table border="0"
summary="Note"><tr><td rowspan="2"
align="center" valign="top" width="25"><img
alt="[Note]" src="./stylesheet-images/note.png"></td><th
align="left">Note</th></tr><tr><td
align="left" valign="top"><p>
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 <b
class="userinput"><tt>-m "some
- log message"</tt></b>. The buffer will already contain
+ environment variable, just omit the <strong
class="userinput"><code>-m "some
+ log message"</code></strong>. The buffer will already contain
comments describing the change; you do not need to delete them
as you enter your own text.
</p></td></tr></table></div><p>
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 <b
class="userinput"><tt>updated some
- files</tt></b> does not accurately describe what has changed
+ Using a log message such as <strong
class="userinput"><code>updated some
+ files</code></strong> does not accurately describe what has changed
and will not help you in the future. If you are correcting a
- bug, use the <span><b
class="application">Bugzilla</b></span> reference.
+ bug, use the <span><strong
class="application">Bugzilla</strong></span> reference.
</p><p>
- The <i
class="replaceable"><tt><filename></tt></i>
can be one
+ The <em
class="replaceable"><code><filename></code></em>
can be one
filename, a series of filenames separated by spaces, or a group
of filenames specified using wildcards such as
- <tt class="filename">*.png</tt> or <tt
class="filename">foo-*.sgml</tt>.
+ <code class="filename">*.png</code> or <code
class="filename">foo-*.sgml</code>.
</p><p>
If no filename or group of filenames is specified in the
- <tt class="command">commit</tt> command, all outstanding
changes of
+ <code class="command">commit</code> 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 <tt
class="command">commit</tt> command
+ Use caution when issuing the <code
class="command">commit</code> command
without any filenames because you might not remember exactly
what files changed.
</p><p>
If you notice a file conflict, refer to
- <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts"
title="10.4.8. Resolving Conflicts">Section 10.4.8,
“Resolving Conflicts”</a>.
- </p></div><div class="section"
lang="en"><div class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-add"></a>10.4.4. Adding
Files</h3></div></div><div></div></div><a
class="indexterm" name="id2971999"></a><p>
+ <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts"
title="8.4.8.��Resolving Conflicts">Section��8.4.8, ���Resolving
Conflicts���</a>.
+ </p></div><div class="section"
lang="en-US"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-add"></a>8.4.4.��Adding
Files</h3></div></div></div><a class="indexterm"
name="id3068981"></a><p>
To add a file to a module, create the file in your local copy
then execute the following command:
- </p><pre class="screen"><tt class="prompt">$
</tt><tt class="command">cvs add</tt> <i
class="replaceable"><tt>file-to-add</tt></i></pre><p>
- After adding the file, you must <tt
class="command">commit</tt> the
- <tt class="command">add</tt> to copy it to the server:
- </p><pre class="screen"><tt class="prompt">$
</tt><tt class="command">cvs commit</tt> <tt
class="option">-m</tt> "<i
class="replaceable"><tt>some log message</tt></i>"
<i
class="replaceable"><tt>file-to-add</tt></i></pre></div><div
class="section" lang="en"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-admin"></a>10.4.5. Managing Binary
Files</h3></div></div><div></div></div><a
class="indexterm" name="id2972084"></a><p>
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">cvs
add</code> <em
class="replaceable"><code>file-to-add</code></em></pre><p>
+ After adding the file, you must <code
class="command">commit</code> the
+ <code class="command">add</code> to copy it to the server:
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">cvs
commit</code> <code class="option">-m</code> "<em
class="replaceable"><code>some log
message</code></em>" <em
class="replaceable"><code>file-to-add</code></em></pre></div><div
class="section" lang="en-US"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-admin"></a>8.4.5.��Managing Binary
Files</h3></div></div></div><a class="indexterm"
name="id3069069"></a><p>
The most commonly-archived files are simple text files but
sometimes binary files are also archived. The
- <span><b class="application">cvs</b></span>
program recognizes most common
- filename extentions such as <tt class="filename">.png</tt>
or
- <tt class="filename">.jpg</tt>, so <span><b
class="application">cvs</b></span>
+ <span><strong
class="application">cvs</strong></span> program recognizes most
common
+ filename extentions such as <code
class="filename">.png</code> or
+ <code class="filename">.jpg</code>, so
<span><strong class="application">cvs</strong></span>
usually "does the right thing".
</p><p>
When a copy of a file is checked out of the repository,
- <span><b class="application">cvs</b></span>
scans it for special keywords,
- such as "<tt class="computeroutput">$id:$</tt>"
and
+ <span><strong
class="application">cvs</strong></span> scans it for special
keywords,
+ such as "<code
class="computeroutput">$id:$</code>" and
replaces the string with a generated value, such as the file
version number.
</p><p>
This keyword substitution usually corrupts binary files, so it
- must be turned off if <span><b
class="application">cvs</b></span> does not
+ must be turned off if <span><strong
class="application">cvs</strong></span> 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:
- </p><pre class="screen"><tt class="prompt">$
</tt><tt class="command">cvs</tt> <tt
class="option">admin</tt> <tt
class="option">-kk</tt> <i
class="replaceable"><tt>filename</tt></i></pre><p>
+ </p><pre class="screen"><code
class="prompt">$ </code><code
class="command">cvs</code> <code
class="option">admin</code> <code
class="option">-kk</code> <em
class="replaceable"><code>filename</code></em></pre><p>
Note that the file must already be checked in to the
- <span class="abbrev">CVS</span> repository before the
- <tt class="option">admin</tt> command can be used. This is
OK, since
+ <abbr class="abbrev">CVS</abbr> repository before the
+ <code class="option">admin</code> 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.
- </p><div class="tip" style="margin-left: 0.5in;
margin-right: 0.5in;"><table border="0" summary="Tip: Recovering
a binary file"><tr><td rowspan="2" align="center"
valign="top" width="25"><img alt="[Tip]"
src="./stylesheet-images/tip.png"></td><th
align="left">Recovering a binary file</th></tr><tr><td
colspan="2" align="left" valign="top"><p>
+ </p><div class="tip" style="margin-left: 0.5in;
margin-right: 0.5in;"><table border="0" summary="Tip: Recovering
a binary file"><tr><td rowspan="2" align="center"
valign="top" width="25"><img alt="[Tip]"
src="./stylesheet-images/tip.png"></td><th
align="left">Recovering a binary file</th></tr><tr><td
align="left" valign="top"><p>
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 <tt class="option">admin</tt> command as described
above, delete
+ the <code class="option">admin</code> command as
described above, delete
your local file copy, and check it out again.
- </p></td></tr></table></div></div><div
class="section" lang="en"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-rm"></a>10.4.6. Removing
Files</h3></div></div><div></div></div><a
class="indexterm" name="id2972234"></a><p>
+ </p></td></tr></table></div></div><div
class="section" lang="en-US"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-rm"></a>8.4.6.��Removing
Files</h3></div></div></div><a class="indexterm"
name="id3069219"></a><p>
If a file is no longer needed in the module, use the
- <tt class="command">remove</tt> command to remove it from
your local
- copy and then <tt class="command">commit</tt> the removal
to the
+ <code class="command">remove</code> command to remove it
from your local
+ copy and then <code class="command">commit</code> 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 <tt
class="command">add</tt>
+ be retrieved at any time with the <code
class="command">add</code>
command.
- </p><pre class="screen"><tt class="prompt">$
</tt><tt class="command">cvs rm -f</tt> <i
class="replaceable"><tt>file-to-remove</tt></i></pre><p>
- After removing the file, you must <tt
class="command">commit</tt> the
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">cvs rm
-f</code> <em
class="replaceable"><code>file-to-remove</code></em></pre><p>
+ After removing the file, you must <code
class="command">commit</code> the
removal:
- </p><pre class="screen"><tt class="prompt">$
</tt><tt class="command">cvs commit</tt> <tt
class="option">-m</tt>"<i
class="replaceable"><tt>some log message</tt></i>"
<i
class="replaceable"><tt>file-to-remove</tt></i></pre><p>
- You can not use wildcards in the <tt
class="command">commit</tt>
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">cvs
commit</code> <code class="option">-m</code>"<em
class="replaceable"><code>some log
message</code></em>" <em
class="replaceable"><code>file-to-remove</code></em></pre><p>
+ You can not use wildcards in the <code
class="command">commit</code>
command to identify removed files. They must be specified with a
exact filename.
</p><p>
If you need to rename a file, it is best to rename the file on
- the <span><b class="application">CVS</b></span>
server so that the history of
+ the <span><strong
class="application">CVS</strong></span> server so that the
history of
the file is preserved. If you need to rename a file, send an
email to
- <a href="mailto:cvsdocs-administrator@fedora.redhat.com"
target="_top"><tt
class="filename">cvsdocs-administrator(a)fedora.redhat.com</tt>
+ <a href="mailto:cvsdocs-administrator@fedoraproject.org"
target="_top"><code
class="filename">cvsdocs-administrator(a)fedoraproject.org</code>
</a> asking to have the file renamed.
- </p></div><div class="section"
lang="en"><div class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-status"></a>10.4.7. Status of
Files</h3></div></div><div></div></div><a
class="indexterm" name="id2972373"></a><p>
+ </p></div><div class="section"
lang="en-US"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-status"></a>8.4.7.��Status of
Files</h3></div></div></div><a class="indexterm"
name="id3069360"></a><p>
Sometimes it is necessary to view the
- <i class="firstterm">status</i> of a file in a
- <span><b class="application">CVS</b></span>
module. To view the status of a
+ <em class="firstterm">status</em> of a file in a
+ <span><strong
class="application">CVS</strong></span> module. To view the
status of a
file, use the command:
- </p><pre class="screen"><tt class="prompt">$
</tt><tt class="command">cvs status</tt> <i
class="replaceable"><tt>filename</tt></i></pre><p>
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">cvs
status</code> <em
class="replaceable"><code>filename</code></em></pre><p>
The status report of a repository file is as follows:
- </p><div class="variablelist"><dl><dt><span
class="term"><tt
class="computeroutput">Up-to-date</tt></span></dt><dd><p>
+ </p><div class="variablelist"><dl><dt><span
class="term"><code
class="computeroutput">Up-to-date</code></span></dt><dd><p>
Your revision of the file is identical to the latest
- revision on the <span><b
class="application">CVS</b></span> server.
- </p></dd><dt><span class="term"><tt
class="computeroutput">Locally
Modified</tt></span></dt><dd><p>
+ revision on the <span><strong
class="application">CVS</strong></span> server.
+ </p></dd><dt><span class="term"><code
class="computeroutput">Locally
Modified</code></span></dt><dd><p>
You have updated to the latest revision from the server,
but then you modified the file on your system.
- </p></dd><dt><span class="term"><tt
class="computeroutput">Locally
Added</tt></span></dt><dd><p>
- You added the file with the <tt class="command">cvs
add</tt>
+ </p></dd><dt><span class="term"><code
class="computeroutput">Locally
Added</code></span></dt><dd><p>
+ You added the file with the <code class="command">cvs
add</code>
command but have not yet committed the addition of the
file.
- </p></dd><dt><span class="term"><tt
class="computeroutput">Locally
Removed</tt></span></dt><dd><p>
- You removed the file with the <tt class="command">cvs
- remove</tt> command but have not yet committed the
+ </p></dd><dt><span class="term"><code
class="computeroutput">Locally
Removed</code></span></dt><dd><p>
+ You removed the file with the <code class="command">cvs
+ remove</code> command but have not yet committed the
removal.
- </p></dd><dt><span class="term"><tt
class="computeroutput">Needs
Checkout</tt></span></dt><dd><p>
+ </p></dd><dt><span class="term"><code
class="computeroutput">Needs
Checkout</code></span></dt><dd><p>
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 <tt class="command">cvs update</tt>
command.
- </p></dd><dt><span class="term"><tt
class="computeroutput">Needs
Patch</tt></span></dt><dd><p>
+ files with the <code class="command">cvs
update</code> command.
+ </p></dd><dt><span class="term"><code
class="computeroutput">Needs
Patch</code></span></dt><dd><p>
The revision in your local checkout needs a patch to be
the latest revision from the server. Issue the
- <tt class="command">cvs update</tt> command to
resolve.
- </p></dd><dt><span class="term"><tt
class="computeroutput">Needs
Merge</tt></span></dt><dd><p>
+ <code class="command">cvs update</code> command to
resolve.
+ </p></dd><dt><span class="term"><code
class="computeroutput">Needs
Merge</code></span></dt><dd><p>
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.
- </p></dd><dt><span class="term"><tt
class="computeroutput">File had conflicts on
merge</tt></span></dt><dd><p>
- Similar to <tt class="computeroutput">Needs
Merge</tt>,
- except when you tried to issue the <tt class="command">cvs
- update</tt> command, the differences could not be
+ </p></dd><dt><span class="term"><code
class="computeroutput">File had conflicts on
merge</code></span></dt><dd><p>
+ Similar to <code class="computeroutput">Needs
Merge</code>,
+ except when you tried to issue the <code
class="command">cvs
+ update</code> command, the differences could not be
resolved automatically. Refer to
- <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts"
title="10.4.8. Resolving Conflicts">Section 10.4.8,
“Resolving Conflicts”</a> for
+ <a href="sn-cvs-cvscommands.php#sn-cvs-cvscommands-conflicts"
title="8.4.8.��Resolving Conflicts">Section��8.4.8, ���Resolving
Conflicts���</a> for
more information on resolving conflicts.
- </p></dd><dt><span class="term"><tt
class="computeroutput">Unknown</tt></span></dt><dd><p>
- The <span><b
class="application">CVS</b></span> server does not know
+ </p></dd><dt><span class="term"><code
class="computeroutput">Unknown</code></span></dt><dd><p>
+ The <span><strong
class="application">CVS</strong></span> 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 <span><b
class="application">CVS</b></span> such as
- <tt class="filename">generated-index.sgml</tt> or for
files
+ not commit to <span><strong
class="application">CVS</strong></span> such as
+ <code class="filename">generated-index.sgml</code> or
for files
that you want to add to the repository but have not yet
- issued the <tt class="command">cvs add</tt> command.
- </p></dd></dl></div></div><div
class="section" lang="en"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-conflicts"></a>10.4.8. Resolving
Conflicts</h3></div></div><div></div></div><a
class="indexterm" name="id2972689"></a><p>
+ issued the <code class="command">cvs add</code>
command.
+ </p></dd></dl></div></div><div
class="section" lang="en-US"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-conflicts"></a>8.4.8.��Resolving
Conflicts</h3></div></div></div><a class="indexterm"
name="id3049270"></a><p>
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:
</p><pre class="screen">
-<tt class="computeroutput">
+<code class="computeroutput">
RCS file: /cvs/docs/module-name/filename.sgml,v
retrieving revision 1.12
retrieving revision 1.13
@@ -247,14 +247,14 @@
rcsmerge: warning: conflicts during merge
cvs server: conflicts found in filename.sgml
C filename.sgml
-</tt>
+</code>
</pre><p>
To resolve the conflict, open the file, search for
- <tt
class="computeroutput"><<<<<<<</tt>
+ <code
class="computeroutput"><<<<<<<</code>
and determine which version of the content is correct. For
example:
</p><pre class="screen">
-<tt class="computeroutput">
+<code class="computeroutput">
<para>
Some sentence.
<<<<<<< filename.sgml
@@ -263,50 +263,61 @@
A same sentence that was changed differently and committed.
>>>>>>> 1.13
</para>
-</tt>
+</code>
</pre><p>
The content between the
- <tt
class="computeroutput"><<<<<<<</tt>,
- and the <tt class="computeroutput">=======</tt> is the
content
+ <code
class="computeroutput"><<<<<<<</code>,
+ and the <code class="computeroutput">=======</code> is the
content
from your working copy. The content between the
- <tt class="computeroutput">=======</tt> and the
- <tt
class="computeroutput">>>>>>>></tt>
is
+ <code class="computeroutput">=======</code> and the
+ <code
class="computeroutput">>>>>>>></code>
is
the content from the server.
</p><p>
Resolve the conflict by editing your copy, and commit the file.
- </p></div><div class="section"
lang="en"><div class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-summary"></a>10.4.9. Summary</h3></div></div><div></div></div><a
class="indexterm" name="id2972801"></a><p>
+ </p></div><div class="section"
lang="en-US"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-cvscommands-summary"></a>8.4.9.��Summary</h3></div></div></div><a
class="indexterm" name="id3049380"></a><p>
All commands assume you are in the proper directory for the
- <span><b class="application">CVS</b></span>
module.
- </p><div class="table"><a
name="tb-cvs-basic-commands"></a><table summary="Basic CVS
Commands"
border="1"><colgroup><col><col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><tt
class="command">cvs checkout
- <i
class="replaceable"><tt><module-name></tt></i></tt>
- or <tt class="command">cvs co <i
class="replaceable"><tt><module-name></tt></i></tt></td><td>Creates
a directory called
- <i
class="replaceable"><tt><module-name></tt></i>
with the contents of the
- module in the directory</td></tr><tr><td><tt
class="command">cvs co -d <i
class="replaceable"><tt><directory></tt></i>
-r <i
class="replaceable"><tt><branchname></tt></i><i
class="replaceable"><tt><module-name></tt></i></tt></td><td>Creates
the <i
class="replaceable"><tt><directory></tt></i>
directory
- with the contents of the <i
class="replaceable"><tt><branchname></tt></i>
- branch of the <i
class="replaceable"><tt><module-name></tt></i>
module</td></tr><tr><td><tt class="command">cvs
update</tt> or <tt class="command">cvs
up</tt></td><td>Update your files with the latest files from the CVS
server</td></tr><tr><td><tt class="command">cvs
add <i
class="replaceable"><tt><filename></tt></i></tt></td><td>Add
a new file "filename" to the CVS
server</td></tr><tr><td><tt class="command">cvs
commit -m "My message"
- <i
class="replaceable"><tt><filename></tt></i></tt></td><td>Update
file <i
class="replaceable"><tt><filename></tt></i>
with the
- latest copy from your computer</td></tr><tr><td><tt
class="command">cvs log <i
class="replaceable"><tt><filename></tt></i></tt></td><td>View
the commit messages for the file <i
class="replaceable"><tt><filename></tt></i></td></tr><tr><td><tt
class="command">cvs status <i
class="replaceable"><tt><filename></tt></i></tt></td><td>View
status of the file, such as <tt class="computeroutput">Locally
- Modified</tt></td></tr><tr><td><tt
class="command">cvs status -v <i
class="replaceable"><tt><filename></tt></i></tt></td><td>View
existing tags and branches for file</td></tr><tr><td><tt
class="command">cvs diff <i
class="replaceable"><tt><filename></tt></i></tt></td><td>Show
diff of the working copy of the file and the latest
- version of the file for the branch</td></tr><tr><td><tt
class="command">cvs diff -r1.1 -r1.2 <i
class="replaceable"><tt><filename></tt></i></tt></td><td>Show
diff of version 1.1 and 1.2 for
file</td></tr></tbody></table><p
class="title"><b>Table 10.1. Basic CVS
Commands</b></p></div><p>
+ <span><strong
class="application">CVS</strong></span> module.
+ </p><div class="table"><a
name="tb-cvs-basic-commands"></a><div
class="table-contents"><table summary="Basic CVS Commands"
border="1"><colgroup><col><col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><code
class="command">cvs checkout
+ <em
class="replaceable"><code><module-name></code></em></code>
+ or <code class="command">cvs co <em
class="replaceable"><code><module-name></code></em></code>
+ </td><td>Creates a directory called
+ <em
class="replaceable"><code><module-name></code></em>
with the contents of the
+ module in the directory</td></tr><tr><td><code
class="command">cvs co -d <em
class="replaceable"><code><directory></code></em>
-r <em
class="replaceable"><code><branchname></code></em><em
class="replaceable"><code><module-name></code></em></code>
+ </td><td>Creates the <em
class="replaceable"><code><directory></code></em>
directory
+ with the contents of the <em
class="replaceable"><code><branchname></code></em>
+ branch of the <em
class="replaceable"><code><module-name></code></em>
module</td></tr><tr><td><code class="command">cvs
update</code> or <code class="command">cvs up</code>
+ </td><td>Update your files with the latest files from the CVS
server</td></tr><tr><td><code class="command">cvs
add <em
class="replaceable"><code><filename></code></em></code>
+ </td><td>Add a new file "filename" to the CVS
server</td></tr><tr><td><code class="command">cvs
commit -m "My message"
+ <em
class="replaceable"><code><filename></code></em></code>
+ </td><td>Update file <em
class="replaceable"><code><filename></code></em>
with the
+ latest copy from your computer</td></tr><tr><td><code
class="command">cvs log <em
class="replaceable"><code><filename></code></em></code>
+ </td><td>View the commit messages for the file <em
class="replaceable"><code><filename></code></em>
+ </td></tr><tr><td><code
class="command">cvs status <em
class="replaceable"><code><filename></code></em></code>
+ </td><td>View status of the file, such as <code
class="computeroutput">Locally
+ Modified</code>
+ </td></tr><tr><td><code
class="command">cvs status -v <em
class="replaceable"><code><filename></code></em></code>
+ </td><td>View existing tags and branches for
file</td></tr><tr><td><code class="command">cvs
diff <em
class="replaceable"><code><filename></code></em></code>
+ </td><td>Show diff of the working copy of the file and the
latest
+ version of the file for the
branch</td></tr><tr><td><code class="command">cvs
diff -r1.1 -r1.2 <em
class="replaceable"><code><filename></code></em></code>
+ </td><td>Show diff of version 1.1 and 1.2 for
file</td></tr></tbody></table></div><p
class="title"><b>Table��8.1.��Basic CVS
Commands</b></p></div><br class="table-break"><p>
For more information, read the CVS manual available on your
system at
- <tt class="filename">/usr/share/doc/cvs-<i
class="replaceable"><tt><version-number></tt></i>/cvs.ps</tt>
+ <code class="filename">/usr/share/doc/cvs-<em
class="replaceable"><code><version-number></code></em>/cvs.ps</code>
(the CVS version might vary) and visit the CVS webpage available
at
<a
href="http://www.cvshome.org/"
target="_top">http://www.cvshome.org/</a>.
- </p><div class="tip" style="margin-left: 0.5in;
margin-right: 0.5in;"><table border="0" summary="Tip:
Tip"><tr><td rowspan="2" align="center"
valign="top" width="25"><img alt="[Tip]"
src="./stylesheet-images/tip.png"></td><th
align="left">Tip</th></tr><tr><td colspan="2"
align="left" valign="top"><p>
- Since <span><b
class="application">CVS</b></span> is using
- <span><b class="application">ssh</b></span>
to connect to the
- <span><b class="application">CVS</b></span>
server, you will be prompted
+ </p><div class="tip" style="margin-left: 0.5in;
margin-right: 0.5in;"><table border="0" summary="Tip:
Tip"><tr><td rowspan="2" align="center"
valign="top" width="25"><img alt="[Tip]"
src="./stylesheet-images/tip.png"></td><th
align="left">Tip</th></tr><tr><td align="left"
valign="top"><p>
+ Since <span><strong
class="application">CVS</strong></span> is using
+ <span><strong
class="application">ssh</strong></span> to connect to the
+ <span><strong
class="application">CVS</strong></span> server, you will be
prompted
your password before performing your
- <span><b class="application">CVS</b></span>
request. If you want to
+ <span><strong
class="application">CVS</strong></span> request. If you want to
configure your machine so that you do not have to enter a
password, refer to the
- <a
href="http://redhat.com/docs/manuals/linux/RHL-9-Manual/custom-guide...
target="_top"><i class="citetitle">Red Hat
- Linux 9 Customization Guide</i> </a> for details
- about using <tt class="command">ssh-agent</tt>.
-
</p></td></tr></table></div></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="sn-cvs-config.php">Prev</a> </td><td
width="20%" align="center"><a accesskey="u"
href="ch-cvs.php">Up</a></td><td width="40%"
align="right"> <a accesskey="n"
href="acknowledgments.php">Next</a></td></tr><tr><td
width="40%" align="left"
valign="top">10.3. Configuring For CVS
Access </td><td width="20%" align="center"><a
accesskey="h" href="index.php">Home</a></td><td
width="40%" align="right"
valign="top"> Chapter 11. Acknowledgments</td></tr></table></div>
-
+ <a
href="http://redhat.com/docs/manuals/linux/RHL-9-Manual/custom-guide...
target="_top"><em class="citetitle">Red Hat
+ Linux 9 Customization Guide</em> </a> for details
+ about using <code class="command">ssh-agent</code>.
+
</p></td></tr></table></div></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="sn-cvs-config.php">Prev</a>��</td><td
width="20%" align="center"><a accesskey="u"
href="ch-cvs.php">Up</a></td><td width="40%"
align="right">��<a accesskey="n"
href="acknowledgments.php">Next</a></td></tr><tr><td
width="40%" align="left" valign="top">8.3.��Configuring
For CVS Access��</td><td width="20%" align="center"><a
accesskey="h" href="index.php">Home</a></td><td
width="40%" align="right"
valign="top">��Chapter��9.��Acknowledgments</td></tr></table></div>
<?
$template->displayFooter('$Date$');
Index: sn-cvs-preparation.php
===================================================================
RCS file: /cvs/fedora/web/html/docs/documentation-guide/sn-cvs-preparation.php,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- sn-cvs-preparation.php 6 Dec 2005 19:37:14 -0000 1.1
+++ sn-cvs-preparation.php 23 Jun 2007 05:42:10 -0000 1.2
@@ -2,83 +2,82 @@
include("site.inc");
$template = new Page;
-$template->initCommon();
+$template->initCommon();
$template->displayHeader();
?>
-<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">10.2. Preparing For CVS
Use</th></tr><tr><td width="20%"
align="left"><a accesskey="p"
href="ch-cvs.php">Prev</a> </td><th
width="60%"
align="center">Chapter 10. CVS</th><td
width="20%" align="right"> <a accesskey="n"
href="sn-cvs-config.php">Next</a></td></tr></table><hr></div><div
class="section" lang="en"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="sn-cvs-preparation"></a>10.2. Preparing For CVS
Use</h2></div></div><div></div></div><a
class="indexterm" name="id2970413"></a><p>
- Before using <span><b
class="application">CVS</b></span>, you need to establish
- an account with the <span><b
class="application">CVS</b></span> server. After
+<div class="navheader"><table width="100%"
summary="Navigation header"><tr><th colspan="3"
align="center">8.2.��Preparing For CVS
Use</th></tr><tr><td width="20%"
align="left"><a accesskey="p"
href="ch-cvs.php">Prev</a>��</td><th width="60%"
align="center">Chapter��8.��CVS</th><td width="20%"
align="right">��<a accesskey="n"
href="sn-cvs-config.php">Next</a></td></tr></table><hr></div><div
class="section" lang="en-US"><div
class="titlepage"><div><div><h2 class="title"
style="clear: both"><a
name="sn-cvs-preparation"></a>8.2.��Preparing For CVS
Use</h2></div></div></div><a class="indexterm"
name="id3066162"></a><p>
+ Before using <span><strong
class="application">CVS</strong></span>, you need to establish
+ an account with the <span><strong
class="application">CVS</strong></span> server. After
getting an account, you do not need to perform these actions
again.
- </p><div class="section" lang="en"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-rpm-check"></a>10.2.1. Is CVS Installed On Your
System</h3></div></div><div></div></div><a
class="indexterm" name="id2970452"></a><p>
- You must have the <span><b
class="application">CVS</b></span>
- <span class="abbrev">RPM</span> package installed. Verify
its presence by
+ </p><div class="section" lang="en-US"><div
class="titlepage"><div><div><h3
class="title"><a name="sn-cvs-rpm-check"></a>8.2.1.��Is
CVS Installed On Your System</h3></div></div></div><a
class="indexterm" name="id3008544"></a><p>
+ You must have the <span><strong
class="application">CVS</strong></span>
+ <abbr class="abbrev">RPM</abbr> package installed. Verify
its presence by
typing the command:
- </p><pre class="screen"><tt class="prompt">$
</tt><tt class="command">rpm -q cvs</tt></pre><p>
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">rpm -q
cvs</code></pre><p>
If you see output similar to
- <tt class="computeroutput">cvs-1.11.19-1</tt>, then the
package
- is installed. A message similar to <tt
class="computeroutput">package cvs
- is not installed</tt> means you must install the
- <span><b class="application">cvs</b></span>
package before continuing. If you
+ <code class="computeroutput">cvs-1.11.19-1</code>, then the
package
+ is installed. A message similar to <code
class="computeroutput">package cvs
+ is not installed</code> means you must install the
+ <span><strong
class="application">cvs</strong></span> package before
continuing. If you
do not know how to do this, consult your system administrator
who can install it for you.
- </p></div><div class="section"
lang="en"><div class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-generate-keys"></a>10.2.2. Generating SSH
Keys</h3></div></div><div></div></div><a
class="indexterm" name="id2970530"></a><p>
- The <span><b class="application">CVS</b></span>
server uses
- <span><b class="application">SSH</b></span>
Protocol 2 keys to authenticate
+ </p></div><div class="section"
lang="en-US"><div
class="titlepage"><div><div><h3
class="title"><a
name="sn-cvs-generate-keys"></a>8.2.2.��Generating SSH
Keys</h3></div></div></div><a class="indexterm"
name="id3034077"></a><p>
+ The <span><strong
class="application">CVS</strong></span> server uses
+ <span><strong
class="application">SSH</strong></span> Protocol 2 keys to
authenticate
users. Thus, you need to generate a pair of keys before applying
- for a <span><b
class="application">CVS</b></span> account. If you already
- have an <span><b
class="application">SSH</b></span> <span
class="abbrev">DSA</span> key,
+ for a <span><strong
class="application">CVS</strong></span> account. If you already
+ have an <span><strong
class="application">SSH</strong></span> <abbr
class="abbrev">DSA</abbr> key,
you may skip this step.
- </p><div class="tip" style="margin-left: 0.5in;
margin-right: 0.5in;"><table border="0" summary="Tip:
Tip"><tr><td rowspan="2" align="center"
valign="top" width="25"><img alt="[Tip]"
src="./stylesheet-images/tip.png"></td><th
align="left">Tip</th></tr><tr><td colspan="2"
align="left" valign="top"><p>
- You already have a <span class="abbrev">DSA</span> key if
you have the
- file <tt class="filename">~/.ssh/id_dsa.pub</tt> on the
system.
+ </p><div class="tip" style="margin-left: 0.5in;
margin-right: 0.5in;"><table border="0" summary="Tip:
Tip"><tr><td rowspan="2" align="center"
valign="top" width="25"><img alt="[Tip]"
src="./stylesheet-images/tip.png"></td><th
align="left">Tip</th></tr><tr><td align="left"
valign="top"><p>
+ You already have a <abbr class="abbrev">DSA</abbr> key if
you have the
+ file <code class="filename">~/.ssh/id_dsa.pub</code> on
the system.
</p><p>
- If your existing <span class="abbrev">DSA</span> key does
not require a
- <i class="wordasword">passphrase</i>, you are strongly
urged to
+ If your existing <abbr class="abbrev">DSA</abbr> key does
not require a
+ <em class="wordasword">passphrase</em>, you are strongly
urged to
generate one that does require a passphrase.
</p></td></tr></table></div><p>
- Use the following steps to generate a <span
class="abbrev">DSA</span> key
- used by <span><b
class="application">SSH</b></span> Protocol 2. It is
+ Use the following steps to generate a <abbr
class="abbrev">DSA</abbr> key
+ used by <span><strong
class="application">SSH</strong></span> Protocol 2. It is
required for an
- <tt class="computeroutput">cvs.fedora.redhat.com</tt>
- <span><b class="application">CVS</b></span>
account.
- </p><div class="orderedlist"><a
class="indexterm" name="id2970641"></a><a
class="indexterm" name="id2970658"></a><ol
type="1"><li><p>
+ <code class="computeroutput">cvs.fedoraproject.org</code>
+ <span><strong
class="application">CVS</strong></span> account.
+ </p><div class="orderedlist"><a
class="indexterm" name="id3067973"></a><a
class="indexterm" name="id3026889"></a><ol
type="1"><li><p>
To generate a
- <span class="acronym">DSA</span>
+ <acronym class="acronym">DSA</acronym>
key to work with version 2.0 protocol, at a shell prompt,
type the command:
- </p><pre class="screen"><tt
class="prompt">$ </tt><tt class="command">ssh-keygen -t
dsa</tt></pre><p>
+ </p><pre class="screen"><code
class="prompt">$ </code><code
class="command">ssh-keygen -t dsa</code></pre><p>
Accept the default file location of
- <tt class="filename">~/.ssh/id_dsa</tt>. You are
strongly urged
- to define and use a <i class="firstterm">passphrase</i>
to
+ <code class="filename">~/.ssh/id_dsa</code>. You are
strongly urged
+ to define and use a <em
class="firstterm">passphrase</em> to
enhance the security of your key. Enter a passphrase
different than your account password and confirm it by
entering it again.
</p></li><li><p>
Copy your new key to the correct file by typing the
following at a shell prompt.
- </p><pre class="screen"><tt
class="prompt">$ </tt><tt class="command">cat
~/.ssh/id_dsa.pub>>~/.ssh/authorized_keys</tt></pre><div
class="note" style="margin-left: 0.5in; margin-right:
0.5in;"><table border="0"
summary="Note"><tr><td rowspan="2"
align="center" valign="top" width="25"><img
alt="[Note]" src="./stylesheet-images/note.png"></td><th
align="left">Note</th></tr><tr><td colspan="2"
align="left" valign="top"><p>
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">cat
~/.ssh/id_dsa.pub>>~/.ssh/authorized_keys</code></pre><div
class="note" style="margin-left: 0.5in; margin-right:
0.5in;"><table border="0"
summary="Note"><tr><td rowspan="2"
align="center" valign="top" width="25"><img
alt="[Note]" src="./stylesheet-images/note.png"></td><th
align="left">Note</th></tr><tr><td
align="left" valign="top"><p>
Check this command carefully before you press the
- <span><b
class="guibutton">ENTER</b></span>
- key. If <tt
class="filename">~/.ssh/authorized_keys</tt>
+ <span><strong
class="guibutton">ENTER</strong></span>
+ key. If <code
class="filename">~/.ssh/authorized_keys</code>
already exists, the contents of
- <tt class="filename">~/.ssh/id_dsa.pub</tt> will be
appended to
- the end of the <tt
class="filename">~/.ssh/authorized_keys</tt>
+ <code class="filename">~/.ssh/id_dsa.pub</code> will
be appended to
+ the end of the <code
class="filename">~/.ssh/authorized_keys</code>
file.
</p></td></tr></table></div></li><li><p>
- Change the permissions of your <tt
class="filename">~/.ssh</tt>
+ Change the permissions of your <code
class="filename">~/.ssh</code>
directory and your keys with the commands:
- </p><pre class="screen"><tt
class="prompt">$ </tt><tt class="command">chmod 755
~/.ssh</tt>
-<tt class="prompt">$ </tt><tt class="command">chmod
644 ~/.ssh/authorized_keys</tt></pre></li></ol></div><div
class="tip" style="margin-left: 0.5in; margin-right:
0.5in;"><table border="0" summary="Tip:
Tip"><tr><td rowspan="2" align="center"
valign="top" width="25"><img alt="[Tip]"
src="./stylesheet-images/tip.png"></td><th
align="left">Tip</th></tr><tr><td colspan="2"
align="left" valign="top"><p>
+ </p><pre class="screen"><code
class="prompt">$ </code><code class="command">chmod 700
~/.ssh</code>
+<code class="prompt">$ </code><code
class="command">chmod 644
~/.ssh/authorized_keys</code></pre></li></ol></div><div
class="tip" style="margin-left: 0.5in; margin-right:
0.5in;"><table border="0" summary="Tip:
Tip"><tr><td rowspan="2" align="center"
valign="top" width="25"><img alt="[Tip]"
src="./stylesheet-images/tip.png"></td><th
align="left">Tip</th></tr><tr><td align="left"
valign="top"><p>
You can have your system remember your passphrase so that you
do not have to type it every time you access the
- <span><b class="application">CVS</b></span>
server. Refer to the
- documentation of the <span><b
class="application">ssh-add</b></span>
+ <span><strong
class="application">CVS</strong></span> server. Refer to the
+ documentation of the <span><strong
class="application">ssh-add</strong></span>
program.
-
</p></td></tr></table></div></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="ch-cvs.php">Prev</a> </td><td
width="20%" align="center"><a accesskey="u"
href="ch-cvs.php">Up</a></td><td width="40%"
align="right"> <a accesskey="n"
href="sn-cvs-config.php">Next</a></td></tr><tr><td
width="40%" align="left"
valign="top">Chapter 10. CVS </td><td
width="20%" align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right" valign="top"> 10.3. Configuring For
CVS Access</td></tr></table></div>
-
+
</p></td></tr></table></div></div></div><div
class="navfooter"><hr><table width="100%"
summary="Navigation footer"><tr><td width="40%"
align="left"><a accesskey="p"
href="ch-cvs.php">Prev</a>��</td><td width="20%"
align="center"><a accesskey="u"
href="ch-cvs.php">Up</a></td><td width="40%"
align="right">��<a accesskey="n"
href="sn-cvs-config.php">Next</a></td></tr><tr><td
width="40%" align="left"
valign="top">Chapter��8.��CVS��</td><td width="20%"
align="center"><a accesskey="h"
href="index.php">Home</a></td><td width="40%"
align="right" valign="top">��8.3.��Configuring For CVS
Access</td></tr></table></div>
<?
$template->displayFooter('$Date$');