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.10 	Revision 1.9  2001/02/19 21:48:40  karl
  5            	CIMxx Class and file name chages
  6            	

  7 karl  1.9  	Revision 1.8  2001/02/06 17:02:13  karl
  8            	rearrange documentation for interfaces
  9            	

 10 karl  1.8  	Revision 1.7  2001/02/05 14:14:00  karl
 11            	doc++ extension for respository
 12            	

 13 karl  1.7  	Revision 1.6  2001/02/02 19:38:23  karl
 14            	add graphic
 15            	

 16 karl  1.6  	Revision 1.5  2001/02/02 18:48:20  karl
 17            	Doc++ expansion
 18            	

 19 karl  1.5  	Revision 1.4  2001/01/30 23:38:18  karl
 20            	Add to documentation
 21            	

 22 karl  1.4  	Revision 1.3  2001/01/24 17:17:05  karl
 23            	add Doc++ comments
 24            	

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

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

 30 karl  1.1  	

 31 karl  1.2  	
 32            	$Author: karl $

 33 karl  1.1  */
 34            /** @name Pegasus
 35            

 36 karl  1.5  <STRONG><B>Welcome to PEGASUS</B></STRONG>

 37 karl  1.1  

 38 karl  1.6  <P><B>DRAFT FOR REVIEW</B>

 39 karl  1.10 <P>Version 0.5, 01/02/02</P>
 40            <P>Version 0.6  01/04/02 - Clean up the API defintions. and Add repository section.
 41            <P>Version 0.7  02/20/02 - Change Class names, Add definitions, Add Architecture documentation.

 42 karl  1.6  

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

 44 karl  1.1  

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

 46 karl  1.1  

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

 48 karl  1.1  

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

 50 karl  1.1  

 51 karl  1.5  Within this manual you should find:
 52            <UL>
 53            <LI>Information on the installation and operation of the broker and additional components.
 54            <LI> A basic defintion of the architecture and function of Pegasus.
 55            <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.
 56            <LI>A number of defintions of additional code that is

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

 58 karl  1.5  </UL>
 59            

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

 61 karl  1.5  
 62            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}.

 63 karl  1.1  

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

 65 karl  1.1  
 66            This version of the Pegasus User Manual was created at \today
 67            */

 68 karl  1.7  
 69            /*
 70            Table stuff to see if it worksl
 71            
 72            <table border cellspacing=0 cellpadding=5>
 73            <tr>
 74            <td colspan=2 rowspan=2></td>
 75            <th colspan=2 align=center>Preferences></th>
 76            </tr>
 77            <tr>
 78            <th>Eating Kumquats</th>
 79            <th>poke int he eye</th>
 80            </tr>
 81            </table>
 82            */
 83            

 84 karl  1.1  /* Change list to mvoe this into repository

 85 karl  1.2      Datetime - Done Comments need more work
 86                String - Moved but comments need work
 87                Name
 88                Type

 89 karl  1.4      Property
 90                Reference
 91                Value
 92                Union  - First comments in

 93 karl  1.1  */
 94            //@{

 95 karl  1.5      //@Include: objectives.dxx

 96 karl  1.1      //@Include: overview.dxx
 97                //@Include: credits.dxx
 98                //@Include: Architecture.dxx
 99                //@Include: Components.dxx

100 karl  1.5      //@Include: Utilization.dxx
101                //@Include: CIMOBJECTS.dxx
102                     //@{ 
103                		//@Include: ..\..\src\Pegasus\Common\Array.h

104 karl  1.9      		//@Include: ..\..\src\Pegasus\Common\CIMClass.h
105                		//@Include: ..\..\src\Pegasus\Common\CIMDateTime.h
106                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h

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

108 karl  1.9      		//@Include: ..\..\src\Pegasus\Common\CIMType.h
109                		//@Include: ..\..\src\Pegasus\Common\CIMInstance.h
110                		//@Include: ..\..\src\Pegasus\Common\CIMValue.h
111                		//@Include: ..\..\src\Pegasus\Common\CIMParameter.h
112                		//@Include: ..\..\src\Pegasus\Common\CIMProperty.h
113                		//@Include: ..\..\src\Pegasus\Common\CIMScope.h
114                		//@Include: ..\..\src\Pegasus\Common\CIMReference.h
115                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierList.h    		
116                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierNames.h
117                		//@Include: ..\..\src\Pegasus\Common\CIMQualifier.h
118                		//@Include: ..\..\src\Pegasus\Common\CIMName.h
119                		//@Include: ..\..\src\Pegasus\Common\CIMMethod.h
120                		//@Include: ..\..\src\Pegasus\Common\CIMFlavor.h

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

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

123 karl  1.5  	//@}

124 karl  1.1      //@Include: Interfaces.dxx
125                   //@{

126 karl  1.8  	    //@Include: CIMOperations.dxx
127            	        //@{

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

129 karl  1.8  		//@}

130 karl  1.1  	    //@Include: ClientInterfaces.dxx   
131            		//@{    

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

133 karl  1.1  		//@}
134                	   //@Include: ProviderInterfaces.dxx

135 karl  1.9      	   	//@{
136            		    //@Include: ..\..\src\Pegasus\Provider\CIMProvider.h
137            		//@}  	 

138 karl  1.1      	   //@Include: ServiceInterfaces.dxx

139 karl  1.7      	   //@Include: RepositoryInterfaces.dxx

140 karl  1.8      	   	//@{

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

142 karl  1.8  		//@}

143 karl  1.1         //@}

144 karl  1.8      

145 karl  1.5      //@Include: ProviderWriting.dxx

146 karl  1.1      //@Include: definitions.dxx
147                //@Include: Examples.dxx

148 karl  1.8      //@Include: references.dxx

149 karl  1.5      //@Include: FAQ.dxx

150 karl  1.1  //@}
151            
152            
153