]> err.no Git - sope/commitdiff
started some makefiles
authorhelge <helge@e4a50df8-12e2-0310-a44c-efbce7f8a7e3>
Fri, 15 Oct 2004 23:20:04 +0000 (23:20 +0000)
committerhelge <helge@e4a50df8-12e2-0310-a44c-efbce7f8a7e3>
Fri, 15 Oct 2004 23:20:04 +0000 (23:20 +0000)
git-svn-id: http://svn.opengroupware.org/SOPE/trunk@263 e4a50df8-12e2-0310-a44c-efbce7f8a7e3

sope-appserver/NGObjWeb/sope-ngobjweb-defaults.5 [new file with mode: 0644]
sope-appserver/SoOFS/sope.8 [new file with mode: 0644]

diff --git a/sope-appserver/NGObjWeb/sope-ngobjweb-defaults.5 b/sope-appserver/NGObjWeb/sope-ngobjweb-defaults.5
new file mode 100644 (file)
index 0000000..77a7a9d
--- /dev/null
@@ -0,0 +1,208 @@
+.TH sope-ngobjweb 8 "October 2004" SOPE "User Manuals"
+.\" Copyright (c) 2004 Helge Hess. All rights reserved.
+.\" ====================================================================
+.\"
+.\" Copyright (c) 2004 Helge Hess.  All rights reserved.
+.\"
+.\" Check the COPYING file for further information.
+.\"
+.\" Created with the help of:
+.\"   http://www.schweikhardt.net/man_page_howto.html
+.\"
+
+.SH NAME
+sope-ngobjweb \- Defaults for the libNGObjWeb library (part of SOPE)
+
+.SH DESCRIPTION
+The
+.B sope-ngobjweb
+library implements the core web application server of SOPE. NGObjWeb provides
+a lot of defaults to configure operation and logging of SOPE based
+applications.
+
+.SH BUGS
+SOPE related bugs are collected in the OpenGroupware.org Bugzilla:
+  http://bugzilla.opengroupware.org/
+
+.SH Application Defaults
+This section describes defaults which are related to general application setup.
+.IP "-WOApplicationBaseURL url (empty)"
+Select a different base URL. Do not touch this option unless you know what you
+are doing. It is overridden by the application URL set by mod_ngobjweb.
+.IP "-WOApplicationSuffix suffix (.woa)"
+The default selects the extension of the application wrapper. If you use a
+different application extension (eg .app), you need to properly configure this 
+default.
+.IP "-WOAutoOpenInBrowser YES|NO (NO)"
+WOAutoOpenInBrowser is a WO compatibility default and doesn't do anything on
+non MacOSX platforms.
+.IP "-WOCGIAdaptorURL url (empty)"
+WOCGIAdaptorURL is a WO compatibility default and doesn't do anything in
+combination with SOPE. SOPE doesn't require those URLs because it is always
+in "direct connect mode".
+.IP "-WOContactSNS                          = NO"
+.IP "-WOCoreOnApplicationException          = NO"
+.IP "-WODebuggingEnabled                    = NO"
+.IP "-WODefaultSessionTimeOut               = 3600"
+.IP "-WODefaultLanguages - array-of-language-codes"
+.IP "-WOExpirationTimeInterval              = 120"
+.IP "-WOFrameworksBaseURL                   = "/WebObjects/Frameworks""
+.IP "-WOGenerateMissingResourceLinks        = NO"
+.IP "-WOLogDefaultsOnStartup                = NO"
+.IP "-WOLogPageCache                        = NO"
+.IP "-WOLogScriptDealloc                    = NO"
+.IP "-WOLogScriptInit                       = NO"
+.IP "-WOLogScriptKVC                        = NO"
+.IP "-WONoProxySuffixes                     = ( )"
+.IP "-WOPageCacheSize                       = 30"
+.IP "-WOPageRefreshOnBacktrack              = YES"
+.IP "-WOPermanentPageCacheSize              = 30"
+.IP "-WOProjectSearchPath                   = ()"
+.IP "-WOSMTPHost                            = "mail""
+.IP "-WOSendMail                            = "/usr/lib/sendmail""
+.IP "-WOSessionStore                        = "WOServerSessionStore""
+.IP "-WOStatsStylesheetName                 = "WOStats.xsl""
+
+.SH Component Defaults
+This section describes component and template related defaults.
+.IP "-WOCachingEnabled YES|NO (YES)"
+If this default is enabled SOPE will cache all templates and won't check for
+changes. So you might want to disable caching during development but you
+definitely should leaved that enabled for deployments or get a huge performance
+hit.
+.IP "-WOComponentExtensions array-of-exts ( (wo) )"
+The option specifies what directory extensions will be treated as wrapper
+components extensions.
+.IP "-WOComponentLoadWOOFiles YES|NO (NO)"
+Component wrappers can contained serialized objects like datasources in so
+called .woo files. This options enables the loading of those serialized files
+at a minor speed hit.
+.IP "-WOCompoundElementPool YES|NO (NO)"
+.IP "-WOCoreOnAwakeComponentInCtxDealloc    = NO"
+.IP "-WOCoreOnRecursiveSubcomponents   = NO"
+.IP "-WODebugActions                        = NO"
+.IP "-WODebugComponentAwake                    = NO"
+.IP "-WODebugComponentDefinition            = NO"
+.IP "-WODebugComponentLookup           = NO"
+.IP "-WODebugCursor                         = NO"
+.IP "-WODebugKeyPathAssociation             = NO"
+.IP "-WODebugResourceLookup                 = NO"
+.IP "-WODebugStaticLinkProcessing           = NO"
+.IP "-WODebugTakeValues                        = NO"
+.IP "-WODescriptiveElementIDs               = NO"
+.IP "-WOEnableComponentsWithoutClasses      = NO"
+.IP "-WOFormAlwaysPassDown                  = YES"
+.IP "-WOKeyPathAssociationsCacheSize        = 200"
+.IP "-WOLogComponents                       = NO"
+.IP "-WONoSelectionString                   = "WONoSelectionString""
+.IP "-WOParsersUseUTF8                      = NO"
+.IP "-WOResourceURLAssociationDebugEnabled  = NO"
+.IP "-WOUseRelativeURLs                     = YES"
+.IP "-WOValueAssociationsCacheSize          = 200"
+.IP "-WOxFileExtensions                     = ( wox, xtmpl, xhtml )"
+.IP "-WOxElemBuilder_LogAssociationMapping  = NO"
+.IP "-WOxElemBuilder_LogAssociationCreation = NO"
+.IP "-WOxComponentElemBuilderDebugEnabled      = NO"
+.IP "-WOxLogBuilderQueue                    = NO"
+.IP "-WOxBuilderClasses - array-of-classname"
+.IP "-WOxAssociationClassMapping - dict-of-uri-to-classnam"
+
+.SH Request Handler Defaults
+.IP "-WOComponentRequestHandlerKey string (wo)"
+The name to be used in the URL for component request handler URLs (action
+binding URLs).
+.IP "-WODirectActionRequestHandlerKey       = "x""
+.IP "-WOPageRequestHandlerDebugEnabled      = NO"
+.IP "-WOResourceRequestHandlerKey           = "y""
+
+.SH SoObjects Defaults
+.IP "-WOIsRedirectionEnabled                = NO"
+.IP "-SoClassRegistryDebugEnabled          = NO"
+.IP "-SoDebugKeyLookup                     = NO"
+.IP "-SoDebugTraversal                     = NO"
+.IP "-SoDebugProductLoading                = NO"
+.IP "-SoDebugProductRegistry               = NO"
+.IP "-SoDebugRequestClassification         = NO"
+.IP "-SoLogSecurityDeclarations            = NO"
+.IP "-SoOFSDebugFactory                    = NO"
+.IP "-SoOFSDebugPlistObject                = NO"
+.IP "-SoOFSDebugRestore                    = NO"
+.IP "-SoOFSDebugNegotiate                  = NO"
+.IP "-SoOFSDebugAuthLookup                 = NO"
+.IP "-SoOFSWebMethodDebugEnabled           = NO"
+.IP "-SoOFSResourceManagerDebugEnabled     = NO"
+.IP "-SoObjCClassDebugEnabled              = NO"
+.IP "-SoObjectSOAPDispatcherDebugEnabled   = NO"
+.IP "-SoObjectDataSourceDebugEnabled       = NO"
+.IP "-SoObjectRequestHandlerDebugEnabled   = NO"
+.IP "-SoObjectMethodDispatcherDebugEnabled = NO"
+.IP "-SoPageInvocationDebugEnabled         = NO"
+.IP "-SoProductResourceManagerDebugEnabled = NO"
+.IP "-SoRendererDebugEnabled               = NO"
+.IP "-SoRedirectToDefaultMethods           = YES"
+.IP "-SoSecurityManagerDebugEnabled        = NO"
+.IP "-SoRequestDispatcherRules rules-array"
+
+.SH XML-RPC Subsystem Defaults
+.IP "-WOCoreOnXmlRpcFault                   = NO"
+.IP "-WOLogXmlRpcSelectorMapping            = NO"
+.IP "-SoObjectXmlRpcDispatcherDebugEnabled = NO"
+
+.SH WebDAV Subsystem Defaults
+.IP "-SoObjectDAVDispatcherDebugEnabled    = NO"
+.IP "-SoPreferredNamespacePrefixes dict-of-uri-to-name"
+.IP "-SoDefaultWebDAVPropertyNames array-of-fqn"
+.IP "-SoWebDAVFormatOutput = NO"
+.IP "-DAVParserDebugProp = NO"
+.IP "-SoWebDAVDefaultAllowMethods array-of-http-mehtods (GET, HEAD, ...)"
+.IP "-SoWebDAVDetectionMethods array-of-http-methods (OPTIONS,MKCOL, ...)"
+
+.SH Adaptor Defaults
+The NGObjWeb adaptor accepts requests from the outside and turns them into
+events in the SOPE application server. Do not mix up the NGObjWeb adaptor
+(which is a class inside the SOPE based server) with the mod_ngobjweb Apache
+module.
+.IP "-WOAdaptor classname (WOHttpAdaptor)"
+This argument selects the SOPE adaptor class used to receive requests from the
+outside. The only adaptor provided by SOPE itself is WOHttpAdaptor.
+.IP "-WOAdaptorLogPath path (empty)"
+Using this option you can select a path where all SOPE HTTP transactions are
+logged to.
+.IP "-WOAdditionalAdaptors array-of-strings (empty)"
+While -WOAdaptor selects the primary adaptor SOPE applications will receive
+input from, this option allows for any number of additional input ports.
+.IP "-WOCoreOnHTTPAdaptorException          = NO"
+.IP "-WODebugHttpTransaction                = NO"
+.IP "-WODebugZipResponse                    = NO"
+.IP "-WODontZipResponse                     = NO"
+.IP "-WOHttpAdaptorReceiveTimeout           = 120"
+.IP "-WOHttpAdaptorSendTimeout              = 120"
+.IP "-WOHttpAdaptor_LogStream               = NO"
+.IP "-WOHttpAllowHost                       = "localhost""
+.IP "-WOHttpTransactionUseSimpleParser      = NO"
+.IP "-WOIncludeCommentsInResponse           = YES"
+.IP "-WOListenQueueSize                     = 5"
+.IP "-WOOutputValidationEnabled             = NO"
+.IP "-WOPort                                = 20000"
+.IP "-WORunMultithreaded                    = NO"
+.IP "-WOWorkerThreadCount                   = 0"
+.IP "-WOSimpleHTTPParserDebugEnabled        = NO"
+.IP "-WOSimpleHTTPParserFileIOBoundary      = 16384"
+.IP "-WOSimpleHTTPParserHeavyDebugEnabled   = NO"
+.IP "-WOSimpleHTTPParserMaxUploadSizeInKB   = 262144"
+
+.SH Profiling Defaults
+.IP "-WOProfileApplication                  = NO"
+.IP "-WOProfileComponents                   = NO"
+.IP "-WOProfileDirectActionRequestHandler   = NO"
+.IP "-WOProfileElements                     = NO"
+.IP "-WOProfileHttpAdaptor                  = NO"
+.IP "-WOProfileLoading                      = NO"
+.IP "-WOProfileResponse                     = NO"
+
+.SH AUTHOR
+Helge Hess <helge.hess@opengroupware.org>
+
+.SH SEE ALSO
+.BR httpd (8),
+.BR Defaults (5).
diff --git a/sope-appserver/SoOFS/sope.8 b/sope-appserver/SoOFS/sope.8
new file mode 100644 (file)
index 0000000..9e9f8cc
--- /dev/null
@@ -0,0 +1,63 @@
+.TH sope 8 "October 2004" OpenGroupware.org "User Manuals"
+.\" Copyright (c) 2004 Helge Hess. All rights reserved.
+.\" ====================================================================
+.\"
+.\" Copyright (c) 2004 Helge Hess.  All rights reserved.
+.\"
+.\" Check the COPYING file for further information.
+.\"
+.\" Created with the help of:
+.\"   http://www.schweikhardt.net/man_page_howto.html
+.\"
+
+.SH NAME
+sope-4.3 \- A tool to serve template based SOPE sites.
+.SH SYNOPSIS
+.B sope-4.3 
+[
+.BI \-WOPort " port"
+]
+
+.SH DESCRIPTION
+.B sope-4.3
+is a generic server to serve SOPE applications composed of just templates
+and products.
+.PP
+Note that you should not connect
+.B sope-4.3
+directly on its port using your client, but rather use
+.B mod_ngobjweb
+in combination with
+.B Apache.
+
+.SH OPTIONS
+.TP 12
+.IP "-WOPort port"
+This option sets the TCP/IP port the
+.B sope-4.3
+server is running on and which the mod_ngobjweb will connect to.
+
+.SH FILES
+.I /etc/opengroupware.org/NSGlobalDomain.plist
+.RS
+This file contains configurations which apply to all SOPE related daemons.
+.RE
+.I /etc/opengroupware.org/sope-4.3.plist
+.RS
+Configurations contained in this file overwrite those in the NSGlobalDomain.
+You can persist any command line option in this file using the
+.BR Defaults (5)
+tool.
+.RE
+
+.SH BUGS
+SOPE bugs are collected in the OpenGroupware.org Bugzilla:
+  http://bugzilla.opengroupware.org/
+
+.SH AUTHOR
+Helge Hess <helge.hess@opengroupware.org>
+
+.SH SEE ALSO
+.BR httpd (8),
+.BR sope-ngobjweb-defaults (8),
+.BR Defaults (5).