Skip to content
📚 Simplified and community-driven man pages
Shell Python JavaScript CSS
Branch: master
Clone or download

Latest commit

3 authors dnf: add and reorder examples (#4063)
Co-authored-by: Zlatan Vasović <zlatanvasovic@gmail.com>
Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
Latest commit c7ae6b3 May 28, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Harmonize project name (lowercase tldr, no semicolon, hyphen-separated) May 27, 2020
contributing-guides Harmonize project name (lowercase tldr, no semicolon, hyphen-separated) May 27, 2020
images Harmonize project name (lowercase tldr, no semicolon, hyphen-separated) May 27, 2020
pages.de/common multiple pages: add missing periods (#3799) Jan 25, 2020
pages.es git-add: add Spanish translation of an example Feb 9, 2020
pages.fr/common rsync: add French translation (#4015) May 21, 2020
pages.hbs/common sha512sum: add hbs translation Feb 7, 2020
pages.it/common date: fix typo (#4069) May 27, 2020
pages.ja/common tldr: add japanese translation (#3774) Jan 22, 2020
pages.ko/common date: fix typo (#4069) May 27, 2020
pages.pl/common update vue Apr 19, 2020
pages.pt_BR multiple pages: Github -> GitHub (#4060) May 22, 2020
pages.pt_PT Update pages.pt_PT/linux/gedit.md Apr 3, 2020
pages.ta/common ab, ack: add Tamil translation (revived) (#3761) Jan 16, 2020
pages.zh date: fix typo (#4069) May 27, 2020
pages dnf: add and reorder examples (#4063) May 28, 2020
scripts Harmonize project name (lowercase tldr, no semicolon, hyphen-separated) May 27, 2020
.editorconfig Trim .editorconfig (#3678) Dec 31, 2019
.gitignore Harmonize project name (lowercase tldr, no semicolon, hyphen-separated) May 27, 2020
.markdownlintrc markdownlint: increase maximum line length to 250 May 7, 2019
.travis.yml Update Travis CI to run on Bionic Beaver Mar 10, 2020
CLIENT-SPECIFICATION.md Minor formatting fixes May 27, 2020
COMMUNITY-ROLES.md Minor formatting fixes May 27, 2020
CONTRIBUTING.md Harmonize project name (lowercase tldr, no semicolon, hyphen-separated) May 27, 2020
GOVERNANCE.md GOVERNANCE.md: link to the maintainer's guide Nov 27, 2018
LICENSE.md Minor formatting fixes May 27, 2020
MAINTAINERS.md Add organization member: @schneiderl (#3766) Jan 19, 2020
README.md Minor formatting fixes May 27, 2020
package-lock.json build(deps): bump minimist from 1.2.0 to 1.2.5 (#3921) Mar 18, 2020
package.json Harmonize project name (lowercase tldr, no semicolon, hyphen-separated) May 27, 2020

README.md

tldr

Build status Gitter chat Merged PRs Issue stats GitHub contributors 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-pages?

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:

screenshot of the tldr-node-client displaying the tldr page for the tar command

This repository is just that: an ever-growing collection of examples for the most common UNIX, Linux, macOS, SunOS and Windows 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! We strive to maintain a welcoming and collaborative community. 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 supports displaying 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 that a long text (or parts of it) has been skipped as too lengthy. Read more in Wikipedia's TL;DR article.

You can’t perform that action at this time.