A simplified documentation command
Command Line – tldr

© Lead Image © toonzzz, 123RF.com
A simplified alternative to man pages, tldr provides the most common command options at a glance.
Too long; didn't read (TL;DR) is a flippant Internet acronym for a summary that first came into use about a decade ago. It seems to be falling out of fashion but survives in tldr
, the newest command and format for computer documentation. It is far from the first documentation command, but it fills a niche as a cheat sheet for the most common options for commands.
The most common documentation format, of course, is the man page, which dates back to 1971 (Figure 1). Man pages cover commands, libraries, and configuration files, usually aiming for an encyclopedia-like summary of their topics. One great advantage is that the pages are highly organized, arranged in nine sections ranging from user commands and system calls to system administration calls, kernel routines, and daemons. Each page presents information in a rigid format divided into further sections (see Table 1), although not all sections are mandatory. The Examples, Notes, and Bugs sections, for example, are frequently omitted. This consistent structure compensates for the often overwhelming detail of some man pages, which can be over 1,000 lines long.
GNU projects provide Info pages that have a similar purpose to man pages and often use more user-friendly language. However, they can be less structured and concise and have not caught on nearly as much. In fact, even GNU projects often maintain both formats. The main advantage of Info pages is that they can be read in Emacs using a mouse.
[...]
Buy this article as PDF
(incl. VAT)
Buy Linux Magazine
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.

News
-
Wayland 1.24 Released with Fixes and New Features
Wayland continues to move forward, while X11 slowly vanishes into the shadows, and the latest release includes plenty of improvements.
-
Bugs Found in sudo
Two critical flaws allow users to gain access to root privileges.
-
Fedora Continues 32-Bit Support
In a move that should come as a relief to some portions of the Linux community, Fedora will continue supporting 32-bit architecture.
-
Linux Kernel 6.17 Drops bcachefs
After a clash over some late fixes and disagreements between bcachefs's lead developer and Linus Torvalds, bachefs is out.
-
ONLYOFFICE v9 Embraces AI
Like nearly all office suites on the market (except LibreOffice), ONLYOFFICE has decided to go the AI route.
-
Two Local Privilege Escalation Flaws Discovered in Linux
Qualys researchers have discovered two local privilege escalation vulnerabilities that allow hackers to gain root privileges on major Linux distributions.
-
New TUXEDO InfinityBook Pro Powered by AMD Ryzen AI 300
The TUXEDO InfinityBook Pro 14 Gen10 offers serious power that is ready for your business, development, or entertainment needs.
-
LibreOffice Tested as Possible Office 365 Alternative
Another major organization has decided to test the possibility of migrating from Microsoft's Office 365 to LibreOffice.
-
Linux Mint 20 Reaches EOL
With Linux Mint 20 at its end of life, the time has arrived to upgrade to Linux Mint 22.
-
TuxCare Announces Support for AlmaLinux 9.2
Thanks to TuxCare, AlmaLinux 9.2 (and soon version 9.6) now enjoys years of ongoing patching and compliance.