tldr

Print the tldr page for a specific command (hint: this is how you got here!)

$ tldr [command]

$ tldr [command] [subcommand]

$ tldr [[-L|--language]] [language_code] [command]

$ tldr [[-p|--platform]] [android|common|freebsd|linux|osx|netbsd|openbsd|sunos|windows] [command]

$ tldr [[-u|--update]]

$ tldr [[-l|--list]]

$ tldr [[-l|--list]] | grep [command] | column

$ tldr [[-l|--list]] | shuf [[-n|--head-count]] 1 | xargs tldr

tldr

command
    The name of the Linux command for which to display the tldr page.

-u, --update
    Update the tldr pages.

-r, --render
    Render a local markdown file.

-f, --file
    Read from file instead of the tldr database.

-v, --version
    Display the tldr client version.

-l, --list
    List all available commands.

-p, --platform
    Specify the platform to use (linux, osx, windows, common). Defaults to the current platform.

-c, --color
    Enable or disable color output.

-h, --help
    Show help message and exit.

The tldr command provides concise and practical examples for common Linux commands. Instead of displaying the full, often verbose, man pages, it shows brief descriptions and usage scenarios, making it easier for users to quickly understand how to use a command. It is a community-maintained project, meaning that the examples and explanations are created and reviewed by other users, making it a collaborative and constantly evolving resource. The tldr pages are designed to be more accessible and user-friendly, especially for beginners or those who just need a quick reminder of how to use a command with common options. It is usually installed via a package manager (like npm, pip, or similar) or a dedicated installation script.

The main goal of tldr is to accelerate the learning process for new users and provide fast access to information for experienced ones.

The tldr pages are not exhaustive and may not cover all possible options or use cases for a command. They are intended to provide a starting point and quick reference, not a complete replacement for the man pages. The accuracy and completeness of the pages depend on the community's contributions.

tldr provides platform-specific examples, covering Linux, macOS, and Windows commands. The `-p` option allows users to specify the desired platform.

Users can contribute to the tldr project by suggesting edits, adding new pages, or reviewing existing ones. Contribution guidelines are available on the project's GitHub repository.

The tldr project started as an open-source initiative to create a more accessible and user-friendly alternative to traditional man pages. It has evolved through community contributions and is now available in many programming languages with command-line and web frontends.

man(1), apropos(1), help(1)