<!--
     The FreeBSD Documentation Project

     $FreeBSD$
-->

<!DOCTYPE BOOK PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN" [
<!ENTITY % bookinfo PUBLIC "-//FreeBSD//ENTITIES DocBook BookInfo Entities//EN">
%bookinfo;
<!ENTITY % man PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN">
%man;
<!ENTITY % chapters SYSTEM "chapters.ent"> %chapters;
<!ENTITY % authors PUBLIC "-//FreeBSD//ENTITIES DocBook Author Entities//EN"> %authors
<!ENTITY % mailing-lists PUBLIC "-//FreeBSD//ENTITIES DocBook Mailing List Entities//EN"> %mailing-lists;
<!ENTITY % chap.index "IGNORE">
]>

<book>
  <bookinfo>
    <title>FreeBSD Developers' Handbook</title>
    
    <corpauthor>The FreeBSD Documentation Project</corpauthor>
    
    <pubdate>August 2000</pubdate>
    
    <copyright>
      <year>2000</year>
      <year>2001</year>
      <year>2002</year>
      <holder>The FreeBSD Documentation Project</holder>
    </copyright>

    &bookinfo.legalnotice;
    
    <abstract>
      <para>Welcome to the Developers' Handbook.  This manual is a
	<emphasis>work in progress</emphasis> and is the work of many
	individuals.  Many sections do not yet exist and some of those
	that do exist need to be updated.  If you are interested in
	helping with this project, send email to the &a.doc;.</para>

      <para>The latest version of this document is always available
        from the <ulink URL="../../../../index.html">FreeBSD World
        Wide Web server</ulink>.  It may also be downloaded in a
        variety of formats and compression options from the <ulink
        url="ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/">FreeBSD FTP
        server</ulink> or one of the numerous <ulink
        url="../handbook/mirrors-ftp.html">mirror
        sites</ulink>.</para>
    </abstract>
  </bookinfo>

  <part id="Basics">
    <title>Basics</title>

    &chap.introduction;  
    &chap.tools;
    &chap.secure;
    &chap.l10n;
    &chap.policies;

  </part>

  <part id="ipc">
    <title>Interprocess Communication</title>
    
    <chapter id="signals">
      <title>* Signals</title>

      <para>Signals, pipes, semaphores, message queues, shared memory,
        ports, sockets, doors</para>

    </chapter>

    &chap.sockets;
    &chap.ipv6;

  </part>

  <part id="kernel">
    <title>Kernel</title>

    <chapter id="kernelhistory">
      <title>* History of the Unix Kernel</title>

      <para>Some history of the Unix/BSD kernel, system calls, how 
        processes work, blocking, scheduling, threads (kernel),
        context switching, signals, interrupts, modules, etc.</para>

      <para></para>
    </chapter>

    &chap.locking;
    &chap.kobj;
    &chap.jail;
    &chap.sysinit;
    &chap.vm;
    &chap.dma;
    &chap.kerneldebug;

    <chapter id="ufs">
      <title>* UFS</title>

      <para>UFS, FFS, Ext2FS, JFS, inodes, buffer cache, labeling,
        locking, metadata, soft-updates, LFS, portalfs, procfs,
        vnodes, memory sharing, memory objects, TLBs, caching</para>

    </chapter>

    <chapter id="afs">
      <title>* AFS</title>

      <para>AFS, NFS, SANs, etc.</para>

    </chapter>

    <chapter id="syscons">
      <title>* Syscons</title>

      <para>Syscons, tty, PCVT, serial console, screen savers,
        etc.</para>

    </chapter>

    <chapter id="compatibility">
      <title>* Compatibility Layers</title>

      <sect1 id="linux">
        <title>* Linux</title>

        <para>Linux, SVR4, etc.</para>
      </sect1>

    </chapter>
  </part>
  
  <part id="devicedrivers">
    <title>Device Drivers</title>

    &chap.driverbasics;
    &chap.isa;
    &chap.pci;
    &chap.scsi;
    &chap.usb;

    <chapter id="newbus">
      <title>* NewBus</title>

      <para>This chapter will talk about the FreeBSD NewBus
      architecture.</para>
    </chapter>

    &chap.snd;

  </part>
  
  <part id="architectures">
    <title>Architectures</title>

    &chap.x86;

    <chapter id="alpha">
      <title>* Alpha</title>

      <para>Talk about the architectural specifics of
      FreeBSD/alpha.</para>

      <para>Explanation of alignment errors, how to fix, how to
      ignore.</para>

      <para>Example assembly language code for FreeBSD/alpha.</para>
    </chapter>

    <chapter id="ia64">
      <title>* IA-64</title>

      <para>Talk about the architectural specifics of
      FreeBSD/ia64.</para>

    </chapter>
  </part>
  
  <part id="appendices">
    <title>Appendices</title>

      <bibliography>

      <biblioentry id="COD" xreflabel="1">
        <authorgroup>
          <author>
            <firstname>Dave</firstname>
            <othername role="MI">A</othername>
            <surname>Patterson</surname>
          </author>
          <author>
            <firstname>John</firstname>
            <othername role="MI">L</othername>
            <surname>Hennessy</surname>
          </author>
        </authorgroup>
        <copyright><year>1998</year><holder>Morgan Kaufmann Publishers,
        Inc.</holder></copyright>
        <isbn>1-55860-428-6</isbn>
        <publisher>
          <publishername>Morgan Kaufmann Publishers, Inc.</publishername>
        </publisher>
        <title>Computer Organization and Design</title>
        <subtitle>The Hardware / Software Interface</subtitle>
        <pagenums>1-2</pagenums>
      </biblioentry>

      <biblioentry xreflabel="2">
        <authorgroup>
          <author>
            <firstname>W.</firstname>
            <othername role="Middle">Richard</othername>
            <surname>Stevens</surname>
          </author>
        </authorgroup>
        <copyright><year>1993</year><holder>Addison Wesley Longman,
        Inc.</holder></copyright>
        <isbn>0-201-56317-7</isbn>
        <publisher>
          <publishername>Addison Wesley Longman, Inc.</publishername>
        </publisher>
        <title>Advanced Programming in the Unix Environment</title>
        <pagenums>1-2</pagenums>
      </biblioentry>

      <biblioentry xreflabel="3">
        <authorgroup>
          <author>
            <firstname>Marshall</firstname>
            <othername role="Middle">Kirk</othername>
            <surname>McKusick</surname>
          </author>
          <author>
            <firstname>Keith</firstname>
            <surname>Bostic</surname>
          </author>
          <author>
            <firstname>Michael</firstname>
            <othername role="MI">J</othername>
            <surname>Karels</surname>
          </author>
          <author>
            <firstname>John</firstname>
            <othername role="MI">S</othername>
            <surname>Quarterman</surname>
          </author>
        </authorgroup>
        <copyright><year>1996</year><holder>Addison-Wesley Publishing Company,
        Inc.</holder></copyright>
        <isbn>0-201-54979-4</isbn>
        <publisher>
          <publishername>Addison-Wesley Publishing Company, Inc.</publishername>
        </publisher>
        <title>The Design and Implementation of the 4.4 BSD Operating System</title>
        <pagenums>1-2</pagenums>
      </biblioentry>

      <biblioentry id="Phrack" xreflabel="4">
        <authorgroup>
          <author>
            <firstname>Aleph</firstname>
            <surname>One</surname>
          </author>
        </authorgroup>
        <title>Phrack 49; "Smashing the Stack for Fun and Profit"</title>
      </biblioentry>

      <biblioentry id="StackGuard" xreflabel="5">
        <authorgroup>
          <author>
            <firstname>Chrispin</firstname>
            <surname>Cowan</surname>
          </author>
          <author>
            <firstname>Calton</firstname>
            <surname>Pu</surname>
          </author>
          <author>
            <firstname>Dave</firstname>
            <surname>Maier</surname>
          </author>
        </authorgroup>
        <title>StackGuard; Automatic Adaptive Detection and Prevention of
        Buffer-Overflow Attacks</title>
      </biblioentry>

      <biblioentry id="OpenBSD" xreflabel="6">
        <authorgroup>
	  <author>
	    <firstname>Todd</firstname>
	    <surname>Miller</surname>
	  </author>
	  <author>
	    <firstname>Theo</firstname>
	    <surname>de Raadt</surname>
	  </author>
	</authorgroup>
	<title>strlcpy and strlcat -- consistent, safe string copy and
	concatenation.</title>
      </biblioentry>

      </bibliography>

      <![ %chap.index;                    [ &chap.index;                ]]>
  </part>

</book>
