譯者： way-ww
我們已經(jīng)討論了一些 man 手冊(cè)的替代方案 。 這些替代方案主要用于學(xué)習(xí)簡(jiǎn)潔的 Linux 命令示例，而無(wú)需通過(guò)全面而過(guò)于詳細(xì)的手冊(cè)頁(yè)。 如果你正在尋找一種快速而簡(jiǎn)單的方法來(lái)輕松快速地學(xué)習(xí) Linux 命令，那么這些替代方案值得嘗試。 現(xiàn)在，你可能正在考慮 —— 如何為 Linux 命令創(chuàng)建自己的 man 式的幫助頁(yè)面？ 這時(shí) “Um” 就派上用場(chǎng)了。 Um 是一個(gè)命令行實(shí)用程序，可以用于輕松創(chuàng)建和維護(hù)包含你到目前為止所了解的所有命令的 man 頁(yè)面。
通過(guò)創(chuàng)建自己的手冊(cè)頁(yè)，你可以在手冊(cè)頁(yè)中避免大量不必要的細(xì)節(jié)打開(kāi)vi編輯器進(jìn)行，并且只包含你需要記住的內(nèi)容。 如果你想創(chuàng)建自己的一套 man 式的頁(yè)面，“Um” 也能為你提供幫助。 在這個(gè)簡(jiǎn)短的教程中，我們將學(xué)習(xí)如何安裝 “Um” 命令以及如何創(chuàng)建自己的 man 手冊(cè)頁(yè)。
安裝 Um
Um 適用于 Linux 和Mac OS。 目前，它只能在 Linux 系統(tǒng)中使用 軟件包管理器來(lái)進(jìn)行安裝。 如果你尚未安裝 ，請(qǐng)參考以下鏈接：
安裝 后，運(yùn)行以下命令安裝 Um 實(shí)用程序。
$ brew /wst/um
如果你會(huì)看到類似下面的輸出，恭喜你！ Um 已經(jīng)安裝好并且可以使用了。
[...]
==> /wst/um
==>
==> from
-=#=# # #
==>
######################################################################## 100.0%
==> gem /home/sk/.cache///
==>
Bash has been to:
/home//./etc/.d
==>
[] /home//.//um/4.0.0: 714 files, 1.3MB, built in 35
==>
==>
A CA file has been using from the
. To add (e.g. the added in
the ), place .pem files in
/home//./etc//certs
and run
/home//./opt//bin/
==> ruby
Emacs Lisp files have been to:
/home//./share/emacs/site-lisp/ruby
==> um
Bash has been to:
/home//./etc/.d
在制作你的 man 手冊(cè)頁(yè)之前，你需要為 Um 啟用 bash 補(bǔ)全。
要開(kāi)啟 bash 補(bǔ)全，首先你需要打開(kāi) ~/. 文件:
$ nano ~/.
并在其中添加以下內(nèi)容：
if [ -f $(brew --)/etc/.d/um-.sh ]; then
. $(brew --)/etc/.d/um-.sh
fi
保存并關(guān)閉文件。運(yùn)行以下命令以更新更改。
$ ~/.
準(zhǔn)備工作全部完成。讓我們繼續(xù)創(chuàng)建我們的第一個(gè) man 手冊(cè)頁(yè)。
創(chuàng)建并維護(hù)自己的man手冊(cè)
如果你想為 dpkg 命令創(chuàng)建自己的 man 手冊(cè)。請(qǐng)運(yùn)行:
$ um edit dpkg
上面的命令將在默認(rèn)編輯器中打開(kāi) 模板：
我的默認(rèn)編輯器是 Vi，因此上面的命令會(huì)在 Vi 編輯器中打開(kāi)它。現(xiàn)在打開(kāi)vi編輯器進(jìn)行，開(kāi)始在此模板中添加有關(guān) dpkg 命令的所有內(nèi)容。
下面是一個(gè)示例：
正如你在上圖的輸出中看到的，我為 dpkg 命令添加了概要，描述和兩個(gè)參數(shù)選項(xiàng)。 你可以在 man 手冊(cè)中添加你所需要的所有部分。不過(guò)你也要確保為每個(gè)部分提供了適當(dāng)且易于理解的標(biāo)題。 完成后，保存并退出文件（如果使用 Vi 編輯器，請(qǐng)按 ESC 鍵并鍵入:wq）。
最后，使用以下命令查看新創(chuàng)建的 man 手冊(cè)頁(yè)：
$ um dpkg
如你所見(jiàn)，dpkg 的 man 手冊(cè)頁(yè)看起來(lái)與官方手冊(cè)頁(yè)完全相同。 如果要在手冊(cè)頁(yè)中編輯和/或添加更多詳細(xì)信息，請(qǐng)?jiān)俅芜\(yùn)行相同的命令并添加更多詳細(xì)信息。
$ um edit dpkg
要使用 Um 查看新創(chuàng)建的 man 手冊(cè)頁(yè)列表，請(qǐng)運(yùn)行：
$ um list
所有手冊(cè)頁(yè)將保存在主目錄中名為 .um 的目錄下
以防萬(wàn)一，如果你不想要某個(gè)特定頁(yè)面，只需刪除它，如下所示。
$ um rm dpkg
要查看幫助部分和所有可用的常規(guī)選項(xiàng)，請(qǐng)運(yùn)行：
$ um --help
usage: um
um [ARGS...]
The first form is to `um read
`.
:
um (l)ist List the pages for the topic.
um (r)ead
Read the given page under the topic.
um (e)dit
or edit the given page under the topic.
um rm
the given page.
um (t)opic [topic] Get or set the topic.
um List all .
um (c)onfig [ key] .
um (h)elp [sub-] this help , or the help for a sub-.
配置 Um
要查看當(dāng)前配置，請(qǐng)運(yùn)行：
$ um
by '*' are set in /home/sk/.um/.
= vi
pager = less
= /home/sk/.um/pages
= shell
= .md
在此文件中，你可以根據(jù)需要編輯和更改 pager、、、 和 選項(xiàng)的值。 比如說(shuō)，如果你想在 文件夾中保存新創(chuàng)建的 Um 頁(yè)面，只需更改 ~/.um/ 文件中 的值并將其更改為 文件夾即可。
= /Users///um
這就是全部?jī)?nèi)容，希望這些能對(duì)你有用，更多好的內(nèi)容敬請(qǐng)關(guān)注！
干杯！
via:
作者： SK 選題： 譯者： way-ww 校對(duì)： wxy
本文由 LCTT 原創(chuàng)編譯， Linux中國(guó) 榮譽(yù)推出
