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.17 	Revision 1.16  2001/03/29 16:41:38  karl
  5            	Add Class Tree Stuff
  6            	

  7 karl  1.16 	Revision 1.15  2001/03/23 13:16:33  karl
  8            	minor corrections
  9            	

 10 karl  1.15 	Revision 1.14  2001/02/25 18:04:45  karl
 11            	extend programing deffinitions
 12            	

 13 karl  1.14 	Revision 1.13  2001/02/25 15:01:40  karl
 14            	Add frames to manual
 15            	

 16 karl  1.6  	

 17 karl  1.3  	

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

 20 karl  1.1  	

 21 karl  1.2  	
 22            	$Author: karl $

 23 karl  1.1  */

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

 26 karl  1.12 */
 27            /** @name Introduction
 28            
 29            <CENTER><FONT Size=+4>Welcome to PEGASUS</FONT></CENTER>

 30 karl  1.1  

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

 32 karl  1.1  

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

 61 karl  1.12   <CAPTION>Revision History</CAPTION>
 62              <tr>
 63                <td width="10%"><b>Versions</b></td>
 64                <td width="13%"><b>Date</b></td>
 65                <td width="37%"><b>Author</b></td>
 66                <td width="117%"><b>Comments</b></td>
 67              </tr>
 68              <tr>
 69                <td width="10%">0.5</td>

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

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

 74 karl  1.16   <tr>

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

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

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

 80 karl  1.16   <tr>

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

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

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

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

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

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

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

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

103 karl  1.13   </tr> 

104 karl  1.17   <tr>
105                      <td width="10%">0.91</td>
106                      <td width="13%">05/03/2001</td>
107                      <td width="37%">Karl</td>
108                      <td width="117%">Generate for 0.9 Pegasus Code</td>
109              </tr
110            </table></p>
111            */

112 karl  1.5  

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

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

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

117 karl  1.1  */

118 karl  1.13 

119 karl  1.5      //@Include: objectives.dxx

120 karl  1.1      //@Include: overview.dxx
121                //@Include: credits.dxx
122                //@Include: Architecture.dxx
123                //@Include: Components.dxx

124 karl  1.5      //@Include: Utilization.dxx

125 karl  1.13         //@{	    
126                	//@Include: availability.dxx
127                	//@Include: installation.dxx
128                	//@Include: operation.dxx
129                	//@Include: CIMClients.dxx
130                	//@Include: PegasusProviders.dxx
131                	//@Include: MOFCompiler.dxx    
132                    //@}

133 karl  1.14     //@Include: programming.dxx

134 karl  1.12         //@{

135 karl  1.14 	   //@Include: CIMObjects.dxx
136            	   //@Include: CIMOBJECTTable.dxx
137            	   //@Include: Classes.dxx

138 karl  1.12            //@{ 

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

140 karl  1.9      		//@Include: ..\..\src\Pegasus\Common\CIMClass.h
141                		//@Include: ..\..\src\Pegasus\Common\CIMDateTime.h
142                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h

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

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

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

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

159 karl  1.17          	//@Include: ..\..\src\Pegasus\Common\Stack.h 
160                     	//@Include: ..\..\src\Pegasus\Common\CIMName.h 
161                         	//@Include: ..\..\src\Pegasus\Common\StopWatch.h 
162                     	//@Include: ..\..\src\Pegasus\Common\TimeValue.h 
163            
164            

165 karl  1.12         	//@{

166 karl  1.13 		//@Include: Exceptions.dxx  

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

168 karl  1.12         	//@}
169                        //@}

170 karl  1.11         	

171 karl  1.5  	//@}

172 karl  1.1      //@Include: Interfaces.dxx
173                   //@{

174 karl  1.8  	    //@Include: CIMOperations.dxx
175            	        //@{

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

177 karl  1.8  		//@}

178 karl  1.1  	    //@Include: ClientInterfaces.dxx   
179            		//@{    

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

181 karl  1.1  		//@}
182                	   //@Include: ProviderInterfaces.dxx

183 karl  1.9      	   	//@{
184            		    //@Include: ..\..\src\Pegasus\Provider\CIMProvider.h
185            		//@}  	 

186 karl  1.1      	   //@Include: ServiceInterfaces.dxx

187 karl  1.7      	   //@Include: RepositoryInterfaces.dxx

188 karl  1.8      	   	//@{

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

190 karl  1.8  		//@}

191 karl  1.1         //@}

192 karl  1.8      

193 karl  1.5      //@Include: ProviderWriting.dxx

194 karl  1.1      //@Include: definitions.dxx
195                //@Include: Examples.dxx

196 karl  1.12     	
197                	//@{
198                		//@Include: ExamplesClient.dxx
199                 		//@Include: ExamplesProvider.dxx  
200                	//@}

201 karl  1.8      //@Include: references.dxx

202 karl  1.5      //@Include: FAQ.dxx

203 karl  1.13  

204 karl  1.1