在Ubuntu系统中查看命令帮助

zxl19 2023-03-17

Ubuntu
Note

记录一下如何在Ubuntu系统中查看命令帮助。

使用`-h`或`--help`选项

大部分命令都支持-h或--help选项，用于显示命令帮助。

使用`man`命令

man命令是系统自带的手册查询工具（manual pager），用于查询程序或函数的帮助手册页面；
全部帮助手册页面可在Manned.org上查看；
语法说明：
```
 man [OPTION...] [SECTION] PAGE...
```

使用`tldr`命令

tldr命令是社区维护的命令行工具帮助页面查询工具；
名称来源于互联网俚语“太长不看”（Too Long; Didn’t Read，TL;DR）；
语法说明：
```
 tldr command [options]
```

安装及配置

安装

python3 -m pip install tldr

配置

在~/.bashrc文件或者是~/.zshrc文件中配置环境变量：

 export TLDR_COLOR_NAME="cyan"
 export TLDR_COLOR_DESCRIPTION="white"
 export TLDR_COLOR_EXAMPLE="green"
 export TLDR_COLOR_COMMAND="red"
 export TLDR_COLOR_PARAMETER="white"
 export TLDR_LANGUAGE="en"
 export TLDR_CACHE_ENABLED=1
 export TLDR_CACHE_MAX_AGE=720
 export TLDR_PAGES_SOURCE_LOCATION="https://raw.githubusercontent.com/tldr-pages/tldr/main/pages"
 export TLDR_DOWNLOAD_CACHE_LOCATION="https://tldr-pages.github.io/assets/tldr.zip"

更新本地缓存，需要连接GitHub：
```
 tldr -u
```

设置自动补全

 # bash
 tldr --print-completion bash | sudo tee "$BASH_COMPLETION_COMPAT_DIR"/tldr
 # zsh (it is recommended to check where zsh/site-functions directory is located)
 ## for Linux:
 tldr --print-completion zsh | sudo tee /usr/share/zsh/site-functions/_tldr

zxl19

在Ubuntu系统中查看命令帮助

使用`-h`或`--help`选项

使用`man`命令

使用`tldr`命令

安装及配置

安装

配置

使用速查表

网站

GitHub

参考

在Ubuntu系统中查看命令帮助

使用-h或--help选项

使用man命令

使用tldr命令

安装及配置

安装

配置

使用速查表

网站

GitHub

参考

使用`-h`或`--help`选项

使用`man`命令

使用`tldr`命令