[docs] docs - heins modified icconfig.sdf
docs@interchange.redhat.com
docs@interchange.redhat.com
Fri Jul 26 18:15:12 2002
User: heins
Date: 2002-07-26 22:14:45 GMT
Modified: . icconfig.sdf
Log:
* Document pre-fork configuration directives, other updates.
Revision Changes Path
1.67 +66 -20 docs/icconfig.sdf
rev 1.67, prev_rev 1.66
Index: icconfig.sdf
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /anon_cvs/repository/docs/icconfig.sdf,v
retrieving revision 1.66
retrieving revision 1.67
diff -u -r1.66 -r1.67
--- icconfig.sdf 26 Jul 2002 02:52:27 -0000 1.66
+++ icconfig.sdf 26 Jul 2002 22:14:45 -0000 1.67
@@ -1,10 +1,10 @@
!init OPT_LOOK=3D"akopia"; OPT_STYLE=3D"manual"
-# $Id: icconfig.sdf,v 1.66 2002/07/26 02:52:27 mheins Exp $
+# $Id: icconfig.sdf,v 1.67 2002/07/26 22:14:45 mheins Exp $
=20
!define DOC_NAME "Configuration Reference"
!define DOC_TYPE ""
!define DOC_CODE "icconfig"
-!define DOC_VERSION substr('$Revision: 1.66 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.67 $',11, -2)
!define DOC_STATUS "Draft"
!define DOC_PROJECT "Interchange"
!define DOC_URL "http://interchange.redhat.com/doc/icconfig.html"
@@ -138,16 +138,6 @@
=20
If the parser is not defined, the directive value will be scalar and the s=
ame as what the user passes in the config file. If defined, the parser must=
be extant before it can be referenced, is always resident in Vend::Config,=
and begins with the string C<parse_>. Examples can be found in the files i=
n the distribution software directory C<compat/>.
=20
-H2: AdminSub *global*
-
-Marks a global subroutine for use only by catalogs that are set to
-C<AllowGlobal> (see below). Normally global subroutines can be referenced =
(in
-embedded Perl) by any catalog.
-
-!block example
- AdminSub dangerous
-!endblock
-
H2: AllowGlobal *global*
=20
Specifies catalog identifiers that may define subroutines and UserTag entr=
ies
@@ -176,6 +166,16 @@
=20
See C<AutoVariable> in C<catalog.cfg>.
=20
+H2: Capability *global*
+
+Just like Require or Suggest, but can never cause a warning or message. Th=
is
+allows a module to be loaded if available and for a program to check for
+that capability later and adapt itself to the configuration.
+
+!block example
+ Capability module Archive::Zip
+!endblock
+
H2: Catalog *global*
=20
Specifies a catalog that can run using this Interchange server. This direc=
tive
@@ -231,6 +231,20 @@
CheckHTML /usr/local/bin/weblint
!endblock
=20
+H2: CodeDef *global*
+
+A generic subroutine mapper that allows mapping of a subroutine as a=20
+{{CMD[jump=3D"icconfig.html#ActionMap *global*"]ActionMap}},
+CoreTag,
+{{CMD[jump=3D"icconfig.html#Filter"]Filter}},
+{{CMD[jump=3D"icconfig.html#FormAction *global*"]FormAction}},
+{{CMD[jump=3D"icconfig.html#GlobalSub *global*"]GlobalSub}},
+{{CMD[jump=3D"icconfig.html#ItemAction"]ItemAction}},
+LocaleChange,
+OrderCheck,
+{{CMD[jump=3D"icconfig.html#UserTag *global*"]UserTag}},
+Widget.
+
H2: ConfigAllAfter *global*
=20
The name of a file (or files) which should be read as a part of every cata=
log's configuration, after any other configuration files are read. Default =
is C<catalog_after.cfg>.
@@ -545,6 +559,17 @@
Mall Yes
!endblock
=20
+H2: MaxRequestsPerChild *global*
+
+The maximum number of requests a page server will handle before it commits
+suicide and asks for a replacement server. This prevents runaway memory l=
eaks.
+
+!block example
+ MaxRequestsPerChild 100
+!endblock
+
+Default is 50. Only applies in {{CMD[jump=3D"icconfig.html#PreFork *global=
*"]PreFork}} mode.
+
H2: MaxServers *global*
=20
The maximum number of servers that will be spawned to handle page
@@ -603,6 +628,26 @@
=20
This file must be writable by the Interchange server user ID.
=20
+H2: PreFork *global*
+
+Causes Interchange to run in pre-forking server mode, where a number of
+Interchange server daemons (defined in
+{{CMD[jump=3D"icconfig.html#StartServers *global*"]StartServers}}) will be
+pre-spawned to handle page requests. Each server will handle the number
+of requests defined in
+{{CMD[jump=3D"icconfig.html#MaxRequestsPerChild *global*"]MaxRequestsPerCh=
ild}}
+before committing suicide and causing another server to pre-fork to replac=
e it.
+
+!block example
+ PreFork Yes
+!endblock
+
+This reduces system overhead due to forking and is the fastest and
+best way to run a busy Interchange server.
+settings that will apply for all catalogs.
+
+A yes/no directive, default is C<No>.
+
H2: Profiles *global*
=20
Names a file (or files) which contain C<OrderProfile> and C<SearchProfile>
@@ -634,23 +679,23 @@
=20
If set to Yes, allows handling of SOAP rpc requests.
=20
-H2: SOAP_Host
+H2: SOAP_Host *global*
=20
The list of hosts that are allowed to connect to for SOAP rpc requests. De=
fault
is C<localhost 127.0.0.1>.
=20
-H2: SOAP_MaxRequests
+H2: SOAP_MaxRequests *global*
=20
The maximum number of requests a SOAP rpc server will handle before it com=
mits
suicide and asks for a replacement server. This prevents runaway memory le=
aks.
=20
-H2: SOAP_Perms
+H2: SOAP_Perms *global*
=20
The permissions that should be set on a SOAP UNIX-domain socket. Default is
C<0660>, which allows only programs running as the same UID as Interchange
to access the socket.
=20
-H2: SOAP_Socket
+H2: SOAP_Socket *global*
=20
A list of sockets which should be monitored for SOAP requests. If they
fit the form NNN.NNN.NNN.NNN:PPPP, they are IP addresses and ports for
@@ -661,7 +706,7 @@
SOAP_Socket 12.23.13.31:7770 1.2.3.4:7770 /var/run/interchange/soap
!endblock
=20
-H2: SOAP_StartServers
+H2: SOAP_StartServers *global*
=20
The number of SOAP servers which should be started to handle SOAP
requests. Default is 1.
@@ -693,13 +738,14 @@
bin/interchange -r SocketPerms=3D0666
!endblock
=20
-H2: StartServers
+H2: StartServers *global*
=20
The number of Interchange page servers which should be started to handle
-page requests when in C<PreFork> mode. Default is 1.
+page requests when in {{CMD[jump=3D"icconfig.html#PreFork *global*"]PreFor=
k}} mode.
+Default is 1.
=20
!block example
- SOAP_StartServers 10
+ StartServers 8
!endblock
=20
H2: SubCatalog *global*