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 monthly 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 .Pa /var/log/daily.log ,
80 .Pa /var/log/weekly.log ,
82 .Pa /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
241 to automatically purge stale entries from
244 Files will be deleted using the same criteria as
246 would normally use when determining whether to believe the cached information,
248 .Pa /etc/mail/sendmail.cf .
249 .It Va daily_clean_hammer_enable
255 file systems to be snapshot, pruned and reblocked.
256 .It Va daily_clean_hammer_verbose
260 if you wish more verbose output.
261 .It Va daily_backup_passwd_enable
266 .Pa /etc/master.passwd
269 files backed up and reported on.
270 Reporting consists of checking both files for modifications and running
275 .It Va daily_backup_aliases_enable
280 .Pa /etc/mail/aliases
281 file backed up and modifications to be displayed in your daily output.
282 .It Va daily_backup_distfile_enable
288 file backed up and modifications to be displayed in your daily output.
289 .It Va daily_calendar_enable
296 .It Va daily_accounting_enable
300 if you want to rotate your daily accounting files.
301 No rotations are necessary unless
302 .Va accounting_enable
305 .It Va daily_accounting_compress
309 if you want your daily accounting files to be compressed using
311 .It Va daily_accounting_save
314 .Va daily_accounting_enable
315 is set, this may also be set to the number of daily accounting files that are
319 .It Va daily_accounting_flags
321 Set to the arguments to pass to the
323 utility (in addition to
326 .Va daily_accounting_enable
331 .It Va daily_distfile_enable
340 file must also exist.
341 .It Va daily_news_expire_enable
346 .Pa /etc/news.expire .
347 .It Va daily_status_disks_enable
353 (with the arguments supplied in
354 .Va daily_status_disks_df_flags )
357 .It Va daily_status_disks_df_flags
359 Set to the arguments for the
362 .Va daily_status_disks_enable
365 .It Va daily_status_network_enable
371 .It Va daily_status_network_usedns
379 option (to do DNS lookups).
380 .It Va daily_status_rwho_enable
394 .It Va daily_status_mailq_enable
400 .It Va daily_status_mailq_shorten
404 if you want to shorten the
407 .Va daily_status_mailq_enable
410 .It Va daily_status_include_submit_mailq
414 if you also want to run
416 on the submit mail queue when
417 .Va daily_status_mailq_enable
420 This may not work with MTAs other than
422 .It Va daily_status_security_enable
426 if you want to run the security check.
427 The security check is another set of
430 The system defaults are in
431 .Pa /etc/periodic/security .
432 Local scripts should be placed in
433 .Pa /usr/local/etc/periodic/security .
436 manual page for more information.
437 .It Va daily_status_security_inline
441 if you want the security check output inline.
442 The default is to either mail or log the output according to the value of
443 .Va daily_status_security_output .
444 .It Va daily_status_security_logdir
446 The directory where the security scripts expect the system's log files.
447 .It Va daily_status_security_output
449 Where to send the output of the security check if
450 .Va daily_status_security_inline
453 This variable behaves in the same way as the
455 variables above, namely it can be set either to one or more email addresses
456 or to an absolute file name.
457 .It Va daily_status_security_diff_flags
459 Set to the arguments to pass to the
461 utility when generating differences.
464 .It Va daily_status_security_chksetuid_enable
468 to compare the modes and modification times of setuid executables with
469 the previous day's values.
470 .It Va daily_status_security_chkmounts_enable
474 to check for changes in mounted filesystems to the previous day's values.
475 .It Va daily_status_security_chkmounts_ignore
476 Set to the list of filesystem types that should not be checked when
477 .Va daily_status_security_chkmounts_enable
480 .It Va daily_status_security_noamd
484 if you want to ignore
486 mounts when comparing against yesterdays filesystem mounts in the
487 .Va daily_status_security_chkmounts_enable
489 .It Va daily_status_security_nomfs
493 if you want to ignore
495 mounts when comparing against yesterdays filesystem mounts in the
496 .Va daily_status_security_chkmounts_enable
498 .It Va daily_status_security_chkuid0_enable
503 .Pa /etc/master.passwd
504 for accounts with uid 0.
505 .It Va daily_status_security_passwdless_enable
510 .Pa /etc/master.passwd
511 for accounts with empty passwords.
512 .It Va daily_status_security_logincheck_enable
520 for more information.
521 .It Va daily_status_security_ipfwdenied_enable
525 to show log entries for packets denied by
527 since yesterday's check.
528 .It Va daily_status_security_ipfdenied_enable
532 to show log entries for packets denied by
534 since yesterday's check.
535 .It Va daily_status_security_pfdenied_enable
539 to show log entries for packets denied by
541 since yesterday's check.
542 .It Va daily_status_security_ipfwlimit_enable
548 rules that have reached their verbosity limit.
549 .It Va daily_status_security_ip6fwdenied_enable
553 to show log entries for packets denied by
555 since yesterday's check.
556 .It Va daily_status_security_ip6fwlimit_enable
562 rules that have reached their verbosity limit.
563 .It Va daily_status_pkgsrc_audit_enable
567 to check the currently installed packages against a database of known
568 vulnerabilities and report those that are vulnerable.
569 .It Va daily_status_pkgsrc_check_signatures
573 to check the digital signature of all files installed by packages against
574 the expected values stored in the packages database.
575 .It Va daily_status_pkgsrc_fetch_vulnerabilities
579 to refresh the local database of package vulnerabilities.
580 .It Va daily_status_security_kernelmsg_enable
586 entries since yesterday's check.
587 .It Va daily_status_security_loginfail_enable
591 to display failed logins from
592 .Pa /var/log/messages
594 .It Va daily_status_security_tcpwrap_enable
598 to display connections denied by tcpwrappers (see
601 .Pa /var/log/messages
602 during the previous day.
603 .It Va daily_status_mail_rejects_enable
607 if you want to summarise mail rejections logged to
609 for the previous day.
610 .It Va daily_status_mail_rejects_logs
612 Set to the number of maillog files that should be checked
613 for yesterday's mail rejects.
614 .It Va daily_status_named_enable
618 if you want to summarise denied zone transfers (AXFR and IXFR)
619 for the previous day.
620 .It Va daily_status_named_usedns
624 if you want to enable reverse DNS lookups.
625 .It Va daily_queuerun_enable
629 if you want to manually run the mail queue at least once a day.
630 .It Va daily_submit_queuerun
634 if you also want to manually run the submit mail queue at least once a day
636 .Va daily_queuerun_enable
641 Set to a list of extra scripts that should be run after all other
643 All scripts must be absolute path names.
646 The following variables are used by the standard scripts that reside in
647 .Pa /etc/periodic/weekly :
648 .Bl -tag -offset 4n -width 2n
649 .It Va weekly_clean_kvmdb_enable
653 if you want to purge old
656 The kvm file for the current kernel will not be purged.
657 .It Va weekly_clean_kvmdb_days
659 Set to the number of days that the file must not have been accessed
660 before being deleted.
661 .It Va weekly_clean_kvmdb_verbose
665 if you want the removed files to be reported in your weekly output.
666 .It Va weekly_locate_enable
671 .Pa /usr/libexec/locate.updatedb .
672 This script is run using
676 and generates the table used by the
679 .It Va weekly_whatis_enable
684 .Pa /usr/libexec/makewhatis.local .
685 This script regenerates the database used by the
688 .It Va weekly_catman_enable
693 .Pa /usr/libexec/catman.local .
694 This script processes all out of date man pages, speeding up the
696 command at the expense of disk space.
697 .It Va weekly_noid_enable
701 if you want to locate orphaned files on the system.
702 An orphaned file is one with an invalid owner or group.
703 .It Va weekly_noid_dirs
705 A list of directories under which orphaned files are searched for.
706 This would usually be set to
710 Set to a list of extra scripts that should be run after all other
712 All scripts must be absolute path names.
715 The following variables are used by the standard scripts that reside in
716 .Pa /etc/periodic/monthly :
717 .Bl -tag -offset 4n -width 2n
718 .It Va monthly_accounting_enable
722 if you want to do login accounting using the
725 .It Va monthly_statistics_enable
729 if you want to report non-identifying information about the OS to the
730 .Pa http://www.bsdstats.org
731 community site on the internet.
732 .It Va monthly_statistics_report_devices
735 .Va monthly_statistics_report_devices
736 is set, this may also be set to report additional device statistics.
739 Set to a list of extra scripts that should be run after all other
741 All scripts must be absolute path names.
744 .Bl -tag -width /etc/defaults/periodic.conf
745 .It Pa /etc/defaults/periodic.conf
746 The default configuration file.
747 This file contains all default variables and values.
748 .It Pa /etc/periodic.conf
749 The usual system specific variable override file.
750 .It Pa /etc/periodic.conf.local
751 An additional override file, useful when
752 .Pa /etc/periodic.conf
753 is shared or distributed.
782 .An Brian Somers Aq brian@Awfulhak.org .