[interchange-docs] xmldocs - docelic modified 17 files
docs at icdevgroup.org
docs at icdevgroup.org
Mon Jan 12 00:49:59 UTC 2009
User: docelic
Date: 2009-01-12 00:49:59 GMT
Modified: refs PreForkSingleFork ReadPermission RedirectCache
Modified: RemoteUser Replace Require RobotHost RobotIP
Modified: RobotUA TableRestrict TagGroup TagInclude
Modified: TaxShipping TcpMap TemplateDir TrackFile TrustProxy
Log:
* Updates to R*/T* config directives
Revision Changes Path
1.2 xmldocs/refs/PreForkSingleFork
rev 1.2, prev_rev 1.1
Index: PreForkSingleFork
===================================================================
RCS file: /var/cvs/xmldocs/refs/PreForkSingleFork,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PreForkSingleFork 11 Jan 2009 12:49:45 -0000 1.1
+++ PreForkSingleFork 12 Jan 2009 00:49:59 -0000 1.2
@@ -1,5 +1,5 @@
__NAME__ purpose
-ensure the prefork code path is entirely controllable by the value of PreFork
+perform one instead of two forks in PreFork mode
__END__
@@ -17,15 +17,14 @@
__NAME__ description
This directive affects ⁣ behavior in conjunction with
-&conf-PreFork;, ensuring the prefork code path is entirely
-controllable by the value of &conf-PreFork;.
+&conf-PreFork;, by using one instead of two <function>fork()</function>
+calls to prefork a server.
</para><para>
-If you're running PreFork, you should use it in combination with
-&conf-PreForkSingleFork;, to create the absolute minimal number of forks
-necessary. Only turn &conf-PreForkSingleFork; off
-if it causes zombie processes to pile up.
+If you are running &IC; in prefork mode, you should use it in combination with
+this directive. Only turn &conf-PreForkSingleFork; off if it causes zombie
+processes to pile up on your system.
</para><para>
-This method reduces system overhead due to forking and is the fastest and
+This method reduces system overhead when forking and is the fastest and
best way to run a busy &IC; server.
__END__
1.3 xmldocs/refs/ReadPermission
rev 1.3, prev_rev 1.2
Index: ReadPermission
===================================================================
RCS file: /var/cvs/xmldocs/refs/ReadPermission,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ReadPermission 6 Nov 2006 18:41:21 -0000 1.2
+++ ReadPermission 12 Jan 2009 00:49:59 -0000 1.3
@@ -15,7 +15,7 @@
__NAME__ description
By default, only the user account that &IC; runs under,
can read and read files created by &IC;. The specified option allows
-adjustment of file &glos-mode;s (read permissions, specifically).
+adjustment of file read permissions.
__END__
__NAME__ example: Producing desired read and write file modes
1.3 xmldocs/refs/RedirectCache
rev 1.3, prev_rev 1.2
Index: RedirectCache
===================================================================
RCS file: /var/cvs/xmldocs/refs/RedirectCache,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- RedirectCache 8 Jan 2009 17:28:46 -0000 1.2
+++ RedirectCache 12 Jan 2009 00:49:59 -0000 1.3
@@ -1,24 +1,33 @@
-* Add RedirectCache directive which allows redirected page requests to
- be set to mv_tmp_session then written to the target from which it was
- redirected. This allows a complete web site to be mirrored to static
- HTML as it is requested, accompanied with the proper setting of
- AcceptRedirect in Interchange and ErrorDocument in the Apache server.
-
- To use:
-
- * Set ErrorDocument 404 to the Interchange URL in Apache.
-
- * Set "AcceptRedirect Yes" in interchange.cfg.
-
- * Set "RedirectCache /var/www/html" in interchange.cfg (use
- your document root in place of /var/www/html).
-
- When a page http://yourdomain.tld/subdir/page.html is not found,
- Interchange gets a redirect which causes it to set mv_tmp_session=1.
- If Interchange doesn't find the page, then it returns "missing" and
- no writing is done. If IC does find the page, it is written to
- /var/www/html/subdir/page.html and the page will be found on next
- access.
+__NAME__ purpose
+use Interchange to generate static web server pages
+__END__
+__NAME__ synopsis
+<arg choice='plain'><replaceable>directory_name</replaceable></arg>
+__END__
+
+
+__NAME__ description
+This directive, along with &conf-AcceptRedirect;, allows
+the web server to route requests for missing static HTML pages to &IC;.
+Interchange processes the requests and saves the produced static content
+to the directory pointed by &conf-__FILENAME__;. On next web server
+page access, the pages are found and served as static content by the
+web server directly.
+</para><para>
+Requests routed to &IC; in this way use a temporary session (<mv>mv_tmp_session</mv>).
+In case the &IC; page is not found, the usual &conf-SpecialPage; "missing"
+is shown and no writing to the web server HTML directory takes place.
+__END__
+
+__NAME__ example: Enabling __FILENAME__
+<programlisting>
+AcceptRedirect Yes
+__FILENAME__ /var/www/html
+</programlisting>
+__END__
+
+__NAME__ see also
+AcceptRedirect
+__END__
-session is not initialized with redirectcache
1.3 xmldocs/refs/RemoteUser
rev 1.3, prev_rev 1.2
Index: RemoteUser
===================================================================
RCS file: /var/cvs/xmldocs/refs/RemoteUser,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- RemoteUser 6 Nov 2006 18:41:21 -0000 1.2
+++ RemoteUser 12 Jan 2009 00:49:59 -0000 1.3
@@ -11,7 +11,7 @@
__NAME__ description
Specify required value of the <envar>REMOTE_USER</envar> HTTP environment
variable that will enable catalog reconfiguration. HTTP basic authentication
-must be set configured independently at web server side, for this to work.
+must be configured at web server side for this to work.
__END__
1.3 xmldocs/refs/Replace
rev 1.3, prev_rev 1.2
Index: Replace
===================================================================
RCS file: /var/cvs/xmldocs/refs/Replace,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Replace 15 Feb 2008 18:24:50 -0000 1.2
+++ Replace 12 Jan 2009 00:49:59 -0000 1.3
@@ -10,11 +10,12 @@
__NAME__ description
-Cause another directive's value to be emptied and re-set to the specified
+Cause &glos-configuration; directive's value to be emptied and reset to the specified
value, or to its default.
</para><para>
-This is primarily useful for directives which append to existing
-definition by default, so at first glance there's no way to "clean" them.
+This is useful primarily for resetting configuration directives which append
+to existing data, so there's no other convenient way to reset them to
+initial values.
__END__
__NAME__ notes
@@ -28,5 +29,6 @@
__END__
__NAME__ see also
+AddDirective
__END__
1.12 xmldocs/refs/Require
rev 1.12, prev_rev 1.11
Index: Require
===================================================================
RCS file: /var/cvs/xmldocs/refs/Require,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- Require 7 Nov 2007 00:48:44 -0000 1.11
+++ Require 12 Jan 2009 00:49:59 -0000 1.12
@@ -16,8 +16,7 @@
__NAME__ description
Just like &conf-Capability; or &conf-Suggest;, this directive checks for
a feature or capability. When the tested feature is missing, a
-catalog is <emphasis role='bold'>not</emphasis> configured and included
-in global configuration.
+catalog is not configured and not included in global configuration.
</para><para>
This is useful to ensure that needed facilities are present, especially if
you run the catalog on different locations.
1.4 xmldocs/refs/RobotHost
rev 1.4, prev_rev 1.3
Index: RobotHost
===================================================================
RCS file: /var/cvs/xmldocs/refs/RobotHost,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- RobotHost 27 Jun 2007 00:02:31 -0000 1.3
+++ RobotHost 12 Jan 2009 00:49:59 -0000 1.4
@@ -27,7 +27,8 @@
visiting does not earn you extra points, and may in fact be
detected by the robot and punished.
</para><para>
-It's important to note that the directive accepts a wildcard list —
+It's important to note that the directive accepts a wildcard list similar
+to globbing —
<literal>*</literal> represents any number of characters, while
<literal>?</literal> represents a single character.
__END__
1.4 xmldocs/refs/RobotIP
rev 1.4, prev_rev 1.3
Index: RobotIP
===================================================================
RCS file: /var/cvs/xmldocs/refs/RobotIP,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- RobotIP 27 Jun 2007 00:02:31 -0000 1.3
+++ RobotIP 12 Jan 2009 00:49:59 -0000 1.4
@@ -27,7 +27,8 @@
visiting does not earn you extra points, and may in fact be
detected by the robot and punished.
</para><para>
-It's important to note that the directive accepts a wildcard list —
+It's important to note that the directive accepts a wildcard list similar
+to globbing —
<literal>*</literal> represents any number of characters, while
<literal>?</literal> represents a single character.
__END__
1.4 xmldocs/refs/RobotUA
rev 1.4, prev_rev 1.3
Index: RobotUA
===================================================================
RCS file: /var/cvs/xmldocs/refs/RobotUA,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- RobotUA 27 Jun 2007 00:02:31 -0000 1.3
+++ RobotUA 12 Jan 2009 00:49:59 -0000 1.4
@@ -27,7 +27,8 @@
visiting does not earn you extra points, and may in fact be
detected by the robot and punished.
</para><para>
-It's important to note that the directive accepts a wildcard list —
+It's important to note that the directive accepts a wildcard list similar
+to globbing —
<literal>*</literal> represents any number of characters, while
<literal>?</literal> represents a single character.
__END__
1.5 xmldocs/refs/TableRestrict
rev 1.5, prev_rev 1.4
Index: TableRestrict
===================================================================
RCS file: /var/cvs/xmldocs/refs/TableRestrict,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TableRestrict 6 Nov 2006 18:41:21 -0000 1.4
+++ TableRestrict 12 Jan 2009 00:49:59 -0000 1.5
@@ -60,8 +60,8 @@
__NAME__ example: Searching using SQL
-When using SQL-based database searches, this directive in effect
-turns the base search query of say,
+When using SQL-based database searches, the <literal>owner=username</literal>
+directive in effect turns the base search query of say,
<programlisting>
SELECT * FROM products
</programlisting>
1.3 xmldocs/refs/TagGroup
rev 1.3, prev_rev 1.2
Index: TagGroup
===================================================================
RCS file: /var/cvs/xmldocs/refs/TagGroup,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TagGroup 6 Nov 2006 18:41:21 -0000 1.2
+++ TagGroup 12 Jan 2009 00:49:59 -0000 1.3
@@ -5,7 +5,7 @@
__NAME__ synopsis
<arg choice='plain'><literal>:</literal><replaceable>group_name</replaceable></arg>
- <arg choice='plain' rep='repeat'>code_declaration_names</arg>
+ <arg choice='plain' rep='repeat'><replaceable>code_declaration_names</replaceable></arg>
__END__
1.3 xmldocs/refs/TagInclude
rev 1.3, prev_rev 1.2
Index: TagInclude
===================================================================
RCS file: /var/cvs/xmldocs/refs/TagInclude,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TagInclude 6 Nov 2006 18:41:21 -0000 1.2
+++ TagInclude 12 Jan 2009 00:49:59 -0000 1.3
@@ -7,11 +7,7 @@
__END__
__NAME__ synopsis
- <arg choice='opt'><literal>!</literal></arg>
- <group choice='opt' rep='repeat'>
- <arg choice='plain'><literal>:</literal><replaceable>group_name</replaceable></arg>
- <arg choice='plain'><replaceable>tag_name</replaceable></arg>
- </group>
+ <arg choice='opt'><literal>!</literal></arg><group choice='opt' rep='repeat'><arg choice='plain'><literal>:</literal><replaceable>group_name</replaceable></arg><arg choice='plain'><replaceable>tag_name</replaceable></arg></group>
__END__
1.3 xmldocs/refs/TaxShipping
rev 1.3, prev_rev 1.2
Index: TaxShipping
===================================================================
RCS file: /var/cvs/xmldocs/refs/TaxShipping,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TaxShipping 6 Nov 2006 18:41:21 -0000 1.2
+++ TaxShipping 12 Jan 2009 00:49:59 -0000 1.3
@@ -16,7 +16,7 @@
__NAME__ description
-Specify states or jurisdictions that <replaceable>tax</replaceable> shipping costs.
+Specify states or jurisdictions that tax shipping costs.
__END__
__NAME__ example: Defining TaxShipping
1.4 xmldocs/refs/TcpMap
rev 1.4, prev_rev 1.3
Index: TcpMap
===================================================================
RCS file: /var/cvs/xmldocs/refs/TcpMap,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- TcpMap 16 Mar 2008 21:29:27 -0000 1.3
+++ TcpMap 12 Jan 2009 00:49:59 -0000 1.4
@@ -68,9 +68,10 @@
<literal>tlink</literal> (Inet &glos-link-program;) still relies only on
the <envar>SCRIPT_PATH</envar> environment variable to determine which
catalog was requested. This means that the
-functional equivalent of catalogs bound to ports can still be achieved,
-by use of Web server location aliases and &IC; script path aliases. Actually,
-you'd probably want to do this just to reduce the length of
+functional equivalent of catalogs bound to ports can still be achieved (without
+&conf-TcpMap;),
+by the use of Web server location aliases and &IC; script path aliases.
+Actually, you'd probably want to do this just to reduce the length of
&glos-HTML; links.
</para><para>
Here's an example of needed &APACHE; Web server configuration:
1.5 xmldocs/refs/TemplateDir
rev 1.5, prev_rev 1.4
Index: TemplateDir
===================================================================
RCS file: /var/cvs/xmldocs/refs/TemplateDir,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TemplateDir 15 Feb 2008 18:24:50 -0000 1.4
+++ TemplateDir 12 Jan 2009 00:49:59 -0000 1.5
@@ -9,22 +9,23 @@
__NAME__ description
-Specify directories containing default pages. This effectively allows you to
-keep pages common for all &glos-catalog;s in common directories, or — in case
-of a catalog directive — extend the page
-search outside the catalog's <filename class='directory'>pages/</filename>
-directory.
+Specify directories containing default pages that are to be looked up if pages
+are not found in the usual &conf-PageDir;. This effectively allows
+keeping pages common for all &glos-catalog;s in common directories,
+or — in case
+of a catalog directive — extending page
+search outside the catalog's &conf-PageDir;.
__END__
-__NAME__ example: Setting TemplateDir
+__NAME__ example: Setting __FILENAME__
<programlisting>
-TemplateDir /usr/local/interchange/default_pages
+__FILENAME__ /usr/local/interchange/default_pages
</programlisting>
__END__
-__NAME__ example: Setting TemplateDir to multiple directories
+__NAME__ example: Setting __FILENAME__ to multiple directories
<programlisting>
-TemplateDir /usr/local/interchange/default_pages /common/pages
+__FILENAME__ /usr/local/interchange/default_pages /common/pages
</programlisting>
__END__
1.7 xmldocs/refs/TrackFile
rev 1.7, prev_rev 1.6
Index: TrackFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/TrackFile,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- TrackFile 15 Feb 2008 18:24:50 -0000 1.6
+++ TrackFile 12 Jan 2009 00:49:59 -0000 1.7
@@ -12,7 +12,7 @@
Specify the <emphasis>usertrack</emphasis> log file location.
</para><para>
User &glos-tracking; can be used in back office administration to summarize
-traffic by affiliates.
+traffic by affiliates or provide other statistics.
__END__
__NAME__ notes
1.3 xmldocs/refs/TrustProxy
rev 1.3, prev_rev 1.2
Index: TrustProxy
===================================================================
RCS file: /var/cvs/xmldocs/refs/TrustProxy,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- TrustProxy 6 Nov 2006 18:41:21 -0000 1.2
+++ TrustProxy 12 Jan 2009 00:49:59 -0000 1.3
@@ -38,7 +38,7 @@
__NAME__ notes
"Globs" are <literal>*</literal> and <literal>?</literal>. The
-<literal>*</literal> stands for any number of characters (including 0), while
+<literal>*</literal> stands for any number of characters (including none), while
<literal>?</literal> stands for 1 character exactly.
</para><para>
The directive could, in general, be also used with external, untrusted HTTP
More information about the docs
mailing list