Introduce /etc/defaults/periodic.conf, similar in concept to rc.conf.

The only change in the default functionality should be that
the output reports are slightly more verbose WRT files deleted.

Not objected to by: freebsd-arch

3 files changed, 419 insertions, 29 deletions

diff --git a/share/man/man5/Makefile b/share/man/man5/Makefile
index 6a85d05..83fc325 100644
--- a/share/man/man5/Makefile
+++ b/share/man/man5/Makefile
@@ -6,8 +6,9 @@ MAN5=	a.out.5 acct.5 core.5 devfs.5 dir.5 disktab.5 ethers.5 \
 	elf.5 fbtab.5 fdesc.5 forward.5 fs.5 fstab.5 group.5 \
 	hosts.5 hosts.equiv.5 hosts.lpd.5 intro.5 kernfs.5 link.5 \
 	linprocfs.5 mailer.conf.5 motd.5 networks.5 passwd.5 pbm.5 \
-	phones.5 procfs.5 protocols.5 rc.conf.5 remote.5 resolver.5 \
-	services.5 shells.5 stab.5 sysctl.conf.5 types.5 utmp.5
+	periodic.conf.5 phones.5 procfs.5 protocols.5 rc.conf.5 \
+	remote.5 resolver.5 services.5 shells.5 stab.5 sysctl.conf.5 \
+	types.5 utmp.5
 
 MLINKS=	dir.5 dirent.5
 MLINKS+=fs.5 inode.5
diff --git a/share/man/man5/periodic.conf.5 b/share/man/man5/periodic.conf.5
new file mode 100644
index 0000000..2780185
--- /dev/null
+++ b/share/man/man5/periodic.conf.5
@@ -0,0 +1,416 @@
+.\"-
+.\" Copyright (c) 2000 Brian Somers <brian@Awfulhak.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd June 22, 2000
+.Dt PERIODIC.CONF 5
+.Os FreeBSD 5.0
+.Sh NAME
+.Nm periodic.conf
+.Nd periodic job configuration information.
+.Sh DESCRIPTION
+The file
+.Nm periodic.conf
+contains a description of how daily, weekly and montly system maintenance
+jobs should run.
+It resides in the
+.Pa /etc/defaults
+directory and parts may be overridden by a file of the same name in
+.Pa /etc ,
+which itself may be overridden by the
+.Pa /etc/periodic.conf.local
+file.
+.Pp
+.Nm
+is actually sourced as a shell script from each of the periodic scripts
+and is intended to simply provide default configuration variables.
+.Pp
+The following list provides a name and short description for each
+variable you can set in the
+.Nm
+file.
+.Bl -tag -offset 4n -width 2n
+.It Ar local_periodic
+(str) List of directories to search for periodic scripts.
+.El
+.B Daily variables
+.Pp
+The following variables are used by the standard scripts that reside in
+.Pa /etc/periodic/daily :
+.Bl -tag -offset 4n -width 2n
+.It Ar daily_clean_disks_enable
+(bool) Set to
+.Dq YES
+if you want to remove all files matching
+.Ar daily_clean_disks_files
+daily.
+.It Ar daily_clean_disks_files
+(str) Set to a list of file names to match.
+Wild cards are permitted.
+.It Ar daily_clean_disks_days
+(int) When
+.Ar daily_clean_disks_enable
+is set to
+.Dq YES ,
+this must also be set to the number of days old that a file's access
+and modification times must be before it's deleted.
+.It Ar daily_clean_disks_verbose
+(bool) Set to
+.Dq YES
+if you want the removed files to be reported in your daily output.
+.It Ar daily_clean_tmps_enable
+(bool) Set to
+.Dq YES
+if you want to clear temporary directories daily.
+.It Ar daily_clean_tmps_dirs
+(str) Set to the list of directories to clear if
+.Ar daily_clean_tmps_enable
+is set to
+.Dq YES .
+.It Ar daily_clean_tmps_days
+(int) When
+.Ar daily_clean_tmps_enable
+is set, this must also be set to the number of days old that a file's access
+and modification times must be before it's deleted.
+.It Ar daily_clean_tmps_ignore
+(str) Set to the list of files that should not be deleted when
+.Ar daily_clean_tmps_enable
+is set to
+.Dq YES .
+Wild card characters are permitted.
+.It Ar daily_clean_tmps_verbose
+(bool) Set to
+.Dq YES
+if you want the removed files to be reported in your daily output.
+.It Ar daily_clean_preserve_enable
+(bool) Set to
+.Dq YES
+if you wish to remove old files from
+.Pa /var/preserve .
+.It Ar daily_clean_preserve_days
+(num) Set to the number of days that files must not have been modified before
+they are deleted.
+.It Ar daily_clean_preserve_verbose
+(bool) Set to
+.Dq YES
+if you want the removed files to be reported in your daily output.
+.It Ar daily_clean_msgs_enable
+(bool) Set to
+.Dq YES
+if you old system messages to be purged.
+.It Ar daily_clean_msgs_days
+(num) Set to the number of days that files must not have been modified before
+they are deleted.
+If this variable is left blank, the
+.Xr msgs 1
+default is used.
+.It Ar daily_clean_rwho_enable
+(bool) Set to
+.Dq YES
+if you wish old files in
+.Pa /var/who
+to be purged.
+.It Ar daily_clean_rwho_days
+(num) Set to the number of days that files must not have been modified before
+they are deleted.
+.It Ar daily_clean_rwho_verbose
+(bool) Set to
+.Dq YES
+if you want the removed files to be reported in your daily output.
+.It Ar daily_clean_hoststat_enable
+(bool) Set to
+.Dq YES
+if you wish old files in
+.Pa /var/spool/.hoststat
+to be purged.
+.It Ar daily_clean_hoststat_days
+(num) Set to the number of days that files must not have been modified before
+they are deleted.
+.It Ar daily_clean_hoststat_verbose
+(bool) Set to
+.Dq YES
+if you want the removed files to be reported in your daily output.
+.It Ar daily_backup_passwd_enable
+(bool) Set to
+.Dq YES
+if you want the
+.Pa /etc/master.passwd
+and
+.Pa /etc/group
+files backed up and reported on.
+Reporting consists of checking both files for modifications and running
+.Xr chkgrp 8
+on the
+.Pa group
+file.
+.It Ar daily_backup_aliases_enable
+(bool) Set to
+.Dq YES
+if you want the
+.Pa /etc/aliases
+file backed up and modifications to be displayed in your daily output.
+.It Ar daily_backup_distfile_enable
+(bool) Set to
+.Dq YES
+if you want the
+.Pa /etc/Distfile
+file backed up and modifications to be displayed in your daily output.
+.It Ar daily_calendar_enable
+(bool) Set to
+.Dq YES
+if you want to run
+.Ic calendar -a
+daily.
+.It Ar daily_accounting_enable
+(bool) Set to
+.Dq YES
+if you want to rotate your daily accounting files.
+No rotations are necessary unless
+.Ar accounting_enable
+is enabled in
+.Xr rc.conf 5 .
+.It Ar daily_distfile_enable
+(bool) Set to
+.Dq YES
+if you want to run
+.Xr rdist 1
+daily.
+The
+.Pa /etc/Distfile
+file must also exist.
+.It Pa daily_news_expire_enable
+(bool) Set to
+.Dq YES
+if you want to run
+.Pa /etc/news.expire .
+.It Pa daily_uuclean_enable
+(bool) Set to
+.Dq YES
+if you want to run
+.Pa /etc/uuclean.daily .
+.it Ar daily_status_disks_enable
+(bool) Set to
+.Dq YES
+if you want to run
+.Ic df -k -t nonfs
+and
+.Ic dump W .
+.It Ar daily_status_uucp_enable
+(bool) Set to
+.Dq YES
+if you want to run
+.Pa /etc/uuclean.daily .
+.It Ar daily_status_network_enable
+(bool) Set to
+.Dq YES
+if you want to run
+.Ic netstat -i .
+.It Ar daily_status_network_usedns
+(bool) Set to
+.Dq YES
+if you want to run
+.Xr netstat 1
+without the
+.Fl n
+option (to do DNS lookups).
+.It Ar daily_status_rwho_enable
+(bool) Set to
+.Dq YES
+if you want to run
+.Xr uptime 1
+(or
+.Xr ruptime 1
+if 
+.Ar rwhod_enable
+is set to
+.Dq YES
+in
+.Pa /etc/rc.conf ).
+.It Ar daily_status_mailq_enable
+(bool) Set to
+.Dq YES
+if you want to run
+.Xr mailq 1 .
+.It Ar daily_status_mailq_shorten
+(bool) Set to
+.Dq YES
+if you want to shorten the
+.Nm mailq
+output when
+.Ar daily_status_mailq_enable
+is set to
+.Dq YES .
+.It Ar daily_status_security_enable
+(bool) Set to
+.Dq YES
+if you want to run
+.Pa /etc/security .
+.It Ar daily_status_security_inline
+(bool) Set to
+.Dq YES
+if you want to run
+.Pa /etc/security
+inline.
+The alternative is to run it as a background job, mailing the output to
+.An root .
+.It Ar daily_status_security_noamd
+(bool) Set to
+.Dq YES
+if you want to ignore
+.Xr amd 8
+mounts when comparing against yesterdays filesystem mounts.
+.It Ar daily_status_security_nomfs
+(bool) Set to
+.Dq YES
+if you want to ignore
+.Xr mfs 8
+mounts when comparing against yesterdays filesystem mounts.
+.It Ar daily_status_mail_rejects_enable
+(bool) Set to
+.Dq YES
+if you want to summarise mail rejections logged to
+.Pa /var/log/maillog
+for the previous day.
+.It Ar daily_local
+(str) Set to a list of extra scripts that should be run after all other
+daily scripts.
+All scripts must be absolute path names.
+.El
+.Pp
+The following variables are used by the standard scripts that reside in
+.Pa /etc/periodic/weekly :
+.Bl -tag -offset 4n -width 2n
+.It Ar weekly_clean_kvmdb_enable
+(bool) Set to
+.Dq YES
+if you want to purge old
+.Pa /var/db/kvm_*.db
+files.
+The kvm file for the current kernel will not be purged.
+.It Ar weekly_clean_kvmdb_days
+(num) Set to the number of days that the file must not have been accessed
+before being deleted.
+.It Ar weekly_clean_kvmdb_verbose
+(bool) Set to
+.Dq YES
+if you want the removed files to be reported in your daily output.
+.It Ar weekly_uucp_enable
+(bool) Set to
+.Dq YES
+if you want to run
+.Pa /usr/libexec/uucp/clean.weekly .
+.It Ar weekly_locate_enable
+(bool) Set to
+.Dq YES
+if you want to run
+.Pa /usr/libexec/locate.updatedb .
+This script is run using
+.Ic nice -5
+as user
+.An nobody ,
+and generates the table used by the
+.Xr locate 1
+command.
+.It Ar weekly_whatis_enable
+(bool) Set to
+.Dq YES
+if you want to run
+.Pa /usr/libexec/makewhatis.local .
+This script regenerates the database used by the
+.Xr apropos 1
+command.
+.It Ar weekly_catman_enable
+(bool) Set to
+.Dq YES
+if you want to run
+.Pa /usr/libexec/catman.local .
+This script processes all out of date man pages, speeding up the
+.Xr man 1
+command at the expense of disk space.
+.It Ar weekly_noid_enable
+(bool) Set to
+.Dq YES
+if you want to locate orphaned files on the system.
+An orphaned file is one with an invalid owner or group.
+.It Ar weekly_noid_dirs
+(str) A list of directories under which orphaned files are searched for.
+This would usually be set to
+.Pa / .
+.It Ar weekly_local
+(str) Set to a list of extra scripts that should be run after all other
+weekly scripts.
+All scripts must be absolute path names.
+.El
+.Pp
+The following variables are used by the standard scripts that reside in
+.Pa /etc/periodic/monthly :
+.Bl -tag -offset 4n -width 2n
+.It Ar monthly_accounting_enable
+(bool) Set to
+.Dq YES
+if you want to do login accounting using the
+.Xr ac 8
+command.
+.It Ar monthly_local
+(str) Set to a list of extra scripts that should be run after all other
+monthly scripts.
+All scripts must be absolute path names.
+.El
+.Sh FILES
+.Bl -tag -width /etc/defaults/periodic.conf
+.It Pa /etc/defaults/periodic.conf
+The default configuration file.
+This file contains all default variables and values.
+.It Pa /etc/periodic.conf
+The usual system specific variable override file.
+.It Pa /etc/periodic.conf.local
+An additional override file, useful when
+.Pa /etc/periodic.conf
+is shared or distributed.
+.El
+.Sh SEE ALSO
+.Xr apropos 1 ,
+.Xr calendar 1 ,
+.Xr df 1 ,
+.Xr locate 1 ,
+.Xr man 1 ,
+.Xr msgs 1 ,
+.Xr netstat 1 ,
+.Xr nice 1 ,
+.Xr rdist 1 ,
+.Xr rc.conf 5 ,
+.Xr ac 8 ,
+.Xr chkgrp 8 ,
+.Xr dump 8 ,
+.Xr mfs 8 .
+.Xr periodic 8 .
+.Sh HISTORY
+The
+.Nm
+file appeared in
+.Fx 5.0 .
+.Sh AUTHORS
+.An Brian Somers Aq brian@Awfulhak.org .
diff --git a/share/man/man5/rc.conf.5 b/share/man/man5/rc.conf.5
index cf31564..8ac2899 100644
--- a/share/man/man5/rc.conf.5
+++ b/share/man/man5/rc.conf.5
@@ -124,8 +124,6 @@ these are the flags to pass to the
 daemon.
 .It Ar local_startup
 (str) List of directories to search for startup script files.
-.It Ar local_periodic
-(str) List of directories to search for periodic scripts.
 .It Ar hostname
 (str) The Fully Qualified Domain Name of your host on the network.
 This should almost certainly be set to something meaningful, even if
@@ -1153,30 +1151,6 @@ boot time.
 if you want
 .Pa /tmp
 to be cleaned at startup.
-.It Ar clear_daily_enable
-(bool) Set to
-.Ar YES
-if you want to clear temporary directories daily.
-.It Ar clear_daily_dirs
-(str) Set to the list of directories to clear if
-.Ar clear_daily_enable
-is set to
-.Ar YES .
-.It Ar clear_daily_days
-(int) When
-.Ar clear_daily_enable
-is set, this must also be set to the number of days old that a file's access
-and modification times must be before it's deleted.
-.It Ar clear_daily_ignore
-(str) Set to the list of files that should not be deleted when
-.Ar clear_daily_enable
-is set to
-.Ar YES .
-Wild cards are permitted.
-.It Ar clear_daily_verbose
-(bool) Set to
-.Ar YES
-if you want the removed files to be reported in your daily output.
 .It Ar ldconfig_paths
 (str) Set to the list of shared library paths to use with
 .Xr ldconfig 8 .
@@ -1238,7 +1212,6 @@ at system boot time.
 .Xr nfsiod 8 ,
 .Xr ntpdate 8 ,
 .Xr pcnfsd 8 ,
-.Xr periodic 8 ,
 .Xr portmap 8 ,
 .Xr quotacheck 8 ,
 .Xr rc 8 ,