]> git.ipfire.org Git - thirdparty/fcron.git/commitdiff
fixed various invalid XML issues
authorThibault Godouet <yo8192@users.noreply.github.com>
Sat, 1 Feb 2020 14:30:13 +0000 (14:30 +0000)
committerThibault Godouet <yo8192@users.noreply.github.com>
Sat, 1 Feb 2020 14:30:13 +0000 (14:30 +0000)
doc/en/changes.sgml
doc/en/faq.sgml
doc/en/fcron-doc.sgml
doc/en/fcron.8.sgml
doc/en/fcron.conf.5.sgml
doc/en/fcrontab.5.sgml

index bba478c1a1b311890dab2736f8f80a7741a7782c..7525df6d7d3026a3eb34862c5cec34784c9bdc8c 100644 (file)
@@ -384,6 +384,7 @@ A copy of the license is included in gfdl.sgml.
            <para>made fcrontab behave better when there is no space left in the
               spool directory (used to truncate the fcrontab source file).
            </para>
+        </listitem>
         <listitem>
            <para>Added a script, check_system_crontabs, to emulate Vixie cron's
               behavior about /etc/crontab and /etc/cron.d. Please have a look
@@ -701,7 +702,7 @@ A copy of the license is included in gfdl.sgml.
         <listitem>
            <para>added some more checks in fileconf.c: allow user to use
               hours, days, hourly, daily, etc options only with %-lines: it is
-              ignored if set for a &-line, which is quite confusing for users
+              ignored if set for a &amp;-line, which is quite confusing for users
               who may type, for instance "&amp;hourly" instead of
               "%hourly".</para>
         </listitem>
@@ -893,7 +894,7 @@ A copy of the license is included in gfdl.sgml.
               well, it seems to be more logical like that :)) .</para>
         </listitem>
         <listitem>
-           <para>bug fix: using options first with a &-line may have led to
+           <para>bug fix: using options first with a &amp;-line may have led to
               some problems during the first read by fcron (mail send
               erroneously if noticenotrun was used, bad set of the first
               execution's time and date or immediate execution if bootrun was
@@ -1146,7 +1147,7 @@ A copy of the license is included in gfdl.sgml.
         </listitem>
         <listitem>
            <para>bug corrected: fcrontab now defines correctly the remain
-              value of a line based on time and date beginning with a "&" but
+              value of a line based on time and date beginning with a "&amp;" but
               without runfreq definition.</para>
         </listitem>
         <listitem>
index 7b1b234a21641d35cacceb55f6a79485a6c40f9f..316916a71244a1ffa2d5f5dfef1863852d50743f 100644 (file)
@@ -108,7 +108,7 @@ every day at 2:30, it will run at 3:30 the day of this kind of DST change.
                the time and date of the execution of a job (please see the entry
                about system clock adjustment in the present FAQ).</para>
                <para>Because of this, on non-Linux systems it is recommended to explicitly 'tell' fcron
-               about suspends and the precise suspend duration:
+               about suspends and the precise suspend duration:</para>
                <orderedlist>
                    <listitem>
                         <para>send a SIGSTOP signal to fcron when going into suspend:
@@ -122,6 +122,7 @@ every day at 2:30, it will run at 3:30 the day of this kind of DST change.
                    <listitem>
                         <para>Wake up fcron and tell it to process the suspend file and reschedule tasks accordingly:
                         <programlisting>$ kill -CONT $(cat &fcron.pid;)</programlisting></para>
+                   </listitem>
                </orderedlist>
               <para>An example script implementing this for pm-utils and systemd is included: fcron.suspend.sh.
                Note that it is however not needed on Linux.  Contribution of equivalent scripts for other
@@ -371,19 +372,19 @@ and set appropriately the paths:</para>
                  <link linkend="fcrontab.5">&fcrontab;(5),</link> and choose the
                  type of line which is the most appropriate for your needs (this is
                  likely to be a @-line or a %-line).</para>
-               <para>On a Debian/Ubuntu, the default /etc/anacrontab looks like:<para>
+               <para>On a Debian/Ubuntu, the default /etc/anacrontab looks like:</para>
 <programlisting>1       5       cron.daily       nice run-parts --report /etc/cron.daily
 7       10      cron.weekly      nice run-parts --report /etc/cron.weekly
 @monthly        15      cron.monthly nice run-parts --report /etc/cron.monthly
 </programlisting>
-               <para>A close fcron equivalent would be (see &optserial;):<para>
+               <para>A close fcron equivalent would be (see &optserial;):</para>
 <programlisting># Run once a day/week/month, and ensure only one of those tasks is run at a time:
 !reset
 !serial,nice(10)
 %daily * * run-parts --report /etc/cron.daily
 %weekly * * run-parts --report /etc/cron.weekly
 %monthly * * * run-parts --report /etc/cron.monthly</programlisting>
-               <para>Or you could go for something a bit more specific (see &optlavg;, &optnoticenotrun;):<para>
+               <para>Or you could go for something a bit more specific (see &optlavg;, &optnoticenotrun;):</para>
 <programlisting># Only run the tasks out of office-hours when the system load is low
 # and send an email to the user if fcron couldn't run the job:
 !reset
index 72a746fde717e576ab740004ece867861119831f..66815c6add54118a1fdb671c67e586b011a859e1 100644 (file)
@@ -40,12 +40,12 @@ document under the terms of the GNU Free Documentation License, Version 1.1 or
 any later version published by the Free Software Foundation; with the Back-Cover
 Texts being <!-- ulink hack because this legal notice gets diverted --> <ulink
 url="#backcover">Back Cover Text</ulink>. A copy of the license is included in
-<xref linkend="fdl">.</para>
+<xref linkend="fdl" />.</para>
        </legalnotice>
 
        <abstract>
            <para>&Fcron; is distributed under GPL license (please read the
-license in <xref linkend="gpl">).</para>
+license in <xref linkend="gpl" />).</para>
            <para>Project home page: &webpage;</para>
            <para>Author: Thibault GODOUET &email;</para>
        </abstract>
index ae9cf449982acfa35c581be28c2c9a3cb95f6d8c..6737e4c5dc295da186dea354cd336347fa0cc0ee 100644 (file)
@@ -62,7 +62,7 @@ A copy of the license is included in gfdl.sgml.
 &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>
+you don't need to start it with '&amp;'.</para>
        <para>
 &Fcron; loads users &fcrontabf;s (see <link
 linkend="fcrontab.5">&fcrontab;(5)</link>) files previously installed by
index 5d6ccaf6761bc5d4f0e61a3e3edc540a1a188708..460811a1e595835135f50f3720ba401471f966cc 100644 (file)
@@ -32,7 +32,7 @@ linkend="fcron.8">&fcron;</link>(8).</para>
        </abstract>
        <para>Blank lines, line beginning by a hash sign (#) (which are
 considered comments), leading blanks and tabs are ignored. Each line in a
-&fcron.conf file is of the form
+&fcron.conf; file is of the form
  <blockquote>
                <para>name = value</para>
            </blockquote> where the blanks around equal-sign (=) are ignored and
@@ -55,6 +55,7 @@ optional. Trailing blanks are also ignored.
                        <para>Location of &fcron; pid file (needed by &fcrontab;
 to work properly).</para>
                    </listitem>
+               </varlistentry>
                <varlistentry>
                    <term><varname>suspendfile</varname>=<replaceable>file-path</replaceable>
 (<filename>&suspendfile;</filename>)</term>
@@ -125,9 +126,9 @@ refer to.</para>
            <varlistentry>
                <term><filename>&etc;/&fcron.conf.location;</filename></term>
                <listitem>
-                   <para>Configuration file for &fcron;, &fcrontab and
+                   <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</link>(5) for
+(editor, shell, etc). See <link linkend="fcron.conf.5">&fcron.conf;</link>(5) for
 more details.</para>
                </listitem>
            </varlistentry>
index 608efc323b204a716ec599210609f8fb746db018..7a03ef4ff9394072728439e8a1e159a05d135e82 100644 (file)
@@ -161,7 +161,7 @@ time</title>
        <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
+"&amp;", 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>
@@ -503,7 +503,7 @@ linkend="uptent">lines based on elapsed system up time</link> is recommended ins
            <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
+"&amp;", 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 commas (,) and their arguments, if
@@ -522,7 +522,7 @@ abbreviation. The options are (default value in parentheses):</para>
                    <term>b</term>
                    <listitem>
                        <para><emphasis><type>boolean</type></emphasis>(<constant>false</constant>)</para>
-                       <para>Run an &-line at &fcron;'s startup (or system's resume after suspend/hibernation) if it should
+                       <para>Run an &amp;-line at &fcron;'s startup (or system's resume after suspend/hibernation) if it should
 have run during system down time.</para>
                    </listitem>
                </varlistentry>
@@ -596,7 +596,7 @@ useful when used in conjunction with option &optvolatile;.</para>
                    <term>jitter</term>
                    <listitem>
                        <para><emphasis><type>integer</type></emphasis>(<constant>0</constant>)</para>
-                       <para>Run the task between 0 and jitter seconds later than it should have been run. This options only applies to &-lines and is intended for systems where many jobs are supposed to be started at the same minute: the jitter option will randomly spread the start of all those jobs across the first jitter seconds of the minute instead of starting all of them at the first second of the minute. The argument must be between 0 and 255 (inclusive).</para>
+                       <para>Run the task between 0 and jitter seconds later than it should have been run. This options only applies to &amp;-lines and is intended for systems where many jobs are supposed to be started at the same minute: the jitter option will randomly spread the start of all those jobs across the first jitter seconds of the minute instead of starting all of them at the first second of the minute. The argument must be between 0 and 255 (inclusive).</para>
                        <para>&seealso; option &optrandom;.</para>
                    </listitem>
                </varlistentry>
@@ -731,7 +731,7 @@ reduce disk access on a laptop.</para>
                    <listitem>
                        <para><emphasis><type>boolean</type></emphasis>(<constant>false</constant>)</para>
                        <para>Should &fcron; mail user to report the
-non-execution of a %-job or an &-job? (because of system down state (including suspend/hibernation) for both or
+non-execution of a %-job or an &amp;-job? (because of system down state (including suspend/hibernation) for both or
 a too high system load average for the latter)</para>
                        <para>&seealso; options &optlavg;, &optstrict;.</para>
                    </listitem>
@@ -790,7 +790,7 @@ permissions and environment (only root is allowed to use this option).</para>
                        <para>If set to true, the task will be run at system startup (i.e. immediately after the &argfirstsleep; delay -- by default, &firstsleep; seconds -- when the &fcron; daemon starts the first time after the OS has booted). This is in addition to the regular schedule which won't be modified by this option.</para>
                         <para>For instance, if a program should be started automatically and run from 7am to 6pm, you could use the following dfcrontab definitions:</para>
                         <programlisting>&amp;runatreboot 0 6 * * 1-5 start_my_program.sh
-& 0 7 * * 1-5 stop_my_program.sh</programlisting>
+&amp; 0 7 * * 1-5 stop_my_program.sh</programlisting>
                        <para>&seealso; options &optvolatile;, &optrunonce;, &optrebootreset;.</para>
                    </listitem>
                </varlistentry>
@@ -881,7 +881,7 @@ not run) or be let there until the system load average allows its execution
                     <para>WARNING: this option is deprecated: use option timezone instead!</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
+to define its &amp; 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. tzdiff is quite stupid: it doesn't handle daylight saving changes, while option timezone does, so you should use the latter.</para>
                        <para>&seealso; options &opttimezone;.</para>
                    </listitem>
@@ -992,10 +992,10 @@ TEXT= " Hello\
 5 9 * * sat,sun echo "Good morning Thibault!" 
 
 # run every even days of march at 18:00, except on 16th 
-0 18 2-30/2~16 Mar * echo "It's time to go back home!" 
+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!" 
+&amp; 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) 
@@ -1003,7 +1003,7 @@ TEXT= " Hello\
 # 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,\
+&amp; 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" 
@@ -1033,7 +1033,7 @@ TEXT= " Hello\
                <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
+(editor, shell, etc). See <link linkend="fcron.conf.5">&fcron.conf;(5)</link> for
 more details.</para>
                </listitem>
            </varlistentry>