luthfianto / rust-tldr

tldr is a simplified and community-driven man pages

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

rust-tldr

A client for tldr, written in Rust.

tldr is a simplified and community-driven man pages.

Preinstallation

Linux

Nothing! You should be good to go!

Windows

Refer to the Windows section of rust-openssl readme

tldr: Install OpenSSL from here. Pick 32/64-bit depending on your system. But Cargo will not be able to find OpenSSL. You can either copy the include/openssl directory, libssl32.dll, and libeay32.dll to locations that Cargo can find or pass the location to Cargo via environment variables:

env OPENSSL_LIB_DIR=C:/OpenSSL-Win64 OPENSSL_INCLUDE_DIR=C:/OpenSSL-Win64/include
cargo build

Or alternatively, download my 64-bit tldr.exe instead from https://github.com/rilut/rust-tldr/releases, and include it to your PATH.

OSX

Refer to the OSX section of rust-openssl readme

tldr: If you are running El Capitan, you will encounter a problem from the missing openssl header when installing the client. To fix that, you should try all of this:

# first, try:
brew link --force openssl

# if it didn't work, try:
export OPENSSL_INCLUDE_DIR=/usr/local/Cellar/openssl/1.0.2d_1/include/

# if it still didn't work, try:
export C_INCLUDE_PATH=/usr/local/Cellar/openssl/1.0.2d_1/include/

Read all of the possible fixes for the El Capitan problems at: sfackler/rust-openssl#255

Installation

$ cargo install tldr

License

MIT

About

tldr is a simplified and community-driven man pages


Languages

Language:Rust 100.0%