[tracker/wip/sam/resource: 11/18] Rewrite tracker-extract man page

commit 75e2105eaee0af4abbdd0d203fbab4240ca1ed4d
Author: Sam Thursfield <sam afuera me uk>
Date:   Thu Apr 7 15:56:21 2016 +0100

    Rewrite tracker-extract man page
    It now corresponds with the user-facing `tracker-extract` command,
    rather than the hidden /usr/libexec/tracker-extract program.

 docs/manpages/tracker-extract.1 |   61 +++++++-------------------------------
 1 files changed, 12 insertions(+), 49 deletions(-)
diff --git a/docs/manpages/tracker-extract.1 b/docs/manpages/tracker-extract.1
index b17d6d6..652912c 100644
--- a/docs/manpages/tracker-extract.1
+++ b/docs/manpages/tracker-extract.1
@@ -1,68 +1,31 @@
-.TH tracker-extract 1 "July 2007" GNU "User Commands"
+.TH tracker-extract 1 "April 2016" GNU "User Commands"
 tracker-extract \- Extract metadata from a file.
-\fBtracker-extract\fR [\fIOPTION\fR...] \fIFILE\fR...
+\fBtracker extract\fR \fIFILE\fR
-.B tracker-extract
-reads the file and mimetype provided in stdin and extract the metadata from this
-file; then it displays the metadata on the standard output.
+.B tracker extract
+reads the file provided and extracts any metadata it can from this
+file, then displays the metadata on standard output.
-If a \fIFILE\fR is not provided then
-.B tracker-extract
-will run for 30 seconds waiting for DBus calls before quitting.
+The metadata is displayed as a SPARQL update command, that can be run against
+a SPARQL endpoint to update its copy of the metadata.
-.B \-?, \-\-help
-Show summary of options.
-.B \-v, \-\-verbosity=N
-Set verbosity to N. This overrides the config value.
-Values include 0=errors, 1=minimal, 2=detailed and 3=debug.
-.B \-f, \-\-file=FILE
-The \fIFILE\fR to extract metadata from. The \fIFILE\fR argument can
-be either a local path or a URI. It also does not have to be an absolute path.
-.B \-m, \-\-mime=MIME
-The \fIMIME\fR type to use for the file. If one is not provided, it
-will be guessed automatically.
-.B \-m, \-\-force-module=MODULE
-Force a particular module to be used. This is here as a convenience
-for developers wanting to test their \fIMODULE\fR file. Only the
-\fIMODULE\fR name has to be specified, not the full path. Typically, a
-\fIMODULE\fR is installed to /usr/lib/tracker-0.7/extract-modules/.
-This option can be used with or without the .so part of the name too,
-for example, you can use
-.B --force-module=foo
+The actual extraction is done by a separate process. This is done to isolate
+the calling process from any memory leaks or crashes in the libraries Tracker
+uses to extract metadata.
-Modules are shared objects which are dynamically loaded at run time. These files
-must have the .so suffix to be loaded and must contain the correct
-symbols to be authenticated by
-.B tracker-extract.
 For more information see the libtracker-extract reference documentation.
-.B \-V, \-\-version
-Show binary version.
 Using command line to extract metadata from a file:
-$ tracker-extract -v 3 -f /path/to/some/file.mp3
-Using a specific module to extract metadata from a file:
-$ tracker-extract -v 3 -f /path/to/some/file.mp3 -m mymodule
+$ tracker extract /path/to/some/file.mp3

[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]