Skip to content

Commit

Permalink
Update README.md with installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
randstr committed Aug 21, 2024
1 parent 6be60ce commit 9ea2dd3
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Goals for the project include:

Non-goals are backward compatibility and one-to-one feature parity.

## Installing from source
## Building from source

### Binary and source compatibility

Expand Down Expand Up @@ -59,7 +59,7 @@ Check the [Wireshark Developer's Guide](https://www.wireshark.org/docs/wsdg_html
for detailed instructions on how to build Wireshark itself. Note that header
installation is a separate install step and it is required to build any Wireshark plugin.

### Building the Wireshark Lua Plugin
### Building the plugin

From the plugin source directory run:

Expand Down Expand Up @@ -87,6 +87,22 @@ To install the plugin on the system (may need to use sudo):
make install
```

## Manual installation of binary plugin

If you are not building from source you need to copy the plugin file
(with extension `.dll` on Windows or `.so` on Linux) to the Wireshark
[personal plugin folder](https://www.wireshark.org/docs/wsug_html_chunked/ChPluginFolders.html).
The following table lists the personal plugin folder per platform:

| Platform | Plugin folder |
| ----------- | ---- |
| Windows | `%APPDATA%\Wireshark\plugins\X.Y\epan` |
| Unix-like | `$HOME/.local/lib/wireshark/plugins/X.Y/epan` |

Where X.Y is the major.minor Wireshark version for the release you are
installing for (so the the last component Z in the complete X.Y.Z version number
is not used).

## Loading Lua scripts

Dissectors written in Lua using this plugin should be copied into a folder
Expand Down

0 comments on commit 9ea2dd3

Please sign in to comment.