[docs] docs - racke modified icconfig.sdf

[docs@interchange.redhat.com]

User:      racke
Date:      2002-08-11 13:43:38 GMT
Modified:  .        icconfig.sdf
Log:
cron configuration documented

Revision  Changes    Path
1.68      +33 -2     docs/icconfig.sdf


rev 1.68, prev_rev 1.67
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.67
retrieving revision 1.68
diff -u -r1.67 -r1.68
--- icconfig.sdf	26 Jul 2002 22:14:45 -0000	1.67
+++ icconfig.sdf	11 Aug 2002 13:43:37 -0000	1.68
@@ -1,10 +1,10 @@
 !init OPT_LOOK=3D"akopia"; OPT_STYLE=3D"manual"
-# $Id: icconfig.sdf,v 1.67 2002/07/26 22:14:45 mheins Exp $
+# $Id: icconfig.sdf,v 1.68 2002/08/11 13:43:37 racke Exp $
=20
 !define DOC_NAME "Configuration Reference"
 !define DOC_TYPE ""
 !define DOC_CODE "icconfig"
-!define DOC_VERSION substr('$Revision: 1.67 $',11, -2)
+!define DOC_VERSION substr('$Revision: 1.68 $',11, -2)
 !define DOC_STATUS "Draft"
 !define DOC_PROJECT "Interchange"
 !define DOC_URL "http://interchange.redhat.com/doc/icconfig.html"
@@ -1370,6 +1370,37 @@
 !block example
    CreditCardAuto     Yes
 !endblock
+
+H2: Cron *5.0 and up*
+
+Configuration for jobs run with the C<--cron> commandline option.
+
+LI1: base_directory, use_global
+
+Directory to search for cron jobs. The default is C<etc/cron> in
+the catalog directory. If C<use_global> is set, the same directory
+is searched in the global configuration directory.
+
+LI1: initialize, autoload
+
+The macros C<initialize> and C<autoload> are executed once resp. before=20
+each job.
+
+LI1: email, log, add_session
+
+The output of a single run of cron jobs is written to a log file and
+send by email if the corresponding configuration values C<email> and
+C<log> are set. An email address passed by the commandline option
+C<--email> has higher preference than the email address in C<email>.
+
+If the run produces no output, neither the email will be send nor
+the log file entry will be written.
+
+C<add_session> adds the current session to the output.
+
+LI1: from, subject, reply_to, extra_headers
+
+Additional configuration values for the generation of the email.
=20
 H2: CustomShipping
=20