diff options
Diffstat (limited to 'static/freebsd/man5/periodic.conf.5 3.html')
| -rw-r--r-- | static/freebsd/man5/periodic.conf.5 3.html | 744 |
1 files changed, 744 insertions, 0 deletions
diff --git a/static/freebsd/man5/periodic.conf.5 3.html b/static/freebsd/man5/periodic.conf.5 3.html new file mode 100644 index 00000000..351533f1 --- /dev/null +++ b/static/freebsd/man5/periodic.conf.5 3.html @@ -0,0 +1,744 @@ +<table class="head"> + <tr> + <td class="head-ltitle">PERIODIC.CONF(5)</td> + <td class="head-vol">File Formats Manual</td> + <td class="head-rtitle">PERIODIC.CONF(5)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">periodic.conf</code> — + <span class="Nd">periodic job configuration information</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The file <code class="Nm">periodic.conf</code> contains a + description of how daily, weekly and monthly system maintenance jobs should + run. It resides in the <span class="Pa">/etc/defaults</span> directory and + parts may be overridden by a file of the same name in + <span class="Pa">/etc</span>, which itself may be overridden by the + <span class="Pa">/etc/periodic.conf.local</span> file.</p> +<p class="Pp">The <code class="Nm">periodic.conf</code> file is actually sourced + as a shell script from each of the periodic scripts and is intended to + simply provide default configuration variables.</p> +<p class="Pp">The following variables are used by <a class="Xr">periodic(8)</a> + itself:</p> +<div class="Bd-indent"> +<dl class="Bl-tag"> + <dt id="local_periodic"><var class="Va">local_periodic</var></dt> + <dd>(<var class="Vt">str</var>) List of directories to search for periodic + scripts. This list is always prefixed with + <span class="Pa">/etc/periodic</span>, and is only used when an argument + to <a class="Xr">periodic(8)</a> is not an absolute directory name.</dd> + <dt>⟨<var class="Ar">dir</var>⟩<var class="Va">_output</var></dt> + <dd>(<var class="Vt">path</var> <span class="No">or</span> + <var class="Vt">list</var>) What to do with the output of the scripts + executed from the directory <var class="Ar">dir</var>. 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. + <p class="Pp">For an unattended machine, suitable values for + <var class="Va">daily_output</var>, <var class="Va">weekly_output</var>, + and <var class="Va">monthly_output</var> might be + “<code class="Li">/var/log/daily.log</code>”, + “<code class="Li">/var/log/weekly.log</code>”, and + “<code class="Li">/var/log/monthly.log</code>” + respectively, as <a class="Xr">newsyslog(8)</a> will rotate these files + (if they exists) at the appropriate times.</p> + </dd> + <dt>⟨<var class="Ar">dir</var>⟩<var class="Va">_show_success</var></dt> + <dd style="width: auto;"> </dd> + <dt>⟨<var class="Ar">dir</var>⟩<var class="Va">_show_info</var></dt> + <dd style="width: auto;"> </dd> + <dt>⟨<var class="Ar">dir</var>⟩<var class="Va">_show_badconfig</var></dt> + <dd>(<var class="Vt">bool</var>) These variables control whether + <a class="Xr">periodic(8)</a> will mask the output of the executed scripts + based on their return code (where <var class="Ar">dir</var> is the base + directory name in which each script resides). If the return code of a + script is ‘0’ and + ⟨<var class="Ar">dir</var>⟩<var class="Va">_show_success</var> + is set to “<code class="Li">NO</code>”, + <a class="Xr">periodic(8)</a> will mask the script's output. If the return + code of a script is ‘1’ and + ⟨<var class="Ar">dir</var>⟩<var class="Va">_show_info</var> + is set to “<code class="Li">NO</code>”, + <a class="Xr">periodic(8)</a> will mask the script's output. If the return + code of a script is ‘2’ and + ⟨<var class="Ar">dir</var>⟩<var class="Va">_show_badconfig</var> + is set to “<code class="Li">NO</code>”, + <a class="Xr">periodic(8)</a> will mask the script's output. If these + variables are set to neither “<code class="Li">YES</code>” + nor “<code class="Li">NO</code>”, they default to + “<code class="Li">YES</code>”, + “<code class="Li">YES</code>” and + “<code class="Li">NO</code>” respectively. + <p class="Pp">Refer to the <a class="Xr">periodic(8)</a> manual page for how + script return codes are interpreted.</p> + </dd> + <dt id="anticongestion_sleeptime"><var class="Va">anticongestion_sleeptime</var></dt> + <dd>(<var class="Vt">int</var>) The maximum number of seconds to randomly + sleep in order to smooth bursty loads on a shared resource, such as a + download mirror.</dd> +</dl> +</div> +<p class="Pp">The following variables are used by the standard scripts that + reside in <span class="Pa">/etc/periodic/daily</span>:</p> +<div class="Bd-indent"> +<dl class="Bl-tag"> + <dt id="daily_clean_disks_enable"><var class="Va">daily_clean_disks_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to remove all + files matching <var class="Va">daily_clean_disks_files</var> daily.</dd> + <dt id="daily_clean_disks_files"><var class="Va">daily_clean_disks_files</var></dt> + <dd>(<var class="Vt">str</var>) Set to a list of file names to match. Wild + cards are permitted.</dd> + <dt id="daily_clean_disks_days"><var class="Va">daily_clean_disks_days</var></dt> + <dd>(<var class="Vt">num</var>) When + <var class="Va">daily_clean_disks_enable</var> is set to + “<code class="Li">YES</code>”, this must also be set to the + number of days old that a file's access and modification times must be + before it is deleted.</dd> + <dt id="daily_clean_disks_verbose"><var class="Va">daily_clean_disks_verbose</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want the removed files + to be reported in your daily output.</dd> + <dt id="daily_clean_tmps_enable"><var class="Va">daily_clean_tmps_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to clear temporary + directories daily.</dd> + <dt id="daily_clean_tmps_dirs"><var class="Va">daily_clean_tmps_dirs</var></dt> + <dd>(<var class="Vt">str</var>) Set to the list of directories to clear if + <var class="Va">daily_clean_tmps_enable</var> is set to + “<code class="Li">YES</code>”.</dd> + <dt id="daily_clean_tmps_days"><var class="Va">daily_clean_tmps_days</var></dt> + <dd>(<var class="Vt">num</var>) When + <var class="Va">daily_clean_tmps_enable</var> 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 is deleted.</dd> + <dt id="daily_clean_tmps_ignore"><var class="Va">daily_clean_tmps_ignore</var></dt> + <dd>(<var class="Vt">str</var>) Set to the list of files that should not be + deleted when <var class="Va">daily_clean_tmps_enable</var> is set to + “<code class="Li">YES</code>”. Wild card characters are + permitted.</dd> + <dt id="daily_clean_tmps_verbose"><var class="Va">daily_clean_tmps_verbose</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want the removed files + to be reported in your daily output.</dd> + <dt id="daily_clean_preserve_enable"><var class="Va">daily_clean_preserve_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you wish to remove old + files from <span class="Pa">/var/preserve</span>.</dd> + <dt id="daily_clean_preserve_days"><var class="Va">daily_clean_preserve_days</var></dt> + <dd>(<var class="Vt">num</var>) Set to the number of days that files must not + have been modified before they are deleted.</dd> + <dt id="daily_clean_preserve_verbose"><var class="Va">daily_clean_preserve_verbose</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want the removed files + to be reported in your daily output.</dd> + <dt id="daily_clean_msgs_enable"><var class="Va">daily_clean_msgs_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you wish old system + messages to be purged.</dd> + <dt id="daily_clean_msgs_days"><var class="Va">daily_clean_msgs_days</var></dt> + <dd>(<var class="Vt">num</var>) Set to the number of days that files must not + have been modified before they are deleted. If this variable is left + blank, the <a class="Xr">msgs(1)</a> default is used.</dd> + <dt id="daily_clean_rwho_enable"><var class="Va">daily_clean_rwho_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you wish old files in + <span class="Pa">/var/who</span> to be purged.</dd> + <dt id="daily_clean_rwho_days"><var class="Va">daily_clean_rwho_days</var></dt> + <dd>(<var class="Vt">num</var>) Set to the number of days that files must not + have been modified before they are deleted.</dd> + <dt id="daily_clean_rwho_verbose"><var class="Va">daily_clean_rwho_verbose</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want the removed files + to be reported in your daily output.</dd> + <dt id="daily_clean_hoststat_enable"><var class="Va">daily_clean_hoststat_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to run + <code class="Nm">sendmail</code> <code class="Fl">-bH</code> to + automatically purge stale entries from <a class="Xr">sendmail(8)</a>'s + host status cache. Files will be deleted using the same criteria as + <a class="Xr">sendmail(8)</a> would normally use when determining whether + to believe the cached information, as configured in + <span class="Pa">/etc/mail/sendmail.cf</span>.</dd> + <dt id="daily_backup_efi_enable"><var class="Va">daily_backup_efi_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to create backup of EFI System + Partition (ESP).</dd> + <dt id="daily_backup_gmirror_enable"><var class="Va">daily_backup_gmirror_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to create backup of gmirror + information (i.e., output of <code class="Nm">gmirror</code> + <code class="Cm">list</code>), see <a class="Xr">gmirror(8)</a>.</dd> + <dt id="daily_backup_gmirror_verbose"><var class="Va">daily_backup_gmirror_verbose</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to report a diff between the + new backup and the existing backup in the daily output.</dd> + <dt id="daily_backup_gpart_enable"><var class="Va">daily_backup_gpart_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to create backups of partition + tables, and bootcode partition contents.</dd> + <dt id="daily_backup_gpart_verbose"><var class="Va">daily_backup_gpart_verbose</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to be verbose if existing + backups for kern.geom.conftxt or the partition tables differ from the new + backups.</dd> + <dt id="daily_backup_passwd_enable"><var class="Va">daily_backup_passwd_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want the + <span class="Pa">/etc/master.passwd</span> and + <span class="Pa">/etc/group</span> files backed up and reported on. + Reporting consists of checking both files for modifications and running + <a class="Xr">chkgrp(8)</a> on the <span class="Pa">group</span> + file.</dd> + <dt id="daily_backup_aliases_enable"><var class="Va">daily_backup_aliases_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want the + <span class="Pa">/etc/mail/aliases</span> file backed up and modifications + to be displayed in your daily output.</dd> + <dt id="daily_backup_zfs_enable"><var class="Va">daily_backup_zfs_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to create backup of the output + generated from the <a class="Xr">zfs-list(8)</a> and + <a class="Xr">zpool-list(8)</a> utilities.</dd> + <dt id="daily_backup_zfs_list_flags"><var class="Va">daily_backup_zfs_list_flags</var></dt> + <dd>(<var class="Vt">str</var>) Set to the arguments for the + <a class="Xr">zfs-list(8)</a> utility. The default is standard + behavior.</dd> + <dt id="daily_backup_zpool_list_flags"><var class="Va">daily_backup_zpool_list_flags</var></dt> + <dd>(<var class="Vt">str</var>) Set to the arguments for the + <a class="Xr">zpool-list(8)</a> utility. The default is + <code class="Fl">-v</code>.</dd> + <dt id="daily_backup_zfs_props_enable"><var class="Va">daily_backup_zfs_props_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to create backup of the output + generated from the <a class="Xr">zfs-get(8)</a> and + <a class="Xr">zpool-get(8)</a> utilities.</dd> + <dt id="daily_backup_zfs_get_flags"><var class="Va">daily_backup_zfs_get_flags</var></dt> + <dd>(<var class="Vt">str</var>) Set to the arguments for the + <a class="Xr">zfs-get(8)</a> utility. The default is + <code class="Cm">all</code>.</dd> + <dt id="daily_backup_zpool_get_flags"><var class="Va">daily_backup_zpool_get_flags</var></dt> + <dd>(<var class="Vt">str</var>) Set to the arguments for the + <a class="Xr">zpool-get(8)</a> utility. The default is + <code class="Cm">all</code>.</dd> + <dt id="daily_backup_zfs_verbose"><var class="Va">daily_backup_zfs_verbose</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to report a diff between the + new backup and the existing backup in the daily output.</dd> + <dt id="daily_calendar_enable"><var class="Va">daily_calendar_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <code class="Nm">calendar</code> <code class="Fl">-a</code> daily.</dd> + <dt id="daily_accounting_enable"><var class="Va">daily_accounting_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to rotate your + daily process accounting files. No rotations are necessary unless + <var class="Va">accounting_enable</var> is enabled in + <a class="Xr">rc.conf(5)</a>.</dd> + <dt id="daily_accounting_compress"><var class="Va">daily_accounting_compress</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want your daily + accounting files to be compressed using <a class="Xr">gzip(1)</a>.</dd> + <dt id="daily_accounting_save"><var class="Va">daily_accounting_save</var></dt> + <dd>(<var class="Vt">num</var>) When + <var class="Va">daily_accounting_enable</var> is set, this may also be set + to the number of daily accounting files that are to be saved. The default + is “<code class="Li">3</code>”.</dd> + <dt id="daily_accounting_flags"><var class="Va">daily_accounting_flags</var></dt> + <dd>(<var class="Vt">str</var>) Set to the arguments to pass to the + <a class="Xr">sa(8)</a> utility (in addition to + <code class="Fl">-s</code>) when + <var class="Va">daily_accounting_enable</var> is set to + “<code class="Li">YES</code>”. The default is + <code class="Fl">-q</code>.</dd> + <dt id="daily_status_disks_enable"><var class="Va">daily_status_disks_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <a class="Xr">df(1)</a> (with the arguments supplied in + <var class="Va">daily_status_disks_df_flags</var>) and + <code class="Nm">dump</code> <code class="Fl">-W</code>.</dd> + <dt id="daily_status_disks_df_flags"><var class="Va">daily_status_disks_df_flags</var></dt> + <dd>(<var class="Vt">str</var>) Set to the arguments for the + <a class="Xr">df(1)</a> utility when + <var class="Va">daily_status_disks_enable</var> is set to + “<code class="Li">YES</code>”. The default is + <code class="Fl">-l</code> <code class="Fl">-h</code>.</dd> + <dt id="daily_status_zfs_enable"><var class="Va">daily_status_zfs_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <code class="Nm">zpool</code> <code class="Cm">status</code> on your + <a class="Xr">zfs(8)</a> pools.</dd> + <dt id="daily_status_zfs_zpool_list_enable"><var class="Va">daily_status_zfs_zpool_list_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <code class="Nm">zpool</code> <code class="Cm">list</code> on your + <a class="Xr">zfs(8)</a> pools. Requires + <var class="Va">daily_status_zfs_enable</var> to be set to + <code class="Li">YES</code>.</dd> + <dt id="daily_status_gmirror_enable"><var class="Va">daily_status_gmirror_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <code class="Nm">gmirror</code> <code class="Cm">status</code> on your + <a class="Xr">gmirror(8)</a> devices.</dd> + <dt id="daily_status_graid3_enable"><var class="Va">daily_status_graid3_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <code class="Nm">graid3</code> <code class="Cm">status</code> on your + <a class="Xr">graid3(8)</a> devices.</dd> + <dt id="daily_status_gstripe_enable"><var class="Va">daily_status_gstripe_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <code class="Nm">gstripe</code> <code class="Cm">status</code> on your + <a class="Xr">gstripe(8)</a> devices.</dd> + <dt id="daily_status_gconcat_enable"><var class="Va">daily_status_gconcat_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <code class="Nm">gconcat</code> <code class="Cm">status</code> on your + <a class="Xr">gconcat(8)</a> devices.</dd> + <dt id="daily_status_mfi_enable"><var class="Va">daily_status_mfi_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <code class="Nm">mfiutil</code> <code class="Cm">status</code> on your + <a class="Xr">mfi(4)</a> devices.</dd> + <dt id="daily_status_network_enable"><var class="Va">daily_status_network_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <code class="Nm">netstat</code> <code class="Fl">-i</code>.</dd> + <dt id="daily_status_network_netstat_flags"><var class="Va">daily_status_network_netstat_flags</var></dt> + <dd>(<var class="Vt">str</var>) Set to additional arguments for the + <a class="Xr">netstat(1)</a> utility when + <var class="Va">daily_status_network_enable</var> is set to + “<code class="Li">YES</code>”. The default is + <code class="Fl">-d</code> <code class="Fl">-W</code>.</dd> + <dt id="daily_status_network_usedns"><var class="Va">daily_status_network_usedns</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <a class="Xr">netstat(1)</a> without the <code class="Fl">-n</code> option + (to do DNS lookups).</dd> + <dt id="daily_status_uptime_enable"><var class="Va">daily_status_uptime_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <a class="Xr">uptime(1)</a> (or <a class="Xr">ruptime(1)</a> if + <var class="Va">rwhod_enable</var> is set to + “<code class="Li">YES</code>” in + <span class="Pa">/etc/rc.conf</span>).</dd> + <dt id="daily_status_mailq_enable"><var class="Va">daily_status_mailq_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <a class="Xr">mailq(1)</a>.</dd> + <dt id="daily_status_mailq_shorten"><var class="Va">daily_status_mailq_shorten</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to shorten the + <a class="Xr">mailq(1)</a> output when + <var class="Va">daily_status_mailq_enable</var> is set to + “<code class="Li">YES</code>”.</dd> + <dt id="daily_status_include_submit_mailq"><var class="Va">daily_status_include_submit_mailq</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you also want to run + <a class="Xr">mailq(1)</a> on the submit mail queue when + <var class="Va">daily_status_mailq_enable</var> is set to + “<code class="Li">YES</code>”. This may not work with MTAs + other than <a class="Xr">sendmail(8)</a>.</dd> + <dt id="daily_status_security_enable"><var class="Va">daily_status_security_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run the + security check. The security check is another set of + <a class="Xr">periodic(8)</a> scripts. The system defaults are in + <span class="Pa">/etc/periodic/security</span>. Local scripts should be + placed in <span class="Pa">/usr/local/etc/periodic/security</span>. See + the <a class="Xr">periodic(8)</a> manual page for more information.</dd> + <dt id="daily_status_security_inline"><var class="Va">daily_status_security_inline</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want the security check + output inline. The default is to either mail or log the output according + to the value of <var class="Va">daily_status_security_output</var>.</dd> + <dt id="daily_status_security_output"><var class="Va">daily_status_security_output</var></dt> + <dd>(<var class="Vt">str</var>) Where to send the output of the security check + if <var class="Va">daily_status_security_inline</var> is set to + “<code class="Li">NO</code>”. This variable behaves in the + same way as the <var class="Va">*_output</var> variables above, namely it + can be set either to one or more email addresses or to an absolute file + name.</dd> + <dt id="daily_status_mail_rejects_enable"><var class="Va">daily_status_mail_rejects_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to summarise mail + rejections logged to <span class="Pa">/var/log/maillog</span> for the + previous day.</dd> + <dt id="daily_status_mail_rejects_logs"><var class="Va">daily_status_mail_rejects_logs</var></dt> + <dd>(<var class="Vt">num</var>) Set to the number of maillog files that should + be checked for yesterday's mail rejects.</dd> + <dt id="daily_status_ntpd_enable"><var class="Va">daily_status_ntpd_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to enable NTP + status check.</dd> + <dt id="daily_status_world_kernel"><var class="Va">daily_status_world_kernel</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to check the running userland + and kernel are in sync.</dd> + <dt id="daily_queuerun_enable"><var class="Va">daily_queuerun_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to manually run + the mail queue at least once a day.</dd> + <dt id="daily_submit_queuerun"><var class="Va">daily_submit_queuerun</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you also want to manually + run the submit mail queue at least once a day when + <var class="Va">daily_queuerun_enable</var> is set to + “<code class="Li">YES</code>”.</dd> + <dt id="daily_scrub_zfs_enable"><var class="Va">daily_scrub_zfs_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run a zfs scrub + periodically.</dd> + <dt id="daily_scrub_zfs_pools"><var class="Va">daily_scrub_zfs_pools</var></dt> + <dd>(<var class="Vt">str</var>) A space separated list of names of zfs pools + to scrub. If the list is empty or not set, all zfs pools are + scrubbed.</dd> + <dt id="daily_scrub_zfs_default_threshold"><var class="Va">daily_scrub_zfs_default_threshold</var></dt> + <dd>(<var class="Vt">int</var>) Number of days between a scrub if no + pool-specific threshold is set. If not set, the default value is 35, + corresponding to 5 weeks.</dd> + <dt id="daily_scrub_zfs_"><var class="Va">daily_scrub_zfs_</var>⟨<var class="Ar">poolname</var>⟩<var class="Va">_threshold</var></dt> + <dd>(<var class="Vt">int</var>) The same as + <var class="Va">daily_scrub_zfs_default_threshold</var> but specific to + the pool ⟨<var class="Ar">poolname</var>⟩.</dd> + <dt id="daily_trim_zfs_enable"><var class="Va">daily_trim_zfs_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run a zfs trim + daily.</dd> + <dt id="daily_trim_zfs_pools"><var class="Va">daily_trim_zfs_pools</var></dt> + <dd>(<var class="Vt">str</var>) A space separated list of names of zfs pools + to trim. If the list is empty or not set, all zfs pools are trimmed.</dd> + <dt id="daily_local"><var class="Va">daily_local</var></dt> + <dd>(<var class="Vt">str</var>) Set to a list of extra scripts that should be + run after all other daily scripts. All scripts must be absolute path + names.</dd> + <dt id="daily_diff_flags"><var class="Va">daily_diff_flags</var></dt> + <dd>(<var class="Vt">str</var>) Set to the arguments to pass to the + <a class="Xr">diff(1)</a> utility when generating differences. The default + is <code class="Fl">-b</code> <code class="Fl">-U</code> + <code class="Cm">0</code>.</dd> +</dl> +</div> +<p class="Pp">The following variables are used by the standard scripts that + reside in <span class="Pa">/etc/periodic/weekly</span>:</p> +<div class="Bd-indent"> +<dl class="Bl-tag"> + <dt id="weekly_locate_enable"><var class="Va">weekly_locate_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <span class="Pa">/usr/libexec/locate.updatedb</span>. This script is run + using <code class="Nm">nice</code> <code class="Fl">-5</code> as user + “<code class="Li">nobody</code>”, and generates the table + used by the <a class="Xr">locate(1)</a> command.</dd> + <dt id="weekly_whatis_enable"><var class="Va">weekly_whatis_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to run + <span class="Pa">/usr/libexec/makewhatis.local</span>. This script + regenerates the database used by the <a class="Xr">apropos(1)</a> + command.</dd> + <dt id="weekly_noid_enable"><var class="Va">weekly_noid_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to locate orphaned + files on the system. An orphaned file is one with an invalid owner or + group.</dd> + <dt id="weekly_noid_dirs"><var class="Va">weekly_noid_dirs</var></dt> + <dd>(<var class="Vt">str</var>) A list of directories under which orphaned + files are searched for. This would usually be set to + <span class="Pa">/</span>.</dd> + <dt id="weekly_status_security_enable"><var class="Va">weekly_status_security_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Weekly counterpart of + <var class="Va">daily_status_security_enable</var>.</dd> + <dt id="weekly_status_security_inline"><var class="Va">weekly_status_security_inline</var></dt> + <dd>(<var class="Vt">bool</var>) Weekly counterpart of + <var class="Va">daily_status_security_inline</var>.</dd> + <dt id="weekly_status_security_output"><var class="Va">weekly_status_security_output</var></dt> + <dd>(<var class="Vt">str</var>) Weekly counterpart of + <var class="Va">daily_status_security_output</var>.</dd> + <dt id="weekly_status_pkg_enable"><var class="Va">weekly_status_pkg_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to use + <a class="Xr">pkg-version(8)</a> to list installed packages which are out + of date.</dd> + <dt id="pkg_version"><var class="Va">pkg_version</var></dt> + <dd>(<var class="Vt">str</var>) When + <var class="Va">weekly_status_pkg_enable</var> is set to + “<code class="Li">YES</code>”, this variable specifies the + program that is used to determine the out of date packages. If unset, the + <a class="Xr">pkg-version(8)</a> program is used. As an example, this + variable might be set to + “<code class="Li">portversion</code>” if the + <span class="Pa">ports/sysutils/portupgrade</span> port has been + installed.</dd> + <dt id="pkg_version_index"><var class="Va">pkg_version_index</var></dt> + <dd>(<var class="Vt">str</var>) This variable specifies the + <span class="Pa">INDEX</span> file from <span class="Pa">/usr/ports</span> + that should be used by <a class="Xr">pkg-version(8)</a>. Because the + dependency tree may be substantially different between versions of + <span class="Ux">FreeBSD</span>, there may be more than one + <span class="Pa">INDEX</span> file in <span class="Pa">/usr/ports</span>. + <p class="Pp">Note, if the <var class="Va">pkg_version</var> variable is set + to “<code class="Li">portversion</code>”, it will also be + necessary to arrange that the correct <span class="Pa">INDEX</span> file + is specified using environment variables and that + <var class="Va">pkg_version_index</var> is cleared in + <span class="Pa">/etc/periodic.conf</span> + (“<code class="Li">pkg_version_index=</code>”).</p> + </dd> + <dt id="weekly_local"><var class="Va">weekly_local</var></dt> + <dd>(<var class="Vt">str</var>) Set to a list of extra scripts that should be + run after all other weekly scripts. All scripts must be absolute path + names.</dd> +</dl> +</div> +<p class="Pp">The following variables are used by the standard scripts that + reside in <span class="Pa">/etc/periodic/monthly</span>:</p> +<div class="Bd-indent"> +<dl class="Bl-tag"> + <dt id="monthly_accounting_enable"><var class="Va">monthly_accounting_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to do login + accounting using the <a class="Xr">ac(8)</a> command.</dd> + <dt id="monthly_status_security_enable"><var class="Va">monthly_status_security_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Monthly counterpart of + <var class="Va">daily_status_security_enable</var>.</dd> + <dt id="monthly_status_security_inline"><var class="Va">monthly_status_security_inline</var></dt> + <dd>(<var class="Vt">bool</var>) Monthly counterpart of + <var class="Va">daily_status_security_inline</var>.</dd> + <dt id="monthly_status_security_output"><var class="Va">monthly_status_security_output</var></dt> + <dd>(<var class="Vt">str</var>) Monthly counterpart of + <var class="Va">daily_status_security_output</var>.</dd> + <dt id="monthly_local"><var class="Va">monthly_local</var></dt> + <dd>(<var class="Vt">str</var>) Set to a list of extra scripts that should be + run after all other monthly scripts. All scripts must be absolute path + names.</dd> +</dl> +</div> +<p class="Pp">The following variables are used by the standard scripts that + reside in <span class="Pa">/etc/periodic/security</span>. Those scripts are + usually run from daily (<var class="Va">daily_status_security_enable</var>), + weekly (<var class="Va">weekly_status_security_enable</var>), and monthly + (<var class="Va">monthly_status_security_enable</var>) periodic hooks. The + <var class="Va">..._period</var> of each script can be configured as + “daily”, “weekly”, “monthly” or + “NO”. Note that when periodic security scripts are run from + <a class="Xr">crontab(5)</a>, they will be always run unless their + <var class="Va">..._enable</var> or <var class="Va">..._period</var> + variable is set to “NO”.</p> +<div class="Bd-indent"> +<dl class="Bl-tag"> + <dt id="security_status_diff_flags"><var class="Va">security_status_diff_flags</var></dt> + <dd>(<var class="Vt">str</var>) Set to the arguments to pass to the + <a class="Xr">diff(1)</a> utility when generating differences. The default + is <code class="Fl">-b</code> <code class="Fl">-U</code> + <code class="Cm">0</code>.</dd> + <dt id="security_status_chksetuid_enable"><var class="Va">security_status_chksetuid_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to compare the modes and + modification times of setuid executables with the previous day's + values.</dd> + <dt id="security_status_chksetuid_period"><var class="Va">security_status_chksetuid_period</var></dt> + <dd>(<var class="Vt">str</var>) Set to either + “<code class="Li">daily</code>”, + “<code class="Li">weekly</code>”, + “<code class="Li">monthly</code>” or + “<code class="Li">NO</code>”.</dd> + <dt id="security_status_chkportsum_enable"><var class="Va">security_status_chkportsum_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to verify checksums of all + installed packages against the known checksums in + <span class="Pa">/var/db/pkg</span>.</dd> + <dt id="security_status_chkportsum_period"><var class="Va">security_status_chkportsum_period</var></dt> + <dd>(<var class="Vt">str</var>) Set to either + “<code class="Li">daily</code>”, + “<code class="Li">weekly</code>”, + “<code class="Li">monthly</code>” or + “<code class="Li">NO</code>”.</dd> + <dt id="security_status_neggrpperm_enable"><var class="Va">security_status_neggrpperm_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to check for files where the + group of a file has less permissions than the world at large. When users + are in more than 14 supplemental groups these negative permissions may not + be enforced via NFS shares.</dd> + <dt id="security_status_neggrpperm_period"><var class="Va">security_status_neggrpperm_period</var></dt> + <dd>(<var class="Vt">str</var>) Set to either + “<code class="Li">daily</code>”, + “<code class="Li">weekly</code>”, + “<code class="Li">monthly</code>” or + “<code class="Li">NO</code>”.</dd> + <dt id="security_status_chkmounts_enable"><var class="Va">security_status_chkmounts_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to check for changes mounted + file systems to the previous day's values.</dd> + <dt id="security_status_chkmounts_period"><var class="Va">security_status_chkmounts_period</var></dt> + <dd>(<var class="Vt">str</var>) Set to either + “<code class="Li">daily</code>”, + “<code class="Li">weekly</code>”, + “<code class="Li">monthly</code>” or + “<code class="Li">NO</code>”.</dd> + <dt id="security_status_noamd"><var class="Va">security_status_noamd</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” if you want to ignore + <a class="Xr">amd(8)</a> mounts when comparing against yesterday's file + system mounts in the + <var class="Va">security_status_chkmounts_enable</var> check.</dd> + <dt id="security_status_chkuid0_enable"><var class="Va">security_status_chkuid0_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to check + <span class="Pa">/etc/master.passwd</span> for accounts with UID 0.</dd> + <dt id="security_status_chkuid0_period"><var class="Va">security_status_chkuid0_period</var></dt> + <dd>(<var class="Vt">str</var>) Set to either + “<code class="Li">daily</code>”, + “<code class="Li">weekly</code>”, + “<code class="Li">monthly</code>” or + “<code class="Li">NO</code>”.</dd> + <dt id="security_status_passwdless_enable"><var class="Va">security_status_passwdless_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to check + <span class="Pa">/etc/master.passwd</span> for accounts with empty + passwords.</dd> + <dt id="security_status_passwdless_period"><var class="Va">security_status_passwdless_period</var></dt> + <dd>(<var class="Vt">str</var>) Set to either + “<code class="Li">daily</code>”, + “<code class="Li">weekly</code>”, + “<code class="Li">monthly</code>” or + “<code class="Li">NO</code>”.</dd> + <dt id="security_status_logincheck_enable"><var class="Va">security_status_logincheck_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to check + <span class="Pa">/etc/login.conf</span> ownership, see + <a class="Xr">login.conf(5)</a> for more information.</dd> + <dt id="security_status_logincheck_period"><var class="Va">security_status_logincheck_period</var></dt> + <dd>(<var class="Vt">str</var>) Set to either + “<code class="Li">daily</code>”, + “<code class="Li">weekly</code>”, + “<code class="Li">monthly</code>” or + “<code class="Li">NO</code>”.</dd> + <dt id="security_status_ipfwdenied_enable"><var class="Va">security_status_ipfwdenied_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to show log entries for + packets denied by <a class="Xr">ipfw(8)</a> since yesterday's check.</dd> + <dt id="security_status_ipfwdenied_period"><var class="Va">security_status_ipfwdenied_period</var></dt> + <dd>(<var class="Vt">str</var>) Set to either + “<code class="Li">daily</code>”, + “<code class="Li">weekly</code>”, + “<code class="Li">monthly</code>” or + “<code class="Li">NO</code>”.</dd> + <dt id="security_status_ipfdenied_enable"><var class="Va">security_status_ipfdenied_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to show log entries for + packets denied by <a class="Xr">ipf(8)</a> since yesterday's check.</dd> + <dt id="security_status_ipfdenied_period"><var class="Va">security_status_ipfdenied_period</var></dt> + <dd>(<var class="Vt">str</var>) Set to either + “<code class="Li">daily</code>”, + “<code class="Li">weekly</code>”, + “<code class="Li">monthly</code>” or + “<code class="Li">NO</code>”.</dd> + <dt id="security_status_pfdenied_enable"><var class="Va">security_status_pfdenied_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to show log entries for + packets denied by <a class="Xr">pf(4)</a> since yesterday's check.</dd> + <dt id="security_status_pfdenied_additionalanchors"><var class="Va">security_status_pfdenied_additionalanchors</var></dt> + <dd>(<var class="Vt">str</var>) Space-separated list of additional anchors + whose denied packets log entries to show. The main ruleset (i.e., the + empty-string anchor) and any <a class="Xr">blocklistd(8)</a> anchors, if + present, are always shown.</dd> + <dt id="security_status_pfdenied_period"><var class="Va">security_status_pfdenied_period</var></dt> + <dd>(<var class="Vt">str</var>) Set to either + “<code class="Li">daily</code>”, + “<code class="Li">weekly</code>”, + “<code class="Li">monthly</code>” or + “<code class="Li">NO</code>”.</dd> + <dt id="security_status_ipfwlimit_enable"><var class="Va">security_status_ipfwlimit_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to display + <a class="Xr">ipfw(8)</a> rules that have reached their verbosity + limit.</dd> + <dt id="security_status_ipfwlimit_period"><var class="Va">security_status_ipfwlimit_period</var></dt> + <dd>(<var class="Vt">str</var>) Set to either + “<code class="Li">daily</code>”, + “<code class="Li">weekly</code>”, + “<code class="Li">monthly</code>” or + “<code class="Li">NO</code>”.</dd> + <dt id="security_status_kernelmsg_enable"><var class="Va">security_status_kernelmsg_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to show new + <a class="Xr">dmesg(8)</a> entries since yesterday's check.</dd> + <dt id="security_status_kernelmsg_period"><var class="Va">security_status_kernelmsg_period</var></dt> + <dd>(<var class="Vt">str</var>) Set to either + “<code class="Li">daily</code>”, + “<code class="Li">weekly</code>”, + “<code class="Li">monthly</code>” or + “<code class="Li">NO</code>”.</dd> + <dt id="security_status_loginfail_enable"><var class="Va">security_status_loginfail_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to display failed logins from + <span class="Pa">/var/log/messages</span> in the previous day.</dd> + <dt id="security_status_loginfail_period"><var class="Va">security_status_loginfail_period</var></dt> + <dd>(<var class="Vt">str</var>) Set to either + “<code class="Li">daily</code>”, + “<code class="Li">weekly</code>”, + “<code class="Li">monthly</code>” or + “<code class="Li">NO</code>”.</dd> + <dt id="security_status_tcpwrap_enable"><var class="Va">security_status_tcpwrap_enable</var></dt> + <dd>(<var class="Vt">bool</var>) Set to + “<code class="Li">YES</code>” to display connections denied + by tcpwrappers (see <a class="Xr">hosts_access(5)</a>) from + <span class="Pa">/var/log/messages</span> during the previous day.</dd> + <dt id="security_status_tcpwrap_period"><var class="Va">security_status_tcpwrap_period</var></dt> + <dd>(<var class="Vt">str</var>) Set to either + “<code class="Li">daily</code>”, + “<code class="Li">weekly</code>”, + “<code class="Li">monthly</code>” or + “<code class="Li">NO</code>”.</dd> +</dl> +</div> +</section> +<section class="Sh"> +<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1> +<dl class="Bl-tag"> + <dt><span class="Pa">/etc/defaults/periodic.conf</span></dt> + <dd>The default configuration file. This file contains all default variables + and values.</dd> + <dt><span class="Pa">/etc/periodic.conf</span></dt> + <dd>The usual system specific variable override file.</dd> + <dt><span class="Pa">/etc/periodic.conf.local</span></dt> + <dd>An additional override file, useful when + <span class="Pa">/etc/periodic.conf</span> is shared or distributed.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">apropos(1)</a>, <a class="Xr">calendar(1)</a>, + <a class="Xr">df(1)</a>, <a class="Xr">diff(1)</a>, + <a class="Xr">gzip(1)</a>, <a class="Xr">locate(1)</a>, + <a class="Xr">man(1)</a>, <a class="Xr">msgs(1)</a>, + <a class="Xr">netstat(1)</a>, <a class="Xr">nice(1)</a>, + <a class="Xr">login.conf(5)</a>, <a class="Xr">rc.conf(5)</a>, + <a class="Xr">ac(8)</a>, <a class="Xr">chkgrp(8)</a>, + <a class="Xr">dump(8)</a>, <a class="Xr">newsyslog(8)</a>, + <a class="Xr">periodic(8)</a>, <a class="Xr">pkg-version(8)</a>, + <a class="Xr">sendmail(8)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">The <code class="Nm">periodic.conf</code> file appeared in + <span class="Ux">FreeBSD 4.1</span>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<p class="Pp"><span class="An">Brian Somers</span> + <<a class="Mt" href="mailto:brian@Awfulhak.org">brian@Awfulhak.org</a>></p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">April 9, 2024</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |