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 by XXX (Wang - wmzhere) to Markdown and
45: integrated into the NetBSD wiki. Along with the conversion, old chapters were
46: removed, the numbering scheme was restricted to the table of contents and soem
47: reformulations were done.
48:
49: You can still get the old version of the Guide at XXX
50:
51: ## Bibliography
52:
53: * [AeleenFrisch] Aeleen Frisch. Copyright © 1991. O'Reilly & Associates. *Essential System Administration*.
54: * [CraigHunt] Craig Hunt. Copyright © 1993. O'Reilly & Associates. *TCP/IP Network Administration*.
55: * [RFC1034] P. V. Mockapetris. Copyright © 1987. *RFC 1034: Domain names - concepts and facilities*.
56: * [RFC1035] P. V. Mockapetris. Copyright © 1987. *RFC 1035: Domain names - implementation and specification*.
57: * [RFC1055] J. L. Romkey. Copyright © 1988. *RFC 1055: Nonstandard for transmission of IP datagrams over serial lines: SLIP*.
58: * [RFC1331] W. Simpson. Copyright © 1992. *RFC 1331: The Point-to-Point Protocol (PPP) for the Transmission of Multi-protocol Datagrams over Point-to-Point Links*.
59: * [RFC1332] G. McGregor. Copyright © 1992. *RFC 1332: The PPP Internet Protocol Control Protocol (IPCP)*.
60: * [RFC1933] R. Gilligan and E. Nordmark. Copyright © 1996. *RFC 1933: Transition Mechanisms for IPv6 Hosts and Routers*.
61: * [RFC2004] C. Perkins. Copyright © 1996. *RFC 2003: IP Encapsulation within IP*.
62: * [RFC2401] S. Kent and R. Atkinson. Copyright © 1998. *RFC 2401: Security Architecture for the Internet Protocol*.
63: * [RFC2411] R. Thayer, N. Doraswamy, and R. Glenn. Copyright © 1998. *RFC 2411: IP Security Document Roadmap*.
64: * [RFC2461] T. Narten, E. Nordmark, and W. Simpson. Copyright © 1998. *RFC 2461: Neighbor Discovery for IP Version 6 (IPv6)*.
65: * [RFC2529] B. Carpenter and C. Jung. Copyright © 1999. *RFC 2529: Transmission of IPv6 over IPv4 Domains without Explicit Tunnels*.
66: * [RFC3024] G. Montenegro. Copyright © 2001. *RFC 3024: Reverse Tunneling for Mobile IP*.
67: * [RFC3027] M. Holdrege and P. Srisuresh. Copyright © 2001. *RFC 3027: Protocol Complications with the IP Network Address Translator*.
68: * [RFC3056] B. Carpenter and K. Moore. Copyright © 2001. *RFC 3056: Connection of IPv6 Domains via IPv4 Clouds*.
69:
70: ## Acknowledgements
71:
72: The NetBSD Guide was originally written by Federico Lupi who managed the
73: sources, coordinated updates, and merged all contributions on his own. Since
74: then, it has been updated and maintained by the NetBSD www team. The Guide has
75: progressed thanks to the contributions of many people who have volunteered their
76: time and effort, supplied material and sent in suggestions and corrections.
77:
78: ### Original acknowledgements
79:
80: Federico's original credits are:
81:
82: * Paulo Aukar
83: * Grant Beattie, converted to XML DocBook.
84: * Manolo De Santis, Audio Chapter
85: * Eric Delcamp, Boot Floppies
86: * Hubert Feyrer, who contributed
87: [[Introduction to TCP/IP Networking|guide/net-intro]] including Next
88: generation Internet protocol - IPv6 and the section
89: [[IPv6 Connectivity & Transition via 6to4|guide/net-practice#ipv6-6to4]]
90: He also helped with the SGML to XML transition.
91: * Jason R. Fink
92: * Daniel de Kok, audio and linux chapters fixes.
93: * Reinoud Koornstra, CVS chapter and rebuilding `/dev` in the Misc chapter.
94: * Brian A. Seklecki [lavalamp@burghcom.com](mailto:lavalamp@burghcom.com), who
95: contributed the CCD Chapter.
96: * Guillain Seuillot
97: * Martti Kuparinen, RAIDframe documentation.
98: * David Magda
99:
100: ### Current acknowledgements
101:
102: This document is currently maintained by the NetBSD www team. Thanks to their
103: efforts, the document is kept up to date and available online at all times. In
104: addition, special thanks go to (in alphabetical order):
105:
106: * Hubert Feyrer, for getting the guide up to speed for NetBSD 2.0, and for
107: making numerous improvements to all chapters.
108: * Jason R. Fink, for maintaining this document and integrating changes.
109: * Andreas Hallman, for his information in
110: [[Tunneling 6to4 through an IPFilter firewall|guide/net-practice#chap-net-practice-ipv6-6to4-ipf]]
111: * Joel Knight for the
112: [[Introduction to the Common Address Redundancy Protocol (CARP)|guide/carp]].
113: See below for for the accompanying license.
114: * Daniel de Kok, for constant contributions of new chapters, maintenance of
115: existing chapters and his translation work.
116: * Hiroki Sato, for allowing us to build PDF and PS versions of this document.
117: * Jan Schaumann, for maintenance work and `www/htdocs` management.
118: * Lubomir Sedlacik, for some details on using CGD for swap in
119: [[Suggestions and Warnings|guide/cgd#suggestions]]
120: * Dag-Erling Smørgrav, for the article on
121: [[Pluggable Authentication Modules (PAM)|guide/pam]]. See below for the
122: accompanying license.
123: * Florian Stöhr, for
124: [[Example: encrypted CDs/DVDs|guide/cgd#cryptocds]]
125:
126:
127: ### Licenses
128:
129: #### Federico Lupi's original license of this guide
130:
131: Redistribution and use in source and binary forms, with or without modification,
132: are permitted provided that the following conditions are met:
133:
134: 1. Redistributions of source code must retain the above copyright notice, this
135: list of conditions and the following disclaimer.
136: 2. Redistributions in binary form must reproduce the above copyright notice,
137: this list of conditions and the following disclaimer in the documentation
138: and/or other materials provided with the distribution.
139: 3. All advertising materials mentioning features or use of this software must
140: display the following acknowledgement: This product includes software developed
141: by Federico Lupi for the NetBSD Project.
142: 4. The name of the author may not be used to endorse or promote products
143: derived from this software without specific prior written permission.
144:
145: THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
146: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
147: MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
148: SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
149: EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
150: OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
151: INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
152: CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
153: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
154: OF SUCH DAMAGE.
155:
156: #### Networks Associates Technology's license on the PAM article
157:
158: Copyright (c) 2001-2003 Networks Associates Technology, Inc.
159: All rights reserved.
160: This software was developed for the FreeBSD Project by ThinkSec AS and
161: Network Associates Laboratories, the Security Research Division of
162: Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
163: ("CBOSS"), as part of the DARPA CHATS research program.
164: Redistribution and use in source and binary forms, with or without
165: modification, are permitted provided that the following conditions
166: are met:
167: 1. Redistributions of source code must retain the above copyright
168: notice, this list of conditions and the following disclaimer.
169: 2. Redistributions in binary form must reproduce the above copyright
170: notice, this list of conditions and the following disclaimer in the
171: documentation and/or other materials provided with the distribution.
172: 3. The name of the author may not be used to endorse or promote
173: products derived from this software without specific prior written
174: permission.
175: THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
176: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
177: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
178: ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
179: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
180: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
181: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
182: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
183: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
184: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
185: SUCH DAMAGE.
186:
187: #### Joel Knight's license on the CARP article
188:
189: Copyright (c) 2005 Joel Knight <enabled@myrealbox.com\>
190: Permission to use, copy, modify, and distribute this documentation for
191: any purpose with or without fee is hereby granted, provided that the
192: above copyright notice and this permission notice appear in all copies.
193: THE DOCUMENTATION IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
194: WARRANTIES WITH REGARD TO THIS DOCUMENTATION INCLUDING ALL IMPLIED
195: WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
196: AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
197: DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
198: PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
199: TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
200: PERFORMANCE OF THIS DOCUMENTATION
201:
202: #### The NetBSD Developers
203:
204: Copyright © 1999, 2000, 2001, 2002 Federico Lupi
205:
206: Copyright © 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The NetBSD Foundation
207:
208: All brand and product names used in this guide are or may be trademarks or registered trademarks of their respective owners.
209:
210: NetBSD® is a registered trademark of The NetBSD Foundation, Inc.
CVSweb for NetBSD wikisrc <wikimaster@NetBSD.org> software: FreeBSD-CVSweb
![[BACK]](/icons/back.gif){kind=icon}
Return to index_bare CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [NetBSD Developer Wiki] / wikisrc / guide