xref: /netbsd-src/share/man/man5/weekly.5 (revision 46f5119e40af2e51998f686b2fdcc76b5488f7f3)
1.\"	$NetBSD: weekly.5,v 1.2 2011/05/03 16:25:19 jruoho 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 May 3, 2011
28.Dt WEEKLY 5
29.Os
30.Sh NAME
31.Nm weekly ,
32.Nm weekly.conf
33.Nd weekly maintenance
34.Sh DESCRIPTION
35The
36.Pa /etc/weekly
37script is run, by default, every Saturday morning on a
38.Nx
39system.
40The
41.Pa /etc/weekly.conf
42file specifies which of the standar
43.Nm
44services are performed.
45.Pp
46The variables described below can be set to
47.Dq YES
48or
49.Dq NO
50in the
51.Pa /etc/weekly.conf
52file.
53The default settings are in the
54.Pa /etc/defaults/weekly.conf
55file.
56(Note that you should never edit
57.Pa /etc/defaults/weekly.conf
58directly, as it is often replaced during system upgrades.)
59.Bl -tag -width rebuild_locatedb
60.It Sy rebuild_locatedb
61This rebuilds the
62.Xr locate 1
63database,
64.Pa /var/db/locate.database ,
65which must also exist, in order to be rebuilt.
66.It Sy rebuild_whatisdb
67This rebuilds the
68.Xr whatis 1
69database(s).
70Note that
71.Nx
72provides a default whatis.db for the system manual pages and
73this may not be needed.
74(Adjust your
75.Pa /etc/man.conf
76as necessary; see
77.Xr man.conf 5
78for details.)
79.El
80.Sh FILES
81.Bl -tag -width /etc/weekly.local -compact
82.It Pa /etc/weekly
83weekly maintenance script
84.It Pa /etc/weekly.conf
85weekly maintenance configuration
86.It Pa /etc/weekly.local
87local site additions to
88.Pa /etc/weekly
89.El
90.Sh SEE ALSO
91.Xr daily.conf 5 ,
92.Xr monthly.conf 5
93.Sh HISTORY
94The
95.Pa /etc/weekly
96script first appeared in
97.Bx 4.3 .
98The
99.Pa /etc/weekly.conf
100configuration file appeared in
101.Nx 1.3 .
102