2016-12-05 61 views
1

我在一家公司工作,他們使用大量的工具和命令的Linux(內部和外部)如何爲linux創建一個通用手冊?

我想創建一個自定義手冊,每個工具的例子。

使用信息工具,這種思想:

info CompanyName tool1 
info CompanyName tool2 
info CompanyName tool3 
.. 

和每個輸出應該是由我添加的例子和評論一個簡單的文本。

但據我所知,Linux中的信息是爲特定的工具創建的,而不是針對您的自定義需求。

任何想法什麼是最好的方式來實現上述? 目前我使用每個工具的標籤使用崇高,每一次,然後我更新新的例子與崇高選項卡。

任何意見將不勝感激。

回答

0

對於它的價值,我不是信息頁的粉絲。我更喜歡優秀的舊版Unix手冊頁,編寫它們非常簡單。您可以在編輯器中簡單地打開任何手冊頁,查看它的源代碼並將其複製以滿足您的需求。

在大多數系統上,手冊頁位於/usr/share/man/{man1,man2,man3,man4,man5,man6,man7,man8}/之類的目錄中,或者您可以使用man命令的-w選項查看任何手冊頁的位置,然後將其打開。例如

$ man -w ls 
/usr/share/man/man1/ls.1.gz 
$ vim /usr/share/man/man1/ls.1.gz 

您可以看到它是如何寫入的,並模仿它來編寫自己的手冊頁。爲了讓任何人都能夠閱讀由您編寫的手冊頁,手冊頁必須安裝在man utility搜索手冊頁的目錄之一中。在Linux上,通常可以通過運行manpath命令來查看這個目錄列表(在其他系統上它可能不同,您將不得不看到man命令本身的手冊頁)。如果您將手冊頁存儲在其中一個目錄中,則任何人都可以使用man實用程序來閱讀它。

按照POSIXman效用也尊重環境變量MANPATH,所以如果你存儲你的男人頁非標準位置,你可以設置MANPATH變量,使man可以看看它。或者,您也可以修改/etc/man.conf文件以將手冊頁目錄添加到搜索路徑man

現在,手冊頁使用宏語言進行標記。 Linux系統傾向於使用man(7)宏語法,以便您可以看到手動here

有編寫手冊頁另一種現代的宏設定,堪稱mdoc(7),這是在BSD系列操作系統的廣泛應用。你可以看到它的手冊here

相關問題