[tracker] Updated man pages for tracker-search and tracker-sparql



commit f652df16e7832d67df1973030fb151d7667109c4
Author: Martyn Russell <martyn lanedo com>
Date:   Tue Sep 8 11:12:53 2009 +0100

    Updated man pages for tracker-search and tracker-sparql

 docs/manpages/tracker-search.1 |   31 ++++++++++++++++++++++-
 docs/manpages/tracker-sparql.1 |   54 ++++++++++++++++++++++++++++++++++++---
 2 files changed, 79 insertions(+), 6 deletions(-)
---
diff --git a/docs/manpages/tracker-search.1 b/docs/manpages/tracker-search.1
index c4108d2..55f191a 100644
--- a/docs/manpages/tracker-search.1
+++ b/docs/manpages/tracker-search.1
@@ -14,6 +14,14 @@ searches all indexed content for \fIEXPRESSION\fR.
 .TP
 \fIEXPRESSION\fR
 One or more terms to search. The default operation is a logical AND.
+For logical OR operations, see -r.
+
+You can not use the search terms with: 
+.B \-\-files,
+.B \-\-music-albums,
+.B \-\-music-artists,
+.B \-\-music-files,
+.B \-\-image-files.
 
 .SH OPTIONS
 .TP
@@ -27,8 +35,29 @@ Limit search to N results. The default is 512.
 Offset the search results by N. For example, start at item number 10
 in the results. The default is 0.
 .TP
+\-r, \-\-or-operator
+Use OR for search terms instead of AND (the default)
+.TP
 \-d, \-\-detailed
-Give more information in the search results.
+Show more detailed results (only applies to general search)
+.TP
+\-f, \-\-files
+List all files in ascending order.
+.TP
+\-a, \-\-music-albums
+List all music albums. This also lists the song count and the sum of
+the duration of all songs associated with each album.
+.TP
+\-s, \-\-music-artists
+List all music artists.
+.TP
+\-u, \-\-music-files
+List all music files. Any file which qualifies as music is listed in
+ascending order. See --files. 
+.TP
+\-l, \-\-image-files
+List all image files. Any file which qualifies as an image is listed in
+ascending order. See --files. 
 
 .SH SEE ALSO
 .BR tracker-store (1),
diff --git a/docs/manpages/tracker-sparql.1 b/docs/manpages/tracker-sparql.1
index 7f966cc..d9c501a 100644
--- a/docs/manpages/tracker-sparql.1
+++ b/docs/manpages/tracker-sparql.1
@@ -21,11 +21,55 @@ does not have to be an absolute path.
 .B \-?, \-\-help
 Show summary of options.
 .TP
-.B \-p, \-\-path=PATH
-Use a file with sparql content to query the Tracker database.
+.B \-f, \-\-file=FILE
+Use a file with SPARQL content to query.
 .TP
-.B \-q, \-\-query=QUERY
-Use a query string with sparql content to query the Tracker database.
+.B \-q, \-\-query=SPARQL
+Use a SPARQL string to query the database with.
+.TP
+.B \-u, \-\-update=SPARQL
+Use a SPARQL string to update the database with.
+.TP
+.B \-c, \-\-list-classes
+Returns a list of classes which describe the ontology used for storing
+data. These classes are also used in queries. For example,
+.B http://www.w3.org/2000/01/rdf-schema#Resource
+is one of many classes which should be returned here.
+.TP
+.B \-x, \-\-list-class-prefixes
+Returns a list of classes and their related prefixes. Prefixes are
+used to make querying a lot simpler and are much like an alias. For
+example,
+.B http://www.w3.org/2000/01/rdf-schema#Resource
+has the prefix 
+.B rdfs
+so queries can be cut down to:
+
+"SELECT ?u WHERE { ?u a rdfs:Resource }"
+
+.TP
+.B \-p, \-\-list-properties=CLASS
+Returns a list of properties which pertain to a class. You can use
+both formats here for the class, either the full name
+.B http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Video
+or the shortened prefix name  
+.B nfo#Video.
+
+This gives the following result:
+
+.NF
+$ tracker-sparql -p nfo#Video
+
+Properties: 2
+  http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#frameRate
+  http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#frameCount
+.FI
+
+These properties
+.B nfo#frameRate
+and
+.B nfo#frameCount
+can be used in more complex queries (see --query).
 
 .SH EXAMPLES
 .TP
@@ -35,7 +79,7 @@ List all classes
 $ tracker-sparql -q "SELECT ?cl WHERE { ?cl a rdfs:Class }"
 
 .TP
-List all properties for the Resources class
+List all properties for the Resources class (see \-\-list-properties)
 
 .BR
 .NF



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