BUG#:8664
[tpot/pegasus.git.bak/pegasus.git] / SetConfig_EnvVar.help
1 PEGASUS_ROOT {
2         path,
3         --source,
4         Directory where source is located,
5         Location where Pegasus source code is located.}
6
7 PEGASUS_HOME {
8         path,
9         --binary,
10         Directory where built binaries are deposited,
11         Location where Pegasus built binaries will be located. Can be the same as PEGASUS_ROOT.}
12
13 PEGASUS_HAS_SSL {
14         Boolean,
15         --enable-ssl,
16         Build in SSL support,
17         Enabling SSL will compile SSL support in Pegasus. If your SSL include files are located in a non-standard location, make sure to define OPENSSL_HOME with the right directory.}
18
19 OPENSSL_BIN {
20         PEGASUS_HAS_SSL,
21         path,
22         --openssl-bin,
23         OpenSSL binary directory,
24         Specifies the location of the OpenSSL binary. }
25
26 OPENSSL_HOME {
27         PEGASUS_HAS_SSL,
28         path,
29         --openssl,
30         OpenSSL directory,
31         Specifies the location of the OpenSSL SDK directory. This directory must contain the OpenSSL include and library directory. }
32
33 PEGASUS_ENABLE_SSLV2 {
34         PEGASUS_HAS_SSL,
35         Boolean,
36         --enable-sslv2,
37         Enable SSLv2 protocol,
38         By default, support for the SSLV2 protocol is disabled in OpenPegasus 2.5. The option can be used to build a version of OpenPegasus that supports SSV2. This variable affects how SSL contexts are constructed for both the CIM Server and CIM Clients. }
39
40 PEGASUS_PAM_AUTHENTICATION {
41         Boolean,
42         --enable-pam,
43         Enable PAM support,
44         Enabling PAM will compile PAM support in Pegasus and provide authentication.}
45
46 PEGASUS_USE_PAM_STANDALONE_PROC {
47         PEGASUS_PAM_AUTHENTICATION,
48         Boolean,
49         --enable-standalone-pam,
50         Enable a PAM workaround,
51         PAM authentication has a leak in it. This workaround provides a process which communicates with the CIMserver the authentication information without causing a memory leak in CIMserver.}
52
53 PEGASUS_ENABLE_USERGROUP_AUTHORIZATION {
54         Boolean,
55         --enable-usergroup-auth,
56         Enables restriction to CIM operations to specified groups,
57         Builds a version of OpenPegasus that allows an administrator to restrict access to CIM operations to members of a designed set of groups.  Refer to the  authorizedUserGroups configuration option for additional details. }
58
59 PEGASUS_ENABLE_REMOTE_CMPI {
60         Boolean,
61         --enable-remote-cmpi,
62         Enable Remote CMPI extension,
63         Remote CMPI enables providers to be run on remote systems without the need for an extra CIMOM. It uses a special proxying provider to relay requests to a remote location using so-called communication layers. The remote side has to start a CMPIRDaemon process, which accepts remote requests and passes them on to CMPI style providers.  Remote providers are fully binary compatible and need not to be recompiled.  Currently there are two types of remote provider available: out-of-process providers and TCP/IP providers using a separate daemon program.}
64
65
66 PEGASUS_ENABLE_JMPI_PROVIDER_MANAGER {
67         Boolean,
68         --enable-jmpi,
69         Enable Java provider support,
70         Enable support for Java providers.}
71
72 PEGASUS_ENABLE_EXECQUERY {
73         Boolean,
74         --enable-execquery,
75         Enables ExecQuery CIM support,
76         When this environment variable is set, processing of ExecQuery operations is enabled. When not set, ExecQuery operation requests get a NotSupported response. }
77
78 PEGASUS_ENABLE_COMPRESSED_REPOSITORY {
79         Boolean,
80         --enable-compressed-repository,
81         Enables compressed repository,
82         If set the Repository Comopression logic is built and enabled and compressed and non compressed repositories are supportted. If not set then compressed repositories are not supporttted. See readme.compression for more details. }
83
84 PEGASUS_ENABLE_SLP {
85         Boolean,
86         --enable-slp,
87         Enable SLP support,
88         Enables Service Locator Protocol. SLP is used in discovery of CIMOMs location.}
89
90 PEGASUS_DEBUG {
91         Boolean,
92         --enable-debug,
93         Compile in debug statements,
94         Provide more debug information.}
95
96 PEGASUS_USE_RELEASE_CONFIG_OPTIONS {
97         Boolean,
98         --use-release-config-options,
99         Compile code with release config options,
100         Compile the code with release config options built-in.}
101
102 PEGASUS_USE_RELEASE_DIRS {
103         Boolean,
104         --use-release-dirs,
105         Compile code with release dirs,
106         Compile code with release dirs built in.}
107
108 PEGASUS_DISABLE_LOCAL_DOMAIN_SOCKET {
109         Boolean,
110         --disable-domain-socket,
111         Disables support for domain socket connection,
112         Disables support for local (same-system) connections over a Unix domain socket. If this option is NOT set, the CIM Server is built to allow connections to be established using a domain socket rather than a TCP port. }
113
114 PEGASUS_DISABLE_PERFINST {
115         Boolean,
116         --disable-perfinst,
117         Disables support for gathering performance data,
118         Builds a version of OpenPegasus that disables support for gathering performance data.  The CIM_ObjectManager.GatherStatisticalData property is used to control statistic gathering. }
119
120 PEGASUS_DISABLE_PROV_USERCTXT {
121         Boolean,
122         --disable-prov-userctxt,
123         Disables support for the Provider User Context feature,
124         Builds a version of OpenPegasus that disables supports for the Provider User Context feature.  This feature allows a Provider to choose the user context in which it is invoked, including the ability to run in the context of the user requesting an operation. The Provider User Context feature may be disabled by compiling with the PEGASUS_DISABLE_PROV_USERCTXT flag defined. In this case, the Provider Registration Manager rejects provider registration requests that specify a UserContext property value. The user context in which providers run is then unchanged by this enhancement. Some platforms, such as OS/400 and z/OS may define the PEGASUS_DISABLE_PROV_USERCTXT as part of the platform configuration, since these platforms already set the provider user context on a per-thread basis.  When the Provider User Context feature is enabled, support for each of the User Context types may be disabled individually. Provider registration fails when an unsupported UserContext value is specified. }
125
126 PEGASUS_DISABLE_PROV_USERCTXT_CIMSERVER {
127         PEGASUS_DISABLE_PROV_USERCTXT,
128         Boolean,
129         --disable-prov-userctxt-cimserver,
130         Disables support for the Provider User Context "CIM Server" option,
131         Builds a version of OpenPegasus that disables support for the Provider User Context "CIM Server" option. Support for the "CIM Server" option allows a Provider to be invoked with the same user context as the CIM Server. This model supports providers that are released together with the CIM Server and for which the CIM Server's user context is known to be acceptable. The provider retains full responsibility for authorizing requesting users. }
132
133 PEGASUS_DISABLE_PROV_USERCTXT_DESIGNATED {
134         PEGASUS_DISABLE_PROV_USERCTXT,
135         Boolean,
136         --disable-prov-userctxt-designated,
137         Disables support for the Provider User Context "Designated" option,
138         uilds a version of OpenPegasus that disables support for the Provider User Context "Designated" option. Support for the "Privileged" option allows a Provider to be invoked in the context of a single, designated user. This option allows a provider to run in a consistent user context with an appropriate level of privilege. The provider retains full responsibility for authorizing requesting users. }
139
140 PEGASUS_DISABLE_PROV_USERCTXT_PRIVILEGED {
141         PEGASUS_DISABLE_PROV_USERCTXT,
142         Boolean,
143         --disable-prov-userctxt-privileged,
144         Disables support for the Provider User Context "Privileged" option,
145         Builds a version of OpenPegasus that disables support for the Provider User Context "Privileged" option. Support for the "Privileged" option allows a Provider to be invoked in the context of a privileged user, potentially escalating the privilege of the requesting user. The provider retains full responsibility for authorizing requesting users. The Privileged User model is much like the Designated User model, except that it clearly declares a privilege requirement and it allows such a provider to be written in a way that is portable across platforms for which the privileged user name differs. }
146
147 PEGASUS_DISABLE_PROV_USERCTXT_REQUESTOR {
148         PEGASUS_DISABLE_PROV_USERCTXT,
149         Boolean,
150         --disable-prov-userctxt-requestor,
151         Disables support to run providers as the "Requestor.",
152         Builds a version of OpenPegasus that will not allow a Provider to run as the "Requestor". Support for the "Requestor" option allows a Provider to be invoked in the context of the user requesting an operation. This option reduces the complexity of writing a provider, because authorization checks that the provider previously had to perform can instead be performed by the underlying platform or managed resource. This reduction in complexity is accompanied by an increase in the security of the solution, because the redundant authorization checks in the provider are likely to miss cases or get out of sync with the authorization model of the managed resource or underlying platform. }
153
154 ICU_INSTALL {
155         PEGASUS_HAS_MESSAGES,
156         path,
157         --icu-install,
158         Directory with ICU libraries,
159         When set, points to the directory containing the  ICU (International Components for Unicode) libraries. Note that the 'lib' sub-directory is appended to this variable. This is used during build to link to ICU. }
160
161 ICU_ROOT {
162         PEGASUS_HAS_MESSAGES,
163         path,
164         --icu-root,
165         Directory with ICU source code,
166         When set, points to the root directory of the  ICU (International Components for Unicode) source tree (ie. the directory before the source directory in the ICU distribution). This is used during build to compile against the ICU header files. }
167
168 PEGASUS_HAS_MESSAGES {
169         boolean,
170         --enable-messages,
171         Enable localization support,
172         If the PEGASUS_HAS_MESSAGES is not set, OpenPegasus is built without localization support. This means that all messages sent by the CIM Server and the CLIs are in English. ICU is an open source project at http://oss.software.ibm.com/icu. Only English tran/slations are included with the OpenPegasus distribution. The OpenPegasus distribution does not provide translated messages. But, enabling for ICU would allow vendor to provide the translations. Refer to the OpenPegasus Release README for additional information regarding the use of ICU.  }
173
174 PEGASUS_ENABLE_CQL {
175         Boolean,
176         --enable-cql,
177         Enables CQL support,
178         When this variable is set = true, support for Indication Subscription filters that have CQL as the language is compiled and enabled}
179
180 PEGASUS_DISABLE_DEPRECATED_INTERFACES {
181         Boolean,
182         --disable-deprecated-interfaces,
183          Removes deprecated symbol definitions,
184          Removes deprecated symbol definitions from Pegasus runtime libraries. If this option is set, the resulting Pegasus libraries will not be binary compatible with clients and providers built using interface definitions from prior releases. This option may be used to slightly reduce binary footprint in an environment where compatibility is not required. }
185
186 PEGASUS_EXTRA_C_FLAGS {
187         flag,
188         --extra-c-flags,
189         Extra C compiler flags,
190         This build option allows a developer to specify an additional set of flags to be included on  the C compile command line. If you don't have any, just leave it blank.}
191
192 PEGASUS_EXTRA_CXX_FLAGS {
193         flag,
194         --extra-cxx-flags,
195         Extra C++ compiler flags,
196         This build option allows a developer to specify an additional set of flags to be included on the C++ compile command line. If you don't have any, just leave it blank}
197
198 PEGASUS_EXTRA_LINK_FLAGS {
199         flag,
200         --extra-link-flags,
201         Extra link flag,
202         This build option allows a developer to specify an additional set of flags to be included on the link command line. If you don't have any, just leave it blank}
203
204 PEGASUS_REPOSITORY_MODE {
205         flag,
206         --repository-mode,
207         Controls how repository is built,
208         Contols if the repository is built in XML or Binary Mode. Only affects he build envirment and not the runtime. Use cimconfig to modify the runtime environment. Possible Values: XML or BIN. XML causes repository to be built in XML mode. BIN causes reposiory to be built in binary mode. }
209
210 PEGASUS_NOASSERTS {
211         boolean,
212         --noasserts,
213         Remove asserts,
214         Defines the NDEBUG compilation macro, which causes the preprocessor to remove PEGASUS_ASSERT() statements. }
215         
216