本文介紹在 Linux 命令行下安裝、使用及配置 Um 來創建和維護自己的 man 手冊，Um 最大的好處是能為 Linux 命令創建自己的 man 式幫助頁面，它本身是一個命令行程序，可以用于輕松創建和維護包含你到目前為止所了解的所有命令的 man 頁面。通過創建自己的手冊頁，你可以在手冊頁中避免大量不必要的細節，并且只包含你需要記住的內容。如果你想創建自己的一套 man 式的頁面，那使用 Um 是最好不過的了，下面開始我們的教程。

安裝 Um

Um 適用于 Linux 和Mac OS。 目前，它只能在 Linux 系統中使用 Linuxbrew 軟件包管理器來進行安裝。如果你尚未安裝 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/d0a5d978fc103866815189a4e3939

==> 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

在制作你的 man 手冊頁之前，你需要為 Um 啟用 bash 補全。

要開啟 bash 補全，首先你需要打開 ~/.bash_profile 文件:

$ 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

準備工作全部完成。讓我們繼續創建我們的第一個 man 手冊頁。

創建并維護自己的man手冊

如果你想為 dpkg 命令創建自己的 man 手冊。請運行：

$ um edit dpkg

上面的命令將在默認編輯器中打開 markdown 模板：

我的默認編輯器是 Vi，因此上面的命令會在 Vi 編輯器中打開它。現在，開始在此模板中添加有關 dpkg 命令的所有內容。

下面是一個示例：

正如你在上圖的輸出中看到的，我為 dpkg 命令添加了概要，描述和兩個參數選項。你可以在 man 手冊中添加你所需要的所有部分。不過你也要確保為每個部分提供了適當且易于理解的標題。完成后，保存并退出文件(如果使用 Vi 編輯器，請按 ESC 鍵并鍵入:wq)。

最后，使用以下命令查看新創建的 man 手冊頁：

$ um dpkg

如你所見，dpkg 的 man 手冊頁看起來與官方手冊頁完全相同。如果要在手冊頁中編輯和/或添加更多詳細信息，請再次運行相同的命令并添加更多詳細信息：

$ um edit dpkg

要使用 Um 查看新創建的 man 手冊頁列表，請運行：

$ um list

所有手冊頁將保存在主目錄中名為 .um 的目錄下。

以防萬一，如果你不想要某個特定頁面，只需刪除它，如下所示：

$ um rm dpkg

要查看幫助部分和所有可用的常規選項，請運行：

$ um --help

usage: um

um [ARGS...]

The first form is equivalent to `um read `.

Subcommands:

um (l)ist List the available pages for the current topic.

um (r)ead Read the given page under the current topic.

um (e)dit Create or edit the given page under the current topic.

um rm 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

要查看當前配置，請運行：

$ 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

在此文件中，你可以根據需要編輯和更改 pager、editor、default_topic、pages_directory 和 pages_ext 選項的值。比如說，如果你想在 Dropbox 文件夾中保存新創建的 Um 頁面，只需更改 ~/.um/umconfig 文件中 pages_directory 的值并將其更改為 Dropbox 文件夾即可。

pages_directory = /Users/myusername/Dropbox/um

到這里，Um 就配置好了。

附：安裝 Linuxbrew 說明(英文)

The installation script installs Linuxbrew to /home/linuxbrew/.linuxbrew if possible and in your home directory at ~/.linuxbrew otherwise.

Paste at a Terminal prompt:

sh -c "$(curl -fsSL https://raw.githubusercontent.com/Linuxbrew/install/master/install.sh)"

Follow the Next steps instructions to add Linuxbrew to your PATH and to your bash shell profile script, either ~/.profile on Debian/Ubuntu or ~/.bash_profile on CentOS/Fedora/RedHat.

test -d ~/.linuxbrew && PATH="$HOME/.linuxbrew/bin:$HOME/.linuxbrew/sbin:$PATH"

test -d /home/linuxbrew/.linuxbrew && PATH="/home/linuxbrew/.linuxbrew/bin:/home/linuxbrew/.linuxbrew/sbin:$PATH"

test -r ~/.bash_profile && echo "export PATH='$(brew --prefix)/bin:$(brew --prefix)/sbin'":'"$PATH"' >>~/.bash_profile

echo "export PATH='$(brew --prefix)/bin:$(brew --prefix)/sbin'":'"$PATH"' >>~/.profile

You’re done! Try installing a package:

brew install hello

If you’re using an older distribution of Linux, installing your first package will also install a recent version of gcc.

Use brew doctor to troubleshoot common issues.

1.Features

Can install software to a home directory and so does not require sudo

Install software not packaged by the native distribution

Install up-to-date versions of software when the native distribution is old

Use the same package manager to manage both your Mac and Linux machines

2.Dependencies

GCC 4.4 or newer

Linux 2.6.16 or newer

64-bit x86 or 32-bit ARM (Raspberry Pi)

Paste at a Terminal prompt:

3.Debian or Ubuntu

sudo apt-get install build-essential curl file git

4.Fedora

sudo dnf groupinstall 'Development Tools' && sudo dnf install curl file git

5.CentOS or Red Hat

sudo yum groupinstall 'Development Tools' && sudo yum install curl file git

6.32-bit x86 platforms

Linuxbrew does not currently support 32-bit x86 platforms. It would be possible for Linuxbrew to work on 32-bit x86 platforms with some effort. Pull requests would be welcome if someone were to volunteer to maintain the 32-bit x86 support.

7.Bottles

Bottles are Linuxbrew’s precompiled binary packages. Linuxbrew bottles work on any Linux system. They do however require glibc 2.19 or better. On systems with an older version of glibc, Linuxbrew will install glibc the first time that you install a bottled formula. If you prefer to use the glibc provided by your system and build all formulas from source, add to your .bashrc or .zshrc:

export HOMEBREW_BUILD_FROM_SOURCE=1

8.Alternative Installation

Extract (or git clone) Linuxbrew wherever you want. Use /home/linuxbrew/.linuxbrew if possible.

git clone https://github.com/Linuxbrew/brew.git ~/.linuxbrew

PATH="$HOME/.linuxbrew/bin:$PATH"

export MANPATH="$(brew --prefix)/share/man:$MANPATH"

export INFOPATH="$(brew --prefix)/share/info:$INFOPATH"

相關主題

總結

以上是生活随笔為你收集整理的linux命令界面维护,在Linux命令行中使用Um来创建和维护man手册的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。