[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] r23997 - in Extractor-docs/WWW: man1 man3 manual manual/htm
|
From: |
gnunet |
|
Subject: |
[GNUnet-SVN] r23997 - in Extractor-docs/WWW: man1 man3 manual manual/html_node |
|
Date: |
Tue, 25 Sep 2012 16:47:07 +0200 |
Author: grothoff
Date: 2012-09-25 16:47:07 +0200 (Tue, 25 Sep 2012)
New Revision: 23997
Added:
Extractor-docs/WWW/manual/html_node/GNU-Free-Documentation-License.html
Extractor-docs/WWW/manual/html_node/Index.html
Extractor-docs/WWW/manual/libextractor.dvi.gz
Extractor-docs/WWW/manual/libextractor.html
Extractor-docs/WWW/manual/libextractor.html.gz
Extractor-docs/WWW/manual/libextractor.html_node.tar.gz
Extractor-docs/WWW/manual/libextractor.info.tar.gz
Extractor-docs/WWW/manual/libextractor.pdf
Extractor-docs/WWW/manual/libextractor.ps.gz
Extractor-docs/WWW/manual/libextractor.texi.tar.gz
Extractor-docs/WWW/manual/libextractor.txt
Extractor-docs/WWW/manual/libextractor.txt.gz
Removed:
Extractor-docs/WWW/manual/html_node/Concept-Index.html
Extractor-docs/WWW/manual/html_node/Copying.html
Extractor-docs/WWW/manual/html_node/Function-and-Data-Index.html
Extractor-docs/WWW/manual/html_node/Type-Index.html
Modified:
Extractor-docs/WWW/man1/extract.1.html
Extractor-docs/WWW/man3/libextractor.3.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/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/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
Log:
updating docs
Modified: Extractor-docs/WWW/man1/extract.1.html
===================================================================
--- Extractor-docs/WWW/man1/extract.1.html 2012-09-25 14:37:40 UTC (rev
23996)
+++ Extractor-docs/WWW/man1/extract.1.html 2012-09-25 14:47:07 UTC (rev
23997)
@@ -188,6 +188,6 @@
This document was created by
<A HREF="/s/libextractor/man/">man2html</A>,
using the manual pages.<BR>
-Time: 11:09:53 GMT, September 06, 2012
+Time: 14:45:51 GMT, September 25, 2012
</BODY>
</HTML>
Modified: Extractor-docs/WWW/man3/libextractor.3.html
===================================================================
--- Extractor-docs/WWW/man3/libextractor.3.html 2012-09-25 14:37:40 UTC (rev
23996)
+++ Extractor-docs/WWW/man3/libextractor.3.html 2012-09-25 14:47:07 UTC (rev
23997)
@@ -107,6 +107,6 @@
This document was created by
<A HREF="/s/libextractor/man/">man2html</A>,
using the manual pages.<BR>
-Time: 11:09:53 GMT, September 06, 2012
+Time: 14:45:51 GMT, September 25, 2012
</BODY>
</HTML>
Deleted: Extractor-docs/WWW/manual/html_node/Concept-Index.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Concept-Index.html 2012-09-25
14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Concept-Index.html 2012-09-25
14:47:07 UTC (rev 23997)
@@ -1,87 +0,0 @@
-<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>
-
Deleted: Extractor-docs/WWW/manual/html_node/Copying.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Copying.html 2012-09-25 14:37:40 UTC
(rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Copying.html 2012-09-25 14:47:07 UTC
(rev 23997)
@@ -1,396 +0,0 @@
-<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>
-
Modified: Extractor-docs/WWW/manual/html_node/Existing-Plugins.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Existing-Plugins.html 2012-09-25
14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Existing-Plugins.html 2012-09-25
14:47:07 UTC (rev 23997)
@@ -10,11 +10,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -22,7 +20,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
Modified: Extractor-docs/WWW/manual/html_node/Extracting-meta-data.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Extracting-meta-data.html
2012-09-25 14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Extracting-meta-data.html
2012-09-25 14:47:07 UTC (rev 23997)
@@ -10,11 +10,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -22,7 +20,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
@@ -49,7 +47,7 @@
<h2 class="chapter">4 Extracting meta data</h2>
-<p>In order to extract meta data with <acronym>GNU libextractor</acronym> you
first need to
+<p>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
Modified: Extractor-docs/WWW/manual/html_node/Extracting.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Extracting.html 2012-09-25 14:37:40 UTC
(rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Extracting.html 2012-09-25 14:47:07 UTC
(rev 23997)
@@ -10,11 +10,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -22,7 +20,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
@@ -62,7 +60,7 @@
<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_mime_type</var><dd>mime-type of data (not of the
original file); can be <code>NULL</code> (if mime-type is not known);
<br><dt><var>data</var><dd>actual meta-data found
@@ -76,9 +74,9 @@
<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.
+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 ‘<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 <code>NULL</code>, 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-<code>NULL</code>,
‘<samp><span class="samp">data</span></samp>’ can be
<code>NULL</code>. 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 c
lass="sa
mp">size</span></samp>’ 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>).
+ <p><a name="index-SIGBUS-45"></a><a name="index-bus-error-46"></a>Meta
data extraction should never really fail — at worst, GNU libextractor
should not call ‘<samp><span class="samp">proc</span></samp>’ 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 <tt>mmap</tt>ed 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 <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 consi
der running GNU libextractor itself also out-of-process (as done, for example,
by <a href="http://grothoff.org/christian/doodle/";>doodle</a>).
</blockquote></div>
Deleted: Extractor-docs/WWW/manual/html_node/Function-and-Data-Index.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Function-and-Data-Index.html
2012-09-25 14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Function-and-Data-Index.html
2012-09-25 14:47:07 UTC (rev 23997)
@@ -1,69 +0,0 @@
-<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/GNU-Free-Documentation-License.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/GNU-Free-Documentation-License.html
(rev 0)
+++ Extractor-docs/WWW/manual/html_node/GNU-Free-Documentation-License.html
2012-09-25 14:47:07 UTC (rev 23997)
@@ -0,0 +1,517 @@
+<html lang="en">
+<head>
+<title>GNU Free Documentation License - 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="Index.html#Index" title="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, 8 September 2012), a library for metadata
+extraction.
+
+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="GNU-Free-Documentation-License"></a>
+<p>
+Next: <a rel="next" accesskey="n" href="Index.html#Index">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 Free Documentation License</h2>
+
+<!-- The GNU Free Documentation License. -->
+<div align="center">Version 1.3, 3 November 2008</div>
+
+<!-- This file is intended to be included within another document, -->
+<!-- hence no sectioning command or @node. -->
+<pre class="display"> Copyright © 2000, 2001, 2002, 2007, 2008 Free
Software Foundation, Inc.
+ <a href="http://fsf.org/";>http://fsf.org/</a>
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+</pre>
+ <ol type=1 start=0>
+<li>PREAMBLE
+
+ <p>The purpose of this License is to make a manual, textbook, or other
+functional and useful document <dfn>free</dfn> in the sense of freedom: to
+assure everyone the effective freedom to copy and redistribute it,
+with or without modifying it, either commercially or noncommercially.
+Secondarily, this License preserves for the author and publisher a way
+to get credit for their work, while not being considered responsible
+for modifications made by others.
+
+ <p>This License is a kind of “copyleft”, which means that
derivative
+works of the document must themselves be free in the same sense. It
+complements the GNU General Public License, which is a copyleft
+license designed for free software.
+
+ <p>We have designed this License in order to use it for manuals for free
+software, because free software needs free documentation: a free
+program should come with manuals providing the same freedoms that the
+software does. But this License is not limited to software manuals;
+it can be used for any textual work, regardless of subject matter or
+whether it is published as a printed book. We recommend this License
+principally for works whose purpose is instruction or reference.
+
+ <li>APPLICABILITY AND DEFINITIONS
+
+ <p>This License applies to any manual or other work, in any medium, that
+contains a notice placed by the copyright holder saying it can be
+distributed under the terms of this License. Such a notice grants a
+world-wide, royalty-free license, unlimited in duration, to use that
+work under the conditions stated herein. The “Document”, below,
+refers to any such manual or work. Any member of the public is a
+licensee, and is addressed as “you”. You accept the license if you
+copy, modify or distribute the work in a way requiring permission
+under copyright law.
+
+ <p>A “Modified Version” of the Document means any work
containing the
+Document or a portion of it, either copied verbatim, or with
+modifications and/or translated into another language.
+
+ <p>A “Secondary Section” is a named appendix or a
front-matter section
+of the Document that deals exclusively with the relationship of the
+publishers or authors of the Document to the Document's overall
+subject (or to related matters) and contains nothing that could fall
+directly within that overall subject. (Thus, if the Document is in
+part a textbook of mathematics, a Secondary Section may not explain
+any mathematics.) The relationship could be a matter of historical
+connection with the subject or with related matters, or of legal,
+commercial, philosophical, ethical or political position regarding
+them.
+
+ <p>The “Invariant Sections” are certain Secondary Sections
whose titles
+are designated, as being those of Invariant Sections, in the notice
+that says that the Document is released under this License. If a
+section does not fit the above definition of Secondary then it is not
+allowed to be designated as Invariant. The Document may contain zero
+Invariant Sections. If the Document does not identify any Invariant
+Sections then there are none.
+
+ <p>The “Cover Texts” are certain short passages of text that
are listed,
+as Front-Cover Texts or Back-Cover Texts, in the notice that says that
+the Document is released under this License. A Front-Cover Text may
+be at most 5 words, and a Back-Cover Text may be at most 25 words.
+
+ <p>A “Transparent” copy of the Document means a
machine-readable copy,
+represented in a format whose specification is available to the
+general public, that is suitable for revising the document
+straightforwardly with generic text editors or (for images composed of
+pixels) generic paint programs or (for drawings) some widely available
+drawing editor, and that is suitable for input to text formatters or
+for automatic translation to a variety of formats suitable for input
+to text formatters. A copy made in an otherwise Transparent file
+format whose markup, or absence of markup, has been arranged to thwart
+or discourage subsequent modification by readers is not Transparent.
+An image format is not Transparent if used for any substantial amount
+of text. A copy that is not “Transparent” is called
“Opaque”.
+
+ <p>Examples of suitable formats for Transparent copies include plain
+<span class="sc">ascii</span> without markup, Texinfo input format, LaTeX input
+format, <acronym>SGML</acronym> or <acronym>XML</acronym> using a publicly
available
+<acronym>DTD</acronym>, and standard-conforming simple <acronym>HTML</acronym>,
+PostScript or <acronym>PDF</acronym> designed for human modification. Examples
+of transparent image formats include <acronym>PNG</acronym>,
<acronym>XCF</acronym> and
+<acronym>JPG</acronym>. Opaque formats include proprietary formats that can be
+read and edited only by proprietary word processors, <acronym>SGML</acronym> or
+<acronym>XML</acronym> for which the <acronym>DTD</acronym> and/or processing
tools are
+not generally available, and the machine-generated <acronym>HTML</acronym>,
+PostScript or <acronym>PDF</acronym> produced by some word processors for
+output purposes only.
+
+ <p>The “Title Page” means, for a printed book, the title page
itself,
+plus such following pages as are needed to hold, legibly, the material
+this License requires to appear in the title page. For works in
+formats which do not have any title page as such, “Title Page”
means
+the text near the most prominent appearance of the work's title,
+preceding the beginning of the body of the text.
+
+ <p>The “publisher” means any person or entity that
distributes copies
+of the Document to the public.
+
+ <p>A section “Entitled XYZ” means a named subunit of the
Document whose
+title either is precisely XYZ or contains XYZ in parentheses following
+text that translates XYZ in another language. (Here XYZ stands for a
+specific section name mentioned below, such as “Acknowledgements”,
+“Dedications”, “Endorsements”, or
“History”.) To “Preserve the Title”
+of such a section when you modify the Document means that it remains a
+section “Entitled XYZ” according to this definition.
+
+ <p>The Document may include Warranty Disclaimers next to the notice which
+states that this License applies to the Document. These Warranty
+Disclaimers are considered to be included by reference in this
+License, but only as regards disclaiming warranties: any other
+implication that these Warranty Disclaimers may have is void and has
+no effect on the meaning of this License.
+
+ <li>VERBATIM COPYING
+
+ <p>You may copy and distribute the Document in any medium, either
+commercially or noncommercially, provided that this License, the
+copyright notices, and the license notice saying this License applies
+to the Document are reproduced in all copies, and that you add no other
+conditions whatsoever to those of this License. You may not use
+technical measures to obstruct or control the reading or further
+copying of the copies you make or distribute. However, you may accept
+compensation in exchange for copies. If you distribute a large enough
+number of copies you must also follow the conditions in section 3.
+
+ <p>You may also lend copies, under the same conditions stated above, and
+you may publicly display copies.
+
+ <li>COPYING IN QUANTITY
+
+ <p>If you publish printed copies (or copies in media that commonly have
+printed covers) of the Document, numbering more than 100, and the
+Document's license notice requires Cover Texts, you must enclose the
+copies in covers that carry, clearly and legibly, all these Cover
+Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
+the back cover. Both covers must also clearly and legibly identify
+you as the publisher of these copies. The front cover must present
+the full title with all words of the title equally prominent and
+visible. You may add other material on the covers in addition.
+Copying with changes limited to the covers, as long as they preserve
+the title of the Document and satisfy these conditions, can be treated
+as verbatim copying in other respects.
+
+ <p>If the required texts for either cover are too voluminous to fit
+legibly, you should put the first ones listed (as many as fit
+reasonably) on the actual cover, and continue the rest onto adjacent
+pages.
+
+ <p>If you publish or distribute Opaque copies of the Document numbering
+more than 100, you must either include a machine-readable Transparent
+copy along with each Opaque copy, or state in or with each Opaque copy
+a computer-network location from which the general network-using
+public has access to download using public-standard network protocols
+a complete Transparent copy of the Document, free of added material.
+If you use the latter option, you must take reasonably prudent steps,
+when you begin distribution of Opaque copies in quantity, to ensure
+that this Transparent copy will remain thus accessible at the stated
+location until at least one year after the last time you distribute an
+Opaque copy (directly or through your agents or retailers) of that
+edition to the public.
+
+ <p>It is requested, but not required, that you contact the authors of the
+Document well before redistributing any large number of copies, to give
+them a chance to provide you with an updated version of the Document.
+
+ <li>MODIFICATIONS
+
+ <p>You may copy and distribute a Modified Version of the Document under
+the conditions of sections 2 and 3 above, provided that you release
+the Modified Version under precisely this License, with the Modified
+Version filling the role of the Document, thus licensing distribution
+and modification of the Modified Version to whoever possesses a copy
+of it. In addition, you must do these things in the Modified Version:
+
+ <ol type=A start=1>
+<li>Use in the Title Page (and on the covers, if any) a title distinct
+from that of the Document, and from those of previous versions
+(which should, if there were any, be listed in the History section
+of the Document). You may use the same title as a previous version
+if the original publisher of that version gives permission.
+
+ <li>List on the Title Page, as authors, one or more persons or
entities
+responsible for authorship of the modifications in the Modified
+Version, together with at least five of the principal authors of the
+Document (all of its principal authors, if it has fewer than five),
+unless they release you from this requirement.
+
+ <li>State on the Title page the name of the publisher of the
+Modified Version, as the publisher.
+
+ <li>Preserve all the copyright notices of the Document.
+
+ <li>Add an appropriate copyright notice for your modifications
+adjacent to the other copyright notices.
+
+ <li>Include, immediately after the copyright notices, a license
notice
+giving the public permission to use the Modified Version under the
+terms of this License, in the form shown in the Addendum below.
+
+ <li>Preserve in that license notice the full lists of Invariant
Sections
+and required Cover Texts given in the Document's license notice.
+
+ <li>Include an unaltered copy of this License.
+
+ <li>Preserve the section Entitled “History”, Preserve
its Title, and add
+to it an item stating at least the title, year, new authors, and
+publisher of the Modified Version as given on the Title Page. If
+there is no section Entitled “History” in the Document, create one
+stating the title, year, authors, and publisher of the Document as
+given on its Title Page, then add an item describing the Modified
+Version as stated in the previous sentence.
+
+ <li>Preserve the network location, if any, given in the Document for
+public access to a Transparent copy of the Document, and likewise
+the network locations given in the Document for previous versions
+it was based on. These may be placed in the “History” section.
+You may omit a network location for a work that was published at
+least four years before the Document itself, or if the original
+publisher of the version it refers to gives permission.
+
+ <li>For any section Entitled “Acknowledgements” or
“Dedications”, Preserve
+the Title of the section, and preserve in the section all the
+substance and tone of each of the contributor acknowledgements and/or
+dedications given therein.
+
+ <li>Preserve all the Invariant Sections of the Document,
+unaltered in their text and in their titles. Section numbers
+or the equivalent are not considered part of the section titles.
+
+ <li>Delete any section Entitled “Endorsements”. Such a
section
+may not be included in the Modified Version.
+
+ <li>Do not retitle any existing section to be Entitled
“Endorsements” or
+to conflict in title with any Invariant Section.
+
+ <li>Preserve any Warranty Disclaimers.
+ </ol>
+
+ <p>If the Modified Version includes new front-matter sections or
+appendices that qualify as Secondary Sections and contain no material
+copied from the Document, you may at your option designate some or all
+of these sections as invariant. To do this, add their titles to the
+list of Invariant Sections in the Modified Version's license notice.
+These titles must be distinct from any other section titles.
+
+ <p>You may add a section Entitled “Endorsements”, provided it
contains
+nothing but endorsements of your Modified Version by various
+parties—for example, statements of peer review or that the text has
+been approved by an organization as the authoritative definition of a
+standard.
+
+ <p>You may add a passage of up to five words as a Front-Cover Text, and a
+passage of up to 25 words as a Back-Cover Text, to the end of the list
+of Cover Texts in the Modified Version. Only one passage of
+Front-Cover Text and one of Back-Cover Text may be added by (or
+through arrangements made by) any one entity. If the Document already
+includes a cover text for the same cover, previously added by you or
+by arrangement made by the same entity you are acting on behalf of,
+you may not add another; but you may replace the old one, on explicit
+permission from the previous publisher that added the old one.
+
+ <p>The author(s) and publisher(s) of the Document do not by this License
+give permission to use their names for publicity for or to assert or
+imply endorsement of any Modified Version.
+
+ <li>COMBINING DOCUMENTS
+
+ <p>You may combine the Document with other documents released under this
+License, under the terms defined in section 4 above for modified
+versions, provided that you include in the combination all of the
+Invariant Sections of all of the original documents, unmodified, and
+list them all as Invariant Sections of your combined work in its
+license notice, and that you preserve all their Warranty Disclaimers.
+
+ <p>The combined work need only contain one copy of this License, and
+multiple identical Invariant Sections may be replaced with a single
+copy. If there are multiple Invariant Sections with the same name but
+different contents, make the title of each such section unique by
+adding at the end of it, in parentheses, the name of the original
+author or publisher of that section if known, or else a unique number.
+Make the same adjustment to the section titles in the list of
+Invariant Sections in the license notice of the combined work.
+
+ <p>In the combination, you must combine any sections Entitled
“History”
+in the various original documents, forming one section Entitled
+“History”; likewise combine any sections Entitled
“Acknowledgements”,
+and any sections Entitled “Dedications”. You must delete all
+sections Entitled “Endorsements.”
+
+ <li>COLLECTIONS OF DOCUMENTS
+
+ <p>You may make a collection consisting of the Document and other
documents
+released under this License, and replace the individual copies of this
+License in the various documents with a single copy that is included in
+the collection, provided that you follow the rules of this License for
+verbatim copying of each of the documents in all other respects.
+
+ <p>You may extract a single document from such a collection, and
distribute
+it individually under this License, provided you insert a copy of this
+License into the extracted document, and follow this License in all
+other respects regarding verbatim copying of that document.
+
+ <li>AGGREGATION WITH INDEPENDENT WORKS
+
+ <p>A compilation of the Document or its derivatives with other separate
+and independent documents or works, in or on a volume of a storage or
+distribution medium, is called an “aggregate” if the copyright
+resulting from the compilation is not used to limit the legal rights
+of the compilation's users beyond what the individual works permit.
+When the Document is included in an aggregate, this License does not
+apply to the other works in the aggregate which are not themselves
+derivative works of the Document.
+
+ <p>If the Cover Text requirement of section 3 is applicable to these
+copies of the Document, then if the Document is less than one half of
+the entire aggregate, the Document's Cover Texts may be placed on
+covers that bracket the Document within the aggregate, or the
+electronic equivalent of covers if the Document is in electronic form.
+Otherwise they must appear on printed covers that bracket the whole
+aggregate.
+
+ <li>TRANSLATION
+
+ <p>Translation is considered a kind of modification, so you may
+distribute translations of the Document under the terms of section 4.
+Replacing Invariant Sections with translations requires special
+permission from their copyright holders, but you may include
+translations of some or all Invariant Sections in addition to the
+original versions of these Invariant Sections. You may include a
+translation of this License, and all the license notices in the
+Document, and any Warranty Disclaimers, provided that you also include
+the original English version of this License and the original versions
+of those notices and disclaimers. In case of a disagreement between
+the translation and the original version of this License or a notice
+or disclaimer, the original version will prevail.
+
+ <p>If a section in the Document is Entitled
“Acknowledgements”,
+“Dedications”, or “History”, the requirement (section
4) to Preserve
+its Title (section 1) will typically require changing the actual
+title.
+
+ <li>TERMINATION
+
+ <p>You may not copy, modify, sublicense, or distribute the Document
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense, or distribute it is void, and
+will automatically terminate your rights under this License.
+
+ <p>However, if you cease all violation of this License, then your license
+from a particular copyright holder is reinstated (a) provisionally,
+unless and until the copyright holder explicitly and finally
+terminates your license, and (b) permanently, if the copyright holder
+fails to notify you of the violation by some reasonable means prior to
+60 days after the cessation.
+
+ <p>Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ <p>Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, receipt of a copy of some or all of the same material does
+not give you any rights to use it.
+
+ <li>FUTURE REVISIONS OF THIS LICENSE
+
+ <p>The Free Software Foundation may publish new, revised versions
+of the GNU Free Documentation 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. See
+<a href="http://www.gnu.org/copyleft/";>http://www.gnu.org/copyleft/</a>.
+
+ <p>Each version of the License is given a distinguishing version number.
+If the Document specifies that a particular numbered version of this
+License “or any later version” applies to it, you have the option
of
+following the terms and conditions either of that specified version or
+of any later version that has been published (not as a draft) by the
+Free Software Foundation. If the Document does not specify a version
+number of this License, you may choose any version ever published (not
+as a draft) by the Free Software Foundation. If the Document
+specifies that a proxy can decide which future versions of this
+License can be used, that proxy's public statement of acceptance of a
+version permanently authorizes you to choose that version for the
+Document.
+
+ <li>RELICENSING
+
+ <p>“Massive Multiauthor Collaboration Site” (or “MMC
Site”) means any
+World Wide Web server that publishes copyrightable works and also
+provides prominent facilities for anybody to edit those works. A
+public wiki that anybody can edit is an example of such a server. A
+“Massive Multiauthor Collaboration” (or “MMC”)
contained in the
+site means any set of copyrightable works thus published on the MMC
+site.
+
+ <p>“CC-BY-SA” means the Creative Commons Attribution-Share
Alike 3.0
+license published by Creative Commons Corporation, a not-for-profit
+corporation with a principal place of business in San Francisco,
+California, as well as future copyleft versions of that license
+published by that same organization.
+
+ <p>“Incorporate” means to publish or republish a Document, in
whole or
+in part, as part of another Document.
+
+ <p>An MMC is “eligible for relicensing” if it is licensed
under this
+License, and if all works that were first published under this License
+somewhere other than this MMC, and subsequently incorporated in whole
+or in part into the MMC, (1) had no cover texts or invariant sections,
+and (2) were thus incorporated prior to November 1, 2008.
+
+ <p>The operator of an MMC Site may republish an MMC contained in the site
+under CC-BY-SA on the same site at any time before August 1, 2009,
+provided the MMC is eligible for relicensing.
+
+ </ol>
+
+<h3 class="heading">ADDENDUM: How to use this License for your documents</h3>
+
+<p>To use this License in a document you have written, include a copy of
+the License in the document and put the following copyright and
+license notices just after the title page:
+
+<pre class="smallexample"> Copyright (C) <var>year</var> <var>your
name</var>.
+ 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''.
+</pre>
+ <p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
+replace the “with<small class="dots">...</small>Texts.” line with
this:
+
+<pre class="smallexample"> with the Invariant Sections being <var>list
their titles</var>, with
+ the Front-Cover Texts being <var>list</var>, and with the Back-Cover
Texts
+ being <var>list</var>.
+</pre>
+ <p>If you have Invariant Sections without Cover Texts, or some other
+combination of the three, merge those two alternatives to suit the
+situation.
+
+ <p>If your document contains nontrivial examples of program code, we
+recommend releasing these examples in parallel under your choice of
+free software license, such as the GNU General Public License,
+to permit their use in free software.
+
+<!-- Local Variables: -->
+<!-- ispell-local-pdict: "ispell-dict" -->
+<!-- End: -->
+ </body></html>
+
Modified: Extractor-docs/WWW/manual/html_node/Generalities.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Generalities.html 2012-09-25
14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Generalities.html 2012-09-25
14:47:07 UTC (rev 23997)
@@ -10,11 +10,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -22,7 +20,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
@@ -92,9 +90,9 @@
</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
+<p>Each public symbol exported by GNU libextractor 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
+impatient, the minimal C code for using GNU libextractor (on the
executing binary itself) looks like this:
<pre class="verbatim">#include <extractor.h>
@@ -113,7 +111,7 @@
</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
+many applications. The full external C API of GNU libextractor 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>.
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-25 14:47:07 UTC
(rev 23997)
@@ -0,0 +1,108 @@
+<html lang="en">
+<head>
+<title>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="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License"
title="GNU Free Documentation License">
+<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
+<!--
+This manual is for GNU libextractor
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
+
+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="Index"></a>
+<p>
+Previous: <a rel="previous" accesskey="p"
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">GNU
Free Documentation License</a>,
+Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+<hr>
+</div>
+
+<h2 class="unnumbered">Index</h2>
+
+<ul class="index-cp" 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="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="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="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="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="Extracting.html#index-EXTRACTOR_005fMetaDataProcessor-38"><code>EXTRACTOR_MetaDataProcessor</code></a>:
<a href="Extracting.html#Extracting">Extracting</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="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="Utility-Constants.html#index-EXTRACTOR_005fVERSION-57"><code>EXTRACTOR_VERSION</code></a>:
<a href="Utility-Constants.html#Utility-Constants">Utility Constants</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="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="Preparation.html#index-LIBEXTRACTOR_005fPREFIX-8"><code>LIBEXTRACTOR_PREFIX</code></a>:
<a href="Preparation.html#Preparation">Preparation</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="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>
+<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><!-- @node Function and Data Index -->
+<!-- @unnumbered Function and Data Index -->
+<!-- @printindex fn -->
+<!-- @node Type Index -->
+<!-- @unnumbered Type Index -->
+<!-- @printindex tp -->
+</body></html>
+
Modified: Extractor-docs/WWW/manual/html_node/Internal-utility-functions.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Internal-utility-functions.html
2012-09-25 14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Internal-utility-functions.html
2012-09-25 14:47:07 UTC (rev 23997)
@@ -10,11 +10,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -22,7 +20,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
@@ -72,12 +70,12 @@
<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
+<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
GNU libextractor 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
+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
Modified: Extractor-docs/WWW/manual/html_node/Introduction.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Introduction.html 2012-09-25
14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Introduction.html 2012-09-25
14:47:07 UTC (rev 23997)
@@ -10,11 +10,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -22,7 +20,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
@@ -49,7 +47,7 @@
<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
+<p><a name="index-error-handling-1"></a>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
@@ -57,35 +55,35 @@
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
+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.
- <p><a name="index-plugin-2"></a><acronym>GNU libextractor</acronym> uses
plugins to handle various file formats.
+ <p><a name="index-plugin-2"></a>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,
-<acronym>GNU libextractor</acronym> will use all plugins that are available
and found
+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.
- <p><acronym>GNU libextractor</acronym> is distributed with the <samp><span
class="command">extract</span></samp>
+ <p>GNU libextractor 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>.
+GNU libextractor.
<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>
+with GNU libextractor. The only relevant parts for end-users
+are the chapter on compiling and installing GNU libextractor
(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
+ <p><a name="index-license-3"></a>GNU libextractor is licensed under the GNU
General Public License,
+specifically, since version 0.7, GNU libextractor is licensed under GPLv3
<em>or any later version</em>.
<div class="footnote">
Modified: Extractor-docs/WWW/manual/html_node/Language-bindings.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Language-bindings.html 2012-09-25
14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Language-bindings.html 2012-09-25
14:47:07 UTC (rev 23997)
@@ -10,11 +10,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -22,7 +20,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
@@ -50,7 +48,7 @@
<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.
+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.
<h3 class="section">5.1 Java</h3>
Modified: Extractor-docs/WWW/manual/html_node/Meta-data-printing.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Meta-data-printing.html 2012-09-25
14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Meta-data-printing.html 2012-09-25
14:47:07 UTC (rev 23997)
@@ -10,11 +10,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -22,7 +20,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
Modified: Extractor-docs/WWW/manual/html_node/Meta-formats.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Meta-formats.html 2012-09-25
14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Meta-formats.html 2012-09-25
14:47:07 UTC (rev 23997)
@@ -11,11 +11,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -23,7 +21,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
Modified: Extractor-docs/WWW/manual/html_node/Meta-types.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Meta-types.html 2012-09-25 14:37:40 UTC
(rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Meta-types.html 2012-09-25 14:47:07 UTC
(rev 23997)
@@ -11,11 +11,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -23,7 +21,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
@@ -51,18 +49,18 @@
<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>.
+<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
GNU libextractor 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>).
+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 GNU libextractor
(<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>).
+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 GNU libextractor (<tt>dgettext("libextractor",
s)</tt>).
</p></blockquote></div>
</body></html>
Modified: Extractor-docs/WWW/manual/html_node/Plugin-management.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Plugin-management.html 2012-09-25
14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Plugin-management.html 2012-09-25
14:47:07 UTC (rev 23997)
@@ -10,11 +10,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -22,7 +20,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
@@ -49,8 +47,8 @@
<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
+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
@@ -63,7 +61,7 @@
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>
+<code>EXTRACTOR_OPTION_IN_PROCESS</code> 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
<tt>EXTRACTOR_plugin_add_defaults</tt> and
@@ -99,19 +97,19 @@
<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.
+Loads a particular plugin. The plugin is added to the existing list, which
can be <code>NULL</code>. The second argument specifies the name of the plugin
(i.e. “ogg”). The third argument can be <code>NULL</code> 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.
+Loads and unloads plugins based on a configuration string, modifying the
existing list, which can be <code>NULL</code>. 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.
+Loads all of the plugins in the plugin directory. This function is what most
GNU libextractor applications should use to setup the plugins.
</p></blockquote></div>
</body></html>
Modified: Extractor-docs/WWW/manual/html_node/Preparation.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Preparation.html 2012-09-25
14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Preparation.html 2012-09-25
14:47:07 UTC (rev 23997)
@@ -10,11 +10,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -22,7 +20,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
@@ -54,15 +52,15 @@
for particular platforms are then described in individual sections
afterwards.
- <p>Compiling <acronym>GNU libextractor</acronym> follows the standard GNU
autotools build process
+ <p>Compiling GNU libextractor 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.
+ <p>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.
+Debian (wheezy) packages that should be installed.
<p>You absolutely need:
@@ -83,13 +81,14 @@
<li>libflac-dev
<li>libmpeg2-4-dev
<li>librpm-dev
-<li>libgtk2.0-dev
+<li>libgtk2.0-dev or libgtk3.0-dev
<li>libgsf-1-dev
<li>libqt4-dev
<li>libpoppler-dev
<li>libexiv2-dev
<li>libavformat-dev
<li>libswscale-dev
+<li>libgstreamer1.0-dev
</ul>
<p>For Subversion access and compilation one also needs:
@@ -103,24 +102,24 @@
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
+ <p>Once you have compiled and installed GNU libextractor, 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>.
+GNU libextractor. 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 GNU
libextractor. The <samp><span class="file">extract</span></samp> man page
+documents the <samp><span class="file">extract</span></samp> tool. The GNU
libextractor man page gives a brief
+summary of the C API for GNU libextractor.
- <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
+ <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 GNU libextractor,
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
+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 <tt>LIBEXTRACTOR_PREFIX</tt>. If
-<acronym>GNU libextractor</acronym> cannot locate a plugin, it will look in
+GNU libextractor cannot locate a plugin, it will look in
<tt>LIBEXTRACTOR_PREFIX/lib/libextractor/</tt>.
<h3 class="section">2.1 Installation on GNU/Linux</h3>
@@ -134,7 +133,7 @@
<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
+is used in GNU libextractor in about three places. This causes problems
during compilation.
<h3 class="section">2.4 Installation on NetBSD</h3>
@@ -169,21 +168,21 @@
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>.
+ <p>The framework can be uninstalled by dragging <br>
+<samp><span class="file">/Library/Frameworks/Extractor.framework</span></samp>
to 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
+<p>In the framework, the <samp><span class="command">extract</span></samp>
command line tool can be found at <br>
<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
+one would most likely want to add <br>
"-I/Library/Frameworks/Extractor.framework/Versions/Current/include"
-to CPPFLAGS and
+to CPPFLAGS and <br>
"-L/Library/Frameworks/Extractor.framework/Versions/Current/lib"
to LDFLAGS.
Modified: Extractor-docs/WWW/manual/html_node/Reporting-bugs.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Reporting-bugs.html 2012-09-25
14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Reporting-bugs.html 2012-09-25
14:47:07 UTC (rev 23997)
@@ -6,15 +6,13 @@
<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 rel="next"
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License"
title="GNU Free Documentation License">
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -22,7 +20,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
@@ -41,7 +39,7 @@
<div class="node">
<a name="Reporting-bugs"></a>
<p>
-Next: <a rel="next" accesskey="n" href="Copying.html#Copying">Copying</a>,
+Next: <a rel="next" accesskey="n"
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">GNU
Free Documentation License</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>
@@ -49,8 +47,8 @@
<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>.
+<p><a name="index-bug-63"></a>GNU libextractor uses the <a
href="https://gnunet.org/bugs/";>Mantis bugtracking system</a>. If possible,
please report bugs there. You can also e-mail
+the GNU libextractor mailinglist at <a
href="address@hidden">address@hidden</a>.
<!-- ********************************************************** -->
<!-- ******************* Appendices ************************* -->
Deleted: Extractor-docs/WWW/manual/html_node/Type-Index.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Type-Index.html 2012-09-25 14:37:40 UTC
(rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Type-Index.html 2012-09-25 14:47:07 UTC
(rev 23997)
@@ -1,60 +0,0 @@
-<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>
-
Modified: Extractor-docs/WWW/manual/html_node/Utility-Constants.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Utility-Constants.html 2012-09-25
14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Utility-Constants.html 2012-09-25
14:47:07 UTC (rev 23997)
@@ -10,11 +10,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -22,7 +20,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
Modified: Extractor-docs/WWW/manual/html_node/Utility-functions.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Utility-functions.html 2012-09-25
14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Utility-functions.html 2012-09-25
14:47:07 UTC (rev 23997)
@@ -10,11 +10,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -22,7 +20,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
@@ -49,7 +47,7 @@
<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.
+<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 GNU libextractor usage. All of
the functions are reentrant.
<ul class="menu">
<li><a accesskey="1" href="Utility-Constants.html#Utility-Constants">Utility
Constants</a>
Modified: Extractor-docs/WWW/manual/html_node/Writing-new-Plugins.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/Writing-new-Plugins.html
2012-09-25 14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/html_node/Writing-new-Plugins.html
2012-09-25 14:47:07 UTC (rev 23997)
@@ -10,11 +10,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -22,7 +20,7 @@
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".
+ section entitled ``GNU Free Documentation License''.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
Modified: Extractor-docs/WWW/manual/html_node/index.html
===================================================================
--- Extractor-docs/WWW/manual/html_node/index.html 2012-09-25 14:37:40 UTC
(rev 23996)
+++ Extractor-docs/WWW/manual/html_node/index.html 2012-09-25 14:47:07 UTC
(rev 23997)
@@ -8,11 +8,9 @@
<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).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
-GNU libextractor is a GNU package.
-
-
Copyright (C) 2007, 2010, 2012 Christian Grothoff
Permission is granted to copy, distribute and/or modify this
@@ -51,10 +49,8 @@
<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>
+<li><a href="index.html#toc_GNU-Free-Documentation-License">Appendix A GNU
Free Documentation License</a></li>
+<li><a href="index.html#toc_Index">Index</a></li>
</ul>
</div>
@@ -115,17 +111,9 @@
</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><a name="toc_GNU-Free-Documentation-License"
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">Appendix
A GNU Free Documentation License</a>
+<li><a name="toc_Index" href="Index.html#Index">Index</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">
@@ -139,10 +127,9 @@
<h2 class="unnumbered">The GNU libextractor Reference Manual</h2>
<p>This manual is for GNU libextractor
-(version 1.0.0, 5 September 2012).
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
- <p>GNU libextractor is a GNU package.
-
<p>Copyright © 2007, 2010, 2012 Christian Grothoff
<blockquote>
@@ -150,20 +137,20 @@
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".
+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="1" href="Introduction.html#Introduction">Introduction</a>:
What is GNU libextractor.
<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="4"
href="Extracting-meta-data.html#Extracting-meta-data">Extracting meta data</a>:
How to use GNU libextractor to obtain meta data.
+<li><a accesskey="5" href="Language-bindings.html#Language-bindings">Language
bindings</a>: How to use GNU libextractor from languages other than
C.
+<li><a accesskey="6" href="Utility-functions.html#Utility-functions">Utility
functions</a>: Utility functions of GNU libextractor.
<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 accesskey="8"
href="Writing-new-Plugins.html#Writing-new-Plugins">Writing new Plugins</a>:
How to write new plugins for GNU libextractor.
+<li><a accesskey="9"
href="Internal-utility-functions.html#Internal-utility-functions">Internal
utility functions</a>: Utility functions of GNU libextractor for writing
plugins.
<li><a href="Reporting-bugs.html#Reporting-bugs">Reporting bugs</a>:
How to report bugs or request new features.
</li></ul>
@@ -171,17 +158,16 @@
</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><a
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">GNU
Free Documentation License</a>: Copying this manual.
</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.
+<li><a href="Index.html#Index">Index</a>: Index
+<!-- * Function and Data Index:: Index of functions, variables and data
types. -->
+<!-- * Type Index:: Index of data types. -->
</ul>
Added: Extractor-docs/WWW/manual/libextractor.dvi.gz
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/libextractor.dvi.gz
===================================================================
--- Extractor-docs/WWW/manual/libextractor.dvi.gz 2012-09-25 14:37:40 UTC
(rev 23996)
+++ Extractor-docs/WWW/manual/libextractor.dvi.gz 2012-09-25 14:47:07 UTC
(rev 23997)
Property changes on: Extractor-docs/WWW/manual/libextractor.dvi.gz
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: Extractor-docs/WWW/manual/libextractor.html
===================================================================
--- Extractor-docs/WWW/manual/libextractor.html (rev 0)
+++ Extractor-docs/WWW/manual/libextractor.html 2012-09-25 14:47:07 UTC (rev
23997)
@@ -0,0 +1,1572 @@
+<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, 8 September 2012), a library for metadata
+extraction.
+
+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="#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_GNU-Free-Documentation-License">Appendix A GNU Free
Documentation License</a></li>
+<li><a href="#toc_Index">Index</a></li>
+</ul>
+</div>
+
+
+
+ <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_GNU-Free-Documentation-License"
href="#GNU-Free-Documentation-License">Appendix A GNU Free Documentation
License</a>
+<li><a name="toc_Index" href="#Index">Index</a>
+</li></ul>
+</div>
+
+<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>
+
+</div>
+
+<h2 class="unnumbered">The GNU libextractor Reference Manual</h2>
+
+<p>This manual is for GNU libextractor
+(version 1.0.0, 8 September 2012), a library for metadata
+extraction.
+
+ <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">Introduction</a>:
What is GNU libextractor.
+<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 GNU libextractor to obtain meta data.
+<li><a accesskey="5" href="#Language-bindings">Language bindings</a>:
How to use GNU libextractor from languages other than C.
+<li><a accesskey="6" href="#Utility-functions">Utility functions</a>:
Utility functions of GNU libextractor.
+<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 GNU libextractor.
+<li><a accesskey="9" href="#Internal-utility-functions">Internal utility
functions</a>: Utility functions of GNU libextractor for writing plugins.
+<li><a href="#Reporting-bugs">Reporting bugs</a>: How to report
bugs or request new features.
+
+</li></ul>
+<p>Appendices
+
+</p>
+<ul class="menu">
+<li><a href="#GNU-Free-Documentation-License">GNU Free Documentation
License</a>: Copying this manual.
+
+</li></ul>
+<p>Indices
+
+</p>
+<ul class="menu">
+<li><a href="#Index">Index</a>: Index
+<!-- * Function and Data Index:: Index of functions, variables and data
types. -->
+<!-- * Type Index:: Index of data types. -->
+
+ </ul>
+
+<!-- ********************************************************** -->
+<!-- ******************* Introduction *********************** -->
+<!-- ********************************************************** -->
+<div class="node">
+<a name="Introduction"></a>
+<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>
+
+</div>
+
+<h2 class="chapter">1 Introduction</h2>
+
+<p><a name="index-error-handling-1"></a>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.
+
+ <p><a name="index-plugin-2"></a>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.
+
+ <p>GNU libextractor 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
+GNU libextractor.
+
+ <p>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
+(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-3"></a>GNU libextractor is licensed under the GNU
General Public License,
+specifically, since version 0.7, GNU libextractor is licensed under GPLv3
+<em>or any later version</em>.
+
+<div class="node">
+<a name="Preparation"></a>
+<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>Compiling GNU libextractor 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>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 (wheezy) 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 or libgtk3.0-dev
+<li>libgsf-1-dev
+<li>libqt4-dev
+<li>libpoppler-dev
+<li>libexiv2-dev
+<li>libavformat-dev
+<li>libswscale-dev
+<li>libgstreamer1.0-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 GNU libextractor, 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
+GNU libextractor. 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 GNU
libextractor. The <samp><span class="file">extract</span></samp> man page
+documents the <samp><span class="file">extract</span></samp> tool. The GNU
libextractor man page gives a brief
+summary of the C API for GNU libextractor.
+
+ <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 GNU libextractor,
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
+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 <tt>LIBEXTRACTOR_PREFIX</tt>. If
+GNU libextractor 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 GNU libextractor 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 <br>
+<samp><span class="file">/Library/Frameworks/Extractor.framework</span></samp>
to 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 <br>
+<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 <br>
+"-I/Library/Frameworks/Extractor.framework/Versions/Current/include"
+to CPPFLAGS and <br>
+"-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.
+
+<div class="node">
+<a name="Generalities"></a>
+<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>
+
+</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 GNU libextractor has the prefix
+<tt>EXTRACTOR_</tt>. 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:
+
+<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 GNU libextractor is described
+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>
+<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 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.
+
+<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>
+
+<div class="node">
+<a name="Plugin-management"></a>
+<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>
+
+</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 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.
+
+ <p>The problem can be solved by loading the plugins using the
+<code>EXTRACTOR_OPTION_IN_PROCESS</code> 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
+<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 <code>NULL</code>. The second argument specifies the name of the plugin
(i.e. “ogg”). The third argument can be <code>NULL</code> 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 <code>NULL</code>. 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
GNU libextractor applications should use to setup the plugins.
+</p></blockquote></div>
+
+<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>
+
+</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
GNU libextractor 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 GNU libextractor
(<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 GNU libextractor (<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>
+
+<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”.
+
+<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>
+
+</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 <code>NULL</code> (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 GNU libextractor. 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 <code>NULL</code>, 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-<code>NULL</code>,
‘<samp><span class="samp">data</span></samp>’ can be
<code>NULL</code>. 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 c
lass="sa
mp">size</span></samp>’ 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, GNU libextractor
should not call ‘<samp><span class="samp">proc</span></samp>’ 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 <tt>mmap</tt>ed 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 <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 consi
der running GNU libextractor itself also out-of-process (as done, for example,
by <a href="http://grothoff.org/christian/doodle/";>doodle</a>).
+
+ </blockquote></div>
+
+<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>
+
+</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>
+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.
+
+<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.
+
+<div class="node">
+<a name="Utility-functions"></a>
+<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>
+
+</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 GNU libextractor 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>
+<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>
+
+</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.
+
+<div class="node">
+<a name="Meta-data-printing"></a>
+<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>
+
+<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>.
+
+<div class="node">
+<a name="Existing-Plugins"></a>
+<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>
+
+</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.
+
+<div class="node">
+<a name="Writing-new-Plugins"></a>
+<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>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>
+ <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>
+
+</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
GNU libextractor 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 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.
+
+ <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>
+
+<div class="node">
+<a name="Reporting-bugs"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n"
href="#GNU-Free-Documentation-License">GNU Free Documentation License</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>
+
+<p><a name="index-bug-63"></a>GNU libextractor uses the <a
href="https://gnunet.org/bugs/";>Mantis bugtracking system</a>. If possible,
please report bugs there. You can also e-mail
+the GNU libextractor mailinglist at <a
href="address@hidden">address@hidden</a>.
+
+<!-- ********************************************************** -->
+<!-- ******************* Appendices ************************* -->
+<!-- ********************************************************** -->
+<div class="node">
+<a name="GNU-Free-Documentation-License"></a>
+<p><hr>
+Next: <a rel="next" accesskey="n" href="#Index">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>
+
+<h2 class="appendix">Appendix A GNU Free Documentation License</h2>
+
+<!-- The GNU Free Documentation License. -->
+<div align="center">Version 1.3, 3 November 2008</div>
+
+<!-- This file is intended to be included within another document, -->
+<!-- hence no sectioning command or @node. -->
+<pre class="display"> Copyright © 2000, 2001, 2002, 2007, 2008 Free
Software Foundation, Inc.
+ <a href="http://fsf.org/";>http://fsf.org/</a>
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+</pre>
+ <ol type=1 start=0>
+<li>PREAMBLE
+
+ <p>The purpose of this License is to make a manual, textbook, or other
+functional and useful document <dfn>free</dfn> in the sense of freedom: to
+assure everyone the effective freedom to copy and redistribute it,
+with or without modifying it, either commercially or noncommercially.
+Secondarily, this License preserves for the author and publisher a way
+to get credit for their work, while not being considered responsible
+for modifications made by others.
+
+ <p>This License is a kind of “copyleft”, which means that
derivative
+works of the document must themselves be free in the same sense. It
+complements the GNU General Public License, which is a copyleft
+license designed for free software.
+
+ <p>We have designed this License in order to use it for manuals for free
+software, because free software needs free documentation: a free
+program should come with manuals providing the same freedoms that the
+software does. But this License is not limited to software manuals;
+it can be used for any textual work, regardless of subject matter or
+whether it is published as a printed book. We recommend this License
+principally for works whose purpose is instruction or reference.
+
+ <li>APPLICABILITY AND DEFINITIONS
+
+ <p>This License applies to any manual or other work, in any medium, that
+contains a notice placed by the copyright holder saying it can be
+distributed under the terms of this License. Such a notice grants a
+world-wide, royalty-free license, unlimited in duration, to use that
+work under the conditions stated herein. The “Document”, below,
+refers to any such manual or work. Any member of the public is a
+licensee, and is addressed as “you”. You accept the license if you
+copy, modify or distribute the work in a way requiring permission
+under copyright law.
+
+ <p>A “Modified Version” of the Document means any work
containing the
+Document or a portion of it, either copied verbatim, or with
+modifications and/or translated into another language.
+
+ <p>A “Secondary Section” is a named appendix or a
front-matter section
+of the Document that deals exclusively with the relationship of the
+publishers or authors of the Document to the Document's overall
+subject (or to related matters) and contains nothing that could fall
+directly within that overall subject. (Thus, if the Document is in
+part a textbook of mathematics, a Secondary Section may not explain
+any mathematics.) The relationship could be a matter of historical
+connection with the subject or with related matters, or of legal,
+commercial, philosophical, ethical or political position regarding
+them.
+
+ <p>The “Invariant Sections” are certain Secondary Sections
whose titles
+are designated, as being those of Invariant Sections, in the notice
+that says that the Document is released under this License. If a
+section does not fit the above definition of Secondary then it is not
+allowed to be designated as Invariant. The Document may contain zero
+Invariant Sections. If the Document does not identify any Invariant
+Sections then there are none.
+
+ <p>The “Cover Texts” are certain short passages of text that
are listed,
+as Front-Cover Texts or Back-Cover Texts, in the notice that says that
+the Document is released under this License. A Front-Cover Text may
+be at most 5 words, and a Back-Cover Text may be at most 25 words.
+
+ <p>A “Transparent” copy of the Document means a
machine-readable copy,
+represented in a format whose specification is available to the
+general public, that is suitable for revising the document
+straightforwardly with generic text editors or (for images composed of
+pixels) generic paint programs or (for drawings) some widely available
+drawing editor, and that is suitable for input to text formatters or
+for automatic translation to a variety of formats suitable for input
+to text formatters. A copy made in an otherwise Transparent file
+format whose markup, or absence of markup, has been arranged to thwart
+or discourage subsequent modification by readers is not Transparent.
+An image format is not Transparent if used for any substantial amount
+of text. A copy that is not “Transparent” is called
“Opaque”.
+
+ <p>Examples of suitable formats for Transparent copies include plain
+<span class="sc">ascii</span> without markup, Texinfo input format, LaTeX input
+format, <acronym>SGML</acronym> or <acronym>XML</acronym> using a publicly
available
+<acronym>DTD</acronym>, and standard-conforming simple <acronym>HTML</acronym>,
+PostScript or <acronym>PDF</acronym> designed for human modification. Examples
+of transparent image formats include <acronym>PNG</acronym>,
<acronym>XCF</acronym> and
+<acronym>JPG</acronym>. Opaque formats include proprietary formats that can be
+read and edited only by proprietary word processors, <acronym>SGML</acronym> or
+<acronym>XML</acronym> for which the <acronym>DTD</acronym> and/or processing
tools are
+not generally available, and the machine-generated <acronym>HTML</acronym>,
+PostScript or <acronym>PDF</acronym> produced by some word processors for
+output purposes only.
+
+ <p>The “Title Page” means, for a printed book, the title page
itself,
+plus such following pages as are needed to hold, legibly, the material
+this License requires to appear in the title page. For works in
+formats which do not have any title page as such, “Title Page”
means
+the text near the most prominent appearance of the work's title,
+preceding the beginning of the body of the text.
+
+ <p>The “publisher” means any person or entity that
distributes copies
+of the Document to the public.
+
+ <p>A section “Entitled XYZ” means a named subunit of the
Document whose
+title either is precisely XYZ or contains XYZ in parentheses following
+text that translates XYZ in another language. (Here XYZ stands for a
+specific section name mentioned below, such as “Acknowledgements”,
+“Dedications”, “Endorsements”, or
“History”.) To “Preserve the Title”
+of such a section when you modify the Document means that it remains a
+section “Entitled XYZ” according to this definition.
+
+ <p>The Document may include Warranty Disclaimers next to the notice which
+states that this License applies to the Document. These Warranty
+Disclaimers are considered to be included by reference in this
+License, but only as regards disclaiming warranties: any other
+implication that these Warranty Disclaimers may have is void and has
+no effect on the meaning of this License.
+
+ <li>VERBATIM COPYING
+
+ <p>You may copy and distribute the Document in any medium, either
+commercially or noncommercially, provided that this License, the
+copyright notices, and the license notice saying this License applies
+to the Document are reproduced in all copies, and that you add no other
+conditions whatsoever to those of this License. You may not use
+technical measures to obstruct or control the reading or further
+copying of the copies you make or distribute. However, you may accept
+compensation in exchange for copies. If you distribute a large enough
+number of copies you must also follow the conditions in section 3.
+
+ <p>You may also lend copies, under the same conditions stated above, and
+you may publicly display copies.
+
+ <li>COPYING IN QUANTITY
+
+ <p>If you publish printed copies (or copies in media that commonly have
+printed covers) of the Document, numbering more than 100, and the
+Document's license notice requires Cover Texts, you must enclose the
+copies in covers that carry, clearly and legibly, all these Cover
+Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
+the back cover. Both covers must also clearly and legibly identify
+you as the publisher of these copies. The front cover must present
+the full title with all words of the title equally prominent and
+visible. You may add other material on the covers in addition.
+Copying with changes limited to the covers, as long as they preserve
+the title of the Document and satisfy these conditions, can be treated
+as verbatim copying in other respects.
+
+ <p>If the required texts for either cover are too voluminous to fit
+legibly, you should put the first ones listed (as many as fit
+reasonably) on the actual cover, and continue the rest onto adjacent
+pages.
+
+ <p>If you publish or distribute Opaque copies of the Document numbering
+more than 100, you must either include a machine-readable Transparent
+copy along with each Opaque copy, or state in or with each Opaque copy
+a computer-network location from which the general network-using
+public has access to download using public-standard network protocols
+a complete Transparent copy of the Document, free of added material.
+If you use the latter option, you must take reasonably prudent steps,
+when you begin distribution of Opaque copies in quantity, to ensure
+that this Transparent copy will remain thus accessible at the stated
+location until at least one year after the last time you distribute an
+Opaque copy (directly or through your agents or retailers) of that
+edition to the public.
+
+ <p>It is requested, but not required, that you contact the authors of the
+Document well before redistributing any large number of copies, to give
+them a chance to provide you with an updated version of the Document.
+
+ <li>MODIFICATIONS
+
+ <p>You may copy and distribute a Modified Version of the Document under
+the conditions of sections 2 and 3 above, provided that you release
+the Modified Version under precisely this License, with the Modified
+Version filling the role of the Document, thus licensing distribution
+and modification of the Modified Version to whoever possesses a copy
+of it. In addition, you must do these things in the Modified Version:
+
+ <ol type=A start=1>
+<li>Use in the Title Page (and on the covers, if any) a title distinct
+from that of the Document, and from those of previous versions
+(which should, if there were any, be listed in the History section
+of the Document). You may use the same title as a previous version
+if the original publisher of that version gives permission.
+
+ <li>List on the Title Page, as authors, one or more persons or
entities
+responsible for authorship of the modifications in the Modified
+Version, together with at least five of the principal authors of the
+Document (all of its principal authors, if it has fewer than five),
+unless they release you from this requirement.
+
+ <li>State on the Title page the name of the publisher of the
+Modified Version, as the publisher.
+
+ <li>Preserve all the copyright notices of the Document.
+
+ <li>Add an appropriate copyright notice for your modifications
+adjacent to the other copyright notices.
+
+ <li>Include, immediately after the copyright notices, a license
notice
+giving the public permission to use the Modified Version under the
+terms of this License, in the form shown in the Addendum below.
+
+ <li>Preserve in that license notice the full lists of Invariant
Sections
+and required Cover Texts given in the Document's license notice.
+
+ <li>Include an unaltered copy of this License.
+
+ <li>Preserve the section Entitled “History”, Preserve
its Title, and add
+to it an item stating at least the title, year, new authors, and
+publisher of the Modified Version as given on the Title Page. If
+there is no section Entitled “History” in the Document, create one
+stating the title, year, authors, and publisher of the Document as
+given on its Title Page, then add an item describing the Modified
+Version as stated in the previous sentence.
+
+ <li>Preserve the network location, if any, given in the Document for
+public access to a Transparent copy of the Document, and likewise
+the network locations given in the Document for previous versions
+it was based on. These may be placed in the “History” section.
+You may omit a network location for a work that was published at
+least four years before the Document itself, or if the original
+publisher of the version it refers to gives permission.
+
+ <li>For any section Entitled “Acknowledgements” or
“Dedications”, Preserve
+the Title of the section, and preserve in the section all the
+substance and tone of each of the contributor acknowledgements and/or
+dedications given therein.
+
+ <li>Preserve all the Invariant Sections of the Document,
+unaltered in their text and in their titles. Section numbers
+or the equivalent are not considered part of the section titles.
+
+ <li>Delete any section Entitled “Endorsements”. Such a
section
+may not be included in the Modified Version.
+
+ <li>Do not retitle any existing section to be Entitled
“Endorsements” or
+to conflict in title with any Invariant Section.
+
+ <li>Preserve any Warranty Disclaimers.
+ </ol>
+
+ <p>If the Modified Version includes new front-matter sections or
+appendices that qualify as Secondary Sections and contain no material
+copied from the Document, you may at your option designate some or all
+of these sections as invariant. To do this, add their titles to the
+list of Invariant Sections in the Modified Version's license notice.
+These titles must be distinct from any other section titles.
+
+ <p>You may add a section Entitled “Endorsements”, provided it
contains
+nothing but endorsements of your Modified Version by various
+parties—for example, statements of peer review or that the text has
+been approved by an organization as the authoritative definition of a
+standard.
+
+ <p>You may add a passage of up to five words as a Front-Cover Text, and a
+passage of up to 25 words as a Back-Cover Text, to the end of the list
+of Cover Texts in the Modified Version. Only one passage of
+Front-Cover Text and one of Back-Cover Text may be added by (or
+through arrangements made by) any one entity. If the Document already
+includes a cover text for the same cover, previously added by you or
+by arrangement made by the same entity you are acting on behalf of,
+you may not add another; but you may replace the old one, on explicit
+permission from the previous publisher that added the old one.
+
+ <p>The author(s) and publisher(s) of the Document do not by this License
+give permission to use their names for publicity for or to assert or
+imply endorsement of any Modified Version.
+
+ <li>COMBINING DOCUMENTS
+
+ <p>You may combine the Document with other documents released under this
+License, under the terms defined in section 4 above for modified
+versions, provided that you include in the combination all of the
+Invariant Sections of all of the original documents, unmodified, and
+list them all as Invariant Sections of your combined work in its
+license notice, and that you preserve all their Warranty Disclaimers.
+
+ <p>The combined work need only contain one copy of this License, and
+multiple identical Invariant Sections may be replaced with a single
+copy. If there are multiple Invariant Sections with the same name but
+different contents, make the title of each such section unique by
+adding at the end of it, in parentheses, the name of the original
+author or publisher of that section if known, or else a unique number.
+Make the same adjustment to the section titles in the list of
+Invariant Sections in the license notice of the combined work.
+
+ <p>In the combination, you must combine any sections Entitled
“History”
+in the various original documents, forming one section Entitled
+“History”; likewise combine any sections Entitled
“Acknowledgements”,
+and any sections Entitled “Dedications”. You must delete all
+sections Entitled “Endorsements.”
+
+ <li>COLLECTIONS OF DOCUMENTS
+
+ <p>You may make a collection consisting of the Document and other
documents
+released under this License, and replace the individual copies of this
+License in the various documents with a single copy that is included in
+the collection, provided that you follow the rules of this License for
+verbatim copying of each of the documents in all other respects.
+
+ <p>You may extract a single document from such a collection, and
distribute
+it individually under this License, provided you insert a copy of this
+License into the extracted document, and follow this License in all
+other respects regarding verbatim copying of that document.
+
+ <li>AGGREGATION WITH INDEPENDENT WORKS
+
+ <p>A compilation of the Document or its derivatives with other separate
+and independent documents or works, in or on a volume of a storage or
+distribution medium, is called an “aggregate” if the copyright
+resulting from the compilation is not used to limit the legal rights
+of the compilation's users beyond what the individual works permit.
+When the Document is included in an aggregate, this License does not
+apply to the other works in the aggregate which are not themselves
+derivative works of the Document.
+
+ <p>If the Cover Text requirement of section 3 is applicable to these
+copies of the Document, then if the Document is less than one half of
+the entire aggregate, the Document's Cover Texts may be placed on
+covers that bracket the Document within the aggregate, or the
+electronic equivalent of covers if the Document is in electronic form.
+Otherwise they must appear on printed covers that bracket the whole
+aggregate.
+
+ <li>TRANSLATION
+
+ <p>Translation is considered a kind of modification, so you may
+distribute translations of the Document under the terms of section 4.
+Replacing Invariant Sections with translations requires special
+permission from their copyright holders, but you may include
+translations of some or all Invariant Sections in addition to the
+original versions of these Invariant Sections. You may include a
+translation of this License, and all the license notices in the
+Document, and any Warranty Disclaimers, provided that you also include
+the original English version of this License and the original versions
+of those notices and disclaimers. In case of a disagreement between
+the translation and the original version of this License or a notice
+or disclaimer, the original version will prevail.
+
+ <p>If a section in the Document is Entitled
“Acknowledgements”,
+“Dedications”, or “History”, the requirement (section
4) to Preserve
+its Title (section 1) will typically require changing the actual
+title.
+
+ <li>TERMINATION
+
+ <p>You may not copy, modify, sublicense, or distribute the Document
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense, or distribute it is void, and
+will automatically terminate your rights under this License.
+
+ <p>However, if you cease all violation of this License, then your license
+from a particular copyright holder is reinstated (a) provisionally,
+unless and until the copyright holder explicitly and finally
+terminates your license, and (b) permanently, if the copyright holder
+fails to notify you of the violation by some reasonable means prior to
+60 days after the cessation.
+
+ <p>Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ <p>Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, receipt of a copy of some or all of the same material does
+not give you any rights to use it.
+
+ <li>FUTURE REVISIONS OF THIS LICENSE
+
+ <p>The Free Software Foundation may publish new, revised versions
+of the GNU Free Documentation 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. See
+<a href="http://www.gnu.org/copyleft/";>http://www.gnu.org/copyleft/</a>.
+
+ <p>Each version of the License is given a distinguishing version number.
+If the Document specifies that a particular numbered version of this
+License “or any later version” applies to it, you have the option
of
+following the terms and conditions either of that specified version or
+of any later version that has been published (not as a draft) by the
+Free Software Foundation. If the Document does not specify a version
+number of this License, you may choose any version ever published (not
+as a draft) by the Free Software Foundation. If the Document
+specifies that a proxy can decide which future versions of this
+License can be used, that proxy's public statement of acceptance of a
+version permanently authorizes you to choose that version for the
+Document.
+
+ <li>RELICENSING
+
+ <p>“Massive Multiauthor Collaboration Site” (or “MMC
Site”) means any
+World Wide Web server that publishes copyrightable works and also
+provides prominent facilities for anybody to edit those works. A
+public wiki that anybody can edit is an example of such a server. A
+“Massive Multiauthor Collaboration” (or “MMC”)
contained in the
+site means any set of copyrightable works thus published on the MMC
+site.
+
+ <p>“CC-BY-SA” means the Creative Commons Attribution-Share
Alike 3.0
+license published by Creative Commons Corporation, a not-for-profit
+corporation with a principal place of business in San Francisco,
+California, as well as future copyleft versions of that license
+published by that same organization.
+
+ <p>“Incorporate” means to publish or republish a Document, in
whole or
+in part, as part of another Document.
+
+ <p>An MMC is “eligible for relicensing” if it is licensed
under this
+License, and if all works that were first published under this License
+somewhere other than this MMC, and subsequently incorporated in whole
+or in part into the MMC, (1) had no cover texts or invariant sections,
+and (2) were thus incorporated prior to November 1, 2008.
+
+ <p>The operator of an MMC Site may republish an MMC contained in the site
+under CC-BY-SA on the same site at any time before August 1, 2009,
+provided the MMC is eligible for relicensing.
+
+ </ol>
+
+<h3 class="heading">ADDENDUM: How to use this License for your documents</h3>
+
+<p>To use this License in a document you have written, include a copy of
+the License in the document and put the following copyright and
+license notices just after the title page:
+
+<pre class="smallexample"> Copyright (C) <var>year</var> <var>your
name</var>.
+ 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''.
+</pre>
+ <p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
+replace the “with<small class="dots">...</small>Texts.” line with
this:
+
+<pre class="smallexample"> with the Invariant Sections being <var>list
their titles</var>, with
+ the Front-Cover Texts being <var>list</var>, and with the Back-Cover
Texts
+ being <var>list</var>.
+</pre>
+ <p>If you have Invariant Sections without Cover Texts, or some other
+combination of the three, merge those two alternatives to suit the
+situation.
+
+ <p>If your document contains nontrivial examples of program code, we
+recommend releasing these examples in parallel under your choice of
+free software license, such as the GNU General Public License,
+to permit their use in free software.
+
+<!-- Local Variables: -->
+<!-- ispell-local-pdict: "ispell-dict" -->
+<!-- End: -->
+<div class="node">
+<a name="Index"></a>
+<p><hr>
+Previous: <a rel="previous" accesskey="p"
href="#GNU-Free-Documentation-License">GNU Free Documentation License</a>,
+Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+
+</div>
+
+<h2 class="unnumbered">Index</h2>
+
+<ul class="index-cp" compact>
+<li><a href="#index-g_t_0028-37"><code>(</code></a>: <a
href="#Extracting">Extracting</a></li>
+<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-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-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-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_005fMetaDataProcessor-38"><code>EXTRACTOR_MetaDataProcessor</code></a>:
<a href="#Extracting">Extracting</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_005fPluginList-14"><code>EXTRACTOR_PluginList</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>
+<li><a href="#index-gettext-30">gettext</a>: <a href="#Meta-types">Meta
types</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-LIBEXTRACTOR_005fPREFIX-8"><code>LIBEXTRACTOR_PREFIX</code></a>:
<a href="#Preparation">Preparation</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-struct-EXTRACTOR_005fPluginList-15"><code>struct
EXTRACTOR_PluginList</code></a>: <a href="#Plugin-management">Plugin
management</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><!-- @node Function and Data Index -->
+<!-- @unnumbered Function and Data Index -->
+<!-- @printindex fn -->
+<!-- @node Type Index -->
+<!-- @unnumbered Type Index -->
+<!-- @printindex tp -->
+<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/libextractor.html.gz
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/libextractor.html.gz
===================================================================
--- Extractor-docs/WWW/manual/libextractor.html.gz 2012-09-25 14:37:40 UTC
(rev 23996)
+++ Extractor-docs/WWW/manual/libextractor.html.gz 2012-09-25 14:47:07 UTC
(rev 23997)
Property changes on: Extractor-docs/WWW/manual/libextractor.html.gz
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: Extractor-docs/WWW/manual/libextractor.html_node.tar.gz
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/libextractor.html_node.tar.gz
===================================================================
--- Extractor-docs/WWW/manual/libextractor.html_node.tar.gz 2012-09-25
14:37:40 UTC (rev 23996)
+++ Extractor-docs/WWW/manual/libextractor.html_node.tar.gz 2012-09-25
14:47:07 UTC (rev 23997)
Property changes on: Extractor-docs/WWW/manual/libextractor.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/libextractor.info.tar.gz
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/libextractor.info.tar.gz
===================================================================
--- Extractor-docs/WWW/manual/libextractor.info.tar.gz 2012-09-25 14:37:40 UTC
(rev 23996)
+++ Extractor-docs/WWW/manual/libextractor.info.tar.gz 2012-09-25 14:47:07 UTC
(rev 23997)
Property changes on: Extractor-docs/WWW/manual/libextractor.info.tar.gz
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: Extractor-docs/WWW/manual/libextractor.pdf
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/libextractor.pdf
===================================================================
--- Extractor-docs/WWW/manual/libextractor.pdf 2012-09-25 14:37:40 UTC (rev
23996)
+++ Extractor-docs/WWW/manual/libextractor.pdf 2012-09-25 14:47:07 UTC (rev
23997)
Property changes on: Extractor-docs/WWW/manual/libextractor.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: Extractor-docs/WWW/manual/libextractor.ps.gz
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/libextractor.ps.gz
===================================================================
--- Extractor-docs/WWW/manual/libextractor.ps.gz 2012-09-25 14:37:40 UTC
(rev 23996)
+++ Extractor-docs/WWW/manual/libextractor.ps.gz 2012-09-25 14:47:07 UTC
(rev 23997)
Property changes on: Extractor-docs/WWW/manual/libextractor.ps.gz
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: Extractor-docs/WWW/manual/libextractor.texi.tar.gz
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/libextractor.texi.tar.gz
===================================================================
--- Extractor-docs/WWW/manual/libextractor.texi.tar.gz 2012-09-25 14:37:40 UTC
(rev 23996)
+++ Extractor-docs/WWW/manual/libextractor.texi.tar.gz 2012-09-25 14:47:07 UTC
(rev 23997)
Property changes on: Extractor-docs/WWW/manual/libextractor.texi.tar.gz
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: Extractor-docs/WWW/manual/libextractor.txt
===================================================================
--- Extractor-docs/WWW/manual/libextractor.txt (rev 0)
+++ Extractor-docs/WWW/manual/libextractor.txt 2012-09-25 14:47:07 UTC (rev
23997)
@@ -0,0 +1,1444 @@
+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 Free Documentation License
+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 Free Documentation License
+Index
+
+
+The GNU libextractor Reference Manual
+*************************************
+
+This manual is for GNU libextractor (version 1.0.0, 8 September 2012),
+a library for metadata extraction.
+
+ 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
+(wheezy) 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 or libgtk3.0-dev
+
+ * libgsf-1-dev
+
+ * libqt4-dev
+
+ * libpoppler-dev
+
+ * libexiv2-dev
+
+ * libavformat-dev
+
+ * libswscale-dev
+
+ * libgstreamer1.0-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' to 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 Free Documentation License
+*****************************************
+
+ Version 1.3, 3 November 2008
+
+ Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
+ `http://fsf.org/'
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ 0. PREAMBLE
+
+ The purpose of this License is to make a manual, textbook, or other
+ functional and useful document "free" in the sense of freedom: to
+ assure everyone the effective freedom to copy and redistribute it,
+ with or without modifying it, either commercially or
+ noncommercially. Secondarily, this License preserves for the
+ author and publisher a way to get credit for their work, while not
+ being considered responsible for modifications made by others.
+
+ This License is a kind of "copyleft", which means that derivative
+ works of the document must themselves be free in the same sense.
+ It complements the GNU General Public License, which is a copyleft
+ license designed for free software.
+
+ We have designed this License in order to use it for manuals for
+ free software, because free software needs free documentation: a
+ free program should come with manuals providing the same freedoms
+ that the software does. But this License is not limited to
+ software manuals; it can be used for any textual work, regardless
+ of subject matter or whether it is published as a printed book.
+ We recommend this License principally for works whose purpose is
+ instruction or reference.
+
+ 1. APPLICABILITY AND DEFINITIONS
+
+ This License applies to any manual or other work, in any medium,
+ that contains a notice placed by the copyright holder saying it
+ can be distributed under the terms of this License. Such a notice
+ grants a world-wide, royalty-free license, unlimited in duration,
+ to use that work under the conditions stated herein. The
+ "Document", below, refers to any such manual or work. Any member
+ of the public is a licensee, and is addressed as "you". You
+ accept the license if you copy, modify or distribute the work in a
+ way requiring permission under copyright law.
+
+ A "Modified Version" of the Document means any work containing the
+ Document or a portion of it, either copied verbatim, or with
+ modifications and/or translated into another language.
+
+ A "Secondary Section" is a named appendix or a front-matter section
+ of the Document that deals exclusively with the relationship of the
+ publishers or authors of the Document to the Document's overall
+ subject (or to related matters) and contains nothing that could
+ fall directly within that overall subject. (Thus, if the Document
+ is in part a textbook of mathematics, a Secondary Section may not
+ explain any mathematics.) The relationship could be a matter of
+ historical connection with the subject or with related matters, or
+ of legal, commercial, philosophical, ethical or political position
+ regarding them.
+
+ The "Invariant Sections" are certain Secondary Sections whose
+ titles are designated, as being those of Invariant Sections, in
+ the notice that says that the Document is released under this
+ License. If a section does not fit the above definition of
+ Secondary then it is not allowed to be designated as Invariant.
+ The Document may contain zero Invariant Sections. If the Document
+ does not identify any Invariant Sections then there are none.
+
+ The "Cover Texts" are certain short passages of text that are
+ listed, as Front-Cover Texts or Back-Cover Texts, in the notice
+ that says that the Document is released under this License. A
+ Front-Cover Text may be at most 5 words, and a Back-Cover Text may
+ be at most 25 words.
+
+ A "Transparent" copy of the Document means a machine-readable copy,
+ represented in a format whose specification is available to the
+ general public, that is suitable for revising the document
+ straightforwardly with generic text editors or (for images
+ composed of pixels) generic paint programs or (for drawings) some
+ widely available drawing editor, and that is suitable for input to
+ text formatters or for automatic translation to a variety of
+ formats suitable for input to text formatters. A copy made in an
+ otherwise Transparent file format whose markup, or absence of
+ markup, has been arranged to thwart or discourage subsequent
+ modification by readers is not Transparent. An image format is
+ not Transparent if used for any substantial amount of text. A
+ copy that is not "Transparent" is called "Opaque".
+
+ Examples of suitable formats for Transparent copies include plain
+ ASCII without markup, Texinfo input format, LaTeX input format,
+ SGML or XML using a publicly available DTD, and
+ standard-conforming simple HTML, PostScript or PDF designed for
+ human modification. Examples of transparent image formats include
+ PNG, XCF and JPG. Opaque formats include proprietary formats that
+ can be read and edited only by proprietary word processors, SGML or
+ XML for which the DTD and/or processing tools are not generally
+ available, and the machine-generated HTML, PostScript or PDF
+ produced by some word processors for output purposes only.
+
+ The "Title Page" means, for a printed book, the title page itself,
+ plus such following pages as are needed to hold, legibly, the
+ material this License requires to appear in the title page. For
+ works in formats which do not have any title page as such, "Title
+ Page" means the text near the most prominent appearance of the
+ work's title, preceding the beginning of the body of the text.
+
+ The "publisher" means any person or entity that distributes copies
+ of the Document to the public.
+
+ A section "Entitled XYZ" means a named subunit of the Document
+ whose title either is precisely XYZ or contains XYZ in parentheses
+ following text that translates XYZ in another language. (Here XYZ
+ stands for a specific section name mentioned below, such as
+ "Acknowledgements", "Dedications", "Endorsements", or "History".)
+ To "Preserve the Title" of such a section when you modify the
+ Document means that it remains a section "Entitled XYZ" according
+ to this definition.
+
+ The Document may include Warranty Disclaimers next to the notice
+ which states that this License applies to the Document. These
+ Warranty Disclaimers are considered to be included by reference in
+ this License, but only as regards disclaiming warranties: any other
+ implication that these Warranty Disclaimers may have is void and
+ has no effect on the meaning of this License.
+
+ 2. VERBATIM COPYING
+
+ You may copy and distribute the Document in any medium, either
+ commercially or noncommercially, provided that this License, the
+ copyright notices, and the license notice saying this License
+ applies to the Document are reproduced in all copies, and that you
+ add no other conditions whatsoever to those of this License. You
+ may not use technical measures to obstruct or control the reading
+ or further copying of the copies you make or distribute. However,
+ you may accept compensation in exchange for copies. If you
+ distribute a large enough number of copies you must also follow
+ the conditions in section 3.
+
+ You may also lend copies, under the same conditions stated above,
+ and you may publicly display copies.
+
+ 3. COPYING IN QUANTITY
+
+ If you publish printed copies (or copies in media that commonly
+ have printed covers) of the Document, numbering more than 100, and
+ the Document's license notice requires Cover Texts, you must
+ enclose the copies in covers that carry, clearly and legibly, all
+ these Cover Texts: Front-Cover Texts on the front cover, and
+ Back-Cover Texts on the back cover. Both covers must also clearly
+ and legibly identify you as the publisher of these copies. The
+ front cover must present the full title with all words of the
+ title equally prominent and visible. You may add other material
+ on the covers in addition. Copying with changes limited to the
+ covers, as long as they preserve the title of the Document and
+ satisfy these conditions, can be treated as verbatim copying in
+ other respects.
+
+ If the required texts for either cover are too voluminous to fit
+ legibly, you should put the first ones listed (as many as fit
+ reasonably) on the actual cover, and continue the rest onto
+ adjacent pages.
+
+ If you publish or distribute Opaque copies of the Document
+ numbering more than 100, you must either include a
+ machine-readable Transparent copy along with each Opaque copy, or
+ state in or with each Opaque copy a computer-network location from
+ which the general network-using public has access to download
+ using public-standard network protocols a complete Transparent
+ copy of the Document, free of added material. If you use the
+ latter option, you must take reasonably prudent steps, when you
+ begin distribution of Opaque copies in quantity, to ensure that
+ this Transparent copy will remain thus accessible at the stated
+ location until at least one year after the last time you
+ distribute an Opaque copy (directly or through your agents or
+ retailers) of that edition to the public.
+
+ It is requested, but not required, that you contact the authors of
+ the Document well before redistributing any large number of
+ copies, to give them a chance to provide you with an updated
+ version of the Document.
+
+ 4. MODIFICATIONS
+
+ You may copy and distribute a Modified Version of the Document
+ under the conditions of sections 2 and 3 above, provided that you
+ release the Modified Version under precisely this License, with
+ the Modified Version filling the role of the Document, thus
+ licensing distribution and modification of the Modified Version to
+ whoever possesses a copy of it. In addition, you must do these
+ things in the Modified Version:
+
+ A. Use in the Title Page (and on the covers, if any) a title
+ distinct from that of the Document, and from those of
+ previous versions (which should, if there were any, be listed
+ in the History section of the Document). You may use the
+ same title as a previous version if the original publisher of
+ that version gives permission.
+
+ B. List on the Title Page, as authors, one or more persons or
+ entities responsible for authorship of the modifications in
+ the Modified Version, together with at least five of the
+ principal authors of the Document (all of its principal
+ authors, if it has fewer than five), unless they release you
+ from this requirement.
+
+ C. State on the Title page the name of the publisher of the
+ Modified Version, as the publisher.
+
+ D. Preserve all the copyright notices of the Document.
+
+ E. Add an appropriate copyright notice for your modifications
+ adjacent to the other copyright notices.
+
+ F. Include, immediately after the copyright notices, a license
+ notice giving the public permission to use the Modified
+ Version under the terms of this License, in the form shown in
+ the Addendum below.
+
+ G. Preserve in that license notice the full lists of Invariant
+ Sections and required Cover Texts given in the Document's
+ license notice.
+
+ H. Include an unaltered copy of this License.
+
+ I. Preserve the section Entitled "History", Preserve its Title,
+ and add to it an item stating at least the title, year, new
+ authors, and publisher of the Modified Version as given on
+ the Title Page. If there is no section Entitled "History" in
+ the Document, create one stating the title, year, authors,
+ and publisher of the Document as given on its Title Page,
+ then add an item describing the Modified Version as stated in
+ the previous sentence.
+
+ J. Preserve the network location, if any, given in the Document
+ for public access to a Transparent copy of the Document, and
+ likewise the network locations given in the Document for
+ previous versions it was based on. These may be placed in
+ the "History" section. You may omit a network location for a
+ work that was published at least four years before the
+ Document itself, or if the original publisher of the version
+ it refers to gives permission.
+
+ K. For any section Entitled "Acknowledgements" or "Dedications",
+ Preserve the Title of the section, and preserve in the
+ section all the substance and tone of each of the contributor
+ acknowledgements and/or dedications given therein.
+
+ L. Preserve all the Invariant Sections of the Document,
+ unaltered in their text and in their titles. Section numbers
+ or the equivalent are not considered part of the section
+ titles.
+
+ M. Delete any section Entitled "Endorsements". Such a section
+ may not be included in the Modified Version.
+
+ N. Do not retitle any existing section to be Entitled
+ "Endorsements" or to conflict in title with any Invariant
+ Section.
+
+ O. Preserve any Warranty Disclaimers.
+
+ If the Modified Version includes new front-matter sections or
+ appendices that qualify as Secondary Sections and contain no
+ material copied from the Document, you may at your option
+ designate some or all of these sections as invariant. To do this,
+ add their titles to the list of Invariant Sections in the Modified
+ Version's license notice. These titles must be distinct from any
+ other section titles.
+
+ You may add a section Entitled "Endorsements", provided it contains
+ nothing but endorsements of your Modified Version by various
+ parties--for example, statements of peer review or that the text
+ has been approved by an organization as the authoritative
+ definition of a standard.
+
+ You may add a passage of up to five words as a Front-Cover Text,
+ and a passage of up to 25 words as a Back-Cover Text, to the end
+ of the list of Cover Texts in the Modified Version. Only one
+ passage of Front-Cover Text and one of Back-Cover Text may be
+ added by (or through arrangements made by) any one entity. If the
+ Document already includes a cover text for the same cover,
+ previously added by you or by arrangement made by the same entity
+ you are acting on behalf of, you may not add another; but you may
+ replace the old one, on explicit permission from the previous
+ publisher that added the old one.
+
+ The author(s) and publisher(s) of the Document do not by this
+ License give permission to use their names for publicity for or to
+ assert or imply endorsement of any Modified Version.
+
+ 5. COMBINING DOCUMENTS
+
+ You may combine the Document with other documents released under
+ this License, under the terms defined in section 4 above for
+ modified versions, provided that you include in the combination
+ all of the Invariant Sections of all of the original documents,
+ unmodified, and list them all as Invariant Sections of your
+ combined work in its license notice, and that you preserve all
+ their Warranty Disclaimers.
+
+ The combined work need only contain one copy of this License, and
+ multiple identical Invariant Sections may be replaced with a single
+ copy. If there are multiple Invariant Sections with the same name
+ but different contents, make the title of each such section unique
+ by adding at the end of it, in parentheses, the name of the
+ original author or publisher of that section if known, or else a
+ unique number. Make the same adjustment to the section titles in
+ the list of Invariant Sections in the license notice of the
+ combined work.
+
+ In the combination, you must combine any sections Entitled
+ "History" in the various original documents, forming one section
+ Entitled "History"; likewise combine any sections Entitled
+ "Acknowledgements", and any sections Entitled "Dedications". You
+ must delete all sections Entitled "Endorsements."
+
+ 6. COLLECTIONS OF DOCUMENTS
+
+ You may make a collection consisting of the Document and other
+ documents released under this License, and replace the individual
+ copies of this License in the various documents with a single copy
+ that is included in the collection, provided that you follow the
+ rules of this License for verbatim copying of each of the
+ documents in all other respects.
+
+ You may extract a single document from such a collection, and
+ distribute it individually under this License, provided you insert
+ a copy of this License into the extracted document, and follow
+ this License in all other respects regarding verbatim copying of
+ that document.
+
+ 7. AGGREGATION WITH INDEPENDENT WORKS
+
+ A compilation of the Document or its derivatives with other
+ separate and independent documents or works, in or on a volume of
+ a storage or distribution medium, is called an "aggregate" if the
+ copyright resulting from the compilation is not used to limit the
+ legal rights of the compilation's users beyond what the individual
+ works permit. When the Document is included in an aggregate, this
+ License does not apply to the other works in the aggregate which
+ are not themselves derivative works of the Document.
+
+ If the Cover Text requirement of section 3 is applicable to these
+ copies of the Document, then if the Document is less than one half
+ of the entire aggregate, the Document's Cover Texts may be placed
+ on covers that bracket the Document within the aggregate, or the
+ electronic equivalent of covers if the Document is in electronic
+ form. Otherwise they must appear on printed covers that bracket
+ the whole aggregate.
+
+ 8. TRANSLATION
+
+ Translation is considered a kind of modification, so you may
+ distribute translations of the Document under the terms of section
+ 4. Replacing Invariant Sections with translations requires special
+ permission from their copyright holders, but you may include
+ translations of some or all Invariant Sections in addition to the
+ original versions of these Invariant Sections. You may include a
+ translation of this License, and all the license notices in the
+ Document, and any Warranty Disclaimers, provided that you also
+ include the original English version of this License and the
+ original versions of those notices and disclaimers. In case of a
+ disagreement between the translation and the original version of
+ this License or a notice or disclaimer, the original version will
+ prevail.
+
+ If a section in the Document is Entitled "Acknowledgements",
+ "Dedications", or "History", the requirement (section 4) to
+ Preserve its Title (section 1) will typically require changing the
+ actual title.
+
+ 9. TERMINATION
+
+ You may not copy, modify, sublicense, or distribute the Document
+ except as expressly provided under this License. Any attempt
+ otherwise to copy, modify, sublicense, or distribute it is void,
+ and will automatically terminate your rights under this License.
+
+ However, if you cease all violation of this License, then your
+ license from a particular copyright holder is reinstated (a)
+ provisionally, unless and until the copyright holder explicitly
+ and finally terminates your license, and (b) permanently, if the
+ copyright holder fails to notify you of the violation by some
+ reasonable means prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+ reinstated permanently if the copyright holder notifies you of the
+ violation by some reasonable means, this is the first time you have
+ received notice of violation of this License (for any work) from
+ that copyright holder, and you cure the violation prior to 30 days
+ after your receipt of the notice.
+
+ Termination of your rights under this section does not terminate
+ the licenses of parties who have received copies or rights from
+ you under this License. If your rights have been terminated and
+ not permanently reinstated, receipt of a copy of some or all of
+ the same material does not give you any rights to use it.
+
+ 10. FUTURE REVISIONS OF THIS LICENSE
+
+ The Free Software Foundation may publish new, revised versions of
+ the GNU Free Documentation 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. See
+ `http://www.gnu.org/copyleft/'.
+
+ Each version of the License is given a distinguishing version
+ number. If the Document specifies that a particular numbered
+ version of this License "or any later version" applies to it, you
+ have the option of following the terms and conditions either of
+ that specified version or of any later version that has been
+ published (not as a draft) by the Free Software Foundation. If
+ the Document does not specify a version number of this License,
+ you may choose any version ever published (not as a draft) by the
+ Free Software Foundation. If the Document specifies that a proxy
+ can decide which future versions of this License can be used, that
+ proxy's public statement of acceptance of a version permanently
+ authorizes you to choose that version for the Document.
+
+ 11. RELICENSING
+
+ "Massive Multiauthor Collaboration Site" (or "MMC Site") means any
+ World Wide Web server that publishes copyrightable works and also
+ provides prominent facilities for anybody to edit those works. A
+ public wiki that anybody can edit is an example of such a server.
+ A "Massive Multiauthor Collaboration" (or "MMC") contained in the
+ site means any set of copyrightable works thus published on the MMC
+ site.
+
+ "CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
+ license published by Creative Commons Corporation, a not-for-profit
+ corporation with a principal place of business in San Francisco,
+ California, as well as future copyleft versions of that license
+ published by that same organization.
+
+ "Incorporate" means to publish or republish a Document, in whole or
+ in part, as part of another Document.
+
+ An MMC is "eligible for relicensing" if it is licensed under this
+ License, and if all works that were first published under this
+ License somewhere other than this MMC, and subsequently
+ incorporated in whole or in part into the MMC, (1) had no cover
+ texts or invariant sections, and (2) were thus incorporated prior
+ to November 1, 2008.
+
+ The operator of an MMC Site may republish an MMC contained in the
+ site under CC-BY-SA on the same site at any time before August 1,
+ 2009, provided the MMC is eligible for relicensing.
+
+
+ADDENDUM: How to use this License for your documents
+====================================================
+
+To use this License in a document you have written, include a copy of
+the License in the document and put the following copyright and license
+notices just after the title page:
+
+ Copyright (C) YEAR YOUR NAME.
+ 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''.
+
+ If you have Invariant Sections, Front-Cover Texts and Back-Cover
+Texts, replace the "with...Texts." line with this:
+
+ with the Invariant Sections being LIST THEIR TITLES, with
+ the Front-Cover Texts being LIST, and with the Back-Cover Texts
+ being LIST.
+
+ If you have Invariant Sections without Cover Texts, or some other
+combination of the three, merge those two alternatives to suit the
+situation.
+
+ If your document contains nontrivial examples of program code, we
+recommend releasing these examples in parallel under your choice of
+free software license, such as the GNU General Public License, to
+permit their use in free software.
+
+Index
+*****
+
+(: See 4.4. (line 569)
+bug: See 10. (line 902)
+bus error: See 4.4. (line 615)
+character set: See 9. (line 878)
+concurrency <1>: See 6. (line 701)
+concurrency <2>: See 4.4. (line 602)
+concurrency: See 4.1. (line 445)
+directory structure: See 2. (line 202)
+enum EXTRACTOR_MetaFormat: See 4.3. (line 541)
+enum EXTRACTOR_MetaType: See 4.2. (line 514)
+enum EXTRACTOR_Options: See 4.1. (line 445)
+environment variables: See 2. (line 202)
+error handling: See 1. (line 82)
+EXTRACTOR_common_convert_to_utf8: See 9. (line 878)
+EXTRACTOR_extract: See 4.4. (line 602)
+EXTRACTOR_meta_data_print: See 6.2. (line 718)
+EXTRACTOR_MetaDataProcessor: See 4.4. (line 569)
+EXTRACTOR_metatype_get_max: See 4.2. (line 514)
+EXTRACTOR_metatype_to_description: See 4.2. (line 530)
+EXTRACTOR_metatype_to_string: See 4.2. (line 522)
+EXTRACTOR_plugin_add: See 4.1. (line 490)
+EXTRACTOR_plugin_add_config: See 4.1. (line 500)
+EXTRACTOR_plugin_add_defaults: See 4.1. (line 507)
+EXTRACTOR_plugin_remove: See 4.1. (line 483)
+EXTRACTOR_plugin_remove_all: See 4.1. (line 479)
+EXTRACTOR_PluginList: See 4.1. (line 471)
+EXTRACTOR_VERSION: See 6.1. (line 707)
+gettext: See 4.2. (line 522)
+internationalization: See 4.2. (line 522)
+Java: See 5. (line 636)
+LIBEXTRACTOR_PREFIX: See 2. (line 202)
+license: See 1. (line 114)
+Mono: See 5. (line 636)
+packageing: See 2. (line 202)
+Perl: See 5. (line 636)
+PHP: See 5. (line 636)
+plugin <1>: See 2. (line 202)
+plugin: See 1. (line 94)
+Python: See 5. (line 636)
+reentrant <1>: See 6. (line 701)
+reentrant <2>: See 4.4. (line 602)
+reentrant: See 4.1. (line 445)
+Ruby: See 5. (line 636)
+SIGBUS: See 4.4. (line 615)
+struct EXTRACTOR_PluginList: See 4.1. (line 471)
+thread-safety <1>: See 6. (line 701)
+thread-safety <2>: See 4.4. (line 602)
+thread-safety: See 4.1. (line 445)
+threads <1>: See 6. (line 701)
+threads <2>: See 4.4. (line 602)
+threads: See 4.1. (line 445)
+UTF-8: See 9. (line 878)
Added: Extractor-docs/WWW/manual/libextractor.txt.gz
===================================================================
(Binary files differ)
Index: Extractor-docs/WWW/manual/libextractor.txt.gz
===================================================================
--- Extractor-docs/WWW/manual/libextractor.txt.gz 2012-09-25 14:37:40 UTC
(rev 23996)
+++ Extractor-docs/WWW/manual/libextractor.txt.gz 2012-09-25 14:47:07 UTC
(rev 23997)
Property changes on: Extractor-docs/WWW/manual/libextractor.txt.gz
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [GNUnet-SVN] r23997 - in Extractor-docs/WWW: man1 man3 manual manual/html_node,
gnunet <=