diff --git a/docs/Makefile.am b/docs/Makefile.am index c730e23..d15e45f 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -4,6 +4,6 @@ endif man_MANS = tracker-extract.1 tracker-files.1 tracker-meta-folder.1 tracker-query.1 tracker-search.1 tracker-stats.1 trackerd.1 \ - tracker-thumbnailer.1 tracker-tag.1 tracker-status.1 tracker.cfg.5 $(tst) + tracker-thumbnailer.1 tracker-tag.1 tracker-status.1 tracker.cfg.5 tracker-services.7 $(tst) EXTRA_DIST = $(man_MANS) diff --git a/docs/tracker-files.1 b/docs/tracker-files.1 index 2886ece..5f32b0a 100644 --- a/docs/tracker-files.1 +++ b/docs/tracker-files.1 @@ -10,19 +10,22 @@ tracker-files \- Return files filtered by the mime type or their category .SH DESCRIPTION .B tracker-files -returns files that match the ServiceType or the mime-type provided; you can +returns files that match the ServiceType or the mime-type provided; +you can .SH OPTIONS .TP \-s ServiceType -Specify the kind of the files you want to find; ServiceType can be Documents, Music, Images, Videos, -Text, Development or Other. +Specify the kind of the files you want to find. For more information on +valid ServiceType see +.BR tracker-services (7). .TP \-m MimeType Specify the mime-type of the files you want to find; see -http://www.iana.org/assignments/media-types/ for the complete list of existing -mime-type. +http://www.iana.org/assignments/media-types/ for the complete list of +existing mime-type. .SH SEE ALSO -.BR trackerd(1). +.BR trackerd (1), +.BR tracker-services (7). diff --git a/docs/tracker-query.1 b/docs/tracker-query.1 index 16a811f..b019b86 100644 --- a/docs/tracker-query.1 +++ b/docs/tracker-query.1 @@ -9,8 +9,8 @@ tracker-query \- command line tool to query tracker database .SH DESCRIPTION .B tracker-query -Exectutes an RDF query and prints the result. Additionally the behavior can -be customized using below described options. +Exectutes an RDF query and prints the result. Additionally the behavior +can be customized using below described options. .SH OPTIONS .TP @@ -19,9 +19,9 @@ Show a brief help message. .TP \-s, --service=ServiceName -Search for files from a specific service. ServiceName has to be one -of Documents, Emails, Attachments, Music, Images, Videos, Text or -Development. For more information on Services see tracker-search(1). +Search for files from a specific service. ServiceName has to be one of +trackers services. For mor information on services, see +.BR tracker-services (7). .TP \-t, --search-term=SerchTerm @@ -32,4 +32,5 @@ Adds a full text search filter to the query. Adds a keyword filter to the query. .SH "SEE ALSO" -trackerd (1). +.BR trackerd (1), +.BR tracker-services (7). diff --git a/docs/tracker-search-tool.1 b/docs/tracker-search-tool.1 index 1c4d6cd..3ebcb50 100644 --- a/docs/tracker-search-tool.1 +++ b/docs/tracker-search-tool.1 @@ -39,14 +39,17 @@ Show GNOME GUI options .SS "Application Options:" .TP \fB\-s\fR, \fB\-\-service\fR=\fISERVICE\fR -Search from a specific service. +Search from a specific service. See +.BR tracker-services (7) +for more information. .TP \fB\-\-display\fR=\fIDISPLAY\fR X display to use .SH SEE ALSO .BR tracker-search (1), -.BR trackerd (1). +.BR trackerd (1), +.BR tracker-services (7). .SH AUTHOR tracker-search-tool was written by Jamie McCracken . diff --git a/docs/tracker-search.1 b/docs/tracker-search.1 index 28f032a..79fe9d9 100644 --- a/docs/tracker-search.1 +++ b/docs/tracker-search.1 @@ -1,7 +1,8 @@ .TH tracker-search 1 "July 2007" GNU "User Commands" .SH NAME -tracker-search \- command line tool to search documents indexed by trackerd +tracker-search \- command line tool to search documents indexed by +trackerd .SH SYNOPSIS .B tracker-search @@ -28,38 +29,11 @@ Limit search to N results. .TP \-s, --service=SERVICE -Search by a specific service. trackerd(1) knows about the following -services: -.RS -.TP -Documents -Searches for general documents like word processing, -spreadsheets or text files. -.TP -Emails -Searches for Emails. -.TP -Attachments -Search es for Email attachments. -.TP -Music -Search for music files. -.TP -Images -Search for image files. -.TP -Videos -Search for video files. -.TP -Text -Search for text files, like word processing files, but e.g. not -spreadsheets. -.TP -Development -Search for development files. This includes make files, -source code files and the like. -.RE +Search by a specific service. For more information on tracker services, +see +.BR tracker-services (7). .SH "SEE ALSO" -.BR trackerd(1), -.BR tracker-search-tool(1). +.BR trackerd (1), +.BR tracker-search-tool (1), +.BR tracker-services (7). diff --git a/docs/tracker-services.7 b/docs/tracker-services.7 new file mode 100644 index 0000000..77d72b6 --- /dev/null +++ b/docs/tracker-services.7 @@ -0,0 +1,60 @@ +.TH tracker-services 7 "July 2007" GNU "Conventions" + +.SH NAME +tracker-services \- service types of trackerd + +.SH INTRODUCTION +Trackerd understands a number of different services which are used to +group search results and documents together. All searches and queries can +be refined by specifying a service to search from. +.PP +For example one could search for "Roses" in the service Conversations +which would only return hits from chat conversations. + +.SH SERVICE TYPES +.TP +Files +Search for files only. This does not include Emails or Conversations. +.TP +Folders +Search for folders i.e. directories. +.TP +Documents +Searches for general documents like word processing, +spreadsheets or text files. +.TP +Emails +Searches for Emails. +.TP +EmailAttachments +Search es for Email attachments. +.TP +Music +Search for music files. +.TP +Images +Search for image files. +.TP +Videos +Search for video files. +.TP +Text +Search for text files, like word processing files, but e.g. not +spreadsheets. +.TP +Development +Search for development files. This includes make files, +source code files and the like. +.TP +Other +Search for documents which could not be put in one of the other services. +.TP +Applications +Search for applications. + +.SH SEE ALSO +.BR trackerd (1), +.BR tracker-search (1), +.BR tracker-search-tool (1), +.BR tracker-query (1), +.BR tracker-files (1). diff --git a/docs/tracker-stats.1 b/docs/tracker-stats.1 index e1b5cab..63c21d8 100644 --- a/docs/tracker-stats.1 +++ b/docs/tracker-stats.1 @@ -20,4 +20,5 @@ Show a brief help message. .SH "SEE ALSO" .BR trackerd (1), -.BR tracker-status (1) +.BR tracker-status (1), +.BR tracker-services (7). diff --git a/docs/trackerd.1 b/docs/trackerd.1 index e9c1953..07559d1 100644 --- a/docs/trackerd.1 +++ b/docs/trackerd.1 @@ -94,4 +94,5 @@ to be running within your current session. .BR tracker-stats (1), .BR tracer-query (1), .BR tracker-meta-folder (1), -.BR tracker-files (1). +.BR tracker-files (1), +.BR tracker-services (7).