summaryrefslogtreecommitdiff
path: root/source4/pidl/README
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2005-08-21 23:30:17 +0000
committerGerald (Jerry) Carter <jerry@samba.org>2007-10-10 13:34:17 -0500
commit59b13f9a1d684a632c2c73352f0ec08a63bc0913 (patch)
tree14b0a564e4db3377f7ad2fa1f9671f8e04405962 /source4/pidl/README
parentefc03df292aa84edb592c22191dbf86cdf8c32d0 (diff)
downloadsamba-59b13f9a1d684a632c2c73352f0ec08a63bc0913.tar.gz
samba-59b13f9a1d684a632c2c73352f0ec08a63bc0913.tar.bz2
samba-59b13f9a1d684a632c2c73352f0ec08a63bc0913.zip
r9460: - Move pidl to lib/. This fixes standalone installation of pidl.
- Update the README - Allow building the docs stand-alone (This used to be commit b56084ce251ab7a35dd1422f38de258e8e1e1477)
Diffstat (limited to 'source4/pidl/README')
-rw-r--r--source4/pidl/README18
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