From b4e25ded431fce4aa7e61bb03f78e33a201bfd39 Mon Sep 17 00:00:00 2001 From: Sam Thursfield Date: Tue, 13 Oct 2020 13:36:49 +0200 Subject: website/faq: Add info on troubleshooting indexing errors --- docs/website/faq.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/website/faq.md b/docs/website/faq.md index 2da090c6d..a4076cd9c 100644 --- a/docs/website/faq.md +++ b/docs/website/faq.md @@ -37,6 +37,20 @@ Files named `.trackerignore`, `.git` and `.hg` have the same effect. You can configure this behaviour with the org.freedesktop.Tracker.Miner.Files `ignored-directories-with-content` GSettings key. +## When I search, I don't see all the results I expect. Why? + +If a file doesn't appear in search results, first check that the location is +indexed. From the commandline, you can run: + + $ tracker3 info $FILENAME + +This will show all the information stored about the file, if there is any. + +If the file should be indexed but nothing is shown, you can check +if there was an error while indexing. Use this command: + + $ tracker3 status $FILENAME + ## Why does Tracker consume resources on my PC? When you add or edit files, Tracker will update its index. This should be very -- cgit v1.2.1 From be7529c6a094282991dacec0cb11b6326f89ccb2 Mon Sep 17 00:00:00 2001 From: Sam Thursfield Date: Tue, 13 Oct 2020 13:40:24 +0200 Subject: website/faq: More Tracker 3 related updates Use 'Tracker Miner FS' instead of 'Tracker' in more places, and `tracker3` instead of `tracker`. --- docs/website/faq.md | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/docs/website/faq.md b/docs/website/faq.md index a4076cd9c..96ed1c1c8 100644 --- a/docs/website/faq.md +++ b/docs/website/faq.md @@ -4,17 +4,17 @@ It's a search engine, and a database. -Tracker indexes content from your home directory automatically, so applications -can provide instant search results when you need them. +Tracker Miner FS indexes content from your home directory automatically, so +applications can provide instant search results when you need them. See the [overview](overview) for more information. ## What files will Tracker index? -The default configuration of Tracker is to look at files and folders in your -XDG content directories such as `Documents`, `Music`, `Pictures` and `Videos`. -It also looks at files in your home directory and `Downloads` directory, but -it doesn't recurse into folders. +The default configuration of Tracker Miner FS is to look at files and folders +in your XDG content directories such as `Documents`, `Music`, `Pictures` and +`Videos`. It also looks at files in your home directory and `Downloads` +directory, but it doesn't recurse into folders. You might want to [control what Tracker indexes] so that it finds files in other places too. @@ -22,15 +22,16 @@ other places too. ## How can I control what Tracker indexes? In GNOME, you can use the Search Settings panel to control what Tracker -indexes. See [GNOME's documentation](https://help.gnome.org/users/gnome-help/unstable/files-search.html.en). +Miner FS indexes. See [GNOME's +documentation](https://help.gnome.org/users/gnome-help/unstable/files-search.html.en). -You can control Tracker's configuration directly using +You can control Tracker Miner FS's configuration directly using [dconf-editor](https://wiki.gnome.org/Apps/DconfEditor) or the `gsettings` CLI tool. The relevant schemas are `org.freedesktop.Tracker.Miner.Files` and `org.freedesktop.Tracker.Extract`. -To tell Tracker's indexer to ignore a directory and all its contents, you can +To tell Tracker Miner FS to ignore a directory and all its contents, you can create an empty file named `.nomedia` inside the directory. This trick also works [on Android](https://www.lifewire.com/nomedia-file-4172882) devices. Files named `.trackerignore`, `.git` and `.hg` have the same effect. You can @@ -53,17 +54,18 @@ if there was an error while indexing. Use this command: ## Why does Tracker consume resources on my PC? -When you add or edit files, Tracker will update its index. This should be very -quick, but if a huge number of files are added then it may cause noticably high -CPU and IO usage until the new files have been indexed. This is normal. +When you add or edit files, Tracker Miner FS will update its index. This should +be very quick, but if a huge number of files are added then it may cause +noticably high CPU and IO usage until the new files have been indexed. This is +normal. Tracker is not designed to index directories of source code or video game data. -If content like this appears in the locations Tracker is configured to index +If content like this appears in the locations it is configured to index then you might see unwanted high resource usage. -If you see high resource usage from Tracker even when no files have changed on -disk, this probably indicates a bug in Tracker or one of its dependencies. -We can [work together](community) to find out what the problem is. +If you see high resource usage from Tracker Miner FS even when no files have +changed on disk, this probably indicates a bug in Tracker or one of its +dependencies. We can [work together](community) to find out what the problem is. ## How can I disable Tracker in GNOME? @@ -73,14 +75,13 @@ expected if you disable it completely. If you are experiencing performance problems, see [Why does Tracker consume resources on my PC?](#why-does-tracker-consume-resources-on-my-pc). -In case of a bug you may need to temporarily stop Tracker indexing. +In case of a bug you may need to temporarily stop Tracker Miner FS indexing. The simplest way is to [edit the configuration](#how-can-i-control-what-tracker-indexes) so that no directories are indexed. This should bring resource usage to zero. -If the Tracker store is using a lot of disk space and you are sure that -there is no unreplaceable data stored in the database, you can run `tracker -reset --hard` to delete everything stored in the database. +If the Tracker Miner FS database is using a lot of disk space, you can run +`tracker3 reset --filesystem` to delete everything stored there. ## Can Tracker help me organize my music collection? -- cgit v1.2.1 From a77fdc0f8b802a4a9ab1b1bed30e94032abfd000 Mon Sep 17 00:00:00 2001 From: Sam Thursfield Date: Tue, 20 Oct 2020 20:11:09 +0200 Subject: website/faq: Add more info about recursive $HOME See https://gitlab.gnome.org/GNOME/tracker/-/merge_requests/329#note_933276 --- docs/website/faq.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/website/faq.md b/docs/website/faq.md index 96ed1c1c8..ec4f9a0fc 100644 --- a/docs/website/faq.md +++ b/docs/website/faq.md @@ -14,11 +14,15 @@ See the [overview](overview) for more information. The default configuration of Tracker Miner FS is to look at files and folders in your XDG content directories such as `Documents`, `Music`, `Pictures` and `Videos`. It also looks at files in your home directory and `Downloads` -directory, but it doesn't recurse into folders. +directory, but it doesn't recurse into folders there. You might want to [control what Tracker indexes] so that it finds files in other places too. +## Does Tracker recursively index my home directory? + +Not by default. See [What files will Tracker index](#what-files-will-tracker-index). + ## How can I control what Tracker indexes? In GNOME, you can use the Search Settings panel to control what Tracker -- cgit v1.2.1