summaryrefslogtreecommitdiffstats
path: root/apropos.1
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2011-11-20 15:43:14 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2011-11-20 15:43:14 +0000
commit8ff9b6d7b2b12cfb863578f68ec6572aa3f3d698 (patch)
treeef050ad362793a35f0d3a5b5c0f098cc1388d2d6 /apropos.1
parent739d6983d048fe131ded5ec372a95b930b72640d (diff)
downloadmandoc-8ff9b6d7b2b12cfb863578f68ec6572aa3f3d698.tar.gz
Integrate a moderately-patched version of schwarze@'s support for multiple
directories containing mandocdb(8) databases. Some changes follow: (1) don't support -M yet; (2) fall back to cwd if no prior manpath has been specified; (3) resolve manpages using realpath() to prevent consecutive chdir()'s over relative paths; (4) note where further error-reporting is required; (5) fix leaking memory on exit in several cases.
Diffstat (limited to 'apropos.1')
-rw-r--r--apropos.115
1 files changed, 12 insertions, 3 deletions
diff --git a/apropos.1 b/apropos.1
index 9de71454..839f22bb 100644
--- a/apropos.1
+++ b/apropos.1
@@ -19,22 +19,28 @@
.Os
.Sh NAME
.Nm apropos
-.Nd search the manual page database
+.Nd search manual page databases
.Sh SYNOPSIS
.Nm
+.Op Fl m Ar manpath
.Op Fl S Ar arch
.Op Fl s Ar section
.Ar expression...
.Sh DESCRIPTION
The
.Nm
-utility queries a manual page database generated by
+utility queries manual page databases generated by
.Xr mandocdb 8 ,
evaluating on
.Ar expression
-for each file in the database.
+for each file in each database.
Its arguments are as follows:
.Bl -tag -width Ds
+.It Fl m Ar manpath
+A colon-separated list of paths containing
+.Xr mandocdb 8
+databases.
+Paths may be relative or absolute.
.It Fl S Ar arch
Search only for a particular architecture.
.It Fl s Ar cat
@@ -105,6 +111,9 @@ is evaluated case-insensitively.
.Pp
By default,
.Nm
+searches for
+.Xr mandocdb 8
+database in the current working directory and
parses terms as case-sensitive regular expressions
.Pq the Li \&~ operator
over manual names and descriptions