diff options
Diffstat (limited to 'source4/pidl/README')
| -rw-r--r-- | source4/pidl/README | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/source4/pidl/README b/source4/pidl/README index e6768b6940..8c709e5ecd 100644 --- a/source4/pidl/README +++ b/source4/pidl/README @@ -1,3 +1,5 @@ +Introduction: +============= This directory contains the source code of the pidl (Perl IDL) compiler. @@ -13,11 +15,26 @@ After a parse tree is present, pidl will call one of it's backends (which one depends on the options given on the command-line). Here is a list of current backends: +Standalone installation: +======================== +Run Makefile.PL to generate the Makefile. + +Then run "make install" (as root) to install. + +Documentation: +============== +Run 'make doc' to generate the manpage and a HTML version of the manpage. +This requires the xsltproc utility to be installed. + +Internals overview: +=================== + -- Generic -- Parse::Pidl::Dump - Converts the parse tree back to an IDL file Parse::Pidl::Samba::Header - Generates header file with data structures defined in IDL file Parse::Pidl::NDR - Generates intermediate datastructures for use by NDR parses/generators Parse::Pidl::ODL - Generates IDL structures from ODL structures for use in the NDR parser generator +Parse::Pidl::Test - Utility functions for use in pidl's testsuite -- Samba NDR -- Parse::Pidl::Samba::NDR::Client - Generates client call functions in C using the NDR parser @@ -25,6 +42,7 @@ Parse::Pidl::Samba::SWIG - Generates SWIG interface files (.i) Parse::Pidl::Samba::NDR::Header - Generates a header file with NDR-parser specific data Parse::Pidl::Samba::NDR::Parser - Generates pull/push functions for parsing NDR Parse::Pidl::Samba::NDR::Server - Generates server side implementation in C +Parse::Pidl::Samba::TDR - Parser generator for the "Trivial Data Representation" Parse::Pidl::Samba::Template - Generates stubs in C for server implementation Parse::Pidl::Samba::EJS - Generates bindings for Embedded JavaScript (EJS) Parse::Pidl::Samba::EJSHeader - Generates headers for the EJS bindings |