xref: /netbsd-src/share/man/man5/weekly.5 (revision 2985f26716009c28872fec4936ea68d959c166fa)
1*2985f267Swiz.\"	$NetBSD: weekly.5,v 1.5 2012/03/06 10:26:18 wiz Exp $
24811a796Sjruoho.\"
34811a796Sjruoho.\" Copyright (c) 1996 Matthew R. Green
44811a796Sjruoho.\" All rights reserved.
54811a796Sjruoho.\"
64811a796Sjruoho.\" Redistribution and use in source and binary forms, with or without
74811a796Sjruoho.\" modification, are permitted provided that the following conditions
84811a796Sjruoho.\" are met:
94811a796Sjruoho.\" 1. Redistributions of source code must retain the above copyright
104811a796Sjruoho.\"    notice, this list of conditions and the following disclaimer.
114811a796Sjruoho.\" 2. Redistributions in binary form must reproduce the above copyright
124811a796Sjruoho.\"    notice, this list of conditions and the following disclaimer in the
134811a796Sjruoho.\"    documentation and/or other materials provided with the distribution.
144811a796Sjruoho.\"
154811a796Sjruoho.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
164811a796Sjruoho.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
174811a796Sjruoho.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
184811a796Sjruoho.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
194811a796Sjruoho.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
204811a796Sjruoho.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
214811a796Sjruoho.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
224811a796Sjruoho.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
234811a796Sjruoho.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
244811a796Sjruoho.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
254811a796Sjruoho.\" SUCH DAMAGE.
264811a796Sjruoho.\"
27498fdc5aSplunky.Dd March 6, 2012
2863728753Sjruoho.Dt WEEKLY 5
294811a796Sjruoho.Os
304811a796Sjruoho.Sh NAME
3163728753Sjruoho.Nm weekly ,
324811a796Sjruoho.Nm weekly.conf
3363728753Sjruoho.Nd weekly maintenance
344811a796Sjruoho.Sh DESCRIPTION
354811a796SjruohoThe
364811a796Sjruoho.Pa /etc/weekly
374811a796Sjruohoscript is run, by default, every Saturday morning on a
384811a796Sjruoho.Nx
394811a796Sjruohosystem.
4063728753SjruohoThe
4163728753Sjruoho.Pa /etc/weekly.conf
42e0b81c69Smbalmerfile specifies which of the standard
4363728753Sjruoho.Nm
4463728753Sjruohoservices are performed.
454811a796Sjruoho.Pp
464811a796SjruohoThe variables described below can be set to
474811a796Sjruoho.Dq YES
484811a796Sjruohoor
494811a796Sjruoho.Dq NO
504811a796Sjruohoin the
514811a796Sjruoho.Pa /etc/weekly.conf
524811a796Sjruohofile.
534811a796SjruohoThe default settings are in the
544811a796Sjruoho.Pa /etc/defaults/weekly.conf
554811a796Sjruohofile.
564811a796Sjruoho(Note that you should never edit
574811a796Sjruoho.Pa /etc/defaults/weekly.conf
584811a796Sjruohodirectly, as it is often replaced during system upgrades.)
594811a796Sjruoho.Bl -tag -width rebuild_locatedb
604811a796Sjruoho.It Sy rebuild_locatedb
6163728753SjruohoThis rebuilds the
6263728753Sjruoho.Xr locate 1
6363728753Sjruohodatabase,
644811a796Sjruoho.Pa /var/db/locate.database ,
654811a796Sjruohowhich must also exist, in order to be rebuilt.
66498fdc5aSplunky.It Sy rebuild_mandb
67498fdc5aSplunkyThis rebuilds the
68498fdc5aSplunky.Xr apropos 1
69498fdc5aSplunkydatabase
70498fdc5aSplunky.Pa /var/db/man.db ,
71498fdc5aSplunkyusing
72498fdc5aSplunky.Xr makemandb 8
73498fdc5aSplunkywith the
74498fdc5aSplunky.Fl f
75498fdc5aSplunkyoption.
764811a796Sjruoho.It Sy rebuild_whatisdb
7763728753SjruohoThis rebuilds the
7863728753Sjruoho.Xr whatis 1
7963728753Sjruohodatabase(s).
804811a796SjruohoNote that
814811a796Sjruoho.Nx
824811a796Sjruohoprovides a default whatis.db for the system manual pages and
834811a796Sjruohothis may not be needed.
844811a796Sjruoho(Adjust your
854811a796Sjruoho.Pa /etc/man.conf
8663728753Sjruohoas necessary; see
874811a796Sjruoho.Xr man.conf 5
884811a796Sjruohofor details.)
894811a796Sjruoho.El
904811a796Sjruoho.Sh FILES
914811a796Sjruoho.Bl -tag -width /etc/weekly.local -compact
924811a796Sjruoho.It Pa /etc/weekly
934811a796Sjruohoweekly maintenance script
944811a796Sjruoho.It Pa /etc/weekly.conf
954811a796Sjruohoweekly maintenance configuration
964811a796Sjruoho.It Pa /etc/weekly.local
974811a796Sjruoholocal site additions to
984811a796Sjruoho.Pa /etc/weekly
994811a796Sjruoho.El
1004811a796Sjruoho.Sh SEE ALSO
1014811a796Sjruoho.Xr daily.conf 5 ,
1024811a796Sjruoho.Xr monthly.conf 5
1034811a796Sjruoho.Sh HISTORY
1044811a796SjruohoThe
10563728753Sjruoho.Pa /etc/weekly
10663728753Sjruohoscript first appeared in
10763728753Sjruoho.Bx 4.3 .
10863728753SjruohoThe
10963728753Sjruoho.Pa /etc/weekly.conf
11063728753Sjruohoconfiguration file appeared in
1114811a796Sjruoho.Nx 1.3 .
112