version 1.35, 2014/09/03 05:22:45 |
version 1.41, 2017/03/17 17:24:41 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2011, 2012, 2014, 2017 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
.Nd search manual page databases |
.Nd search manual page databases |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm |
.Nm |
.Op Fl acfhklVw |
.Op Fl acfhklw |
.Op Fl C Ar file |
.Op Fl C Ar file |
.Op Fl M Ar path |
.Op Fl M Ar path |
.Op Fl m Ar path |
.Op Fl m Ar path |
Line 79 to paginate them. |
|
Line 79 to paginate them. |
|
In |
In |
.Fl a |
.Fl a |
mode, the options |
mode, the options |
.Fl IOTW |
.Fl IKOTW |
described in the |
described in the |
.Xr mandoc 1 |
.Xr mandoc 1 |
manual are also available. |
manual are also available. |
Line 162 By default, pages from all sections are shown. |
|
Line 162 By default, pages from all sections are shown. |
|
See |
See |
.Xr man 1 |
.Xr man 1 |
for a listing of sections. |
for a listing of sections. |
.It Fl V |
|
Print version and exit. |
|
.It Fl w |
.It Fl w |
Instead of showing title lines, show the pathnames of the matching |
Instead of showing title lines, show the pathnames of the matching |
manual pages, just like |
manual pages, just like |
|
|
.Sm off |
.Sm off |
.Oo |
.Oo |
.Op Ar key Op , Ar key ... |
.Op Ar key Op , Ar key ... |
.Pq Cm = | ~ |
.Pq Cm = | \(ti |
.Oc |
.Oc |
.Ar val , |
.Ar val , |
.Sm on |
.Sm on |
Line 229 for a list of available keys. |
|
Line 227 for a list of available keys. |
|
Operator |
Operator |
.Cm = |
.Cm = |
evaluates a substring, while |
evaluates a substring, while |
.Cm ~ |
.Cm \(ti |
evaluates a regular expression. |
evaluates a regular expression. |
.It Fl i Ar term |
.It Fl i Ar term |
If |
If |
Line 239 is evaluated case-insensitively. |
|
Line 237 is evaluated case-insensitively. |
|
Has no effect on substring terms. |
Has no effect on substring terms. |
.El |
.El |
.Pp |
.Pp |
Results are sorted by manual sections and names, with output formatted as |
Results are sorted according to the following criteria: |
|
.Bl -enum |
|
.It |
|
The manpath directory tree the page is found in, according to the |
|
order specified with |
|
.Fl M , |
|
.Fl m , |
|
the |
|
.Ev MANPATH |
|
environment variable, the |
|
.Xr man.conf 5 |
|
configuration file, or the default documented in |
|
.Xr man.conf 5 . |
|
.It |
|
The section number in ascending numerical order. |
|
.It |
|
The page name in ascending |
|
.Xr ascii 7 |
|
alphabetical order, case-insensitive. |
|
.El |
.Pp |
.Pp |
|
Each output line is formatted as |
|
.Pp |
.D1 name[, name...](sec) \- description |
.D1 name[, name...](sec) \- description |
.Pp |
.Pp |
Where |
Where |
Line 367 Specifies the pagination program to use when |
|
Line 386 Specifies the pagination program to use when |
|
.Ev MANPAGER |
.Ev MANPAGER |
is not defined. |
is not defined. |
If neither PAGER nor MANPAGER is defined, |
If neither PAGER nor MANPAGER is defined, |
.Pa /usr/bin/more Fl s |
.Xr more 1 |
|
.Fl s |
will be used. |
will be used. |
.El |
.El |
.Sh FILES |
.Sh FILES |
|
|
.Pp |
.Pp |
Search in names and descriptions using a regular expression: |
Search in names and descriptions using a regular expression: |
.Pp |
.Pp |
.Dl $ apropos '~set.?[ug]id' |
.Dl $ apropos \(aq\(tiset.?[ug]id\(aq |
.Pp |
.Pp |
Search for manuals in the library section mentioning both the |
Search for manuals in the library section mentioning both the |
.Qq optind |
.Qq optind |
Line 415 Do exactly the same as calling |
|
Line 435 Do exactly the same as calling |
|
with the argument |
with the argument |
.Qq ssh : |
.Qq ssh : |
.Pp |
.Pp |
.Dl $ apropos \-\- \-i 'Nm~[[:<:]]ssh[[:>:]]' |
.Dl $ apropos \-\- \-i \(aqNm\(ti[[:<:]]ssh[[:>:]]\(aq |
.Pp |
.Pp |
The following two invocations are equivalent: |
The following two invocations are equivalent: |
.Pp |
.Pp |
.D1 Li $ apropos -S Ar arch Li -s Ar section expression |
.D1 Li $ apropos -S Ar arch Li -s Ar section expression |
.Bd -ragged -offset indent |
.Bd -ragged -offset indent |
.Li $ apropos \e( Ar expression Li \e) |
.Li $ apropos \e( Ar expression Li \e) |
.Li -a arch~^( Ns Ar arch Ns Li |any)$ |
.Li -a arch\(ti^( Ns Ar arch Ns Li |any)$ |
.Li -a sec~^ Ns Ar section Ns Li $ |
.Li -a sec\(ti^ Ns Ar section Ns Li $ |
.Ed |
.Ed |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr man 1 , |
.Xr man 1 , |
|
|
.Ox 5.6 |
.Ox 5.6 |
for |
for |
.Nm whatis . |
.Nm whatis . |
|
The options |
|
.Fl acfhIKklOTWw |
|
appeared in |
|
.Ox 5.7 . |
.Sh AUTHORS |
.Sh AUTHORS |
.An -nosplit |
.An -nosplit |
.An Bill Joy |
.An Bill Joy |