這篇文章給大家分享的是有關(guān)怎么創(chuàng)建和維護(hù)你自己的man手冊(cè)的內(nèi)容。小編覺(jué)得挺實(shí)用的,因此分享給大家做個(gè)參考,一起跟隨小編過(guò)來(lái)看看吧。
鎮(zhèn)安網(wǎng)站建設(shè)公司成都創(chuàng)新互聯(lián),鎮(zhèn)安網(wǎng)站設(shè)計(jì)制作,有大型網(wǎng)站制作公司豐富經(jīng)驗(yàn)。已為鎮(zhèn)安近千家提供企業(yè)網(wǎng)站建設(shè)服務(wù)。企業(yè)網(wǎng)站搭建\成都外貿(mào)網(wǎng)站建設(shè)要多少錢,請(qǐng)找那個(gè)售后服務(wù)好的鎮(zhèn)安做網(wǎng)站的公司定做!
Um 適用于 Linux 和Mac OS。 目前,它只能在 Linux 系統(tǒng)中使用 Linuxbrew 軟件包管理器來(lái)進(jìn)行安裝。 如果你尚未安裝 Linuxbrew,請(qǐng)參考以下鏈接:
Linuxbrew:一個(gè)用于 Linux 和 MacOS 的通用包管理器
安裝 Linuxbrew 后,運(yùn)行以下命令安裝 Um 實(shí)用程序。
$ brew install sinclairtarget/wst/um
如果你會(huì)看到類似下面的輸出,恭喜你! Um 已經(jīng)安裝好并且可以使用了。
[...]==> 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==> CaveatsBash 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==> opensslA CA file has been bootstrapped using certificates from the SystemRootskeychain. To add additional certificates (e.g. the certificates added inthe System keychain), place .pem files in/home/linuxbrew/.linuxbrew/etc/openssl/certs and run/home/linuxbrew/.linuxbrew/opt/openssl/bin/c_rehash==> rubyEmacs Lisp files have been installed to:/home/linuxbrew/.linuxbrew/share/emacs/site-lisp/ruby==> umBash completion has been installed to:/home/linuxbrew/.linuxbrew/etc/bash_completion.d
在制作你的 man 手冊(cè)頁(yè)之前,你需要為 Um 啟用 bash 補(bǔ)全。
要開(kāi)啟 bash 補(bǔ)全,首先你需要打開(kāi) ~/.bash_profile
文件:
$ nano ~/.bash_profile
并在其中添加以下內(nèi)容:
if [ -f $(brew --prefix)/etc/bash_completion.d/um-completion.sh ]; then . $(brew --prefix)/etc/bash_completion.d/um-completion.shfi
保存并關(guān)閉文件。運(yùn)行以下命令以更新更改。
$ source ~/.bash_profile
準(zhǔn)備工作全部完成。讓我們繼續(xù)創(chuàng)建我們的***個(gè) man 手冊(cè)頁(yè)。
如果你想為 dpkg
命令創(chuàng)建自己的 man 手冊(cè)。請(qǐng)運(yùn)行:
$ um edit dpkg
上面的命令將在默認(rèn)編輯器中打開(kāi) markdown 模板:
我的默認(rèn)編輯器是 Vi,因此上面的命令會(huì)在 Vi 編輯器中打開(kāi)它?,F(xià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 --helpusage: umum [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.
要查看當(dāng)前配置,請(qǐng)運(yùn)行:
$ um configOptions prefixed by '*' are set in /home/sk/.um/umconfig.editor = vipager = lesspages_directory = /home/sk/.um/pagesdefault_topic = shellpages_ext = .md
在此文件中,你可以根據(jù)需要編輯和更改 pager
、editor
、default_topic
、pages_directory
和 pages_ext
選項(xiàng)的值。 比如說(shuō),如果你想在 Dropbox 文件夾中保存新創(chuàng)建的 Um 頁(yè)面,只需更改 ~/.um/umconfig
文件中 pages_directory
的值并將其更改為 Dropbox 文件夾即可。
pages_directory = /Users/myusername/Dropbox/um
感謝各位的閱讀!關(guān)于“怎么創(chuàng)建和維護(hù)你自己的man手冊(cè)”這篇文章就分享到這里了,希望以上內(nèi)容可以對(duì)大家有一定的幫助,讓大家可以學(xué)到更多知識(shí),如果覺(jué)得文章不錯(cuò),可以把它分享出去讓更多的人看到吧!