libvirt/tools/wireshark
Andrea Bolognani 818652619d Convert all remaining Markdown files to reStructuredText
We've adopted reStructuredText as the primary markup language for
our documentation and, given that both GitLab and GitHub can render
documents in this format just fine, it makes sense to get rid of
the few last remaining bits of Markdown and standardize on
reStructuredText across the board.

Signed-off-by: Andrea Bolognani <abologna@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 16:29:04 +02:00
..
samples Fix common misspellings 2015-03-23 09:01:30 +01:00
src replace use of gnulib snprintf by g_snprintf 2019-11-15 15:07:40 +01:00
util tools: Keep wireshark plugin registration code in git 2019-02-12 09:22:59 +01:00
README.rst Convert all remaining Markdown files to reStructuredText 2020-04-14 16:29:04 +02:00

README.rst

=====
About
=====

This is the project of Google Summer of Code 2013 accepted by QEMU.org and
libvirt community.  The goal of this project is, provide Wireshark dissector for
Libvirt RPC protocol. It will provide Libvirt packet overview/detail analysing
in Wireshark. Furthermore, it will be able to build(generated) from RPC protocol
definition placed in Libvirt source tree to support latest protocol
specification.

See also:

* http://www.google-melange.com/gsoc/project/google/gsoc2013/kawamuray/7001
* https://wiki.qemu.org/Features/LibvirtWiresharkDissector


Installation
=============

Run ``./configure`` with ``--with-wireshark-dissector`` option enabled.
Then dissector will compiled with libvirt itself.

Add/Remove protocol from dissector's support
--------------------------------------------

Modify variable ``WS_DISSECTOR_PROTO_FILES``
in ``tools/wireshark/src/Makefile.am``.

Changing installation directory
-------------------------------

You can change installation directory of pluggable shared
object(``libvirt.so``) by specifying ``--with-ws-plugindir=<path>``.

You can install ``libvirt.so`` into your local wireshark plugin directory:

::

  $ ./configure --with-wireshark-dissector \
                --with-ws-plugindir=$HOME/.wireshark/plugins