如何爲我的shell腳本創建一個手冊頁？

如何爲我的shell腳本創建手冊頁？
我無法找到關於如何在Google上製作手冊頁的初學者方法。如何爲我的shell腳本創建一個手冊頁？

根據模板製作我自己的手冊頁並使用腳本進行安裝的最簡單方法是什麼？

來源

2015-10-10 Miguel M

http://www.cyberciti.biz/faq/linux-unix-creating-a-manpage/ – C1sc0

沒錯，但說我需要一個特殊格式的文件，它並沒有告訴我如何格式化爲：/。另外我不明白如何安裝它。 –

我建議你使用Grapse是一個在線的手冊頁編輯器，因爲你可以看到實時結果我相信這對於初學者非常有用。

來源

2016-01-27 00:01:44 roperzh

Grapse無法正確讀取help2man的輸出，fyi。 – David

謝謝大衛，我會看看這:) – roperzh

樣品手冊頁，從link：

.\" Manpage for nuseradd. 
.\" Contact [email protected] to correct errors or typos. 
.TH man 8 "06 May 2010" "1.0" "nuseradd man page" 
.SH NAME 
nuseradd \- create a new LDAP user 
.SH SYNOPSIS 
nuseradd [USERNAME] 
.SH DESCRIPTION 
nuseradd is high level shell program for adding users to LDAP server. On Debian, administrators should usually use nuseradd.debian(8) instead. 
.SH OPTIONS 
The nuseradd does not take any options. However, you can supply username. 
.SH SEE ALSO 
useradd(8), passwd(5), nuseradd.debian(8) 
.SH BUGS 
No known bugs. 
.SH AUTHOR 
Vivek Gite ([email protected])

與腳本安裝：

install -g 0 -o 0 -m 0644 nuseradd.1 /usr/local/man/man8/ 
gzip /usr/local/man/man8/nuseradd.1

手動安裝它：關於使用pandoc

cp nuseradd /usr/local/man/man8/nuseradd.1 
gzip /usr/local/man/man8/nuseradd.1

來源

2015-10-10 01:40:12 C1sc0

什麼。您可以在markdown（甚至是html，latex）中編寫文檔，並且可以轉換爲html，pdf，word，手冊頁，epub，....這樣您就可以用一種格式編寫文檔並以任何格式轉換/分發你喜歡

來源

2015-10-10 07:58:04

help2man在給出--help標誌以產生一個像樣的手冊頁時使用腳本的輸出。

這需要很少的努力並提供合理的輸出。由於它通過--help和--version時依賴於你的腳本的輸出也迫使你寫一個體面的--help :-)

來源

2015-10-10 17:38:18

C1sc0您的答案中有錯誤。

，使自己的手冊頁，請按照下列步驟操作：

1成爲超級用戶：

$ sudo -i

2 - 到這個目錄：

$ cd /usr/bin 
$ nano your_function

3 - 複製粘貼這個man（maual）頁面的模板，然後根據您的項目對其進行個性化設置：

./" Manpage for your_fonction 
.TH man 1 "10 September 2017" "1.0" "your_fonction man page" 
.SH NAME 
your_fonction - do.... 
.SH SYNOPSIS 
your_fonction [optionnal argument] [optionnal argument] 
.SH DESCRIPTION 
your_fonction is a function which ..... 
.SH OPTIONS 
your_fonction does not take any options 
.SH BUGS 
No known bugs. 
.SH AUTHOR 
written by your_name (your_website or your_github or whatever) 
.SH REPORTING BUGS 
you_github_repository/isssues for example

4-你必須選擇在哪個目錄的男人你的文件必須，看：

$ cd/usr/share/man/ && ls

你看到男1，男2，.... 這些是類：

（MAN1）1 - 提供給用戶命令
（MAN2）2 - 的Unix和C的系統調用
（man3）的更新3 - C庫例程C程序
（男4）4 - 特殊文件名
（MAN5）5 - 文件格式和約定由Unix
（man6）6使用的文件 - 遊戲
（man7）7 - 文字處理包
（man8）8 - 系統管理命令和程序

這裏的例子中，目的地將是男1，所以：

5回USR/bin中

$ cd /usr/bin

6-使具有良好的後綴副本：

$ cp your_function your_function.1

7 - gzip的your_function.1

$ gzip your_function.1

8將其發送到良好的目錄，這裏示例man1：

$ cp your_function.1.gz /usr/share/man/man1/

這樣做，你可以測試你的美麗的男人頁！

$ man your_function

來源

2017-09-10 21:46:17 marcdahan

如何爲我的shell腳本創建一個手冊頁？

回答

相關問題