d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Information updates, typo patrol, rewrites.

Browse Source
This commit is contained in:
Jordan K. Hubbard 1995-12-11 15:09:13 +00:00
parent 04936d2e08
commit 6db0bfd820
7 changed files with 110 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
share/doc/handbook/basics.sgml
View File

@ -1,4 +1,4 @@
<!-- $Id: basics.sgml,v 1.3 1995/06/30 17:37:29 jfieber Exp $ -->
<!-- $Id: basics.sgml,v 1.4 1995/10/22 00:41:53 jfieber Exp $ -->
<!-- The FreeBSD Documentation Project -->
<chapt><heading>Unix Basics<label id="basics"></heading>
@ -9,7 +9,7 @@
<p>The most comprehensive documentation on FreeBSD is in
the form of <em>man pages</em>. Nearly every program
on the system comes with a short reference manual
explaining the basic operation and various argument.
explaining the basic operation and various arguments.
These manuals can be view with the
<tt><bf>man</bf></tt> command. Use of the
<tt><bf>man</bf></tt> command is simple:
@ -40,20 +40,20 @@
is a <tt><bf>chmod</bf></tt> user command and a
<tt><bf>chmod()</bf></tt> system call. In this case,
you can tell the <tt><bf>man</bf></tt> command which
you want by specifying the section:
one you want by specifying the section:
<tscreen>
% <bf>man 1 chmod</bf>
</tscreen>
which will display the manual page for the user command
<tt><bf>chmod</bf></tt>. References to a particular
section of the on-line manual are traditionally placed
in paranthesis in written documentation; so
in parenthesis in written documentation, so
<tt><bf>chmod(1)</bf></tt> refers to the <tt><bf>chmod
</bf></tt> user command, while <tt><bf>chmod(2)</bf></tt>
means the system call.
</bf></tt> user command and <tt><bf>chmod(2)</bf></tt>
refers to the system call.
<p>This is fine if you know the name of the command and
forgot how to use it, but what if you cannot recall the
simply wish to know how to use it, but what if you cannot recall the
command name? You can use <tt><bf>man</bf></tt> to
search for keywords in the command <em>descriptions</em> by
using the <tt><bf>-k</bf></tt> switch:
@ -62,13 +62,12 @@
</tscreen>
With this command you will be presented with a list of
commands that have the keyword `mail' in their
descriptions. This is the same as the separate command
<tt><bf>apropos</bf></tt>.
descriptions. This is actually functionally equivalent to
using the <tt><bf>apropos</bf></tt> command.
<p>You are seeing all those fancy commands in <tt>
/usr/bin</tt>, but don't even have the silliest idea
what most of the names do actually stand for? Simply
do a
<p>So, you are looking at all those fancy commands in <tt>
/usr/bin</tt> but don't even have the faintest idea
what most of them actually do? Simply do a
<tscreen>
% <bf>cd /usr/bin; man -f *</bf>
</tscreen>
@ -76,7 +75,7 @@
<tscreen>
% <bf>cd /usr/bin; whatis *</bf>
</tscreen>
which is the same.
which does the same thing.
<sect>
<heading>GNU Info files<label id="basics:info"></heading>
@ -90,8 +89,8 @@
mode of <tt>emacs</tt>.
To use the <tt>info(1)</tt> command, simply type:
<tscreen>% <bf>info</bf></tscreen> For a brief
introduction, type <tt><bf>h</bf></tt>, and for a quick
<tscreen>% <bf>info</bf></tscreen>. For a brief
introduction, type <tt><bf>h</bf></tt>. For a quick
command reference, type <tt><bf>?</bf></tt>.

6
share/doc/handbook/bibliography.sgml
View File

@ -1,4 +1,4 @@
<!-- $Id: bibliography.sgml,v 1.3 1995/06/30 18:41:08 jfieber Exp $ -->
<!-- $Id: bibliography.sgml,v 1.4 1995/09/27 00:46:14 jmz Exp $ -->
<!-- The FreeBSD Documentation Project -->
<chapt>
@ -9,8 +9,8 @@
they are notorious for not illustrating how to put the
pieces together to make the whole operating system run
smoothly. For this, there is no substitute for a good
book on Unix system administration, and a good users'
manual.
book on Unix system administration and a good users'
manual.
<sect>
<heading>Users' guides</heading>

4
share/doc/handbook/boothelp.sgml
View File

@ -1,4 +1,4 @@
<!-- $Id$ -->
<!-- $Id: boothelp.sgml,v 1.1 1995/09/03 21:12:24 jfieber Exp $ -->
<!-- The FreeBSD Documentation Project -->
<!DOCTYPE linuxdoc PUBLIC "-//FreeBSD//DTD linuxdoc//EN" [
@ -28,7 +28,7 @@
<abstract>Welcome to FreeBSD! This guide describes the
FreeBSD installation process. To navigate through the
sections in this guide using the <bf>up</bf> and
<bf>down</bf> arrow keys to select a section you wish to
<bf>down</bf> arrow keys to select the section you wish to
read. Then use the <bf>right arrow</bf> or the <bf>enter
key</bf> to view the section. You can backtrack through
sections you have read by using the <bf>left arrow</bf>.

6
share/doc/handbook/contrib.sgml
View File

@ -1,4 +1,4 @@
<!-- $Id: contrib.sgml,v 1.38 1995/11/26 13:44:48 asami Exp $ -->
<!-- $Id: contrib.sgml,v 1.39 1995/12/05 00:55:45 asami Exp $ -->
<!-- The FreeBSD Documentation Project -->
<chapt><heading>FreeBSD contributor list<label id="contrib"></heading>
@ -312,7 +312,3 @@
<item>Wolfgang Stanglmeier &lt;wolf@dentaro.GUN.de&gt;
<item>Yuval Yarom &lt;yval@cs.huji.ac.il&gt;
</itemize>
Last, but not least, the release engineer would like to
thank: His Wife, for chocolate chip cookies, and some other
things. The DGB project @ TFS, for patience and tolerance.

91
share/doc/handbook/current.sgml
View File

@ -1,4 +1,4 @@
<!-- $Id: current.sgml,v 1.5 1995/09/27 00:46:16 jmz Exp $ -->
<!-- $Id: current.sgml,v 1.6 1995/10/16 09:01:52 jkh Exp $ -->
<!-- The FreeBSD Documentation Project -->
@ -10,41 +10,43 @@
THE FREEBSD CURRENT POLICY
Last updated: $Date: 1995/09/27 00:46:16 $
Last updated: $Date: 1995/10/16 09:01:52 $
This document attempts to explain the rationale behind FreeBSD-current,
what you should expect should you decide to run it, and states some
prerequisites for making sure the process goes as smoothly as possible.
This document attempts to explain the rationale behind
FreeBSD-current, what you should expect should you decide to run it,
and states some prerequisites for making sure the process goes as
smoothly as possible.
-->
<sect><heading>What is FreeBSD-current?</heading>
<p>FreeBSD-current is, quite literally, nothing more than a daily snapshot of
the working sources for FreeBSD. These include work in progress, experimental
changes, and transitional mechanisms that may or may not be present in
the next official release of the software. While many of us compile
almost daily from FreeBSD-current sources, there are periods of time when
the sources are literally uncompilable. These problems are generally resolved
as expeditiously as possible, but whether or not FreeBSD-current sources bring
disaster or greatly desired functionality can literally be a matter of which
part of any given 24 hour period you grabbed them in!
<p>FreeBSD-current is, quite literally, nothing more than a daily
snapshot of the working sources for FreeBSD. These include work in
progress, experimental changes and transitional mechanisms that may or
may not be present in the next official release of the software.
While many of us compile almost daily from FreeBSD-current sources,
there are periods of time when the sources are literally uncompilable.
These problems are generally resolved as expeditiously as possible,
but whether or not FreeBSD-current sources bring disaster or greatly
desired functionality can literally be a matter of which part of any
given 24 hour period you grabbed them in!
Under certain circumstances we will sometimes make binaries for parts of
FreeBSD-current available, but only because we're interested in getting
something tested, not because we're in the business of providing binary
releases of current. If we don't offer, please don't ask! It takes far
too much time to do this as a general task.
Under certain circumstances we will sometimes make binaries for parts
of FreeBSD-current available, but only because we're interested in
getting something tested, not because we're in the business of
providing binary releases of current. If we don't offer, please don't
ask! It takes far too much time to do this as a general task.
<sect><heading>Who needs FreeBSD-current?</heading>
<p>FreeBSD-current is made generally available for 3 primary interest groups:
<enum>
<item> Members of the FreeBSD group who are actively working on one
part or another of the source tree and for whom keeping `current'
is an absolute requirement.
<item> Members of the FreeBSD group who are actively working on some
part of the source tree and for whom keeping `current' is an
absolute requirement.
<item> Members of the FreeBSD group who are active ALPHA or BETA testers
and willing to spend time working through problems in order to
<item> Members of the FreeBSD group who are active testers,
willing to spend time working through problems in order to
ensure that FreeBSD-current remains as sane as possible. These
are also people who wish to make topical suggestions on changes
and the general direction of FreeBSD.
@ -58,8 +60,8 @@ too much time to do this as a general task.
<sect><heading>What is FreeBSD-current <em>NOT</em>?</heading>
<p><enum>
<item> A fast-track to getting pre-release bits because there's something
you heard was pretty cool in there and you want to be the first on
<item> A fast-track to getting pre-release bits because you heard there's
some cool new feature in there and you want to be the first on
your block to have it.
<item> A quick way of getting bug fixes.
@ -73,9 +75,9 @@ too much time to do this as a general task.
experimental system software. This is not because we're mean and
nasty people who don't like helping people out (we wouldn't even be
doing FreeBSD if we were), it's literally because we can't answer
400 messages a day <em>and</em> actually work on FreeBSD! I'm sure if
given the choice between having us answer lots of questions or
continue to improve FreeBSD, most of you would vote for us
400 messages a day <em>and</em> actually work on FreeBSD! I'm sure
that, if given the choice between having us answer lots of questions or
continuing to improve FreeBSD, most of you would vote for us
improving it.
</enum>
@ -84,8 +86,8 @@ too much time to do this as a general task.
<p><enum> <item> Join the freebsd-current and cvs-all
mailing lists. This is not just a good idea, it's
<em>essential</em>. If you aren't on freebsd-current, you
won't read the comments that people are making about the
current state of the system and thus will end up stumbling
won't see the comments that people are making about the
current state of the system and thus will probably end up stumbling
over a lot of problems that others have already found and
solved. Even more importantly, you will miss out on
potentially critical information (e.g. ``Yo, Everybody!
@ -93,9 +95,8 @@ too much time to do this as a general task.
rebuild the kernel or your system will crash horribly!").
The cvs-all mailing list will allow you to see the commit log
entry for each change as it's made. This can also contain
important information, and will let you know what parts of
the system are being actively changed.
entry for each change as it's made along with any pertinent
information on possible side-effects.
To join these lists, send mail to `majordomo@FreeBSD.ORG'
and say:
@ -148,28 +149,18 @@ too much time to do this as a general task.
<item> If you're grabbing the sources to run, and not just look at,
then grab <em>all</em> of current, not just selected portions. The
reason for this is that various parts of the source depend on
updates elsewhere and trying to compile just a subset is almost
updates elsewhere, and trying to compile just a subset is almost
guaranteed to get you into trouble.
<item> Before compiling current, read the Makefile in /usr/src
carefully. You'll see one-time targets like `bootstrapld'
which <em><bf>must</bf></em> be run as part of the upgrading process. Reading
freebsd-hackers will keep you up-to-date on other bootstrapping
procedures that sometimes become necessary as we move towards
the next release.
carefully. You should at least run a `make world' the first time
through as part of the upgrading process.
Reading freebsd-hackers will keep you up-to-date on other
bootstrapping procedures that sometimes become necessary as we move
towards the next release.
<item> Be active! If you're running FreeBSD-current, we want to know
what you have to say about it, especially if you have suggestions
for enhancements or bug fixes. Suggestions with accompanying code
are received most enthusiastically!
</enum>
<!--
Thank you for taking the time to read this all the way through. We're
always very keen to remain "open" and share the fruits of our labor
with the widest possible audience, but sharing development sources has
always had certain pitfalls associated with it (which is why most
commercial organizations won't even consider it) and I want to make
sure that people at least come into this with their eyes open, and
don't make the leap unless they're good at working without a net!
-->

87
share/doc/handbook/eresources.sgml
View File

@ -1,80 +1,80 @@
<!-- $Id: eresources.sgml,v 1.15 1995/11/20 01:10:16 jfieber Exp $ -->
<!-- $Id: eresources.sgml,v 1.16 1995/11/24 07:55:25 jkh Exp $ -->
<!-- The FreeBSD Documentation Project -->
<chapt>
<heading>Resources on the Internet<label id="eresources"></heading>
<p><em>Contributed by &a.jkh;.</em>
<p>The rapid pace of FreeBSD progress makes print media
impractical as a means for following the latest
developments. Electronic resources are the best, if not the
only way stay informed of the latest advances. Also, since
FreeBSD is a volunteer effort, the user community also serves
as the technical support department and invariably,
electronic mail and Usenet news are the most effective way of
getting technical problems resolved.
developments. Electronic resources are the best, if not often the
only way stay informed of the latest advances. Since
FreeBSD is a volunteer effort, the user community itself also generally
serves as a `technical support department' of sorts, with electronic mail
and Usenet news being the most effective way of reaching that community.
Below, the most important points of contact with the FreeBSD
user community are outlined. If you are aware of other
resources not included, please send them to
<tt>doc@freebsd.org</tt> so they may be included.
The most important points of contact with the FreeBSD
user community are outlined below. If you are aware of other
resources not mentioned here, please send them to
<tt>doc@freebsd.org</tt> so that they may also be included.
<sect>
<heading>Mailing lists<label id="eresources:mail"></heading>
<p>Though many of the FreeBSD development members read USENET, we cannot
always guarantee that we'll get to your questions in a timely fashion
(or at all) if you post them only to one of the comp.unix.bsd.*
(or at all) if you post them only to one of the comp.unix.bsd.freebsd.*
groups. By addressing your questions to the appropriate mailing list
you will reach both us and a concentrated FreeBSD audience, invariably
assuring a better (or at least faster) response.
There are list charters at the bottom of this document. Please read
the list charter before joining a list. We must strive to
keep the signal to noise ratio of the lists high, especially in
the technical lists.
<p>The charters for the various lists are given at the bottom of this
document. Please read the charter before joining a list since we must
strive to keep the signal to noise ratio of the lists high, especially
in the technical ones.
Archives are kept for all of the mailing lists and can be searched
using the the <url url="http://www.freebsd.org/search.html"
name="FreeBSD World Wide Web server">. The keyword searchable archive
offers an excellent way to find answers to frequently asked questions
and should be consulted before posting a question.
offers an excellent way of finding answers to frequently asked
questions and should be consulted before posting a question.
<sect1><heading>List summary</heading>
<p><bf>General lists:</bf> The following are general lists that
<p><bf>General lists:</bf> The following are general lists which
anyone is free to join:
<verb>
List Purpose
----------------------------------------------------------------------
freebsd-announce Important events / milestones
freebsd-announce Important events and project milestones
freebsd-bugs Bug reports
freebsd-chat Non technical items related to the community
freebsd-current Discussions about the use of FreeBSD-current
freebsd-chat Non-technical items related to the FreeBSD community
freebsd-current Discussion concerning the use of FreeBSD-current
freebsd-isp Issues for Internet Service Providers using FreeBSD
freebsd-policy Policy issues and suggestions
freebsd-policy General policy issues and suggestions
freebsd-questions User questions
</verb>
<bf>Technical lists:</bf> The following are the technical lists. You should
read the charter carefully before joining them, and you should keep
your e-mail within the scope of the guidelines.
<bf>Technical lists:</bf> The following lists are for technical discussion.
You should read the charter carefully before joining one, keeping any
messages sent to a list within the scope of the guidelines.
<verb>
List Purpose
----------------------------------------------------------------------
freebsd-doc The FreeBSD Documentation project
freebsd-fs Filesystems
freebsd-hackers General Technical discussions
freebsd-hardware General discussion of FreeBSD hardware
freebsd-multimedia Multimedia discussions
freebsd-platforms Porting to Non-Intel platforms
freebsd-ports Discussion of "ports"
freebsd-hackers General technical discussion
freebsd-hardware General discussion of hardware for running FreeBSD
freebsd-multimedia Multimedia discussion
freebsd-platforms Concerning ports to non-Intel architecture platforms
freebsd-ports Discussion of the ports collection
freebsd-security Security issues
freebsd-scsi SCSI subsystem
freebsd-scsi The SCSI subsystem
</verb>
<bf>Limited lists:</bf> The following are limited lists that you will need
approval to join. Even though access to these lists is controled,
anyone is free to send suggestions and comments to them. It is a
<bf>Limited lists:</bf> The following lists require approval to join,
though anyone is free to send suggestions and comments to them. It is a
good idea establish a presence in the technical lists before asking
to join one of these limited lists.
<verb>
@ -87,8 +87,8 @@ freebsd-install Installation development
freebsd-user-groups User group coordination
</verb>
<bf>CVS lists:</bf> The following lists are for people seeing the log messages
for source changes in specific areas:
<bf>CVS lists:</bf> The following lists are for people interested in
seeing the log messages for changes to various areas of the source tree.
<verb>
List name Source area Area Description (source for)
----------------------------------------------------------------------
@ -113,9 +113,8 @@ cvs-usrsbin /usr/src/usr.sbin System binaries
<sect1><heading>How to subscribe</heading>
<p>All mailing lists live on <tt>FreeBSD.ORG</tt>, so to post to a
list you simply mail to <em>listname</em><tt>@FreeBSD.ORG</tt>. It
will then be redistributed to mailing list members throughout the
world.
given list you simply mail to <em>listname</em><tt>@FreeBSD.ORG</tt>. It
will then be redistributed to mailing list members world-wide.
To subscribe to a list, send mail to:
<tscreen><verb>
@ -150,10 +149,10 @@ list of available commands, do this:
help
^D
</verb></tscreen>
Finally, we again request that you keep the technical mailing lists on
a technical track. If you're only interested in the "high points",
then it's suggested that you join freebsd-announce, which will contain
only infrequent traffic.
Again, we'd like to request that you keep discussion in the technical mailing
lists on a technical track. If you're only interested in the "high points"
then it's suggested that you join freebsd-announce, which is intended only
for infrequent traffic.
<sect1><heading>List charters</heading>

9
share/doc/handbook/hw.sgml
View File

@ -1,4 +1,4 @@
<!-- $Id: hw.sgml,v 1.9 1995/11/25 20:00:48 jkh Exp $ -->
<!-- $Id: hw.sgml,v 1.10 1995/12/03 00:17:57 jkh Exp $ -->
<!-- The FreeBSD Documentation Project -->
<!--
@ -143,9 +143,10 @@ Slippery when wet. Beware of dog.
<p><em>Contributed by &a.rgrimes;.<newline>25 April 1995.</em></p>
<p>Of the Intel PCI chip sets the following is a list
of brokenness from worst to best and a short
description of brokenness.</p>
<p>Of the Intel PCI chip sets, the following list describes
various types of known-brokenness and the degree of
breakage, listed from worst to best.
</p>
<p><descrip>