[tracker-miners/wip/carlosg/cli-improvements] docs: Update manpages



commit 512604b6c42fe25153d4d66667b9367929ae1b64
Author: Carlos Garnacho <carlosg gnome org>
Date:   Tue Aug 18 13:55:17 2020 +0200

    docs: Update manpages
    
    So they reflect the tracker3 status/index changes.

 docs/manpages/tracker-index.1.txt  | 13 ++++++-------
 docs/manpages/tracker-status.1.txt | 22 ++++++----------------
 2 files changed, 12 insertions(+), 23 deletions(-)
---
diff --git a/docs/manpages/tracker-index.1.txt b/docs/manpages/tracker-index.1.txt
index d1df8cf0a..5f26c9b46 100644
--- a/docs/manpages/tracker-index.1.txt
+++ b/docs/manpages/tracker-index.1.txt
@@ -8,19 +8,18 @@ tracker-index - Index content using the Tracker filesystem miner
 == SYNOPSIS
 
 ....
-tracker index <path> [[path] ...]
+tracker index
+tracker index --add [--recursive] <dir> [[dir] ...]
+tracker index --remove <path> [[dir] ...]
 ....
 
 == DESCRIPTION
 
 This command causes the Tracker filesystem miner to process the given
-files or directories.
+directories. These changes are persistent across future restarts.
 
-Usually you should configure the miner to automatically index your
-content, because it will monitor the content locations for changes and
-ensure that the index is kept up to date. Content that is added using
-`tracker index` will not be monitored for changes by default, so you can
-end up with stale data in your search results if you use this command.
+If invoked without arguments, the currently indexed locations will be
+listed.
 
 == SEE ALSO
 
diff --git a/docs/manpages/tracker-status.1.txt b/docs/manpages/tracker-status.1.txt
index c558d0986..7402b9656 100644
--- a/docs/manpages/tracker-status.1.txt
+++ b/docs/manpages/tracker-status.1.txt
@@ -9,21 +9,22 @@ tracker-status - Provide status and statistics on the data indexed
 
 ....
 tracker status
+tracker status [[expression1]...]
 tracker status --stat [-a] [[expression1]...]
-tracker status --collect-debug-info
 ....
 
 == DESCRIPTION
 
-Display the status of the current index and data set.
+Display the status of the current index and data set. A summary of
+recorded failures during file metadata indexing is also displayed.
+
+Providing a search expression will list the full details of the
+recorded failures matching the filename.
 
 With the *--stat* 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 *--collect-debug-info* option.
-
 == OPTIONS
 
 *--stat[=__expression__]*::
@@ -45,17 +46,6 @@ possible classes matching _expression_, see *tracker sparql -c*.
 This option is implied if search terms are provided to filter ALL
 possible statistics.
 
-*--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).
-
 == SEE ALSO
 
 *tracker-daemon*(1), *tracker-sparql*(1), *tracker-info*(1).


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