epan/dissectors/README.X11

   1 The X11 dissector generator is no longer run automatically.
   2
   3 To run the dissector generator, you will need perl 5.10 or later and the
   4 XML::Twig module from CPAN. You will also need 'git' to retrieve the
   5 latest protocol descriptions.
   6
   7 Once you have those, you also need the XML protocol descriptions. In the
   8 epan/dissectors directory, run the following commands:
   9   git clone git@gitlab.freedesktop.org:xorg/proto/xcbproto.git
  10   git clone git@gitlab.freedesktop.org:mesa/mesa.git
  11
  12 Please be aware that the Mesa repository is rather large. As of this writing,
  13 the full git history is 587MiB and the source itself is roughly 250MiB. The
  14 space needed can be significantly reduced by downloading less commit history
  15 (such as with the git option --shallow-source, available since git 2.11) and
  16 performing a sparse checkout (available since git 2.25), e.g.,
  17
  18   git clone --shallow-since=2024-04-23 --sparse git@gitlab.freedesktop.org:mesa/mesa.git
  19   cd mesa
  20   git sparse-checkout add src/mapi/glapi/gen/
  21
  22 As of this writing, mesa will provide:
  23  src/mapi/glapi/gen/gl_API.xml
  24 and xcbproto provides:
  25  bigreq.xml
  26  composite.xml
  27  damage.xml
  28  dpms.xml
  29  dri2.xml
  30  dri3.xml
  31  ge.xml
  32  glx.xml
  33  present.xml
  34  randr.xml
  35  record.xml
  36  render.xml
  37  res.xml
  38  screensaver.xml
  39  shape.xml
  40  shm.xml
  41  sync.xml
  42  xc_misc.xml
  43  xevie.xml
  44  xf86dri.xml
  45  xf86vidmode.xml
  46  xfixes.xml
  47  xinerama.xml
  48  xinput.xml
  49  xkb.xml
  50  xprint.xml
  51  xproto.xml (ignored)
  52  xselinux.xml
  53  xtest.xml
  54  xv.xml
  55  xvmc.xml
  56
  57 Or, if you have already cloned those repositories, "git pull" each one to bring
  58 it up to date.
  59
  60 Then build the x11-dissector target; for example, run the command
  61
  62   make x11-dissector
  63
  64 if you're using Make as your build tool or
  65
  66   ninja x11-dissector
  67
  68 if you're using Ninja as your build tool.
  69
  70 This will automatically run process-x11-fields.pl (for the core protocol
  71 definitions), and then it will run process-x11-xcb.pl to process the XML
  72 descriptions from XCB and Mesa to generate the extension dissectors.
  73
  74 Once this is complete, compile wireshark as usual.