A simplified documentation command
Command Line – tldr
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
-
Endless OS 6 has Arrived
After more than a year since the last update, the latest release of Endless OS is now available for general usage.
-
Fedora Asahi 40 Remix Available for Macs with Apple Silicon
If you've been anticipating KDE's Plasma 6 for your Apple Silicon-powered Mac, then you're in luck.
-
Red Hat Adds New Deployment Option for Enterprise Linux Platforms
Red Hat has re-imagined enterprise Linux for an AI future with Image Mode.
-
OSJH and LPI Release 2024 Open Source Pros Job Survey Results
See what open source professionals look for in a new role.
-
Proton 9.0-1 Released to Improve Gaming with Steam
The latest release of Proton 9 adds several improvements and fixes an issue that has been problematic for Linux users.
-
So Long Neofetch and Thanks for the Info
Today is a day that every Linux user who enjoys bragging about their system(s) will mourn, as Neofetch has come to an end.
-
Ubuntu 24.04 Comes with a “Flaw"
If you're thinking you might want to upgrade from your current Ubuntu release to the latest, there's something you might want to consider before doing so.
-
Canonical Releases Ubuntu 24.04
After a brief pause because of the XZ vulnerability, Ubuntu 24.04 is now available for install.
-
Linux Servers Targeted by Akira Ransomware
A group of bad actors who have already extorted $42 million have their sights set on the Linux platform.
-
TUXEDO Computers Unveils Linux Laptop Featuring AMD Ryzen CPU
This latest release is the first laptop to include the new CPU from Ryzen and Linux preinstalled.