unix - 使用 MAN 命令描述脚本的文档

Question

我在 perl 中有一个示例脚本。例如 script.pl 内容：打印“Hello\n”；

我还有一个上述脚本的文档 script.doc，其中描述了脚本的用法和其他详细信息。我想编写 MAN 命令，以便完整地解释文档。使用文档作为参考。

请帮忙。我也无法找到任何线索，我也是 UNIX 新手。

谢谢

Answer 1

您需要为 man 文本创建一个 troff 格式的页面 - 如此处所述，然后您需要安装程序将其放入 /usr/local/share/man （或其他 man 目录），或者您可以提供 --直接加载手册页的脚本的帮助选项。

示例页面：

.\" 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)