嗯,创建并维护自己的Ubuntu手册页

大约

在下一篇文章中,我们将看一下Um。 今天,没有人可以怀疑手册页及其替代方法的用处。 这些替代方法主要用于访问 定制示例,因此不必遍历整个手册页。 如果您正在寻找一种快速交流或轻松学习Gnu / Linux命令的方法,那么这些替代方法值得尝试。 Um将允许我们为命令创建我们自己的帮助页面。 这是一个终端实用程序,对于 轻松创建和维护我们自己的手册页 仅包含我们感兴趣的内容。

通过创建自己的帮助页面,您可以避免许多“细节手册页中仅包含必要的内容,以考虑到我们感兴趣的情况。 如果你想 创建自己的手册页集,绝对对您有用。

在Ubuntu 18.04上安装Um

Um适用于Gnu / Linux和Mac OS。 在我写这篇文章的时候,我只是 可以使用Linuxbrew软件包管理器安装 在Gnu / Linux系统上。 检查以下内容 文章(如果尚未安装Linuxbrew) 在您的Ubuntu上,因为必须执行以下操作。

安装Linuxbrew后,在终端(Ctrl + Alt + T)中运行以下命令以 安装Um:

使用linuxbrew进行UM安装

brew install sinclairtarget/wst/um

如果一切顺利,终端将告诉我们安装已令人满意地完成。

在使用它制作手册页之前,您必须 为Um启用bash完成。 为此,请打开您的文件 在〜/ .bash_profile:

vi ~/.bash_profile

并且,将以下行添加到文件中:

bash配置文件um install linuxbrew

if [ -f $(brew --prefix)/etc/bash_completion.d/um-completion.sh ]; then
. $(brew --prefix)/etc/bash_completion.d/um-completion.sh
fi

保存并关闭文件。 现在运行以下命令 更新变更:

source ~/.bash_profile

都准备好了现在,我们可以创建我们的第一个手册页。

配置Um

查看当前设置, 跑:

UM配置

um config

在此文件中,我们最感兴趣的是我们将能够编辑和更改选项的值,例如默认主题,页面目录和页面。 举例来说,假设您要保存在Dropbox文件夹中创建的Um页面,只需更改pages目录指令的值并将其发送到 档案 〜/ .um / umconfig 在里面写。

pages_directory = /home/tu-usuario/Dropbox/um

如果未创建此文件,则需要创建该文件来存储配置。

创建和维护自己的手册页

假设您有兴趣 为命令创建自己的手册页 'apt',在终端上运行(Ctrl + Alt + T):

um edit apt

上面的命令将打开一个 您的默认编辑器中的模板:

关于使用um创建的apt的手册页模板

我的默认编辑器是Vi。 现在,我们可以开始 添加您需要记住的所有内容 关于此模板中的“ apt”命令。

整版

如上面的屏幕截图所示,作为示例,我添加了apt命令的提要,描述和一些选项。 您将能够 根据需要添加任意数量的部分 在这些页面上。 确保为每个部分提供适当且易于理解的标题。 完成后,保存并退出文件。 如果使用的是Vi编辑器,请按ESC键并输入:wq。

现在你可以 查看您新创建的手册页 使用命令:

用apt um创建的手册页

um apt

如您所见,apt的手册页 看起来与官方手册页相同。 如果要在手册页中编辑和/或添加更多详细信息,请再次运行同一命令并添加所需的详细信息。

um edit apt

抓住她 最近使用Um创建的手册页列表,在终端(Ctrl + Alt + T)中运行:

um list

如果不 您不再需要特定页面,只需将其删除,如下所示:

um rm dpkg

请参阅帮助部分 以及所有可用的常规选项,启动命令:

嗯帮助

um --help

todas 手册页将保存在名为〜/ .um的目录中 在您的主目录中。 任何人都可以 了解有关此应用程序的更多信息 在项目所在的存储库中 GitHub上.


成为第一个发表评论

发表您的评论

您的电子邮件地址将不会被发表。 必填字段标有 *

*

*

  1. 负责数据:MiguelÁngelGatón
  2. 数据用途:控制垃圾邮件,注释管理。
  3. 合法性:您的同意
  4. 数据通讯:除非有法律义务,否则不会将数据传达给第三方。
  5. 数据存储:Occentus Networks(EU)托管的数据库
  6. 权利:您可以随时限制,恢复和删除您的信息。