From 72b5a833a673e17fda676c2d10e063c43aee0af7 Mon Sep 17 00:00:00 2001 From: flexagoon Date: Sat, 3 Feb 2024 11:34:25 +0300 Subject: [PATCH] add instructions for tldrc (#295) --- programs/tldr.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/programs/tldr.json b/programs/tldr.json index 3f7a3f65..da071199 100644 --- a/programs/tldr.json +++ b/programs/tldr.json @@ -1,10 +1,15 @@ { "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, - "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" } ] }