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.19 	Revision 1.18  2001/05/21 17:33:33  karl
  5            	Update version number
  6            	

  7 karl  1.18 	Revision 1.17  2001/05/05 10:07:23  karl
  8            	
  9            	no Change
 10            	

 11 karl  1.17 	Revision 1.16  2001/03/29 16:41:38  karl
 12            	Add Class Tree Stuff
 13            	

 14 karl  1.16 	Revision 1.15  2001/03/23 13:16:33  karl
 15            	minor corrections
 16            	

 17 karl  1.15 	Revision 1.14  2001/02/25 18:04:45  karl
 18            	extend programing deffinitions
 19            	

 20 karl  1.14 	Revision 1.13  2001/02/25 15:01:40  karl
 21            	Add frames to manual
 22            	

 23 karl  1.6  	

 24 karl  1.3  	

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

 27 karl  1.1  	

 28 karl  1.2  	
 29            	$Author: karl $

 30 karl  1.1  */

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

 33 karl  1.12 */
 34            /** @name Introduction
 35            
 36            <CENTER><FONT Size=+4>Welcome to PEGASUS</FONT></CENTER>

 37 karl  1.1  

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

 39 karl  1.19 <SMALL><CENTER>version 0.97.2</CENTER></SMALL>

 40 karl  1.1  

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

 66 karl  1.19 

 67 karl  1.17 */

 68 karl  1.19 //@Include:DocumentHistory.dxx
 69            /* The following is the complete file hiearchy for this document.

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

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

 73 karl  1.1  */

 74 karl  1.13 

 75 karl  1.5      //@Include: objectives.dxx

 76 karl  1.1      //@Include: overview.dxx
 77                //@Include: credits.dxx
 78                //@Include: Architecture.dxx
 79                //@Include: Components.dxx

 80 karl  1.5      //@Include: Utilization.dxx

 81 karl  1.13         //@{	    
 82                	//@Include: availability.dxx
 83                	//@Include: installation.dxx
 84                	//@Include: operation.dxx
 85                	//@Include: CIMClients.dxx
 86                	//@Include: PegasusProviders.dxx
 87                	//@Include: MOFCompiler.dxx    
 88                    //@}

 89 karl  1.14     //@Include: programming.dxx

 90 karl  1.12         //@{

 91 karl  1.14 	   //@Include: CIMObjects.dxx
 92            	   //@Include: CIMOBJECTTable.dxx
 93            	   //@Include: Classes.dxx

 94 karl  1.12            //@{ 

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

 96 karl  1.9      		//@Include: ..\..\src\Pegasus\Common\CIMClass.h
 97                		//@Include: ..\..\src\Pegasus\Common\CIMDateTime.h
 98                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h

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

100 karl  1.9      		//@Include: ..\..\src\Pegasus\Common\CIMType.h
101                		//@Include: ..\..\src\Pegasus\Common\CIMInstance.h
102                		//@Include: ..\..\src\Pegasus\Common\CIMValue.h
103                		//@Include: ..\..\src\Pegasus\Common\CIMParameter.h
104                		//@Include: ..\..\src\Pegasus\Common\CIMProperty.h
105                		//@Include: ..\..\src\Pegasus\Common\CIMScope.h
106                		//@Include: ..\..\src\Pegasus\Common\CIMReference.h
107                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierList.h    		
108                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierNames.h
109                		//@Include: ..\..\src\Pegasus\Common\CIMQualifier.h
110                		//@Include: ..\..\src\Pegasus\Common\CIMName.h
111                		//@Include: ..\..\src\Pegasus\Common\CIMMethod.h
112                		//@Include: ..\..\src\Pegasus\Common\CIMFlavor.h

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

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

115 karl  1.17          	//@Include: ..\..\src\Pegasus\Common\Stack.h 
116                     	//@Include: ..\..\src\Pegasus\Common\CIMName.h 
117                         	//@Include: ..\..\src\Pegasus\Common\StopWatch.h 
118                     	//@Include: ..\..\src\Pegasus\Common\TimeValue.h 
119            
120            

121 karl  1.12         	//@{

122 karl  1.13 		//@Include: Exceptions.dxx  

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

124 karl  1.12         	//@}
125                        //@}

126 karl  1.11         	

127 karl  1.5  	//@}

128 karl  1.1      //@Include: Interfaces.dxx
129                   //@{

130 karl  1.8  	    //@Include: CIMOperations.dxx
131            	        //@{

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

133 karl  1.8  		//@}

134 karl  1.1  	    //@Include: ClientInterfaces.dxx   
135            		//@{    

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

137 karl  1.1  		//@}
138                	   //@Include: ProviderInterfaces.dxx

139 karl  1.9      	   	//@{
140            		    //@Include: ..\..\src\Pegasus\Provider\CIMProvider.h
141            		//@}  	 

142 karl  1.1      	   //@Include: ServiceInterfaces.dxx

143 karl  1.7      	   //@Include: RepositoryInterfaces.dxx

144 karl  1.8      	   	//@{

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

146 karl  1.8  		//@}

147 karl  1.1         //@}

148 karl  1.8      

149 karl  1.5      //@Include: ProviderWriting.dxx

150 karl  1.1      //@Include: definitions.dxx
151                //@Include: Examples.dxx

152 karl  1.12     	
153                	//@{
154                		//@Include: ExamplesClient.dxx
155                 		//@Include: ExamplesProvider.dxx  
156                	//@}

157 karl  1.8      //@Include: references.dxx

158 karl  1.5      //@Include: FAQ.dxx

159 karl  1.13  

160 karl  1.1