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

  3 kumpf 1.19.2.3 
  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 kumpf 1.19.2.3 	Revision 1.19.2.2  2001/09/21 05:47:58  karl
 19                	doc change to TOG formats
 20                	

 21 karl  1.19.2.2 	Revision 1.19.2.1  2001/09/13 21:29:24  karl
 22                	Update to no Frame work
 23                	

 24 karl  1.19.2.1 	Revision 1.19  2001/05/27 10:11:50  karl
 25                	Clean up object tables
 26                	

 27 karl  1.19     	Revision 1.18  2001/05/21 17:33:33  karl
 28                	Update version number
 29                	

 30 karl  1.2      	
 31                	$Author: karl $

 32 karl  1.1      */

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

 35 karl  1.12     */
 36                /** @name Introduction
 37                
 38                <CENTER><FONT Size=+4>Welcome to PEGASUS</FONT></CENTER>

 39 karl  1.1      

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

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

 42 karl  1.1      

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

 68 karl  1.19     

 69 karl  1.17     */

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

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

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

 75 karl  1.1      */

 76 karl  1.13     

 77 kumpf 1.19.2.3     //@Include: Objectives.dxx

 78 karl  1.1          //@Include: overview.dxx
 79                    //@Include: credits.dxx

 80 kumpf 1.19.2.3     //@Include: architecture.dxx
 81                    //@Include: components.dxx

 82 karl  1.5          //@Include: Utilization.dxx

 83 karl  1.13             //@{	    
 84                    	//@Include: availability.dxx

 85 kumpf 1.19.2.3     	//@Include: Installation.dxx

 86 karl  1.13         	//@Include: operation.dxx
 87                    	//@Include: CIMClients.dxx
 88                    	//@Include: PegasusProviders.dxx

 89 kumpf 1.19.2.3     	//@Include: MOFcompiler.dxx    

 90 karl  1.13             //@}

 91 karl  1.14         //@Include: programming.dxx

 92 karl  1.12             //@{

 93 kumpf 1.19.2.3 	   //@Include: cimobjects.dxx
 94                	   //@Include: CIMobjectTable.dxx
 95                	   //@Include: classes.dxx

 96 karl  1.12                //@{ 

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

 98 karl  1.9          		//@Include: ..\..\src\Pegasus\Common\CIMClass.h
 99                    		//@Include: ..\..\src\Pegasus\Common\CIMDateTime.h
100                    		//@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h

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

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

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

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

117 karl  1.17              	//@Include: ..\..\src\Pegasus\Common\Stack.h 
118                         	//@Include: ..\..\src\Pegasus\Common\CIMName.h 

119 kumpf 1.19.2.3              	//@Include: ..\..\src\Pegasus\Common\Stopwatch.h 

120 karl  1.17              	//@Include: ..\..\src\Pegasus\Common\TimeValue.h 
121                
122                

123 karl  1.12             	//@{

124 karl  1.13     		//@Include: Exceptions.dxx  

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

126 karl  1.12             	//@}
127                            //@}

128 karl  1.11             	

129 karl  1.5      	//@}

130 kumpf 1.19.2.3     //@Include: interfaces.dxx

131 karl  1.1             //@{

132 karl  1.8      	    //@Include: CIMOperations.dxx
133                	        //@{

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

135 karl  1.8      		//@}

136 karl  1.1      	    //@Include: ClientInterfaces.dxx   
137                		//@{    

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

139 karl  1.1      		//@}
140                    	   //@Include: ProviderInterfaces.dxx

141 karl  1.9          	   	//@{
142                		    //@Include: ..\..\src\Pegasus\Provider\CIMProvider.h
143                		//@}  	 

144 karl  1.1          	   //@Include: ServiceInterfaces.dxx

145 karl  1.7          	   //@Include: RepositoryInterfaces.dxx

146 karl  1.8          	   	//@{

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

148 karl  1.8      		//@}

149 karl  1.1             //@}

150 karl  1.8          

151 karl  1.5          //@Include: ProviderWriting.dxx

152 karl  1.1          //@Include: definitions.dxx
153                    //@Include: Examples.dxx

154 karl  1.12         	
155                    	//@{
156                    		//@Include: ExamplesClient.dxx
157                     		//@Include: ExamplesProvider.dxx  
158                    	//@}

159 karl  1.8          //@Include: references.dxx

160 kumpf 1.19.2.3     //@Include: FAQ.DXX

161 karl  1.13      

162 karl  1.1