有效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

（儘管如此，Asciidoc格式的聯機幫助更多的例子非常歡迎！）

Answer 2

除了鏈接從@ ifischer的答案，它提供了一個非常有用的例子，我想引導讀者閱讀asciidoc文檔的以下頁面：http://www.methods.co.nz/asciidoc/chunked/ch24.html。

特別是，它提到：

• 標題需要被正確格式化（例如：程序（1））

• 文檔類型需要 「手冊頁」（例如：「 ：doctype：manpage「）

• 第一部分需要爲」名稱「。本節的內容也必須格式正確（例如：「程序 - ...」）

• 第二部分需要是「簡介」。看起來本節的內容可以是任何內容，但標準的聯機幫助頁練習將列出所有的程序調用選項。

• 該文件當然必須是格式正確的asciidoc文件。

有可選條信息可以用於經由手冊頁設置「：指令：」在文檔標題。

當您運行a2x時，它會根據名稱部分和標題的內容自動命名輸出的手冊頁。我相信它總是被命名爲「name.x」，其中名稱來自名稱部分，x是來自標題的數字。