267 lines
7.6 KiB
XML
267 lines
7.6 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook XML V5.0-Based Extension//EN"
|
|
"http://www.FreeBSD.org/XML/share/xml/freebsd50.dtd" [
|
|
<!ENTITY % chapters SYSTEM "chapters.ent"> %chapters;
|
|
<!-- ENTITY index SYSTEM "index.xml" -->
|
|
]>
|
|
<!-- 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.
|
|
|
|
$FreeBSD$
|
|
-->
|
|
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
|
|
<info><title>FreeBSD Documentation Project Primer for New
|
|
Contributors</title>
|
|
|
|
|
|
<author><orgname>The FreeBSD Documentation Project</orgname></author>
|
|
|
|
<copyright>
|
|
<year>1998</year>
|
|
<year>1999</year>
|
|
<year>2000</year>
|
|
<year>2001</year>
|
|
<year>2002</year>
|
|
<year>2003</year>
|
|
<year>2004</year>
|
|
<year>2005</year>
|
|
<year>2006</year>
|
|
<year>2007</year>
|
|
<year>2008</year>
|
|
<year>2009</year>
|
|
<year>2010</year>
|
|
<year>2011</year>
|
|
<year>2012</year>
|
|
<year>2013</year>
|
|
<holder role="mailto:doceng@FreeBSD.org">DocEng</holder>
|
|
</copyright>
|
|
|
|
<pubdate role="rcs">$FreeBSD$</pubdate>
|
|
|
|
<releaseinfo>$FreeBSD$</releaseinfo>
|
|
|
|
&legalnotice;
|
|
|
|
<abstract>
|
|
<para>Thank you for becoming a part of the FreeBSD Documentation
|
|
Project. Your contribution is extremely valuable, and we
|
|
appreciate it.</para>
|
|
|
|
<para>This primer covers details needed
|
|
to start contributing to the FreeBSD Documentation
|
|
Project, or <acronym>FDP</acronym>, including tools, software,
|
|
and the philosophy behind the
|
|
Documentation Project.</para>
|
|
|
|
<para>This is a work in progress. Corrections and
|
|
additions are always welcome.</para>
|
|
</abstract>
|
|
</info>
|
|
|
|
<preface xml:id="preface">
|
|
<title>Preface</title>
|
|
|
|
<sect1 xml:id="preface-prompts">
|
|
<title>Shell Prompts</title>
|
|
|
|
<para>This table shows the default system prompt and
|
|
superuser prompt. The examples use these prompts to
|
|
indicate which type of user is running the example.</para>
|
|
|
|
<informaltable frame="none" pgwide="1">
|
|
<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><systemitem class="username">root</systemitem></entry>
|
|
<entry>&prompt.root;</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</sect1>
|
|
|
|
<sect1 xml:id="preface-conventions">
|
|
<title>Typographic Conventions</title>
|
|
|
|
<para>This table describes the typographic conventions
|
|
used in this book.</para>
|
|
|
|
<informaltable frame="none" pgwide="1">
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>Meaning</entry>
|
|
<entry>Examples</entry>
|
|
</row>
|
|
</thead>
|
|
|
|
<tbody>
|
|
<row>
|
|
<entry>The names of commands.</entry>
|
|
<entry>Use <command>ls -l</command> to list all
|
|
files.</entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>The names of files.</entry>
|
|
<entry>Edit <filename>.login</filename>.</entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>On-screen computer output.</entry>
|
|
<entry><screen>You have mail.</screen></entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>What the user types, contrasted with on-screen
|
|
computer output.</entry>
|
|
|
|
<entry><screen>&prompt.user; <userinput>date +"The time is %H:%M"</userinput>
|
|
The time is 09:18</screen></entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>Manual page references.</entry>
|
|
<entry>Use &man.su.1; to change user identity.</entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>User and group names.</entry>
|
|
<entry>Only <systemitem class="username">root</systemitem> can do
|
|
this.</entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>Emphasis.</entry>
|
|
<entry>The user <emphasis>must</emphasis> do
|
|
this.</entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>Text that the user is expected to replace with
|
|
the actual text.</entry>
|
|
|
|
<entry>To search for a keyword in the manual pages, type
|
|
<command>man -k
|
|
<replaceable>keyword</replaceable></command></entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>Environment variables.</entry>
|
|
<entry><envar>$HOME</envar> is set to the user's home
|
|
directory.</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</sect1>
|
|
|
|
<sect1 xml:id="preface-notes">
|
|
<title>Notes, Tips, Important Information, Warnings, and
|
|
Examples</title>
|
|
|
|
<para>Notes, warnings, and examples appear within the
|
|
text.</para>
|
|
|
|
<note>
|
|
<para>Notes are represented like this, and contain information
|
|
to take note of, as it may affect what the user
|
|
does.</para>
|
|
</note>
|
|
|
|
<tip>
|
|
<para>Tips are represented like this, and contain information
|
|
helpful to the user, like showing an easier way to do
|
|
something.</para>
|
|
</tip>
|
|
|
|
<important>
|
|
<para>Important information is represented like this.
|
|
Typically, these show extra steps the user may need to
|
|
take.</para>
|
|
</important>
|
|
|
|
<warning>
|
|
<para>Warnings are represented like this, and contain
|
|
information warning about possible damage if the
|
|
instructions are not followed. This damage may be physical,
|
|
to the hardware or the user, 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 showing a walkthrough, or
|
|
the results of a particular action.</para>
|
|
</example>
|
|
</sect1>
|
|
|
|
<sect1 xml: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>
|
|
</sect1>
|
|
</preface>
|
|
|
|
&chap.overview;
|
|
&chap.tools;
|
|
&chap.working-copy;
|
|
&chap.structure;
|
|
&chap.doc-build;
|
|
&chap.the-website;
|
|
&chap.xml-primer;
|
|
&chap.xhtml-markup;
|
|
&chap.docbook-markup;
|
|
&chap.stylesheets;
|
|
&chap.translations;
|
|
&chap.writing-style;
|
|
&chap.editor-config;
|
|
&chap.see-also;
|
|
|
|
&app.examples;
|
|
|
|
<index/>
|
|
</book>
|