← 返回

在終端上用 restydoc 檢視 OpenResty 文件

章亦春釋出於 Dec 2, 2020 更新於 Dec 2, 2020

預計閱讀 3 分鐘

閱讀次數

本教程演示瞭如何使用 OpenResty 的 restydoc 命令列工具快速查詢 Nginx 模組、Nginx配置指令、Lua API函式、Lua C函式、Lua模組等 OpenResty 文件。restydoc工具最初的靈感來自 Perl 的 perldoc 工具。

which restydoc
rpm -qf `which restydoc`

restydoc實用程式是與 OpenResty 本身一起釋出的，在基於 Yum 的系統中，它的名字是 openresty-doc。在基於 Yum 的系統中，軟體包的名稱是 openresty-doc。

在基於 Debian 的系統上，比如 Ubuntu 20.04，軟體包的名字是 openresty-restydoc。

ssh ubuntu20-pkg

which restydoc
dpkg -S `which restydoc`

我們可以像這樣查詢 Nginx 標準指令 rewrite 的文件。

restydoc -s rewrite

請注意 -s 選項，意思是“段”。

它是從 Nginx 官方文件中提取的。在外殼下，它呼叫了 less 工具。

我們可以使用空格鍵切換到下一頁。

我們用 q 鍵退出。

或者標準的 Nginx 的 listen 指令。

restydoc -s listen

或者我們的 OpenResty 的 nginx 模組指令，比如 init_worker_by_lua。

restydoc -s init_worker_by_lua

標準的 Lua 函式也可以查到。

restydoc -s string.find

它是從官方的 Lua 5.1 參考手冊中提取的。

或標準的 Lua 的 C API 函式。

restydoc -s lua_gc

或者 LuaJIT 的 Lua API 擴充套件。

restydoc -s ffi.cdef

或者 OpenResty 自己的 Lua API 擴充套件。

restydoc -s ngx.re.match

上面所有的 restydoc 命令都指定了 -s 選項。這是因為顯示的文件都是一些較大文件中的部分。

我們可以像檢視整個 Nginx 模組的大型文件一樣檢視。

restydoc ngx_http_rewrite_module

這裡我們不指定 -s 選項。

和預期的一樣，文字長了很多。

或者整個 Lua 模組。

restydoc resty.redis

這是 OpenResty 附帶的 resty.redis 庫。

或者指定 Lua 庫名。

restydoc lua-resty-lrucache

要檢視 restydoc 的所有選項，請使用 -h 選項。

restydoc -h

今天我想介紹的就這麼多。希望你覺得這個工具有用。如果你喜歡這個教程，請訂閱這個部落格網站和我們的 YouTube 頻道或 B 站頻道。謝謝！

立即申請 OpenResty XRay 試用

關於本文和關聯影片

本文和相關聯的影片都是完全由我們的 OpenResty Showman 產品從一個簡單的劇本檔案自動生成的。

關於作者

章亦春是開源 OpenResty^® 專案創始人兼 OpenResty Inc. 公司 CEO 和創始人。

章亦春（Github ID: agentzh），生於中國江蘇，現定居美國灣區。他是中國早期開源技術和文化的倡導者和領軍人物，曾供職於多家國際知名的高科技企業，如 Cloudflare、雅虎、阿里巴巴, 是 “邊緣計算“、”動態追蹤 “和 “機器程式設計 “的先驅，擁有超過 22 年的程式設計及 16 年的開源經驗。作為擁有超過 4000 萬全球域名使用者的開源專案的領導者。他基於其 OpenResty^® 開源專案打造的高科技企業 OpenResty Inc. 位於美國矽谷中心。其主打的兩個產品 OpenResty XRay（利用動態追蹤技術的非侵入式的故障剖析和排除工具）和 OpenResty Edge（最適合微服務和分散式流量的全能型閘道器軟體），廣受全球眾多上市及大型企業青睞。在 OpenResty 以外，章亦春為多個開源專案貢獻了累計超過百萬行程式碼，其中包括，Linux 核心、Nginx、LuaJIT、GDB、SystemTap、LLVM、Perl 等，並編寫過 60 多個開源軟體庫。