文本屏幕的手册页编辑器

时间:2011-08-29 09:40:40

标签: linux documentation console man

你知道在文本屏幕(终端和控制台)上工作的man(1)页的任何编辑器吗?搜索被拘禁者没有给出任何有用的结果,因为这些词很常见。

或者我应该了解格式的详细信息并手工编写?

4 个答案:

答案 0 :(得分:3)

你可以写它,例如在markdown中,然后通过例如pandoc到联机帮助页格式((t|g)roff)。这是精细的手册:http://johnmacfarlane.net/pandoc/README.html

HTH

答案 1 :(得分:1)

当然,请继续学习格式并在常规文本编辑器中手动编写。

另一方面,perl项目使用一种名为pod的通用标记,然后通过运行pod2man转换为联机帮助页。

答案 2 :(得分:1)

手册页使用简单的标记语言troff以纯文本编写。

实际上有一些相关的标记系统都受到以roff结尾的一组命令所支持:nrofftroff以及所有歌唱,所有舞蹈超集{{1 }}

我的Mac OS 10.5系统在groff中有一个很好的历史摘要。

正如其他人所说,有几种工具可以将其他标记格式转换为手册页。

答案 3 :(得分:1)

最简单的方法是将内容写为“reStructuredText”(比wiki语法简单)并使用docutils从中生成手册页。

请参阅this tutorial