From 8db437bcb86aac99eb3d145e06ce129c0dbddae5 Mon Sep 17 00:00:00 2001 From: thib Date: Mon, 14 Jul 2003 10:58:43 +0000 Subject: [PATCH] updated support for emacs's psgml updated support for emacs's psgml >> alphabetized options >> tried to make things clearer >> grammar mistake fixed >> --- doc/en/fcrontab.5.sgml | 455 ++++++++++++++++++++++------------------- 1 file changed, 249 insertions(+), 206 deletions(-) diff --git a/doc/en/fcrontab.5.sgml b/doc/en/fcrontab.5.sgml index 93d65a8..1b78500 100644 --- a/doc/en/fcrontab.5.sgml +++ b/doc/en/fcrontab.5.sgml @@ -8,7 +8,7 @@ Foundation. A copy of the license is included in gfdl.sgml. --> - + @@ -249,7 +249,7 @@ below). # 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. +# get mails every hour 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 @@ -263,40 +263,25 @@ below). Entries run periodically The third type of &fcrontabf;'s entries begin by a "%", -followed by one of the keywords : - - hourly - daily - monthly - weekly - - - midhourly - middaily - nightly - midmonthly - midweekly - - - mins - hours - days - mons - dow - - and optional options. - 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 weekly 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 : midweekly will run a command once from -Thursday to Wednesday. Note that nightly is equivalent to -middaily. +followed by a keyword from one of 3 different lists, and optional options. + + "*ly" keywords + Those keywords are : + + hourly + daily + monthly + weekly + + Those keywords tell &fcron; to run the command +once from the beginning of the corresponding time interval to the end of that +time interval. A time interval is, for example, the time from Monday 16:20 to Wednesday 01h43. +For instance, the keyword weekly tells &fcron; +to run a command once between Monday and Sunday each week. With this two kind of keywords, user must give the needed time fields (as defined in "Entries based on time and date" (see above)) to specify when the command should be run during -each interval : +each time interval : Needed time fields for each keyword @@ -326,6 +311,23 @@ each interval :
+ + + + "mid*ly" keywords + They are similar to the "*ly" ones : + + midhourly + middaily + nightly + midmonthly + midweekly + + They work exactly has the "*ly" keywords, except +that the time intervals are defined from middle to middle of the corresponding +"*ly" intervals : midweekly will run a command once from +Thursday to Wednesday. Note that nightly is equivalent to +middaily. For example : @@ -339,12 +341,24 @@ option &optmail;). &seealso; options &optlavg;, &optnoticenotrun;, &optstrict;, &optmail;, &optnolog;, &optserial;, &optnice;, &optrunas;, &optrandom; (see below). - - The keywords of the third list act differently, as + + + + + "*s" keywords + They are : + + mins + hours + days + mons + dow + + Those keywords act differently, as follows: - run this command once during EACH interval specified, ignoring -the fields below the keyword in the interval definition (a -hours prevents the mins field to be considered as an + run this command once during EACH time interval specified, ignoring +the fields below the keyword in the time interval definition (a +hours prevents the mins field to be considered as a time interval, but it will be used to determine when the line should be run during an interval : see the note below) (dow means "day of week"). @@ -356,14 +370,17 @@ dates in the lines with that kind of keyword (i.e. the following is not allowed but %hours * 0-22 * * * echo "Ok." is allowed). - a single number in a field is considered as an interval : + a single number in a field is considered as a time interval : %mins 15 2-4 * * * echo will run at 2:15, 3:15 AND 4:15 every day. - But every fields below the keywords are ignored in + But all fields below the keywords are ignored in time interval definition : %hours 15 2-4 * * * echo will run only ONCE either at 2:15, 3:15 OR 4:15. &seealso; option &optrandom; (see below). + + + @@ -375,64 +392,57 @@ a whole line immediately after an exclamation mark (!), while it is done after a that an option declaration in a schedule overrides the global declaration of that same option. Options are separated by comas (,) and their arguments, if -any, are placed between brackets ("(" and ")") and separated by comas. No spaces +any, are placed in parentheses ("(" and ")") and separated by comas. No spaces are allowed. A declaration of options is of the form
option[(arg1[,arg2][...])][,option[(arg1[...])]][...]
where option is either the name of an option or its -abbreviation. The options are (default value between brackets) : +abbreviation. The options are (default value in parentheses) : - Valid options in a &fcrontabf; - - reset - - boolean - Reset all the options to default. - - - - exesev + Valid options in a &fcrontabf; (alphabetically) + + + bootrun + b boolean(false) - Can a job be executed several times simultaneously -? - &seealso; options &optserialonce;, -&optlavgonce;. + Run a &-line at &fcron;'s startup if it should +have be run during system down time. - - serialonce + + + dayand - boolean(&serialoncedef;) - Can a job be queued several times in serial queue -simultaneously ? - &seealso; options &optexesev;, -&optlavgonce;. + boolean(true) + Perform a logic AND between week and month +day. + &seealso; options &optdayor;. - - serial - s + + + dayor boolean(false) - &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 ). May be used with big -jobs to limit system overload. - &seealso; options &optserialonce;, -&optlavg;. + Perform a logic OR between week and month +day. + &seealso; options &optdayand;. - - bootrun - b + + + exesev boolean(false) - Run a &-line at &fcron;'s startup if it should -have be run during system down time. + Can a job be executed several times simultaneously +? + &seealso; options &optserialonce;, +&optlavgonce;. + first f @@ -445,28 +455,76 @@ avoid them to run simultaneously everytime. You can also set it to 0, which is useful when used in conjunction with option &optvolatile;. - - runfreq - r + + + forcemail - integer - Run every "runfreq" -matches of time and date. (this option is ignored for lines based on elapsed system up time). + boolean(false) + Mail output even if zero-length. + &seealso; options &optmail;, &optmailto;, +&optnolog;. - - mailto + + + lavg - user-name(name -of file's owner) - Mail output (if needed) to -"user-name". A &optmailto; declared and empty (string -"") is equivalent to "mail(false)". - &seealso; options &optmail;, &optforcemail;, -&optnolog;. + real(0) +real(0) +real(0) + Set the values of the 1, 5 and 15-minute (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). + &seealso; options &optlavg1;, &optlavg5;, +&optlavg15;, &optuntil;, &optlavgonce;, &optlavgor;, &optlavgand;, &optstrict;, +&optnoticenotrun;. + + + + lavg1 + lavg5 + lavg15 + + real(0) + 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. + &seealso; options &optlavg;. + + + + + lavgand + + boolean(true) + Perform a logic AND between the 1, 5 and 15 +minutes system load average values. + &seealso; options &optlavg;, &optlavgor;. + + + lavgonce + + boolean(&lavgoncedef;) + Can a job be queued several times in lavg queue +simultaneously ? + &seealso; options &optlavg;. + + + + + lavgor + + boolean(false) + Perform a logic OR between the 1, 5 and 15 minutes +system load average values. + &seealso; options &optlavg;, &optlavgand;. + + + mail m @@ -477,15 +535,32 @@ of file's owner) &optnolog;. - - forcemail + + + mailto - boolean(false) - Mail output even if zero-length. - &seealso; options &optmail;, &optmailto;, + user-name(name +of file's owner) + Mail output (if needed) to +"user-name". A &optmailto; declared and empty (string +"") is equivalent to "mail(false)". + &seealso; options &optmail;, &optforcemail;, &optnolog;. + + + nice + n + + nice-value + Change job priority. A +nice-value is an integer from -20 (highest +priority) to 19 (lowest) (only root is allowed to use a negative value with this +option). + + + nolog @@ -497,35 +572,40 @@ reduce disk access on a laptop. &optforcemail;. - - dayand + + + noticenotrun - boolean(true) - Perform a logic AND between week and month -day. - &seealso; options &optdayor;. + boolean(false) + 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) + &seealso; options &optlavg;, &optstrict;. - - dayor + + + random boolean(false) - Perform a logic OR between week and month -day. - &seealso; options &optdayand;. + In a line run +periodically, this option answers the question : should this job be run +as soon as possible in its time interval of execution (safer), or should fcron set a +random time of execution in that time interval ? Note that if this option is set, the +job may not run if fcron is not running during all the +execution interval. Besides, you must know that the random scheme may be quite +easy to guess for skilled people. - - nice - n + + + reset - nice-value - Change job priority. A -nice-value is an integer from -20 (highest -priority) to 19 (lowest) (only root is allowed to use a negative value with this -option). + boolean + Reset all the options to default. + runas @@ -534,76 +614,59 @@ option). permissions and environment (only root is allowed to use this option). - - lavg - - real(0) -real(0) -real(0) - Set the values of the 1, 5 and 15-minute (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). - &seealso; options &optlavg1;, &optlavg5;, -&optlavg15;, &optuntil;, &optlavgonce;, &optlavgor;, &optlavgand;, &optstrict;, -&optnoticenotrun;. - - - - lavg1 - lavg5 - lavg15 + + + runfreq + r - real(0) - 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. - &seealso; options &optlavg;. + integer + Run every "runfreq" +matches of time and date. (this option is ignored for lines based on elapsed system up time). - - until + + + serial + s - time-value(0) - 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. - &seealso; options &optlavg;. + boolean(false) + &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 ). May be used with big +jobs to limit system overload. + &seealso; options &optserialonce;, +&optlavg;. - - lavgonce + + + serialonce - boolean(&lavgoncedef;) - Can a job be queued several times in lavg queue + boolean(&serialoncedef;) + Can a job be queued several times in serial queue simultaneously ? - &seealso; options &optlavg;. - - - - lavgand - - boolean(true) - Perform a logic AND between the 1, 5 and 15 -minutes system load average values. - &seealso; options &optlavg;, &optlavgor;. + &seealso; options &optexesev;, +&optlavgonce;. - - lavgor + + + stdout boolean(false) - Perform a logic OR between the 1, 5 and 15 minutes -system load average values. - &seealso; options &optlavg;, &optlavgand;. + If fcron is running in the forground, then also +let jobs print to stderr/stdout instead of mailing or discarding it. + &seealso; fcron's option +in &fcron;(8). + strict boolean(true) - When a lavg %-job is at the end of an interval of + When a lavg %-job is at the end of a time 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)) ? @@ -611,16 +674,7 @@ not run) or be let there until the system load average allows its execution &optnoticenotrun;. - - noticenotrun - - boolean(no) - 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) - &seealso; options &optlavg;, &optstrict;. - - + tzdiff @@ -632,23 +686,22 @@ whole fcrontab file, and only the last definition is taken into account. &seealso; options &optlavg;, &optstrict;. - - random + + + until - boolean(0) - In a line run -periodically, 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 all the -execution interval. Besides, you must know that the random scheme may be quite -easy to guess for skilled people. + time-value(0) + 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. + &seealso; options &optlavg;. + volatile - boolean(0) + boolean(false) 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 @@ -660,19 +713,10 @@ linkend="uptent">lines based on elapsed system up time, fcron's option in &fcron;(8). - - stdout - - boolean(0) - If fcron is running in the forground, then also -let jobs print to stderr/stdout instead of mailing or discarding it. - &seealso; fcron's option -in &fcron;(8). - - + A boolean argument can be inexistent, in which -case brackets are not used and it means true; the string +case parentheses are not used and it means true; the string "true", "yes" or 1 to mean true; and the string "false", "no" or 0 to mean false. See above for explanations about time value (section "entries based on elapsed system up @@ -730,14 +774,14 @@ TEXT= " Hello\ !serial(true),b(0) # run after five minutes of execution the first time, -# then run every hours -@first(5) 1h echo "Run every hours" +# then run every hour +@first(5) 1h echo "Run every hour" -# run every days +# run every day @ 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 +# if systems is running at any moment of these time intervals %hours * 8-12,14-18 * * * echo "Hey boss, I'm working today !" # run once a week during our lunch @@ -826,6 +870,5 @@ name per line, special name "all" acts for everyone) Local variables: mode: sgml sgml-parent-document:("fcron-doc.sgml" "book" "chapter" "sect1" "") -sgml-default-dtd-file: "fcron-doc.ced" End: --> -- 2.40.0