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
-
Framework Laptop 13 Pro Competes with the Best
Framework has released what might be considered the MacBook of Linux devices.
-
The Latest CachyOS Features Supercharged Kernel
The latest release of CachyOS brings with it an enhanced version of the latest Linux kernel.
-
Kernel 7.0 Is a Bit More Rusty
Linux kernel 7.0 has been released for general availability, with Rust finally getting its due.
-
France Says "Au Revoir" to Microsoft
In a move that should surprise no one, France announced plans to reduce its reliance on US technology, and Microsoft Windows is the first to get the boot.
-
CIQ Releases Compatibility Catalog for Rocky Linux
The company behind Rocky Linux is making an open catalog available to developers, hobbyists, and other contributors, so they can verify and publish compatibility with the CIQ lineup.
-
KDE Gets Some Resuscitation
KDE is bringing back two themes that vanished a few years ago, putting a bit more air under its wings.
-
Ubuntu 26.04 Beta Arrives with Some Surprises
Ubuntu 26.04 is almost here, but the beta version has been released, and it might surprise some people.
-
Ubuntu MATE Dev Leaving After 12 years
Martin Wimpress, the maintainer of Ubuntu MATE, is now searching for his successor. Are you the next in line?
-
Kali Linux Waxes Nostalgic with BackTrack Mode
For those who've used Kali Linux since its inception, the changes with the new release are sure to put a smile on your face.
-
Gnome 50 Smooths Out NVIDIA GPU Issues
Gamers rejoice, your favorite pastime just got better with Gnome 50 and NVIDIA GPUs.
