From nobody@FreeBSD.org  Sat Jun  2 02:17:54 2001
Return-Path: <nobody@FreeBSD.org>
Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21])
	by hub.freebsd.org (Postfix) with ESMTP id 6931A37B43C
	for <freebsd-gnats-submit@FreeBSD.org>; Sat,  2 Jun 2001 02:17:54 -0700 (PDT)
	(envelope-from nobody@FreeBSD.org)
Received: (from nobody@localhost)
	by freefall.freebsd.org (8.11.1/8.11.1) id f529HsH38695;
	Sat, 2 Jun 2001 02:17:54 -0700 (PDT)
	(envelope-from nobody)
Message-Id: <200106020917.f529HsH38695@freefall.freebsd.org>
Date: Sat, 2 Jun 2001 02:17:54 -0700 (PDT)
From: opentrax@email.com
To: freebsd-gnats-submit@FreeBSD.org
Subject: No man page for locate.rc
X-Send-Pr-Version: www-1.0

>Number:         27833
>Category:       docs
>Synopsis:       No man page for locate.rc
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    linimon
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat Jun 02 02:20:01 PDT 2001
>Closed-Date:    Mon Apr 03 21:55:52 GMT 2006
>Last-Modified:  Mon Apr 03 21:55:52 GMT 2006
>Originator:     Jesse Monroy, Jr.
>Release:        3.5.1
>Organization:
Digital Marshalls
>Environment:
FreeBSD spammie.svbug.com 3.5.1-RELEASE FreeBSD 3.5.1-RELEASE #0: Wed Sep 13 20:07:41 PDT 2000     jessem@spammie.svbug.com:/usr/src/sys/compile/GATEWAY  i386
>Description:
locate.updatedb(8) says the locate db can be controlled by
/etc/locate.rc. There is no example rc file, nor is locate.rc 
documented in a man page.
>How-To-Repeat:

>Fix:
Since locate.updatedb is a shell script, here are some notes to get
a man page started. Documenter please note you may
verify these notes by reading /usr/libexec/locate.updatedb
---------------------
/etc/locate.rc can be used to change the default behaviour
of locate.updatedb(8). Since, /usr/libexec/locate.updatedb is
a shell script, there are several parameters which
can be overwritten.  The following issues effect the out
come, or may give cause to use locate.rc:

o...Your system mounts more that ufs (Unix File System).
o...locate.updatedb support programs are not stored in 
    /usr/libexec:/bin:/usr/bin, or ${PATH} of user running 
    locate.updatedb
o...The database is not stored in the usual location (/var/db)
o...You want to setup locate(1) for a diskless system, systems that
    are chroot(2|8)'d, or systems that the default root directory is
    not '/'.
o...You want to exclude world readable directories, other than
    the usual temporary directories. (/tmp /usr/tmp /var/tmp)
o...You want to create a locate(1) database for a mountable
    file system, like nfs or cdrom.


Again, with the following parameters for locate.rc, write them
as sh(1) variables.

	LIBEXECDIR	Directory the subprograms are stored.
	TMPDIR		Temporary directory to use.
	FCODES		Final datbase name.
	SEARCHPATHS	The directories to put in the database.
	PRUNEPATHS	Paths you want to exclude from the database.
	FILESYSTEMS     The types of file systems you want to include.
                        (As a 'find' parameter)

The following parameter should not be changed, but are included
for completeness.

	mklocatedb	The program run to create the datebase.
	find		The program run to create the list of files
                        for the 'mklocatedb' program.

The following example script stores the database in
the file '/var/db/locate.cdrom'. It only searches the
directories below '/cdrom'. And it sets the file system
type to 'rdonly' (read only).
#
# Here is an example for a iso-9660 cdrom 
#
FCODES=/var/db/locate.cdrom
SEARCHPATHS=/cdrom
FILESYSTEMS=rdonly


See Also
	sh(1), locate.db(8), find(1), chroot(2), chroot(8)

>Release-Note:
>Audit-Trail:

From: Pete Fritchman <petef@databits.net>
To: opentrax@email.com
Cc: freebsd-gnats-submit@freebsd.org
Subject: Re: docs/27833: No man page for locate.rc
Date: Sat, 2 Jun 2001 10:20:40 -0400

 ++ 02/06/01 02:17 -0700 - opentrax@email.com:
 | /etc/locate.rc. There is no example rc file, nor is locate.rc 
 | documented in a man page.
 
 I have an /etc/locate.rc on 4-STABLE.  As well as
 /usr/share/examples/etc/locate.rc.  
 
 -pete
 
 --
 Pete Fritchman <petef@databits.net>
 Databits Network Services, Inc. <http://databits.net>
 finger petef@databits.net for PGP key
 
State-Changed-From-To: open->analyzed 
State-Changed-By: cjc 
State-Changed-When: Sat Dec 1 01:47:17 PST 2001 
State-Changed-Why:  
Either make a new locate.rc(5) or link it to the locate.updatedb(8) 
page and add some info there. But yes, locate.rc should be better 
documented. 


Responsible-Changed-From-To: freebsd-doc->cjc 
Responsible-Changed-By: cjc 
Responsible-Changed-When: Sat Dec 1 01:47:17 PST 2001 
Responsible-Changed-Why:  
I am doing some work on the locate(8)-system. 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=27833 
State-Changed-From-To: analyzed->feedback 
State-Changed-By: linimon 
State-Changed-When: Mon Apr 3 21:28:56 UTC 2006 
State-Changed-Why:  
Is this still applicable to modern versions of FreeBSD? 


Responsible-Changed-From-To: cjc->linimon 
Responsible-Changed-By: linimon 
Responsible-Changed-When: Mon Apr 3 21:28:56 UTC 2006 
Responsible-Changed-Why:  
Reset PR assigned to inactive committer who has not responded to email. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=27833 
State-Changed-From-To: feedback->closed 
State-Changed-By: linimon 
State-Changed-When: Mon Apr 3 21:55:37 UTC 2006 
State-Changed-Why:  
Submitter's email address bounces. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=27833 
>Unformatted:
