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.7 	Revision 1.6  2001/02/02 19:38:23  karl
  5           	add graphic
  6           	

  7 karl  1.6 	Revision 1.5  2001/02/02 18:48:20  karl
  8           	Doc++ expansion
  9           	

 10 karl  1.5 	Revision 1.4  2001/01/30 23:38:18  karl
 11           	Add to documentation
 12           	

 13 karl  1.4 	Revision 1.3  2001/01/24 17:17:05  karl
 14           	add Doc++ comments
 15           	

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

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

 21 karl  1.1 	

 22 karl  1.2 	
 23           	$Author: karl $

 24 karl  1.1 */
 25           /** @name Pegasus
 26           

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

 28 karl  1.1 

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

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

 32 karl  1.6 

 33 karl  1.5 An open source implementation of the manageability environment defined by the DMTF WBEM standards.

 34 karl  1.1 

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

 36 karl  1.1 

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

 38 karl  1.1 

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

 40 karl  1.1 

 41 karl  1.5 Within this manual you should 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 karl  1.1 available to interface with Pegasus as providers, consumers, and services.

 48 karl  1.5 </UL>
 49           

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

 51 karl  1.5 
 52           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}.

 53 karl  1.1 

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

 55 karl  1.1 

 56 karl  1.7 
 57           

 58 karl  1.1 This version of the Pegasus User Manual was created at \today
 59           */

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

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

 77 karl  1.2     Datetime - Done Comments need more work
 78               String - Moved but comments need work
 79               Name
 80               Type

 81 karl  1.4     Property
 82               Reference
 83               Value
 84               Union  - First comments in

 85 karl  1.1 */
 86           //@{

 87 karl  1.5     //@Include: objectives.dxx

 88 karl  1.1     //@Include: overview.dxx
 89               //@Include: credits.dxx
 90               //@Include: Architecture.dxx
 91               //@Include: Components.dxx

 92 karl  1.5     //@Include: Utilization.dxx
 93               //@Include: CIMOBJECTS.dxx
 94                    //@{ 
 95               		//@Include: ..\..\src\Pegasus\Common\Array.h
 96               		//@Include: ..\..\src\Pegasus\Common\ClassDecl.h
 97               		//@Include: ..\..\src\Pegasus\Common\DateTime.h
 98               		//@Include: ..\..\src\Pegasus\Common\QualifierDecl.h
 99               		//@Include: ..\..\src\Pegasus\Common\String.h
100               		//@Include: ..\..\src\Pegasus\Common\Type.h
101               		//@Include: ..\..\src\Pegasus\Common\InstanceDecl.h
102               		//@Include: ..\..\src\Pegasus\Common\Value.h
103               		//@Include: ..\..\src\Pegasus\Common\Property.h
104               		//@Include: ..\..\src\Pegasus\Common\Scope.h
105               		//@Include: ..\..\src\Pegasus\Common\Reference.h
106               		//@Include: ..\..\src\Pegasus\Common\QualifierNames.h
107               		//@Include: ..\..\src\Pegasus\Common\Qualifier.h
108               		//@Include: ..\..\src\Pegasus\Common\Name.h
109               		//@Include: ..\..\src\Pegasus\Common\Method.h
110               		//@Include: ..\..\src\Pegasus\Common\Flavor.h
111               		//@Include: ..\..\src\Pegasus\Common\Char16.h
112           	//@}

113 karl  1.1     //@Include: Interfaces.dxx
114                  //@{
115           	    //@Include: ClientInterfaces.dxx   
116           		//@{    

117 karl  1.6 		    //@Include: ..\..\src\Pegasus\Common\operations.h

118 karl  1.1 		//@}
119               	   //@Include: ProviderInterfaces.dxx
120               	 
121               	   //@Include: ServiceInterfaces.dxx

122 karl  1.7     	   //@Include: RepositoryInterfaces.dxx

123 karl  1.1        //@}
124               //@Include: references.dxx

125 karl  1.5     //@Include: ProviderWriting.dxx

126 karl  1.1     //@Include: definitions.dxx
127               //@Include: Examples.dxx

128 karl  1.5     //@Include: FAQ.dxx

129 karl  1.1 //@}
130           
131           
132