[docs] xmldocs - docelic modified 6 files

Sun May 22 06:21:29 EDT 2005

User:      docelic
Date:      2005-05-22 10:21:28 GMT
Modified:  refs     ConfDir ExecutionLocale HouseKeeping
Added:     refs     CategoryField ChildLife DefaultLocale
Log:
Fixes and 3 new config directives

Revision  Changes    Path
1.2       +25 -0     xmldocs/refs/ConfDir


rev 1.2, prev_rev 1.1
Index: ConfDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/ConfDir,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2

--- ConfDir	21 May 2005 12:51:29 -0000	1.1
+++ ConfDir	22 May 2005 10:21:28 -0000	1.2
@@ -1,5 +1,30 @@
+__NAME__ purpose
+specify catalog "config" directory
+__END__
 
 
+__NAME__ synopsis
+<group choice='req'>
+	<arg choice='plain'>directory</arg>
+</group>
+__END__
+
+
+__NAME__ description
+Specify catalog "config" directory. By default, this is
+<filename>etc/</filename> inside &glos-CATROOT;.
+__END__
+
+__NAME__ notes
+Make sure you don't get confused by the existence of all
+&conf-DirConfig;, &conf-ConfDir; and &conf-ConfigDir;.
+__END__
+
+__NAME__ example: Redefining ConfDir
+<programlisting>
+ConfDir etc2
+</programlisting>
+__END__
 
 __NAME__ notes
 Make sure you don't get confused by the existence of all



1.2       +1 -1      xmldocs/refs/ExecutionLocale


rev 1.2, prev_rev 1.1
Index: ExecutionLocale
===================================================================
RCS file: /var/cvs/xmldocs/refs/ExecutionLocale,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ExecutionLocale	21 May 2005 12:51:29 -0000	1.1
+++ ExecutionLocale	22 May 2005 10:21:28 -0000	1.2
@@ -1,5 +1,5 @@
 __NAME__ purpose
-specify the lowest-level locale
+specify lowest-level locale
 __END__
 
 



1.5       +1 -1      xmldocs/refs/HouseKeeping


rev 1.5, prev_rev 1.4
Index: HouseKeeping
===================================================================
RCS file: /var/cvs/xmldocs/refs/HouseKeeping,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- HouseKeeping	21 May 2005 12:51:29 -0000	1.4
+++ HouseKeeping	22 May 2005 10:21:28 -0000	1.5
@@ -11,7 +11,7 @@
 
 
 __NAME__ description
-Specify at which intervals should the Interchange server 
+Specify time &glos-interval;s at which should the Interchange server 
 <emphasis>wake up</emphasis> and
 look for user reconfiguration requests and hung search processes. On some
 systems, this wakeup is the only time the server will terminate in response



1.1                  xmldocs/refs/CategoryField


rev 1.1, prev_rev 1.0
Index: CategoryField
===================================================================
__NAME__ purpose
specify name of the "category" field in the Interchange database
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'><replaceable>field_name</replaceable></arg>
</group>
__END__


__NAME__ description
By default, &IC; expects item category to be in the 
<database class='field'>category</database> field in the database,
if a system of categories is used.
This directive allows modification of the default name.
__END__


__NAME__ notes
The field can also be set according to a &conf-Locale;.
__END__

__NAME__ example: Redefining CategoryField
<programlisting>
CategoryField type
</programlisting>
__END__




1.1                  xmldocs/refs/ChildLife


rev 1.1, prev_rev 1.0
Index: ChildLife
===================================================================
__NAME__ purpose
define maximum child process lifetime
__END__


__NAME__ see also
PreFork,MaxServers,PIDcheck,PIDfile,HouseKeeping
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'><replaceable>interval</replaceable></arg>
</group>
__END__


__NAME__ description
Occasionally, in &conf-PreFork; mode, you will find child processes that get
"starved", in other words they never seem to win the battle and receive a
page request so they just sit there forever.
</para><para>
The &conf-ChildLife; directive times out a page server after a period
of time.
</para><para>
If &conf-ChildLife; is not set, the default, the server will act just
like it does now, stuck in that internal loop forever until
<command>kill -9</command> happens.
</para><para>
All the directive does is set the start_time of the server, and then when
&conf-HouseKeeping; gets triggered, it checks the current time and terminates
the server (just like &conf-MaxRequestsPerChild;, basically) if it
has expired.
</para><para>
This should clear up the problem where people see with a growing number of
servers over time.
__END__

__NAME__ notes
The directive is only used when &IC; is in <literal>PreFork</literal>
&glos-ic-run-mode;.
</para><para>
The directive value can be any Interchange &glos-interval;.
__END__


__NAME__ example: Setting ChildLife
<programlisting>
ChildLife 30 minutes
</programlisting>
__END__

__NAME__ author
&mheins;
__END__



1.1                  xmldocs/refs/DefaultLocale


rev 1.1, prev_rev 1.0
Index: DefaultLocale
===================================================================
__NAME__ purpose
specify default locale
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'>locale definition</arg>
</group>
__END__


__NAME__ description
The directive specifies the default &glos-locale;.
__END__

__NAME__ notes
If two locales are set "default" using &conf-Locale;, and no
&conf-DefaultLocale; is specified, the behavior is undefined as the first
"default" found will be set as the actual default.
__END__

__NAME__ example: Defining DefaultLocale
<programlisting>
DefaultLocale hr_HR
</programlisting>
__END__

__NAME__ example: Achieving effect of DefaultLocale using Locale directive
Exactly the same effect as in the above example can be produced with:
<programlisting>
Locale  hr_HR  default 1
</programlisting>
__END__


__NAME__ see also
Locale
__END__

__NAME__ author
&mheins;
__END__






