diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/extract.1 | 8 | ||||
-rw-r--r-- | doc/extractor.texi | 28 | ||||
-rw-r--r-- | doc/libextractor.3 | 6 |
3 files changed, 23 insertions, 19 deletions
diff --git a/doc/extract.1 b/doc/extract.1 index 500c061..db6374c 100644 --- a/doc/extract.1 +++ b/doc/extract.1 | |||
@@ -1,4 +1,4 @@ | |||
1 | .TH EXTRACT 1 "Aug 7, 2012" "libextractor 0.7.0" | 1 | .TH EXTRACT 1 "Aug 7, 2012" "libextractor 1.0.0" |
2 | .\" $Id | 2 | .\" $Id |
3 | .SH NAME | 3 | .SH NAME |
4 | extract | 4 | extract |
@@ -24,7 +24,7 @@ extract | |||
24 | \&... | 24 | \&... |
25 | .br | 25 | .br |
26 | .SH DESCRIPTION | 26 | .SH DESCRIPTION |
27 | This manual page documents version 0.7.0 of the | 27 | This manual page documents version 1.0.0 of the |
28 | .B extract | 28 | .B extract |
29 | command. | 29 | command. |
30 | .PP | 30 | .PP |
@@ -73,7 +73,7 @@ Be verbose. This option can be specified multiple times to increase verbosity f | |||
73 | .TP 8 | 73 | .TP 8 |
74 | .I \-x " type" | 74 | .I \-x " type" |
75 | Exclude keywords of the specified type from the output. By default, all keywords that are found and not removed as duplicates are printed. | 75 | Exclude keywords of the specified type from the output. By default, all keywords that are found and not removed as duplicates are printed. |
76 | .SH SEE ALSO | 76 | .SH "SEE ALSO" |
77 | .BR libextractor (3) | 77 | .BR libextractor (3) |
78 | \- description of the libextractor library | 78 | \- description of the libextractor library |
79 | .br | 79 | .br |
@@ -95,7 +95,7 @@ Keywords for file test/test.jpg: | |||
95 | Keywords for file test/test.png: | 95 | Keywords for file test/test.png: |
96 | comment \- Testing keyword extraction | 96 | comment \- Testing keyword extraction |
97 | 97 | ||
98 | .SH LEGAL NOTICE | 98 | .SH "LEGAL NOTICE" |
99 | libextractor and the extract tool are released under the GPL. libextractor is a GNU package. | 99 | libextractor and the extract tool are released under the GPL. libextractor is a GNU package. |
100 | 100 | ||
101 | .SH BUGS | 101 | .SH BUGS |
diff --git a/doc/extractor.texi b/doc/extractor.texi index 3074e68..e38dee1 100644 --- a/doc/extractor.texi +++ b/doc/extractor.texi | |||
@@ -405,9 +405,9 @@ roughly the following binary packages: | |||
405 | @item | 405 | @item |
406 | libextractor (main library only, only hard dependency for other packages depending on GNU libextractor) | 406 | libextractor (main library only, only hard dependency for other packages depending on GNU libextractor) |
407 | @item | 407 | @item |
408 | extract (command-line tool and man page) | 408 | extract (command-line tool and man page extract.1) |
409 | @item | 409 | @item |
410 | libextractor-dev (extractor.h header and man page) | 410 | libextractor-dev (extractor.h header and man page libextractor.3) |
411 | @item | 411 | @item |
412 | libextractor-doc (this manual) | 412 | libextractor-doc (this manual) |
413 | @item | 413 | @item |
@@ -415,13 +415,17 @@ libextractor-plugins (plugins without external dependencies; recommended but not | |||
415 | @item | 415 | @item |
416 | libextractor-plugin-XXX (plugin with dependency on libXXX, for example for XXX=mpeg this would be @file{libextractor_mpeg.so}) | 416 | libextractor-plugin-XXX (plugin with dependency on libXXX, for example for XXX=mpeg this would be @file{libextractor_mpeg.so}) |
417 | @item | 417 | @item |
418 | libextractor-plugins-all (meta package that requires all plugins) | 418 | libextractor-plugins-all (meta package that requires all plugins except experimental plugins) |
419 | @end itemize | 419 | @end itemize |
420 | 420 | ||
421 | This would enable minimal installations (i.e. for embedded systems) to | 421 | This would enable minimal installations (i.e. for embedded systems) to |
422 | not include any plugins, as well as moderate-size installations (that | 422 | not include any plugins, as well as moderate-size installations (that |
423 | do not trigger GTK, QT and X11) for systems that have limited | 423 | do not trigger GTK and X11) for systems that have limited resources. |
424 | resources. | 424 | Right now, the MP4 plugin is experimental and does nothing and should |
425 | thus never be included at all. The gstreamer plugin is experimental | ||
426 | but largely works with the correct version of gstreamer and can thus | ||
427 | be packaged (especially if the dependency is available on the target | ||
428 | system) but should probably not be part of libextractor-plugins-all. | ||
425 | 429 | ||
426 | 430 | ||
427 | @node Generalities | 431 | @node Generalities |
@@ -551,7 +555,7 @@ time is not safe. | |||
551 | 555 | ||
552 | All plugin code is expected required to be reentrant and state-less, | 556 | All plugin code is expected required to be reentrant and state-less, |
553 | but due to the extensive use of 3rd party libraries this cannot | 557 | but due to the extensive use of 3rd party libraries this cannot |
554 | be guaranteed. | 558 | be guaranteed. |
555 | 559 | ||
556 | 560 | ||
557 | @deftp {C Struct} EXTRACTOR_PluginList | 561 | @deftp {C Struct} EXTRACTOR_PluginList |
@@ -798,19 +802,19 @@ ARCHIVE (using libarchive) | |||
798 | @item | 802 | @item |
799 | DVI | 803 | DVI |
800 | @item | 804 | @item |
801 | EXIV2 (using libexiv2) | 805 | EXIV2 (using libexiv2, 0.23 or later preferred) |
802 | @item | 806 | @item |
803 | FLAC (using libFLAC) | 807 | FLAC (using libFLAC) |
804 | @item | 808 | @item |
805 | GIF (using libgif) | 809 | GIF (using libgif) |
806 | @item | 810 | @item |
807 | GSTREAMER (using libgstreamer) | 811 | GSTREAMER (using libgstreamer v1.0 or later) |
808 | @item | 812 | @item |
809 | HTML (using libtidy) | 813 | HTML (using libtidy) |
810 | @item | 814 | @item |
811 | IT | 815 | IT |
812 | @item | 816 | @item |
813 | JPEG (using libjpeg) | 817 | JPEG (using libjpeg v8 or later) |
814 | @item | 818 | @item |
815 | MAN | 819 | MAN |
816 | @item | 820 | @item |
@@ -842,11 +846,11 @@ S3M | |||
842 | @item | 846 | @item |
843 | SID | 847 | SID |
844 | @item | 848 | @item |
845 | ThumbnailFFMPEG (using libavformat) | 849 | ThumbnailFFMPEG (using libavformat and related libav-libraries, including libswscale) |
846 | @item | 850 | @item |
847 | ThumbnailGtk (using libgtk) | 851 | ThumbnailGtk (using libgtk) |
848 | @item | 852 | @item |
849 | TIFF (with libtiff) | 853 | TIFF (with libtiff, tested with v4) |
850 | @item | 854 | @item |
851 | WAV | 855 | WAV |
852 | @item | 856 | @item |
@@ -986,7 +990,7 @@ caller, so storing the string in the keyword list is acceptable. | |||
986 | @chapter Reporting bugs | 990 | @chapter Reporting bugs |
987 | 991 | ||
988 | @cindex bug | 992 | @cindex bug |
989 | @gnule{} uses the @url{http://gnunet.org/bugs/,Mantis bugtracking | 993 | @gnule{} uses the @url{https://gnunet.org/bugs/,Mantis bugtracking |
990 | system}. If possible, please report bugs there. You can also e-mail | 994 | system}. If possible, please report bugs there. You can also e-mail |
991 | the @gnule{} mailinglist at @url{libextractor@@gnu.org}. | 995 | the @gnule{} mailinglist at @url{libextractor@@gnu.org}. |
992 | 996 | ||
diff --git a/doc/libextractor.3 b/doc/libextractor.3 index 0cc8ad3..7c7c004 100644 --- a/doc/libextractor.3 +++ b/doc/libextractor.3 | |||
@@ -1,6 +1,6 @@ | |||
1 | .TH LIBEXTRACTOR 3 "Aug 8, 2012" "libextractor 0.7.0" | 1 | .TH LIBEXTRACTOR 3 "Sept 4, 2012" "GNU libextractor 1.0.0" |
2 | .SH NAME | 2 | .SH NAME |
3 | libextractor \- meta\-information extraction library 0.7.0 | 3 | GNU libextractor \- meta\-information extraction library 1.0.0 |
4 | .SH SYNOPSIS | 4 | .SH SYNOPSIS |
5 | 5 | ||
6 | \fB#include <extractor.h> | 6 | \fB#include <extractor.h> |
@@ -48,7 +48,7 @@ Textual meta data obtained from libextractor is supposed to be UTF-8 encoded if | |||
48 | .SH "SEE ALSO" | 48 | .SH "SEE ALSO" |
49 | extract(1) | 49 | extract(1) |
50 | 50 | ||
51 | .SH LEGAL NOTICE | 51 | .SH "LEGAL NOTICE" |
52 | libextractor is released under the GPL and a GNU package (http://www.gnu.org/). | 52 | libextractor is released under the GPL and a GNU package (http://www.gnu.org/). |
53 | 53 | ||
54 | .SH BUGS | 54 | .SH BUGS |