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