TLDR Pages

Last updated
tldr-pages
Original author(s) Romain Prieto
Initial releaseDecember 8, 2013;9 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]

Contents

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

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:

tldrcommand

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

tldrtldr

Show the tar TLDR page for Linux:

tldr-plinuxtar

Get help for a Git subcommand:

tldrgit-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

Related Research Articles

man page Unix software documentation

A man page is a form of software documentation usually found on a Unix or Unix-like operating system. Topics covered include computer programs, formal standards and conventions, and even abstract concepts. A user may invoke a man page by issuing the man command.

<span class="mw-page-title-main">Blackbox</span> Free and open-source stacking window manager for the X Window System

Blackbox is a free and open-source stacking window manager for the X Window System.

<span class="mw-page-title-main">Arch Linux</span> Rolling release distribution of Linux

Arch Linux is an independently developed, x86-64 general-purpose Linux distribution that strives to provide the latest stable versions of most software by following a rolling-release model. The default installation is a minimal base system, configured by the user to only add what is purposely required.

<span class="mw-page-title-main">BitlBee</span>

BitlBee is a cross-platform IRC instant messaging gateway, licensed under the terms of the GNU General Public License.

<span class="mw-page-title-main">Git</span> Software for version control of files

Git is a distributed version control system that tracks changes in any set of computer files, usually used for coordinating work among programmers who are collaboratively developing source code during software development. Its goals include speed, data integrity, and support for distributed, non-linear workflows.

In software development, distributed version control is a form of version control in which the complete codebase, including its full history, is mirrored on every developer's computer. Compared to centralized version control, this enables automatic management branching and merging, speeds up most operations, improves the ability to work offline, and does not rely on a single location for backups. Git, the world's most popular version control system, is a distributed version control system.

<span class="mw-page-title-main">AppImage</span> Linux executable file format

AppImage is a format for distributing portable software on Linux without needing superuser permissions to install the application. It tries also to allow Linux distribution-agnostic binary software deployment for application developers, also called upstream packaging. Released first in 2004 under the name klik, it was continuously developed, then renamed in 2011 to PortableLinuxApps and later in 2013 to AppImage.

<span class="mw-page-title-main">Embeddable Linux Kernel Subset</span>

The Embeddable Linux Kernel Subset (ELKS), formerly known as Linux-8086, is a Linux-like operating system kernel. It is a subset of the Linux kernel, intended for 16-bit computers with limited processor and memory resources such as machines powered by Intel 8086 and compatible microprocessors not supported by 32-bit Linux.


This is a comparison of notable free and open-source configuration management software, suitable for tasks like server configuration, orchestration and infrastructure as code typically performed by a system administrator.

A Contributor License Agreement (CLA) defines the terms under which intellectual property has been contributed to a company/project, typically software under an open source license.

<span class="mw-page-title-main">GitHub</span> Hosting service for software projects

GitHub, Inc. is a platform and cloud-based service for software development and version control using Git, allowing developers to store and manage their code. It provides the distributed version control of Git plus access control, bug tracking, software feature requests, task management, continuous integration, and wikis for every project. Headquartered in California, it has been a subsidiary of Microsoft since 2018.

<span class="mw-page-title-main">Jami (software)</span> Distributed multimedia communications platform

Jami is a SIP-compatible distributed peer-to-peer softphone and SIP-based instant messenger for Linux, Microsoft Windows, macOS, iOS, and Android. Jami was developed and maintained by the Canadian company Savoir-faire Linux, and with the help of a global community of users and contributors, Jami positions itself as a potential free Skype replacement.

<span class="mw-page-title-main">Homebrew (package manager)</span> Software installation management software

Homebrew is a free and open-source software package management system that simplifies the installation of software on Apple's operating system, macOS, as well as Linux. The name is intended to suggest the idea of building software on the Mac depending on the user's taste. Originally written by Max Howell, the package manager has gained popularity in the Ruby on Rails community and earned praise for its extensibility. Homebrew has been recommended for its ease of use as well as its integration into the command-line interface. Homebrew is a member of the Open Source Collective, and is run entirely by unpaid volunteers.

Docker is a set of platform as a service (PaaS) products that use OS-level virtualization to deliver software in packages called containers. The service has both free and premium tiers. The software that hosts the containers is called Docker Engine. It was first released in 2013 and is developed by Docker, Inc.

The OpenAPI Specification, previously known as the Swagger Specification, is a specification for a machine-readable interface definition language for describing, producing, consuming and visualizing web services. Previously part of the Swagger framework, it became a separate project in 2016, overseen by the OpenAPI Initiative, an open-source collaboration project of the Linux Foundation.

<span class="mw-page-title-main">Gitter</span> Open source messaging software

Gitter is an open-source instant messaging and chat room system for developers and users of GitLab and GitHub repositories. Gitter is provided as software-as-a-service, with a free option providing all basic features and the ability to create a single private chat room, and paid subscription options for individuals and organisations, which allows them to create arbitrary numbers of private chat rooms.

<span class="mw-page-title-main">Borg (backup software)</span> Deduplicating backup program

Borg is deduplicating backup software for various Unix-like operating systems.

<span class="mw-page-title-main">Swagger (software)</span> Computing language

Swagger is a suite of tools for API developers from SmartBear Software and a former specification upon which the OpenAPI Specification is based.

Microsoft, a technology company historically known for its opposition to the open source software paradigm, turned to embrace the approach in the 2010s. From the 1970s through 2000s under CEOs Bill Gates and Steve Ballmer, Microsoft viewed the community creation and sharing of communal code, later to be known as free and open source software, as a threat to its business, and both executives spoke negatively against it. In the 2010s, as the industry turned towards cloud, embedded, and mobile computing—technologies powered by open source advances—CEO Satya Nadella led Microsoft towards open source adoption although Microsoft's traditional Windows business continued to grow throughout this period generating revenues of 26.8 billion in the third quarter of 2018, while Microsoft's Azure cloud revenues nearly doubled.

youtube-dl is a free and open source download manager for video and audio from YouTube and over 1,000 other video hosting websites. It is released under the Unlicense software license.

References

  1. 1 2 commit 11264d9b19000734a2d35ecbdbdebc0b0b45aed9
  2. ↑ "TLDR Pages: Simplified and Community-Driven Man pages". Laravel News.
  3. ↑ "TLDR - Easy to Understand Man Pages for Every Linux User". www.tecmint.com. 16 January 2019.
  4. ↑ "TLDR pages: Simplified, community-driven man pages". January 22, 2020.
  5. ↑ /web/20210301121724/https://github.com/tldr-pages/tldr
  6. ↑ "tldr-pages/tldr - Gitter". gitter.im.
  7. ↑ "Monosnap". monosnap.com.
  8. ↑ "tldr-pages/tldr - Gitter". gitter.im.
  9. ↑ "TLDR pages | Hacker News". news.ycombinator.com.
  10. ↑ "tldr-pages/tldr - Gitter". gitter.im.
  11. ↑ @asyncadventures (28 December 2015). "Sometimes, a little side project is useful to other people and goes trending :) Thanks to all the TLDR contributors!" (Tweet) – via Twitter.
  12. ↑ "Star history". star-history.t9t.io. Archived from the original on 18 February 2021. Retrieved 13 January 2022.
  13. 1 2 "tldr-pages/tldr". GitHub. 23 November 2021.
This page is based on this Wikipedia article
Text is available under the CC BY-SA 4.0 license; additional terms may apply.
Images, videos and audio are available under their respective licenses.