如何为linux创建通用手册？_Linux_Info

如何为linux创建通用手册？

linux

如何为linux创建通用手册？,linux,info,Linux,Info,我在一家公司工作，他们在那里为linux使用大量工具和命令（内部和外部）我想创建一个自定义手册，每个工具的例子考虑使用info工具进行此操作： info CompanyName tool1 info CompanyName tool2 info CompanyName tool3 .. 每一个的输出都应该是我添加的示例和注释的简单文本但据我所知，Linux中的信息是为特定的工具而创建的，而不是为您的定制需求而创建的你知道实现上述目标的最佳方式是什么吗？目前，我正在使用升华，每个工具都

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

我想创建一个自定义手册，每个工具的例子

考虑使用info工具进行此操作：

info CompanyName tool1
info CompanyName tool2
info CompanyName tool3
..

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

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

你知道实现上述目标的最佳方式是什么吗？目前，我正在使用升华，每个工具都有一个标签，每一次，然后我用新的示例更新升华标签

任何建议都将不胜感激。

无论如何，我不喜欢信息页面。我更喜欢好的旧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

您可以看到它是如何编写的，并模仿它来编写自己的手册页。为了让任何人都能够阅读您编写的手册页，手册页必须安装在手册实用程序搜索手册页的其中一个目录中。在Linux上，您通常可以通过运行

manpath

命令来查看此目录列表（在其他系统上可能会有所不同，您必须查看

man

命令本身的手册页）。如果您将手册页存储在其中一个目录中，则任何人都可以使用

man

实用程序读取手册页

根据

POSIX

，

man

实用程序也尊重环境变量

MANPATH

，因此如果您将手册页存储在非标准位置，您可以设置MANPATH变量，以便

man

可以查找它。或者您也可以修改

/etc/man.conf

文件，将手册页目录添加到

man

的搜索路径中

现在，手册页使用宏语言进行标记。Linux系统倾向于使用

man（7）

宏语法，有关宏语法，请参阅手册

还有另一个用于编写手册页的现代宏集，称为

mdoc（7）

，在BSD操作系统系列中广泛使用。你可以看看它的手册，了解它的价值，我不喜欢信息页面。我更喜欢好的旧Unix手册页，编写它们非常简单。您只需在编辑器中打开任何手册页，查看其源代码，然后复制它以满足您的需要