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.2 	Revision 1.19.2.1  2001/09/13 21:29:24  karl
  5                	Update to no Frame work
  6                	

  7 karl  1.19.2.1 	Revision 1.19  2001/05/27 10:11:50  karl
  8                	Clean up object tables
  9                	

 10 karl  1.19     	Revision 1.18  2001/05/21 17:33:33  karl
 11                	Update version number
 12                	

 13 karl  1.2      	
 14                	$Author: karl $

 15 karl  1.1      */

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

 18 karl  1.12     */
 19                /** @name Introduction
 20                
 21                <CENTER><FONT Size=+4>Welcome to PEGASUS</FONT></CENTER>

 22 karl  1.1      

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

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

 25 karl  1.1      

 26 karl  1.17     Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.
 27                
 28                <B>This Document</B>
 29                
 30                <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.
 31                
 32                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.
 33                
 34                Within this manual you will find:
 35                <UL>
 36                <LI>Information on the installation and operation of the broker and additional components.
 37                <LI> A basic defintion of the architecture and function of Pegasus.
 38                <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.
 39                <LI>A number of defintions of additional code that is
 40                available to interface with Pegasus as providers, consumers, and services.
 41                </UL>
 42                
 43                <B>ATTN:</B> We need to give a description of the sections and what they accomplish with hotlinks to each.
 44                
 45                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}).
 46                
 47 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.
 48                
 49                This version of the Pegasus User Manual was created at \today
 50                */

 51 karl  1.19     

 52 karl  1.17     */

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

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

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

 58 karl  1.1      */

 59 karl  1.13     

 60 karl  1.5          //@Include: objectives.dxx

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

 65 karl  1.5          //@Include: Utilization.dxx

 66 karl  1.13             //@{	    
 67                    	//@Include: availability.dxx
 68                    	//@Include: installation.dxx
 69                    	//@Include: operation.dxx
 70                    	//@Include: CIMClients.dxx
 71                    	//@Include: PegasusProviders.dxx
 72                    	//@Include: MOFCompiler.dxx    
 73                        //@}

 74 karl  1.14         //@Include: programming.dxx

 75 karl  1.12             //@{

 76 karl  1.14     	   //@Include: CIMObjects.dxx
 77                	   //@Include: CIMOBJECTTable.dxx
 78                	   //@Include: Classes.dxx

 79 karl  1.12                //@{ 

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

 81 karl  1.9          		//@Include: ..\..\src\Pegasus\Common\CIMClass.h
 82                    		//@Include: ..\..\src\Pegasus\Common\CIMDateTime.h
 83                    		//@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h

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

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

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

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

100 karl  1.17              	//@Include: ..\..\src\Pegasus\Common\Stack.h 
101                         	//@Include: ..\..\src\Pegasus\Common\CIMName.h 
102                             	//@Include: ..\..\src\Pegasus\Common\StopWatch.h 
103                         	//@Include: ..\..\src\Pegasus\Common\TimeValue.h 
104                
105                

106 karl  1.12             	//@{

107 karl  1.13     		//@Include: Exceptions.dxx  

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

109 karl  1.12             	//@}
110                            //@}

111 karl  1.11             	

112 karl  1.5      	//@}

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

115 karl  1.8      	    //@Include: CIMOperations.dxx
116                	        //@{

117 karl  1.19.2.2 		    //@Include: ..\..\doc\CIMOperations.h

118 karl  1.8      		//@}

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

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

122 karl  1.1      		//@}
123                    	   //@Include: ProviderInterfaces.dxx

124 karl  1.9          	   	//@{
125                		    //@Include: ..\..\src\Pegasus\Provider\CIMProvider.h
126                		//@}  	 

127 karl  1.1          	   //@Include: ServiceInterfaces.dxx

128 karl  1.7          	   //@Include: RepositoryInterfaces.dxx

129 karl  1.8          	   	//@{

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

131 karl  1.8      		//@}

132 karl  1.1             //@}

133 karl  1.8          

134 karl  1.5          //@Include: ProviderWriting.dxx

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

137 karl  1.12         	
138                    	//@{
139                    		//@Include: ExamplesClient.dxx
140                     		//@Include: ExamplesProvider.dxx  
141                    	//@}

142 karl  1.8          //@Include: references.dxx

143 karl  1.5          //@Include: FAQ.dxx

144 karl  1.13      

145 karl  1.1