.jar文件的手册页?

时间:2018-05-20 15:07:08

标签: java jar package

所以,我制作了一个jar文件,test.jar
有没有办法为jar文件制作手册页?
喜欢,

  

man java -jar test.jar

  

man test.jar

2 个答案:

答案 0 :(得分:1)

在unix中创建手册页的最简单方法是在模板的帮助下将其写为文本。

我们想说我们要为 myprog 创建一个手册页。

.\" Manpage for myprog.
.\" Contact myprog@ya.ru to thanks
.TH man 1 "20 March 2018" "1.0" "myprog man page"
.SH NAME
myprog \- Watch for directories, file or url change
.SH SYNOPSIS
myprog [user]
.SH DESCRIPTION
Watch for file changes into directories , file(s), or url.
myprog is beautiful

(..)


.SH OPTIONS
myprog  [url|file|(empty=folder)]
.SH SEE ALSO
inotify(7) my_otherprog(1)
.SH BUGS
Mail function is off.
.SH AUTHOR
MYPROG myprog@ya.ru

根据需要进行编辑,然后将文件命名为 myprog.1 ,如果您希望它在类别1中。

人类分类如下:

1   General commands
2   System calls
3   Library functions, covering in particular the C standard library
4   Special files (usually devices, those found in /dev) and drivers
5   File formats and conventions
6   Games and screensavers
7   Miscellanea
8   System administration commands and daemons

然后将您的手册页 myprog.1 复制到相应的文件夹中:

sudo cp myprog.1 /usr/local/share/man/man1/

更新man数据库:

sudo mandb

全部完成!

现在,所有用户都可以看到您的手册页:

man myprog

enter image description here

要稍后更新,只需再次替换。

答案 1 :(得分:0)

man是Unix特有的,对java和你的jar一无所知。

要阅读jar中的清单或帮助文件,您可以尝试类似

的内容

unzip -q -c test.jar META-INF / MANIFEST.MF>猫