Return to index_bare CVS log

Up to [NetBSD Developer Wiki] / wikisrc / guide

Convert from ISO-8859-1 to UTF-8.

    1: # The NetBSD Guide
    2: 
    3: ## Purpose of this guide
    4: 
    5: This guide describes the installation and the configuration of the NetBSD
    6: operating system as well as the setup and administration of some of its
    7: subsystems. It primarily addresses people coming from other Unix-like operating
    8: systems, and aims to be a useful guide in the face of the many small problems
    9: one encounters when using a new tool.
   10: 
   11: This guide is not a Unix tutorial: basic knowledge of some concepts and tools
   12: is assumed. You should know, for example, what a file and a directory are, and
   13: how to use an editor. There are plenty of books explaining basic Unix and
   14: operating system concepts, and you should consult one if you need more
   15: background information. It is better to choose a general book and avoid titles
   16: like "Learning Unix-XYZ, version 1.2.3.4 in 10 days", but this is a matter of
   17: personal taste.
   18: 
   19: Originally, the guide has been a book, which was subsequently moved to the wiki
   20: to make it easier to contribute.
   21: 
   22: If you have additions or comments to the guide, but don't want to create an
   23: account, feel free to post your submissions to the
   24: [www team](mailto:www@netbsd.org) or the
   25: [docs mailing list](netbsd-docs@netbsd.org). The text is maintained in
   26: Markdown, and you can use the button in the top right corner to show the source
   27: of an article.
   28: 
   29: ## Table of Contents
   30: %%TOC%%
   31: 
   32: ## Guide history
   33: 
   34: This guide was born as a collection of sparse notes that Federico Lupi, the
   35: original author of the NetBSD Guide, wrote mostly for himself. When he realized
   36: that they could be useful to other NetBSD users he started collecting them and
   37: created the first version of the guide using the groff formatter. In order to
   38: "easily" get a wider variety of output formats (e.g. HTML and
   39: PostScript/PDF), he made the "mistake" of moving to SGML/DocBook, which
   40: was the format of the sources. Maintainership was picked up by the NetBSD
   41: project and its developers later, and the format was changed to XML/DocBook
   42: later due to better tools and slightly more knowhow on customisations.
   43: 
   44: In 2012/2013, the guide was converted in a Google Code-In task by Mingzhe Wang
   45: (wmzhere) to Markdown. In early 2013, it was integrated to the NetBSD wiki,
   46: along with removing old chapters, restricting numbering schemes and some
   47: reformulations.
   48: 
   49: You can still get the
   50: [old version of the Guide](http://netbsd.org/docs/guide), which is not
   51: maintained anymore.
   52: 
   53: ## Acknowledgements
   54: 
   55: The NetBSD Guide was originally written by Federico Lupi who managed the
   56: sources, coordinated updates, and merged all contributions on his own. Since
   57: then, it has been updated and maintained by the NetBSD www team. The Guide has
   58: progressed thanks to the contributions of many people who have volunteered their
   59: time and effort, supplied material and sent in suggestions and corrections.
   60: 
   61: ### Original acknowledgements
   62: 
   63: Federico's original credits are:
   64: 
   65:  * Paulo Aukar
   66:  * Grant Beattie, converted to XML DocBook.
   67:  * Manolo De Santis, Audio Chapter
   68:  * Eric Delcamp, Boot Floppies
   69:  * Hubert Feyrer, who contributed
   70:    [[Introduction to TCP/IP Networking|guide/net-intro]] including Next
   71:    generation Internet protocol - IPv6 and the section
   72:    [[IPv6 Connectivity & Transition via 6to4|guide/net-practice#ipv6-6to4]]
   73:    He also helped with the SGML to XML transition.
   74:  * Jason R. Fink
   75:  * Daniel de Kok, audio and linux chapters fixes.
   76:  * Reinoud Koornstra, CVS chapter and rebuilding `/dev` in the Misc chapter.
   77:  * Brian A. Seklecki [lavalamp@burghcom.com](mailto:lavalamp@burghcom.com), who
   78:    contributed the CCD Chapter.
   79:  * Guillain Seuillot
   80:  * Martti Kuparinen, RAIDframe documentation.
   81:  * David Magda
   82: 
   83: ### Current acknowledgements
   84: 
   85: This document is currently maintained by the NetBSD www team. Thanks to their
   86: efforts, the document is kept up to date and available online at all times. In
   87: addition, special thanks go to (in alphabetical order):
   88: 
   89:  * Hubert Feyrer, for getting the guide up to speed for NetBSD 2.0, and for
   90:    making numerous improvements to all chapters.
   91:  * Jason R. Fink, for maintaining this document and integrating changes.
   92:  * Andreas Hallman, for his information in
   93:    [[Tunneling 6to4 through an IPFilter firewall|guide/net-practice#chap-net-practice-ipv6-6to4-ipf]]
   94:  * Joel Knight for the
   95:    [[Introduction to the Common Address Redundancy Protocol (CARP)|guide/carp]].
   96:    See below for for the accompanying license.
   97:  * Daniel de Kok, for constant contributions of new chapters, maintenance of
   98:    existing chapters and his translation work.
   99:  * Hiroki Sato, for allowing us to build PDF and PS versions of this document.
  100:  * Jan Schaumann, for maintenance work and `www/htdocs` management.
  101:  * Lubomir Sedlacik, for some details on using CGD for swap in
  102:    [[Suggestions and Warnings|guide/cgd#suggestions]]
  103:  * Dag-Erling Smørgrav, for the article on
  104:    [[Pluggable Authentication Modules (PAM)|guide/pam]]. See below for the
  105:    accompanying license.
  106:  * Florian Stöhr, for
  107:    [[Example: encrypted CDs/DVDs|guide/cgd#cryptocds]]
  108: 
  109: 
  110: ### Licenses
  111: 
  112: #### Federico Lupi's original license of this guide
  113: 
  114: Redistribution and use in source and binary forms, with or without modification,
  115: are permitted provided that the following conditions are met:
  116: 
  117:  1. Redistributions of source code must retain the above copyright notice, this
  118:     list of conditions and the following disclaimer.
  119:  2. Redistributions in binary form must reproduce the above copyright notice,
  120:     this list of conditions and the following disclaimer in the documentation
  121:     and/or other materials provided with the distribution.
  122:  3. All advertising materials mentioning features or use of this software must
  123:     display the following acknowledgement: This product includes software developed
  124:     by Federico Lupi for the NetBSD Project.
  125:  4. The name of the author may not be used to endorse or promote products
  126:     derived from this software without specific prior written permission.
  127: 
  128: THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
  129: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  130: MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  131: SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  132: EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  133: OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  134: INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  135: CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  136: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  137: OF SUCH DAMAGE.
  138: 
  139: #### The NetBSD Developers
  140: 
  141: Copyright © 1999, 2000, 2001, 2002 Federico Lupi
  142: 
  143: Copyright © 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The NetBSD Foundation
  144: 
  145: All brand and product names used in this guide are or may be trademarks or registered trademarks of their respective owners.
  146: 
  147: NetBSD® is a registered trademark of The NetBSD Foundation, Inc.