1 karl  1.1 /*
 2           The file documents the Pegasus MOF compiler.
 3           */
 4           
 5           /** @name Pegasus MOF Compiler
 6           
 7           The Pegasus MOF compiler is a command line utility that compiles MOF files
 8           (using the MOF format defined by the DMTF CIM Specification) into a Pegasus
 9           repository. It allows compiling from strucutures of MOF files using the
10           include pragma and can either compile into a Pegasus repository or simply
11           perform a syntax check on the MOF files.
12           
13           In the syntax check mode, it checks each class independently and does not do
14           semantic checks between classes (ex. check for super-classes, etc.). When
15           compiling into a Pegasus repository, the compiler uses Pegasus to install the
16           classes and instances into the repository and uses the semantic checking built
17           into Pegasus.
18           
19           The compiler operates standalone in the syntax checking mode but requires the
20           Pegasus libraries when compiling into a Pegasus respository.
21           
22 karl  1.1 The compiler requires that the input MOF files be in the current directory

23 bob   1.2 or that a fully qualified path be given.  MOF files included using
24           #pragma include must be in the current directory or in a directory specified
25           by a -I command line switch.

26 karl  1.1 
27           The compiler assumes that the file extension is .mof it is not specified.

28 bob   1.2 (This feature is not yet implemented.)

29 karl  1.1 

30 karl  1.3 The actual configuration and type of repository created depends on the
31           characteristics of the repository implemented in Pegasus. 
32           See the description of the Pegasus repositories for more information.
33           
34           There are actually two compiler executable files.
35           
36           cimof.exe - This file operates through the client interface and acts as a
37           remote compiler against an active CIM Repository
38           cimmofl.exe - This file operates locally and directly against the repository.

39 karl  1.1 
40           <B>EXAMPLE</B>
41           
42           <PRE>

43 bob   1.2        cimmof -w -Rtestrepository -I./MOF MOF/CIMSchema25.mof

44 karl  1.1 </PRE>
45           
46           Compile the mof file defined in the directory MOF with the name CIMSchema25.mof
47           and with include pragmas for other MOF files also in that directory and create
48           the repository testrepository
49           
50           
51           <B>NAME</B>
52           
53           	cimmof - Compile DMTF CIM MOF
54           
55           <B>SYNOPSIS</B>
56           	<PRE>
57           	cimmof [OPTION]... [FILE]...
58           	</PRE>
59           	
60           
61           <B>DESCRIPTION</B>
62           
63           The MOF compiler TBD
64           
65 karl  1.1 <B>OPTIONS</B>
66           <UL>
67           <LI>-h, --help	Print out usage message with command line definitions.
68           
69           

70 bob   1.2 <LI>-E - 		Perform only a syntax check on the input and creates no 					repository.  Inthis mode, the compiler does not do the sematic checks that are done when a CIM object is\
71            added to a repository

72 karl  1.1 

73 bob   1.2 -w -- Suppresses warning messages.

74 karl  1.1 
75           <LI>-R<path> - 	Specifies the path to the repository to be written. This is an
76           alternative to the PEGASUS_HOME environment variable. If PEGASUS_HOME is set
77           the repository gets written to $PEGASUS_HOME/repository. The -R flag one the
78           command line overrides this with <path> specified in the directive.

79 bob   1.2 Specify an absolute path.

80 karl  1.1 
81           <LI>--CIMRepository=<path>
82           
83           <LI>-I<path> -- 	Specifies the path to included MOF files. If the inputmof file has include pragmas and the included files  do not reside in the current directory, the -I directive must be used to specify a path to them on the compiler command line. Do this with the -I flag.
84           
85           	cimmof -I~/testfiles ~/testfiles/main.mof
86           

87 bob   1.2 The path may be relative or absolute.

88 karl  1.1 
89           </UL>
90           
91           */
92