我討論了一些 手冊頁的一個很好的替代品..這些替代方法主要用於學習簡潔的 Linux 命令示例,而無需閱讀全面的手冊頁。 如果您正在尋找一種簡單快捷的方式來學習 Linux 命令,那麼值得一試這些替代方法。現在您可能正在思考如何為 Linux 命令創建自己的類人幫助頁面?這是哪裡 “1” 方便的。 Um 是一個命令行實用程序,可讓您輕鬆創建和維護您自己的手冊頁,其中僅包含您目前對命令的了解。
通過創建自己的手冊頁替代方案,您可以避免許多不必要的全面細節,並且只包含您需要記住的內容。如果您想像人一樣創建自己的頁面組,Um 絕對有幫助。這個簡短的教程將向您展示如何安裝“Um”命令行實用程序以及如何創建您自己的手冊頁。
內容
嗯安裝
Um 適用於 Linux 和 Mac OS。目前僅使用安裝 Linuxbrew Linux 系統包管理器。 如果您沒有安裝 Linuxbrew,請參閱下面的鏈接。
- Linuxbrew-適用於 Linux 和 Mac OS X 的通用包管理器
安裝 Linuxbrew 後,運行以下命令安裝 Um 實用程序。
$ brew install sinclairtarget/wst/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
在使用make man page之前,需要先開啟bash才能完成um。
去做這個 ~/.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
全部完成。讓我們繼續創建第一個手冊頁。
創建和維護您自己的手冊頁
假設您想為“dpkg”命令創建自己的手冊頁。為此,請執行以下操作:
$ um edit dpkg
上述命令將在您的默認編輯器中打開降價模板。
創建一個新的手冊頁
我的默認編輯器是 Vi,所以上面的命令將在 Vi 編輯器中打開。現在開始在此模板中添加您需要記住的關於“dpkg”命令的所有內容。
這是一個例子:
將內容添加到 dpkg 手冊頁
正如您在上面的輸出中看到的,我們在 dpkg 命令中添加了摘要、描述和兩個選項。您可以將任意數量的部分添加到手冊頁。給每個部分一個正確且易於理解的標題。完成後,保存文件並退出(如果您使用 Vi 編輯器,請按。 結束 鍵和類型 : wq)。
最後,使用以下命令顯示新創建的手冊頁。
$ um dpkg
查看 dpkg 手冊頁
如您所見,dpkg 手冊頁與官方手冊頁完全相同。如果要在手冊頁中編輯和/或添加詳細信息,請再次運行相同的命令以添加詳細信息。
$ um edit dpkg
要使用 Um 查看新創建的手冊頁列表,請運行以下命令:
$ 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 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.
配置1
要查看當前配置,請執行以下操作:
$ 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, 什麼時候 pages_ext 請選擇您喜歡的那一款。比如一個新創建的 Um 頁面 投遞箱 文件夾,只需更改 pages_directory 運行命令並指向 Dropbox 文件夾 ~/.um/umconfig 文檔。
pages_directory = /Users/myusername/Dropbox/um
如果有幫助。
資源:
- 嗯 GitHub 存儲庫
謝謝你的到來!
請幫助我們幫助您:
- 訂閱電子郵件通訊: 立即註冊
- OSTechNix 支持: 通過貝寶捐款
- 下載免費電子書和視頻: Trade Pub OS Tech Nix
- 詢問: 紅迪網 | Facebook | 推特 | 領英 | RSS訂閱
祝你今天過得愉快! !!
LinuxmanpagesManualPages 開源 嗯