比man page更友好的命令帮助文档tldr命令:如何在Linux系统安装tldr以及如何使用tldr


原文地址:比man page更友好的命令帮助文档tldr命令:如何在Linux系统安装tldr以及...

ldr-pages项目是命令行工具的简化且由社区维护的帮助页面的集合,比man page更友好、简洁。本篇文章分享了如何在Linux上安装Tealdeer,以及Tealdeer命令的使用示例。

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

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

在Linux中安装Tealdeer tldr客户端

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

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

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

对于Arch Linux的和它的衍生物,它是在提供AUR -  tealdeer, tealdeer-bin 或 tealdeer-git。您可以使用AUR帮助程序安装任何Tealdeer软件包,例如Yay,如下所示:

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

在Ubuntu或者Debian上

sudo apt install tldr

2.使用cargo安装Tealdeer

如果尚未安装Rust编程语言,请在您的Linux系统上安装它。

然后,运行以下命令以使用cargo软件包管理器安装Tealdeer :

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
  • Bash:将bash_tealdeer 文件复制 到 /usr/share/bash-completion/completions/tldr
  • Fish:将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

例如,我将ls使用Tealdeer使用以下命令来显示命令的备忘单:

tldr ls

Tealdeer客户端将从tldr-pages项目获取请求的备忘单,并将其显示在终端中。

这是上面命令的示例输出:

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

比man page更友好的命令帮助文档tldr命令:如何在Linux系统安装tldr以及如何使用tldr

看到?没有全面的文本部分,没有每个标志/选项的解释。只是有关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

评论

登录后评论

服务器优惠活动

Top