linux下查看帮助文档的几种方式

Saturday, March 28, 2020

–help选项

大多数linux的命令都可以使用 command --hlep 来获取命令使用格式和选项的简要解释

Man page

大多数linux下的命令都有自己的man page,了解一条命令最好的方式就是 man command

得益于无数前辈的努力,相当一部分man page有中文翻译,但大多是中文man page已经多年未更新,有能力阅读英文的还是尽量阅读英文。

下面介绍几个常用选项

man 会根据系统设置来选择man page语言,也可以手动指定man page语言,例如:

$ man -L zh_CN ls
$ man -L en_US ls

根据关键字查找man page

$ man -k keyword

使用浏览器查看man page

$ man -H command

浏览器由变量 BROWSER 指定,也可一在 -H 后面手动指定,例如:

$ man -Hfirefox command

-f 只显示命令的简短介绍,因为man page可能会重名,这个选项一般用来展示所有同名man page

$ man -f command

例如:

$ man -f printf
printf (1)           - format and print data
printf (3)           - formatted output conversion
printf (3p)          - print formatted output
printf (1p)          - write formatted output

可以用括号里的数字指定具体查看哪个man page,例如:

$ man 3 printf
# 或者
$ man printf.3

p代表POSIX,括号内数字的具体含义参看下表:

nummean含义
1Executable programs or shell commands可执行的普通程序或shell命令
2System calls (functions provided by the kernel)内核提供的系统调用
3Library calls (functions within program libraries)库调用(库函数),一般就是C语言库
4Special files (usually found in /dev)特殊文件(通常在/dev目录下)
5File formats and conventions文件格式规范
6Games游戏
7Miscellaneous (including macro packages and conventions)杂项(及其规范)
8System administration commands (usually only for root)系统管理命令(通常仅root用户可用)

TLDR

github主页在这里 ,取义于 “tl;dr”,即“Too long; didn’t read” 的缩写。对于日常使用来说,没必要去了解“回”字的四种写法(少年,你经历过被tar支配的恐惧么),tldr提供非常简短直白,但却异常有用的命令用法示例

$ tldr man

  Archiving utility.
  Often combined with a compression method, such as gzip or bzip.
  More information: <https://www.gnu.org/software/tar>.

  Create an archive from files:

      tar cf target.tar file1 file2 file3

  Create a gzipped archive:

      tar czf target.tar.gz file1 file2 file3

  Create a gzipped archive from a directory using relative paths:

      tar czf target.tar.gz -C path/to/directory .

  Extract a (compressed) archive into the current directory:

      tar xf source.tar[.gz|.bz2|.xz]

  Extract an archive into a target directory:

      tar xf source.tar -C directory

  Create a compressed archive, using archive suffix to determine the compression program:

      tar caf target.tar.xz file1 file2 file3

  List the contents of a tar file:

      tar tvf source.tar

  Extract files matching a pattern:

      tar xf source.tar --wildcards "*.html"

下载安装前你可以先试试TLDR网页版 ,或者这个国内的中文版

Texinfo(Info page)

GNU项目的一部分,使用 info 命令来阅读,相比与man page最大的优点是支持超链接,可以从一个页面跳转到另一个页面,也可以从文档的索引跳到正文。功能还是相当强大的,但实际支持的文档似乎没有man page多(个人感觉,没有统计过),一些文档沿用了man page的格式 。我个人用的比较少。

/usr/share/doc

很多软件会把自身相关的一些文档放在这个目录,各种格式的都有,有些甚至有html,可以直接在浏览器查看,例如:

还有一些文档和软件保存在 /usr/share/ 比如gimp的官方教程(需安装 gimp-help-en )完整路径是 /usr/share/gimp/2.0/help/en/index.html,gtk3的参考手册在 /usr/share/gtk-doc/html/gtk3/index.html

API文档查看工具DevDocs

DevDocs是一个自由开源的web应用,无需下载安装,直接访问https://devdocs.io/ 即可,文档相当丰富。虽然身为为一个web应用,但文档数据可以下载保存在本地,不用每次从服务器拉取数据;比较丰富的快捷键(键盘党表示很舒服);可以添加到浏览器引擎,直接在浏览器搜索框搜索。


参考:

linux

Linux(X Window)剪贴板

Slax的安装和基本配置