os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Pull all the docs into one place, and simplify/rearrange the list of

Browse source 
available documentation.  There's a hell of a lot more work needs doing
on the website. . .
This commit is contained in:
Nik Clayton 2001-02-22 15:44:37 +00:00
parent 8162e20a6a
commit 9c5c8d0337
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/www/; revision=8824
2 changed files with 239 additions and 176 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

401
en/docs.sgml
View file

@ -1,165 +1,114 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN" [
<!ENTITY date "$FreeBSD: www/en/docs.sgml,v 1.90 2001/02/07 11:06:32 obrien Exp $">
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" [
<!ENTITY date "$FreeBSD: www/en/docs.sgml,v 1.91 2001/02/07 11:09:32 obrien Exp $">
<!ENTITY title "Documentation">
<!ENTITY % includes SYSTEM "includes.sgml"> %includes;
]>
<!-- $FreeBSD: www/en/docs.sgml,v 1.90 2001/02/07 11:06:32 obrien Exp $ -->
<!-- $FreeBSD: www/en/docs.sgml,v 1.91 2001/02/07 11:09:32 obrien Exp $ -->
<html>
&header;
<img src="gifs/doc.jpg" align="right" border="0" width="274" height="163">
<ul>
<li><a href="#press">FreeBSD in the Press</a></li>
<li><a href="#y2kbug">Year 2000 Compatibility</a></li>
<li><a href="#qnewsletter">FreeBSD Quick Newsletter</a></li>
<li><a href="#handbook">The FreeBSD Handbook</a></li>
<li><a href="#porthandbook">The FreeBSD Porter's Handbook</a></li>
<li><a href="#faq">Frequently Asked Questions (FAQ)</a></li>
<li><a href="#tutorial">Tutorials</a></li>
<li><a href="#addresources">Additional Resources</a></li>
<li><a href="#books">Books</a></li>
<li><a href="#man">Manual Pages</a></li>
<li><a href="#44doc">4.4BSD Documents</a></li>
<li><a href="#info">Info Documents</a></li>
<li><a href="#source">The Source Code</a></li>
<li><a href="#doc">The FreeBSD Documentation Project</a></li>
<li><a href="#diary">The FreeBSD Diary</a></li>
</ul>
<a name="press"></a>
<h2><a href="news/press.html">FreeBSD in the Press</a></h2>
<p>Articles in the press about FreeBSD.</p>
<img src="gifs/doc.jpg" alt="" align="right" border="0" width="274" height="163">
<a name="y2kbug"></a>
<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><a href="y2kbug.html">Year 2000 Compatibility</a></h2>
<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>Books</h3>
<p><a href="docs/en/books/faq/index.html">The FreeBSD FAQ</a><br>
<small>Frequently Asked Questions, and answers, covering all
aspects of FreeBSD.</small></p>
<p>The FreeBSD project's current statement about its Year 2000
compatibility.</p>
<a name="qnewsletter"></a>
<p><a href="docs/en/books/handbook/index.html">The FreeBSD Handbook</a><br>
<small>A constantly evolving, comprehensive resource for FreeBSD
users.</small></p>
<h2><a href="news/qnewsletter.html">FreeBSD Real-Quick (TM) Newsletter
(RQN)</a></h2>
<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>
<p><a href="docs/en/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>
<a name="handbook"></a>
<p><a href="docs/en/books/ppp-primer/index.html">The Pedantic PPP
Primer</a><br>
<small>Everything you need to know about configuring PPP on
FreeBSD.</small></p>
<h2><a href="handbook/index.html">The FreeBSD Handbook</a></h2>
<p>An evolving, comprehensive on-line resource for FreeBSD users.
Please address comments and contributions to <a
href="mailto:freebsd-doc@FreeBSD.org"><tt>&lt;freebsd-doc@FreeBSD.org&gt;</tt></a>.</p>
<p>A <a href="&base/ja/handbook/">Japanese translation</a> of the handbook
(EUC encoding) is also available.</p>
<p><a href="docs/en/books/porters-handbook">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>
<a name="porthandbook"></a>
<p><a href="docs/en/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>
<h2><a href="porters-handbook/index.html">The FreeBSD Porter's Handbook</a></h2>
<p>An evolving, comprehensive on-line resource for users interested
in creating and submitting a port for the Ports Collection. It
also provides some useful information for Ports committers.
Please address comments and contributions to <a
href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>.</p>
<h3>Articles</h3>
<a name="faq"></a>
<p><a href="docs/en/articles/committers-guide/index.html">The Committer's
Guide</a><br>
<small>Introductory information for FreeBSD committers.</small></p>
<h2><a href="FAQ/FAQ.html">Frequently Asked Questions (FAQ)</a></h2>
<p>If you have a question, chances are that someone else has had it too.
The most common of these questions (and answers) have been compiled here.</p>
<p><a href="docs/en/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>&i.new; We now offer a <a href="&base/ru/FAQ/">Russian translation</a>
and a <a href="&base/zh/FAQ/">Chinese translation</a> of the FAQ.</p>
<p><a href="docs/en/articles/diskless-x/index.html">Creating a diskless X
server</a><br>
<small>How to create a diskless X server.</small></p>
<p>A <a href="&base/ja/FAQ/">Japanese translation</a> of
the FAQ (EUC encoding) is also available.</p>
<a name="tutorial"></a>
<p><a href="docs/en/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>
<h2><a href="tutorials/">Tutorials</a></h2>
<p>Assorted documents about various aspects of FreeBSD, FreeBSD
software, and hardware. If you have comments or would like to
contribute a document, please contact us at <a
href="mailto:freebsd-doc@FreeBSD.org">freebsd-doc@FreeBSD.org</a>.</p>
<p><a href="docs/en/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>
<a name="addresources"></a>
<p><a href="docs/en/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 maximise the chances of getting
useful information from the -questions mailing list.</small></p>
<h2>Additional Resources</h2>
<p>www.FreeBSD.org is not the only place to get information on FreeBSD;
various independent efforts have also produced a great deal of useful
information about FreeBSD.</p>
<p><a href="docs/en/articles/mh/index.html">An MH Primer</a><br>
<small>An introduction to using the MH mail reader on
FreeBSD.</small></p>
<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>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>
<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>.<br>
<p><a href="docs/en/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>
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>
<p><a href="docs/en/articles/new-users/index.html">FreeBSD First
Steps</a><br>
<small>For people coming to FreeBSD and Unix for the first
time.</small></p>
<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>
<p><a href="docs/en/articles/programming-tools/index.html">Programming
Tools on FreeBSD</a><br>
<small>A user's guide to the various tools for software development on
FreeBSD.</small></p>
<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>
<p><a href="docs/en/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>
<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>
</ul>
<a name="books"></a>
<h3>Manual pages</h3>
<h2><a href="handbook/bibliography.html">Books</a></h2>
<p>Online documentation is useful, but any serious FreeBSD user should
consider getting some of the books listed here. Most books that cover
BSD systems apply well to FreeBSD.</p>
<a name="man"></a>
<h2><a href="http://www.FreeBSD.org/cgi/man.cgi">Manual Pages</a></h2>
<dl>
<dt><strong>FreeBSD</strong></dt>
@ -214,60 +163,160 @@
href="http://www.FreeBSD.org/cgi/man.cgi?manpath=XFree86">XFree86</a>.
</dd>
</dl>
<!--
<form action="http://www.FreeBSD.org/cgi/man.cgi" method="GET">
Manual Page Search for:
<input type="hidden" name="proto" value="1.0">
<input type="hidden" name="apropos" value="0">
<input name="query" value="">
<input type="submit" value="Submit">
</form>
-->
<p>This service is provided courtesy of <a
href="http://wolfram.schneider.org/">Wolfram Schneider</a>.</p>
<a name="44doc"></a>
<h2><a href="http://www.FreeBSD.org/doc/"> 4.4BSD Documents</a></h2>
<h3>Other documentation</h3>
<p>If you like to read BSD manuals online, here 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>
<a name="info"></a>
<h2><a href="http://www.FreeBSD.org/info/">Info Documents</a></h2>
<p>If you like to read FreeBSD Info documents online, here 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
<p><a href="http://www.FreeBSD.org/doc/">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>
<a name="source"></a>
<p><a href="http://www.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>
<h2><a href="http://minnie.cs.adfa.oz.au/FreeBSD-srctree/FreeBSD.html">The
Source Code</a></h2>
<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://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><a href="http://people.FreeBSD.org/~rpratt/">FreeBSD Installation
Details for Newbies</a>.</p>
<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><a href="http://www.daemonnews.org/200008/isa.html">Writing
an ISA device driver</a>.</p>
</li>
<li>
<p><a href=" http://www.int80h.org/bsdasm/">FreeBSD Assembly
Language Programming Tutorial</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="news/qnewsletter.html">FreeBSD Real-Quick (TM) Newsletter
(RQN)</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.cs.adfa.oz.au/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.cs.adfa.oz.au/warren.html">Warren
Toomey</a>.</p>
<a name="doc"></a>
<h2><a href="docproj/docproj.html">The FreeBSD Documentation
Project</a></h2>
<h2><a href="http://www.daemonnews.org/">Daemon News</a></h2>
<h3><a href="http://www.daemonnews.org/">Daemon News</a></h3>
<p>The industry leader in BSD news.</p>
<h2><a href="http://www.freebsdzine.org/">The FreeBSD 'zine</a></h2>
<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>
@ -276,8 +325,8 @@
effort. The goals of the project are outlined here, as are the
procedures for submitting corrections and new material.</p>
<h2><a name="diary" href="http://www.freebsddiary.org/">The FreeBSD
Diary</a></h2>
<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

14
en/docs/Makefile Normal file
View file

@ -0,0 +1,14 @@
#
# $FreeBSD$i
#
# Build the FreeBSD documentation *outside* of the www tree, and install it
# in to the right place as necessary.
#
# This assumes that you have the www/ and doc/ trees checked out beside
# one another -- this was always the case anyway, so there are no extra
# requirements here.
#
all install clean:
echo foo
(cd ../../../doc/en_US.ISO_8859-1 && unset DESTDIR && ${MAKE} FORMATS=html-split DOCDIR=${DESTDIR}/data/docs ${.TARGET})