From: thib <thib>
Date: Thu, 29 Aug 2002 17:35:00 +0000 (+0000)
Subject: updated : doc for ls_*
X-Git-Tag: ver1564~44
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=47ac5264256b2d256d99e7bb04a9fef75c48aa6a;p=fcron

updated : doc for ls_*
---

diff --git a/doc/en/fcrondyn.1.sgml b/doc/en/fcrondyn.1.sgml
index 910a263..e4ec14e 100644
--- a/doc/en/fcrondyn.1.sgml
+++ b/doc/en/fcrondyn.1.sgml
@@ -8,7 +8,7 @@ Foundation.
 A copy of the license is included in gfdl.sgml.
 -->
 
-<!-- $Id: fcrondyn.1.sgml,v 1.5 2002-08-22 21:37:58 thib Exp $ -->
+<!-- $Id: fcrondyn.1.sgml,v 1.6 2002-08-29 17:35:00 thib Exp $ -->
 
 <refentry id="fcrondyn.1">
     <refmeta>
@@ -53,7 +53,8 @@ them, renice a running job, send a signal to a running job, etc.</para>
 	    <varlistentry>
 		<term><option>-i</option></term>
 		<listitem>
-		    <para>Run &fcrondyn; in interactive mode.</para>
+		    <para>Run &fcrondyn; in interactive mode. &fcrondyn; is also
+		    run in interactive mode when no option is given.</para>
 		</listitem>
 	    </varlistentry>
 	    <varlistentry>
@@ -172,29 +173,35 @@ fields used by <command>ls*</command> commands.</para>
 		<term><command>ls_lavgq</command>
 [<emphasis><type>user</type></emphasis>]</term>
 		<listitem>
-		    <para>(NOT THE PID OF THE JOB ITSELF BUT THE FCRON PROCESS CONTROLLING IT - but the job's pid is likely to be next to that one (under linux at least))</para>
+		    <para>Same as <command>ls</command>, but list only the jobs
+which are in the load-average queue (i.e. which are waiting for a lower load
+average to be run).</para>
 		</listitem>
 	    </varlistentry>
 	    <varlistentry>
 		<term><command>ls_serialq</command>
 [<emphasis><type>user</type></emphasis>]</term>
 		<listitem>
-		    <para></para>
+		    <para>Same as <command>ls</command>, but list only the jobs
+		    which are in the serial queue (i.e. which are waiting for
+		    other jobs to be finished).</para>
 		</listitem>
 	    </varlistentry>
 	    <varlistentry>
 		<term><command>ls_exeq</command>
 [<emphasis><type>user</type></emphasis>]</term>
 		<listitem>
-		    <para></para>
+		    <para>Same as <command>ls</command>, but list only the jobs
+		    which are running.</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>
+		    <para>Print details about a
+job. <emphasis><type>jobid</type></emphasis> is the one given by
+<command>ls</command>.</para>
 		</listitem>
 	    </varlistentry>
 	    <varlistentry>
@@ -229,17 +236,36 @@ fields used by <command>ls*</command> commands.</para>
 	    </varlistentry>
 	</variablelist>
 	<variablelist id="fcrondyn.1.ls.fields">
-	    <title>Fields used by <command>ls*</command> commands</title>
+	    <title>Fields used by <command>detail</command> and
+	    <command>ls*</command> commands</title>
+	    <varlistentry>
+		<term>ID</term>
+		<listitem>
+		    <para>Job's unique identification number.</para>
+		</listitem>
+	    </varlistentry>
 	    <varlistentry>
 		<term>USER</term>
 		<listitem>
-		    <para>user who owns this job.</para>
+		    <para>User who owns this job.</para>
 		</listitem>
 	    </varlistentry>
 	    <varlistentry>
-		<term>ID</term>
+		<term>PID</term>
 		<listitem>
-		    <para>job's unique identification number.</para>
+		    <para>The pid of the running job.</para>
+		    <warning>
+			<para>This is currently not the pid of the job itself,
+			but the pid of the fcron process controlling it. However,
+			the pid of the job itself should be a number close to
+			that one (under linux at least).</para>
+		    </warning>
+		</listitem>
+	    </varlistentry>
+	    <varlistentry>
+		<term>INDEX</term>
+		<listitem>
+		    <para>Index of the job in the serial queue (i.e. it will be run when all the jobs of an inferior index have been run)</para>
 		</listitem>
 	    </varlistentry>
 	    <varlistentry>
@@ -249,16 +275,45 @@ fields used by <command>ls*</command> commands.</para>
 serial or lavg queue.</para>
 		</listitem>
 	    </varlistentry>
+	    <varlistentry>
+		<term>OPTIONS</term>
+		<listitem>
+		    <para>List of main options which are set. L for lavg jobs
+		    (LO if the job is also lavgonce), S for serial (SO if also
+		    serialone), ES for exesev jobs.</para>
+		</listitem>
+	    </varlistentry>
+	    <varlistentry>
+		<term>LAVG</term>
+		<listitem>
+		    <para>3 values, corresponding to the 1, 5, and 15-minute (in
+		    this order) system load average values below which the job
+		    should be run (see &optlavg; option).</para>
+		</listitem>
+	    </varlistentry>
+	    <varlistentry>
+		<term>UNTIL</term>
+		<listitem>
+		    <para>Field corresponding to the &optuntil; option.</para>
+		</listitem>
+	    </varlistentry>
+	    <varlistentry>
+		<term>STRICT</term>
+		<listitem>
+		    <para>Field corresponding to the &optstrict; option. Y for
+		    yes, N for no.</para>
+		</listitem>
+	    </varlistentry>
 	    <varlistentry>
 		<term>SCHEDULE</term>
 		<listitem>
-		    <para>next run is scheduled at this time and date.</para>
+		    <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>
+		    <para>The command that will be executed.</para>
 		</listitem>
 	    </varlistentry>
 	</variablelist>