version 1.5, 2011/12/24 22:37:16 |
version 1.8, 2012/03/24 01:54:43 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" |
.\" |
.\" 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 |
Line 41 You can then use the |
|
Line 41 You can then use the |
|
.Xr man 1 |
.Xr man 1 |
command to get more information. |
command to get more information. |
.Pp |
.Pp |
|
By default, |
|
.Nm |
|
searches for |
|
.Xr mandocdb 8 |
|
databases in the default paths stipulated by |
|
.Xr man 1 . |
|
If standard output is a TTY, a result may be selected from a list and |
|
its manual displayed with the pager. |
|
.Pp |
The options are as follows: |
The options are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl C Ar file |
.It Fl C Ar file |
|
|
for a listing of manual sections. |
for a listing of manual sections. |
.El |
.El |
.Pp |
.Pp |
By default, |
|
.Nm |
|
searches for |
|
.Xr mandocdb 8 |
|
databases in the default paths stipulated by |
|
.Xr man 1 . |
|
Results are sorted by manual title, with output formatted as |
Results are sorted by manual title, with output formatted as |
.Pp |
.Pp |
.D1 title(sec) \- description |
.D1 title(sec) \- description |
Line 94 If an architecture is specified for the manual, it is |
|
Line 97 If an architecture is specified for the manual, it is |
|
.Pp |
.Pp |
.D1 title(cat/arch) \- description |
.D1 title(cat/arch) \- description |
.Pp |
.Pp |
Resulting manuals may be accessed as |
If on a TTY, results are prefixed with a numeric identifier. |
.Pp |
.Pp |
.Dl $ man \-s sec title |
.D1 [index] title(cat) \- description |
.Pp |
.Pp |
If an architecture is specified in the output, use |
One may choose a manual be entering the index at the prompt. |
|
Valid choices are displayed using |
|
.Ev MANPAGER , |
|
or failing that , |
|
.Ev PAGER |
|
or just |
|
.Xr more 1 . |
|
Source pages are formatted with |
|
.Xr mandoc 1 ; |
|
preformatted pages with |
|
.Xr cat 1 . |
.Pp |
.Pp |
.Dl $ man \-s sec \-S arch title |
|
.Pp |
|
.Nm |
.Nm |
is identical to running |
is identical to running |
.Xr apropos 1 |
.Xr apropos 1 |
|
|
.Dl $ apropos -- -i 'Nm~[[:<:]]term[[:>:]]' |
.Dl $ apropos -- -i 'Nm~[[:<:]]term[[:>:]]' |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
|
.It Ev MANPAGER |
|
Default pager for manuals. |
|
If this is unset, falls back to |
|
.Ev Pager . |
|
.It Ev PAGER |
|
The second choice for a manual pager. |
|
If this is unset, use |
|
.Xr more 1 . |
.It Ev MANPATH |
.It Ev MANPATH |
Colon-separated paths modifying the default list of paths searched for |
Colon-separated paths modifying the default list of paths searched for |
manual databases. |
manual databases. |
Line 130 If none of these conditions are met, it overrides the |
|
Line 149 If none of these conditions are met, it overrides the |
|
.El |
.El |
.Sh FILES |
.Sh FILES |
.Bl -tag -width "/etc/man.conf" -compact |
.Bl -tag -width "/etc/man.conf" -compact |
.It Pa mandoc.db |
.It Pa whatis.db |
name of the |
name of the |
.Xr mandocdb 8 |
.Xr mandocdb 8 |
keyword database |
keyword database |
.It Pa mandoc.index |
.It Pa whatis.index |
name of the |
name of the |
.Xr mandocdb 8 |
.Xr mandocdb 8 |
filename database |
filename database |