2 .\" Copyright (c) 2000 Brian Somers <brian@Awfulhak.org>
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" $FreeBSD: src/share/man/man5/periodic.conf.5,v 1.8.2.22 2003/02/08 21:42:01 gshapiro Exp $
33 .Nd periodic job configuration information
37 contains a description of how daily, weekly and montly system maintenance
41 directory and parts may be overridden by a file of the same name in
43 which itself may be overridden by the
44 .Pa /etc/periodic.conf.local
48 is actually sourced as a shell script from each of the periodic scripts
49 and is intended to simply provide default configuration variables.
51 The following variables are used by
54 .Bl -tag -offset 4n -width 2n
57 List of directories to search for periodic scripts.
58 This list is always prefixed with
60 and is only used when an argument to
62 is not an absolute directory name.
63 .It Va dir Ns No _output
64 .Pq Vt path No or Vt list
65 What to do with the output of the scripts envoked from
68 If this variable is set to an absolute path name, output is logged to
69 that file, otherwise it is taken as one or more space separated email
70 addresses and mailed to those users.
71 If this variable is not set or is empty, output is sent to standard output.
73 For an unattended machine, suitable values for
79 .Dq /var/log/daily.log ,
80 .Dq /var/log/weekly.log ,
82 .Dq /var/log/monthly.log
85 will rotate these files (if they exists) at the appropriate times.
86 .It Va dir Ns No _show_success
87 .It Va dir Ns No _show_info
88 .It Va dir Ns No _show_badconfig
90 These variables control whether
92 will mask the output of the envoked scripts based on their return code
95 is the base directory name in which each script resides).
96 If the return code of a script is
99 .Va dir Ns No _show_success
103 will mask the script's output.
104 If the return code of a script is
107 .Va dir Ns No _show_info
111 will mask the script's output.
112 If the return code of a script is
115 .Va dir Ns No _show_badconfig
119 will mask the script's output.
120 If these variables are set to neither
133 man page for how script return codes are interpreted.
136 The following variables are used by the standard scripts that reside in
137 .Pa /etc/periodic/daily :
138 .Bl -tag -offset 4n -width 2n
139 .It Va daily_clean_disks_enable
143 if you want to remove all files matching
144 .Va daily_clean_disks_files
146 .It Va daily_clean_disks_files
148 Set to a list of file names to match.
149 Wild cards are permitted.
150 .It Va daily_clean_disks_days
153 .Va daily_clean_disks_enable
156 this must also be set to the number of days old that a file's access
157 and modification times must be before it's deleted.
158 .It Va daily_clean_disks_verbose
162 if you want the removed files to be reported in your daily output.
163 .It Va daily_clean_tmps_enable
167 if you want to clear temporary directories daily.
168 .It Va daily_clean_tmps_dirs
170 Set to the list of directories to clear if
171 .Va daily_clean_tmps_enable
174 .It Va daily_clean_tmps_days
177 .Va daily_clean_tmps_enable
178 is set, this must also be set to the number of days old that a file's access
179 and modification times must be before it's deleted.
180 .It Va daily_clean_tmps_ignore
182 Set to the list of files that should not be deleted when
183 .Va daily_clean_tmps_enable
186 Wild card characters are permitted.
187 .It Va daily_clean_tmps_verbose
191 if you want the removed files to be reported in your daily output.
192 .It Va daily_clean_preserve_enable
196 if you wish to remove old files from
198 .It Va daily_clean_preserve_days
200 Set to the number of days that files must not have been modified before
202 .It Va daily_clean_preserve_verbose
206 if you want the removed files to be reported in your daily output.
207 .It Va daily_clean_msgs_enable
211 if you wish old system messages to be purged.
212 .It Va daily_clean_msgs_days
214 Set to the number of days that files must not have been modified before
216 If this variable is left blank, the
219 .It Va daily_clean_rwho_enable
223 if you wish old files in
226 .It Va daily_clean_rwho_days
228 Set to the number of days that files must not have been modified before
230 .It Va daily_clean_rwho_verbose
234 if you want the removed files to be reported in your daily output.
235 .It Va daily_clean_hoststat_enable
239 if you wish old files in
240 .Pa /var/spool/.hoststat
242 .It Va daily_clean_hoststat_days
244 Set to the number of days that files must not have been modified before
246 .It Va daily_clean_hoststat_verbose
250 if you want the removed files to be reported in your daily output.
251 .It Va daily_backup_passwd_enable
256 .Pa /etc/master.passwd
259 files backed up and reported on.
260 Reporting consists of checking both files for modifications and running
265 .It Va daily_backup_aliases_enable
270 .Pa /etc/mail/aliases
271 file backed up and modifications to be displayed in your daily output.
272 .It Va daily_backup_distfile_enable
278 file backed up and modifications to be displayed in your daily output.
279 .It Va daily_calendar_enable
286 .It Va daily_accounting_enable
290 if you want to rotate your daily accounting files.
291 No rotations are necessary unless
292 .Va accounting_enable
295 .It Va daily_accounting_compress
299 if you want your daily accounting files to be compressed using
301 .It Va daily_accounting_save
304 .Va daily_accounting_enable
305 is set, this may also be set to the number of daily accounting files that are
309 .It Va daily_accounting_flags
311 Set to the arguments to pass to the
313 utility (in addition to
316 .Va daily_accounting_enable
321 .It Va daily_distfile_enable
330 file must also exist.
331 .It Va daily_news_expire_enable
336 .Pa /etc/news.expire .
337 .It Pa daily_uuclean_enable
342 .Pa /etc/uuclean.daily .
343 .It Va daily_status_disks_enable
349 (with the arguments supplied in
350 .Va daily_status_disks_df_flags )
353 .It Va daily_status_disks_df_flags
355 Set to the arguments for the
358 .Va daily_status_disks_enable
361 .It Va daily_status_uucp_enable
367 .It Va daily_status_network_enable
373 .It Va daily_status_network_usedns
381 option (to do DNS lookups).
382 .It Va daily_status_rwho_enable
396 .It Va daily_status_mailq_enable
402 .It Va daily_status_mailq_shorten
406 if you want to shorten the
409 .Va daily_status_mailq_enable
412 .It Va daily_status_include_submit_mailq
416 if you also want to run
418 on the submit mail queue when
419 .Va daily_status_mailq_enable
422 This may not work with MTAs other than
424 .It Va daily_status_security_enable
428 if you want to run the security check.
429 The security check is another set of
432 The system defaults are in
433 .Pa /etc/periodic/security .
434 Local scripts should be placed in
435 .Pa /usr/local/etc/periodic/security .
438 manual page for more information.
439 .It Va daily_status_security_inline
443 if you want the security check output inline.
444 The default is to either mail or log the output according to the value of
445 .Va daily_status_security_output .
446 .It Va daily_status_security_output
448 Where to send the output of the security check if
449 .Va daily_status_security_inline
452 This variable behaves in the same way as the
454 variables above, namely it can be set either to one or more email addresses
455 or to an absolute file name.
456 .It Va daily_status_security_chksetuid_enable
460 to compare the modes and modification times of setuid executables with
461 the previous day's values.
462 .It Va daily_status_security_chkmounts_enable
466 to check for changes mounted filesystems to the previous day's values.
467 .It Va daily_status_security_noamd
471 if you want to ignore
473 mounts when comparing against yesterdays filesystem mounts in the
474 .Va daily_status_security_chkmounts_enable
476 .It Va daily_status_security_nomfs
480 if you want to ignore
482 mounts when comparing against yesterdays filesystem mounts in the
483 .Va daily_status_security_chkmounts_enable
485 .It Va daily_status_security_chkuid0_enable
490 .Pa /etc/master.passwd
491 for accounts with uid 0.
492 .It Va daily_status_security_passwdless_enable
497 .Pa /etc/master.passwd
498 for accounts with empty passwords.
499 .It Va daily_status_security_ipfwdenied_enable
503 to show log entries for packets denied by
505 since yesterday's check.
506 .It Va daily_status_security_ipfdenied_enable
510 to show log entries for packets denied by
512 since yesterday's check.
513 .It Va daily_status_security_ipfwlimit_enable
519 rules that have reached their verbosity limit.
520 .It Va daily_status_security_ip6fwdenied_enable
524 to show log entries for packets denied by
526 since yesterday's check.
527 .It Va daily_status_security_ip6fwlimit_enable
533 rules that have reached their verbosity limit.
534 .It Va daily_status_security_kernelmsg_enable
540 entries since yesterday's check.
541 .It Va daily_status_security_loginfail_enable
545 to display failed logins from
546 .Pa /var/log/messages
548 .It Va daily_status_security_tcpwrap_enable
552 to display connections denied by tcpwrappers (see
555 .Pa /var/log/messages
556 during the previous day.
557 .It Va daily_status_mail_rejects_enable
561 if you want to summarise mail rejections logged to
563 for the previous day.
564 .It Va daily_status_mail_rejects_logs
566 Set to the number of maillog files that should be checked
567 for yesterday's mail rejects.
568 .It Va daily_status_named_enable
572 if you want to summarise denied zone transfers (AXFR and IXFR)
573 for the previious day.
574 .It Va daily_status_named_usedns
578 if you want to enable reverse DNS lookups.
579 .It Va daily_queuerun_enable
583 if you want to manually run the mail queue at least once a day.
584 .It Va daily_submit_queuerun
588 if you also want to manually run the submit mail queue at least once a day
590 .Va daily_queuerun_enable
595 Set to a list of extra scripts that should be run after all other
597 All scripts must be absolute path names.
600 The following variables are used by the standard scripts that reside in
601 .Pa /etc/periodic/weekly :
602 .Bl -tag -offset 4n -width 2n
603 .It Va weekly_clean_kvmdb_enable
607 if you want to purge old
610 The kvm file for the current kernel will not be purged.
611 .It Va weekly_clean_kvmdb_days
613 Set to the number of days that the file must not have been accessed
614 before being deleted.
615 .It Va weekly_clean_kvmdb_verbose
619 if you want the removed files to be reported in your weekly output.
620 .It Va weekly_uucp_enable
625 .Pa /usr/libexec/uucp/clean.weekly .
626 .It Va weekly_locate_enable
631 .Pa /usr/libexec/locate.updatedb .
632 This script is run using
636 and generates the table used by the
639 .It Va weekly_whatis_enable
644 .Pa /usr/libexec/makewhatis.local .
645 This script regenerates the database used by the
648 .It Va weekly_catman_enable
653 .Pa /usr/libexec/catman.local .
654 This script processes all out of date man pages, speeding up the
656 command at the expense of disk space.
657 .It Va weekly_noid_enable
661 if you want to locate orphaned files on the system.
662 An orphaned file is one with an invalid owner or group.
663 .It Va weekly_noid_dirs
665 A list of directories under which orphaned files are searched for.
666 This would usually be set to
668 .It Va weekly_status_pkg_enable
674 to list installed packages which are out of date.
677 Set to a list of extra scripts that should be run after all other
679 All scripts must be absolute path names.
682 The following variables are used by the standard scripts that reside in
683 .Pa /etc/periodic/monthly :
684 .Bl -tag -offset 4n -width 2n
685 .It Va monthly_accounting_enable
689 if you want to do login accounting using the
694 Set to a list of extra scripts that should be run after all other
696 All scripts must be absolute path names.
699 .Bl -tag -width /etc/defaults/periodic.conf
700 .It Pa /etc/defaults/periodic.conf
701 The default configuration file.
702 This file contains all default variables and values.
703 .It Pa /etc/periodic.conf
704 The usual system specific variable override file.
705 .It Pa /etc/periodic.conf.local
706 An additional override file, useful when
707 .Pa /etc/periodic.conf
708 is shared or distributed.
736 .An Brian Somers Aq brian@Awfulhak.org .