[interchange-docs] xmldocs - racke modified refs/HouseKeepingCron

docs at icdevgroup.org docs at icdevgroup.org
Thu Aug 9 06:54:57 EDT 2007


User:      racke
Date:      2007-08-09 10:54:57 GMT
Modified:  refs     HouseKeepingCron
Log:
ripped off some documentation from CVS, to be continued

Revision  Changes    Path
1.2       +52 -2     xmldocs/refs/HouseKeepingCron


rev 1.2, prev_rev 1.1
Index: HouseKeepingCron
===================================================================
RCS file: /var/cvs/xmldocs/refs/HouseKeepingCron,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- HouseKeepingCron	6 Nov 2006 22:04:40 -0000	1.1
+++ HouseKeepingCron	9 Aug 2007 10:54:56 -0000	1.2
@@ -1,4 +1,54 @@
+__NAME__ purpose
+Specifies Crontab for Regular Tasks
+__END__
 
-__NAME__ missing
-All
+__NAME__ synopsis
+HouseKeepingCron <crontab
+__END__
+
+__NAME__ description
+  The targets are GlobalSub or anything which you can make run
+  with Vend::Dispatch::run_macro. Bear in mind there is no
+  catalog context.
+</para>
+<para>
+  Two special targets exist, <literal>:reconfig</literal> and <literal>:jobs</literal>. 
+  They allow calling
+  of the catalog reconfig routines and jobs routines, respectively.
+  The etc/reconfig and etc/jobsqueue files will be ignored if these
+  targets are not present -- a warning will be issued at startup
+  (and crontab change) if they are not there.
+</para>
+<para>
+  A target prepended with > runs *after* the reconfig/restart/jobs/pid
+  mgmt cycle. Normal specifications run before.
+</para>
+<para>
+  The basic entry to implement <literal>HouseKeeping 5</literal> would be:
+</para>
+<para>
+<programlisting><![CDATA[
+
+
+     HouseKeeping 1
+	 HouseKeepingCron <<EOC
+	 */5 * * * * * :restart
+	 */5 * * * * * :jobs
+	 EOC
+]]></programlisting>
+__END__
+
+__NAME__ example: Running Batch Jobs
+<programlisting><![CDATA[
+HouseKeepingCron <<EOC
+0 0 * * * * =standard hourly
+0 1 2 * * * =standard daily
+0 2 4 * * 7 =standard weekly
+0 0 3 1 * * =standard monthly
+EOC
+]]></programlisting>
+__END__
+
+__NAME__ see also
+HouseKeeping
 __END__








More information about the docs mailing list