granicus.if.org Git - fcron/blob - doc/en/fcron.conf.5.sgml

   1 <!--
   2 Fcron documentation
   3 Copyright 2000-2012 Thibault Godouet <fcron@free.fr>
   4 Permission is granted to copy, distribute and/or modify this
   5 document under the terms of the GNU Free Documentation License,
   6 Version 1.1 or any later version published by the Free Software
   7 Foundation.
   8 A copy of the license is included in gfdl.sgml.
   9 -->
  10
  11
  12 <refentry id="fcron.conf.5">
  13     <refmeta>
  14         <refentrytitle>fcron.conf</refentrytitle>
  15         <manvolnum>5</manvolnum>
  16         <refmiscinfo>Fcron &version; <![%devrelease; [
  17 (<emphasis>development</emphasis> release)]]></refmiscinfo>
  18         <refmiscinfo>&date;</refmiscinfo>
  19     </refmeta>
  20     <refnamediv>
  21         <refname>fcron.conf</refname>
  22         <refpurpose>configuration file for fcron and fcrontab</refpurpose>
  23     </refnamediv>
  24
  25     <refsect1>
  26         <title>Description</title>
  27         <abstract>
  28             <para>This page describes the syntax used for the configuration file
  29 of <link linkend="fcrontab.1">&fcrontab;</link>(1), <link
  30 linkend="fcrondyn.1">&fcrondyn;</link>(1) and <link
  31 linkend="fcron.8">&fcron;</link>(8).</para>
  32         </abstract>
  33         <para>Blank lines, line beginning by a hash sign (#) (which are
  34 considered comments), leading blanks and tabs are ignored. Each line in a
  35 &fcron.conf file is of the form
  36  <blockquote>
  37                 <para>name = value</para>
  38             </blockquote> where the blanks around equal-sign (=) are ignored and
  39 optional. Trailing blanks are also ignored.
  40 </para>
  41         <para>The following names are recognized (default value in parentheses):
  42 <variablelist>
  43                 <title>Valid variables in a fcron.conf file</title>
  44                 <varlistentry>
  45                     <term><varname>fcrontabs</varname>=<replaceable>directory</replaceable>
  46 (<filename>&fcrontabsdir;</filename>)</term>
  47                     <listitem>
  48                         <para>&Fcron; spool directory.</para>
  49                     </listitem>
  50                 </varlistentry>
  51                 <varlistentry>
  52                     <term><varname>pidfile</varname>=<replaceable>file-path</replaceable>
  53 (<filename>&fcron.pid;</filename>)</term>
  54                     <listitem>
  55                         <para>Location of &fcron; pid file (needed by &fcrontab;
  56 to work properly).</para>
  57                     </listitem>
  58                 </varlistentry>
  59                 <varlistentry>
  60                     <term><varname>fifofile</varname>=<replaceable>file-path</replaceable>
  61 (<filename>&fcron.fifo;</filename>)</term>
  62                     <listitem>
  63                         <para>Location of &fcron; fifo file (needed by
  64 &fcrondyn; to communicate with &fcron;).</para>
  65                     </listitem>
  66                 </varlistentry>
  67                 <varlistentry>
  68                     <term><varname>fcronallow</varname>=<replaceable>file-path</replaceable>
  69 (<filename>&etc;/&fcron.allow;</filename>)</term>
  70                     <listitem>
  71                         <para>Location of fcron.allow file.</para>
  72                     </listitem>
  73                 </varlistentry>
  74                 <varlistentry>
  75                     <term><varname>fcrondeny</varname>=<replaceable>file-path</replaceable>
  76 (<filename>&etc;/&fcron.deny;</filename>)</term>
  77                     <listitem>
  78                         <para>Location of fcron.deny file.</para>
  79                     </listitem>
  80                 </varlistentry>
  81                 <varlistentry>
  82                     <term><varname>shell</varname>=<replaceable>file-path</replaceable>
  83 (<filename>&shell;</filename>)</term>
  84                     <listitem>
  85                         <para>Location of default shell called by &fcron; when
  86 running a job. When &fcron; runs a job, &fcron; uses the value of <envar>SHELL</envar> from the fcrontab if any, otherwise it uses the value from <filename>fcron.conf</filename> if any, or in last resort the value from <filename>/etc/passwd</filename>.</para>
  87                     </listitem>
  88                 </varlistentry>
  89                 <varlistentry>
  90                     <term><varname>sendmail</varname>=<replaceable>file-path</replaceable>
  91 (<filename>&sendmail;</filename>)</term>
  92                     <listitem>
  93                         <para>Location of mailer program called by &fcron; to
  94 send job output.</para>
  95                     </listitem>
  96                 </varlistentry>
  97                 <varlistentry>
  98                     <term><varname>editor</varname>=<replaceable>file-path</replaceable>
  99 (<filename>&editor;</filename>)</term>
 100                     <listitem>
 101                         <para>Location of default editor used when invoking
 102 "fcrontab -e".</para>
 103                     </listitem>
 104                 </varlistentry>
 105             </variablelist> File-paths and directories are complete and absolute
 106 (i.e. beginning by a "/").</para>
 107         <para>To run several instances of &fcron; simultaneously on the same
 108 system, you must use a different configuration file for each instance. Each
 109 instance must have a different <varname>fcrontabs</varname>,
 110 <varname>pidfile</varname> and <varname>fifofile</varname>. Then, use <link
 111 linkend="fcron.8">&fcron;</link>(8)'s command line option
 112 <parameter>-c</parameter> to select which config file (so which instance) you
 113 refer to.</para>
 114     </refsect1>
 115
 116     <refsect1>
 117         <title>Files</title>
 118         <variablelist>
 119             <varlistentry>
 120                 <term><filename>&etc;/&fcron.conf.location;</filename></term>
 121                 <listitem>
 122                     <para>Configuration file for &fcron;, &fcrontab and
 123 &fcrondyn;: contains paths (spool dir, pid file) and default programs to use
 124 (editor, shell, etc). See <link linkend="fcron.conf.5">&fcron.conf</link>(5) for
 125 more details.</para>
 126                 </listitem>
 127             </varlistentry>
 128             <varlistentry>
 129                 <term><filename>&etc;/&fcron.allow;</filename></term>
 130                 <listitem>
 131                     <para>Users allowed to use &fcrontab; and &fcrondyn; (one
 132 name per line, special name "all" acts for everyone)</para>
 133                 </listitem>
 134             </varlistentry>
 135             <varlistentry>
 136                 <term><filename>&etc;/&fcron.deny;</filename></term>
 137                 <listitem>
 138                     <para>Users who are not allowed to use &fcrontab; and
 139 &fcrondyn; (same format as allow file)</para>
 140                 </listitem>
 141             </varlistentry>
 142             <varlistentry>
 143                 <term><filename>&etc;/pam.d/fcron</filename> (or
 144 <filename>&etc;/pam.conf</filename>)</term>
 145                 <listitem>
 146                     <para><productname>PAM</productname> configuration file for
 147 &fcron;. Take a look at &pam;(8) for more details.</para>
 148                 </listitem>
 149             </varlistentry>
 150         </variablelist>
 151     </refsect1>
 152
 153     &manpage-foot;
 154
 155 </refentry>
 156
 157 <!-- Keep this comment at the end of the file
 158 Local variables:
 159 mode: sgml
 160 sgml-parent-document:("fcron-doc.sgml" "book" "chapter" "sect1" "refentry" "")
 161 End:
 162 -->