Annotation of wikisrc/guide/index.mdwn, revision 1.8

1.1       jdf         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: 
1.3       jdf        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]]
1.1       jdf        41: 
                     42: ***II. System installation and related issues***
                     43: 
                     44: 
                     45: ***III. System configuration, administration and tuning***
                     46: 
1.2       jdf        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]]
1.3       jdf        60:    * [[5.10. Secure Shell ssh(1)]]
1.2       jdf        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:  * [[7. The rc.d System|guide/rc]]
                     69:    * [[7.1. Basics]]
                     70:    * [[7.2. The rc.d scripts]]
                     71:    * [[7.3. Order/dependencies of start determined by rcorder]]
                     72:    * [[7.4. rc.d scripts of additional services]]
                     73:    * [[7.5. Additional Reading]]
                     74:  * [[9. X|guide/x]]
                     75:    * [[9.1. What is X?]]
                     76:    * [[9.2. Configuration]]
                     77:    * [[9.3. The mouse]]
                     78:    * [[9.4. The keyboard]]
                     79:    * [[9.5. The monitor]]
                     80:    * [[9.6. The video card]]
                     81:    * [[9.7. Starting X]]
                     82:    * [[9.8. Customizing X]]
                     83:    * [[9.9. Other window managers or desktop environments]]
                     84:    * [[9.10. Graphical login with xdm]]
                     85:  * [[11. Audio|guide/audio]]
                     86:    * [[11.1. Basic hardware elements]]
                     87:    * [[11.2. Supported audio cards]]
                     88:    * [[11.3. BIOS settings]]
                     89:    * [[11.4. Configuring the audio device]]
                     90:    * [[11.5. Multiple audio devices]]
                     91:    * [[11.6. Configuring the kernel audio devices]]
                     92:    * [[11.7. Advanced commands]]
1.4       jdf        93:  * [[19. Tuning NetBSD|guide/tuning]]
                     94:    * [[19.1. Introduction]]
                     95:    * [[19.2. Tuning Considerations]]
                     96:    * [[19.3. Visual Monitoring Tools]]
                     97:    * [[19.4. Monitoring Tools]]
                     98:    * [[19.5. Network Tools]]
                     99:    * [[19.6. Accounting]]
                    100:    * [[19.7. Kernel Profiling]]
                    101:    * [[19.8. System Tuning]]
                    102:    * [[19.9. Kernel Tuning]]
1.2       jdf       103:  * [[20. NetBSD Veriexec subsystem|guide/veriexec]]
                    104:    * [[20.1. How it works]]
                    105:    * [[20.2. Signatures file]]
                    106:    * [[20.3. Strict levels]]
                    107:    * [[20.4. Veriexec and layered file systems]]
                    108:    * [[20.5. Kernel configuration]]
1.7       jdf       109:  * [[22. Miscellaneous operations|guide/misc]]
                    110:    * [[22.1. Installing the boot manager]]
                    111:    * [[22.2. Deleting the disklabel]]
                    112:    * [[22.3. Speaker]]
                    113:    * [[22.4. Forgot root password?]]
                    114:    * [[22.5. Password file is busy?]]
                    115:    * [[22.6. Adding a new hard disk]]
                    116:    * [[22.7. How to rebuild the devices in /dev]]
1.1       jdf       117: 
                    118: ***IV. Networking and related issues***
                    119: 
1.5       jdf       120:  * [[25. The Internet Super Server inetd|guide/inetd]]
                    121:    * [[25.1. Overview]]
                    122:    * [[25.2. What is inetd?]]
                    123:    * [[25.3. Configuring inetd - `/etc/inetd.conf`]]
                    124:    * [[25.4. Services - `/etc/services`]]
                    125:    * [[25.5. Protocols - `/etc/protocols`]]
                    126:    * [[25.6. Remote Procedure Calls (RPC) - `/etc/rpc`]]
                    127:    * [[25.7. Allowing and denying hosts - `/etc/hosts.{allow,deny}`]]
                    128:    * [[25.8. Adding a Service]]
                    129:    * [[25.9. When to use or not to use inetd]]
                    130:    * [[25.10. Other Resources]]
1.6       jdf       131:  * [[28. Introduction to the Common Address Redundancy Protocol (CARP)|guide/carp]]
                    132:    * [[28.1. CARP Operation]]
                    133:    * [[28.2. Configuring CARP]]
                    134:    * [[28.3. Enabling CARP Support]]
                    135:    * [[28.4. CARP Example]]
                    136:    * [[28.5. Advanced CARP configuration]]
                    137:    * [[28.6. Forcing Failover of the Master]]
                    138:    * [[28.7. License]]
1.1       jdf       139: 
                    140: ***V. Building the system***
                    141: 
1.8     ! jdf       142:  * [[30. Obtaining the sources|guide/fetch]]
        !           143:    * [[30.1. Preparing directories]]
        !           144:    * [[30.2. Terminology]]
        !           145:    * [[30.3. Downloading tarballs]]
        !           146:    * [[30.4. Fetching by CVS]]
        !           147:    * [[30.5. Sources on CD (ISO)]]
1.2       jdf       148:  * [[32. Compiling the kernel|guide/kernel]]
                    149:    * [[32.1. Requirements and procedure]]
                    150:    * [[32.2. Installing the kernel sources]]
                    151:    * [[32.3. Creating the kernel configuration file]]
                    152:    * [[32.4. Building the kernel manually]]
                    153:    * [[32.5. Building the kernel using `build.sh`]]
                    154:    * [[32.6. Installing the new kernel]]
                    155:    * [[32.7. If something went wrong]]
                    156:  * [[33. Updating an existing system from sources|guide/updating]]
                    157:    * [[33.1. Manual build and update procedure]]
                    158:    * [[33.2. Using sysinst]]
                    159:    * [[33.3. Using sysbuild and sysupgrade]]
                    160:    * [[33.4. More details about the updating of configuration and startup files]]
1.1       jdf       161: 
                    162: ## Guide history
                    163: 
                    164: This guide was born as a collection of sparse notes that Federico Lupi, the
                    165: original author of the NetBSD Guide, wrote mostly for himself. When he realized
                    166: that they could be useful to other NetBSD users he started collecting them and
                    167: created the first version of the guide using the groff formatter. In order to
                    168: "easily" get a wider variety of output formats (e.g. HTML and
                    169: PostScript/PDF), he made the "mistake" of moving to SGML/DocBook, which
1.6       jdf       170: was the format of the sources. Maintainership was picked up by the NetBSD
1.1       jdf       171: project and its developers later, and the format was changed to XML/DocBook
                    172: later due to better tools and slightly more knowhow on customisations.
                    173: 
1.7       jdf       174: In 2012/2013, the guide was converted in a Google Code-In task by Mingzhe Wang
                    175: (wmzhere) to Markdown. In early 2013, it was integrated to the NetBSD wiki,
                    176: along with removing old chapters, restricting numbering schemes and some
                    177: reformulations.
                    178: 
                    179: You can still get the
                    180: [old version of the Guide](http://netbsd.org/docs/guide), which is not
                    181: maintained anymore.
1.1       jdf       182: 
                    183: ## Bibliography
                    184: 
                    185: * [AeleenFrisch] Aeleen Frisch. Copyright © 1991. O'Reilly & Associates. *Essential System Administration*.
                    186: * [CraigHunt] Craig Hunt. Copyright © 1993. O'Reilly & Associates. *TCP/IP Network Administration*.
                    187: * [RFC1034] P. V. Mockapetris. Copyright © 1987. *RFC 1034: Domain names - concepts and facilities*.
                    188: * [RFC1035] P. V. Mockapetris. Copyright © 1987. *RFC 1035: Domain names - implementation and specification*.
                    189: * [RFC1055] J. L. Romkey. Copyright © 1988. *RFC 1055: Nonstandard for transmission of IP datagrams over serial lines: SLIP*.
                    190: * [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*.
                    191: * [RFC1332] G. McGregor. Copyright © 1992. *RFC 1332: The PPP Internet Protocol Control Protocol (IPCP)*.
                    192: * [RFC1933] R. Gilligan and E. Nordmark. Copyright © 1996. *RFC 1933: Transition Mechanisms for IPv6 Hosts and Routers*.
                    193: * [RFC2004] C. Perkins. Copyright © 1996. *RFC 2003: IP Encapsulation within IP*.
                    194: * [RFC2401] S. Kent and R. Atkinson. Copyright © 1998. *RFC 2401: Security Architecture for the Internet Protocol*.
                    195: * [RFC2411] R. Thayer, N. Doraswamy, and R. Glenn. Copyright © 1998. *RFC 2411: IP Security Document Roadmap*.
                    196: * [RFC2461] T. Narten, E. Nordmark, and W. Simpson. Copyright © 1998. *RFC 2461: Neighbor Discovery for IP Version 6 (IPv6)*.
                    197: * [RFC2529] B. Carpenter and C. Jung. Copyright © 1999. *RFC 2529: Transmission of IPv6 over IPv4 Domains without Explicit Tunnels*.
                    198: * [RFC3024] G. Montenegro. Copyright © 2001. *RFC 3024: Reverse Tunneling for Mobile IP*.
                    199: * [RFC3027] M. Holdrege and P. Srisuresh. Copyright © 2001. *RFC 3027: Protocol Complications with the IP Network Address Translator*.
                    200: * [RFC3056] B. Carpenter and K. Moore. Copyright © 2001. *RFC 3056: Connection of IPv6 Domains via IPv4 Clouds*.
                    201: 
                    202: ## Acknowledgements
                    203: 
                    204: The NetBSD Guide was originally written by Federico Lupi who managed the
                    205: sources, coordinated updates, and merged all contributions on his own. Since
                    206: then, it has been updated and maintained by the NetBSD www team. The Guide has
                    207: progressed thanks to the contributions of many people who have volunteered their
                    208: time and effort, supplied material and sent in suggestions and corrections.
                    209: 
                    210: ### Original acknowledgements
                    211: 
                    212: Federico's original credits are:
                    213: 
                    214: * Paulo Aukar
                    215: * Grant Beattie, converted to XML DocBook.
                    216: * Manolo De Santis, Audio Chapter
                    217: * Eric Delcamp, Boot Floppies
                    218: * Hubert Feyrer, who contributed
                    219: [[Introduction to TCP/IP Networking|guide/net-intro]] including Next
                    220: generation Internet protocol - IPv6 and the section
                    221: [[IPv6 Connectivity & Transition via 6to4|guide/net-practice#ipv6-6to4]]
                    222: He also helped with the SGML to XML transition.
                    223: * Jason R. Fink
                    224: * Daniel de Kok, audio and linux chapters fixes.
                    225: * Reinoud Koornstra, CVS chapter and rebuilding `/dev` in the Misc chapter.
                    226: * Brian A. Seklecki [lavalamp@burghcom.com](mailto:lavalamp@burghcom.com), who
                    227: contributed the CCD Chapter.
                    228: * Guillain Seuillot
                    229: * Martti Kuparinen, RAIDframe documentation.
                    230: * David Magda
                    231: 
                    232: ### Current acknowledgements
                    233: 
                    234: This document is currently maintained by the NetBSD www team. Thanks to their
                    235: efforts, the document is kept up to date and available online at all times. In
                    236: addition, special thanks go to (in alphabetical order):
                    237: 
                    238: * Hubert Feyrer, for getting the guide up to speed for NetBSD 2.0, and for
                    239: making numerous improvements to all chapters.
                    240: * Jason R. Fink, for maintaining this document and integrating changes.
                    241: * Andreas Hallman, for his information in
                    242: [[Tunneling 6to4 through an IPFilter firewall|guide/net-practice#chap-net-practice-ipv6-6to4-ipf]]
                    243: * Joel Knight for the
                    244: [[Introduction to the Common Address Redundancy Protocol (CARP)|guide/carp]].
                    245: See below for for the accompanying license.
                    246: * Daniel de Kok, for constant contributions of new chapters, maintenance of
                    247: existing chapters and his translation work.
                    248: * Hiroki Sato, for allowing us to build PDF and PS versions of this document.
                    249: * Jan Schaumann, for maintenance work and `www/htdocs` management.
                    250: * Lubomir Sedlacik, for some details on using CGD for swap in
                    251: [[Suggestions and Warnings|guide/cgd#suggestions]]
                    252: * Dag-Erling Smrgrav, for the article on
                    253: [[Pluggable Authentication Modules (PAM)|guide/pam]]. See below for the
                    254: accompanying license.
                    255: * Florian Sthr, for
                    256: [[Example: encrypted CDs/DVDs|guide/cgd#cryptocds]]
                    257: 
                    258: 
                    259: ### Licenses
                    260: 
                    261: #### Federico Lupi's original license of this guide
                    262: 
                    263: Redistribution and use in source and binary forms, with or without modification,
                    264: are permitted provided that the following conditions are met:
                    265: 
                    266: 1. Redistributions of source code must retain the above copyright notice, this
                    267: list of conditions and the following disclaimer.
                    268: 2. Redistributions in binary form must reproduce the above copyright notice,
                    269: this list of conditions and the following disclaimer in the documentation
                    270: and/or other materials provided with the distribution.
                    271: 3. All advertising materials mentioning features or use of this software must
                    272: display the following acknowledgement: This product includes software developed
                    273: by Federico Lupi for the NetBSD Project.
                    274: 4. The name of the author may not be used to endorse or promote products
                    275: derived from this software without specific prior written permission.
                    276: 
                    277: THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
                    278: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
                    279: MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
                    280: SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
                    281: EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
                    282: OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
                    283: INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
                    284: CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
                    285: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
                    286: OF SUCH DAMAGE.
                    287: 
                    288: #### Networks Associates Technology's license on the PAM article
                    289: 
                    290: Copyright (c) 2001-2003 Networks Associates Technology, Inc.
                    291: All rights reserved.
                    292: This software was developed for the FreeBSD Project by ThinkSec AS and
                    293: Network Associates Laboratories, the Security Research Division of
                    294: Network Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
                    295: ("CBOSS"), as part of the DARPA CHATS research program.
                    296: Redistribution and use in source and binary forms, with or without
                    297: modification, are permitted provided that the following conditions
                    298: are met:
                    299: 1. Redistributions of source code must retain the above copyright
                    300: notice, this list of conditions and the following disclaimer.
                    301: 2. Redistributions in binary form must reproduce the above copyright
                    302: notice, this list of conditions and the following disclaimer in the
                    303: documentation and/or other materials provided with the distribution.
                    304: 3. The name of the author may not be used to endorse or promote
                    305: products derived from this software without specific prior written
                    306: permission.
                    307: THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
                    308: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                    309: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                    310: ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
                    311: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                    312: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                    313: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                    314: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                    315: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                    316: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                    317: SUCH DAMAGE.
                    318: 
                    319: #### Joel Knight's license on the CARP article
                    320: 
                    321: Copyright (c) 2005 Joel Knight <enabled@myrealbox.com>
                    322: Permission to use, copy, modify, and distribute this documentation for
                    323: any purpose with or without fee is hereby granted, provided that the
                    324: above copyright notice and this permission notice appear in all copies.
                    325: THE DOCUMENTATION IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
                    326: WARRANTIES WITH REGARD TO THIS DOCUMENTATION INCLUDING ALL IMPLIED
                    327: WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
                    328: AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
                    329: DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
                    330: PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
                    331: TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
                    332: PERFORMANCE OF THIS DOCUMENTATION
                    333: 
                    334: #### The NetBSD Developers
                    335: 
                    336: Copyright  1999, 2000, 2001, 2002 Federico Lupi
                    337: 
1.6       jdf       338: Copyright  2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The NetBSD Foundation
1.1       jdf       339: 
                    340: All brand and product names used in this guide are or may be trademarks or registered trademarks of their respective owners.
                    341: 
                    342: NetBSD is a registered trademark of The NetBSD Foundation, Inc.

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