Whitespace-only fixes. Wrap long lines and use tabs instead of spaces
where appropriate.
This commit is contained in:
Warren Block
parent
8b77569806
commit
54ef3d3d4b
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=38420
1 changed files with 64 additions and 59 deletions
|
|
@ -40,10 +40,11 @@
|
|||
|
||||
<book>
|
||||
<bookinfo>
|
||||
<title>FreeBSD Documentation Project Primer for New Contributors</title>
|
||||
|
||||
<title>FreeBSD Documentation Project Primer for New
|
||||
Contributors</title>
|
||||
|
||||
<corpauthor>The FreeBSD Documentation Project</corpauthor>
|
||||
|
||||
|
||||
<copyright>
|
||||
<year>1998</year>
|
||||
<year>1999</year>
|
||||
|
|
@ -65,19 +66,19 @@
|
|||
<releaseinfo>$FreeBSD$</releaseinfo>
|
||||
|
||||
&bookinfo.legalnotice;
|
||||
|
||||
|
||||
<abstract>
|
||||
<para>Thank you for becoming a part of the FreeBSD Documentation
|
||||
Project. Your contribution is extremely valuable.</para>
|
||||
Project. Your contribution is extremely valuable.</para>
|
||||
|
||||
<para>This primer covers everything you will need to know in order
|
||||
to start contributing to the FreeBSD Documentation Project, from
|
||||
the tools and software you will be using (both mandatory and
|
||||
recommended) to the philosophy behind the Documentation
|
||||
Project.</para>
|
||||
<para>This primer covers everything you will need to know in
|
||||
order to start contributing to the FreeBSD Documentation
|
||||
Project, from the tools and software you will be using (both
|
||||
mandatory and recommended) to the philosophy behind the
|
||||
Documentation Project.</para>
|
||||
|
||||
<para>This document is a work in progress, and is not complete. Sections
|
||||
that are known to be incomplete are indicated with a
|
||||
<para>This document is a work in progress, and is not complete.
|
||||
Sections that are known to be incomplete are indicated with a
|
||||
<literal>*</literal> in their name.</para>
|
||||
</abstract>
|
||||
</bookinfo>
|
||||
|
|
@ -87,10 +88,11 @@
|
|||
|
||||
<sect1 id="preface-prompts">
|
||||
<title>Shell Prompts</title>
|
||||
|
||||
<para>The following table shows the default system prompt and superuser
|
||||
prompt. The examples will use this prompt to indicate which user you
|
||||
should be running the example as.</para>
|
||||
|
||||
<para>The following table shows the default system prompt and
|
||||
superuser prompt. The examples will use this prompt to
|
||||
indicate which user you should be running the example
|
||||
as.</para>
|
||||
|
||||
<informaltable frame="none" pgwide="1">
|
||||
<tgroup cols="2">
|
||||
|
|
@ -100,7 +102,7 @@
|
|||
<entry>Prompt</entry>
|
||||
</row>
|
||||
</thead>
|
||||
|
||||
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>Normal user</entry>
|
||||
|
|
@ -115,12 +117,12 @@
|
|||
</tgroup>
|
||||
</informaltable>
|
||||
</sect1>
|
||||
|
||||
|
||||
<sect1 id="preface-conventions">
|
||||
<title>Typographic Conventions</title>
|
||||
|
||||
<para>The following table describes the typographic conventions used in
|
||||
this book.</para>
|
||||
<para>The following table describes the typographic conventions
|
||||
used in this book.</para>
|
||||
|
||||
<informaltable frame="none" pgwide="1">
|
||||
<tgroup cols="2">
|
||||
|
|
@ -134,12 +136,14 @@
|
|||
<tbody>
|
||||
<row>
|
||||
<entry>The names of commands.</entry>
|
||||
<entry>Use <command>ls -l</command> to list all files.</entry>
|
||||
<entry>Use <command>ls -l</command> to list all
|
||||
files.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>The names of files.</entry>
|
||||
<entry>Edit your <filename>.login</filename> file.</entry>
|
||||
<entry>Edit your <filename>.login</filename>
|
||||
file.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
|
|
@ -148,8 +152,8 @@
|
|||
</row>
|
||||
|
||||
<row>
|
||||
<entry>What you type, when contrasted with on-screen computer
|
||||
output.</entry>
|
||||
<entry>What you type, when contrasted with on-screen
|
||||
computer output.</entry>
|
||||
|
||||
<entry><screen>&prompt.user; <userinput>su</userinput>
|
||||
Password:</screen></entry>
|
||||
|
|
@ -157,35 +161,31 @@ Password:</screen></entry>
|
|||
|
||||
<row>
|
||||
<entry>Manual page references.</entry>
|
||||
|
||||
<entry>Use
|
||||
&man.su.1;
|
||||
to change user names.</entry>
|
||||
<entry>Use &man.su.1; to change user names.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>User and group names</entry>
|
||||
|
||||
<entry>Only <username>root</username> can do this.</entry>
|
||||
<entry>Only <username>root</username> can do
|
||||
this.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Emphasis</entry>
|
||||
|
||||
<entry>You <emphasis>must</emphasis> do this.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Command line variables; replace with the real name or
|
||||
variable.</entry>
|
||||
|
||||
<entry>To delete a file, type <command>rm <filename><replaceable>filename</replaceable></filename></command></entry>
|
||||
<entry>Command line variables; replace with the real
|
||||
name or variable.</entry>
|
||||
<entry>To delete a file, type <command>rm
|
||||
<filename><replaceable>filename</replaceable></filename></command></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Environment variables</entry>
|
||||
|
||||
<entry><envar>$HOME</envar> is your home directory.</entry>
|
||||
<entry><envar>$HOME</envar> is your home
|
||||
directory.</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
|
|
@ -193,52 +193,57 @@ Password:</screen></entry>
|
|||
</sect1>
|
||||
|
||||
<sect1 id="preface-notes">
|
||||
<title>Notes, Tips, Important Information, Warnings, and Examples</title>
|
||||
<title>Notes, Tips, Important Information, Warnings, and
|
||||
Examples</title>
|
||||
|
||||
<para>Within the text appear notes, warnings, and examples.</para>
|
||||
<para>Within the text appear notes, warnings, and
|
||||
examples.</para>
|
||||
|
||||
<note>
|
||||
<para>Notes are represented like this, and contain information that
|
||||
you should take note of, as it may affect what you do.</para>
|
||||
<para>Notes are represented like this, and contain information
|
||||
that you should take note of, as it may affect what you
|
||||
do.</para>
|
||||
</note>
|
||||
|
||||
<tip>
|
||||
<para>Tips are represented like this, and contain information that you
|
||||
might find useful, or lead to an easier way to do something.</para>
|
||||
<para>Tips are represented like this, and contain information
|
||||
that you might find useful, or lead to an easier way to do
|
||||
something.</para>
|
||||
</tip>
|
||||
|
||||
<important>
|
||||
<para>Important information is represented like this. Typically they
|
||||
flag extra steps you may need to carry out.</para>
|
||||
<para>Important information is represented like this.
|
||||
Typically they flag extra steps you may need to carry
|
||||
out.</para>
|
||||
</important>
|
||||
|
||||
<warning>
|
||||
<para>Warnings are represented like this, and contain information
|
||||
warning you about possible damage if you do not follow the
|
||||
instructions. This damage may be physical, to your hardware or to
|
||||
you, or it may be non-physical, such as the inadvertent deletion of
|
||||
important files.</para>
|
||||
<para>Warnings are represented like this, and contain
|
||||
information warning you about possible damage if you do not
|
||||
follow the instructions. This damage may be physical, to
|
||||
your hardware or to you, or it may be non-physical, such as
|
||||
the inadvertent deletion of important files.</para>
|
||||
</warning>
|
||||
|
||||
<example>
|
||||
<title>A Sample Example</title>
|
||||
|
||||
<para>Examples are represented like this, and typically contain
|
||||
examples you should walk through, or show you what the results of a
|
||||
particular action should be.</para>
|
||||
<para>Examples are represented like this, and typically
|
||||
contain examples you should walk through, or show you what
|
||||
the results of a particular action should be.</para>
|
||||
</example>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="preface-acknowledgements">
|
||||
<title>Acknowledgments</title>
|
||||
|
||||
<para>My thanks to Sue Blake, Patrick Durusau, Jon Hamilton, Peter
|
||||
Flynn, and Christopher Maden, who took the time to read early drafts
|
||||
of this document and offer many valuable comments and
|
||||
criticisms.</para>
|
||||
<para>My thanks to Sue Blake, Patrick Durusau, Jon Hamilton,
|
||||
Peter Flynn, and Christopher Maden, who took the time to read
|
||||
early drafts of this document and offer many valuable comments
|
||||
and criticisms.</para>
|
||||
</sect1>
|
||||
</preface>
|
||||
|
||||
|
||||
&chap.overview;
|
||||
&chap.tools;
|
||||
&chap.sgml-primer;
|
||||
|
|
@ -255,7 +260,7 @@ Password:</screen></entry>
|
|||
&app.examples;
|
||||
|
||||
<!--
|
||||
&index;
|
||||
&index;
|
||||
-->
|
||||
</book>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue