macos - 如何在 mac os x 上安装自定义 man(手册)页

Question

我正在尝试在 Mac OS X 10.9.5 上为 bash 脚本安装手册页。我尝试遵循的过程总结如下:man page tutorial .我还总结了我在下面尝试的步骤:

cp custom_command.1 /usr/local/man/man1/custom_command.1
gzip /usr/local/man/man1/custom_command.1

尝试时 man custom_command我收到输出 No manual entry for custom_command .我也尝试过 man page tutorial中提到的其他安装方法.

有趣的是，上述步骤适用于 emacs 控制台，即当我输入 man custom_command 时，我确实得到了正确的手册。但是，自动完成功能无法识别该命令，并且在我能够阅读手册之前收到以下警告: WARNING: terminal is not fully functional .

关于如何解决上述问题的任何建议(即系统终端和 emacs 控制台)将不胜感激。

备注 1

作为引用，我尝试安装的 man 脚本取自 tutorial并在下面重述以供引用:

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

Answer 1

首先，您可能需要检查您尝试安装的手册页格式是否正确以及是否可以通过 man 打开。命令。为此，将 man 文件的路径传递给 man命令。它必须包含斜杠才能被识别为路径，例如:

man /usr/local/man/man1/custom_command.1

然后，您应该确保安装手册页的路径在 man 的搜索列表中。命令。为了找到手册页，它的路径必须是:

指定为 -M man 的选项命令

在环境变量中设置 MANPATH

列在其配置文件(在 OS X 上为 /private/etc/man.conf)中 MANPATH 下声明或下MANPATH_MAP声明(仅适用于 PATH 环境变量中的位置)

位于相对于安装二进制文件的位置，即:如果二进制文件安装在 path/bin在 path/man 中搜索手册页, path/cat和 path/bin/man , path/bin/cat

在 /private/etc/manpaths.d/ 中添加的文件中列出目录

手册页文件的名称必须与带有可选节号的命令名称相同。它可以被gzip压缩。

看看男人会在哪里搜索你的 custom_command手册页运行

man -d custom_command