1 karl  1.1 /*

 2 bob   1.2 	$Log: MOFcompiler.dxx,v $

 3 karl  1.3 	Revision 1.2  2001/03/05 15:22:53  bob
 4           	Minor cleanup
 5           	

 6 bob   1.2 	Revision 1.1  2001/02/25 15:01:40  karl
 7           	Add frames to manual
 8           	

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

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

33 karl  1.1 
34           The compiler assumes that the file extension is .mof it is not specified.

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

36 karl  1.1 

37 karl  1.3 The actual configuration and type of repository created depends on the
38           characteristics of the repository implemented in Pegasus. 
39           See the description of the Pegasus repositories for more information.
40           
41           There are actually two compiler executable files.
42           
43           cimof.exe - This file operates through the client interface and acts as a
44           remote compiler against an active CIM Repository
45           cimmofl.exe - This file operates locally and directly against the repository.

46 karl  1.1 
47           <B>EXAMPLE</B>
48           
49           <PRE>

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

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

77 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\
78            added to a repository

79 karl  1.1 

80 bob   1.2 -w -- Suppresses warning messages.

81 karl  1.1 
82           <LI>-R<path> - 	Specifies the path to the repository to be written. This is an
83           alternative to the PEGASUS_HOME environment variable. If PEGASUS_HOME is set
84           the repository gets written to $PEGASUS_HOME/repository. The -R flag one the
85           command line overrides this with <path> specified in the directive.

86 bob   1.2 Specify an absolute path.

87 karl  1.1 
88           <LI>--CIMRepository=<path>
89           
90           <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.
91           
92           	cimmof -I~/testfiles ~/testfiles/main.mof
93           

94 bob   1.2 The path may be relative or absolute.

95 karl  1.1 
96           </UL>
97           
98           */
99