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.23
|
4 karl 1.1 */
|
5 karl 1.13 /* do not change the following Name. Used in the Frame definition.
6 If you change it, the HTML Frame must also be changed.
|
7 karl 1.12 */
8 /** @name Introduction
9
10 <CENTER><FONT Size=+4>Welcome to PEGASUS</FONT></CENTER>
|
11 karl 1.1
|
12 karl 1.12 <P><B><CENTER>DRAFT FOR REVIEW</CENTER></B>
|
13 mike 1.20 <SMALL><CENTER>version 1.01 13 September 2001</CENTER></SMALL>
|
14 karl 1.1
|
15 karl 1.17 Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.
16
17 <B>This Document</B>
18
19 <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.
20
21 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.
22
23 Within this manual you will find:
24 <UL>
25 <LI>Information on the installation and operation of the broker and additional components.
26 <LI> A basic defintion of the architecture and function of Pegasus.
27 <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.
28 <LI>A number of defintions of additional code that is
29 available to interface with Pegasus as providers, consumers, and services.
30 </UL>
31
32 <B>ATTN:</B> We need to give a description of the sections and what they accomplish with hotlinks to each.
33
34 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}).
35
36 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.
37
38 This version of the Pegasus User Manual was created at \today
39 */
|
40 karl 1.19
|
41 karl 1.17 */
|
42 kumpf 1.21 /* //@Include:DocumentHistory.dxx */
|
43 karl 1.19 /* The following is the complete file hiearchy for this document.
|
44 karl 1.13 We have tried to keep all file references in only this one place
|
45 karl 1.12 to make modification easier. In the future, please keep the
46 references here and text in the individual files.
|
47 karl 1.1 */
|
48 karl 1.13
|
49 mike 1.20 //@Include: Objectives.dxx
|
50 karl 1.1 //@Include: overview.dxx
51 //@Include: credits.dxx
|
52 mike 1.20 //@Include: architecture.dxx
53 //@Include: components.dxx
|
54 karl 1.5 //@Include: Utilization.dxx
|
55 karl 1.13 //@{
56 //@Include: availability.dxx
|
57 mike 1.20 //@Include: Installation.dxx
|
58 karl 1.13 //@Include: operation.dxx
59 //@Include: CIMClients.dxx
60 //@Include: PegasusProviders.dxx
|
61 mike 1.20 //@Include: MOFcompiler.dxx
|
62 karl 1.13 //@}
|
63 karl 1.14 //@Include: programming.dxx
|
64 karl 1.12 //@{
|
65 mike 1.20 //@Include: cimobjects.dxx
66 //@Include: CIMobjectTable.dxx
67 //@Include: classes.dxx
|
68 karl 1.12 //@{
|
69 karl 1.22 //@Include: ../../src/Pegasus/Common/Array.h
70 //@Include: ../../src/Pegasus/Common/Boolean.h
71 //@Include: ../../src/Pegasus/Common/CIMClass.h
72 //@Include: ../../src/Pegasus/Common/CIMClassRep.h
73 //@Include: ../../src/Pegasus/Common/CIMDateTime.h
74 //@Include: ../../src/Pegasus/Common/CIMExceptionRep.h
75 //@Include: ../../src/Pegasus/Common/CIMFlavor.h
76 //@Include: ../../src/Pegasus/Common/CIMIndication.h
77 //@Include: ../../src/Pegasus/Common/CIMInstance.h
78 //@Include: ../../src/Pegasus/Common/CIMInstanceRep.h
79 //@Include: ../../src/Pegasus/Common/CIMMessage.h
80 //@Include: ../../src/Pegasus/Common/CIMMethod.h
81 //@Include: ../../src/Pegasus/Common/CIMMethodRep.h
82 //@Include: ../../src/Pegasus/Common/CIMName.h
83 //@Include: ../../src/Pegasus/Common/CIMOMPort.h
84 //@Include: ../../src/Pegasus/Common/CIMObject.h
85 //@Include: ../../src/Pegasus/Common/CIMObjectPath.h
86 //@Include: ../../src/Pegasus/Common/CIMObjectRep.h
87 //@Include: ../../src/Pegasus/Common/CIMParamValue.h
88 //@Include: ../../src/Pegasus/Common/CIMParamValueRep.h
89 //@Include: ../../src/Pegasus/Common/CIMParameter.h
90 karl 1.22 //@Include: ../../src/Pegasus/Common/CIMParameterRep.h
91 //@Include: ../../src/Pegasus/Common/CIMPredicate.h
92 //@Include: ../../src/Pegasus/Common/CIMProperty.h
93 //@Include: ../../src/Pegasus/Common/CIMPropertyList.h
94 //@Include: ../../src/Pegasus/Common/CIMPropertyRep.h
95 //@Include: ../../src/Pegasus/Common/CIMQualifier.h
96 //@Include: ../../src/Pegasus/Common/CIMQualifierDecl.h
97 //@Include: ../../src/Pegasus/Common/CIMQualifierDeclRep.h
98 //@Include: ../../src/Pegasus/Common/CIMQualifierList.h
99 //@Include: ../../src/Pegasus/Common/CIMQualifierNames.h
100 //@Include: ../../src/Pegasus/Common/CIMQualifierRep.h
101 //@Include: ../../src/Pegasus/Common/CIMRepositoryBase.h
102 //@Include: ../../src/Pegasus/Common/CIMScope.h
103 //@Include: ../../src/Pegasus/Common/CIMStatusCode.h
104 //@Include: ../../src/Pegasus/Common/CIMType.h
105 //@Include: ../../src/Pegasus/Common/CIMValue.h
106 //@Include: ../../src/Pegasus/Common/Char16.h
107 //@Include: ../../src/Pegasus/Common/Formatter.h
108 //@Include: ../../src/Pegasus/Common/OperationContext.h
109 //@Include: ../../src/Pegasus/Common/Queue.h
110 //@Include: ../../src/Pegasus/Common/Stopwatch.h
111 karl 1.22 //@Include: ../../src/Pegasus/Common/String.h
|
112 karl 1.17
|
113 karl 1.12 //@{
|
114 karl 1.13 //@Include: Exceptions.dxx
|
115 kumpf 1.21 //@Include: ../../src/Pegasus/Common/Exception.h
|
116 karl 1.12 //@}
117 //@}
|
118 karl 1.11
|
119 karl 1.5 //@}
|
120 mike 1.20 //@Include: interfaces.dxx
|
121 karl 1.1 //@{
|
122 karl 1.8 //@Include: CIMOperations.dxx
123 //@{
|
124 kumpf 1.21 //@Include: ../../doc/CIMOperations.h
|
125 karl 1.8 //@}
|
126 karl 1.1 //@Include: ClientInterfaces.dxx
127 //@{
|
128 kumpf 1.21 //@Include: ../../src/Pegasus/Client/CIMClient.h
|
129 karl 1.1 //@}
130 //@Include: ProviderInterfaces.dxx
|
131 karl 1.9 //@{
|
132 kumpf 1.21
|
133 karl 1.22 //@Include: ../../src/Pegasus/Provider/CIMProvider.h
134 //@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h
135 //@Include: ../../src/Pegasus/Provider/CIMClassProvider.h
136 //@Include: ../../src/Pegasus/Provider/CIMIndicationConsumer.h
137 //@Include: ../../src/Pegasus/Provider/CIMIndicationProvider.h
138 //@Include: ../../src/Pegasus/Provider/CIMInstanceProvider.h
139 //@Include: ../../src/Pegasus/Provider/CIMMethodProvider.h
140 //@Include: ../../src/Pegasus/Provider/CIMNullProvider.h
141 //@Include: ../../src/Pegasus/Provider/CIMOMHandle.h
142 //@Include: ../../src/Pegasus/Provider/CIMPropertyProvider.h
143 //@Include: ../../src/Pegasus/Provider/CIMQueryProvider.h
144 //@Include: ../../src/Pegasus/Provider/ProviderException.h
|
145 karl 1.9 //@}
|
146 karl 1.1 //@Include: ServiceInterfaces.dxx
|
147 karl 1.7 //@Include: RepositoryInterfaces.dxx
|
148 karl 1.8 //@{
|
149 kumpf 1.21 //@Include: ../../src/Pegasus/Repository/CIMRepository.h
|
150 karl 1.8 //@}
|
151 karl 1.1 //@}
|
152 karl 1.8
|
153 karl 1.5 //@Include: ProviderWriting.dxx
|
154 karl 1.1 //@Include: definitions.dxx
155 //@Include: Examples.dxx
|
156 karl 1.12
157 //@{
158 //@Include: ExamplesClient.dxx
159 //@Include: ExamplesProvider.dxx
160 //@}
|
161 karl 1.8 //@Include: references.dxx
|
162 mike 1.20 //@Include: FAQ.DXX
|
163 karl 1.13
|
164 karl 1.1
|