Question

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

我还有一个上述脚本的文档作为script.doc，它描述了脚本用法和其他细节。我想编写MAN命令，以便完全解释文档。使用该文件作为参考。

请帮忙。我也无法找到任何相同的领导者，我也不熟悉UNIX。

由于

Answer 1

你需要为man文本创建一个troff格式的页面 - 如here所述，然后你需要一个安装程序将它放在/ usr / local / share / 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)

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

1 个答案: