Documentation/DocBook/wanbook.tmpl

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
   4
   5 <book id="WANGuide">
   6  <bookinfo>
   7   <title>Synchronous PPP and Cisco HDLC Programming Guide</title>
   8
   9   <authorgroup>
  10    <author>
  11     <firstname>Alan</firstname>
  12     <surname>Cox</surname>
  13     <affiliation>
  14      <address>
  15       <email>alan@redhat.com</email>
  16      </address>
  17     </affiliation>
  18    </author>
  19   </authorgroup>
  20
  21   <copyright>
  22    <year>2000</year>
  23    <holder>Alan Cox</holder>
  24   </copyright>
  25
  26   <legalnotice>
  27    <para>
  28      This documentation is free software; you can redistribute
  29      it and/or modify it under the terms of the GNU General Public
  30      License as published by the Free Software Foundation; either
  31      version 2 of the License, or (at your option) any later
  32      version.
  33    </para>
  34
  35    <para>
  36      This program is distributed in the hope that it will be
  37      useful, but WITHOUT ANY WARRANTY; without even the implied
  38      warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  39      See the GNU General Public License for more details.
  40    </para>
  41
  42    <para>
  43      You should have received a copy of the GNU General Public
  44      License along with this program; if not, write to the Free
  45      Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  46      MA 02111-1307 USA
  47    </para>
  48
  49    <para>
  50      For more details see the file COPYING in the source
  51      distribution of Linux.
  52    </para>
  53   </legalnotice>
  54  </bookinfo>
  55
  56 <toc></toc>
  57
  58   <chapter id="intro">
  59       <title>Introduction</title>
  60   <para>
  61         The syncppp drivers in Linux provide a fairly complete
  62         implementation of Cisco HDLC and a minimal implementation of
  63         PPP. The longer term goal is to switch the PPP layer to the
  64         generic PPP interface that is new in Linux 2.3.x. The API should
  65         remain unchanged when this is done, but support will then be
  66         available for IPX, compression and other PPP features
  67   </para>
  68   </chapter>
  69   <chapter id="bugs">
  70      <title>Known Bugs And Assumptions</title>
  71   <para>
  72   <variablelist>
  73     <varlistentry><term>PPP is minimal</term>
  74     <listitem>
  75     <para>
  76         The current PPP implementation is very basic, although sufficient
  77         for most wan usages.
  78     </para>
  79     </listitem></varlistentry>
  80
  81     <varlistentry><term>Cisco HDLC Quirks</term>
  82     <listitem>
  83     <para>
  84         Currently we do not end all packets with the correct Cisco multicast
  85         or unicast flags. Nothing appears to mind too much but this should
  86         be corrected.
  87     </para>
  88     </listitem></varlistentry>
  89   </variablelist>
  90
  91   </para>
  92   </chapter>
  93
  94   <chapter id="pubfunctions">
  95      <title>Public Functions Provided</title>
  96 !Edrivers/net/wan/syncppp.c
  97   </chapter>
  98
  99 </book>