Skip to content

Commit

Permalink
add instructions for tldrc (#295)
Browse files Browse the repository at this point in the history
  • Loading branch information
flexagoon committed Feb 3, 2024
1 parent c87ab80 commit 72b5a83
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion programs/tldr.json
Original file line number Diff line number Diff line change
@@ -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"
}
]
}

0 comments on commit 72b5a83

Please sign in to comment.