epan/dissectors/pidl/README

   1 A note about PIDL generated files
   2 =================================
   3
   4 Quick guide
   5 ===========
   6     rsync -av rsync.samba.org::ftp/pub/unpacked/samba_4_0_test/pidl .
   7
   8     for file in *.idl; do
   9         echo "Generating dissector for $file"
  10         ./pidl/pidl --ws-parser -- $file;
  11     done
  12     cp packet-dcerpc*.* ..
  13
  14 Complete infos
  15 ==============
  16
  17 The following files:
  18 ../packet-dcerpc-atsvc.h
  19 ../packet-dcerpc-budb.c
  20 ../packet-dcerpc-budb.h
  21 ../packet-dcerpc-butc.c
  22 ../packet-dcerpc-butc.h
  23 ../packet-dcerpc-dfs.h
  24 ../packet-dcerpc-dnsserver.h
  25 ../packet-dcerpc-drsuapi.c
  26 ../packet-dcerpc-drsuapi.h
  27 ../packet-dcerpc-dssetup.h
  28 ../packet-dcerpc-efs.h
  29 ../packet-dcerpc-eventlog.h
  30 ../packet-dcerpc-frsrpc.h
  31 ../packet-dcerpc-frstrans.h
  32 ../packet-dcerpc-initshutdown.h
  33 ../packet-dcerpc-lsa.h
  34 ../packet-dcerpc-mapi.h
  35 ../packet-dcerpc-misc.h
  36 ../packet-dcerpc-nspi.h
  37 ../packet-dcerpc-rfr.h
  38 ../packet-dcerpc-samr.h
  39 ../packet-dcerpc-srvsvc.h
  40 ../packet-dcerpc-winreg.h
  41 ../packet-dcerpc-wkssvc.h
  42 ../packet-dcerpc-wzcsvc.h
  43
  44 Are automatically generated via a tool called "pidl", you shouldn't modify them manually.
  45
  46 The pidl tool is maintained by the Samba project (http://samba.org, samba-technical@samba.org)
  47 We recommend to fetch a copy of the git tree of Samba to get the tool:
  48     git clone git://git.samba.org/samba.git
  49
  50 Or if you are just interested to run pidl you could fetch it via rsync:
  51     rsync -av rsync.samba.org::ftp/pub/unpacked/samba_4_0_test/pidl .
  52
  53 If both solution are not applicable you can use the copy that is located in the
  54 tool folder but it might be a bit outdated.
  55
  56 Running pidl
  57 ============
  58
  59 You have to run the pidl command inside the pidl folder of the wireshark source tree
  60
  61 The command to compile file:
  62     <path_to_pidl>pidl --ws-parser -- <idl-file>
  63                                    ^^^
  64                                    This is *VERY* important
  65 The command generate 2 files:
  66     packet-dcerpc-<interfacename>.h
  67     packet-dcerpc-<interfacename>.c
  68
  69 For instance with a pidl copy in /usr/local/src/samba/pidl and the atsvc.idl, the
  70 command will be:
  71
  72     /usr/local/src/samba/pidl/pidl --ws-parser -- atsvc.idl
  73
  74 This will generate 2 files:
  75     packet-dcerpc-atsvc.h
  76     packet-dcerpc-atsvc.c
  77
  78 If you run outside the dissectors/pidl directory, this *will* result in a
  79 warning such as:
  80
  81     atsvc.idl:5:23: idl_types.h: No such file or directory
  82
  83 and *may* result in additional warnings such as:
  84
  85     Warning: No conformance file `initshutdown.cnf'
  86     Unable to handle string with flags STR_LEN4|STR_NOTERM at /usr/lib/perl5/site_perl/5.8.6/Parse/Pidl/Wireshark/NDR.pm line 283.
  87
  88 Notes about the in-tree pidl
  89 ============================
  90
  91 To allow building Wireshark pidl dissectors without having to
  92 *explicitly* access a remote svn repository a copy of pidl is located in tools/pidl
  93
  94 Don't do changes in the tools/pidl directory, do them at the samba tree!
  95 Changes to this tree will be overwritten the next time the sources from
  96 the samba tree are updated, which is basically every time you do an svn
  97 up in the Wireshark toplevel dir.
  98
  99 Not compiling idl
 100 =================
 101 As of October 2013, the following idl have issues when generating and compiling:
 102 dfs.idl
 103 srvsvc.idl
 104 wkssvc.cnf