pegasus/doc/DevManual/PegasusDoc.dxx - annotate

Return to PegasusDoc.dxx CVS log

Up to [Pegasus] / pegasus / doc / DevManual

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.13 Revision 1.12 2001/02/23 20:27:46 karl 5 correct documentation 6
7 karl 1.12 Revision 1.11 2001/02/21 01:53:08 karl 8 Namespaces stuff 9
10 karl 1.11 Revision 1.10 2001/02/20 14:06:05 karl 11 name changes 12
13 karl 1.10 Revision 1.9 2001/02/19 21:48:40 karl 14 CIMxx Class and file name chages 15
16 karl 1.9 Revision 1.8 2001/02/06 17:02:13 karl 17 rearrange documentation for interfaces 18
19 karl 1.8 Revision 1.7 2001/02/05 14:14:00 karl 20 doc++ extension for respository 21
22 karl 1.7 Revision 1.6 2001/02/02 19:38:23 karl 23 add graphic 24
25 karl 1.6 Revision 1.5 2001/02/02 18:48:20 karl 26 Doc++ expansion 27
28 karl 1.5 Revision 1.4 2001/01/30 23:38:18 karl 29 Add to documentation 30
31 karl 1.4 Revision 1.3 2001/01/24 17:17:05 karl 32 add Doc++ comments 33
34 karl 1.3 Revision 1.2 2001/01/24 16:16:38 karl 35 Incorporate Doc++ Comments as documentation into .h files 36
37 karl 1.2 Revision 1.1 2001/01/24 14:18:48 karl 38 import Dev Doc Files
39 karl 1.1
40 karl 1.2 41 $Author: karl $
42 karl 1.1 */
43 karl 1.13 /* do not change the following Name. Used in the Frame definition. 44 If you change it, the HTML Frame must also be changed.
45 karl 1.12 / 46 /* @name Introduction 47 48 <CENTER><FONT Size=+4>Welcome to PEGASUS</FONT></CENTER>
49 karl 1.1
50 karl 1.12 <P><B><CENTER>DRAFT FOR REVIEW</CENTER></B>
51 karl 1.1
52 karl 1.12 <table border="1" width="100%"> 53 <CAPTION>Revision History</CAPTION> 54 <tr> 55 <td width="10%"><b>Versions</b></td> 56 <td width="13%"><b>Date</b></td> 57 <td width="37%"><b>Author</b></td> 58 <td width="117%"><b>Comments</b></td> 59 </tr> 60 <tr> 61 <td width="10%">0.5</td> 62 <td width="13%">01/02/02</td> 63 <td width="37%">Karl</td> 64 <td width="117%"> </td> 65 </tr> 66 <tr> 67 <td width="10%">0.6</td> 68 <td width="13%">01/04/02</td> 69 <td width="37%">Karl</td> 70 <td width="117%">Clean up the API defintions. and Add repository section.</td> 71 </tr> 72 </tr> 73 karl 1.12 <tr> 74 <td width="10%">0.7</td> 75 <td width="13%">02/20/02</td> 76 <td width="37%">Karl</td> 77 <td width="117%">Change Class names, Add definitions, Add Architecture documentation.</td> 78 </tr>
79 karl 1.13 </tr> 80 <tr> 81 <td width="10%">0.75</td> 82 <td width="13%">02/25/02</td> 83 <td width="37%">Karl</td> 84 <td width="117%">Create Frames Version and redo structure..</td> 85 </tr>
86 karl 1.12 </table>
87 karl 1.6
88 karl 1.8 Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.
89 karl 1.1
90 karl 1.5 <B>This Document</B>
91 karl 1.1
92 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.
93 karl 1.1
94 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.
95 karl 1.1
96 karl 1.12 Within this manual you will find:
97 karl 1.5 <UL> 98 <LI>Information on the installation and operation of the broker and additional components. 99 <LI> A basic defintion of the architecture and function of Pegasus. 100 <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. 101 <LI>A number of defintions of additional code that is
102 karl 1.1 available to interface with Pegasus as providers, consumers, and services.
103 karl 1.5 </UL> 104
105 karl 1.6 <B>ATTN:</B> I need to give a description of the sections and what they accomplish with hotlinks to each.
106 karl 1.5 107 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}.
108 karl 1.1
109 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.
110 karl 1.1 111 This version of the Pegasus User Manual was created at \today 112 */
113 karl 1.12 /* The following is the complete file haearchy for this document.
114 karl 1.13 We have tried to keep all file references in only this one place
115 karl 1.12 to make modification easier. In the future, please keep the 116 references here and text in the individual files.
117 karl 1.1 */
118 karl 1.13
119 karl 1.5 //@Include: objectives.dxx
120 karl 1.1 //@Include: overview.dxx 121 //@Include: credits.dxx 122 //@Include: Architecture.dxx 123 //@Include: Components.dxx
124 karl 1.5 //@Include: Utilization.dxx
125 karl 1.13 //@{ 126 //@Include: availability.dxx 127 //@Include: installation.dxx 128 //@Include: operation.dxx 129 //@Include: CIMClients.dxx 130 //@Include: PegasusProviders.dxx 131 //@Include: MOFCompiler.dxx 132 //@}
133 karl 1.5 //@Include: CIMOBJECTS.dxx
134 karl 1.12 //@{ 135 //@Include: CIMOBJECTTable.dxx 136 //@{
137 karl 1.5 //@Include: ..\..\src\Pegasus\Common\Array.h
138 karl 1.9 //@Include: ..\..\src\Pegasus\Common\CIMClass.h 139 //@Include: ..\..\src\Pegasus\Common\CIMDateTime.h 140 //@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h
141 karl 1.5 //@Include: ..\..\src\Pegasus\Common\String.h
142 karl 1.9 //@Include: ..\..\src\Pegasus\Common\CIMType.h 143 //@Include: ..\..\src\Pegasus\Common\CIMInstance.h 144 //@Include: ..\..\src\Pegasus\Common\CIMValue.h 145 //@Include: ..\..\src\Pegasus\Common\CIMParameter.h 146 //@Include: ..\..\src\Pegasus\Common\CIMProperty.h 147 //@Include: ..\..\src\Pegasus\Common\CIMScope.h 148 //@Include: ..\..\src\Pegasus\Common\CIMReference.h 149 //@Include: ..\..\src\Pegasus\Common\CIMQualifierList.h 150 //@Include: ..\..\src\Pegasus\Common\CIMQualifierNames.h 151 //@Include: ..\..\src\Pegasus\Common\CIMQualifier.h 152 //@Include: ..\..\src\Pegasus\Common\CIMName.h 153 //@Include: ..\..\src\Pegasus\Common\CIMMethod.h 154 //@Include: ..\..\src\Pegasus\Common\CIMFlavor.h
155 karl 1.5 //@Include: ..\..\src\Pegasus\Common\Char16.h
156 karl 1.9 //@Include: ..\..\src\Pegasus\Common\DeclContext.h
157 karl 1.12 //@{
158 karl 1.13 //@Include: Exceptions.dxx
159 karl 1.11 //@Include: ..\..\src\Pegasus\Common\Exception.h
160 karl 1.12 //@} 161 //@}
162 karl 1.11
163 karl 1.5 //@}
164 karl 1.1 //@Include: Interfaces.dxx 165 //@{
166 karl 1.8 //@Include: CIMOperations.dxx 167 //@{
168 karl 1.9 //@Include: ..\..\src\Pegasus\Common\CIMOperations.h
169 karl 1.8 //@}
170 karl 1.1 //@Include: ClientInterfaces.dxx 171 //@{
172 karl 1.9 //@Include: ..\..\src\Pegasus\Client\CIMClient.h
173 karl 1.1 //@} 174 //@Include: ProviderInterfaces.dxx
175 karl 1.9 //@{ 176 //@Include: ..\..\src\Pegasus\Provider\CIMProvider.h 177 //@}
178 karl 1.1 //@Include: ServiceInterfaces.dxx
179 karl 1.7 //@Include: RepositoryInterfaces.dxx
180 karl 1.8 //@{
181 karl 1.9 //@Include: ..\..\src\Pegasus\Repository\CIMRepository.h
182 karl 1.8 //@}
183 karl 1.1 //@}
184 karl 1.8
185 karl 1.5 //@Include: ProviderWriting.dxx
186 karl 1.1 //@Include: definitions.dxx 187 //@Include: Examples.dxx
188 karl 1.12 189 //@{ 190 //@Include: ExamplesClient.dxx 191 //@Include: ExamplesProvider.dxx 192 //@}
193 karl 1.8 //@Include: references.dxx
194 karl 1.5 //@Include: FAQ.dxx
195 karl 1.13
196 karl 1.1

No CVS admin address has been configured