我想用Asciidoc为我的CLI脚本编写联机帮助页,并用
转换它a2x --doctype manpage --format manpage MYMANPAGE.ASCIIDOC
我找不到任何可以使用此命令成功转换为联机帮助页的Asciidoc示例。 你能指点我一个例子还是提供一个例子?
答案 0 :(得分:5)
找到一个例子 - 来自Asciidoc来源本身:
http://code.google.com/p/asciidoc/source/browse/doc/asciidoc.1.txt
(尽管如此,Ascii-doc格式的联机帮助页的更多示例非常受欢迎!)
答案 1 :(得分:1)
除了来自@ ifischer的答案的链接,它提供了一个非常有用的示例,我想引导读者阅读asciidoc文档中的以下页面:http://www.methods.co.nz/asciidoc/chunked/ch24.html。
特别提到:
标题需要格式正确(例如:PROGRAM(1))
doctype需要为“manpage”(例如:“:doctype:manpage”)
第一部分需要是“名称”。还必须正确格式化本节的内容(例如:“program - ...”)
第二部分需要是“概要”。看来本节的内容可以是任何内容,尽管标准的手册页练习是列出所有程序调用选项。
该文档当然必须是格式正确的asciidoc文档。
可以通过文档标题中的“:directives:”为手册页设置可选的信息。
当您运行a2x
时,它会根据名称部分和标题的内容自动命名输出的联机帮助页。我相信它总是被命名为“name.x”,其中name来自名称部分,x是标题中的数字。