1:
2: # The NetBSD Guide
3:
4: ## Purpose of this guide
5:
6: This guide describes the installation and the configuration of the NetBSD
7: operating system as well as the setup and administration of some of its
8: subsystems. It primarily addresses people coming from other Unix-like operating
9: systems, and aims to be a useful guide in the face of the many small problems
10: one encounters when using a new tool.
11:
12: This guide is not a Unix tutorial: basic knowledge of some concepts and tools
13: is assumed. You should know, for example, what a file and a directory are, and
14: how to use an editor. There are plenty of books explaining basic Unix and
15: operating system concepts, and you should consult one if you need more
16: background information. It is better to choose a general book and avoid titles
17: like "Learning Unix-XYZ, version 1.2.3.4 in 10 days", but this is a matter of
18: personal taste.
19:
20: Originally, the guide has been a book, which was subsequently moved to the wiki
21: to make it easier to contribute.
22:
23: If you have additions or comments to the guide, but don't want to create an
24: account, feel free to post your submissions to the
25: [www team](mailto:www@netbsd.org) or the
26: [docs mailing list](netbsd-docs@netbsd.org). The text is maintained in
27: Markdown, and you can use the button in the top right corner to show the source
28: of an article.
29:
30: ## Table of Contents
31:
32: ***I. About NetBSD***
33:
34: * [[1. What is NetBSD?|guide/intro]]
35: * [[1.1. The story of NetBSD]]
36: * [[1.2. NetBSD features]]
37: * [[1.3. Supported platforms]]
38: * [[1.4. NetBSD's target users]]
39: * [[1.5. Applications for NetBSD]]
40: * [[1.6. How to get NetBSD]]
41:
42: ***II. System installation and related issues***
43:
44:
45: ***III. System configuration, administration and tuning***
46:
47: * [[4. Upgrading NetBSD|guide/upgrading]]
48: * [[4.1. Using sysinst]]
49: * [[4.2. Using sysupgrade]]
50: * [[5. The first steps on NetBSD|guide/boot]]
51: * [[5.1. Troubleshooting]]
52: * [[5.2. The man command]]
53: * [[5.3. Editing configuration files]]
54: * [[5.4. Login]]
55: * [[5.5. Changing the root password]]
56: * [[5.6. Adding users]]
57: * [[5.7. Shadow passwords]]
58: * [[5.8. Changing the keyboard layout]]
59: * [[5.9. System time]]
60: * [[5.10. Secure Shell ssh(1)]]
61: * [[5.11. Basic configuration in /etc/rc.conf]]
62: * [[5.12. Basic network settings]]
63: * [[5.13. Mounting a CD-ROM]]
64: * [[5.14. Mounting a floppy]]
65: * [[5.15. Installing additional software]]
66: * [[5.16. Security alerts]]
67: * [[5.17. Stopping and rebooting the system]]
68: * [[6. Editing|guide/edit]]
69: * [[6.1. Introducing vi]]
70: * [[6.2. Configuring vi]]
71: * [[6.3. Using tags with vi]]
72: * [[7. The rc.d System|guide/rc]]
73: * [[7.1. Basics]]
74: * [[7.2. The rc.d scripts]]
75: * [[7.3. Order/dependencies of start determined by rcorder]]
76: * [[7.4. rc.d scripts of additional services]]
77: * [[7.5. Additional Reading]]
78: * [[8. Console drivers|guide/cons]]
79: * [[8.1. wscons]]
80: * [[9. X|guide/x]]
81: * [[9.1. What is X?]]
82: * [[9.2. Configuration]]
83: * [[9.3. The mouse]]
84: * [[9.4. The keyboard]]
85: * [[9.5. The monitor]]
86: * [[9.6. The video card]]
87: * [[9.7. Starting X]]
88: * [[9.8. Customizing X]]
89: * [[9.9. Other window managers or desktop environments]]
90: * [[9.10. Graphical login with xdm]]
91: * [[10. Linux emulation|guide/linux]]
92: * [[10.1. Emulation setup]]
93: * [[10.2. Directory structure]]
94: * [[10.3. Emulating /proc]]
95: * [[10.4. Using Linux browser plugins]]
96: * [[10.5. Further reading]]
97: * [[11. Audio|guide/audio]]
98: * [[11.1. Basic hardware elements]]
99: * [[11.2. Supported audio cards]]
100: * [[11.3. BIOS settings]]
101: * [[11.4. Configuring the audio device]]
102: * [[11.5. Multiple audio devices]]
103: * [[11.6. Configuring the kernel audio devices]]
104: * [[11.7. Advanced commands]]
105: * [[12. Printing|guide/print]]
106: * [[12.1. Enabling the printer daemon]]
107: * [[12.2. Configuring `/etc/printcap`]]
108: * [[12.3. Configuring Ghostscript]]
109: * [[12.4. Printer management commands]]
110: * [[12.5. Remote printing]]
111: * [[13. Using removable media|guide/rmmedia]]
112: * [[13.1. Reading data CDs with NetBSD]]
113: * [[13.2. Reading multi-session CDs with NetBSD]]
114: * [[13.3. Allowing normal users to access CDs]]
115: * [[13.4. Mounting an ISO image]]
116: * [[13.5. Using video CDs with NetBSD]]
117: * [[13.6. Using audio CDs with NetBSD]]
118: * [[13.7. Creating an MP3 (MPEG layer 3) file from an audio CD]]
119: * [[13.8. Using a CD-R writer with data CDs]]
120: * [[13.9. Using a CD-R writer to create audio CDs]]
121: * [[13.10. Creating an audio CD from MP3s]]
122: * [[13.11. Copying an audio CD]]
123: * [[13.12. Copying a data CD with two drives]]
124: * [[13.13. Using CD-RW rewritables]]
125: * [[13.14. DVD support]]
126: * [[13.15. Creating ISO images from a CD]]
127: * [[13.16. Getting volume information from CDs and ISO images]]
128: * [[13.17. Initializing and using floppy disks]]
129: * [[14. The cryptographic device driver (CGD)|guide/cgd]]
130: * [[14.1. Overview]]
131: * [[14.2. Components of the Crypto-Graphic Disk system]]
132: * [[14.3. Example: encrypting your disk]]
133: * [[14.4. Example: encrypted CDs/DVDs]]
134: * [[14.5. Suggestions and Warnings]]
135: * [[14.6. Further Reading]]
136: * [[15. Concatenated Disk Device (CCD) configuration|guide/ccd]]
137: * [[15.1. Install physical media]]
138: * [[15.2. Configure Kernel Support]]
139: * [[15.3. Disklabel each volume member of the CCD]]
140: * [[15.4. Configure the CCD]]
141: * [[15.5. Initialize the CCD device]]
142: * [[15.6. Create a 4.2BSD/UFS filesystem on the new CCD device]]
143: * [[15.7. Mount the filesystem]]
144: * [[17. NetBSD Logical Volume Manager (LVM) configuration|guide/lvm]]
145: * [[17.1. Anatomy of NetBSD Logical Volume Manager]]
146: * [[17.2. Install physical media]]
147: * [[17.3. Configure Kernel Support]]
148: * [[17.4. Configure LVM on a NetBSD system]]
149: * [[17.5. Disklabel each physical volume member of the LVM]]
150: * [[17.6. Create Physical Volumes]]
151: * [[17.7. Create Volume Group]]
152: * [[17.8. Create Logical Volume]]
153: * [[17.9. Example: LVM with Volume groups located on raid1]]
154: * [[18. Pluggable Authentication Modules (PAM)|guide/pam]]
155: * [[18.1. About]]
156: * [[18.2. Introduction]]
157: * [[18.3. Terms and conventions]]
158: * [[18.4. PAM Essentials]]
159: * [[18.5. PAM Configuration]]
160: * [[18.6. PAM modules]]
161: * [[18.7. PAM Application Programming]]
162: * [[18.8. PAM Module Programming]]
163: * [[18.9. Sample PAM Application]]
164: * [[18.10. Sample PAM Module]]
165: * [[18.11. Sample PAM Conversation Function]]
166: * [[18.12. Further Reading]]
167: * [[19. Tuning NetBSD|guide/tuning]]
168: * [[19.1. Introduction]]
169: * [[19.2. Tuning Considerations]]
170: * [[19.3. Visual Monitoring Tools]]
171: * [[19.4. Monitoring Tools]]
172: * [[19.5. Network Tools]]
173: * [[19.6. Accounting]]
174: * [[19.7. Kernel Profiling]]
175: * [[19.8. System Tuning]]
176: * [[19.9. Kernel Tuning]]
177: * [[20. NetBSD Veriexec subsystem|guide/veriexec]]
178: * [[20.1. How it works]]
179: * [[20.2. Signatures file]]
180: * [[20.3. Strict levels]]
181: * [[20.4. Veriexec and layered file systems]]
182: * [[20.5. Kernel configuration]]
183: * [[21. Bluetooth on NetBSD|guide/bluetooth]]
184: * [[21.1. Introduction]]
185: * [[21.2. Supported Hardware]]
186: * [[21.3. System Configuration]]
187: * [[21.4. Human Interface Devices]]
188: * [[21.5. Personal Area Networking]]
189: * [[21.6. Serial Connections]]
190: * [[21.7. Audio]]
191: * [[21.8. Object Exchange]]
192: * [[21.9. Troubleshooting]]
193: * [[22. Miscellaneous operations|guide/misc]]
194: * [[22.1. Installing the boot manager]]
195: * [[22.2. Deleting the disklabel]]
196: * [[22.3. Speaker]]
197: * [[22.4. Forgot root password?]]
198: * [[22.5. Password file is busy?]]
199: * [[22.6. Adding a new hard disk]]
200: * [[22.7. How to rebuild the devices in /dev]]
201:
202: ***IV. Networking and related issues***
203:
204: * [[25. The Internet Super Server inetd
205: Allowing and denying hosts - /etc/hosts.allow, /etc/hosts.deny|guide/inetd]]
206: * [[25.1. Overview]]
207: * [[25.2. What is inetd?]]
208: * [[25.3. Configuring inetd - /etc/inetd.conf]]
209: * [[25.4. Services - /etc/services]]
210: * [[25.5. Protocols - /etc/protocols]]
211: * [[25.6. Remote Procedure Calls (RPC) - /etc/rpc]]
212: * [[25.7. Adding a Service]]
213: * [[25.8. When to use or not to use inetd]]
214: * [[25.9. Other Resources]]
215: * [[26. The Domain Name System|guide/dns]]
216: * [[26.1. DNS Background and Concepts]]
217: * [[26.2. The DNS Files]]
218: * [[26.3. Using DNS]]
219: * [[26.4. Setting up a caching only name server]]
220: * [[28. Introduction to the Common Address Redundancy Protocol (CARP)|guide/carp]]
221: * [[28.1. CARP Operation]]
222: * [[28.2. Configuring CARP]]
223: * [[28.3. Enabling CARP Support]]
224: * [[28.4. CARP Example]]
225: * [[28.5. Advanced CARP configuration]]
226: * [[28.6. Forcing Failover of the Master]]
227: * [[28.7. License]]
228:
229: ***V. Building the system***
230:
231: * [[30. Obtaining the sources|guide/fetch]]
232: * [[30.1. Preparing directories]]
233: * [[30.2. Terminology]]
234: * [[30.3. Downloading tarballs]]
235: * [[30.4. Fetching by CVS]]
236: * [[30.5. Sources on CD (ISO)]]
237: * [[31. Crosscompiling NetBSD with build.sh|guide/build]]
238: * [[31.1. Building the crosscompiler]]
239: * [[31.2. Configuring the kernel manually]]
240: * [[31.3. Crosscompiling the kernel manually]]
241: * [[31.4. Crosscompiling the kernel with build.sh]]
242: * [[31.5. Crosscompiling the userland]]
243: * [[31.6. Crosscompiling the X Window System]]
244: * [[31.7. Changing build behaviour]]
245: * [[32. Compiling the kernel|guide/kernel]]
246: * [[32.1. Requirements and procedure]]
247: * [[32.2. Installing the kernel sources]]
248: * [[32.3. Creating the kernel configuration file]]
249: * [[32.4. Building the kernel manually]]
250: * [[32.5. Building the kernel using build.sh]]
251: * [[32.6. Installing the new kernel]]
252: * [[32.7. If something went wrong]]
253: * [[33. Updating an existing system from sources|guide/updating]]
254: * [[33.1. Manual build and update procedure]]
255: * [[33.2. Using sysinst]]
256: * [[33.3. Using sysbuild and sysupgrade]]
257: * [[33.4. More details about the updating of configuration and startup files]]
258:
259: ## Guide history
260:
261: This guide was born as a collection of sparse notes that Federico Lupi, the
262: original author of the NetBSD Guide, wrote mostly for himself. When he realized
263: that they could be useful to other NetBSD users he started collecting them and
264: created the first version of the guide using the groff formatter. In order to
265: "easily" get a wider variety of output formats (e.g. HTML and
266: PostScript/PDF), he made the "mistake" of moving to SGML/DocBook, which
267: was the format of the sources. Maintainership was picked up by the NetBSD
268: project and its developers later, and the format was changed to XML/DocBook
269: later due to better tools and slightly more knowhow on customisations.
270:
271: In 2012/2013, the guide was converted in a Google Code-In task by Mingzhe Wang
272: (wmzhere) to Markdown. In early 2013, it was integrated to the NetBSD wiki,
273: along with removing old chapters, restricting numbering schemes and some
274: reformulations.
275:
276: You can still get the
277: [old version of the Guide](http://netbsd.org/docs/guide), which is not
278: maintained anymore.
279:
280: ## Bibliography
281:
282: * [AeleenFrisch] Aeleen Frisch. Copyright © 1991. O'Reilly & Associates. *Essential System Administration*.
283: * [CraigHunt] Craig Hunt. Copyright © 1993. O'Reilly & Associates. *TCP/IP Network Administration*.
284: * [RFC1034] P. V. Mockapetris. Copyright © 1987. *RFC 1034: Domain names - concepts and facilities*.
285: * [RFC1035] P. V. Mockapetris. Copyright © 1987. *RFC 1035: Domain names - implementation and specification*.
286: * [RFC1055] J. L. Romkey. Copyright © 1988. *RFC 1055: Nonstandard for transmission of IP datagrams over serial lines: SLIP*.
287: * [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*.
288: * [RFC1332] G. McGregor. Copyright © 1992. *RFC 1332: The PPP Internet Protocol Control Protocol (IPCP)*.
289: * [RFC1933] R. Gilligan and E. Nordmark. Copyright © 1996. *RFC 1933: Transition Mechanisms for IPv6 Hosts and Routers*.
290: * [RFC2004] C. Perkins. Copyright © 1996. *RFC 2003: IP Encapsulation within IP*.
291: * [RFC2401] S. Kent and R. Atkinson. Copyright © 1998. *RFC 2401: Security Architecture for the Internet Protocol*.
292: * [RFC2411] R. Thayer, N. Doraswamy, and R. Glenn. Copyright © 1998. *RFC 2411: IP Security Document Roadmap*.
293: * [RFC2461] T. Narten, E. Nordmark, and W. Simpson. Copyright © 1998. *RFC 2461: Neighbor Discovery for IP Version 6 (IPv6)*.
294: * [RFC2529] B. Carpenter and C. Jung. Copyright © 1999. *RFC 2529: Transmission of IPv6 over IPv4 Domains without Explicit Tunnels*.
295: * [RFC3024] G. Montenegro. Copyright © 2001. *RFC 3024: Reverse Tunneling for Mobile IP*.
296: * [RFC3027] M. Holdrege and P. Srisuresh. Copyright © 2001. *RFC 3027: Protocol Complications with the IP Network Address Translator*.
297: * [RFC3056] B. Carpenter and K. Moore. Copyright © 2001. *RFC 3056: Connection of IPv6 Domains via IPv4 Clouds*.
298:
299: ## Acknowledgements
300:
301: The NetBSD Guide was originally written by Federico Lupi who managed the
302: sources, coordinated updates, and merged all contributions on his own. Since
303: then, it has been updated and maintained by the NetBSD www team. The Guide has
304: progressed thanks to the contributions of many people who have volunteered their
305: time and effort, supplied material and sent in suggestions and corrections.
306:
307: ### Original acknowledgements
308:
309: Federico's original credits are:
310:
311: * Paulo Aukar
312: * Grant Beattie, converted to XML DocBook.
313: * Manolo De Santis, Audio Chapter
314: * Eric Delcamp, Boot Floppies
315: * Hubert Feyrer, who contributed
316: [[Introduction to TCP/IP Networking|guide/net-intro]] including Next
317: generation Internet protocol - IPv6 and the section
318: [[IPv6 Connectivity & Transition via 6to4|guide/net-practice#ipv6-6to4]]
319: He also helped with the SGML to XML transition.
320: * Jason R. Fink
321: * Daniel de Kok, audio and linux chapters fixes.
322: * Reinoud Koornstra, CVS chapter and rebuilding `/dev` in the Misc chapter.
323: * Brian A. Seklecki [lavalamp@burghcom.com](mailto:lavalamp@burghcom.com), who
324: contributed the CCD Chapter.
325: * Guillain Seuillot
326: * Martti Kuparinen, RAIDframe documentation.
327: * David Magda
328:
329: ### Current acknowledgements
330:
331: This document is currently maintained by the NetBSD www team. Thanks to their
332: efforts, the document is kept up to date and available online at all times. In
333: addition, special thanks go to (in alphabetical order):
334:
335: * Hubert Feyrer, for getting the guide up to speed for NetBSD 2.0, and for
336: making numerous improvements to all chapters.
337: * Jason R. Fink, for maintaining this document and integrating changes.
338: * Andreas Hallman, for his information in
339: [[Tunneling 6to4 through an IPFilter firewall|guide/net-practice#chap-net-practice-ipv6-6to4-ipf]]
340: * Joel Knight for the
341: [[Introduction to the Common Address Redundancy Protocol (CARP)|guide/carp]].
342: See below for for the accompanying license.
343: * Daniel de Kok, for constant contributions of new chapters, maintenance of
344: existing chapters and his translation work.
345: * Hiroki Sato, for allowing us to build PDF and PS versions of this document.
346: * Jan Schaumann, for maintenance work and `www/htdocs` management.
347: * Lubomir Sedlacik, for some details on using CGD for swap in
348: [[Suggestions and Warnings|guide/cgd#suggestions]]
349: * Dag-Erling Smørgrav, for the article on
350: [[Pluggable Authentication Modules (PAM)|guide/pam]]. See below for the
351: accompanying license.
352: * Florian Stöhr, for
353: [[Example: encrypted CDs/DVDs|guide/cgd#cryptocds]]
354:
355:
356: ### Licenses
357:
358: #### Federico Lupi's original license of this guide
359:
360: Redistribution and use in source and binary forms, with or without modification,
361: are permitted provided that the following conditions are met:
362:
363: 1. Redistributions of source code must retain the above copyright notice, this
364: list of conditions and the following disclaimer.
365: 2. Redistributions in binary form must reproduce the above copyright notice,
366: this list of conditions and the following disclaimer in the documentation
367: and/or other materials provided with the distribution.
368: 3. All advertising materials mentioning features or use of this software must
369: display the following acknowledgement: This product includes software developed
370: by Federico Lupi for the NetBSD Project.
371: 4. The name of the author may not be used to endorse or promote products
372: derived from this software without specific prior written permission.
373:
374: THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
375: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
376: MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
377: SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
378: EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
379: OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
380: INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
381: CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
382: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
383: OF SUCH DAMAGE.
384:
385: #### The NetBSD Developers
386:
387: Copyright © 1999, 2000, 2001, 2002 Federico Lupi
388:
389: Copyright © 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The NetBSD Foundation
390:
391: All brand and product names used in this guide are or may be trademarks or registered trademarks of their respective owners.
392:
393: 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.mdwn CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [NetBSD Developer Wiki] / wikisrc / guide