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