TAO/TAO_IDL/docs/historical/CLI

   1 OMG INTERFACE DEFINITION LANGUAGE COMPILER FRONT END: COMMAND LINE INTERFACE
   2 -==========================================================================-
   3
   4 INTRODUCTION
   5
   6 This document describes general OMG Interface Definition Language compiler
   7 command line options. Options that are specific to a given back end, object
   8 adapter or language are not described here. These should be described in a
   9 document detailing the interface implemented by each specific back end.
  10
  11 OMG INTERFACE DEFINITION LANGUAGE COMMAND LINE OPTIONS
  12
  13 OMG Interface Definition Language compiler options are described below.
  14 Unless otherwise noted, only one occurrence of each option is allowed.
  15 The following conventions are used
  16
  17 - Text in '[..]' is optional.
  18 - Text followed by '*' can be repeated zero or more times.
  19 - Text followed by '+' can be repeated once or more times.
  20 - '{' and '}' are used to group text to cause '+' or '*' to apply to
  21   the entire grouped text.
  22 - 'aa|bb' means either 'aa' or 'bb'.
  23
  24 COMMAND LINE SUMMARY
  25
  26         idl [flag | file-name]*
  27
  28 Flags are command line words that start with a '-'. All other command line
  29 words are assumed to be file names. If no file names are given, input is
  30 taken from stdin.
  31
  32 COMMAND LINE FLAGS
  33
  34 -A[xyz] A local escape. This can be used to specify additional options that
  35         are specific to a given implementation. More than one -A option is
  36         allowed
  37
  38 -Dname[=value]
  39         Defines name and an optional value to be passed to a compliant C++
  40         preprocessor, as if by #define. White space between the -D option
  41         and the name is optional. More than one -D option is allowed.
  42
  43 -d      If no parse errors were found, prints out a representation of the
  44         IDL input to stderr.
  45
  46 -E      Runs the C++ preprocessor on the OMG Interface Definition Language
  47         input and sends the result to the standard output.
  48
  49 -Idirectory
  50         Causes directory to be added to the search path for include files.
  51         More than one -I option is allowed. This option is processed by a
  52         compliant C++ preprocessor.
  53
  54 -Uname  Undefines name, as if by #undef. White space between the -U option
  55         and the name is optional. More than one -U option is allowed.
  56
  57 -V      Causes the version information of the CFE to be displayed. No other
  58         work is done, regardless of any other options.
  59
  60 -W[b|p][,arg]+
  61         Hands off the arguments supplied to a specific portion of the OMG
  62         Interface Definition Language compiler:
  63
  64         - -Wb arguments are handed to the loaded back end
  65         - -Wp arguments are handed to a compliant C++ preprocessor
  66
  67 -Yp,pathname
  68         Specifies an alternate path for finding a C++ compliant
  69         preprocessor. Specifiers other than 'p' may be defined in future
  70         versions of the CFE. More than one -Y option may appear. The last
  71         one specifying each component takes effect.
  72
  73         This option exists but currently does nothing. Instead, we use the
  74         preprocessing facilities provided by invoking CC -E always.
  75
  76 -bback_end
  77         Causes the CFE to use a different compiler back end than the
  78         default one (if dynamic loading is supported). Legal values for
  79         this option and the default value are implementation specific.
  80
  81 -u      Prints a usage message from the CFE. All possible options are
  82         shown. No other work is done regardless of any other options.
  83
  84 -v      Causes the CFE to produce informational output as the various
  85         phases of the compiler execute.
  86
  87 -w      Suppresses IDL compiler warning messages.
  88
  89
  90 WHITESPACE
  91
  92 All option arguments may be separated from their option letter by
  93 whitespace. For example, -D FOO is equivalent to -DFOO.
  94
  95 UNKNOWN OPTIONS
  96
  97 If an unknown option is passed to the CFE, the offending option is
  98 displayed to the user together with a usage message, and no compilation is
  99 performed.
 100
 101 PASSING OPTIONS TO COMPILER PHASES
 102
 103 The order in which options appear on the command line is preserved when
 104 they are passed to various compiler phases.
 105
 106 MUTUALLY EXCLUSIVE OPTION COMBINATIONS
 107
 108 Mutually exclusive or ambiguous option combinations are resolved by using
 109 the option that appears later on the command line. For example,
 110
 111     -DFOO -UFOO
 112
 113 has no effect and leaves FOO undefined for the preprocessor.
 114
 115 OPTION SCOPE
 116
 117 All options are in effect for the entire IDL compilation run. If multiple
 118 IDL source file names are given on the command line, all options apply to
 119 each file. If different IDL source files require different sets of options
 120 for successfull compilation, they must be compiled separately.
 121
 122 EXIT STATUS
 123
 124 IDL Compilers exit with status equal to zero for successfull compilations.
 125 If errors were found by the CFE, the exit status is a count of the errors.
 126 The exit status for unsuccessfull compilations aborted by BEs is defined by
 127 each BE.
 128
 129 NOTE:
 130
 131 SunOS, SunSoft, Sun, Solaris, Sun Microsystems or the Sun logo are
 132 trademarks or registered trademarks of Sun Microsystems, Inc.
 133
 134 COPYRIGHT NOTICE:
 135
 136 Copyright 1992, 1993, 1994 Sun Microsystems, Inc.  Printed in the United
 137 States of America.  All Rights Reserved.
 138
 139 This product is protected by copyright and distributed under the following
 140 license restricting its use.
 141
 142 The Interface Definition Language Compiler Front End (CFE) is made
 143 available for your use provided that you include this license and copyright
 144 notice on all media and documentation and the software program in which
 145 this product is incorporated in whole or part. You may copy and extend
 146 functionality (but may not remove functionality) of the Interface
 147 Definition Language CFE without charge, but you are not authorized to
 148 license or distribute it to anyone else except as part of a product or
 149 program developed by you or with the express written consent of Sun
 150 Microsystems, Inc. ("Sun").
 151
 152 The names of Sun Microsystems, Inc. and any of its subsidiaries or
 153 affiliates may not be used in advertising or publicity pertaining to
 154 distribution of Interface Definition Language CFE as permitted herein.
 155
 156 This license is effective until terminated by Sun for failure to comply
 157 with this license.  Upon termination, you shall destroy or return all code
 158 and documentation for the Interface Definition Language CFE.
 159
 160 INTERFACE DEFINITION LANGUAGE CFE IS PROVIDED AS IS WITH NO WARRANTIES OF
 161 ANY KIND INCLUDING THE WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS
 162 FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR ARISING FROM A COURSE OF
 163 DEALING, USAGE OR TRADE PRACTICE.
 164
 165 INTERFACE DEFINITION LANGUAGE CFE IS PROVIDED WITH NO SUPPORT AND WITHOUT
 166 ANY OBLIGATION ON THE PART OF Sun OR ANY OF ITS SUBSIDIARIES OR AFFILIATES
 167 TO ASSIST IN ITS USE, CORRECTION, MODIFICATION OR ENHANCEMENT.
 168
 169 SUN OR ANY OF ITS SUBSIDIARIES OR AFFILIATES SHALL HAVE NO LIABILITY WITH
 170 RESPECT TO THE INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY
 171 INTERFACE DEFINITION LANGUAGE CFE OR ANY PART THEREOF.
 172
 173 IN NO EVENT WILL SUN OR ANY OF ITS SUBSIDIARIES OR AFFILIATES BE LIABLE FOR
 174 ANY LOST REVENUE OR PROFITS OR OTHER SPECIAL, INDIRECT AND CONSEQUENTIAL
 175 DAMAGES, EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 176
 177 Use, duplication, or disclosure by the government is subject to
 178 restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in
 179 Technical Data and Computer Software clause at DFARS 252.227-7013 and FAR
 180 52.227-19.
 181
 182 Sun, Sun Microsystems and the Sun logo are trademarks or registered
 183 trademarks of Sun Microsystems, Inc.
 184
 185 SunSoft, Inc.
 186 2550 Garcia Avenue
 187 Mountain View, California  94043