我该如何写手册页?[关闭]


16

如何编写手册页?

在哪里可以找到所有格式代码的参考?

在编写手册页方面有什么好的教程吗?

编写手册页最方便的方法是什么?我应该直接在文本编辑器中输入它吗?有所见即所得的编辑器吗?还是应该以其他格式编写然后转换?

好人手册应遵循哪些规则?


这个问题似乎太广泛了。它仅成功地吸引了许多仅链接的答案和一些不受支持的意见。
200_success 2014年

man manman groff
珍妮·D

Answers:



6

有一些写手册页的工具可以绕过troff格式。联机帮助页是一种很小的,定界的语言,易于定位。

两种流行的工具是:

yodlzoem在这个领域似乎是其他不错的格式。

总而言之,我建议xmltoman,因为它是一个非常帮助手册的dsl,它将密切指导您。


“ dsl” ==“域特定语言”?
暂停,直到另行通知。

是的(da。si。15个字符。)
Tobu 2010年

1
另一个不错的选择是ronn,它可以读取使用更广泛的Markdown文本标记语言。
poolie

5

我写了一篇有关该主题的相当广泛的博客文章,您可以在这里找到:

http://2buntu.com/articles/1034/how-to-write-a-manpage/


4
如果您至少可以在这里总结一下文章,将会很有帮助-一旦链接的页面不可避免地移动或消失,仅链接是毫无价值的。
Caleb 2013年

我不同意Caleb。这是网络。网络是基于链接的,而stackexchange对此没有任何特殊的例外。复制内容会适得其反。无论坏事可以发生在页面或文档也可以发生在一个。我们不能仅仅因为网络的其余部分可能消失而ho积所有内容的抓取副本。(将该工作留给类似Wayback Machine的站点)。
卡兹(Kaz)

Kaz,您可能不同意,但是Caleb的评论绝对是ServerFault的最佳实践。
MadHatter 2014年

2

我不知道任何IDE或教程,但是您可以从复制现有的手册页开始并对其进行修改以适合您的需求。

有关带有MAN宏的groff语言的参考(手册页使用的内容),请查阅groff_man手册页,或在此处在线阅读


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.