This tutorial demonstrates how to use OpenResty’s
restydoc command-line utility to quickly lookup OpenResty documentation for Nginx modules, Nginx configuration directives, Lua API functions, Lua C functions, Lua modules, and many more. The
restydoc tool was originally inspired by Perl’s
restydoc utility is shipped with OpenResty itself. The package name is
openresty-doc on Yum-based systems.
The package name is
openresty-restydoc on Debian-based systems, like Ubuntu 20.04.
We can lookup the docs for the standard Nginx directive
rewrite like this.
restydoc -s rewrite
-s option, which means “section”.
It is extracted from the official Nginx documentation. Under the hood, it invokes the
We can use the space key to switch to the next page.
We use the
q key to quit.
Or the standard Nginx’s
restydoc -s listen
Or our OpenResty’s nginx module directives like
restydoc -s init_worker_by_lua
Standard Lua functions can be looked up too.
restydoc -s string.find
It is extracted from the official Lua 5.1 reference manual.
Or the standard Lua’s C API functions.
restydoc -s lua_gc
Or the LuaJIT’s Lua API extension.
restydoc -s ffi.cdef
Or OpenResty’s own Lua API extension.
restydoc -s ngx.re.match
restydoc commands above specify the
-s option. This is because the displayed docs are all sections from some larger documents.
We can view large documents like a whole Nginx module’s.
Here we do not specify the
It’s much longer, as expected.
Or a whole Lua module.
This is the
resty.redis library shipped with OpenResty.
Or specifying the Lua library name.
To view all the options of
restydoc, use the
That’s all I’d like to cover today. Hopefully you’ve found this tool useful.
If you like this tutorial, please subscribe to this blog site and our YouTube channel. Thank you!
This article and its associated video are both generated automatically from a simple screenplay file.
Yichun Zhang is the creator of the OpenResty® open source project. He is also the founder and CEO of the OpenResty Inc. company. He contributed a dozen open source Nginx 3rd-party modules, quite some Nginx and LuaJIT core patches, and designed the OpenResty XRay platform.
We provide the Chinese translation for this article on blog.openresty.com.cn. We also welcome interested readers to contribute translations in other natural languages as long as the full article is translated without any omissions. We thank them in advance.
We always welcome talented and enthusiastic engineers to join our team at OpenResty Inc.
to explore various open source software’s internals and build powerful analyzers and
visualizers for real world applications built atop the open source software. If you are
interested, please send your resume to
firstname.lastname@example.org . Thank you!