err.no Git - sope/blob - sope-appserver/NGObjWeb/sope-ngobjweb-defaults.5

   1 .TH sope-ngobjweb 8 "October 2004" SOPE "User Manuals"
   2 .\" Copyright (c) 2004 Helge Hess. All rights reserved.
   3 .\" ====================================================================
   4 .\"
   5 .\" Copyright (c) 2004 Helge Hess.  All rights reserved.
   6 .\"
   7 .\" Check the COPYING file for further information.
   8 .\"
   9 .\" Created with the help of:
  10 .\"   http://www.schweikhardt.net/man_page_howto.html
  11 .\"
  12
  13 .SH NAME
  14 sope-ngobjweb \- Defaults for the libNGObjWeb library (part of SOPE)
  15
  16 .SH DESCRIPTION
  17 The
  18 .B sope-ngobjweb
  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
  21 applications.
  22
  23 .SH BUGS
  24 SOPE related bugs are collected in the OpenGroupware.org Bugzilla:
  25   http://bugzilla.opengroupware.org/
  26
  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
  35 default.
  36 .IP "-WOAutoOpenInBrowser YES|NO (NO)"
  37 WOAutoOpenInBrowser is a WO compatibility default and does not do anything on
  38 non MacOSX platforms.
  39 .IP "-WOCGIAdaptorURL url (empty)"
  40 WOCGIAdaptorURL is a WO compatibility default and does not do anything in
  41 combination with SOPE. SOPE does not require those URLs because it is always
  42 in "direct connect mode".
  43 .IP "-WOContactSNS YES|NO (NO)"
  44 Whether the application should register with a snsd load balancing server.
  45 .IP "-WOCoreOnApplicationException YES|NO (NO)"
  46 If enabled, the application will call the system abort() function in case an
  47 uncatched exception occures. Abort will generate a coredump, so that you can
  48 analyze the cause for an exception. Only enable in development environments!
  49 .IP "-WODebuggingEnabled YES|NO (NO)"
  50 Enable NGObjWeb debug logs.
  51 .IP "-WODefaultSessionTimeOut duration (3600)"
  52 Use this option to set the default session timeout. The duration value is in
  53 specified seconds.
  54 .IP "-WODefaultLanguages array-of-language-codes"
  55 The language array specifies for what languages resource lookups are performed.
  56 .IP "-WOExpirationTimeInterval seconds (120)"
  57 Sets the interval in which session stores check whether sessions are expired
  58 and need to be shut down.
  59 .IP "-WOFrameworksBaseURL url (/WebObjects/Frameworks)"
  60 WOFrameworksBaseURL is a WO compatibility default and currently does not do
  61 anything in SOPE.
  62 .IP "-WOGenerateMissingResourceLinks YES|NO (NO)"
  63 If a resource (eg a filename in WOImage) could not be found, SOPE will generate
  64 a replacement URL.
  65 .IP "-WOLogDefaultsOnStartup YES|NO (NO)"
  66 When enabled, a SOPE will print all configured defaults to stdout on startup.
  67 .IP "-WOLogPageCache YES|NO (NO)"
  68 Print log messages when pages are stored or retrieved from the session page
  69 cache.
  70 .IP "-WONoProxySuffixes array-of-strings (empty array)"
  71 .IP "-WOPageCacheSize number (30)"
  72 .IP "-WOPageRefreshOnBacktrack YES|NO (YES)"
  73 .IP "-WOPermanentPageCacheSize number (30)"
  74 .IP "-WOProjectSearchPath array-of-pathes (empty array)"
  75 .IP "-WOSMTPHost hostname (mail)"
  76 .IP "-WOSendMail path (/usr/lib/sendmail)"
  77 .IP "-WOSessionStore classname (WOServerSessionStore)"
  78 .IP "-WOStatsStylesheetName string (WOStats.xsl)"
  79
  80 .SH Component Defaults
  81 This section describes component and template related defaults.
  82 .IP "-WOCachingEnabled YES|NO (YES)"
  83 If this default is enabled SOPE will cache all templates and won't check for
  84 changes. So you might want to disable caching during development but you
  85 definitely should leaved that enabled for deployments or get a huge performance
  86 hit.
  87 .IP "-WOComponentExtensions array-of-exts ( (wo) )"
  88 The option specifies what directory extensions will be treated as wrapper
  89 components extensions.
  90 .IP "-WOComponentLoadWOOFiles YES|NO (NO)"
  91 Component wrappers can contained serialized objects like datasources in so
  92 called .woo files. This options enables the loading of those serialized files
  93 at a minor speed hit.
  94 .IP "-WOCompoundElementPool YES|NO (NO)"
  95 Wrap each rendering of a compound template element in an NSAutoreleasePool.
  96 This can help to find memory bugs hidden in templates. You might also want
  97 to enable double release checks in the NSAutoreleasePool when using this
  98 option
  99 .IP "-WOCoreOnAwakeComponentInCtxDealloc YES|NO (NO)"
 100 This default can be used to debug situations where a context is being
 101 deallocated but a component is still awake. In such a situation the framework
 102 will trigger a coredump using abort() which can be used to investigate.
 103 Never enable in deployments!
 104 .IP "-WOCoreOnRecursiveSubcomponents YES|NO (NO)"
 105 When enabled, the framework will generate a coredump if a component makes a
 106 recursive call to itself. Note that this is not necessarily a bug.
 107 .IP "-WODebugActions YES|NO (NO)"
 108 .IP "-WODebugComponentAwake YES|NO (NO)"
 109 .IP "-WODebugComponentDefinition YES|NO (NO)"
 110 .IP "-WODebugComponentLookup YES|NO (NO)"
 111 .IP "-WODebugCursor YES|NO (NO)"
 112 .IP "-WODebugKeyPathAssociation YES|NO (NO)"
 113 .IP "-WODebugResourceLookup YES|NO (NO)"
 114 .IP "-WODebugStaticLinkProcessing YES|NO (NO)"
 115 .IP "-WODebugTakeValues YES|NO (NO)"
 116 .IP "-WODescriptiveElementIDs YES|NO (NO)"
 117 .IP "-WOEnableComponentsWithoutClasses YES|NO (NO)"
 118 When enabled SOPE will not print a warning if it finds a template but no
 119 matching Objective-C class or script.
 120 .IP "-WOFormAlwaysPassDown YES|NO (YES)"
 121 Disable this option if the WOForm dynamic element should only run the take
 122 values phase on its child elements if the form URI or element id matches the
 123 request. This might confuse dynamic elements which are not form elements but
 124 nevertheless want to take values from the request (like the DnD elements).
 125 .IP "-WOLogComponents YES|NO (NO)"
 126 When enabled, the WOContext will log when a component enters or leaves the
 127 component stack. This is useful to debug how components are activated.
 128 .IP "-WONoSelectionString string (WONoSelectionString)"
 129 The string to be used for empty selections in the WOPopUpButton dynamic
 130 element.
 131 .IP "-WOParsersUseUTF8 YES|NO (NO)"
 132 Only affects wrapper templates (XML templates use XML to specify the charset).
 133 When enabled, .html and .wod files will always be parsed in the UTF-8 encoding,
 134 otherwise the Foundation system (cstring) encoding will be used.
 135 .IP "-WOResourceURLAssociationDebugEnabled YES|NO (NO)"
 136 .IP "-WOUseRelativeURLs YES|NO (YES)"
 137 .IP "-WOKeyPathAssociationsCacheSize number (200)"
 138 .IP "-WOValueAssociationsCacheSize number (200)"
 139 .IP "-WOxFileExtensions array-of-strings ( wox, xtmpl, xhtml )"
 140 An array of the extensions for files which are to be loaded as WOx (XML based)
 141 templates.
 142 .IP "-WOxElemBuilder_LogAssociationMapping YES|NO (NO)"
 143 .IP "-WOxElemBuilder_LogAssociationCreation YES|NO (NO)"
 144 .IP "-WOxComponentElemBuilderDebugEnabled YES|NO (NO)"
 145 .IP "-WOxLogBuilderQueue YES|NO (NO)"
 146 .IP "-WOxBuilderClasses - array-of-classnames"
 147 .IP "-WOxAssociationClassMapping - dict-of-uri-to-classnam"
 148
 149 .SH Request Handler Defaults
 150 .IP "-WOComponentRequestHandlerKey string (wo)"
 151 The name to be used in the URL for component request handler URLs (action
 152 binding URLs).
 153 .IP "-WODirectActionRequestHandlerKey string (x)"
 154 The name to be used in the URL for direct action request handler URLs. You
 155 may want to set this option to 'wa' for improved WO compatibility.
 156 .IP "-WOResourceRequestHandlerKey string (y)"
 157 The name to be used in the URL for resource request handler URLs.
 158 .IP "-WOPageRequestHandlerDebugEnabled YES|NO (NO)"
 159 Enable/disable debug logs in the page request handler.
 160
 161 .SH SoObjects Defaults
 162 .IP "-WOIsRedirectionEnabled YES|NO (NO)"
 163 .IP "-SoClassRegistryDebugEnabled YES|NO (NO)"
 164 .IP "-SoDebugKeyLookup YES|NO (NO)"
 165 .IP "-SoDebugTraversal YES|NO (NO)"
 166 .IP "-SoDebugProductLoading YES|NO (NO)"
 167 .IP "-SoDebugProductRegistry YES|NO (NO)"
 168 .IP "-SoDebugRequestClassification YES|NO (NO)"
 169 .IP "-SoLogSecurityDeclarations YES|NO (NO)"
 170 .IP "-SoOFSDebugFactory YES|NO (NO)"
 171 .IP "-SoOFSDebugPlistObject YES|NO (NO)"
 172 .IP "-SoOFSDebugRestore YES|NO (NO)"
 173 .IP "-SoOFSDebugNegotiate YES|NO (NO)"
 174 .IP "-SoOFSDebugAuthLookup YES|NO (NO)"
 175 .IP "-SoOFSWebMethodDebugEnabled YES|NO (NO)"
 176 .IP "-SoOFSResourceManagerDebugEnabled YES|NO (NO)"
 177 .IP "-SoObjCClassDebugEnabled YES|NO (NO)"
 178 .IP "-SoObjectSOAPDispatcherDebugEnabled YES|NO (NO)"
 179 .IP "-SoObjectDataSourceDebugEnabled YES|NO (NO)"
 180 .IP "-SoObjectRequestHandlerDebugEnabled YES|NO (NO)"
 181 .IP "-SoObjectMethodDispatcherDebugEnabled YES|NO (NO)"
 182 .IP "-SoPageInvocationDebugEnabled YES|NO (NO)"
 183 .IP "-SoProductResourceManagerDebugEnabled YES|NO (NO)"
 184 .IP "-SoRendererDebugEnabled YES|NO (NO)"
 185 .IP "-SoRedirectToDefaultMethods YES|NO (YES)"
 186 .IP "-SoSecurityManagerDebugEnabled YES|NO (NO)"
 187 .IP "-SoRequestDispatcherRules rules-array"
 188
 189 .SH XML-RPC Subsystem Defaults
 190 .IP "-WOCoreOnXmlRpcFault YES|NO (NO)"
 191 .IP "-WOLogXmlRpcSelectorMapping YES|NO (NO)"
 192 .IP "-SoObjectXmlRpcDispatcherDebugEnabled YES|NO (NO)" = NO"
 193
 194 .SH WebDAV Subsystem Defaults
 195 .IP "-SoObjectDAVDispatcherDebugEnabled YES|NO (NO)"
 196 .IP "-SoPreferredNamespacePrefixes dict-of-uri-to-name"
 197 .IP "-SoDefaultWebDAVPropertyNames array-of-fqn"
 198 .IP "-SoWebDAVFormatOutput YES|NO (NO)"
 199 .IP "-DAVParserDebugProp YES|NO (NO)"
 200 .IP "-SoWebDAVDefaultAllowMethods array-of-http-mehtods (GET, HEAD, ...)"
 201 .IP "-SoWebDAVDetectionMethods array-of-http-methods (OPTIONS,MKCOL, ...)"
 202
 203 .SH Adaptor Defaults
 204 The NGObjWeb adaptor accepts requests from the outside and turns them into
 205 events in the SOPE application server. Do not mix up the NGObjWeb adaptor
 206 (which is a class inside the SOPE based server) with the mod_ngobjweb Apache
 207 module.
 208 .IP "-WOAdaptor classname (WOHttpAdaptor)"
 209 This argument selects the SOPE adaptor class used to receive requests from the
 210 outside. The only adaptor provided by SOPE itself is WOHttpAdaptor.
 211 .IP "-WOAdaptorLogPath path (empty)"
 212 Using this option you can select a path where all SOPE HTTP transactions are
 213 logged to.
 214 .IP "-WOAdditionalAdaptors array-of-strings (empty)"
 215 While -WOAdaptor selects the primary adaptor SOPE applications will receive
 216 input from, this option allows for any number of additional input ports.
 217 .IP "-WOCoreOnHTTPAdaptorException YES|NO (NO)"
 218 .IP "-WODebugHttpTransaction YES|NO (NO)"
 219 .IP "-WODebugZipResponse YES|NO (NO)"
 220 .IP "-WODontZipResponse YES|NO (NO)"
 221 In the default configuration SOPE compresses all responses if the browser
 222 supports that. Enable this option to disable compression which can be useful
 223 in combination with WOHttpAdaptor_LogStream.
 224 .IP "-WOHttpAdaptorReceiveTimeout           = 120"
 225 .IP "-WOHttpAdaptorSendTimeout              = 120"
 226 .IP "-WOHttpAdaptor_LogStream YES|NO (NO)"
 227 Log the complete HTTP transaction on stdout. You might also want to set
 228 WODontZipResponse to disable zip compression (otherwise you will only see
 229 'scrambled' output)
 230 .IP "-WOHttpAllowHost hostname|array-of-hostnames (localhost)"
 231 SOPE checks the IP of the client prior accepting a connection. Per default it
 232 only allows connects from localhost. In deployments you should always connect
 233 applications through Apache/mod_ngobjweb and keep the client restriction.
 234 .IP "-WOHttpTransactionUseSimpleParser YES|NO (NO)"
 235 Select whether the more complex/slow MIME parser or the new lightweight HTTP
 236 parser ('simple parser') should be used. The latter doesn't support all
 237 features required for HTML forms processing and should only be used for WebDAV
 238 and XML-RPC clients.
 239 .IP "-WOIncludeCommentsInResponse YES|NO (YES)"
 240 When disabled, HTML comments will be stripped from .html wrapper templates
 241 prior delivery to the client (WOx templates always strip comments). This might
 242 clash with JavaScript tags in your templates and is therefore enabled per
 243 default.
 244 .IP "-WOListenQueueSize number (5)"
 245 This parameter configures the backlog size of the socket listen queue. See the
 246 listen (2) call for further information.
 247 .IP "-WOOutputValidationEnabled YES|NO (NO)"
 248 .IP "-WOPort number (20000)"
 249 The port the SOPE application will listen on.
 250 .IP "-WORunMultithreaded YES|NO (NO)"
 251 Enable/disable multi threading in SOPE. Note that SOPE 4.5 is not considered
 252 thread safe.
 253 .IP "-WOWorkerThreadCount number (0)"
 254 Configures the number of worker threads which are used to receive/send requests
 255 and responses in parallel to the application processing. This is currently
 256 unsupported by the SOPE WOHttpAdaptor.
 257 .IP "-WOSimpleHTTPParserDebugEnabled YES|NO (NO)"
 258 .IP "-WOSimpleHTTPParserFileIOBoundary number (16384)"
 259 .IP "-WOSimpleHTTPParserHeavyDebugEnabled YES|NO (NO)"
 260 .IP "-WOSimpleHTTPParserMaxUploadSizeInKB number (262144)"
 261
 262 .SH Profiling Defaults
 263 .IP "-WOProfileApplication YES|NO (NO)"
 264 .IP "-WOProfileComponents YES|NO (NO)"
 265 .IP "-WOProfileDirectActionRequestHandler YES|NO (NO)"
 266 .IP "-WOProfileElements YES|NO (NO)"
 267 .IP "-WOProfileHttpAdaptor YES|NO (NO)"
 268 .IP "-WOProfileLoading YES|NO (NO)"
 269 .IP "-WOProfileResponse YES|NO (NO)"
 270
 271 .SH Deprecated Defaults
 272 .IP "-WOLogScriptDealloc YES|NO (NO)"
 273 .IP "-WOLogScriptInit YES|NO (NO)"
 274 .IP "-WOLogScriptKVC YES|NO (NO)"
 275
 276 .SH AUTHOR
 277 Helge Hess <helge.hess@opengroupware.org>
 278
 279 .SH SEE ALSO
 280 .BR httpd (8),
 281 .BR Defaults (5).