スクリプトのmanページを作成できますか？

Question

可能性のある複製：
自分の電動工具のマニュアルページエントリを追加するにはどうすればよいですか？

ほとんど（すべてではない）のLinuxコマンドには、使用オプションなどを説明するマニュアルページがあります。自分のbashスクリプト用に同様のマニュアルページを作成できますか？

Answer 1

Manページはroff（man 7 roffを参照）形式のドキュメントです。

• 手で書くことができます。
• help2man を使用して、スクリプトのヘルプ出力から生成できます。
• マークアップ言語で記述し、専用のツールを使用してそれを人に変換することができます：
  • a2x（asciidocパッケージから） AsciiDoc
  • grutatxt for Grutatxt
  • pod2man（Perlパッケージから） [〜＃〜] pod [〜＃〜]
  • rst2man（docutilsパッケージから） reStructuredText
  • txt2tags for txt2tags
  • Mantastic （Heroku Webサービス）for Markdown

Answer 2

はい、できます。マニュアルページは nroff ファイルとして記述されています。
/usr/local/manディレクトリは、ローカルにインストールされたパッケージ/ファイルに通常使用される場所です。
既存のマンページ（最初に圧縮解除する必要がある可能性が高い）を見て例を確認することもできます man もご覧ください。
現在、多くのユーザーがnroffよりもgroffを好んでいますman groffはじめに