diff --git a/docs/Makefile.am b/docs/Makefile.am index d865af0..c730e23 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 $(tst) + tracker-thumbnailer.1 tracker-tag.1 tracker-status.1 tracker.cfg.5 $(tst) EXTRA_DIST = $(man_MANS) diff --git a/docs/tracker-extract.1 b/docs/tracker-extract.1 index fb1bd76..aef39f1 100644 --- a/docs/tracker-extract.1 +++ b/docs/tracker-extract.1 @@ -1,12 +1,16 @@ -.TH tracker-extract 1 "September 2006" "Version 0.5" +.TH tracker-extract 1 "July 2007" GNU "User Commands" + .SH NAME tracker-extract \- extract metadata from file and display them. + .SH SYNOPSYS .B tracker-extract .I file + .SH DESCRIPTION .B tracker-extract -read the file provided in paramater and extract the metadata -from this file; then it displays the metadata on the standard output. -.SH AUTHOR -Baptiste Mille-Mathias +read the file provided in paramater and extract the metadata from this +file; then it displays the metadata on the standard output. + +.SH SEE ALSO +.BR trackerd (1) diff --git a/docs/tracker-files.1 b/docs/tracker-files.1 index 778ac16..2886ece 100644 --- a/docs/tracker-files.1 +++ b/docs/tracker-files.1 @@ -1,22 +1,28 @@ -.TH tracker-files 1 "September 2006" "Version 0.5" +.TH tracker-files 1 "July 2007" GNU "User Commands" + .SH NAME tracker-files \- Return files filtered by the mime type or their category (called ServiceType) + .SH SYNOPSIS .B tracker-files -[-s ServiceType|-m Mime-Type] [search] +[-s ServiceType|-m MimeType] + .SH DESCRIPTION .B tracker-files 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. + .TP -\-m Mime-Type +\-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. -.SH AUTHOR -Baptiste Mille-Mathias + +.SH SEE ALSO +.BR trackerd(1). diff --git a/docs/tracker-meta-folder.1 b/docs/tracker-meta-folder.1 index 599f53e..168015b 100644 --- a/docs/tracker-meta-folder.1 +++ b/docs/tracker-meta-folder.1 @@ -1,12 +1,15 @@ -.TH tracker-meta-folder 1 "September 2006" "Version 0.5" +.TH tracker-meta-folder 1 "July, 2007" GNU "User Commands" + .SH NAME tracker-meta-folder \- return list of files indexed by tracker for a folder + .SH SYNOPSIS .B tracker-meta-folder folder + .SH DESCRIPTION .B tracker-meta-folder returns the list of files indexed by tracker and stored under the folder provided as parameter. -.SH AUTHOR -Baptiste Mille-Mathias +.SH SEE ALSO +.BR trackerd(1). diff --git a/docs/tracker-query.1 b/docs/tracker-query.1 index 87ed9ba..9cd5c97 100644 --- a/docs/tracker-query.1 +++ b/docs/tracker-query.1 @@ -1,14 +1,35 @@ -.TH tracker-query 1 "September 2006" "Version 0.5" +.TH tracker-query 1 "July 2007" GNU "User Commands" + .SH NAME tracker-query \- command line tool to query tracker database + .SH SYNOPSIS .B tracker-query -.I query-file.rdf +.I [OPTIONS] query-file.rdf [MetaDataFields...] + .SH DESCRIPTION .B tracker-query -searches documents using a query file (in rdf format) provided as parameter, and -returns the documents matching the criteria of the query file. -.SH AUTHOR -Baptiste Mille-Mathias +Exectutes an RDF query and prints the result. Additionally the behavior can +be customized using below described options. + +.SH OPTIONS +.TP +\-?, --help +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 inforation +on Services see tracker-search(1). + +.TP +\-t, --search-term=SerchTerm +Adds a fulltext search filter to the query. + +.TP +\-k, --keyword=Keyword +Adds a keyword filter to the query. + .SH "SEE ALSO" -trackerd (1) +trackerd (1). diff --git a/docs/tracker-search-tool.1 b/docs/tracker-search-tool.1 index 21df8ea..145157d 100644 --- a/docs/tracker-search-tool.1 +++ b/docs/tracker-search-tool.1 @@ -1,4 +1,4 @@ -.TH TRACKER-SEARCH-TOOL 1 "Januar 10, 2007" +.TH tracker-search-tool 1 "July, 2007" GNU "User Commands" .SH NAME tracker-search-tool \- Gnome Tracker Search Tool @@ -44,7 +44,6 @@ Search from a specific service. \fB\-\-display\fR=\fIDISPLAY\fR X display to use - .SH SEE ALSO .BR tracker-search (1), .BR trackerd (1). diff --git a/docs/tracker-search.1 b/docs/tracker-search.1 index 90a5b70..6e712bd 100644 --- a/docs/tracker-search.1 +++ b/docs/tracker-search.1 @@ -1,17 +1,65 @@ -.TH tracker-search 1 "September 2006" "Version 0.5" +.TH tracker-search 1 "July 2007" GNU "User Commands" + .SH NAME tracker-search \- command line tool to search documents indexed by trackerd + .SH SYNOPSIS .B tracker-search +[OPTIONS] .I expression + .SH DESCRIPTION .B tracker-search -searches the expression provided as parameter in the list of documents indexed -by -.BR trackerd (1) -, and return the list of documents which contain it. The expression will be -searched in the content of the documents and also in their metadata. -.SH AUTHOR -Baptiste Mille-Mathias +searches all by +.BR trackerd(1) +indexed content for +.I expression. +.I Expression +can be any number of words to be searched for. + +.SH OPTIONS +.TP +\-?, --help +Give a short help message. + +.TP +\-l, --limit=N +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 textfiles, 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 + .SH "SEE ALSO" -trackerd (1) +.BR trackerd(1), +.BR tracker-search-tool(1). diff --git a/docs/tracker-stats.1 b/docs/tracker-stats.1 index b90f6ea..e1b5cab 100644 --- a/docs/tracker-stats.1 +++ b/docs/tracker-stats.1 @@ -1,15 +1,23 @@ -.TH tracker-stats 1 "September 2006" "Version 0.5" +.TH tracker-stats 1 "July 2007" GNU "User Commands" + .SH NAME -tracker-stats \- command line tool that provides statistics on files -indexed by +tracker-stats\- command line tool that provides statistics on files +indexed by .B trackerd + .SH SYNOPSIS -.B tracker-stats +.B tracker-stats [OPTIONS] + .SH DESCRIPTION .B tracker-stats -returns statistics on files indexed by tracker indexing daemoni, order by -services. -.SH AUTHOR -Baptiste Mille-Mathias +returns statistics on files indexed by tracker indexing daemon, ordered +by service type. + +.SH OPTIONS +.TP +\-?, --help +Show a brief help message. + .SH "SEE ALSO" -trackerd (1) +.BR trackerd (1), +.BR tracker-status (1) diff --git a/docs/tracker-status.1 b/docs/tracker-status.1 new file mode 100644 index 0000000..2993e86 --- /dev/null +++ b/docs/tracker-status.1 @@ -0,0 +1,17 @@ +.TH tracker-status 1 "July 2007" GNU "User Commands" + +.SH NAME +tracker-status\- command line tool that reports the trackerd status + +.SH SYNOPSIS +.B tracker-status + +.SH DESCRIPTION +.B tracker-status +Prints trackerd's status. Which can be one of the following: +.PP +Initializing, Watching, Indexing, Pending, Optimizing, Idle, Shutdown. + +.SH SEE ALSO +.BR trackerd (1), +.BR tracker-stats (1) diff --git a/docs/tracker-tag.1 b/docs/tracker-tag.1 index 624f8b3..6665354 100644 --- a/docs/tracker-tag.1 +++ b/docs/tracker-tag.1 @@ -1,4 +1,4 @@ -.TH TRACKER-TAG 1 "Januar 10, 2007" +.TH tracker-tag 1 "July, 2007" GNU "User Commands" .SH NAME tracker-tag \- command line tool for setting and searching tags/keywords diff --git a/docs/tracker-thumbnailer.1 b/docs/tracker-thumbnailer.1 index 8081d55..7b20719 100644 --- a/docs/tracker-thumbnailer.1 +++ b/docs/tracker-thumbnailer.1 @@ -1,4 +1,4 @@ -.TH TRACKER-THUMBNAILER 1 "Januar 10, 2007" +.TH tracker-thumbnailer 1 "July, 2007" GNU "User Commands" .SH NAME tracker-thumbnailer \- create freedesktop.org compliant thumbnails @@ -10,7 +10,7 @@ tracker-thumbnailer \- create freedesktop.org compliant thumbnails .B tracker-thumbnailer takes an image file as input and produces a thumbnail which is compliant to the freedesktop.org thumbnail specification. -.br +.BR It relies on external tools like \fBconvert\fR to do the actual transformation. .PP @@ -37,6 +37,7 @@ Currently supported is only \fBnormal\fR, which is 128x128 pixel. .SH SEE ALSO .BR trackerd (1), +.BR tracker-search (1), .BR tracker-search-tool (1), .BR convert (1). diff --git a/docs/tracker.cfg.5 b/docs/tracker.cfg.5 new file mode 100644 index 0000000..29995bb --- /dev/null +++ b/docs/tracker.cfg.5 @@ -0,0 +1,190 @@ +.TH tracker.cfg 5 "July 2007" GNU "Configuration Files" + +.SH NAME +tracker.cfg \- configuration file for the trackerd search daemon + +.SH DESCRIPTION +The tracker.cfg file resides in the $HOME/.config/tracker directory. +.PP +The file is organized in sections, each section having a number of +related options. +.SS Comments +Empty lines and those starting with ; or # are ignored. +.SS value tyopes +.TP +VALUE +Denotes a positive integer. +.TP +BOOLEAN +Denotes either true or false. +.TP +Any other value +Any special keyword is to be replaced by one of the documented valid +values, e.g. pathnames or language codes. + +.SH EXAMPLE +.PP +[General] +.PP +Verbosity=0 +.PP +InitialSleep=50 + +.SH Sections +.SS General +This section may contain general settings for trackerd. +.TP +Verbosity=VALUE +Specifies how verbose trackerd should be logging. VALUE can be one of +0 through 3. +.RS +.TP +0 +Show no but error and critical output, this is the default behavior. +.TP +1 +Show minimal output, i.e. not just errors. +.TP +2 +Show verbose output. +.TP +3 +Show debugging output, enable this only if you know what you are doing. +.RE +.TP +LowMemoryMode=BOOLEAN +Enables low memorry mode. Tracker may be slightly less fast at +indexing/search but also needs less system memory. +.TP +InitialSleep=VALUE +Sets the initial sleep time for trackerd. This is a number of seconds +that trackerd wait before indexing. + +.SS Watches +.TP +WatchDirectoryRoots=DIRECTORY[;MORE;DIRECTORIES] +Sets the directories trackerd should watch and index. Defaults to the +users home directory. +.TP +NoWatchDirectory=DIRECTORY[;MORE;DIRECTORIES] +Sets directories trackerd should ignore, i.e. not index or watch. +.TP +EnableWatching=BOOLEAN +Enables or disables watching of directories, i.e. re-index files when +they change. + +.SS Indexing +This section may contain indexing related options. +.TP +Throttle=VALUE +Sets the throttling value for the Indexer. VALUE can be any number from +0 to 20 whereas higher values decrease indexing speed. +.TP +EnableIndexing=BOOLEAN +Enable or disable the indexer. +.TP +EnableFileContentIndexing=BOOLEAN +Enable or disable indexing of files text contents. +.TP +EnableThumbnails=BOOLEAN +Enable or disable the generation of thumbnails. +.TP +NoIndexFileTypes=FILEGLOB[;MORE;FILEGLOBS...] +List of partial file patterns (glob) separated by semicolons that specify +files not to index. Only basic metadata (i.e. information retrieved by +stat(2)) is indexed. +.TP +MinWordLength=VALUE +Sets the minimum word length to index. Words having less then VALUE +characters will not be indexed. +.TP +MaxWordLength=VALUE +Sets the maximum word length to index. Words having more then VALUE +characters will not be indexed. +.TP +Language=LANGCODE +Sets the language specific stemmer and stopword list to use. Valid +values are: +.RS +.TP +en +English +.TP +da +Danish +.TP +nl +dutch +.TP +fi +Finnish +.TP +fr +French +.TP +de +German +.TP +it +Italian +.TP +nb +Norwegian +.TP +pt +Portugese +.TP +ru +Russian +.TP +es +Spanish +.TP +sv +Swedish +.RE +.TP +EnableStemmer=BOOLEAN +Enable or disable the stemmer. + +.SS Emails +This section may contain Email specific options. +.TP +IndexEvolutionEmails=BOOLEAN +Enable or disable indexing or Evolution emails. + +.SS Performance +Trackerd performance related options. +.TP +MaxTextToIndex=VALUE +Maximum size of text in bytes to index from a file's text contents. +Defaults to 1048576. +.TP +MaxWordsToIndex=VALUE +Maximum number of unique words to index from a file's text contents. +Defaults to 10000. +.TP +OptimizationSweepCount=VALUE +Specifies the no of entities to index before determining whether to +perform index optimization. Default to 10000. +.TP +MaxBucketCount=VALUE +Sets the maximum bucket count for the indexer. Defaults to 524288. +.TP +MinBucketCount=VALUE +Sets the minimum bucket count. Defaults to 65536 +.TP +Divisions=VALUE +Sets no. of divisions of the index file. Default to 4. +.TP +BucketRatio=VALUE +Selects the desired ratio of used records to buckets to be used when +optimizing index (should be a value between 0 and 4). Defaults to 1. +.TP +Padding=VALUE +Alters how much padding is used to prevent index relocations. Higher +values improve indexing speed but waste more disk space. Value should +be in range (1..8). Defaults to 2. + +.SH SEE ALSO +.BR tracker(1) diff --git a/docs/trackerd.1 b/docs/trackerd.1 index 816a86d..e2407c2 100644 --- a/docs/trackerd.1 +++ b/docs/trackerd.1 @@ -1,47 +1,97 @@ -.TH trackerd 1 "September 2006" "Version 0.5" +.TH trackerd 1 "July 2007" GNU "User Commands" + .SH NAME trackerd \- indexer daemon for tracker search tool + .SH SYNOPSIS .B trackerd [OPTIONS] + .SH DESCRIPTION -.B trackerd -porvides both a powerful indexer and an extensible metadata database. It indexes files including the text contents and any available metadata to provide -fast search services. By default, trackerd will index all files in a users home directory (with -the exception of hidden files). This can be overriden by specifying one or -more directories to be indexed instead in the config file -($HOME/.Tracker/tracker.cfg) and/or by using the --include-dir param to specify -other directories to be indexed. +.B Trackerd +provides both a powerful indexer and an extensible metadata database. It +indexes files including the text contents and any available metadata to +provide fast search services. +.PP +By default, trackerd will index all files in a user's home directory (with +the exception of hidden files). This can be overridden by specifying +one or more directories to be indexed instead in the configuration file +($HOME/.config/tracker/tracker.cfg) and/or by using the --include-dir +option to specify other directories to be indexed. + .SH OPTIONS .TP +\-?, --help +A brief help message including some examples. + +.TP \-e, --exclude-dir=/PATH/DIR -Specifies directories to be excluded from indexing +Specifies a directory to be excluded from indexing (including all +subdirectories). Can be repeated to exclude more than one directory. + .TP \-i, --include-dir=/PATH/DIR -Specifies directories to be included for indexing. All non-hidden sub directories of the specified directory will also be indexed. If this param is set then the user's home directory is no longer indexed by default (you can still add the home directory to this param) +Specifies a directory to be included for indexing. All non-hidden +subdirectories of the specified directory will also be indexed. If this +param is set then the user's home directory is no longer indexed by +default (you can still add the home directory with this option). + .TP -\--no-indexing -Disables indexing of any files +\-n, --no-indexing +Prevent .B trackerd from indexing and watching. Searching is still +possible. + .TP -\--verbosity=value -Value that controls the level of logging to both the log file and to stdout. Valid values are 0 (default minimal), 1 (detailed) and 2 (debug) +\-v, --verbosity=value +Makes trackerd log/print more information. Value can be one of 0 - show +only errors, 1 - show only minimal output, 2 - show detailed output and +3 - show debug output (don't do this, unless you know what you are doing). .TP -\--throttle=value -Value to use for throttling indexing. Value must be in range 0-20 (default 0) with lower values increasing indexing speed +\-t, --throttle=value +Value to throttle indexing. Value must be in range 0-20 (default 0) +with lower values increasing indexing speed. .TP \-m, --low-memory - Minimises the use of memory but may slow indexing down +Minimise memory usage. Note that this may slow down indexing. + +.TP +\-s, --initial-sleep=value +Set the initial sleep time in seconds. This is the time .B trackerd +waits at startup before indexing. + .TP \-l, --language=value - Language to use for stemmer and stop words list (ISO 639-1 2 characters code) +Language to use for stemmer and stop words list (ISO 639-1 2 characters +code). + +.TP +\-R, --reindex +This forces trackerd to reindex all watched files and directories. +Since every watched directory and any previously indexed file has to be +read and processed again, this may degrade the whole system performance, +see also --throttle. .SH FILES -.I $HOME/.Tracker/tracker.cfg +.I $HOME/.config/tracker/tracker.cfg .RS Trackerd user configuration file. See -.BR tracker.cfg(5) +.BR tracker.cfg (5) +and +.BR tracker-preferences (1) for further details. -.SH AUTHOR -Baptiste Mille-Mathias -Jamie McCracken + +.SH NOTES +.B Trackerd +needs a +.BR dbus-daemon(1) +to be running within your current session. + +.SH SEE ALSO +.BR tracker-search-tool (1), +.BR tracker-search (1), +.BR tracker-tag (1), +.BR tracker-stats (1), +.BR tracer-query (1), +.BR tracker-meta-folder (1), +.BR tracker-files (1).