Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 29 Jun 1998 01:08:53 -0700 (PDT)
From:      Nik Clayton <nik@FreeBSD.ORG>
To:        cvs-committers@FreeBSD.ORG, cvs-all@FreeBSD.ORG, cvs-doc@FreeBSD.ORG
Subject:   cvs commit: doc/sgml freebsd.dtd
Message-ID:  <199806290808.BAA25191@freefall.freebsd.org>

next in thread | raw e-mail | index | archive | help
nik         1998/06/29 01:08:53 PDT

  Added files:
    sgml                 freebsd.dtd 
  Log:
  DTD for the FreeBSD Documentation Project.
  
  Extends DocBook v3.0, with (currently) the following additions.
  
   1. <hostid>, <username>, <devicename>, <makevar>, and <maketarget> have
      been added. Sample uses would be be.
  
        <para>By convention, the the local machine can always be referred
  	to as <hostid>localhost</hostid>, with the IP address
  	<hostid role="ipaddr">127.0.0.1</hostid>.</para>
  
        <para>The most powerful account on the system is
  	<username>root</username>, able to leap tall buildings in a single
  	bound.</para>
  
        <para>Some devices have an entry in <filename>/dev</filename>. For
  	example, <filename>/dev/cuaa0</filename> corresponds to
  	<devicename>sio0</devicename>. Other devices, such as
  	<devicename>ed0</devicename> do not have entries in
  	<filename>/dev</filename>.
  
        <para>To rebuild the system, use the <maketarget>world</maketarget>
  	target. If you do not want to build profiled libraries then ensure
  	that <makevar>NOPROFILE</makevar> is set.</para>
  
   2. <FAQList> has been added as a new list type, with its own listitem.
  
      Use like so;
  
        <FAQList>
  	<FAQListItem>
  	  <FAQQuestion>
  	    <para>I have bad blocks on my hard drive!</para>
  
  	    <!-- Nothing restricting a question to one paragraph -->
            </FAQQuestion>
  
  	  <FAQAnswer>
  	    <para>With SCSI drives, the drive should be capable&hellip;</para>
  
  	    <para>&hellip;</para>
            </FAQAnswer>
  	</FAQListItem>
        </FAQList>
  
      Long winded, but comprehensive, and in keeping with the rest of DocBook.
  
  As I convert the handbook from LinuxDoc to DocBook I'm working on an
  extensive markup guide for the project, where constructs like these will be
  fully documented.



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?199806290808.BAA25191>