A copy of the license is included in gfdl.sgml.
-->
-<!-- $Id: fcron.8.sgml,v 1.4 2002-03-31 15:08:46 thib Exp $ -->
+<!-- $Id: fcron.8.sgml,v 1.5 2002-07-19 19:44:27 thib Exp $ -->
<refentry id="fcron.8">
<refmeta>
<refentrytitle>fcron</refentrytitle>
<manvolnum>8</manvolnum>
- <refmiscinfo>Fcron &version; <![%devrelease; [ (<emphasis>development</emphasis> release)]]></refmiscinfo>
+ <refmiscinfo>Fcron &version; <![%devrelease; [
+(<emphasis>development</emphasis> release)]]></refmiscinfo>
<refmiscinfo>&date;</refmiscinfo>
</refmeta>
<refnamediv>
<para>
&Fcron; should be started from <filename>/etc/rc</filename> or
<filename>/etc/rc.local</filename>. Unless the <option>-f</option> (or
-<option>--foreground</option>) option is given, it will return
-immediately, so you don't need to start it with '&'.</para>
+<option>--foreground</option>) option is given, it will return immediately, so
+you don't need to start it with '&'.</para>
<para>
&Fcron; loads users &fcrontabf;s (see <link
linkend="fcrontab.5">&fcrontab;(5)</link>) files previously installed by
<command>fcrontab</command> (see <link
-linkend="fcrontab.1">&fcrontab;(1)</link>). Then, &fcron; calculates the
-time and date of each job's next execution, and determines how long it
-has to sleep, and sleeps for this amount of time. When it wakes up, it
-checks all jobs loaded and runs them if needed. When a job is
-executed, &fcron; forks, changes its user and group permissions to match
-those of the user the job is being done for, executes that job and
-mails the outputs to the user (this can be changed : see <link
-linkend="fcrontab.5">&fcrontab;(5)</link>).</para>
+linkend="fcrontab.1">&fcrontab;(1)</link>). Then, &fcron; calculates the time
+and date of each job's next execution, and determines how long it has to sleep,
+and sleeps for this amount of time. When it wakes up, it checks all jobs loaded
+and runs them if needed. When a job is executed, &fcron; forks, changes its user
+and group permissions to match those of the user the job is being done for,
+executes that job and mails the outputs to the user (this can be changed : see
+<link linkend="fcrontab.5">&fcrontab;(5)</link>).</para>
<para>
Informative message about what &fcron; is doing are sent to
-<application>syslogd</application>(8) under facility
-<emphasis>cron</emphasis>, priority <emphasis>notice</emphasis>.
-Warning and error messages are sent respectively at priority
-<emphasis>warning</emphasis> and <emphasis>error</emphasis>.</para>
+<application>syslogd</application>(8) under facility <emphasis>cron</emphasis>,
+priority <emphasis>notice</emphasis>. Warning and error messages are sent
+respectively at priority <emphasis>warning</emphasis> and
+<emphasis>error</emphasis>.</para>
<para><note>
<para>
-&Fcron; sleeps at least &firstsleep; seconds after it has been started
-before executing a job to avoid to use too much resources during
-system boot.</para>
+&Fcron; sleeps at least &firstsleep; seconds after it has been started before
+executing a job to avoid to use too much resources during system boot.</para>
</note></para>
</refsect1>
<term><option>--foreground</option></term>
<listitem>
<para>
- Don't fork to the background. In this mode, &fcron; will output informational message to standard error as well as to syslogd.</para>
+ Don't fork to the background. In this mode, &fcron; will
+output informational message to standard error as well as to syslogd.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-b</option></term>
<term><option>--background</option></term>
<listitem>
- <para>Force running in background, even if &fcron; has been compiled to run in foreground as default.</para>
+ <para>Force running in background, even if &fcron; has been
+compiled to run in foreground as default.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option> <replaceable>time</replaceable></term>
- <term><option>--savetime</option> <replaceable>time</replaceable></term>
+ <term><option>--savetime</option>
+<replaceable>time</replaceable></term>
<listitem>
- <para>Save &fcrontabf;s on disk every t sec (default is 1800).</para>
+ <para>Save &fcrontabf;s on disk every t sec (default is
+1800).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-m</option> <replaceable>num</replaceable></term>
- <term><option>--maxserial</option> <replaceable>num</replaceable></term>
+ <term><option>--maxserial</option>
+<replaceable>num</replaceable></term>
<listitem>
- <para>Set to n the maximum number of serial jobs which can run simultaneously. By default, this value is set to &serialmaxrunning;.</para>
+ <para>Set to n the maximum number of serial jobs which can
+run simultaneously. By default, this value is set to &serialmaxrunning;.</para>
<para>&seealso; option &optserial; in &fcrontab;(5).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option> <replaceable>file</replaceable></term>
- <term><option>--configfile</option> <replaceable>file</replaceable></term>
+ <term><option>--configfile</option>
+<replaceable>file</replaceable></term>
<listitem>
<para>Make &fcron; use config file
<replaceable>file</replaceable> instead of default config file
<filename>&etc;/&fcron.conf.location;</filename>. To interact with that running
-&fcron; process, &fcrontab; must use the same config file (which is
-defined by &fcrontab;'s option <option>-c</option>). That way, several
-&fcron; processes can run simultaneously on an only system (but each
-&fcron; process *must* have a different spool dir and pid file from the
-other processes).</para>
+&fcron; process, &fcrontab; must use the same config file (which is defined by
+&fcrontab;'s option <option>-c</option>). That way, several &fcron; processes
+can run simultaneously on an only system (but each &fcron; process *must* have a
+different spool dir and pid file from the other processes).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o</option></term>
<term><option>--once</option></term>
<listitem>
- <para>Execute all jobs that need to be run at the time fcron was started, wait for them, then return. Sets <option>firstsleep</option> to 0. May be especially useful when used with options <option>-y</option> and <option>-f</option> in a script run, for instance, at dialup connection.</para>
- <para>&seealso; fcrontab's options &optvolatile;, &optstdout;.</para>
+ <para>Execute all jobs that need to be run at the time fcron
+was started, wait for them, then return. Sets <option>firstsleep</option> to 0.
+May be especially useful when used with options <option>-y</option> and
+<option>-f</option> in a script run, for instance, at dialup connection.</para>
+ <para>&seealso; fcrontab's options &optvolatile;,
+&optstdout;.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-y</option></term>
<term><option>--nosyslog</option></term>
<listitem>
- <para>Don't log to syslog at all. May be useful when running in foreground.</para>
+ <para>Don't log to syslog at all. May be useful when running
+in foreground.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-l</option> <replaceable>time</replaceable></term>
- <term><option>--firstsleep</option> <replaceable>time</replaceable></term>
+ <term><option>--firstsleep</option>
+<replaceable>time</replaceable></term>
<listitem>
- <para>Sets the initial delay (in seconds) before any job is executed, default to &firstsleep; seconds.</para>
+ <para>Sets the initial delay (in seconds) before any job is
+executed, default to &firstsleep; seconds.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option> <replaceable>dir</replaceable></term>
- <term><option>--newspooldir</option> <replaceable>dir</replaceable></term>
+ <term><option>--newspooldir</option>
+<replaceable>dir</replaceable></term>
<listitem>
- <para>Create <replaceable>dir</replaceable> as a new spool directory for &fcron;. Set correctly its mode and owner. Then, exit.</para>
+ <para>Create <replaceable>dir</replaceable> as a new spool
+directory for &fcron;. Set correctly its mode and owner. Then, exit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</option></term>
<term><option>--version</option></term>
<listitem>
- <para>Display an informational message about &fcron;, including its version and the license under which it is distributed.</para>
+ <para>Display an informational message about &fcron;,
+including its version and the license under which it is distributed.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option></term>
<term><option>--debug</option></term>
<listitem>
- <para>Run in debug mode (more details on stderr (if option <option>-f</option> is set) and in log file)</para>
+ <para>Run in debug mode (more details on stderr (if option
+<option>-f</option> is set) and in log file)</para>
</listitem>
</varlistentry>
</variablelist>
<refsect1>
<title>Return values</title>
- <para>&Fcron; returns &exitok; on normal exit, and &exiterr; on error.</para>
+ <para>&Fcron; returns &exitok; on normal exit, and &exiterr; on
+error.</para>
</refsect1>
<refsect1>
<varlistentry>
<term><constant>SIGTERM</constant></term>
<listitem>
- <para>Save configuration (time remaining until next execution, time and date of next execution, etc), wait for all running jobs and exit.</para>
+ <para>Save configuration (time remaining until next
+execution, time and date of next execution, etc), wait for all running jobs and
+exit.</para>
</listitem>
</varlistentry>
<varlistentry>
<varlistentry>
<term><constant>SIGUSR2</constant></term>
<listitem>
- <para>Make &fcron; print its current schedule on syslog. It also toggles on/off the printing on debug info on syslog.</para>
+ <para>Make &fcron; print its current schedule on syslog. It
+also toggles on/off the printing on debug info on syslog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>SIGHUP</constant></term>
<listitem>
- <para>Tell &fcron; to check if there is any configuration update (this signal is used by &fcrontab;(5))</para>
+ <para>Tell &fcron; to check if there is any configuration
+update (this signal is used by &fcrontab;(5))</para>
</listitem>
</varlistentry>
</variablelist>
<varlistentry>
<term><filename>&etc;/&fcron.conf.location;</filename></term>
<listitem>
- <para>Configuration file for &fcron;, &fcrontab; and &fcrondyn; : contains paths (spool dir, pid file) and default programs to use (editor, shell, etc). See <link linkend="fcron.conf.5">&fcron.conf;(5)</link> for more details.</para>
+ <para>Configuration file for &fcron;, &fcrontab; and
+&fcrondyn; : contains paths (spool dir, pid file) and default programs to use
+(editor, shell, etc). See <link linkend="fcron.conf.5">&fcron.conf;(5)</link>
+for more details.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>&etc;/&fcron.allow;</filename></term>
<listitem>
- <para>Users allowed to use &fcrontab; and &fcrondyn; (one name per line, special name "all" acts for everyone)</para>
+ <para>Users allowed to use &fcrontab; and &fcrondyn; (one
+name per line, special name "all" acts for everyone)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>&etc;/&fcron.deny;</filename></term>
<listitem>
- <para>Users who are not allowed to use &fcrontab; and &fcrondyn; (same format as allow file)</para>
+ <para>Users who are not allowed to use &fcrontab; and
+&fcrondyn; (same format as allow file)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>&etc;/pam.d/fcron</filename> (or <filename>&etc;/pam.conf</filename>)</term>
+ <term><filename>&etc;/pam.d/fcron</filename> (or
+<filename>&etc;/pam.conf</filename>)</term>
<listitem>
- <para><productname>PAM</productname> configuration file for &fcron;. Take a look at pam(8) for more details.</para>
+ <para><productname>PAM</productname> configuration file for
+&fcron;. Take a look at pam(8) for more details.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
- <refsect1>
- <title>See also</title>
- <simplelist>
- <member><link linkend="fcron.conf.5">&fcron.conf;(5)</link></member>
- <member><link linkend="fcrontab.1">&fcrontab;(1)</link></member>
- <member><link linkend="fcrontab.5">&fcrontab;(5)</link></member>
- <member><link linkend="fcrondyn.1">&fcrondyn;(1)</link></member>
- <member>The HTML version of the documentation, if you are not reading it right now, which is far better than these man pages :)).</member>
- </simplelist>
- </refsect1>
+ &manpage-foot;
- <refsect1>
- <title>Author</title>
- <para>Thibault Godouet &email;</para>
- </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
sgml-parent-document:("fcron-doc.sgml" "book" "chapter" "sect1" "")
sgml-default-dtd-file: "fcron-doc.ced"
End:
--->
+-->
\ No newline at end of file
A copy of the license is included in gfdl.sgml.
-->
-<!-- $Id: fcrondyn.1.sgml,v 1.3 2002-03-31 15:08:26 thib Exp $ -->
+<!-- $Id: fcrondyn.1.sgml,v 1.4 2002-07-19 19:43:56 thib Exp $ -->
<refentry id="fcrondyn.1">
<refmeta>
<refentrytitle>fcrondyn</refentrytitle>
<manvolnum>1</manvolnum>
- <refmiscinfo>Fcron &version; <![%devrelease; [ (<emphasis>development</emphasis> release)]]></refmiscinfo>
+ <refmiscinfo>Fcron &version; <![%devrelease; [
+(<emphasis>development</emphasis> release)]]></refmiscinfo>
<refmiscinfo>&date;</refmiscinfo>
</refmeta>
<refnamediv>
<refsect1>
<title>Description</title>
- <para>&Fcrondyn; is a user tool intended to interact with a running fcron daemon. It can, for instance, list user's jobs loaded by fcron, run one of them, renice a running job, send a signal to a running job, etc.</para>
+ <para>&Fcrondyn; is a user tool intended to interact with a running
+fcron daemon. It can, for instance, list user's jobs loaded by fcron, run one of
+them, renice a running job, send a signal to a running job, etc.</para>
</refsect1>
<refsect1>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-x</option> <replaceable>command</replaceable></term>
+ <term><option>-x</option>
+<replaceable>command</replaceable></term>
<listitem>
- <para>Run <replaceable>command</replaceable> and returns immediately. <link linkend="fcrondyn.1.cmd.descp">See below</link> for syntax and a list of commands.</para>
+ <para>Run <replaceable>command</replaceable> and returns
+immediately. <link linkend="fcrondyn.1.cmd.descp">See below</link> for syntax
+and a list of commands.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option> <replaceable>file</replaceable></term>
<listitem>
- <para>Make &fcrontab; use config file <replaceable>file</replaceable> instead of default config file <filename>&etc;/&fcron.conf.location;</filename>. To interact with a running &fcron; process, &fcrontab; must use the same config file as the process. That way, several &fcron; processes can run simultaneously on an only system.</para>
+ <para>Make &fcrontab; use config file
+<replaceable>file</replaceable> instead of default config file
+<filename>&etc;/&fcron.conf.location;</filename>. To interact with a running
+&fcron; process, &fcrontab; must use the same config file as the process. That
+way, several &fcron; processes can run simultaneously on an only system.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option></term>
<listitem>
- <para>Run in debug mode. In this mode, many informational messages will be output in order to check if anything went wrong.</para>
+ <para>Run in debug mode. In this mode, many informational
+messages will be output in order to check if anything went wrong.</para>
</listitem>
</varlistentry>
<varlistentry>
<varlistentry>
<term><option>-V</option></term>
<listitem>
- <para>Display an informational message about &fcrontab;, including its version and the license under which it is distributed.</para>
+ <para>Display an informational message about &fcrontab;,
+including its version and the license under which it is distributed.</para>
</listitem>
</varlistentry>
</variablelist>
<title>Command description</title>
<para>&Fcrondyn;'s command syntax is the following : </para>
<blockquote>
- <para><command>command</command> <replaceable>arg1</replaceable> <replaceable>arg2</replaceable> [...]</para>
+ <para><command>command</command> <replaceable>arg1</replaceable>
+<replaceable>arg2</replaceable> [...]</para>
</blockquote>
- <para>An argument of a &fcrondyn; command is of one of the following type :</para>
+ <para>An argument of a &fcrondyn; command is of one of the following
+type :</para>
<variablelist>
<title>Argument types of &fcrondyn;'s commands</title>
<varlistentry>
<varlistentry>
<term><emphasis><type>jobid</type></emphasis></term>
<listitem>
- <para>A job id given by one of &fcrondyn;'s <command>ls*</command> commands (i.e. an integer).</para>
+ <para>A job id given by one of &fcrondyn;'s
+<command>ls*</command> commands (i.e. an integer).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis><type>sig</type></emphasis></term>
<listitem>
- <para>A signal number, or its name (case does not matter). For instance, "term" or "15".</para>
+ <para>A signal number, or its name (case does not matter).
+For instance, "term" or "15".</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis><type>niceval</type></emphasis></term>
<listitem>
- <para>A job priority value. A <emphasis><type>niceval</type></emphasis> is an integer from -20 (highest priority) to 19 (lowest) (only root is allowed to use a negative value with this option).</para>
+ <para>A job priority value. A
+<emphasis><type>niceval</type></emphasis> is an integer from -20 (highest
+priority) to 19 (lowest) (only root is allowed to use a negative value with this
+option).</para>
</listitem>
</varlistentry>
</variablelist>
- <para>Last, but not least, the following commands are recognized (optional arguments are between []) :</para>
+ <para>Last, but not least, the following commands are recognized
+(optional arguments are between []) :</para>
<variablelist>
<title>Valid &fcrondyn;'s commands</title>
<varlistentry>
<term><command>help</command></term>
<term><command>h</command></term>
<listitem>
- <para>Print an help message about fcrondyn's commands.</para>
+ <para>Print an help message about fcrondyn's
+commands.</para>
</listitem>
</varlistentry>
<varlistentry>
</listitem>
</varlistentry>
<varlistentry>
- <term><command>ls</command> [<emphasis><type>user</type></emphasis>]</term>
+ <term><command>ls</command>
+[<emphasis><type>user</type></emphasis>]</term>
<listitem>
- <para>List all jobs of user. When <command>ls</command> is run by root, all users are listed unless a user name is given as argument. <link linkend="fcrondyn.1.ls.fields">See below</link> for some explanations about the fields used by <command>ls*</command> commands.</para>
+ <para>List all jobs of user. When <command>ls</command> is
+run by root, all users are listed unless a user name is given as argument. <link
+linkend="fcrondyn.1.ls.fields">See below</link> for some explanations about the
+fields used by <command>ls*</command> commands.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><command>ls_lavgq</command> [<emphasis><type>user</type></emphasis>]</term>
+ <term><command>ls_lavgq</command>
+[<emphasis><type>user</type></emphasis>]</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><command>ls_serialq</command> [<emphasis><type>user</type></emphasis>]</term>
+ <term><command>ls_serialq</command>
+[<emphasis><type>user</type></emphasis>]</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><command>ls_exeq</command> [<emphasis><type>user</type></emphasis>]</term>
+ <term><command>ls_exeq</command>
+[<emphasis><type>user</type></emphasis>]</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><command>detail</command> <emphasis><type>jobid</type></emphasis></term>
+ <term><command>detail</command>
+<emphasis><type>jobid</type></emphasis></term>
<listitem>
- <para>Print details about a job. jobid is the one given by <command>ls</command></para>
+ <para>Print details about a job. jobid is the one given by
+<command>ls</command></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><command>runnow</command> <emphasis><type>jobid</type></emphasis></term>
+ <term><command>runnow</command>
+<emphasis><type>jobid</type></emphasis></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><command>run</command> <emphasis><type>jobid</type></emphasis></term>
+ <term><command>run</command>
+<emphasis><type>jobid</type></emphasis></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><command>kill</command> <emphasis><type>sig</type></emphasis> <emphasis><type>jobid</type></emphasis></term>
+ <term><command>kill</command>
+<emphasis><type>sig</type></emphasis>
+<emphasis><type>jobid</type></emphasis></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
- <term><command>renice</command> <emphasis><type>niceval</type></emphasis> <emphasis><type>jobid</type></emphasis></term>
+ <term><command>renice</command>
+<emphasis><type>niceval</type></emphasis>
+<emphasis><type>jobid</type></emphasis></term>
<listitem>
<para></para>
</listitem>
<varlistentry>
<term>R&Q</term>
<listitem>
- <para>The job has this number instances running or queued in serial or lavg queue.</para>
+ <para>The job has this number instances running or queued in
+serial or lavg queue.</para>
</listitem>
</varlistentry>
<varlistentry>
<refsect1>
<title>Return values</title>
- <para>&Fcrondyn; returns &exitok; on normal exit and &exiterr; on error.</para>
+ <para>&Fcrondyn; returns &exitok; on normal exit and &exiterr; on
+error.</para>
</refsect1>
<refsect1>
<varlistentry>
<term><filename>&etc;/&fcron.conf.location;</filename></term>
<listitem>
- <para>Configuration file for &fcron;, &fcrontab; and &fcrondyn; : contains paths (spool dir, pid file) and default programs to use (editor, shell, etc). See <link linkend="fcron.conf.5">&fcron.conf;(5)</link> for more details.</para>
+ <para>Configuration file for &fcron;, &fcrontab; and
+&fcrondyn; : contains paths (spool dir, pid file) and default programs to use
+(editor, shell, etc). See <link linkend="fcron.conf.5">&fcron.conf;(5)</link>
+for more details.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>&etc;/&fcron.allow;</filename></term>
<listitem>
- <para>Users allowed to use &fcrontab; and &fcrondyn; (one name per line, special name "all" acts for everyone)</para>
+ <para>Users allowed to use &fcrontab; and &fcrondyn; (one
+name per line, special name "all" acts for everyone)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>&etc;/&fcron.deny;</filename></term>
<listitem>
- <para>Users who are not allowed to use &fcrontab; and &fcrondyn; (same format as allow file)</para>
+ <para>Users who are not allowed to use &fcrontab; and
+&fcrondyn; (same format as allow file)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>&etc;/pam.d/fcron</filename> (or <filename>&etc;/pam.conf</filename>)</term>
+ <term><filename>&etc;/pam.d/fcron</filename> (or
+<filename>&etc;/pam.conf</filename>)</term>
<listitem>
- <para><productname>PAM</productname> configuration file for &fcron;. Take a look at pam(8) for more details.</para>
+ <para><productname>PAM</productname> configuration file for
+&fcron;. Take a look at pam(8) for more details.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
- <refsect1>
- <title>See also</title>
- <simplelist>
- <member><link linkend="fcrontab.1">&fcrontab;(1)</link></member>
- <member><link linkend="fcrontab.5">&fcrontab;(5)</link></member>
- <member><link linkend="fcron.8">&fcron;(8)</link></member>
- <member><link linkend="fcron.conf.5">&fcron.conf;(5)</link></member>
- <member>The HTML version of the documentation, if you are not reading it right now, which is far better than these man pages :)).</member>
- </simplelist>
- </refsect1>
-
- <refsect1>
- <title>Author</title>
- <para>Thibault Godouet &email;</para>
- </refsect1>
-
+ &manpage-foot;
</refentry>
A copy of the license is included in gfdl.sgml.
-->
-<!-- $Id: fcrontab.1.sgml,v 1.4 2002-03-31 15:09:57 thib Exp $ -->
+<!-- $Id: fcrontab.1.sgml,v 1.5 2002-07-19 19:45:14 thib Exp $ -->
<refentry id="fcrontab.1">
<refmeta>
<refentrytitle>fcrontab</refentrytitle>
<manvolnum>1</manvolnum>
- <refmiscinfo>Fcron &version; <![%devrelease; [ (<emphasis>development</emphasis> release)]]></refmiscinfo>
+ <refmiscinfo>Fcron &version; <![%devrelease; [
+(<emphasis>development</emphasis> release)]]></refmiscinfo>
<refmiscinfo>&date;</refmiscinfo>
</refmeta>
<refnamediv>
<refsect1>
<title>Description</title>
- <para>&Fcrontab; is the program intended to install, edit, list and remove the tables used by <link linkend="fcron.8">&fcron;(8)</link> daemon. As &fcron; internally uses a non-human readable format (this is needed because &fcron; saves more informations than the user gives, for example the time and date of next execution), the user cannot edit directly his &fcrontabf; (the one used by &fcron;).</para>
- <para>When a user installs a &fcrontabf;, the source file is saved in the spool directory (<filename>&fcrontabsdir;</filename>) to allow future editions, a formatted file is generated for the &fcron; daemon, which is signaled once about ten seconds before the next minute for all changes made previously. The daemon is not signaled immediately to keep ill disposed users from blocking the daemon by installing &fcrontabf;s over and over.
-We will call "<emphasis>fcrontab</emphasis>" the source file of the &fcrontabf; in the following.</para>
- <para>A user can install a &fcrontabf; if he is listed in the <filename>&etc;/&fcron.allow;</filename> and not (unless by the keyword all) listed in <filename>&etc;/&fcron.deny;</filename> (see section "<link linkend="fcrontab.1.files">files</link>" below). If neither <filename>fcron.allow</filename> nor <filename>fcron.deny</filename> exist, every users are allowed. None of these files have to exist, but if they do, the deny file takes precedence.</para>
- <para>The first form of the command is used to install a new &fcrontabf; file, from any named file or from standard input if the pseudo-filename "-" is given, replacing the previous one (if any) : each user can have only one &fcrontabf;.</para>
+ <para>&Fcrontab; is the program intended to install, edit, list and
+remove the tables used by <link linkend="fcron.8">&fcron;(8)</link> daemon. As
+&fcron; internally uses a non-human readable format (this is needed because
+&fcron; saves more informations than the user gives, for example the time and
+date of next execution), the user cannot edit directly his &fcrontabf; (the one
+used by &fcron;).</para>
+ <para>When a user installs a &fcrontabf;, the source file is saved in
+the spool directory (<filename>&fcrontabsdir;</filename>) to allow future
+editions, a formatted file is generated for the &fcron; daemon, which is
+signaled once about ten seconds before the next minute for all changes made
+previously. The daemon is not signaled immediately to keep ill disposed users
+from blocking the daemon by installing &fcrontabf;s over and over. We will call
+"<emphasis>fcrontab</emphasis>" the source file of the &fcrontabf; in the
+following.</para>
+ <para>A user can install a &fcrontabf; if he is listed in the
+<filename>&etc;/&fcron.allow;</filename> and not (unless by the keyword all)
+listed in <filename>&etc;/&fcron.deny;</filename> (see section "<link
+linkend="fcrontab.1.files">files</link>" below). If neither
+<filename>fcron.allow</filename> nor <filename>fcron.deny</filename> exist,
+every users are allowed. None of these files have to exist, but if they do, the
+deny file takes precedence.</para>
+ <para>The first form of the command is used to install a new &fcrontabf;
+file, from any named file or from standard input if the pseudo-filename "-" is
+given, replacing the previous one (if any) : each user can have only one
+&fcrontabf;.</para>
+ <para>For instance, root can create a systemwide fcrontab file, say
+<filename>/etc/fcrontab</filename>, and run "<command>fcrontab</command>
+<filename>/etc/fcrontab</filename>" to install the new version after each change
+of the file. Or (s)he can create a new fcrontab running a simple
+"<command>fcrontab</command>", and then maintain it using
+"<command>fcrontab</command> <option>-e</option>". Same considerations apply to
+a non privileged user.</para>
</refsect1>
<refsect1>
<varlistentry>
<term><option>-u</option> <replaceable>user</replaceable></term>
<listitem>
- <para>Specify the user whose &fcrontabf; will be managed. Should only be used by root. If not given, the &fcrontabf; file of the user invoking &fcrontab; will be handled. It may be useful since the <application>su</application>(8) command may confuse &fcrontab;.
-<note><para>the '<replaceable>user</replaceable>' in the <link linkend="fcrontab.1.synopsis">synopsys</link> is equivalent to a '<option>-u</option> <replaceable>user</replaceable>'.</para>
+ <para>Specify the user whose &fcrontabf; will be managed.
+Should only be used by root. If not given, the &fcrontabf; file of the user
+invoking &fcrontab; will be handled. It may be useful since the
+<application>su</application>(8) command may confuse &fcrontab;.
+<note><para>the '<replaceable>user</replaceable>' in the <link
+linkend="fcrontab.1.synopsis">synopsys</link> is equivalent to a
+'<option>-u</option> <replaceable>user</replaceable>'.</para>
</note></para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-l</option></term>
<listitem>
- <para>List user's current &fcrontabf; to standard output.</para>
+ <para>List user's current &fcrontabf; to standard
+output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-e</option></term>
<listitem>
- <para>Edit user's current &fcrontabf; using either the editor specified by the environment variable <envar>VISUAL</envar>, or <envar>EDITOR</envar> if <envar>VISUAL</envar> is not set. If none or them are set, <command>&editor;</command> will be used.</para>
+ <para>Edit user's current &fcrontabf; using either the
+editor specified by the environment variable <envar>VISUAL</envar>, or
+<envar>EDITOR</envar> if <envar>VISUAL</envar> is not set. If none or them are
+set, <command>&editor;</command> will be used.</para>
</listitem>
</varlistentry>
<varlistentry>
<varlistentry>
<term><option>-z</option></term>
<listitem>
- <para>Reinstall user's &fcrontabf; from its source code. All informations &fcron; may have kept in the binary &fcrontabf; (such as the last execution time and date) will be forgotten.</para>
+ <para>Reinstall user's &fcrontabf; from its source code. All
+informations &fcron; may have kept in the binary &fcrontabf; (such as the last
+execution time and date) will be forgotten.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option></term>
<listitem>
- <para>Ignore previous version. If this option is not given, &fcron; will try to keep as much information as possible between old and new version of the &fcrontabf; (time and date of next execution, if job is in serial queue, etc) if the line hasn't been modified (same fields, same shell command).</para>
+ <para>Ignore previous version. If this option is not given,
+&fcron; will try to keep as much information as possible between old and new
+version of the &fcrontabf; (time and date of next execution, if job is in serial
+queue, etc) if the line hasn't been modified (same fields, same shell
+command).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option> <replaceable>file</replaceable></term>
<listitem>
- <para>Make &fcrontab; use config file <replaceable>file</replaceable> instead of default config file <filename>&etc;/&fcron.conf.location;</filename>. To interact with a running &fcron; process, &fcrontab; must use the same config file as the process. That way, several &fcron; processes can run simultaneously on an only system.</para>
+ <para>Make &fcrontab; use config file
+<replaceable>file</replaceable> instead of default config file
+<filename>&etc;/&fcron.conf.location;</filename>. To interact with a running
+&fcron; process, &fcrontab; must use the same config file as the process. That
+way, several &fcron; processes can run simultaneously on an only system.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option></term>
<listitem>
- <para>Run in debug mode. In this mode, many informational messages will be output in order to check if anything went wrong.</para>
+ <para>Run in debug mode. In this mode, many informational
+messages will be output in order to check if anything went wrong.</para>
</listitem>
</varlistentry>
<varlistentry>
<varlistentry>
<term><option>-V</option></term>
<listitem>
- <para>Display an informational message about &fcrontab;, including its version and the license under which it is distributed.</para>
+ <para>Display an informational message about &fcrontab;,
+including its version and the license under which it is distributed.</para>
</listitem>
</varlistentry>
</variablelist>
<refsect1>
<title>Return values</title>
- <para>&Fcrontab; returns &exitok; on normal exit and &exiterr; on error.</para>
+ <para>&Fcrontab; returns &exitok; on normal exit and &exiterr; on
+error.</para>
</refsect1>
<refsect1>
<varlistentry>
<term><filename>&etc;/&fcron.conf.location;</filename></term>
<listitem>
- <para>Configuration file for &fcron;, &fcrontab; and &fcrondyn; : contains paths (spool dir, pid file) and default programs to use (editor, shell, etc). See <link linkend="fcron.conf.5">&fcron.conf;(5)</link> for more details.</para>
+ <para>Configuration file for &fcron;, &fcrontab; and
+&fcrondyn; : contains paths (spool dir, pid file) and default programs to use
+(editor, shell, etc). See <link linkend="fcron.conf.5">&fcron.conf;(5)</link>
+for more details.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>&etc;/&fcron.allow;</filename></term>
<listitem>
- <para>Users allowed to use &fcrontab; and &fcrondyn; (one name per line, special name "all" acts for everyone)</para>
+ <para>Users allowed to use &fcrontab; and &fcrondyn; (one
+name per line, special name "all" acts for everyone)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>&etc;/&fcron.deny;</filename></term>
<listitem>
- <para>Users who are not allowed to use &fcrontab; and &fcrondyn; (same format as allow file)</para>
+ <para>Users who are not allowed to use &fcrontab; and
+&fcrondyn; (same format as allow file)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>&etc;/pam.d/fcron</filename> (or <filename>&etc;/pam.conf</filename>)</term>
+ <term><filename>&etc;/pam.d/fcron</filename> (or
+<filename>&etc;/pam.conf</filename>)</term>
<listitem>
- <para><productname>PAM</productname> configuration file for &fcron;. Take a look at pam(8) for more details.</para>
+ <para><productname>PAM</productname> configuration file for
+&fcron;. Take a look at pam(8) for more details.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
- <refsect1>
- <title>See also</title>
- <simplelist>
- <member><link linkend="fcrontab.5">&fcrontab;(5)</link></member>
- <member><link linkend="fcron.8">&fcron;(8)</link></member>
- <member><link linkend="fcron.conf.5">&fcron.conf;(5)</link></member>
- <member><link linkend="fcrondyn.1">&fcrondyn;(1)</link></member>
- <member>The HTML version of the documentation, if you are not reading it right now, which is far better than these man pages :)).</member>
- </simplelist>
- </refsect1>
-
- <refsect1>
- <title>Author</title>
- <para>Thibault Godouet &email;</para>
- </refsect1>
+ &manpage-foot;
</refentry>
A copy of the license is included in gfdl.sgml.
-->
-<!-- $Id: fcrontab.5.sgml,v 1.7 2002-03-31 15:10:09 thib Exp $ -->
+<!-- $Id: fcrontab.5.sgml,v 1.8 2002-07-19 19:45:28 thib Exp $ -->
<refentry id="fcrontab.5">
<refmeta>
<refentrytitle>fcrontab</refentrytitle>
<manvolnum>5</manvolnum>
- <refmiscinfo>Fcron &version; <![%devrelease; [ (<emphasis>development</emphasis> release)]]></refmiscinfo>
+ <refmiscinfo>Fcron &version; <![%devrelease; [
+(<emphasis>development</emphasis> release)]]></refmiscinfo>
<refmiscinfo>&date;</refmiscinfo>
</refmeta>
<refnamediv>
<refsect1>
<title>Description</title>
- <para>A &fcrontabf; is a file containing all tables used by the &fcron;(8) daemon. In other words, it is the means for a user to tell the daemon "execute this command at this moment". Each user has his own &fcrontabf;, whose commands are executed as his owner (only root can run a job as another using the option &optrunas; (see below)).</para>
- <para>Blank lines, line beginning by a pound-sign (#) (which are considered comments), leading blanks and tabs are ignored. Each line in a fcrontab file can be either</para>
+ <para>A &fcrontabf; is a file containing all tables used by the
+&fcron;(8) daemon. In other words, it is the means for a user to tell the daemon
+"execute this command at this moment". Each user has his own &fcrontabf;, whose
+commands are executed as his owner (only root can run a job as another using the
+option &optrunas; (see below)).</para>
+ <para>Blank lines, line beginning by a pound-sign (#) (which are
+considered comments), leading blanks and tabs are ignored. Each line in a
+fcrontab file can be either</para>
<itemizedlist>
<listitem>
<para>an environment setting,</para>
<para>entries based on elapsed system up time,</para>
</listitem>
<listitem>
- <para>entries based on absolut time (like normal crontab entries), or</para>
+ <para>entries based on absolut time (like normal crontab
+entries), or</para>
</listitem>
<listitem>
<para>entries run periodically.</para>
</listitem>
</itemizedlist>
- <para>Any logical line (an entry or an assignment) can be divided into several real lines (the lines which end by a newline character) by placing a backslash (\) before the newline character (\n).</para>
+ <para>Any logical line (an entry or an assignment) can be divided into
+several real lines (the lines which end by a newline character) by placing a
+backslash (\) before the newline character (\n).</para>
<refsect2>
<title>The environment settings</title>
<blockquote>
<para>name = value</para>
</blockquote>
- <para>where the blanks around equal-sign (=) are ignored and optional. Trailing blanks are also ignored, but you can place the value in quotes (simple or double, but matching) to preserve any blanks in the value.</para>
- <para>When &fcron; executes a command, it always sets <envar>USER</envar>, <envar>HOME</envar>, and <envar>SHELL</envar> as defined in <filename>/etc/passwd</filename> for the owner of the &fcrontabf; from which the command is extracted. <envar>HOME</envar> and <envar>SHELL</envar> may be overridden by settings in the &fcrontabf;, but <envar>USER</envar> may not. Every other environment assignments defined in the user &fcrontabf; are then made, and the command is executed.</para>
- <para>Plus, the special variable <varname>MAILTO</varname> allows you to tell &fcron; to whom it has to mail the command's output. Note that <varname>MAILTO</varname> is in fact equivalent to a global declaration of the option &optmailto; (see below). It is only used for backward compatibility, so you should use the option &optmailto; directly.
+ <para>where the blanks around equal-sign (=) are ignored and
+optional. Trailing blanks are also ignored, but you can place the value in
+quotes (simple or double, but matching) to preserve any blanks in the
+value.</para>
+ <para>When &fcron; executes a command, it always sets
+<envar>USER</envar>, <envar>HOME</envar>, and <envar>SHELL</envar> as defined in
+<filename>/etc/passwd</filename> for the owner of the &fcrontabf; from which the
+command is extracted. <envar>HOME</envar> and <envar>SHELL</envar> may be
+overridden by settings in the &fcrontabf;, but <envar>USER</envar> may not.
+Every other environment assignments defined in the user &fcrontabf; are then
+made, and the command is executed.</para>
+ <para>Plus, the special variable <varname>MAILTO</varname> allows
+you to tell &fcron; to whom it has to mail the command's output. Note that
+<varname>MAILTO</varname> is in fact equivalent to a global declaration of the
+option &optmailto; (see below). It is only used for backward compatibility, so
+you should use the option &optmailto; directly.
</para>
</refsect2>
<refsect2 id="uptent">
<title>Entries based on elapsed system up time</title>
- <para>The entries of commands which have to be run once every m minutes of &fcron;'s execution (which is normally the same as m minutes of system's execution) are of the form</para>
+ <para>The entries of commands which have to be run once every m
+minutes of &fcron;'s execution (which is normally the same as m minutes of
+system's execution) are of the form</para>
<programlisting>@options frequency command</programlisting>
- <para>where frequency is a time value of the form value*multiplier+value*multiplier+...+value-in-minutes as "12h02" or "3w2d5h1". The first means "12 hours and 2 minutes of fcron execution" while the second means "3 weeks, 2 days, 5 hours and 1 minute of fcron execution". The only valid multipliers are:</para>
+ <para>where frequency is a time value of the form
+value*multiplier+value*multiplier+...+value-in-minutes as "12h02" or "3w2d5h1".
+The first means "12 hours and 2 minutes of fcron execution" while the second
+means "3 weeks, 2 days, 5 hours and 1 minute of fcron execution". The only valid
+multipliers are:</para>
<table>
<title>Valid time multipliers</title>
<tgroup cols="2">
</tgroup>
</table>
- <para>In place of <replaceable>options</replaceable>, user can put a time value : it will be interpreted as <token>@first(<replaceable>time</replaceable>)</token>. If &optfirst; option is not set, the value of "<varname>frequency</varname>" is used.</para>
- <para>This kind of entry does not guarantee a time and date of execution (as the job is delayed at each startup by the time elapsed since the shutdown), but should be useful for jobs depending on the number of things done by the users (for instance, the filesystem should better be checked after a certain amount of use by the users rather than every x days, as the system may run from 1 day to x days during that x days interval).</para>
- <para>The time remaining before next execution is saved every &save; seconds (to limit damages caused by a crash) and when &fcron; exits after having received a <constant>SIGTERM</constant> signal, i.e. when systems go down. Thus, this kind of entries is particularly useful for systems that don't run regularly. The syntax being very simple, it may also useful for tasks which don't need to be run at a specific time and date.</para>
- <para>&seealso; options &optfirst;, &optmail;, &optnolog;, &optserial;, &optlavg;, &optnice;, &optrunas; (see below).</para>
+ <para>In place of <replaceable>options</replaceable>, user can put a
+time value : it will be interpreted as
+<token>@first(<replaceable>time</replaceable>)</token>. If &optfirst; option is
+not set, the value of "<varname>frequency</varname>" is used.</para>
+ <para>This kind of entry does not guarantee a time and date of
+execution (as the job is delayed at each startup by the time elapsed since the
+shutdown), but should be useful for jobs depending on the number of things done
+by the users (for instance, the filesystem should better be checked after a
+certain amount of use by the users rather than every x days, as the system may
+run from 1 day to x days during that x days interval).</para>
+ <para>The time remaining before next execution is saved every &save;
+seconds (to limit damages caused by a crash) and when &fcron; exits after having
+received a <constant>SIGTERM</constant> signal, i.e. when systems go down. Thus,
+this kind of entries is particularly useful for systems that don't run
+regularly. The syntax being very simple, it may also useful for tasks which
+don't need to be run at a specific time and date.</para>
+ <para>&seealso; options &optfirst;, &optmail;, &optnolog;,
+&optserial;, &optlavg;, &optnice;, &optrunas; (see below).</para>
<para><example>
- <title>Some examples of lines based on elapsed system up time</title>
+ <title>Some examples of lines based on elapsed system up
+time</title>
<programlisting>
-# Get our mails every 30 minutes
-@ 30 getmails -all
-
-# make some security tests every 48 hours of system up time,
-# force a mail to be sent to root even if there is no output
-@mailto(root),forcemail 2d /etc/security/msec/cron-sh/security.sh
+# Get our mails every 30 minutes @ 30 getmails -all # make some security tests
+every 48 hours of system up time, # force a mail to be sent to root even if
+there is no output @mailto(root),forcemail 2d
+/etc/security/msec/cron-sh/security.sh
</programlisting>
</example></para>
</refsect2>
<refsect2 id="fcrontab.5.tadent">
<title>Entries based on time and date</title>
- <para>The second type of &fcrontabf;'s entries begins by an optional "&", which can be immediately followed by an optional number defining the frequency of execution (this is equivalent to option &optrunfreq;) or a declaration of options; it has five time and date fields, and a shell command :</para>
- <programlisting>&options min hrs day-of-month month day-of-week command</programlisting>
- <para>Note that the shell command may be preceded by a user name, which is equivalent to <token>runas(<replaceable>user</replaceable>)</token>: as it is only here for backward compatibility you should use option &optrunas; (see below) instead. The frequency is interpreted as: "run this command after x matches of time and date fields". The time and date fields are:</para>
+ <para>The second type of &fcrontabf;'s entries begins by an optional
+"&", which can be immediately followed by an optional number defining the
+frequency of execution (this is equivalent to option &optrunfreq;) or a
+declaration of options; it has five time and date fields, and a shell command
+:</para>
+ <programlisting>&options min hrs day-of-month month day-of-week
+command</programlisting>
+ <para>Note that the shell command may be preceded by a user name,
+which is equivalent to <token>runas(<replaceable>user</replaceable>)</token>: as
+it is only here for backward compatibility you should use option &optrunas; (see
+below) instead. The frequency is interpreted as: "run this command after x
+matches of time and date fields". The time and date fields are:</para>
<table>
<title>Time and date fields</title>
<tgroup cols="2">
</row>
<row>
<entry>day of week : </entry>
- <entry>0-7 (0 and 7 are both Sunday, or names) </entry>
+ <entry>0-7 (0 and 7 are both Sunday, or names)
+</entry>
</row>
</tbody>
</tgroup>
</table>
- <para>A field is always filled by either an asterisk (*), which acts as "<token>first-last</token>" range, a single number or a list.</para>
- <para>List are numbers or range separated with commas (,). For instance: "2,5,15,23".</para>
- <para>Ranges of number are of the form "<token><replaceable>begin</replaceable>-<replaceable>end</replaceable></token>", where "<replaceable>begin</replaceable>" and "<replaceable>end</replaceable>" are included. For example, "3-5" specifies the values 3, 4 and 5. You can also add an optional "/<replaceable>number</replaceable>" to a range, where the <replaceable>number</replaceable> specifies skips of the <replaceable>number</replaceable>'s value through the range. For example, "0-23/2" can be used in the hours field to specify command execution every other hour. Finally, one or several "~<replaceable>number</replaceable>" can be added to turn off some values in a range. For example, "5-8~6~7" is equivalent to "5,8". The final form of a field is:</para>
+ <para>A field is always filled by either an asterisk (*), which acts
+as "<token>first-last</token>" range, a single number or a list.</para>
+ <para>List are numbers or range separated with commas (,). For
+instance: "2,5,15,23".</para>
+ <para>Ranges of number are of the form
+"<token><replaceable>begin</replaceable>-<replaceable>end</replaceable></token>",
+where "<replaceable>begin</replaceable>" and "<replaceable>end</replaceable>"
+are included. For example, "3-5" specifies the values 3, 4 and 5. You can also
+add an optional "/<replaceable>number</replaceable>" to a range, where the
+<replaceable>number</replaceable> specifies skips of the
+<replaceable>number</replaceable>'s value through the range. For example,
+"0-23/2" can be used in the hours field to specify command execution every other
+hour. Finally, one or several "~<replaceable>number</replaceable>" can be added
+to turn off some values in a range. For example, "5-8~6~7" is equivalent to
+"5,8". The final form of a field is:</para>
<blockquote>
<para>a[-b[/c][~d][~e][...]][,f[-g[/h][~i][~j][...]]][,...]</para>
</blockquote>
<para>where the letters are integers.</para>
- <para>You can also use an asterisk (*) in a field. It acts for "<token>first-last</token>". For example, a "*" in the field minute means all minutes from minute 0 down to minute 59.</para>
- <para>Ranges can be included in a list as a single number. For instance: "2,5-10/2~6,15,20-25,30".</para>
- <para>Names can also be used for the "month" and "day of week" fields. To do so, use the first three letters of the particular day or month (case doesn't matter). Please note that names are used exactly as numbers: you can use them in a list or a range.</para>
- <para>If a day of month and a day of week are given, the command will execute only when <emphasis>both</emphasis> match with the current time and date unless option &optdayor; is set. For example, with the line <programlisting>5 10 31 * 7 echo ''</programlisting> echo will only be executed days which are a Sunday AND a 31th, at 10:05.</para>
- <para>&seealso; options &optdayor;, &optbootrun;, &optrunfreq;, &optmail;, &optnolog;, &optserial;, &optlavg;, &optnice;, &optrunas; (see below).</para>
+ <para>You can also use an asterisk (*) in a field. It acts for
+"<token>first-last</token>". For example, a "*" in the field minute means all
+minutes from minute 0 down to minute 59.</para>
+ <para>Ranges can be included in a list as a single number. For
+instance: "2,5-10/2~6,15,20-25,30".</para>
+ <para>Names can also be used for the "month" and "day of week"
+fields. To do so, use the first three letters of the particular day or month
+(case doesn't matter). Please note that names are used exactly as numbers: you
+can use them in a list or a range.</para>
+ <para>If a day of month and a day of week are given, the command
+will execute only when <emphasis>both</emphasis> match with the current time and
+date unless option &optdayor; is set. For example, with the line
+<programlisting>5 10 31 * 7 echo ''</programlisting> echo will only be executed
+days which are a Sunday AND a 31th, at 10:05.</para>
+ <para>&seealso; options &optdayor;, &optbootrun;, &optrunfreq;,
+&optmail;, &optnolog;, &optserial;, &optlavg;, &optnice;, &optrunas; (see
+below).</para>
<para><example>
- <title>Some examples of entries based on time and date</title>
+ <title>Some examples of entries based on time and
+date</title>
<programlisting>
-# run mycommand at 12:05, 12:35, 13:05, 13:35, 14:05 *and* 14:35 everyday
-& 05,35 12-14 * * * mycommand -u me -o file
-
-# get mails every hours past 20, 21, 22, and 24 minutes.
-20-24~23 * * * * getmail
-
-# save our work of the day every night at 03:45 with a low priority
-# unless we are sunday, mail the output to jim and run that job
-# at startup if computer was down at 03:45
+# run mycommand at 12:05, 12:35, 13:05, 13:35, 14:05 *and* 14:35 everyday &
+05,35 12-14 * * * mycommand -u me -o file # get mails every hours past 20, 21,
+22, and 24 minutes. 20-24~23 * * * * getmail # save our work of the day every
+night at 03:45 with a low priority # unless we are sunday, mail the output to
+jim and run that job # at startup if computer was down at 03:45
&nice(10),mailto(jim),bootrun 45 03 * * *~0 "save --our work"
</programlisting>
</example></para>
<refsect2 id="fcrontab.5.periodent">
<title>Entries run periodically</title>
- <para>The third type of &fcrontabf;'s entries begin by a "%", followed by one of the keywords :</para>
+ <para>The third type of &fcrontabf;'s entries begin by a "%",
+followed by one of the keywords :</para>
<para><simplelist type="inline">
<member><parameter>hourly </parameter></member>
<member><parameter>daily </parameter></member>
<member><parameter>dow </parameter></member>
</simplelist></para>
<para>and optional options.</para>
- <para>The keywords of the first line tell &fcron; to run the command once from the beginning of the corresponding interval to the end of that interval : for instance, the keyword <parameter>weekly</parameter> tells &fcron; to run a command once between Monday and Sunday each week. On top of that, the second list acts similarly but from middle to middle of the corresponding interval : <parameter>midweekly</parameter> will run a command once from Thursday to Wednesday. Note that <parameter>nightly</parameter> is equivalent to <parameter>middaily</parameter>.</para>
- <para>With this two kind of keywords, user must give the needed time fields (as defined in "<link linkend="fcrontab.5.tadent">Entries based on time and date</link>" (see above)) to specify when the command should be run during each interval :</para>
+ <para>The keywords of the first line tell &fcron; to run the command
+once from the beginning of the corresponding interval to the end of that
+interval : for instance, the keyword <parameter>weekly</parameter> tells &fcron;
+to run a command once between Monday and Sunday each week. On top of that, the
+second list acts similarly but from middle to middle of the corresponding
+interval : <parameter>midweekly</parameter> will run a command once from
+Thursday to Wednesday. Note that <parameter>nightly</parameter> is equivalent to
+<parameter>middaily</parameter>.</para>
+ <para>With this two kind of keywords, user must give the needed time
+fields (as defined in "<link linkend="fcrontab.5.tadent">Entries based on time
+and date</link>" (see above)) to specify when the command should be run during
+each interval :</para>
<table>
<title>Needed time fields for each keyword</title>
<tgroup cols="2">
</thead>
<tbody>
<row>
- <entry><parameter> hourly</parameter>, <parameter>midhourly</parameter> : </entry>
+ <entry><parameter> hourly</parameter>,
+<parameter>midhourly</parameter> : </entry>
<entry> minutes.</entry>
</row>
<row>
- <entry><parameter> daily</parameter>, <parameter>middaily</parameter>, <parameter>nightly</parameter>, <parameter>weekly</parameter>, <parameter>midweekly</parameter> : </entry>
+ <entry><parameter> daily</parameter>,
+<parameter>middaily</parameter>, <parameter>nightly</parameter>,
+<parameter>weekly</parameter>, <parameter>midweekly</parameter> : </entry>
<entry> minutes and hours.</entry>
</row>
<row>
- <entry><parameter> monthly</parameter>, <parameter>midmonthly</parameter> : </entry>
+ <entry><parameter> monthly</parameter>,
+<parameter>midmonthly</parameter> : </entry>
<entry> minutes, hours and days.</entry>
</row>
</tbody>
%nightly,mail(no) * 21-23,3-5 echo "a nigthly entry"
</programlisting>
</informalexample></para>
- <para>will run the command once each night either between 21:00 and 23:59, or between 3:00 and 5:59 (it will run as soon as possible. To change that, use option &optrandom;) and won't send mail (due to the optional use of option &optmail;).</para>
- <para>&seealso; options &optlavg;, &optnoticenotrun;, &optstrict;, &optmail;, &optnolog;, &optserial;, &optnice;, &optrunas;, &optrandom; (see below).</para>
-
- <para>The keywords of the third list act differently, as follows:</para>
- <para>run this command once during EACH interval specified, ignoring the fields below the keyword in the interval definition (a <parameter>hours</parameter> prevents the mins field to be considered as an interval, but it will be used to determine when the line should be run during an interval : see the note below) (<parameter>dow</parameter> means "day of week").</para>
- <para>Such a keyword is followed by 5 time and date fields (the same fields used for a <link linkend="fcrontab.5.tadent">line based on absolute time</link> (see above)). Furthermore, there must be some non-matching time and dates in the lines with that kind of keyword (i.e. the following is not allowed : <programlisting>%hours * 0-23 * * * echo "INCORRECT line !"</programlisting> but <programlisting>%hours * 0-22 * * * echo "Ok."</programlisting> is allowed).</para>
+ <para>will run the command once each night either between 21:00 and
+23:59, or between 3:00 and 5:59 (it will run as soon as possible. To change
+that, use option &optrandom;) and won't send mail (due to the optional use of
+option &optmail;).</para>
+ <para>&seealso; options &optlavg;, &optnoticenotrun;, &optstrict;,
+&optmail;, &optnolog;, &optserial;, &optnice;, &optrunas;, &optrandom; (see
+below).</para>
+
+ <para>The keywords of the third list act differently, as
+follows:</para>
+ <para>run this command once during EACH interval specified, ignoring
+the fields below the keyword in the interval definition (a
+<parameter>hours</parameter> prevents the mins field to be considered as an
+interval, but it will be used to determine when the line should be run during an
+interval : see the note below) (<parameter>dow</parameter> means "day of
+week").</para>
+ <para>Such a keyword is followed by 5 time and date fields (the same
+fields used for a <link linkend="fcrontab.5.tadent">line based on absolute
+time</link> (see above)). Furthermore, there must be some non-matching time and
+dates in the lines with that kind of keyword (i.e. the following is not allowed
+: <programlisting>%hours * 0-23 * * * echo "INCORRECT line !"</programlisting>
+but <programlisting>%hours * 0-22 * * * echo "Ok."</programlisting> is
+allowed).</para>
<note>
- <para>a single number in a field is considered as an interval : <programlisting>%mins 15 2-4 * * * echo</programlisting> will run at 2:15, 3:15 AND 4:15 every day.</para>
- <para>But every fields below the keywords are ignored in interval definition : <programlisting>%hours 15 2-4 * * * echo</programlisting> will run only ONCE either at 2:15, 3:15 OR 4:15.</para>
+ <para>a single number in a field is considered as an interval :
+<programlisting>%mins 15 2-4 * * * echo</programlisting> will run at 2:15, 3:15
+AND 4:15 every day.</para>
+ <para>But every fields below the keywords are ignored in
+interval definition : <programlisting>%hours 15 2-4 * * * echo</programlisting>
+will run only ONCE either at 2:15, 3:15 OR 4:15.</para>
</note>
<para>&seealso; option &optrandom; (see below).</para>
</refsect2>
<refsect2>
<title>Options</title>
- <para>The options can be set either for every line below the declaration or for an individual line. In the first case, the setting is done on a whole line immediately after an exclamation mark (!), while it is done after a "&", a "%" or a "@" depending on the type of scheduling in the second case. Note that an option declaration in a schedule overrides the global declaration of that same option.</para>
- <para>Options are separated by comas (,) and their arguments, if any, are placed between brackets ("(" and ")") and separated by comas. No spaces are allowed. A declaration of options is of the form</para>
+ <para>The options can be set either for every line below the
+declaration or for an individual line. In the first case, the setting is done on
+a whole line immediately after an exclamation mark (!), while it is done after a
+"&", a "%" or a "@" depending on the type of scheduling in the second case. Note
+that an option declaration in a schedule overrides the global declaration of
+that same option.</para>
+ <para>Options are separated by comas (,) and their arguments, if
+any, are placed between brackets ("(" and ")") and separated by comas. No spaces
+are allowed. A declaration of options is of the form</para>
<blockquote>
<para><replaceable>option</replaceable>[(<replaceable>arg1</replaceable>[,<replaceable>arg2</replaceable>][...])][,<replaceable>option</replaceable>[(<replaceable>arg1</replaceable>[...])]][...]</para>
</blockquote>
- <para>where option is either the name of an option or its abbreviation. The options are (default value between brackets) :</para>
+ <para>where option is either the name of an option or its
+abbreviation. The options are (default value between brackets) :</para>
<variablelist>
<title>Valid options in a &fcrontabf;</title>
<varlistentry id="fcrontab.5.reset">
<term>exesev</term>
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>false</constant>)</para>
- <para>Can a job be executed several times simultaneously ?</para>
- <para>&seealso; options &optserialonce;, &optlavgonce;.</para>
+ <para>Can a job be executed several times simultaneously
+?</para>
+ <para>&seealso; options &optserialonce;,
+&optlavgonce;.</para>
</listitem>
</varlistentry>
<varlistentry id="fcrontab.5.serialonce">
<term>serialonce</term>
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>&serialoncedef;</constant>)</para>
- <para>Can a job be queued several times in serial queue simultaneously ?</para>
- <para>&seealso; options &optexesev;, &optlavgonce;.</para>
+ <para>Can a job be queued several times in serial queue
+simultaneously ?</para>
+ <para>&seealso; options &optexesev;,
+&optlavgonce;.</para>
</listitem>
</varlistentry>
<varlistentry id="fcrontab.5.serial">
<term>s</term>
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>false</constant>)</para>
- <para>&Fcron; runs at most &serialmaxrunning; serial jobs (and the same number of lavg serial jobs) simultaneously (but this value may be modified by &fcron;'s option <option>-m</option>). May be used with big jobs to limit system overload.</para>
- <para>&seealso; options &optserialonce;, &optlavg;.</para>
+ <para>&Fcron; runs at most &serialmaxrunning; serial
+jobs (and the same number of lavg serial jobs) simultaneously (but this value
+may be modified by &fcron;'s option <option>-m</option>). May be used with big
+jobs to limit system overload.</para>
+ <para>&seealso; options &optserialonce;,
+&optlavg;.</para>
</listitem>
</varlistentry>
<varlistentry id="fcrontab.5.bootrun">
<term>b</term>
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>false</constant>)</para>
- <para>Run a &-line at &fcron;'s startup if it should have be run during system down time.</para>
+ <para>Run a &-line at &fcron;'s startup if it should
+have be run during system down time.</para>
</listitem>
</varlistentry>
<varlistentry id="fcrontab.5.first">
<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. You can also set it to 0, which is useful when used in conjunction with option &optvolatile;.</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">
<term>r</term>
<listitem>
<para><emphasis><type>integer</type></emphasis></para>
- <para>Run every "<replaceable>runfreq</replaceable>" matches of time and date. (this option is ignored for <link linkend="uptent">lines based on elapsed system up time</link>).</para>
+ <para>Run every "<replaceable>runfreq</replaceable>"
+matches of time and date. (this option is ignored for <link
+linkend="uptent">lines based on elapsed system up time</link>).</para>
</listitem>
</varlistentry>
<varlistentry id="fcrontab.5.mailto">
<term>mailto</term>
<listitem>
- <para><emphasis><type>user-name</type></emphasis>(<constant>name of file's owner</constant>)</para>
- <para>Mail output (if needed) to "<replaceable>user-name</replaceable>". A &optmailto; declared and empty (string "") is equivalent to "<token>mail(false)</token>".</para>
- <para>&seealso; options &optmail;, &optforcemail;, &optnolog;.</para>
+ <para><emphasis><type>user-name</type></emphasis>(<constant>name
+of file's owner</constant>)</para>
+ <para>Mail output (if needed) to
+"<replaceable>user-name</replaceable>". A &optmailto; declared and empty (string
+"") is equivalent to "<token>mail(false)</token>".</para>
+ <para>&seealso; options &optmail;, &optforcemail;,
+&optnolog;.</para>
</listitem>
</varlistentry>
<varlistentry id="fcrontab.5.mail">
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>true</constant>)</para>
<para>Mail output (if any) or not.</para>
- <para>&seealso; options &optmailto;, &optforcemail;, &optnolog;.</para>
+ <para>&seealso; options &optmailto;, &optforcemail;,
+&optnolog;.</para>
</listitem>
</varlistentry>
<varlistentry id="fcrontab.5.forcemail">
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>false</constant>)</para>
<para>Mail output even if zero-length.</para>
- <para>&seealso; options &optmail;, &optmailto;, &optnolog;.</para>
+ <para>&seealso; options &optmail;, &optmailto;,
+&optnolog;.</para>
</listitem>
</varlistentry>
<varlistentry id="fcrontab.5.nolog">
<term>nolog</term>
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>false</constant>)</para>
- <para>If set to true, log only errors for the corresponding job(s). May be useful for jobs running very often, and/or to reduce disk access on a laptop.</para>
- <para>&seealso; options &optmail;, &optmailto;, &optforcemail;.</para>
+ <para>If set to true, log only errors for the
+corresponding job(s). May be useful for jobs running very often, and/or to
+reduce disk access on a laptop.</para>
+ <para>&seealso; options &optmail;, &optmailto;,
+&optforcemail;.</para>
</listitem>
</varlistentry>
<varlistentry id="fcrontab.5.dayand">
<term>dayand</term>
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>true</constant>)</para>
- <para>Perform a logic AND between week and month day.</para>
+ <para>Perform a logic AND between week and month
+day.</para>
<para>&seealso; options &optdayor;.</para>
</listitem>
</varlistentry>
<term>dayor</term>
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>false</constant>)</para>
- <para>Perform a logic OR between week and month day.</para>
+ <para>Perform a logic OR between week and month
+day.</para>
<para>&seealso; options &optdayand;.</para>
</listitem>
</varlistentry>
<term>n</term>
<listitem>
<para><emphasis><type>nice-value</type></emphasis></para>
- <para>Change job priority. A <emphasis><type>nice-value</type></emphasis> is an integer from -20 (highest priority) to 19 (lowest) (only root is allowed to use a negative value with this option).</para>
+ <para>Change job priority. A
+<emphasis><type>nice-value</type></emphasis> is an integer from -20 (highest
+priority) to 19 (lowest) (only root is allowed to use a negative value with this
+option).</para>
</listitem>
</varlistentry>
<varlistentry id="fcrontab.5.runas">
<term>runas</term>
<listitem>
<para><emphasis><type>user-name</type></emphasis></para>
- <para>Run with "<replaceable>user-name</replaceable>" permissions and environment (only root is allowed to use this option).</para>
+ <para>Run with "<replaceable>user-name</replaceable>"
+permissions and environment (only root is allowed to use this option).</para>
</listitem>
</varlistentry>
<varlistentry id="fcrontab.5.lavg">
<term>lavg</term>
<listitem>
- <para><emphasis><type>real</type></emphasis>(<constant>0</constant>) <emphasis><type>real</type></emphasis>(<constant>0</constant>) <emphasis><type>real</type></emphasis>(<constant>0</constant>)</para>
- <para>Set the values of the 1, 5 and 15 minutes (in this order) system load average values below which the job should run. The values have a maximum of 1 decimal (i.e. "2.3"), any other decimals are only used to round off. Set a value to 0 to ignore the corresponding load average (or all of the values to run the job regardless of the load average).</para>
- <para>&seealso; options &optlavg1;, &optlavg5;, &optlavg15;, &optuntil;, &optlavgonce;, &optlavgor;, &optlavgand;, &optstrict;, &optnoticenotrun;.</para>
+ <para><emphasis><type>real</type></emphasis>(<constant>0</constant>)
+<emphasis><type>real</type></emphasis>(<constant>0</constant>)
+<emphasis><type>real</type></emphasis>(<constant>0</constant>)</para>
+ <para>Set the values of the 1, 5 and 15 minutes (in this
+order) system load average values below which the job should run. The values
+have a maximum of 1 decimal (i.e. "2.3"), any other decimals are only used to
+round off. Set a value to 0 to ignore the corresponding load average (or all of
+the values to run the job regardless of the load average).</para>
+ <para>&seealso; options &optlavg1;, &optlavg5;,
+&optlavg15;, &optuntil;, &optlavgonce;, &optlavgor;, &optlavgand;, &optstrict;,
+&optnoticenotrun;.</para>
</listitem>
</varlistentry>
<varlistentry id="fcrontab.5.lavgX">
<term>lavg15</term>
<listitem>
<para><emphasis><type>real</type></emphasis>(<constant>0</constant>)</para>
- <para>Set the threshold of, respectively, the 1, 5 or 15 minutes system load average value. Set one of them to 0 to ignore the corresponding load average.</para>
+ <para>Set the threshold of, respectively, the 1, 5 or 15
+minutes system load average value. Set one of them to 0 to ignore the
+corresponding load average.</para>
<para>&seealso; options &optlavg;.</para>
</listitem>
</varlistentry>
<term>until</term>
<listitem>
<para><emphasis><type>time-value</type></emphasis>(<constant>0</constant>)</para>
- <para>Set the timeout of the waiting of the wanted system load average values. If the timeout is exceeded, the job runs no matter the load average. Set until to 0 to remove the timeout.</para>
+ <para>Set the timeout of the waiting of the wanted
+system load average values. If the timeout is exceeded, the job runs no matter
+the load average. Set until to 0 to remove the timeout.</para>
<para>&seealso; options &optlavg;.</para>
</listitem>
</varlistentry>
<term>lavgonce</term>
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>&lavgoncedef;</constant>)</para>
- <para>Can a job be queued several times in lavg queue simultaneously ?</para>
+ <para>Can a job be queued several times in lavg queue
+simultaneously ?</para>
<para>&seealso; options &optlavg;.</para>
</listitem>
</varlistentry>
<term>lavgand</term>
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>true</constant>)</para>
- <para>Perform a logic AND between the 1, 5 and 15 minutes system load average values.</para>
+ <para>Perform a logic AND between the 1, 5 and 15
+minutes system load average values.</para>
<para>&seealso; options &optlavg;, &optlavgor;.</para>
</listitem>
</varlistentry>
<term>lavgor</term>
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>false</constant>)</para>
- <para>Perform a logic OR between the 1, 5 and 15 minutes system load average values.</para>
+ <para>Perform a logic OR between the 1, 5 and 15 minutes
+system load average values.</para>
<para>&seealso; options &optlavg;, &optlavgand;.</para>
</listitem>
</varlistentry>
<term>strict</term>
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>true</constant>)</para>
- <para>When a lavg %-job is at the end of an interval of execution, should it be removed from the lavg queue (strict(true), so the job is not run) or be let there until the system load average allows its execution (strict(false)) ?</para>
- <para>&seealso; options &optlavg;, &optnoticenotrun;.</para>
+ <para>When a lavg %-job is at the end of an interval of
+execution, should it be removed from the lavg queue (strict(true), so the job is
+not run) or be let there until the system load average allows its execution
+(strict(false)) ?</para>
+ <para>&seealso; options &optlavg;,
+&optnoticenotrun;.</para>
</listitem>
</varlistentry>
<varlistentry id="fcrontab.5.noticenotrun">
<term>noticenotrun</term>
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>no</constant>)</para>
- <para>Should &fcron; mail user to report the non-execution of a %-job or a &-job ? (because of system down state for both or a too high system load average for the latter)</para>
+ <para>Should &fcron; mail user to report the
+non-execution of a %-job or a &-job ? (because of system down state for both or
+a too high system load average for the latter)</para>
<para>&seealso; options &optlavg;, &optstrict;.</para>
</listitem>
</varlistentry>
<term>tzdiff</term>
<listitem>
<para><emphasis><type>integer</type></emphasis>(<constant>0</constant>)</para>
- <para>Time zone difference (in hours, between -24 and 24) between the system time, and the local real time. This option allows a user to define its & and %-lines in the local time. Note that this value is set for a whole fcrontab file, and only the last definition is taken into account.</para>
+ <para>Time zone difference (in hours, between -24 and
+24) between the system time, and the local real time. This option allows a user
+to define its & and %-lines in the local time. Note that this value is set for a
+whole fcrontab file, and only the last definition is taken into account.</para>
<para>&seealso; options &optlavg;, &optstrict;.</para>
</listitem>
</varlistentry>
<term>random</term>
<listitem>
<para><emphasis><type>boolean</type></emphasis>(<constant>0</constant>)</para>
- <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>
+ <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>
+ <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>
+ <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>
- <para>Note a special case to be handled :
-A job should be entered into the serial queue, *but* the previous entry for this job has not been completed yet, because of high system load or some external event. Option <varname>serialonce</varname> answers the question : should the new entry of the job be ignored ? This way one can distinguish between jobs required to run a certain number of times, preferably at specified times, and tasks to be performed irrespective of their number (-> serialonce(true)), which make the system respond faster.</para>
- <para>The same considerations apply for the load average queue, and can be expressed with option <varname>lavgonce</varname>.</para>
- <para>Moreover, if the serial or the lavg queue contains respectively more than &serialqueuemax; and &lavgqueuemax; jobs, any new job is refused and not run to avoid an overwhelming of system resources. In this case, an error message is logged through syslog.</para>
- <para>Finally, if jobs remain in the lavg or serial queues when fcron stops, they will be put once in the corresponding queue on startup (their order may not be conserved).</para>
+ <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>
+ <para>Note a special case to be handled : A job should be entered
+into the serial queue, *but* the previous entry for this job has not been
+completed yet, because of high system load or some external event. Option
+<varname>serialonce</varname> answers the question : should the new entry of the
+job be ignored ? This way one can distinguish between jobs required to run a
+certain number of times, preferably at specified times, and tasks to be
+performed irrespective of their number (-> serialonce(true)), which make the
+system respond faster.</para>
+ <para>The same considerations apply for the load average queue, and
+can be expressed with option <varname>lavgonce</varname>.</para>
+ <para>Moreover, if the serial or the lavg queue contains
+respectively more than &serialqueuemax; and &lavgqueuemax; jobs, any new job is
+refused and not run to avoid an overwhelming of system resources. In this case,
+an error message is logged through syslog.</para>
+ <para>Finally, if jobs remain in the lavg or serial queues when
+fcron stops, they will be put once in the corresponding queue on startup (their
+order may not be conserved).</para>
<para><example>
<title>An example of an option declaration :</title>
<programlisting>!reset,serial(true),dayor,bootrun(0),mailto(root),lavg(.5,2,1.5)</programlisting>
<para><example>
<title>An example of a user fcrontab</title>
<programlisting>
-# use /bin/bash to run commands, ignoring what /etc/passwd says
-SHELL=/bin/bash
-
-# mail output to thib, no matter whose fcrontab this is
-!mailto(thib)
-
-# define a variable which is equivalent to " Hello thib and paul ! "
-# here the newline characters are escaped by a backslash (\)
-# and quotes are used to force to keep leading and trailing blanks
-TEXT= " Hello\
-
-
-thib and\
-
-
-paul ! "
-
-# we want to use serial but not bootrun:
-!serial(true),b(0)
-
-# run after five minutes of execution the first time,
-# then run every hours
-@first(5) 1h echo "Run every hours"
-
-# run every days
-@ 1d echo "fcron daily"
-
-# run once between in the morning and once in the afternoon
-# if systems is running at any moment of these intervals
-%hours * 8-12,14-18 * * * echo "Hey boss, I'm working today !"
-
-# run once a week during our lunch
-%weekly * 12-13 echo "I left my system on at least once \
- at lunch time this week."
-
-# run every Sunday and Saturday at 9:05
-5 9 * * sat,sun echo "Good morning Thibault !"
-
-# run every peer days of march at 18:00, except on 16th
-0 18 2-30/2~16 Mar * echo "It's time to go back home !"
-
-# the line above is equivalent to
-& 0 18 2-30/2~16 Mar * echo "It's time to go back home !"
-
-# reset options to default and set runfreq for lines below
-!reset,runfreq(7)
-
-# run once every 7 matches (thanks to the declaration above),
-# so if system is running every day at 10:00, this will be
-# run once a week
-& 0 10 * * * echo "if you got this message last time 7 days ago,\
- this computer has been running every day at 10:00 last week.\
- If you got the message 8 days ago, then the system has been down \
- one day at 10:00 since you got it, etc"
-
-# wait every hour for a 5 minutes load average under 0.9
-@lavg5(0.9) 1h echo "The system load average is low"
-
-# wait a maximum of 5 hours every day for a fall of the load average
-@lavgand,lavg(1,2.0,3.0),until(5h) 1d echo "Load average is going down"
-
-# wait for the best moment to run a heavy job
-@lavgor,lavg(0.8,1.2,1.5),nice(10) 1w echo "This is a heavy job"
-
-# run once every night between either 21:00 and 23:00 or
-# between 3:00 and 6:00
-%nightly,lavg(1.5,2,2) * 21-23,3-6 echo "It's time to retrieve \
-the last release of Mozilla !"</programlisting>
+# use /bin/bash to run commands, ignoring what /etc/passwd says SHELL=/bin/bash
+# mail output to thib, no matter whose fcrontab this is !mailto(thib) # define a
+variable which is equivalent to " Hello thib and paul ! " # here the newline
+characters are escaped by a backslash (\) # and quotes are used to force to keep
+leading and trailing blanks TEXT= " Hello\ thib and\ paul ! " # we want to use
+serial but not bootrun: !serial(true),b(0) # run after five minutes of execution
+the first time, # then run every hours @first(5) 1h echo "Run every hours" #
+run every days @ 1d echo "fcron daily" # run once between in the morning and
+once in the afternoon # if systems is running at any moment of these intervals
+%hours * 8-12,14-18 * * * echo "Hey boss, I'm working today !" # run once a week
+during our lunch %weekly * 12-13 echo "I left my system on at least once \ at
+lunch time this week." # run every Sunday and Saturday at 9:05 5 9 * * sat,sun
+echo "Good morning Thibault !" # run every peer days of march at 18:00, except
+on 16th 0 18 2-30/2~16 Mar * echo "It's time to go back home !" # the line above
+is equivalent to & 0 18 2-30/2~16 Mar * echo "It's time to go back home !" #
+reset options to default and set runfreq for lines below !reset,runfreq(7) # run
+once every 7 matches (thanks to the declaration above), # so if system is
+running every day at 10:00, this will be # run once a week & 0 10 * * * echo "if
+you got this message last time 7 days ago,\ this computer has been running every
+day at 10:00 last week.\ If you got the message 8 days ago, then the system has
+been down \ one day at 10:00 since you got it, etc" # wait every hour for a 5
+minutes load average under 0.9 @lavg5(0.9) 1h echo "The system load average is
+low" # wait a maximum of 5 hours every day for a fall of the load average
+@lavgand,lavg(1,2.0,3.0),until(5h) 1d echo "Load average is going down" # wait
+for the best moment to run a heavy job @lavgor,lavg(0.8,1.2,1.5),nice(10) 1w
+echo "This is a heavy job" # run once every night between either 21:00 and 23:00
+or # between 3:00 and 6:00 %nightly,lavg(1.5,2,2) * 21-23,3-6 echo "It's time
+to retrieve \ the last release of Mozilla !"</programlisting>
</example></para>
</refsect1>
<varlistentry>
<term><filename>&etc;/&fcron.conf.location;</filename></term>
<listitem>
- <para>Configuration file for &fcron;, &fcrontab; and &fcrondyn; : contains paths (spool dir, pid file) and default programs to use (editor, shell, etc). See <link linkend="fcron.conf.5">&fcron.conf(5)</link> for more details.</para>
+ <para>Configuration file for &fcron;, &fcrontab; and
+&fcrondyn; : contains paths (spool dir, pid file) and default programs to use
+(editor, shell, etc). See <link linkend="fcron.conf.5">&fcron.conf(5)</link> for
+more details.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>&etc;/&fcron.allow;</filename></term>
<listitem>
- <para>Users allowed to use &fcrontab; and &fcrondyn; (one name per line, special name "all" acts for everyone)</para>
+ <para>Users allowed to use &fcrontab; and &fcrondyn; (one
+name per line, special name "all" acts for everyone)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>&etc;/&fcron.deny;</filename></term>
<listitem>
- <para>Users who are not allowed to use &fcrontab; and &fcrondyn; (same format as allow file)</para>
+ <para>Users who are not allowed to use &fcrontab; and
+&fcrondyn; (same format as allow file)</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>&etc;/pam.d/fcron</filename> (or <filename>&etc;/pam.conf</filename>)</term>
+ <term><filename>&etc;/pam.d/fcron</filename> (or
+<filename>&etc;/pam.conf</filename>)</term>
<listitem>
- <para><productname>PAM</productname> configuration file for &fcron;. Take a look at pam(8) for more details.</para>
+ <para><productname>PAM</productname> configuration file for
+&fcron;. Take a look at pam(8) for more details.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
- <refsect1>
- <title>See also</title>
- <simplelist>
- <member><link linkend="fcron.8">&fcron;(8)</link></member>
- <member><link linkend="fcrontab.1">&fcrontab;(1)</link></member>
- <member><link linkend="fcrondyn.1">&fcrondyn;(1)</link></member>
- <member><link linkend="fcrontab.5">&fcron.conf;(5)</link></member>
- <member>The HTML version of the documentation, if you are not reading it right now, which is far better than these man pages :)).</member>
- </simplelist>
- </refsect1>
-
- <refsect1>
- <title>Author</title>
- <para>Thibault Godouet &email;</para>
- </refsect1>
+ &manpage-foot;
</refentry>
projects / fcron / commitdiff