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.2 2003/06/17 04:37:00 dillon Exp $
34 .Nd periodic job configuration information
38 contains a description of how daily, weekly and montly 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 .Dq /var/log/daily.log ,
81 .Dq /var/log/weekly.log ,
83 .Dq /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
240 if you wish old files in
241 .Pa /var/spool/.hoststat
243 .It Va daily_clean_hoststat_days
245 Set to the number of days that files must not have been modified before
247 .It Va daily_clean_hoststat_verbose
251 if you want the removed files to be reported in your daily output.
252 .It Va daily_backup_passwd_enable
257 .Pa /etc/master.passwd
260 files backed up and reported on.
261 Reporting consists of checking both files for modifications and running
266 .It Va daily_backup_aliases_enable
271 .Pa /etc/mail/aliases
272 file backed up and modifications to be displayed in your daily output.
273 .It Va daily_backup_distfile_enable
279 file backed up and modifications to be displayed in your daily output.
280 .It Va daily_calendar_enable
287 .It Va daily_accounting_enable
291 if you want to rotate your daily accounting files.
292 No rotations are necessary unless
293 .Va accounting_enable
296 .It Va daily_accounting_compress
300 if you want your daily accounting files to be compressed using
302 .It Va daily_accounting_save
305 .Va daily_accounting_enable
306 is set, this may also be set to the number of daily accounting files that are
310 .It Va daily_accounting_flags
312 Set to the arguments to pass to the
314 utility (in addition to
317 .Va daily_accounting_enable
322 .It Va daily_distfile_enable
331 file must also exist.
332 .It Va daily_news_expire_enable
337 .Pa /etc/news.expire .
338 .It Pa daily_uuclean_enable
343 .Pa /etc/uuclean.daily .
344 .It Va daily_status_disks_enable
350 (with the arguments supplied in
351 .Va daily_status_disks_df_flags )
354 .It Va daily_status_disks_df_flags
356 Set to the arguments for the
359 .Va daily_status_disks_enable
362 .It Va daily_status_uucp_enable
368 .It Va daily_status_network_enable
374 .It Va daily_status_network_usedns
382 option (to do DNS lookups).
383 .It Va daily_status_rwho_enable
397 .It Va daily_status_mailq_enable
403 .It Va daily_status_mailq_shorten
407 if you want to shorten the
410 .Va daily_status_mailq_enable
413 .It Va daily_status_include_submit_mailq
417 if you also want to run
419 on the submit mail queue when
420 .Va daily_status_mailq_enable
423 This may not work with MTAs other than
425 .It Va daily_status_security_enable
429 if you want to run the security check.
430 The security check is another set of
433 The system defaults are in
434 .Pa /etc/periodic/security .
435 Local scripts should be placed in
436 .Pa /usr/local/etc/periodic/security .
439 manual page for more information.
440 .It Va daily_status_security_inline
444 if you want the security check output inline.
445 The default is to either mail or log the output according to the value of
446 .Va daily_status_security_output .
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_chksetuid_enable
461 to compare the modes and modification times of setuid executables with
462 the previous day's values.
463 .It Va daily_status_security_chkmounts_enable
467 to check for changes mounted filesystems to the previous day's values.
468 .It Va daily_status_security_noamd
472 if you want to ignore
474 mounts when comparing against yesterdays filesystem mounts in the
475 .Va daily_status_security_chkmounts_enable
477 .It Va daily_status_security_nomfs
481 if you want to ignore
483 mounts when comparing against yesterdays filesystem mounts in the
484 .Va daily_status_security_chkmounts_enable
486 .It Va daily_status_security_chkuid0_enable
491 .Pa /etc/master.passwd
492 for accounts with uid 0.
493 .It Va daily_status_security_passwdless_enable
498 .Pa /etc/master.passwd
499 for accounts with empty passwords.
500 .It Va daily_status_security_ipfwdenied_enable
504 to show log entries for packets denied by
506 since yesterday's check.
507 .It Va daily_status_security_ipfdenied_enable
511 to show log entries for packets denied by
513 since yesterday's check.
514 .It Va daily_status_security_ipfwlimit_enable
520 rules that have reached their verbosity limit.
521 .It Va daily_status_security_ip6fwdenied_enable
525 to show log entries for packets denied by
527 since yesterday's check.
528 .It Va daily_status_security_ip6fwlimit_enable
534 rules that have reached their verbosity limit.
535 .It Va daily_status_security_kernelmsg_enable
541 entries since yesterday's check.
542 .It Va daily_status_security_loginfail_enable
546 to display failed logins from
547 .Pa /var/log/messages
549 .It Va daily_status_security_tcpwrap_enable
553 to display connections denied by tcpwrappers (see
556 .Pa /var/log/messages
557 during the previous day.
558 .It Va daily_status_mail_rejects_enable
562 if you want to summarise mail rejections logged to
564 for the previous day.
565 .It Va daily_status_mail_rejects_logs
567 Set to the number of maillog files that should be checked
568 for yesterday's mail rejects.
569 .It Va daily_status_named_enable
573 if you want to summarise denied zone transfers (AXFR and IXFR)
574 for the previious day.
575 .It Va daily_status_named_usedns
579 if you want to enable reverse DNS lookups.
580 .It Va daily_queuerun_enable
584 if you want to manually run the mail queue at least once a day.
585 .It Va daily_submit_queuerun
589 if you also want to manually run the submit mail queue at least once a day
591 .Va daily_queuerun_enable
596 Set to a list of extra scripts that should be run after all other
598 All scripts must be absolute path names.
601 The following variables are used by the standard scripts that reside in
602 .Pa /etc/periodic/weekly :
603 .Bl -tag -offset 4n -width 2n
604 .It Va weekly_clean_kvmdb_enable
608 if you want to purge old
611 The kvm file for the current kernel will not be purged.
612 .It Va weekly_clean_kvmdb_days
614 Set to the number of days that the file must not have been accessed
615 before being deleted.
616 .It Va weekly_clean_kvmdb_verbose
620 if you want the removed files to be reported in your weekly output.
621 .It Va weekly_uucp_enable
626 .Pa /usr/libexec/uucp/clean.weekly .
627 .It Va weekly_locate_enable
632 .Pa /usr/libexec/locate.updatedb .
633 This script is run using
637 and generates the table used by the
640 .It Va weekly_whatis_enable
645 .Pa /usr/libexec/makewhatis.local .
646 This script regenerates the database used by the
649 .It Va weekly_catman_enable
654 .Pa /usr/libexec/catman.local .
655 This script processes all out of date man pages, speeding up the
657 command at the expense of disk space.
658 .It Va weekly_noid_enable
662 if you want to locate orphaned files on the system.
663 An orphaned file is one with an invalid owner or group.
664 .It Va weekly_noid_dirs
666 A list of directories under which orphaned files are searched for.
667 This would usually be set to
669 .It Va weekly_status_pkg_enable
675 to list installed packages which are out of date.
678 Set to a list of extra scripts that should be run after all other
680 All scripts must be absolute path names.
683 The following variables are used by the standard scripts that reside in
684 .Pa /etc/periodic/monthly :
685 .Bl -tag -offset 4n -width 2n
686 .It Va monthly_accounting_enable
690 if you want to do login accounting using the
695 Set to a list of extra scripts that should be run after all other
697 All scripts must be absolute path names.
700 .Bl -tag -width /etc/defaults/periodic.conf
701 .It Pa /etc/defaults/periodic.conf
702 The default configuration file.
703 This file contains all default variables and values.
704 .It Pa /etc/periodic.conf
705 The usual system specific variable override file.
706 .It Pa /etc/periodic.conf.local
707 An additional override file, useful when
708 .Pa /etc/periodic.conf
709 is shared or distributed.
737 .An Brian Somers Aq brian@Awfulhak.org .