4

Asciidoc を使用して CLI スクリプトのマンページを作成し、次のように変換したい

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

このコマンドでマンページに正常に変換できる Asciidoc の例は見つかりませんでした。例を教えてください。

4

2 に答える 2

6

例を見つけました-Asciidocソース自体から：

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

(それでも、Ascii-doc 形式のマンページの例は大歓迎です!)

于 2012-07-10T10:28:10.097 に答える
1

非常に有用な例を提供する @ifischer の回答からのリンクに加えて、asciidoc ドキュメントから次のページに読者を誘導したいと思います: http://www.methods.co.nz/asciidoc/chunked/ch24。 html .

特に、次のことが言及されています。

  • タイトルは適切にフォーマットする必要があります (例: PROGRAM(1))

  • doctype は "manpage" である必要があります (例: ":doctype: manpage")

  • 最初のセクションは「名前」である必要があります。このセクションの内容も適切にフォーマットする必要があります (例: "program - ...")。

  • 2 番目のセクションは「概要」である必要があります。このセクションの内容は何でもかまいませんが、標準的なマンページの慣行では、すべてのプログラム呼び出しオプションをリストすることになります。

  • もちろん、ドキュメントは適切にフォーマットされた asciidoc ドキュメントでなければなりません。

ドキュメント ヘッダーの ":directives:" を介してマンページに設定できるオプションの情報があります。

を実行するa2xと、名前セクションとタイトルの内容に基づいて、出力されたマンページに自動的に名前が付けられます。名前は名前セクションから、x はタイトルからの番号で、常に「name.x」という名前になっていると思います。

于 2014-01-08T01:29:45.973 に答える