kernel/linux/Documentation/DocBook/wanbook.tmpl

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