share/man/man5/weekly.conf.5

   1 .\"     $NetBSD: weekly.conf.5,v 1.9 2007/02/15 23:04:10 reed Exp $
   2 .\"
   3 .\" Copyright (c) 1996 Matthew R. Green
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  20 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  21 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  22 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  23 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .Dd February 15, 2007
  28 .Dt WEEKLY.CONF 5
  29 .Os
  30 .Sh NAME
  31 .Nm weekly.conf
  32 .Nd weekly maintenance configuration file
  33 .Sh DESCRIPTION
  34 The
  35 .Nm
  36 file specifies which of the standard
  37 .Pa /etc/weekly
  38 services are performed.  The
  39 .Pa /etc/weekly
  40 script is run, by default, every Saturday morning on a
  41 .Nx
  42 system.
  43 .Pp
  44 The variables described below can be set to
  45 .Dq YES
  46 or
  47 .Dq NO
  48 in the
  49 .Pa /etc/weekly.conf
  50 file.
  51 The default settings are in the
  52 .Pa /etc/defaults/weekly.conf
  53 file.
  54 (Note that you should never edit
  55 .Pa /etc/defaults/weekly.conf
  56 directly, as it is often replaced during system upgrades.)
  57 .Bl -tag -width rebuild_locatedb
  58 .It Sy rebuild_locatedb
  59 This rebuilds the locate database,
  60 .Pa /var/db/locate.database ,
  61 which must also exist, in order to be rebuilt.
  62 .It Sy rebuild_whatisdb
  63 This rebuilds the whatis database(s).
  64 Note that
  65 .Nx
  66 provides a default whatis.db for the system manual pages and
  67 this may not be needed.
  68 (Adjust your
  69 .Pa /etc/man.conf
  70 as necessary.
  71 See
  72 .Xr man.conf 5
  73 for details.)
  74 .El
  75 .Sh FILES
  76 .Bl -tag -width /etc/weekly.local -compact
  77 .It Pa /etc/weekly
  78 weekly maintenance script
  79 .It Pa /etc/weekly.conf
  80 weekly maintenance configuration
  81 .It Pa /etc/weekly.local
  82 local site additions to
  83 .Pa /etc/weekly
  84 .El
  85 .Sh SEE ALSO
  86 .Xr daily.conf 5 ,
  87 .Xr monthly.conf 5
  88 .Sh HISTORY
  89 The
  90 .Nm
  91 file appeared in
  92 .Nx 1.3 .