BASH：为别名创建手册页

Question

使用bash时我有很多别名，有时候我倾向于忘记某个别名的作用。是否可以在运行man <youralias>？

时为别名创建简短描述

Answer 1

虽然在How to add entry in Linux man page database

上有答案

这样做更容易。

创建一个文本文件，其中包含解释别名的简短段落，然后将其保存到alias-name.txt

获取ronn（红宝石宝石），这将从您的文本生成man / troff / roff格式文件。

gem install ronn

然后转换您的文本文件：

ronn -r alias-name.txt

将创建文件./alias-name，将其移至您当地的共享人路径。例如

mv alias-name /usr/local/share/man1/alias-name.1

现在欣赏你的手工......

man alias-name

要获得更高级的格式，请查看ronn格式（基于Markdown。）https://rtomayko.github.io/ronn/ronn-format.7.html