1 .TH sope-ngobjweb 8 "October 2004" SOPE "User Manuals"
2 .\" Copyright (c) 2004 Helge Hess. All rights reserved.
3 .\" ====================================================================
5 .\" Copyright (c) 2004 Helge Hess. All rights reserved.
7 .\" Check the COPYING file for further information.
9 .\" Created with the help of:
10 .\" http://www.schweikhardt.net/man_page_howto.html
14 sope-ngobjweb \- Defaults for the libNGObjWeb library (part of SOPE)
19 library implements the core web application server of SOPE. NGObjWeb provides
20 a lot of defaults to configure operation and logging of SOPE based
24 SOPE related bugs are collected in the OpenGroupware.org Bugzilla:
25 http://bugzilla.opengroupware.org/
27 .SH Application Defaults
28 This section describes defaults which are related to general application setup.
29 .IP "-WOApplicationBaseURL url (empty)"
30 Select a different base URL. Do not touch this option unless you know what you
31 are doing. It is overridden by the application URL set by mod_ngobjweb.
32 .IP "-WOApplicationSuffix suffix (.woa)"
33 The default selects the extension of the application wrapper. If you use a
34 different application extension (eg .app), you need to properly configure this
36 .IP "-WOAutoOpenInBrowser YES|NO (NO)"
37 WOAutoOpenInBrowser is a WO compatibility default and doesn't do anything on
39 .IP "-WOCGIAdaptorURL url (empty)"
40 WOCGIAdaptorURL is a WO compatibility default and doesn't do anything in
41 combination with SOPE. SOPE doesn't require those URLs because it is always
42 in "direct connect mode".
43 .IP "-WOContactSNS = NO"
44 .IP "-WOCoreOnApplicationException = NO"
45 .IP "-WODebuggingEnabled = NO"
46 .IP "-WODefaultSessionTimeOut = 3600"
47 .IP "-WODefaultLanguages - array-of-language-codes"
48 .IP "-WOExpirationTimeInterval = 120"
49 .IP "-WOFrameworksBaseURL = "/WebObjects/Frameworks""
50 .IP "-WOGenerateMissingResourceLinks = NO"
51 .IP "-WOLogDefaultsOnStartup = NO"
52 .IP "-WOLogPageCache = NO"
53 .IP "-WOLogScriptDealloc = NO"
54 .IP "-WOLogScriptInit = NO"
55 .IP "-WOLogScriptKVC = NO"
56 .IP "-WONoProxySuffixes = ( )"
57 .IP "-WOPageCacheSize = 30"
58 .IP "-WOPageRefreshOnBacktrack = YES"
59 .IP "-WOPermanentPageCacheSize = 30"
60 .IP "-WOProjectSearchPath = ()"
61 .IP "-WOSMTPHost = "mail""
62 .IP "-WOSendMail = "/usr/lib/sendmail""
63 .IP "-WOSessionStore = "WOServerSessionStore""
64 .IP "-WOStatsStylesheetName = "WOStats.xsl""
66 .SH Component Defaults
67 This section describes component and template related defaults.
68 .IP "-WOCachingEnabled YES|NO (YES)"
69 If this default is enabled SOPE will cache all templates and won't check for
70 changes. So you might want to disable caching during development but you
71 definitely should leaved that enabled for deployments or get a huge performance
73 .IP "-WOComponentExtensions array-of-exts ( (wo) )"
74 The option specifies what directory extensions will be treated as wrapper
75 components extensions.
76 .IP "-WOComponentLoadWOOFiles YES|NO (NO)"
77 Component wrappers can contained serialized objects like datasources in so
78 called .woo files. This options enables the loading of those serialized files
80 .IP "-WOCompoundElementPool YES|NO (NO)"
81 .IP "-WOCoreOnAwakeComponentInCtxDealloc = NO"
82 .IP "-WOCoreOnRecursiveSubcomponents = NO"
83 .IP "-WODebugActions = NO"
84 .IP "-WODebugComponentAwake = NO"
85 .IP "-WODebugComponentDefinition = NO"
86 .IP "-WODebugComponentLookup = NO"
87 .IP "-WODebugCursor = NO"
88 .IP "-WODebugKeyPathAssociation = NO"
89 .IP "-WODebugResourceLookup = NO"
90 .IP "-WODebugStaticLinkProcessing = NO"
91 .IP "-WODebugTakeValues = NO"
92 .IP "-WODescriptiveElementIDs = NO"
93 .IP "-WOEnableComponentsWithoutClasses = NO"
94 .IP "-WOFormAlwaysPassDown = YES"
95 .IP "-WOKeyPathAssociationsCacheSize = 200"
96 .IP "-WOLogComponents = NO"
97 .IP "-WONoSelectionString = "WONoSelectionString""
98 .IP "-WOParsersUseUTF8 = NO"
99 .IP "-WOResourceURLAssociationDebugEnabled = NO"
100 .IP "-WOUseRelativeURLs = YES"
101 .IP "-WOValueAssociationsCacheSize = 200"
102 .IP "-WOxFileExtensions = ( wox, xtmpl, xhtml )"
103 .IP "-WOxElemBuilder_LogAssociationMapping = NO"
104 .IP "-WOxElemBuilder_LogAssociationCreation = NO"
105 .IP "-WOxComponentElemBuilderDebugEnabled = NO"
106 .IP "-WOxLogBuilderQueue = NO"
107 .IP "-WOxBuilderClasses - array-of-classname"
108 .IP "-WOxAssociationClassMapping - dict-of-uri-to-classnam"
110 .SH Request Handler Defaults
111 .IP "-WOComponentRequestHandlerKey string (wo)"
112 The name to be used in the URL for component request handler URLs (action
114 .IP "-WODirectActionRequestHandlerKey = "x""
115 .IP "-WOPageRequestHandlerDebugEnabled = NO"
116 .IP "-WOResourceRequestHandlerKey = "y""
118 .SH SoObjects Defaults
119 .IP "-WOIsRedirectionEnabled = NO"
120 .IP "-SoClassRegistryDebugEnabled = NO"
121 .IP "-SoDebugKeyLookup = NO"
122 .IP "-SoDebugTraversal = NO"
123 .IP "-SoDebugProductLoading = NO"
124 .IP "-SoDebugProductRegistry = NO"
125 .IP "-SoDebugRequestClassification = NO"
126 .IP "-SoLogSecurityDeclarations = NO"
127 .IP "-SoOFSDebugFactory = NO"
128 .IP "-SoOFSDebugPlistObject = NO"
129 .IP "-SoOFSDebugRestore = NO"
130 .IP "-SoOFSDebugNegotiate = NO"
131 .IP "-SoOFSDebugAuthLookup = NO"
132 .IP "-SoOFSWebMethodDebugEnabled = NO"
133 .IP "-SoOFSResourceManagerDebugEnabled = NO"
134 .IP "-SoObjCClassDebugEnabled = NO"
135 .IP "-SoObjectSOAPDispatcherDebugEnabled = NO"
136 .IP "-SoObjectDataSourceDebugEnabled = NO"
137 .IP "-SoObjectRequestHandlerDebugEnabled = NO"
138 .IP "-SoObjectMethodDispatcherDebugEnabled = NO"
139 .IP "-SoPageInvocationDebugEnabled = NO"
140 .IP "-SoProductResourceManagerDebugEnabled = NO"
141 .IP "-SoRendererDebugEnabled = NO"
142 .IP "-SoRedirectToDefaultMethods = YES"
143 .IP "-SoSecurityManagerDebugEnabled = NO"
144 .IP "-SoRequestDispatcherRules rules-array"
146 .SH XML-RPC Subsystem Defaults
147 .IP "-WOCoreOnXmlRpcFault = NO"
148 .IP "-WOLogXmlRpcSelectorMapping = NO"
149 .IP "-SoObjectXmlRpcDispatcherDebugEnabled = NO"
151 .SH WebDAV Subsystem Defaults
152 .IP "-SoObjectDAVDispatcherDebugEnabled = NO"
153 .IP "-SoPreferredNamespacePrefixes dict-of-uri-to-name"
154 .IP "-SoDefaultWebDAVPropertyNames array-of-fqn"
155 .IP "-SoWebDAVFormatOutput = NO"
156 .IP "-DAVParserDebugProp = NO"
157 .IP "-SoWebDAVDefaultAllowMethods array-of-http-mehtods (GET, HEAD, ...)"
158 .IP "-SoWebDAVDetectionMethods array-of-http-methods (OPTIONS,MKCOL, ...)"
161 The NGObjWeb adaptor accepts requests from the outside and turns them into
162 events in the SOPE application server. Do not mix up the NGObjWeb adaptor
163 (which is a class inside the SOPE based server) with the mod_ngobjweb Apache
165 .IP "-WOAdaptor classname (WOHttpAdaptor)"
166 This argument selects the SOPE adaptor class used to receive requests from the
167 outside. The only adaptor provided by SOPE itself is WOHttpAdaptor.
168 .IP "-WOAdaptorLogPath path (empty)"
169 Using this option you can select a path where all SOPE HTTP transactions are
171 .IP "-WOAdditionalAdaptors array-of-strings (empty)"
172 While -WOAdaptor selects the primary adaptor SOPE applications will receive
173 input from, this option allows for any number of additional input ports.
174 .IP "-WOCoreOnHTTPAdaptorException = NO"
175 .IP "-WODebugHttpTransaction = NO"
176 .IP "-WODebugZipResponse = NO"
177 .IP "-WODontZipResponse = NO"
178 .IP "-WOHttpAdaptorReceiveTimeout = 120"
179 .IP "-WOHttpAdaptorSendTimeout = 120"
180 .IP "-WOHttpAdaptor_LogStream = NO"
181 .IP "-WOHttpAllowHost = "localhost""
182 .IP "-WOHttpTransactionUseSimpleParser = NO"
183 .IP "-WOIncludeCommentsInResponse = YES"
184 .IP "-WOListenQueueSize = 5"
185 .IP "-WOOutputValidationEnabled = NO"
186 .IP "-WOPort = 20000"
187 .IP "-WORunMultithreaded = NO"
188 .IP "-WOWorkerThreadCount = 0"
189 .IP "-WOSimpleHTTPParserDebugEnabled = NO"
190 .IP "-WOSimpleHTTPParserFileIOBoundary = 16384"
191 .IP "-WOSimpleHTTPParserHeavyDebugEnabled = NO"
192 .IP "-WOSimpleHTTPParserMaxUploadSizeInKB = 262144"
194 .SH Profiling Defaults
195 .IP "-WOProfileApplication = NO"
196 .IP "-WOProfileComponents = NO"
197 .IP "-WOProfileDirectActionRequestHandler = NO"
198 .IP "-WOProfileElements = NO"
199 .IP "-WOProfileHttpAdaptor = NO"
200 .IP "-WOProfileLoading = NO"
201 .IP "-WOProfileResponse = NO"
204 Helge Hess <helge.hess@opengroupware.org>