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.19.2.1 	Revision 1.19  2001/05/27 10:11:50  karl
  5                	Clean up object tables
  6                	

  7 karl  1.19     	Revision 1.18  2001/05/21 17:33:33  karl
  8                	Update version number
  9                	

 10 karl  1.2      	
 11                	$Author: karl $

 12 karl  1.1      */

 13 karl  1.13     /* do not change the following Name.  Used in the Frame definition.
 14                If you change it, the HTML Frame must also be changed.

 15 karl  1.12     */
 16                /** @name Introduction
 17                
 18                <CENTER><FONT Size=+4>Welcome to PEGASUS</FONT></CENTER>

 19 karl  1.1      

 20 karl  1.12     <P><B><CENTER>DRAFT FOR REVIEW</CENTER></B>

 21 karl  1.19.2.1 <SMALL><CENTER>version 1.01 13 September 2001</CENTER></SMALL>

 22 karl  1.1      

 23 karl  1.17     Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.
 24                
 25                <B>This Document</B>
 26                
 27                <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                
 29                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                
 31                Within this manual you will 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                available to interface with Pegasus as providers, consumers, and services.
 38                </UL>
 39                
 40                <B>ATTN:</B> We need to 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 will be available from The Open Group (\URL{http://www.opengroup.org/management}).
 43                
 44 karl  1.17     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                
 46                This version of the Pegasus User Manual was created at \today
 47                */

 48 karl  1.19     

 49 karl  1.17     */

 50 karl  1.19     //@Include:DocumentHistory.dxx
 51                /* The following is the complete file hiearchy for this document.

 52 karl  1.13        We have tried to keep all file references in only this one place

 53 karl  1.12        to make modification easier.  In the future, please keep the
 54                   references here and text in the individual files.

 55 karl  1.1      */

 56 karl  1.13     

 57 karl  1.5          //@Include: objectives.dxx

 58 karl  1.1          //@Include: overview.dxx
 59                    //@Include: credits.dxx
 60                    //@Include: Architecture.dxx
 61                    //@Include: Components.dxx

 62 karl  1.5          //@Include: Utilization.dxx

 63 karl  1.13             //@{	    
 64                    	//@Include: availability.dxx
 65                    	//@Include: installation.dxx
 66                    	//@Include: operation.dxx
 67                    	//@Include: CIMClients.dxx
 68                    	//@Include: PegasusProviders.dxx
 69                    	//@Include: MOFCompiler.dxx    
 70                        //@}

 71 karl  1.14         //@Include: programming.dxx

 72 karl  1.12             //@{

 73 karl  1.14     	   //@Include: CIMObjects.dxx
 74                	   //@Include: CIMOBJECTTable.dxx
 75                	   //@Include: Classes.dxx

 76 karl  1.12                //@{ 

 77 karl  1.5          		//@Include: ..\..\src\Pegasus\Common\Array.h

 78 karl  1.9          		//@Include: ..\..\src\Pegasus\Common\CIMClass.h
 79                    		//@Include: ..\..\src\Pegasus\Common\CIMDateTime.h
 80                    		//@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h

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

 82 karl  1.9          		//@Include: ..\..\src\Pegasus\Common\CIMType.h
 83                    		//@Include: ..\..\src\Pegasus\Common\CIMInstance.h
 84                    		//@Include: ..\..\src\Pegasus\Common\CIMValue.h
 85                    		//@Include: ..\..\src\Pegasus\Common\CIMParameter.h
 86                    		//@Include: ..\..\src\Pegasus\Common\CIMProperty.h
 87                    		//@Include: ..\..\src\Pegasus\Common\CIMScope.h
 88                    		//@Include: ..\..\src\Pegasus\Common\CIMReference.h
 89                    		//@Include: ..\..\src\Pegasus\Common\CIMQualifierList.h    		
 90                    		//@Include: ..\..\src\Pegasus\Common\CIMQualifierNames.h
 91                    		//@Include: ..\..\src\Pegasus\Common\CIMQualifier.h
 92                    		//@Include: ..\..\src\Pegasus\Common\CIMName.h
 93                    		//@Include: ..\..\src\Pegasus\Common\CIMMethod.h
 94                    		//@Include: ..\..\src\Pegasus\Common\CIMFlavor.h

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

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

 97 karl  1.17              	//@Include: ..\..\src\Pegasus\Common\Stack.h 
 98                         	//@Include: ..\..\src\Pegasus\Common\CIMName.h 
 99                             	//@Include: ..\..\src\Pegasus\Common\StopWatch.h 
100                         	//@Include: ..\..\src\Pegasus\Common\TimeValue.h 
101                
102                

103 karl  1.12             	//@{

104 karl  1.13     		//@Include: Exceptions.dxx  

105 karl  1.11             	//@Include: ..\..\src\Pegasus\Common\Exception.h

106 karl  1.12             	//@}
107                            //@}

108 karl  1.11             	

109 karl  1.5      	//@}

110 karl  1.1          //@Include: Interfaces.dxx
111                       //@{

112 karl  1.8      	    //@Include: CIMOperations.dxx
113                	        //@{

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

115 karl  1.8      		//@}

116 karl  1.1      	    //@Include: ClientInterfaces.dxx   
117                		//@{    

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

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

121 karl  1.9          	   	//@{
122                		    //@Include: ..\..\src\Pegasus\Provider\CIMProvider.h
123                		//@}  	 

124 karl  1.1          	   //@Include: ServiceInterfaces.dxx

125 karl  1.7          	   //@Include: RepositoryInterfaces.dxx

126 karl  1.8          	   	//@{

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

128 karl  1.8      		//@}

129 karl  1.1             //@}

130 karl  1.8          

131 karl  1.5          //@Include: ProviderWriting.dxx

132 karl  1.1          //@Include: definitions.dxx
133                    //@Include: Examples.dxx

134 karl  1.12         	
135                    	//@{
136                    		//@Include: ExamplesClient.dxx
137                     		//@Include: ExamplesProvider.dxx  
138                    	//@}

139 karl  1.8          //@Include: references.dxx

140 karl  1.5          //@Include: FAQ.dxx

141 karl  1.13      

142 karl  1.1