diff options
author | Kristaps Dzonsons <kristaps@bsd.lv> | 2012-03-24 01:46:25 +0000 |
---|---|---|
committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2012-03-24 01:46:25 +0000 |
commit | b0976924948da9277626c1ae9d5fe06b0b25fc09 (patch) | |
tree | e3cd8d44084258de491b4b32d5dac14c07b3ee69 /apropos.1 | |
parent | dfc1c5fe2f232d072fbe6514abe57b63c443baa8 (diff) | |
download | mandoc-b0976924948da9277626c1ae9d5fe06b0b25fc09.tar.gz |
Be insane. Make apropos(1) subsume man(1).
Diffstat (limited to 'apropos.1')
-rw-r--r-- | apropos.1 | 36 |
1 files changed, 26 insertions, 10 deletions
@@ -1,6 +1,6 @@ .\" $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 .\" purpose with or without fee is hereby granted, provided that the above @@ -44,11 +44,11 @@ searches for databases in the default paths stipulated by .Xr man 1 , parses terms as case-sensitive regular expressions -.Pq the Li \&~ operator -over manual names and descriptions -.Pq the Li \&Nm No and Li \&Nd No macro keys . +over manual names and descriptions. Multiple terms imply pairwise .Fl o . +If standard output is a TTY, a result may be selected from a list and +its manual displayed with the pager. .Pp Its arguments are as follows: .Bl -tag -width Ds @@ -156,13 +156,21 @@ If an architecture is specified for the manual, it is displayed as .Pp .D1 title(cat/arch) \- description .Pp -Resulting manuals may be accessed as +If on a TTY, results are prefixed with a numeric identifier. .Pp -.Dl $ man \-s sec title +.D1 [index] title(cat) \- description .Pp -If an architecture is specified in the output, use -.Pp -.Dl $ man \-s sec \-S arch title +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 . .Ss Macro Keys Queries evaluate over a subset of .Xr mdoc 7 @@ -240,6 +248,14 @@ Text production: .El .Sh ENVIRONMENT .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 Colon-separated paths modifying the default list of paths searched for manual databases. @@ -301,7 +317,7 @@ as variable names in the library category: .Pp .Dl $ apropos \-s 3 Va~^optind \-a Va~^optarg$ .Sh SEE ALSO -.Xr man 1 , +.Xr more 1 .Xr re_format 7 , .Xr mandocdb 8 .Sh AUTHORS |