um

um 是一个命令行工具,用于创建和维护自己的 man 类似的帮助页面。它可用于 MacOS (通过 Homebrew) 和 Linux (通过 Arch 中的 AUR,否则通过 Homebrew,现在已在 Linux 上提供)。

假设你已经第三次提醒自己 grep 的工作原理。你想要保留这些宝贵的知识，以免再次翻阅 grep 的手册。你可以使用 um 来实现这一点：

um 支持多个附加子命令。其中包括：

• um list，列出您已有的所有 um 页面。
• um rm，删除现有的 um 页面。
• um topic，切换页面的主题命名空间，允许您为 CSS 属性等保留单独的 um 页面集。

幸运的是, Kramdown 库可以用来将 Markdown 文档转换为类似 roff 的 man 页。 (以前, um 使用了 Pandoc。如果切换到 Kramdown 破坏了您的 um 页,请参阅 UPGRADE.md。) 默认情况下, um 希望您使用 Markdown 编写 um 页,以便它可以将其转换并传递给 man 程序