/usr/share/doc/wireshark-doc/wsug_html_chunked/wsluarm.html is in wireshark-doc 1.6.7-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 11. Lua Support in Wireshark</title><link rel="stylesheet" type="text/css" href="ws.css"><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" href="index.html" title="Wireshark User's Guide"><link rel="up" href="index.html" title="Wireshark User's Guide"><link rel="prev" href="ChUserDLTsSection.html" title="10.20. User DLTs protocol table"><link rel="next" href="wslua_dissector_example.html" title="11.2. Example of Dissector written in Lua"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 11. Lua Support in Wireshark</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ChUserDLTsSection.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="wslua_dissector_example.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 11. Lua Support in Wireshark"><div class="titlepage"><div><div><h2 class="title"><a name="wsluarm"></a>Chapter 11. Lua Support in Wireshark</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="wsluarm.html#wsluarm_intro">11.1. Introduction</a></span></dt><dt><span class="section"><a href="wslua_dissector_example.html">11.2. Example of Dissector written in Lua</a></span></dt><dt><span class="section"><a href="wslua_tap_example.html">11.3. Example of Listener written in Lua</a></span></dt><dt><span class="section"><a href="wsluarm_modules.html">11.4. Wireshark's Lua API Reference Manual</a></span></dt><dt><span class="section"><a href="lua_module_Dumper.html">11.5. Saving capture files </a></span></dt><dd><dl><dt><span class="section"><a href="lua_module_Dumper.html#lua_class_Dumper">11.5.1. Dumper</a></span></dt><dt><span class="section"><a href="lua_module_Dumper.html#lua_class_PseudoHeader">11.5.2. PseudoHeader</a></span></dt></dl></dd><dt><span class="section"><a href="lua_module_Field.html">11.6. Obtaining dissection data </a></span></dt><dd><dl><dt><span class="section"><a href="lua_module_Field.html#lua_class_Field">11.6.1. Field</a></span></dt><dt><span class="section"><a href="lua_module_Field.html#lua_class_FieldInfo">11.6.2. FieldInfo</a></span></dt><dt><span class="section"><a href="lua_module_Field.html#non_method_functions_Field">11.6.3. Non Method Functions</a></span></dt></dl></dd><dt><span class="section"><a href="lua_module_Gui.html">11.7. GUI support </a></span></dt><dd><dl><dt><span class="section"><a href="lua_module_Gui.html#lua_class_ProgDlg">11.7.1. ProgDlg</a></span></dt><dt><span class="section"><a href="lua_module_Gui.html#lua_class_TextWindow">11.7.2. TextWindow</a></span></dt><dt><span class="section"><a href="lua_module_Gui.html#non_method_functions_Gui">11.7.3. Non Method Functions</a></span></dt></dl></dd><dt><span class="section"><a href="lua_module_Listener.html">11.8. Post-dissection packet analysis </a></span></dt><dd><dl><dt><span class="section"><a href="lua_module_Listener.html#lua_class_Listener">11.8.1. Listener</a></span></dt></dl></dd><dt><span class="section"><a href="lua_module_Pinfo.html">11.9. Obtaining packet information </a></span></dt><dd><dl><dt><span class="section"><a href="lua_module_Pinfo.html#lua_class_Address">11.9.1. Address</a></span></dt><dt><span class="section"><a href="lua_module_Pinfo.html#lua_class_Column">11.9.2. Column</a></span></dt><dt><span class="section"><a href="lua_module_Pinfo.html#lua_class_Columns">11.9.3. Columns</a></span></dt><dt><span class="section"><a href="lua_module_Pinfo.html#lua_class_Pinfo">11.9.4. Pinfo</a></span></dt></dl></dd><dt><span class="section"><a href="lua_module_Proto.html">11.10. Functions for writing dissectors </a></span></dt><dd><dl><dt><span class="section"><a href="lua_module_Proto.html#lua_class_Dissector">11.10.1. Dissector</a></span></dt><dt><span class="section"><a href="lua_module_Proto.html#lua_class_DissectorTable">11.10.2. DissectorTable</a></span></dt><dt><span class="section"><a href="lua_module_Proto.html#lua_class_Pref">11.10.3. Pref</a></span></dt><dt><span class="section"><a href="lua_module_Proto.html#lua_class_Prefs">11.10.4. Prefs</a></span></dt><dt><span class="section"><a href="lua_module_Proto.html#lua_class_Proto">11.10.5. Proto</a></span></dt><dt><span class="section"><a href="lua_module_Proto.html#lua_class_ProtoField">11.10.6. ProtoField</a></span></dt><dt><span class="section"><a href="lua_module_Proto.html#non_method_functions_Proto">11.10.7. Non Method Functions</a></span></dt></dl></dd><dt><span class="section"><a href="lua_module_Tree.html">11.11. Adding information to the dissection tree </a></span></dt><dd><dl><dt><span class="section"><a href="lua_module_Tree.html#lua_class_TreeItem">11.11.1. TreeItem</a></span></dt></dl></dd><dt><span class="section"><a href="lua_module_Tvb.html">11.12. Functions for handling packet data </a></span></dt><dd><dl><dt><span class="section"><a href="lua_module_Tvb.html#lua_class_ByteArray">11.12.1. ByteArray</a></span></dt><dt><span class="section"><a href="lua_module_Tvb.html#lua_class_Int">11.12.2. Int</a></span></dt><dt><span class="section"><a href="lua_module_Tvb.html#lua_class_Tvb">11.12.3. Tvb</a></span></dt><dt><span class="section"><a href="lua_module_Tvb.html#lua_class_TvbRange">11.12.4. TvbRange</a></span></dt><dt><span class="section"><a href="lua_module_Tvb.html#lua_class_UInt">11.12.5. UInt</a></span></dt></dl></dd><dt><span class="section"><a href="lua_module_Utility.html">11.13. Utility Functions </a></span></dt><dd><dl><dt><span class="section"><a href="lua_module_Utility.html#lua_class_Dir">11.13.1. Dir</a></span></dt><dt><span class="section"><a href="lua_module_Utility.html#non_method_functions_Utility">11.13.2. Non Method Functions</a></span></dt></dl></dd></dl></div><div class="section" title="11.1. Introduction"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="wsluarm_intro"></a>11.1. Introduction</h2></div></div></div><p>
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
<a class="ulink" href="http://www.lua.org" target="_top">Lua.org</a>.
Both Tecgraf and Lua.org are laboratories of the Department of Computer Science.
</p><p>
In Wireshark Lua can be used to write dissectors and taps.
</p><p>
Wireshark's Lua interpreter starts by loading <span class="command"><strong>init.lua</strong></span> that
is located in the global configuration directory of Wireshark.
Lua is enabled by default. To disable Lua the line variable <span class="command"><strong>disable_lua</strong></span>
should be set to <span class="command"><strong>true</strong></span> in <span class="command"><strong>init.lua</strong></span>.
</p><p>
After loading <span class="command"><strong>init.lua</strong></span> from the data directory if Lua is enabled
Wireshark will try to load a file named <span class="command"><strong>init.lua</strong></span> in the user's
directory.
</p><p>
Wireshark will also load all files with <span class="command"><strong>.lua</strong></span> suffix from both the
global and the personal plugins directory.
</p><p>
The command line option <span class="command"><strong>-X lua_script:<file.lua></strong></span> can be used to
load Lua scripts as well.
</p><p>
The Lua code will be executed once after all the protocol dissectors have being initialized
and before reading any file.
</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ChUserDLTsSection.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="wslua_dissector_example.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">10.20. User DLTs protocol table </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 11.2. Example of Dissector written in Lua</td></tr></table></div></body></html>
|