.\"- .\" 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: src/share/man/man5/periodic.conf.5,v 1.8.2.17 2001/11/27 11:36:35 ru Exp $ .\" .Dd June 22, 2000 .Dt PERIODIC.CONF 5 .Os .Sh NAME .Nm periodic.conf .Nd periodic job configuration information .Sh DESCRIPTION The file .Nm 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 variables are used by .Xr periodic 8 itself: .Bl -tag -offset 4n -width 2n .It Va local_periodic .Pq Vt str List of directories to search for periodic scripts. This list is always prefixed with .Pa /etc/periodic , and is only used when an argument to .Xr periodic 8 is not an absolute directory name. .It Va dir Ns No _output .Pq Vt path No or Vt list What to do with the output of the scripts envoked from the directory .Ar dir . If this variable is set to an absolute path name, output is logged to that file, otherwise it is taken as one or more space separated email addresses and mailed to those users. If this variable is not set or is empty, output is sent to standard output. .Pp .It Va dir Ns No _show_success .It Va dir Ns No _show_info .It Va dir Ns No _show_badconfig .Pq Vt bool These variables control whether .Xr periodic 8 will mask the output of the envoked scripts based on their return code (where .Ar dir is the base directory name in which each script resides). If the return code of a script is .Sq 0 and .Va dir Ns No _show_success is set to .Dq NO , .Xr periodic 8 will mask the script's output. If the return code of a script is .Sq 1 and .Va dir Ns No _show_info is set to .Dq NO , .Xr periodic 8 will mask the script's output. If the return code of a script is .Sq 2 and .Va dir Ns No _show_badconfig is set to .Dq NO , .Xr periodic 8 will mask the script's output. If these variables are set to neither .Dq YES nor .Dq NO , they default to .Dq YES , .Dq YES and .Dq NO respectively. .Pp Refer to the .Xr periodic 8 man page for how script return codes are interpreted. .El .Pp The following variables are used by the standard scripts that reside in .Bl -tag -offset 4n -width 2n .Pa /etc/periodic/daily : .It Va daily_clean_logs_enable .Pq Vt bool Set to .Dq YES if you want to clear log directories daily. .It Va daily_clean_logs_dirs .Pq Vt str Set to the list of directories to clear if .Va daily_clean_logs_enable is set to .Dq YES . .It Va daily_clean_logs_days .Pq Vt num When .Va daily_clean_logs_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 Va daily_clean_logs_ignore .Pq Vt str Set to the list of files that should not be deleted when .Va daily_clean_logs_enable is set to .Dq YES . Wild card characters are permitted. .It Va daily_clean_logs_verbose .Pq Vt bool Set to .Dq YES if you want the removed files to be reported in your daily output. .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 gzip 1 , .Xr locate 1 , .Xr man 1 , .Xr msgs 1 , .Xr netstat 1 , .Xr nice 1 , .Xr rc.conf 5 , .Xr ac 8 , .Xr chkgrp 8 , .Xr dump 8 , .Xr periodic 8 .Sh AUTHORS .An Brian Somers Aq brian@Awfulhak.org .