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
-
Fedora Asahi Remix 41 Available for Apple Silicon
If you have an Apple Silicon Mac and you're hoping to install Fedora, you're in luck because the latest release supports the M1 and M2 chips.
-
Systemd Fixes Bug While Facing New Challenger in GNU Shepherd
The systemd developers have fixed a really nasty bug amid the release of the new GNU Shepherd init system.
-
AlmaLinux 10.0 Beta Released
The AlmaLinux OS Foundation has announced the availability of AlmaLinux 10.0 Beta ("Purple Lion") for all supported devices with significant changes.
-
Gnome 47.2 Now Available
Gnome 47.2 is now available for general use but don't expect much in the way of newness, as this is all about improvements and bug fixes.
-
Latest Cinnamon Desktop Releases with a Bold New Look
Just in time for the holidays, the developer of the Cinnamon desktop has shipped a new release to help spice up your eggnog with new features and a new look.
-
Armbian 24.11 Released with Expanded Hardware Support
If you've been waiting for Armbian to support OrangePi 5 Max and Radxa ROCK 5B+, the wait is over.
-
SUSE Renames Several Products for Better Name Recognition
SUSE has been a very powerful player in the European market, but it knows it must branch out to gain serious traction. Will a name change do the trick?
-
ESET Discovers New Linux Malware
WolfsBane is an all-in-one malware that has hit the Linux operating system and includes a dropper, a launcher, and a backdoor.
-
New Linux Kernel Patch Allows Forcing a CPU Mitigation
Even when CPU mitigations can consume precious CPU cycles, it might not be a bad idea to allow users to enable them, even if your machine isn't vulnerable.
-
Red Hat Enterprise Linux 9.5 Released
Notify your friends, loved ones, and colleagues that the latest version of RHEL is available with plenty of enhancements.