如何在Linux/UNIX中创建联机帮助页

时间:2020-01-09 10:42:11  来源:igfitidea点击:

如何在类似Linux/UNIX的操作系统下为shell或者python脚本创建手册页?
几乎像oses一样,所有UNIX都预装了手册页。

Troff和Groff宏

.TH宏引入了手册页(例如,设置手册页标题和部分)。
使用.SH宏显示的节标题,段落分隔符,列表和显示等。
请参见下面的手册页,其中描述了所有宏:

man 7 mdoc

如何安装手册页?

只需执行以下命令:

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

您还可以如下使用install命令(对于shell脚本推荐):

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