]> granicus.if.org Git - fcron/commitdiff
added secondes in time-value
authorthib <thib>
Sun, 31 Mar 2002 15:10:09 +0000 (15:10 +0000)
committerthib <thib>
Sun, 31 Mar 2002 15:10:09 +0000 (15:10 +0000)
added options volatile and stdout
updated first option description

doc/en/fcrontab.5.sgml

index 5fd2b96f6a53334b85d7871c1754fae0fbd0b49c..d3688b5887370789a41a519b12e91225544649dd 100644 (file)
@@ -8,7 +8,7 @@ Foundation.
 A copy of the license is included in gfdl.sgml.
 -->
 
-<!-- $Id: fcrontab.5.sgml,v 1.6 2002-03-02 17:33:25 thib Exp $ -->
+<!-- $Id: fcrontab.5.sgml,v 1.7 2002-03-31 15:10:09 thib Exp $ -->
 
 <refentry id="fcrontab.5">
     <refmeta>
@@ -88,6 +88,10 @@ A copy of the license is included in gfdl.sgml.
                            <entry>hours (60 minutes) : </entry>
                            <entry>h  </entry>
                        </row>
+                       <row>
+                           <entry>seconds : </entry>
+                           <entry>s  </entry>
+                       </row>
                    </tbody>
                </tgroup>
            </table>
@@ -301,7 +305,7 @@ A copy of the license is included in gfdl.sgml.
                    <term>f</term>
                    <listitem>
                        <para><emphasis><type>time-value</type></emphasis></para>
-                       <para>Delay before first execution of a job based on system up time ("@"-lines). Useful in the following case : you have several jobs running, say, every hour. By setting different first value for each job, you can avoid them to run simultaneously everytime.</para>
+                       <para>Delay before first execution of a job based on system up time ("@"-lines). Useful in the following case : you have several jobs running, say, every hour. By setting different first value for each job, you can avoid them to run simultaneously everytime. You can also set it to 0, which is useful when used in conjunction with option &optvolatile;.</para>
                    </listitem>
                </varlistentry>
                <varlistentry id="fcrontab.5.runfreq">
@@ -457,6 +461,22 @@ A copy of the license is included in gfdl.sgml.
                        <para>In a <link linkend="fcrontab.5.periodent">line run periodically</link>, this option answers the question : should this job be run as soon as possible in its interval of execution (safer), or should fcron set a random time of execution in that interval ? Note that if this option is set, the job may not run if fcron is not running during <emphasis>all</emphasis> the execution interval. Besides, you must know that the random scheme may be quite easy to guess for skilled people.</para>
                    </listitem>
                </varlistentry>
+               <varlistentry id="fcrontab.5.volatile">
+                   <term>volatile</term>
+                   <listitem>
+                       <para><emphasis><type>boolean</type></emphasis>(<constant>0</constant>)</para>
+                       <para>When set to true, the job is based on a "volatile" system up time, i.e. restart counting each time fcron is started, which is useful when fcron is started by a script running only, for instance, during a dialup connection : the "volatile" system up time then refers to the dialup connection time. You may also want to use option &optfirst; if you use fcron that way.</para>
+                       <para>&seealso; options &optfirst;, &optstdout;, <link linkend="uptent">lines based on elapsed system up time</link>, fcron's option <option>--once</option> in <link linkend="fcron.8">&fcron;(8)</link>.</para>
+                   </listitem>
+               </varlistentry>
+               <varlistentry id="fcrontab.5.stdout">
+                   <term>stdout</term>
+                   <listitem>
+                       <para><emphasis><type>boolean</type></emphasis>(<constant>0</constant>)</para>
+                       <para>If fcron is running in the forground, then also let jobs print to stderr/stdout instead of mailing or discarding it.</para>
+                       <para>&seealso; fcron's option <option>--once</option> in <link linkend="fcron.8">&fcron;(8)</link>.</para>
+                   </listitem>
+               </varlistentry>
            </variablelist>
            <para>A <type>boolean</type> argument can be inexistent, in which case brackets are not used and it means <constant>true</constant>; the string "true", "yes" or 1 to mean <constant>true</constant>; and the string "false", "no" or 0 to mean <constant>false</constant>. See above for explanations about time value (section <link linkend="uptent">"entries based on elapsed system up time"</link>).</para>
            <para>Note that <varname>dayand</varname> and <varname>dayor</varname> are in fact the same option : a false value to <varname>dayand</varname> is equivalent to a true to <varname>dayor</varname>, and reciprocally a false value to <varname>dayor</varname> is equivalent a true value to <varname>dayand</varname>. It is the same for <varname>lavgand</varname> and <varname>lavgor</varname>.</para>