TLDR Pages

Short description: Simplified and community-driven man pages

tldr-pages

Screenshot of a CLI client for tldr-pages

Original author(s)| Romain Prieto
Initial release| December 8, 2013; 12 years ago (2013-12-08)[1]
Repository| github.com/tldr-pages/tldr
Written in| Markdown
Platform| Multiplatform
Available in| German, Spanish, Farsi, French, Indonesian, Italian, Japan , Korean, Malayalam, Dutch, Norwegian, Portugal, Russian, Swedish, Slovene, Hindi, Tamil, Thai, Turkish, Chinese,Ukrainian, Arabic, Bengali, Bosnian, Catalan, Persian
Type| Software documentation
License| CC BY-SA 4.0
MIT License
Website| tldr.sh

TLDR Pages (stylized as tldr-pages) is a free and open-source collaborative software documentation project that aims to be a simpler, more approachable complement to traditional man pages. It's a collection of community-maintained help pages that covers command-line utilities and other computer programs. A page can be invoked by issuing the `tldr` command.[2][3] The name comes from the word TL;DR, which is an abbreviation for "too long; didn't read", referring to man pages that are said to be too long by several users.[4]

As of December 2022, its repository on GitHub has more than 41,000 stars and 3,500 forks.[5]

## Contents

* 1 History
* 2 Formatting
* 3 Command usage
* 4 Authoring
* 5 Licensing
* 6 See also
* 7 References
* 8 External links

## History

Romain Prieto started the project by making the first commit on the popular code hosting and version control site GitHub, on 8 December 2013 at 19:56:16 according to the timezone of their personal computer.[1]

At first, only a handful of people were contributing to the project. By the end of 2015, with the help of unknown Chinese publications promoting it, the project has seen a rapid amount of growth in popularity on GitHub, leaving popular software and programming languages like Swift in behind.[6] On 25 December 2015, the project ended up trending at 3rd place.[7] By 27 December 2015, the repository had reached 2700+ stars, having gained approximately 700 of it only in a week.[8] In the following day, the project reached to the front page of Hacker News.[9] After the post, the amount of stars received by the project reached to 3700+ and the project itself arrived at #1 in daily popularity within the day.[10][11] The project had seen another bump in late 2017 and later kept a stable increase of popularity to this day.[12]

## Formatting

The default formatting usage of tldr-pages is Markdown, a popular markup language used in many other free software and documentation projects.[13]

While the project has its own custom `{{token_syntax}}` extension, it adheres to CommonMark specification. In fact the project specifications require that clients are fully compatible with CommonMark.

## Command usage

Get typical usages of a command:

tldr command

To see what can be done, a reasonably nice command would be:

tldr tldr

Show the tar TLDR page for Linux:

tldr -p linux tar

Get help for a Git subcommand:

tldr git-checkout

Update local pages (if the client supports caching):

tldr -u

## Authoring

TLDR Pages can be written in any text editor that supports CommonMark formatting.[13]

To make a contribution to the tldr-pages repository on GitHub, you need to sign the Contributor License Agreement and follow the project's guidelines, which are said to be not strict rules but auxiliary information to keep simple nature of the pages.

## Licensing

The pages are licensed under the Creative Commons Attribution 4.0 International License, while the contents of the `scripts/` directory are licensed under MIT License. Any contributions to the project are governed under the Contributor License Agreement.

## See also

* List of Unix commands
* Man page
* info
* apropos
* Collaborative innovation network

## References

1. ↑ 1.0 1.1 commit 11264d9b19000734a2d35ecbdbdebc0b0b45aed9
2. ↑ "TLDR Pages: Simplified and Community-Driven Man pages". https://laravel-news.com/tldr-pages.
3. ↑ "TLDR - Easy to Understand Man Pages for Every Linux User". 16 January 2019. https://www.tecmint.com/tldr-easy-to-understand-linux-man-pages/.
4. ↑ "TLDR pages: Simplified, community-driven man pages". January 22, 2020. http://www.reddit.com/r/linux/comments/ese2dt/tldr_pages_simplified_communitydriven_man_pages/.
5. ↑ /web/20210301121724/https://github.com/tldr-pages/tldr
6. ↑ "tldr-pages/tldr - Gitter". https://gitter.im/tldr-pages/tldr/archives/2015/12/25.
7. ↑ "Monosnap". https://monosnap.com/file/LjjQCt1n5EP0iuY7l199ysrgHlAkuG.
8. ↑ "tldr-pages/tldr - Gitter". https://gitter.im/tldr-pages/tldr/archives/2015/12/27?at=56806f6b653b30761d7644c9.
9. ↑ "TLDR pages | Hacker News". https://news.ycombinator.com/item?id=10797303.
10. ↑ "tldr-pages/tldr - Gitter". https://gitter.im/tldr-pages/tldr/archives/2015/12/28?at=5681c31f35e1a316162e7b62.
11. ↑ @asyncadventures (28 December 2015). "Sometimes, a little side project is useful to other people and goes trending :) Thanks to all the TLDR contributors!". https://twitter.com/asyncadventures/status/681594304108756992.
12. ↑ "Star history". https://star-history.t9t.io/.
13. ↑ 13.0 13.1 "tldr-pages/tldr". 23 November 2021. https://github.com/tldr-pages/tldr.

## External links

* Repository
* PDF documentation

* v
* t
* e

Free and open-source software

General|

* Alternative terms for free software
* Comparison of open-source and closed-source software
* Comparison of source-code-hosting facilities
* Free software
* Free software project directories
* Gratis versus libre
* Long-term support
* Open-source software
* Open-source software development
* Outline

Software
packages|

* Audio
* Bioinformatics
* Codecs
* Collaboration
* Configuration management
* Device drivers
* Graphics
* Wireless
* Geophysics
* Health
* Mathematics
* Operating systems
* Programming languages
* Routing
* Statistics
* Television
* Video games
* Web applications
* Content management systems
* E-commerce
* Word processors
* Android apps
* iOS apps
* Commercial
* Trademarked
* Formerly proprietary

Community|

* Free software movement
* History
* Open-source-software movement
* Organizations
* Events

Licenses|

* AFL
* Apache
* APSL
* Artistic
* Beerware
* Boost
* BSD
* CC0
* CDDL
* EPL
* Free Software Foundation
* GNU GPL
* GNU LGPL
* ISC
* MIT
* MPL
* Ms-PL/RL
* Python
* Python Software Foundation License
* Sleepycat
* Unlicense
* WTFPL
* zlib

| Types and
standards|

* Comparison of free and open-source software licenses
* Contributor License Agreement
* Copyleft
* Debian Free Software Guidelines
* Definition of Free Cultural Works
* Free license
* The Free Software Definition
* The Open Source Definition
* Open-source license
* Permissive software license
* Public domain
* Viral license

|

Challenges|

* Digital rights management
* Firmware security
* Hardware restrictions
* License proliferation
* Mozilla software rebranding
* Proprietary device drivers
* Proprietary firmware
* Proprietary software
* SCO/Linux controversies
* Secure boot
* Software patents
* Software security
* Trusted Computing

Related topics|

* Forking
* GNU Manifesto
* Microsoft Open Specification Promise
* Open-core model
* Open-source hardware
* Shared Source Initiative
* Source-available software
* The Cathedral and the Bazaar
* Revolution OS

*   * Category
* Commons
* WikiProject
* Book

0.00

(0 votes)

|

Retrieved from "https://handwiki.org/wiki/index.php?title=Software:TLDR_Pages&oldid=539285"
*[v]: View this template
*[t]: Discuss this template
*[e]: Edit this template