File:  [NetBSD Developer Wiki] / wikisrc / guide / index.mdwn
Revision 1.13: download - view: text, annotated - select for diffs
Wed Mar 6 23:38:39 2013 UTC (7 years, 4 months ago) by jdf
Branches: MAIN
CVS tags: HEAD
 * Cosmetics for ccd
 * Moving cgd from the guide to the wiki

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

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