使用 Tealdeer 工具显示 Linux 命令备忘单

越来越多的资源使新手学习 Linux 命令变得更加方便和容易。 值得注意的资源之一是 tldr 页面. tldr-pages 项目是命令行工具的简化和社区维护的帮助页面的集合。 不同于传统的 man pages，tldr-pages 项目为给定的命令行工具提供了简洁实用的示例，不包括所有其他综合文本部分。 除了官方的 tldr 客户端，还有许多第三方客户端可以访问 tldr 页面。 其中之一是 小鹿. Tealdeer 是一个快速的非官方 tldr 客户端，允许您在终端中访问和显示 Linux 命令备忘单。

与官方 tldr 客户端和其他社区支持的 tldr 客户端相比，Tealdeer 的开发人员声称它非常快。 Tealdeer 是一个开源工具 锈 编程语言及其源代码可在 GitHub 中免费获得。

在 Linux 中安装 Tealdeer tldr 客户端

Tealdeer 可以通过多种方式安装，如下所示。

1.使用包管理器安装Tealdeer

Tealdeer 已为许多 Linux 发行版打包。

为了 Arch Linux 及其衍生物，它可用于 AUR – tealdeer, tealdeer-bin 或者 tealdeer-git. 您可以使用 AUR 帮助程序安装任何这些 tealdeer 软件包，例如 example 耶，如下所示：

$ yay -S tealdeer

或者，

$ yay -S tealdeer-bin

或者，

$ yay -S tealdeer-git

安装Tealdeer Fedora， 跑：

$ sudo dnf install tealdeer

在 NixOS 上：

$ nix-env --install tealdeer

在 openSUSE 上：

$ sudo zypper install tealdeer

在 Void Linux 上：

$ sudo xbps-install --synchronize tealdeer

2.使用cargo安装Tealdeer

如果您还没有安装 Rust 编程语言，请在您的 Linux 系统上安装它。

  • 在 Linux 中安装 Rust 编程语言

然后，运行以下命令来安装 Tealdeer cargo 包管理器：

$ cargo install tealdeer

3. 从静态二进制文件安装 Tealdeer

您还可以从以下位置下载预编译的二进制文件 GitHub 发布页面 并将其移至您的 $PATH 如下所示。

$ wget https://github.com/dbrgn/tealdeer/releases/download/v1.4.1/tldr-linux-x86_64-musl
$ sudo cp tldr-linux-x86_64-musl /usr/local/bin/tldr

使其可执行：

$ sudo chmod +x /usr/local/bin/tldr

或者，您可以为您的 $SHELL 从发布页面启用自动完成功能。

  • 重击： 复制 bash_tealdeer 文件到 /usr/share/bash-completion/completions/tldr
  • 鱼： 复制 fish_tealdeer 文件到 ~/.config/fish/completions/tldr.fish
  • Zsh： 复制 zsh_tealdeer 文件到 /usr/share/zsh/site-functions/_tldr

在终端中使用 Tealdeer 显示 Linux 命令备忘单

使用 Tealdeer 可以更轻松地获取 Unix 和 Linux 命令的备忘单！

在开始使用 Tealdeer 之前，您必须使用以下命令更新其缓存：

$ tldr --update

现在您可以使用 Tealdeer 客户端显示任何 Unix 和 Linux 命令的备忘单，如下所示：

tldr command_name

为了 example我要显示 ls 命令的备忘单使用 Tealdeer 使用此命令：

$ tldr ls

Tealdeer 客户端将从 tldr 页面 项目并将其显示在您的终端中。

以下是上述命令的示例输出：

  List directory contents.

  List files one per line:

      ls -1

  List all files, including hidden files:

      ls -a

  List all files, with trailing `/` added to directory names:

      ls -F

  Long format list (permissions, ownership, size and modification date) of all files:

      ls -la

  Long format list with size displayed using human readable units (KB, MB, GB):

      ls -lh

  Long format list sorted by size (descending):

      ls -lS

  Long format list of all files, sorted by modification date (oldest first):

      ls -ltr
在终端中使用 Tealdeer 显示 Linux 命令备忘单

看？ 没有全面的文本部分，没有对每个标志/选项的解释。 只是一个关于 ls 命令与实际 example 命令！ 您可以从列表中选择您想要使用的那个！

无需浏览 man pages 或无需进行网络搜索。 Tealdeer 可以为您提供大多数 Unix 和 Linux 命令的实用示例。

你甚至可以得到 tldr 命令的示例如下：

$ tldr tldr

  Displays simple help pages for command-line tools, from the tldr-pages project.
  More information: <https://tldr.sh>.

  Get typical usages of a command (hint: this is how you got here!):

      tldr command

  Show the tar tldr page for Linux:

      tldr -p linux tar

  Get help for a git subcommand:

      tldr git-checkout

  Update local pages (if the client supports caching):

      tldr -u

要列出缓存中的所有命令，请运行：

$ tldr --list

如果要清除本地缓存，请使用 -c, --clear-cache 旗帜。

$ tldr --clear-cache

清除缓存后，别忘了更新本地缓存：

$ tldr --update

有关更多详细信息，请参阅 tldr 帮助部分：

$ tldr --help
Usage:

    tldr [options] <command>...
    tldr [options]

Options:

    -h --help           Show this screen
    -v --version        Show version information
    -l --list           List all commands in the cache
    -f --render <file>  Render a specific markdown file
    -o --os <type>      Override the operating system [linux, osx, sunos, windows]
    -u --update         Update the local cache
    -c --clear-cache    Clear the local cache
    -p --pager          Use a pager to page output
    -m --markdown       Display the raw markdown instead of rendering it
    -q --quiet          Suppress informational messages
    --config-path       Show config file path
    --seed-config       Create a basic config
    --color <when>      Control when to use color [always, auto, never] [default: auto]

Examples:

    $ tldr tar
    $ tldr --list

To control the cache:

    $ tldr --update
    $ tldr --clear-cache

To render a local file (for testing):

    $ tldr --render /path/to/file.md

资源：

相关阅读：

  • 每个 Linux 用户都需要知道的手册页的好替代品
  • 如何创建和维护自己的手册页
  • 学习有效地使用手册页
  • 如何在 Ubuntu 上安装缺少的命令手册页
  • Pinfo – 一个 CLI 程序，用于阅读彩色信息和手册页

Related Posts