281 lines
8.7 KiB
Text
281 lines
8.7 KiB
Text
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.
|
|
|
|
Redistribution and use in source (SGML DocBook) and 'compiled' forms
|
|
(SGML, HTML, PDF, PostScript, RTF and so forth) with or without
|
|
modification, are permitted provided that the following conditions
|
|
are met:
|
|
|
|
1. Redistributions of source code (SGML DocBook) must retain the above
|
|
copyright notice, this list of conditions and the following
|
|
disclaimer as the first lines of this file unmodified.
|
|
|
|
2. Redistributions in compiled form (transformed to other DTDs,
|
|
converted to PDF, PostScript, RTF and other formats) must reproduce
|
|
the above copyright notice, this list of conditions and the
|
|
following disclaimer in the documentation and/or other materials
|
|
provided with the distribution.
|
|
|
|
THIS DOCUMENTATION IS PROVIDED BY NIK CLAYTON "AS IS" AND ANY EXPRESS OR
|
|
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL NIK CLAYTON BE LIABLE FOR ANY DIRECT,
|
|
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
|
|
POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
$Id: book.sgml,v 1.5 1999-07-14 22:31:28 nik Exp $
|
|
-->
|
|
|
|
<!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [
|
|
|
|
<!ENTITY % man PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN">
|
|
%man;
|
|
|
|
<!ENTITY % chapters SYSTEM "chapters.ent"> %chapters;
|
|
]>
|
|
|
|
<book>
|
|
<bookinfo>
|
|
<title>FreeBSD Documentation Project Primer for New Contributors</title>
|
|
|
|
<author>
|
|
<firstname>Nik</firstname>
|
|
<surname>Clayton</surname>
|
|
<affiliation>
|
|
<address><email>nik@FreeBSD.ORG</email></address>
|
|
</affiliation>
|
|
</author>
|
|
|
|
<copyright>
|
|
<year>1998</year>
|
|
<year>1999</year>
|
|
<holder role="mailto:nik@FreeBSD.ORG">Nik Clayton</holder>
|
|
</copyright>
|
|
|
|
<pubdate role="rcs">$Date: 1999-07-14 22:31:28 $</pubdate>
|
|
|
|
<releaseinfo>$Id: book.sgml,v 1.5 1999-07-14 22:31:28 nik Exp $</releaseinfo>
|
|
|
|
<legalnotice>
|
|
<para>Redistribution and use in source (SGML DocBook) and 'compiled'
|
|
forms (SGML, HTML, PDF, PostScript, RTF and so forth) with or without
|
|
modification, are permitted provided that the following conditions are
|
|
met:</para>
|
|
|
|
<orderedlist>
|
|
<listitem>
|
|
<para>Redistributions of source code (SGML DocBook) must retain the
|
|
above copyright notice, this list of conditions and the following
|
|
disclaimer as the first lines of this file unmodified.</para>
|
|
</listitem>
|
|
|
|
<listitem>
|
|
<para>Redistributions in compiled form (transformed to other DTDs,
|
|
converted to PDF, PostScript, RTF and other formats) must
|
|
reproduce the above copyright notice, this list of conditions and
|
|
the following disclaimer in the documentation and/or other
|
|
materials provided with the distribution.</para>
|
|
</listitem>
|
|
</orderedlist>
|
|
|
|
<important>
|
|
<para>THIS DOCUMENTATION IS PROVIDED BY NIK CLAYTON "AS IS" AND ANY
|
|
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NIK CLAYTON BE LIABLE FOR
|
|
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
|
|
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
|
|
DAMAGE.</para>
|
|
</important>
|
|
</legalnotice>
|
|
|
|
<abstract>
|
|
<para>Thank you for becoming a part of the FreeBSD Documentation
|
|
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 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>
|
|
|
|
<preface>
|
|
<title>Preface</title>
|
|
|
|
<sect1>
|
|
<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>
|
|
|
|
<informaltable frame="none">
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>User</entry>
|
|
<entry>Prompt</entry>
|
|
</row>
|
|
</thead>
|
|
|
|
<tbody>
|
|
<row>
|
|
<entry>Normal user</entry>
|
|
<entry>&prompt.user;</entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry><username>root</username></entry>
|
|
<entry>&prompt.root;</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</sect1>
|
|
|
|
<sect1>
|
|
<title>Typographic Conventions</title>
|
|
|
|
<para>The following table describes the typographic conventions used in
|
|
this book.</para>
|
|
|
|
<informaltable frame="none">
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>Meaning</entry>
|
|
<entry>Examples</entry>
|
|
</row>
|
|
</thead>
|
|
|
|
<tbody>
|
|
<row>
|
|
<entry>The name of commands, files, and directories. On screen
|
|
computer output.</entry>
|
|
<entry><para>Edit your <filename>.login</filename>
|
|
file.</para><para>Use <command>ls -a</command> to list all
|
|
files.</para><para><screen>You have mail.</screen>
|
|
</para></entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>What you type, when contrasted with on-screen computer
|
|
output.</entry>
|
|
|
|
<entry><screen>&prompt.user; <userinput>su</userinput>
|
|
Password:</screen></entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>Manual page references.</entry>
|
|
|
|
<entry>Use <citerefentry>
|
|
<refentrytitle>su</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
</citerefentry> to change user names.</entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>User and group names</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>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>Environment variables</entry>
|
|
|
|
<entry><envar>$HOME</envar> is your home directory.</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</sect1>
|
|
|
|
<sect1>
|
|
<title>Notes, warnings, and examples</title>
|
|
|
|
<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>
|
|
</note>
|
|
|
|
<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 inadvertant 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>
|
|
</example>
|
|
</sect1>
|
|
|
|
<sect1>
|
|
<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>
|
|
</sect1>
|
|
</preface>
|
|
|
|
&chap.overview;
|
|
&chap.tools;
|
|
&chap.sgml-primer;
|
|
&chap.sgml-markup;
|
|
&chap.stylesheets;
|
|
&chap.the-faq;
|
|
&chap.the-handbook;
|
|
&chap.the-website;
|
|
&chap.translations;
|
|
&chap.writing-style;
|
|
&chap.psgml-mode;
|
|
&chap.see-also;
|
|
|
|
</book>
|
|
|
|
<!--
|
|
Local Variables:
|
|
mode: sgml
|
|
sgml-indent-data: t
|
|
sgml-omittag: nil
|
|
sgml-always-quote-attributes: t
|
|
End:
|
|
-->
|