source: general/sysutils/fcron.xml@ 6397333

basic
Last change on this file since 6397333 was 6397333, checked in by Bruce Dubbs <bdubbs@…>, 4 years ago

Convert internal like to external links for BLFS packages not in
the Basic book.

Reorder some chapters.

Merge System V and systemd sections so both are always displayed
with proper attribution for system type.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/basic@20524 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 11.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY fcron-download-http "http://fcron.free.fr/archives/fcron-&fcron-version;.src.tar.gz">
8 <!ENTITY fcron-download-ftp " ">
9<!-- <!ENTITY fcron-download-ftp "ftp://ftp.seul.org/pub/fcron/fcron-&fcron-version;.src.tar.gz">-->
10 <!ENTITY fcron-md5sum "bd4996e941a40327d11efc5e3fd1f839">
11 <!ENTITY fcron-size "587 KB">
12 <!ENTITY fcron-buildsize "5.1 MB">
13 <!ENTITY fcron-time "0.1 SBU">
14]>
15
16<sect1 id="fcron" xreflabel="fcron-&fcron-version;">
17 <?dbhtml filename="fcron.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>Fcron-&fcron-version;</title>
25
26 <indexterm zone="fcron">
27 <primary sortas="a-Fcron">Fcron</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to Fcron</title>
32
33 <para>The <application>Fcron</application> package contains a periodical
34 command scheduler which aims at replacing <application>Vixie
35 Cron</application>.</para>
36
37 &lfs83_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>Download (HTTP): <ulink url="&fcron-download-http;"/></para>
43 </listitem>
44 <listitem>
45 <para>Download (FTP): <ulink url="&fcron-download-ftp;"/></para>
46 </listitem>
47 <listitem>
48 <para>Download MD5 sum: &fcron-md5sum;</para>
49 </listitem>
50 <listitem>
51 <para>Download size: &fcron-size;</para>
52 </listitem>
53 <listitem>
54 <para>Estimated disk space required: &fcron-buildsize;</para>
55 </listitem>
56 <listitem>
57 <para>Estimated build time: &fcron-time;</para>
58 </listitem>
59 </itemizedlist>
60
61 <bridgehead renderas="sect3">Fcron Dependencies</bridgehead>
62
63 <bridgehead renderas="sect4">Optional</bridgehead>
64 <para role="optional">
65 A mail server such as <xref linkend="postfix"/>,
66 A text editor
67 (default is <command>vi</command> from the vim package),
68 <ulink url="&blfs-book;/postlfs/linux-pam.html">linux-pam</ulink>, and
69 <ulink url="&blfs-book;/postlfs/pst/docbook-utils.html">docbook-utils</ulink>
70 </para>
71
72 <para condition="html" role="usernotes">User Notes:
73 <ulink url="&blfs-wiki;/fcron"/></para>
74
75 </sect2>
76
77 <sect2 role="installation">
78 <title>Installation of Fcron</title>
79
80 <para id="fcron-syslog"> For System V versions of LFS,
81 <application>fcron</application>
82 uses the cron facility of <command>syslog</command> to log all messages.
83 Since LFS does not set up this facility in
84 <filename>/etc/syslog.conf</filename>, it needs to be done prior to
85 installing <application>fcron</application>. This command will append the
86 necessary line to the current <filename>/etc/syslog.conf</filename>
87 (perform as the <systemitem class='username'>root</systemitem> user):</para>
88
89 <indexterm zone="fcron fcron-syslog">
90 <primary sortas="e-etc-syslog.conf">/etc/syslog.conf</primary>
91 </indexterm>
92
93<screen role="root"><userinput>cat &gt;&gt; /etc/syslog.conf &lt;&lt; "EOF"
94<literal># Begin fcron addition to /etc/syslog.conf
95
96cron.* -/var/log/cron.log
97
98# End fcron addition</literal>
99EOF</userinput></screen>
100
101 <para>The configuration file has been modified, so reloading
102 the <command>sysklogd</command> daemon will activate the changes (again as
103 the <systemitem class='username'>root</systemitem> user).</para>
104
105<screen role="root"><userinput>/etc/rc.d/init.d/sysklogd reload</userinput></screen>
106
107 <para>For security reasons, an unprivileged user and group for
108 <application>fcron</application> should be created (perform as the
109 <systemitem class='username'>root</systemitem> user):</para>
110
111<screen role="root"><userinput>groupadd -g 22 fcron &amp;&amp;
112useradd -d /dev/null -c "Fcron User" -g fcron -s /bin/false -u 22 fcron</userinput></screen>
113
114 <para>Install <application>Fcron</application> by running the following
115 commands:</para>
116
117 <para>For System V based systems:</para>
118
119<screen><userinput>./configure --prefix=/usr \
120 --sysconfdir=/etc \
121 --localstatedir=/var \
122 --without-sendmail \
123 --with-boot-install=no \
124 --with-systemdsystemunitdir=no &amp;&amp;
125make</userinput></screen>
126
127 <para>For systemd based systems:</para>
128
129<screen><userinput>./configure --prefix=/usr \
130 --sysconfdir=/etc \
131 --localstatedir=/var \
132 --without-sendmail \
133 --with-boot-install=no &amp;&amp;
134make</userinput></screen>
135
136 <para>This package does not come with a test suite.</para>
137
138 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
139
140<screen role="root"><userinput>make install</userinput></screen>
141
142 <para>DESTDIR install must be done as <systemitem class="username">root</systemitem> user.</para>
143
144 </sect2>
145
146 <sect2 role="commands">
147 <title>Command Explanations</title>
148
149 <para><parameter>--without-sendmail</parameter>: By default,
150 <application>fcron</application> will attempt to use the
151 <command>sendmail</command> command from a mail server sucj as the
152 <xref linkend="postfix"/>
153 package to email you the results of the <command>fcron</command> script.
154 This switch is used to disable default email notification. Omit the switch
155 to enable the default. Alternatively, you can use the
156 <option>--with-sendmail=<replaceable>&lt;/path/to/MTA
157 command&gt;</replaceable></option> to use a different mailer command.</para>
158
159 <para><parameter>--with-boot-install=no</parameter>: This prevents
160 installation of the bootscript included with the package.</para>
161
162 <para><parameter>--with-systemdsystemunitdir=no</parameter>:
163 This prevents building the <application>systemd</application> units, which
164 are not needed for a <application>SYS V</application> system.</para>
165
166 <para><option>--with-editor=<replaceable>&lt;/path/to/editor&gt;</replaceable></option>:
167 This switch allows you to set the default text editor.</para>
168
169 <para>
170 <option>--with-dsssl-dir=<replaceable>&lt;/path/to/dsssl-stylesheets&gt;</replaceable></option>:
171 May be used if you have
172 <ulink url="&blfs-book;/postlfs/pst/docbook-utils.html">docbook-utils</ulink>
173 installed.
174 Currently, the dsssl stylesheets are located at
175 <filename class="directory">/usr/share/sgml/docbook/dsssl-stylesheets-1.79</filename>.
176 </para>
177
178 </sect2>
179
180 <sect2 role="configuration">
181 <title>Configuring Fcron</title>
182
183 <sect3 id="fcron-config">
184 <title>Config Files</title>
185
186 <para><filename>/etc/fcron.conf</filename>,
187 <filename>/etc/fcron.allow</filename>, and
188 <filename>/etc/fcron.deny</filename></para>
189
190 <indexterm zone="fcron fcron-config">
191 <primary sortas="e-etc-fcron.conf">/etc/fcron.conf</primary>
192 </indexterm>
193
194 <indexterm zone="fcron fcron-config">
195 <primary sortas="e-etc-fcron.allow">/etc/fcron.allow</primary>
196 </indexterm>
197
198 <indexterm zone="fcron fcron-config">
199 <primary sortas="e-etc-fcron.deny">/etc/fcron.deny</primary>
200 </indexterm>
201
202 </sect3>
203
204 <sect3>
205 <title>Configuration Information</title>
206
207 <para>There are no required changes in any of the config files.
208 Configuration information can be found in the man page for
209 <filename>fcron.conf</filename>.</para>
210
211 <para><command>fcron</command> scripts are written using
212 <command>fcrontab</command>. Refer to the <command>fcrontab</command> man
213 page for proper parameters to address your situation.</para>
214
215 <para id="fcron-pam">If <application>Linux-PAM</application>
216 is installed, two PAM configuration files are installed in
217 <filename class='directory'>/etc/pam.d</filename>. Alternatively if
218 <filename class='directory'>/etc/pam.d</filename> is not used, the
219 installation will append two configuration sections to the existing
220 <filename>/etc/pam.conf</filename> file. You should ensure the files match
221 your preferences. Modify them as required to suit your needs.</para>
222
223 <indexterm zone="fcron fcron-pam">
224 <primary sortas="e-etc-pam.d">/etc/pam.d/*</primary>
225 </indexterm>
226
227 <indexterm zone="fcron fcron-pam">
228 <primary sortas="e-etc-pam.conf">/etc/pam.conf</primary>
229 </indexterm>
230
231 </sect3>
232
233 <sect3 id="fcron-init">
234 <title>Boot Script or Systemd Unit</title>
235
236 <para>For System V bases systems, install the
237 <filename>/etc/rc.d/init.d/fcron</filename> init script from the
238 <xref linkend="bootscripts"/> package.</para>
239
240<screen role="root"><userinput>make install-fcron</userinput></screen>
241
242 <para>For systemd based systems, enable <application>fcron</application> to start
243 at boot using the previously installed systemd unit.</para>
244
245 <indexterm zone="fcron fcron-init">
246 <primary sortas="f-fcron">fcron</primary>
247 </indexterm>
248
249<screen role="root"><userinput>systemctl enable fcron</userinput></screen>
250
251 </sect3>
252
253 </sect2>
254
255 <sect2 role="content">
256 <title>Contents</title>
257
258 <segmentedlist>
259 <segtitle>Installed Programs</segtitle>
260 <segtitle>Installed Libraries</segtitle>
261 <segtitle>Installed Directories</segtitle>
262
263 <seglistitem>
264 <seg>fcron, fcrondyn, fcronsighup, and fcrontab</seg>
265 <seg>None</seg>
266 <seg>/usr/share/doc/fcron-&fcron-version; and /var/spool/fcron</seg>
267 </seglistitem>
268 </segmentedlist>
269
270 <variablelist>
271 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
272 <?dbfo list-presentation="list"?>
273 <?dbhtml list-presentation="table"?>
274
275 <varlistentry id="fcron-prog">
276 <term><command>fcron</command></term>
277 <listitem>
278 <para>is the scheduling daemon.</para>
279 <indexterm zone="fcron fcron-prog">
280 <primary sortas="b-fcron">fcron</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry id="fcrondyn">
286 <term><command>fcrondyn</command></term>
287 <listitem>
288 <para>is a user tool intended to interact with a running
289 <command>fcron</command> daemon.</para>
290 <indexterm zone="fcron fcrondyn">
291 <primary sortas="b-fcrondyn">fcrondyn</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="fcronsighup">
297 <term><command>fcronsighup</command></term>
298 <listitem>
299 <para>instructs <command>fcron</command> to reread the
300 <application>Fcron</application> tables.</para>
301 <indexterm zone="fcron fcronsighup">
302 <primary sortas="b-fcronsighup">fcronsighup</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="fcrontab">
308 <term><command>fcrontab</command></term>
309 <listitem>
310 <para>is a program used to install, edit, list and remove the
311 tables used by <command>fcron</command>.</para>
312 <indexterm zone="fcron fcrontab">
313 <primary sortas="b-fcrontab">fcrontab</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 </variablelist>
319
320 </sect2>
321
322</sect1>
Note: See TracBrowser for help on using the repository browser.