要转换为手册页的有效Asciidoc (带a2x)

Question

我想用Asciidoc为我的CLI脚本编写手册页，并将其转换为

a2x --doctype manpage --format manpage MYMANPAGE.ASCIIDOC

我找不到任何Asciidoc示例，可以使用此命令将其成功转换为手册页。你能给我举个例子或提供一个例子吗？

Answer 1

找到一个例子-来自Asciidoc源代码本身：

http://code.google.com/p/asciidoc/source/browse/doc/asciidoc.1.txt

(不过，欢迎使用Ascii-doc格式的手册页的更多示例！)

Answer 2

除了@ifischer的答案中提供了一个非常有用的示例的链接之外，我还想将读者从asciidoc文档中引导到以下页面：http://www.methods.co.nz/asciidoc/chunked/ch24.html。

它特别提到：

名称标题需要正确格式化(例如: PROGRAM(1))

• the doctype需要是"manpage“(例如：：doctype：
• ))
• 第一部分需要是"Name”。此部分的内容也必须格式正确(例如："program -...“)
• 第二部分需要为”概要“。看起来这一部分的内容可以是任何内容，尽管标准的手册页做法是列出所有程序调用选项。
• 文档当然必须是格式正确的asciidoc文档。

可以通过文档标题中的“：指令：”为手册页设置可选的信息。

当您运行a2x时，它将根据名称部分和标题的内容自动命名输出的手册页。我相信它总是被命名为"name.x"，其中name来自name部分，x是来自标题的数字。