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