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.9 	Revision 1.8  2001/02/06 17:02:13  karl
  5           	rearrange documentation for interfaces
  6           	

  7 karl  1.8 	Revision 1.7  2001/02/05 14:14:00  karl
  8           	doc++ extension for respository
  9           	

 10 karl  1.7 	Revision 1.6  2001/02/02 19:38:23  karl
 11           	add graphic
 12           	

 13 karl  1.6 	Revision 1.5  2001/02/02 18:48:20  karl
 14           	Doc++ expansion
 15           	

 16 karl  1.5 	Revision 1.4  2001/01/30 23:38:18  karl
 17           	Add to documentation
 18           	

 19 karl  1.4 	Revision 1.3  2001/01/24 17:17:05  karl
 20           	add Doc++ comments
 21           	

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

 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           /** @name Pegasus
 32           

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

 34 karl  1.1 

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

 36 karl  1.7 <P>Version 1.5, 01/02/02</P>
 37           <P>Version 1.6  01/04/02 - Clean up the API defintions. and Add repository section.

 38 karl  1.6 

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

 40 karl  1.1 

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

 42 karl  1.1 

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

 44 karl  1.1 

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

 46 karl  1.1 

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

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

 54 karl  1.5 </UL>
 55           

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

 57 karl  1.5 
 58           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}.

 59 karl  1.1 

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

 61 karl  1.1 
 62           This version of the Pegasus User Manual was created at \today
 63           */

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

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

 81 karl  1.2     Datetime - Done Comments need more work
 82               String - Moved but comments need work
 83               Name
 84               Type

 85 karl  1.4     Property
 86               Reference
 87               Value
 88               Union  - First comments in

 89 karl  1.1 */
 90           //@{

 91 karl  1.5     //@Include: objectives.dxx

 92 karl  1.1     //@Include: overview.dxx
 93               //@Include: credits.dxx
 94               //@Include: Architecture.dxx
 95               //@Include: Components.dxx

 96 karl  1.5     //@Include: Utilization.dxx
 97               //@Include: CIMOBJECTS.dxx
 98                    //@{ 
 99               		//@Include: ..\..\src\Pegasus\Common\Array.h

100 karl  1.9     		//@Include: ..\..\src\Pegasus\Common\CIMClass.h
101               		//@Include: ..\..\src\Pegasus\Common\CIMDateTime.h
102               		//@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h

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

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

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

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

119 karl  1.5 	//@}

120 karl  1.1     //@Include: Interfaces.dxx
121                  //@{

122 karl  1.8 	    //@Include: CIMOperations.dxx
123           	        //@{

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

125 karl  1.8 		//@}

126 karl  1.1 	    //@Include: ClientInterfaces.dxx   
127           		//@{    

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

129 karl  1.1 		//@}
130               	   //@Include: ProviderInterfaces.dxx

131 karl  1.9     	   	//@{
132           		    //@Include: ..\..\src\Pegasus\Provider\CIMProvider.h
133           		//@}  	 

134 karl  1.1     	   //@Include: ServiceInterfaces.dxx

135 karl  1.7     	   //@Include: RepositoryInterfaces.dxx

136 karl  1.8     	   	//@{

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

138 karl  1.8 		//@}

139 karl  1.1        //@}

140 karl  1.8     

141 karl  1.5     //@Include: ProviderWriting.dxx

142 karl  1.1     //@Include: definitions.dxx
143               //@Include: Examples.dxx

144 karl  1.8     //@Include: references.dxx

145 karl  1.5     //@Include: FAQ.dxx

146 karl  1.1 //@}
147           
148           
149