TLDR，一个简易版的命令查询手册

HaC

发布于 2022-05-20 09:34:53

8570

发布于 2022-05-20 09:34:53

文章被收录于专栏：HaC的技术专栏

Linux系统拥有丰富的命令，一切基于命令操作。

但是要记住所有的命令，任何人可能都无法完成，其次，Linux的命令都带有十分多的参数。

比如我平时百度得最多的是 tar 命令，虽然我知道它是解压缩用的，但你直接用的时候就蒙圈了。

缺少参数的后果：

[root@VM-8-8-centos software]# tar zookeeper-3.4.11.tar.gz
tar: Old option `g' requires an argument.
Try `tar --help' or `tar --usage' for more information.

为了解决这个问题，人们创建了手册页man page，(手册 —— man 是 manual 的缩写，一个Linux命令使用手册)。

但是man手册，实在是太长了：

[root@VM-8-8-centos software]# man tar
TAR(1)                                                   User Commands                                                   TAR(1)

NAME
       tar - manual page for tar 1.26

SYNOPSIS
       tar [OPTION...] [FILE]...

DESCRIPTION
       GNU  `tar'  saves  many files together into a single tape or disk archive, and can restore individual files from the ar‐
       chive.

       Note that this manual page contains just very brief description (or more like a list of possible  functionality)  origi‐
       nally generated by the help2man utility.  The full documentation for tar is maintained as a Texinfo manual.  If the info
       and tar programs are properly installed at your site, the command `info tar' should give you access to the complete man‐
       ual.

EXAMPLES
       tar -cf archive.tar foo bar
              # Create archive.tar from files foo and bar.

       tar -tvf archive.tar
              # List all files in archive.tar verbosely.

       tar -xf archive.tar
              # Extract all files from archive.tar.

蒙圈plus，都怪我英语太菜了。

看到这样的文档，我还是宁愿百度……

直到后来我用了TLDR，百度的频率就大大减少了。

1、TLDR

为了舍弃man手册，于是程序员大神们搞了很多个工具，比如TLDR、Bro、Cheat ，这些都是很简洁的命令手册。

其中我最喜欢的还是 TLDR。

项目地址：https://github.com/tldr-pages/tldr

tl;dr 是一个网络词汇，它的全称是「Too Long; Don’t Read」，翻译成中文的话就叫**「太长不看」**。

（所以文章也是一样，又长又臭就没人看了🤣）

TLDR区别于man手册的区别：

简洁，清晰的排版+言简意赅的说明
只收集高频使用的实际例子
缺点是没有man手册全面，但目前一直在更新

TLDR 安装也很简单，支持 node 和 python 安装

node：

npm install -g tldr

python:

pip3 install tldr

2、使用

TLDR 的用法比较简单，可以使用 tldr --help 查看用法。

Options:
  -v, --version            output the version number
  -l, --list               List all commands for the chosen platform in the cache
  -a, --list-all           List all commands in the cache
  -1, --single-column      List single command per line (use with options -l or -a)
  -r, --random             Show a random command
  -e, --random-example     Show a random example
  -f, --render [file]      Render a specific markdown [file]
  -m, --markdown           Output in markdown format
  -o, --os [type]          Override the operating system [linux, osx, sunos]
  --linux                  Override the operating system with Linux
  --osx                    Override the operating system with OSX
  --sunos                  Override the operating system with SunOS
  -t, --theme [theme]      Color theme (simple, base16, ocean)
  -s, --search [keywords]  Search pages using keywords
  -u, --update             Update the local cache
  -c, --clear-cache        Clear the local cache
  -h, --help               display help for command

以上用法太长不看，直接使用 tldr 命令

默认就是当前系统下的使用用法，如果要查看其他系统的用法，可以- o指定。

查看windows下的tar用法：