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.18 	Revision 1.17  2001/05/05 10:07:23  karl
  5            	
  6            	no Change
  7            	

  8 karl  1.17 	Revision 1.16  2001/03/29 16:41:38  karl
  9            	Add Class Tree Stuff
 10            	

 11 karl  1.16 	Revision 1.15  2001/03/23 13:16:33  karl
 12            	minor corrections
 13            	

 14 karl  1.15 	Revision 1.14  2001/02/25 18:04:45  karl
 15            	extend programing deffinitions
 16            	

 17 karl  1.14 	Revision 1.13  2001/02/25 15:01:40  karl
 18            	Add frames to manual
 19            	

 20 karl  1.6  	

 21 karl  1.3  	

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

 24 karl  1.1  	

 25 karl  1.2  	
 26            	$Author: karl $

 27 karl  1.1  */

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

 30 karl  1.12 */
 31            /** @name Introduction
 32            
 33            <CENTER><FONT Size=+4>Welcome to PEGASUS</FONT></CENTER>

 34 karl  1.1  

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

 36 karl  1.1  

 37 karl  1.17 Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.
 38            
 39            <B>This Document</B>
 40            
 41            <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.
 42            
 43            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.
 44            
 45            Within this manual you will find:
 46            <UL>
 47            <LI>Information on the installation and operation of the broker and additional components.
 48            <LI> A basic defintion of the architecture and function of Pegasus.
 49            <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.
 50            <LI>A number of defintions of additional code that is
 51            available to interface with Pegasus as providers, consumers, and services.
 52            </UL>
 53            
 54            <B>ATTN:</B> We need to give a description of the sections and what they accomplish with hotlinks to each.
 55            
 56            This is not an internals manual for Pegasus.  The Internals for Pegasus developers will be defined in a separate manual that will be available from The Open Group (\URL{http://www.opengroup.org/management}).
 57            
 58 karl  1.17 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.
 59            
 60            This version of the Pegasus User Manual was created at \today
 61            */
 62            /** @name Revision History
 63            <p><B>Revision History</B></p>
 64            <p><table border="1" width="100%">

 65 karl  1.12   <CAPTION>Revision History</CAPTION>
 66              <tr>
 67                <td width="10%"><b>Versions</b></td>
 68                <td width="13%"><b>Date</b></td>
 69                <td width="37%"><b>Author</b></td>
 70                <td width="117%"><b>Comments</b></td>
 71              </tr>
 72              <tr>
 73                <td width="10%">0.5</td>

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

 75 karl  1.12     <td width="37%">Karl</td>
 76                <td width="117%">&nbsp;</td>
 77              </tr>

 78 karl  1.16   <tr>

 79 karl  1.12       <td width="10%">0.6</td>

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

 81 karl  1.12       <td width="37%">Karl</td>
 82                  <td width="117%">Clean up the API defintions. and Add repository section.</td>
 83              </tr>

 84 karl  1.16   <tr>

 85 karl  1.12       <td width="10%">0.7</td>

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

 87 karl  1.12       <td width="37%">Karl</td>
 88                  <td width="117%">Change Class names, Add definitions, Add Architecture documentation.</td>
 89              </tr>  

 90 karl  1.16   <tr>
 91                  <td width="10%">0.75</td>
 92                  <td width="13%">02/25/01</td>
 93                  <td width="37%">Karl</td>
 94                  <td width="117%">Create Frames Version and redo structure..</td>
 95              </tr> 
 96              <tr>
 97                  <td width="10%">0.8</td>
 98                  <td width="13%">03/12/2001</td>
 99                  <td width="37%">Karl</td>
100                  <td width="117%">Generate for 0.8 Release.</td>
101              </tr> 
102                <tr>

103 karl  1.17         <td width="10%">0.85</td>

104 karl  1.16         <td width="13%">03/12/2001</td>

105 karl  1.13         <td width="37%">Karl</td>

106 karl  1.17         <td width="117%">Generate for 0.8.5 Release.</td>

107 karl  1.13   </tr> 

108 karl  1.17   <tr>
109                      <td width="10%">0.91</td>
110                      <td width="13%">05/03/2001</td>
111                      <td width="37%">Karl</td>
112                      <td width="117%">Generate for 0.9 Pegasus Code</td>

113 karl  1.18   </tr> 
114              <tr>
115                      <td width="10%">0.97</td>
116                      <td width="13%">05/21/2001</td>
117                      <td width="37%">Karl</td>
118                      <td width="117%">Generate for 0.97 Pegasus Code</td>
119              </tr>

120 karl  1.17 </table></p>
121            */

122 karl  1.5  

123 karl  1.17 /* The following is the complete file hieaarchy for this document.

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

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

127 karl  1.1  */

128 karl  1.13 

129 karl  1.5      //@Include: objectives.dxx

130 karl  1.1      //@Include: overview.dxx
131                //@Include: credits.dxx
132                //@Include: Architecture.dxx
133                //@Include: Components.dxx

134 karl  1.5      //@Include: Utilization.dxx

135 karl  1.13         //@{	    
136                	//@Include: availability.dxx
137                	//@Include: installation.dxx
138                	//@Include: operation.dxx
139                	//@Include: CIMClients.dxx
140                	//@Include: PegasusProviders.dxx
141                	//@Include: MOFCompiler.dxx    
142                    //@}

143 karl  1.14     //@Include: programming.dxx

144 karl  1.12         //@{

145 karl  1.14 	   //@Include: CIMObjects.dxx
146            	   //@Include: CIMOBJECTTable.dxx
147            	   //@Include: Classes.dxx

148 karl  1.12            //@{ 

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

150 karl  1.9      		//@Include: ..\..\src\Pegasus\Common\CIMClass.h
151                		//@Include: ..\..\src\Pegasus\Common\CIMDateTime.h
152                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h

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

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

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

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

169 karl  1.17          	//@Include: ..\..\src\Pegasus\Common\Stack.h 
170                     	//@Include: ..\..\src\Pegasus\Common\CIMName.h 
171                         	//@Include: ..\..\src\Pegasus\Common\StopWatch.h 
172                     	//@Include: ..\..\src\Pegasus\Common\TimeValue.h 
173            
174            

175 karl  1.12         	//@{

176 karl  1.13 		//@Include: Exceptions.dxx  

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

178 karl  1.12         	//@}
179                        //@}

180 karl  1.11         	

181 karl  1.5  	//@}

182 karl  1.1      //@Include: Interfaces.dxx
183                   //@{

184 karl  1.8  	    //@Include: CIMOperations.dxx
185            	        //@{

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

187 karl  1.8  		//@}

188 karl  1.1  	    //@Include: ClientInterfaces.dxx   
189            		//@{    

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

191 karl  1.1  		//@}
192                	   //@Include: ProviderInterfaces.dxx

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

196 karl  1.1      	   //@Include: ServiceInterfaces.dxx

197 karl  1.7      	   //@Include: RepositoryInterfaces.dxx

198 karl  1.8      	   	//@{

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

200 karl  1.8  		//@}

201 karl  1.1         //@}

202 karl  1.8      

203 karl  1.5      //@Include: ProviderWriting.dxx

204 karl  1.1      //@Include: definitions.dxx
205                //@Include: Examples.dxx

206 karl  1.12     	
207                	//@{
208                		//@Include: ExamplesClient.dxx
209                 		//@Include: ExamplesProvider.dxx  
210                	//@}

211 karl  1.8      //@Include: references.dxx

212 karl  1.5      //@Include: FAQ.dxx

213 karl  1.13  

214 karl  1.1