principis/tldr-sharp

C# tldr-pages client

tldr-sharp

A C# based, feature-rich command-line client for tldr-pages.

Requirements

• .NET Runtime 6.0 (or newer). Download it from here.

Installation

Linux

Ubuntu/Debian

Install the latest Debian package.

Fedora

tldr-sharp is available in COPR

sudo dnf copr enable principis/tldr-sharp
sudo dnf --refresh install tldr-sharp

Manual

Download and extract the latest release.

mkdir tldr-sharp
tar xzf <version>.tar.gz -C tldr-sharp
sudo chown -R root:root tldr-sharp
sudo cp -pr tldr-sharp /usr/local/lib/
sudo ln -s /usr/local/lib/tldr-sharp/tldr-sharp /usr/local/bin/tldr-sharp

Windows

Note: Your antivirus may detect tldr-sharp as a virus.

It is recommended to use the new Windows Terminal, so the highlighting works as expected.

Installer

Download and run the installer.

Manual installation

• Download the latest release
• Extract to a folder of choice, for example C:\ProgramData\tldr-sharp
• Copy tldr-sharp.exe to tldr.exe
• Add it to the path
  • Open Control Panel (old style)
  • On the System page, click Advanced system settings on the left-hand side
  • In the dialog window, click on the Environment Variables button
  • In User variables select Path and click Edit
  • In the popup, click New and add the path where you've installed tldr-sharp as follows: C:\ProgramData\tldr-sharp
• Reboot to make sure the Path is updated

You can now use tldr-sharp by entering tldr tar in your favorite shell.

Usage

Usage: tldr command [options]
Simplified and community-driven man pages
  -a, --list-all             List all pages
  -c, --clear-cache          Clear the local cache
  -f, --render=VALUE         Render a specific markdown file
  -h, --help                 Display this help text
  -l, --list                 List all pages for the current platform and
                               language
      --list-platforms       List all platforms
      --list-languages       List all languages
  -L, --language, --lang=VALUE
                             Specifies the preferred language
  -m, --markdown             Show the markdown source of a page
  -p, --platform=VALUE       Override the default platform
  -s, --search=VALUE         Search for a string
  -u, --update               Update the local cache
      --self-update          Check for tldr-sharp updates
  -v, --version              Show version information

License

• This project is licensed under GPL-3.0-or-later.
• Some configuration and scripts are licensed under CC0-1.0.

For more accurate information, check the individual files.

Contributing

Contributions are always welcome! Please open an issue first.

tldr-sharp's Issues

BadImageFormatException in Mono.Data.Sqlite with Releases starting from v2.6.1

Using any Release newer than v2.6.0 (I tried each release from v2.6.1 to v2.6.4) results in the following exception for me:

Unbehandelte Ausnahme: System.BadImageFormatException: Es wurde versucht, eine Datei mit einem falschen Format zu laden. (Ausnahme von HRESULT: 0x8007000B)
   bei Mono.Data.Sqlite.UnsafeNativeMethods.sqlite3_open_v2(Byte[] utf8Filename, IntPtr& db, Int32 flags, IntPtr vfs)
   bei Mono.Data.Sqlite.SQLite3.Open(String strFilename, SQLiteOpenFlagsEnum flags, Int32 maxPoolSize, Boolean usePool)
   bei Mono.Data.Sqlite.SqliteConnection.Open()
   bei tldr_sharp.Index.ListLanguages()
   bei tldr_sharp.Locale.GetPreferredLanguages()
   bei tldr_sharp.PageController.Print(String pageName, String prefLanguage, String platform, Boolean markdown)
   bei tldr_sharp.Program.doMain(String[] args)
   bei tldr_sharp.Program.Main(String[] args)

The first line translated means something like
Unhandled Exception: System.BadImageFormatException: It was attempted to load a file with a wrong format.
bei means at

I also tried clearing cache with v2.6.4 which did not help.
I also tried to replace the .tldr folder with a copy from v2.6.0 while v2.6.4 is installed … did not help as well …
Release v2.6.0 works.

incorrect display in cmd, windows powershell

the color doesn't display correctly in windows cmd, powershell.
However, it works in the new windows terminal

Language field in the pages SQL table is too short

I was looking at the code in Program.cs and I see you're using a VARCHAR(2) for the language when creating the pages table (here). Language identifiers can be longer than 2 characters, as described here in the translation guidelines (I'd say they could reach up to 7 characters), so this should probably be updated.