1

我在一家公司工作,他们使用大量的 Linux 工具和命令(内部和外部)

我想创建一个自定义手册,每个工具都有示例。

为此考虑使用信息工具:

info CompanyName tool1
info CompanyName tool2
info CompanyName tool3
..

每个的输出应该是我添加的示例和评论的简单文本。

但据我所知,Linux 中的信息是为特定工具创建的,而不是为您的定制需求而创建的。

知道实现上述目标的最佳方法是什么吗?目前,我正在使用 sublime 和每个工具的选项卡,并且每次使用一次,然后我使用新示例更新 sublime 选项卡。

任何建议将不胜感激。

4

1 回答 1

0

对于它的价值,我不喜欢信息页面。我更喜欢旧的 Unix 手册页,编写它们非常简单。您可以简单地在编辑器中打开任何手册页,查看它的源代码并复制它以满足您的需要。

在大多数系统上,手册页位于类似的目录中/usr/share/man/{man1,man2,man3,man4,man5,man6,man7,man8}/,或者您可以使用命令-w选项man查看任何手册页的位置,然后打开它。例如

$ man -w ls 
/usr/share/man/man1/ls.1.gz
$ vim /usr/share/man/man1/ls.1.gz

您可以看到它是如何编写的,并模仿它来编写您自己的手册页。为了让任何人都能阅读您编写的手册页,必须将手册页安装在 man 实用程序搜索手册页的目录之一中。在 Linux 上,您通常可以通过运行manpath命令来查看此目录列表(在其他系统上可能会有所不同,您必须查看man命令本身的手册页)。如果您将手册页存储在这些目录之一中,那么任何人都可以使用该man实用程序来阅读它。

根据POSIXman实用程序还尊重环境变量MANPATH,因此如果您将手册页存储在非标准位置,您可以设置 MANPATH 变量,以便man查找它。或者您也可以修改/etc/man.conf文件以将您的手册页目录添加到man.

现在,手册页使用宏语言进行标记。Linux 系统倾向于使用man(7)宏语法,您可以在此处查看手册

还有另一个用于编写手册页的现代宏集,称为mdoc(7),它在 BSD 系列操作系统中广泛使用。您可以在此处查看其手册

于 2016-12-05T15:46:44.853 回答