如何建立和維護你自己的 man 手冊 | Linux 中國

我們已經討論了一些 man 手冊的替代方案[1]。 這些替代方案主要用於學習簡潔的 Linux 命令示例，而無需透過全面而過於詳細的手冊頁。 如果你正在尋找一種快速而簡單的方法來輕鬆快速地學習 Linux 命令，那麼這些替代方案值得嘗試。 現在，你可能正在考慮 —— 如何為 Linux 命令建立自己的 man 式的幫助頁面？ 這時 “Um” 就派上用場了。 Um 是一個命令列實用程式，可以用於輕鬆建立和維護包含你到目前為止所瞭解的所有命令的 man 頁面。

透過建立自己的手冊頁，你可以在手冊頁中避免大量不必要的細節，並且只包含你需要記住的內容。 如果你想建立自己的一套 man 式的頁面，“Um” 也能為你提供幫助。 在這個簡短的教程中，我們將學習如何安裝 “Um” 命令以及如何建立自己的 man 手冊頁。

安裝 Um

Um 適用於 Linux 和Mac OS。 目前，它只能在 Linux 系統中使用 Linuxbrew 軟體包管理器來進行安裝。 如果你尚未安裝 Linuxbrew，請參考以下連結：

安裝 Linuxbrew 後，執行以下命令安裝 Um 實用程式。

$ brew install sinclairtarget/wst/um

如果你會看到類似下麵的輸出，恭喜你！ Um 已經安裝好並且可以使用了。

[...]
==> Installing sinclairtarget/wst/um
==> Downloading https://github.com/sinclairtarget/um/archive/4.0.0.tar.gz
==> Downloading from https://codeload.github.com/sinclairtarget/um/tar.gz/4.0.0
-=#=# # #
==> Downloading https://rubygems.org/gems/kramdown-1.17.0.gem
######################################################################## 100.0%
==> gem install /home/sk/.cache/Homebrew/downloads/d0a5d978120a791d9c5965fc103866815189a4e3939
==> Caveats
Bash completion has been installed to:
/home/linuxbrew/.linuxbrew/etc/bash_completion.d
==> Summary
[] /home/linuxbrew/.linuxbrew/Cellar/um/4.0.0: 714 files, 1.3MB, built in 35 seconds
==> Caveats
==> openssl
A CA file has been bootstrapped using certificates from the SystemRoots
keychain. To add additional certificates (e.g. the certificates added in
the System keychain), place .pem files in
/home/linuxbrew/.linuxbrew/etc/openssl/certs
and run
/home/linuxbrew/.linuxbrew/opt/openssl/bin/c_rehash
==> ruby
Emacs Lisp files have been installed to:
/home/linuxbrew/.linuxbrew/share/emacs/site-lisp/ruby
==> um
Bash completion has been installed to:
/home/linuxbrew/.linuxbrew/etc/bash_completion.d

$ nano ~/.bash_profile

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 edit dpkg

$ um dpkg

$ um edit dpkg

$ um list

$ um rm dpkg

$ um --help
usage: um <page name>
 um <sub-command> [ARGS...]
The first form is equivalent to `um read `.
Subcommands:
 um (l)ist List the available pages for the current topic.
 um (r)ead <page name> Read the given page under the current topic.
 um (e)dit <page name> Create or edit the given page under the current topic.
 um rm <page name> Remove the given page.
 um (t)opic [topic] Get or set the current topic.
 um topics List all topics.
 um (c)onfig [config key] Display configuration environment.
 um (h)elp [sub-command] Display this help message, or the help message for a sub-command.

$ um config
Options prefixed by '*' are set in /home/sk/.um/umconfig.
editor = vi
pager = less
pages_directory = /home/sk/.um/pages
default_topic = shell
pages_ext = .md

pages_directory = /Users/myusername/Dropbox/um