GNOME.org
 

[tracker] Updated man pages and added one for tracker-info

commit a417243ed0acfc734c966dd8bb7b68ffd8e02953
Author: Martyn Russell <martyn imendio com>
Date:   Wed Jul 8 18:07:34 2009 +0100

    Updated man pages and added one for tracker-info

 docs/manpages/Makefile.am       |    7 +++--
 docs/manpages/tracker-extract.1 |   40 ++++++++++++++++++++++++++++++---
 docs/manpages/tracker-import.1  |   31 ++++++++++++++++++++++++++
 docs/manpages/tracker-info.1    |   30 +++++++++++-------------
 docs/manpages/tracker-search.1  |   46 +++++++++++++++++----------------------
 docs/manpages/tracker-sparql.1  |   30 ++++++++++++++++++++-----
 docs/manpages/tracker-stats.1   |   25 ++++++++++++++------
 docs/manpages/tracker-status.1  |   10 ++++++--
 docs/manpages/tracker-tag.1     |   19 +++++-----------
 9 files changed, 159 insertions(+), 79 deletions(-)
---
diff --git a/docs/manpages/Makefile.am b/docs/manpages/Makefile.am
index 2dbe4dd..74aaffa 100644
--- a/docs/manpages/Makefile.am
+++ b/docs/manpages/Makefile.am
@@ -14,14 +14,15 @@ endif
 
 man_MANS = 			\
 	tracker-extract.1	\
+	tracker-import.1	\
+	tracker-info.1		\
 	tracker-search.1	\
+	tracker-sparql.1	\
 	tracker-stats.1		\
+	tracker-status.1	\
 	tracker-store.1		\
-	tracker-sparql.1	\
 	tracker-tag.1		\
-	tracker-status.1	\
 	tracker.cfg.5		\
-	tracker-info.1		\
 	$(tst)			\
 	$(ta)			\
 	$(tp)
diff --git a/docs/manpages/tracker-extract.1 b/docs/manpages/tracker-extract.1
index c68d072..49d7350 100644
--- a/docs/manpages/tracker-extract.1
+++ b/docs/manpages/tracker-extract.1
@@ -1,16 +1,45 @@
 .TH tracker-extract 1 "July 2007" GNU "User Commands"
 
 .SH NAME
-tracker-extract \- extract metadata from file and display them.
+tracker-extract \- Extract metadata from a file.
 
 .SH SYNOPSYS
-.B tracker-extract
+\fBtracker-extract\fR [\fIOPTIONS\fR] \fIFILE\fR...
 
 .SH DESCRIPTION
 .B tracker-extract
-read the file and mimetype provided in stdin and extract the metadata from this
+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 NOTE:
+If a \fIFILE\fR is not provided then 
+.B tracker-extract
+will run for 30 seconds waiting for DBus calls before quitting.
+
+.SH OPTIONS
+.TP
+.B \-?, \-\-help
+Show summary of options.
+.TP
+.B \-V, \-\-version
+Show binary version.
+.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 \-d, \-\-debug
+Enable debug mode which will provide more information about what is
+going on during the extraction.
+
 .SH EXAMPLES
 .TP
 Using tracker-extract from command line to extract metadata from one file:
@@ -18,4 +47,7 @@ Using tracker-extract from command line to extract metadata from one file:
 $ echo -e "/x/y/z.mp3\\naudio/mpeg" | tracker-extract
 
 .SH SEE ALSO
-.BR tracker-store (1)
+.BR tracker-store (1),
+.BR tracker-sparql (1),
+.BR tracker-stats (1),
+.BR tracker-info (1).
diff --git a/docs/manpages/tracker-import.1 b/docs/manpages/tracker-import.1
new file mode 100644
index 0000000..58dc2e5
--- /dev/null
+++ b/docs/manpages/tracker-import.1
@@ -0,0 +1,31 @@
+.TH tracker-import 1 "July 2009" GNU "User Commands"
+
+.SH NAME
+tracker-import \- Imports Turtle file data into the database
+
+.SH SYNOPSIS
+\fBtracker-import\fR 
+\fIFILE\fR
+
+.SH DESCRIPTION
+.B tracker-import
+allows data to be imported to the database by providing files with
+Turtle content.
+
+Multiple \fIFILE\fR arguments can be provided to import data from
+multiple files.
+
+The \fIFILE\fR argument can be either a local path or a URI. It also
+does not have to be an absolute path.
+
+.SH OPTIONS
+.TP
+.B \-?, \-\-help
+Show summary of options.
+
+.SH SEE ALSO
+.BR tracker-store (1),
+.BR tracker-sparql (1),
+.BR tracker-info (1).
+.TP
+.BR Turtle.
diff --git a/docs/manpages/tracker-info.1 b/docs/manpages/tracker-info.1
index 5709f00..684ec4f 100644
--- a/docs/manpages/tracker-info.1
+++ b/docs/manpages/tracker-info.1
@@ -1,33 +1,31 @@
 .TH tracker-info 1 "Oct 2008" GNU "User Commands"
 
 .SH NAME
-tracker-info \- command line tool to retrieve all metadata available
-in tracker for a certain file.
+tracker-info \- Retrieve all information available for a certain file.
 
 .SH SYNOPSIS
 \fBtracker-info\fR 
--s ServiceType \fIFILE\fR
+\fIFILE\fR
 
 .SH DESCRIPTION
 .B tracker-info
-asks tracker for all the known metadata available for the 
-\fIFILE\fR. The actual information is stored in the
-.B tracker
-database.
+asks for all the known metadata available for the given \fIFILE\fR.
+
+Multiple \fIFILE\fR arguments can be provided to retrieve information
+about multiple files.
+
+The \fIFILE\fR argument can be either a local path or a URI. It also
+does not have to be an absolute path.
 
 .SH OPTIONS
 .TP
 .B \-?, \-\-help
 Show summary of options.
-.TP
-.B \-s, \-\-service=SERVICE
-Look for the file in this service type. For more information on
-tracker services, see 
-.BR tracker-services (1)
 
 .SH SEE ALSO
 .BR tracker-store (1),
-.BR tracker-services (1).
-
-.SH AUTHOR
-tracker-info was written by Ivan Frade <ivan frade nokia com>.
+.BR tracker-sparql (1).
+.TP
+.BR Nepomuk
+.TP
+.BR http://www.w3.org/TR/rdf-sparql-query/
diff --git a/docs/manpages/tracker-search.1 b/docs/manpages/tracker-search.1
index 7157df5..c4108d2 100644
--- a/docs/manpages/tracker-search.1
+++ b/docs/manpages/tracker-search.1
@@ -1,43 +1,37 @@
-.TH tracker-search 1 "July 2007" GNU "User Commands"
+.TH tracker-search 1 "July 2009" GNU "User Commands"
 
 .SH NAME
-tracker-search \- command line tool to search documents indexed by
-tracker-store
+tracker-search \- Search all content for keywords
 
 .SH SYNOPSIS
-.B tracker-search
+.B tracker-search 
 [OPTIONS]
-.I EXPRESION
+.I EXPRESSION
 
 .SH DESCRIPTION
 .B tracker-search
-searches all by
-.BR tracker-store(1)
-indexed content for
-.I expression.
-.I Expression
-can be any number of words to be searched for.
+searches all indexed content for \fIEXPRESSION\fR.
+.TP
+\fIEXPRESSION\fR
+One or more terms to search. The default operation is a logical AND.
 
 .SH OPTIONS
 .TP
-\-?, --help
+\-?, \-\-help
 Give a short help message.
-
 .TP
-\fIEXPRESSION\fR
-One or more terms to search. The default operation is a logical AND.
-
+\-l, \-\-limit=N
+Limit search to N results. The default is 512.
 .TP
-\-l, --limit=N
-Limit search to N results.
-
+\-o, \-\-offset=N
+Offset the search results by N. For example, start at item number 10
+in the results. The default is 0.
 .TP
-\-s, --service=SERVICE
-Search by a specific service. For more information on tracker services,
-see
-.BR tracker-services (1).
+\-d, \-\-detailed
+Give more information in the search results.
 
-.SH "SEE ALSO"
+.SH SEE ALSO
 .BR tracker-store (1),
-.BR tracker-search-tool (1),
-.BR tracker-services (1).
+.BR tracker-stats (1),
+.BR tracker-tag (1),
+.BR tracker-info (1).
diff --git a/docs/manpages/tracker-sparql.1 b/docs/manpages/tracker-sparql.1
index f62db4c..9e2c6b3 100644
--- a/docs/manpages/tracker-sparql.1
+++ b/docs/manpages/tracker-sparql.1
@@ -3,14 +3,29 @@
 .SH NAME
 tracker-sparql \- Use SparQL to query the Tracker databases.
 
-.SH SYNOPSYS
-.B tracker-sparql [-p <path> | -q <query>]
+.SH SYNOPSIS
+\fBtracker-sparql\fR 
+[-p \fIFILE\fR | -q \fIQUERY\fR]
 
 .SH DESCRIPTION
 .B tracker-sparql
-Allows the caller to run an RDF SparQL query on the Tracker database.
-This can be done two ways. Either by providing a path to a file with
-the query or by providing a string with the query on the command line.
+allows the caller to run an RDF query on the database. This can be
+done two ways. Either by providing a \fIFILE\fR with the query or by
+providing a string with the \fIQUERY\fR string. 
+
+The \fIFILE\fR argument can be either a local path or a URI. It also
+does not have to be an absolute path. 
+
+.SH OPTIONS
+.TP
+.B \-?, \-\-help
+Show summary of options.
+.TP
+.B \-p, \-\-path=PATH
+Use a file with sparql content to query the Tracker database.
+.TP
+.B \-q, \-\-query=QUERY
+Use a query string with sparql content to query the Tracker database.
 
 .SH EXAMPLES
 .TP
@@ -119,6 +134,9 @@ $ tracker-sparql -q "SELECT ?image ?date WHERE {
 .FI
 
 .SH SEE ALSO
-.BR tracker-store (1)
+.BR tracker-store (1),
+.BR tracker-info (1).
+.TP
+.BR Nepomuk
 .TP
 .BR http://www.w3.org/TR/rdf-sparql-query/
diff --git a/docs/manpages/tracker-stats.1 b/docs/manpages/tracker-stats.1
index 716aa38..644a6d4 100644
--- a/docs/manpages/tracker-stats.1
+++ b/docs/manpages/tracker-stats.1
@@ -1,17 +1,21 @@
-.TH tracker-stats 1 "July 2007" GNU "User Commands"
+.TH tracker-stats 1 "July 2009" GNU "User Commands"
 
 .SH NAME
-tracker-stats\- command line tool that provides statistics on files
-indexed by
-.B tracker-store 
+tracker-stats \- Provides statistics on the data available for querying
 
 .SH SYNOPSIS
-.B tracker-stats [OPTIONS] 
+\fBtracker-stats\fR 
 
 .SH DESCRIPTION
 .B tracker-stats
-returns statistics on files indexed by tracker indexing daemon, ordered
-by service type.
+takes no arguments and returns statistics based on the ontology
+classes outlined in the 
+.B Nepomuk
+ontology specification. These classes can be used to further query
+more information using 
+.B SparQL
+with 
+.B tracker-sparql.
 
 .SH OPTIONS
 .TP
@@ -21,4 +25,9 @@ Show a brief help message.
 .SH SEE ALSO
 .BR tracker-store (1),
 .BR tracker-status (1),
-.BR tracker-services (7).
+.BR tracker-sparql (1),
+.BR tracker-info (1).
+.TP
+.BR Nepomuk.
+.TP
+.BR http://www.w3.org/TR/rdf-sparql-query/
diff --git a/docs/manpages/tracker-status.1 b/docs/manpages/tracker-status.1
index eea5e65..7288bb8 100644
--- a/docs/manpages/tracker-status.1
+++ b/docs/manpages/tracker-status.1
@@ -1,14 +1,18 @@
-.TH tracker-status 1 "July 2007" GNU "User Commands"
+.TH tracker-status 1 "July 2009" GNU "User Commands"
 
 .SH NAME
-tracker-status\- command line tool that reports the tracker-store status
+tracker-status \- Report the 
+.B tracker-store
+status
 
 .SH SYNOPSIS
 .B tracker-status
 
 .SH DESCRIPTION
 .B tracker-status
-Prints tracker-store's status. Which can be one of the following:
+shows the status of 
+.B tracker-store
+which can be one of the following:
 .PP
 Initializing, Watching, Indexing, Pending, Optimizing, Idle, Shutdown.
 
diff --git a/docs/manpages/tracker-tag.1 b/docs/manpages/tracker-tag.1
index 515858b..809fd37 100644
--- a/docs/manpages/tracker-tag.1
+++ b/docs/manpages/tracker-tag.1
@@ -1,17 +1,14 @@
 .TH tracker-tag 1 "July 2007" GNU "User Commands"
 
 .SH NAME
-tracker-tag \- command line tool for setting and searching tags/keywords
+tracker-tag \- Tool to get/set and search for tags and keywords
 
 .SH SYNOPSIS
-\fBtracker-tag\fR [\fIoptions\fR] \fIFILE\fR...
+\fBtracker-tag\fR [\fIOPTIONS\fR] \fIFILE\fR...
 
 .SH DESCRIPTION
 .B tracker-tag
-allows you to modify the tags that are associated with a file.
-The actual information is stored in a 
-.B tracker
-database.
+allows you to change and search for tags associated with a file.
 
 .SH OPTIONS
 .TP
@@ -36,10 +33,6 @@ If no file name is given, all known tags and their count is listed.
 Search for files matching the given tag.
 
 .SH SEE ALSO
-.BR tracker-store (1).
-
-.SH AUTHOR
-tracker-tag was written by Jamie McCracken <jamiemcc gnome org>.
-.PP
-This manual page was written by Michael Biebl <biebl debian org>,
-for the Debian project (but may be used by others).
+.BR tracker-store (1),
+.BR tracker-stats (1),
+.BR tracker-info (1).
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]