diff options
author | Sam Thursfield <sam@afuera.me.uk> | 2016-04-07 15:56:21 +0100 |
---|---|---|
committer | Sam Thursfield <sam@afuera.me.uk> | 2016-07-04 21:52:59 +0100 |
commit | e8882dc09703cc2c388b4d10f51c97d419e2f334 (patch) | |
tree | b04e7f2486918cc36a9dd2318a53fb8b314db2f8 | |
parent | 0470a96341d1b80baba56d187008e0830e211b9d (diff) | |
download | tracker-e8882dc09703cc2c388b4d10f51c97d419e2f334.tar.gz |
Rewrite tracker-extract man page
It now corresponds with the user-facing `tracker-extract` command,
rather than the hidden /usr/libexec/tracker-extract program.
-rw-r--r-- | 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 b17d6d6ff..652912c7e 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" .SH NAME tracker-extract \- Extract metadata from a file. .SH SYNOPSYS -\fBtracker-extract\fR [\fIOPTION\fR...] \fIFILE\fR... +\fBtracker extract\fR \fIFILE\fR .SH DESCRIPTION -.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. -.B NOTE: -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. -.SH OPTIONS -.TP -.B \-?, \-\-help -Show summary of options. -.TP -.B \-v, \-\-verbosity=N -Set verbosity to N. This overrides the config value. -Values include 0=errors, 1=minimal, 2=detailed and 3=debug. -.TP -.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. -.TP -.B \-m, \-\-mime=MIME -The \fIMIME\fR type to use for the file. If one is not provided, it -will be guessed automatically. -.TP -.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. -.TP -.B \-V, \-\-version -Show binary version. .SH EXAMPLES .TP Using command line to extract metadata from a file: -.BR -$ tracker-extract -v 3 -f /path/to/some/file.mp3 - -.TP -Using a specific module to extract metadata from a file: - -.BR -$ tracker-extract -v 3 -f /path/to/some/file.mp3 -m mymodule +.BR +$ tracker extract /path/to/some/file.mp3 .SH ENVIRONMENT .TP |