usr/src/cmd/simplewbem/genclass.1
author Cyril Plisko <cyril.plisko@grigale.com>
Tue, 06 Apr 2010 16:00:14 +0300
changeset 11 87960ed158f9
parent 0 b34509ac961f
permissions -rw-r--r--
Import sfw build 137 Bugs Fixed ---------- 6926835 Wireshark cannot open files typed into the location bar 6930214 CVE-2010-0624: Heap-based buffer overflow in GNU Tar 6933424 Various sfw manual pages need to be adjusted to use the new OpenSolaris package names. 6937764 upgrade OpenSSL to 0.9.8n (and fix CVE-2010-0740)

'\" t
.\"
.\" CDDL HEADER START
.\"
.\" The contents of this file are subject to the terms of the
.\" Common Development and Distribution License (the "License").
.\" You may not use this file except in compliance with the License.
.\"
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
.\" or http://www.opensolaris.org/os/licensing.
.\" See the License for the specific language governing permissions
.\" and limitations under the License.
.\"
.\" When distributing Covered Code, include this CDDL HEADER in each
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
.\" If applicable, add the following below this CDDL HEADER, with the
.\" fields enclosed by brackets "[]" replaced with your own identifying
.\" information: Portions Copyright [yyyy] [name of copyright owner]
.\"
.\" CDDL HEADER END
.\"
.\" Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
.\" Use is subject to license terms.
.\"
.\" ident	"@(#)genclass.1	1.2	10/03/16 SMI"
.\"
.\" Man page for genclass
.TH "genclass" "1" "" "" ""
.SH "NAME"
.B genclass
\- generate C++ definitions from MOF classes
.SH "SYNOPSIS"
.B genclass
[OPTIONS] <class\-names>...

.SH "DESCRIPTION"
.P
The 
.B genclass 
utility generates C++ definitions from MOF classes. For each class-name
argument, it generates at least two files: CLASSNAME.h (containing the 
corresponding C++ class) and CLASSNAME.cpp (containing opaque meta-data for
the class). It also generates header and source files for any dependent 
classes (ancestor and reference classes).
.P
.B genclass 
to process the following MOF files:
.RS
.TP 3
1. First CIM_Schema.mof or first file of form 
cimv[0-9]*.mof (required).
.TP
2. Second repository.mof (optional).
.TP
3. Finally any files given by the -M option (optional).
.RE
.P
.B genclass 
requires the CIMPLE_MOF_PATH environment variable to be set, where
it expects to find CIM_Schema.mof or cimv[0-9]*.mof (which contains the CIM 
schema). The syntax of CIMPLE_MOF_PATH is similar to the Linux/Unix PATH 
environment variable (i.e., a list of directories separated by colons). For 
example:
.TP
    export CIMPLE_MOF_PATH=/opt/cimple/schema/cim2131:/tmp/cim
.PP
.B genclass 
searches for user-defined MOF files in the following way:
.RS
.TP
1. First in the current directory.
.TP
2. Second under $CIMPLE_MOF_PATH.
.TP
3. Finally, under directories given by the -I options.
.RE

.SH "OPTIONS"
.B genclass 
recognizes the following options:
.RS
.TP
.B -V
Print the version number.
.TP
.B -I path
Add to MOF include path (can be repeated).
.TP 
.B -M file	
Add to list of MOF files to be parsed (can be repeated).
.TP
.B -r
Generate repository.h and repository.cpp.
.TP
.B -h
Print the help message.
.TP
.B -e
Generate enum tags for Values/ValueMap qualifiers.
.TP
.B -s
Generate classes for entire CIM schema.
.TP
.B -l
Export class symbols (for shared libraries).
.TP
.B -q
Generate non-boolean qualifiers and non-description qualifiers.
.TP
.B -d
Generate Description qualifiers.
.TP
.B -b
Generate boolean qualifiers (in addition to bit mask).
.TP
.B -f file	
Read class names from this file (one per line).
.TP
.B -S
Create .genclass file that contains generated .cpp files.
.RE

.SH "EXIT STATUS"
When an error occurs, an error message is written to the standard error
stream and a non-zero exit status value is returned.

.SH "SEE ALSO"
genhnd(1), genmak(1), genmod(1), genproj(1), genprov(1), regmod(1).

'\" t
.\"
.\" Modified for Solaris to add the Solaris stability classification,
.\" and to add a note about source availability.
.\"
.\" Begin Sun update
.SH ATTRIBUTES
See
.BR attributes (5)
for descriptions of the following attributes:
.sp
.TS
box;
cbp-1 | cbp-1
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
=
Availability	system/management/wbem/cimple
=
Interface Stability	Uncommitted
.TE 
.PP
.SH NOTES
Source for SimpleWBEM (Cimple) is available on http://opensolaris.org.
.\" End Sun update