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.15 	Revision 1.14  2001/02/25 18:04:45  karl
  5            	extend programing deffinitions
  6            	

  7 karl  1.14 	Revision 1.13  2001/02/25 15:01:40  karl
  8            	Add frames to manual
  9            	

 10 karl  1.13 	Revision 1.12  2001/02/23 20:27:46  karl
 11            	correct documentation
 12            	

 13 karl  1.12 	Revision 1.11  2001/02/21 01:53:08  karl
 14            	Namespaces stuff
 15            	

 16 karl  1.11 	Revision 1.10  2001/02/20 14:06:05  karl
 17            	name changes
 18            	

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

 22 karl  1.9  	Revision 1.8  2001/02/06 17:02:13  karl
 23            	rearrange documentation for interfaces
 24            	

 25 karl  1.8  	Revision 1.7  2001/02/05 14:14:00  karl
 26            	doc++ extension for respository
 27            	

 28 karl  1.7  	Revision 1.6  2001/02/02 19:38:23  karl
 29            	add graphic
 30            	

 31 karl  1.6  	Revision 1.5  2001/02/02 18:48:20  karl
 32            	Doc++ expansion
 33            	

 34 karl  1.5  	Revision 1.4  2001/01/30 23:38:18  karl
 35            	Add to documentation
 36            	

 37 karl  1.4  	Revision 1.3  2001/01/24 17:17:05  karl
 38            	add Doc++ comments
 39            	

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

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

 45 karl  1.1  	

 46 karl  1.2  	
 47            	$Author: karl $

 48 karl  1.1  */

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

 51 karl  1.12 */
 52            /** @name Introduction
 53            
 54            <CENTER><FONT Size=+4>Welcome to PEGASUS</FONT></CENTER>

 55 karl  1.1  

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

 57 karl  1.1  

 58 karl  1.12 <table border="1" width="100%">
 59              <CAPTION>Revision History</CAPTION>
 60              <tr>
 61                <td width="10%"><b>Versions</b></td>
 62                <td width="13%"><b>Date</b></td>
 63                <td width="37%"><b>Author</b></td>
 64                <td width="117%"><b>Comments</b></td>
 65              </tr>
 66              <tr>
 67                <td width="10%">0.5</td>

 68 karl  1.15     <td width="13%">01/02/01</td>

 69 karl  1.12     <td width="37%">Karl</td>
 70                <td width="117%">&nbsp;</td>
 71              </tr>
 72                <tr>
 73                  <td width="10%">0.6</td>

 74 karl  1.15       <td width="13%">01/04/01</td>

 75 karl  1.12       <td width="37%">Karl</td>
 76                  <td width="117%">Clean up the API defintions. and Add repository section.</td>
 77              </tr>
 78              </tr>
 79                <tr>
 80                  <td width="10%">0.7</td>

 81 karl  1.15       <td width="13%">02/20/01</td>

 82 karl  1.12       <td width="37%">Karl</td>
 83                  <td width="117%">Change Class names, Add definitions, Add Architecture documentation.</td>
 84              </tr>  

 85 karl  1.13     </tr>
 86                  <tr>
 87                    <td width="10%">0.75</td>

 88 karl  1.15         <td width="13%">02/25/01</td>

 89 karl  1.13         <td width="37%">Karl</td>
 90                    <td width="117%">Create Frames Version and redo structure..</td>

 91 karl  1.15   </tr> 
 92              </tr>  
 93                  </tr>
 94                    <tr>
 95                      <td width="10%">0.8</td>
 96                      <td width="13%">03/12/2001</td>
 97                      <td width="37%">Karl</td>
 98                      <td width="117%">Generate for 0.8 Release.</td>

 99 karl  1.13   </tr> 

100 karl  1.12 </table>

101 karl  1.6  

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

103 karl  1.1  

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

105 karl  1.1  

106 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.

107 karl  1.1  

108 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.

109 karl  1.1  

110 karl  1.12 Within this manual you will find:

111 karl  1.5  <UL>
112            <LI>Information on the installation and operation of the broker and additional components.
113            <LI> A basic defintion of the architecture and function of Pegasus.
114            <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.
115            <LI>A number of defintions of additional code that is

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

117 karl  1.5  </UL>
118            

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

120 karl  1.5  
121            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}.

122 karl  1.1  

123 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.

124 karl  1.1  
125            This version of the Pegasus User Manual was created at \today
126            */

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

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

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

131 karl  1.1  */

132 karl  1.13 

133 karl  1.5      //@Include: objectives.dxx

134 karl  1.1      //@Include: overview.dxx
135                //@Include: credits.dxx
136                //@Include: Architecture.dxx
137                //@Include: Components.dxx

138 karl  1.5      //@Include: Utilization.dxx

139 karl  1.13         //@{	    
140                	//@Include: availability.dxx
141                	//@Include: installation.dxx
142                	//@Include: operation.dxx
143                	//@Include: CIMClients.dxx
144                	//@Include: PegasusProviders.dxx
145                	//@Include: MOFCompiler.dxx    
146                    //@}

147 karl  1.14     //@Include: programming.dxx

148 karl  1.12         //@{

149 karl  1.14 	   //@Include: CIMObjects.dxx
150            	   //@Include: CIMOBJECTTable.dxx
151            	   //@Include: Classes.dxx

152 karl  1.12            //@{ 

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

154 karl  1.9      		//@Include: ..\..\src\Pegasus\Common\CIMClass.h
155                		//@Include: ..\..\src\Pegasus\Common\CIMDateTime.h
156                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h

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

158 karl  1.9      		//@Include: ..\..\src\Pegasus\Common\CIMType.h
159                		//@Include: ..\..\src\Pegasus\Common\CIMInstance.h
160                		//@Include: ..\..\src\Pegasus\Common\CIMValue.h
161                		//@Include: ..\..\src\Pegasus\Common\CIMParameter.h
162                		//@Include: ..\..\src\Pegasus\Common\CIMProperty.h
163                		//@Include: ..\..\src\Pegasus\Common\CIMScope.h
164                		//@Include: ..\..\src\Pegasus\Common\CIMReference.h
165                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierList.h    		
166                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierNames.h
167                		//@Include: ..\..\src\Pegasus\Common\CIMQualifier.h
168                		//@Include: ..\..\src\Pegasus\Common\CIMName.h
169                		//@Include: ..\..\src\Pegasus\Common\CIMMethod.h
170                		//@Include: ..\..\src\Pegasus\Common\CIMFlavor.h

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

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

173 karl  1.12         	//@{

174 karl  1.13 		//@Include: Exceptions.dxx  

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

176 karl  1.12         	//@}
177                        //@}

178 karl  1.11         	

179 karl  1.5  	//@}

180 karl  1.1      //@Include: Interfaces.dxx
181                   //@{

182 karl  1.8  	    //@Include: CIMOperations.dxx
183            	        //@{

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

185 karl  1.8  		//@}

186 karl  1.1  	    //@Include: ClientInterfaces.dxx   
187            		//@{    

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

189 karl  1.1  		//@}
190                	   //@Include: ProviderInterfaces.dxx

191 karl  1.9      	   	//@{
192            		    //@Include: ..\..\src\Pegasus\Provider\CIMProvider.h
193            		//@}  	 

194 karl  1.1      	   //@Include: ServiceInterfaces.dxx

195 karl  1.7      	   //@Include: RepositoryInterfaces.dxx

196 karl  1.8      	   	//@{

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

198 karl  1.8  		//@}

199 karl  1.1         //@}

200 karl  1.8      

201 karl  1.5      //@Include: ProviderWriting.dxx

202 karl  1.1      //@Include: definitions.dxx
203                //@Include: Examples.dxx

204 karl  1.12     	
205                	//@{
206                		//@Include: ExamplesClient.dxx
207                 		//@Include: ExamplesProvider.dxx  
208                	//@}

209 karl  1.8      //@Include: references.dxx

210 karl  1.5      //@Include: FAQ.dxx

211 karl  1.13  

212 karl  1.1