gpt4 book ai didi

linux - 如何为 linux 创建通用手册?

转载 作者:塔克拉玛干 更新时间:2023-11-03 01:22:29 27 4
gpt4 key购买 nike

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

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

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

info CompanyName tool1
info CompanyName tool2
info CompanyName tool3
..

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

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

知道实现上述目标的最佳方法是什么吗?目前,我使用 sublime with tab per tool 并且每次都使用 sublime,然后我用新示例更新 sublime tab。

任何建议将不胜感激。

最佳答案

尽管如此,我并不喜欢信息页。我更喜欢古老的 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 命令来查看此目录列表(在其他系统上可能有所不同,您必须查看 man 的手册页命令本身)。如果您将手册页存储在这些目录之一中,那么任何人都可以使用 man 实用程序阅读它。

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

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

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

关于linux - 如何为 linux 创建通用手册?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/40977177/

27 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com