1.\"- 2.\" Copyright (c) 2000 Brian Somers <brian@Awfulhak.org> 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 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. 13.\" 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 24.\" SUCH DAMAGE. 25.\" 26.\" $FreeBSD$ 27.\" 28.Dd June 22, 2000 29.Dt PERIODIC.CONF 5 30.Os FreeBSD 5.0 31.Sh NAME 32.Nm periodic.conf 33.Nd periodic job configuration information. 34.Sh DESCRIPTION 35The file 36.Nm periodic.conf 37contains a description of how daily, weekly and montly system maintenance 38jobs should run. 39It resides in the 40.Pa /etc/defaults 41directory and parts may be overridden by a file of the same name in 42.Pa /etc , 43which itself may be overridden by the 44.Pa /etc/periodic.conf.local 45file. 46.Pp 47.Nm 48is actually sourced as a shell script from each of the periodic scripts 49and is intended to simply provide default configuration variables. 50.Pp 51The following list provides a name and short description for each 52variable you can set in the 53.Nm 54file. 55.Bl -tag -offset 4n -width 2n 56.It Ar local_periodic 57(str) List of directories to search for periodic scripts. 58.El 59.B Daily variables 60.Pp 61The following variables are used by the standard scripts that reside in 62.Pa /etc/periodic/daily : 63.Bl -tag -offset 4n -width 2n 64.It Ar daily_clean_disks_enable 65(bool) Set to 66.Dq YES 67if you want to remove all files matching 68.Ar daily_clean_disks_files 69daily. 70.It Ar daily_clean_disks_files 71(str) Set to a list of file names to match. 72Wild cards are permitted. 73.It Ar daily_clean_disks_days 74(int) When 75.Ar daily_clean_disks_enable 76is set to 77.Dq YES , 78this must also be set to the number of days old that a file's access 79and modification times must be before it's deleted. 80.It Ar daily_clean_disks_verbose 81(bool) Set to 82.Dq YES 83if you want the removed files to be reported in your daily output. 84.It Ar daily_clean_tmps_enable 85(bool) Set to 86.Dq YES 87if you want to clear temporary directories daily. 88.It Ar daily_clean_tmps_dirs 89(str) Set to the list of directories to clear if 90.Ar daily_clean_tmps_enable 91is set to 92.Dq YES . 93.It Ar daily_clean_tmps_days 94(int) When 95.Ar daily_clean_tmps_enable 96is set, this must also be set to the number of days old that a file's access 97and modification times must be before it's deleted. 98.It Ar daily_clean_tmps_ignore 99(str) Set to the list of files that should not be deleted when 100.Ar daily_clean_tmps_enable 101is set to 102.Dq YES . 103Wild card characters are permitted. 104.It Ar daily_clean_tmps_verbose 105(bool) Set to 106.Dq YES 107if you want the removed files to be reported in your daily output. 108.It Ar daily_clean_preserve_enable 109(bool) Set to 110.Dq YES 111if you wish to remove old files from 112.Pa /var/preserve . 113.It Ar daily_clean_preserve_days 114(num) Set to the number of days that files must not have been modified before 115they are deleted. 116.It Ar daily_clean_preserve_verbose 117(bool) Set to 118.Dq YES 119if you want the removed files to be reported in your daily output. 120.It Ar daily_clean_msgs_enable 121(bool) Set to 122.Dq YES 123if you old system messages to be purged. 124.It Ar daily_clean_msgs_days 125(num) Set to the number of days that files must not have been modified before 126they are deleted. 127If this variable is left blank, the 128.Xr msgs 1 129default is used. 130.It Ar daily_clean_rwho_enable 131(bool) Set to 132.Dq YES 133if you wish old files in 134.Pa /var/who 135to be purged. 136.It Ar daily_clean_rwho_days 137(num) Set to the number of days that files must not have been modified before 138they are deleted. 139.It Ar daily_clean_rwho_verbose 140(bool) Set to 141.Dq YES 142if you want the removed files to be reported in your daily output. 143.It Ar daily_clean_hoststat_enable 144(bool) Set to 145.Dq YES 146if you wish old files in 147.Pa /var/spool/.hoststat 148to be purged. 149.It Ar daily_clean_hoststat_days 150(num) Set to the number of days that files must not have been modified before 151they are deleted. 152.It Ar daily_clean_hoststat_verbose 153(bool) Set to 154.Dq YES 155if you want the removed files to be reported in your daily output. 156.It Ar daily_backup_passwd_enable 157(bool) Set to 158.Dq YES 159if you want the 160.Pa /etc/master.passwd 161and 162.Pa /etc/group 163files backed up and reported on. 164Reporting consists of checking both files for modifications and running 165.Xr chkgrp 8 166on the 167.Pa group 168file. 169.It Ar daily_backup_aliases_enable 170(bool) Set to 171.Dq YES 172if you want the 173.Pa /etc/aliases 174file backed up and modifications to be displayed in your daily output. 175.It Ar daily_backup_distfile_enable 176(bool) Set to 177.Dq YES 178if you want the 179.Pa /etc/Distfile 180file backed up and modifications to be displayed in your daily output. 181.It Ar daily_calendar_enable 182(bool) Set to 183.Dq YES 184if you want to run 185.Ic calendar -a 186daily. 187.It Ar daily_accounting_enable 188(bool) Set to 189.Dq YES 190if you want to rotate your daily accounting files. 191No rotations are necessary unless 192.Ar accounting_enable 193is enabled in 194.Xr rc.conf 5 . 195.It Ar daily_accounting_compress 196(bool) Set to 197.Dq YES 198if you want your daily accounting files to be compressed using 199.Xr gzip 1 . 200.It Ar daily_distfile_enable 201(bool) Set to 202.Dq YES 203if you want to run 204.Xr rdist 1 205daily. 206The 207.Pa /etc/Distfile 208file must also exist. 209.It Pa daily_news_expire_enable 210(bool) Set to 211.Dq YES 212if you want to run 213.Pa /etc/news.expire . 214.It Pa daily_uuclean_enable 215(bool) Set to 216.Dq YES 217if you want to run 218.Pa /etc/uuclean.daily . 219.It Ar daily_status_disks_enable 220(bool) Set to 221.Dq YES 222if you want to run 223.Xr df 1 224.Po 225with the arguments supplied in 226.Ar daily_status_disks_df_flags 227.Pc 228and 229.Ic dump W . 230.It Ar daily_status_disks_df_flags 231(str) Set to the arguments for the 232.Xr df 1 233utility when 234.Ar daily_status_disks_enable 235is set to 236.Dq YES . 237.It Ar daily_status_uucp_enable 238(bool) Set to 239.Dq YES 240if you want to run 241.Pa /etc/uuclean.daily . 242.It Ar daily_status_network_enable 243(bool) Set to 244.Dq YES 245if you want to run 246.Ic netstat -i . 247.It Ar daily_status_network_usedns 248(bool) Set to 249.Dq YES 250if you want to run 251.Xr netstat 1 252without the 253.Fl n 254option (to do DNS lookups). 255.It Ar daily_status_rwho_enable 256(bool) Set to 257.Dq YES 258if you want to run 259.Xr uptime 1 260(or 261.Xr ruptime 1 262if 263.Ar rwhod_enable 264is set to 265.Dq YES 266in 267.Pa /etc/rc.conf ). 268.It Ar daily_status_mailq_enable 269(bool) Set to 270.Dq YES 271if you want to run 272.Xr mailq 1 . 273.It Ar daily_status_mailq_shorten 274(bool) Set to 275.Dq YES 276if you want to shorten the 277.Nm mailq 278output when 279.Ar daily_status_mailq_enable 280is set to 281.Dq YES . 282.It Ar daily_status_security_enable 283(bool) Set to 284.Dq YES 285if you want to run 286.Pa /etc/security . 287.It Ar daily_status_security_inline 288(bool) Set to 289.Dq YES 290if you want to run 291.Pa /etc/security 292inline. 293The alternative is to run it as a background job, mailing the output to 294.An root . 295.It Ar daily_status_security_noamd 296(bool) Set to 297.Dq YES 298if you want to ignore 299.Xr amd 8 300mounts when comparing against yesterdays filesystem mounts. 301.It Ar daily_status_security_nomfs 302(bool) Set to 303.Dq YES 304if you want to ignore 305.Xr mfs 8 306mounts when comparing against yesterdays filesystem mounts. 307.It Ar daily_status_mail_rejects_enable 308(bool) Set to 309.Dq YES 310if you want to summarise mail rejections logged to 311.Pa /var/log/maillog 312for the previous day. 313.It Ar daily_status_mail_rejects_logs 314(num) Set to the number of maillog files that should be checked 315for yesterday's mail rejects. 316.It Ar daily_local 317(str) Set to a list of extra scripts that should be run after all other 318daily scripts. 319All scripts must be absolute path names. 320.El 321.Pp 322The following variables are used by the standard scripts that reside in 323.Pa /etc/periodic/weekly : 324.Bl -tag -offset 4n -width 2n 325.It Ar weekly_clean_kvmdb_enable 326(bool) Set to 327.Dq YES 328if you want to purge old 329.Pa /var/db/kvm_*.db 330files. 331The kvm file for the current kernel will not be purged. 332.It Ar weekly_clean_kvmdb_days 333(num) Set to the number of days that the file must not have been accessed 334before being deleted. 335.It Ar weekly_clean_kvmdb_verbose 336(bool) Set to 337.Dq YES 338if you want the removed files to be reported in your daily output. 339.It Ar weekly_uucp_enable 340(bool) Set to 341.Dq YES 342if you want to run 343.Pa /usr/libexec/uucp/clean.weekly . 344.It Ar weekly_locate_enable 345(bool) Set to 346.Dq YES 347if you want to run 348.Pa /usr/libexec/locate.updatedb . 349This script is run using 350.Ic nice -5 351as user 352.An nobody , 353and generates the table used by the 354.Xr locate 1 355command. 356.It Ar weekly_whatis_enable 357(bool) Set to 358.Dq YES 359if you want to run 360.Pa /usr/libexec/makewhatis.local . 361This script regenerates the database used by the 362.Xr apropos 1 363command. 364.It Ar weekly_catman_enable 365(bool) Set to 366.Dq YES 367if you want to run 368.Pa /usr/libexec/catman.local . 369This script processes all out of date man pages, speeding up the 370.Xr man 1 371command at the expense of disk space. 372.It Ar weekly_noid_enable 373(bool) Set to 374.Dq YES 375if you want to locate orphaned files on the system. 376An orphaned file is one with an invalid owner or group. 377.It Ar weekly_noid_dirs 378(str) A list of directories under which orphaned files are searched for. 379This would usually be set to 380.Pa / . 381.It Ar weekly_status_pkg_dirs 382(bool) Set to 383.Dq YES 384if you want to use 385.Xr pkg_version 1 386to list installed packages which are out of date. 387.It Ar weekly_local 388(str) Set to a list of extra scripts that should be run after all other 389weekly scripts. 390All scripts must be absolute path names. 391.El 392.Pp 393The following variables are used by the standard scripts that reside in 394.Pa /etc/periodic/monthly : 395.Bl -tag -offset 4n -width 2n 396.It Ar monthly_accounting_enable 397(bool) Set to 398.Dq YES 399if you want to do login accounting using the 400.Xr ac 8 401command. 402.It Ar monthly_local 403(str) Set to a list of extra scripts that should be run after all other 404monthly scripts. 405All scripts must be absolute path names. 406.El 407.Sh FILES 408.Bl -tag -width /etc/defaults/periodic.conf 409.It Pa /etc/defaults/periodic.conf 410The default configuration file. 411This file contains all default variables and values. 412.It Pa /etc/periodic.conf 413The usual system specific variable override file. 414.It Pa /etc/periodic.conf.local 415An additional override file, useful when 416.Pa /etc/periodic.conf 417is shared or distributed. 418.El 419.Sh SEE ALSO 420.Xr apropos 1 , 421.Xr calendar 1 , 422.Xr df 1 , 423.Xr gzip 1 , 424.Xr locate 1 , 425.Xr man 1 , 426.Xr msgs 1 , 427.Xr netstat 1 , 428.Xr nice 1 , 429.Xr pkg_version 1 , 430.Xr rdist 1 , 431.Xr rc.conf 5 , 432.Xr ac 8 , 433.Xr chkgrp 8 , 434.Xr dump 8 , 435.Xr mfs 8 . 436.Xr periodic 8 . 437.Sh HISTORY 438The 439.Nm 440file appeared in 441.Fx 5.0 . 442.Sh AUTHORS 443.An Brian Somers Aq brian@Awfulhak.org . 444