LINUX 內核文檔地址

 

 

Linux的man很強大，該手冊分紅不少section，使用man時能夠指定不一樣的section來瀏覽，各個section意義以下： 

1 - commands
2 - system calls
3 - library calls
4 - special files
5 - file formats and convertions
6 - games for linux
7 - macro packages and conventions
8 - system management commands
9 - 其餘

其中：
1是普通的命令
2是系統調用,如open,write之類的
3是庫函數,如printf,fread
4是特殊文件,也就是/dev下的各類設備文件
5是指文件的格式,好比passwd, 就會說明這個文件中各個字段的含義
6是給遊戲留的,由各個遊戲本身定義
7是附件還有一些變量,好比向environ這種全局變量在這裏就有說明
8是系統管理用的命令,這些命令只能由root使用,如ifconfig

使用手冊方式舉例:
man 1 ls         #查看第一章中的ls命令幫助
man 3 printf     #查看庫函數printf幫助

 

 

 

Set colors for man pages：

 

設置方法比較簡單，打開/etc/bash.bashrc（須要root權限）或者~/.bashrc文件加入以下內容：
 

# Set colors for man pages
man() {
env \
LESS_TERMCAP_mb=$(printf 「\e[1;31m」) \
LESS_TERMCAP_md=$(printf 「\e[1;31m」) \
LESS_TERMCAP_me=$(printf 「\e[0m」) \
LESS_TERMCAP_se=$(printf 「\e[0m」) \
LESS_TERMCAP_so=$(printf 「\e[1;44;33m」) \
LESS_TERMCAP_ue=$(printf 「\e[0m」) \
LESS_TERMCAP_us=$(printf 「\e[1;32m」) \
man 「$@」
}

從新打開終端，如今執行man就有顏色了。

該腳本其實定義了一個man函數，每次咱們執行man的時候都是執行的該函數。

若是執行原始的man運行/usr/bin/man 便可。

 

   EG：

[root@server1 test1]# gunzip -c ifconfig.8.gz > ./ifconfig.man
[root@server1 test1]# man2html ifconfig.man >ifconfig.html

腳本:
從linux的man中提取html格式文件作成chm電子書 #!/bin/bash #This is a manual transform script #it will transform all manuals to htmls MAN2HTML=/usr/bin/man2html MANPATH=/home/tt/man/man GZ=/bin/gzip TargetHtmlPath=/home/tt/pp NUM=9
function createhtml() { for (( i=1; i<=NUM; i++ )); do
        dir="${MANPATH}${i}" ##get target path if [ -d $dir ] then ( cd $dir ${GZ} -dvf *.gz && ${MAN2HTML} ".*${i}" 
        for file in *
        do
            if [ -f $file ] then ${MAN2HTML} $file >"${file}.html"
            fi
        done ) fi dir2="${MANPATH}${i}p" ##get target path if [ -d $dir2 ] then
        echo $dir2 ( cd $dir2 && ${GZ} -dvf *.gz && ${MAN2HTML} ".*${i}" 
        for file in *
        do
            if [ -f $file ] then ${MAN2HTML} $file >"${file}.html"
            fi
        done ) fi    
    done } function copyhtml() { for (( i=1; i<=NUM; i++ )); do
        dir="${MANPATH}${i}" ##get target path if [ -d $dir ] then ( cd $dir 
        pwd #cp *.html ${TargetHtmlPath} -v for file in *.html do
            cp ${file} ${TargetHtmlPath} -v done ) fi dir2="${MANPATH}${i}p" ##get target path if [ -d dir2 ]; then ( cd $dir2 pwd #cp *.html ${TargetHtmlPath} -v for file in *.html do
            cp ${file} ${TargetHtmlPath} -v done ) fi
    done } #createhtml copyhtml

 

 

 

 

把linux的man手冊轉化爲windows下可讀的格式：

 

man ls >ls.txt
可是從Linux系統裏傳到 windows裏沒法正常查看。
解決方法：
man ls | col -b >ls.txt

格式：man command_name | col -b >command_name.txt

感受不方便也能夠製做成pdf電子書

格式以下:man -t command_name | ps2pdf ->command_name.pdf

 

 

 

http://www.kerneltravel.net/?page_id=5   LINUX 內核

 http://www.dit.upm.es/~jmseyas/linux/kernel/hackers-docs.html   online document book about linux kernerl

 

https://lwn.net/Articles/648154/     ：Adding Processor Trace support to Linux

 

http://halobates.de/blog/  

 

http://kernelplanet.org/   LINUX 內核站點

 

https://www.kernel.org/doc/  LINUX 內核文檔

 

https://github.com/tinyclub/linux-doc

 

 

Linux內核源碼自帶了不少很優秀的文檔信息，那麼這些文檔的大概閱讀順序是什麼呢？

（http://lxr.linux.no/linux+v2.6.36/是一個在線閱讀Linux內核源碼的好地方）

第一部分：學會安裝使用Linux內核、GPL規範和怎樣與Linux內核維護者聯繫

一、README（http://lxr.linux.no/linux+v2.6.36/README），它的內容包括如下幾部分：什麼是Linux、運行的硬件環境、怎樣安裝和升級Linux內核源碼、

編譯Linux內核所須要的最小軟件工具集合、怎樣編譯內核、怎樣使用和引導新內核以及遇到問題時怎樣處理等。

二、COPYING（http://lxr.linux.no/linux+v2.6.36/COPYING），這個是GNU協議GPL的詳細說明。

三、CREDITS（http://lxr.linux.no/linux+v2.6.36/CREDITS），這個是對Linux內核有貢獻的部分程序員列表。

四、REPORTING-BUGS（http://lxr.linux.no/linux+v2.6.36/REPORTING-BUGS），這個是提交BUG的規範。

第二部分：瞭解Linux內核源碼自帶文檔Documentation的整體結構以及Linux內核的編碼風格

五、Documentation（http://lxr.linux.no/linux+v2.6.36/Documentation/），這個文件夾裏面包含的就是Linux內核具體的文檔內容，其中有一些比較重要的文檔。

六、Documentation/00-INDEX（http://lxr.linux.no/linux+v2.6.36/Documentation/00-INDEX），這個文檔介紹了Documentation文件夾下各個文檔的大體做用和內容。

七、Documentation/Changes（http://lxr.linux.no/linux+v2.6.36/Documentation/Changes），這個文檔列出並介紹了運行Linux內核的最小工具軟件集合。

八、Documentation/CodeStyle（http://lxr.linux.no/linux+v2.6.36/Documentation/CodingStyle），這個文檔介紹了Linux內核的編碼風格。

第三部分：開始學習Linux內核

九、Documentation/HOWTO（http://lxr.linux.no/linux+v2.6.36/Documentation/HOWTO），介紹了怎樣成爲一位內核開發人員。

十、Documentation/kernel-docs.txt（http://lxr.linux.no/linux+v2.6.36/Documentation/kernel-docs.txt），開始學習Linux內核的你必定須要不少參考書籍，這個文檔列出了不少學習Linux內核的優秀資源，包括不少著名書籍，例如：Linux Device Drivers等。

第四部分：Linux內核的具體模塊的文檔，這方面的文檔能夠根據本身的研究興趣來查看，例如：Linux內核的啓動代碼文檔、文件系統代碼文檔等。

十一、Documentation/x86/boot.txt（http://lxr.linux.no/linux+v2.6.36/Documentation/x86/boot.txt），介紹了Linux內核啓動時使用協議，內存結構圖等。

十二、Documentation/filessystems/ext4.txt（http://lxr.linux.no/linux+v2.6.36/Documentation/filesystems/ext4.txt），介紹了ext4文件系統