Question

如何为shell脚本创建手册页？我无法找到关于如何在Google上制作手册页的初学者方法。

根据模板创建自己的Man页面的最简单方法是什么，并使用我的脚本安装它？

Answer 1

我建议您使用Grapse是一个在线手册页编辑器，因为您可以实时查看结果我相信这对初学者非常有用。

Answer 2

使用pandoc怎么样？您可以在markdown（甚至是html，latex）中编写文档，并且可以转换为html，pdf，word，手册页，epub，....这样您就可以编写文档了一种格式并以您喜欢的任何格式转换/分发

Answer 3

示例手册页，来自link：

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

使用您的脚本安装：

install -g 0 -o 0 -m 0644 nuseradd.1 /usr/local/man/man8/
gzip /usr/local/man/man8/nuseradd.1

手动安装：

cp nuseradd /usr/local/man/man8/nuseradd.1
gzip /usr/local/man/man8/nuseradd.1

Answer 4

help2man在给出--help标志时使用脚本的输出来生成正确的联机帮助页。

这需要很少的努力并提供合理的输出。因为它在传递--help和--version时依赖于脚本的输出，它也会迫使你写出一个不错的--help： - ）

Answer 5

C1sc0你的答案有误。

制作自己的手册页，请按照以下步骤操作：

1-成为超级用户：

awk

2-转到此目录：

$ sudo -i

3-复制粘贴此man（maual）页面模板，然后根据您的项目对其进行个性化设置：

$ cd /usr/bin
$ nano your_function

4-您必须选择文件必须在哪个目录中，请查看：

./" Manpage for your_fonction
.TH man 1 "10 September 2017" "1.0" "your_fonction man page"
.SH NAME
your_fonction - do.... 
.SH SYNOPSIS
your_fonction [optionnal argument] [optionnal argument]
.SH DESCRIPTION
your_fonction is a function which .....
.SH OPTIONS
your_fonction does not take any options
.SH BUGS
No known bugs.
.SH AUTHOR
written by your_name (your_website or your_github or whatever)
.SH REPORTING BUGS
you_github_repository/isssues for example

你看到man1，man2，.... 这些是类别：

（man1）1 - 用户可用的命令
（man2）2 - Unix和C系统调用
（man3）3 - C程序用于C程序
（man4）4 - 特殊文件名
（man5）5 - Unix使用的文件的文件格式和约定
（man6）6 - 游戏
（man7）7 - 文字处理包
（man8）8 - 系统管理命令和程序

这里的例子目的地是man1，所以：

5-回到usr / bin

$ cd/usr/share/man/ && ls

6-制作带有良好后缀的副本：

$ cd /usr/bin

7-gzip your_function.1

$ cp your_function your_function.1

8-将它发送到好的目录，这里的例子是man1：

$ gzip your_function.1

完成了，你可以测试你美丽的男人页面！

$ cp your_function.1.gz /usr/share/man/man1/

如何为我的shell脚本创建一个手册页？

5 个答案: