GNOME.org
 

[tracker-miners/sam/manpage-updates] docs: Update some manpages

commit 7b2621363239e718e2a52668c9649e7c50797e6a
Author: Sam Thursfield <sam afuera me uk>
Date:   Sun Apr 12 17:23:07 2020 +0200

    docs: Update some manpages
    
    Remove references to tracker-store(1).
    
    Update tracker-reset and tracker-daemon for recent changes.
    
    Remove "ENVIRONMENT VARIABLES" section, these aren't intended for
    end users.

 docs/manpages/tracker-daemon.1.txt    | 45 +++++++----------------------------
 docs/manpages/tracker-extract.1.txt   | 20 +---------------
 docs/manpages/tracker-miner-fs.1.txt  | 15 +-----------
 docs/manpages/tracker-miner-rss.1.txt |  4 ++--
 docs/manpages/tracker-reset.1.txt     | 19 ++++++---------
 docs/manpages/tracker-search.1.txt    |  3 +--
 docs/manpages/tracker-status.1.txt    |  3 +--
 docs/manpages/tracker-tag.1.txt       |  3 +--
 docs/manpages/tracker-writeback.1.txt |  2 +-
 9 files changed, 23 insertions(+), 91 deletions(-)
---
diff --git a/docs/manpages/tracker-daemon.1.txt b/docs/manpages/tracker-daemon.1.txt
index 808d86a2c..d21281163 100644
--- a/docs/manpages/tracker-daemon.1.txt
+++ b/docs/manpages/tracker-daemon.1.txt
@@ -18,10 +18,7 @@ tracker daemon --miner <miner> --resume <cookie>
 
 == 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.
-
+Tracker indexes content with daemon processes that run in the background.
 The *tracker daemon* command allows for control of these components.
 This ranges from starting, stopping and killing processes to pausing and
 resuming them.
@@ -32,11 +29,7 @@ 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 *tracker-store*, the status is always "Idle" unless it is restoring
-a backup and/or replaying a journal (see also *tracker reset* --soft).
-For a list of common statuses, see *--list-common-statuses*.
+of all Tracker data miners.
 
 The data miners can be paused or resumed using this command and you can
 also list miners running and available.
@@ -45,34 +38,16 @@ also list miners running and available.
 
 *-p, --list-processes*::
   This lists all Tracker processes in the system.
-*-k, --kill=[_daemons_]*::
+*-k, --kill::
   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.
-
-The possible _daemons_ options are:
-
-_____________________________________
-· _all_ - All daemons.
-
-· _store_ - Only the *tracker-store*.
-
-· _miners_ - Only data miners.
-_____________________________________
-
-*-t, --terminate=[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 _daemons_, see --kill.
-
+*-t, --terminate=::
+  This uses SIGTERM to stop all Tracker processes.  This is recommended over
+  --kill because it gives the processes time to shutdown cleanly.
 *-s, --start*::
-  Starts all miners. This indirectly starts *tracker-store* too because
-  it is needed for miners to operate properly. The store is started from
-  D-Bus.
+  Starts all miners.
 *--get-log-verbosity*::
   This displays the log verbosity for ALL components using GSettings for
   this configuration. For possible values, see *--set-log-verbosity.*
@@ -111,7 +86,7 @@ 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
+    $ tracker-daemon -w nie:url,nie:mimeType,nfo:fileSize,nie:dataSource
     Now listening for resource updates to the database
     All nie:plainTextContent properties are omitted
 
@@ -168,7 +143,3 @@ of the miner in question.
   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.
-
-== SEE ALSO
-
-*tracker-store*(1).
diff --git a/docs/manpages/tracker-extract.1.txt b/docs/manpages/tracker-extract.1.txt
index ed081fda4..c277dbb52 100644
--- a/docs/manpages/tracker-extract.1.txt
+++ b/docs/manpages/tracker-extract.1.txt
@@ -50,27 +50,9 @@ Using command line to extract metadata from a file:::
 
 $ tracker extract /path/to/some/file.mp3
 
-== ENVIRONMENT
-
-*TRACKER_EXTRACTORS_DIR*::
-  This is the directory which tracker uses to load the shared libraries
-  from (used for extracting metadata for specific file types). These are
-  needed on each invocation of tracker-store. If unset it will default
-  to the correct place. This is used mainly for testing purposes. The
-  default location is /usr/lib/tracker-1.0/extract-modules/.
-*TRACKER_EXTRACTOR_RULES_DIR*::
-  This is the directory which tracker uses to load the rules files from.
-  The rules files describe extractor modules and their supported MIME
-  types. The default location is /usr/share/tracker/extract-rules/.
-*TRACKER_USE_CONFIG_FILES*::
-  Don't use GSettings, instead use a config file similar to how settings
-  were saved in 0.10.x. That is, a file which is much like an .ini file.
-  These are saved to $HOME/.config/tracker/
-
 == SEE ALSO
 
-*tracker-store*(1), *tracker-sparql*(1), *tracker-stats*(1),
-*tracker-info*(1).
+*tracker-sparql*(1), *tracker-stats*(1), *tracker-info*(1).
 
 - */usr/lib/tracker-1.0/extract-modules/*
 - */usr/share/tracker/extract-rules/*
diff --git a/docs/manpages/tracker-miner-fs.1.txt b/docs/manpages/tracker-miner-fs.1.txt
index 34e591d71..6ef1948f5 100644
--- a/docs/manpages/tracker-miner-fs.1.txt
+++ b/docs/manpages/tracker-miner-fs.1.txt
@@ -41,19 +41,6 @@ than one instance of this at the same time.
   would be monitored for changes. This works with non-existing *FILE*
   arguments as well as existing *FILE* arguments.
 
-== ENVIRONMENT
-
-*TRACKER_USE_LOG_FILES*::
-  Don't just log to stdout and stderr, but to log files too which are
-  kept in $HOME/.local/share/tracker/. This came into effect in 0.15.3
-  and 0.16.0. After this version of Tracker, logging to file (usually
-  useful for debugging) can only be done by declaring this environment
-  variable.
-*TRACKER_USE_CONFIG_FILES*::
-  Don't use GSettings, instead use a config file similar to how settings
-  were saved in 0.10.x. That is, a file which is much like an .ini file.
-  These are saved to $HOME/.config/tracker/
-
 == SEE ALSO
 
-*tracker-store*(1), *tracker-info*(1).
+*tracker-info*(1).
diff --git a/docs/manpages/tracker-miner-rss.1.txt b/docs/manpages/tracker-miner-rss.1.txt
index 1a752fd26..868c51204 100644
--- a/docs/manpages/tracker-miner-rss.1.txt
+++ b/docs/manpages/tracker-miner-rss.1.txt
@@ -27,7 +27,7 @@ than one instance of this at the same time.
 *-v, --verbosity=\{0|1|2|3}*::
   Sets the logging level, 0=errors, 1=minimal, 2=detailed, 3=debug.
 *-a, --add-feed=URL*::
-  Adds a feed to the Tracker store. This must be used with *--title*
+  Adds a feed to be indexed. This must be used with *--title*
   option. An examples of such a URL would be:
 
 http://planet.gnome.org/atom.xml
@@ -43,4 +43,4 @@ You can use *tracker-search --feeds* to get the latest feed information.
 
 == SEE ALSO
 
-*tracker-store*(1), *tracker-info*(1), *tracker-search*(1).
+*tracker-info*(1), *tracker-search*(1).
diff --git a/docs/manpages/tracker-reset.1.txt b/docs/manpages/tracker-reset.1.txt
index 32c1b6f86..2a2293fb3 100644
--- a/docs/manpages/tracker-reset.1.txt
+++ b/docs/manpages/tracker-reset.1.txt
@@ -7,7 +7,7 @@ tracker-reset - Reset the index and configuration
 
 == SYNOPSIS
 
-*tracker reset* [--hard | --soft] [--config] [--file _FILE_]
+*tracker reset* [--filesystem | --rss] [--config] [--file _FILE_]
 
 == DESCRIPTION
 
@@ -25,16 +25,11 @@ hard reset option. This behaves as if Tracker was just installed.
 
 == OPTIONS
 
-*-r, --hard*::
-  This kills all processes in the same way that *tracker daemon* --kill
-  does but it also removes all databases. Restarting *tracker-store*
-  re-creates the databases.
-*-e, --soft*::
-  A soft reset works exactly the same way that *--hard* does, with the
-  exception that the backup and journal are not removed. These are
-  restored when *tracker-store* 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.
+*--filesystem*::
+  Removes data stored by tracker-miner-fs(1). The miner will automatically
+  recreate its cache from the filesystem when it restarts.
+*--rss::
+  Removes data stored by tracker-miner-rss(1).
 *-c, --config*::
   Resets all configuration to its defaults.
 *-f, --file _FILE_*::
@@ -45,4 +40,4 @@ hard reset option. This behaves as if Tracker was just installed.
 
 == SEE ALSO
 
-*tracker-daemon*(1). *tracker*(1).
+*tracker-daemon*(1). *tracker-miner-fs*(1), *tracker-miner-rss*(1).
diff --git a/docs/manpages/tracker-search.1.txt b/docs/manpages/tracker-search.1.txt
index 6ab9241f5..8377e4910 100644
--- a/docs/manpages/tracker-search.1.txt
+++ b/docs/manpages/tracker-search.1.txt
@@ -94,5 +94,4 @@ _expression_::
 
 == SEE ALSO
 
-*tracker-store*(1), *tracker-stats*(1), *tracker-tag*(1),
-*tracker-info*(1).
+*tracker-stats*(1), *tracker-tag*(1), *tracker-info*(1).
diff --git a/docs/manpages/tracker-status.1.txt b/docs/manpages/tracker-status.1.txt
index ae9e44b44..c558d0986 100644
--- a/docs/manpages/tracker-status.1.txt
+++ b/docs/manpages/tracker-status.1.txt
@@ -58,8 +58,7 @@ finally statistics about the data in the database (e.g. how many
 
 == SEE ALSO
 
-*tracker-store*(1), *tracker-control*(1), *tracker-sparql*(1),
-*tracker-info*(1).
+*tracker-daemon*(1), *tracker-sparql*(1), *tracker-info*(1).
 
 - *http://nepomuk.semanticdesktop.org/*
 - *http://www.w3.org/TR/rdf-sparql-query/*
diff --git a/docs/manpages/tracker-tag.1.txt b/docs/manpages/tracker-tag.1.txt
index da28d26c7..640090627 100644
--- a/docs/manpages/tracker-tag.1.txt
+++ b/docs/manpages/tracker-tag.1.txt
@@ -71,5 +71,4 @@ tags.
 
 == SEE ALSO
 
-*tracker-store*(1), *tracker-sparql*(1), *tracker-search*(1),
-*tracker-info*(1).
+*tracker-sparql*(1), *tracker-search*(1), *tracker-info*(1).
diff --git a/docs/manpages/tracker-writeback.1.txt b/docs/manpages/tracker-writeback.1.txt
index fabfac556..cb67d4363 100644
--- a/docs/manpages/tracker-writeback.1.txt
+++ b/docs/manpages/tracker-writeback.1.txt
@@ -39,4 +39,4 @@ tracker-miner-fs configuration.
 
 == SEE ALSO
 
-*tracker-store*(1), *tracker-miner-fs*(1). *tracker-extract*(1).
+*tracker-miner-fs*(1). *tracker-extract*(1).
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]