一、man檔案簡述
1、man檔案的存放位置
man檔案一般應放在/usr/share/man/的對應子目錄下,子目錄名的形式為mann。
其中n是數字1-9。這個數字也就是man中的section.各section的作用如下
節號 敘述
1 使用者命令(commands)
2 系統呼叫(system calls)
3 庫函式(library calls)
4 裝置檔案 (specical files found in /dev)
5 檔案格式 (file formats and conventiions)
6 遊戲 (games)
7 幫助手冊 (macro packages and conventions)
8 系統管理 (system)
9 核心 (kernel routines)
標籤: .sh
格式: .sh [text for heading]
說明:.sh 建立乙個一級標題,類似於html裡的。樣式為:左對齊,寬體。
常見的.sh文字包括
name 手冊頁名稱
synopsis 語法
descripition 描述
return value 返回值
exit status, 命令返回碼
error handling, 錯誤處理
errors, 錯誤**
options, 選項
usage, 用法
examples, 示例
files, 相關檔案
environment, 相關環境變數
diagnostics, 診斷
security, 安全性
conforming to, 相容性
notes, 備註
bugs, bug
author, 作者
see also 參閱
標籤: .ss
格式: .ss [text for heading]
說明:.ss 建立乙個二級標題,類似於html裡的。樣式為:右對齊,寬體。
3、段落設定
標籤: .tp
格式: .tp[xn]
說明:.tp標籤下的第2行開始縮排x個字元(在第1行超過x字元的前提下).字元的單位是n.
如果第一行的字元數不超過x,則兩行合為一行。這個功能有點象word的懸掛縮排。
比如
.tp 2n
first
second
輸出為:
first
second
注意第二行前面有兩個空格。
而.tp 5n
first
second
輸出為:
first second
這次只輸出一行。
4、字型設定
標籤:.b
.b設定文字的字型為粗體(bold face),類似於html裡的。
標籤:.i
.i設定文字的字型為斜體(italic),類似於html裡的。i
標籤:.rb
這個相當於.r(羅馬字型)與.b的組合,
將文字交替的以羅馬字型和粗體顯示。.ri與之類似。
.sp
空行。相當於html裡的
5、 轉義字元
.為/&.
-為/-
三、man檔案製作示例
1、建立roff格式的檔案
vi hello.1
內容為./" author : laomai
.th hello 1 "2008-4-2" "linux" "hello maunal" /" 注意"2008-4-2"會被顯示在
/" 檔案最後一行(頁尾)的中部,
/" "gnu"在最後一行的行首
/" "gnu tools"在第一行(頁首)的中部
.sh name
hello /- gnu hello /" - 必須用 /- 轉義
.sh synopsis
.b hello
.rb [/fb/-help/fr] /".rb為羅馬字型+粗體交替顯示
.rb [/-a]
.sp /" 空行
.sh description
this is an example of man page.
.sp/&.is at begin of a line. /" 行首的.要用/&.轉義
2、測試顯示效果
$ groff -tascii -man hello.1
3、如果效果可以,則生成幫助檔案
gzip hello.1
4、將幫助檔案拷貝到合適位置
cp hello.1.gz /usr/share/man/man1
5、檢視最終效果
man hello
四、致謝:
本文在以下資料的基礎上修改和編輯而成
參考資料1: 製作自己的man手冊
參考資料2:groff 巨集包
Linux學習筆記 man的用法
man是手冊manual的縮寫man man 檢視man命令的幫助 man passwd 檢視passwd命令的幫助1 man的級別1 系統命令 2 系統介面 3 函式庫 4 特殊檔案,比如裝置檔案 5 檔案 6 遊戲 7 系統的軟體包 8 系統管理命令 9 核心示例 man 5 passwd 檢視...
Linux學習筆記 10 幫助命令man
詞彙 manual man 要顯示的東西如檢視ls命令的幫助頁 按 可以向下翻 如要檢視幫助頁中有關 d 的部分,只要打 d就可以進行搜尋 按字母n就會向下乙個乙個位置跳,按shift n向上跳。man是官方給出的資料。man不僅能檢視命令的幫助 1級 還可以檢視一些其它級別的幫助,這可以通過man...
dnf命令引數筆記(man)
alias 列出或建立命令別名 autoremove 刪除所有原先因為依賴關係安裝的不需要的軟體包 heck 在包資料庫中尋找問題 check update 檢查是否有軟體包公升級 clean 刪除已快取的資料 deplist 列出軟體包的依賴關係和提供這些軟體包的源 distro sync 同步已...