1.10 参考手册

OpenResty附带了非常完善的用户参考手册restydoc，提供与UNIX手册man相同的功能，可以检索OpenResty里所有组件的帮助文档，包括但不限于：

    ■  OpenResty各个组件的介绍和用法；
    ■  OpenResty指令和功能接口的用法；
    ■  Nginx介绍、用法、基本工作原理；
    ■  Lua/LuaJIT语法要素。

下面示范了一些restydoc的用法，其中的“-s”参数用来指定搜索手册里的小节名：

restydoc nginx                                #Nginx的说明
restydoc luajit                               #LuaJIT的说明
restydoc opm                                  #包管理工具opm的说明
restydoc resty-cli                            #命令行工具resty的说明
restydoc ngx_echo                             #ngx_echo组件的说明
restydoc ngx_lua                              #ngx_lua的说明
restydoc stream_lua                           #stream_lua的说明
restydoc lua-cjson                            #lua-cjson的说明
restydoc -s proxy_pass                        #反向代理指令proxy_pass的说明
restydoc -s content_by_lua_block              #content_by_lua_block指令的说明
restydoc -s ngx.say                           #功能接口ngx.say的说明
restydoc -s concat                            #Lua函数concat的说明

对于使用opm安装的组件，需要使用“-r”参数指定安装目录，例如：

restydoc -r /usr/local/openresty/site -s lua-resty-http

多使用restydoc可以帮助我们尽快熟悉OpenResty开发。