我在一家公司工作,他们在那里为Linux使用了很多工具和命令(内部和外部)
我想创建一个自定义手册,每个工具都有示例。
考虑使用信息工具:
info CompanyName tool1
info CompanyName tool2
info CompanyName tool3
..
每一个的输出都应该是由我添加的示例和注释的简单文本。
但据我所知,Linux中的信息是为特定的工具而不是为您的定制需求而创建的。
你知道实现上述目标的最佳方法是什么吗?
目前,我正在使用每个工具和每一次选项卡升华,然后我用新的例子更新升华选项卡。
任何建议都将不胜感激。
最佳答案
不管怎样,我不喜欢信息页面。我更喜欢旧的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
你可以看到它是如何写的,并模仿它来写你自己的手册页。为了让任何人都能够阅读您编写的手册页,手册页必须安装在手册实用程序搜索手册页的目录中。在linux上,您通常可以通过运行
manpath
命令来查看这个目录列表(在其他系统上可能会有所不同,您将不得不看到man
命令本身的手册页)。如果您将手册页存储在其中一个目录中,那么任何人都可以使用man
实用程序读取它。根据
POSIX
,man
实用程序也会考虑环境变量MANPATH
,因此如果您将手册页存储在非标准位置,则可以设置manpath变量,以便man
可以查找它。也可以修改/etc/man.conf
文件,将手册页目录添加到man
的搜索路径中。现在,手册页使用宏语言进行标记。Linux系统倾向于使用
man(7)
宏语法,您可以看到手册here还有另一种用于编写手册页的现代宏集,称为
mdoc(7)
,它在bsd系列操作系统中广泛使用。您可以看到它的手册here