NAME¶
tracker-control - Manage Tracker processes and data
SYNOPSIS¶
tracker-control [
OPTION...]
DESCRIPTION¶
tracker-control manages and checks status of all Tracker processes and
data.
Controls Tracker both at process level, and at entity level (store, miners).
To start or stop miners, you can use
--start. The store is started
automatically by the D-Bus calls from the miners.
It also allows checking the status of the Tracker store and all data miners. For
tracker-store , the status is always
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
--list-common-statuses.
The miners can be paused or resumed using this command and you can also list
miners running and available.
COMMON OPTIONS¶
- -?, --help
- Show summary of options by group.
- -?, --help-all
- Show all groups and options.
- -V, --version
- Returns the version of this program.
GENERAL OPTIONS¶
- -p, --list-processes
- This lists all Tracker processes in the system.
- -k, --kill=[all|store|miners]
- 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 GUARANTEES death.
- -t, --terminate=[all|store|miners]
- 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.
- -r, --hard-reset
- This kills all processes in the same way that --kill does but it
also removes all databases. Restarting tracker-store re-creates the
databases.
- -e, --soft-reset
- A soft reset works exactly the same way that --hard-reset does,
with the exception that the backup and journal are not removed. These are
restored when tracker-store is restarted.
- -c, --remove-config
- This removes all config files in $HOME/.config/tracker. All files listed
are files which were found and successfully removed. Restarting the
respective processes re-creates the default configuration files.
- -s, --start
- Starts all miners. This indirectly starts tracker-store too because it is
needed for miners to operate properly.
- -b, --backup=FILE
- Begins backing up the Tracker databases to the FILE given.
- -o, --restore=FILE
- Begins restoring a previous backup (see --backup ) to the Tracker
databases. The FILE points to the location of the backup.
- --get-log-verbosity
- This displays the log verbosity for ALL components using GSettings for
this configuration. For possible values, see
--set-log-verbosity.
- --set-log-verbosity=[debug|detailed|minimal|errors]
- This sets the log verbosity for ALL components using GSettings using this
configuration option ('verbosity').
- --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).
STATUS OPTIONS¶
- -S, --status
- Show the current status of all Tracker entities (store and all available
miners).
- -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.
- -w, --watch=[ONTOLOGY]
- Watch changes that happen to the database in real time. This requires
Ctrl+C to stop and return to the command line.
If the ONTOLOGY is unspecified, all changes are shown. The
ONTOLOGY can be a comma separated list of shorthand or long hand
ontology properties. For example:
$ 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'
...
- --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.
MINER OPTIONS¶
- -m, --reindex-mime-type=MIME
- Re-index files which match the MIME type supplied. This is usually
used when installing new extractors which support MIME types
previously unsupported. This forces Tracker to re-index those files. You
can use --reindex-mime-type more than once per MIME
type.
- -f, --index-file=FILE
- (Re)index a file matching the FILE type supplied.
- --list-miners-running
- This will list all miners which have responded to a D-Bus call. Sometimes
it is helpfult to use this command with
--list-miners-available.
- --list-miners-available
- This will list all miners which are available even if they are not running
at the moment.
- --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.
- --miner=MINER
- This argument is used with --pause or --resume 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
- --pause=REASON
- The REASON 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.
- --pause-for-process=REASON
- This works exactly the same way as --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.
- --resume=COOKIE
- The COOKIE is given by a successful --pause command. It is a number
which identifies each pause request. When all pauses have been resumed,
the miner will resume working.
ENVIRONMENT¶
- TRACKER_MINERS_DIR
- Miners that are installed should have a .desktop file in
/usr/share/tracker/miners/, this is how tracker-control knows about miners
which exist but may not have not been started. This environment variable
allows the location that miner .desktop files are loaded from to be
overridden by setting it to a new path.
- TRACKER_MINERS_DIR_DISABLED
- If you don't have .desktop files for miners, you can use this environment
variable to get status information from RUNNING processes. This
doesn't give any indication for miners NOT running. This uses
registered miners on DBus to know about existing Tracker based data
miners.
SEE ALSO¶
tracker-store(1).