1 karl  1.1 
 2           HOWTO - Pegasus comiler usage
 3           
 4           K. Schopmeyer (15 Feb 2002)
 5           
 6           The Pegasus MOF compiler is a command line utility that compiles MOF files
 7           (using the MOF format defined by the DMTF CIM Specification) into a Pegasus
 8           repository. It allows compiling from strucutures of MOF files using the
 9           include pragma and can either compile into a Pegasus repository or simply
10           perform a syntax check on the MOF files.
11           
12           In the syntax check mode, it checks each class independently and does not do
13           semantic checks between classes (ex. check for super-classes, etc.). When
14           compiling into a Pegasus repository, the compiler uses Pegasus to install the
15           classes and instances into the repository and uses the semantic checking built
16           into Pegasus.
17           
18           The compiler operates standalone in the syntax checking mode but requires the
19           Pegasus libraries when compiling into a Pegasus respository.
20           
21           The compiler requires that the input MOF files be in the current directory
22 karl  1.1 or that a fully qualified path be given.  MOF files included using
23           #pragma include must be in the current directory or in a directory specified
24           by a -I command line switch.
25           
26           The compiler assumes that the file extension is .mof if it is not specified.
27           (This feature is not yet implemented.)
28           
29           The actual configuration and type of repository created depends on the
30           characteristics of the repository implemented in Pegasus. 
31           See the description of the Pegasus repositories for more information.
32           
33           There are actually two compiler executable files.
34           
35           cimof.exe - This file operates through the client interface and acts as a
36           remote compiler against an active CIM Repository
37           cimmofl.exe - This file operates locally and directly against the repository.
38           
39                  cimmof -w -Rtestrepository -I./MOF MOF/CIMSchema25.mof
40                  cimmofl -w -Rtestrepository -I./MOF MOF/CIMSchema25.mof
41           
42           
43 karl  1.1 Compile the mof file defined in the directory MOF with the name CIMSchema25.mof
44           and with include pragmas for other MOF files also in that directory and create
45           the repository testrepository
46           
47           
48           NAME
49           
50           	cimmof - Compile DMTF CIM MOF
51           
52           SYNOPSIS
53           	cimmof [OPTION]... [FILE]...
54           	
55           DESCRIPTION
56           
57           The MOF compiler TBD
58           
59           OPTIONS
60           -h, --help	Print out usage message with command line definitions.
61           
62           -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\
63            		ded to a repository
64 karl  1.1 
65           -w  		Suppresses warning messages.
66           
67           -R<path> - 	Specifies the path to the repository to be written. This is an
68           		alternative to the PEGASUS_HOME environment variable. If 
69           		PEGASUS_HOME is set the repository gets written to 
70           		$PEGASUS_HOME/repository. The -R flag one the command line
71           		overrides this with <path> specified in the directive.
72           		Specify an absolute  or relative path.
73           
74           --CIMRepository=<path>
75           
76           -I<path>  	Specifies the path to included MOF files. If the inputmof file 
77           		has include pragmas and the included files  do not reside in 
78           		the current directory, the -I directive must be used to specify 
79           		a path to them on the compiler command line. Do this with 
80           		the -I flag.
81           
82           	cimmof -I~/testfiles ~/testfiles/main.mof
83           
84           The path may be relative or absolute.