doc/en/docs.sgml
2001-11-23 15:52:00 +00:00

450 lines
19 KiB
Text

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" [
<!ENTITY date "$FreeBSD: www/en/docs.sgml,v 1.129 2001/11/07 17:55:28 phantom Exp $">
<!ENTITY title "Documentation">
<!ENTITY % includes SYSTEM "includes.sgml"> %includes;
]>
<html>
&header;
<img src="gifs/doc.jpg" alt="" align="right" border="0" width="274" height="163">
<p>A wide variety of documentation is available for FreeBSD, on this web
site, on other web sites, and available over the counter.</p>
<h2>On this site</h2>
<p>All the documentation on this site can be downloaded in a variety of
different formats (HTML, Postscript, PDF, and more) and compression
schemes (GZip, BZip2, Zip) from the <a
href="ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/">FreeBSD FTP site</a>.</p>
<p>This documentation is provided and maintained by the <a
href="docproj/docproj.html">FreeBSD Documentation Project</a>, and we are
always looking for people to contribute new documentation and maintain
existing documentation.</p>
<h3><a name="books">Books</a></h3>
<p><a href="doc/en_US.ISO8859-1/books/faq/index.html">The FreeBSD
FAQ</a><br>
<small>Frequently Asked Questions, and answers, covering all
aspects of FreeBSD.</small></p>
<p><a href="doc/en_US.ISO8859-1/books/handbook/index.html">The FreeBSD
Handbook</a><br>
<small>A constantly evolving, comprehensive resource for FreeBSD
users.</small></p>
<p><a href="doc/en_US.ISO8859-1/books/developers-handbook/index.html">The
FreeBSD Developer's Handbook</a><br>
<small>For people who want to develop software for FreeBSD (and not
just people who are developing FreeBSD itself).</small></p>
<p><a href="doc/en_US.ISO8859-1/books/design-44bsd/index.html">Chapter 2
of "The Design and Implementation of the 4.4BSD Operating
System"</a><br>
<small>Donated by Addison-Wesley, provides a design overview of 4.4BSD,
from which FreeBSD was originally derived.</small></p>
<p><a href="doc/en_US.ISO8859-1/books/corp-net-guide/index.html">Chapter
8 of "The FreeBSD Corporate Networker's Guide"</a><br>
<small>Donated by Addison-Wesley, provides an in-depth look at using
FreeBSD to provide printing services to Windows, NT, and Novell
hosts.</small></p>
<p><a href="doc/en_US.ISO8859-1/books/ppp-primer/index.html">The Pedantic
PPP Primer</a><br>
<small>Everything you need to know about configuring PPP on
FreeBSD.</small></p>
<p><a href="doc/en_US.ISO8859-1/books/porters-handbook/index.html">The Porter's
Handbook</a><br>
<small>Essential reading if you plan on providing a port of a third
party piece of software.</small></p>
<p><a href="doc/en_US.ISO8859-1/books/fdp-primer">The FreeBSD
Documentation Project Primer for New Contributors</a><br>
<small>Everything you need to know in order to start contributing to the
FreeBSD Documentation Project.</small></p>
<h3><a name="articles">Articles</a></h3>
<p><a href="doc/en_US.ISO8859-1/articles/committers-guide/index.html">The
Committer's Guide</a><br>
<small>Introductory information for FreeBSD committers.</small></p>
<p><a
href="doc/en_US.ISO8859-1/articles/console-server/article.html">Console
Server Tutorial</a><br>
<small>How to setup a FreeBSD based console server with a cheap
multi-port serial card.</small></p>
<p><a
href="doc/en_US.ISO8859-1/articles/contributing/index.html">Contributing
to FreeBSD</a><br>
<small>How to contribute to the FreeBSD Project.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/contributors/index.html">The
List of FreeBSD Contributors</a><br>
<small>A list of organizations and individuals who have helped
enhance FreeBSD.</small></p>
<p><a
href="doc/en_US.ISO8859-1/articles/cvsup-advanced/article.html">CVSup
Advanced Points</a><br>
<small>An article with some tips about the subtleties of CVSup.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/dialup-firewall/index.html">Dialup
firewalling with FreeBSD</a><br>
<small>How to set up a firewall using PPP and ipfw over a dialup link
with dynamically assigned IP addresses.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/diskless-x/index.html">Creating
a diskless X server</a><br>
<small>How to create a diskless X server.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/filtering-bridges/index.html">Filtering
Bridges</a><br>
<small>Configuring firewalls and filtering on FreeBSD hosts acting as
bridges rather than routers.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/fonts/index.html">Fonts and
FreeBSD</a><br>
<small>A description of the various font technologies in FreeBSD, and
how to use them with different programs.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/formatting-media/index.html">Formatting
media on FreeBSD</a><br>
<small>How to slice, partition, and format fixed and removable media on
FreeBSD.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/freebsd-questions/index.html">How
to get the best results from the FreeBSD-questions mailing list</a><br>
<small>Tips and tricks to help you maximize the chances of getting
useful information from the -questions mailing list.</small></p>
<p><a
href="doc/en_US.ISO8859-1/articles/laptop/article.html">FreeBSD
on Laptops</a><br>
<small>Information about running FreeBSD on a laptop.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/mh/index.html">An MH
Primer</a><br>
<small>An introduction to using the MH mail reader on
FreeBSD.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/multi-os/index.html">Using
FreeBSD with other operating systems</a><br>
<small>How to install FreeBSD alongside one or more different operating
systems on the same computer.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/new-users/index.html">FreeBSD
First Steps</a><br>
<small>For people coming to FreeBSD and Unix for the first
time.</small></p>
<p><a
href="doc/en_US.ISO8859-1/articles/problem-reports/article.html">Writing
FreeBSD Problem Reports</a><br>
<small>How to best formulate and submit a problem report to the
FreeBSD Project.</small></p>
<p>Programming Tools on FreeBSD<br>
<small>This document has moved into <a
href="doc/en_US.ISO8859-1/books/developers-handbook/index.html">The
Developer's Handbook.</a></small></p>
<p><a href="doc/en_US.ISO8859-1/articles/pxe/index.html">PXE booting
FreeBSD</a><br>
<small>How to create an Intel PXE server using FreeBSD, and how to
configure a FreeBSD client to boot from a PXE server.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/serial-uart/index.html">Serial
and UART devices</a><br>
<small>Detailed information about the use of serial ports on FreeBSD,
including several multi-port serial cards.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/solid-state/index.html">FreeBSD
and Solid State Devices</a><br>
<small>The use of solid state disk devices in FreeBSD.</small></p>
<p><a
href="doc/en_US.ISO8859-1/articles/storage-devices/index.html">Storage Devices</a><br>
<small>Detailed information about using storage devices with FreeBSD,
including ESDI disks, and SCSI disks, tape drives, and CDROM
drives.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/vinum/index.html">Bootstrapping
Vinum: A Foundation for Reliable Servers</a><br>
<small>A gentle introduction to failure-resilient servers and
step-by-step instructions for building one with Vinum.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/vm-design/index.html">Design
elements of the FreeBSD VM system</a><br>
<small>An easy to follow description of the design of the FreeBSD
virtual memory system.</small></p>
<p><a href="doc/en_US.ISO8859-1/articles/zip-drive/index.html">Zip-drives
and FreeBSD</a><br>
<small>How to format, mount, and use an Iomega Zip (SCSI, IDE, or
parallel) Drive on FreeBSD.</small></p>
<h3><a name="man">Manual pages</a></h3>
<dl>
<dt><strong>FreeBSD</strong></dt>
<dd>For release:
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+1.0-RELEASE">1.0</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+1.1-RELEASE">1.1</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+1.1.5.1-RELEASE">1.1.5.1</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+2.0-RELEASE">2.0</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+2.0.5-RELEASE">2.0.5</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+2.1.0-RELEASE">2.1.0</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+2.1.5-RELEASE">2.1.5</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+2.1.6.1-RELEASE">2.1.6.1</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+2.1.7.1-RELEASE">2.1.7.1</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+2.2.1-RELEASE">2.2.1</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+2.2.2-RELEASE">2.2.2</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+2.2.5-RELEASE">2.2.5</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+2.2.6-RELEASE">2.2.6</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+2.2.7-RELEASE">2.2.7</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+2.2.8-RELEASE">2.2.8</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+3.0-RELEASE">3.0</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+3.1-RELEASE">3.1</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+3.2-RELEASE">3.2</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+3.3-RELEASE">3.3</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+3.4-RELEASE">3.4</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+3.5.1-RELEASE">3.5.1</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+4.0-RELEASE">4.0</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+4.1-RELEASE">4.1</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+4.2-RELEASE">4.2</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+4.3-RELEASE">4.3</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+4.4-RELEASE">4.4</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+4.4-stable">4.4-stable</a>,
<a
href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+5.0-current">5.0-current</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=FreeBSD+Ports">Ports</a>.</dd>
<dt><strong>Other Systems</strong></dt>
<dd><a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=v7">Unix Seventh Edition (V7)</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=2.8BSD">2.8BSD</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=2.9BSD">2.9.1BSD</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=2.10BSD">2.10BSD</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=2.11BSD">2.11BSD</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=4.3BSD+Reno">4.3BSD Reno</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=NET%2F2">NET/2</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=386BSD+0.1">386BSD 0.1</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=4.4BSD+Lite2">4.4BSD Lite2</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=linux">Linux</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=NetBSD">NetBSD</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=OpenBSD">OpenBSD</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=darwin">Darwin</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=plan9">Plan 9</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=sunos4">SunOS 4.x</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=sunos5">SunOS 5.x</a>,
<a href="http://www.FreeBSD.org/cgi/man.cgi?manpath=ultrix">ULTRIX 4.2</a>,
and <a
href="http://www.FreeBSD.org/cgi/man.cgi?manpath=XFree86">XFree86</a>.
</dd>
</dl>
<h3><a name="other">Other documentation</a></h3>
<p><a href="http://docs.FreeBSD.org/44doc/">4.4BSD Documents</a>: This is a
hypertext version of the 4.4BSD documents from
<a href="file:/usr/share/doc">/usr/share/doc</a>, where you will find the
documents on a FreeBSD machine (if you install the doc
distribution).</p>
<p><a href="http://docs.FreeBSD.org/info/">Info Documents</a>: This is a
hypertext version of the Info documents from
<a href="file:/usr/share/info">/usr/share/info</a>, where you will find
the Info documents on a FreeBSD machine (if you install the info
distribution).</p>
<h2>On other web sites</h2>
<p>Various independent efforts have also produced a great deal of useful
information about FreeBSD.</p>
<h3>Books</h3>
<ul>
<li>
<p><a href="http://www.vmunix.com/fbsd-book/">A Comprehensive Guide
to FreeBSD</a> - an attempt at a more readable, "book-like"
tutorial explaining the FreeBSD Operating System. Intended for
people new to both FreeBSD and UNIX. Currently a work in
progress.</p>
</li>
</ul>
<h3>Articles</h3>
<ul>
<li>
<p><a href="http://www.computerbits.com/">Computer Bits</a>, an
Internet online magazine, has, since March 1996, been running an
excellent series of FreeBSD related articles in their column titled
<strong>The Network Community</strong>, by
<a href="mailto:tedm@agora.rdrop.com">Ted Mittelstaedt</a>.</p>
<p>These articles cover everything from setting up
<a href="http://www.computerbits.com/archive/9603/lan9603.htm">a
FreeBSD based mail server</a> to doing <a
href="http://www.computerbits.com/archive/9708/lan9708.htm">Network
Address Translation</a> for other hosts.</p>
</li>
</ul>
<ul>
<li>
<p><a href="mailto:mckusick@mckusick.com">Kirk McKusick</a>, one
of the original architects of BSD at U.C. Berkeley, teaches two <a
href="http://www.mckusick.com/courses/">4.4BSD Kernel
Internals</a> courses using FreeBSD. For those unable to attend
the courses in person, a video tape series is also now
available.</p>
</li>
<li>
<p><a href="http://flag.blackened.net/freebsd/">FreeBSD How-To's for
the Lazy and Hopeless</a> is another somewhat more light-hearted
attempt to provide more readable "how-to" style information on
setting up and configuring FreeBSD.</p>
</li>
<li>
<p><a href="http://www.linuxdoc.org/HOWTO/mini/Linux+FreeBSD.html">The
Linux+FreeBSD mini-HOWTO</a> describes how to use
Linux and FreeBSD on the same system. It introduces FreeBSD and
discusses how the two operating systems can cooperate, e.g. by
sharing swap space.</p>
</li>
<li>
<p><a href="http://www.nber.org/amd.html">Getting started with AMD on
FreeBSD</a></p>
</li>
<li>
<p><a href="http://ukug.uk.FreeBSD.org/~mark/ntfs_install_2.2.html">Installing
the FreeBSD 2.2.x NTFS (NT file system) driver</a>.</p>
</li>
<li><p><a href="http://ukug.uk.FreeBSD.org/~mark/ntfs_install_3.1.html">Installing
the FreeBSD 3.1 NTFS driver</a>.</p>
</li>
<li>
<p><em>FreeBSD Installation Details for Newbies</em>. This
document has been imported into <a
href="doc/en_US.ISO8859-1/books/handbook/install.html">The
FreeBSD Handbook</a>.</p>
</li>
<li>
<p><a href="http://www.daemonnews.org/200010/blueprints.html">Dynamic
Kernel Linker (KLD) Facility Programming Tutorial</a>.</p>
</li>
<li>
<p><a href="http://www.daemonnews.org/200007/newbus-intro.html">How to
Write Kernel Drivers with Newbus</a>.</p>
</li>
<li>
<p><em>Writing an ISA device driver</em>. This document has been
imported into <a
href="doc/en_US.ISO8859-1/books/developers-handbook">The
Developers Handbook</a>.</p>
</li>
<li>
<p><em>FreeBSD Assembly Language Programming Tutorial</em>. This
document has been imported into <a
href="doc/en_US.ISO8859-1/books/developers-handbook">The
Developers Handbook</a>.</p>
</li>
<li>
<p><a href="http://www.cfcl.com/rdm/split_DNS.html">Setting up
Split DNS on FreeBSD</a></p>
</li>
</ul>
<h3>Links</h3>
<ul>
<li>
<p>The
<a href="http://dmoz.org/Computers/Operating_Systems/Unix/FreeBSD/">Open
Directory Project</a> offers an excellent selection of links for
FreeBSD, including a list of
<a href="http://dmoz.org/Computers/Operating_Systems/Unix/FreeBSD/Prominent_Users/">prominent
users</a> which can be helpful for marketing purposes.</p></li>
</ul>
<h2>In the real world...</h2>
<h3><a href="news/press.html">FreeBSD in the Press</a></h3>
<p>Articles in the press about FreeBSD.</p>
<h2>Additional resources</h2>
<h3><a href="y2kbug.html">Year 2000 Compatibility</a></h3>
<p>The FreeBSD project's current statement about its Year 2000
compatibility.</p>
<h3><a href="http://www.daemonnews.org/newsletter/">BSD Real-Quick (TM) Newsletter</a></h3>
<p>A monthly (sometimes bi-weekly) newsletter announcing recent
developments in the FreeBSD arena. Subscribe to freebsd-announce to
receive this newsletter via e-mail.</p>
<h3><a href="http://minnie.tuhs.org/FreeBSD-srctree/FreeBSD.html">The
Source Code</a></h3>
<p>If you like digging your fingers into source code, here is a hypertext
version of the FreeBSD <em>kernel</em> source. This is brought to you
courtesy of <a href="http://minnie.tuhs.org/warren.html">Warren
Toomey</a>.</p>
<h3><a href="http://www.daemonnews.org/">Daemon News</a></h3>
<p>The industry leader in BSD news.</p>
<h3><a href="http://www.freebsdzine.org/">The FreeBSD 'zine</a></h3>
<p>A monthly collection of easy to read (we hope)
articles written by FreeBSD users and administrators just like you.</p>
<p>Like FreeBSD itself, this documentation is the product of a volunteer
effort. The goals of the project are outlined here, as are the
procedures for submitting corrections and new material.</p>
<h3><a name="diary" href="http://www.freebsddiary.org/">The FreeBSD
Diary</a></h3>
<p>The FreeBSD Diary is a collection of how-to entries aimed at UNIX
novices. The aim is to provide a set of step-by-step guides to
installing and configuring various ports.</p>
&footer;
</body>
</html>
<!--
Local Variables:
mode: sgml
sgml-indent-data: t
sgml-omittag: nil
sgml-always-quote-attributes: t
End:
-->