1 karl  1.1 /* PegasusDoc.dxx - Top Level file for Developer Documentation.
  2           This file defines the document strucuture and provides the introduction

  3 karl  1.2 	$Log: PegasusDoc.dxx,v $

  4 karl  1.14 	Revision 1.13  2001/02/25 15:01:40  karl
  5            	Add frames to manual
  6            	

  7 karl  1.13 	Revision 1.12  2001/02/23 20:27:46  karl
  8            	correct documentation
  9            	

 10 karl  1.12 	Revision 1.11  2001/02/21 01:53:08  karl
 11            	Namespaces stuff
 12            	

 13 karl  1.11 	Revision 1.10  2001/02/20 14:06:05  karl
 14            	name changes
 15            	

 16 karl  1.10 	Revision 1.9  2001/02/19 21:48:40  karl
 17            	CIMxx Class and file name chages
 18            	

 19 karl  1.9  	Revision 1.8  2001/02/06 17:02:13  karl
 20            	rearrange documentation for interfaces
 21            	

 22 karl  1.8  	Revision 1.7  2001/02/05 14:14:00  karl
 23            	doc++ extension for respository
 24            	

 25 karl  1.7  	Revision 1.6  2001/02/02 19:38:23  karl
 26            	add graphic
 27            	

 28 karl  1.6  	Revision 1.5  2001/02/02 18:48:20  karl
 29            	Doc++ expansion
 30            	

 31 karl  1.5  	Revision 1.4  2001/01/30 23:38:18  karl
 32            	Add to documentation
 33            	

 34 karl  1.4  	Revision 1.3  2001/01/24 17:17:05  karl
 35            	add Doc++ comments
 36            	

 37 karl  1.3  	Revision 1.2  2001/01/24 16:16:38  karl
 38            	Incorporate Doc++ Comments as documentation into .h files
 39            	

 40 karl  1.2  	Revision 1.1  2001/01/24 14:18:48  karl
 41            	import Dev Doc Files

 42 karl  1.1  	

 43 karl  1.2  	
 44            	$Author: karl $

 45 karl  1.1  */

 46 karl  1.13 /* do not change the following Name.  Used in the Frame definition.
 47            If you change it, the HTML Frame must also be changed.

 48 karl  1.12 */
 49            /** @name Introduction
 50            
 51            <CENTER><FONT Size=+4>Welcome to PEGASUS</FONT></CENTER>

 52 karl  1.1  

 53 karl  1.12 <P><B><CENTER>DRAFT FOR REVIEW</CENTER></B>

 54 karl  1.1  

 55 karl  1.12 <table border="1" width="100%">
 56              <CAPTION>Revision History</CAPTION>
 57              <tr>
 58                <td width="10%"><b>Versions</b></td>
 59                <td width="13%"><b>Date</b></td>
 60                <td width="37%"><b>Author</b></td>
 61                <td width="117%"><b>Comments</b></td>
 62              </tr>
 63              <tr>
 64                <td width="10%">0.5</td>
 65                <td width="13%">01/02/02</td>
 66                <td width="37%">Karl</td>
 67                <td width="117%">&nbsp;</td>
 68              </tr>
 69                <tr>
 70                  <td width="10%">0.6</td>
 71                  <td width="13%">01/04/02</td>
 72                  <td width="37%">Karl</td>
 73                  <td width="117%">Clean up the API defintions. and Add repository section.</td>
 74              </tr>
 75              </tr>
 76 karl  1.12     <tr>
 77                  <td width="10%">0.7</td>
 78                  <td width="13%">02/20/02</td>
 79                  <td width="37%">Karl</td>
 80                  <td width="117%">Change Class names, Add definitions, Add Architecture documentation.</td>
 81              </tr>  

 82 karl  1.13     </tr>
 83                  <tr>
 84                    <td width="10%">0.75</td>
 85                    <td width="13%">02/25/02</td>
 86                    <td width="37%">Karl</td>
 87                    <td width="117%">Create Frames Version and redo structure..</td>
 88              </tr> 

 89 karl  1.12 </table>

 90 karl  1.6  

 91 karl  1.8  Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.

 92 karl  1.1  

 93 karl  1.5  <B>This Document</B>

 94 karl  1.1  

 95 karl  1.5  <P>This is a working document that is the temporary user and developers manual for the Pegasus CIM Server implementation which is being created by the OpenGroup Enterprise Management Program Group.

 96 karl  1.1  

 97 karl  1.5  This manual serves as both a manual for installation and operation of the prototype version of Pegasus and a manual for developing components to attach to Pegasus. In addition to the manual, we keep current working information in a set of README files within the Pegasus distributions. Please consult these files also.

 98 karl  1.1  

 99 karl  1.12 Within this manual you will find:

100 karl  1.5  <UL>
101            <LI>Information on the installation and operation of the broker and additional components.
102            <LI> A basic defintion of the architecture and function of Pegasus.
103            <LI>The current definition of the programming interfaces that Pegasus allows.  As these interfaces are stabilized they will be moved from this document to an Open Group specificaton.
104            <LI>A number of defintions of additional code that is

105 karl  1.1  available to interface with Pegasus as providers, consumers, and services.

106 karl  1.5  </UL>
107            

108 karl  1.6  <B>ATTN:</B> I need to give a description of the sections and what they accomplish with hotlinks to each.

109 karl  1.5  
110            This is not an internals manual for Pegasus.  The Internals for Pegasus developers will be defined in a separate manual that is also available from The Open Group (\URL{http://www.opengroup.org/Management}.

111 karl  1.1  

112 karl  1.5  NOTE: This a working document today.  It is revised frequently as we learn more about the documentation system and stabilize the Pegasus interfaces.  We apologize for the existing insonsistencies and errors in this working version of the document.

113 karl  1.1  
114            This version of the Pegasus User Manual was created at \today
115            */

116 karl  1.12 /* The following is the complete file haearchy for this document.

117 karl  1.13    We have tried to keep all file references in only this one place

118 karl  1.12    to make modification easier.  In the future, please keep the
119               references here and text in the individual files.

120 karl  1.1  */

121 karl  1.13 

122 karl  1.5      //@Include: objectives.dxx

123 karl  1.1      //@Include: overview.dxx
124                //@Include: credits.dxx
125                //@Include: Architecture.dxx
126                //@Include: Components.dxx

127 karl  1.5      //@Include: Utilization.dxx

128 karl  1.13         //@{	    
129                	//@Include: availability.dxx
130                	//@Include: installation.dxx
131                	//@Include: operation.dxx
132                	//@Include: CIMClients.dxx
133                	//@Include: PegasusProviders.dxx
134                	//@Include: MOFCompiler.dxx    
135                    //@}

136 karl  1.14     //@Include: programming.dxx

137 karl  1.12         //@{

138 karl  1.14 	   //@Include: CIMObjects.dxx
139            	   //@Include: CIMOBJECTTable.dxx
140            	   //@Include: Classes.dxx

141 karl  1.12            //@{ 

142 karl  1.5      		//@Include: ..\..\src\Pegasus\Common\Array.h

143 karl  1.9      		//@Include: ..\..\src\Pegasus\Common\CIMClass.h
144                		//@Include: ..\..\src\Pegasus\Common\CIMDateTime.h
145                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h

146 karl  1.5      		//@Include: ..\..\src\Pegasus\Common\String.h

147 karl  1.9      		//@Include: ..\..\src\Pegasus\Common\CIMType.h
148                		//@Include: ..\..\src\Pegasus\Common\CIMInstance.h
149                		//@Include: ..\..\src\Pegasus\Common\CIMValue.h
150                		//@Include: ..\..\src\Pegasus\Common\CIMParameter.h
151                		//@Include: ..\..\src\Pegasus\Common\CIMProperty.h
152                		//@Include: ..\..\src\Pegasus\Common\CIMScope.h
153                		//@Include: ..\..\src\Pegasus\Common\CIMReference.h
154                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierList.h    		
155                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierNames.h
156                		//@Include: ..\..\src\Pegasus\Common\CIMQualifier.h
157                		//@Include: ..\..\src\Pegasus\Common\CIMName.h
158                		//@Include: ..\..\src\Pegasus\Common\CIMMethod.h
159                		//@Include: ..\..\src\Pegasus\Common\CIMFlavor.h

160 karl  1.5      		//@Include: ..\..\src\Pegasus\Common\Char16.h

161 karl  1.9          	//@Include: ..\..\src\Pegasus\Common\DeclContext.h

162 karl  1.12         	//@{

163 karl  1.13 		//@Include: Exceptions.dxx  

164 karl  1.11         	//@Include: ..\..\src\Pegasus\Common\Exception.h

165 karl  1.12         	//@}
166                        //@}

167 karl  1.11         	

168 karl  1.5  	//@}

169 karl  1.1      //@Include: Interfaces.dxx
170                   //@{

171 karl  1.8  	    //@Include: CIMOperations.dxx
172            	        //@{

173 karl  1.9  		    //@Include: ..\..\src\Pegasus\Common\CIMOperations.h

174 karl  1.8  		//@}

175 karl  1.1  	    //@Include: ClientInterfaces.dxx   
176            		//@{    

177 karl  1.9  		    //@Include: ..\..\src\Pegasus\Client\CIMClient.h

178 karl  1.1  		//@}
179                	   //@Include: ProviderInterfaces.dxx

180 karl  1.9      	   	//@{
181            		    //@Include: ..\..\src\Pegasus\Provider\CIMProvider.h
182            		//@}  	 

183 karl  1.1      	   //@Include: ServiceInterfaces.dxx

184 karl  1.7      	   //@Include: RepositoryInterfaces.dxx

185 karl  1.8      	   	//@{

186 karl  1.9  		    //@Include: ..\..\src\Pegasus\Repository\CIMRepository.h

187 karl  1.8  		//@}

188 karl  1.1         //@}

189 karl  1.8      

190 karl  1.5      //@Include: ProviderWriting.dxx

191 karl  1.1      //@Include: definitions.dxx
192                //@Include: Examples.dxx

193 karl  1.12     	
194                	//@{
195                		//@Include: ExamplesClient.dxx
196                 		//@Include: ExamplesProvider.dxx  
197                	//@}

198 karl  1.8      //@Include: references.dxx

199 karl  1.5      //@Include: FAQ.dxx

200 karl  1.13  

201 karl  1.1