improve USAGE section
[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.
18
19
20 REQUIREMENTS
21 ------------
22
23 libexif is written in plain C and does not require any additional library.
24
25
26 LIMITATIONS
27 -----------
28
29 libexif can only handle some maker notes, and even those not very well. More
30 work needs to be done. Note that libmnote has been merged with libexif - it
31 is no longer needed.
32
33
34 USAGE
35 -----
36
37 We have started documenting the libexif API using doxygen and are making
38 the results available at http://libexif.sourceforge.net/api/
39
40 Until someone writes some better documentation however, you need to refer
41 to the header files.
42
43 The short test-program test/test-mem illustrates how to create valid
44 EXIF data from scratch, how to save EXIF data and how to load EXIF data 
45 from data in memory. Don't hesitate to contact us 
46 (<libexif-devel@lists.sourceforge.net>) if you've got any questions
47 on how to use libexif.
48
49 To link to libexif into your own package, we recommend using the
50 pkgconfig utility (cf. http://pkg-config.freedesktop.org/wiki/). For
51 your convenience, libexif both provides libexif-uninstalled.pc and
52 installs libexif.pc.
53
54
55 FRONTENDS
56 ---------
57
58 Right now, I know of the following frontends to libexif:
59  - exif:     A small command-line utility to show EXIF information in JPEG
60              files (http://www.sourceforge.net/projects/libexif).
61  - gexif:    A GTK+ frontend for editing EXIF data
62              (http://www.sourceforge.net/projects/libexif).
63  - gphoto2:  A command-line frontend to libgphoto2, a library to access a 
64              wide range of digital cameras (http://www.gphoto.org).
65  - gtkam:    A GTK+ frontend to libgphoto2 (http://www.topfrose.de).
66  - thirdeye: Digital photos organizer and driver for eComStation
67              (http://ecomstation.ru/thirdeye).
68  - digicam:  
69 If you would like to migrate your program to use libexif or add EXIF support
70 to it, don't hesitate to contact the authors.
71
72
73 LIBRARIES
74 ---------
75
76 I know of the following libraries that use or have been inspired by libexif:
77  - pel: PHP-Code (http://pel.sourceforge.net)
78
79
80 AUTHORS
81 -------
82
83 libexif has originally been written by Curtis Galloway
84 <curtisg@users.sourceforge.net>. Because of the original design not
85 supporting editing and saving, Lutz Müller <lutz@users.sourceforge.net>
86 rewrote libexif from scratch.
87
88
89 LINKS
90 -----
91
92 Some links you might want to check out if you are interested in further
93 information about EXIF.
94
95  - http://drewnoakes.com/code/exif: metadata extraction framework in Java
96  - http://www.pima.net: This is where I got the exif standard from. Site is
97    down as of 2002/12/31.
98  - http://www.jeida.or.jp: Can't remember any more. Site is down as of
99    2002/12/31.
100  - http://www.exif.org: information about the EXIF standard.
101  - http://www.sno.phy.queensu.ca/~phil/exiftool/TagNames/index.html: Looks
102    like libexif in Perl. Seems to support a lot of MakerNotes.