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.6 Revision 1.5 2001/02/02 18:48:20 karl
5 Doc++ expansion
6
|
7 karl 1.5 Revision 1.4 2001/01/30 23:38:18 karl
8 Add to documentation
9
|
10 karl 1.4 Revision 1.3 2001/01/24 17:17:05 karl
11 add Doc++ comments
12
|
13 karl 1.3 Revision 1.2 2001/01/24 16:16:38 karl
14 Incorporate Doc++ Comments as documentation into .h files
15
|
16 karl 1.2 Revision 1.1 2001/01/24 14:18:48 karl
17 import Dev Doc Files
|
18 karl 1.1
|
19 karl 1.2
20 $Author: karl $
|
21 karl 1.1 */
22 /** @name Pegasus
23
|
24 karl 1.5 <STRONG><B>Welcome to PEGASUS</B></STRONG>
|
25 karl 1.1
|
26 karl 1.6 <P><B>DRAFT FOR REVIEW</B>
27 <P>Version 1.5, 2001/02/02
28
|
29 karl 1.5 An open source implementation of the manageability environment defined by the DMTF WBEM standards.
|
30 karl 1.1
|
31 karl 1.5 <B>This Document</B>
|
32 karl 1.1
|
33 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.
|
34 karl 1.1
|
35 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.
|
36 karl 1.1
|
37 karl 1.5 Within this manual you should find:
38 <UL>
39 <LI>Information on the installation and operation of the broker and additional components.
40 <LI> A basic defintion of the architecture and function of Pegasus.
41 <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.
42 <LI>A number of defintions of additional code that is
|
43 karl 1.1 available to interface with Pegasus as providers, consumers, and services.
|
44 karl 1.5 </UL>
45
|
46 karl 1.6 <B>ATTN:</B> I need to give a description of the sections and what they accomplish with hotlinks to each.
|
47 karl 1.5
48 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}.
|
49 karl 1.1
|
50 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.
|
51 karl 1.1
52 This version of the Pegasus User Manual was created at \today
53 */
54 /* Change list to mvoe this into repository
|
55 karl 1.2 Datetime - Done Comments need more work
56 String - Moved but comments need work
57 Name
58 Type
|
59 karl 1.4 Property
60 Reference
61 Value
62 Union - First comments in
|
63 karl 1.1 */
64 //@{
|
65 karl 1.5 //@Include: objectives.dxx
|
66 karl 1.1 //@Include: overview.dxx
67 //@Include: credits.dxx
68 //@Include: Architecture.dxx
69 //@Include: Components.dxx
|
70 karl 1.5 //@Include: Utilization.dxx
71 //@Include: CIMOBJECTS.dxx
72 //@{
73 //@Include: ..\..\src\Pegasus\Common\Array.h
74 //@Include: ..\..\src\Pegasus\Common\ClassDecl.h
75 //@Include: ..\..\src\Pegasus\Common\DateTime.h
76 //@Include: ..\..\src\Pegasus\Common\QualifierDecl.h
77 //@Include: ..\..\src\Pegasus\Common\String.h
78 //@Include: ..\..\src\Pegasus\Common\Type.h
79 //@Include: ..\..\src\Pegasus\Common\InstanceDecl.h
80 //@Include: ..\..\src\Pegasus\Common\Value.h
81 //@Include: ..\..\src\Pegasus\Common\Property.h
82 //@Include: ..\..\src\Pegasus\Common\Scope.h
83 //@Include: ..\..\src\Pegasus\Common\Reference.h
84 //@Include: ..\..\src\Pegasus\Common\QualifierNames.h
85 //@Include: ..\..\src\Pegasus\Common\Qualifier.h
86 //@Include: ..\..\src\Pegasus\Common\Name.h
87 //@Include: ..\..\src\Pegasus\Common\Method.h
88 //@Include: ..\..\src\Pegasus\Common\Flavor.h
89 //@Include: ..\..\src\Pegasus\Common\Char16.h
90 //@}
|
91 karl 1.1 //@Include: Interfaces.dxx
92 //@{
93 //@Include: ClientInterfaces.dxx
94 //@{
|
95 karl 1.6 //@Include: ..\..\src\Pegasus\Common\operations.h
|
96 karl 1.1 //@}
97 //@Include: ProviderInterfaces.dxx
98
99 //@Include: ServiceInterfaces.dxx
100 //@}
101 //@Include: references.dxx
|
102 karl 1.5 //@Include: ProviderWriting.dxx
|
103 karl 1.1 //@Include: definitions.dxx
104 //@Include: Examples.dxx
|
105 karl 1.5 //@Include: FAQ.dxx
|
106 karl 1.1 //@}
107
108
109
|