[tracker-miners/wip/carlosg/cli-split: 23/23] docs: Restore man pages for miner CLI subcommands



commit 01b52b22cdce9ff27b9557496ce57eb92c90c502
Author: Carlos Garnacho <carlosg gnome org>
Date:   Fri Dec 27 17:49:59 2019 +0100

    docs: Restore man pages for miner CLI subcommands

 docs/manpages/meson.build      |   6 ++
 docs/manpages/tracker-daemon.1 | 239 +++++++++++++++++++++++++++++++++++++++++
 docs/manpages/tracker-index.1  |  63 +++++++++++
 docs/manpages/tracker-reset.1  |  46 ++++++++
 docs/manpages/tracker-search.1 | 136 +++++++++++++++++++++++
 docs/manpages/tracker-status.1 |  64 +++++++++++
 docs/manpages/tracker-tag.1    | 104 ++++++++++++++++++
 7 files changed, 658 insertions(+)
---
diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build
index fcaf097b0..8a3b0fc3b 100644
--- a/docs/manpages/meson.build
+++ b/docs/manpages/meson.build
@@ -1,5 +1,11 @@
+install_man('tracker-daemon.1')
 install_man('tracker-extract.1')
+install_man('tracker-index.1')
 install_man('tracker-miner-fs.1')
+install_man('tracker-reset.1')
+install_man('tracker-search.1')
+install_man('tracker-status.1')
+install_man('tracker-tag.1')
 install_man('tracker-writeback.1')
 
 if have_tracker_miner_rss
diff --git a/docs/manpages/tracker-daemon.1 b/docs/manpages/tracker-daemon.1
new file mode 100644
index 000000000..66432f27f
--- /dev/null
+++ b/docs/manpages/tracker-daemon.1
@@ -0,0 +1,239 @@
+.TH tracker-daemon 1 "September 2014" GNU "User Commands"
+
+.SH NAME
+tracker-daemon \- Start, stop, restart and list daemons responsible for indexing content
+
+.SH SYNOPSIS
+.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
+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. 
+
+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.
+
+If no arguments are provided this command will show the current status
+of all Tracker entities (store and all available data miners).
+
+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 data miners can be paused or resumed using this command and you can
+also list miners running and available.
+
+.SH OPTIONS
+.TP
+.B \-p, \-\-list\-processes
+This lists all Tracker processes in the system.
+.TP
+.B \-k, \-\-kill\fR=[\fIdaemons\fR]
+This uses SIGKILL to stop all Tracker processes found matching the
+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, "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 \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\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 \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
+    Now listening for resource updates to the database
+    All nie:plainTextContent properties are omitted
+
+    Press Ctrl+C to stop
+
+    'nfo:Document'
+       'nfo:fileSize' = '1770'
+       'nie:dataSource' = 'http://www.tracker-project.org/ontologies/tracker#extractor-data-source'
+       'nie:mimeType' = 'text/plain'
+       'nie:url' = 'file:///home/martyn/.bash_aliases'
+    'nfo:Document'
+       'nie:dataSource' = 'http://www.tracker-project.org/ontologies/tracker#extractor-data-source'
+
+    ...
+.fi
+
+.TP
+.B \-\-list-common-statuses
+This will list statuses most commonly produced by miners and the
+store. These statuses are not translated when sent over D-Bus and
+should be translated by each application. These are not considered
+static and are subject to change at any point.
+
+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
+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.
+.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
+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\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\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 SEE ALSO
+.BR tracker-store (1).
diff --git a/docs/manpages/tracker-index.1 b/docs/manpages/tracker-index.1
new file mode 100644
index 000000000..30a32169e
--- /dev/null
+++ b/docs/manpages/tracker-index.1
@@ -0,0 +1,63 @@
+.TH tracker-index 1 "September 2014" GNU "User Commands"
+
+.SH NAME
+tracker-index \- List, pause, resume and command data miners indexing content
+
+.SH SYNOPSIS
+.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
+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-existent
+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\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 \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 \-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-reset.1 b/docs/manpages/tracker-reset.1
new file mode 100644
index 000000000..a039cb6cc
--- /dev/null
+++ b/docs/manpages/tracker-reset.1
@@ -0,0 +1,46 @@
+.TH tracker-reset 1 "September 2014" GNU "User Commands"
+
+.SH NAME
+tracker-reset \- Reset the index and configuration
+
+.SH SYNOPSIS
+\fBtracker reset\fR [\-\-hard | \-\-soft] [\-\-config] [\-\-file \fIFILE\fR]
+
+.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
+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
+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, \-\-config
+Resets all configuration to its defaults.
+.TP
+.B \-f, \-\-file \fIFILE\fR
+Resets all indexed information about \fIFILE\fR, works recursively for
+directories. Nothing will be done if \fIFILE\fR is not currently indexed.
+After deletion, a request to reindex this data will be immediately issued.
+
+.SH SEE ALSO
+.BR tracker-daemon (1).
+.BR tracker (1).
diff --git a/docs/manpages/tracker-search.1 b/docs/manpages/tracker-search.1
new file mode 100644
index 000000000..06762f5af
--- /dev/null
+++ b/docs/manpages/tracker-search.1
@@ -0,0 +1,136 @@
+.TH tracker-search 1 "July 2009" GNU "User Commands"
+
+.SH NAME
+tracker-search \- Search for content by type or across all types
+
+.SH SYNOPSIS
+\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 
+.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 
+.B \-\-folders
+for example) then ALL items in that category are returned instead.
+.TP
+\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 \-f, \-\-files
+Search for files of any type matching \fIexpression\fR (optional).
+.TP
+.B \-s, \-\-folders
+Search for folders matching \fIexpression\fR (optional).
+.TP
+.B \-m, \-\-music
+Search for music files matching \fIexpression\fR (optional).
+.TP
+.B \-\-music\-albums
+Search for music albums matching \fIexpression\fR (optional).
+.TP
+.B \-\-music\-artists
+Search for music artists matching \fIexpression\fR (optional).
+.TP
+.B \-i, \-\-images
+Search for images matching \fIexpression\fR (optional).
+.TP
+.B \-v, \-\-videos
+Search for videos matching \fIexpression\fR (optional).
+.TP
+.B \-t, \-\-documents
+Search for documents matching \fIexpression\fR (optional).
+.TP
+.B \-e, \-\-emails
+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
+of names and email addresses found.
+.TP
+.B \-\-software
+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
+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
+of those found.
+.TP
+.B \-b, \-\-bookmarks
+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
+.B TRACKER_SPARQL_BACKEND
+This option allows you to choose which backend you use for connecting
+to the database. This choice can limit your functionality. There are
+three settings.
+
+With "\fBdirect\fR" the connection to the database is made directly to
+the file itself on the disk, there is no intermediary daemon or
+process. The "\fBdirect\fR" approach is purely \fIread-only\fR.
+
+With "\fBbus\fR" the \fBtracker-store\fR process is used to liase with
+the database queuing all requests and managing the connections via an
+IPC / D-Bus. This adds a small overhead \fIBUT\fR this is the only
+approach you can use if you want to \fIwrite\fR to the database.
+
+With "\fBauto\fR" the backend is decided for you, much like it would
+be if this environment variable was undefined.
+
+.SH SEE ALSO
+.BR tracker-store (1),
+.BR tracker-stats (1),
+.BR tracker-tag (1),
+.BR tracker-info (1).
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
new file mode 100644
index 000000000..c4e3285e5
--- /dev/null
+++ b/docs/manpages/tracker-tag.1
@@ -0,0 +1,104 @@
+.TH tracker-tag 1 "July 2009" GNU "User Commands"
+
+.SH NAME
+tracker-tag \- Add, remove and list tags.
+
+.SH SYNOPSIS
+.nf
+\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
+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 \-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
+associated with each tag by using --show-files.
+
+The \fITAG\fR arguments are optional. If no \fITAG\fR argument
+is specified, all tags are listed. If one or more \fITAG\fRs are
+given, either matching tags are listed (OR condition). For example,
+this will match any tags named either \fIfoo\fR, \fIbar\fR or
+\fIbaz\fR:
+
+.nf
+$ tracker-tag -t foo bar baz
+.fi
+
+.TP
+.B \-s, \-\-show-files
+Show the files associated with each tag. This option is ONLY available
+WITH the
+.B --list
+option.
+.TP
+.B \-a, \-\-add=TAG
+Add a tag with the name \fITAG\fR. If no \fIFILE\fR arguments are
+specified, the tag is simply created (if it didn'talready exist) and
+no files are associated with it. Multiple \fIFILE\fR arguments can be
+specified.
+.TP
+.B \-d, \-\-delete=TAG
+Delete a tag with the name \fITAG\fR. If no \fIFILE\fR arguments are
+specified, the tag is deleted for ALL files. If \fIFILE\fR arguments
+are specified, only those files have the \fITAG\fR deleted.
+.TP
+.B \-e, \-\-description=STRING
+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
+.B TRACKER_SPARQL_BACKEND
+This option allows you to choose which backend you use for connecting
+to the database. This choice can limit your functionality. There are
+three settings.
+
+With "\fBdirect\fR" the connection to the database is made directly to
+the file itself on the disk, there is no intermediary daemon or
+process. The "\fBdirect\fR" approach is purely \fIread-only\fR.
+
+With "\fBbus\fR" the \fBtracker-store\fR process is used to liase with
+the database queuing all requests and managing the connections via an
+IPC / D-Bus. This adds a small overhead \fIBUT\fR this is the only
+approach you can use if you want to \fIwrite\fR to the database.
+
+With "\fBauto\fR" the backend is decided for you, much like it would
+be if this environment variable was undefined.
+
+.SH SEE ALSO
+.BR tracker-store (1),
+.BR tracker-sparql (1),
+.BR tracker-search (1),
+.BR tracker-info (1).


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