aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO8859-1/books/fdp-primer/book.xml
blob: 5793e35839cbc65cef1dc48dc7b3f928fa37954a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook XML V4.5-Based Extension//EN"
	"../../../share/xml/freebsd45.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 lang='en'>
  <bookinfo>
    <title>FreeBSD Documentation Project Primer for New
      Contributors</title>

    <corpauthor>The FreeBSD Documentation Project</corpauthor>

    <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>
  </bookinfo>

  <preface id="preface">
    <title>Preface</title>

    <sect1 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><username>root</username></entry>
	      <entry>&prompt.root;</entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </sect1>

    <sect1 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 <username>root</username> 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 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 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>