1 mateus.baur 1.7 .\" $Header: /cvs/MSB/pegasus/rpm/manLinux/man1.Z/cimmof.1,v 1.6 2005/07/07 11:59:18 aruran.ms Exp $

  2 alagaraja   1.4 .\" .TA c \" lowercase initial letter of .TH name
  3                 .TH "cimmof" "1" "" "" ""
  4                 .SH "NAME"

  5 kumpf       1.2 cimmof \- compile MOF files into the CIM Repository 

  6 alagaraja   1.4 .SH "SYNOPSIS"

  7 aruran.ms   1.6 \fBcimmof\fP \fB\-h\fP | \fB\-\-help\fP
  8                 
  9                 \fBcimmof\fP \fB\-\-version\fP
 10                 
 11                 \fBcimmof\fP [ \fB\-w\fP ] [ \fB\-E\fP ] [ \fB\-uc\fP ] [ \fB\-aE | \-aV | \-aEV\fP ] [ \fB\-I\fP path ] 
 12                        [ \fB\-n\fP namespace ] [ \fB\-\-namespace\fP namespace ] [ \fB\-\-xml\fP ] 
 13                        [ \fB\-\-trace\fP ] [ mof_file ... ]

 14 kumpf       1.2 .SS Remarks

 15 alagaraja   1.4 .PP 

 16 kumpf       1.2 Only a superuser or user with write access to the default or specified 
 17                 namespace can run the 
 18                 .B cimmof
 19                 command to compile MOFs in the CIM Repository.

 20 alagaraja   1.4 .PP 

 21 kumpf       1.2 Superclasses must be compiled before subclasses, else the compile will fail.

 22 alagaraja   1.4 .PP 

 23 kumpf       1.2 It is strongly recommended that MOF files include all necessary subclasses,
 24                 so they can compile properly even if certain classes are not in the CIM 
 25                 Repository.

 26 alagaraja   1.4 .SH "DESCRIPTION"
 27                 .PP 

 28 kumpf       1.2 The 
 29                 .B cimmof
 30                 command is the command line interface to the Managed
 31                 Object Format (MOF) Compiler.  The MOF Compiler is a utility that
 32                 compiles MOF files (using the MOF format defined by the DMTF CIM
 33                 Specification) into CIM classes and instances that are stored
 34                 in the CIM Repository.

 35 alagaraja   1.4 .PP 

 36 kumpf       1.2 The 
 37                 .B cimmof
 38                 command can be used to compile MOF files at any time after installation.
 39                 If no input file is specified, stdin is used as the input.

 40 alagaraja   1.4 .PP 

 41 kumpf       1.2 The MOF Compiler requires that the input MOF files be in the current
 42                 directory or that a fully qualified path be given.  To simplify the
 43                 specification of multiple MOF files in the 
 44                 .B cimmof
 45                 command line, the MOF Compiler allows compiling from files containing a list of
 46                 MOF files using the include pragma (as shown below).
 47                 .RS

 48 alagaraja   1.4 .TP 

 49 kumpf       1.2 .PD 0
 50                 .B "#pragma include (""application.mof"")"

 51 alagaraja   1.4 .TP 

 52 kumpf       1.2 .B "#pragma include (""server.mof"")"
 53                 .PD
 54                 .RE

 55 alagaraja   1.4 .PP 

 56 kumpf       1.2 MOF files using the include pragma must be in the current directory
 57                 or in a directory specified by the 
 58                 .B \-I
 59                 command line option.

 60 alagaraja   1.4 .PP 

 61 kumpf       1.2 The 
 62                 .B \-n
 63                 option can be used to specify a 

 64 alagaraja   1.4 .I R namespace 

 65 kumpf       1.2 in which the CIM classes and instances will be compiled.  If this option is not
 66                 specified, the default 

 67 alagaraja   1.4 .I R namespace 

 68 kumpf       1.2 is root/cimv2 (with the exception of provider registration schemas).  

 69 alagaraja   1.4 .PP 

 70 kumpf       1.2 For provider registration schemas, if the 
 71                 .B \-n
 72                 option is not
 73                 specified, the default 

 74 alagaraja   1.4 .I R namespace 

 75 kumpf       1.2 is root/PG_InterOp.  If 
 76                 .B \-n
 77                 option is specified, the 

 78 alagaraja   1.4 .I R namespace 

 79 kumpf       1.2 specified must be root/PG_InterOp, otherwise, the error message "The 
 80                 requested operation is not supported." is returned.   For provider
 81                 MOFs, the 

 82 alagaraja   1.4 .I R namespace 

 83 kumpf       1.2 specified must match one of the namespaces specified
 84                 in the PG_ProviderCapabilities class schema definition. 
 85                 .SS Options
 86                 The 
 87                 .B cimmof
 88                 command recognizes the following options:
 89                 .RS
 90                 .TP 15

 91 alagaraja   1.4 .B \-aE
 92                 Allow Experimental Schema changes.
 93                 .TP 
 94                 .B \-aEV
 95                 Allow both Experimental and Version Schema changes.
 96                 .TP 
 97                 .B \-aV
 98                 Allow both Major and Down Revision Schema changes.
 99                 .TP 
100                 .B \-E
101                 Syntax check only
102                 .TP 
103                 .B \-h, \-\-help
104                 Display command usage information.
105                 .TP 
106                 \fB\-I\fP path

107 kumpf       1.2 Specify the path to included MOF files.  This path may be relative or
108                 absolute.

109 alagaraja   1.4 .IP 

110 kumpf       1.2 If the input MOF file has include pragmas and the
111                 included files do not reside in the current directory,
112                 the 

113 alagaraja   1.4 .C \-I

114 kumpf       1.2 directive must be used to specify a path to
115                 them on the 
116                 .B cimmof
117                 command line.

118 alagaraja   1.4 .TP 
119                 \fB\-n\fP 

120 kumpf       1.2 Override the default CIM Repository namespace. The

121 alagaraja   1.4 .I namespace 

122 kumpf       1.2 specified  must be a valid CIM
123                 namespace name.  For the definition of a valid CIM
124                 namespace name, refer to the Administrator's Guide.
125                 For provider registration schemas, the 

126 alagaraja   1.4 .I namepace

127 kumpf       1.2 specified must be root/PG_InterOp.

128 alagaraja   1.4 .TP 
129                 \fB\-\-namespace\fP 
130                 Override the default CIM Repository namespace. The
131                 .I namespace 
132                 specified  must be a valid CIM
133                 namespace name.  For the definition of a valid CIM
134                 namespace name, refer to the Administrator's Guide.
135                 For provider registration schemas, the 
136                 .I namepace
137                 specified must be root/PG_InterOp.
138                 .TP 
139                 \fB\-\-trace\fP 
140                 Trace to file (default to stdout)
141                 .TP 
142                 \fB\-uc\fP 
143                 Allow update of an existing class definition.
144                 .TP 
145                 \fB\-\-version\fP 
146                 Display CIM Server version.
147                 .TP 
148                 .B \-w
149 alagaraja   1.4 Suppress warning messages. 
150                 .IP 
151                 When compiling the MOF files, if there are CIM elements (such as classes,
152                 instances, properties, or methods) defined in the MOF files which 
153                 already exist in the CIM Repository, the 
154                 .B cimmof
155                 command returns warning messages.  The 
156                 .B \-w
157                 option can be used to suppress these warning messages.
158                 .TP 
159                 .B \-\-xml
160                 Output XML only, to stdout. Do not update repository.
161                 .SH "EXIT STATUS"
162                 .PP 

163 kumpf       1.2 The 
164                 .B cimmof
165                 command returns one of the following values:
166                 .RS

167 alagaraja   1.4 .TP 

168 kumpf       1.2 .B 0
169                 Successful completion
170                 .PD 0

171 alagaraja   1.4 .TP 

172 kumpf       1.2 .B 1 
173                 Error
174                 .PD
175                 .RE

176 alagaraja   1.4 .PP 

177 kumpf       1.2 When an error occurs, an error message is written to stderr and an
178                 error value of 1 is returned.

179 mateus.baur 1.7 .SH "USAGE NOTES"
180                 .PP
181                 The
182                 .B cimmof
183                 command requires that the CIM Server is running.  If an operation requires
184                 more than two minutes to be processed, the
185                 .B cimmof
186                 command prints a timeout message and returns an error value.

187 alagaraja   1.4 .SH "DIAGNOSTICS"
188                 .PP 

189 kumpf       1.2 .B "Error trying to create Repository in path localhost:5988: Cannot connect to: localhost:5988 Failed to set DefaultNamespacePath."

190 alagaraja   1.4 .IP 

191 kumpf       1.2 The CIM Server is not running.  Start the CIM Server with the
192                 .C cimserver 

193 alagaraja   1.4 command and re\-run

194 kumpf       1.2 .B cimmof .

195 alagaraja   1.4 .PP 

196 kumpf       1.2 If the MOF Compiler detects an error in the MOF file while parsing the file, 
197                 a parsing error is returned with the line number of the MOF file containing
198                 the error.

199 alagaraja   1.4 .PP 

200 kumpf       1.2 .B "Operation cannot be carried out since the specified superclass does not exist." 

201 alagaraja   1.4 .IP 

202 kumpf       1.2 The MOF Compiler compiled a MOF file with superclasses that were not
203                 in the CIM Repository.

204 alagaraja   1.4 .PP 

205 kumpf       1.2 For a list of possible error messages
206                 that may be returned, refer to the Chapter on WBEM messages in
207                 the Administrator's Guide.

208 alagaraja   1.4 .SH "EXAMPLES"
209                 .PP 

210 kumpf       1.2 Compile a MOF file into the default namespace in the CIM Repository,
211                 issue the 
212                 .B cimmof
213                 command with no options.

214 alagaraja   1.4 .IP 

215 kumpf       1.2 .B "cimmof processInfo.mof"

216 alagaraja   1.4 .PP 
217                 Compile the MOF files into the "root/application" namespace.
218                 .IP 
219                 .B  "cimmof \-nroot/application test1.mof test2.mof"
220                 .PP 

221 kumpf       1.2 Compile the MOF file defined in the directory ./MOF with the name
222                 CIMSchema25.mof, and containing include pragmas for other MOF files also
223                 in the ./MOF directory.

224 alagaraja   1.4 .IP 
225                 .B "cimmof \-w \-I./MOF MOF/CIMSchema25.mof"
226                 .PP 
227                 Display Usage Info for the 
228                 .B cimmof
229                 command.  
230                 .IP 
231                 .B "cimmof \-h"
232                 .SH "SEE ALSO"
233                 .PP 
234                 cimserver(1).