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.5 	Revision 1.4  2001/01/30 23:38:18  karl
  5           	Add to documentation
  6           	

  7 karl  1.4 	Revision 1.3  2001/01/24 17:17:05  karl
  8           	add Doc++ comments
  9           	

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

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

 15 karl  1.1 	

 16 karl  1.2 	
 17           	$Author: karl $

 18 karl  1.1 */
 19           /** @name Pegasus
 20           

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

 22 karl  1.1 

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

 24 karl  1.1 

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

 26 karl  1.1 

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

 28 karl  1.1 

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

 30 karl  1.1 

 31 karl  1.5 Within this manual you should find:
 32           <UL>
 33           <LI>Information on the installation and operation of the broker and additional components.
 34           <LI> A basic defintion of the architecture and function of Pegasus.
 35           <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.
 36           <LI>A number of defintions of additional code that is

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

 38 karl  1.5 </UL>
 39           
 40           ATTN: Give a description of the sections and what they accomplish with hotlinks to each.
 41           
 42           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}.

 43 karl  1.1 

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

 45 karl  1.1 
 46           This version of the Pegasus User Manual was created at \today
 47           
 48           
 49           */
 50           /* Change list to mvoe this into repository

 51 karl  1.2     Datetime - Done Comments need more work
 52               String - Moved but comments need work
 53               Name
 54               Type

 55 karl  1.4     Property
 56               Reference
 57               Value
 58               Union  - First comments in

 59 karl  1.1 */
 60           //@{

 61 karl  1.5     //@Include: objectives.dxx

 62 karl  1.1     //@Include: overview.dxx
 63               //@Include: credits.dxx
 64               //@Include: Architecture.dxx
 65               //@Include: Components.dxx

 66 karl  1.5     //@Include: Utilization.dxx
 67               //@Include: CIMOBJECTS.dxx
 68                    //@{ 
 69               		//@Include: ..\..\src\Pegasus\Common\Array.h
 70               		//@Include: ..\..\src\Pegasus\Common\ClassDecl.h
 71               		//@Include: ..\..\src\Pegasus\Common\DateTime.h
 72               		//@Include: ..\..\src\Pegasus\Common\QualifierDecl.h
 73               		//@Include: ..\..\src\Pegasus\Common\String.h
 74               		//@Include: ..\..\src\Pegasus\Common\Type.h
 75               		//@Include: ..\..\src\Pegasus\Common\InstanceDecl.h
 76               		//@Include: ..\..\src\Pegasus\Common\Value.h
 77               		//@Include: ..\..\src\Pegasus\Common\Property.h
 78               		//@Include: ..\..\src\Pegasus\Common\Scope.h
 79               		//@Include: ..\..\src\Pegasus\Common\Reference.h
 80               		//@Include: ..\..\src\Pegasus\Common\QualifierNames.h
 81               		//@Include: ..\..\src\Pegasus\Common\Qualifier.h
 82               		//@Include: ..\..\src\Pegasus\Common\Name.h
 83               		//@Include: ..\..\src\Pegasus\Common\Method.h
 84               		//@Include: ..\..\src\Pegasus\Common\Flavor.h
 85               		//@Include: ..\..\src\Pegasus\Common\Char16.h
 86           	//@}

 87 karl  1.1     //@Include: Interfaces.dxx
 88                  //@{
 89           	    //@Include: ClientInterfaces.dxx   
 90           		//@{    

 91 karl  1.5 		    //@Include: ..\..\src\Pegasus\Common\operations

 92 karl  1.1 		//@}
 93               	   //@Include: ProviderInterfaces.dxx
 94               	 
 95               	   //@Include: ServiceInterfaces.dxx
 96                  //@}
 97           

 98 karl  1.5 

 99 karl  1.1     //@Include: references.dxx

100 karl  1.5     //@Include: ProviderWriting.dxx

101 karl  1.1     //@Include: definitions.dxx
102               //@Include: Examples.dxx

103 karl  1.5     //@Include: FAQ.dxx

104 karl  1.1 //@}
105           
106           
107