web-dev-qa-db-ja.com

マニュアルページの書き方は?

マニュアルページを書くにはどうすればいいですか?

すべてのフォーマットコードのリファレンスはどこにありますか?

Manページの作成に関する優れたチュートリアルはありますか?

Manページを書く最も便利な方法は何ですか?テキストエディターに直接入力する必要がありますか? WYSIWYGエディタはありますか?または、別の形式で書き込んでから変換する必要がありますか?

良いmanページはどのルールに従うべきですか?

16
amarillion

Troffフォーマットをバイパスするmanページを書くためのツールがあります。マンページは小さくて区切られた言語であり、簡単にターゲティングできます。

2つの一般的なツールは次のとおりです。

yodlzoem は、この分野では他の素晴らしい形式のようです。

概して、xmltomanはマンページ固有のdslであるため、詳しく説明します。

6
Tobu

私はトピックについてかなり広範囲のブログ記事を書きました、あなたはここで見つけることができます:

http://2buntu.com/articles/1034/how-to-write-a-manpage/

5
Nathan Osman

ronn project を見てください。その markdown からmanページジェネレータ。 this のように、HTMLでmanページを生成することもできます。

ソフトウェアのドキュメントをすべて1つの形式で書くのが好きです。 Markdown IMOは良い選択です

2
Bruno Polaco

IDEやチュートリアルは知りませんが、まずは既存のmanページをコピーして、ニーズに合わせて修正することができます。

MANマクロ(manページで使用されているもの)でのgroff言語のリファレンスについては、groff_manマニュアルページ、または ここからオンラインで読む

2
Dan Andreatta