diff options
Diffstat (limited to 'docbook')
-rw-r--r-- | docbook/Makefile.common | 1 | ||||
-rw-r--r-- | docbook/user-guide.xml | 18 | ||||
-rw-r--r-- | docbook/wsluarm.xml | 52 |
3 files changed, 58 insertions, 13 deletions
diff --git a/docbook/Makefile.common b/docbook/Makefile.common index dfe0ffdeef..a7c0881d0f 100644 --- a/docbook/Makefile.common +++ b/docbook/Makefile.common @@ -16,6 +16,7 @@ WSUG_FILES = \ wsug_src/WSUG_chapter_work.xml \ wsug_src/WSUG_meta_info.xml \ wsug_src/WSUG_preface.xml \ + wsluarm.xml \ ws.css WSUG_GRAPHICS = \ diff --git a/docbook/user-guide.xml b/docbook/user-guide.xml index b4de6ed62f..188625d93f 100644 --- a/docbook/user-guide.xml +++ b/docbook/user-guide.xml @@ -297,6 +297,8 @@ FILE SECTION <!-- WSLua Reference Manual --> + + <!ENTITY WsLuaRm SYSTEM "wsluarm.xml"> <!ENTITY WsLuaDumper SYSTEM "wsluarm_src/wslua_dumper.xml"> <!ENTITY WsLuaField SYSTEM "wsluarm_src/wslua_field.xml"> <!ENTITY WsLuaGui SYSTEM "wsluarm_src/wslua_gui.xml"> @@ -326,11 +328,13 @@ WSLua Reference Manual &ChapterStatistics; &ChapterCustomize; + &WsLuaRm; + &AppFiles; &AppProtocols; &AppMessages; &AppTools; - + &AppGPL; <!-- Removed, as these chapters must be reworked @@ -342,17 +346,5 @@ WSLua Reference Manual &ChapterTroubleshoot; --> - <chapter id="wsluarm"> - <title>Wireshark's Lua API Reference Manual</title> - &WsLuaDumper; - &WsLuaField; - &WsLuaGui; - &WsLuaListener; - &WsLuaPinfo; - &WsLuaProto; - &WsLuaTree; - &WsLuaTvb; - &WsLuaUtility; - </chapter> </book> diff --git a/docbook/wsluarm.xml b/docbook/wsluarm.xml new file mode 100644 index 0000000000..434060923d --- /dev/null +++ b/docbook/wsluarm.xml @@ -0,0 +1,52 @@ +<chapter id="wsluarm"> + <title>Lua Support in Wireshark</title> + <section id="wsluarm_intro"> + <title>Introduction</title> + <para> + Wireshark has an embedded Lua interpreter. Lua is a powerful light-weight + programming language designed for extending applications. Lua is designed + and implemented by a team at PUC-Rio, the Pontifical Catholic University + of Rio de Janeiro in Brazil. Lua was born and raised at Tecgraf, the + Computer Graphics Technology Group of PUC-Rio, and is now housed at Lua.org. + Both Tecgraf and Lua.org are laboratories of the Department of Computer Science. + </para> + <para> + In Wireshark Lua can be used to write dissectors and taps. + </para> + <para> + Wireshark's Lua interpreter starts by loading <command>init.lua</command> that + is located in the global configuration directory of Wireshark. + Lua is disabled by default by setting the variable <command>disable_lua</command> + to true in <command>init.lua</command>. To enable lua the line that sets that variable + must be removed or commented out. + </para> + <para> + After loading <command>init.lua</command> from the data directory if lua is enabled + Wireshark will try to load a file named <command>init.lua</command> in the user's + directory. + </para> + <para> + The command line option <command>-X lua_script:<file.lua></command> can be used to + load lua scripts as well. + </para> + <para> + The Lua code will be executed once after all the protocols have being initialized and before reading + any file. + </para> + </section> + <section id="wsluarm_modules"> + <title>Wireshark's Lua API Reference Manual</title> + <para> + This Part of the User Guide describes the Wireshark specific functions embedded Lua API. + </para> + &WsLuaDumper; + &WsLuaField; + &WsLuaGui; + &WsLuaListener; + &WsLuaPinfo; + &WsLuaProto; + &WsLuaTree; + &WsLuaTvb; + &WsLuaUtility; + </section> +</chapter> |