File:  [NetBSD Developer Wiki] / wikisrc / guide / index_bare
Revision 1.9: download - view: text, annotated - select for diffs
Sat Apr 12 02:41:36 2014 UTC (7 years, 6 months ago) by jakllsch
Branches: MAIN
CVS tags: HEAD
Convert from ISO-8859-1 to UTF-8.

# The NetBSD Guide

## Purpose of this guide

This guide describes the installation and the configuration of the NetBSD
operating system as well as the setup and administration of some of its
subsystems. It primarily addresses people coming from other Unix-like operating
systems, and aims to be a useful guide in the face of the many small problems
one encounters when using a new tool.

This guide is not a Unix tutorial: basic knowledge of some concepts and tools
is assumed. You should know, for example, what a file and a directory are, and
how to use an editor. There are plenty of books explaining basic Unix and
operating system concepts, and you should consult one if you need more
background information. It is better to choose a general book and avoid titles
like "Learning Unix-XYZ, version 1.2.3.4 in 10 days", but this is a matter of
personal taste.

Originally, the guide has been a book, which was subsequently moved to the wiki
to make it easier to contribute.

If you have additions or comments to the guide, but don't want to create an
account, feel free to post your submissions to the
[www team](mailto:www@netbsd.org) or the
[docs mailing list](netbsd-docs@netbsd.org). The text is maintained in
Markdown, and you can use the button in the top right corner to show the source
of an article.

## Table of Contents
%%TOC%%

## Guide history

This guide was born as a collection of sparse notes that Federico Lupi, the
original author of the NetBSD Guide, wrote mostly for himself. When he realized
that they could be useful to other NetBSD users he started collecting them and
created the first version of the guide using the groff formatter. In order to
"easily" get a wider variety of output formats (e.g. HTML and
PostScript/PDF), he made the "mistake" of moving to SGML/DocBook, which
was the format of the sources. Maintainership was picked up by the NetBSD
project and its developers later, and the format was changed to XML/DocBook
later due to better tools and slightly more knowhow on customisations.

In 2012/2013, the guide was converted in a Google Code-In task by Mingzhe Wang
(wmzhere) to Markdown. In early 2013, it was integrated to the NetBSD wiki,
along with removing old chapters, restricting numbering schemes and some
reformulations.

You can still get the
[old version of the Guide](http://netbsd.org/docs/guide), which is not
maintained anymore.

## Acknowledgements

The NetBSD Guide was originally written by Federico Lupi who managed the
sources, coordinated updates, and merged all contributions on his own. Since
then, it has been updated and maintained by the NetBSD www team. The Guide has
progressed thanks to the contributions of many people who have volunteered their
time and effort, supplied material and sent in suggestions and corrections.

### Original acknowledgements

Federico's original credits are:

 * Paulo Aukar
 * Grant Beattie, converted to XML DocBook.
 * Manolo De Santis, Audio Chapter
 * Eric Delcamp, Boot Floppies
 * Hubert Feyrer, who contributed
   [[Introduction to TCP/IP Networking|guide/net-intro]] including Next
   generation Internet protocol - IPv6 and the section
   [[IPv6 Connectivity & Transition via 6to4|guide/net-practice#ipv6-6to4]]
   He also helped with the SGML to XML transition.
 * Jason R. Fink
 * Daniel de Kok, audio and linux chapters fixes.
 * Reinoud Koornstra, CVS chapter and rebuilding `/dev` in the Misc chapter.
 * Brian A. Seklecki [lavalamp@burghcom.com](mailto:lavalamp@burghcom.com), who
   contributed the CCD Chapter.
 * Guillain Seuillot
 * Martti Kuparinen, RAIDframe documentation.
 * David Magda

### Current acknowledgements

This document is currently maintained by the NetBSD www team. Thanks to their
efforts, the document is kept up to date and available online at all times. In
addition, special thanks go to (in alphabetical order):

 * Hubert Feyrer, for getting the guide up to speed for NetBSD 2.0, and for
   making numerous improvements to all chapters.
 * Jason R. Fink, for maintaining this document and integrating changes.
 * Andreas Hallman, for his information in
   [[Tunneling 6to4 through an IPFilter firewall|guide/net-practice#chap-net-practice-ipv6-6to4-ipf]]
 * Joel Knight for the
   [[Introduction to the Common Address Redundancy Protocol (CARP)|guide/carp]].
   See below for for the accompanying license.
 * Daniel de Kok, for constant contributions of new chapters, maintenance of
   existing chapters and his translation work.
 * Hiroki Sato, for allowing us to build PDF and PS versions of this document.
 * Jan Schaumann, for maintenance work and `www/htdocs` management.
 * Lubomir Sedlacik, for some details on using CGD for swap in
   [[Suggestions and Warnings|guide/cgd#suggestions]]
 * Dag-Erling Smørgrav, for the article on
   [[Pluggable Authentication Modules (PAM)|guide/pam]]. See below for the
   accompanying license.
 * Florian Stöhr, for
   [[Example: encrypted CDs/DVDs|guide/cgd#cryptocds]]


### Licenses

#### Federico Lupi's original license of this guide

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

 1. Redistributions of source code must retain the above copyright notice, this
    list of conditions and the following disclaimer.
 2. Redistributions in binary form 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.
 3. All advertising materials mentioning features or use of this software must
    display the following acknowledgement: This product includes software developed
    by Federico Lupi for the NetBSD Project.
 4. The name of the author may not be used to endorse or promote products
    derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR "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 THE AUTHOR 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 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.

#### The NetBSD Developers

Copyright © 1999, 2000, 2001, 2002 Federico Lupi

Copyright © 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The NetBSD Foundation

All brand and product names used in this guide are or may be trademarks or registered trademarks of their respective owners.

NetBSD® is a registered trademark of The NetBSD Foundation, Inc.

CVSweb for NetBSD wikisrc <wikimaster@NetBSD.org> software: FreeBSD-CVSweb