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
Digital Autonomy
• How the Fediverse Found Parts for Its Platforms
• The Answer Was Already on the Shelf
• Changing the Chip Industry: How Public Investment Has Grown Open Silicon
• United Nations Open Source Portal Goes Live
• EU Open Source Strategy Plays Key Role in Tech Sovereignty Package
• France Says “Au Revoir” to Microsoft
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
-
Bottlenecks Discovered by Meta Engineers Lead to Scalability Improvements
Thanks to a small group of engineers at Meta, the Linux kernel module kernfs has been improved, which has led to some serious gains.
-
PwnEscape Poses VM Vulnerability
A guest-to-host escape flaw in Linux KVM, named PwnEscape, might be yet another means of attacking Linux.
-
Linux Mint 27 Set for a Christmas Release
The developers behind Linux Mint have announced a Christmas release, and it looks like Santa's sack will be brimming with features.
-
Is Linus Torvalds Vibe Coding?
The creator of Linux has added AI into his process for Linux kernel development, and it's more than just for debugging.
-
openKylin 3.0 Released with Expanded AI Integration
The latest release features a pre-installed AI agent to help perform tasks.
-
DigitalOcean Ends Open Source Credits Program
In a change that has surprised many open source developers, DigitalOcean has decided to sunset its Open Source Credits Program.
-
Office 365 Available for Testing on Linux via Bottles
Linux users can now test the official Office 365, thanks to Mirko Brombin's work on Bottles.
-
Dutch Government Turns to Open Source for Digital Sovereignty
Following in the footsteps of other European countries, the Netherlands is looking to increase its sovereign digital infrastructure with open source software.
-
Linux May Soon Work on Snapdragon X2-Based PCs
If you're thinking about buying a Snapdragon X2-based desktop or laptop, Linux may soon be an option.
-
KDE for People Initiative Calls for AI Ban in Plasma
A new community of KDE wants the project to adopt a strict no-AI policy for KDE Plasma.
