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 $
27 .\" $DragonFly: src/share/man/man5/periodic.conf.5,v 1.8 2007/12/29 21:57:58 matthias Exp $
34 .Nd periodic job configuration information
38 contains a description of how daily, weekly and monthly system maintenance
42 directory and parts may be overridden by a file of the same name in
44 which itself may be overridden by the
45 .Pa /etc/periodic.conf.local
49 is actually sourced as a shell script from each of the periodic scripts
50 and is intended to simply provide default configuration variables.
52 The following variables are used by
55 .Bl -tag -offset 4n -width 2n
58 List of directories to search for periodic scripts.
59 This list is always prefixed with
61 and is only used when an argument to
63 is not an absolute directory name.
64 .It Va dir Ns No _output
65 .Pq Vt path No or Vt list
66 What to do with the output of the scripts envoked from
69 If this variable is set to an absolute path name, output is logged to
70 that file, otherwise it is taken as one or more space separated email
71 addresses and mailed to those users.
72 If this variable is not set or is empty, output is sent to standard output.
74 For an unattended machine, suitable values for
80 .Pa /var/log/daily.log ,
81 .Pa /var/log/weekly.log ,
83 .Pa /var/log/monthly.log
86 will rotate these files (if they exists) at the appropriate times.
87 .It Va dir Ns No _show_success
88 .It Va dir Ns No _show_info
89 .It Va dir Ns No _show_badconfig
91 These variables control whether
93 will mask the output of the envoked scripts based on their return code
96 is the base directory name in which each script resides).
97 If the return code of a script is
100 .Va dir Ns No _show_success
104 will mask the script's output.
105 If the return code of a script is
108 .Va dir Ns No _show_info
112 will mask the script's output.
113 If the return code of a script is
116 .Va dir Ns No _show_badconfig
120 will mask the script's output.
121 If these variables are set to neither
134 man page for how script return codes are interpreted.
137 The following variables are used by the standard scripts that reside in
138 .Pa /etc/periodic/daily :
139 .Bl -tag -offset 4n -width 2n
140 .It Va daily_clean_disks_enable
144 if you want to remove all files matching
145 .Va daily_clean_disks_files
147 .It Va daily_clean_disks_files
149 Set to a list of file names to match.
150 Wild cards are permitted.
151 .It Va daily_clean_disks_days
154 .Va daily_clean_disks_enable
157 this must also be set to the number of days old that a file's access
158 and modification times must be before it's deleted.
159 .It Va daily_clean_disks_verbose
163 if you want the removed files to be reported in your daily output.
164 .It Va daily_clean_tmps_enable
168 if you want to clear temporary directories daily.
169 .It Va daily_clean_tmps_dirs
171 Set to the list of directories to clear if
172 .Va daily_clean_tmps_enable
175 .It Va daily_clean_tmps_days
178 .Va daily_clean_tmps_enable
179 is set, this must also be set to the number of days old that a file's access
180 and modification times must be before it's deleted.
181 .It Va daily_clean_tmps_ignore
183 Set to the list of files that should not be deleted when
184 .Va daily_clean_tmps_enable
187 Wild card characters are permitted.
188 .It Va daily_clean_tmps_verbose
192 if you want the removed files to be reported in your daily output.
193 .It Va daily_clean_preserve_enable
197 if you wish to remove old files from
199 .It Va daily_clean_preserve_days
201 Set to the number of days that files must not have been modified before
203 .It Va daily_clean_preserve_verbose
207 if you want the removed files to be reported in your daily output.
208 .It Va daily_clean_msgs_enable
212 if you wish old system messages to be purged.
213 .It Va daily_clean_msgs_days
215 Set to the number of days that files must not have been modified before
217 If this variable is left blank, the
220 .It Va daily_clean_rwho_enable
224 if you wish old files in
227 .It Va daily_clean_rwho_days
229 Set to the number of days that files must not have been modified before
231 .It Va daily_clean_rwho_verbose
235 if you want the removed files to be reported in your daily output.
236 .It Va daily_clean_hoststat_enable
242 to automatically purge stale entries from
245 Files will be deleted using the same criteria as
247 would normally use when determining whether to believe the cached information,
249 .Pa /etc/mail/sendmail.cf .
250 .It Va daily_backup_passwd_enable
255 .Pa /etc/master.passwd
258 files backed up and reported on.
259 Reporting consists of checking both files for modifications and running
264 .It Va daily_backup_aliases_enable
269 .Pa /etc/mail/aliases
270 file backed up and modifications to be displayed in your daily output.
271 .It Va daily_backup_distfile_enable
277 file backed up and modifications to be displayed in your daily output.
278 .It Va daily_calendar_enable
285 .It Va daily_accounting_enable
289 if you want to rotate your daily accounting files.
290 No rotations are necessary unless
291 .Va accounting_enable
294 .It Va daily_accounting_compress
298 if you want your daily accounting files to be compressed using
300 .It Va daily_accounting_save
303 .Va daily_accounting_enable
304 is set, this may also be set to the number of daily accounting files that are
308 .It Va daily_accounting_flags
310 Set to the arguments to pass to the
312 utility (in addition to
315 .Va daily_accounting_enable
320 .It Va daily_distfile_enable
329 file must also exist.
330 .It Va daily_news_expire_enable
335 .Pa /etc/news.expire .
336 .It Va daily_status_disks_enable
342 (with the arguments supplied in
343 .Va daily_status_disks_df_flags )
346 .It Va daily_status_disks_df_flags
348 Set to the arguments for the
351 .Va daily_status_disks_enable
354 .It Va daily_status_network_enable
360 .It Va daily_status_network_usedns
368 option (to do DNS lookups).
369 .It Va daily_status_rwho_enable
383 .It Va daily_status_mailq_enable
389 .It Va daily_status_mailq_shorten
393 if you want to shorten the
396 .Va daily_status_mailq_enable
399 .It Va daily_status_include_submit_mailq
403 if you also want to run
405 on the submit mail queue when
406 .Va daily_status_mailq_enable
409 This may not work with MTAs other than
411 .It Va daily_status_security_enable
415 if you want to run the security check.
416 The security check is another set of
419 The system defaults are in
420 .Pa /etc/periodic/security .
421 Local scripts should be placed in
422 .Pa /usr/local/etc/periodic/security .
425 manual page for more information.
426 .It Va daily_status_security_inline
430 if you want the security check output inline.
431 The default is to either mail or log the output according to the value of
432 .Va daily_status_security_output .
433 .It Va daily_status_security_logdir
435 The directory where the security scripts expect the system's log files.
436 .It Va daily_status_security_output
438 Where to send the output of the security check if
439 .Va daily_status_security_inline
442 This variable behaves in the same way as the
444 variables above, namely it can be set either to one or more email addresses
445 or to an absolute file name.
446 .It Va daily_status_security_diff_flags
448 Set to the arguments to pass to the
450 utility when generating differences.
453 .It Va daily_status_security_chksetuid_enable
457 to compare the modes and modification times of setuid executables with
458 the previous day's values.
459 .It Va daily_status_security_chkmounts_enable
463 to check for changes in mounted filesystems to the previous day's values.
464 .It Va daily_status_security_chkmounts_ignore
465 Set to the list of filesystem types that should not be checked when
466 .Va daily_status_security_chkmounts_enable
469 .It Va daily_status_security_noamd
473 if you want to ignore
475 mounts when comparing against yesterdays filesystem mounts in the
476 .Va daily_status_security_chkmounts_enable
478 .It Va daily_status_security_nomfs
482 if you want to ignore
484 mounts when comparing against yesterdays filesystem mounts in the
485 .Va daily_status_security_chkmounts_enable
487 .It Va daily_status_security_chkuid0_enable
492 .Pa /etc/master.passwd
493 for accounts with uid 0.
494 .It Va daily_status_security_passwdless_enable
499 .Pa /etc/master.passwd
500 for accounts with empty passwords.
501 .It Va daily_status_security_logincheck_enable
509 for more information.
510 .It Va daily_status_security_ipfwdenied_enable
514 to show log entries for packets denied by
516 since yesterday's check.
517 .It Va daily_status_security_ipfdenied_enable
521 to show log entries for packets denied by
523 since yesterday's check.
524 .It Va daily_status_security_pfdenied_enable
528 to show log entries for packets denied by
530 since yesterday's check.
531 .It Va daily_status_security_ipfwlimit_enable
537 rules that have reached their verbosity limit.
538 .It Va daily_status_security_ip6fwdenied_enable
542 to show log entries for packets denied by
544 since yesterday's check.
545 .It Va daily_status_security_ip6fwlimit_enable
551 rules that have reached their verbosity limit.
552 .It Va daily_status_security_kernelmsg_enable
558 entries since yesterday's check.
559 .It Va daily_status_security_loginfail_enable
563 to display failed logins from
564 .Pa /var/log/messages
566 .It Va daily_status_security_tcpwrap_enable
570 to display connections denied by tcpwrappers (see
573 .Pa /var/log/messages
574 during the previous day.
575 .It Va daily_status_mail_rejects_enable
579 if you want to summarise mail rejections logged to
581 for the previous day.
582 .It Va daily_status_mail_rejects_logs
584 Set to the number of maillog files that should be checked
585 for yesterday's mail rejects.
586 .It Va daily_status_named_enable
590 if you want to summarise denied zone transfers (AXFR and IXFR)
591 for the previous day.
592 .It Va daily_status_named_usedns
596 if you want to enable reverse DNS lookups.
597 .It Va daily_queuerun_enable
601 if you want to manually run the mail queue at least once a day.
602 .It Va daily_submit_queuerun
606 if you also want to manually run the submit mail queue at least once a day
608 .Va daily_queuerun_enable
613 Set to a list of extra scripts that should be run after all other
615 All scripts must be absolute path names.
618 The following variables are used by the standard scripts that reside in
619 .Pa /etc/periodic/weekly :
620 .Bl -tag -offset 4n -width 2n
621 .It Va weekly_clean_kvmdb_enable
625 if you want to purge old
628 The kvm file for the current kernel will not be purged.
629 .It Va weekly_clean_kvmdb_days
631 Set to the number of days that the file must not have been accessed
632 before being deleted.
633 .It Va weekly_clean_kvmdb_verbose
637 if you want the removed files to be reported in your weekly output.
638 .It Va weekly_locate_enable
643 .Pa /usr/libexec/locate.updatedb .
644 This script is run using
648 and generates the table used by the
651 .It Va weekly_whatis_enable
656 .Pa /usr/libexec/makewhatis.local .
657 This script regenerates the database used by the
660 .It Va weekly_catman_enable
665 .Pa /usr/libexec/catman.local .
666 This script processes all out of date man pages, speeding up the
668 command at the expense of disk space.
669 .It Va weekly_noid_enable
673 if you want to locate orphaned files on the system.
674 An orphaned file is one with an invalid owner or group.
675 .It Va weekly_noid_dirs
677 A list of directories under which orphaned files are searched for.
678 This would usually be set to
682 Set to a list of extra scripts that should be run after all other
684 All scripts must be absolute path names.
687 The following variables are used by the standard scripts that reside in
688 .Pa /etc/periodic/monthly :
689 .Bl -tag -offset 4n -width 2n
690 .It Va monthly_accounting_enable
694 if you want to do login accounting using the
697 .It Va monthly_statistics_enable
701 if you want to report non-identifying information about the OS to the
702 .Pa http://www.bsdstats.org
703 community site on the internet.
704 .It Va monthly_statistics_report_devices
707 .Va monthly_statistics_report_devices
708 is set, this may also be set to report additional device statistics.
711 Set to a list of extra scripts that should be run after all other
713 All scripts must be absolute path names.
716 .Bl -tag -width /etc/defaults/periodic.conf
717 .It Pa /etc/defaults/periodic.conf
718 The default configuration file.
719 This file contains all default variables and values.
720 .It Pa /etc/periodic.conf
721 The usual system specific variable override file.
722 .It Pa /etc/periodic.conf.local
723 An additional override file, useful when
724 .Pa /etc/periodic.conf
725 is shared or distributed.
754 .An Brian Somers Aq brian@Awfulhak.org .