doc/man_pages/idl2wrs.adoc

   1 include::../attributes.adoc[]
   2 = idl2wrs(1)
   3 :doctype: manpage
   4 :stylesheet: ws.css
   5 :linkcss:
   6 :copycss: {css_dir}/{stylesheet}
   7
   8 == NAME
   9
  10 idl2wrs - CORBA IDL to Wireshark Plugin Generator
  11
  12 == SYNOPSIS
  13
  14 *idl2wrs* <filename>
  15
  16 == DESCRIPTION
  17
  18 *idl2wrs* is a program that takes a user specified *CORBA IDL*
  19 file and generates *"C"* source code for a *Wireshark* "plugin".
  20
  21 This resulting file can be compiled as a *Wireshark* plugin, and
  22 used to monitor *GIOP/IIOP* traffic that is using this IDL.
  23
  24 *idl2wrs* is actually a shell script wrapper for two *Python* programs.
  25 These programs are:
  26
  27 * *wireshark_be.py*
  28 Contains the main IDL Visitor Class
  29
  30 * *wireshark_gen.py*
  31 Contains the Source Code Generator Class
  32
  33 *idl2wrs* supports heuristic dissection of GIOP/IIOP traffic,
  34 and some experimental code for explicit dissection, based on
  35 Object Key <-> Repository Id mapping.
  36 However, code for heuristic based plugins is
  37 generated by default, and users should consider this the preferred
  38 method unless you have some namespace collisions.
  39
  40 == OPTIONS
  41
  42 Currently there are no options. *idl2wrs* can be invoked as follows.
  43
  44 1.  To write the C code to stdout.
  45
  46     idl2wrs  <your_file.idl>
  47
  48     eg: idl2wrs echo.idl
  49
  50 2. To write to a file, just redirect the output.
  51
  52     idl2wrs echo.idl > packet-test.c
  53
  54 == ENVIRONMENT
  55
  56 *idl2wrs* will look for *wireshark_be.py* and *wireshark_gen.py* in
  57 *$PYTHONPATH/site-packages/* and if not found, will try the current
  58 directory *./*
  59
  60 The *-p* option passed to omniidl (inside *idl2wrs*) indicates where
  61 *wireshark_be.py* and *wireshark_gen.py* will be searched.  This may
  62 need tweaking if you place these files somewhere else.
  63
  64 If it complains about being unable to find some modules (eg tempfile.py),
  65 you may want to check if PYTHONPATH is set correctly.
  66
  67 eg:  PYTHONPATH=/usr/lib/python3/
  68
  69 == SEE ALSO
  70
  71 xref:wireshark.html[wireshark](1), xref:tshark.html[tshark](1)
  72
  73 == NOTES
  74
  75 *idl2wrs* (including *wireshark_be.py* and *wireshark_gen.py*) are part of
  76 the *Wireshark* distribution.  The latest version of *Wireshark* can
  77 be found at https://www.wireshark.org.
  78
  79 *idl2wrs* uses *omniidl*, an IDL parser, and can be found at
  80 http://omniorb.sourceforge.net/
  81
  82 == TODO
  83
  84 Some of the more important things to do are:
  85
  86 * Improve Explicit dissection code.
  87
  88 * Improve command line options.
  89
  90 * Improve decode algorithm when we have operation name collision.
  91
  92 == AUTHORS
  93
  94 .Original Author
  95 [%hardbreaks]
  96 Frank Singleton <frank.singleton[AT]ericsson.com>
  97
  98 .Contributors
  99 [%hardbreaks]
 100