doc/comedilib.sgml

   1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
   2 <!ENTITY intro SYSTEM "intro.sgml">
   3 <!ENTITY install SYSTEM "install.sgml">
   4 <!ENTITY tutorial SYSTEM "tutorial.sgml">
   5 <!ENTITY other SYSTEM "other.sgml">
   6 <!ENTITY driverwriting SYSTEM "driverwriting.sgml">
   7 <!ENTITY drivers SYSTEM "drivers.sgml">
   8 <!ENTITY reference SYSTEM "reference.sgml">
   9 <!ENTITY funcref SYSTEM "funcref.sgml">
  10 <!ENTITY calibration-funcref SYSTEM "calibration_funcref.sgml">
  11 <!ENTITY command-funcref SYSTEM "command_funcref.sgml">
  12 <!ENTITY dio-funcref SYSTEM "dio_funcref.sgml">
  13 <!ENTITY deprecated-funcref SYSTEM "deprecated_funcref.sgml">
  14 <!ENTITY error-funcref SYSTEM "error_funcref.sgml">
  15 <!ENTITY extensions-funcref SYSTEM "extensions_funcref.sgml">
  16 <!ENTITY glossary SYSTEM "glossary.sgml">
  17 <!ENTITY comedi "<acronym>Comedi</acronym>">
  18 <!ENTITY uuml "ue">
  19 <!ENTITY hellip "...">
  20 ]>
  21
  22 <article>
  23 <articleinfo>
  24   <title>
  25     Comedi
  26   </title>
  27   <subtitle>
  28 The <emphasis>Control and Measurement Device Interface</emphasis>
  29 handbook
  30   </subtitle>
  31   <author>
  32     <firstname>David</firstname>
  33     <surname>Schleef</surname>
  34     <affiliation>
  35       <address>ds@schleef.org</address>
  36     </affiliation>
  37   </author>
  38   <author>
  39     <firstname>Frank</firstname>
  40     <surname>Hess</surname>
  41     <affiliation>
  42       <address>fmhess@users.sourceforge.net</address>
  43     </affiliation>
  44   </author>
  45   <author>
  46     <firstname>Herman</firstname>
  47     <surname>Bruyninckx</surname>
  48     <affiliation>
  49       <address>Herman.Bruyninckx@mech.kuleuven.ac.be</address>
  50     </affiliation>
  51   </author>
  52  <copyright>
  53   <year>1998-2003</year>
  54   <holder>David Schleef</holder>
  55  </copyright>
  56  <copyright>
  57   <year>2001-2003, 2005, 2008</year>
  58   <holder>Frank Mori Hess</holder>
  59  </copyright>
  60  <copyright>
  61   <year>2002-2003</year>
  62   <holder>Herman Bruyninckx</holder>
  63  </copyright>
  64
  65  <abstract>
  66  <para>
  67  <emphasis role="strong">Abstract</emphasis>
  68  </para>
  69  <para>
  70 &comedi; is a free software project to interface
  71 <emphasis>digital acquisition</emphasis> (DAQ) cards. It is the
  72 combination of three complementary software items: (i) a generic,
  73 device-independent API, (ii) a collection of Linux kernel modules that
  74 implement this API for a wide range of cards, and (iii) a Linux user
  75 space library with a developer-oriented programming interface to
  76 configure and use the cards.
  77  </para>
  78  </abstract>
  79
  80  <legalnotice>
  81   <para>
  82 This document is part of Comedilib.  In the context of this
  83 document, the term "source code" as defined by the license is
  84 interpreted as the SGML source.
  85
  86 COMEDILIB - Linux Control and Measurement Device Interface Library
  87 Copyright (C) 1997-2003 David A. Schleef &lt;ds@schleef.org&gt;
  88
  89 This library is free software; you can redistribute it and/or
  90 modify it under the terms of the GNU Lesser General Public
  91 License as published by the Free Software Foundation, version 2.1
  92 of the License.
  93
  94 This library is distributed in the hope that it will be useful,
  95 but WITHOUT ANY WARRANTY; without even the implied warranty of
  96 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  97 Lesser General Public License for more details.
  98
  99 You should have received a copy of the GNU Lesser General Public
 100 License along with this library; if not, write to the Free Software
 101 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
 102 USA.
 103  </para>
 104  </legalnotice>
 105
 106 </articleinfo>
 107
 108 &intro;
 109
 110 &install;
 111
 112 &tutorial;
 113
 114 &other;
 115
 116 &driverwriting;
 117
 118 <section id="lowleveldrivers">
 119   <title>
 120     Low-level drivers
 121   </title>
 122
 123 &drivers;
 124
 125 </section>
 126
 127 <section id="comedireference">
 128   <title>
 129     &comedi; Reference
 130   </title>
 131   <para>
 132     Reference for
 133   <link linkend="constantsmacros">constants and macros</link>,
 134   <link linkend="datatypesstructures">data types and structures</link>,
 135   and <link linkend="functionreference">functions</link>.
 136   </para>
 137
 138   &reference;
 139
 140 <!-- </section> -->
 141
 142         <section id="functionreference">
 143                 <title>Functions</title>
 144                 <section>
 145                         <title>Core Functions</title>
 146                         &funcref;
 147                 </section>
 148                 <section>
 149                         <title>Asyncronous Commands</title>
 150                         &command-funcref;
 151                 </section>
 152                 <section>
 153                         <title>Calibration</title>
 154                         &calibration-funcref;
 155                 </section>
 156                 <section>
 157                         <title>Digital I/O</title>
 158                         &dio-funcref;
 159                 </section>
 160                 <section>
 161                         <title>Error Reporting</title>
 162                         &error-funcref;
 163                 </section>
 164                 <section>
 165                         <title>Extensions</title>
 166                         &extensions-funcref;
 167                 </section>
 168                 <section>
 169                         <title>Deprecated</title>
 170                         &deprecated-funcref;
 171                 </section>
 172         </section>
 173 </section>
 174
 175   &glossary;
 176
 177 </article>
 178