Annotation of wikisrc/guide/index_bare, revision 1.6

1.1       jdf         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: 
1.4       jdf        19: Originally, the guide has been a book, which was subsequently moved to the wiki
1.1       jdf        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: 
1.4       jdf        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
1.1       jdf        42: later due to better tools and slightly more knowhow on customisations.
                     43: 
1.4       jdf        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
1.3       jdf        47: reformulations.
                     48: 
                     49: You can still get the
1.4       jdf        50: [old version of the Guide](http://netbsd.org/docs/guide), which is not
1.3       jdf        51: maintained anymore.
1.1       jdf        52: 
                     53: ## Bibliography
                     54: 
                     55:  * [AeleenFrisch] Aeleen Frisch. Copyright © 1991. O'Reilly & Associates. *Essential System Administration*.
                     56:  * [CraigHunt] Craig Hunt. Copyright © 1993. O'Reilly & Associates. *TCP/IP Network Administration*.
                     57:  * [RFC1933] R. Gilligan and E. Nordmark. Copyright © 1996. *RFC 1933: Transition Mechanisms for IPv6 Hosts and Routers*.
                     58:  * [RFC2004] C. Perkins. Copyright © 1996. *RFC 2003: IP Encapsulation within IP*.
                     59:  * [RFC2529] B. Carpenter and C. Jung. Copyright © 1999. *RFC 2529: Transmission of IPv6 over IPv4 Domains without Explicit Tunnels*.
                     60:  * [RFC3056] B. Carpenter and K. Moore. Copyright © 2001. *RFC 3056: Connection of IPv6 Domains via IPv4 Clouds*.
                     61: 
                     62: ## Acknowledgements
                     63: 
1.4       jdf        64: The NetBSD Guide was originally written by Federico Lupi who managed the
                     65: sources, coordinated updates, and merged all contributions on his own. Since
                     66: then, it has been updated and maintained by the NetBSD www team. The Guide has
                     67: progressed thanks to the contributions of many people who have volunteered their
1.1       jdf        68: time and effort, supplied material and sent in suggestions and corrections.
                     69: 
                     70: ### Original acknowledgements
                     71: 
                     72: Federico's original credits are:
                     73: 
                     74:  * Paulo Aukar
                     75:  * Grant Beattie, converted to XML DocBook.
                     76:  * Manolo De Santis, Audio Chapter
                     77:  * Eric Delcamp, Boot Floppies
                     78:  * Hubert Feyrer, who contributed
1.4       jdf        79:    [[Introduction to TCP/IP Networking|guide/net-intro]] including Next
1.1       jdf        80:    generation Internet protocol - IPv6 and the section
                     81:    [[IPv6 Connectivity & Transition via 6to4|guide/net-practice#ipv6-6to4]]
                     82:    He also helped with the SGML to XML transition.
                     83:  * Jason R. Fink
                     84:  * Daniel de Kok, audio and linux chapters fixes.
                     85:  * Reinoud Koornstra, CVS chapter and rebuilding `/dev` in the Misc chapter.
1.4       jdf        86:  * Brian A. Seklecki [lavalamp@burghcom.com](mailto:lavalamp@burghcom.com), who
1.1       jdf        87:    contributed the CCD Chapter.
                     88:  * Guillain Seuillot
                     89:  * Martti Kuparinen, RAIDframe documentation.
                     90:  * David Magda
                     91: 
                     92: ### Current acknowledgements
                     93: 
1.4       jdf        94: This document is currently maintained by the NetBSD www team. Thanks to their
                     95: efforts, the document is kept up to date and available online at all times. In
1.1       jdf        96: addition, special thanks go to (in alphabetical order):
                     97: 
1.4       jdf        98:  * Hubert Feyrer, for getting the guide up to speed for NetBSD 2.0, and for
1.1       jdf        99:    making numerous improvements to all chapters.
                    100:  * Jason R. Fink, for maintaining this document and integrating changes.
                    101:  * Andreas Hallman, for his information in
                    102:    [[Tunneling 6to4 through an IPFilter firewall|guide/net-practice#chap-net-practice-ipv6-6to4-ipf]]
                    103:  * Joel Knight for the
1.4       jdf       104:    [[Introduction to the Common Address Redundancy Protocol (CARP)|guide/carp]].
1.1       jdf       105:    See below for for the accompanying license.
1.4       jdf       106:  * Daniel de Kok, for constant contributions of new chapters, maintenance of
1.1       jdf       107:    existing chapters and his translation work.
                    108:  * Hiroki Sato, for allowing us to build PDF and PS versions of this document.
                    109:  * Jan Schaumann, for maintenance work and `www/htdocs` management.
                    110:  * Lubomir Sedlacik, for some details on using CGD for swap in
                    111:    [[Suggestions and Warnings|guide/cgd#suggestions]]
                    112:  * Dag-Erling Smrgrav, for the article on
1.4       jdf       113:    [[Pluggable Authentication Modules (PAM)|guide/pam]]. See below for the
1.1       jdf       114:    accompanying license.
                    115:  * Florian Sthr, for
                    116:    [[Example: encrypted CDs/DVDs|guide/cgd#cryptocds]]
                    117: 
                    118: 
                    119: ### Licenses
                    120: 
                    121: #### Federico Lupi's original license of this guide
                    122: 
1.4       jdf       123: Redistribution and use in source and binary forms, with or without modification,
1.1       jdf       124: are permitted provided that the following conditions are met:
                    125: 
1.4       jdf       126:  1. Redistributions of source code must retain the above copyright notice, this
1.1       jdf       127:     list of conditions and the following disclaimer.
1.4       jdf       128:  2. Redistributions in binary form must reproduce the above copyright notice,
                    129:     this list of conditions and the following disclaimer in the documentation
1.1       jdf       130:     and/or other materials provided with the distribution.
1.4       jdf       131:  3. All advertising materials mentioning features or use of this software must
                    132:     display the following acknowledgement: This product includes software developed
1.1       jdf       133:     by Federico Lupi for the NetBSD Project.
1.4       jdf       134:  4. The name of the author may not be used to endorse or promote products
1.1       jdf       135:     derived from this software without specific prior written permission.
                    136: 
1.4       jdf       137: THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
                    138: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
                    139: MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
                    140: SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
                    141: EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
                    142: OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
                    143: INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
                    144: CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
                    145: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
1.1       jdf       146: OF SUCH DAMAGE.
                    147: 
                    148: #### The NetBSD Developers
                    149: 
                    150: Copyright  1999, 2000, 2001, 2002 Federico Lupi
                    151: 
1.2       jdf       152: Copyright  2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The NetBSD Foundation
1.1       jdf       153: 
                    154: All brand and product names used in this guide are or may be trademarks or registered trademarks of their respective owners.
                    155: 
                    156: NetBSD is a registered trademark of The NetBSD Foundation, Inc.

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