usr.sbin/periodic/periodic.8

   1 .\" Copyright (c) 1997 FreeBSD, Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .Dd June 18, 2020
  26 .Dt PERIODIC 8
  27 .Os
  28 .Sh NAME
  29 .Nm periodic
  30 .Nd run periodic system functions
  31 .Sh SYNOPSIS
  32 .Nm
  33 .Sm off
  34 .Cm daily | weekly | monthly | security | Ar directory
  35 .Sm on
  36 .Ar ...
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 utility is intended to be called by
  41 .Xr cron 8
  42 to execute shell scripts
  43 located in the specified directory.
  44 .Pp
  45 One or more of the following arguments must be specified:
  46 .Bl -tag -width "directory"
  47 .It Cm daily
  48 Perform the standard daily periodic executable run.
  49 This usually occurs early in the morning (local time).
  50 .It Cm weekly
  51 Perform the standard weekly periodic executable run.
  52 This usually occurs very early on Saturday mornings.
  53 .It Cm monthly
  54 Perform the standard monthly periodic executable run.
  55 This usually occurs on the first day of the month.
  56 .It Cm security
  57 Perform the standard daily security checks.
  58 This is usually spawned by the
  59 .Cm daily
  60 run.
  61 .It Ar directory
  62 An arbitrary directory containing a set of executables to be run.
  63 .El
  64 .Pp
  65 If an argument is an absolute directory name it is used as is, otherwise
  66 it is searched for under
  67 .Pa /etc/periodic
  68 and any other directories specified by the
  69 .Va local_periodic
  70 setting in
  71 .Xr periodic.conf 5
  72 (see below).
  73 .Pp
  74 The
  75 .Nm
  76 utility will run each executable file in the directory or directories
  77 specified.
  78 If a file does not have the executable bit set, it is silently ignored.
  79 .Pp
  80 Each script is required to exit with one of the following values:
  81 .Bl -tag -width 4n
  82 .It 0
  83 The script has produced nothing notable in its output.
  84 The
  85 .Ao Ar basedir Ac Ns Va _show_success
  86 variable controls the masking of this output.
  87 .It 1
  88 The script has produced some notable information in its output.
  89 The
  90 .Ao Ar basedir Ac Ns Va _show_info
  91 variable controls the masking of this output.
  92 .It 2
  93 The script has produced some warnings due to invalid configuration settings.
  94 The
  95 .Ao Ar basedir Ac Ns Va _show_badconfig
  96 variable controls the masking of this output.
  97 .It >2
  98 The script has produced output that must not be masked.
  99 .El
 100 .Pp
 101 If the relevant variable (where
 102 .Aq Ar basedir
 103 is the base directory in which the script resides) is set to
 104 .Dq Li NO
 105 in
 106 .Pa periodic.conf ,
 107 .Nm
 108 will mask the script output.
 109 If the variable is not set to either
 110 .Dq Li YES
 111 or
 112 .Dq Li NO ,
 113 it will be given a default value as described in
 114 .Xr periodic.conf 5 .
 115 .Pp
 116 All remaining script output is delivered based on the value of the
 117 .Ao Ar basedir Ac Ns Va _output
 118 setting.
 119 .Pp
 120 If this is set to a path name (beginning with a
 121 .Ql /
 122 character), output is simply logged to that file.
 123 .Xr newsyslog 8
 124 knows about the files
 125 .Pa /var/log/daily.log , /var/log/weekly.log
 126 and
 127 .Pa /var/log/monthly.log ,
 128 and if they exist, it will rotate them at the appropriate times.
 129 These are therefore good values if you wish to log
 130 .Nm
 131 output.
 132 .Pp
 133 If the
 134 .Ao Ar basedir Ac Ns Va _output
 135 value does not begin with a
 136 .Ql /
 137 and is not empty, it is assumed to contain a list of email addresses, and
 138 the output is mailed to them.
 139 If
 140 .Ao Ar basedir Ac Ns Va _show_empty_output
 141 is set to
 142 .Dq Li NO ,
 143 then no mail will be sent if the output was empty.
 144 .Pp
 145 If
 146 .Ao Ar basedir Ac Ns Va _output
 147 is not set or is empty, output is sent to standard output.
 148 .Sh ENVIRONMENT
 149 The
 150 .Nm
 151 utility sets the
 152 .Ev PATH
 153 environment to include all standard system directories, but no additional
 154 directories, such as
 155 .Pa /usr/local/bin .
 156 If executables are added which depend upon other path components, each
 157 executable must be responsible for configuring its own appropriate environment.
 158 .Sh FILES
 159 .Bl -tag -width ".Pa /etc/defaults/periodic.conf"
 160 .It Pa /etc/crontab
 161 the
 162 .Nm
 163 utility is typically called via entries in the system default
 164 .Xr cron 8
 165 table
 166 .It Pa /etc/periodic
 167 the top level directory containing
 168 .Pa daily ,
 169 .Pa weekly ,
 170 .Pa monthly ,
 171 and
 172 .Pa security
 173 subdirectories which contain standard system periodic executables
 174 .It Pa /etc/defaults/periodic.conf
 175 the
 176 .Pa periodic.conf
 177 system registry contains variables that control the behaviour of
 178 .Nm
 179 and the standard
 180 .Pa daily , weekly , monthly ,
 181 and
 182 .Pa security
 183 scripts
 184 .It Pa /etc/periodic.conf , ${LOCALBASE}/etc/periodic.conf
 185 this file contains local overrides for the default
 186 .Nm
 187 configuration
 188 .El
 189 .Sh EXIT STATUS
 190 Exit status is 0 on success and 1 if the command fails.
 191 .Sh EXAMPLES
 192 The system crontab should have entries for
 193 .Nm
 194 similar to the following example:
 195 .Bd -literal -offset indent
 196 # do daily/weekly/monthly maintenance
 197 0      2       *       *       *       root    periodic daily
 198 0      3       *       *       6       root    periodic weekly
 199 0      5       1       *       *       root    periodic monthly
 200 .Ed
 201 .Pp
 202 The
 203 .Pa /etc/defaults/periodic.conf
 204 system registry will typically have a
 205 .Va local_periodic
 206 variable reading:
 207 .Pp
 208 .Dl local_periodic="${_localbase}/etc/periodic"
 209 .Pp
 210 where
 211 .Pa ${_localbase}
 212 is being set from within
 213 .Pa /usr/sbin/periodic .
 214 .Pp
 215 To log
 216 .Nm
 217 output instead of receiving it as email, add the following lines to
 218 .Pa /etc/periodic.conf :
 219 .Bd -literal -offset indent
 220 daily_output=/var/log/daily.log
 221 weekly_output=/var/log/weekly.log
 222 monthly_output=/var/log/monthly.log
 223 .Ed
 224 .Pp
 225 To only see important information from daily periodic jobs, add the
 226 following lines to
 227 .Pa /etc/periodic.conf :
 228 .Bd -literal -offset indent
 229 daily_show_success=NO
 230 daily_show_info=NO
 231 daily_show_badconfig=NO
 232 .Ed
 233 .Sh DIAGNOSTICS
 234 The command may fail for one of the following reasons:
 235 .Bl -diag
 236 .It usage: periodic <directory of files to execute>
 237 No directory path argument was passed to
 238 .Nm
 239 to specify where the script fragments reside.
 240 .It <directory> not found
 241 Self explanatory.
 242 .El
 243 .Sh SEE ALSO
 244 .Xr sh 1 ,
 245 .Xr crontab 5 ,
 246 .Xr periodic.conf 5 ,
 247 .Xr cron 8 ,
 248 .Xr newsyslog 8
 249 .Sh HISTORY
 250 The
 251 .Nm
 252 utility first appeared in
 253 .Fx 3.0 .
 254 .Sh AUTHORS
 255 .An Paul Traina Aq Mt pst@FreeBSD.org
 256 .An Brian Somers Aq Mt brian@Awfulhak.org
 257 .Sh BUGS
 258 Since one specifies information about a directory using shell
 259 variables containing the string,
 260 .Aq Ar basedir ,
 261 .Aq Ar basedir
 262 must only contain characters that are valid within a
 263 .Xr sh 1
 264 variable name, alphanumerics and underscores, and the first character
 265 may not be numeric.