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

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

Tealdeer的开发人员声称,与官方tldr客户和其他社区支持的tldr客户相比,它的运行速度非常快。 Tealdeer是用以下语言编写的开源工具 编程语言及其源代码可在GitHub上免费获得。

在Linux中安装Tealdeer tldr客户端

可以按照下面列出的多种方式安装Tealdeer。

1.使用软件包管理器安装Tealdeer

Tealdeer已被打包用于许多Linux发行版。

对于 Arch Linux 及其衍生物,可以在 AURtealdeertealdeer-bin 要么 tealdeer-git。 例如,您可以使用AUR帮助程序安装这些tealdeer软件包中的任何一个。 好极了,如下所示:

$ yay -S tealdeer

要么,

$ yay -S tealdeer-bin

要么,

$ yay -S tealdeer-git

要在Fedora上安装Tealdeer,请运行:

$ sudo dnf install tealdeer

在NixOS上:

$ nix-env --install tealdeer

在openSUSE上:

$ sudo zypper install tealdeer

在Void Linux上:

$ sudo xbps-install --synchronize tealdeer

2.使用货物安装泰尔代尔

如果尚未安装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完成脚本 $SHELL 从发布页面启用自动完成功能。

  • 重击:复制 bash_tealdeer 归档到 /usr/share/bash-completion/completions/tldr
  • :复制 fish_tealdeer 归档到 ~/.config/fish/completions/tldr.fish
  • sh:复制 zsh_tealdeer 归档到 /usr/share/zsh/site-functions/_tldr

在终端中显示带有Tealdeer的Linux命令速查表

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

在开始使用Tealdeer之前,必须使用以下命令更新其缓存:

$ tldr --update

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

tldr command_name

例如,我要显示 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 命令和实际示例命令! 您可以从列表中选择要使用的一个!

无需浏览 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程序,用于读取彩色信息和手册页

Linux命令手册页开源tealdeerTldrtldr-pagesUnix

Sidebar