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.11 Revision 1.10 2001/02/20 14:06:05 karl
5 name changes
6
|
7 karl 1.10 Revision 1.9 2001/02/19 21:48:40 karl
8 CIMxx Class and file name chages
9
|
10 karl 1.9 Revision 1.8 2001/02/06 17:02:13 karl
11 rearrange documentation for interfaces
12
|
13 karl 1.8 Revision 1.7 2001/02/05 14:14:00 karl
14 doc++ extension for respository
15
|
16 karl 1.7 Revision 1.6 2001/02/02 19:38:23 karl
17 add graphic
18
|
19 karl 1.6 Revision 1.5 2001/02/02 18:48:20 karl
20 Doc++ expansion
21
|
22 karl 1.5 Revision 1.4 2001/01/30 23:38:18 karl
23 Add to documentation
24
|
25 karl 1.4 Revision 1.3 2001/01/24 17:17:05 karl
26 add Doc++ comments
27
|
28 karl 1.3 Revision 1.2 2001/01/24 16:16:38 karl
29 Incorporate Doc++ Comments as documentation into .h files
30
|
31 karl 1.2 Revision 1.1 2001/01/24 14:18:48 karl
32 import Dev Doc Files
|
33 karl 1.1
|
34 karl 1.2
35 $Author: karl $
|
36 karl 1.1 */
37 /** @name Pegasus
38
|
39 karl 1.5 <STRONG><B>Welcome to PEGASUS</B></STRONG>
|
40 karl 1.1
|
41 karl 1.6 <P><B>DRAFT FOR REVIEW</B>
|
42 karl 1.10 <P>Version 0.5, 01/02/02</P>
43 <P>Version 0.6 01/04/02 - Clean up the API defintions. and Add repository section.
44 <P>Version 0.7 02/20/02 - Change Class names, Add definitions, Add Architecture documentation.
|
45 karl 1.6
|
46 karl 1.8 Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.
|
47 karl 1.1
|
48 karl 1.5 <B>This Document</B>
|
49 karl 1.1
|
50 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.
|
51 karl 1.1
|
52 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.
|
53 karl 1.1
|
54 karl 1.5 Within this manual you should 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 karl 1.1 available to interface with Pegasus as providers, consumers, and services.
|
61 karl 1.5 </UL>
62
|
63 karl 1.6 <B>ATTN:</B> I need to give a description of the sections and what they accomplish with hotlinks to each.
|
64 karl 1.5
65 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}.
|
66 karl 1.1
|
67 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.
|
68 karl 1.1
69 This version of the Pegasus User Manual was created at \today
70 */
|
71 karl 1.7
72 /*
73 Table stuff to see if it worksl
74
75 <table border cellspacing=0 cellpadding=5>
76 <tr>
77 <td colspan=2 rowspan=2></td>
78 <th colspan=2 align=center>Preferences></th>
79 </tr>
80 <tr>
81 <th>Eating Kumquats</th>
82 <th>poke int he eye</th>
83 </tr>
84 </table>
85 */
86
|
87 karl 1.1 /* Change list to mvoe this into repository
|
88 karl 1.2 Datetime - Done Comments need more work
89 String - Moved but comments need work
90 Name
91 Type
|
92 karl 1.4 Property
93 Reference
94 Value
95 Union - First comments in
|
96 karl 1.1 */
97 //@{
|
98 karl 1.5 //@Include: objectives.dxx
|
99 karl 1.1 //@Include: overview.dxx
100 //@Include: credits.dxx
101 //@Include: Architecture.dxx
102 //@Include: Components.dxx
|
103 karl 1.5 //@Include: Utilization.dxx
104 //@Include: CIMOBJECTS.dxx
105 //@{
106 //@Include: ..\..\src\Pegasus\Common\Array.h
|
107 karl 1.9 //@Include: ..\..\src\Pegasus\Common\CIMClass.h
108 //@Include: ..\..\src\Pegasus\Common\CIMDateTime.h
109 //@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h
|
110 karl 1.5 //@Include: ..\..\src\Pegasus\Common\String.h
|
111 karl 1.9 //@Include: ..\..\src\Pegasus\Common\CIMType.h
112 //@Include: ..\..\src\Pegasus\Common\CIMInstance.h
113 //@Include: ..\..\src\Pegasus\Common\CIMValue.h
114 //@Include: ..\..\src\Pegasus\Common\CIMParameter.h
115 //@Include: ..\..\src\Pegasus\Common\CIMProperty.h
116 //@Include: ..\..\src\Pegasus\Common\CIMScope.h
117 //@Include: ..\..\src\Pegasus\Common\CIMReference.h
118 //@Include: ..\..\src\Pegasus\Common\CIMQualifierList.h
119 //@Include: ..\..\src\Pegasus\Common\CIMQualifierNames.h
120 //@Include: ..\..\src\Pegasus\Common\CIMQualifier.h
121 //@Include: ..\..\src\Pegasus\Common\CIMName.h
122 //@Include: ..\..\src\Pegasus\Common\CIMMethod.h
123 //@Include: ..\..\src\Pegasus\Common\CIMFlavor.h
|
124 karl 1.5 //@Include: ..\..\src\Pegasus\Common\Char16.h
|
125 karl 1.9 //@Include: ..\..\src\Pegasus\Common\DeclContext.h
|
126 karl 1.11 //@Include: ..\..\src\Pegasus\Common\Exception.h
127
|
128 karl 1.5 //@}
|
129 karl 1.1 //@Include: Interfaces.dxx
130 //@{
|
131 karl 1.8 //@Include: CIMOperations.dxx
132 //@{
|
133 karl 1.9 //@Include: ..\..\src\Pegasus\Common\CIMOperations.h
|
134 karl 1.8 //@}
|
135 karl 1.1 //@Include: ClientInterfaces.dxx
136 //@{
|
137 karl 1.9 //@Include: ..\..\src\Pegasus\Client\CIMClient.h
|
138 karl 1.1 //@}
139 //@Include: ProviderInterfaces.dxx
|
140 karl 1.9 //@{
141 //@Include: ..\..\src\Pegasus\Provider\CIMProvider.h
142 //@}
|
143 karl 1.1 //@Include: ServiceInterfaces.dxx
|
144 karl 1.7 //@Include: RepositoryInterfaces.dxx
|
145 karl 1.8 //@{
|
146 karl 1.9 //@Include: ..\..\src\Pegasus\Repository\CIMRepository.h
|
147 karl 1.8 //@}
|
148 karl 1.1 //@}
|
149 karl 1.8
|
150 karl 1.5 //@Include: ProviderWriting.dxx
|
151 karl 1.1 //@Include: definitions.dxx
152 //@Include: Examples.dxx
|
153 karl 1.8 //@Include: references.dxx
|
154 karl 1.5 //@Include: FAQ.dxx
|
155 karl 1.1 //@}
156
157
158
|