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.8 	Revision 1.7  2001/02/05 14:14:00  karl
  5           	doc++ extension for respository
  6           	

  7 karl  1.7 	Revision 1.6  2001/02/02 19:38:23  karl
  8           	add graphic
  9           	

 10 karl  1.6 	Revision 1.5  2001/02/02 18:48:20  karl
 11           	Doc++ expansion
 12           	

 13 karl  1.5 	Revision 1.4  2001/01/30 23:38:18  karl
 14           	Add to documentation
 15           	

 16 karl  1.4 	Revision 1.3  2001/01/24 17:17:05  karl
 17           	add Doc++ comments
 18           	

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

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

 24 karl  1.1 	

 25 karl  1.2 	
 26           	$Author: karl $

 27 karl  1.1 */
 28           /** @name Pegasus
 29           

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

 31 karl  1.1 

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

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

 35 karl  1.6 

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

 37 karl  1.1 

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

 39 karl  1.1 

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

 41 karl  1.1 

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

 43 karl  1.1 

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

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

 51 karl  1.5 </UL>
 52           

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

 54 karl  1.5 
 55           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}.

 56 karl  1.1 

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

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

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

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

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

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

 86 karl  1.1 */
 87           //@{

 88 karl  1.5     //@Include: objectives.dxx

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

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

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

116 karl  1.8 	    //@Include: CIMOperations.dxx
117           	        //@{
118           		    //@Include: ..\..\src\Pegasus\Common\Operations.h
119           		//@}

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

122 karl  1.8 		    //@Include: ..\..\src\Pegasus\Client\Client.h

123 karl  1.1 		//@}
124               	   //@Include: ProviderInterfaces.dxx
125               	 
126               	   //@Include: ServiceInterfaces.dxx

127 karl  1.7     	   //@Include: RepositoryInterfaces.dxx

128 karl  1.8     	   	//@{
129           		    //@Include: ..\..\src\Pegasus\Repository\Repository.h
130           		//@}

131 karl  1.1        //@}

132 karl  1.8     

133 karl  1.5     //@Include: ProviderWriting.dxx

134 karl  1.1     //@Include: definitions.dxx
135               //@Include: Examples.dxx

136 karl  1.8     //@Include: references.dxx

137 karl  1.5     //@Include: FAQ.dxx

138 karl  1.1 //@}
139           
140           
141