summaryrefslogtreecommitdiff
path: root/doc/api/gphoto2-api.sgml
blob: 15ac32e0f34343235be882c27cce78a95bd7f984 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!entity hash "#">
<!entity gphoto2-filesys        SYSTEM "sgml/gphoto2-filesys.sgml">
<!entity gphoto2-file		SYSTEM "sgml/gphoto2-file.sgml">
<!entity gphoto2-widget         SYSTEM "sgml/gphoto2-widget.sgml">
<!entity gphoto2-camera         SYSTEM "sgml/gphoto2-camera.sgml">
<!entity gphoto2-result         SYSTEM "sgml/gphoto2-result.sgml">
<!entity gphoto2-library        SYSTEM "sgml/gphoto2-library.sgml">
<!entity gphoto2-list           SYSTEM "sgml/gphoto2-list.sgml">
<!entity gphoto2-abilities-list SYSTEM "sgml/gphoto2-abilities-list.sgml">
]>

<book id="index">
  <bookinfo>
    <title>GPhoto2 API Reference Manual</title>
    <authorgroup>
      <author>
        <firstname>Lutz</firstname>
        <surname>Müller</surname>
        <affiliation>
          <address>
	    <email>lutz@users.sf.net</email>
          </address>
        </affiliation>
      </author>
    </authorgroup>

    <copyright>
      <year>2000</year>
      <holder>The Free Software Foundation</holder>
    </copyright>

    <legalnotice>
      <para>
        Permission is granted to copy, distribute and/or modify this
        document under the terms of the <citetitle>GNU Free
        Documentation License</citetitle>, Version 1.1 or any later
        version published by the Free Software Foundation with no
        Invariant Sections, no Front-Cover Texts, and no Back-Cover
        Texts. You may obtain a copy of the <citetitle>GNU Free
        Documentation License</citetitle> from the Free Software
        Foundation by visiting <ulink type="http"
        url="http://www.fsf.org">their Web site</ulink> or by writing
        to:

        <address>
          The Free Software Foundation, Inc.,
          <street>59 Temple Place</street> - Suite 330,
          <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
          <country>USA</country>
        </address>
      </para>
    </legalnotice>
  </bookinfo>

  <chapter id="gphoto2"
    <title>GPhoto2 Overview</title>
    <para>
GPhoto2 is a library for accessing a wide range of digital cameras.
It works on many UNIX-like platforms. GPhoto2 is released under the GNU
Library General Public License (GNU LGPL), which allows for flexible 
licensing of client applications. GPhoto2 is written entirely in C and 
has an object-oriented architecture that makes it easy for other 
programming languages to access GPhoto2.
    </para>
    <para>
GPhoto2 doesn't depend on any external library. However, it is 
strongly recommended that you have some library installed that handles
locking of serial ports. GPhoto2 currently supports
<variablelist>
  <varlistentry>
    <term>baudboy.h</term>
    <listitem>
      <para>BaudBoy, a library used on Red-Hat systems,</para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>ttylock.h</term>
    <listitem>
      <para>
        ttyLock, a header file provided by several locking libraries
	(i.e. BaudBoy and LockDev), and
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term>lockdev.h</term>
    <listitem>
      <para>
        LockDev, a library available for several systems including
	Red-Hat and Debian
      </para>
    </listitem>
  </varlistentry>
</variablelist>
 
    </para>
  </chapter>

  <chapter id="gphoto2base" role="no-toc">
    <title>GPhoto2 Utilities</title>
    <para>
      GPhoto2's core provides some utility functions and general 
      datatypes. In contrast to the
      objects presented later, they
      cannot be classified as objects, and are therefore presented upfront.
    </para>

&gphoto2-result;
&gphoto2-library;

  </chapter>

  <chapter id="gphoto2objects" role="no-toc">
    <title>GPhoto2 Objects</title>
    <para>
      In order to simplify programming with GPhoto2, an object oriented
      approach has been used. The different objects are presented in
      the following sections.
    </para>

&gphoto2-camera;
&gphoto2-filesys;
&gphoto2-widget;
&gphoto2-list;
&gphoto2-abilities-list;
&gphoto2-file;

  </chapter>

  <appendix id="license">
    <title>License</title>
        
    <para>
      This library is free software; you can redistribute it and/or
      modify it under the terms of the <citetitle>GNU Library General
      Public License</citetitle> as published by the Free Software
      Foundation; either version 2 of the License, or (at your option)
      any later version.
    </para>

    <para>
      This library is distributed in the hope that it will be useful,
      but WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      <citetitle>GNU Library General Public License</citetitle> for
      more details.
    </para>

    <para>
      You may obtain a copy of the <citetitle>GNU Library General
      Public License</citetitle> from the Free Software Foundation by
      visiting <ulink type="http" url="http://www.fsf.org">their Web
      site</ulink> or by writing to:

      <address>
        Free Software Foundation, Inc.
        <street>59 Temple Place</street> - Suite 330
        <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
        <country>USA</country>
      </address>
    </para>
  </appendix>

</book>