document the defaults for the locate.updatedb(8) command line options
authorschwarze <schwarze@openbsd.org>
Sun, 8 Aug 2021 17:48:25 +0000 (17:48 +0000)
committerschwarze <schwarze@openbsd.org>
Sun, 8 Aug 2021 17:48:25 +0000 (17:48 +0000)
and make it clear that the config file *modifies* the defaults rather
than *control* them, and that having a config file is optional;
tweak and OK jmc@, OK tim@

usr.bin/locate/locate/locate.updatedb.8

index ce2fdbf..0408f39 100644 (file)
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: locate.updatedb.8,v 1.21 2021/08/07 11:23:07 schwarze Exp $
+.\"    $OpenBSD: locate.updatedb.8,v 1.22 2021/08/08 17:48:25 schwarze Exp $
 .\"
 .\" Copyright (c) 1996
 .\"    Mike Pritchard <mpp@FreeBSD.org>.  All rights reserved.
@@ -30,7 +30,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: August 7 2021 $
+.Dd $Mdocdate: August 8 2021 $
 .Dt LOCATE.UPDATEDB 8
 .Os
 .Sh NAME
@@ -63,16 +63,23 @@ send the database to the standard output.
 .It Fl \-filesystems
 A list of filesystem types to be traversed by
 .Xr find 1 .
+The default is
+.Eo \(aq ffs ufs Ec \(aq .
 .It Fl \-prunepaths
-Sets the list of parent directories that should not go in
-the database.
+Set the list of parent directories that should not go in the database.
+The default is
+.Eo \(aq Pa /tmp /var/tmp Ec \(aq .
 .It Fl \-searchpaths
-Sets the list of directories to be put in the database.
+Set the list of directories to be put in the database.
+The default is
+.Eo \(aq Pa / Ec \(aq .
 .It Fl \-tmpdir
-Sets the directory temporary files are stored in.
+Set the directory temporary files are stored in.
+The default is
+.Pa /tmp .
 .El
 .Pp
-The default settings are controlled by the configuration file
+The default settings are modified by the optional configuration file
 .Pa /etc/locate.rc .
 It is a
 .Xr sh 1