]> granicus.if.org Git - fcron/commitdiff
removed spaces before punctuation
authorthib <thib>
Wed, 11 Jan 2006 01:01:18 +0000 (01:01 +0000)
committerthib <thib>
Wed, 11 Jan 2006 01:01:18 +0000 (01:01 +0000)
doc/en/faq.sgml
doc/en/install.sgml

index 5a37e8ed8ee6d02d45714fbac5d04d0adc18c21c..2d96569a8d82dceb101d2dbb020591015114b20a 100644 (file)
@@ -1,6 +1,6 @@
 <!-- 
 Fcron documentation
-Copyright 2000-2004 Thibault Godouet <fcron@free.fr>
+Copyright 2000-2006 Thibault Godouet <fcron@free.fr>
 Permission is granted to copy, distribute and/or modify this
 document under the terms of the GNU Free Documentation License,
 Version 1.1 or any later version published by the Free Software
@@ -8,17 +8,17 @@ Foundation.
 A copy of the license is included in gfdl.sgml.
 -->
 
-<!-- $Id: faq.sgml,v 1.13 2005-07-28 11:07:48 thib Exp $ -->
+<!-- $Id: faq.sgml,v 1.14 2006-01-11 01:01:18 thib Exp $ -->
 
 <sect1 id="faq">
     <title>Frequently Asked Questions</title>
     <para>This FAQ intends to complement the man pages by following a more
 practical approach.</para>
-    <para>If you think a QA should be added, please mail me it !</para>
+    <para>If you think a QA should be added, please mail me it!</para>
     <qandaset>
        <qandaentry>
            <question>
-               <para>How does fcron handle system clock adjustments ?</para>
+               <para>How does fcron handle system clock adjustments?</para>
            </question>
            <answer>
                <para>
@@ -62,24 +62,24 @@ a big change in the time and date, you should probably reset all the scheduled
        </qandaentry>
         <qandaentry>
            <question>
-              <para>How does fcron handle daylight saving time changes ?</para>
+              <para>How does fcron handle daylight saving time changes?</para>
            </question>
            <answer>
-              <para>There are two types of daylight saving time change 
+              <para>There are two types of daylight saving time change: 
 the remove-one-hour change (for instance, "at 3:00, it will be 2:00"), 
 and the add-one-hour one (for instance, "at 2:00, it will be 3:00").
 In both cases, fcron will run the job only once (more precisely, it won't
 run the job twice as many as it should have).</para>
               <para>In the first case, the official time changes as follow
-(in order of real chronological time) : [x, 2:00] -> i1 : [2:00, 3:00]
- -> i2 : [2:00, 3:00] -> [3:00, y]. i1 and i2 are the names of the two
+(in order of real chronological time): [x, 2:00] -> i1: [2:00, 3:00]
+ -> i2: [2:00, 3:00] -> [3:00, y]. i1 and i2 are the names of the two
 intervals [2:00, 3:00]. For this kind of DST change, a job which should
 run between 2:00 and 3:00 will run either in i1 or in i2, but not both.
 Consequently, a job scheduled to run every day at 2:30 (for instance)
 will be run only once. There is no way for a user to know if the job will
 be run in i1 or i2.</para>
-              <para>In the second case, there is a gap in time :
-the official time changes as follow (in order of real chronological time) :
+              <para>In the second case, there is a gap in time:
+the official time changes as follow (in order of real chronological time):
 [x, 2:00] -> [3:00, y]. A job scheduled between 2:00 and 3:00 will get
 run once, and only once, even if it should have been run several times.
 For instance, a job which should have run every 10 minutes will run only
@@ -92,7 +92,7 @@ every day at 2:30, it will run at 3:30 the day of this kind of DST change.
         <qandaentry>
            <question>
               <para>What about fcron and software suspend 
-                 (aka. suspend to RAM, to disk) ?</para>
+                 (aka. suspend to RAM, to disk)?</para>
            </question>
            <answer>
               <para>We suppose here that you are using swsusp and the hibernate
@@ -101,7 +101,7 @@ every day at 2:30, it will run at 3:30 the day of this kind of DST change.
               <para>When you switch on your computer after a suspend to disk,
                  the system time will be incorrect, and will then be corrected
                  by the hibernate script. Before it is corrected, fcron may
-                 compute the time and date of the next execution of a job :
+                 compute the time and date of the next execution of a job:
                  the computation would then be incorrect (please see the entry
                  about system clock adjustment in the present FAQ).</para>
               <para>So you should have the hibernate script stop fcron before
@@ -115,15 +115,15 @@ every day at 2:30, it will run at 3:30 the day of this kind of DST change.
        <qandaentry>
            <question>
                <para>How can I prevent fcrontab from considering the first
-"word" of my command line as a user name i.e. "runas(word)" ?</para>
+"word" of my command line as a user name i.e. "runas(word)"?</para>
            </question>
            <answer>
                <para>
       Suppose you have an user called "echo" (weird idea ... :)) ). If you use
-the line '* * * * * echo "Hello !"' in root's fcrontab, "echo" will be
+the line '* * * * * echo "Hello!"' in root's fcrontab, "echo" will be
 interpreted as "runas(echo)".</para>
-               <para>To suppress that, put your command in quotes :
-<programlisting>* * * * * 'echo "Hello !"'</programlisting> will work as
+               <para>To suppress that, put your command in quotes:
+<programlisting>* * * * * 'echo "Hello!"'</programlisting> will work as
 expected as quotes are allowed for the shell command but not for the user
 name.</para>
            </answer>
@@ -176,13 +176,13 @@ where: d is the time interval between active task count readings, typically ever
 
        <qandaentry>
            <question>
-               <para>How can I use fcrontab in scripts ?</para>
+               <para>How can I use fcrontab in scripts?</para>
            </question>
            <answer>
                <para>
       You can use pipes with "<command>fcrontab -l</command>" (list the
 fcrontab) and "<command>fcrontab -</command>" (read the new fcrontab from
-input). For example : </para>
+input). For example: </para>
                <screen> <command>echo -e "`fcrontab -l | grep -v exim`\n0 * * * *      /usr/sbin/exim -q" | fcrontab -</command></screen>
                <para>
                  can be used to add a line. Another way to do it would be to:
@@ -198,23 +198,23 @@ tmpfile</command>").
        <qandaentry>
            <question>
                <para>Can I use fcron from time to time, for instance in a
-script ?</para>
+script?</para>
            </question>
            <answer>
                <para>Let's suppose you use fcron in your ppp-up script. Fcron
 can permit you to run some jobs at connection startup, but not at each
-connection, like it would be if the job was run directly by the ppp-up script :
+connection, like it would be if the job was run directly by the ppp-up script:
 for instance, only once every week.</para>
                <para><example>
-                       <title>Using fcron in a script : running a job once
+                       <title>Using fcron in a script: running a job once
 every day, week, etc, at dialup connection</title>
-                       <para>You can use a script like :</para>
+                       <para>You can use a script like:</para>
                        <programlisting>
 # A ppp-up script ... 
-# run the jobs pending, then returns 
+# run the jobs pending, then returns: 
 fcron -f -y -o
 </programlisting>
-                       <para>in conjunction with a fcrontab file like :</para>
+                       <para>in conjunction with a fcrontab file like:</para>
                        <programlisting>
 # a fcrontab file ... 
 %random(no),weekly,stdout * * /a/command/to/download/latest/mozilla/release 
@@ -223,26 +223,26 @@ fcron -f -y -o
                    </example></para>
                <para>You can also use fcron to run some jobs until the end of
 the connection. For instance, you can make fetchmail retrieve mails more often
-during connection : we suppose that it is configured to retrieve mails every
+during connection: we suppose that it is configured to retrieve mails every
 hour, which launches a dialup connection if necessary, and we want it to check
 for mails every 5 minutes while connected.</para>
                <para><example>
-                       <title>Using fcron in a script : running a job until the
+                       <title>Using fcron in a script: running a job until the
 end of the connection</title>
-                       <para>ppp-up script :</para>
+                       <para>ppp-up script:</para>
                        <programlisting>
 # A ppp-up script ... 
-# run fcron at the beginning of the connection 
+# run fcron at the beginning of the connection: 
 fcron -b
 </programlisting>
-                       <para>ppp-down script :</para>
+                       <para>ppp-down script:</para>
                        <programlisting>
 # A ppp-down script ... 
-# stop fcron at the end of the connection 
-# -- Warning : killall may have unwanted effect on non linux systems -- 
+# stop fcron at the end of the connection: 
+# -- Warning: killall may have unwanted effect on non linux systems -- 
 killall -TERM fcron
 </programlisting>
-                       <para>the fcrontab :</para>
+                       <para>the fcrontab:</para>
                        <programlisting>
 # a fcrontab file ... 
 @volatile,first(0) 5 fetchmail
@@ -263,7 +263,7 @@ linkend="fcrontab.5">&fcrontab;(5)</link></para>
        
        <qandaentry>
            <question>
-               <para>Can I run fcron without root's privileges ?</para>
+               <para>Can I run fcron without root's privileges?</para>
            </question>
            <answer>
                <para>Yes, you can. To do that, see the
@@ -272,7 +272,7 @@ without root privileges.</para>
                <orderedlist>
                    <listitem>
                        <para>First, create a directory where you'll install fcron,
- and some subdirectories :</para>
+ and some subdirectories:</para>
                        <screen><prompt>bash$
 </prompt> <command>mkdir /home/thib/fcron</command>
 <prompt>bash$</prompt> <command>cd /home/thib/fcron</command>
@@ -281,7 +281,7 @@ without root privileges.</para>
                    <listitem>
                        <para>Then, run configure with option 
 <option>--with-run-non-privileged</option>, set all user names and groups to yours,
-and set appropriately the paths :</para>
+and set appropriately the paths:</para>
                        <para><warning>
                            <para>This option allows a non privileged user to run
        fcron. When used, fcron does not change its rights before running a job
@@ -304,12 +304,12 @@ and set appropriately the paths :</para>
 
         <qandaentry>
            <question>
-              <para>Has fcron some incompatibilities with Vixie cron ?</para>
+              <para>Has fcron some incompatibilities with Vixie cron?</para>
            </question>
            <answer>
               <para>As far as I know, fcron supports completely the syntax of
                  Vixie cron's crontab, excepted the @* syntax (@annually,
-                 @weekly, etc : if you use that, you will have to replace it
+                 @weekly, etc: if you use that, you will have to replace it
                  with the explicit equivalent given in crontab(5)). So you
                  should not have much problem with that (otherwise, please
                  contact me at &email;).</para>
@@ -319,18 +319,18 @@ and set appropriately the paths :</para>
                  As for now, fcron do not do that. Fcron do not support the
                  /etc/cron.d/ dir too, as it is just an extension of the /etc/crontab
                  file.
-                 But be reassured : /etc/cron.{daily,weekly,monthly} are supported
+                 But be reassured: /etc/cron.{daily,weekly,monthly} are supported
                  by fcron (in fact, those dirs are not managed by fcron directly,
                  but by run-parts, which is independent from fcron).</para>
               <para>So if you want to replace transparently Vixie cron by fcron,
                  all you have to do is creating a /usr/bin/crontab link to
                  /usr/bin/crontab, and to reinstall the system (f)crontab
               with fcrontab /etc/crontab each time you modify it
-                 (if you find something else to do, please tell me !).</para>
+                 (if you find something else to do, please tell me!).</para>
               <para>You can also use the script script/check_system_crontabs
                  to generate a system fcrontab from /etc/(f)crontab and /etc/cron.d/,
                  and install it automatically. If you choose to do that, take 
-                 a look at the beginning of the script : you will find insctructions
+                 a look at the beginning of the script: you will find insctructions
                  on how to use it -- and a few warnings you should pay attention to.
                  With this script, the behavior of fcron should be very similar
                  to Vixie cron's one concerning /etc/crontab and /etc/cron.d/.
@@ -339,10 +339,10 @@ and set appropriately the paths :</para>
         </qandaentry>
         <qandaentry>
            <question>
-              <para>How can I emulate an anacron entry ?</para>
+              <para>How can I emulate an anacron entry?</para>
            </question>
            <answer>
-              <para>You should use a line similar to the following one :</para>
+              <para>You should use a line similar to the following one:</para>
               <para>@volatile,first(xx) BIG-period /your/command</para>
               <para>where xx is the time you would have put in your anacron line.</para>
            </answer>
index a8df6390923252f033e756393da671697f4ae60d..58f524f8fa70e0d23fc7a9224d52c05ea8d9c4da 100644 (file)
@@ -1,6 +1,6 @@
 <!-- 
 Fcron documentation
-Copyright 2000-2004 Thibault Godouet <fcron@free.fr>
+Copyright 2000-2006 Thibault Godouet <fcron@free.fr>
 Permission is granted to copy, distribute and/or modify this
 document under the terms of the GNU Free Documentation License,
 Version 1.1 or any later version published by the Free Software
@@ -8,13 +8,13 @@ Foundation.
 A copy of the license is included in gfdl.sgml.
 -->
 
-<!-- $Id: install.sgml,v 1.8 2003-12-25 22:59:16 thib Exp $ -->
+<!-- $Id: install.sgml,v 1.9 2006-01-11 01:01:38 thib Exp $ -->
 
 <sect1 id="install">
     <title>How to install fcron</title>
     <itemizedlist>
        <listitem>
-           <para>uncompress the archive :</para>
+           <para>uncompress the archive:</para>
            <screen><prompt>bash$ </prompt><command>
 tar -xzf fcron-X.Y.Z.src.tar.gz</command></screen>
        </listitem>
@@ -23,7 +23,7 @@ tar -xzf fcron-X.Y.Z.src.tar.gz</command></screen>
            <screen><prompt>bash$ </prompt><command>cd fcron-X.Y.Z</command></screen>
        </listitem>
        <listitem>
-           <para>run the <command>configure</command> script :</para>
+           <para>run the <command>configure</command> script:</para>
            <screen><prompt>bash$
 </prompt><command>./configure</command></screen>
            <para>
@@ -43,7 +43,7 @@ and/or <option>--with-boot-install</option> (see "<command>./configure</command>
                            <para>
                                You may also want to change the place where
 &fcron; will be installed: you can use the <command>configure </command>'s
-option <option>--prefix</option> to do that. For instance :
+option <option>--prefix</option> to do that. For instance:
 <command>./configure</command> <option>--prefix=/usr/local</option> (default is
 prefix=/usr)
                            </para>
@@ -85,7 +85,7 @@ necessary force a value by the options <option>--mandir</option> and
                            <para>
                                If you get older &fcron;'s man-pages with
 <command>man</command> command after having upgraded, it's probably because
-&fcron; has changed its default man directory : you should remove manually the
+&fcron; has changed its default man directory: you should remove manually the
 outdated man-pages.
                            </para>
                        </listitem>
@@ -108,12 +108,12 @@ is on the top of the file and clearly delimited).</para>
        </listitem>
 
        <listitem>
-           <para>compile :</para>
+           <para>compile:</para>
            <screen><prompt>bash$ </prompt><command>make</command></screen>
        </listitem>
 
        <listitem>
-           <para>then install binaries as root :</para>
+           <para>then install binaries as root:</para>
            <screen><prompt>bash$ </prompt><command>su root</command></screen>
            <screen><prompt>bash# </prompt><command>make install</command></screen>
        </listitem>