[docs] xmldocs - docelic modified 26 files
docs at icdevgroup.org
docs at icdevgroup.org
Sat Jun 11 19:39:26 EDT 2005
User: docelic
Date: 2005-06-11 23:39:26 GMT
Modified: . TODO
Modified: glossary internationalization profile session
Modified: refs AllowGlobal EncryptProgram NoCache NoImport
Modified: Password ProductFiles Profiles ScratchDefault
Added: glossary crypt
Added: howtos obtain-and-run-interchange
Added: refs LocaleDatabase MailOrderTo NoImportExternal
Added: NoSearch OfflineDir OrderCounter OrderLineLimit
Added: OrderProfile Replace RobotLimit SaveExpire
Added: ScratchDir
Log:
- 12 new and fixes/updates to the rest
Revision Changes Path
1.74 +3 -1 xmldocs/TODO
rev 1.74, prev_rev 1.73
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.73
retrieving revision 1.74
diff -u -r1.73 -r1.74
--- TODO 11 Jun 2005 17:22:36 -0000 1.73
+++ TODO 11 Jun 2005 23:39:25 -0000 1.74
@@ -1,12 +1,14 @@
Outstanding:
=======
- across glossary entries, insert <section>s
+- s/crypt/cypher/ , encrypt/encypher, etc..
+- in refs, replace "database" with "database_name", that kind of things
- import my hand-made test from /var/lib/.../pages/* to appropriate
ref pages as online examples
- At least in filters, <<EOR messes up the thing, only < is printed and stops
- bin/refs-autogen should report which refs/* files have comments in them
(text outside __NAME__ __END__ markers). It indicates there's a work to do
- on the item
+ on the item. Also XML files that have <!-- --> in them
s/0-1/No-Yes/
On config directives, include parse_<> function in source context
- See that if 'crypt' is put in see also, all symbols of that name appear
1.2 +2 -2 xmldocs/glossary/internationalization
rev 1.2, prev_rev 1.1
Index: internationalization
===================================================================
RCS file: /var/cvs/xmldocs/glossary/internationalization,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- internationalization 11 Jun 2005 08:29:00 -0000 1.1
+++ internationalization 11 Jun 2005 23:39:25 -0000 1.2
@@ -6,8 +6,8 @@
differing price formats, different currency definitions, price factoring,
sorting, and other settings. Currently, those features are implemented as
&IC;-specific, and do not rely on &PERL;'s I18N/L10N features, except for
-the built-in POSIX support (<code>use locale</code>,
-<function>getlocale()</function> and <function>setlocale()</function>).
+the built-in POSIX support (<code>use locale</code>
+and <function>setlocale()</function>).
</para><para>
The definitions are maintained in the &ccf; file, through the use of
Interchange's &conf-Locale; directive. All settings are
1.2 +6 -0 xmldocs/glossary/profile
rev 1.2, prev_rev 1.1
Index: profile
===================================================================
RCS file: /var/cvs/xmldocs/glossary/profile,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- profile 3 Jan 2005 20:43:54 -0000 1.1
+++ profile 11 Jun 2005 23:39:25 -0000 1.2
@@ -164,3 +164,9 @@
<para>
+
+<!-- TODO
+ Multiple profiles can reside in the same file, if separated by C<__END__> tokens, which must be on a line by themselves.
+-->
+
+
1.4 +4 -4 xmldocs/glossary/session
rev 1.4, prev_rev 1.3
Index: session
===================================================================
RCS file: /var/cvs/xmldocs/glossary/session,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- session 11 Jun 2005 17:22:36 -0000 1.3
+++ session 11 Jun 2005 23:39:25 -0000 1.4
@@ -1,3 +1,4 @@
+<!--
=item Session parameters
Things like where the user originally found your catalog ([data session source]
@@ -31,14 +32,14 @@
(or "submit") the order.
Their payment may be taken at that point via real-time credit card
-approval and a soft-goods product downloaded -- or their order
+approval and a soft-goods product downloaded - or their order
information may be simply sent to you, the store owner, via encrypted
email. The order is saved to a database table (and a file as backup),
or in the case of fully-automated systems sent directly to an order
entry program or database link.
All of these operations are fully configurable by you. The base Interchange
-distribution includes a sample store -- some users have simply customized
+distribution includes a sample store - some users have simply customized
the text and images inside, changed the database entries, and opened
their store. You will probably want to fully customize for a distinctive
catalog look and feel.
@@ -131,5 +132,4 @@
The page, which is now entirely in regular HTML, is delivered to
the HTTP server, which returns it to the browser.
-=back
-
+-->
1.1 xmldocs/glossary/crypt
rev 1.1, prev_rev 1.0
Index: crypt
===================================================================
<programlisting><![CDATA[
> In any case, you can create the encrypted pwds with:
>
> 1) makepasswd --crypt
> makepasswd --crypt-md5
>
> 2) or help yourself with htpasswd/htpasswd2 and htdigest/htdigest2
> that come with apache (htpasswd for crypt(), htdigest for MD5):
>
> htpasswd2 -c /tmp/temp test
> htdigest2 -c /tmp/temp test test
It's done with simple Unix crypt by default.
To have Apache's htpasswd output to stdout instead of a file, you can do:
htpasswd -n test
Jon
]]></programlisting>
1.1 xmldocs/howtos/obtain-and-run-interchange
rev 1.1, prev_rev 1.0
Index: obtain-and-run-interchange
===================================================================
=head1 DISTRIBUTION AND SUPPORT INFORMATION
Interchange is free of charge, and is distributed under the GNU
General Public License. This means that individuals and organizations,
both commercial and non-commercial, may use Interchange without charge. If
you modify and redistribute it, there are certain obligations you
must fulfill. See the file Copying which came with your Interchange
distribution for the full license.
Interchange is not guaranteed to be supported other than by making
full source code available. If it breaks you get to keep both pieces.
However, in practice Interchange is supported by a developer group and
user community at it's mail list, interchange-users at icdevgroup.org. There
are dozens of consultants who make Interchange-based systems their full-time
work, and their are scores more who develop Interchange catalogs and sites.
=head2 Where to Download Interchange
The Interchange version described in this document is available from:
http://ftp.icdevgroup.org/
=head2 Perl
You will need Perl version 5.601 or higher to run Interchange 5.4, and
Perl 5.8.3 or higher is recommended. Interchange requires the modules
in Bundle::Interchange plus one of GDBM_File and DB_File.
Interchange can run on Windows with the cygwin extensions,
but it is not supported and there are no known production sites
using Windows. The majority of Interchange sites run on Linux,
but there are also sites running FreeBSD, Irix, Mac OS/X, and Solaris.
There is no reason Interchange cannot run on any Unix-like
operating system.
=head2 Setup for HTTP Servers
Interchange requires a that a web server be installed on your system
in the normal course of events.
As detailed previously, Interchange is always running in the background
as a daemon. It monitors either 1) a UNIX-domain file-based socket, located
in the RunDir directory (often etc/ in the main directory); or 2) a
series of INET-domain sockets.
The small CGI link program, called in the demo standard, is run to
connect to one of those sockets and provide the link between Interchange
and the web server.
NOTE: Since Apache servers are the most popular, we will talk in the
terms they use.
You need to have a ScriptAlias or other CGI execution capability
to use the link program. (The default ScriptAlias for many web
servers is /cgi-bin.) If you have ExecCGI set for all of your
directories, then any program ending in a particular file suffix (usually
.cgi) will be seen as a CGI program.
=head2 UNIX-domain sockets
This is a socket which is not reachable from the Internet directly,
but which must come from a request on your own server. The link program
vlink is the provided facility for such communication with Interchange.
This is the most secure way to run your catalog, for there is no way
for systems on the Internet to interact with Interchange except through
its link program.
The most important issue with UNIX-domain sockets on Interchange is the
permissions with which the CGI program and the Interchange server run.
To improve security, Interchange normally runs with the socket file
having 0600 permissions (rw-------), which mandates that the CGI
program and the server run as the same user ID. This means
that the vlink program must be SUID to the same user ID as
the server executes under. (Or that CGIWRAP or suexec is used
on a single catalog system).
With Interchange multiple catalog capability, the permissions situation
gets a bit tricky. Interchange comes with a program, makecat, which
configures catalogs for a multiple catalog system. It should properly set
up ownership and permissions for multiple users if run as the superuser.
=head2 INET-domain sockets
These are sockets which are reachable from the Internet directly.
The link program tlink is the provided facility for such communication with
Interchange; you may also use your browser to talk to the socket directly
if you have it mapped to a catalog with the global TcpMap directive.
To improve security, Interchange usually checks that the request comes
from one of a limited number of systems, defined in the global TcpHost
directive.
=head1 QUICK START
Obtain, decompress and untar the distribution:
gzip -dc interchange-5.x.tar.gz | tar xvf -
Change to the created directory, something like:
cd interchange-5.4.0
Run the configure script with:
./configure
If you have trouble with ./configure, try this:
perl Makefile.PL
make
make test
make install
Replace the perl with the proper path to your Perl binary.
You will be asked for the directory where you want to install Interchange --
any directory will do. You must of course have write permission there;
and you will eventually need to have write permission on your CGI-BIN
and HTML directories. This directory is referred to later in the
documentation as VendRoot or the Interchange software directory.
The process should be self-explanatory. If you have trouble answering
the questions asked, look closely at the examples provided. If you
still have trouble, you will need to find a tutorial about the World
Wide Web -- the WWW FAQ at http://www.boutell.com/newfaq/ would be a
good place to look.
1.4 +1 -1 xmldocs/refs/AllowGlobal
rev 1.4, prev_rev 1.3
Index: AllowGlobal
===================================================================
RCS file: /var/cvs/xmldocs/refs/AllowGlobal,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- AllowGlobal 18 Feb 2005 00:28:07 -0000 1.3
+++ AllowGlobal 11 Jun 2005 23:39:25 -0000 1.4
@@ -1,5 +1,5 @@
__NAME__ purpose
-list catalogs that may define subroutines and tags which operate with full Interchange server permissions
+specify catalogs that may define subroutines and tags which operate with full Interchange server permissions
__END__
1.3 +1 -1 xmldocs/refs/EncryptProgram
rev 1.3, prev_rev 1.2
Index: EncryptProgram
===================================================================
RCS file: /var/cvs/xmldocs/refs/EncryptProgram,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- EncryptProgram 11 Jun 2005 17:22:36 -0000 1.2
+++ EncryptProgram 11 Jun 2005 23:39:25 -0000 1.3
@@ -39,7 +39,7 @@
__NAME__ example: Specifying EncryptProgram
<programlisting>
-EncryptProgram /usr/local/bin/gpg -feat sales at company.com
+EncryptProgram /usr/local/bin/gpg -feat orders@&def-domain;
</programlisting>
__END__
1.5 +1 -0 xmldocs/refs/NoCache
rev 1.5, prev_rev 1.4
Index: NoCache
===================================================================
RCS file: /var/cvs/xmldocs/refs/NoCache,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- NoCache 1 Mar 2005 10:31:12 -0000 1.4
+++ NoCache 11 Jun 2005 23:39:25 -0000 1.5
@@ -27,6 +27,7 @@
Put the following in &ccf;:
<programlisting>
NoCache ord special
+NoCache special2
</programlisting>
__END__
1.2 +16 -6 xmldocs/refs/NoImport
rev 1.2, prev_rev 1.1
Index: NoImport
===================================================================
RCS file: /var/cvs/xmldocs/refs/NoImport,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- NoImport 10 Apr 2005 20:37:21 -0000 1.1
+++ NoImport 11 Jun 2005 23:39:25 -0000 1.2
@@ -1,5 +1,5 @@
__NAME__ purpose
-do not re-import text source files to databases unless the database disappears
+specify databases not to re-import, unless the database completely disappears
__END__
@@ -12,15 +12,25 @@
__NAME__ description
The directive specifies &glos-database; tables that should not be
-re-imported from the text source files, unless the database disappears
-(for example, if the <filename><replaceable>table</replaceable>.gdbm</filename>
-is deleted).
+re-imported from the text source files. The database would then be
+re-imported only on critical events, such as
+<filename><replaceable>table</replaceable>.gdbm</filename> being deleted.
__END__
-__NAME__ example: Disabling 'products' table import
+__NAME__ notes
+The import would ordinarily happen when a change in appropriate
+text source file is detected, &IC; is (re)started, or the catalog
+is reconfigured.
+</para><para>
+This setting is useful for &glos-SQL; databases used by other applications
+besides &IC;, or large databases you load and back up outside of Interchange.
+With this option, you can omit text source files for databases entirely.
+__END__
+
+__NAME__ example: Disabling 'products' and 'inventory' table import
Put the following in &gcf;:
<programlisting>
-NoImport products
+NoImport products inventory
</programlisting>
__END__
1.2 +4 -1 xmldocs/refs/Password
rev 1.2, prev_rev 1.1
Index: Password
===================================================================
RCS file: /var/cvs/xmldocs/refs/Password,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Password 25 May 2005 09:36:50 -0000 1.1
+++ Password 11 Jun 2005 23:39:25 -0000 1.2
@@ -25,9 +25,12 @@
using <command>htpasswd</command>, or invoking
<command>perl -le'print crypt("mypasswd","AA")'</command>,
where <literal>mypasswd</literal> is the desired password and
-<literal>AA</literal> are your two always random characters.
+<literal>AA</literal> are your two always random characters called
+the &glos-salt;.
</para><para>
See &var-MV_NO_CRYPT; and &tag-crypt; for more discussion.
+See &glos-crypt; glossary entry for complete information on crypto
+algorithms used and ways to generate encrypted strings.
__END__
1.2 +1 -1 xmldocs/refs/ProductFiles
rev 1.2, prev_rev 1.1
Index: ProductFiles
===================================================================
RCS file: /var/cvs/xmldocs/refs/ProductFiles,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ProductFiles 25 May 2005 09:36:50 -0000 1.1
+++ ProductFiles 11 Jun 2005 23:39:25 -0000 1.2
@@ -5,7 +5,7 @@
__NAME__ synopsis
<group choice='req'>
- <arg choice='plain' rep='repeat'><replaceable>database</replaceable></arg>
+ <arg choice='plain' rep='repeat'><replaceable>database_name</replaceable></arg>
</group>
__END__
1.2 +2 -1 xmldocs/refs/Profiles
rev 1.2, prev_rev 1.1
Index: Profiles
===================================================================
RCS file: /var/cvs/xmldocs/refs/Profiles,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Profiles 9 Jun 2005 12:02:43 -0000 1.1
+++ Profiles 11 Jun 2005 23:39:25 -0000 1.2
@@ -10,6 +10,7 @@
__NAME__ see also
+OrderProfile,SearchProfile
__END__
__NAME__ synopsis
@@ -31,7 +32,7 @@
__NAME__ example: Defining Profiles
<programlisting>
-Profiles etc/profiles.common etc/profiles.login
+Profiles etc/profiles.common
</programlisting>
__END__
1.2 +39 -5 xmldocs/refs/ScratchDefault
rev 1.2, prev_rev 1.1
Index: ScratchDefault
===================================================================
RCS file: /var/cvs/xmldocs/refs/ScratchDefault,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ScratchDefault 11 Jun 2005 08:29:00 -0000 1.1
+++ ScratchDefault 11 Jun 2005 23:39:25 -0000 1.2
@@ -1,8 +1,42 @@
-It is recommended to use the C<ScratchDefault> directive for setting the
-catalog's default locale:
+__NAME__ purpose
+define default scratch variable values
+__END__
-!block example
- ScratchDefault mv_locale de_DE
- !endblock
+__NAME__ see also
+ScratchDefault,ValuesDefault
+__END__
+
+
+__NAME__ synopsis
+ <arg choice='plain'><replaceable>name</replaceable></arg>
+ <arg choice='plain' rep='repeat'><replaceable>value</replaceable></arg>
+__END__
+
+
+__NAME__ description
+The directive sets default &glos-scratch; variable values.
+__END__
+
+__NAME__ example: Defining default scratch values
+Make Interchange URLs elegant — do not include the session ID information
+or the "counter", and append <literal>.html</literal> to pages if it is
+missing.
+<programlisting>
+ScratchDefault mv_no_session_id 1 mv_no_count 1
+ScratchDefault mv_add_dot_html 1
+</programlisting>
+To understand this example, see &glos-scratch; and &glos-session; glossary
+entries, and the &conf-HTMLsuffix; configuration directive.
+__END__
+
+__NAME__ example: Using ScratchDefault to define default locale
+It is recommended to use this directive for setting the catalog's
+default locale:
+<programlisting>
+ScratchDefault mv_locale de_DE
+</programlisting>
+To understand this example, see &glos-internationalization; and &glos-locale;
+glossary entries.
+__END__
1.1 xmldocs/refs/LocaleDatabase
rev 1.1, prev_rev 1.0
Index: LocaleDatabase
===================================================================
__NAME__ purpose
specify database that contains locale settings
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>database_name</replaceable></arg>
</group>
__END__
__NAME__ description
The directive specifies Interchange &glos-database; that
contains &conf-Locale; settings.
__END__
__NAME__ notes
Settings from &conf-LocaleDatabase; add on to (and override)
any that are already defined in the catalog configuration files through
the use of &conf-Locale;.
__END__
__NAME__ example: Defining LocaleDatabase
<programlisting>
Database locale locale.asc TAB
LocaleDatabase locale
</programlisting>
__END__
1.1 xmldocs/refs/MailOrderTo
rev 1.1, prev_rev 1.0
Index: MailOrderTo
===================================================================
__NAME__ purpose
specify e-mail address that completed orders should be sent to
__END__
__NAME__ see also
VendURL,Catalog
__END__
__NAME__ synopsis
<arg choice='plain'><replaceable>e-mail_address</replaceable></arg>
__END__
__NAME__ description
The directive specifies
an e-mail address that completed orders should be sent to.
__END__
__NAME__ notes
&conf-MailOrder>To; is one of the basic Interchange &glos-configuration;
directives.
</para><para>
If the &ccf; file, expected in the catalog base directory, is not found, or is
unreadable by the &IC; server, somewhat misguiding error message will be reported.
Namely, instead of the appropriate permissions-problem message, this mandatory
&conf-MailOrderTo; directive will be reported undefined.
__END__
__NAME__ example: Defining MailOrderTo
<programlisting>
MailOrderTo orders@&def-domain;
</programlisting>
__END__
1.1 xmldocs/refs/NoImportExternal
rev 1.1, prev_rev 1.0
Index: NoImportExternal
===================================================================
__NAME__ purpose
do not re-import external databases
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>0</arg>
<arg choice='plain'>1</arg>
</group>
__END__
__NAME__ description
The directive specifies that all external &glos-database; tables
should not be re-imported.
</para><para>
<emphasis>External</emphasis> database types are DBI (&MYSQL;, &PGSQL;,
&ORACLE; etc.) and LDAP (&OPENLDAP; etc.). In contrast,
<emphasis>internal</emphasis> database types are DBM variants
(&GDBM;, &BDBM;, SDBM) and in-memory.
__END__
__NAME__ notes
For an introduction to "importing" and the times it can occur, see
&glos-database; glossary entry and the &conf-NoImport; configuration
directive.
__END__
__NAME__ see also
NoImport
__END__
__NAME__ example: Enabling NoImportExternal
<programlisting>
NoImportExternal 1
</programlisting>
__END__
1.1 xmldocs/refs/NoSearch
rev 1.1, prev_rev 1.0
Index: NoSearch
===================================================================
__NAME__ purpose
specify databases on which Interchange-style searches cannot be performed
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain' rep='repeat'><replaceable>database_name_glob</replaceable></arg>
</group>
__END__
__NAME__ description
Specify one or more filename fragments that will be matched against the file
name used in any attempted search (the <mv>mv_search_file</mv> attribute).
You may separate multiple match strings with whitespace, and may include
shell-style wildcards (globs).
</para><para>
The default setting is <literal>userdb</literal>, which
means that, by default, you cannot use &IC;-style searches on the
<database>userdb</database> table.
__END__
__NAME__ notes
This directive only disables file/database-based searches, pure SQL
searches still work with it, however.
__END__
__NAME__ example: Defining NoSearch
Disable searching on <database>userdb</database>, and other databases
beginning with "<literal>.</literal>" or ending in "<literal>.secret</literal>".
<programlisting>
NoSearch userdb .* *.secret
</programlisting>
__END__
1.1 xmldocs/refs/OfflineDir
rev 1.1, prev_rev 1.0
Index: OfflineDir
===================================================================
__NAME__ purpose
specify directory to use for "offline" files
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain' rep='repeat'><replaceable>directory</replaceable></arg>
</group>
__END__
__NAME__ description
Specify directory to use for the offline database files, which are generated
by the offline database build command.
__END__
__NAME__ example: Setting OfflineDir
<programlisting>
OfflineDir /usr/data/interchange/offline
</programlisting>
__END__
__NAME__ missing
PORT_OLD
__END__
1.1 xmldocs/refs/OrderCounter
rev 1.1, prev_rev 1.0
Index: OrderCounter
===================================================================
__NAME__ purpose
specify file that keeps and increments order count
__END__
__NAME__ see also
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>filename</replaceable></arg>
</group>
__END__
__NAME__ description
Specify location of the file keeping and incrementing order numbers.
</para><para>
If not set, the order will be
assigned a string based on the time of the order and the user's session number.
__END__
__NAME__ notes
Bear in mind that &IC; provides this order number counter only as a convenience
for display, and that no internal functions depend on it. Custom order number
routines may be defined and used without fear of consequences.
</para><para>
If &conf-Route; is set to <literal>supplant</literal> and the
<literal>counter</literal> attribute is set there, this directive is ignored.
</para><para>
See &glos-order; glossary entry for complete discussion of &IC;'s
ordering process.
__END__
__NAME__ example: Setting OrderCounter
<programlisting>
OrderCounter etc/order.number
</programlisting>
__END__
1.1 xmldocs/refs/OrderLineLimit
rev 1.1, prev_rev 1.0
Index: OrderLineLimit
===================================================================
__NAME__ purpose
specify maximum number of items the user is allowed to place in the shopping cart
__END__
__NAME__ see also
LockoutCommand
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>count</replaceable></arg>
</group>
__END__
__NAME__ description
Specify maximum number of items that the user is allowed to place in the
shopping cart.
</para><para>
Some poorly-mannered robots may "attack" a site by following
all links one after another. Some even ignore any
<filename>robots.txt</filename> file that may have been created. If one of
these bad robots orders several dozen or more items, the time required to
save and restore the shopping cart from the user session may become excessive.
</para><para>
When the &conf-OrderLineLimit; is
exceeded, the command defined in &conf-LockoutCommand; will be executed and
the shopping cart will be emptied.
__END__
__NAME__ notes
Set the directive to a number greater than the number of line items a user
is ever expected to order.
__END__
__NAME__ example: Setting OrderLineLimit
<programlisting>
OrderLineLimit 50
</programlisting>
__END__
1.1 xmldocs/refs/OrderProfile
rev 1.1, prev_rev 1.0
Index: OrderProfile
===================================================================
__NAME__ purpose
specify files containing order profile definitions
__END__
__NAME__ see also
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain' rep='repeat'><replaceable>filename</replaceable></arg>
</group>
__END__
__NAME__ description
Specify filenames that contain &glos-profile; definitions.
__END__
__NAME__ notes
The actions defined in order profiles can also used for
<literal>mv_click</literal> actions
if the actions are not defined in &glos-scratch; space. They are accessed by
setting the <mv>mv_order_profile</mv> variable to the name of the order
profile.
</para><para>
For the complete discussion, please see the &glos-profile; glossary entry.
__END__
__NAME__ example: Defining OrderProfile
<programlisting>
OrderProfile etc/profiles.order etc/profiles.login
</programlisting>
__END__
__NAME__ missing
Diff between Profiles and OrderProfile ?
__END__
1.1 xmldocs/refs/Replace
rev 1.1, prev_rev 1.0
Index: Replace
===================================================================
__NAME__ purpose
re-set directive to a new value, or its default
__END__
__NAME__ synopsis
<arg choice='plain'><replaceable>directive_name</replaceable></arg>
<arg choice='opt'><replaceable>value</replaceable></arg>
__END__
__NAME__ description
Cause another directive's value to be emptied and re-set 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.
__END__
__NAME__ notes
Capitalization must be exact on each directive.
__END__
__NAME__ example: Replacing NoCache
<programlisting>
Replace NoCache ord special multi reconfig query
</programlisting>
__END__
__NAME__ see also
__END__
1.1 xmldocs/refs/RobotLimit
rev 1.1, prev_rev 1.0
Index: RobotLimit
===================================================================
__NAME__ purpose
specify maximum number of pages a user can visit without a 30 second pause
__END__
__NAME__ see also
LockoutCommand,OrderLineLimit
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'><replaceable>count</replaceable></arg>
</group>
__END__
__NAME__ description
Specify maximum number of
consecutive pages a user may access without a 30 second pause.
</para><para>
When the &conf-RobotLimit; is
exceeded, the command defined in &conf-LockoutCommand; will be executed and
the catalog URLs will be rewritten to
<literal>127.0.0.1</literal>, effectively pointing the robot back to itself.
__END__
__NAME__ notes
Set the directive to a number greater than the number of pages users are
ever expected to visit in a short time frame.
__END__
__NAME__ example: Setting RobotLimit
<programlisting>
RobotLimit 200
</programlisting>
__END__
1.1 xmldocs/refs/SaveExpire
rev 1.1, prev_rev 1.0
Index: SaveExpire
===================================================================
__NAME__ purpose
specify the amount of time for which Interchange cookies should be valid (their expiry time)
__END__
__NAME__ missing
__END__
__NAME__ see also
HammerLock,SessionExpire
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain' rep='repeat'><replaceable>interval</replaceable></arg>
</group>
__END__
__NAME__ description
Specify &glos-interval;, an amount of time, that &IC;-issued &glos-cookie;s
should
be valid for.
</para><para>
This, of course, only applies to &glos-cookie;s other than session ID
cookie (<literal>MV_SESSION_ID</literal>), which always lasts only for the
duration of the session.
The ones used in &IC; by default (and which are affected by this directive)
are <literal>MV_USERNAME</literal> and <literal>MV_PASSWORD</literal>, for
the &conf-CookieLogin; feature.
__END__
__NAME__ example: Defining SaveExpire
<programlisting>
SaveExpire 52 weeks
</programlisting>
__END__
1.1 xmldocs/refs/ScratchDir
rev 1.1, prev_rev 1.0
Index: ScratchDir
===================================================================
__NAME__ purpose
specify directory containing temporary files
__END__
__NAME__ synopsis
<group choice='req'>
<arg choice='plain'>directory</arg>
</group>
__END__
__NAME__ description
Specify the directory containing temporary, runtime files.
</para><para>
The kind of files &IC; drops to the &conf-ScratchDir; directory include
cached searches and retired &glos-session; IDs.
__END__
__NAME__ notes
The specified location is, unless absolute, treated relative to &glos-CATROOT;.
__END__
__NAME__ example: Setting ScratchDir
<programlisting>
ScratchDir /tmp
</programlisting>
__END__
More information about the docs
mailing list