aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO8859-1/books/fdp-primer/book.sgml
blob: 3e6ac5ac8f562fbfde73f7329fde1a27be82b9ea (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
270
271
272
273
274
275
276
277
278
279
280
<!-- 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.4 1999-07-14 19:11:09 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 19:11:09 $</pubdate>

    <releaseinfo>$Id: book.sgml,v 1.4 1999-07-14 19:11:09 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.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:
-->