有时“手册”页面布局不太好,甚至没有帮助,还有其他选择吗?

有时“手册”页面布局不太好,甚至没有帮助,还有其他选择吗?

我一直想编写一个名为的 bash 实用程序realman,它可以像手册页中那样解释命令,但它不会按照命令的选项的字母顺序排列命令,而是只提供普通用户需要的示例。

一些命令确实给出了示例,但是由于手册页是由不同的人构建的,因此没有中央控制来控制手册页的可读性。

以描述man为例

NAME
       man - an interface to the on-line reference manuals

SYNOPSIS
       man  [-C  file]  [-d]  [-D] [--warnings[=warnings]] [-R encoding] [-L locale] [-m system[,...]] [-M path] [-S list] [-e extension] [-i|-I] [--regex|--wildcard]
       [--names-only] [-a] [-u] [--no-subpages] [-P pager] [-r prompt] [-7] [-E  encoding]  [--no-hyphenation]  [--no-justification]  [-p  string]  [-t]  [-T[device]]
       [-H[browser]] [-X[dpi]] [-Z] [[section] page ...] ...
       man -k [apropos options] regexp ...
       man -K [-w|-W] [-S list] [-i|-I] [--regex] [section] term ...
       man -f [whatis options] page ...
       man  -l  [-C  file]  [-d]  [-D]  [--warnings[=warnings]]  [-R  encoding]  [-L  locale]  [-P pager] [-r prompt] [-7] [-E encoding] [-p string] [-t] [-T[device]]
       [-H[browser]] [-X[dpi]] [-Z] file ...
       man -w|-W [-C file] [-d] [-D] page ...
       man -c [-C file] [-d] [-D] page ...
       man [-hV]

这完全是小题大做。我的手册页会这样写...

Its a program gives you more details of a command.
eg. "man bash" would explain more about the command "bash"

必须通读命令的所有选项才能找到大多数用户会使用的那个选项,这并不是很具建设性。

所以我的问题很简单,Ubuntu 中是否有通过命令行提供的“realman”类型的程序,该程序更面向用户而不是面向系统管理员?

答案1

您所要求的内容可能定义不明确。并非每个命令都有“大多数用户都会使用的选项”。

但是,您说过man您希望看到类似这样的内容:

它是一个程序,可以为您提供有关命令的更多详细信息。

有关命令的此类信息,请使用whatis。这里总结了手册页。

ek@Kip:~$ whatis man
man (7)              - macros to format man pages
man (1)              - an interface to the on-line reference manuals
ek@Kip:~$ whatis whatis
whatis (1)           - display manual page descriptions
ek@Kip:~$ whatis ls
ls (1)               - list directory contents
LS (6)               - display animations aimed to correct users who accident...
ek@Kip:~$ whatis ping
ping (8)             - send ICMP ECHO_REQUEST to network hosts

这仍然没有为您提供有关命令的命令行选项的任何信息(但话又说回来,“它是一个为您提供有关命令的更多详细信息的程序”)。

如果您需要中等量的信息,最好的方法可能是在互联网上查找该命令。您可以搜索网络,甚至可以搜索维基百科。许多最知名和最常用的命令都有维基百科文章。例如,请参阅lsman(关于手册页的一般内容,但包括man语法建议),grep, 和fsck

如果愿意,您可以使用支持命令行模式的 Web 浏览器(例如链接2安装 links2)或仅使用命令行的浏览器(例如山猫安装 lynx)。

最后,请注意,Ubuntu 中的许多命令行实用程序都来自 GNU 项目,该项目提供了出色的文档。通常,它比手册页更长、更详细,但您可能会发现它的组织更好。而且通常有描述性标题可帮助您找到特定信息,根据我的经验,这比许多手册页更容易。

GNU 手册可以在这里找到。(记住不要全部实用程序是 GNU 实用程序。)许多最常用的命令没有按名称出现,而是属于GNU 核心实用程序。GNU 手册可以在线查看,也可以以各种文件格式下载,其中一些非常适合在命令行上查看。

相关内容