Align history files to XDG specification (#426)

[xdg-ninja.git] / programs / tldr.json

diff --git a/programs/tldr.json b/programs/tldr.json
index 3f7a3f65e893ab2512cfd56921af025cd3307dde..da071199caeab72d1ca10a0aa027a99c9f717d0a 100644 (file)
--- a/programs/tldr.json
+++ b/programs/tldr.json
@@ -1,10 +1,15 @@
 {
     "name": "tldr",
     "files": [
 {
     "name": "tldr",
     "files": [

+        {
+            "path": "$HOME/.tldr",
+            "movable": true,
+            "help": "Tldr has multiple official clients, so the instructions depend on your installation method.\n\nIf you're using the C client, export the following environment variable:\n\n```bash\nexport TLDR_CACHE_DIR=\"$XDG_CACHE_HOME\"/tldr\n```\n\nThe Python client and tlrc (Rust client) use the correct XDG directory out of the box.\n\n**There is currently no way to use an XDG directory in the Node.js client.**\n"
+        },

         {
             "path": "$HOME/.tldrc",
             "movable": true,
         {
             "path": "$HOME/.tldrc",
             "movable": true,

-            "help": "Currently tldr-pages do not have any specification for clients on where to cache tldr-pages. See the relevant [issue](https://github.com/tldr-pages/tldr/issues/876) and [specification](https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md)\n\nOfficial tldr-nodejs-client, tldr-python-client or tldr-c-client do not support XDG Base Directories.\n\n**Use [Tealdeer](https://github.com/dbrgn/tealdeer), a rust client for tldr that supports XDG Base Directories instead.**\n"
+            "help": "Tldr has multiple official clients, so the instructions depend on your installation method.\n\nIf you're using the C client, export the following environment variable:\n\n```bash\nexport TLDR_CACHE_DIR=\"$XDG_CACHE_HOME\"/tldr\n```\n\nThe Python client and tlrc (Rust client) use the correct XDG directory out of the box.\n\n**There is currently no way to use an XDG directory in the Node.js client.**\n"

         }
     ]
 }
         }
     ]
 }