1 karl  1.1 /* PegasusDoc.dxx - Top Level file for Developer Documentation.
  2           This file defines the document strucuture and provides the introduction

  3 mike  1.20 
  4                    Fixed file name case for use on GNU/Linux:
  5                        Header file "StopWatch.h" is actually "Stopwatch.h"
  6                        "objectives.dxx" is actually "Objectives.dxx"
  7                        "Architecture.dxx" is actually "architecture.dxx"
  8                        "Components.dxx" is actually "components.dxx"
  9                        "installation.dxx" is actually "Installation.dxx"
 10                        "MOFCompiler.dxx" is actually "MOFcompiler.dxx"
 11                        "CIMObjects.dxx" is actually "cimobjects.dxx"
 12                        "CIMOBJECTTable.dxx" is actually "CIMobjectTable.dxx"
 13                        "Classes.dxx" is actually "classes.dxx"
 14                        "Interfaces.dxx" is actually "interfaces.dxx"
 15                        "FAQ.dxx" is actually "FAQ.DXX"
 16            

 17 karl  1.2  	$Log: PegasusDoc.dxx,v $

 18 mike  1.20 	Revision 1.19.2.3  2001/10/05 21:16:41  kumpf
 19            	HP-RK Fix case for platforms with case-sensitive file names.

 20 karl  1.19 	

 21 mike  1.20 	Revision 1.19.2.2  2001/09/21 05:47:58  karl
 22            	doc change to TOG formats

 23 karl  1.18 	

 24 mike  1.20 	Revision 1.19.2.1  2001/09/13 21:29:24  karl
 25            	Update to no Frame work

 26 karl  1.18 	

 27 mike  1.20 	Revision 1.19  2001/05/27 10:11:50  karl
 28            	Clean up object tables

 29 karl  1.17 	

 30 mike  1.20 	Revision 1.18  2001/05/21 17:33:33  karl
 31            	Update version number

 32 karl  1.1  	

 33 karl  1.2  	

 34 mike  1.20 	$Author: kumpf $

 35 karl  1.1  */

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

 38 karl  1.12 */
 39            /** @name Introduction
 40            
 41            <CENTER><FONT Size=+4>Welcome to PEGASUS</FONT></CENTER>

 42 karl  1.1  

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

 44 mike  1.20 <SMALL><CENTER>version 1.01 13 September 2001</CENTER></SMALL>

 45 karl  1.1  

 46 karl  1.17 Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.
 47            
 48            <B>This Document</B>
 49            
 50            <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.
 51            
 52            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.
 53            
 54            Within this manual you will find:
 55            <UL>
 56            <LI>Information on the installation and operation of the broker and additional components.
 57            <LI> A basic defintion of the architecture and function of Pegasus.
 58            <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.
 59            <LI>A number of defintions of additional code that is
 60            available to interface with Pegasus as providers, consumers, and services.
 61            </UL>
 62            
 63            <B>ATTN:</B> We need to give a description of the sections and what they accomplish with hotlinks to each.
 64            
 65            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}).
 66            
 67 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.
 68            
 69            This version of the Pegasus User Manual was created at \today
 70            */

 71 karl  1.19 

 72 karl  1.17 */

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

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

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

 78 karl  1.1  */

 79 karl  1.13 

 80 mike  1.20     //@Include: Objectives.dxx

 81 karl  1.1      //@Include: overview.dxx
 82                //@Include: credits.dxx

 83 mike  1.20     //@Include: architecture.dxx
 84                //@Include: components.dxx

 85 karl  1.5      //@Include: Utilization.dxx

 86 karl  1.13         //@{	    
 87                	//@Include: availability.dxx

 88 mike  1.20     	//@Include: Installation.dxx

 89 karl  1.13     	//@Include: operation.dxx
 90                	//@Include: CIMClients.dxx
 91                	//@Include: PegasusProviders.dxx

 92 mike  1.20     	//@Include: MOFcompiler.dxx    

 93 karl  1.13         //@}

 94 karl  1.14     //@Include: programming.dxx

 95 karl  1.12         //@{

 96 mike  1.20 	   //@Include: cimobjects.dxx
 97            	   //@Include: CIMobjectTable.dxx
 98            	   //@Include: classes.dxx

 99 karl  1.12            //@{ 

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

101 karl  1.9      		//@Include: ..\..\src\Pegasus\Common\CIMClass.h
102                		//@Include: ..\..\src\Pegasus\Common\CIMDateTime.h
103                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h

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

105 karl  1.9      		//@Include: ..\..\src\Pegasus\Common\CIMType.h
106                		//@Include: ..\..\src\Pegasus\Common\CIMInstance.h
107                		//@Include: ..\..\src\Pegasus\Common\CIMValue.h
108                		//@Include: ..\..\src\Pegasus\Common\CIMParameter.h
109                		//@Include: ..\..\src\Pegasus\Common\CIMProperty.h
110                		//@Include: ..\..\src\Pegasus\Common\CIMScope.h
111                		//@Include: ..\..\src\Pegasus\Common\CIMReference.h
112                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierList.h    		
113                		//@Include: ..\..\src\Pegasus\Common\CIMQualifierNames.h
114                		//@Include: ..\..\src\Pegasus\Common\CIMQualifier.h
115                		//@Include: ..\..\src\Pegasus\Common\CIMName.h
116                		//@Include: ..\..\src\Pegasus\Common\CIMMethod.h
117                		//@Include: ..\..\src\Pegasus\Common\CIMFlavor.h

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

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

120 karl  1.17          	//@Include: ..\..\src\Pegasus\Common\Stack.h 
121                     	//@Include: ..\..\src\Pegasus\Common\CIMName.h 

122 mike  1.20              	//@Include: ..\..\src\Pegasus\Common\Stopwatch.h 

123 karl  1.17          	//@Include: ..\..\src\Pegasus\Common\TimeValue.h 
124            
125            

126 karl  1.12         	//@{

127 karl  1.13 		//@Include: Exceptions.dxx  

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

129 karl  1.12         	//@}
130                        //@}

131 karl  1.11         	

132 karl  1.5  	//@}

133 mike  1.20     //@Include: interfaces.dxx

134 karl  1.1         //@{

135 karl  1.8  	    //@Include: CIMOperations.dxx
136            	        //@{

137 mike  1.20 		    //@Include: ..\..\doc\CIMOperations.h

138 karl  1.8  		//@}

139 karl  1.1  	    //@Include: ClientInterfaces.dxx   
140            		//@{    

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

142 karl  1.1  		//@}
143                	   //@Include: ProviderInterfaces.dxx

144 karl  1.9      	   	//@{
145            		    //@Include: ..\..\src\Pegasus\Provider\CIMProvider.h
146            		//@}  	 

147 karl  1.1      	   //@Include: ServiceInterfaces.dxx

148 karl  1.7      	   //@Include: RepositoryInterfaces.dxx

149 karl  1.8      	   	//@{

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

151 karl  1.8  		//@}

152 karl  1.1         //@}

153 karl  1.8      

154 karl  1.5      //@Include: ProviderWriting.dxx

155 karl  1.1      //@Include: definitions.dxx
156                //@Include: Examples.dxx

157 karl  1.12     	
158                	//@{
159                		//@Include: ExamplesClient.dxx
160                 		//@Include: ExamplesProvider.dxx  
161                	//@}

162 karl  1.8      //@Include: references.dxx

163 mike  1.20     //@Include: FAQ.DXX

164 karl  1.13  

165 karl  1.1