unix - MAN コマンドを使用してスクリプトのドキュメントを記述する

Question

perl のサンプル スクリプトがあります。例 script.pl 内容: print "Hello\n";

また、上記のスクリプトのドキュメントを script.doc として用意しており、スクリプトの使用法やその他の詳細について説明しています。ドキュメントを完全に説明するようにMANコマンドを書きたいです。ドキュメントを参照として使用します。

助けてください。私はUNIXを初めて使用するため、同じリードを見つけることができません。

ありがとう

Answer 1

man テキスト用に troff 形式のページを作成する必要があります -ここで説明されているように、それを /usr/local/share/man (または他の man ディレクトリ) に配置するインストーラが必要です。 man ページを直接ロードするスクリプトに help オプションを追加します。

例のページ:

.\" Manpage for nuseradd.
.\" Contact vivek@nixcraft.net.in to correct errors or typos.
.TH man 8 "06 May 2010" "1.0" "nuseradd man page"
.SH NAME
nuseradd \- create a new LDAP user
.SH SYNOPSIS
nuseradd [USERNAME]
.SH DESCRIPTION
nuseradd is high level shell program for adding users to LDAP server.  On Debian, administrators should usually use nuseradd.debian(8) instead.
.SH OPTIONS
The nuseradd does not take any options. However, you can supply username.
.SH SEE ALSO
useradd(8), passwd(5), nuseradd.debian(8)
.SH BUGS
No known bugs.
.SH AUTHOR
Vivek Gite (vivek@nixcraft.net.in)