[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] r23668 - in Extractor-docs/WWW: . manual manual/html_node
|
From: |
gnunet |
|
Subject: |
[GNUnet-SVN] r23668 - in Extractor-docs/WWW: . manual manual/html_node |
|
Date: |
Thu, 6 Sep 2012 13:11:18 +0200 |
Author: grothoff
Date: 2012-09-06 13:11:18 +0200 (Thu, 06 Sep 2012)
New Revision: 23668
Added:
Extractor-docs/WWW/man1/
Extractor-docs/WWW/man3/
Extractor-docs/WWW/manual/extractor.dvi.gz
Extractor-docs/WWW/manual/extractor.html.gz
Extractor-docs/WWW/manual/extractor.html_node.tar.gz
Extractor-docs/WWW/manual/extractor.info.tar.gz
Extractor-docs/WWW/manual/extractor.ps.gz
Extractor-docs/WWW/manual/extractor.texi.tar.gz
Extractor-docs/WWW/manual/extractor.txt
Extractor-docs/WWW/manual/extractor.txt.gz
Extractor-docs/WWW/manual/html_node/
Extractor-docs/WWW/manual/html_node/Concept-Index.html
Extractor-docs/WWW/manual/html_node/Copying.html
Extractor-docs/WWW/manual/html_node/Existing-Plugins.html
Extractor-docs/WWW/manual/html_node/Extracting-meta-data.html
Extractor-docs/WWW/manual/html_node/Extracting.html
Extractor-docs/WWW/manual/html_node/Function-and-Data-Index.html
Extractor-docs/WWW/manual/html_node/Generalities.html
Extractor-docs/WWW/manual/html_node/Internal-utility-functions.html
Extractor-docs/WWW/manual/html_node/Introduction.html
Extractor-docs/WWW/manual/html_node/Language-bindings.html
Extractor-docs/WWW/manual/html_node/Meta-data-printing.html
Extractor-docs/WWW/manual/html_node/Meta-formats.html
Extractor-docs/WWW/manual/html_node/Meta-types.html
Extractor-docs/WWW/manual/html_node/Plugin-management.html
Extractor-docs/WWW/manual/html_node/Preparation.html
Extractor-docs/WWW/manual/html_node/Reporting-bugs.html
Extractor-docs/WWW/manual/html_node/Type-Index.html
Extractor-docs/WWW/manual/html_node/Utility-Constants.html
Extractor-docs/WWW/manual/html_node/Utility-functions.html
Extractor-docs/WWW/manual/html_node/Writing-new-Plugins.html
Extractor-docs/WWW/manual/html_node/index.html
Extractor-docs/WWW/manual/index.html
Extractor-docs/WWW/run-gendocs.sh
Removed:
Extractor-docs/WWW/man/
Modified:
Extractor-docs/WWW/index.html
Extractor-docs/WWW/manual/extractor.html
Extractor-docs/WWW/manual/extractor.pdf
Log:
updating docs
Modified: Extractor-docs/WWW/index.html
===================================================================
--- Extractor-docs/WWW/index.html 2012-09-06 10:54:46 UTC (rev 23667)
+++ Extractor-docs/WWW/index.html 2012-09-06 11:11:18 UTC (rev 23668)
@@ -145,9 +145,9 @@
by running
<em><a href="manual/extractor.html">info libextractor</a></em>
or
-<em><a href="man/libextractor.html">man libextractor</a></em>,
+<em><a href="man3/libextractor.3.html">man libextractor</a></em>,
or
-<em><a href="man/extract.html">man extract</a></em>,
+<em><a href="man1/extract.1.html">man extract</a></em>,
or by looking at
<em>/usr/share/doc/libextractor/</em>,
<em>/usr/local/doc/libextractor/</em>,
Added: Extractor-docs/WWW/manual/extractor.dvi.gz
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/extractor.dvi.gz
===================================================================
--- Extractor-docs/WWW/manual/extractor.dvi.gz 2012-09-06 10:54:46 UTC (rev
23667)
+++ Extractor-docs/WWW/manual/extractor.dvi.gz 2012-09-06 11:11:18 UTC (rev
23668)
Property changes on: Extractor-docs/WWW/manual/extractor.dvi.gz
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Modified: Extractor-docs/WWW/manual/extractor.html
===================================================================
--- Extractor-docs/WWW/manual/extractor.html 2012-09-06 10:54:46 UTC (rev
23667)
+++ Extractor-docs/WWW/manual/extractor.html 2012-09-06 11:11:18 UTC (rev
23668)
@@ -1,310 +1,319 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html401/loose.dtd";>
-<html>
-<!-- This manual is for GNU libextractor
-(version 0.6.0, 13 January 2010).
+<html lang="en">
+<head>
+<title>The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
GNU libextractor is a GNU package.
-Copyright C 2007, 2010 Christian Grothoff
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.3
-or any later version published by the Free Software Foundation;
-with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
-Texts. A copy of the license is included in the section entitled "GNU
-Free Documentation License".
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<h1 class="settitle">The GNU libextractor Reference Manual</h1>
+ <div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+<li><a href="#toc_Top">The GNU libextractor Reference Manual</a></li>
+<li><a href="#toc_Introduction">1 Introduction</a></li>
+<li><a href="#toc_Preparation">2 Preparation</a></li>
+<li><a href="#toc_Generalities">3 Generalities</a></li>
+<li><a href="#toc_Extracting-meta-data">4 Extracting meta data</a></li>
+<li><a href="#toc_Language-bindings">5 Language bindings</a></li>
+<li><a href="#toc_Utility-functions">6 Utility functions</a></li>
+<li><a href="#toc_Existing-Plugins">7 Existing Plugins</a></li>
+<li><a href="#toc_Writing-new-Plugins">8 Writing new Plugins</a></li>
+<li><a href="#toc_Internal-utility-functions">9 Internal utility
functions</a></li>
+<li><a href="#toc_Reporting-bugs">10 Reporting bugs</a></li>
+<li><a href="#toc_Copying">Appendix A GNU GENERAL PUBLIC LICENSE</a></li>
+<li><a href="#toc_Concept-Index">Concept Index</a></li>
+<li><a href="#toc_Function-and-Data-Index">Function and Data Index</a></li>
+<li><a href="#toc_Type-Index">Type Index</a></li>
+</ul>
+</div>
- -->
-<!-- Created on January 13, 2010 by texi2html 1.82
-texi2html was written by:
- Lionel Cons <address@hidden> (original author)
- Karl Berry <address@hidden>
- Olaf Bachmann <address@hidden>
- and many others.
-Maintained by: Many creative people.
-Send bugs and suggestions to <address@hidden>
--->
-<head>
-<title>The GNU libextractor Reference Manual</title>
-<meta name="description" content="The GNU libextractor Reference Manual">
-<meta name="keywords" content="The GNU libextractor Reference Manual">
-<meta name="resource-type" content="document">
-<meta name="distribution" content="global">
-<meta name="Generator" content="texi2html 1.82">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<style type="text/css">
-<!--
-a.summary-letter {text-decoration: none}
-blockquote.smallquotation {font-size: smaller}
-pre.display {font-family: serif}
-pre.format {font-family: serif}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: serif; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: serif; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.roman {font-family:serif; font-weight:normal;}
-span.sansserif {font-family:sans-serif; font-weight:normal;}
-ul.toc {list-style: none}
--->
-</style>
+ <div class="contents">
+<h2>Table of Contents</h2>
+<ul>
+<li><a name="toc_Top" href="#Top">The GNU libextractor Reference Manual</a>
+<li><a name="toc_Introduction" href="#Introduction">1 Introduction</a>
+<li><a name="toc_Preparation" href="#Preparation">2 Preparation</a>
+<ul>
+<li><a href="#Preparation">2.1 Installation on GNU/Linux</a>
+<li><a href="#Preparation">2.2 Installation on FreeBSD</a>
+<li><a href="#Preparation">2.3 Installation on OpenBSD</a>
+<li><a href="#Preparation">2.4 Installation on NetBSD</a>
+<li><a href="#Preparation">2.5 Installation using MinGW</a>
+<li><a href="#Preparation">2.6 Installation on OS X</a>
+<ul>
+<li><a href="#Preparation">2.6.1 Installing and uninstalling the framework</a>
+<li><a href="#Preparation">2.6.2 Using the framework</a>
+<li><a href="#Preparation">2.6.3 Example for using the framework</a>
+<li><a href="#Preparation">2.6.4 Example for using the dynamic library</a>
+</li></ul>
+<li><a href="#Preparation">2.7 Note to package maintainers</a>
+</li></ul>
+<li><a name="toc_Generalities" href="#Generalities">3 Generalities</a>
+<ul>
+<li><a href="#Generalities">3.1 Introduction to the “extract”
command</a>
+<li><a href="#Generalities">3.2 Common usage examples for
“extract”</a>
+<li><a href="#Generalities">3.3 Introduction to the libextractor library</a>
+</li></ul>
+<li><a name="toc_Extracting-meta-data" href="#Extracting-meta-data">4
Extracting meta data</a>
+<ul>
+<li><a href="#Plugin-management">4.1 Plugin management</a>
+<li><a href="#Meta-types">4.2 Meta types</a>
+<li><a href="#Meta-formats">4.3 Meta formats</a>
+<li><a href="#Extracting">4.4 Extracting</a>
+</li></ul>
+<li><a name="toc_Language-bindings" href="#Language-bindings">5 Language
bindings</a>
+<ul>
+<li><a href="#Language-bindings">5.1 Java</a>
+<li><a href="#Language-bindings">5.2 Mono</a>
+<li><a href="#Language-bindings">5.3 Perl</a>
+<li><a href="#Language-bindings">5.4 Python</a>
+<li><a href="#Language-bindings">5.5 PHP</a>
+<li><a href="#Language-bindings">5.6 Ruby</a>
+</li></ul>
+<li><a name="toc_Utility-functions" href="#Utility-functions">6 Utility
functions</a>
+<ul>
+<li><a href="#Utility-Constants">6.1 Utility Constants</a>
+<li><a href="#Meta-data-printing">6.2 Meta data printing</a>
+</li></ul>
+<li><a name="toc_Existing-Plugins" href="#Existing-Plugins">7 Existing
Plugins</a>
+<li><a name="toc_Writing-new-Plugins" href="#Writing-new-Plugins">8 Writing
new Plugins</a>
+<ul>
+<li><a href="#Writing-new-Plugins">8.1 Example for a minimal extract method</a>
+</li></ul>
+<li><a name="toc_Internal-utility-functions"
href="#Internal-utility-functions">9 Internal utility functions</a>
+<li><a name="toc_Reporting-bugs" href="#Reporting-bugs">10 Reporting bugs</a>
+<li><a name="toc_Copying" href="#Copying">Appendix A GNU GENERAL PUBLIC
LICENSE</a>
+<ul>
+<ul>
+<li><a href="#Copying">A.0.1 Preamble</a>
+</li></ul>
+<li><a href="#Copying">How to Apply These Terms to Your New Programs</a>
+</li></ul>
+<li><a name="toc_Concept-Index" href="#Concept-Index">Concept Index</a>
+<li><a name="toc_Function-and-Data-Index"
href="#Function-and-Data-Index">Function and Data Index</a>
+<li><a name="toc_Type-Index" href="#Type-Index">Type Index</a>
+</li></ul>
+</div>
-</head>
+<div class="node">
+<a name="Top"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Introduction">Introduction</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
-<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
+</div>
-<a name="Top"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="The-GNU-libextractor-Reference-Manual"></a>
-<h1 class="settitle">The GNU libextractor Reference Manual</h1>
+<h2 class="unnumbered">The GNU libextractor Reference Manual</h2>
+
<p>This manual is for GNU libextractor
-(version 0.6.0, 13 January 2010).
-</p>
-<p>GNU libextractor is a GNU package.
-</p>
+(version 1.0.0, 5 September 2012).
-<p>Copyright © 2007, 2010 Christian Grothoff
-</p>
-<blockquote><p>Permission is granted to copy, distribute and/or modify this
document
+ <p>GNU libextractor is a GNU package.
+
+ <p>Copyright © 2007, 2010, 2012 Christian Grothoff
+
+ <blockquote>
+Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
-Texts. A copy of the license is included in the section entitled "GNU
-Free Documentation License".
-</p></blockquote>
+Texts. A copy of the license is included in the section entitled "GNU
+Free Documentation License".
+</blockquote>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Introduction">1.
Introduction</a></td><td> </td><td align="left" valign="top">
What is <acronym>GNU libextractor</acronym>.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Preparation">2.
Preparation</a></td><td> </td><td align="left" valign="top">
What you should do before using the library.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Generalities">3.
Generalities</a></td><td> </td><td align="left" valign="top">
General library functions and data types.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Extracting-meta-data">4.
Extracting meta data</a></td><td> </td><td align="left"
valign="top"> How to use <acronym>GNU libextractor</acronym> to obtain
meta data.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Language-bindings">5. Language
bindings</a></td><td> </td><td align="left" valign="top">
How to use <acronym>GNU libextractor</acronym> from languages other than C.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Utility-functions">6. Utility
functions</a></td><td> </td><td align="left" valign="top">
Utility functions of <acronym>GNU libextractor</acronym>.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Existing-Plugins">7. Existing
Plugins</a></td><td> </td><td align="left" valign="top">
What plugins are available.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Writing-new-Plugins">8. Writing
new Plugins</a></td><td> </td><td align="left" valign="top">
How to write new plugins for <acronym>GNU libextractor</acronym>.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Internal-utility-functions">9.
Internal utility functions</a></td><td> </td><td align="left"
valign="top"> Utility functions of <acronym>GNU libextractor</acronym> for
writing plugins.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Reporting-bugs">10. Reporting
bugs</a></td><td> </td><td align="left" valign="top">
How to report bugs or request new features.
-</td></tr>
-<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
-Appendices
+<ul class="menu">
+<li><a accesskey="1" href="#Introduction">Introduction</a>:
What is <acronym>GNU libextractor</acronym>.
+<li><a accesskey="2" href="#Preparation">Preparation</a>:
What you should do before using the library.
+<li><a accesskey="3" href="#Generalities">Generalities</a>:
General library functions and data types.
+<li><a accesskey="4" href="#Extracting-meta-data">Extracting meta data</a>:
How to use <acronym>GNU libextractor</acronym> to obtain meta data.
+<li><a accesskey="5" href="#Language-bindings">Language bindings</a>:
How to use <acronym>GNU libextractor</acronym> from languages other than C.
+<li><a accesskey="6" href="#Utility-functions">Utility functions</a>:
Utility functions of <acronym>GNU libextractor</acronym>.
+<li><a accesskey="7" href="#Existing-Plugins">Existing Plugins</a>:
What plugins are available.
+<li><a accesskey="8" href="#Writing-new-Plugins">Writing new Plugins</a>:
How to write new plugins for <acronym>GNU libextractor</acronym>.
+<li><a accesskey="9" href="#Internal-utility-functions">Internal utility
functions</a>: Utility functions of <acronym>GNU libextractor</acronym> for
writing plugins.
+<li><a href="#Reporting-bugs">Reporting bugs</a>: How to report
bugs or request new features.
-</pre></th></tr><tr><td align="left" valign="top"><a href="#Copying">A. GNU
GENERAL PUBLIC LICENSE</a></td><td> </td><td align="left"
valign="top"> The GNU General Public License says how you
+</li></ul>
+<p>Appendices
+
+</p>
+<ul class="menu">
+<li><a href="#Copying">Copying</a>: The GNU General
Public License says how you
can copy and share some parts of <acronym>GNU
libextractor</acronym>.
-</td></tr>
-<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
-Indices
-</pre></th></tr><tr><td align="left" valign="top"><a
href="#Concept-Index">Concept Index</a></td><td> </td><td
align="left" valign="top"> Index of concepts and programs.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Function-and-Data-Index">Function
and Data Index</a></td><td> </td><td align="left" valign="top">
Index of functions, variables and data types.
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Type-Index">Type
Index</a></td><td> </td><td align="left" valign="top">
Index of data types.
-</td></tr>
-<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
-</pre></th></tr></table>
+</li></ul>
+<p>Indices
+</p>
+<ul class="menu">
+<li><a href="#Concept-Index">Concept Index</a>: Index of
concepts and programs.
+<li><a href="#Function-and-Data-Index">Function and Data Index</a>: Index
of functions, variables and data types.
+<li><a href="#Type-Index">Type Index</a>: Index of data
types.
+ </ul>
-<hr size="1">
+<!-- ********************************************************** -->
+<!-- ******************* Introduction *********************** -->
+<!-- ********************************************************** -->
+<div class="node">
<a name="Introduction"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Top" title="Previous section
in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Beginning of this
chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Next chapter">
>> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Introduction-1"></a>
-<h1 class="chapter">1. Introduction</h1>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Preparation">Preparation</a>,
+Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-<a name="index-error-handling"></a>
-<p><acronym>GNU libextractor</acronym> is GNU’s library for extracting
meta data from
+</div>
+
+<h2 class="chapter">1 Introduction</h2>
+
+<p><a name="index-error-handling-1"></a><acronym>GNU libextractor</acronym> is
GNU's library for extracting meta data from
files. Meta data includes format information (such as mime type,
image dimensions, color depth, recording frequency), content
descriptions (such as document title or document description) and
-copyright information (such as license, author and contributors).
+copyright information (such as license, author and contributors).
Meta data extraction is an inherently uncertain business — a parse
error can be a corrupt file, an incompatibility in the file format
version, an entirely different file format or a bug in the parser. As
a result of this uncertainty, <acronym>GNU libextractor</acronym> deliberately
avoids to ever report any errors. Unexpected file contents simply
-result in less or possibly no meta data being extracted.
-</p>
-<a name="index-plugin"></a>
-<p><acronym>GNU libextractor</acronym> uses plugins to handle various file
formats.
+result in less or possibly no meta data being extracted.
+
+ <p><a name="index-plugin-2"></a><acronym>GNU libextractor</acronym> uses
plugins to handle various file formats.
Technically a plugin can support multiple file formats; however, most
plugins only support one particular format. By default,
<acronym>GNU libextractor</acronym> will use all plugins that are available
and found
in the plugin installation directory. Applications can
request the use of only specific plugins or the exclusion of
certain plugins.
-</p>
-<p><acronym>GNU libextractor</acronym> is distributed with the
<code>extract</code>
-command<a name="DOCF1" href="#FOOT1">(1)</a> which is a command-line tool for
extracting
-meta data. <code>extract</code> is given a list of filenames and
-prints the resulting meta data to the console. The <code>extract</code>
+
+ <p><acronym>GNU libextractor</acronym> is distributed with the <samp><span
class="command">extract</span></samp>
+command<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a> which is a
command-line tool for extracting
+meta data. <samp><span class="command">extract</span></samp> is given a list
of filenames and
+prints the resulting meta data to the console. The <samp><span
class="command">extract</span></samp>
source code also serves as an advanced example for how to use
-<acronym>GNU libextractor</acronym>.
-</p>
-<p>This manual focuses on providing documentation for writing software
+<acronym>GNU libextractor</acronym>.
+
+ <p>This manual focuses on providing documentation for writing software
with <acronym>GNU libextractor</acronym>. The only relevant parts for
end-users
are the chapter on compiling and installing <acronym>GNU libextractor</acronym>
-(See section <a href="#Preparation">Preparation</a>.). Also, the chapter on
existing plugins maybe of
-interest (See section <a href="#Existing-Plugins">Existing Plugins</a>.).
Additional documentation for
-end-users can be find in the man page on <code>extract</code> (using
+(See <a href="#Preparation">Preparation</a>.). Also, the chapter on existing
plugins maybe of
+interest (See <a href="#Existing-Plugins">Existing Plugins</a>.). Additional
documentation for
+end-users can be find in the man page on <samp><span
class="command">extract</span></samp> (using
<tt>man extract</tt>).
-</p>
-<a name="index-license"></a>
-<p><acronym>GNU libextractor</acronym> is licensed under the GNU General
Public License. The
-developers have frequently received requests to license GNU
-libextractor under alternative terms. However, <acronym>GNU
libextractor</acronym>
-borrows plenty of GPL-licensed code from various other projects.
-Hence we cannot change the license (even if we wanted to).<a name="DOCF2"
href="#FOOT2">(2)</a>
-</p>
-<hr size="6">
+
+ <p><a name="index-license-3"></a><acronym>GNU libextractor</acronym> is
licensed under the GNU General Public License,
+specifically, since version 0.7, <acronym>GNU libextractor</acronym> is
licensed under GPLv3
+<em>or any later version</em>.
+
+<div class="node">
<a name="Preparation"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Introduction" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation-on-GNU_002fLinux"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Introduction" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Preparation-1"></a>
-<h1 class="chapter">2. Preparation</h1>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Generalities">Generalities</a>,
+Previous: <a rel="previous" accesskey="p"
href="#Introduction">Introduction</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+</div>
+
+<h2 class="chapter">2 Preparation</h2>
+
<p>This chapter first describes the general build instructions that
should apply to all systems. Specific instructions for known problems
for particular platforms are then described in individual sections
afterwards.
-</p>
-<p>Compiling <acronym>GNU libextractor</acronym> follows the standard GNU
autotools build process
-using <code>configure</code> and <code>make</code>. For details on the GNU
-autotools build process, read the ‘<tt>INSTALL</tt>’ file and query
-<tt>./configure --help</tt> for additional options.
-</p>
-<p><acronym>GNU libextractor</acronym> has various dependencies, some of which
are optional.
+
+ <p>Compiling <acronym>GNU libextractor</acronym> follows the standard GNU
autotools build process
+using <samp><span class="command">configure</span></samp> and <samp><span
class="command">make</span></samp>. For details on the GNU
+autotools build process, read the <samp><span
class="file">INSTALL</span></samp> file and query
+<tt>./configure --help</tt> for additional options.
+
+ <p><acronym>GNU libextractor</acronym> has various dependencies, most of
which are optional.
Instead of specifying the names of the software packages, we
will give the list in terms of the names of the respective
Debian (unstable) packages that should be installed.
-</p>
-<p>You absolutely need:
-</p>
-<ul>
-<li>
-libtool
-</li><li>
-gcc
-</li><li>
-make
-</li><li>
-g++
-</li><li>
-libltdl7-dev
-</li><li>
-zlib1g-dev
-</li><li>
-libbz2-dev
-</li></ul>
-<p>Recommended dependencies are:
-</p><ul>
-<li>
-libgtk2.0-dev
-</li><li>
-libvorbis-dev
-</li><li>
-libflac-dev
-</li><li>
-libgsf-1-dev
-</li><li>
-libmpeg2-4-dev
-</li><li>
-libqt4-dev
-</li><li>
-librpm-dev
-</li><li>
-libpoppler-dev
-</li><li>
-libexiv2-dev
-</li></ul>
+ <p>You absolutely need:
-<p>Optional dependencies (you would need to additionally specify
-the configure option <code>--enable-ffmpeg</code>) to make use of these
-are:
-</p><ul>
-<li>
-libavformat-dev
-</li><li>
-libswscale-dev
-</li></ul>
+ <ul>
+<li>libtool
+<li>gcc
+<li>make
+<li>g++
+<li>libltdl7-dev
+</ul>
-<p>For Subversion access and compilation one also needs:
-</p><ul>
-<li>
-subversion
-</li><li>
-autoconf
-</li><li>
-automake
-</li></ul>
+ <p>Recommended dependencies are:
+ <ul>
+<li>zlib1g-dev
+<li>libbz2-dev
+<li>libgif-dev
+<li>libvorbis-dev
+<li>libflac-dev
+<li>libmpeg2-4-dev
+<li>librpm-dev
+<li>libgtk2.0-dev
+<li>libgsf-1-dev
+<li>libqt4-dev
+<li>libpoppler-dev
+<li>libexiv2-dev
+<li>libavformat-dev
+<li>libswscale-dev
+</ul>
-<p>Please notify us if we missed some dependencies (note that the list is
+ <p>For Subversion access and compilation one also needs:
+ <ul>
+<li>subversion
+<li>autoconf
+<li>automake
+</ul>
+
+ <p>Please notify us if we missed some dependencies (note that the list is
supposed to only list direct dependencies, not transitive
dependencies).
-</p>
-<p>Once you have compiled and installed <acronym>GNU libextractor</acronym>,
you should have a file
-‘<tt>extractor.h</tt>’ installed in your
‘<tt>include/</tt>’ directory. This
+
+ <p>Once you have compiled and installed <acronym>GNU
libextractor</acronym>, you should have a file
+<samp><span class="file">extractor.h</span></samp> installed in your
<samp><span class="file">include/</span></samp> directory. This
file should be the starting point for your C and C++ development with
-<acronym>GNU libextractor</acronym>. The build process also installs the
‘<tt>extract</tt>’ binary and
-man pages for ‘<tt>extract</tt>’ and <acronym>GNU
libextractor</acronym>. The ‘<tt>extract</tt>’ man page
-documents the ‘<tt>extract</tt>’ tool. The <acronym>GNU
libextractor</acronym> man page gives a brief
+<acronym>GNU libextractor</acronym>. The build process also installs the
<samp><span class="file">extract</span></samp> binary and
+man pages for <samp><span class="file">extract</span></samp> and <acronym>GNU
libextractor</acronym>. The <samp><span class="file">extract</span></samp> man
page
+documents the <samp><span class="file">extract</span></samp> tool. The
<acronym>GNU libextractor</acronym> man page gives a brief
summary of the C API for <acronym>GNU libextractor</acronym>.
-</p>
-<a name="index-packageing"></a>
-<a name="index-directory-structure"></a>
-<a name="index-plugin-1"></a>
-<a name="index-environment-variables"></a>
-<a name="index-LIBEXTRACTOR_005fPREFIX"></a>
-<p>When you install <acronym>GNU libextractor</acronym>, various plugins will
be
-installed in the ‘<tt>lib/libextractor/</tt>’ directory. The main
library
-will be installed as ‘<tt>lib/libextractor.so</tt>’. Note that
+
+ <p><a name="index-packageing-4"></a><a
name="index-directory-structure-5"></a><a name="index-plugin-6"></a><a
name="index-environment-variables-7"></a><a
name="index-LIBEXTRACTOR_005fPREFIX-8"></a>When you install <acronym>GNU
libextractor</acronym>, various plugins will be
+installed in the <samp><span class="file">lib/libextractor/</span></samp>
directory. The main library
+will be installed as <samp><span
class="file">lib/libextractor.so</span></samp>. Note that
<acronym>GNU libextractor</acronym> will attempt to find the plugins relative
to the
path of the main library. Consequently, a package manager can move
the library and its plugins to a different location later — as long
@@ -313,479 +322,204 @@
environment variable <tt>LIBEXTRACTOR_PREFIX</tt>. If
<acronym>GNU libextractor</acronym> cannot locate a plugin, it will look in
<tt>LIBEXTRACTOR_PREFIX/lib/libextractor/</tt>.
-</p>
-<hr size="6">
-<a name="Installation-on-GNU_002fLinux"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Preparation" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation-on-FreeBSD"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">2.1 Installation on GNU/Linux</h2>
+<h3 class="section">2.1 Installation on GNU/Linux</h3>
<p>Should work using the standard instructions without problems.
-</p>
-<hr size="6">
-<a name="Installation-on-FreeBSD"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Installation-on-GNU_002fLinux"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation-on-OpenBSD"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">2.2 Installation on FreeBSD</h2>
+<h3 class="section">2.2 Installation on FreeBSD</h3>
<p>Should work using the standard instructions without problems.
-</p>
-<hr size="6">
-<a name="Installation-on-OpenBSD"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Installation-on-FreeBSD"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation-on-NetBSD"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">2.3 Installation on OpenBSD</h2>
+<h3 class="section">2.3 Installation on OpenBSD</h3>
-<p>OpenBSD 3.8 also doesn’t have CODESET in
‘<tt>langinfo.h</tt>’. CODESET
+<p>OpenBSD 3.8 also doesn't have CODESET in <samp><span
class="file">langinfo.h</span></samp>. CODESET
is used in <acronym>GNU libextractor</acronym> in about three places. This
causes problems
during compilation.
-</p>
-<hr size="6">
-<a name="Installation-on-NetBSD"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Installation-on-OpenBSD"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation-using-MinGW"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">2.4 Installation on NetBSD</h2>
+<h3 class="section">2.4 Installation on NetBSD</h3>
<p>No reports so far.
-</p>
-<hr size="6">
-<a name="Installation-using-MinGW"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Installation-on-NetBSD"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation-on-OS-X" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">2.5 Installation using MinGW</h2>
+<h3 class="section">2.5 Installation using MinGW</h3>
<p>Linking -lstdc++ with the provided libtool fails on Cygwin, this
is a problem with libtool, there is unfortunately no flag to tell
libtool how to do its job on Cygwin and it seems that it cannot be the
-default to set the library check to ’pass_all’. Patching libtool
may
+default to set the library check to 'pass_all'. Patching libtool may
help.
-</p>
-<p>Note: this is a rather dated report and may no longer apply.
-</p>
-<hr size="6">
-<a name="Installation-on-OS-X"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Installation-using-MinGW"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a
href="#Installing-and-uninstalling-the-framework" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">2.6 Installation on OS X</h2>
+ <p>Note: this is a rather dated report and may no longer apply.
+<h3 class="section">2.6 Installation on OS X</h3>
+
<p>libextractor has two installation methods on Mac OS X: it can be
installed as a Mac OS X framework or with the standard
-<code>./configure; make; make install</code> shell commands. The
+<samp><span class="command">./configure; make; make install</span></samp>
shell commands. The
framework package is self-contained, but currently omits some of the
extractor plugins that can be compiled in if libextractor is installed
-with <code>./configure; make; make install</code> (provided that the
+with <samp><span class="command">./configure; make; make install</span></samp>
(provided that the
required dependencies exist.)
-</p>
-<hr size="6">
-<a name="Installing-and-uninstalling-the-framework"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Installation-on-OS-X"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Using-the-framework" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation-on-OS-X" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h3 class="subsection">2.6.1 Installing and uninstalling the framework</h3>
-<p>The binary framework is distributed as a disk image
(‘<tt>Extractor-x.x.xx.dmg</tt>’).
-Installation is done by opening the disk image and clicking
‘<tt>Extractor.pkg</tt>’
+<h4 class="subsection">2.6.1 Installing and uninstalling the framework</h4>
+
+<p>The binary framework is distributed as a disk image (<samp><span
class="file">Extractor-x.x.xx.dmg</span></samp>).
+Installation is done by opening the disk image and clicking <samp><span
class="file">Extractor.pkg</span></samp>
inside it. The Mac OS X installer application will then run. The framework
-is installed to the root volume’s
‘<tt>/Library/Frameworks</tt>’ folder and installing
+is installed to the root volume's <samp><span
class="file">/Library/Frameworks</span></samp> folder and installing
will require admin privileges.
-</p>
-<p>The framework can be uninstalled by dragging
-‘<tt>/Library/Frameworks/Extractor.framework</tt>’ cto the
‘<tt>Trash</tt>’.
-</p>
-<hr size="6">
-<a name="Using-the-framework"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a
href="#Installing-and-uninstalling-the-framework" title="Previous section in
reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Example-for-using-the-framework"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation-on-OS-X" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h3 class="subsection">2.6.2 Using the framework</h3>
+ <p>The framework can be uninstalled by dragging
+<samp><span class="file">/Library/Frameworks/Extractor.framework</span></samp>
cto the <samp><span class="file">Trash</span></samp>.
-<p>In the framework, the <code>extract</code> command line tool can be found
at
-‘<tt>/Library/Frameworks/Extractor.framework/Versions/Current/bin/extract</tt>’
-</p>
-<p>The framework can be used in software projects as a framework or as a
dynamic
-library.
-</p>
-<p>When using the framework as a dynamic library in projects using autotools,
-one would most likely want to add
-"-I/Library/Frameworks/Extractor.framework/Versions/Current/include"
-to CPPFLAGS and
-"-L/Library/Frameworks/Extractor.framework/Versions/Current/lib"
+<h4 class="subsection">2.6.2 Using the framework</h4>
+
+<p>In the framework, the <samp><span class="command">extract</span></samp>
command line tool can be found at
+<samp><span
class="file">/Library/Frameworks/Extractor.framework/Versions/Current/bin/extract</span></samp>
+
+ <p>The framework can be used in software projects as a framework or as a
dynamic
+library.
+
+ <p>When using the framework as a dynamic library in projects using
autotools,
+one would most likely want to add
+"-I/Library/Frameworks/Extractor.framework/Versions/Current/include"
+to CPPFLAGS and
+"-L/Library/Frameworks/Extractor.framework/Versions/Current/lib"
to LDFLAGS.
-</p>
-<hr size="6">
-<a name="Example-for-using-the-framework"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Using-the-framework"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a
href="#Example-for-using-the-dynamic-library" title="Next section in reading
order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation-on-OS-X" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h3 class="subsection">2.6.3 Example for using the framework</h3>
+<h4 class="subsection">2.6.3 Example for using the framework</h4>
-<table><tr><td> </td><td><pre class="verbatim">// hello.c
-#include <Extractor/extractor.h>
+<pre class="example"><pre class="verbatim"> // hello.c
+ #include <Extractor/extractor.h>
+
+ int
+ main (int argc, char **argv)
+ {
+ struct EXTRACTOR_PluginList *el;
+ el = EXTRACTOR_plugin_load_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
+ // ...
+ EXTRACTOR_plugin_remove_all (el);
+ return 0;
+ }
+</pre>
+</pre>
+ <p>You can then compile the example using
-int main()
-{
- struct EXTRACTOR_PluginList *el;
- el = EXTRACTOR_plugin_load_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
- // ...
- EXTRACTOR_plugin_remove_all (el);
- return 0;
-}
-</pre></td></tr></table>
-
-<p>You can then compile the example using
-</p>
<pre class="verbatim">$ gcc -o hello hello.c -framework Extractor
</pre>
-<hr size="6">
-<a name="Example-for-using-the-dynamic-library"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a
href="#Example-for-using-the-framework" title="Previous section in reading
order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Note-to-package-maintainers"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Installation-on-OS-X" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h3 class="subsection">2.6.4 Example for using the dynamic library</h3>
-<table><tr><td> </td><td><pre class="verbatim">// hello.c
-#include <extractor.h>
-int main()
-{
- struct EXTRACTOR_PluginList *el;
- el = EXTRACTOR_plugin_load_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
- // ...
- EXTRACTOR_plugin_remove_all (el);
- return 0;
-}
-</pre></td></tr></table>
+<h4 class="subsection">2.6.4 Example for using the dynamic library</h4>
-<p>You can then compile the example using
-</p>
+<pre class="example"><pre class="verbatim"> // hello.c
+ #include <extractor.h>
+ int main()
+ {
+ struct EXTRACTOR_PluginList *el;
+ el = EXTRACTOR_plugin_load_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
+ // ...
+ EXTRACTOR_plugin_remove_all (el);
+ return 0;
+ }
+</pre>
+</pre>
+ <p>You can then compile the example using
+
<pre class="verbatim">$ gcc
-I/Library/Frameworks/Extractor.framework/Versions/Current/include \
-o hello hello.c \
-L/Library/Frameworks/Extractor.framework/Versions/Current/lib \
-lextractor
</pre>
-<p>Notice the difference in the <code>#include</code> line.
-</p>
+ <p>Notice the difference in the <code>#include</code> line.
+<h3 class="section">2.7 Note to package maintainers</h3>
+<p>The suggested way to package GNU libextractor is to split it into
+roughly the following binary packages:
+ <ul>
+<li>libextractor (main library only, only hard dependency for other packages
depending on GNU libextractor)
+<li>extract (command-line tool and man page extract.1)
+<li>libextractor-dev (extractor.h header and man page libextractor.3)
+<li>libextractor-doc (this manual)
+<li>libextractor-plugins (plugins without external dependencies; recommended
but not required by extract and libextractor package)
+<li>libextractor-plugin-XXX (plugin with dependency on libXXX, for example for
XXX=mpeg this would be <samp><span
class="file">libextractor_mpeg.so</span></samp>)
+<li>libextractor-plugins-all (meta package that requires all plugins except
experimental plugins)
+</ul>
-<hr size="6">
-<a name="Note-to-package-maintainers"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a
href="#Example-for-using-the-dynamic-library" title="Previous section in
reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">2.7 Note to package maintainers</h2>
-
-<p>The suggested way to package GNU libextractor is to split it into
-roughly the following binary packages:<a name="DOCF3" href="#FOOT3">(3)</a>
-</p>
-<ul>
-<li>
-libextractor (main library only, only hard dependency for other packages
depending on GNU libextractor)
-</li><li>
-extract (command-line tool and man page)
-</li><li>
-libextractor-dev (extractor.h header and man page)
-</li><li>
-libextractor-doc (this manual)
-</li><li>
-libextractor-plugins (plugins without external dependencies; recommended but
not required by extract and libextractor package)
-</li><li>
-libextractor-plugin-XXX (plugin with dependency on libXXX, for example for
XXX=mpeg this would be ‘<tt>libextractor_mpeg.so</tt>’)
-</li><li>
-libextractor-plugins-all (meta package that requires all plugins)
-</li></ul>
-
-<p>This would enable minimal installations (i.e. for embedded systems) to
+ <p>This would enable minimal installations (i.e. for embedded systems) to
not include any plugins, as well as moderate-size installations (that
-do not trigger GTK, QT and X11) for systems that have limited
-resources.
-</p>
+do not trigger GTK and X11) for systems that have limited resources.
+Right now, the MP4 plugin is experimental and does nothing and should
+thus never be included at all. The gstreamer plugin is experimental
+but largely works with the correct version of gstreamer and can thus
+be packaged (especially if the dependency is available on the target
+system) but should probably not be part of libextractor-plugins-all.
-<hr size="6">
+<div class="node">
<a name="Generalities"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Note-to-package-maintainers"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a
href="#Introduction-to-the-_0060_0060extract_0027_0027-command" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Preparation" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Extracting-meta-data" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Generalities-1"></a>
-<h1 class="chapter">3. Generalities</h1>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Extracting-meta-data">Extracting
meta data</a>,
+Previous: <a rel="previous" accesskey="p"
href="#Preparation">Preparation</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-<hr size="6">
-<a name="Introduction-to-the-_0060_0060extract_0027_0027-command"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Generalities" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a
href="#Common-usage-examples-for-_0060_0060extract_0027_0027" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Extracting-meta-data" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">3.1 Introduction to the “extract” command</h2>
+</div>
-<p>The <code>extract</code> command takes a list of file names as arguments,
+<h2 class="chapter">3 Generalities</h2>
+
+<h3 class="section">3.1 Introduction to the “extract” command</h3>
+
+<p>The <samp><span class="command">extract</span></samp> command takes a list
of file names as arguments,
extracts meta data from each of those files and prints the result to
-the console. By default, <code>extract</code> will use all available
+the console. By default, <samp><span class="command">extract</span></samp>
will use all available
plugins and print all (non-binary) meta data that is found.
-</p>
-<p>The set of plugins used by <code>extract</code> can be controlled using
+
+ <p>The set of plugins used by <samp><span
class="command">extract</span></samp> can be controlled using
the “-l” and “-n” options. Use “-n” to
not load all of the
default plugins. Use “-l NAME” to specifically load a certain
plugin. For example, specify “-n -l mime” to only use the MIME
plugin.
-</p>
-<p>Using the “-p” option the output of <code>extract</code> can be
limited
+
+ <p>Using the “-p” option the output of <samp><span
class="command">extract</span></samp> can be limited
to only certain keyword types. Similarly, using the “-x” option,
certain keyword types can be excluded. A list of all known keyword
types can be obtained using the “-L” option.
-</p>
-<p>The output format of <code>extract</code> can be influenced with the
+
+ <p>The output format of <samp><span class="command">extract</span></samp>
can be influenced with the
“-V” (more verbose, lists filenames), “-g”
(grep-friendly, all
meta data on a single line per file) and “-b” (bibTeX style)
options.
-</p>
-<hr size="6">
-<a name="Common-usage-examples-for-_0060_0060extract_0027_0027"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a
href="#Introduction-to-the-_0060_0060extract_0027_0027-command" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a
href="#Introduction-to-the-libextractor-library" title="Next section in reading
order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Extracting-meta-data" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">3.2 Common usage examples for “extract”</h2>
-<table><tr><td> </td><td><pre class="example">$ extract test/test.jpg
-comment - (C) 2001 by Christian Grothoff, using gimp 1.2 1
-mimetype - image/jpeg
+<h3 class="section">3.2 Common usage examples for “extract”</h3>
-$ extract -V -x comment test/test.jpg
-Keywords for file test/test.jpg:
-mimetype - image/jpeg
+<pre class="example"> $ extract test/test.jpg
+ comment - (C) 2001 by Christian Grothoff, using gimp 1.2 1
+ mimetype - image/jpeg
+
+ $ extract -V -x comment test/test.jpg
+ Keywords for file test/test.jpg:
+ mimetype - image/jpeg
+
+ $ extract -p comment test/test.jpg
+ comment - (C) 2001 by Christian Grothoff, using gimp 1.2 1
+
+ $ extract -nV -l png.so -p comment test/test.jpg test/test.png
+ Keywords for file test/test.jpg:
+ Keywords for file test/test.png:
+ comment - Testing keyword extraction
+</pre>
+<h3 class="section">3.3 Introduction to the libextractor library</h3>
-$ extract -p comment test/test.jpg
-comment - (C) 2001 by Christian Grothoff, using gimp 1.2 1
-
-$ extract -nV -l png.so -p comment test/test.jpg test/test.png
-Keywords for file test/test.jpg:
-Keywords for file test/test.png:
-comment - Testing keyword extraction
-</pre></td></tr></table>
-
-
-<hr size="6">
-<a name="Introduction-to-the-libextractor-library"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a
href="#Common-usage-examples-for-_0060_0060extract_0027_0027" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Extracting-meta-data" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Up section">
Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Extracting-meta-data" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">3.3 Introduction to the libextractor library</h2>
-
<p>Each public symbol exported by <acronym>GNU libextractor</acronym> has the
prefix
<tt>EXTRACTOR_</tt>. All-caps names are used for constants. For the
impatient, the minimal C code for using <acronym>GNU libextractor</acronym>
(on the
executing binary itself) looks like this:
-</p>
-<pre class="verbatim">#include <extractor.h>
-int main(int argc, char ** argv) {
+
+<pre class="verbatim">#include <extractor.h>
+
+int
+main (int argc, char ** argv)
+{
struct EXTRACTOR_PluginList *plugins
= EXTRACTOR_plugin_add_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
EXTRACTOR_extract (plugins, argv[1],
@@ -795,550 +529,293 @@
return 0;
}
</pre>
-<p>The minimal API illustrated by this example is actually sufficient for
+
+ <p>The minimal API illustrated by this example is actually sufficient for
many applications. The full external C API of <acronym>GNU
libextractor</acronym> is described
-in chapter See section <a href="#Extracting-meta-data">Extracting meta
data</a>. Bindings for other languages
-are described in chapter See section <a href="#Language-bindings">Language
bindings</a>. The API for
-writing new plugins is described in chapter See section <a
href="#Writing-new-Plugins">Writing new Plugins</a>.
-</p>
-<hr size="6">
+in chapter See <a href="#Extracting-meta-data">Extracting meta data</a>.
Bindings for other languages
+are described in chapter See <a href="#Language-bindings">Language
bindings</a>. The API for
+writing new plugins is described in chapter See <a
href="#Writing-new-Plugins">Writing new Plugins</a>.
+
+<div class="node">
<a name="Extracting-meta-data"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a
href="#Introduction-to-the-libextractor-library" title="Previous section in
reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Plugin-management" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Generalities" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Language-bindings" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Extracting-meta-data-1"></a>
-<h1 class="chapter">4. Extracting meta data</h1>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Language-bindings">Language
bindings</a>,
+Previous: <a rel="previous" accesskey="p"
href="#Generalities">Generalities</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+</div>
+
+<h2 class="chapter">4 Extracting meta data</h2>
+
<p>In order to extract meta data with <acronym>GNU libextractor</acronym> you
first need to
load the respective plugins and then call the extraction API
with the plugins and the data to process. This section
documents how to load and unload plugins, the various types
and formats in which meta data is returned to the application
and finally the extraction API itself.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Plugin-management">4.1 Plugin
management</a></td><td> </td><td align="left" valign="top"> How to
load and unload plugins
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Meta-types">4.2 Meta
types</a></td><td> </td><td align="left" valign="top">
About meta types
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Meta-formats">4.3 Meta
formats</a></td><td> </td><td align="left" valign="top">
About meta formats
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Extracting">4.4
Extracting</a></td><td> </td><td align="left" valign="top">
How to use the extraction API
-</td></tr>
-</table>
+<ul class="menu">
+<li><a accesskey="1" href="#Plugin-management">Plugin management</a>: How
to load and unload plugins
+<li><a accesskey="2" href="#Meta-types">Meta types</a>: About meta
types
+<li><a accesskey="3" href="#Meta-formats">Meta formats</a>: About meta
formats
+<li><a accesskey="4" href="#Extracting">Extracting</a>: How to use
the extraction API
+</ul>
-<hr size="6">
+<div class="node">
<a name="Plugin-management"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Extracting-meta-data"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Meta-types" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Extracting-meta-data"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Extracting-meta-data" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Language-bindings" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Plugin-management-1"></a>
-<h2 class="section">4.1 Plugin management</h2>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Meta-types">Meta types</a>,
+Up: <a rel="up" accesskey="u" href="#Extracting-meta-data">Extracting
meta data</a>
-<a name="index-reentrant"></a>
-<a name="index-concurrency"></a>
-<a name="index-threads"></a>
-<a name="index-thread_002dsafety"></a>
-<a name="index-enum-EXTRACTOR_005fOptions"></a>
+</div>
-<p>All of the functions for loading and unloading plugins, including
-<tt>EXTRACTOR_plugin_add_defaults</tt> and
<tt>EXTRACTOR_plugin_remove_all</tt>,
-are thread-safe and reentrant. However, using the same plugin list
-from multiple threads at the same time is not safe. Creating multiple
-plugin lists and using them concurrently is supported as long as
-the <code>EXTRACTOR_OPTION_IN_PROCESS</code> option is not used.
-</p>
-<p>Generally, <acronym>GNU libextractor</acronym> is fully thread-safe and
mostly reentrant.
-All plugin code is expected required to be reentrant and state-less,
+<h3 class="section">4.1 Plugin management</h3>
+
+<p><a name="index-reentrant-9"></a><a name="index-concurrency-10"></a><a
name="index-threads-11"></a><a name="index-thread_002dsafety-12"></a><a
name="index-enum-EXTRACTOR_005fOptions-13"></a>
+Using <acronym>GNU libextractor</acronym> from a multi-threaded parent process
requires some
+care. The problem is that on most platforms <acronym>GNU
libextractor</acronym> starts
+sub-processes for the actual extraction work. This is useful to
+isolate the parent process from potential bugs; however, it can cause
+problems if the parent process is multi-threaded. The issue is that
+at the time of the fork, another thread of the application may hold a
+lock (i.e. in gettext or libc). That lock would then never be
+released in the child process (as the other thread is not present in
+the child process). As a result, the child process would then
+deadlock on trying to acquire the lock and never terminate. This has
+actually been observed with a lock in GNU gettext that is triggered by
+the plugin startup code when it interacts with libltdl.
+
+ <p>The problem can be solved by loading the plugins using the
+<code>EXTRACTOR_OPTION_IN_PROCESS</code> option, which will run <acronym>GNU
libextractor</acronym>
+in-process and thus avoid the locking issue. In this case, all of the
+functions for loading and unloading plugins, including
+<tt>EXTRACTOR_plugin_add_defaults</tt> and
+<tt>EXTRACTOR_plugin_remove_all</tt>, are thread-safe and reentrant.
+However, using the same plugin list from multiple threads at the same
+time is not safe.
+
+ <p>All plugin code is expected required to be reentrant and state-less,
but due to the extensive use of 3rd party libraries this cannot
-be guaranteed. Hence plugins are executed (by default) out of
-process. This also ensures that plugins that crash do not cause
-the main application to fail as well.
-</p>
-<p>Plugins can be executed in-process by giving the option
-<code>EXTRACTOR_OPTION_IN_PROCESS</code> when loading the plugin. This
-option is only recommended when debugging plugins and not for
-production use. Due to the use of shared-memory IPC the
-out-of-process execution of plugins should not be a concern for
-performance.
-</p>
+be guaranteed.
-<dl>
-<dt><a name="index-EXTRACTOR_005fPluginList"></a><u>C Struct:</u>
<b>EXTRACTOR_PluginList</b></dt>
-<dd><a name="index-struct-EXTRACTOR_005fPluginList"></a>
-
-<p>A plugin list represents a set of GNU libextractor plugins. Most of
+<div class="defun">
+— C Struct: <b>EXTRACTOR_PluginList</b><var><a
name="index-EXTRACTOR_005fPluginList-14"></a></var><br>
+<blockquote><p><a name="index-struct-EXTRACTOR_005fPluginList-15"></a>
+A plugin list represents a set of GNU libextractor plugins. Most of
the GNU libextractor API is concerned with either constructing a
plugin list or using it to extract meta data. The internal representation
-of the plugin list is of no concern to users or plugin developers.
-</p></dd></dl>
+of the plugin list is of no concern to users or plugin developers.
+</p></blockquote></div>
+<div class="defun">
+— Function: void <b>EXTRACTOR_plugin_remove_all</b> (<var>struct
EXTRACTOR_PluginList *plugins</var>)<var><a
name="index-EXTRACTOR_005fplugin_005fremove_005fall-16"></a></var><br>
+<blockquote><p><a name="index-EXTRACTOR_005fplugin_005fremove_005fall-17"></a>
+Unload all of the plugins in the given list.
+</p></blockquote></div>
-<dl>
-<dt><a
name="index-EXTRACTOR_005fplugin_005fremove_005fall"></a><u>Function:</u> void
<b>EXTRACTOR_plugin_remove_all</b><i> (struct EXTRACTOR_PluginList
*plugins)</i></dt>
-<dd><a name="index-EXTRACTOR_005fplugin_005fremove_005fall-1"></a>
+<div class="defun">
+— Function: struct EXTRACTOR_PluginList * <b>EXTRACTOR_plugin_remove</b>
(<var>struct EXTRACTOR_PluginList *plugins, const char*name</var>)<var><a
name="index-EXTRACTOR_005fplugin_005fremove-18"></a></var><br>
+<blockquote><p><a name="index-EXTRACTOR_005fplugin_005fremove-19"></a>
+Unloads a particular plugin. The given name should be the short name of the
plugin, for example “mime” for the mime-type extractor or
“mpeg” for the MPEG extractor.
+</p></blockquote></div>
-<p>Unload all of the plugins in the given list.
-</p></dd></dl>
+<div class="defun">
+— Function: struct EXTRACTOR_PluginList * <b>EXTRACTOR_plugin_add</b>
(<var>struct EXTRACTOR_PluginList *plugins, const char* name,const char*
options, enum EXTRACTOR_Options flags</var>)<var><a
name="index-EXTRACTOR_005fplugin_005fadd-20"></a></var><br>
+<blockquote><p><a name="index-EXTRACTOR_005fplugin_005fadd-21"></a>
+Loads a particular plugin. The plugin is added to the existing list, which
can be NULL. The second argument specifies the name of the plugin (i.e.
“ogg”). The third argument can be NULL and specifies
plugin-specific options. Finally, the last argument specifies if the plugin
should be executed out-of-process
(<code>EXTRACTOR_OPTION_DEFAULT_POLICY</code>) or not.
+</p></blockquote></div>
-<dl>
-<dt><a name="index-EXTRACTOR_005fplugin_005fremove"></a><u>Function:</u>
struct EXTRACTOR_PluginList * <b>EXTRACTOR_plugin_remove</b><i> (struct
EXTRACTOR_PluginList *plugins, const char*name)</i></dt>
-<dd><a name="index-EXTRACTOR_005fplugin_005fremove-1"></a>
+<div class="defun">
+— Function: struct EXTRACTOR_PluginList *
<b>EXTRACTOR_plugin_add_config</b> (<var>struct EXTRACTOR_PluginList *plugins,
const char* config, enum EXTRACTOR_Options flags</var>)<var><a
name="index-EXTRACTOR_005fplugin_005fadd_005fconfig-22"></a></var><br>
+<blockquote><p><a name="index-EXTRACTOR_005fplugin_005fadd_005fconfig-23"></a>
+Loads and unloads plugins based on a configuration string, modifying the
existing list, which can be NULL. The string has the format
“[-]NAME(OPTIONS){:[-]NAME(OPTIONS)}*”. Prefixing the plugin name
with a “-” means that the plugin should be unloaded.
+</p></blockquote></div>
-<p>Unloads a particular plugin. The given name should be the short name of
the plugin, for example “mime” for the mime-type extractor or
“mpeg” for the MPEG extractor.
-</p></dd></dl>
+<div class="defun">
+— Function: struct EXTRACTOR_PluginList *
<b>EXTRACTOR_plugin_add_defaults</b> (<var>enum EXTRACTOR_Options
flags</var>)<var><a
name="index-EXTRACTOR_005fplugin_005fadd_005fdefaults-24"></a></var><br>
+<blockquote><p><a
name="index-EXTRACTOR_005fplugin_005fadd_005fdefaults-25"></a>
+Loads all of the plugins in the plugin directory. This function is what most
<acronym>GNU libextractor</acronym> applications should use to setup the
plugins.
+</p></blockquote></div>
-<dl>
-<dt><a name="index-EXTRACTOR_005fplugin_005fadd"></a><u>Function:</u> struct
EXTRACTOR_PluginList * <b>EXTRACTOR_plugin_add</b><i> (struct
EXTRACTOR_PluginList *plugins, const char* name,const char* options, enum
EXTRACTOR_Options flags)</i></dt>
-<dd><a name="index-EXTRACTOR_005fplugin_005fadd-1"></a>
+<div class="node">
+<a name="Meta-types"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Meta-formats">Meta formats</a>,
+Previous: <a rel="previous" accesskey="p"
href="#Plugin-management">Plugin management</a>,
+Up: <a rel="up" accesskey="u" href="#Extracting-meta-data">Extracting
meta data</a>
-<p>Loads a particular plugin. The plugin is added to the existing list, which
can be NULL. The second argument specifies the name of the plugin (i.e.
“ogg”). The third argument can be NULL and specifies
plugin-specific options. Finally, the last argument specifies if the plugin
should be executed out-of-process
(<code>EXTRACTOR_OPTION_DEFAULT_POLICY</code>) or not.
-</p></dd></dl>
+</div>
-<dl>
-<dt><a
name="index-EXTRACTOR_005fplugin_005fadd_005fconfig"></a><u>Function:</u>
struct EXTRACTOR_PluginList * <b>EXTRACTOR_plugin_add_config</b><i> (struct
EXTRACTOR_PluginList *plugins, const char* config, enum EXTRACTOR_Options
flags)</i></dt>
-<dd><a name="index-EXTRACTOR_005fplugin_005fadd_005fconfig-1"></a>
+<h3 class="section">4.2 Meta types</h3>
-<p>Loads and unloads plugins based on a configuration string, modifying the
existing list, which can be NULL. The string has the format
“[-]NAME(OPTIONS){:[-]NAME(OPTIONS)}*”. Prefixing the plugin name
with a “-” means that the plugin should be unloaded.
-</p></dd></dl>
+<p><a name="index-enum-EXTRACTOR_005fMetaType-26"></a><a
name="index-EXTRACTOR_005fmetatype_005fget_005fmax-27"></a>
+<tt>enum EXTRACTOR_MetaType</tt> is a C enum which defines a list of over 100
different types of meta data. The total number can differ between different
<acronym>GNU libextractor</acronym> releases; the maximum value for the current
release can be obtained using the <tt>EXTRACTOR_metatype_get_max</tt> function.
All values in this enumeration are of the form <tt>EXTRACTOR_METATYPE_XXX</tt>.
-<dl>
-<dt><a
name="index-EXTRACTOR_005fplugin_005fadd_005fdefaults"></a><u>Function:</u>
struct EXTRACTOR_PluginList * <b>EXTRACTOR_plugin_add_defaults</b><i> (enum
EXTRACTOR_Options flags)</i></dt>
-<dd><a name="index-EXTRACTOR_005fplugin_005fadd_005fdefaults-1"></a>
+<div class="defun">
+— Function: const char * <b>EXTRACTOR_metatype_to_string</b> (<var>enum
EXTRACTOR_MetaType type</var>)<var><a
name="index-EXTRACTOR_005fmetatype_005fto_005fstring-28"></a></var><br>
+<blockquote><p><a
name="index-EXTRACTOR_005fmetatype_005fto_005fstring-29"></a><a
name="index-gettext-30"></a><a name="index-internationalization-31"></a>
+The function <tt>EXTRACTOR_metatype_to_string</tt> can be used to obtain a
short English string ‘<samp><span class="samp">s</span></samp>’
describing the meta data type. The string can be translated into other
languages using GNU gettext with the domain set to <acronym>GNU
libextractor</acronym> (<tt>dgettext("libextractor", s)</tt>).
+</p></blockquote></div>
-<p>Loads all of the plugins in the plugin directory. This function is what
most <acronym>GNU libextractor</acronym> applications should use to setup the
plugins.
-</p></dd></dl>
+<div class="defun">
+— Function: const char * <b>EXTRACTOR_metatype_to_description</b>
(<var>enum EXTRACTOR_MetaType type</var>)<var><a
name="index-EXTRACTOR_005fmetatype_005fto_005fdescription-32"></a></var><br>
+<blockquote><p><a
name="index-EXTRACTOR_005fmetatype_005fto_005fdescription-33"></a><a
name="index-gettext-34"></a><a name="index-internationalization-35"></a>
+The function <tt>EXTRACTOR_metatype_to_description</tt> can be used to obtain
a longer English string ‘<samp><span class="samp">s</span></samp>’
describing the meta data type. The description may be empty if the short
description returned by <code>EXTRACTOR_metatype_to_string</code> is already
comprehensive. The string can be translated into other languages using GNU
gettext with the domain set to <acronym>GNU libextractor</acronym>
(<tt>dgettext("libextractor", s)</tt>).
+</p></blockquote></div>
+<div class="node">
+<a name="Meta-formats"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Extracting">Extracting</a>,
+Previous: <a rel="previous" accesskey="p" href="#Meta-types">Meta
types</a>,
+Up: <a rel="up" accesskey="u" href="#Extracting-meta-data">Extracting
meta data</a>
+</div>
-<hr size="6">
-<a name="Meta-types"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Plugin-management"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Meta-formats" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Extracting-meta-data"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Extracting-meta-data" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Language-bindings" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Meta-types-1"></a>
-<h2 class="section">4.2 Meta types</h2>
+<h3 class="section">4.3 Meta formats</h3>
+<p><a name="index-enum-EXTRACTOR_005fMetaFormat-36"></a>
+<tt>enum EXTRACTOR_MetaFormat</tt> is a C enum which defines on a high level
how the extracted meta data is represented. Currently, the library uses three
formats: UTF-8 strings, C strings and binary data. A fourth value,
<code>EXTRACTOR_METAFORMAT_UNKNOWN</code> is defined but not used. UTF-8
strings are 0-terminated strings that have been converted to UTF-8. The format
code is <code>EXTRACTOR_METAFORMAT_UTF8</code>. Ideally, most text meta data
will be of this format. Some file formats fail to specify the encoding used
for the text. In this case, the text cannot be converted to UTF-8. However,
the meta data is still known to be 0-terminated and presumably human-readable.
In this case, the format code used is
<code>EXTRACTOR_METAFORMAT_C_STRING</code>; however, this should not be
understood to mean that the encoding is the same as that used by the C
compiler. Finally, for binary data (mostly images), the format
<code>EXTRACTOR_METAFORMAT_BINARY</code> is used.
-<a name="index-enum-EXTRACTOR_005fMetaType"></a>
-<a name="index-EXTRACTOR_005fmetatype_005fget_005fmax"></a>
+ <p>Naturally this is not a precise description of the meta format. Plugins
can provide a more precise description (if known) by providing the respective
mime type of the meta data. For example, binary image meta data could be also
tagged as “image/png” and normal text would typically be tagged as
“text/plain”.
-<p><tt>enum EXTRACTOR_MetaType</tt> is a C enum which defines a list of over
100 different types of meta data. The total number can differ between
different <acronym>GNU libextractor</acronym> releases; the maximum value for
the current release can be obtained using the
<tt>EXTRACTOR_metatype_get_max</tt> function. All values in this enumeration
are of the form <tt>EXTRACTOR_METATYPE_XXX</tt>.
-</p>
-<dl>
-<dt><a
name="index-EXTRACTOR_005fmetatype_005fto_005fstring"></a><u>Function:</u>
const char * <b>EXTRACTOR_metatype_to_string</b><i> (enum EXTRACTOR_MetaType
type)</i></dt>
-<dd><a name="index-EXTRACTOR_005fmetatype_005fto_005fstring-1"></a>
-<a name="index-gettext"></a>
-<a name="index-internationalization"></a>
+<div class="node">
+<a name="Extracting"></a>
+<p><hr>
+Previous: <a rel="previous" accesskey="p" href="#Meta-formats">Meta
formats</a>,
+Up: <a rel="up" accesskey="u" href="#Extracting-meta-data">Extracting
meta data</a>
-<p>The function <tt>EXTRACTOR_metatype_to_string</tt> can be used to obtain a
short English string ‘<samp>s</samp>’ describing the meta data
type. The string can be translated into other languages using GNU gettext with
the domain set to <acronym>GNU libextractor</acronym>
(<tt>dgettext("libextractor", s)</tt>).
-</p></dd></dl>
+</div>
-<dl>
-<dt><a
name="index-EXTRACTOR_005fmetatype_005fto_005fdescription"></a><u>Function:</u>
const char * <b>EXTRACTOR_metatype_to_description</b><i> (enum
EXTRACTOR_MetaType type)</i></dt>
-<dd><a name="index-EXTRACTOR_005fmetatype_005fto_005fdescription-1"></a>
-<a name="index-gettext-1"></a>
-<a name="index-internationalization-1"></a>
+<h3 class="section">4.4 Extracting</h3>
-<p>The function <tt>EXTRACTOR_metatype_to_description</tt> can be used to
obtain a longer English string ‘<samp>s</samp>’ describing the meta
data type. The description may be empty if the short description returned by
<code>EXTRACTOR_metatype_to_string</code> is already comprehensive. The string
can be translated into other languages using GNU gettext with the domain set to
<acronym>GNU libextractor</acronym> (<tt>dgettext("libextractor",
s)</tt>).
-</p></dd></dl>
+<div class="defun">
+— Function Pointer: int
<b>(</b><var>*EXTRACTOR_MetaDataProcessor</var>)(<var>void *cls, const char
*plugin_name, enum EXTRACTOR_MetaType type, enum EXTRACTOR_MetaFormat format,
const char *data_mime_type, const char *data, size_t data_len</var>)<var><a
name="index-g_t_0028-37"></a></var><br>
+<blockquote><p><a name="index-EXTRACTOR_005fMetaDataProcessor-38"></a>
+Type of a function that libextractor calls for each meta data item found.
+ <dl>
+<dt><var>cls</var><dd>closure (user-defined)
+ <br><dt><var>plugin_name</var><dd>name of the plugin that produced
this value; special values can be used (i.e. '<zlib>' for zlib being used
in the main libextractor library and yielding meta data);
-<hr size="6">
-<a name="Meta-formats"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Meta-types" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Extracting" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Extracting-meta-data"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Extracting-meta-data" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Language-bindings" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Meta-formats-1"></a>
-<h2 class="section">4.3 Meta formats</h2>
+ <br><dt><var>type</var><dd>libextractor-type describing the meta
data;
-<a name="index-enum-EXTRACTOR_005fMetaFormat"></a>
+ <br><dt><var>format basic</var><dd>format information about data
-<p><tt>enum EXTRACTOR_MetaFormat</tt> is a C enum which defines on a high
level how the extracted meta data is represented. Currently, the library uses
three formats: UTF-8 strings, C strings and binary data. A fourth value,
<code>EXTRACTOR_METAFORMAT_UNKNOWN</code> is defined but not used. UTF-8
strings are 0-terminated strings that have been converted to UTF-8. The format
code is <code>EXTRACTOR_METAFORMAT_UTF8</code>. Ideally, most text meta data
will be of this format. Some file formats fail to specify the encoding used
for the text. In this case, the text cannot be converted to UTF-8. However,
the meta data is still known to be 0-terminated and presumably human-readable.
In this case, the format code used is
<code>EXTRACTOR_METAFORMAT_C_STRING</code>; however, this should not be
understood to mean that the encoding is the same as that used by the C
compiler. Finally, for binary data (mostly images), the format
<code>EXTRACTOR_METAFORMAT_BINARY</code> is used.
-</p>
-<p>Naturally this is not a precise description of the meta format. Plugins can
provide a more precise description (if known) by providing the respective mime
type of the meta data. For example, binary image meta data could be also
tagged as “image/png” and normal text would typically be tagged as
“text/plain”.
-</p>
+ <br><dt><var>data_mime_type</var><dd>mime-type of data (not of the
original file); can be NULL (if mime-type is not known);
+ <br><dt><var>data</var><dd>actual meta-data found
-<hr size="6">
-<a name="Extracting"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Meta-formats" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Language-bindings" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Extracting-meta-data"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Extracting-meta-data" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Language-bindings" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Extracting-1"></a>
-<h2 class="section">4.4 Extracting</h2>
+ <br><dt><var>data_len</var><dd>number of bytes in data
-<dl>
-<dt><a name="index-_0028"></a><u>Function Pointer:</u> int
<b>(</b><i>*EXTRACTOR_MetaDataProcessor)(void *cls, const char *plugin_name,
enum EXTRACTOR_MetaType type, enum EXTRACTOR_MetaFormat format, const char
*data_mime_type, const char *data, size_t data_len)</i></dt>
-<dd><a name="index-EXTRACTOR_005fMetaDataProcessor"></a>
+ </dl>
-<p>Type of a function that libextractor calls for each meta data item found.
-</p>
-<dl compact="compact">
-<dt> <var>cls</var> </dt>
-<dd><p>closure (user-defined)
-</p>
-</dd>
-<dt> <var>plugin_name</var> </dt>
-<dd><p>name of the plugin that produced this value; special values can be used
(i.e. ’<zlib>’ for zlib being used in the main libextractor
library and yielding meta data);
-</p>
-</dd>
-<dt> <var>type</var> </dt>
-<dd><p>libextractor-type describing the meta data;
-</p>
-</dd>
-<dt> <var>format basic</var> </dt>
-<dd><p>format information about data
-</p>
-</dd>
-<dt> <var>data_mime_type</var> </dt>
-<dd><p>mime-type of data (not of the original file); can be NULL (if mime-type
is not known);
-</p>
-</dd>
-<dt> <var>data</var> </dt>
-<dd><p>actual meta-data found
-</p>
-</dd>
-<dt> <var>data_len</var> </dt>
-<dd><p>number of bytes in data
-</p>
-</dd>
-</dl>
+ <p>Return 0 to continue extracting, 1 to abort.
+</p></blockquote></div>
-<p>Return 0 to continue extracting, 1 to abort.
-</p></dd></dl>
+<div class="defun">
+— Function: void <b>EXTRACTOR_extract</b> (<var>struct
EXTRACTOR_PluginList *plugins, const char *filename, const void *data, size_t
size, EXTRACTOR_MetaDataProcessor proc, void *proc_cls</var>)<var><a
name="index-EXTRACTOR_005fextract-39"></a></var><br>
+<blockquote><p><a name="index-EXTRACTOR_005fextract-40"></a><a
name="index-reentrant-41"></a><a name="index-concurrency-42"></a><a
name="index-threads-43"></a><a name="index-thread_002dsafety-44"></a>
+This is the main function for extracting keywords with <acronym>GNU
libextractor</acronym>. The first argument is a plugin list which specifies
the set of plugins that should be used for extracting meta data. The
‘<samp><span class="samp">filename</span></samp>’ argument is
optional and can be used to specify the name of a file to process. If
‘<samp><span class="samp">filename</span></samp>’ is NULL, then the
‘<samp><span class="samp">data</span></samp>’ argument must point
to the in-memory data to extract meta data from. If ‘<samp><span
class="samp">filename</span></samp>’ is non-NULL, ‘<samp><span
class="samp">data</span></samp>’ can be NULL. If ‘<samp><span
class="samp">data</span></samp>’ is non-null, then ‘<samp><span
class="samp">size</span></samp>’ is the size of ‘<samp><span
class="samp">data</span></samp>’ in bytes. Otherwise ‘<samp><span
class="samp">size</sp
an></sam
p>’ should be zero. For each meta data item found, GNU libextractor
will call the ‘<samp><span class="samp">proc</span></samp>’
function, passing ‘<samp><span class="samp">proc_cls</span></samp>’
as the first argument to ‘<samp><span
class="samp">proc</span></samp>’. The other arguments to
‘<samp><span class="samp">proc</span></samp>’ depend on the
specific meta data found.
+ <p><a name="index-SIGBUS-45"></a><a name="index-bus-error-46"></a>Meta
data extraction should never really fail — at worst, <acronym>GNU
libextractor</acronym> should not call ‘<samp><span
class="samp">proc</span></samp>’ with any meta data. By design,
<acronym>GNU libextractor</acronym> should never crash or leak memory, even
given corrupt files as input. Note however, that running <acronym>GNU
libextractor</acronym> on a corrupt file system (or incorrectly <tt>mmap</tt>ed
files) can result in the operating system sending a SIGBUS (bus error) to the
process. While <acronym>GNU libextractor</acronym> runs plugins
out-of-process, it first maps the file into memory and then attempts to
decompress it. During decompression it is possible to encounter a SIGBUS.
<acronym>GNU libextractor</acronym> will <em>not</em> attempt to catch this
signal and your application is likely to crash. Note again that this should
only happen if the file <em>system</em
> is cor
rupt (not if individual files are corrupt). If this is not acceptable, you
might want to consider running <acronym>GNU libextractor</acronym> itself also
out-of-process (as done, for example, by <a
href="http://grothoff.org/christian/doodle/";>doodle</a>).
+ </blockquote></div>
-<dl>
-<dt><a name="index-EXTRACTOR_005fextract"></a><u>Function:</u> void
<b>EXTRACTOR_extract</b><i> (struct EXTRACTOR_PluginList *plugins, const char
*filename, const void *data, size_t size, EXTRACTOR_MetaDataProcessor proc,
void *proc_cls)</i></dt>
-<dd><a name="index-EXTRACTOR_005fextract-1"></a>
-<a name="index-reentrant-1"></a>
-<a name="index-concurrency-1"></a>
-<a name="index-threads-1"></a>
-<a name="index-thread_002dsafety-1"></a>
+<div class="node">
+<a name="Language-bindings"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Utility-functions">Utility
functions</a>,
+Previous: <a rel="previous" accesskey="p"
href="#Extracting-meta-data">Extracting meta data</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-<p>This is the main function for extracting keywords with <acronym>GNU
libextractor</acronym>. The first argument is a plugin list which specifies
the set of plugins that should be used for extracting meta data. The
‘<samp>filename</samp>’ argument is optional and can be used to
specify the name of a file to process. If ‘<samp>filename</samp>’
is NULL, then the ‘<samp>data</samp>’ argument must point to the
in-memory data to extract meta data from. If
‘<samp>filename</samp>’ is non-NULL,
‘<samp>data</samp>’ can be NULL. If
‘<samp>data</samp>’ is non-null, then
‘<samp>size</samp>’ is the size of ‘<samp>data</samp>’
in bytes. Otherwise ‘<samp>size</samp>’ should be zero. For each
meta data item found, GNU libextractor will call the
‘<samp>proc</samp>’ function, passing
‘<samp>proc_cls</samp>’ as the first argument to
‘<samp>proc</samp
>’
. The other arguments to ‘<samp>proc</samp>’ depend on the
specific meta data found.
-</p>
-<a name="index-SIGBUS"></a>
-<a name="index-bus-error"></a>
-<p>Meta data extraction should never really fail — at worst,
<acronym>GNU libextractor</acronym> should not call
‘<samp>proc</samp>’ with any meta data. By design, <acronym>GNU
libextractor</acronym> should never crash or leak memory, even given corrupt
files as input. Note however, that running <acronym>GNU libextractor</acronym>
on a corrupt file system (or incorrectly <tt>mmap</tt>ed files) can result in
the operating system sending a SIGBUS (bus error) to the process. While
<acronym>GNU libextractor</acronym> runs plugins out-of-process, it first maps
the file into memory and then attempts to decompress it. During decompression
it is possible to encounter a SIGBUS. <acronym>GNU libextractor</acronym>
will <em>not</em> attempt to catch this signal and your application is likely
to crash. Note again that this should only happen if the file <em>system</em>
is corrupt (not if individual files are corrupt). If this is not acceptable,
you might want to
conside
r running <acronym>GNU libextractor</acronym> itself also out-of-process (as
done, for example, by <a
href="http://grothoff.org/christian/doodle/";>doodle</a>).
-</p>
-</dd></dl>
+</div>
+<h2 class="chapter">5 Language bindings</h2>
-<hr size="6">
-<a name="Language-bindings"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Extracting" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Java" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Extracting-meta-data"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Utility-functions" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Language-bindings-1"></a>
-<h1 class="chapter">5. Language bindings</h1>
-<a name="index-Java"></a>
-<a name="index-Mono"></a>
-<a name="index-Perl"></a>
-<a name="index-Python"></a>
-<a name="index-PHP"></a>
-<a name="index-Ruby"></a>
+<p><a name="index-Java-47"></a><a name="index-Mono-48"></a><a
name="index-Perl-49"></a><a name="index-Python-50"></a><a
name="index-PHP-51"></a><a name="index-Ruby-52"></a>
+<acronym>GNU libextractor</acronym> works immediately with C and C++ code.
Bindings for Java, Mono, Ruby, Perl, PHP and Python are available for download
from the main <acronym>GNU libextractor</acronym> website. Documentation for
these bindings (if available) is part of the downloads for the respective
binding. In all cases, a full installation of the C library is required before
the binding can be installed.
-<p><acronym>GNU libextractor</acronym> works immediately with C and C++ code.
Bindings for Java, Mono, Ruby, Perl, PHP and Python are available for download
from the main <acronym>GNU libextractor</acronym> website. Documentation for
these bindings (if available) is part of the downloads for the respective
binding. In all cases, a full installation of the C library is required before
the binding can be installed.
-</p>
-<hr size="6">
-<a name="Java"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Language-bindings"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Mono" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Language-bindings"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Language-bindings" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Utility-functions" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">5.1 Java</h2>
+<h3 class="section">5.1 Java</h3>
<p>Compiling the GNU libextractor Java binding follows the usual process of
-running <code>configure</code> and <code>make</code>. The result will be a
-shared C library ‘<tt>libextractor_java.so</tt>’ with the native
code and
-a JAR file (installed to
‘<tt>$PREFIX/share/java/libextractor.java</tt>’).
-</p>
-<p>A minimal example for using GNU libextractor’s Java binding would look
+running <samp><span class="command">configure</span></samp> and <samp><span
class="command">make</span></samp>. The result will be a
+shared C library <samp><span class="file">libextractor_java.so</span></samp>
with the native code and
+a JAR file (installed to <samp><span
class="file">$PREFIX/share/java/libextractor.java</span></samp>).
+
+ <p>A minimal example for using GNU libextractor's Java binding would look
like this:
-</p><pre class="verbatim">import org.gnu.libextractor.*;
+<pre class="verbatim">import org.gnu.libextractor.*;
import java.util.ArrayList;
public static void main(String[] args) {
Extractor ex = Extractor.getDefault();
for (int i=0;i<args.length;i++) {
ArrayList keywords = ex.extract(args[i]);
- System.out.println("Keywords for " + args[i] + ":");
+ System.out.println("Keywords for " + args[i] + ":");
for (int j=0;j<keywords.size();j++)
System.out.println(keywords.get(j));
}
}
</pre>
-<p>The GNU libextractor library and the
‘<tt>libextractor_java.so</tt>’ JNI binding
+
+ <p>The GNU libextractor library and the <samp><span
class="file">libextractor_java.so</span></samp> JNI binding
have to be in the library search path for this to work. Furthermore, the
-‘<tt>libextractor.jar</tt>’ file should be on the classpath.
-</p>
-<p>Note that the API does not use Java 5 style generics in order to work
+<samp><span class="file">libextractor.jar</span></samp> file should be on the
classpath.
+
+ <p>Note that the API does not use Java 5 style generics in order to work
with older versions of Java.
-</p>
-<hr size="6">
-<a name="Mono"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Java" title="Previous section
in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Perl" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Language-bindings"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Language-bindings" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Utility-functions" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">5.2 Mono</h2>
-<p>This binding is undocumented at this point.
-</p>
-<hr size="6">
-<a name="Perl"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Mono" title="Previous section
in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Python" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Language-bindings"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Language-bindings" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Utility-functions" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">5.3 Perl</h2>
+<h3 class="section">5.2 Mono</h3>
+<p>his binding is undocumented at this point.
+
+<h3 class="section">5.3 Perl</h3>
+
<p>This binding is undocumented at this point.
-</p>
-<hr size="6">
-<a name="Python"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Perl" title="Previous section
in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#PHP" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Language-bindings"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Language-bindings" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Utility-functions" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">5.4 Python</h2>
+<h3 class="section">5.4 Python</h3>
+
<p>This binding is undocumented at this point.
-</p>
-<hr size="6">
-<a name="PHP"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Python" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Ruby" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Language-bindings"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Language-bindings" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Utility-functions" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">5.5 PHP</h2>
+<h3 class="section">5.5 PHP</h3>
+
<p>This binding is undocumented at this point.
-</p>
-<hr size="6">
-<a name="Ruby"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#PHP" title="Previous section
in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Utility-functions" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Language-bindings"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Language-bindings" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Utility-functions" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">5.6 Ruby</h2>
+<h3 class="section">5.6 Ruby</h3>
+
<p>This binding is undocumented at this point.
-</p>
-
-<hr size="6">
+<div class="node">
<a name="Utility-functions"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Ruby" title="Previous section
in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Utility-Constants" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Language-bindings"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Existing-Plugins" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Utility-functions-1"></a>
-<h1 class="chapter">6. Utility functions</h1>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Existing-Plugins">Existing
Plugins</a>,
+Previous: <a rel="previous" accesskey="p"
href="#Language-bindings">Language bindings</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-<a name="index-reentrant-2"></a>
-<a name="index-concurrency-2"></a>
-<a name="index-threads-2"></a>
-<a name="index-thread_002dsafety-2"></a>
-<p>This chapter describes various utility functions for <acronym>GNU
libextractor</acronym> usage. All of the functions are reentrant.
-</p>
-<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#Utility-Constants">6.1 Utility
Constants</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-<tr><td align="left" valign="top"><a href="#Meta-data-printing">6.2 Meta data
printing</a></td><td> </td><td align="left" valign="top">
-</td></tr>
-</table>
+</div>
-<hr size="6">
+<h2 class="chapter">6 Utility functions</h2>
+
+<p><a name="index-reentrant-53"></a><a name="index-concurrency-54"></a><a
name="index-threads-55"></a><a name="index-thread_002dsafety-56"></a>This
chapter describes various utility functions for <acronym>GNU
libextractor</acronym> usage. All of the functions are reentrant.
+
+<ul class="menu">
+<li><a accesskey="1" href="#Utility-Constants">Utility Constants</a>
+<li><a accesskey="2" href="#Meta-data-printing">Meta data printing</a>
+</ul>
+
+<div class="node">
<a name="Utility-Constants"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Utility-functions"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Meta-data-printing" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Utility-functions"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Utility-functions" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Existing-Plugins" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Utility-Constants-1"></a>
-<h2 class="section">6.1 Utility Constants</h2>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Meta-data-printing">Meta data
printing</a>,
+Up: <a rel="up" accesskey="u" href="#Utility-functions">Utility
functions</a>
-<a name="index-EXTRACTOR_005fVERSION"></a>
-<p>The constant <tt>EXTRACTOR_VERSION</tt> is a hexadecimal
+</div>
+
+<h3 class="section">6.1 Utility Constants</h3>
+
+<p><a name="index-EXTRACTOR_005fVERSION-57"></a>The constant
<tt>EXTRACTOR_VERSION</tt> is a hexadecimal
representation of the version number of the installed libextractor
header. The hexadecimal format is 0xAABBCCDD where AA is the major
version (so far always 0), BB is the minor version, CC is the revision
@@ -1346,549 +823,282 @@
have AA=0, BB=5, CC=18 and DD=0. Minor releases such as 0.5.18a or
significant changes in unreleased versions would be marked with DD=1
or higher.
-</p>
-<hr size="6">
+<div class="node">
<a name="Meta-data-printing"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Utility-Constants"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Existing-Plugins" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Utility-functions"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Utility-functions" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Existing-Plugins" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Meta-data-printing-1"></a>
-<h2 class="section">6.2 Meta data printing</h2>
+<p><hr>
+Previous: <a rel="previous" accesskey="p"
href="#Utility-Constants">Utility Constants</a>,
+Up: <a rel="up" accesskey="u" href="#Utility-functions">Utility
functions</a>
+</div>
-<a name="index-EXTRACTOR_005fmeta_005fdata_005fprint"></a>
-<p>The <tt>EXTRACTOR_meta_data_print</tt> is a simple function which prints
the meta data found with libextractor to a file. The function is mostly useful
for debugging and as an example for how to manipulate the keyword list and can
be passed as the ‘<samp>proc</samp>’ argument to
<code>EXTRACTOR_extract</code>. The file to print to should be passed as
‘<samp>proc_cls</samp>’ (which must be of type <code>FILE
*</code>), for example <code>stdout</code>.
-</p>
+<h3 class="section">6.2 Meta data printing</h3>
+<p><a name="index-EXTRACTOR_005fmeta_005fdata_005fprint-58"></a>The
<tt>EXTRACTOR_meta_data_print</tt> is a simple function which prints the meta
data found with libextractor to a file. The function is mostly useful for
debugging and as an example for how to manipulate the keyword list and can be
passed as the ‘<samp><span class="samp">proc</span></samp>’
argument to <code>EXTRACTOR_extract</code>. The file to print to should be
passed as ‘<samp><span class="samp">proc_cls</span></samp>’ (which
must be of type <code>FILE *</code>), for example <code>stdout</code>.
-<hr size="6">
+<div class="node">
<a name="Existing-Plugins"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Meta-data-printing"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Writing-new-Plugins" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Utility-functions"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Writing-new-Plugins" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Existing-Plugins-1"></a>
-<h1 class="chapter">7. Existing Plugins</h1>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Writing-new-Plugins">Writing new
Plugins</a>,
+Previous: <a rel="previous" accesskey="p"
href="#Utility-functions">Utility functions</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-<ul>
-<li>
-APPLEFILE
-</li><li>
-ASF
-</li><li>
-DEB
-</li><li>
-DVI
-</li><li>
-ELF
-</li><li>
-EXIV2
-</li><li>
-FLAC
-</li><li>
-FLV
-</li><li>
-GIF
-</li><li>
-HTML
-</li><li>
-ID3 (v2.0, v2.3, v2.4)
-</li><li>
-IT
-</li><li>
-JPEG
-</li><li>
-OLE2
-</li><li>
-thumbnail (GTK, QT or FFMPEG-based)
-</li><li>
-MAN
-</li><li>
-MIME
-</li><li>
-MP3 (ID3v1)
-</li><li>
-MPEG
-</li><li>
-NSF and NSFE
-</li><li>
-ODF
-</li><li>
-PNG
-</li><li>
-PS (PostScript)
-</li><li>
-QT (QuickTime)
-</li><li>
-REAL
-</li><li>
-RIFF
-</li><li>
-RPM
-</li><li>
-S3M
-</li><li>
-SID
-</li><li>
-TAR
-</li><li>
-TIFF
-</li><li>
-WAV
-</li><li>
-XM
-</li><li>
-ZIP
-</li></ul>
+</div>
-<p>‘<tt>gzip</tt>’ and ‘<tt>bzip2</tt>’ compressed
versions of these formats are
-also supported (as well as meta data embedded by ‘<tt>gzip</tt>’
itself).
-</p>
-<hr size="6">
+<h2 class="chapter">7 Existing Plugins</h2>
+
+ <ul>
+<li>ARCHIVE (using libarchive)
+<li>DVI
+<li>EXIV2 (using libexiv2, 0.23 or later preferred)
+<li>FLAC (using libFLAC)
+<li>GIF (using libgif)
+<li>GSTREAMER (using libgstreamer v1.0 or later)
+<li>HTML (using libtidy)
+<li>IT
+<li>JPEG (using libjpeg v8 or later)
+<li>MAN
+<li>MIDI (using libsmf)
+<li>MIME (using libmagic)
+<li>MPEG (using libmpeg2)
+<li>NSF
+<li>NSFE
+<li>ODF
+<li>OLE2 (with libgsf)
+<li>OGG (with libogg)
+<li>PNG
+<li>PS
+<li>RIFF
+<li>RPM (using librpm)
+<li>S3M
+<li>SID
+<li>ThumbnailFFMPEG (using libavformat and related libav-libraries, including
libswscale)
+<li>ThumbnailGtk (using libgtk)
+<li>TIFF (with libtiff, tested with v4)
+<li>WAV
+<li>XM
+<li>ZIP
+</ul>
+
+ <p><samp><span class="file">gzip</span></samp> and <samp><span
class="file">bzip2</span></samp> compressed versions of these formats are
+also supported (as well as meta data embedded by <samp><span
class="file">gzip</span></samp> itself)
+if zlib or libbz2 are available.
+
+<div class="node">
<a name="Writing-new-Plugins"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Existing-Plugins"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a
href="#Example-for-a-minimal-extract-method" title="Next section in reading
order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Existing-Plugins" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Internal-utility-functions"
title="Next chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Writing-new-Plugins-1"></a>
-<h1 class="chapter">8. Writing new Plugins</h1>
+<p><hr>
+Next: <a rel="next" accesskey="n"
href="#Internal-utility-functions">Internal utility functions</a>,
+Previous: <a rel="previous" accesskey="p"
href="#Existing-Plugins">Existing Plugins</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+</div>
+
+<h2 class="chapter">8 Writing new Plugins</h2>
+
<p>Writing a new plugin for libextractor usually requires writing of or
interfacing with an actual parser for a specific format. How this is
can be accomplished depends on the format and cannot be specified in
general. However, care should be taken for the code to be reentrant
and highly fault-tolerant, especially with respect to malformed
inputs.
-</p>
-<p>Plugins should start by verifying that the header of the data matches
-the specific format and immediately return if that is not the case.
+
+ <p>Plugins should start by verifying that the header of the data matches
+the specific format and immediately return if that is not the case.
Even if the header matches the expected file format, plugins must not
assume that the remainder of the file is well formed.
-</p>
-<p>The plugin library must be called libextractor_XXX.so, where XXX
-denotes the file format of the plugin. The library must export a
-method <tt>libextractor_XXX_extract</tt>, with the following
+
+ <p>The plugin library must be called libextractor_XXX.so, where XXX
+denotes the file format of the plugin. The library must export a
+method <tt>libextractor_XXX_extract_method</tt>, with the following
signature:
-</p><pre class="verbatim">int
-EXTRACTOR_XXX_extract
- (const char *data,
- size_t data_size,
- EXTRACTOR_MetaDataProcessor proc,
- void *proc_cls,
- const char * options);
+<pre class="verbatim">void
+EXTRACTOR_XXX_extract_method (struct EXTRACTOR_ExtractContext *ec);
</pre>
-<p>‘<samp>data</samp>’ is a pointer to the typically memory mapped
contents of
-the file. Note that plugins cannot ignore the <tt>const</tt>
-annotation since the memory mapping may have been done read-only (and
-thus writes to this page will result in an error). The
‘<samp>data_size</samp>’
-argument specifies the size of the ‘<samp>data</samp>’ buffer in
bytes.
-</p>
-<p>‘<samp>proc</samp>’ should be called on each meta data item
found. If ‘<samp>proc</samp>’
-returns non-zero, processing should be aborted and the <code>extract</code>
-function must return 1. Otherwise <code>extract</code> should always return
zero.
-</p>
-<p>In order to test new plugins, the ‘<tt>extract</tt>’ command
can be run
+ <p>‘<samp><span class="samp">ec</span></samp>’ contains various
information the plugin may need for its
+execution. Most importantly, it contains functions for reading
+(“read”) and seeking (“seek”) the input data and for
returning
+extracted data (“proc”). The “config” member can
contain
+additional configuration options. “proc” should be called on
+each meta data item found. If “proc” returns non-zero,
+processing should be aborted (if possible).
+
+ <p>In order to test new plugins, the <samp><span
class="file">extract</span></samp> command can be run
with the options “-ni” and “-l XXX” . This will run
the plugin
in-process (making it easier to debug) and without any of the other
plugins.
-</p>
-<hr size="6">
-<a name="Example-for-a-minimal-extract-method"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Writing-new-Plugins"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Plugin-execution-options"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Writing-new-Plugins"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Writing-new-Plugins" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internal-utility-functions"
title="Next chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">8.1 Example for a minimal extract method</h2>
+<h3 class="section">8.1 Example for a minimal extract method</h3>
<p>The following example shows how a plugin can return the mime type of
a file.
-</p><table><tr><td> </td><td><pre class="verbatim">int
-EXTRACTOR_mymime_extract
- (const char *data,
- size_t data_size,
- EXTRACTOR_MetaDataProcessor proc,
- void *proc_cls,
- const char * options)
-{
- if (data_size < 4)
- return 0;
- if (0 != memcmp (data, "\177ELF", 4))
- return 0;
- if (0 != proc (proc_cls,
- "mymime",
- EXTRACTOR_METATYPE_MIMETYPE,
- EXTRACTOR_METAFORMAT_UTF8,
- "text/plain",
- "application/x-executable",
- 1 + strlen("application/x-executable")))
- return 1;
- /* more calls to 'proc' here as needed */
- return 0;
-}
-</pre></td></tr></table>
-
-<hr size="6">
-<a name="Plugin-execution-options"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a
href="#Example-for-a-minimal-extract-method" title="Previous section in reading
order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Example-for-an-options-method"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Writing-new-Plugins"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Writing-new-Plugins" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internal-utility-functions"
title="Next chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">8.2 Plugin execution options</h2>
-
-<p>Plugins can request that their execution be done in a particular way.
-For this, the plugin defines a function with the following signature:
-</p>
-<pre class="verbatim">const char *
-EXTRACTOR_XXX_options (void);
+<pre class="example"><pre class="verbatim"> void
+ EXTRACTOR_mymime_extract (struct EXTRACTOR_ExtractContext *ec)
+ {
+ void *data;
+ ssize_t data_size,
+
+ if (-1 == (data_size = ec->read (ec->cls, &data, 4)))
+ return; /* read error */
+ if (data_size < 4)
+ return; /* file too small */
+ if (0 != memcmp (data, "\177ELF", 4))
+ return; /* not ELF */
+ if (0 != ec->proc (ec->cls,
+ "mymime",
+ EXTRACTOR_METATYPE_MIMETYPE,
+ EXTRACTOR_METAFORMAT_UTF8,
+ "text/plain",
+ "application/x-executable",
+ 1 + strlen("application/x-executable")))
+ return;
+ /* more calls to 'proc' here as needed */
+ }
</pre>
-<p>The function should return a string with the execution options.
-Individual options in this string should be separated by semicolons.
-Options that are included in the string but not known to the library
-are ignored. The following options are supported:
-</p>
-<ul>
-<li>
-<code>oop-only</code> ensures that the plugin is only run out-of-process; if
-this is not possible, the plugin will not be executed at all if this
-option is set.
+</pre>
+ <div class="node">
+<a name="Internal-utility-functions"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Reporting-bugs">Reporting
bugs</a>,
+Previous: <a rel="previous" accesskey="p"
href="#Writing-new-Plugins">Writing new Plugins</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-</li><li>
-<code>close-stderr</code> ensures that <code>stderr</code> is closed during the
-execution of the plugin. This is useful if the plugin uses libraries
-that write (error) messages to <code>stderr</code> and where this behavior
cannot be
-turned off. This option only works if the plugin is executed out-of-process.
+</div>
-</li><li>
-<code>close-stdout</code> ensures that <code>stdout</code> is closed during the
-execution of the plugin. This is useful if the plugin uses libraries
-that write messages to <code>stdout</code> and where this behavior cannot be
-turned off. This option only works if the plugin is executed out-of-process.
+<h2 class="chapter">9 Internal utility functions</h2>
-</li><li>
-<code>force-kill</code> kills and restarts the plugin process for each
-file that is being analyzed. This is useful if the plugin uses
-libraries that keep global state between runs that is problematic or
-if the plugin uses libraries that are known to have serious resource
-leaks (such as memory leaks).
-
-</li><li>
-<code>want-tail</code>
-In order to limit memory consumption, limit the amount if reading from
-disk and to keep the API simple, the ‘<samp>data</samp>’ argument
passed to
-the <code>EXTRACTOR_XXX_extract</code> method bounded (to 32 MB of normal
-data; for compressed data, a limit of 16 MB is imposed).<a name="DOCF4"
href="#FOOT4">(4)</a> Since
-some file formats contain meta data at the end of the file, this option
-provides a way for plugins to access not the first 16–32 MB of a file
-but instead the last (roughly) 32 MB.
-
-<p>Note that even for files larger than 32 MB, ‘<samp>size</samp>’
is not
-guaranteed to be 32 MB since ‘<samp>data</samp>’ will be aligned
to the page
-size of the operating system. However, the last byte of
‘<samp>data</samp>’
-is guaranteed to be the last byte of the file. Furthermore, if the
-file was large and compressed, unlike in the case of meta data
-extraction from the header, the end of the file will not be
-automatically decompressed by <acronym>GNU libextractor</acronym>.
-</p>
-</li></ul>
-
-<p>Note that using options other than <code>want-tail</code> is pretty much
-always a kludge and should thus be avoided.
-</p>
-<hr size="6">
-<a name="Example-for-an-options-method"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Plugin-execution-options"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Internal-utility-functions"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Writing-new-Plugins"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Writing-new-Plugins" title="Up
section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#Internal-utility-functions"
title="Next chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="section">8.3 Example for an options method</h2>
-
-<p>The following example shows how a plugin can set some of the options listed
above:
-</p><table><tr><td> </td><td><pre class="verbatim">const char *
-EXTRACTOR_id3_options ()
-{
- return "close-stderr;want-tail";
-}
-</pre></td></tr></table>
-
-<hr size="6">
-<a name="Internal-utility-functions"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Example-for-an-options-method"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Reporting-bugs" title="Next
section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Writing-new-Plugins"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Reporting-bugs" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Internal-utility-functions-1"></a>
-<h1 class="chapter">9. Internal utility functions</h1>
-
<p>Some plugins link against the <code>libextractor_common</code> library which
provides common abstractions needed by many plugins. This section
documents this internal API for plugin developers. Note that the headers
for this library are (intentionally) not installed: we do not consider
-this API stable and it should hence only be used by plugins that are
+this API stable and it should hence only be used by plugins that are
build and shipped with GNU libextractor. Third-party plugins should
not use it.
-</p>
-<p>‘<tt>convert_numeric.h</tt>’ defines various conversion
functions for
+
+ <p><samp><span class="file">convert_numeric.h</span></samp> defines various
conversion functions for
numbers (in particular, byte-order conversion for floating point
-numbers).
-</p>
-<p>‘<tt>unzip.h</tt>’ defines an API for accessing compressed
files.
-</p>
-<p>‘<tt>pack.h</tt>’ provides an interpreter for unpacking structs
of integer
+numbers).
+
+ <p><samp><span class="file">unzip.h</span></samp> defines an API for
accessing compressed files.
+
+ <p><samp><span class="file">pack.h</span></samp> provides an interpreter
for unpacking structs of integer
numbers from streams and converting from big or little endian to host
byte order at the same time.
-</p>
-<p>‘<tt>convert.h</tt>’ provides a function for character set
conversion described
+
+ <p><samp><span class="file">convert.h</span></samp> provides a function for
character set conversion described
below.
-</p>
-<dl>
-<dt><a
name="index-EXTRACTOR_005fcommon_005fconvert_005fto_005futf8"></a><u>Function:</u>
char * <b>EXTRACTOR_common_convert_to_utf8</b><i>(const char *input, size_t
len, const char * charset)</i></dt>
-<dd><a name="index-UTF_002d8"></a>
-<a name="index-character-set"></a>
-<a name="index-EXTRACTOR_005fcommon_005fconvert_005fto_005futf8-1"></a>
-<p>Various <acronym>GNU libextractor</acronym> plugins make use of the internal
-‘<tt>convert.h</tt>’ header which defines a function
-</p>
-<p><tt>EXTRACTOR_common_convert_to_utf8</tt> which can be used to easily
convert text from
+
+<div class="defun">
+— Function: char * <b>EXTRACTOR_common_convert_to_utf8</b> (<var>const
char *input, size_t len, const char *charset</var>)<var><a
name="index-EXTRACTOR_005fcommon_005fconvert_005fto_005futf8-59"></a></var><br>
+<blockquote><p><a name="index-UTF_002d8-60"></a><a
name="index-character-set-61"></a><a
name="index-EXTRACTOR_005fcommon_005fconvert_005fto_005futf8-62"></a>Various
<acronym>GNU libextractor</acronym> plugins make use of the internal
+<samp><span class="file">convert.h</span></samp> header which defines a
function
+
+ <p><tt>EXTRACTOR_common_convert_to_utf8</tt> which can be used to
easily convert text from
any character set to UTF-8. This conversion is important since the
linked list of keywords that is returned by <acronym>GNU
libextractor</acronym> is
expected to contain only UTF-8 strings. Naturally, proper conversion
may not always be possible since some file formats fail to specify the
character set. In that case, it is often better to not convert at
all.
-</p>
-<p>The arguments to <tt>EXTRACTOR_common_convert_to_utf8</tt> are the input
string (which
+
+ <p>The arguments to <tt>EXTRACTOR_common_convert_to_utf8</tt> are the
input string (which
does <em>not</em> have to be zero-terminated), the length of the input
-string, and the character set (which <em>must</em> be zero-terminated).
+string, and the character set (which <em>must</em> be zero-terminated).
Which character sets are supported depends on the platform, a list can
-generally be obtained using the <code>iconv -l</code> command. The
+generally be obtained using the <samp><span class="command">iconv
-l</span></samp> command. The
return value from <tt>EXTRACTOR_common_convert_to_utf8</tt> is a
zero-terminated string
in UTF-8 format. The responsibility to free the string is with the
-caller, so storing the string in the keyword list is acceptable.
-</p></dd></dl>
+caller, so storing the string in the keyword list is acceptable.
+</p></blockquote></div>
+<div class="node">
+<a name="Reporting-bugs"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Copying">Copying</a>,
+Previous: <a rel="previous" accesskey="p"
href="#Internal-utility-functions">Internal utility functions</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+</div>
+<h2 class="chapter">10 Reporting bugs</h2>
-
-<hr size="6">
-<a name="Reporting-bugs"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Internal-utility-functions"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Copying" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Internal-utility-functions"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Copying" title="Next chapter">
>> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Reporting-bugs-1"></a>
-<h1 class="chapter">10. Reporting bugs</h1>
-
-<a name="index-bug"></a>
-<p><acronym>GNU libextractor</acronym> uses the <a
href="http://gnunet.org/bugs/";>Mantis bugtracking system</a>. If possible,
please report bugs there. You can also e-mail
+<p><a name="index-bug-63"></a><acronym>GNU libextractor</acronym> uses the <a
href="https://gnunet.org/bugs/";>Mantis bugtracking system</a>. If possible,
please report bugs there. You can also e-mail
the <acronym>GNU libextractor</acronym> mailinglist at <a
href="address@hidden">address@hidden</a>.
-</p>
+<!-- ********************************************************** -->
+<!-- ******************* Appendices ************************* -->
+<!-- ********************************************************** -->
+<div class="node">
+<a name="Copying"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Concept-Index">Concept Index</a>,
+Previous: <a rel="previous" accesskey="p"
href="#Reporting-bugs">Reporting bugs</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+</div>
-<hr size="6">
-<a name="Copying"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Reporting-bugs"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Preamble" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Reporting-bugs" title="Beginning
of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="GNU-GENERAL-PUBLIC-LICENSE"></a>
-<h1 class="appendix">A. GNU GENERAL PUBLIC LICENSE</h1>
+<h2 class="appendix">Appendix A GNU GENERAL PUBLIC LICENSE</h2>
-<a name="index-GPL_002c-GNU-General-Public-License"></a>
-<p align="center"> Version 2, June 1991
-</p>
-<table><tr><td> </td><td><pre class="display">Copyright © 1989, 1991
Free Software Foundation, Inc.
-59 Temple Place – Suite 330, Boston, MA 02111-1307, USA
+<p><a name="index-GPL_002c-GNU-General-Public-License-64"></a><div
align="center">Version 2, June 1991</div>
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
-</pre></td></tr></table>
+<pre class="display"> Copyright © 1989, 1991 Free Software
Foundation, Inc.
+ 59 Temple Place – Suite 330, Boston, MA 02111-1307, USA
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+</pre>
+<h4 class="appendixsubsec">A.0.1 Preamble</h4>
-<hr size="6">
-<a name="Preamble"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Copying" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a
href="#How-to-Apply-These-Terms-to-Your-New-Programs" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Copying" title="Beginning of this
chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Copying" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h3 class="appendixsubsec">A.0.1 Preamble</h3>
-
-<p> The licenses for most software are designed to take away your
+<p>The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software—to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
-Foundation’s software and to any other program whose authors commit to
+Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
-</p>
-<p> When we speak of free software, we are referring to freedom, not
+
+ <p>When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
-</p>
-<p> To protect your rights, we need to make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
+
+ <p>To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
-</p>
-<p> For example, if you distribute copies of such a program, whether
+
+ <p>For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
-</p>
-<p> We protect your rights with two steps: (1) copyright the software, and
+
+ <p>We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
-</p>
-<p> Also, for each author’s protection and ours, we want to make certain
+
+ <p>Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
-authors’ reputations.
-</p>
-<p> Finally, any free program is threatened constantly by software
+authors' reputations.
+
+ <p>Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
-patent must be licensed for everyone’s free use or not licensed at all.
-</p>
-<p> The precise terms and conditions for copying, distribution and
+patent must be licensed for everyone's free use or not licensed at all.
+
+ <p>The precise terms and conditions for copying, distribution and
modification follow.
-</p>
-<ol>
-<li>
-This License applies to any program or other work which contains
+ <ol type=1 start=1>
+<li>This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The “Program”,
below,
refers to any such program or work, and a “work based on the
Program”
@@ -1898,15 +1108,14 @@
language. (Hereinafter, translation is included without limitation in
the term “modification”.) Each licensee is addressed as
“you”.
-<p>Activities other than copying, distribution and modification are not
+ <p>Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
+Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
-</p>
-</li><li>
-You may copy and distribute verbatim copies of the Program’s
+
+ <li>You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
@@ -1914,28 +1123,24 @@
and give any other recipients of the Program a copy of this License
along with the Program.
-<p>You may charge a fee for the physical act of transferring a copy, and
+ <p>You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
-</p>
-</li><li>
-You may modify your copy or copies of the Program or any portion
+
+ <li>You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
-<ol>
-<li>
-You must cause the modified files to carry prominent notices
+ <ol type=a start=1>
+<li>You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
-</li><li>
-You must cause any work that you distribute or publish, that in
+ <li>You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
-</li><li>
-If the modified program normally reads commands interactively
+ <li>If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
@@ -1945,9 +1150,9 @@
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
-</li></ol>
+ </ol>
-<p>These requirements apply to the modified work as a whole. If
+ <p>These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
@@ -1956,45 +1161,41 @@
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
-</p>
-<p>Thus, it is not the intent of this section to claim rights or contest
+
+ <p>Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
-</p>
-<p>In addition, mere aggregation of another work not based on the Program
+
+ <p>In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
-</p>
-</li><li>
-You may copy and distribute the Program (or a work based on it,
+
+ <li>You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
-<ol>
-<li>
-Accompany it with the complete corresponding machine-readable
+ <ol type=a start=1>
+<li>Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
-</li><li>
-Accompany it with a written offer, valid for at least three
+ <li>Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
-</li><li>
-Accompany it with the information you received as to the offer
+ <li>Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
-</li></ol>
+ </ol>
-<p>The source code for a work means the preferred form of the work for
+ <p>The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
@@ -2004,24 +1205,22 @@
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
-</p>
-<p>If distribution of executable or object code is made by offering
+
+ <p>If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
-</p>
-</li><li>
-You may not copy, modify, sublicense, or distribute the Program
+
+ <li>You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
-void, and will automatically terminate your rights under this License.
+void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
-</li><li>
-You are not required to accept this License, since you have not
+ <li>You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
@@ -2030,17 +1229,15 @@
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
-</li><li>
-Each time you redistribute the Program (or any work based on the
+ <li>Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
-restrictions on the recipients’ exercise of the rights granted herein.
+restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
-</li><li>
-If, as a consequence of a court judgment or allegation of patent
+ <li>If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
@@ -2053,12 +1250,12 @@
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
-<p>If any portion of this section is held invalid or unenforceable under
+ <p>If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
-</p>
-<p>It is not the purpose of this section to induce you to infringe any
+
+ <p>It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
@@ -2068,12 +1265,11 @@
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
-</p>
-<p>This section is intended to make thoroughly clear what is believed to
+
+ <p>This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
-</p>
-</li><li>
-If the distribution and/or use of the Program is restricted in
+
+ <li>If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
@@ -2081,22 +1277,20 @@
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
-</li><li>
-The Free Software Foundation may publish revised and/or new versions
+ <li>The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
-<p>Each version is given a distinguishing version number. If the Program
+ <p>Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and “any
later version”, you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
-</p>
-</li><li>
-If you wish to incorporate parts of the Program into other free
+
+ <li>If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
@@ -2104,9 +1298,7 @@
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
-
-</li><li>
-BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+ <li>BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED
@@ -2116,8 +1308,7 @@
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
-</li><li>
-IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+ <li>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
@@ -2126,599 +1317,168 @@
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
-</li></ol>
+ </ol>
+<h3 class="unnumberedsec">How to Apply These Terms to Your New Programs</h3>
-
-<hr size="6">
-<a name="How-to-Apply-These-Terms-to-Your-New-Programs"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Preamble" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index" title="Next section
in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Copying" title="Beginning of this
chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Copying" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index" title="Next
chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h2 class="unnumberedsec">How to Apply These Terms to Your New Programs</h2>
-
-<p> If you develop a new program, and you want it to be of the greatest
+<p>If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
-</p>
-<p> To do so, attach the following notices to the program. It is safest
+
+ <p>To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the “copyright” line and a pointer to where the full notice is
found.
-</p>
-<table><tr><td> </td><td><pre class="smallexample"><var>one line to give
the program's name and an idea of what it does.</var>
-Copyright (C) 19<var>yy</var> <var>name of author</var>
-This program is free software; you can redistribute it and/or
-modify it under the terms of the GNU General Public License
-as published by the Free Software Foundation; either version 2
-of the License, or (at your option) any later version.
+<pre class="smallexample"> <var>one line to give the program's name and an
idea of what it does.</var>
+ Copyright (C) 19<var>yy</var> <var>name of author</var>
+
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the GNU General Public License
+ as published by the Free Software Foundation; either version 2
+ of the License, or (at your option) any later version.
+
+ This program 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
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
+</pre>
+ <p>Also add information on how to contact you by electronic and paper mail.
-This program 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
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program; if not, write to the Free Software Foundation, Inc.,
-59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
-</pre></td></tr></table>
-
-<p>Also add information on how to contact you by electronic and paper mail.
-</p>
-<p>If the program is interactive, make it output a short notice like this
+ <p>If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
-</p>
-<table><tr><td> </td><td><pre class="smallexample">Gnomovision version
69, Copyright (C) 19<var>yy</var> <var>name of author</var>
-Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
-type `show w'. This is free software, and you are welcome
-to redistribute it under certain conditions; type `show c'
-for details.
-</pre></td></tr></table>
-<p>The hypothetical commands ‘<samp>show w</samp>’ and
‘<samp>show c</samp>’ should show
+<pre class="smallexample"> Gnomovision version 69, Copyright (C)
19<var>yy</var> <var>name of author</var>
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
+ type `show w'. This is free software, and you are welcome
+ to redistribute it under certain conditions; type `show c'
+ for details.
+</pre>
+ <p>The hypothetical commands ‘<samp><span class="samp">show
w</span></samp>’ and ‘<samp><span class="samp">show
c</span></samp>’ should show
the appropriate parts of the General Public License. Of course, the
-commands you use may be called something other than ‘<samp>show
w</samp>’ and
-‘<samp>show c</samp>’; they could even be mouse-clicks or menu
items—whatever
+commands you use may be called something other than ‘<samp><span
class="samp">show w</span></samp>’ and
+‘<samp><span class="samp">show c</span></samp>’; they could even
be mouse-clicks or menu items—whatever
suits your program.
-</p>
-<p>You should also get your employer (if you work as a programmer) or your
+
+ <p>You should also get your employer (if you work as a programmer) or your
school, if any, to sign a “copyright disclaimer” for the program,
if
necessary. Here is a sample; alter the names:
-</p>
-<table><tr><td> </td><td><pre class="smallexample">Yoyodyne, Inc., hereby
disclaims all copyright
-interest in the program `Gnomovision'
-(which makes passes at compilers) written
-by James Hacker.
-<var>signature of Ty Coon</var>, 1 April 1989
-Ty Coon, President of Vice
-</pre></td></tr></table>
-
-<p>This General Public License does not permit incorporating your program into
+<pre class="smallexample"> Yoyodyne, Inc., hereby disclaims all copyright
+ interest in the program `Gnomovision'
+ (which makes passes at compilers) written
+ by James Hacker.
+
+ <var>signature of Ty Coon</var>, 1 April 1989
+ Ty Coon, President of Vice
+</pre>
+ <p>This General Public License does not permit incorporating your program
into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.
-</p>
-<hr size="6">
+
+<div class="node">
<a name="Concept-Index"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a
href="#How-to-Apply-These-Terms-to-Your-New-Programs" title="Previous section
in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Function-and-Data-Index"
title="Next section in reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Copying" title="Beginning of this
chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Function-and-Data-Index"
title="Next chapter"> >> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Concept-Index-1"></a>
-<h1 class="unnumbered">Concept Index</h1>
+<p><hr>
+Next: <a rel="next" accesskey="n"
href="#Function-and-Data-Index">Function and Data Index</a>,
+Previous: <a rel="previous" accesskey="p" href="#Copying">Copying</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-<table><tr><th valign="top">Jump to: </th><td><a
href="#Concept-Index-1_cp_letter-B" class="summary-letter"><b>B</b></a>
-
-<a href="#Concept-Index-1_cp_letter-C" class="summary-letter"><b>C</b></a>
-
-<a href="#Concept-Index-1_cp_letter-D" class="summary-letter"><b>D</b></a>
-
-<a href="#Concept-Index-1_cp_letter-E" class="summary-letter"><b>E</b></a>
-
-<a href="#Concept-Index-1_cp_letter-G" class="summary-letter"><b>G</b></a>
-
-<a href="#Concept-Index-1_cp_letter-I" class="summary-letter"><b>I</b></a>
-
-<a href="#Concept-Index-1_cp_letter-J" class="summary-letter"><b>J</b></a>
-
-<a href="#Concept-Index-1_cp_letter-L" class="summary-letter"><b>L</b></a>
-
-<a href="#Concept-Index-1_cp_letter-M" class="summary-letter"><b>M</b></a>
-
-<a href="#Concept-Index-1_cp_letter-P" class="summary-letter"><b>P</b></a>
-
-<a href="#Concept-Index-1_cp_letter-R" class="summary-letter"><b>R</b></a>
-
-<a href="#Concept-Index-1_cp_letter-S" class="summary-letter"><b>S</b></a>
-
-<a href="#Concept-Index-1_cp_letter-T" class="summary-letter"><b>T</b></a>
-
-<a href="#Concept-Index-1_cp_letter-U" class="summary-letter"><b>U</b></a>
-
-</td></tr></table>
-<table border="0" class="index-cp">
-<tr><td></td><th align="left">Index Entry</th><th align="left">
Section</th></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index-1_cp_letter-B">B</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-bug">bug</a></td><td
valign="top"><a href="#Reporting-bugs">10. Reporting bugs</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-bus-error">bus error</a></td><td
valign="top"><a href="#Extracting">4.4 Extracting</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index-1_cp_letter-C">C</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-character-set">character
set</a></td><td valign="top"><a href="#Internal-utility-functions">9. Internal
utility functions</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-concurrency">concurrency</a></td><td valign="top"><a
href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-concurrency-1">concurrency</a></td><td valign="top"><a
href="#Extracting">4.4 Extracting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-concurrency-2">concurrency</a></td><td valign="top"><a
href="#Utility-functions">6. Utility functions</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index-1_cp_letter-D">D</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-directory-structure">directory
structure</a></td><td valign="top"><a href="#Preparation">2.
Preparation</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index-1_cp_letter-E">E</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-environment-variables">environment variables</a></td><td
valign="top"><a href="#Preparation">2. Preparation</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-error-handling">error
handling</a></td><td valign="top"><a href="#Introduction">1.
Introduction</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index-1_cp_letter-G">G</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-gettext">gettext</a></td><td
valign="top"><a href="#Meta-types">4.2 Meta types</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-gettext-1">gettext</a></td><td
valign="top"><a href="#Meta-types">4.2 Meta types</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-GPL_002c-GNU-General-Public-License">GPL, GNU General Public
License</a></td><td valign="top"><a href="#Copying">A. GNU GENERAL PUBLIC
LICENSE</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index-1_cp_letter-I">I</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-internationalization">internationalization</a></td><td
valign="top"><a href="#Meta-types">4.2 Meta types</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-internationalization-1">internationalization</a></td><td
valign="top"><a href="#Meta-types">4.2 Meta types</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index-1_cp_letter-J">J</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-Java">Java</a></td><td
valign="top"><a href="#Language-bindings">5. Language bindings</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index-1_cp_letter-L">L</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-license">license</a></td><td
valign="top"><a href="#Introduction">1. Introduction</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index-1_cp_letter-M">M</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-Mono">Mono</a></td><td
valign="top"><a href="#Language-bindings">5. Language bindings</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index-1_cp_letter-P">P</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-packageing">packageing</a></td><td valign="top"><a
href="#Preparation">2. Preparation</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-Perl">Perl</a></td><td
valign="top"><a href="#Language-bindings">5. Language bindings</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-PHP">PHP</a></td><td
valign="top"><a href="#Language-bindings">5. Language bindings</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-plugin">plugin</a></td><td
valign="top"><a href="#Introduction">1. Introduction</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-plugin-1">plugin</a></td><td
valign="top"><a href="#Preparation">2. Preparation</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-Python">Python</a></td><td
valign="top"><a href="#Language-bindings">5. Language bindings</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index-1_cp_letter-R">R</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-reentrant">reentrant</a></td><td
valign="top"><a href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-reentrant-1">reentrant</a></td><td valign="top"><a
href="#Extracting">4.4 Extracting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-reentrant-2">reentrant</a></td><td valign="top"><a
href="#Utility-functions">6. Utility functions</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-Ruby">Ruby</a></td><td
valign="top"><a href="#Language-bindings">5. Language bindings</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index-1_cp_letter-S">S</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-SIGBUS">SIGBUS</a></td><td
valign="top"><a href="#Extracting">4.4 Extracting</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index-1_cp_letter-T">T</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-thread_002dsafety">thread-safety</a></td><td valign="top"><a
href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-thread_002dsafety-1">thread-safety</a></td><td valign="top"><a
href="#Extracting">4.4 Extracting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-thread_002dsafety-2">thread-safety</a></td><td valign="top"><a
href="#Utility-functions">6. Utility functions</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-threads">threads</a></td><td
valign="top"><a href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-threads-1">threads</a></td><td
valign="top"><a href="#Extracting">4.4 Extracting</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-threads-2">threads</a></td><td
valign="top"><a href="#Utility-functions">6. Utility functions</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Concept-Index-1_cp_letter-U">U</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-UTF_002d8">UTF-8</a></td><td
valign="top"><a href="#Internal-utility-functions">9. Internal utility
functions</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-</table>
-<table><tr><th valign="top">Jump to: </th><td><a
href="#Concept-Index-1_cp_letter-B" class="summary-letter"><b>B</b></a>
-
-<a href="#Concept-Index-1_cp_letter-C" class="summary-letter"><b>C</b></a>
-
-<a href="#Concept-Index-1_cp_letter-D" class="summary-letter"><b>D</b></a>
-
-<a href="#Concept-Index-1_cp_letter-E" class="summary-letter"><b>E</b></a>
-
-<a href="#Concept-Index-1_cp_letter-G" class="summary-letter"><b>G</b></a>
-
-<a href="#Concept-Index-1_cp_letter-I" class="summary-letter"><b>I</b></a>
-
-<a href="#Concept-Index-1_cp_letter-J" class="summary-letter"><b>J</b></a>
-
-<a href="#Concept-Index-1_cp_letter-L" class="summary-letter"><b>L</b></a>
-
-<a href="#Concept-Index-1_cp_letter-M" class="summary-letter"><b>M</b></a>
-
-<a href="#Concept-Index-1_cp_letter-P" class="summary-letter"><b>P</b></a>
-
-<a href="#Concept-Index-1_cp_letter-R" class="summary-letter"><b>R</b></a>
-
-<a href="#Concept-Index-1_cp_letter-S" class="summary-letter"><b>S</b></a>
-
-<a href="#Concept-Index-1_cp_letter-T" class="summary-letter"><b>T</b></a>
-
-<a href="#Concept-Index-1_cp_letter-U" class="summary-letter"><b>U</b></a>
-
-</td></tr></table>
+</div>
-<hr size="6">
+<h2 class="unnumbered">Concept Index</h2>
+
+<ul class="index-cp" compact>
+<li><a href="#index-bug-63">bug</a>: <a href="#Reporting-bugs">Reporting
bugs</a></li>
+<li><a href="#index-bus-error-46">bus error</a>: <a
href="#Extracting">Extracting</a></li>
+<li><a href="#index-character-set-61">character set</a>: <a
href="#Internal-utility-functions">Internal utility functions</a></li>
+<li><a href="#index-concurrency-54">concurrency</a>: <a
href="#Utility-functions">Utility functions</a></li>
+<li><a href="#index-concurrency-42">concurrency</a>: <a
href="#Extracting">Extracting</a></li>
+<li><a href="#index-concurrency-10">concurrency</a>: <a
href="#Plugin-management">Plugin management</a></li>
+<li><a href="#index-directory-structure-5">directory structure</a>: <a
href="#Preparation">Preparation</a></li>
+<li><a href="#index-environment-variables-7">environment variables</a>: <a
href="#Preparation">Preparation</a></li>
+<li><a href="#index-error-handling-1">error handling</a>: <a
href="#Introduction">Introduction</a></li>
+<li><a href="#index-gettext-30">gettext</a>: <a href="#Meta-types">Meta
types</a></li>
+<li><a href="#index-GPL_002c-GNU-General-Public-License-64">GPL, GNU General
Public License</a>: <a href="#Copying">Copying</a></li>
+<li><a href="#index-internationalization-31">internationalization</a>: <a
href="#Meta-types">Meta types</a></li>
+<li><a href="#index-Java-47">Java</a>: <a href="#Language-bindings">Language
bindings</a></li>
+<li><a href="#index-license-3">license</a>: <a
href="#Introduction">Introduction</a></li>
+<li><a href="#index-Mono-48">Mono</a>: <a href="#Language-bindings">Language
bindings</a></li>
+<li><a href="#index-packageing-4">packageing</a>: <a
href="#Preparation">Preparation</a></li>
+<li><a href="#index-Perl-49">Perl</a>: <a href="#Language-bindings">Language
bindings</a></li>
+<li><a href="#index-PHP-51">PHP</a>: <a href="#Language-bindings">Language
bindings</a></li>
+<li><a href="#index-plugin-6">plugin</a>: <a
href="#Preparation">Preparation</a></li>
+<li><a href="#index-plugin-2">plugin</a>: <a
href="#Introduction">Introduction</a></li>
+<li><a href="#index-Python-50">Python</a>: <a
href="#Language-bindings">Language bindings</a></li>
+<li><a href="#index-reentrant-53">reentrant</a>: <a
href="#Utility-functions">Utility functions</a></li>
+<li><a href="#index-reentrant-41">reentrant</a>: <a
href="#Extracting">Extracting</a></li>
+<li><a href="#index-reentrant-9">reentrant</a>: <a
href="#Plugin-management">Plugin management</a></li>
+<li><a href="#index-Ruby-52">Ruby</a>: <a href="#Language-bindings">Language
bindings</a></li>
+<li><a href="#index-SIGBUS-45">SIGBUS</a>: <a
href="#Extracting">Extracting</a></li>
+<li><a href="#index-thread_002dsafety-56">thread-safety</a>: <a
href="#Utility-functions">Utility functions</a></li>
+<li><a href="#index-thread_002dsafety-44">thread-safety</a>: <a
href="#Extracting">Extracting</a></li>
+<li><a href="#index-thread_002dsafety-12">thread-safety</a>: <a
href="#Plugin-management">Plugin management</a></li>
+<li><a href="#index-threads-55">threads</a>: <a
href="#Utility-functions">Utility functions</a></li>
+<li><a href="#index-threads-43">threads</a>: <a
href="#Extracting">Extracting</a></li>
+<li><a href="#index-threads-11">threads</a>: <a
href="#Plugin-management">Plugin management</a></li>
+<li><a href="#index-UTF_002d8-60">UTF-8</a>: <a
href="#Internal-utility-functions">Internal utility functions</a></li>
+ </ul><div class="node">
<a name="Function-and-Data-Index"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Concept-Index" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#Type-Index" title="Next section in
reading order"> > </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Concept-Index" title="Beginning of
this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#Type-Index" title="Next chapter">
>> </a>]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Function-and-Data-Index-1"></a>
-<h1 class="unnumbered">Function and Data Index</h1>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Type-Index">Type Index</a>,
+Previous: <a rel="previous" accesskey="p" href="#Concept-Index">Concept
Index</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-<table><tr><th valign="top">Jump to: </th><td><a
href="#Function-and-Data-Index-1_fn_symbol-1"
class="summary-letter"><b>(</b></a>
-
-<br>
-<a href="#Function-and-Data-Index-1_fn_letter-E"
class="summary-letter"><b>E</b></a>
-
-</td></tr></table>
-<table border="0" class="index-fn">
-<tr><td></td><th align="left">Index Entry</th><th align="left">
Section</th></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Function-and-Data-Index-1_fn_symbol-1">(</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-_0028"><code>(</code></a></td><td valign="top"><a
href="#Extracting">4.4 Extracting</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a
name="Function-and-Data-Index-1_fn_letter-E">E</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fcommon_005fconvert_005fto_005futf8"><code>EXTRACTOR_common_convert_to_utf8</code></a></td><td
valign="top"><a href="#Internal-utility-functions">9. Internal utility
functions</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fcommon_005fconvert_005fto_005futf8-1"><code>EXTRACTOR_common_convert_to_utf8</code></a></td><td
valign="top"><a href="#Internal-utility-functions">9. Internal utility
functions</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fextract"><code>EXTRACTOR_extract</code></a></td><td
valign="top"><a href="#Extracting">4.4 Extracting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fextract-1"><code>EXTRACTOR_extract</code></a></td><td
valign="top"><a href="#Extracting">4.4 Extracting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fmetatype_005fget_005fmax"><code>EXTRACTOR_metatype_get_max</code></a></td><td
valign="top"><a href="#Meta-types">4.2 Meta types</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fmetatype_005fto_005fdescription"><code>EXTRACTOR_metatype_to_description</code></a></td><td
valign="top"><a href="#Meta-types">4.2 Meta types</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fmetatype_005fto_005fdescription-1"><code>EXTRACTOR_metatype_to_description</code></a></td><td
valign="top"><a href="#Meta-types">4.2 Meta types</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fmetatype_005fto_005fstring"><code>EXTRACTOR_metatype_to_string</code></a></td><td
valign="top"><a href="#Meta-types">4.2 Meta types</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fmetatype_005fto_005fstring-1"><code>EXTRACTOR_metatype_to_string</code></a></td><td
valign="top"><a href="#Meta-types">4.2 Meta types</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fmeta_005fdata_005fprint"><code>EXTRACTOR_meta_data_print</code></a></td><td
valign="top"><a href="#Meta-data-printing">6.2 Meta data printing</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fplugin_005fadd"><code>EXTRACTOR_plugin_add</code></a></td><td
valign="top"><a href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fplugin_005fadd-1"><code>EXTRACTOR_plugin_add</code></a></td><td
valign="top"><a href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fplugin_005fadd_005fconfig"><code>EXTRACTOR_plugin_add_config</code></a></td><td
valign="top"><a href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fplugin_005fadd_005fconfig-1"><code>EXTRACTOR_plugin_add_config</code></a></td><td
valign="top"><a href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fplugin_005fadd_005fdefaults"><code>EXTRACTOR_plugin_add_defaults</code></a></td><td
valign="top"><a href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fplugin_005fadd_005fdefaults-1"><code>EXTRACTOR_plugin_add_defaults</code></a></td><td
valign="top"><a href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fplugin_005fremove"><code>EXTRACTOR_plugin_remove</code></a></td><td
valign="top"><a href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fplugin_005fremove-1"><code>EXTRACTOR_plugin_remove</code></a></td><td
valign="top"><a href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fplugin_005fremove_005fall"><code>EXTRACTOR_plugin_remove_all</code></a></td><td
valign="top"><a href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fplugin_005fremove_005fall-1"><code>EXTRACTOR_plugin_remove_all</code></a></td><td
valign="top"><a href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fVERSION"><code>EXTRACTOR_VERSION</code></a></td><td
valign="top"><a href="#Utility-Constants">6.1 Utility Constants</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-</table>
-<table><tr><th valign="top">Jump to: </th><td><a
href="#Function-and-Data-Index-1_fn_symbol-1"
class="summary-letter"><b>(</b></a>
-
-<br>
-<a href="#Function-and-Data-Index-1_fn_letter-E"
class="summary-letter"><b>E</b></a>
-
-</td></tr></table>
+</div>
-<hr size="6">
-<a name="Type-Index"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Function-and-Data-Index"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[ > ]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Function-and-Data-Index"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
-<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[ >> ]</td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left"> </td>
-<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<a name="Type-Index-1"></a>
-<h1 class="unnumbered">Type Index</h1>
+<h2 class="unnumbered">Function and Data Index</h2>
-<table><tr><th valign="top">Jump to: </th><td><a
href="#Type-Index-1_tp_letter-E" class="summary-letter"><b>E</b></a>
-
-<a href="#Type-Index-1_tp_letter-S" class="summary-letter"><b>S</b></a>
-
-</td></tr></table>
-<table border="0" class="index-tp">
-<tr><td></td><th align="left">Index Entry</th><th align="left">
Section</th></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Type-Index-1_tp_letter-E">E</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-enum-EXTRACTOR_005fMetaFormat"><code>enum
EXTRACTOR_MetaFormat</code></a></td><td valign="top"><a
href="#Meta-formats">4.3 Meta formats</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-enum-EXTRACTOR_005fMetaType"><code>enum
EXTRACTOR_MetaType</code></a></td><td valign="top"><a href="#Meta-types">4.2
Meta types</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-enum-EXTRACTOR_005fOptions"><code>enum
EXTRACTOR_Options</code></a></td><td valign="top"><a
href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fMetaDataProcessor"><code>EXTRACTOR_MetaDataProcessor</code></a></td><td
valign="top"><a href="#Extracting">4.4 Extracting</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-EXTRACTOR_005fPluginList"><code>EXTRACTOR_PluginList</code></a></td><td
valign="top"><a href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-<tr><th><a name="Type-Index-1_tp_letter-S">S</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-struct-EXTRACTOR_005fPluginList"><code>struct
EXTRACTOR_PluginList</code></a></td><td valign="top"><a
href="#Plugin-management">4.1 Plugin management</a></td></tr>
-<tr><td colspan="3"> <hr></td></tr>
-</table>
-<table><tr><th valign="top">Jump to: </th><td><a
href="#Type-Index-1_tp_letter-E" class="summary-letter"><b>E</b></a>
-
-<a href="#Type-Index-1_tp_letter-S" class="summary-letter"><b>S</b></a>
-
-</td></tr></table>
-<hr size="6">
-<a name="SEC_Foot"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h1>Footnotes</h1>
-<h3><a name="FOOT1" href="#DOCF1">(1)</a></h3>
-<p>Some distributions ship <code>extract</code> in a
-seperate package.
-</p><h3><a name="FOOT2" href="#DOCF2">(2)</a></h3>
-<p>It
-maybe possible to switch to GPLv3 in the future. For this, an audit
-of the license status of our dependencies would be required. The new
-code that was developed specifically for <acronym>GNU libextractor</acronym>
has
-always been licensed under GPLv2 <em>or any later version</em>.
-</p><h3><a name="FOOT3" href="#DOCF3">(3)</a></h3>
-<p>Debian policy
-furthermore requires a ‘<tt>-dev</tt>’ (meta) package that would
depend on
-all of the above packages.
-</p><h3><a name="FOOT4" href="#DOCF4">(4)</a></h3>
-<p>If
-<acronym>GNU libextractor</acronym> was given a pointer to an existing,
uncompressed block of
-data in memory, no bound is imposed for plugins executing in-process;
-for out-of-process plugins, a 32 MB limit is still imposed.
-</p><hr size="1">
-<a name="SEC_Contents"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h1>Table of Contents</h1>
-<div class="contents">
-<ul class="toc">
- <li><a name="toc-Introduction-1" href="#Introduction">1.
Introduction</a></li>
- <li><a name="toc-Preparation-1" href="#Preparation">2. Preparation</a>
- <ul class="toc">
- <li><a name="toc-Installation-on-GNU_002fLinux"
href="#Installation-on-GNU_002fLinux">2.1 Installation on GNU/Linux</a></li>
- <li><a name="toc-Installation-on-FreeBSD"
href="#Installation-on-FreeBSD">2.2 Installation on FreeBSD</a></li>
- <li><a name="toc-Installation-on-OpenBSD"
href="#Installation-on-OpenBSD">2.3 Installation on OpenBSD</a></li>
- <li><a name="toc-Installation-on-NetBSD"
href="#Installation-on-NetBSD">2.4 Installation on NetBSD</a></li>
- <li><a name="toc-Installation-using-MinGW"
href="#Installation-using-MinGW">2.5 Installation using MinGW</a></li>
- <li><a name="toc-Installation-on-OS-X" href="#Installation-on-OS-X">2.6
Installation on OS X</a>
- <ul class="toc">
- <li><a name="toc-Installing-and-uninstalling-the-framework"
href="#Installing-and-uninstalling-the-framework">2.6.1 Installing and
uninstalling the framework</a></li>
- <li><a name="toc-Using-the-framework" href="#Using-the-framework">2.6.2
Using the framework</a></li>
- <li><a name="toc-Example-for-using-the-framework"
href="#Example-for-using-the-framework">2.6.3 Example for using the
framework</a></li>
- <li><a name="toc-Example-for-using-the-dynamic-library"
href="#Example-for-using-the-dynamic-library">2.6.4 Example for using the
dynamic library</a></li>
- </ul></li>
- <li><a name="toc-Note-to-package-maintainers"
href="#Note-to-package-maintainers">2.7 Note to package maintainers</a></li>
- </ul></li>
- <li><a name="toc-Generalities-1" href="#Generalities">3. Generalities</a>
- <ul class="toc">
- <li><a name="toc-Introduction-to-the-_0060_0060extract_0027_0027-command"
href="#Introduction-to-the-_0060_0060extract_0027_0027-command">3.1
Introduction to the “extract” command</a></li>
- <li><a name="toc-Common-usage-examples-for-_0060_0060extract_0027_0027"
href="#Common-usage-examples-for-_0060_0060extract_0027_0027">3.2 Common usage
examples for “extract”</a></li>
- <li><a name="toc-Introduction-to-the-libextractor-library"
href="#Introduction-to-the-libextractor-library">3.3 Introduction to the
libextractor library</a></li>
- </ul></li>
- <li><a name="toc-Extracting-meta-data-1" href="#Extracting-meta-data">4.
Extracting meta data</a>
- <ul class="toc">
- <li><a name="toc-Plugin-management-1" href="#Plugin-management">4.1 Plugin
management</a></li>
- <li><a name="toc-Meta-types-1" href="#Meta-types">4.2 Meta types</a></li>
- <li><a name="toc-Meta-formats-1" href="#Meta-formats">4.3 Meta
formats</a></li>
- <li><a name="toc-Extracting-1" href="#Extracting">4.4 Extracting</a></li>
- </ul></li>
- <li><a name="toc-Language-bindings-1" href="#Language-bindings">5. Language
bindings</a>
- <ul class="toc">
- <li><a name="toc-Java" href="#Java">5.1 Java</a></li>
- <li><a name="toc-Mono" href="#Mono">5.2 Mono</a></li>
- <li><a name="toc-Perl" href="#Perl">5.3 Perl</a></li>
- <li><a name="toc-Python" href="#Python">5.4 Python</a></li>
- <li><a name="toc-PHP" href="#PHP">5.5 PHP</a></li>
- <li><a name="toc-Ruby" href="#Ruby">5.6 Ruby</a></li>
- </ul></li>
- <li><a name="toc-Utility-functions-1" href="#Utility-functions">6. Utility
functions</a>
- <ul class="toc">
- <li><a name="toc-Utility-Constants-1" href="#Utility-Constants">6.1
Utility Constants</a></li>
- <li><a name="toc-Meta-data-printing-1" href="#Meta-data-printing">6.2 Meta
data printing</a></li>
- </ul></li>
- <li><a name="toc-Existing-Plugins-1" href="#Existing-Plugins">7. Existing
Plugins</a></li>
- <li><a name="toc-Writing-new-Plugins-1" href="#Writing-new-Plugins">8.
Writing new Plugins</a>
- <ul class="toc">
- <li><a name="toc-Example-for-a-minimal-extract-method"
href="#Example-for-a-minimal-extract-method">8.1 Example for a minimal extract
method</a></li>
- <li><a name="toc-Plugin-execution-options"
href="#Plugin-execution-options">8.2 Plugin execution options</a></li>
- <li><a name="toc-Example-for-an-options-method"
href="#Example-for-an-options-method">8.3 Example for an options method</a></li>
- </ul></li>
- <li><a name="toc-Internal-utility-functions-1"
href="#Internal-utility-functions">9. Internal utility functions</a></li>
- <li><a name="toc-Reporting-bugs-1" href="#Reporting-bugs">10. Reporting
bugs</a></li>
- <li><a name="toc-GNU-GENERAL-PUBLIC-LICENSE" href="#Copying">A. GNU GENERAL
PUBLIC LICENSE</a>
- <ul class="toc">
+<ul class="index-fn" compact>
+<li><a href="#index-g_t_0028-37"><code>(</code></a>: <a
href="#Extracting">Extracting</a></li>
+<li><a
href="#index-EXTRACTOR_005fcommon_005fconvert_005fto_005futf8-59"><code>EXTRACTOR_common_convert_to_utf8</code></a>:
<a href="#Internal-utility-functions">Internal utility functions</a></li>
+<li><a
href="#index-EXTRACTOR_005fextract-39"><code>EXTRACTOR_extract</code></a>: <a
href="#Extracting">Extracting</a></li>
+<li><a
href="#index-EXTRACTOR_005fmeta_005fdata_005fprint-58"><code>EXTRACTOR_meta_data_print</code></a>:
<a href="#Meta-data-printing">Meta data printing</a></li>
+<li><a
href="#index-EXTRACTOR_005fmetatype_005fget_005fmax-27"><code>EXTRACTOR_metatype_get_max</code></a>:
<a href="#Meta-types">Meta types</a></li>
+<li><a
href="#index-EXTRACTOR_005fmetatype_005fto_005fdescription-32"><code>EXTRACTOR_metatype_to_description</code></a>:
<a href="#Meta-types">Meta types</a></li>
+<li><a
href="#index-EXTRACTOR_005fmetatype_005fto_005fstring-28"><code>EXTRACTOR_metatype_to_string</code></a>:
<a href="#Meta-types">Meta types</a></li>
+<li><a
href="#index-EXTRACTOR_005fplugin_005fadd-20"><code>EXTRACTOR_plugin_add</code></a>:
<a href="#Plugin-management">Plugin management</a></li>
+<li><a
href="#index-EXTRACTOR_005fplugin_005fadd_005fconfig-22"><code>EXTRACTOR_plugin_add_config</code></a>:
<a href="#Plugin-management">Plugin management</a></li>
+<li><a
href="#index-EXTRACTOR_005fplugin_005fadd_005fdefaults-24"><code>EXTRACTOR_plugin_add_defaults</code></a>:
<a href="#Plugin-management">Plugin management</a></li>
+<li><a
href="#index-EXTRACTOR_005fplugin_005fremove-18"><code>EXTRACTOR_plugin_remove</code></a>:
<a href="#Plugin-management">Plugin management</a></li>
+<li><a
href="#index-EXTRACTOR_005fplugin_005fremove_005fall-16"><code>EXTRACTOR_plugin_remove_all</code></a>:
<a href="#Plugin-management">Plugin management</a></li>
+<li><a
href="#index-EXTRACTOR_005fVERSION-57"><code>EXTRACTOR_VERSION</code></a>: <a
href="#Utility-Constants">Utility Constants</a></li>
+ </ul><div class="node">
+<a name="Type-Index"></a>
+<p><hr>
+Previous: <a rel="previous" accesskey="p"
href="#Function-and-Data-Index">Function and Data Index</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
- <ul class="toc">
- <li><a name="toc-Preamble" href="#Preamble">A.0.1 Preamble</a></li>
- </ul></li>
- <li><a name="toc-How-to-Apply-These-Terms-to-Your-New-Programs"
href="#How-to-Apply-These-Terms-to-Your-New-Programs">How to Apply These Terms
to Your New Programs</a></li>
- </ul></li>
- <li><a name="toc-Concept-Index-1" href="#Concept-Index">Concept
Index</a></li>
- <li><a name="toc-Function-and-Data-Index-1"
href="#Function-and-Data-Index">Function and Data Index</a></li>
- <li><a name="toc-Type-Index-1" href="#Type-Index">Type Index</a></li>
-</ul>
</div>
-<hr size="1">
-<a name="SEC_Overview"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h1>Short Table of Contents</h1>
-<div class="shortcontents">
-<ul class="toc">
-<li><a name="stoc-Introduction-1" href="#Introduction">1. Introduction</a></li>
-<li><a name="stoc-Preparation-1" href="#Preparation">2. Preparation</a></li>
-<li><a name="stoc-Generalities-1" href="#Generalities">3. Generalities</a></li>
-<li><a name="stoc-Extracting-meta-data-1" href="#Extracting-meta-data">4.
Extracting meta data</a></li>
-<li><a name="stoc-Language-bindings-1" href="#Language-bindings">5. Language
bindings</a></li>
-<li><a name="stoc-Utility-functions-1" href="#Utility-functions">6. Utility
functions</a></li>
-<li><a name="stoc-Existing-Plugins-1" href="#Existing-Plugins">7. Existing
Plugins</a></li>
-<li><a name="stoc-Writing-new-Plugins-1" href="#Writing-new-Plugins">8.
Writing new Plugins</a></li>
-<li><a name="stoc-Internal-utility-functions-1"
href="#Internal-utility-functions">9. Internal utility functions</a></li>
-<li><a name="stoc-Reporting-bugs-1" href="#Reporting-bugs">10. Reporting
bugs</a></li>
-<li><a name="stoc-GNU-GENERAL-PUBLIC-LICENSE" href="#Copying">A. GNU GENERAL
PUBLIC LICENSE</a></li>
-<li><a name="stoc-Concept-Index-1" href="#Concept-Index">Concept Index</a></li>
-<li><a name="stoc-Function-and-Data-Index-1"
href="#Function-and-Data-Index">Function and Data Index</a></li>
-<li><a name="stoc-Type-Index-1" href="#Type-Index">Type Index</a></li>
-</ul>
-</div>
-<hr size="1">
-<a name="SEC_About"></a>
-<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
-<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
-<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
-</tr></table>
-<h1>About This Document</h1>
-<p>
- This document was generated by <em>Christian Grothoff</em> on <em>January
13, 2010</em> using <a href="http://www.nongnu.org/texi2html/";><em>texi2html
1.82</em></a>.
-</p>
-<p>
- The buttons in the navigation panels have the following meaning:
-</p>
-<table border="1">
- <tr>
- <th> Button </th>
- <th> Name </th>
- <th> Go to </th>
- <th> From 1.2.3 go to</th>
- </tr>
- <tr>
- <td align="center"> [ < ] </td>
- <td align="center">Back</td>
- <td>Previous section in reading order</td>
- <td>1.2.2</td>
- </tr>
- <tr>
- <td align="center"> [ > ] </td>
- <td align="center">Forward</td>
- <td>Next section in reading order</td>
- <td>1.2.4</td>
- </tr>
- <tr>
- <td align="center"> [ << ] </td>
- <td align="center">FastBack</td>
- <td>Beginning of this chapter or previous chapter</td>
- <td>1</td>
- </tr>
- <tr>
- <td align="center"> [ Up ] </td>
- <td align="center">Up</td>
- <td>Up section</td>
- <td>1.2</td>
- </tr>
- <tr>
- <td align="center"> [ >> ] </td>
- <td align="center">FastForward</td>
- <td>Next chapter</td>
- <td>2</td>
- </tr>
- <tr>
- <td align="center"> [Top] </td>
- <td align="center">Top</td>
- <td>Cover (top) of document</td>
- <td> </td>
- </tr>
- <tr>
- <td align="center"> [Contents] </td>
- <td align="center">Contents</td>
- <td>Table of contents</td>
- <td> </td>
- </tr>
- <tr>
- <td align="center"> [Index] </td>
- <td align="center">Index</td>
- <td>Index</td>
- <td> </td>
- </tr>
- <tr>
- <td align="center"> [ ? ] </td>
- <td align="center">About</td>
- <td>About (help)</td>
- <td> </td>
- </tr>
-</table>
-<p>
- where the <strong> Example </strong> assumes that the current position is at
<strong> Subsubsection One-Two-Three </strong> of a document of the following
structure:
-</p>
+<h2 class="unnumbered">Type Index</h2>
-<ul>
- <li> 1. Section One
- <ul>
- <li>1.1 Subsection One-One
- <ul>
- <li>...</li>
- </ul>
- </li>
- <li>1.2 Subsection One-Two
- <ul>
- <li>1.2.1 Subsubsection One-Two-One</li>
- <li>1.2.2 Subsubsection One-Two-Two</li>
- <li>1.2.3 Subsubsection One-Two-Three
- <strong><== Current Position </strong></li>
- <li>1.2.4 Subsubsection One-Two-Four</li>
- </ul>
- </li>
- <li>1.3 Subsection One-Three
- <ul>
- <li>...</li>
- </ul>
- </li>
- <li>1.4 Subsection One-Four</li>
- </ul>
- </li>
-</ul>
-<hr size="1">
-<p>
- <font size="-1">
- This document was generated by <em>Christian Grothoff</em> on <em>January
13, 2010</em> using <a href="http://www.nongnu.org/texi2html/";><em>texi2html
1.82</em></a>.
- </font>
- <br>
-</p>
-</body>
-</html>
+<ul class="index-tp" compact>
+<li><a href="#index-enum-EXTRACTOR_005fMetaFormat-36"><code>enum
EXTRACTOR_MetaFormat</code></a>: <a href="#Meta-formats">Meta formats</a></li>
+<li><a href="#index-enum-EXTRACTOR_005fMetaType-26"><code>enum
EXTRACTOR_MetaType</code></a>: <a href="#Meta-types">Meta types</a></li>
+<li><a href="#index-enum-EXTRACTOR_005fOptions-13"><code>enum
EXTRACTOR_Options</code></a>: <a href="#Plugin-management">Plugin
management</a></li>
+<li><a
href="#index-EXTRACTOR_005fMetaDataProcessor-38"><code>EXTRACTOR_MetaDataProcessor</code></a>:
<a href="#Extracting">Extracting</a></li>
+<li><a
href="#index-EXTRACTOR_005fPluginList-14"><code>EXTRACTOR_PluginList</code></a>:
<a href="#Plugin-management">Plugin management</a></li>
+<li><a href="#index-struct-EXTRACTOR_005fPluginList-15"><code>struct
EXTRACTOR_PluginList</code></a>: <a href="#Plugin-management">Plugin
management</a></li>
+ </ul><div class="footnote">
+<hr>
+<a name="texinfo-footnotes-in-document"></a><h4>Footnotes</h4><p
class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small> Some
distributions ship <samp><span class="command">extract</span></samp> in a
+seperate package.</p>
+
+ <hr></div>
+
+</body></html>
+
Added: Extractor-docs/WWW/manual/extractor.html.gz
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/extractor.html.gz
===================================================================
--- Extractor-docs/WWW/manual/extractor.html.gz 2012-09-06 10:54:46 UTC (rev
23667)
+++ Extractor-docs/WWW/manual/extractor.html.gz 2012-09-06 11:11:18 UTC (rev
23668)
Property changes on: Extractor-docs/WWW/manual/extractor.html.gz
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: Extractor-docs/WWW/manual/extractor.html_node.tar.gz
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/extractor.html_node.tar.gz
===================================================================
--- Extractor-docs/WWW/manual/extractor.html_node.tar.gz 2012-09-06
10:54:46 UTC (rev 23667)
+++ Extractor-docs/WWW/manual/extractor.html_node.tar.gz 2012-09-06
11:11:18 UTC (rev 23668)
Property changes on: Extractor-docs/WWW/manual/extractor.html_node.tar.gz
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: Extractor-docs/WWW/manual/extractor.info.tar.gz
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/extractor.info.tar.gz
===================================================================
--- Extractor-docs/WWW/manual/extractor.info.tar.gz 2012-09-06 10:54:46 UTC
(rev 23667)
+++ Extractor-docs/WWW/manual/extractor.info.tar.gz 2012-09-06 11:11:18 UTC
(rev 23668)
Property changes on: Extractor-docs/WWW/manual/extractor.info.tar.gz
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Modified: Extractor-docs/WWW/manual/extractor.pdf
===================================================================
(Binary files differ)
Added: Extractor-docs/WWW/manual/extractor.ps.gz
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/extractor.ps.gz
===================================================================
--- Extractor-docs/WWW/manual/extractor.ps.gz 2012-09-06 10:54:46 UTC (rev
23667)
+++ Extractor-docs/WWW/manual/extractor.ps.gz 2012-09-06 11:11:18 UTC (rev
23668)
Property changes on: Extractor-docs/WWW/manual/extractor.ps.gz
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: Extractor-docs/WWW/manual/extractor.texi.tar.gz
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/extractor.texi.tar.gz
===================================================================
--- Extractor-docs/WWW/manual/extractor.texi.tar.gz 2012-09-06 10:54:46 UTC
(rev 23667)
+++ Extractor-docs/WWW/manual/extractor.texi.tar.gz 2012-09-06 11:11:18 UTC
(rev 23668)
Property changes on: Extractor-docs/WWW/manual/extractor.texi.tar.gz
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: Extractor-docs/WWW/manual/extractor.txt
===================================================================
--- Extractor-docs/WWW/manual/extractor.txt (rev 0)
+++ Extractor-docs/WWW/manual/extractor.txt 2012-09-06 11:11:18 UTC (rev
23668)
@@ -0,0 +1,1330 @@
+Short Contents
+**************
+
+The GNU libextractor Reference Manual
+1 Introduction
+2 Preparation
+3 Generalities
+4 Extracting meta data
+5 Language bindings
+6 Utility functions
+7 Existing Plugins
+8 Writing new Plugins
+9 Internal utility functions
+10 Reporting bugs
+Appendix A GNU GENERAL PUBLIC LICENSE
+Concept Index
+Function and Data Index
+Type Index
+
+
+Table of Contents
+*****************
+
+The GNU libextractor Reference Manual
+1 Introduction
+2 Preparation
+ 2.1 Installation on GNU/Linux
+ 2.2 Installation on FreeBSD
+ 2.3 Installation on OpenBSD
+ 2.4 Installation on NetBSD
+ 2.5 Installation using MinGW
+ 2.6 Installation on OS X
+ 2.6.1 Installing and uninstalling the framework
+ 2.6.2 Using the framework
+ 2.6.3 Example for using the framework
+ 2.6.4 Example for using the dynamic library
+ 2.7 Note to package maintainers
+3 Generalities
+ 3.1 Introduction to the "extract" command
+ 3.2 Common usage examples for "extract"
+ 3.3 Introduction to the libextractor library
+4 Extracting meta data
+ 4.1 Plugin management
+ 4.2 Meta types
+ 4.3 Meta formats
+ 4.4 Extracting
+5 Language bindings
+ 5.1 Java
+ 5.2 Mono
+ 5.3 Perl
+ 5.4 Python
+ 5.5 PHP
+ 5.6 Ruby
+6 Utility functions
+ 6.1 Utility Constants
+ 6.2 Meta data printing
+7 Existing Plugins
+8 Writing new Plugins
+ 8.1 Example for a minimal extract method
+9 Internal utility functions
+10 Reporting bugs
+Appendix A GNU GENERAL PUBLIC LICENSE
+ A.0.1 Preamble
+ How to Apply These Terms to Your New Programs
+Concept Index
+Function and Data Index
+Type Index
+
+
+The GNU libextractor Reference Manual
+*************************************
+
+This manual is for GNU libextractor (version 1.0.0, 5 September 2012).
+
+ GNU libextractor is a GNU package.
+
+ Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+
+1 Introduction
+**************
+
+GNU libextractor is GNU's library for extracting meta data from files.
+Meta data includes format information (such as mime type, image
+dimensions, color depth, recording frequency), content descriptions
+(such as document title or document description) and copyright
+information (such as license, author and contributors). Meta data
+extraction is an inherently uncertain business -- a parse error can be
+a corrupt file, an incompatibility in the file format version, an
+entirely different file format or a bug in the parser. As a result of
+this uncertainty, GNU libextractor deliberately avoids to ever report
+any errors. Unexpected file contents simply result in less or possibly
+no meta data being extracted.
+
+ GNU libextractor uses plugins to handle various file formats.
+Technically a plugin can support multiple file formats; however, most
+plugins only support one particular format. By default, GNU
+libextractor will use all plugins that are available and found in the
+plugin installation directory. Applications can request the use of
+only specific plugins or the exclusion of certain plugins.
+
+ GNU libextractor is distributed with the `extract' command(1) which
+is a command-line tool for extracting meta data. `extract' is given a
+list of filenames and prints the resulting meta data to the console.
+The `extract' source code also serves as an advanced example for how to
+use GNU libextractor.
+
+ This manual focuses on providing documentation for writing software
+with GNU libextractor. The only relevant parts for end-users are the
+chapter on compiling and installing GNU libextractor (*Note
+Preparation::.). Also, the chapter on existing plugins maybe of
+interest (*Note Existing Plugins::.). Additional documentation for
+end-users can be find in the man page on `extract' (using man extract).
+
+ GNU libextractor is licensed under the GNU General Public License,
+specifically, since version 0.7, GNU libextractor is licensed under
+GPLv3 _or any later version_.
+
+ ---------- Footnotes ----------
+
+ (1) Some distributions ship `extract' in a seperate package.
+
+2 Preparation
+*************
+
+This chapter first describes the general build instructions that should
+apply to all systems. Specific instructions for known problems for
+particular platforms are then described in individual sections
+afterwards.
+
+ Compiling GNU libextractor follows the standard GNU autotools build
+process using `configure' and `make'. For details on the GNU autotools
+build process, read the `INSTALL' file and query ./configure --help for
+additional options.
+
+ GNU libextractor has various dependencies, most of which are
+optional. Instead of specifying the names of the software packages, we
+will give the list in terms of the names of the respective Debian
+(unstable) packages that should be installed.
+
+ You absolutely need:
+
+ * libtool
+
+ * gcc
+
+ * make
+
+ * g++
+
+ * libltdl7-dev
+
+ Recommended dependencies are:
+ * zlib1g-dev
+
+ * libbz2-dev
+
+ * libgif-dev
+
+ * libvorbis-dev
+
+ * libflac-dev
+
+ * libmpeg2-4-dev
+
+ * librpm-dev
+
+ * libgtk2.0-dev
+
+ * libgsf-1-dev
+
+ * libqt4-dev
+
+ * libpoppler-dev
+
+ * libexiv2-dev
+
+ * libavformat-dev
+
+ * libswscale-dev
+
+ For Subversion access and compilation one also needs:
+ * subversion
+
+ * autoconf
+
+ * automake
+
+ Please notify us if we missed some dependencies (note that the list
+is supposed to only list direct dependencies, not transitive
+dependencies).
+
+ Once you have compiled and installed GNU libextractor, you should
+have a file `extractor.h' installed in your `include/' directory. This
+file should be the starting point for your C and C++ development with
+GNU libextractor. The build process also installs the `extract' binary
+and man pages for `extract' and GNU libextractor. The `extract' man
+page documents the `extract' tool. The GNU libextractor man page gives
+a brief summary of the C API for GNU libextractor.
+
+ When you install GNU libextractor, various plugins will be installed
+in the `lib/libextractor/' directory. The main library will be
+installed as `lib/libextractor.so'. Note that GNU libextractor will
+attempt to find the plugins relative to the path of the main library.
+Consequently, a package manager can move the library and its plugins to
+a different location later -- as long as the relative path between the
+main library and the plugins is preserved. As a method of last resort,
+the user can specify an environment variable LIBEXTRACTOR_PREFIX. If
+GNU libextractor cannot locate a plugin, it will look in
+LIBEXTRACTOR_PREFIX/lib/libextractor/.
+
+2.1 Installation on GNU/Linux
+=============================
+
+Should work using the standard instructions without problems.
+
+2.2 Installation on FreeBSD
+===========================
+
+Should work using the standard instructions without problems.
+
+2.3 Installation on OpenBSD
+===========================
+
+OpenBSD 3.8 also doesn't have CODESET in `langinfo.h'. CODESET is used
+in GNU libextractor in about three places. This causes problems during
+compilation.
+
+2.4 Installation on NetBSD
+==========================
+
+No reports so far.
+
+2.5 Installation using MinGW
+============================
+
+Linking -lstdc++ with the provided libtool fails on Cygwin, this is a
+problem with libtool, there is unfortunately no flag to tell libtool
+how to do its job on Cygwin and it seems that it cannot be the default
+to set the library check to 'pass_all'. Patching libtool may help.
+
+ Note: this is a rather dated report and may no longer apply.
+
+2.6 Installation on OS X
+========================
+
+libextractor has two installation methods on Mac OS X: it can be
+installed as a Mac OS X framework or with the standard `./configure;
+make; make install' shell commands. The framework package is
+self-contained, but currently omits some of the extractor plugins that
+can be compiled in if libextractor is installed with `./configure;
+make; make install' (provided that the required dependencies exist.)
+
+2.6.1 Installing and uninstalling the framework
+-----------------------------------------------
+
+The binary framework is distributed as a disk image
+(`Extractor-x.x.xx.dmg'). Installation is done by opening the disk
+image and clicking `Extractor.pkg' inside it. The Mac OS X installer
+application will then run. The framework is installed to the root
+volume's `/Library/Frameworks' folder and installing will require admin
+privileges.
+
+ The framework can be uninstalled by dragging
+`/Library/Frameworks/Extractor.framework' cto the `Trash'.
+
+2.6.2 Using the framework
+-------------------------
+
+In the framework, the `extract' command line tool can be found at
+`/Library/Frameworks/Extractor.framework/Versions/Current/bin/extract'
+
+ The framework can be used in software projects as a framework or as
+a dynamic library.
+
+ When using the framework as a dynamic library in projects using
+autotools, one would most likely want to add
+"-I/Library/Frameworks/Extractor.framework/Versions/Current/include" to
+CPPFLAGS and
+"-L/Library/Frameworks/Extractor.framework/Versions/Current/lib" to
+LDFLAGS.
+
+2.6.3 Example for using the framework
+-------------------------------------
+
+ // hello.c
+ #include <Extractor/extractor.h>
+
+ int
+ main (int argc, char **argv)
+ {
+ struct EXTRACTOR_PluginList *el;
+ el = EXTRACTOR_plugin_load_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
+ // ...
+ EXTRACTOR_plugin_remove_all (el);
+ return 0;
+ }
+
+ You can then compile the example using
+
+$ gcc -o hello hello.c -framework Extractor
+
+2.6.4 Example for using the dynamic library
+-------------------------------------------
+
+ // hello.c
+ #include <extractor.h>
+ int main()
+ {
+ struct EXTRACTOR_PluginList *el;
+ el = EXTRACTOR_plugin_load_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
+ // ...
+ EXTRACTOR_plugin_remove_all (el);
+ return 0;
+ }
+
+ You can then compile the example using
+
+$ gcc -I/Library/Frameworks/Extractor.framework/Versions/Current/include \
+ -o hello hello.c \
+ -L/Library/Frameworks/Extractor.framework/Versions/Current/lib \
+ -lextractor
+
+ Notice the difference in the `#include' line.
+
+2.7 Note to package maintainers
+===============================
+
+The suggested way to package GNU libextractor is to split it into
+roughly the following binary packages:
+
+ * libextractor (main library only, only hard dependency for other
+ packages depending on GNU libextractor)
+
+ * extract (command-line tool and man page extract.1)
+
+ * libextractor-dev (extractor.h header and man page libextractor.3)
+
+ * libextractor-doc (this manual)
+
+ * libextractor-plugins (plugins without external dependencies;
+ recommended but not required by extract and libextractor package)
+
+ * libextractor-plugin-XXX (plugin with dependency on libXXX, for
+ example for XXX=mpeg this would be `libextractor_mpeg.so')
+
+ * libextractor-plugins-all (meta package that requires all plugins
+ except experimental plugins)
+
+ This would enable minimal installations (i.e. for embedded systems)
+to not include any plugins, as well as moderate-size installations (that
+do not trigger GTK and X11) for systems that have limited resources.
+Right now, the MP4 plugin is experimental and does nothing and should
+thus never be included at all. The gstreamer plugin is experimental
+but largely works with the correct version of gstreamer and can thus be
+packaged (especially if the dependency is available on the target
+system) but should probably not be part of libextractor-plugins-all.
+
+3 Generalities
+**************
+
+3.1 Introduction to the "extract" command
+=========================================
+
+The `extract' command takes a list of file names as arguments, extracts
+meta data from each of those files and prints the result to the
+console. By default, `extract' will use all available plugins and
+print all (non-binary) meta data that is found.
+
+ The set of plugins used by `extract' can be controlled using the
+"-l" and "-n" options. Use "-n" to not load all of the default
+plugins. Use "-l NAME" to specifically load a certain plugin. For
+example, specify "-n -l mime" to only use the MIME plugin.
+
+ Using the "-p" option the output of `extract' can be limited to only
+certain keyword types. Similarly, using the "-x" option, certain
+keyword types can be excluded. A list of all known keyword types can
+be obtained using the "-L" option.
+
+ The output format of `extract' can be influenced with the "-V" (more
+verbose, lists filenames), "-g" (grep-friendly, all meta data on a
+single line per file) and "-b" (bibTeX style) options.
+
+3.2 Common usage examples for "extract"
+=======================================
+
+ $ extract test/test.jpg
+ comment - (C) 2001 by Christian Grothoff, using gimp 1.2 1
+ mimetype - image/jpeg
+
+ $ extract -V -x comment test/test.jpg
+ Keywords for file test/test.jpg:
+ mimetype - image/jpeg
+
+ $ extract -p comment test/test.jpg
+ comment - (C) 2001 by Christian Grothoff, using gimp 1.2 1
+
+ $ extract -nV -l png.so -p comment test/test.jpg test/test.png
+ Keywords for file test/test.jpg:
+ Keywords for file test/test.png:
+ comment - Testing keyword extraction
+
+3.3 Introduction to the libextractor library
+============================================
+
+Each public symbol exported by GNU libextractor has the prefix
+EXTRACTOR_. All-caps names are used for constants. For the impatient,
+the minimal C code for using GNU libextractor (on the executing binary
+itself) looks like this:
+
+#include <extractor.h>
+
+int
+main (int argc, char ** argv)
+{
+ struct EXTRACTOR_PluginList *plugins
+ = EXTRACTOR_plugin_add_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
+ EXTRACTOR_extract (plugins, argv[1],
+ NULL, 0,
+ &EXTRACTOR_meta_data_print, stdout);
+ EXTRACTOR_plugin_remove_all (plugins);
+ return 0;
+}
+
+ The minimal API illustrated by this example is actually sufficient
+for many applications. The full external C API of GNU libextractor is
+described in chapter *Note Extracting meta data::. Bindings for other
+languages are described in chapter *Note Language bindings::. The API
+for writing new plugins is described in chapter *Note Writing new
+Plugins::.
+
+4 Extracting meta data
+**********************
+
+In order to extract meta data with GNU libextractor you first need to
+load the respective plugins and then call the extraction API with the
+plugins and the data to process. This section documents how to load
+and unload plugins, the various types and formats in which meta data is
+returned to the application and finally the extraction API itself.
+
+4.1 Plugin management
+=====================
+
+Using GNU libextractor from a multi-threaded parent process requires
+some care. The problem is that on most platforms GNU libextractor
+starts sub-processes for the actual extraction work. This is useful to
+isolate the parent process from potential bugs; however, it can cause
+problems if the parent process is multi-threaded. The issue is that at
+the time of the fork, another thread of the application may hold a lock
+(i.e. in gettext or libc). That lock would then never be released in
+the child process (as the other thread is not present in the child
+process). As a result, the child process would then deadlock on trying
+to acquire the lock and never terminate. This has actually been
+observed with a lock in GNU gettext that is triggered by the plugin
+startup code when it interacts with libltdl.
+
+ The problem can be solved by loading the plugins using the
+`EXTRACTOR_OPTION_IN_PROCESS' option, which will run GNU libextractor
+in-process and thus avoid the locking issue. In this case, all of the
+functions for loading and unloading plugins, including
+EXTRACTOR_plugin_add_defaults and EXTRACTOR_plugin_remove_all, are
+thread-safe and reentrant. However, using the same plugin list from
+multiple threads at the same time is not safe.
+
+ All plugin code is expected required to be reentrant and state-less,
+but due to the extensive use of 3rd party libraries this cannot be
+guaranteed.
+
+ -- C Struct: EXTRACTOR_PluginList
+ A plugin list represents a set of GNU libextractor plugins. Most
+ of the GNU libextractor API is concerned with either constructing a
+ plugin list or using it to extract meta data. The internal
+ representation of the plugin list is of no concern to users or
+ plugin developers.
+
+ -- Function: void EXTRACTOR_plugin_remove_all (struct
+ EXTRACTOR_PluginList *plugins)
+ Unload all of the plugins in the given list.
+
+ -- Function: struct EXTRACTOR_PluginList * EXTRACTOR_plugin_remove
+ (struct EXTRACTOR_PluginList *plugins, const char*name)
+ Unloads a particular plugin. The given name should be the short
+ name of the plugin, for example "mime" for the mime-type extractor
+ or "mpeg" for the MPEG extractor.
+
+ -- Function: struct EXTRACTOR_PluginList * EXTRACTOR_plugin_add
+ (struct EXTRACTOR_PluginList *plugins, const char* name,const
+ char* options, enum EXTRACTOR_Options flags)
+ Loads a particular plugin. The plugin is added to the existing
+ list, which can be NULL. The second argument specifies the name
+ of the plugin (i.e. "ogg"). The third argument can be NULL and
+ specifies plugin-specific options. Finally, the last argument
+ specifies if the plugin should be executed out-of-process
+ (`EXTRACTOR_OPTION_DEFAULT_POLICY') or not.
+
+ -- Function: struct EXTRACTOR_PluginList * EXTRACTOR_plugin_add_config
+ (struct EXTRACTOR_PluginList *plugins, const char* config,
+ enum EXTRACTOR_Options flags)
+ Loads and unloads plugins based on a configuration string,
+ modifying the existing list, which can be NULL. The string has
+ the format "[-]NAME(OPTIONS){:[-]NAME(OPTIONS)}*". Prefixing the
+ plugin name with a "-" means that the plugin should be unloaded.
+
+ -- Function: struct EXTRACTOR_PluginList *
+EXTRACTOR_plugin_add_defaults (enum EXTRACTOR_Options flags)
+ Loads all of the plugins in the plugin directory. This function
+ is what most GNU libextractor applications should use to setup the
+ plugins.
+
+4.2 Meta types
+==============
+
+enum EXTRACTOR_MetaType is a C enum which defines a list of over 100
+different types of meta data. The total number can differ between
+different GNU libextractor releases; the maximum value for the current
+release can be obtained using the EXTRACTOR_metatype_get_max function.
+All values in this enumeration are of the form EXTRACTOR_METATYPE_XXX.
+
+ -- Function: const char * EXTRACTOR_metatype_to_string (enum
+ EXTRACTOR_MetaType type)
+ The function EXTRACTOR_metatype_to_string can be used to obtain a
+ short English string `s' describing the meta data type. The
+ string can be translated into other languages using GNU gettext
+ with the domain set to GNU libextractor (dgettext("libextractor",
+ s)).
+
+ -- Function: const char * EXTRACTOR_metatype_to_description (enum
+ EXTRACTOR_MetaType type)
+ The function EXTRACTOR_metatype_to_description can be used to
+ obtain a longer English string `s' describing the meta data type.
+ The description may be empty if the short description returned by
+ `EXTRACTOR_metatype_to_string' is already comprehensive. The
+ string can be translated into other languages using GNU gettext
+ with the domain set to GNU libextractor (dgettext("libextractor",
+ s)).
+
+4.3 Meta formats
+================
+
+enum EXTRACTOR_MetaFormat is a C enum which defines on a high level how
+the extracted meta data is represented. Currently, the library uses
+three formats: UTF-8 strings, C strings and binary data. A fourth
+value, `EXTRACTOR_METAFORMAT_UNKNOWN' is defined but not used. UTF-8
+strings are 0-terminated strings that have been converted to UTF-8.
+The format code is `EXTRACTOR_METAFORMAT_UTF8'. Ideally, most text meta
+data will be of this format. Some file formats fail to specify the
+encoding used for the text. In this case, the text cannot be converted
+to UTF-8. However, the meta data is still known to be 0-terminated and
+presumably human-readable. In this case, the format code used is
+`EXTRACTOR_METAFORMAT_C_STRING'; however, this should not be understood
+to mean that the encoding is the same as that used by the C compiler.
+Finally, for binary data (mostly images), the format
+`EXTRACTOR_METAFORMAT_BINARY' is used.
+
+ Naturally this is not a precise description of the meta format.
+Plugins can provide a more precise description (if known) by providing
+the respective mime type of the meta data. For example, binary image
+meta data could be also tagged as "image/png" and normal text would
+typically be tagged as "text/plain".
+
+4.4 Extracting
+==============
+
+ -- Function Pointer: int (*EXTRACTOR_MetaDataProcessor)(void *cls,
+ const char *plugin_name, enum EXTRACTOR_MetaType type, enum
+ EXTRACTOR_MetaFormat format, const char *data_mime_type,
+ const char *data, size_t data_len)
+ Type of a function that libextractor calls for each meta data item
+ found.
+
+ CLS
+ closure (user-defined)
+
+ PLUGIN_NAME
+ name of the plugin that produced this value; special values
+ can be used (i.e. '<zlib>' for zlib being used in the main
+ libextractor library and yielding meta data);
+
+ TYPE
+ libextractor-type describing the meta data;
+
+ FORMAT BASIC
+ format information about data
+
+ DATA_MIME_TYPE
+ mime-type of data (not of the original file); can be NULL (if
+ mime-type is not known);
+
+ DATA
+ actual meta-data found
+
+ DATA_LEN
+ number of bytes in data
+
+
+ Return 0 to continue extracting, 1 to abort.
+
+ -- Function: void EXTRACTOR_extract (struct EXTRACTOR_PluginList
+ *plugins, const char *filename, const void *data, size_t
+ size, EXTRACTOR_MetaDataProcessor proc, void *proc_cls)
+ This is the main function for extracting keywords with GNU
+ libextractor. The first argument is a plugin list which specifies
+ the set of plugins that should be used for extracting meta data.
+ The `filename' argument is optional and can be used to specify the
+ name of a file to process. If `filename' is NULL, then the `data'
+ argument must point to the in-memory data to extract meta data
+ from. If `filename' is non-NULL, `data' can be NULL. If `data'
+ is non-null, then `size' is the size of `data' in bytes.
+ Otherwise `size' should be zero. For each meta data item found,
+ GNU libextractor will call the `proc' function, passing `proc_cls'
+ as the first argument to `proc'. The other arguments to `proc'
+ depend on the specific meta data found.
+
+ Meta data extraction should never really fail -- at worst, GNU
+ libextractor should not call `proc' with any meta data. By design,
+ GNU libextractor should never crash or leak memory, even given
+ corrupt files as input. Note however, that running GNU
+ libextractor on a corrupt file system (or incorrectly mmaped
+ files) can result in the operating system sending a SIGBUS (bus
+ error) to the process. While GNU libextractor runs plugins
+ out-of-process, it first maps the file into memory and then
+ attempts to decompress it. During decompression it is possible to
+ encounter a SIGBUS. GNU libextractor will _not_ attempt to catch
+ this signal and your application is likely to crash. Note again
+ that this should only happen if the file _system_ is corrupt (not
+ if individual files are corrupt). If this is not acceptable, you
+ might want to consider running GNU libextractor itself also
+ out-of-process (as done, for example, by doodle
+ (http://grothoff.org/christian/doodle/)).
+
+
+5 Language bindings
+*******************
+
+GNU libextractor works immediately with C and C++ code. Bindings for
+Java, Mono, Ruby, Perl, PHP and Python are available for download from
+the main GNU libextractor website. Documentation for these bindings
+(if available) is part of the downloads for the respective binding. In
+all cases, a full installation of the C library is required before the
+binding can be installed.
+
+5.1 Java
+========
+
+Compiling the GNU libextractor Java binding follows the usual process of
+running `configure' and `make'. The result will be a shared C library
+`libextractor_java.so' with the native code and a JAR file (installed
+to `$PREFIX/share/java/libextractor.java').
+
+ A minimal example for using GNU libextractor's Java binding would
+look like this:
+import org.gnu.libextractor.*;
+import java.util.ArrayList;
+
+public static void main(String[] args) {
+ Extractor ex = Extractor.getDefault();
+ for (int i=0;i<args.length;i++) {
+ ArrayList keywords = ex.extract(args[i]);
+ System.out.println("Keywords for " + args[i] + ":");
+ for (int j=0;j<keywords.size();j++)
+ System.out.println(keywords.get(j));
+ }
+}
+
+ The GNU libextractor library and the `libextractor_java.so' JNI
+binding have to be in the library search path for this to work.
+Furthermore, the `libextractor.jar' file should be on the classpath.
+
+ Note that the API does not use Java 5 style generics in order to work
+with older versions of Java.
+
+5.2 Mono
+========
+
+his binding is undocumented at this point.
+
+5.3 Perl
+========
+
+This binding is undocumented at this point.
+
+5.4 Python
+==========
+
+This binding is undocumented at this point.
+
+5.5 PHP
+=======
+
+This binding is undocumented at this point.
+
+5.6 Ruby
+========
+
+This binding is undocumented at this point.
+
+6 Utility functions
+*******************
+
+This chapter describes various utility functions for GNU libextractor
+usage. All of the functions are reentrant.
+
+6.1 Utility Constants
+=====================
+
+The constant EXTRACTOR_VERSION is a hexadecimal representation of the
+version number of the installed libextractor header. The hexadecimal
+format is 0xAABBCCDD where AA is the major version (so far always 0),
+BB is the minor version, CC is the revision and DD the patch number.
+For example, for version 0.5.18, we would have AA=0, BB=5, CC=18 and
+DD=0. Minor releases such as 0.5.18a or significant changes in
+unreleased versions would be marked with DD=1 or higher.
+
+6.2 Meta data printing
+======================
+
+The EXTRACTOR_meta_data_print is a simple function which prints the
+meta data found with libextractor to a file. The function is mostly
+useful for debugging and as an example for how to manipulate the
+keyword list and can be passed as the `proc' argument to
+`EXTRACTOR_extract'. The file to print to should be passed as
+`proc_cls' (which must be of type `FILE *'), for example `stdout'.
+
+7 Existing Plugins
+******************
+
+ * ARCHIVE (using libarchive)
+
+ * DVI
+
+ * EXIV2 (using libexiv2, 0.23 or later preferred)
+
+ * FLAC (using libFLAC)
+
+ * GIF (using libgif)
+
+ * GSTREAMER (using libgstreamer v1.0 or later)
+
+ * HTML (using libtidy)
+
+ * IT
+
+ * JPEG (using libjpeg v8 or later)
+
+ * MAN
+
+ * MIDI (using libsmf)
+
+ * MIME (using libmagic)
+
+ * MPEG (using libmpeg2)
+
+ * NSF
+
+ * NSFE
+
+ * ODF
+
+ * OLE2 (with libgsf)
+
+ * OGG (with libogg)
+
+ * PNG
+
+ * PS
+
+ * RIFF
+
+ * RPM (using librpm)
+
+ * S3M
+
+ * SID
+
+ * ThumbnailFFMPEG (using libavformat and related libav-libraries,
+ including libswscale)
+
+ * ThumbnailGtk (using libgtk)
+
+ * TIFF (with libtiff, tested with v4)
+
+ * WAV
+
+ * XM
+
+ * ZIP
+
+ `gzip' and `bzip2' compressed versions of these formats are also
+supported (as well as meta data embedded by `gzip' itself) if zlib or
+libbz2 are available.
+
+8 Writing new Plugins
+*********************
+
+Writing a new plugin for libextractor usually requires writing of or
+interfacing with an actual parser for a specific format. How this is
+can be accomplished depends on the format and cannot be specified in
+general. However, care should be taken for the code to be reentrant
+and highly fault-tolerant, especially with respect to malformed inputs.
+
+ Plugins should start by verifying that the header of the data matches
+the specific format and immediately return if that is not the case.
+Even if the header matches the expected file format, plugins must not
+assume that the remainder of the file is well formed.
+
+ The plugin library must be called libextractor_XXX.so, where XXX
+denotes the file format of the plugin. The library must export a method
+libextractor_XXX_extract_method, with the following signature:
+void
+EXTRACTOR_XXX_extract_method (struct EXTRACTOR_ExtractContext *ec);
+
+ `ec' contains various information the plugin may need for its
+execution. Most importantly, it contains functions for reading
+("read") and seeking ("seek") the input data and for returning
+extracted data ("proc"). The "config" member can contain additional
+configuration options. "proc" should be called on each meta data item
+found. If "proc" returns non-zero, processing should be aborted (if
+possible).
+
+ In order to test new plugins, the `extract' command can be run with
+the options "-ni" and "-l XXX" . This will run the plugin in-process
+(making it easier to debug) and without any of the other plugins.
+
+8.1 Example for a minimal extract method
+========================================
+
+The following example shows how a plugin can return the mime type of a
+file.
+ void
+ EXTRACTOR_mymime_extract (struct EXTRACTOR_ExtractContext *ec)
+ {
+ void *data;
+ ssize_t data_size,
+
+ if (-1 == (data_size = ec->read (ec->cls, &data, 4)))
+ return; /* read error */
+ if (data_size < 4)
+ return; /* file too small */
+ if (0 != memcmp (data, "\177ELF", 4))
+ return; /* not ELF */
+ if (0 != ec->proc (ec->cls,
+ "mymime",
+ EXTRACTOR_METATYPE_MIMETYPE,
+ EXTRACTOR_METAFORMAT_UTF8,
+ "text/plain",
+ "application/x-executable",
+ 1 + strlen("application/x-executable")))
+ return;
+ /* more calls to 'proc' here as needed */
+ }
+
+9 Internal utility functions
+****************************
+
+Some plugins link against the `libextractor_common' library which
+provides common abstractions needed by many plugins. This section
+documents this internal API for plugin developers. Note that the
+headers for this library are (intentionally) not installed: we do not
+consider this API stable and it should hence only be used by plugins
+that are build and shipped with GNU libextractor. Third-party plugins
+should not use it.
+
+ `convert_numeric.h' defines various conversion functions for numbers
+(in particular, byte-order conversion for floating point numbers).
+
+ `unzip.h' defines an API for accessing compressed files.
+
+ `pack.h' provides an interpreter for unpacking structs of integer
+numbers from streams and converting from big or little endian to host
+byte order at the same time.
+
+ `convert.h' provides a function for character set conversion
+described below.
+
+ -- Function: char * EXTRACTOR_common_convert_to_utf8 (const char
+ *input, size_t len, const char *charset)
+ Various GNU libextractor plugins make use of the internal
+ `convert.h' header which defines a function
+
+ EXTRACTOR_common_convert_to_utf8 which can be used to easily
+ convert text from any character set to UTF-8. This conversion is
+ important since the linked list of keywords that is returned by
+ GNU libextractor is expected to contain only UTF-8 strings.
+ Naturally, proper conversion may not always be possible since some
+ file formats fail to specify the character set. In that case, it
+ is often better to not convert at all.
+
+ The arguments to EXTRACTOR_common_convert_to_utf8 are the input
+ string (which does _not_ have to be zero-terminated), the length
+ of the input string, and the character set (which _must_ be
+ zero-terminated). Which character sets are supported depends on
+ the platform, a list can generally be obtained using the `iconv
+ -l' command. The return value from
+ EXTRACTOR_common_convert_to_utf8 is a zero-terminated string in
+ UTF-8 format. The responsibility to free the string is with the
+ caller, so storing the string in the keyword list is acceptable.
+
+10 Reporting bugs
+*****************
+
+GNU libextractor uses the Mantis bugtracking system
+(https://gnunet.org/bugs/). If possible, please report bugs there.
+You can also e-mail the GNU libextractor mailinglist at
address@hidden'.
+
+Appendix A GNU GENERAL PUBLIC LICENSE
+*************************************
+
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+A.0.1 Preamble
+--------------
+
+The licenses for most software are designed to take away your freedom
+to share and change it. By contrast, the GNU General Public License is
+intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it in
+new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software,
+and (2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+ 1. This License applies to any program or other work which contains a
+ notice placed by the copyright holder saying it may be distributed
+ under the terms of this General Public License. The "Program",
+ below, refers to any such program or work, and a "work based on
+ the Program" means either the Program or any derivative work under
+ copyright law: that is to say, a work containing the Program or a
+ portion of it, either verbatim or with modifications and/or
+ translated into another language. (Hereinafter, translation is
+ included without limitation in the term "modification".) Each
+ licensee is addressed as "you".
+
+ Activities other than copying, distribution and modification are
+ not covered by this License; they are outside its scope. The act
+ of running the Program is not restricted, and the output from the
+ Program is covered only if its contents constitute a work based on
+ the Program (independent of having been made by running the
+ Program). Whether that is true depends on what the Program does.
+
+ 2. You may copy and distribute verbatim copies of the Program's
+ source code as you receive it, in any medium, provided that you
+ conspicuously and appropriately publish on each copy an appropriate
+ copyright notice and disclaimer of warranty; keep intact all the
+ notices that refer to this License and to the absence of any
+ warranty; and give any other recipients of the Program a copy of
+ this License along with the Program.
+
+ You may charge a fee for the physical act of transferring a copy,
+ and you may at your option offer warranty protection in exchange
+ for a fee.
+
+ 3. You may modify your copy or copies of the Program or any portion
+ of it, thus forming a work based on the Program, and copy and
+ distribute such modifications or work under the terms of Section 1
+ above, provided that you also meet all of these conditions:
+
+ a. You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b. You must cause any work that you distribute or publish, that
+ in whole or in part contains or is derived from the Program
+ or any part thereof, to be licensed as a whole at no charge
+ to all third parties under the terms of this License.
+
+ c. If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display
+ an announcement including an appropriate copyright notice and
+ a notice that there is no warranty (or else, saying that you
+ provide a warranty) and that users may redistribute the
+ program under these conditions, and telling the user how to
+ view a copy of this License. (Exception: if the Program
+ itself is interactive but does not normally print such an
+ announcement, your work based on the Program is not required
+ to print an announcement.)
+
+ These requirements apply to the modified work as a whole. If
+ identifiable sections of that work are not derived from the
+ Program, and can be reasonably considered independent and separate
+ works in themselves, then this License, and its terms, do not
+ apply to those sections when you distribute them as separate
+ works. But when you distribute the same sections as part of a
+ whole which is a work based on the Program, the distribution of
+ the whole must be on the terms of this License, whose permissions
+ for other licensees extend to the entire whole, and thus to each
+ and every part regardless of who wrote it.
+
+ Thus, it is not the intent of this section to claim rights or
+ contest your rights to work written entirely by you; rather, the
+ intent is to exercise the right to control the distribution of
+ derivative or collective works based on the Program.
+
+ In addition, mere aggregation of another work not based on the
+ Program with the Program (or with a work based on the Program) on
+ a volume of a storage or distribution medium does not bring the
+ other work under the scope of this License.
+
+ 4. You may copy and distribute the Program (or a work based on it,
+ under Section 2) in object code or executable form under the terms
+ of Sections 1 and 2 above provided that you also do one of the
+ following:
+
+ a. Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of
+ Sections 1 and 2 above on a medium customarily used for
+ software interchange; or,
+
+ b. Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a
+ medium customarily used for software interchange; or,
+
+ c. Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with
+ such an offer, in accord with Subsection b above.)
+
+ The source code for a work means the preferred form of the work for
+ making modifications to it. For an executable work, complete
+ source code means all the source code for all modules it contains,
+ plus any associated interface definition files, plus the scripts
+ used to control compilation and installation of the executable.
+ However, as a special exception, the source code distributed need
+ not include anything that is normally distributed (in either
+ source or binary form) with the major components (compiler,
+ kernel, and so on) of the operating system on which the executable
+ runs, unless that component itself accompanies the executable.
+
+ If distribution of executable or object code is made by offering
+ access to copy from a designated place, then offering equivalent
+ access to copy the source code from the same place counts as
+ distribution of the source code, even though third parties are not
+ compelled to copy the source along with the object code.
+
+ 5. You may not copy, modify, sublicense, or distribute the Program
+ except as expressly provided under this License. Any attempt
+ otherwise to copy, modify, sublicense or distribute the Program is
+ void, and will automatically terminate your rights under this
+ License. However, parties who have received copies, or rights,
+ from you under this License will not have their licenses
+ terminated so long as such parties remain in full compliance.
+
+ 6. You are not required to accept this License, since you have not
+ signed it. However, nothing else grants you permission to modify
+ or distribute the Program or its derivative works. These actions
+ are prohibited by law if you do not accept this License.
+ Therefore, by modifying or distributing the Program (or any work
+ based on the Program), you indicate your acceptance of this
+ License to do so, and all its terms and conditions for copying,
+ distributing or modifying the Program or works based on it.
+
+ 7. Each time you redistribute the Program (or any work based on the
+ Program), the recipient automatically receives a license from the
+ original licensor to copy, distribute or modify the Program
+ subject to these terms and conditions. You may not impose any
+ further restrictions on the recipients' exercise of the rights
+ granted herein. You are not responsible for enforcing compliance
+ by third parties to this License.
+
+ 8. If, as a consequence of a court judgment or allegation of patent
+ infringement or for any other reason (not limited to patent
+ issues), conditions are imposed on you (whether by court order,
+ agreement or otherwise) that contradict the conditions of this
+ License, they do not excuse you from the conditions of this
+ License. If you cannot distribute so as to satisfy simultaneously
+ your obligations under this License and any other pertinent
+ obligations, then as a consequence you may not distribute the
+ Program at all. For example, if a patent license would not permit
+ royalty-free redistribution of the Program by all those who
+ receive copies directly or indirectly through you, then the only
+ way you could satisfy both it and this License would be to refrain
+ entirely from distribution of the Program.
+
+ If any portion of this section is held invalid or unenforceable
+ under any particular circumstance, the balance of the section is
+ intended to apply and the section as a whole is intended to apply
+ in other circumstances.
+
+ It is not the purpose of this section to induce you to infringe any
+ patents or other property right claims or to contest validity of
+ any such claims; this section has the sole purpose of protecting
+ the integrity of the free software distribution system, which is
+ implemented by public license practices. Many people have made
+ generous contributions to the wide range of software distributed
+ through that system in reliance on consistent application of that
+ system; it is up to the author/donor to decide if he or she is
+ willing to distribute software through any other system and a
+ licensee cannot impose that choice.
+
+ This section is intended to make thoroughly clear what is believed
+ to be a consequence of the rest of this License.
+
+ 9. If the distribution and/or use of the Program is restricted in
+ certain countries either by patents or by copyrighted interfaces,
+ the original copyright holder who places the Program under this
+ License may add an explicit geographical distribution limitation
+ excluding those countries, so that distribution is permitted only
+ in or among countries not thus excluded. In such case, this
+ License incorporates the limitation as if written in the body of
+ this License.
+
+ 10. The Free Software Foundation may publish revised and/or new
+ versions of the General Public License from time to time. Such
+ new versions will be similar in spirit to the present version, but
+ may differ in detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+ Program specifies a version number of this License which applies
+ to it and "any later version", you have the option of following
+ the terms and conditions either of that version or of any later
+ version published by the Free Software Foundation. If the Program
+ does not specify a version number of this License, you may choose
+ any version ever published by the Free Software Foundation.
+
+ 11. If you wish to incorporate parts of the Program into other free
+ programs whose distribution conditions are different, write to the
+ author to ask for permission. For software which is copyrighted
+ by the Free Software Foundation, write to the Free Software
+ Foundation; we sometimes make exceptions for this. Our decision
+ will be guided by the two goals of preserving the free status of
+ all derivatives of our free software and of promoting the sharing
+ and reuse of software generally.
+
+ 12. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
+ WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
+ LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+ HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
+ WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT
+ NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE
+ QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
+ SERVICING, REPAIR OR CORRECTION.
+
+ 13. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+ WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
+ MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE
+ LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
+ INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
+ INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+ DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU
+ OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY
+ OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
+ ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+How to Apply These Terms to Your New Programs
+=============================================
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these
+terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ ONE LINE TO GIVE THE PROGRAM'S NAME AND AN IDEA OF WHAT IT DOES.
+ Copyright (C) 19YY NAME OF AUTHOR
+
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the GNU General Public License
+ as published by the Free Software Foundation; either version 2
+ of the License, or (at your option) any later version.
+
+ This program 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
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
+
+ Also add information on how to contact you by electronic and paper
+mail.
+
+ If the program is interactive, make it output a short notice like
+this when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) 19YY NAME OF AUTHOR
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
+ type `show w'. This is free software, and you are welcome
+ to redistribute it under certain conditions; type `show c'
+ for details.
+
+ The hypothetical commands `show w' and `show c' should show the
+appropriate parts of the General Public License. Of course, the
+commands you use may be called something other than `show w' and `show
+c'; they could even be mouse-clicks or menu items--whatever suits your
+program.
+
+ You should also get your employer (if you work as a programmer) or
+your school, if any, to sign a "copyright disclaimer" for the program,
+if necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright
+ interest in the program `Gnomovision'
+ (which makes passes at compilers) written
+ by James Hacker.
+
+ SIGNATURE OF TY COON, 1 April 1989
+ Ty Coon, President of Vice
+
+ This General Public License does not permit incorporating your
+program into proprietary programs. If your program is a subroutine
+library, you may consider it more useful to permit linking proprietary
+applications with the library. If this is what you want to do, use the
+GNU Library General Public License instead of this License.
+
+Concept Index
+*************
+
+bug: See 10. (line 907)
+bus error: See 4.4. (line 620)
+character set: See 9. (line 883)
+concurrency <1>: See 6. (line 706)
+concurrency <2>: See 4.4. (line 607)
+concurrency: See 4.1. (line 450)
+directory structure: See 2. (line 207)
+environment variables: See 2. (line 207)
+error handling: See 1. (line 89)
+gettext: See 4.2. (line 527)
+GPL, GNU General Public License: See Appendix A.
+ (line 915)
+internationalization: See 4.2. (line 527)
+Java: See 5. (line 641)
+license: See 1. (line 121)
+Mono: See 5. (line 641)
+packageing: See 2. (line 207)
+Perl: See 5. (line 641)
+PHP: See 5. (line 641)
+plugin <1>: See 2. (line 207)
+plugin: See 1. (line 101)
+Python: See 5. (line 641)
+reentrant <1>: See 6. (line 706)
+reentrant <2>: See 4.4. (line 607)
+reentrant: See 4.1. (line 450)
+Ruby: See 5. (line 641)
+SIGBUS: See 4.4. (line 620)
+thread-safety <1>: See 6. (line 706)
+thread-safety <2>: See 4.4. (line 607)
+thread-safety: See 4.1. (line 450)
+threads <1>: See 6. (line 706)
+threads <2>: See 4.4. (line 607)
+threads: See 4.1. (line 450)
+UTF-8: See 9. (line 883)
+Function and Data Index
+***********************
+
+(: See 4.4. (line 574)
+EXTRACTOR_common_convert_to_utf8: See 9. (line 883)
+EXTRACTOR_extract: See 4.4. (line 607)
+EXTRACTOR_meta_data_print: See 6.2. (line 723)
+EXTRACTOR_metatype_get_max: See 4.2. (line 519)
+EXTRACTOR_metatype_to_description: See 4.2. (line 535)
+EXTRACTOR_metatype_to_string: See 4.2. (line 527)
+EXTRACTOR_plugin_add: See 4.1. (line 495)
+EXTRACTOR_plugin_add_config: See 4.1. (line 505)
+EXTRACTOR_plugin_add_defaults: See 4.1. (line 512)
+EXTRACTOR_plugin_remove: See 4.1. (line 488)
+EXTRACTOR_plugin_remove_all: See 4.1. (line 484)
+EXTRACTOR_VERSION: See 6.1. (line 712)
+Type Index
+**********
+
+enum EXTRACTOR_MetaFormat: See 4.3. (line 546)
+enum EXTRACTOR_MetaType: See 4.2. (line 519)
+enum EXTRACTOR_Options: See 4.1. (line 450)
+EXTRACTOR_MetaDataProcessor: See 4.4. (line 574)
+EXTRACTOR_PluginList: See 4.1. (line 476)
+struct EXTRACTOR_PluginList: See 4.1. (line 476)
Added: Extractor-docs/WWW/manual/extractor.txt.gz
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/extractor.txt.gz
===================================================================
--- Extractor-docs/WWW/manual/extractor.txt.gz 2012-09-06 10:54:46 UTC (rev
23667)
+++ Extractor-docs/WWW/manual/extractor.txt.gz 2012-09-06 11:11:18 UTC (rev
23668)
Property changes on: Extractor-docs/WWW/manual/extractor.txt.gz
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: Extractor-docs/WWW/manual/html_node/Concept-Index.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Concept-Index.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Concept-Index.html 2012-09-06
11:11:18 UTC (rev 23668)
@@ -0,0 +1,87 @@
+<html lang="en">
+<head>
+<title>Concept Index - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="prev" href="Copying.html#Copying" title="Copying">
+<link rel="next" href="Function-and-Data-Index.html#Function-and-Data-Index"
title="Function and Data Index">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Concept-Index"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Function-and-Data-Index.html#Function-and-Data-Index">Function and Data
Index</a>,
+Previous: <a rel="previous" accesskey="p"
href="Copying.html#Copying">Copying</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="unnumbered">Concept Index</h2>
+
+<ul class="index-cp" compact>
+<li><a href="Reporting-bugs.html#index-bug-63">bug</a>: <a
href="Reporting-bugs.html#Reporting-bugs">Reporting bugs</a></li>
+<li><a href="Extracting.html#index-bus-error-46">bus error</a>: <a
href="Extracting.html#Extracting">Extracting</a></li>
+<li><a href="Internal-utility-functions.html#index-character-set-61">character
set</a>: <a
href="Internal-utility-functions.html#Internal-utility-functions">Internal
utility functions</a></li>
+<li><a href="Utility-functions.html#index-concurrency-54">concurrency</a>: <a
href="Utility-functions.html#Utility-functions">Utility functions</a></li>
+<li><a href="Extracting.html#index-concurrency-42">concurrency</a>: <a
href="Extracting.html#Extracting">Extracting</a></li>
+<li><a href="Plugin-management.html#index-concurrency-10">concurrency</a>: <a
href="Plugin-management.html#Plugin-management">Plugin management</a></li>
+<li><a href="Preparation.html#index-directory-structure-5">directory
structure</a>: <a href="Preparation.html#Preparation">Preparation</a></li>
+<li><a href="Preparation.html#index-environment-variables-7">environment
variables</a>: <a href="Preparation.html#Preparation">Preparation</a></li>
+<li><a href="Introduction.html#index-error-handling-1">error handling</a>: <a
href="Introduction.html#Introduction">Introduction</a></li>
+<li><a href="Meta-types.html#index-gettext-30">gettext</a>: <a
href="Meta-types.html#Meta-types">Meta types</a></li>
+<li><a href="Copying.html#index-GPL_002c-GNU-General-Public-License-64">GPL,
GNU General Public License</a>: <a href="Copying.html#Copying">Copying</a></li>
+<li><a
href="Meta-types.html#index-internationalization-31">internationalization</a>:
<a href="Meta-types.html#Meta-types">Meta types</a></li>
+<li><a href="Language-bindings.html#index-Java-47">Java</a>: <a
href="Language-bindings.html#Language-bindings">Language bindings</a></li>
+<li><a href="Introduction.html#index-license-3">license</a>: <a
href="Introduction.html#Introduction">Introduction</a></li>
+<li><a href="Language-bindings.html#index-Mono-48">Mono</a>: <a
href="Language-bindings.html#Language-bindings">Language bindings</a></li>
+<li><a href="Preparation.html#index-packageing-4">packageing</a>: <a
href="Preparation.html#Preparation">Preparation</a></li>
+<li><a href="Language-bindings.html#index-Perl-49">Perl</a>: <a
href="Language-bindings.html#Language-bindings">Language bindings</a></li>
+<li><a href="Language-bindings.html#index-PHP-51">PHP</a>: <a
href="Language-bindings.html#Language-bindings">Language bindings</a></li>
+<li><a href="Preparation.html#index-plugin-6">plugin</a>: <a
href="Preparation.html#Preparation">Preparation</a></li>
+<li><a href="Introduction.html#index-plugin-2">plugin</a>: <a
href="Introduction.html#Introduction">Introduction</a></li>
+<li><a href="Language-bindings.html#index-Python-50">Python</a>: <a
href="Language-bindings.html#Language-bindings">Language bindings</a></li>
+<li><a href="Utility-functions.html#index-reentrant-53">reentrant</a>: <a
href="Utility-functions.html#Utility-functions">Utility functions</a></li>
+<li><a href="Extracting.html#index-reentrant-41">reentrant</a>: <a
href="Extracting.html#Extracting">Extracting</a></li>
+<li><a href="Plugin-management.html#index-reentrant-9">reentrant</a>: <a
href="Plugin-management.html#Plugin-management">Plugin management</a></li>
+<li><a href="Language-bindings.html#index-Ruby-52">Ruby</a>: <a
href="Language-bindings.html#Language-bindings">Language bindings</a></li>
+<li><a href="Extracting.html#index-SIGBUS-45">SIGBUS</a>: <a
href="Extracting.html#Extracting">Extracting</a></li>
+<li><a
href="Utility-functions.html#index-thread_002dsafety-56">thread-safety</a>: <a
href="Utility-functions.html#Utility-functions">Utility functions</a></li>
+<li><a href="Extracting.html#index-thread_002dsafety-44">thread-safety</a>: <a
href="Extracting.html#Extracting">Extracting</a></li>
+<li><a
href="Plugin-management.html#index-thread_002dsafety-12">thread-safety</a>: <a
href="Plugin-management.html#Plugin-management">Plugin management</a></li>
+<li><a href="Utility-functions.html#index-threads-55">threads</a>: <a
href="Utility-functions.html#Utility-functions">Utility functions</a></li>
+<li><a href="Extracting.html#index-threads-43">threads</a>: <a
href="Extracting.html#Extracting">Extracting</a></li>
+<li><a href="Plugin-management.html#index-threads-11">threads</a>: <a
href="Plugin-management.html#Plugin-management">Plugin management</a></li>
+<li><a href="Internal-utility-functions.html#index-UTF_002d8-60">UTF-8</a>: <a
href="Internal-utility-functions.html#Internal-utility-functions">Internal
utility functions</a></li>
+ </ul></body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Copying.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Copying.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Copying.html 2012-09-06 11:11:18 UTC
(rev 23668)
@@ -0,0 +1,396 @@
+<html lang="en">
+<head>
+<title>Copying - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="prev" href="Reporting-bugs.html#Reporting-bugs" title="Reporting
bugs">
+<link rel="next" href="Concept-Index.html#Concept-Index" title="Concept Index">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Copying"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Concept-Index.html#Concept-Index">Concept Index</a>,
+Previous: <a rel="previous" accesskey="p"
href="Reporting-bugs.html#Reporting-bugs">Reporting bugs</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="appendix">Appendix A GNU GENERAL PUBLIC LICENSE</h2>
+
+<p><a name="index-GPL_002c-GNU-General-Public-License-64"></a><div
align="center">Version 2, June 1991</div>
+
+<pre class="display"> Copyright © 1989, 1991 Free Software
Foundation, Inc.
+ 59 Temple Place – Suite 330, Boston, MA 02111-1307, USA
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+</pre>
+<h4 class="appendixsubsec">A.0.1 Preamble</h4>
+
+<p>The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software—to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ <p>When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ <p>To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ <p>For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ <p>We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ <p>Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ <p>Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ <p>The precise terms and conditions for copying, distribution and
+modification follow.
+
+ <ol type=1 start=1>
+<li>This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The “Program”,
below,
+refers to any such program or work, and a “work based on the
Program”
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term “modification”.) Each licensee is addressed as
“you”.
+
+ <p>Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ <li>You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+ <p>You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ <li>You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ <ol type=a start=1>
+<li>You must cause the modified files to carry prominent notices
+stating that you changed the files and the date of any change.
+
+ <li>You must cause any work that you distribute or publish, that in
+whole or in part contains or is derived from the Program or any
+part thereof, to be licensed as a whole at no charge to all third
+parties under the terms of this License.
+
+ <li>If the modified program normally reads commands interactively
+when run, you must cause it, when started running for such
+interactive use in the most ordinary way, to print or display an
+announcement including an appropriate copyright notice and a
+notice that there is no warranty (or else, saying that you provide
+a warranty) and that users may redistribute the program under
+these conditions, and telling the user how to view a copy of this
+License. (Exception: if the Program itself is interactive but
+does not normally print such an announcement, your work based on
+the Program is not required to print an announcement.)
+ </ol>
+
+ <p>These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+ <p>Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+ <p>In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ <li>You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ <ol type=a start=1>
+<li>Accompany it with the complete corresponding machine-readable
+source code, which must be distributed under the terms of Sections
+1 and 2 above on a medium customarily used for software interchange; or,
+
+ <li>Accompany it with a written offer, valid for at least three
+years, to give any third party, for a charge no more than your
+cost of physically performing source distribution, a complete
+machine-readable copy of the corresponding source code, to be
+distributed under the terms of Sections 1 and 2 above on a medium
+customarily used for software interchange; or,
+
+ <li>Accompany it with the information you received as to the offer
+to distribute corresponding source code. (This alternative is
+allowed only for noncommercial distribution and only if you
+received the program in object code or executable form with such
+an offer, in accord with Subsection b above.)
+ </ol>
+
+ <p>The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+ <p>If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ <li>You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ <li>You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ <li>Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ <li>If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+ <p>If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+ <p>It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+ <p>This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ <li>If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ <li>The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ <p>Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and “any
+later version”, you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ <li>If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ <li>BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ <li>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+ </ol>
+
+<h3 class="unnumberedsec">How to Apply These Terms to Your New Programs</h3>
+
+<p>If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ <p>To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the “copyright” line and a pointer to where the full notice is
found.
+
+<pre class="smallexample"> <var>one line to give the program's name and an
idea of what it does.</var>
+ Copyright (C) 19<var>yy</var> <var>name of author</var>
+
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the GNU General Public License
+ as published by the Free Software Foundation; either version 2
+ of the License, or (at your option) any later version.
+
+ This program 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
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
+</pre>
+ <p>Also add information on how to contact you by electronic and paper mail.
+
+ <p>If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+<pre class="smallexample"> Gnomovision version 69, Copyright (C)
19<var>yy</var> <var>name of author</var>
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
+ type `show w'. This is free software, and you are welcome
+ to redistribute it under certain conditions; type `show c'
+ for details.
+</pre>
+ <p>The hypothetical commands ‘<samp><span class="samp">show
w</span></samp>’ and ‘<samp><span class="samp">show
c</span></samp>’ should show
+the appropriate parts of the General Public License. Of course, the
+commands you use may be called something other than ‘<samp><span
class="samp">show w</span></samp>’ and
+‘<samp><span class="samp">show c</span></samp>’; they could even
be mouse-clicks or menu items—whatever
+suits your program.
+
+ <p>You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a “copyright disclaimer” for the program,
if
+necessary. Here is a sample; alter the names:
+
+<pre class="smallexample"> Yoyodyne, Inc., hereby disclaims all copyright
+ interest in the program `Gnomovision'
+ (which makes passes at compilers) written
+ by James Hacker.
+
+ <var>signature of Ty Coon</var>, 1 April 1989
+ Ty Coon, President of Vice
+</pre>
+ <p>This General Public License does not permit incorporating your program
into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Existing-Plugins.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Existing-Plugins.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Existing-Plugins.html 2012-09-06
11:11:18 UTC (rev 23668)
@@ -0,0 +1,90 @@
+<html lang="en">
+<head>
+<title>Existing Plugins - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="prev" href="Utility-functions.html#Utility-functions"
title="Utility functions">
+<link rel="next" href="Writing-new-Plugins.html#Writing-new-Plugins"
title="Writing new Plugins">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Existing-Plugins"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Writing-new-Plugins.html#Writing-new-Plugins">Writing new Plugins</a>,
+Previous: <a rel="previous" accesskey="p"
href="Utility-functions.html#Utility-functions">Utility functions</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="chapter">7 Existing Plugins</h2>
+
+ <ul>
+<li>ARCHIVE (using libarchive)
+<li>DVI
+<li>EXIV2 (using libexiv2, 0.23 or later preferred)
+<li>FLAC (using libFLAC)
+<li>GIF (using libgif)
+<li>GSTREAMER (using libgstreamer v1.0 or later)
+<li>HTML (using libtidy)
+<li>IT
+<li>JPEG (using libjpeg v8 or later)
+<li>MAN
+<li>MIDI (using libsmf)
+<li>MIME (using libmagic)
+<li>MPEG (using libmpeg2)
+<li>NSF
+<li>NSFE
+<li>ODF
+<li>OLE2 (with libgsf)
+<li>OGG (with libogg)
+<li>PNG
+<li>PS
+<li>RIFF
+<li>RPM (using librpm)
+<li>S3M
+<li>SID
+<li>ThumbnailFFMPEG (using libavformat and related libav-libraries, including
libswscale)
+<li>ThumbnailGtk (using libgtk)
+<li>TIFF (with libtiff, tested with v4)
+<li>WAV
+<li>XM
+<li>ZIP
+</ul>
+
+ <p><samp><span class="file">gzip</span></samp> and <samp><span
class="file">bzip2</span></samp> compressed versions of these formats are
+also supported (as well as meta data embedded by <samp><span
class="file">gzip</span></samp> itself)
+if zlib or libbz2 are available.
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Extracting-meta-data.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Extracting-meta-data.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Extracting-meta-data.html
2012-09-06 11:11:18 UTC (rev 23668)
@@ -0,0 +1,67 @@
+<html lang="en">
+<head>
+<title>Extracting meta data - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="prev" href="Generalities.html#Generalities" title="Generalities">
+<link rel="next" href="Language-bindings.html#Language-bindings"
title="Language bindings">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Extracting-meta-data"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Language-bindings.html#Language-bindings">Language bindings</a>,
+Previous: <a rel="previous" accesskey="p"
href="Generalities.html#Generalities">Generalities</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="chapter">4 Extracting meta data</h2>
+
+<p>In order to extract meta data with <acronym>GNU libextractor</acronym> you
first need to
+load the respective plugins and then call the extraction API
+with the plugins and the data to process. This section
+documents how to load and unload plugins, the various types
+and formats in which meta data is returned to the application
+and finally the extraction API itself.
+
+<ul class="menu">
+<li><a accesskey="1" href="Plugin-management.html#Plugin-management">Plugin
management</a>: How to load and unload plugins
+<li><a accesskey="2" href="Meta-types.html#Meta-types">Meta types</a>:
About meta types
+<li><a accesskey="3" href="Meta-formats.html#Meta-formats">Meta formats</a>:
About meta formats
+<li><a accesskey="4" href="Extracting.html#Extracting">Extracting</a>:
How to use the extraction API
+</ul>
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Extracting.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Extracting.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Extracting.html 2012-09-06 11:11:18 UTC
(rev 23668)
@@ -0,0 +1,86 @@
+<html lang="en">
+<head>
+<title>Extracting - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="up" href="Extracting-meta-data.html#Extracting-meta-data"
title="Extracting meta data">
+<link rel="prev" href="Meta-formats.html#Meta-formats" title="Meta formats">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Extracting"></a>
+<p>
+Previous: <a rel="previous" accesskey="p"
href="Meta-formats.html#Meta-formats">Meta formats</a>,
+Up: <a rel="up" accesskey="u"
href="Extracting-meta-data.html#Extracting-meta-data">Extracting meta data</a>
+<hr>
+</div>
+
+<h3 class="section">4.4 Extracting</h3>
+
+<div class="defun">
+— Function Pointer: int
<b>(</b><var>*EXTRACTOR_MetaDataProcessor</var>)(<var>void *cls, const char
*plugin_name, enum EXTRACTOR_MetaType type, enum EXTRACTOR_MetaFormat format,
const char *data_mime_type, const char *data, size_t data_len</var>)<var><a
name="index-g_t_0028-37"></a></var><br>
+<blockquote><p><a name="index-EXTRACTOR_005fMetaDataProcessor-38"></a>
+Type of a function that libextractor calls for each meta data item found.
+
+ <dl>
+<dt><var>cls</var><dd>closure (user-defined)
+
+ <br><dt><var>plugin_name</var><dd>name of the plugin that produced
this value; special values can be used (i.e. '<zlib>' for zlib being used
in the main libextractor library and yielding meta data);
+
+ <br><dt><var>type</var><dd>libextractor-type describing the meta
data;
+
+ <br><dt><var>format basic</var><dd>format information about data
+
+ <br><dt><var>data_mime_type</var><dd>mime-type of data (not of the
original file); can be NULL (if mime-type is not known);
+
+ <br><dt><var>data</var><dd>actual meta-data found
+
+ <br><dt><var>data_len</var><dd>number of bytes in data
+
+ </dl>
+
+ <p>Return 0 to continue extracting, 1 to abort.
+</p></blockquote></div>
+
+<div class="defun">
+— Function: void <b>EXTRACTOR_extract</b> (<var>struct
EXTRACTOR_PluginList *plugins, const char *filename, const void *data, size_t
size, EXTRACTOR_MetaDataProcessor proc, void *proc_cls</var>)<var><a
name="index-EXTRACTOR_005fextract-39"></a></var><br>
+<blockquote><p><a name="index-EXTRACTOR_005fextract-40"></a><a
name="index-reentrant-41"></a><a name="index-concurrency-42"></a><a
name="index-threads-43"></a><a name="index-thread_002dsafety-44"></a>
+This is the main function for extracting keywords with <acronym>GNU
libextractor</acronym>. The first argument is a plugin list which specifies
the set of plugins that should be used for extracting meta data. The
‘<samp><span class="samp">filename</span></samp>’ argument is
optional and can be used to specify the name of a file to process. If
‘<samp><span class="samp">filename</span></samp>’ is NULL, then the
‘<samp><span class="samp">data</span></samp>’ argument must point
to the in-memory data to extract meta data from. If ‘<samp><span
class="samp">filename</span></samp>’ is non-NULL, ‘<samp><span
class="samp">data</span></samp>’ can be NULL. If ‘<samp><span
class="samp">data</span></samp>’ is non-null, then ‘<samp><span
class="samp">size</span></samp>’ is the size of ‘<samp><span
class="samp">data</span></samp>’ in bytes. Otherwise ‘<samp><span
class="samp">size</sp
an></sam
p>’ should be zero. For each meta data item found, GNU libextractor
will call the ‘<samp><span class="samp">proc</span></samp>’
function, passing ‘<samp><span class="samp">proc_cls</span></samp>’
as the first argument to ‘<samp><span
class="samp">proc</span></samp>’. The other arguments to
‘<samp><span class="samp">proc</span></samp>’ depend on the
specific meta data found.
+
+ <p><a name="index-SIGBUS-45"></a><a name="index-bus-error-46"></a>Meta
data extraction should never really fail — at worst, <acronym>GNU
libextractor</acronym> should not call ‘<samp><span
class="samp">proc</span></samp>’ with any meta data. By design,
<acronym>GNU libextractor</acronym> should never crash or leak memory, even
given corrupt files as input. Note however, that running <acronym>GNU
libextractor</acronym> on a corrupt file system (or incorrectly <tt>mmap</tt>ed
files) can result in the operating system sending a SIGBUS (bus error) to the
process. While <acronym>GNU libextractor</acronym> runs plugins
out-of-process, it first maps the file into memory and then attempts to
decompress it. During decompression it is possible to encounter a SIGBUS.
<acronym>GNU libextractor</acronym> will <em>not</em> attempt to catch this
signal and your application is likely to crash. Note again that this should
only happen if the file <em>system</em
> is cor
rupt (not if individual files are corrupt). If this is not acceptable, you
might want to consider running <acronym>GNU libextractor</acronym> itself also
out-of-process (as done, for example, by <a
href="http://grothoff.org/christian/doodle/";>doodle</a>).
+
+ </blockquote></div>
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Function-and-Data-Index.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Function-and-Data-Index.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Function-and-Data-Index.html
2012-09-06 11:11:18 UTC (rev 23668)
@@ -0,0 +1,69 @@
+<html lang="en">
+<head>
+<title>Function and Data Index - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="prev" href="Concept-Index.html#Concept-Index" title="Concept Index">
+<link rel="next" href="Type-Index.html#Type-Index" title="Type Index">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Function-and-Data-Index"></a>
+<p>
+Next: <a rel="next" accesskey="n" href="Type-Index.html#Type-Index">Type
Index</a>,
+Previous: <a rel="previous" accesskey="p"
href="Concept-Index.html#Concept-Index">Concept Index</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="unnumbered">Function and Data Index</h2>
+
+
+
+<ul class="index-fn" compact>
+<li><a href="Extracting.html#index-g_t_0028-37"><code>(</code></a>: <a
href="Extracting.html#Extracting">Extracting</a></li>
+<li><a
href="Internal-utility-functions.html#index-EXTRACTOR_005fcommon_005fconvert_005fto_005futf8-59"><code>EXTRACTOR_common_convert_to_utf8</code></a>:
<a href="Internal-utility-functions.html#Internal-utility-functions">Internal
utility functions</a></li>
+<li><a
href="Extracting.html#index-EXTRACTOR_005fextract-39"><code>EXTRACTOR_extract</code></a>:
<a href="Extracting.html#Extracting">Extracting</a></li>
+<li><a
href="Meta-data-printing.html#index-EXTRACTOR_005fmeta_005fdata_005fprint-58"><code>EXTRACTOR_meta_data_print</code></a>:
<a href="Meta-data-printing.html#Meta-data-printing">Meta data
printing</a></li>
+<li><a
href="Meta-types.html#index-EXTRACTOR_005fmetatype_005fget_005fmax-27"><code>EXTRACTOR_metatype_get_max</code></a>:
<a href="Meta-types.html#Meta-types">Meta types</a></li>
+<li><a
href="Meta-types.html#index-EXTRACTOR_005fmetatype_005fto_005fdescription-32"><code>EXTRACTOR_metatype_to_description</code></a>:
<a href="Meta-types.html#Meta-types">Meta types</a></li>
+<li><a
href="Meta-types.html#index-EXTRACTOR_005fmetatype_005fto_005fstring-28"><code>EXTRACTOR_metatype_to_string</code></a>:
<a href="Meta-types.html#Meta-types">Meta types</a></li>
+<li><a
href="Plugin-management.html#index-EXTRACTOR_005fplugin_005fadd-20"><code>EXTRACTOR_plugin_add</code></a>:
<a href="Plugin-management.html#Plugin-management">Plugin management</a></li>
+<li><a
href="Plugin-management.html#index-EXTRACTOR_005fplugin_005fadd_005fconfig-22"><code>EXTRACTOR_plugin_add_config</code></a>:
<a href="Plugin-management.html#Plugin-management">Plugin management</a></li>
+<li><a
href="Plugin-management.html#index-EXTRACTOR_005fplugin_005fadd_005fdefaults-24"><code>EXTRACTOR_plugin_add_defaults</code></a>:
<a href="Plugin-management.html#Plugin-management">Plugin management</a></li>
+<li><a
href="Plugin-management.html#index-EXTRACTOR_005fplugin_005fremove-18"><code>EXTRACTOR_plugin_remove</code></a>:
<a href="Plugin-management.html#Plugin-management">Plugin management</a></li>
+<li><a
href="Plugin-management.html#index-EXTRACTOR_005fplugin_005fremove_005fall-16"><code>EXTRACTOR_plugin_remove_all</code></a>:
<a href="Plugin-management.html#Plugin-management">Plugin management</a></li>
+<li><a
href="Utility-Constants.html#index-EXTRACTOR_005fVERSION-57"><code>EXTRACTOR_VERSION</code></a>:
<a href="Utility-Constants.html#Utility-Constants">Utility Constants</a></li>
+ </ul></body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Generalities.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Generalities.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Generalities.html 2012-09-06
11:11:18 UTC (rev 23668)
@@ -0,0 +1,122 @@
+<html lang="en">
+<head>
+<title>Generalities - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="prev" href="Preparation.html#Preparation" title="Preparation">
+<link rel="next" href="Extracting-meta-data.html#Extracting-meta-data"
title="Extracting meta data">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Generalities"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Extracting-meta-data.html#Extracting-meta-data">Extracting meta data</a>,
+Previous: <a rel="previous" accesskey="p"
href="Preparation.html#Preparation">Preparation</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="chapter">3 Generalities</h2>
+
+<h3 class="section">3.1 Introduction to the “extract” command</h3>
+
+<p>The <samp><span class="command">extract</span></samp> command takes a list
of file names as arguments,
+extracts meta data from each of those files and prints the result to
+the console. By default, <samp><span class="command">extract</span></samp>
will use all available
+plugins and print all (non-binary) meta data that is found.
+
+ <p>The set of plugins used by <samp><span
class="command">extract</span></samp> can be controlled using
+the “-l” and “-n” options. Use “-n” to
not load all of the
+default plugins. Use “-l NAME” to specifically load a certain
+plugin. For example, specify “-n -l mime” to only use the MIME
+plugin.
+
+ <p>Using the “-p” option the output of <samp><span
class="command">extract</span></samp> can be limited
+to only certain keyword types. Similarly, using the “-x” option,
+certain keyword types can be excluded. A list of all known keyword
+types can be obtained using the “-L” option.
+
+ <p>The output format of <samp><span class="command">extract</span></samp>
can be influenced with the
+“-V” (more verbose, lists filenames), “-g”
(grep-friendly, all
+meta data on a single line per file) and “-b” (bibTeX style)
+options.
+
+<h3 class="section">3.2 Common usage examples for “extract”</h3>
+
+<pre class="example"> $ extract test/test.jpg
+ comment - (C) 2001 by Christian Grothoff, using gimp 1.2 1
+ mimetype - image/jpeg
+
+ $ extract -V -x comment test/test.jpg
+ Keywords for file test/test.jpg:
+ mimetype - image/jpeg
+
+ $ extract -p comment test/test.jpg
+ comment - (C) 2001 by Christian Grothoff, using gimp 1.2 1
+
+ $ extract -nV -l png.so -p comment test/test.jpg test/test.png
+ Keywords for file test/test.jpg:
+ Keywords for file test/test.png:
+ comment - Testing keyword extraction
+</pre>
+<h3 class="section">3.3 Introduction to the libextractor library</h3>
+
+<p>Each public symbol exported by <acronym>GNU libextractor</acronym> has the
prefix
+<tt>EXTRACTOR_</tt>. All-caps names are used for constants. For the
+impatient, the minimal C code for using <acronym>GNU libextractor</acronym>
(on the
+executing binary itself) looks like this:
+
+<pre class="verbatim">#include <extractor.h>
+
+int
+main (int argc, char ** argv)
+{
+ struct EXTRACTOR_PluginList *plugins
+ = EXTRACTOR_plugin_add_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
+ EXTRACTOR_extract (plugins, argv[1],
+ NULL, 0,
+ &EXTRACTOR_meta_data_print, stdout);
+ EXTRACTOR_plugin_remove_all (plugins);
+ return 0;
+}
+</pre>
+
+ <p>The minimal API illustrated by this example is actually sufficient for
+many applications. The full external C API of <acronym>GNU
libextractor</acronym> is described
+in chapter See <a
href="Extracting-meta-data.html#Extracting-meta-data">Extracting meta data</a>.
Bindings for other languages
+are described in chapter See <a
href="Language-bindings.html#Language-bindings">Language bindings</a>. The API
for
+writing new plugins is described in chapter See <a
href="Writing-new-Plugins.html#Writing-new-Plugins">Writing new Plugins</a>.
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Internal-utility-functions.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Internal-utility-functions.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Internal-utility-functions.html
2012-09-06 11:11:18 UTC (rev 23668)
@@ -0,0 +1,97 @@
+<html lang="en">
+<head>
+<title>Internal utility functions - The GNU libextractor Reference
Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="prev" href="Writing-new-Plugins.html#Writing-new-Plugins"
title="Writing new Plugins">
+<link rel="next" href="Reporting-bugs.html#Reporting-bugs" title="Reporting
bugs">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Internal-utility-functions"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Reporting-bugs.html#Reporting-bugs">Reporting bugs</a>,
+Previous: <a rel="previous" accesskey="p"
href="Writing-new-Plugins.html#Writing-new-Plugins">Writing new Plugins</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="chapter">9 Internal utility functions</h2>
+
+<p>Some plugins link against the <code>libextractor_common</code> library which
+provides common abstractions needed by many plugins. This section
+documents this internal API for plugin developers. Note that the headers
+for this library are (intentionally) not installed: we do not consider
+this API stable and it should hence only be used by plugins that are
+build and shipped with GNU libextractor. Third-party plugins should
+not use it.
+
+ <p><samp><span class="file">convert_numeric.h</span></samp> defines various
conversion functions for
+numbers (in particular, byte-order conversion for floating point
+numbers).
+
+ <p><samp><span class="file">unzip.h</span></samp> defines an API for
accessing compressed files.
+
+ <p><samp><span class="file">pack.h</span></samp> provides an interpreter
for unpacking structs of integer
+numbers from streams and converting from big or little endian to host
+byte order at the same time.
+
+ <p><samp><span class="file">convert.h</span></samp> provides a function for
character set conversion described
+below.
+
+<div class="defun">
+— Function: char * <b>EXTRACTOR_common_convert_to_utf8</b> (<var>const
char *input, size_t len, const char *charset</var>)<var><a
name="index-EXTRACTOR_005fcommon_005fconvert_005fto_005futf8-59"></a></var><br>
+<blockquote><p><a name="index-UTF_002d8-60"></a><a
name="index-character-set-61"></a><a
name="index-EXTRACTOR_005fcommon_005fconvert_005fto_005futf8-62"></a>Various
<acronym>GNU libextractor</acronym> plugins make use of the internal
+<samp><span class="file">convert.h</span></samp> header which defines a
function
+
+ <p><tt>EXTRACTOR_common_convert_to_utf8</tt> which can be used to
easily convert text from
+any character set to UTF-8. This conversion is important since the
+linked list of keywords that is returned by <acronym>GNU
libextractor</acronym> is
+expected to contain only UTF-8 strings. Naturally, proper conversion
+may not always be possible since some file formats fail to specify the
+character set. In that case, it is often better to not convert at
+all.
+
+ <p>The arguments to <tt>EXTRACTOR_common_convert_to_utf8</tt> are the
input string (which
+does <em>not</em> have to be zero-terminated), the length of the input
+string, and the character set (which <em>must</em> be zero-terminated).
+Which character sets are supported depends on the platform, a list can
+generally be obtained using the <samp><span class="command">iconv
-l</span></samp> command. The
+return value from <tt>EXTRACTOR_common_convert_to_utf8</tt> is a
zero-terminated string
+in UTF-8 format. The responsibility to free the string is with the
+caller, so storing the string in the keyword list is acceptable.
+</p></blockquote></div>
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Introduction.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Introduction.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Introduction.html 2012-09-06
11:11:18 UTC (rev 23668)
@@ -0,0 +1,99 @@
+<html lang="en">
+<head>
+<title>Introduction - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="prev" href="index.html#Top" title="Top">
+<link rel="next" href="Preparation.html#Preparation" title="Preparation">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Introduction"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Preparation.html#Preparation">Preparation</a>,
+Previous: <a rel="previous" accesskey="p" href="index.html#Top">Top</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="chapter">1 Introduction</h2>
+
+<p><a name="index-error-handling-1"></a><acronym>GNU libextractor</acronym> is
GNU's library for extracting meta data from
+files. Meta data includes format information (such as mime type,
+image dimensions, color depth, recording frequency), content
+descriptions (such as document title or document description) and
+copyright information (such as license, author and contributors).
+Meta data extraction is an inherently uncertain business — a parse
+error can be a corrupt file, an incompatibility in the file format
+version, an entirely different file format or a bug in the parser. As
+a result of this uncertainty, <acronym>GNU libextractor</acronym> deliberately
+avoids to ever report any errors. Unexpected file contents simply
+result in less or possibly no meta data being extracted.
+
+ <p><a name="index-plugin-2"></a><acronym>GNU libextractor</acronym> uses
plugins to handle various file formats.
+Technically a plugin can support multiple file formats; however, most
+plugins only support one particular format. By default,
+<acronym>GNU libextractor</acronym> will use all plugins that are available
and found
+in the plugin installation directory. Applications can
+request the use of only specific plugins or the exclusion of
+certain plugins.
+
+ <p><acronym>GNU libextractor</acronym> is distributed with the <samp><span
class="command">extract</span></samp>
+command<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a> which is a
command-line tool for extracting
+meta data. <samp><span class="command">extract</span></samp> is given a list
of filenames and
+prints the resulting meta data to the console. The <samp><span
class="command">extract</span></samp>
+source code also serves as an advanced example for how to use
+<acronym>GNU libextractor</acronym>.
+
+ <p>This manual focuses on providing documentation for writing software
+with <acronym>GNU libextractor</acronym>. The only relevant parts for
end-users
+are the chapter on compiling and installing <acronym>GNU libextractor</acronym>
+(See <a href="Preparation.html#Preparation">Preparation</a>.). Also, the
chapter on existing plugins maybe of
+interest (See <a href="Existing-Plugins.html#Existing-Plugins">Existing
Plugins</a>.). Additional documentation for
+end-users can be find in the man page on <samp><span
class="command">extract</span></samp> (using
+<tt>man extract</tt>).
+
+ <p><a name="index-license-3"></a><acronym>GNU libextractor</acronym> is
licensed under the GNU General Public License,
+specifically, since version 0.7, <acronym>GNU libextractor</acronym> is
licensed under GPLv3
+<em>or any later version</em>.
+
+ <div class="footnote">
+<hr>
+<h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1"
href="#fnd-1">1</a>]</small> Some distributions ship <samp><span
class="command">extract</span></samp> in a
+seperate package.</p>
+
+ <hr></div>
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Language-bindings.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Language-bindings.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Language-bindings.html 2012-09-06
11:11:18 UTC (rev 23668)
@@ -0,0 +1,106 @@
+<html lang="en">
+<head>
+<title>Language bindings - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="prev" href="Extracting-meta-data.html#Extracting-meta-data"
title="Extracting meta data">
+<link rel="next" href="Utility-functions.html#Utility-functions"
title="Utility functions">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Language-bindings"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Utility-functions.html#Utility-functions">Utility functions</a>,
+Previous: <a rel="previous" accesskey="p"
href="Extracting-meta-data.html#Extracting-meta-data">Extracting meta data</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="chapter">5 Language bindings</h2>
+
+<p><a name="index-Java-47"></a><a name="index-Mono-48"></a><a
name="index-Perl-49"></a><a name="index-Python-50"></a><a
name="index-PHP-51"></a><a name="index-Ruby-52"></a>
+<acronym>GNU libextractor</acronym> works immediately with C and C++ code.
Bindings for Java, Mono, Ruby, Perl, PHP and Python are available for download
from the main <acronym>GNU libextractor</acronym> website. Documentation for
these bindings (if available) is part of the downloads for the respective
binding. In all cases, a full installation of the C library is required before
the binding can be installed.
+
+<h3 class="section">5.1 Java</h3>
+
+<p>Compiling the GNU libextractor Java binding follows the usual process of
+running <samp><span class="command">configure</span></samp> and <samp><span
class="command">make</span></samp>. The result will be a
+shared C library <samp><span class="file">libextractor_java.so</span></samp>
with the native code and
+a JAR file (installed to <samp><span
class="file">$PREFIX/share/java/libextractor.java</span></samp>).
+
+ <p>A minimal example for using GNU libextractor's Java binding would look
+like this:
+<pre class="verbatim">import org.gnu.libextractor.*;
+import java.util.ArrayList;
+
+public static void main(String[] args) {
+ Extractor ex = Extractor.getDefault();
+ for (int i=0;i<args.length;i++) {
+ ArrayList keywords = ex.extract(args[i]);
+ System.out.println("Keywords for " + args[i] + ":");
+ for (int j=0;j<keywords.size();j++)
+ System.out.println(keywords.get(j));
+ }
+}
+</pre>
+
+ <p>The GNU libextractor library and the <samp><span
class="file">libextractor_java.so</span></samp> JNI binding
+have to be in the library search path for this to work. Furthermore, the
+<samp><span class="file">libextractor.jar</span></samp> file should be on the
classpath.
+
+ <p>Note that the API does not use Java 5 style generics in order to work
+with older versions of Java.
+
+<h3 class="section">5.2 Mono</h3>
+
+<p>his binding is undocumented at this point.
+
+<h3 class="section">5.3 Perl</h3>
+
+<p>This binding is undocumented at this point.
+
+<h3 class="section">5.4 Python</h3>
+
+<p>This binding is undocumented at this point.
+
+<h3 class="section">5.5 PHP</h3>
+
+<p>This binding is undocumented at this point.
+
+<h3 class="section">5.6 Ruby</h3>
+
+<p>This binding is undocumented at this point.
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Meta-data-printing.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Meta-data-printing.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Meta-data-printing.html 2012-09-06
11:11:18 UTC (rev 23668)
@@ -0,0 +1,54 @@
+<html lang="en">
+<head>
+<title>Meta data printing - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="up" href="Utility-functions.html#Utility-functions" title="Utility
functions">
+<link rel="prev" href="Utility-Constants.html#Utility-Constants"
title="Utility Constants">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Meta-data-printing"></a>
+<p>
+Previous: <a rel="previous" accesskey="p"
href="Utility-Constants.html#Utility-Constants">Utility Constants</a>,
+Up: <a rel="up" accesskey="u"
href="Utility-functions.html#Utility-functions">Utility functions</a>
+<hr>
+</div>
+
+<h3 class="section">6.2 Meta data printing</h3>
+
+<p><a name="index-EXTRACTOR_005fmeta_005fdata_005fprint-58"></a>The
<tt>EXTRACTOR_meta_data_print</tt> is a simple function which prints the meta
data found with libextractor to a file. The function is mostly useful for
debugging and as an example for how to manipulate the keyword list and can be
passed as the ‘<samp><span class="samp">proc</span></samp>’
argument to <code>EXTRACTOR_extract</code>. The file to print to should be
passed as ‘<samp><span class="samp">proc_cls</span></samp>’ (which
must be of type <code>FILE *</code>), for example <code>stdout</code>.
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Meta-formats.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Meta-formats.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Meta-formats.html 2012-09-06
11:11:18 UTC (rev 23668)
@@ -0,0 +1,59 @@
+<html lang="en">
+<head>
+<title>Meta formats - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="up" href="Extracting-meta-data.html#Extracting-meta-data"
title="Extracting meta data">
+<link rel="prev" href="Meta-types.html#Meta-types" title="Meta types">
+<link rel="next" href="Extracting.html#Extracting" title="Extracting">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Meta-formats"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Extracting.html#Extracting">Extracting</a>,
+Previous: <a rel="previous" accesskey="p"
href="Meta-types.html#Meta-types">Meta types</a>,
+Up: <a rel="up" accesskey="u"
href="Extracting-meta-data.html#Extracting-meta-data">Extracting meta data</a>
+<hr>
+</div>
+
+<h3 class="section">4.3 Meta formats</h3>
+
+<p><a name="index-enum-EXTRACTOR_005fMetaFormat-36"></a>
+<tt>enum EXTRACTOR_MetaFormat</tt> is a C enum which defines on a high level
how the extracted meta data is represented. Currently, the library uses three
formats: UTF-8 strings, C strings and binary data. A fourth value,
<code>EXTRACTOR_METAFORMAT_UNKNOWN</code> is defined but not used. UTF-8
strings are 0-terminated strings that have been converted to UTF-8. The format
code is <code>EXTRACTOR_METAFORMAT_UTF8</code>. Ideally, most text meta data
will be of this format. Some file formats fail to specify the encoding used
for the text. In this case, the text cannot be converted to UTF-8. However,
the meta data is still known to be 0-terminated and presumably human-readable.
In this case, the format code used is
<code>EXTRACTOR_METAFORMAT_C_STRING</code>; however, this should not be
understood to mean that the encoding is the same as that used by the C
compiler. Finally, for binary data (mostly images), the format
<code>EXTRACTOR_METAFORMAT_BINARY</code> is used.
+
+ <p>Naturally this is not a precise description of the meta format. Plugins
can provide a more precise description (if known) by providing the respective
mime type of the meta data. For example, binary image meta data could be also
tagged as “image/png” and normal text would typically be tagged as
“text/plain”.
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Meta-types.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Meta-types.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Meta-types.html 2012-09-06 11:11:18 UTC
(rev 23668)
@@ -0,0 +1,69 @@
+<html lang="en">
+<head>
+<title>Meta types - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="up" href="Extracting-meta-data.html#Extracting-meta-data"
title="Extracting meta data">
+<link rel="prev" href="Plugin-management.html#Plugin-management" title="Plugin
management">
+<link rel="next" href="Meta-formats.html#Meta-formats" title="Meta formats">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Meta-types"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Meta-formats.html#Meta-formats">Meta formats</a>,
+Previous: <a rel="previous" accesskey="p"
href="Plugin-management.html#Plugin-management">Plugin management</a>,
+Up: <a rel="up" accesskey="u"
href="Extracting-meta-data.html#Extracting-meta-data">Extracting meta data</a>
+<hr>
+</div>
+
+<h3 class="section">4.2 Meta types</h3>
+
+<p><a name="index-enum-EXTRACTOR_005fMetaType-26"></a><a
name="index-EXTRACTOR_005fmetatype_005fget_005fmax-27"></a>
+<tt>enum EXTRACTOR_MetaType</tt> is a C enum which defines a list of over 100
different types of meta data. The total number can differ between different
<acronym>GNU libextractor</acronym> releases; the maximum value for the current
release can be obtained using the <tt>EXTRACTOR_metatype_get_max</tt> function.
All values in this enumeration are of the form <tt>EXTRACTOR_METATYPE_XXX</tt>.
+
+<div class="defun">
+— Function: const char * <b>EXTRACTOR_metatype_to_string</b> (<var>enum
EXTRACTOR_MetaType type</var>)<var><a
name="index-EXTRACTOR_005fmetatype_005fto_005fstring-28"></a></var><br>
+<blockquote><p><a
name="index-EXTRACTOR_005fmetatype_005fto_005fstring-29"></a><a
name="index-gettext-30"></a><a name="index-internationalization-31"></a>
+The function <tt>EXTRACTOR_metatype_to_string</tt> can be used to obtain a
short English string ‘<samp><span class="samp">s</span></samp>’
describing the meta data type. The string can be translated into other
languages using GNU gettext with the domain set to <acronym>GNU
libextractor</acronym> (<tt>dgettext("libextractor", s)</tt>).
+</p></blockquote></div>
+
+<div class="defun">
+— Function: const char * <b>EXTRACTOR_metatype_to_description</b>
(<var>enum EXTRACTOR_MetaType type</var>)<var><a
name="index-EXTRACTOR_005fmetatype_005fto_005fdescription-32"></a></var><br>
+<blockquote><p><a
name="index-EXTRACTOR_005fmetatype_005fto_005fdescription-33"></a><a
name="index-gettext-34"></a><a name="index-internationalization-35"></a>
+The function <tt>EXTRACTOR_metatype_to_description</tt> can be used to obtain
a longer English string ‘<samp><span class="samp">s</span></samp>’
describing the meta data type. The description may be empty if the short
description returned by <code>EXTRACTOR_metatype_to_string</code> is already
comprehensive. The string can be translated into other languages using GNU
gettext with the domain set to <acronym>GNU libextractor</acronym>
(<tt>dgettext("libextractor", s)</tt>).
+</p></blockquote></div>
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Plugin-management.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Plugin-management.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Plugin-management.html 2012-09-06
11:11:18 UTC (rev 23668)
@@ -0,0 +1,118 @@
+<html lang="en">
+<head>
+<title>Plugin management - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="up" href="Extracting-meta-data.html#Extracting-meta-data"
title="Extracting meta data">
+<link rel="next" href="Meta-types.html#Meta-types" title="Meta types">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Plugin-management"></a>
+<p>
+Next: <a rel="next" accesskey="n" href="Meta-types.html#Meta-types">Meta
types</a>,
+Up: <a rel="up" accesskey="u"
href="Extracting-meta-data.html#Extracting-meta-data">Extracting meta data</a>
+<hr>
+</div>
+
+<h3 class="section">4.1 Plugin management</h3>
+
+<p><a name="index-reentrant-9"></a><a name="index-concurrency-10"></a><a
name="index-threads-11"></a><a name="index-thread_002dsafety-12"></a><a
name="index-enum-EXTRACTOR_005fOptions-13"></a>
+Using <acronym>GNU libextractor</acronym> from a multi-threaded parent process
requires some
+care. The problem is that on most platforms <acronym>GNU
libextractor</acronym> starts
+sub-processes for the actual extraction work. This is useful to
+isolate the parent process from potential bugs; however, it can cause
+problems if the parent process is multi-threaded. The issue is that
+at the time of the fork, another thread of the application may hold a
+lock (i.e. in gettext or libc). That lock would then never be
+released in the child process (as the other thread is not present in
+the child process). As a result, the child process would then
+deadlock on trying to acquire the lock and never terminate. This has
+actually been observed with a lock in GNU gettext that is triggered by
+the plugin startup code when it interacts with libltdl.
+
+ <p>The problem can be solved by loading the plugins using the
+<code>EXTRACTOR_OPTION_IN_PROCESS</code> option, which will run <acronym>GNU
libextractor</acronym>
+in-process and thus avoid the locking issue. In this case, all of the
+functions for loading and unloading plugins, including
+<tt>EXTRACTOR_plugin_add_defaults</tt> and
+<tt>EXTRACTOR_plugin_remove_all</tt>, are thread-safe and reentrant.
+However, using the same plugin list from multiple threads at the same
+time is not safe.
+
+ <p>All plugin code is expected required to be reentrant and state-less,
+but due to the extensive use of 3rd party libraries this cannot
+be guaranteed.
+
+<div class="defun">
+— C Struct: <b>EXTRACTOR_PluginList</b><var><a
name="index-EXTRACTOR_005fPluginList-14"></a></var><br>
+<blockquote><p><a name="index-struct-EXTRACTOR_005fPluginList-15"></a>
+A plugin list represents a set of GNU libextractor plugins. Most of
+the GNU libextractor API is concerned with either constructing a
+plugin list or using it to extract meta data. The internal representation
+of the plugin list is of no concern to users or plugin developers.
+</p></blockquote></div>
+
+<div class="defun">
+— Function: void <b>EXTRACTOR_plugin_remove_all</b> (<var>struct
EXTRACTOR_PluginList *plugins</var>)<var><a
name="index-EXTRACTOR_005fplugin_005fremove_005fall-16"></a></var><br>
+<blockquote><p><a name="index-EXTRACTOR_005fplugin_005fremove_005fall-17"></a>
+Unload all of the plugins in the given list.
+</p></blockquote></div>
+
+<div class="defun">
+— Function: struct EXTRACTOR_PluginList * <b>EXTRACTOR_plugin_remove</b>
(<var>struct EXTRACTOR_PluginList *plugins, const char*name</var>)<var><a
name="index-EXTRACTOR_005fplugin_005fremove-18"></a></var><br>
+<blockquote><p><a name="index-EXTRACTOR_005fplugin_005fremove-19"></a>
+Unloads a particular plugin. The given name should be the short name of the
plugin, for example “mime” for the mime-type extractor or
“mpeg” for the MPEG extractor.
+</p></blockquote></div>
+
+<div class="defun">
+— Function: struct EXTRACTOR_PluginList * <b>EXTRACTOR_plugin_add</b>
(<var>struct EXTRACTOR_PluginList *plugins, const char* name,const char*
options, enum EXTRACTOR_Options flags</var>)<var><a
name="index-EXTRACTOR_005fplugin_005fadd-20"></a></var><br>
+<blockquote><p><a name="index-EXTRACTOR_005fplugin_005fadd-21"></a>
+Loads a particular plugin. The plugin is added to the existing list, which
can be NULL. The second argument specifies the name of the plugin (i.e.
“ogg”). The third argument can be NULL and specifies
plugin-specific options. Finally, the last argument specifies if the plugin
should be executed out-of-process
(<code>EXTRACTOR_OPTION_DEFAULT_POLICY</code>) or not.
+</p></blockquote></div>
+
+<div class="defun">
+— Function: struct EXTRACTOR_PluginList *
<b>EXTRACTOR_plugin_add_config</b> (<var>struct EXTRACTOR_PluginList *plugins,
const char* config, enum EXTRACTOR_Options flags</var>)<var><a
name="index-EXTRACTOR_005fplugin_005fadd_005fconfig-22"></a></var><br>
+<blockquote><p><a name="index-EXTRACTOR_005fplugin_005fadd_005fconfig-23"></a>
+Loads and unloads plugins based on a configuration string, modifying the
existing list, which can be NULL. The string has the format
“[-]NAME(OPTIONS){:[-]NAME(OPTIONS)}*”. Prefixing the plugin name
with a “-” means that the plugin should be unloaded.
+</p></blockquote></div>
+
+<div class="defun">
+— Function: struct EXTRACTOR_PluginList *
<b>EXTRACTOR_plugin_add_defaults</b> (<var>enum EXTRACTOR_Options
flags</var>)<var><a
name="index-EXTRACTOR_005fplugin_005fadd_005fdefaults-24"></a></var><br>
+<blockquote><p><a
name="index-EXTRACTOR_005fplugin_005fadd_005fdefaults-25"></a>
+Loads all of the plugins in the plugin directory. This function is what most
<acronym>GNU libextractor</acronym> applications should use to setup the
plugins.
+</p></blockquote></div>
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Preparation.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Preparation.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Preparation.html 2012-09-06
11:11:18 UTC (rev 23668)
@@ -0,0 +1,260 @@
+<html lang="en">
+<head>
+<title>Preparation - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="prev" href="Introduction.html#Introduction" title="Introduction">
+<link rel="next" href="Generalities.html#Generalities" title="Generalities">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Preparation"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Generalities.html#Generalities">Generalities</a>,
+Previous: <a rel="previous" accesskey="p"
href="Introduction.html#Introduction">Introduction</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="chapter">2 Preparation</h2>
+
+<p>This chapter first describes the general build instructions that
+should apply to all systems. Specific instructions for known problems
+for particular platforms are then described in individual sections
+afterwards.
+
+ <p>Compiling <acronym>GNU libextractor</acronym> follows the standard GNU
autotools build process
+using <samp><span class="command">configure</span></samp> and <samp><span
class="command">make</span></samp>. For details on the GNU
+autotools build process, read the <samp><span
class="file">INSTALL</span></samp> file and query
+<tt>./configure --help</tt> for additional options.
+
+ <p><acronym>GNU libextractor</acronym> has various dependencies, most of
which are optional.
+Instead of specifying the names of the software packages, we
+will give the list in terms of the names of the respective
+Debian (unstable) packages that should be installed.
+
+ <p>You absolutely need:
+
+ <ul>
+<li>libtool
+<li>gcc
+<li>make
+<li>g++
+<li>libltdl7-dev
+</ul>
+
+ <p>Recommended dependencies are:
+ <ul>
+<li>zlib1g-dev
+<li>libbz2-dev
+<li>libgif-dev
+<li>libvorbis-dev
+<li>libflac-dev
+<li>libmpeg2-4-dev
+<li>librpm-dev
+<li>libgtk2.0-dev
+<li>libgsf-1-dev
+<li>libqt4-dev
+<li>libpoppler-dev
+<li>libexiv2-dev
+<li>libavformat-dev
+<li>libswscale-dev
+</ul>
+
+ <p>For Subversion access and compilation one also needs:
+ <ul>
+<li>subversion
+<li>autoconf
+<li>automake
+</ul>
+
+ <p>Please notify us if we missed some dependencies (note that the list is
+supposed to only list direct dependencies, not transitive
+dependencies).
+
+ <p>Once you have compiled and installed <acronym>GNU
libextractor</acronym>, you should have a file
+<samp><span class="file">extractor.h</span></samp> installed in your
<samp><span class="file">include/</span></samp> directory. This
+file should be the starting point for your C and C++ development with
+<acronym>GNU libextractor</acronym>. The build process also installs the
<samp><span class="file">extract</span></samp> binary and
+man pages for <samp><span class="file">extract</span></samp> and <acronym>GNU
libextractor</acronym>. The <samp><span class="file">extract</span></samp> man
page
+documents the <samp><span class="file">extract</span></samp> tool. The
<acronym>GNU libextractor</acronym> man page gives a brief
+summary of the C API for <acronym>GNU libextractor</acronym>.
+
+ <p><a name="index-packageing-4"></a><a
name="index-directory-structure-5"></a><a name="index-plugin-6"></a><a
name="index-environment-variables-7"></a><a
name="index-LIBEXTRACTOR_005fPREFIX-8"></a>When you install <acronym>GNU
libextractor</acronym>, various plugins will be
+installed in the <samp><span class="file">lib/libextractor/</span></samp>
directory. The main library
+will be installed as <samp><span
class="file">lib/libextractor.so</span></samp>. Note that
+<acronym>GNU libextractor</acronym> will attempt to find the plugins relative
to the
+path of the main library. Consequently, a package manager can move
+the library and its plugins to a different location later — as long
+as the relative path between the main library and the plugins is
+preserved. As a method of last resort, the user can specify an
+environment variable <tt>LIBEXTRACTOR_PREFIX</tt>. If
+<acronym>GNU libextractor</acronym> cannot locate a plugin, it will look in
+<tt>LIBEXTRACTOR_PREFIX/lib/libextractor/</tt>.
+
+<h3 class="section">2.1 Installation on GNU/Linux</h3>
+
+<p>Should work using the standard instructions without problems.
+
+<h3 class="section">2.2 Installation on FreeBSD</h3>
+
+<p>Should work using the standard instructions without problems.
+
+<h3 class="section">2.3 Installation on OpenBSD</h3>
+
+<p>OpenBSD 3.8 also doesn't have CODESET in <samp><span
class="file">langinfo.h</span></samp>. CODESET
+is used in <acronym>GNU libextractor</acronym> in about three places. This
causes problems
+during compilation.
+
+<h3 class="section">2.4 Installation on NetBSD</h3>
+
+<p>No reports so far.
+
+<h3 class="section">2.5 Installation using MinGW</h3>
+
+<p>Linking -lstdc++ with the provided libtool fails on Cygwin, this
+is a problem with libtool, there is unfortunately no flag to tell
+libtool how to do its job on Cygwin and it seems that it cannot be the
+default to set the library check to 'pass_all'. Patching libtool may
+help.
+
+ <p>Note: this is a rather dated report and may no longer apply.
+
+<h3 class="section">2.6 Installation on OS X</h3>
+
+<p>libextractor has two installation methods on Mac OS X: it can be
+installed as a Mac OS X framework or with the standard
+<samp><span class="command">./configure; make; make install</span></samp>
shell commands. The
+framework package is self-contained, but currently omits some of the
+extractor plugins that can be compiled in if libextractor is installed
+with <samp><span class="command">./configure; make; make install</span></samp>
(provided that the
+required dependencies exist.)
+
+<h4 class="subsection">2.6.1 Installing and uninstalling the framework</h4>
+
+<p>The binary framework is distributed as a disk image (<samp><span
class="file">Extractor-x.x.xx.dmg</span></samp>).
+Installation is done by opening the disk image and clicking <samp><span
class="file">Extractor.pkg</span></samp>
+inside it. The Mac OS X installer application will then run. The framework
+is installed to the root volume's <samp><span
class="file">/Library/Frameworks</span></samp> folder and installing
+will require admin privileges.
+
+ <p>The framework can be uninstalled by dragging
+<samp><span class="file">/Library/Frameworks/Extractor.framework</span></samp>
cto the <samp><span class="file">Trash</span></samp>.
+
+<h4 class="subsection">2.6.2 Using the framework</h4>
+
+<p>In the framework, the <samp><span class="command">extract</span></samp>
command line tool can be found at
+<samp><span
class="file">/Library/Frameworks/Extractor.framework/Versions/Current/bin/extract</span></samp>
+
+ <p>The framework can be used in software projects as a framework or as a
dynamic
+library.
+
+ <p>When using the framework as a dynamic library in projects using
autotools,
+one would most likely want to add
+"-I/Library/Frameworks/Extractor.framework/Versions/Current/include"
+to CPPFLAGS and
+"-L/Library/Frameworks/Extractor.framework/Versions/Current/lib"
+to LDFLAGS.
+
+<h4 class="subsection">2.6.3 Example for using the framework</h4>
+
+<pre class="example"><pre class="verbatim"> // hello.c
+ #include <Extractor/extractor.h>
+
+ int
+ main (int argc, char **argv)
+ {
+ struct EXTRACTOR_PluginList *el;
+ el = EXTRACTOR_plugin_load_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
+ // ...
+ EXTRACTOR_plugin_remove_all (el);
+ return 0;
+ }
+</pre>
+</pre>
+ <p>You can then compile the example using
+
+<pre class="verbatim">$ gcc -o hello hello.c -framework Extractor
+</pre>
+
+<h4 class="subsection">2.6.4 Example for using the dynamic library</h4>
+
+<pre class="example"><pre class="verbatim"> // hello.c
+ #include <extractor.h>
+ int main()
+ {
+ struct EXTRACTOR_PluginList *el;
+ el = EXTRACTOR_plugin_load_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
+ // ...
+ EXTRACTOR_plugin_remove_all (el);
+ return 0;
+ }
+</pre>
+</pre>
+ <p>You can then compile the example using
+
+<pre class="verbatim">$ gcc
-I/Library/Frameworks/Extractor.framework/Versions/Current/include \
+ -o hello hello.c \
+ -L/Library/Frameworks/Extractor.framework/Versions/Current/lib \
+ -lextractor
+</pre>
+
+ <p>Notice the difference in the <code>#include</code> line.
+
+<h3 class="section">2.7 Note to package maintainers</h3>
+
+<p>The suggested way to package GNU libextractor is to split it into
+roughly the following binary packages:
+
+ <ul>
+<li>libextractor (main library only, only hard dependency for other packages
depending on GNU libextractor)
+<li>extract (command-line tool and man page extract.1)
+<li>libextractor-dev (extractor.h header and man page libextractor.3)
+<li>libextractor-doc (this manual)
+<li>libextractor-plugins (plugins without external dependencies; recommended
but not required by extract and libextractor package)
+<li>libextractor-plugin-XXX (plugin with dependency on libXXX, for example for
XXX=mpeg this would be <samp><span
class="file">libextractor_mpeg.so</span></samp>)
+<li>libextractor-plugins-all (meta package that requires all plugins except
experimental plugins)
+</ul>
+
+ <p>This would enable minimal installations (i.e. for embedded systems) to
+not include any plugins, as well as moderate-size installations (that
+do not trigger GTK and X11) for systems that have limited resources.
+Right now, the MP4 plugin is experimental and does nothing and should
+thus never be included at all. The gstreamer plugin is experimental
+but largely works with the correct version of gstreamer and can thus
+be packaged (especially if the dependency is available on the target
+system) but should probably not be part of libextractor-plugins-all.
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Reporting-bugs.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Reporting-bugs.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Reporting-bugs.html 2012-09-06
11:11:18 UTC (rev 23668)
@@ -0,0 +1,59 @@
+<html lang="en">
+<head>
+<title>Reporting bugs - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="prev"
href="Internal-utility-functions.html#Internal-utility-functions"
title="Internal utility functions">
+<link rel="next" href="Copying.html#Copying" title="Copying">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Reporting-bugs"></a>
+<p>
+Next: <a rel="next" accesskey="n" href="Copying.html#Copying">Copying</a>,
+Previous: <a rel="previous" accesskey="p"
href="Internal-utility-functions.html#Internal-utility-functions">Internal
utility functions</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="chapter">10 Reporting bugs</h2>
+
+<p><a name="index-bug-63"></a><acronym>GNU libextractor</acronym> uses the <a
href="https://gnunet.org/bugs/";>Mantis bugtracking system</a>. If possible,
please report bugs there. You can also e-mail
+the <acronym>GNU libextractor</acronym> mailinglist at <a
href="address@hidden">address@hidden</a>.
+
+<!-- ********************************************************** -->
+<!-- ******************* Appendices ************************* -->
+<!-- ********************************************************** -->
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Type-Index.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Type-Index.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Type-Index.html 2012-09-06 11:11:18 UTC
(rev 23668)
@@ -0,0 +1,60 @@
+<html lang="en">
+<head>
+<title>Type Index - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="prev" href="Function-and-Data-Index.html#Function-and-Data-Index"
title="Function and Data Index">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Type-Index"></a>
+<p>
+Previous: <a rel="previous" accesskey="p"
href="Function-and-Data-Index.html#Function-and-Data-Index">Function and Data
Index</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="unnumbered">Type Index</h2>
+
+
+
+<ul class="index-tp" compact>
+<li><a
href="Meta-formats.html#index-enum-EXTRACTOR_005fMetaFormat-36"><code>enum
EXTRACTOR_MetaFormat</code></a>: <a href="Meta-formats.html#Meta-formats">Meta
formats</a></li>
+<li><a href="Meta-types.html#index-enum-EXTRACTOR_005fMetaType-26"><code>enum
EXTRACTOR_MetaType</code></a>: <a href="Meta-types.html#Meta-types">Meta
types</a></li>
+<li><a
href="Plugin-management.html#index-enum-EXTRACTOR_005fOptions-13"><code>enum
EXTRACTOR_Options</code></a>: <a
href="Plugin-management.html#Plugin-management">Plugin management</a></li>
+<li><a
href="Extracting.html#index-EXTRACTOR_005fMetaDataProcessor-38"><code>EXTRACTOR_MetaDataProcessor</code></a>:
<a href="Extracting.html#Extracting">Extracting</a></li>
+<li><a
href="Plugin-management.html#index-EXTRACTOR_005fPluginList-14"><code>EXTRACTOR_PluginList</code></a>:
<a href="Plugin-management.html#Plugin-management">Plugin management</a></li>
+<li><a
href="Plugin-management.html#index-struct-EXTRACTOR_005fPluginList-15"><code>struct
EXTRACTOR_PluginList</code></a>: <a
href="Plugin-management.html#Plugin-management">Plugin management</a></li>
+ </ul></body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Utility-Constants.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Utility-Constants.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Utility-Constants.html 2012-09-06
11:11:18 UTC (rev 23668)
@@ -0,0 +1,61 @@
+<html lang="en">
+<head>
+<title>Utility Constants - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="up" href="Utility-functions.html#Utility-functions" title="Utility
functions">
+<link rel="next" href="Meta-data-printing.html#Meta-data-printing" title="Meta
data printing">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Utility-Constants"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Meta-data-printing.html#Meta-data-printing">Meta data printing</a>,
+Up: <a rel="up" accesskey="u"
href="Utility-functions.html#Utility-functions">Utility functions</a>
+<hr>
+</div>
+
+<h3 class="section">6.1 Utility Constants</h3>
+
+<p><a name="index-EXTRACTOR_005fVERSION-57"></a>The constant
<tt>EXTRACTOR_VERSION</tt> is a hexadecimal
+representation of the version number of the installed libextractor
+header. The hexadecimal format is 0xAABBCCDD where AA is the major
+version (so far always 0), BB is the minor version, CC is the revision
+and DD the patch number. For example, for version 0.5.18, we would
+have AA=0, BB=5, CC=18 and DD=0. Minor releases such as 0.5.18a or
+significant changes in unreleased versions would be marked with DD=1
+or higher.
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Utility-functions.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Utility-functions.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Utility-functions.html 2012-09-06
11:11:18 UTC (rev 23668)
@@ -0,0 +1,60 @@
+<html lang="en">
+<head>
+<title>Utility functions - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="prev" href="Language-bindings.html#Language-bindings"
title="Language bindings">
+<link rel="next" href="Existing-Plugins.html#Existing-Plugins" title="Existing
Plugins">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Utility-functions"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Existing-Plugins.html#Existing-Plugins">Existing Plugins</a>,
+Previous: <a rel="previous" accesskey="p"
href="Language-bindings.html#Language-bindings">Language bindings</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="chapter">6 Utility functions</h2>
+
+<p><a name="index-reentrant-53"></a><a name="index-concurrency-54"></a><a
name="index-threads-55"></a><a name="index-thread_002dsafety-56"></a>This
chapter describes various utility functions for <acronym>GNU
libextractor</acronym> usage. All of the functions are reentrant.
+
+<ul class="menu">
+<li><a accesskey="1" href="Utility-Constants.html#Utility-Constants">Utility
Constants</a>
+<li><a accesskey="2" href="Meta-data-printing.html#Meta-data-printing">Meta
data printing</a>
+</ul>
+
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/Writing-new-Plugins.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Writing-new-Plugins.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/Writing-new-Plugins.html
2012-09-06 11:11:18 UTC (rev 23668)
@@ -0,0 +1,114 @@
+<html lang="en">
+<head>
+<title>Writing new Plugins - The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="index.html#Top">
+<link rel="prev" href="Existing-Plugins.html#Existing-Plugins" title="Existing
Plugins">
+<link rel="next"
href="Internal-utility-functions.html#Internal-utility-functions"
title="Internal utility functions">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<div class="node">
+<a name="Writing-new-Plugins"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Internal-utility-functions.html#Internal-utility-functions">Internal
utility functions</a>,
+Previous: <a rel="previous" accesskey="p"
href="Existing-Plugins.html#Existing-Plugins">Existing Plugins</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="chapter">8 Writing new Plugins</h2>
+
+<p>Writing a new plugin for libextractor usually requires writing of or
+interfacing with an actual parser for a specific format. How this is
+can be accomplished depends on the format and cannot be specified in
+general. However, care should be taken for the code to be reentrant
+and highly fault-tolerant, especially with respect to malformed
+inputs.
+
+ <p>Plugins should start by verifying that the header of the data matches
+the specific format and immediately return if that is not the case.
+Even if the header matches the expected file format, plugins must not
+assume that the remainder of the file is well formed.
+
+ <p>The plugin library must be called libextractor_XXX.so, where XXX
+denotes the file format of the plugin. The library must export a
+method <tt>libextractor_XXX_extract_method</tt>, with the following
+signature:
+<pre class="verbatim">void
+EXTRACTOR_XXX_extract_method (struct EXTRACTOR_ExtractContext *ec);
+</pre>
+
+ <p>‘<samp><span class="samp">ec</span></samp>’ contains various
information the plugin may need for its
+execution. Most importantly, it contains functions for reading
+(“read”) and seeking (“seek”) the input data and for
returning
+extracted data (“proc”). The “config” member can
contain
+additional configuration options. “proc” should be called on
+each meta data item found. If “proc” returns non-zero,
+processing should be aborted (if possible).
+
+ <p>In order to test new plugins, the <samp><span
class="file">extract</span></samp> command can be run
+with the options “-ni” and “-l XXX” . This will run
the plugin
+in-process (making it easier to debug) and without any of the other
+plugins.
+
+<h3 class="section">8.1 Example for a minimal extract method</h3>
+
+<p>The following example shows how a plugin can return the mime type of
+a file.
+<pre class="example"><pre class="verbatim"> void
+ EXTRACTOR_mymime_extract (struct EXTRACTOR_ExtractContext *ec)
+ {
+ void *data;
+ ssize_t data_size,
+
+ if (-1 == (data_size = ec->read (ec->cls, &data, 4)))
+ return; /* read error */
+ if (data_size < 4)
+ return; /* file too small */
+ if (0 != memcmp (data, "\177ELF", 4))
+ return; /* not ELF */
+ if (0 != ec->proc (ec->cls,
+ "mymime",
+ EXTRACTOR_METATYPE_MIMETYPE,
+ EXTRACTOR_METAFORMAT_UTF8,
+ "text/plain",
+ "application/x-executable",
+ 1 + strlen("application/x-executable")))
+ return;
+ /* more calls to 'proc' here as needed */
+ }
+</pre>
+</pre>
+ </body></html>
+
Added: Extractor-docs/WWW/manual/html_node/index.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/index.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/index.html 2012-09-06 11:11:18 UTC
(rev 23668)
@@ -0,0 +1,192 @@
+<html lang="en">
+<head>
+<title>The GNU libextractor Reference Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="The GNU libextractor Reference Manual">
+<meta name="generator" content="makeinfo 4.13">
+<link title="Top" rel="start" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+GNU libextractor is a GNU package.
+
+
+Copyright (C) 2007, 2010, 2012 Christian Grothoff
+
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU Free Documentation License,
+ Version 1.3 or any later version published by the Free Software
+ Foundation; with no Invariant Sections, no Front-Cover Texts, and
+ no Back-Cover Texts. A copy of the license is included in the
+ section entitled "GNU Free Documentation License".
+ -->
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<h1 class="settitle">The GNU libextractor Reference Manual</h1>
+<div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+<li><a href="index.html#toc_Top">The GNU libextractor Reference Manual</a></li>
+<li><a href="index.html#toc_Introduction">1 Introduction</a></li>
+<li><a href="index.html#toc_Preparation">2 Preparation</a></li>
+<li><a href="index.html#toc_Generalities">3 Generalities</a></li>
+<li><a href="index.html#toc_Extracting-meta-data">4 Extracting meta
data</a></li>
+<li><a href="index.html#toc_Language-bindings">5 Language bindings</a></li>
+<li><a href="index.html#toc_Utility-functions">6 Utility functions</a></li>
+<li><a href="index.html#toc_Existing-Plugins">7 Existing Plugins</a></li>
+<li><a href="index.html#toc_Writing-new-Plugins">8 Writing new Plugins</a></li>
+<li><a href="index.html#toc_Internal-utility-functions">9 Internal utility
functions</a></li>
+<li><a href="index.html#toc_Reporting-bugs">10 Reporting bugs</a></li>
+<li><a href="index.html#toc_Copying">Appendix A GNU GENERAL PUBLIC
LICENSE</a></li>
+<li><a href="index.html#toc_Concept-Index">Concept Index</a></li>
+<li><a href="index.html#toc_Function-and-Data-Index">Function and Data
Index</a></li>
+<li><a href="index.html#toc_Type-Index">Type Index</a></li>
+</ul>
+</div>
+
+
+
+ <div class="contents">
+<h2>Table of Contents</h2>
+<ul>
+<li><a name="toc_Top" href="index.html#Top">The GNU libextractor Reference
Manual</a>
+<li><a name="toc_Introduction" href="Introduction.html#Introduction">1
Introduction</a>
+<li><a name="toc_Preparation" href="Preparation.html#Preparation">2
Preparation</a>
+<ul>
+<li><a href="Preparation.html#Preparation">2.1 Installation on GNU/Linux</a>
+<li><a href="Preparation.html#Preparation">2.2 Installation on FreeBSD</a>
+<li><a href="Preparation.html#Preparation">2.3 Installation on OpenBSD</a>
+<li><a href="Preparation.html#Preparation">2.4 Installation on NetBSD</a>
+<li><a href="Preparation.html#Preparation">2.5 Installation using MinGW</a>
+<li><a href="Preparation.html#Preparation">2.6 Installation on OS X</a>
+<ul>
+<li><a href="Preparation.html#Preparation">2.6.1 Installing and uninstalling
the framework</a>
+<li><a href="Preparation.html#Preparation">2.6.2 Using the framework</a>
+<li><a href="Preparation.html#Preparation">2.6.3 Example for using the
framework</a>
+<li><a href="Preparation.html#Preparation">2.6.4 Example for using the dynamic
library</a>
+</li></ul>
+<li><a href="Preparation.html#Preparation">2.7 Note to package maintainers</a>
+</li></ul>
+<li><a name="toc_Generalities" href="Generalities.html#Generalities">3
Generalities</a>
+<ul>
+<li><a href="Generalities.html#Generalities">3.1 Introduction to the
“extract” command</a>
+<li><a href="Generalities.html#Generalities">3.2 Common usage examples for
“extract”</a>
+<li><a href="Generalities.html#Generalities">3.3 Introduction to the
libextractor library</a>
+</li></ul>
+<li><a name="toc_Extracting-meta-data"
href="Extracting-meta-data.html#Extracting-meta-data">4 Extracting meta data</a>
+<ul>
+<li><a href="Plugin-management.html#Plugin-management">4.1 Plugin
management</a>
+<li><a href="Meta-types.html#Meta-types">4.2 Meta types</a>
+<li><a href="Meta-formats.html#Meta-formats">4.3 Meta formats</a>
+<li><a href="Extracting.html#Extracting">4.4 Extracting</a>
+</li></ul>
+<li><a name="toc_Language-bindings"
href="Language-bindings.html#Language-bindings">5 Language bindings</a>
+<ul>
+<li><a href="Language-bindings.html#Language-bindings">5.1 Java</a>
+<li><a href="Language-bindings.html#Language-bindings">5.2 Mono</a>
+<li><a href="Language-bindings.html#Language-bindings">5.3 Perl</a>
+<li><a href="Language-bindings.html#Language-bindings">5.4 Python</a>
+<li><a href="Language-bindings.html#Language-bindings">5.5 PHP</a>
+<li><a href="Language-bindings.html#Language-bindings">5.6 Ruby</a>
+</li></ul>
+<li><a name="toc_Utility-functions"
href="Utility-functions.html#Utility-functions">6 Utility functions</a>
+<ul>
+<li><a href="Utility-Constants.html#Utility-Constants">6.1 Utility
Constants</a>
+<li><a href="Meta-data-printing.html#Meta-data-printing">6.2 Meta data
printing</a>
+</li></ul>
+<li><a name="toc_Existing-Plugins"
href="Existing-Plugins.html#Existing-Plugins">7 Existing Plugins</a>
+<li><a name="toc_Writing-new-Plugins"
href="Writing-new-Plugins.html#Writing-new-Plugins">8 Writing new Plugins</a>
+<ul>
+<li><a href="Writing-new-Plugins.html#Writing-new-Plugins">8.1 Example for a
minimal extract method</a>
+</li></ul>
+<li><a name="toc_Internal-utility-functions"
href="Internal-utility-functions.html#Internal-utility-functions">9 Internal
utility functions</a>
+<li><a name="toc_Reporting-bugs" href="Reporting-bugs.html#Reporting-bugs">10
Reporting bugs</a>
+<li><a name="toc_Copying" href="Copying.html#Copying">Appendix A GNU GENERAL
PUBLIC LICENSE</a>
+<ul>
+<ul>
+<li><a href="Copying.html#Copying">A.0.1 Preamble</a>
+</li></ul>
+<li><a href="Copying.html#Copying">How to Apply These Terms to Your New
Programs</a>
+</li></ul>
+<li><a name="toc_Concept-Index"
href="Concept-Index.html#Concept-Index">Concept Index</a>
+<li><a name="toc_Function-and-Data-Index"
href="Function-and-Data-Index.html#Function-and-Data-Index">Function and Data
Index</a>
+<li><a name="toc_Type-Index" href="Type-Index.html#Type-Index">Type Index</a>
+</li></ul>
+</div>
+
+<div class="node">
+<a name="Top"></a>
+<p>
+Next: <a rel="next" accesskey="n"
href="Introduction.html#Introduction">Introduction</a>,
+Up: <a rel="up" accesskey="u" href="../index.html#dir">(dir)</a>
+<hr>
+</div>
+
+<h2 class="unnumbered">The GNU libextractor Reference Manual</h2>
+
+<p>This manual is for GNU libextractor
+(version 1.0.0, 5 September 2012).
+
+ <p>GNU libextractor is a GNU package.
+
+ <p>Copyright © 2007, 2010, 2012 Christian Grothoff
+
+ <blockquote>
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3
+or any later version published by the Free Software Foundation;
+with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
+Texts. A copy of the license is included in the section entitled "GNU
+Free Documentation License".
+</blockquote>
+
+<ul class="menu">
+<li><a accesskey="1" href="Introduction.html#Introduction">Introduction</a>:
What is <acronym>GNU libextractor</acronym>.
+<li><a accesskey="2" href="Preparation.html#Preparation">Preparation</a>:
What you should do before using the library.
+<li><a accesskey="3" href="Generalities.html#Generalities">Generalities</a>:
General library functions and data types.
+<li><a accesskey="4"
href="Extracting-meta-data.html#Extracting-meta-data">Extracting meta data</a>:
How to use <acronym>GNU libextractor</acronym> to obtain meta data.
+<li><a accesskey="5" href="Language-bindings.html#Language-bindings">Language
bindings</a>: How to use <acronym>GNU libextractor</acronym> from
languages other than C.
+<li><a accesskey="6" href="Utility-functions.html#Utility-functions">Utility
functions</a>: Utility functions of <acronym>GNU
libextractor</acronym>.
+<li><a accesskey="7" href="Existing-Plugins.html#Existing-Plugins">Existing
Plugins</a>: What plugins are available.
+<li><a accesskey="8"
href="Writing-new-Plugins.html#Writing-new-Plugins">Writing new Plugins</a>:
How to write new plugins for <acronym>GNU libextractor</acronym>.
+<li><a accesskey="9"
href="Internal-utility-functions.html#Internal-utility-functions">Internal
utility functions</a>: Utility functions of <acronym>GNU
libextractor</acronym> for writing plugins.
+<li><a href="Reporting-bugs.html#Reporting-bugs">Reporting bugs</a>:
How to report bugs or request new features.
+
+</li></ul>
+<p>Appendices
+
+</p>
+<ul class="menu">
+<li><a href="Copying.html#Copying">Copying</a>: The GNU
General Public License says how you
+ can copy and share some parts of <acronym>GNU
libextractor</acronym>.
+
+</li></ul>
+<p>Indices
+
+</p>
+<ul class="menu">
+<li><a href="Concept-Index.html#Concept-Index">Concept Index</a>:
Index of concepts and programs.
+<li><a href="Function-and-Data-Index.html#Function-and-Data-Index">Function
and Data Index</a>: Index of functions, variables and data types.
+<li><a href="Type-Index.html#Type-Index">Type Index</a>:
Index of data types.
+
+ </ul>
+
+<!-- ********************************************************** -->
+<!-- ******************* Introduction *********************** -->
+<!-- ********************************************************** -->
+ </body></html>
+
Added: Extractor-docs/WWW/manual/index.html
===================================================================
--- Extractor-docs/WWW/manual/index.html (rev 0)
+++ Extractor-docs/WWW/manual/index.html 2012-09-06 11:11:18 UTC (rev
23668)
@@ -0,0 +1,1694 @@
+
+
+
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";>
+<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
+<!-- ViewVC :: http://www.viewvc.org/ -->
+<head>
+<title>[sources] Log of /texinfo/texinfo/util/gendocs_template</title>
+<meta name="generator" content="ViewVC 1.0.7" />
+<link rel="stylesheet" href="/viewcvs-doc/styles.css" type="text/css" />
+
+</head>
+<body>
+<div style="float: right; padding: 5px;"><a
href="http://savannah.gnu.org/";><img
src="http://savannah.gnu.org/images/common/floating.png"; alt="Provided by GNU
Savannah" width="148" height="125" /></a></div>
+<h3>Savannah CVS Surfing
+
+
+- Log of /texinfo/texinfo/util/gendocs_template
+</h3>
+<table style="margin:0; border-spacing:0" class="vc_navheader">
+<tr>
+<td>
+<strong>
+
+<a href="/viewvc/">
+
+[sources]</a>
+/
+
+<a href="/viewvc/texinfo/">
+
+texinfo</a>
+/
+
+<a href="/viewvc/texinfo/texinfo/">
+
+texinfo</a>
+/
+
+<a href="/viewvc/texinfo/texinfo/util/">
+
+util</a>
+/
+
+
+
+gendocs_template
+
+
+</strong>
+
+</td>
+</tr>
+</table>
+<!-- It would be nice to detect a "web.cvs.s*.*gnu.org vhost, and use /web
instead of /sources... -->
+
+
+
+
+
+
+<p style="margin:0;">
+
+<a href="/viewvc/texinfo/texinfo/util/"><img
src="/viewcvs-doc/images/back_small.png" width="16" height="16" alt="Parent
Directory" /> Parent Directory</a>
+
+
+
+
+</p>
+
+<hr />
+<table class="auto">
+
+
+
+<tr>
+<td>Links to HEAD:</td>
+<td>
+(<a href="/viewvc/texinfo/texinfo/util/gendocs_template?view=markup">view</a>)
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=annotate">annotate</a>)
+</td>
+</tr>
+
+
+
+<tr>
+<td>Sticky Tag:</td>
+<td><form method="get" action="/viewvc/texinfo/texinfo/util/gendocs_template"
style="display: inline">
+<div style="display: inline">
+<input type="hidden" name="view" value="log" />
+
+
+<select name="pathrev" onchange="submit()">
+<option value=""></option>
+
+<optgroup label="Branches">
+
+
+<option>texinfo_4_8</option>
+
+
+
+<option>texinfo_4_13</option>
+
+
+
+<option>texinfo_4_12</option>
+
+
+
+<option>texinfo_4_11</option>
+
+
+
+<option>MAIN</option>
+
+
+</optgroup>
+
+<optgroup label="Non-branch tags">
+
+
+<option>texinfo_4_7</option>
+
+
+
+<option>HEAD</option>
+
+
+</optgroup>
+
+</select>
+
+<input type="submit" value="Set" />
+</div>
+</form>
+
+</td>
+</tr>
+</table>
+
+
+
+
+
+
+
+
+
+<div>
+<hr />
+
+<a name="rev1.23"></a>
+<a name="HEAD"></a>
+
+
+Revision <strong>1.23</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.23&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.23">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.23">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.23&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Sun Jan 1 17:09:10 2012 UTC</em> (8 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+<br />CVS Tags:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=HEAD"><strong>HEAD</strong></a>
+
+
+
+
+
+
+<br />Changes since <strong>1.22: +1 -1 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.22&r2=1.23">previous
1.22</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">2012
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.22"></a>
+
+
+Revision <strong>1.22</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.22&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.22">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.22">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.22&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Mon Mar 28 18:37:32 2011 UTC</em> (17 months, 1 week ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.21: +0 -6 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.21&r2=1.22">previous
1.21</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">rm xml comments
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.21"></a>
+
+
+Revision <strong>1.21</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.21&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.21">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.21">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.21&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Tue Mar 22 23:54:43 2011 UTC</em> (17 months, 2 weeks ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.20: +12 -13 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.20&r2=1.21">previous
1.20</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">2011, boilerplate
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.20"></a>
+
+
+Revision <strong>1.20</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.20&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.20">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.20">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.20&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Sun May 16 18:58:42 2010 UTC</em> (2 years, 3 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.19: +1 -1 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.19&r2=1.20">previous
1.19</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">2010
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.19"></a>
+
+
+Revision <strong>1.19</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.19&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.19">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.19">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.19&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Tue Apr 21 13:35:50 2009 UTC</em> (3 years, 4 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.18: +3 -5 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.18&r2=1.19">previous
1.18</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">consistently use <...> for email, a la boilerplate
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.18"></a>
+
+
+Revision <strong>1.18</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.18&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.18">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.18">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.18&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Tue Apr 21 13:26:26 2009 UTC</em> (3 years, 4 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.17: +5 -5 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.17&r2=1.18">previous
1.17</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">trailing whitespace
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.17"></a>
+
+
+Revision <strong>1.17</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.17&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.17">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.17">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.17&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Thu Jan 1 19:26:59 2009 UTC</em> (3 years, 8 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.16: +5 -7 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.16&r2=1.17">previous
1.16</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">support email replacement in templates
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.16"></a>
+
+
+Revision <strong>1.16</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.16&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.16">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.16">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.16&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Thu Jun 12 23:00:19 2008 UTC</em> (4 years, 2 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+<br />Branch point for:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=texinfo_4_13"><strong>texinfo_4_13</strong></a>
+
+
+
+
+
+<br />Changes since <strong>1.15: +3 -3 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.15&r2=1.16">previous
1.15</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">gendocs_template updates from Yavor
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.15"></a>
+
+
+Revision <strong>1.15</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.15&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.15">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.15">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.15&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Wed Oct 24 13:31:34 2007 UTC</em> (4 years, 10 months ago) by <em>gray</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+<br />Branch point for:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=texinfo_4_12"><strong>texinfo_4_12</strong></a>
+
+
+
+
+
+<br />Changes since <strong>1.14: +19 -1 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.14&r2=1.15">previous
1.14</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">Conditionally enable section and chapter split HTMLs.
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.14"></a>
+
+
+Revision <strong>1.14</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.14&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.14">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.14">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.14&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Thu Jun 14 22:53:50 2007 UTC</em> (5 years, 2 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+<br />Branch point for:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=texinfo_4_11"><strong>texinfo_4_11</strong></a>
+
+
+
+
+
+<br />Changes since <strong>1.13: +4 -0 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.13&r2=1.14">previous
1.13</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">mention possibility of buying manuals
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.13"></a>
+
+
+Revision <strong>1.13</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.13&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.13">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.13">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.13&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Tue May 22 13:25:53 2007 UTC</em> (5 years, 3 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.12: +1 -1 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.12&r2=1.13">previous
1.12</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">missing period
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.12"></a>
+
+
+Revision <strong>1.12</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.12&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.12">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.12">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.12&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Thu Apr 26 17:16:11 2007 UTC</em> (5 years, 4 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.11: +42 -55 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.11&r2=1.12">previous
1.11</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">gendocs_template conform to current GNU style
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.11"></a>
+
+
+Revision <strong>1.11</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.11&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.11">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.11">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.11&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Mon Apr 2 22:53:38 2007 UTC</em> (5 years, 5 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.10: +9 -9 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.10&r2=1.11">previous
1.10</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">bytes better than characters
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.10"></a>
+
+
+Revision <strong>1.10</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.10&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.10">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.10">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.10&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Sun Feb 25 01:36:03 2007 UTC</em> (5 years, 6 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.9: +1 -1 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.9&r2=1.10">previous
1.9</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">2007
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.9"></a>
+
+
+Revision <strong>1.9</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.9&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.9">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.9">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.9&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Sat Oct 14 14:01:21 2006 UTC</em> (5 years, 10 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.8: +1 -4 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.8&r2=1.9">previous
1.8</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">gif patents expired
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.8"></a>
+
+
+Revision <strong>1.8</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.8&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.8">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.8">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.8&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Sat Jul 15 15:45:24 2006 UTC</em> (6 years, 1 month ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.7: +2 -8 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.7&r2=1.8">previous
1.7</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">avoid RCS keywords since these are also in gnulib now
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.7"></a>
+
+
+Revision <strong>1.7</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.7&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.7">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.7">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.7&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Sun May 15 00:00:08 2005 UTC</em> (7 years, 3 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.6: +3 -3 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.6&r2=1.7">previous
1.6</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">update FSF address
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.6"></a>
+
+
+Revision <strong>1.6</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.6&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.6">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.6">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.6&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Thu Sep 23 13:16:19 2004 UTC</em> (7 years, 11 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+<br />Branch point for:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=texinfo_4_8"><strong>texinfo_4_8</strong></a>
+
+
+
+
+
+<br />Changes since <strong>1.5: +5 -6 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.5&r2=1.6">previous
1.5</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">tweak link, wording
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.5"></a>
+
+
+Revision <strong>1.5</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.5&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.5">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.5">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.5&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Mon May 17 12:57:58 2004 UTC</em> (8 years, 3 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.4: +4 -4 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.4&r2=1.5">previous
1.4</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">use package.format.tar.gz consistently
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.4"></a>
+<a name="texinfo_4_7"></a>
+
+
+Revision <strong>1.4</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.4&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.4">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.4">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.4&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Sun Apr 11 17:56:47 2004 UTC</em> (8 years, 4 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+<br />CVS Tags:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=texinfo_4_7"><strong>texinfo_4_7</strong></a>
+
+
+
+
+
+
+<br />Changes since <strong>1.3: +0 -0 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.3&r2=1.4">previous
1.3</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">import from berlios
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.3"></a>
+
+
+Revision <strong>1.3</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.3&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.3">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.3">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.3&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Sat Feb 28 00:11:56 2004 UTC</em> (8 years, 6 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.2: +101 -67 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.2&r2=1.3">previous
1.2</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">update
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.2"></a>
+
+
+Revision <strong>1.2</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.2&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.2">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.2">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.2&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Sun Oct 26 11:56:12 2003 UTC</em> (8 years, 10 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+<br />Changes since <strong>1.1: +9 -10 lines</strong>
+
+
+
+
+
+
+
+<br />Diff to <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.1&r2=1.2">previous
1.1</a>
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">.
+</pre>
+</div>
+
+
+
+<div>
+<hr />
+
+<a name="rev1.1"></a>
+
+
+Revision <strong>1.1</strong> -
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?revision=1.1&view=markup">view</a>)
+
+(<a
href="/viewvc/*checkout*/texinfo/texinfo/util/gendocs_template?revision=1.1">download</a>)
+
+(<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?annotate=1.1">annotate</a>)
+
+
+
+- <a
href="/viewvc/texinfo/texinfo/util/gendocs_template?r1=1.1&view=log">[select
for diffs]</a>
+
+
+
+
+<br />
+
+<em>Tue Oct 21 23:36:05 2003 UTC</em> (8 years, 10 months ago) by <em>karl</em>
+
+
+<br />Branch:
+
+<a
href="/viewvc/texinfo/texinfo/util/gendocs_template?view=log&pathrev=MAIN"><strong>MAIN</strong></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<pre class="vc_log">initial
+</pre>
+</div>
+
+
+
+
+
+ <hr />
+<p><a name="diff"></a>
+This form allows you to request diffs between any two revisions of this file.
+For each of the two "sides" of the diff,
+
+select a symbolic revision name using the selection box, or choose
+'Use Text Field' and enter a numeric revision.
+
+</p>
+<form method="get" action="/viewvc/texinfo/texinfo/util/gendocs_template"
id="diff_select">
+<table cellpadding="2" cellspacing="0" class="auto">
+<tr>
+<td> </td>
+<td>
+<input type="hidden" name="view" value="diff" />
+Diffs between
+
+<select name="r1">
+<option value="text" selected="selected">Use Text Field</option>
+
+<option value="1.6:texinfo_4_8">texinfo_4_8</option>
+
+<option value="1.4:texinfo_4_7">texinfo_4_7</option>
+
+<option value="1.16:texinfo_4_13">texinfo_4_13</option>
+
+<option value="1.15:texinfo_4_12">texinfo_4_12</option>
+
+<option value="1.14:texinfo_4_11">texinfo_4_11</option>
+
+<option value="1.23:MAIN">MAIN</option>
+
+<option value="1.23:HEAD">HEAD</option>
+
+</select>
+<input type="text" size="12" name="tr1"
+value="1.23"
+onchange="document.getElementById('diff_select').r1.selectedIndex=0" />
+
+and
+
+<select name="r2">
+<option value="text" selected="selected">Use Text Field</option>
+
+<option value="1.6:texinfo_4_8">texinfo_4_8</option>
+
+<option value="1.4:texinfo_4_7">texinfo_4_7</option>
+
+<option value="1.16:texinfo_4_13">texinfo_4_13</option>
+
+<option value="1.15:texinfo_4_12">texinfo_4_12</option>
+
+<option value="1.14:texinfo_4_11">texinfo_4_11</option>
+
+<option value="1.23:MAIN">MAIN</option>
+
+<option value="1.23:HEAD">HEAD</option>
+
+</select>
+<input type="text" size="12" name="tr2"
+value="1.1"
+onchange="document.getElementById('diff_select').r2.selectedIndex=0" />
+
+</td>
+</tr>
+<tr>
+<td> </td>
+<td>
+Type of Diff should be a
+<select name="diff_format" onchange="submit()">
+<option value="h" selected="selected">Colored Diff</option>
+<option value="l" >Long Colored Diff</option>
+<option value="u" >Unidiff</option>
+<option value="c" >Context Diff</option>
+<option value="s" >Side by Side</option>
+</select>
+<input type="submit" value=" Get Diffs " />
+</td>
+</tr>
+</table>
+</form>
+
+
+<form method="get" action="/viewvc/texinfo/texinfo/util/gendocs_template">
+<div>
+<hr />
+<a name="logsort"></a>
+<input type="hidden" name="view" value="log" />
+Sort log by:
+<select name="logsort" onchange="submit()">
+<option value="cvs" >Not sorted</option>
+<option value="date" selected="selected">Commit date</option>
+<option value="rev" >Revision</option>
+</select>
+<input type="submit" value=" Sort " />
+</div>
+</form>
+
+
+<hr />
+<table>
+<tr>
+<td><address>Send suggestions and report system problems to the <a
href="https://savannah.gnu.org/support/?group=administration";>Savannah
Hackers</a>.</address></td>
+<td style="text-align: right;"><strong><a
href="/viewcvs-doc/help_log.html">ViewVC Help</a></strong></td>
+</tr>
+<tr>
+<td>Powered by <a href="http://viewvc.tigris.org/";>ViewVC 1.0.7</a></td>
+<td style="text-align: right;"> </td>
+</tr>
+</table>
+</body>
+</html>
+
+
Added: Extractor-docs/WWW/run-gendocs.sh
===================================================================
--- Extractor-docs/WWW/run-gendocs.sh (rev 0)
+++ Extractor-docs/WWW/run-gendocs.sh 2012-09-06 11:11:18 UTC (rev 23668)
@@ -0,0 +1,5 @@
+#!/bin/sh
+cp ../../Extractor/doc/*.texi .
+gendocs.sh --email address@hidden extractor "GNU Libextractor manual"
+man2html -r -M /s/libextractor/man/ -p ../../Extractor/doc/extract.1 | sed -e
"s/Content-type: text\/html//" > man1/extract.1.html
+man2html -r -M /s/libextractor/man/ -p ../../Extractor/doc/libextractor.3 |
sed -e "s/Content-type: text\/html//" > man3/libextractor.3.html
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [GNUnet-SVN] r23668 - in Extractor-docs/WWW: . manual manual/html_node,
gnunet <=