source: general/sysutils/at.xml

trunk
Last change on this file was 1638aa7, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

Typos
  • Property mode set to 100644
File size: 8.8 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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 at-download-http "&sources-anduin-http;/at/at_&at-version;.orig.tar.gz">
8 <!ENTITY at-download-ftp " ">
9 <!ENTITY at-md5sum "ca3657a1c90d7c3d252e0bc17feddc6e">
10 <!ENTITY at-size "130 KB">
11 <!ENTITY at-buildsize "1.9 MB (including tests)">
12 <!ENTITY at-time "less than 0.1 SBU">
13]>
14
15<sect1 id="at" xreflabel="At-&at-version;">
16 <?dbhtml filename="at.html"?>
17
18
19 <title>at-&at-version;</title>
20
21 <indexterm zone="at">
22 <primary sortas="a-at">at</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to at</title>
27
28 <para>
29 The <application>at</application> package provides delayed job execution
30 and batch processing. It is required for Linux Standards Base (LSB)
31 conformance.
32 </para>
33
34 &lfs121_checked;
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing="compact">
38 <listitem>
39 <para>
40 Download (HTTP): <ulink url="&at-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download (FTP): <ulink url="&at-download-ftp;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download MD5 sum: &at-md5sum;
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download size: &at-size;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Estimated disk space required: &at-buildsize;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated build time: &at-time;
66 </para>
67 </listitem>
68 </itemizedlist>
69
70 <bridgehead renderas="sect3">at Dependencies</bridgehead>
71
72 <bridgehead renderas="sect4">Required</bridgehead>
73 <para role="required">
74 An <xref linkend="server-mail"/>
75 </para>
76
77 <bridgehead renderas="sect4">Optional</bridgehead>
78 <para role="optional">
79 <xref linkend="linux-pam"/>
80 </para>
81
82 </sect2>
83
84 <sect2 role="installation">
85 <title>Installation of at</title>
86
87 <para>
88 Before building <application>at</application>, as the
89 <systemitem class="username">root</systemitem> user you should create
90 the group and user <systemitem class="username">atd</systemitem> which
91 will run the <command>atd</command> daemon:
92 </para>
93
94<screen role="root"><userinput>groupadd -g 17 atd &amp;&amp;
95useradd -d /dev/null -c "atd daemon" -g atd -s /bin/false -u 17 atd</userinput></screen>
96
97 <para>
98 Install <application>at</application> with the following
99 commands:
100 </para>
101
102 <screen revision="sysv"><userinput>./configure --with-daemon_username=atd \
103 --with-daemon_groupname=atd \
104 --with-jobdir=/var/spool/atjobs \
105 --with-atspool=/var/spool/atspool \
106 SENDMAIL=/usr/sbin/sendmail &amp;&amp;
107make -j1</userinput></screen>
108
109 <screen revision="systemd"><userinput>./configure --with-daemon_username=atd \
110 --with-daemon_groupname=atd \
111 SENDMAIL=/usr/sbin/sendmail \
112 --with-jobdir=/var/spool/atjobs \
113 --with-atspool=/var/spool/atspool \
114 --with-systemdsystemunitdir=/lib/systemd/system &amp;&amp;
115make -j1</userinput></screen>
116
117 <para>
118 To test the results, issue: <command>make test</command>.
119 </para>
120
121
122 <para>
123 Now, as the <systemitem class="username">root</systemitem> user:
124 </para>
125
126<screen role="root"><userinput>make install docdir=/usr/share/doc/at-&at-version; \
127 atdocdir=/usr/share/doc/at-&at-version;</userinput></screen>
128
129 </sect2>
130
131 <sect2 role="configuration">
132 <title>Configuring at</title>
133
134 <sect3 id="at-config">
135 <title>Config Files</title>
136
137 <para>
138 <filename>/etc/at.allow</filename> and
139 <filename>/etc/at.deny</filename> determines who can submit jobs via at
140 or batch.
141 </para>
142
143 <indexterm zone="at at-config">
144 <primary sortas="e-etc-at.allow">/etc/at.allow</primary>
145 </indexterm>
146
147 <indexterm zone="at at-config">
148 <primary sortas="e-etc-at.deny">/etc/at.deny</primary>
149 </indexterm>
150
151 </sect3>
152
153 <sect3>
154 <title>Linux PAM Configuration</title>
155
156 <para>
157 If <application>At</application> has been built with
158 <application>Linux PAM</application> support, you need to create a
159 <application>PAM</application> configuration file, to get it working
160 correctly with BLFS.
161 </para>
162
163 <para>
164 Issue the following commands as the <systemitem
165 class="username">root</systemitem> user to create the configuration
166 file for <application>Linux PAM</application>:
167 </para>
168
169<screen role="root"><userinput>cat &gt; /etc/pam.d/atd &lt;&lt; "EOF"
170<literal># Begin /etc/pam.d/atd
171
172auth required pam_unix.so
173account required pam_unix.so
174password required pam_unix.so
175session required pam_unix.so
176
177# End /etc/pam.d/atd</literal>
178EOF</userinput></screen>
179
180 </sect3>
181
182 <sect3 id="at-init">
183 <title><phrase revision="sysv">Boot Script</phrase>
184 <phrase revision="systemd">Systemd Unit</phrase></title>
185
186 <para revision="sysv">
187 Install the <filename>/etc/init.d/atd</filename>
188 init script from the <xref linkend="bootscripts"/> package.
189 </para>
190
191 <para revision="systemd">
192 To start the <command>atd</command> daemon at boot,
193 enable the previously installed systemd unit by
194 running the following command as the
195 <systemitem class="username">root</systemitem> user:
196 </para>
197
198 <indexterm zone="at at-init">
199 <primary sortas="f-at">at</primary>
200 </indexterm>
201
202<screen role="root" revision="sysv"><userinput>make install-atd</userinput></screen>
203
204<screen role="root" revision="systemd"><userinput>systemctl enable atd</userinput></screen>
205
206 </sect3>
207
208 </sect2>
209
210 <sect2 role="content">
211 <title>Contents</title>
212
213 <segmentedlist>
214 <segtitle>Installed Programs</segtitle>
215 <segtitle>Installed Libraries</segtitle>
216 <segtitle>Installed Directories</segtitle>
217
218 <seglistitem>
219 <seg>
220 at, atd, atq (symlink), atrm (symlink), atrun, and batch
221 </seg>
222 <seg>
223 None
224 </seg>
225 <seg>
226 /usr/share/doc/at-&at-version;
227 </seg>
228 </seglistitem>
229 </segmentedlist>
230
231 <variablelist>
232 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
233 <?dbfo list-presentation="list"?>
234 <?dbhtml list-presentation="table"?>
235
236 <varlistentry id="at-prog">
237 <term><command>at</command></term>
238 <listitem>
239 <para>
240 queues, examines or deletes jobs for later execution
241 </para>
242 <indexterm zone="at at-prog">
243 <primary sortas="b-at">at</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="atd">
249 <term><command>atd</command></term>
250 <listitem>
251 <para>
252 is the daemon that runs jobs queued for later execution
253 </para>
254 <indexterm zone="at atd">
255 <primary sortas="b-atd">atd</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="atq">
261 <term><command>atq</command></term>
262 <listitem>
263 <para>
264 lists the user's pending jobs, or all jobs, if superuser
265 </para>
266 <indexterm zone="at atq">
267 <primary sortas="b-atq">atq</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
272 <varlistentry id="atrm">
273 <term><command>atrm</command></term>
274 <listitem>
275 <para>
276 deletes jobs, identified by their job number
277 </para>
278 <indexterm zone="at atrm">
279 <primary sortas="b-atrm">atrm</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="atrun">
285 <term><command>atrun</command></term>
286 <listitem>
287 <para>
288 runs jobs queued for later execution
289 </para>
290 <indexterm zone="at atrun">
291 <primary sortas="b-atrun">atrun</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="batch">
297 <term><command>batch</command></term>
298 <listitem>
299 <para>
300 is a script that executes commands when system load levels permit
301 </para>
302 <indexterm zone="at batch">
303 <primary sortas="b-batch">batch</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 </variablelist>
309
310 </sect2>
311
312</sect1>
Note: See TracBrowser for help on using the repository browser.