|
本文介绍在 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 <page name> um <sub-command> [ARGS...] The first form is equivalent to `um read <page name>`. 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 要查看当前配置，请运行： $ 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"
相关主题 |
