pegasus/doc/DevManual/PegasusDoc.dxx - annotate

Return to PegasusDoc.dxx CVS log

Up to [Pegasus] / pegasus / doc / DevManual

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.12 Revision 1.11 2001/02/21 01:53:08 karl 5 Namespaces stuff 6
7 karl 1.11 Revision 1.10 2001/02/20 14:06:05 karl 8 name changes 9
10 karl 1.10 Revision 1.9 2001/02/19 21:48:40 karl 11 CIMxx Class and file name chages 12
13 karl 1.9 Revision 1.8 2001/02/06 17:02:13 karl 14 rearrange documentation for interfaces 15
16 karl 1.8 Revision 1.7 2001/02/05 14:14:00 karl 17 doc++ extension for respository 18
19 karl 1.7 Revision 1.6 2001/02/02 19:38:23 karl 20 add graphic 21
22 karl 1.6 Revision 1.5 2001/02/02 18:48:20 karl 23 Doc++ expansion 24
25 karl 1.5 Revision 1.4 2001/01/30 23:38:18 karl 26 Add to documentation 27
28 karl 1.4 Revision 1.3 2001/01/24 17:17:05 karl 29 add Doc++ comments 30
31 karl 1.3 Revision 1.2 2001/01/24 16:16:38 karl 32 Incorporate Doc++ Comments as documentation into .h files 33
34 karl 1.2 Revision 1.1 2001/01/24 14:18:48 karl 35 import Dev Doc Files
36 karl 1.1
37 karl 1.2 38 $Author: karl $
39 karl 1.1 */
40 karl 1.12 /* do not change the following Name. Used in the Frame definition 41 / 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 karl 1.1
48 karl 1.12 <table border="1" width="100%"> 49 <CAPTION>Revision History</CAPTION> 50 <tr> 51 <td width="10%"><b>Versions</b></td> 52 <td width="13%"><b>Date</b></td> 53 <td width="37%"><b>Author</b></td> 54 <td width="117%"><b>Comments</b></td> 55 </tr> 56 <tr> 57 <td width="10%">0.5</td> 58 <td width="13%">01/02/02</td> 59 <td width="37%">Karl</td> 60 <td width="117%"> </td> 61 </tr> 62 <tr> 63 <td width="10%">0.6</td> 64 <td width="13%">01/04/02</td> 65 <td width="37%">Karl</td> 66 <td width="117%">Clean up the API defintions. and Add repository section.</td> 67 </tr> 68 </tr> 69 karl 1.12 <tr> 70 <td width="10%">0.7</td> 71 <td width="13%">02/20/02</td> 72 <td width="37%">Karl</td> 73 <td width="117%">Change Class names, Add definitions, Add Architecture documentation.</td> 74 </tr> 75 </table>
76 karl 1.6
77 karl 1.8 Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.
78 karl 1.1
79 karl 1.5 <B>This Document</B>
80 karl 1.1
81 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.
82 karl 1.1
83 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.
84 karl 1.1
85 karl 1.12 Within this manual you will find:
86 karl 1.5 <UL> 87 <LI>Information on the installation and operation of the broker and additional components. 88 <LI> A basic defintion of the architecture and function of Pegasus. 89 <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. 90 <LI>A number of defintions of additional code that is
91 karl 1.1 available to interface with Pegasus as providers, consumers, and services.
92 karl 1.5 </UL> 93
94 karl 1.6 <B>ATTN:</B> I need to give a description of the sections and what they accomplish with hotlinks to each.
95 karl 1.5 96 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}.
97 karl 1.1
98 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.
99 karl 1.1 100 This version of the Pegasus User Manual was created at \today 101 */
102 karl 1.12 /* The following is the complete file haearchy for this document. 103 We ahve tried to keep all file references in only this one place 104 to make modification easier. In the future, please keep the 105 references here and text in the individual files.
106 karl 1.1 */ 107 //@{
108 karl 1.5 //@Include: objectives.dxx
109 karl 1.1 //@Include: overview.dxx 110 //@Include: credits.dxx 111 //@Include: Architecture.dxx 112 //@Include: Components.dxx
113 karl 1.5 //@Include: Utilization.dxx 114 //@Include: CIMOBJECTS.dxx
115 karl 1.12 //@{ 116 //@Include: CIMOBJECTTable.dxx 117 //@{
118 karl 1.5 //@Include: ..\..\src\Pegasus\Common\Array.h
119 karl 1.9 //@Include: ..\..\src\Pegasus\Common\CIMClass.h 120 //@Include: ..\..\src\Pegasus\Common\CIMDateTime.h 121 //@Include: ..\..\src\Pegasus\Common\CIMQualifierDecl.h
122 karl 1.5 //@Include: ..\..\src\Pegasus\Common\String.h
123 karl 1.9 //@Include: ..\..\src\Pegasus\Common\CIMType.h 124 //@Include: ..\..\src\Pegasus\Common\CIMInstance.h 125 //@Include: ..\..\src\Pegasus\Common\CIMValue.h 126 //@Include: ..\..\src\Pegasus\Common\CIMParameter.h 127 //@Include: ..\..\src\Pegasus\Common\CIMProperty.h 128 //@Include: ..\..\src\Pegasus\Common\CIMScope.h 129 //@Include: ..\..\src\Pegasus\Common\CIMReference.h 130 //@Include: ..\..\src\Pegasus\Common\CIMQualifierList.h 131 //@Include: ..\..\src\Pegasus\Common\CIMQualifierNames.h 132 //@Include: ..\..\src\Pegasus\Common\CIMQualifier.h 133 //@Include: ..\..\src\Pegasus\Common\CIMName.h 134 //@Include: ..\..\src\Pegasus\Common\CIMMethod.h 135 //@Include: ..\..\src\Pegasus\Common\CIMFlavor.h
136 karl 1.5 //@Include: ..\..\src\Pegasus\Common\Char16.h
137 karl 1.9 //@Include: ..\..\src\Pegasus\Common\DeclContext.h
138 karl 1.12 //@{ 139 //@Include: ..\..\src\Pegasus\Common\Exception.dxx
140 karl 1.11 //@Include: ..\..\src\Pegasus\Common\Exception.h
141 karl 1.12 //@} 142 //@}
143 karl 1.11
144 karl 1.5 //@}
145 karl 1.1 //@Include: Interfaces.dxx 146 //@{
147 karl 1.8 //@Include: CIMOperations.dxx 148 //@{
149 karl 1.9 //@Include: ..\..\src\Pegasus\Common\CIMOperations.h
150 karl 1.8 //@}
151 karl 1.1 //@Include: ClientInterfaces.dxx 152 //@{
153 karl 1.9 //@Include: ..\..\src\Pegasus\Client\CIMClient.h
154 karl 1.1 //@} 155 //@Include: ProviderInterfaces.dxx
156 karl 1.9 //@{ 157 //@Include: ..\..\src\Pegasus\Provider\CIMProvider.h 158 //@}
159 karl 1.1 //@Include: ServiceInterfaces.dxx
160 karl 1.7 //@Include: RepositoryInterfaces.dxx
161 karl 1.8 //@{
162 karl 1.9 //@Include: ..\..\src\Pegasus\Repository\CIMRepository.h
163 karl 1.8 //@}
164 karl 1.1 //@}
165 karl 1.8
166 karl 1.5 //@Include: ProviderWriting.dxx
167 karl 1.1 //@Include: definitions.dxx 168 //@Include: Examples.dxx
169 karl 1.12 170 //@{ 171 //@Include: ExamplesClient.dxx 172 //@Include: ExamplesProvider.dxx 173 //@}
174 karl 1.8 //@Include: references.dxx
175 karl 1.5 //@Include: FAQ.dxx
176 karl 1.1 //@} 177

No CVS admin address has been configured