为从源代码安装的程序创建手册


1

通常,从源代码安装软件包时,无法使用man命令查看该软件包的手册。我猜是因为没有手动安装。

因此,有没有办法为从源头安装的软件包安装手册?

PS:我知道--help几乎在每个程序中使用该选项都会给我带来某种帮助,甚至为命令提供手册,但是我确实需要安装一本真正的手册,该手册可以随man命令一起提供。

希望我的问题清楚。



@JonasCz您提供的链接为开发人员说明了如何创建其联机帮助页(我想)。我正在寻找如何安装不是我的开源程序的手册页。
Sidahmed

1
它取决于特定的软件包,即它是否包括手册页,以及默认的安装命令是否处理并安装它们(例如,有些提供单独的Makefile目标,例如make docs您可以使用)
steeldriver

我可以举一个开源软件包的例子吗(如果您可以给我一个带有metasploit的例子,那就更好了,但是我想我这样问了很多)
Sidahmed16年

Answers:


1

man man 说:

   -l, --local-file
          Activate `local' mode.  Format and display  local  manual  files

您可以使用man --local-file /path/to/file。例如,如果要阅读名为的手册页example,则可以使用man --local-file ./example,前提是该文件存在于当前目录中。


这是完整的问题:我使用fishshell,此shell解析联机帮助页以查找参数(用于自动补全)。因此,我需要生成并安装手册页以帮助fish解析从源代码安装的程序的参数。
Sidahmed

@Sidahmed你有没有尝试过的人的页面文件移动到/usr/local/man/man1sudo mv example /usr/local/man/man1?然后关闭外壳并尝试man example
grooveplex '16

我不知道在哪里可以找到开放源代码程序的手册,我也没有很多关于此主题的信息。
Sidahmed

@Sidahmed该项目有手册页吗?
凹槽复活'16

是文件夹doc-pak吗?
Sidahmed16年
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.