doc/api/gphoto2-api.sgml

   1 <!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
   2 <!entity hash "#">
   3 <!entity gphoto2-filesys        SYSTEM "sgml/gphoto2-filesys.sgml">
   4 <!entity gphoto2-file           SYSTEM "sgml/gphoto2-file.sgml">
   5 <!entity gphoto2-widget         SYSTEM "sgml/gphoto2-widget.sgml">
   6 <!entity gphoto2-camera         SYSTEM "sgml/gphoto2-camera.sgml">
   7 <!entity gphoto2-result         SYSTEM "sgml/gphoto2-result.sgml">
   8 <!entity gphoto2-library        SYSTEM "sgml/gphoto2-library.sgml">
   9 <!entity gphoto2-list           SYSTEM "sgml/gphoto2-list.sgml">
  10 <!entity gphoto2-abilities-list SYSTEM "sgml/gphoto2-abilities-list.sgml">
  11 ]>
  12
  13 <book id="index">
  14   <bookinfo>
  15     <title>GPhoto2 API Reference Manual</title>
  16     <authorgroup>
  17       <author>
  18         <firstname>Lutz</firstname>
  19         <surname>Müller</surname>
  20         <affiliation>
  21           <address>
  22             <email>lutz@users.sf.net</email>
  23           </address>
  24         </affiliation>
  25       </author>
  26     </authorgroup>
  27
  28     <copyright>
  29       <year>2000</year>
  30       <holder>The Free Software Foundation</holder>
  31     </copyright>
  32
  33     <legalnotice>
  34       <para>
  35         Permission is granted to copy, distribute and/or modify this
  36         document under the terms of the <citetitle>GNU Free
  37         Documentation License</citetitle>, Version 1.1 or any later
  38         version published by the Free Software Foundation with no
  39         Invariant Sections, no Front-Cover Texts, and no Back-Cover
  40         Texts. You may obtain a copy of the <citetitle>GNU Free
  41         Documentation License</citetitle> from the Free Software
  42         Foundation by visiting <ulink type="http"
  43         url="http://www.fsf.org">their Web site</ulink> or by writing
  44         to:
  45
  46         <address>
  47           The Free Software Foundation, Inc.,
  48           <street>59 Temple Place</street> - Suite 330,
  49           <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
  50           <country>USA</country>
  51         </address>
  52       </para>
  53     </legalnotice>
  54   </bookinfo>
  55
  56   <chapter id="gphoto2"
  57     <title>GPhoto2 Overview</title>
  58     <para>
  59 GPhoto2 is a library for accessing a wide range of digital cameras.
  60 It works on many UNIX-like platforms. GPhoto2 is released under the GNU
  61 Library General Public License (GNU LGPL), which allows for flexible
  62 licensing of client applications. GPhoto2 is written entirely in C and
  63 has an object-oriented architecture that makes it easy for other
  64 programming languages to access GPhoto2.
  65     </para>
  66     <para>
  67 GPhoto2 doesn't depend on any external library. However, it is
  68 strongly recommended that you have some library installed that handles
  69 locking of serial ports. GPhoto2 currently supports
  70 <variablelist>
  71   <varlistentry>
  72     <term>baudboy.h</term>
  73     <listitem>
  74       <para>BaudBoy, a library used on Red-Hat systems,</para>
  75     </listitem>
  76   </varlistentry>
  77   <varlistentry>
  78     <term>ttylock.h</term>
  79     <listitem>
  80       <para>
  81         ttyLock, a header file provided by several locking libraries
  82         (i.e. BaudBoy and LockDev), and
  83       </para>
  84     </listitem>
  85   </varlistentry>
  86   <varlistentry>
  87     <term>lockdev.h</term>
  88     <listitem>
  89       <para>
  90         LockDev, a library available for several systems including
  91         Red-Hat and Debian
  92       </para>
  93     </listitem>
  94   </varlistentry>
  95 </variablelist>
  96
  97     </para>
  98   </chapter>
  99
 100   <chapter id="gphoto2base" role="no-toc">
 101     <title>GPhoto2 Utilities</title>
 102     <para>
 103       GPhoto2's core provides some utility functions and general
 104       datatypes. In contrast to the
 105       objects presented later, they
 106       cannot be classified as objects, and are therefore presented upfront.
 107     </para>
 108
 109 &gphoto2-result;
 110 &gphoto2-library;
 111
 112   </chapter>
 113
 114   <chapter id="gphoto2objects" role="no-toc">
 115     <title>GPhoto2 Objects</title>
 116     <para>
 117       In order to simplify programming with GPhoto2, an object oriented
 118       approach has been used. The different objects are presented in
 119       the following sections.
 120     </para>
 121
 122 &gphoto2-camera;
 123 &gphoto2-filesys;
 124 &gphoto2-widget;
 125 &gphoto2-list;
 126 &gphoto2-abilities-list;
 127 &gphoto2-file;
 128
 129   </chapter>
 130
 131   <appendix id="license">
 132     <title>License</title>
 133
 134     <para>
 135       This library is free software; you can redistribute it and/or
 136       modify it under the terms of the <citetitle>GNU Library General
 137       Public License</citetitle> as published by the Free Software
 138       Foundation; either version 2 of the License, or (at your option)
 139       any later version.
 140     </para>
 141
 142     <para>
 143       This library is distributed in the hope that it will be useful,
 144       but WITHOUT ANY WARRANTY; without even the implied warranty of
 145       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 146       <citetitle>GNU Library General Public License</citetitle> for
 147       more details.
 148     </para>
 149
 150     <para>
 151       You may obtain a copy of the <citetitle>GNU Library General
 152       Public License</citetitle> from the Free Software Foundation by
 153       visiting <ulink type="http" url="http://www.fsf.org">their Web
 154       site</ulink> or by writing to:
 155
 156       <address>
 157         Free Software Foundation, Inc.
 158         <street>59 Temple Place</street> - Suite 330
 159         <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
 160         <country>USA</country>
 161       </address>
 162     </para>
 163   </appendix>
 164
 165 </book>