Document the camera types for which maker notes are supported
[platform/upstream/libexif.git] / README
1                                     libexif
2                                     -------
3
4 DESCRIPTION
5 -----------
6
7 libexif is a library for parsing, editing, and saving EXIF data. It is
8 intended to replace lots of redundant implementations in command-line
9 utilities and programs with GUIs.
10
11
12 FEATURES
13 --------
14
15 libexif supports parsing, editing and saving of EXIF data. In addition, it
16 has gettext support. All EXIF tags described in EXIF standard 2.1
17 are supported.  Many maker notes from Canon, Casio, Fuji, Nikon, Olympus,
18 Pentax and Sanyo cameras are also supported.
19
20
21 REQUIREMENTS
22 ------------
23
24 libexif is written in plain C and does not require any additional library.
25 GNU gettext will be used for language translation, if available.
26
27
28 LIMITATIONS
29 -----------
30
31 libexif can only handle some maker notes, and even those not very well. More
32 work needs to be done. Note that libmnote has been merged with libexif - it
33 is no longer needed.
34
35
36 USAGE
37 -----
38
39 We have started documenting the libexif API using doxygen and are making
40 the results available at http://libexif.sourceforge.net/api/
41
42 Until someone writes some better documentation however, you need to refer
43 to the header files.
44
45 The short test-program test/test-mem illustrates how to create valid
46 EXIF data from scratch, how to save EXIF data and how to load EXIF data 
47 from data in memory. Don't hesitate to contact us 
48 (<libexif-devel@lists.sourceforge.net>) if you've got any questions
49 on how to use libexif.
50
51 To link to libexif into your own package, we recommend using the
52 pkgconfig utility (cf. http://pkg-config.freedesktop.org/wiki/). For
53 your convenience, libexif both provides libexif-uninstalled.pc and
54 installs libexif.pc.
55
56
57 FRONTENDS
58 ---------
59
60 Right now, I know of the following frontends to libexif:
61  - exif:     A small command-line utility to show EXIF information in JPEG
62              files (http://www.sourceforge.net/projects/libexif).
63  - gexif:    A GTK+ frontend for editing EXIF data
64              (http://www.sourceforge.net/projects/libexif).
65  - gphoto2:  A command-line frontend to libgphoto2, a library to access a 
66              wide range of digital cameras (http://www.gphoto.org).
67  - gtkam:    A GTK+ frontend to libgphoto2 (http://www.topfrose.de).
68  - thirdeye: Digital photos organizer and driver for eComStation
69              (http://ecomstation.ru/thirdeye).
70  - digicam:  
71 If you would like to migrate your program to use libexif or add EXIF support
72 to it, don't hesitate to contact the authors.
73
74
75 LIBRARIES
76 ---------
77
78 I know of the following libraries that use or have been inspired by libexif:
79  - pel: PHP-Code (http://pel.sourceforge.net)
80
81
82 BUILDING
83 --------
84
85 It really depends on your environment what to do in order to get libexif
86 to build. Building from the source tar ball usually involves the commands:
87
88   ./configure
89   make
90   sudo make install
91
92 When building from source out of CVS, something like the following will be
93 necessary:
94
95   gettextize
96   mv po/Makevars.template po/Makevars
97   aclocal -I auto-m4 -I m4m
98   autoheader
99   libtoolize --force
100   automake --add-missing
101   autoconf
102   ./configure
103   make
104
105 Besides the standard arguments, configure takes several specific to libexif:
106
107   --disable-docs          To disable producing any documentation
108   --enable-internal-docs  Build internal code docs if Doxygen available
109   --enable-ship-binaries  To include Windows DLLs in 'make dist'
110
111 Certain specialized applications can reduce the size of the libexif
112 binary by setting one or both of the following macros in the CPPFLAGS
113 environment variable at configure time.  Each one removes certain kinds of
114 text strings from the binary.  Applications which need to access specific,
115 known EXIF tags and know in advance the meaning of their data have no need
116 of those strings and can save considerable space by eliminating them.
117
118  -DNO_VERBOSE_TAG_STRINGS Names and descriptions of EXIF tags, & debug messages
119  -DNO_VERBOSE_TAG_DATA    Names of enumerated tag data contents
120
121
122 INTERNATIONALIZATION
123 --------------------
124
125 All translations for libexif, except ru and en_CA, are coordinated by
126 the Translation Project at http://translationproject.org/.  This means
127 that ALL changes to the .po files (except those two exceptions) MUST be
128 made through the TP web site, or they will be eventually overwritten
129 and lost.  If you are interested in translating libexif into a new
130 language, simply join TP and start!  A translation disclaimer is NOT
131 required for libexif; by making a translation, you agree implicitly to
132 provide it under the same license terms as the rest of libexif (LGPL).
133 When a new version of libexif is available for translation, a libexif
134 maintainer will contact the Translation Project and all interested TP
135 members will be automatically notified.
136
137
138 AUTHORS
139 -------
140
141 libexif has originally been written by Curtis Galloway
142 <curtisg@users.sourceforge.net>. Because of the original design not
143 supporting editing and saving, Lutz Mueller <lutz@users.sourceforge.net>
144 rewrote libexif from scratch.
145
146
147 LINKS
148 -----
149
150 Some links you might want to check out if you are interested in further
151 information about EXIF.
152
153  - http://drewnoakes.com/code/exif: metadata extraction framework in Java
154  - http://www.pima.net: This is where I got the exif standard from. Site is
155    down as of 2002/12/31.
156  - http://www.jeida.or.jp: Can't remember any more. Site is down as of
157    2002/12/31.
158  - http://www.exif.org: information about the EXIF standard.
159  - http://www.sno.phy.queensu.ca/~phil/exiftool/TagNames/index.html: Looks
160    like libexif in Perl. Seems to support a lot of MakerNotes.