pman (PHP Manual) 是 PHP 官方文檔的命令列版本，透過 PEAR 安裝，提供類似 Linux man 的離線查詢體驗，支援彩色輸出、關鍵字搜尋、Vim 整合。
# 1. 確保 PEAR 可用
which pear
# 2. 升級 PEAR (避免版本過舊)
sudo pear upgrade pear
# 3. 安裝 pman
sudo pear install doc.php.net/pman
# 4. 驗證安裝
pman --version
| 指令 | 說明 | 範例 |
|---|---|---|
pman strlen | 查看函數文檔 | 查看 strlen 語法、參數、範例 |
pman -k json | 關鍵字搜尋 | 搜尋所有含 json 的函數 |
pman -f strlen | 顯示函數簡短說明 | 等同 whatis |
pman -a array | 顯示所有匹配項 | 列出所有 array 相關 |
pman -w strlen | 顯示文檔檔案位置 | 定位原始文檔 |
" .vimrc 加入
" 游標下關鍵字按 K 查詢
set keywordprg=pman
" 或自訂映射
nnoremap <leader>p :!pman <cword><CR>
在 Vim 中將游標置於函數名按 K 即可查閱文檔。
# 強制啟用顏色
export MANPAGER="less -R"
pman strlen
# 列出所有可用文檔
pman -k '' | awk '{print $1}' | sort -u > all_funcs.txt
# 批次匯出 HTML (需額外工具)
| 問題 | 解決方案 |
|---|---|
| pear: command not found | 安裝 php-pear 套件 (apt/yum/brew) |
| 安裝失敗 404 | PEAR 頻道舊，執行 pear channel-update pear.php.net |
| 中文顯示亂碼 | 確保終端機 UTF-8，設定 export LANG=zh_TW.UTF-8 |
| 找不到函數 | 嘗試 pman -k 關鍵字 搜尋 |
| 工具 | 優點 | 缺點 |
|---|---|---|
| pman | 官方、離線、Vim整合、輕量 | 需 PEAR、更新慢、無中文 |
| PHPStorm/IDE 內建 | 智慧提示、跳轉、中文 | 需 IDE、較重 |
| Dash/Zeal (docset) | 跨語言、極快、離線、中文 | 需購買/設定 |
| devdocs.io | 線上、多語言、搜尋快、PWA | 需網路 |
| php.net 官網 | 最新、完整、用戶註釋 | 需網路、廣告干擾 |
pman 適合終端機重度使用者、Vim 開發者、離線環境。現代開發多搭配 IDE 或 Dash 等文檔瀏覽器，pman 作為備援工具極佳。
