diff options
author | Martyn Russell <martyn@lanedo.com> | 2014-10-02 18:47:33 +0100 |
---|---|---|
committer | Martyn Russell <martyn@lanedo.com> | 2014-12-10 15:51:35 +0000 |
commit | 9e742515f1e4f0f38d6120b87ec8ecc9f4835743 (patch) | |
tree | f1302ac271adbbf9fd40c476c8dca27d4259fb74 /docs/manpages | |
parent | a750d053f8a633b2ff31017cd3850aa064151e73 (diff) | |
download | tracker-9e742515f1e4f0f38d6120b87ec8ecc9f4835743.tar.gz |
tracker: Merged all external commands into 'tracker'
Diffstat (limited to 'docs/manpages')
-rw-r--r-- | docs/manpages/Makefile.am | 3 | ||||
-rw-r--r-- | docs/manpages/tracker-daemon.1 | 266 | ||||
-rw-r--r-- | docs/manpages/tracker-import.1 | 34 | ||||
-rw-r--r-- | docs/manpages/tracker-index.1 | 63 | ||||
-rw-r--r-- | docs/manpages/tracker-info.1 | 30 | ||||
-rw-r--r-- | docs/manpages/tracker-reset.1 | 45 | ||||
-rw-r--r-- | docs/manpages/tracker-search.1 | 129 | ||||
-rw-r--r-- | docs/manpages/tracker-sparql.1 | 142 | ||||
-rw-r--r-- | docs/manpages/tracker-stats.1 | 48 | ||||
-rw-r--r-- | docs/manpages/tracker-status.1 | 64 | ||||
-rw-r--r-- | docs/manpages/tracker-tag.1 | 52 |
11 files changed, 475 insertions, 401 deletions
diff --git a/docs/manpages/Makefile.am b/docs/manpages/Makefile.am index 549546bf3..e8006a63c 100644 --- a/docs/manpages/Makefile.am +++ b/docs/manpages/Makefile.am @@ -4,13 +4,12 @@ tmrss = tracker-miner-rss.1 common = \ tracker-extract.1 \ - tracker-import.1 \ tracker-info.1 \ tracker-miner-fs.1 \ tracker-daemon.1 \ tracker-search.1 \ tracker-sparql.1 \ - tracker-stats.1 \ + tracker-status.1 \ tracker-store.1 \ tracker-tag.1 \ tracker-reset.1 \ diff --git a/docs/manpages/tracker-daemon.1 b/docs/manpages/tracker-daemon.1 index 300f4e4ec..794fbc1c5 100644 --- a/docs/manpages/tracker-daemon.1 +++ b/docs/manpages/tracker-daemon.1 @@ -4,27 +4,38 @@ tracker-daemon \- Start, stop, restart and list daemons responsible for indexing content .SH SYNOPSIS -\fBtracker daemon\fR [\fIOPTION\fR...] +.nf +\fBtracker daemon\fR [\fIoptions\fR...] +\fBtracker daemon\fR \-s | \-t [\fIdaemons\fR] | \-k [\fIdaemons\fR] | \-l +\fBtracker daemon\fR \-f | \-w [\fIontology\fR] +\fBtracker daemon\fR \-\-miner <\fIminer\fR> \-\-pause[-for-process] <\fIreason\fR> +\fBtracker daemon\fR \-\-miner <\fIminer\fR> \-\-resume <\fIcookie\fR> + +.fi .SH DESCRIPTION -.B Manages and checks status of all Tracker processes and data. +Tracker has many components to it including a "store" for handling data +set updates and "miners" for handling data mining in their respective +areas. + +The \fBtracker daemon\fR command allows for control of these components. +This ranges from starting, stopping and killing processes to pausing +and resuming them. -Controls Tracker both at process level, and at entity level (store, miners). +In addition to all this, there are ways to change the log verbsity for +all processes that generate logs and to follow or watch what is +happening in real time from a top level and right down where the +SPARQL commits are happening too. -To start or stop miners, you can use -.B \-\-start. -The store is started automatically by the D-Bus calls from the miners. +If no arguments are provided this command will show the current status +of all Tracker entities (store and all available data miners). -It also allows checking the status of the Tracker store and all data miners. -For -.B tracker-store -, the status is always -.B Idle -unless it is restoring a backup and/or replaying a journal (regardless of -load from applications or miners). For a list of common statuses, see -.B \-\-list\-common\-statuses. +For \fBtracker-store\fR, the status is always "Idle" unless it is +restoring a backup and/or replaying a journal (see also \fBtracker reset +--soft\fR). For a list of common statuses, see +\fB\-\-list\-common\-statuses\fR. -The miners can be paused or resumed using this command and you can +The data miners can be paused or resumed using this command and you can also list miners running and available. .SH OPTIONS @@ -32,76 +43,131 @@ also list miners running and available. .B \-p, \-\-list\-processes This lists all Tracker processes in the system. .TP -.B \-k, \-\-kill=[all|store|miners] +.B \-k, \-\-kill\fR=[\fIdaemons\fR] This uses SIGKILL to stop all Tracker processes found matching the -parameter, if no extra parameter is passed, -.B all -will be assumed. This is not advised unless you are having problems -stopping Tracker in the first place. This -.B GUARANTEES -death. -.TP -.B \-t, \-\-terminate=[all|store|miners] +parameter, if no extra parameter is passed, "all" will be assumed. +This is not advised unless you are having problems stopping Tracker in +the first place. This \fBGUARANTEES\fR death. + +The possible \fIdaemons\fR options are: +.sp +.RS 12 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIall\fR +\- All daemons. +.sp +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.IP \(bu 2.3 +.\} +\fIstore\fR +\- Only the \fBtracker-store\fR. +.sp +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIminers\fR +\- Only data miners. +.sp +.RE + +.TP +.B \-t, \-\-terminate\fR=[daemons] This uses SIGTERM to stop all Tracker processes found matching the -parameter, if no extra parameter is passed, -.B all -will be assumed. This is recommended over \-\-kill because it gives -the processes time to shutdown cleanly. +parameter, if no extra parameter is passed, "all" will be assumed. +This is recommended over \-\-kill because it gives the processes time +to shutdown cleanly. + +For a list of possible \fIdaemons\fR, see \-\-kill. .TP .B \-s, \-\-start -Starts all miners. This indirectly starts tracker-store too because it -is needed for miners to operate properly. -.TP -.B \-b, \-\-backup=FILE -Begins backing up the Tracker databases to the -.B FILE -given. -.TP -.B \-o, \-\-restore=FILE -Begins restoring a previous backup (see -.B \-\-backup -) to the Tracker databases. The -.B FILE -points to the location of the backup. -.TP -.B \-\-get-log-verbosity +Starts all miners. This indirectly starts \fBtracker-store\fR too +because it is needed for miners to operate properly. The store is +started from D-Bus. +.TP +.B \-\-get\-log\-verbosity This displays the log verbosity for ALL components using GSettings for this configuration. For possible values, see -.B \-\-set-log-verbosity. -.TP -.B \-\-set-log-verbosity=[debug|detailed|minimal|errors] -This sets the log verbosity for ALL components using GSettings using -this configuration option ('verbosity'). -.TP -.B \-\-collect-debug-info -Useful when debugging problems to diagnose the state of Tracker on -your system. The data is output to stdout. Useful if bugs are filed -against the project itself. - -Data collected includes Tracker version in use, disk space available, -size of the databases on the disk, the configuration in use, states of -the index (e.g. last filesystem crawl, data set locale, etc.) and -finally statistics about the data in the database (e.g. how many -nfo:FileDataObject resources exist). -.TP -.B \-S, \-\-status -Show the current status of all Tracker entities (store and all available -miners). -.TP -.B \-F, \-\-follow -Follow status changes as they happen. This requires Ctrl+C to stop and -return to the command line. Each new status is put on a new line. -.TP -.B \-w, \-\-watch=[ONTOLOGY] +.B \-\-set\-log\-verbosity. +.TP +.B \-\-set\-log\-verbosity\fR=<\fIverbosity\fR> +This sets the log verbosity for ALL daemons using GSettings to store +their "verbosity" configuration. + +The possible \fIverbosity\fR options are: +.sp +.RS 12 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIdebug\fR +\- Show EVERYTHING, from debug messages to errors. This often includes +actual SQL being executed. +.sp +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.IP \(bu 2.3 +.\} +\fIdetailed\fR +\- Show enough detail to understand what is happening. +.sp +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIminimal\fR +\- Show an overview of what is going on, e.g. stats and when things +start or stop. +.sp +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIerrors\fR +\- Show only warnings, criticals, errors or fatal events. +.RE + +.TP +.B \-f, \-\-follow +Follow status changes to daemons as they happen. This is a top level +view of what is happening. You will see the name for each daemon and a +state with the progress in that state. + +This requires Ctrl+C to stop and return to the command line. Each new +status is put on a new line. + +.TP +.B \-w, \-\-watch\fR=[\fIontology\fR] Watch changes that happen to the database in real time. This requires Ctrl+C to stop and return to the command line. -If the -.B ONTOLOGY -is unspecified, all changes are shown. The -.B ONTOLOGY -can be a comma separated list of shorthand or long hand ontology -properties. For example: +If \fIontology\fR is unspecified, all updates are shown. The +\fIontology\fR can be a comma separated list of shorthand or long hand +ontology properties. For example: .nf $ tracker-control -w nie:url,nie:mimeType,nfo:fileSize,nie:dataSource @@ -132,50 +198,42 @@ Additionally, these statuses are not the only ones which may be reported by a miner. There may be other states pertaining to the specific roles of the miner in question. .TP -.B \-\-list-miners-running +.B \-\-list\-miners\-running This will list all miners which have responded to a D-Bus call. Sometimes it is helpful to use this command with -.B \-\-list-miners-available. +.B \-\-list\-miners\-available. .TP .B \-\-list-miners-available This will list all miners which are available even if they are not running at the moment. .TP -.B \-\-pause-details +.B \-\-pause\-details For listing all miners which are paused and the reasons for being paused, you can use this. It will also display the application that requested the pause too. .TP -.B \-\-miner=MINER -This argument is used with -.B \-\-pause -or -.B \-\-resume -to say which miner you want to pause or resume. You can use the full -D-Bus name, e.g. -.B org.freedesktop.Tracker1.Miner.Files -OR you can use the suffix, e.g. -.B Files -.TP -.B \-\-pause=REASON -The REASON here is useful to know WHY the miner should be paused. A +.B \-\-miner\fR=<\fIminer\fR> +This argument is used with \fB\-\-pause\fR or \fB\-\-resume\fR to say +which miner you want to pause or resume. You can use the full D-Bus +name, e.g. "org.freedesktop.Tracker1.Miner.Files" OR you can use +the suffix, e.g. "Files". +.TP +.B \-\-pause\fR=<\fIreason\fR> +The \fIreason\fR here is useful to know WHY the miner should be paused. A miner can be paused many times by multiple applications. Only when all pauses have been resumed will it continue. If successful, a cookie will be given to uniquely identify the request. This cookie is used to resume the pause at a later stage. .TP -.B \-\-pause-for-process=REASON -This works exactly the same way as -.B \-\-pause -with the exception that it only keeps the pause active while the -calling process is alive. As soon as you press Ctrl+C the pause is -resumed automatically. -.TP -.B \-\-resume=COOKIE -The COOKIE is given by a successful -.B \-\-pause -command. It is a number which identifies each pause request. When all -pauses have been resumed, the miner will resume working. +.B \-\-pause\-for\-process\fR=<\fIreason\fR> +This works exactly the same way as \fB\-\-pause\fR with the exception +that it only keeps the pause active while the calling process is +alive. As soon as you press Ctrl+C the pause is resumed automatically. +.TP +.B \-\-resume\fR=<\fIcookie\fR> +The \fIcookie\fR is given by a successful \fB\-\-pause\fR command. It +is a number which identifies each pause request. When all pauses have +been resumed, the miner will resume working. .SH ENVIRONMENT .TP diff --git a/docs/manpages/tracker-import.1 b/docs/manpages/tracker-import.1 deleted file mode 100644 index 673f401e9..000000000 --- a/docs/manpages/tracker-import.1 +++ /dev/null @@ -1,34 +0,0 @@ -.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. -.TP -.B \-V, \-\-version -Print version. - -.SH SEE ALSO -.BR tracker-store (1), -.BR tracker-sparql (1), -.BR tracker-info (1). -.TP -.BR Turtle. diff --git a/docs/manpages/tracker-index.1 b/docs/manpages/tracker-index.1 index d8f8718d6..85f5e23d1 100644 --- a/docs/manpages/tracker-index.1 +++ b/docs/manpages/tracker-index.1 @@ -1,28 +1,63 @@ -.TH tracker-control 1 "September 2009" GNU "User Commands" +.TH tracker-index 1 "September 2014" GNU "User Commands" .SH NAME tracker-index \- List, pause, resume and command data miners indexing content .SH SYNOPSIS -\fBtracker index\fR [\fIOPTION\fR...] +.nf +\fBtracker index\fR \-\-reindex\-mime\-type <\fImime1\fR> [[\-m [\fImime2\fR]] ...] +\fBtracker index\fR \-\-file <\fIfile1\fR> [[\fIfile2\fR] ...] +\fBtracker index\fR \-\-import <\fIfile1\fR> [[\fIfile2\fR] ...] +\fBtracker index\fR \-\-backup <\fIfile\fR> | \-\-restore <\fIfile\fR> +.fi .SH DESCRIPTION -Control the indexing process with pausing and resuming and add content -to be indexed. In addition it is possible to reindex entire MIME -types, which may be useful in cases where a new extractor or GStreamer -backend is available and providing support. +This command perform actions on the current index. The "index" holds a +snapshot of the working tree in a database. + +The index command allows some level of control on existing data +indexed, such as re-indexing content from a specific demographic - +e.g. all JPEG images, or simply reindexing an existing or non-existant +file. + +It may be a good idea to backup your index before an upgrade in case +there is data loss (which should never happen). In those cases, the +backup command is made available and of course the restore command +will import an older data set (or index) into an empty index. + +Finally, there is an import feature which makes testing or applying a +"base" data set for use much easier. + .SH OPTIONS .TP -.B \-m, \-\-reindex-mime-type=MIME -Re-index files which match the \fIMIME\fR type supplied. This is -usually used when installing new extractors which support \fIMIME\fR +.B \-m, \-\-reindex-mime\-type\fR=<\fImime1\fR> [[\-m [\fImime2\fR]] ...] +Re-index files which match the \fImime\fR type supplied. This is +usually used when installing new extractors which support \fImime\fR types previously unsupported. This forces Tracker to re-index those -files. You can use -.B \-\-reindex-mime-type -more than once per \fIMIME\fR type. +files. You can use \fB\-\-reindex\-mime\-type\fR more than once per +\fImime\fR type. +.TP +.B \-f, \-\-index\fR=<\fIfile1\fR> [[\fIfile2\fR] ...] +(Re)index a file matching the \fIfile\fR name(s) supplied. .TP -.B \-f, \-\-index-file=FILE -(Re)index a file matching the \fIFILE\fR type supplied. +.B \-b, \-\-backup\fR=<\fIfile\fR> +Begins backing up the Tracker databases and save it to the \fIfile\fR +given. +.TP +.B \-o, \-\-restore\fR=<\fIfile\fR> +Begins restoring a previous backup from the \fIfile\fR which points to +the location of the backup generated by \fB\-\-backup\fR. +.TP +.B \i, \-\-import\fR=<\fIfile1\fR> [[\fIfile2\fR] ...] +Allows data to be imported into the index / 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 SEE ALSO .BR tracker (1). +.BR Turtle. diff --git a/docs/manpages/tracker-info.1 b/docs/manpages/tracker-info.1 index 6dbc97c02..f50759398 100644 --- a/docs/manpages/tracker-info.1 +++ b/docs/manpages/tracker-info.1 @@ -4,28 +4,22 @@ tracker-info \- Retrieve all information available for a certain file. .SH SYNOPSIS -\fBtracker-info\fR [\fIOPTION\fR...] \fIFILE\fR... +\fBtracker info\fR [\fIoptions\fR...] <\fIfile1\fR> [[\fIfile2\fR] ...] .SH DESCRIPTION -.B tracker-info -asks for all the known metadata available for the given \fIFILE\fR. +.B tracker info +asks for all the known metadata available for the given \fIfile\fR. -Multiple \fIFILE\fR arguments can be provided to retrieve information +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 +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 \-V, \-\-version -Print version. -.TP .B \-f, \-\-full\-namespaces -By default, all keys and values reported about any given \fIFILE\fR +By default, all keys and values reported about any given \fIfile\fR are returned in shortened form, for example, \fInie:title\fR is shown instead of \fIhttp://www.semanticdesktop.org/ontologies/2007/01/19/nie#title\fR. @@ -39,18 +33,18 @@ information about the content of the resource, which could be the contents of a file on the disk), then this option displays that in the output. .TP -.B \-i, \-\-resource-is-iri -In most cases, the \fIFILE\fR argument supplied points to a URL or +.B \-i, \-\-resource\-is\-iri +In most cases, the \fIfile\fR argument supplied points to a URL or PATH which is queried for according to the resource associated with it -by \fInie:url\fR. However, in cases where the \fIFILE\fR specified +by \fInie:url\fR. However, in cases where the \fIfile\fR specified turns out to be the actual URN itself, this argument is required to -tell \fBtracker-info\fR not to do the extra step of looking up the URN +tell "tracker info" not to do the extra step of looking up the URN related by \fInie:url\fR. For example, consider that you store URNs by the actual URL itself and use the unique nie:url in another resource (which is quite reasonable when using containers and multi-resource conditions), you would need -this argument to tell \fBtracker-info\fR that the \fIFILE\fR supplied +this argument to tell "tracker info" that the \fIfile\fR supplied is actually a URN not URL. .TP .B \-t, \-\-turtle @@ -83,7 +77,7 @@ be if this environment variable was undefined. Tracker has a fixed set of PRAGMA settings for creating its SQLite connection. With this environment variable pointing to a text file you can override these settings. The file is a \\n separated list of SQLite queries to execute on any -newly created SQLite connection in tracker-store. +newly created SQLite connection in \fBtracker-store\fR. .SH SEE ALSO .BR tracker-store (1), diff --git a/docs/manpages/tracker-reset.1 b/docs/manpages/tracker-reset.1 index c1c5824cb..89dc62160 100644 --- a/docs/manpages/tracker-reset.1 +++ b/docs/manpages/tracker-reset.1 @@ -1,35 +1,44 @@ .TH tracker-reset 1 "September 2014" GNU "User Commands" .SH NAME -tracker-reset \- Reset the index, configuration or replay journal +tracker-reset \- Reset the index and configuration .SH SYNOPSIS -\fBtracker reset\fR [\fIOPTION\fR...] +\fBtracker reset\fR [\-\-hard | \-\-soft] [\-\-config] .SH DESCRIPTION +The reset command will change either your configuration or index +irreversibly and should be used with care. Other than tags, actual +data (e.g. files) should not be affected by this command. + +The "index" is a link between your content (either locally or +remotely) and how it can be found quickly using a number of different +queries. Under the hood, this is done using a database. + +Removing all data and starting again from the beginning with an empty +data set (which is a common use of this command) is done by using the +hard reset option. This behaves as if Tracker was just installed. .SH OPTIONS .TP -.B \-r, \-\-hard-reset -This kills all processes in the same way that -.B \-\-kill -does but it also removes all databases. Restarting -.B tracker-store -re-creates the databases. +.B \-r, \-\-hard +This kills all processes in the same way that \fBtracker daemon +\-\-kill\fR does but it also removes all databases. Restarting +\fBtracker-store\fR re-creates the databases. .TP -.B \-e, \-\-soft-reset -A soft reset works exactly the same way that -.B \-\-hard-reset -does, with the exception that the backup and journal are not removed. -These are restored when -.B tracker-store -is restarted. +.B \-e, \-\-soft +A soft reset works exactly the same way that \fB\-\-hard\fR does, with +the exception that the backup and journal are not removed. These are +restored when \fBtracker-store\fR is restarted. This command is useful if +you have a corrupt database but want to reply the journal to restore +it to the last known good place. .TP -.B \-c, \-\-remove-config -This removes all config files in $HOME/.config/tracker. All files -listed are files which were found and successfully removed. +.B \-c, \-\-config +This removes all config files in \fI$HOME/.config/tracker\fR. All +files listed are files which were found and successfully removed. Restarting the respective processes re-creates the default configuration files. .SH SEE ALSO +.BR tracker-daemon (1). .BR tracker (1). diff --git a/docs/manpages/tracker-search.1 b/docs/manpages/tracker-search.1 index 328786524..109602ed0 100644 --- a/docs/manpages/tracker-search.1 +++ b/docs/manpages/tracker-search.1 @@ -1,117 +1,114 @@ .TH tracker-search 1 "July 2009" GNU "User Commands" .SH NAME -tracker-search \- Search all content for keywords +tracker-search \- Search for content by type or across all types .SH SYNOPSIS -\fBtracker search\fR [\fIOPTION\fR...] \fIEXPRESSION\fR [\fIEXPRESSION\fR...] +\fBtracker search\fR [\fIoptions\fR...] [[\fIexpression1\fR] ...] .SH DESCRIPTION .B tracker search -searches all indexed content for \fIEXPRESSION\fR. The resource in -which \fIEXPRESSION\fR matches must exist (see +searches all indexed content for \fIexpression\fR. The resource in +which \fIexpression\fR matches must exist (see .B \-\-all for more information). All results are returned in ascending order. In -all cases, if no \fIEXPRESSION\fR is given for an argument (like +all cases, if no \fIexpression\fR is given for an argument (like .B \-\-folders for example) then ALL items in that category are returned instead. .TP -\fIEXPRESSION\fR +\fIexpression\fR One or more terms to search. The default operation is a logical AND. For logical OR operations, see -r. .SH OPTIONS .TP -.B \-l, \-\-limit=N -Limit search to N results. The default is 10 or 512 with \-\-disable\-snippets. -.TP -.B \-o, \-\-offset=N -Offset the search results by N. For example, start at item number 10 -in the results. The default is 0. -.TP -.B \-r, \-\-or-operator -Use OR for search terms instead of AND (the default) -.TP -.B \-d, \-\-detailed -Show the unique URN associated with each search result. This does not -apply to \-\-music\-albums and \-\-music\-artists. -.TP -.B \-a, \-\-all -Show results which might not be available. This might bebecause a -removable media is not mounted for example. Without this option, -resources are only shown if they exist. This option applies to all -command line switches except -.TP -.B \-\-disable-snippets -Results are shown with snippets. Snippets are context around the word -that was searched for in the first place. This gives some idea of if -the resource found is the right one. Snippets require Full Text Search -to be compile time enabled AND to not be disabled with -\-\-disable\-fts. Using \-\-disable\-snippets only shows the resources -which matched, no context is provided about where the match occurred. -.TP -.B \-\-disable-fts -If Full Text Search (FTS) is available, this option allows it to be -disabled for one off searches. This returns results slightly -using particular properties to match the search terms (like nie:title) -instead of looking for the search terms amongst ALL properties. It is -more limiting to do this, but sometimes searching without FTS can -yield better results if the FTS ranking is off. -.TP -.B \-\-disable-color -This disables any ANSI color use on the command line. By default this -is enabled to make it easier to see results. -.B \-\-music-albums -and -.B \-\-music-artists. -.TP .B \-f, \-\-files -Search for files of any type matching \fIEXPRESSION\fR (optional). +Search for files of any type matching \fIexpression\fR (optional). .TP .B \-s, \-\-folders -Search for folders matching \fIEXPRESSION\fR (optional). +Search for folders matching \fIexpression\fR (optional). .TP .B \-m, \-\-music -Search for music files matching \fIEXPRESSION\fR (optional). +Search for music files matching \fIexpression\fR (optional). .TP -.B \-\-music\-albums -Search for music albums matching \fIEXPRESSION\fR (optional). +.B \-\-music\-albums +Search for music albums matching \fIexpression\fR (optional). .TP -.B \-\-music\-artists -Search for music artists matching \fIEXPRESSION\fR (optional). +.B \-\-music\-artists +Search for music artists matching \fIexpression\fR (optional). .TP .B \-i, \-\-images -Search for images matching \fIEXPRESSION\fR (optional). +Search for images matching \fIexpression\fR (optional). .TP .B \-v, \-\-videos -Search for videos matching \fIEXPRESSION\fR (optional). +Search for videos matching \fIexpression\fR (optional). .TP .B \-t, \-\-documents -Search for documents matching \fIEXPRESSION\fR (optional). +Search for documents matching \fIexpression\fR (optional). .TP .B \-e, \-\-emails -Search for emails matching \fIEXPRESSION\fR (optional). Returns a list +Search for emails matching \fIexpression\fR (optional). Returns a list of subjects for emails found. .TP .B \-c, \-\-contacts -Search for contacts matching \fIEXPRESSION\fR (optional). Returns a list +Search for contacts matching \fIexpression\fR (optional). Returns a list of names and email addresses found. .TP .B \-\-software -Search for software installed matching \fIEXPRESSION\fR (optional). Returns a list +Search for software installed matching \fIexpression\fR (optional). Returns a list of desktop files and application titles found. .TP -.B \-\-software-categories -Search for software categories matching \fIEXPRESSION\fR (optional). Returns a list +.B \-\-software\-categories +Search for software categories matching \fIexpression\fR (optional). Returns a list of urns and their categories (e.g. Settings, Video, Utility, etc). .TP .B \-\-feeds -Search through RSS feed information matching \fIEXPRESSION\fR (optional). Returns a list +Search through RSS feed information matching \fIexpression\fR (optional). Returns a list of those found. .TP .B \-b, \-\-bookmarks -Search through bookmarks matching \fIEXPRESSION\fR (optional). Returns a list +Search through bookmarks matching \fIexpression\fR (optional). Returns a list titles and links for each bookmark found. +.TP +.B \-l, \-\-limit\fR=<\fIlimit\fR> +Limit search to \fIlimit\fR results. The default is 10 or 512 with \-\-disable\-snippets. +.TP +.B \-o, \-\-offset\fR=<\fIoffset\fR> +Offset the search results by \fIoffset\fR. For example, start at item number 10 +in the results. The default is 0. +.TP +.B \-r, \-\-or\-operator +Use OR for search terms instead of AND (the default) +.TP +.B \-d, \-\-detailed +Show the unique URN associated with each search result. This does not +apply to \-\-music\-albums and \-\-music\-artists. +.TP +.B \-a, \-\-all +Show results which might not be available. This might bebecause a +removable media is not mounted for example. Without this option, +resources are only shown if they exist. This option applies to all +command line switches except +.TP +.B \-\-disable\-snippets +Results are shown with snippets. Snippets are context around the word +that was searched for in the first place. This gives some idea of if +the resource found is the right one. Snippets require Full Text Search +to be compile time enabled AND to not be disabled with +\-\-disable\-fts. Using \-\-disable\-snippets only shows the resources +which matched, no context is provided about where the match occurred. +.TP +.B \-\-disable\-fts +If Full Text Search (FTS) is available, this option allows it to be +disabled for one off searches. This returns results slightly +using particular properties to match the search terms (like "nie:title") +instead of looking for the search terms amongst ALL properties. It is +more limiting to do this, but sometimes searching without FTS can +yield better results if the FTS ranking is off. +.TP +.B \-\-disable\-color +This disables any ANSI color use on the command line. By default this +is enabled to make it easier to see results. .SH ENVIRONMENT .TP diff --git a/docs/manpages/tracker-sparql.1 b/docs/manpages/tracker-sparql.1 index 9435928c1..2e5df8cde 100644 --- a/docs/manpages/tracker-sparql.1 +++ b/docs/manpages/tracker-sparql.1 @@ -4,41 +4,50 @@ tracker-sparql \- Use SparQL to query the Tracker databases. .SH SYNOPSIS -\fBtracker sparql\fR [\fIOPTION\fR...] [-q \fIQUERY\fR] | [-f \fIFILE\fR] +.nf +\fBtracker sparql\fR \-q <\fIsparql\fR> [\-u] | \-f <\fIfile\fR> +\fBtracker sparql\fR \-t [\fIclass\fR] [-s <\fIneedle\fR>] [\-p] +\fBtracker sparql\fR [\-c] [\-p] [\-x] [-n [\fIclass\fR]] [\-i [\fIproperty\fR]] [\-s <\fIneedle\fR>] +\fBtracker sparql\fR [\-\-get\-longhand <\fIclass\fR>] [\-\-get\-shorthand <\fIclass\fR>] +.fi .SH DESCRIPTION -.B tracker sparql -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 +This command allows probing of the current database schema (also +known as ontology) and running low level queries or updates on the +data set. In terms of the database ontology, it's easy to find out what +properties are indexed for speed, or notified on changes, what classes are +available and the properties belonging to those classes. There are +also visual tools to display an ascii tree layout of the classes and +their relationships to each other. + +When the caller runs a query, the query is in RDF and SPARQL. This can be +done two ways. Either by providing a \fIfile\fR with the query or by +providing a string with the \fIsparql\fR query. + +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 \-f, \-\-file=FILE -Use a \fIFILE\fR with SPARQL content to query or update. +.B \-f, \-\-file\fR=<\fIfile\fR> +Use a \fIfile\fR with SPARQL content to query or update. .TP -.B \-q, \-\-query=SPARQL -Use a \fISPARQL\fR string to query the database with. +.B \-q, \-\-query\fR=<\fIsparql\fR> +Use a \fIsparql\fR string to query the database with. .TP .B \-u, \-\-update -This has to be used with -.B \-\-query. -This tells -.B tracker-sparql -to use the SPARQL update extensions so it knows it isn't a regular -data lookup request. So if your query is intended to change data in -the database, this option is needed. +This has to be used with \fB\-\-query\fR. This tells +"tracker sparql" to use the SPARQL update extensions so it knows +it isn't a regular data lookup request. So if your query is intended +to change data in the database, this option is needed. .TP -.B \-c, \-\-list-classes +.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, \fIhttp://www.w3.org/2000/01/rdf-schema#Resource\fR is one of many classes which should be returned here. .TP -.B \-x, \-\-list-class-prefixes +.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, \fIhttp://www.w3.org/2000/01/rdf-schema#Resource\fR has the @@ -47,16 +56,16 @@ prefix \fIrdfs\fR 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\-p, \-\-list\-properties\fR=[\fIclass\fR] +Returns a list of properties which pertain to a \fIclass\fR. You can +use both formats here for the \fIclass\fR, either the full name \fIhttp://www.semanticdesktop.org/ontologies/2007/03/22/nfo#Video\fR or the shortened prefix name \fInfo:Video\fR. This gives the following result: .nf -$ tracker-sparql -p nfo:Video +$ tracker sparql -p nfo:Video Properties: 2 http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#frameRate @@ -64,39 +73,34 @@ Properties: 2 .fi These properties \fInfo:frameRate\fR and \fInfo:frameCount\fR can then -be used in queries (see also -.B \-\-query -). +be used in queries. -See also -.B \-\-tree +See also \fB\-\-tree\fR and \fB\-\-query\fR. .TP -.B \-n, \-\-list-notifies=CLASS +.B \-n, \-\-list\-notifies\fR=[\fIclass\fR] Returns a list of classes which are notified over D-Bus about any -changes that occur in the database. \fICLASS\fR does not have to be +changes that occur in the database. The \fIclass\fR does not have to be supplied here. This is optional and filters the results according to -any argument supplied. With no \fICLASS\fR, all classes are listed. +any argument supplied. With no \fIclass\fR, all classes are listed. .TP -.B \-i, \-\-list-indexes=PROPERTY +.B \-i, \-\-list\-indexes\fR=[\fIproperty\fR] Returns a list of properties which are indexed in the database. -Indexes improves query speed but also add an indexing penalty. -\fIPROPERTY\fR does not have to be supplied here. This is optional and +Indexes improves query speed but also add an indexing penalty. The +\fIproperty\fR does not have to be supplied here. This is optional and filters the results according to any argument supplied. With no -\fIPROPERTY\fR, all properties are listed. +\fIproperty\fR, all properties are listed. .TP -.B \-t, \-\-tree [<CLASS>] -Prints a tree showing all parent classes of \fICLASS\fR in the -ontology. \fICLASS\fR can be provided in shorthand or longhand (see -.B \-\-get\-shorthand -and -.B \-\-get\-longhand -for details). For example: +.B \-t, \-\-tree\fR=[\fIclass\fR] +Prints a tree showing all parent classes of \fIclass\fR in the +ontology. The \fIclass\fR can be provided in shorthand or longhand (see +\fB\-\-get\-shorthand\fR and \fB\-\-get\-longhand\fR for details). For +example: .nf -$ tracker-sparql -t nmo:MMSMessage +$ tracker sparql -t nmo:MMSMessage ROOT +-- rdfs:Resource (C) | +-- nie:InformationElement (C) @@ -107,20 +111,18 @@ ROOT | | | | | | `-- nmo:MMSMessage (C) .fi -If no \fICLASS\fR is given, the entire tree is shown. +If no \fIclass\fR is given, the entire tree is shown. The .B \-\-search command line option can be used to highlight parts of the tree you're looking for. The search is case insensitive. -The -.B \-\-properties -command line option can be used to show properties for each class -displayed, for example: +The \fB\-\-properties\fR command line option can be used to show +properties for each class displayed, for example: .nf -$ tracker-sparql -t nfo:FileDataObject -p +$ tracker sparql -t nfo:FileDataObject -p ROOT +-- rdfs:Resource (C) | --> http://purl.org/dc/elements/1.1/contributor (P) @@ -172,13 +174,13 @@ ROOT .fi .TP -.B \-s, \-\-search=TERM +.B \-s, \-\-search\fR=<\fIneedle\fR> Returns a list of classes and properties which partially match -\fITERM\fR in the ontology. This is a case insensitive match, for +\fIneedle\fR in the ontology. This is a case insensitive match, for example: .nf -$ tracker-sparql -s text +$ tracker sparql -s text Classes: 4 http://www.semanticdesktop.org/ontologies/2007/03/22/nfo#TextDocument @@ -193,27 +195,25 @@ Properties: 4 http://www.tracker-project.org/temp/scal#textLocation .fi -See also -.B \-\-tree - +See also \fB\-\-tree\fR. .TP -.B \-\-get\-shorthand <CLASS> +.B \-\-get\-shorthand\fR=<\fIclass\fR> Returns the shorthand for a class given by a URL. For example: .nf -$ tracker-sparql --get-shorthand http://www.semanticdesktop.org/ontologies/2007/03/22/nmo#plainTextMessageContent +$ tracker sparql --get-shorthand http://www.semanticdesktop.org/ontologies/2007/03/22/nmo#plainTextMessageContent nmo:plainTextMessageContent .fi .TP -.B \-\-get\-longhand <CLASS> +.B \-\-get\-longhand\fR=<\fIclass\fR> Returns the longhand for a class given in the form of CLASS:PROPERTY. For example: .nf -$ tracker-sparql --get-longhand nmm:MusicPiece +$ tracker sparql --get-longhand nmm:MusicPiece http://www.tracker-project.org/temp/nmm#MusicPiece .fi @@ -241,7 +241,7 @@ be if this environment variable was undefined. Tracker has a fixed set of PRAGMA settings for creating its SQLite connection. With this environment variable pointing to a text file you can override these settings. The file is a \\n separated list of SQLite queries to execute on any -newly created SQLite connection in tracker-store. +newly created SQLite connection in \fBtracker-store\fR. .SH EXAMPLES .TP @@ -249,7 +249,7 @@ List all classes .BR .nf -$ tracker-sparql -q "SELECT ?cl WHERE { ?cl a rdfs:Class }" +$ tracker sparql -q "SELECT ?cl WHERE { ?cl a rdfs:Class }" .fi .TP @@ -257,7 +257,7 @@ List all properties for the Resources class (see \-\-list-properties) .BR .nf -$ tracker-sparql -q "SELECT ?prop WHERE { +$ tracker sparql -q "SELECT ?prop WHERE { ?prop a rdf:Property ; rdfs:domain <http://www.w3.org/2000/01/rdf-schema#Resource> }" @@ -268,7 +268,7 @@ List all class namespace prefixes .BR .nf -$ tracker-sparql -q "SELECT ?prefix ?ns WHERE { +$ tracker sparql -q "SELECT ?prefix ?ns WHERE { ?ns a tracker:Namespace ; tracker:prefix ?prefix }" @@ -279,7 +279,7 @@ List all music files .BR .nf -$ tracker-sparql -q "SELECT ?song WHERE { ?song a nmm:MusicPiece }" +$ tracker sparql -q "SELECT ?song WHERE { ?song a nmm:MusicPiece }" .fi .TP @@ -287,7 +287,7 @@ List all music albums .BR .nf -$ tracker-sparql -q "SELECT ?album ?title COUNT(?song) +$ tracker sparql -q "SELECT ?album ?title COUNT(?song) AS songs SUM(?length) AS totallength WHERE { @@ -303,7 +303,7 @@ List all music from a particular artist .BR .nf -$ tracker-sparql -q "SELECT ?song ?title WHERE { +$ tracker sparql -q "SELECT ?song ?title WHERE { ?song nmm:performer [ nmm:artistName 'Artist Name' ] ; nie:title ?title }" @@ -314,7 +314,7 @@ Set the played count for a song .BR .nf -$ tracker-sparql -u -q "DELETE { +$ tracker sparql -u -q "DELETE { <file:///home/user/Music/song.mp3> nie:usageCounter ?count } WHERE { <file:///home/user/Music/song.mp3> nie:usageCounter ?count @@ -328,7 +328,7 @@ List all image files .BR .nf -$ tracker-sparql -q "SELECT ?image WHERE { ?image a nfo:Image }" +$ tracker sparql -q "SELECT ?image WHERE { ?image a nfo:Image }" .fi .TP @@ -336,7 +336,7 @@ List all image files with a specific tag .BR .nf -$ tracker-sparql -q "SELECT ?image WHERE { +$ tracker sparql -q "SELECT ?image WHERE { ?image a nfo:Image ; nao:hasTag [ nao:prefLabel 'tag' ] }" @@ -347,7 +347,7 @@ List all image files created on a specific month and order by date .BR .nf -$ tracker-sparql -q "SELECT ?image ?date WHERE { +$ tracker sparql -q "SELECT ?image ?date WHERE { ?image a nfo:Image ; nie:contentCreated ?date . FILTER (?date >= '2008-07-01T00:00:00' && diff --git a/docs/manpages/tracker-stats.1 b/docs/manpages/tracker-stats.1 deleted file mode 100644 index 26bf9181e..000000000 --- a/docs/manpages/tracker-stats.1 +++ /dev/null @@ -1,48 +0,0 @@ -.TH tracker-stats 1 "July 2009" GNU "User Commands" - -.SH NAME -tracker-stats \- Provides statistics on the data indexed - -.SH SYNOPSIS -\fBtracker stats\fR [\fIOPTION\fR...] [[\fIEXPRESSION\fR...] [\fIEXPRESSION\fR...]] - -.SH DESCRIPTION -Display statistics about RDF classes in and how many of each exist for -the data set that has been indexed. - -By default, only common and useful classes are shown, e.g. -nfo:Document or nfo:Folder, for a full set of statistics, see the -.B\-\-all -option. - -If one or more \fIEXPRESSION\fR is given, the statistics returned are -filtered to only include information about RDF types matching -\fIEXPRESSION\fR (case folded and matching accented variants). - -The RDF classes are detailed by 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 -.B \-a, \-\-all -Display statistics about ALL RDF classes that exist in the database. -Without this option only the common RDF classes will be shown, for -example nfo:Document and nfo:FileDataObject. - -This option is implied if search terms are provided to filter ALL -possible statistics. - -.SH SEE ALSO -.BR tracker-store (1), -.BR tracker-control (1), -.BR tracker-sparql (1), -.BR tracker-info (1). -.TP -.BR http://nepomuk.semanticdesktop.org/ -.TP -.BR http://www.w3.org/TR/rdf-sparql-query/ diff --git a/docs/manpages/tracker-status.1 b/docs/manpages/tracker-status.1 new file mode 100644 index 000000000..6afb9a315 --- /dev/null +++ b/docs/manpages/tracker-status.1 @@ -0,0 +1,64 @@ +.TH tracker-status 1 "September 2014" GNU "User Commands" + +.SH NAME +tracker-status \- Provide status and statistics on the data indexed + +.SH SYNOPSIS +.nf +\fBtracker status\fR +\fBtracker status\fR \-\-stat [-a] [[\fIexpression1\fR]...] +\fBtracker status\fR \-\-collect\-debug\-info +.fi + +.SH DESCRIPTION +Display the status of the current index and data set. + +With the \fB\-\-stat\fR option, displays statistics about the RDF +classes and how many of each exist for data set that has been indexed. +For example, "10 Folders". + +This command also provides a way to collect information for debug +purposes using the \fB\-\-collect\-debug\-info\fR option. + +.SH OPTIONS +.TP +.B \-\-stat\fR[=\fIexpression\fR] +By default, only common and useful classes are shown, e.g. +"nfo:Document" or "nfo:Folder", for a full set of statistics, see the +\fB\-\-all\fR option. + +If one or more \fIexpression\fR arguments is given, the statistics +returned are filtered to only show information those RDF types +matching \fIexpression\fR (case folded and matching accented +variants). The RDF classes are detailed by the Nepomuk otology +specification. A list of possible classes matching \fIexpression\fR, +see \fBtracker sparql \-c\fR. +.TP +.B \-a, \-\-all +Display statistics about ALL RDF classes that exist in the database. +Without this option only the common RDF classes will be shown, for +example "nfo:Document" and "nfo:FileDataObject". + +This option is implied if search terms are provided to filter ALL +possible statistics. +.TP +.B \-\-collect\-debug\-info +Useful when debugging problems to diagnose the state of Tracker on +your system. The data is output to stdout. Useful if bugs are filed +against the project itself. + +Data collected includes Tracker version in use, disk space available, +size of the databases on the disk, the configuration in use, states of +the index (e.g. last filesystem crawl, data set locale, etc.) and +finally statistics about the data in the database (e.g. how many +"nfo:FileDataObject" resources exist). + +.SH SEE ALSO +.BR tracker-store (1), +.BR tracker-control (1), +.BR tracker-sparql (1), +.BR tracker-info (1). +.TP +.BR http://nepomuk.semanticdesktop.org/ +.TP +.BR http://www.w3.org/TR/rdf-sparql-query/ diff --git a/docs/manpages/tracker-tag.1 b/docs/manpages/tracker-tag.1 index 9e85f1698..b450f8f24 100644 --- a/docs/manpages/tracker-tag.1 +++ b/docs/manpages/tracker-tag.1 @@ -4,41 +4,23 @@ tracker-tag \- Add, remove and list tags. .SH SYNOPSIS -\fBtracker tag\fR [\fIOPTION...\fR] FILE [\fIFILE...\fR] .nf -\fBtracker tag\fR [\fIOPTION...\fR] -t [[\fITAG\fR] [\fITAG\fR] ...\fR] +\fBtracker tag\fR \fIFILE1\fR [\fIFILE2\fR ...] [\-l <limit>] [\-o <offset>] [\-r] +\fBtracker tag\fR \-t [[\fITAG1\fR] [\fITAG2\fR] ...] [\-s] [\-r] +\fBtracker tag\fR \-a <\fITAG\fR> [-e <description>] +\fBtracker tag\fR \-d <\fITAG\fR> .fi .SH DESCRIPTION -.B tracker tag -allows the caller add tags, remove tags and list tags by URN or to -list all tags and the files associated with them. +List tags for local files or by the tag labels themselves if \-t is used. + +It's also possible to manage tags with the \-a and and \-d options. 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 \-l, \-\-limit=N -Limit search to N results. The default is 512. -.TP -.B \-o, \-\-offset=N -Offset the search results by N. For example, start at item number 10 -in the results. The default is 0. -.TP -.B \-r, \-\-and-operator -Use AND operator for search terms instead of OR(the default). For -example: - -.nf -$ tracker-tag -s -t sliff sloff -.fi - -Should show files in the database that have both the \fIsliff\fR -.B AND -\fIsloff\fR tags. - -.TP .B \-t, \-\-list List all tags. Results include the number of files associated with that tag and the tag's unique identifier. You can show the files @@ -77,6 +59,24 @@ This option ONLY applies when using .B \-\-add and provides a description to go with the tag label according to \fISTRING\fR. +.TP +.B \-l, \-\-limit=N +Limit search to N results. The default is 512. +.TP +.B \-o, \-\-offset=N +Offset the search results by N. For example, start at item number 10 +in the results. The default is 0. +.TP +.B \-r, \-\-and-operator +Use AND operator for search terms instead of OR (the default). For +example: + +.nf +$ tracker-tag -s -t sliff sloff +.fi + +Should show files in the database that have both the \fIsliff\fR and +\fIsloff\fR tags. .SH ENVIRONMENT .TP @@ -102,7 +102,7 @@ be if this environment variable was undefined. Tracker has a fixed set of PRAGMA settings for creating its SQLite connection. With this environment variable pointing to a text file you can override these settings. The file is a \\n separated list of SQLite queries to execute on any -newly created SQLite connection in tracker-store. +newly created SQLite connection in \fBtracker-store\fR. .SH SEE ALSO .BR tracker-store (1), |