omniidl(1)

1omniidl(1)                  General Commands Manual                 omniidl(1)
2
3
4

NAME

6       omniidl - omniORB idl compiler
7

SYNOPSIS

9       omniidl [options] -b<back-end> [back-end options] file
10

DESCRIPTION

12       omniidl  is  the  omniORB  IDL compiler front end. If a back-end is not
13       specified, it checks the input IDL file for validity, and  produces  no
14       output. Usually, a language mapping back-end is specified, so stubs and
15       skeletons in the target language are produced.
16
17       The input files are processed by the C  preprocessor  before  they  are
18       parsed by the compiler.
19
20

COMMON OPTIONS

22       -b<backend>    Run  the specified back-end (e.g., -bcxx = C++, -bpython
23                      = Python)
24
25       -D<name>=<value>
26                      Define <name> for the C preprocessor.
27
28       -U<name>       Undefine <name> for the C preprocessor.
29
30       -I<dir>        Include <dir> in the C preprocessor search path.
31
32       -E             Only run the C preprocessor, sending its output to  std‐
33                      out.
34
35       -Y<cmd>        Use <cmd> as the preprocessor instead of the default.
36
37       -N             Do not run the C preprocessor.
38
39       -Wp<arg>       Send <arg> to the C preprocessor.
40
41       -Wb<arg>       Send <arg> to the back-end.
42
43       -nf            Do not warn about unresolved forward declarations.
44
45       -k             Keep  comments  after  declarations,  to be used by some
46                      back-ends.
47
48       -K             Keep comments before declarations, to be  used  by  some
49                      back-ends.
50
51       -C<dir>        Change directory to <dir> before writing output files.
52
53       -d             Dump  the  parsed IDL then exit, without running a back-
54                      end.
55
56       -p<dir>        Use <dir> as a path to find omniidl back-ends.
57
58       -V             Print version information then exit.
59
60       -u             Print usage information.
61
62       -v             Verbose: trace compilation stages.
63
64

C++ BACK-END

66       Choose the C++ back-end with -bcxx.  The C++ back-end is only available
67       when you have omniORB for C++ installed.
68
69       The  C++ back-end produces two output files: a header and a stub/skele‐
70       ton file. By default they are named by appending suffixes .hh and SK.cc
71       to the base name of the input IDL file.
72
73       If  the  -Wba option is specified, then a third file is generated (with
74       default suffix DynSK.cc ), containing code for TypeCode and Any.
75
76
77

C++ BACK-END OPTIONS

79       -Wbh=<suffix>  Use <suffix> instead of .hh
80
81       -Wbs=<suffix>  Use <suffix> instead of SK.cc
82
83       -Wbd=<suffix>  Use <suffix> instead of DynSK.cc. If the same suffix  is
84                      specified  for -Wbs and -Wbd then a single skeleton file
85                      containing all the definitions is output.
86
87       -Wba           Generate definitions for TypeCode and Any.
88
89       -Wbinline      Output stubs for #included IDL files in  line  with  the
90                      main file.
91
92       -Wbtp          Generate tie implementation skeletons.
93
94       -Wbtf          Generate flattened tie implementation skeletons.
95
96       -Wbsplice-modules
97                      Splice together multiply-opened modules into one.
98
99       -Wbexample     Generate example implementation code.
100
101       -WbBOA         Generate BOA compatible skeletons.
102
103       -Wbkeep_inc_path
104                      Preserve IDL #include paths in generated #include direc‐
105                      tives.
106
107       -Wbuse_quotes  Use quotes in #include  directives  (e.g.  "foo"  rather
108                      than <foo>).
109
110
111

PYTHON BACK-END

113       Choose the Python back-end with -bpython.  The Python back-end produces
114       Python packages according to the standard IDL to Python mapping, to  be
115       used  with  omniORBpy.  The  Python back-end is only available when you
116       have omniORBpy installed.
117
118       The Python back-end generates Python package  directories  named  after
119       the  modules declared in IDL, as required by the IDL to Python mapping.
120       It also creates separate stub files that are imported by the packages.
121
122

PYTHON BACK-END OPTIONS

124       -Wbinline      Output stubs for #included IDL files in  line  with  the
125                      main file.
126
127       -Wbglobal=<name>
128                      Use <name> as the name for the global IDL scope (default
129                      _GlobalIDL).
130
131       -Wbpackage=<name>
132                      Put both  Python  modules  and  stub  files  in  package
133                      <name>.
134
135       -Wbmodules=<name>
136                      Put Python modules in package <name>
137
138       -Wbstubs=<name>
139                      Put stub files in package <name>
140
141

AUTHOR

147       Duncan Grisby
148
149
150
151AT&T Laboratories, Cambridge         2001                           omniidl(1)