diff --git a/en/docs.sgml b/en/docs.sgml index b143bdf21bf1..43ef07f9f1f4 100644 --- a/en/docs.sgml +++ b/en/docs.sgml @@ -1,621 +1,626 @@ + %includes; ]> &header;

A wide variety of documentation is available for FreeBSD, on this web site, on other web sites, and available over the counter.

On this site

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 FreeBSD FTP site.

This documentation is provided and maintained by the FreeBSD Documentation Project, and we are always looking for people to contribute new documentation and maintain existing documentation.


The FreeBSD FAQ (faq)
Frequently Asked Questions, and answers, covering all aspects of FreeBSD.

The FreeBSD Handbook (handbook)
A constantly evolving, comprehensive resource for FreeBSD users.

The FreeBSD Developer's Handbook (developers-handbook)
For people who want to develop software for FreeBSD (and not just people who are developing FreeBSD itself).

The FreeBSD Architecture Handbook (arch-handbook)
For FreeBSD system developers. This book covers the architectural details of many important FreeBSD kernel subsystems.

The Porter's Handbook (porters-handbook)
Essential reading if you plan on providing a port of a third party piece of software.

Chapter 2 of "The Design and Implementation of the 4.4BSD Operating System" (design-44bsd)
Donated by Addison-Wesley, provides a design overview of 4.4BSD, from which FreeBSD was originally derived.

Chapter 8 of "The FreeBSD Corporate Networker's Guide" (corp-net-guide)
Donated by Addison-Wesley, provides an in-depth look at using FreeBSD to provide printing services to Windows, NT, and Novell hosts.

The FreeBSD Documentation Project Primer for New Contributors (fdp-primer)
Everything you need to know in order to start contributing to the FreeBSD Documentation Project.


The Roadmap for 5-STABLE (5-roadmap)
Describes medium-term development and release engineering plans leading to the 5-STABLE branch point.

Integration of Checkpoint VPN-1/Firewall-1 and FreeBSD IPsec (checkpoint)
How to configure Checkpoint VPN-1/Firewall-1 and FreeBSD IPsec.

The Committer's Guide (committers-guide)
Introductory information for FreeBSD committers.

Console Server Tutorial (console-server)
How to setup a FreeBSD based console server with a cheap multi-port serial card.

Contributing to FreeBSD (contributing)
How to contribute to the FreeBSD Project.

The List of FreeBSD Contributors (contributors)
A list of organizations and individuals who have helped enhance FreeBSD.

Setting up a CVS repository - The FreeBSD way (cvs-freebsd)
How to set up a CVS repository that uses the same CVSROOT infrastructure as the FreeBSD project.

CVSup Advanced Points (cvsup-advanced)
An article with some tips about the subtleties of CVSup.

Dialup firewalling with FreeBSD (dialup-firewall)
How to set up a firewall using PPP and ipfw over a dialup link with dynamically assigned IP addresses.

Creating a diskless X server (diskless-x)
How to create a diskless X server.

The Euro symbol on FreeBSD (euro)
How to configure FreeBSD and related applications to display the new Euro symbol.

Explaining BSD (explaining-bsd)
An answer to the question ``What is BSD?''

FreeBSD From Scratch (fbsd-from-scratch)
How to automatically compile, install and configure a system from scratch (i.e. to an empty file system), including your favorite ports.

Filtering Bridges (filtering-bridges)
Configuring firewalls and filtering on FreeBSD hosts acting as bridges rather than routers.

Fonts and FreeBSD (fonts)
A description of the various font technologies in FreeBSD, and how to use them with different programs.

Formatting media on FreeBSD (formatting-media)
How to slice, partition, and format fixed and removable media on FreeBSD.

How to get the best results from the FreeBSD-questions mailing list (freebsd-questions)
Tips and tricks to help you maximize the chances of getting useful information from the -questions mailing list.

Working with Hats (hats)
A committer's guide to working with ``hats'' (other committers with authority over specific areas of FreeBSD).

Mirroring FreeBSD (hubs)
The all in one guide for mirroring the FreeBSD website, CVSup servers, FTP servers, and more.

Independent Verification of IPsec Functionality in FreeBSD (ipsec-must)
A method for experimentally verifying IPsec functionality.

Java, and Jakarta Tomcat (java-tomcat)
Information on setting up Java and Jakarta Tomcat on a FreeBSD system.

FreeBSD on Laptops (laptop)
Information about running FreeBSD on a laptop.

An MH Primer (mh)
An introduction to using the MH mail reader on FreeBSD.

Using FreeBSD with other operating systems (multi-os)
How to install FreeBSD alongside one or more different operating systems on the same computer.

FreeBSD First Steps (new-users)
For people coming to FreeBSD and &unix; for the first time.

Pluggable Authentication Modules (pam)
A guide to the PAM system and modules under FreeBSD.

FreeBSD Problem Report Handling Guidelines (pr-guidelines)
Recommended practices for handling FreeBSD problem reports.

Writing FreeBSD Problem Reports (problem-reports)
How to best formulate and submit a problem report to the FreeBSD Project.

PXE booting FreeBSD (pxe)
How to create an Intel PXE server using FreeBSD, and how to configure a FreeBSD client to boot from a PXE server.

FreeBSD Release Engineering (releng)
Describes the approach used by the FreeBSD release engineering team to make production quality releases of the FreeBSD Operating System. It describes the tools available for those interested in producing customized FreeBSD releases for corporate rollouts or commercial productization.

FreeBSD Release Engineering for Third Party Packages (releng-packages)
Describes the approach used by the FreeBSD release engineering team to produce a high quality package set suitable for official FreeBSD release media. This document is a work in progress, but eventually it will cover the process used to build a clean package set on the FreeBSD.org "Ports Cluster", how to configure any other set of machines as a ports cluster, how to split up the packages for the release media, and how to verify that a package set is consistent.

Serial and UART devices (serial-uart)
Detailed information about the use of serial ports on FreeBSD, including several multi-port serial cards.

FreeBSD and Solid State Devices (solid-state)
The use of solid state disk devices in FreeBSD.

Storage Devices (storage-devices)
Detailed information about using storage devices with FreeBSD, including ESDI disks, and SCSI disks, tape drives, and CDROM drives.

Bootstrapping Vinum: A Foundation for Reliable Servers (vinum)
A gentle introduction to failure-resilient servers and step-by-step instructions for building one with Vinum.

Design elements of the FreeBSD VM system (vm-design)
An easy to follow description of the design of the FreeBSD virtual memory system.

Zip-drives and FreeBSD (zip-drive)
How to format, mount, and use an Iomega Zip (SCSI, IDE, or parallel) Drive on FreeBSD.

Manual pages

For release: 1.0, 1.1,, 2.0, 2.0.5, 2.1.0, 2.1.5,,, 2.2.1, 2.2.2, 2.2.5, 2.2.6, 2.2.7, 2.2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5.1, 4.0, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 4.x-stable, 5.0, 5.1, 5.1-current, Ports.
Other Systems
Unix Seventh Edition (V7), 2.8BSD, 2.9.1BSD, 2.10BSD, 2.11BSD, 4.3BSD Reno, NET/2, 386BSD 0.1, 4.4BSD Lite2, HP-UX, Linux, NetBSD, OpenBSD, Darwin, Plan 9, SunOS 4.x, SunOS 5.x, ULTRIX 4.2, and XFree86.

Other documentation

4.4BSD Documents: This is a hypertext version of the 4.4BSD documents from /usr/share/doc, where you will find the documents on a FreeBSD machine (if you install the doc distribution).

Info Documents: This is a hypertext version of the Info documents from /usr/share/info, where you will find the Info documents on a FreeBSD machine (if you install the info distribution).

On other web sites

Various independent efforts have also produced a great deal of useful information about FreeBSD.




In the real world...

FreeBSD in the Press

Articles in the press about FreeBSD.


The following newsgroups contain discussion pertinent to FreeBSD users:

Additional resources

Year 2000 Compatibility

The FreeBSD project's current statement about its Year 2000 compatibility.

BSD Real-Quick (TM) Newsletter

A monthly (sometimes bi-weekly) newsletter announcing recent developments in the FreeBSD arena. Subscribe to freebsd-announce to receive this newsletter via e-mail.

The Source Code

If you like digging your fingers into source code, here is a hypertext version of the FreeBSD kernel source. This is brought to you courtesy of Warren Toomey.

Daemon News

The industry leader in BSD news.

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.

The FreeBSD Diary

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.

The O'Reilly Network BSD Dev Center

The BSD Dev Center includes two regular columns on FreeBSD, featuring tips and tutorials.



+ +

FreeBSDhowtos.com features a comprehensive database of + HOWTOs and installation instructions.

+ &footer;