マニュアルページをどのように作成し、どのスタイルを使用する必要がありますか？ [閉鎖]

私の質問は、プロジェクトがほぼ完了した後、マニュアルページなどの文書化などの作業に集中する時間です。

今、人々はマンページを好むかもしれないし、好きではないかもしれませんが、Linuxのツールと一緒にマンページを提供するのはほぼ標準的な方法です。

しかし、私の問題は、それを正確に構築してプログラムする方法に関する情報を見つけることです。

どのセクションを常に含めるべきかなどのおおよそのガイドラインがあることを知っています。しかし、私はgroff、、、、sshなどの内容を理解し、base64それを（正しく）書く方法を理解するために、主にすでに書かれているマニュアルページに頼っていました。

問題は彼らのスタイルが非常に多様であるということです。

オプションテーブルで一般的に使用されるコマンドではなく、一般的なbase64コマンドを使用するためのマニュアルページ。しかし、 troff に似たエスケープシーケンスを使用します。.SH.TP.OP

.TP
\fB\-d\fR, \fB\-\-decode\fR
decode data

簡単だと言えば十分です。

マニュアルページはgroff全く違う話です。概要は同様のスイッチコマンドを使用します.SY。.OP

.SH SYNOPSIS
.\" --------------------------------------------------------------------
.
.SY groff
.OP \-abcegijklpstzCEGNRSUVXZ
.OP \-d cs
.OP \-D arg
.OP \-f fam
...

エスケープシーケンスをほとんど使用せず、代わりにテキストは次のように構成されています。

.TP
.B \-j
Preprocess with
.BR chem .
.
Implies
.BR \-p .

つまり、エスケープシーケンスの代わりに troff コマンドを使用します。

他の同様の例があり、マニュアルページを書いた人なら誰でも他のスタイルなどを知っています。

この時どんなスタイルに従うべきか悩みになります。少なくともいくつかのリファレンスガイドがあれば良いでしょう。基本的にこれを実装する方法についての入門書や何かがあるかもしれません。 （例：.SYコマンドが何をしているのかわかりませんでした。）

このページは始めに役に立ちましたが、すぐにその使いやすさがなくなりました。

• http://www.linuxhowtos.org/System/creatingman.htm
• https://www.linux.com/news/what-you-need-know-write-man-pages
• http://liw.fi/manpages/

---

編集：マニュアルページの追加情報

• http://man7.org/linux/man-pages/man7/groff_man.7.html
• http://man7.org/linux/man-pages/man7/mdoc.samples.7.html
• http://man7.org/linux/man-pages/man7/mdoc.7.html

ありがとう、スティーブン・ハリス。