ExTldr is an Elixir client for tldr-pages.
- Erlang/OTP installed (it does not require Elixir, because Elixir is embedded in the script).
- Read Erlang package from official repositories (Linux) to know about tested versions of Erlang available on some Linux distributions.
- Download ExTldr. You can:
- Download the latest release.
- Clone this repository.
Once you have downloaded ExTldr, and unzipped in the case you downloaded a release, you can execute the script: ./extldr
The script's first argument is the operating system, and the second argument is the command/term you want to search. Below there are some examples:
-
Search command
feh
in the pages of your current operating system:extldr feh
-
Search Linux command
adduser
:extldr linux adduser
-
Search a common command,
chroot
, in different operating systems:extldr common chroot
-
Search Linux command
cat
, available in common pages due it is available in different operating systems:extldr linux cat
Then, if you like, you can make it globally available with a symbolic link or adding it to your PATH
.
Although I prefer to track possible enhancements and ideas in the issues, below there are some essentials:
- Multilingual support (#1).
- Check by default the operating system in which ExTldr is being executed (#2).
ExTldr is heavily inspired by the great and awesome work of the tldr-pages community and the actually archived TLDR Elixir Client developed by Eduardo Gurgel.
ExTldr is licensed under the GNU General Public License v3.0.