Skip to content
/ tldr Public
forked from tldr-pages/tldr

📚 Simplified and community-driven man pages

License

Notifications You must be signed in to change notification settings

chang/tldr

This branch is 13204 commits behind tldr-pages/tldr:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Jan 4, 2018
5d30dbf Â· Jan 4, 2018
Dec 31, 2017
Nov 28, 2017
Jan 4, 2018
Sep 12, 2017
Dec 4, 2015
Jul 28, 2017
Jan 19, 2016
May 9, 2017
Nov 29, 2017
Mar 18, 2017
Dec 6, 2017
May 9, 2017
Jul 16, 2016

Repository files navigation

tldr

Build status Gitter chat Merged PRs Issue stats GitHub contributors Number of files license

A collection of simplified and community-driven man pages.

Install it with npm install -g tldr or try the web client.

What is tldr?

New to the command-line world? Or just a little rusty? Or perhaps you can't always remember the arguments to lsof, or tar?

Maybe it doesn't help that the first option explained in man tar is:

-b blocksize
   Specify the block size, in 512-byte records, for tape drive I/O.
   As a rule, this argument is only needed when reading from or writing to tape drives,
   and usually not even then as the default block size of 20 records (10240 bytes) is very common.

Surely people could benefit from simplified man pages focused on practical examples. How about:

tldr screenshot

This repository is just that: an ever-growing collection of examples for the most common UNIX / Linux / macOS / SunOS commands.

Clients

You can access these pages on your computer using one of the following clients:

There is also a comprehensive list of clients in our Wiki.

Contributing

  • Your favourite command isn't covered?
  • You can think of more examples for an existing command?

Contributions are most welcome! Have a look at the contributing guidelines and go ahead!

Similar projects

  • Cheat allows you to create and view interactive cheatsheets on the command-line. It was designed to help remind *nix system administrators of options for commands that they use frequently, but not frequently enough to remember.

  • Bro pages are a highly readable supplement to man pages. Bro pages show concise, common-case examples for Unix commands. The examples are submitted by the user base, and can be voted up or down; the best entries are what people see first when they look up a command.

  • eg provides detailed examples with explanations on the command line. Examples come from the repository, but eg allows you to display custom examples and commands alongside the defaults.

What does "tldr" mean?

TL;DR stands for "Too Long; Didn't Read". It originates in Internet slang, where it is used to indicate parts of the text skipped as too lengthy. Read more in the TLDR article on Wikipedia.

About

📚 Simplified and community-driven man pages

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TeX 39.8%
  • Shell 30.6%
  • Python 15.1%
  • JavaScript 14.5%