如何为Jar文件创建man手册？支持`man test.jar`等调用形式

当然可以给你的test.jar创建man手册！不过得先澄清一个小问题：man java -jar test.jar这种调用方式没法直接实现——因为man的命令逻辑是man [选项] 手册名，这里的-jar会被当成man自身的选项，而不是java的参数。不过我们可以完美实现man test.jar，同时给你一个更实用的替代方案来覆盖你想要的场景。下面一步步来：

一、实现man test.jar直接调用手册 #

1. 编写man页面文件 #

首先创建一个troff格式的man手册源文件，比如命名为testjar.1（man手册的命名规则是名称.章节号，1代表用户命令）。这里给你一个基础模板，你可以根据自己的test.jar功能修改：

.TH TESTJAR 1 "2024年5月20日" "1.0" "test.jar 应用手册"
.SH 名称
test.jar - 自定义Java应用程序
.SH 概要
java -jar /path/to/test.jar [选项]
.SH 描述
这是一个用于XXX功能的Java应用程序，支持以下选项...
.SH 选项
.TP
\-h, \-\-help
显示应用帮助信息
.TP
\-v, \-\-version
显示应用版本号
.SH 示例
.TP
运行应用并显示帮助：
java -jar test.jar -h
.TP
启动应用的调试模式：
java -jar test.jar --debug
.SH 作者
你的名字/团队名
.SH 版权
MIT License（根据实际情况修改）

2. 压缩并安装手册 #

man手册通常以gzip压缩格式存放，执行以下命令处理：

# 压缩源文件
gzip testjar.1

然后把压缩后的文件放到man的系统搜索路径（需要sudo权限）：

sudo mv testjar.1.gz /usr/share/man/man1/

如果是个人用户不想用sudo，可以放到用户本地的man目录：

# 先创建目录（如果不存在）
mkdir -p ~/.local/share/man/man1/
# 移动文件
mv testjar.1.gz ~/.local/share/man/man1/
# 确保本地man目录在MANPATH中（可以添加到.bashrc/.zshrc）
echo 'export MANPATH="$HOME/.local/share/man:$MANPATH"' >> ~/.bashrc
source ~/.bashrc

3. 创建符号链接实现man test.jar #

默认情况下我们的手册是testjar.1.gz，对应man testjar，要支持man test.jar，只需创建一个符号链接：

# 系统目录的情况
sudo ln -s testjar.1.gz /usr/share/man/man1/test.jar.1.gz
# 本地目录的情况
ln -s testjar.1.gz ~/.local/share/man/man1/test.jar.1.gz

4. 更新man数据库并测试 #

最后更新man的搜索数据库，确保能找到新添加的手册：

# 系统目录用sudo
sudo mandb
# 本地目录
mandb ~/.local/share/man

现在运行man test.jar或者man testjar就能看到你的自定义手册了！

二、替代man java -jar test.jar的实用方案 #

既然直接调用man java -jar test.jar不可行，我们可以给test.jar做一个shell包装脚本，让用户可以像调用普通命令一样启动应用，同时直接用man查看手册，体验更流畅：

1. 创建shell包装脚本 #

创建一个名为testjar的脚本（放在/usr/local/bin/或者~/.local/bin/）：

#!/bin/bash
# 替换成你的test.jar实际路径
JAR_PATH="/path/to/your/test.jar"

if [ ! -f "$JAR_PATH" ]; then
    echo "错误：找不到test.jar文件，请检查路径"
    exit 1
fi

java -jar "$JAR_PATH" "$@"

给脚本添加执行权限：

# 系统路径（需要sudo）
sudo chmod +x /usr/local/bin/testjar
# 本地路径
chmod +x ~/.local/bin/testjar

2. 关联手册 #

因为我们已经有了testjar.1.gz手册，现在用户运行testjar就能启动应用，运行man testjar就能查看手册，完全满足你想要的“通过man查看应用文档”的需求，比man java -jar test.jar更符合Linux命令的使用习惯。

内容的提问来源于stack exchange，提问作者DYK