マニュアルページを書くにはどうすればいいですか？[閉まっている]

16

manページを書くにはどうすればいいですか？

すべてのフォーマットコードの参照先はどこにありますか？

manページの作成に関する良いチュートリアルはありますか？

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

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

documentation

— アマリリオン
ソース

この質問は広すぎるようです。リンクのみの回答と支持されていないいくつかの意見を集めることに成功しました。

— 200_success 14年

man man、man groff。

— ジェニーD 14年

13

始めるのに役立ついくつかのWebページを次に示します。

いくつかの便利なツール：

— 追って通知があるまで一時停止します。
ソース

6

troffフォーマットをバイパスするマニュアルページを書くためのツールがあります。マンページは小さく、十分に区切られた言語であり、ターゲット設定が簡単です。

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

xmltomanは、マンページとhtmlを生成できる小さくてよく構造化されたxml言語です。Lennart Poetteringのプロジェクト（syrepやpulseaudioなど）で使用されます。
asciidoc、たとえばgitによって使用されます。

yodlとzoemは、この分野では他の優れた形式のようです。

全体として、xmltomanは非常にマンページ固有のdslであり、密接にガイドできるため、xmltomanをお勧めします。

— 東武
ソース

"dsl" == "ドメイン固有言語"？

— 追って通知があるまで一時停止します。

はい（da。si。15文字）

— 東武

1

別の優れたオプションはronnです。これは、より広く使用されているMarkdownテキストマークアップ言語を読み取ります。

— プーリー

5

このトピックに関するかなり広範囲なブログ記事を作成しました。ここで見つけることができます。

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

— ネイサン・オスマン
ソース

4

少なくともここで記事を要約できれば助かります。リンクされたページが必然的に移動したり消えたりすると、リンクだけでは価値がなくなります。

— カレブ

私はカレブに同意しません。これはウェブです。Webはリンクに基づいており、stackexchangeにはこれに関する特別な例外はありません。コンテンツのコピーは逆効果です。どのような悪いことが起こるにできるというページやドキュメントにもに発生する可能性があり、この 1。Webの残りの部分が消える可能性があるため、すべてのコンテンツのコピーを保存することはできません。（ウェイバックマシンのようなサイトにそのジョブを残します）。

— カズ

カズ、あなたは同意しないかもしれませんが、カレブのコメントは間違いなくServerFaultのベストプラクティスです。

— MadHatterは、モニカをサポートします

2

IDEやチュートリアルについては知りませんが、既存のmanページをコピーして、ニーズに合わせて変更することから始めることができます。

MANマクロを使用したgroff言語のリファレンス（マニュアルページで使用されているもの）については、groff_manのマニュアルページを参照するか、オンラインで読む

— ダン・アンドレアッタ
ソース

2

見てみましょうRONNプロジェクトを。マニュアルページジェネレーターへのマークダウンです。このように、htmlのmanページを生成することもできます。

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

— ブルーノ・ポラコ
ソース