]> granicus.if.org Git - fcron/commitdiff
*** empty log message ***
authorthib <thib>
Sun, 31 Mar 2002 15:05:49 +0000 (15:05 +0000)
committerthib <thib>
Sun, 31 Mar 2002 15:05:49 +0000 (15:05 +0000)
doc/en/changes.sgml
doc/en/fcrondyn.1.sgml
doc/en/fcrontab.1.sgml
doc/en/todo.sgml
fcron.c

index a2b01a0a720b3a2c49c168fb4941e4b8aaef59fc..d2ecae570f2ec58636447a187875164ab1d5a815 100644 (file)
@@ -8,13 +8,13 @@ Foundation.
 A copy of the license is included in gfdl.sgml.
 -->
 
-<!-- $Id: changes.sgml,v 1.8 2002-03-02 17:33:20 thib Exp $ -->
+<!-- $Id: changes.sgml,v 1.9 2002-03-31 15:09:47 thib Exp $ -->
 
 <sect1 id="changes">
     <title>Changes</title>
 
     <itemizedlist>
-       <title>From version 2.1.0 to 2.1.1</title>
+       <title>From version 2.1.0 to 2.9.0</title>
        <listitem>
            <para>Added some new options to fcron : -y, -o, -l ; and some fcrontab options : stdout and volatile. All these permit to make fcron run in foreground, execute all the pending jobs (mainly %-jobs), and return. May be used, for instance, in a ppp-up script with a dialup connection to update a software regularly.</para>
        </listitem>
index f85353d7f2387c627e69b7b5773432a9e535918e..5d0551fb7918c16827a5d2201d2915d8322c13fa 100644 (file)
@@ -8,7 +8,7 @@ Foundation.
 A copy of the license is included in gfdl.sgml.
 -->
 
-<!-- $Id: fcrondyn.1.sgml,v 1.2 2002-03-02 17:32:45 thib Exp $ -->
+<!-- $Id: fcrondyn.1.sgml,v 1.3 2002-03-31 15:08:26 thib Exp $ -->
 
 <refentry id="fcrondyn.1">
     <refmeta>
@@ -22,10 +22,210 @@ A copy of the license is included in gfdl.sgml.
        <refpurpose>dialog dyn-amically with a running fcron daemon</refpurpose>
     </refnamediv>
 
+    <refsynopsisdiv id="fcrondyn.1.synopsis">
+       <cmdsynopsis>
+           <command>fcrondyn</command>
+           <arg>-c <replaceable>file</replaceable></arg>
+           <arg>-i</arg>
+       </cmdsynopsis>
+       <cmdsynopsis>
+           <command>fcrondyn</command>
+           <arg>-c <replaceable>file</replaceable></arg>
+           <arg choice="plain">-x <replaceable>command</replaceable></arg>
+       </cmdsynopsis>
+       <cmdsynopsis>
+           <command>fcrondyn</command>
+           <arg>-h</arg>
+       </cmdsynopsis>
+    </refsynopsisdiv>
 
-<!-- ---------------------------------------------------------
-     TEXT HERE
-     --------------------------------------------------------- -->
+    <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>
+    </refsect1>
+
+    <refsect1>
+       <title>Options</title>
+       <variablelist>
+           <varlistentry>
+               <term><option>-i</option></term>
+               <listitem>
+                   <para>Run &fcrondyn; in interactive mode.</para>
+               </listitem>
+           </varlistentry>
+           <varlistentry>
+               <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>
+               </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>
+               </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>
+               </listitem>
+           </varlistentry>
+           <varlistentry>
+               <term><option>-h</option></term>
+               <listitem>
+                   <para>Display a brief description of the options.</para>
+               </listitem>
+           </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>
+               </listitem>
+           </varlistentry>
+       </variablelist>
+    </refsect1>
+
+    <refsect1 id="fcrondyn.1.cmd.descp">
+       <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>
+       </blockquote>
+       <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>
+               <term><emphasis><type>user</type></emphasis></term>
+               <listitem>
+                   <para>A valid user name.</para>
+               </listitem>
+           </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>
+               </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>
+               </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>
+               </listitem>
+           </varlistentry>
+       </variablelist>
+       <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>
+               </listitem>
+           </varlistentry>
+           <varlistentry>
+               <term><command>quit</command></term>
+               <term><command>q</command></term>
+               <listitem>
+                   <para>In interactive mode, quit fcrondyn.</para>
+               </listitem>
+           </varlistentry>
+           <varlistentry>
+               <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>
+               </listitem>
+           </varlistentry>
+           <varlistentry>
+               <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>
+               <listitem>
+                   <para></para>
+               </listitem>
+           </varlistentry>
+           <varlistentry>
+               <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>
+               <listitem>
+                   <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>
+               <listitem>
+                   <para></para>
+               </listitem>
+           </varlistentry>
+           <varlistentry>
+               <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>
+               <listitem>
+                   <para></para>
+               </listitem>
+           </varlistentry>
+           <varlistentry>
+               <term><command>renice</command> <emphasis><type>niceval</type></emphasis> <emphasis><type>jobid</type></emphasis></term>
+               <listitem>
+                   <para></para>
+               </listitem>
+           </varlistentry>
+       </variablelist>
+       <variablelist id="fcrondyn.1.ls.fields">
+           <title>Fields used by <command>ls*</command> commands</title>
+           <varlistentry>
+               <term>USER</term>
+               <listitem>
+                   <para>user who owns this job.</para>
+               </listitem>
+           </varlistentry>
+           <varlistentry>
+               <term>ID</term>
+               <listitem>
+                   <para>job's unique identification number.</para>
+               </listitem>
+           </varlistentry>
+           <varlistentry>
+               <term>R&amp;Q</term>
+               <listitem>
+                   <para>The job has this number instances running or queued in serial or lavg queue.</para>
+               </listitem>
+           </varlistentry>
+           <varlistentry>
+               <term>SCHEDULE</term>
+               <listitem>
+                   <para>next run is scheduled at this time and date.</para>
+               </listitem>
+           </varlistentry>
+           <varlistentry>
+               <term>CMD</term>
+               <listitem>
+                   <para>the command that will be executed.</para>
+               </listitem>
+           </varlistentry>
+       </variablelist>
+    </refsect1>
 
 
     <refsect1>
index a1b58ce942b09be41a338c1be22b58d50b729e99..794114bacbe259ff4e9c53e18c596c3f7fc5883e 100644 (file)
@@ -8,7 +8,7 @@ Foundation.
 A copy of the license is included in gfdl.sgml.
 -->
 
-<!-- $Id: fcrontab.1.sgml,v 1.3 2002-03-02 17:33:23 thib Exp $ -->
+<!-- $Id: fcrontab.1.sgml,v 1.4 2002-03-31 15:09:57 thib Exp $ -->
 
 <refentry id="fcrontab.1">
     <refmeta>
@@ -27,7 +27,7 @@ A copy of the license is included in gfdl.sgml.
            <command>fcrontab</command>
            <arg>-c <replaceable>file</replaceable></arg>
            <arg>-n</arg>
-           <arg choice="req"><replaceable>file</replaceable></arg>
+           <arg choice="plain"><replaceable>file</replaceable></arg>
            <group>
                <arg><replaceable>user</replaceable></arg>
                <arg>-u <replaceable>user</replaceable></arg>
index d2fc36d676002abc7b37fceb74d2911c27be327e..b6635f5796d86306efb097ab889bc6097555b304 100644 (file)
@@ -8,7 +8,7 @@ Foundation.
 A copy of the license is included in gfdl.sgml.
 -->
 
-<!-- $Id: todo.sgml,v 1.6 2002-02-25 18:47:17 thib Exp $ -->
+<!-- $Id: todo.sgml,v 1.7 2002-03-31 15:08:10 thib Exp $ -->
 
 <sect1 id="todo">
     <title>Todo</title>
@@ -16,7 +16,7 @@ A copy of the license is included in gfdl.sgml.
     <para>If you plan to help me, please send a mail at &email; to prevent two people from doing the same thing. You can send me some propositions as well.</para>
     <itemizedlist>
        <listitem>
-           <para>PAM support (included in fcron, but need more tests by people using PAM)</para>
+           <para>PAM support (included in fcron, but need more tests by people using PAM - not implemented in fcrondyn)</para>
        </listitem>
        <listitem>
            <para>allow a non-privileged user to run fcron</para>
@@ -25,11 +25,14 @@ A copy of the license is included in gfdl.sgml.
            <para>add a return code for jobs which would mean that they should not be run again (in case of an error, etc...).</para>
        </listitem>
        <listitem>
-           <para>possibility to display a list of jobs including their options, time and date of next execution, status, of only the running jobs, all the jobs, in order of execution or classified by user, etc.</para>
+           <para>fcrondyn : possibility to display a list of jobs including their options, time and date of next execution, status, of only the running jobs, all the jobs, in order of execution or classified by user, etc. (some of these functions or not implemented yet)</para>
        </listitem>
        <listitem>
            <para>run one of this job, change its nice value, stop it...</para>
        </listitem>
+       <listitem>
+           <para>make fcrondyn more secure and reliable</para>
+       </listitem>
        <listitem>
            <para>add a system of modules : at startup, fcron loads some modules
                   (.so files). Then, when fcron should run the job, it calls a function
diff --git a/fcron.c b/fcron.c
index 89ae2907d74fe0d233094cf67e1b96e9c0f08442..26dfae7858ce4149744b0c3e05a9c60eb990ca39 100644 (file)
--- a/fcron.c
+++ b/fcron.c
@@ -21,7 +21,7 @@
  *  `LICENSE' that comes with the fcron source distribution.
  */
 
- /* $Id: fcron.c,v 1.61 2002-03-02 17:26:47 thib Exp $ */
+ /* $Id: fcron.c,v 1.62 2002-03-31 15:05:49 thib Exp $ */
 
 #include "fcron.h"
 
@@ -33,7 +33,7 @@
 #include "socket.h"
 #endif
 
-char rcs_info[] = "$Id: fcron.c,v 1.61 2002-03-02 17:26:47 thib Exp $";
+char rcs_info[] = "$Id: fcron.c,v 1.62 2002-03-31 15:05:49 thib Exp $";
 
 void main_loop(void);
 void check_signal(void);
@@ -144,13 +144,13 @@ usage(void)
            "  -m n   --maxserial n    Set to n the max number of running serial jobs.\n"
            "  -c f   --configfile f   Make fcron use config file f.\n"
            "  -n d   --newspooldir d  Create d as a new spool directory.\n"
-           "  -d     --debug          Set Debug mode.\n"
            "  -f     --foreground     Stay in foreground.\n"
            "  -b     --background     Go to background.\n"
            "  -y     --nosyslog       Don't log to syslog at all.\n"
            "  -o     --once           Execute all jobs that need to be run, wait for "
            "them,\n                          then return. Sets firstsleep to 0.\n"
            "                          Especially useful with -f and -y.\n"
+           "  -d     --debug          Set Debug mode.\n"
            "  -h     --help           Show this help message.\n"
            "  -V     --version        Display version & infos about fcron.\n",
            FIRST_SLEEP