如何为 linux 创建通用手册？

Question

我在一家公司工作，他们使用大量工具和命令 linux（内部和外部）

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

为此使用信息工具的想法：

info CompanyName tool1
info CompanyName tool2
info CompanyName tool3
..

并且每个输出应该是我添加的示例和注释的简单文本。

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

知道实现上述目标的最佳方法是什么吗？目前我正在使用 sublime with tab per tool and every once 然后我用新的例子更新 sublime tab。

任何建议将不胜感激。

Answer 1

尽管如此，我不喜欢信息页。我更喜欢古老的 Unix 手册页，而且编写它们非常简单。您可以简单地在编辑器中打开任何手册页，查看它的源代码，然后根据您的需要复制它。

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

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

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

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

的搜索路径中

现在，手册页使用宏语言来做标记。 Linux系统倾向于使用man(7)宏语法，具体可以看手册here

还有另一个用于编写手册页的现代宏集，称为 mdoc(7)，广泛用于 BSD 系列操作系统。可以看它的说明书here

如何为 linux 创建通用手册？

how to create a general manual for linux?

linux

info