Subject: misc/22229: man page for locate database building tools
To: None <gnats-bugs@gnats.netbsd.org>
From: None <reed@reedmedia.net>
List: netbsd-bugs
Date: 07/22/2003 23:49:11
>Number:         22229
>Category:       misc
>Synopsis:       man page for locate database building tools
>Confidential:   yes
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people
>State:          open
>Class:          change-request
>Submitter-Id:   net
>Arrival-Date:   Wed Jul 23 06:50:00 UTC 2003
>Closed-Date:
>Last-Modified:
>Originator:     
>Release:        NetBSD 1.6
>Organization:
http://bsd.reedmedia.net/
>Environment:
	
	
System: NetBSD rainier.reedmedia.net 1.6 NetBSD 1.6 (JCR-20020927) #3: Sat Sep 28 13:40:20 PDT 2002 reed@rainier.reedmedia.net:/usr/src/sys/arch/i386/compile/JCR-20020927 i386
Architecture: i386
Machine: i386
>Description:
	
>How-To-Repeat:
man locate.updatedb
>Fix:
Please consider the following for locate.updatedb(8)
and links for locate.code and locate.bigram:
(You may keep the AUTHOR commented out if you wish.)

.\"	$NetBSD$
.Dd July 22, 2003
.Dt UPDATEDB 8
.Os
.Sh NAME
.Nm locate.bigram ,
.Nm locate.code ,
.Nm locate.updatedb
.Nd build locate database
.Sh SYNOPSIS
.Nm locate.bigram
.Nm locate.code
.Ar common_bigrams_file
.Nm locate.updatedb
.Sh DESCRIPTION
The
.Nm locate.updatedb
utility creates the
.Xr locate 1
database.
It builds a file list and then uses the
.Nm locate.bigram
and
.Nm locate.code
utilities to generate this pathnames database.
(This script is usually run from the
.Xr weekly 8
maintenance script.)
.Pp
.Nm locate.bigram
reads the list of filenames from standard input and outputs
the list of bigrams.
(A bigram is a two-character sequence,
the first 128 most common of which are encoded in one byte.)
.Pp
.Nm locate.code
is a sorted list compressor which encodes the final data file
using front compression.
It uses the
.Ar common_bigrams_file
and reads in the list of filenames from standard input and outputs
the database.
.Sh FILES
.Bl -tag -width "/var/db/locate.database" -compact
.It Pa /var/db/locate.database
.Xr locate 1
pathnames database
.Sh SEE ALSO
.Xr locate 1 ,
.Xr weekly.conf 5
.Rs
.%A Woods, James A.
.%D 1983
.%T "Finding Files Fast"
.%J ";login"
.%V 8:1
.%P pp. 8-10
.Re
.\" .Sh STANDARDS
.\" Maybe should discuss new- and old-format and compare with GNU fileutils.
.Sh HISTORY
These utilities, originally known as
updatedb, bigram and code,
were written by James A. Woods in 1982
and appeared in
.Bx 4.4 .
.\" .Sh AUTHORS
.\" This manual page was written by Jeremy C. Reed.
>Release-Note:
>Audit-Trail:
>Unformatted: