[BACK]Return to apropos.1 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/apropos.1, Revision 1.38

1.38    ! schwarze    1: .\"    $Id: apropos.1,v 1.37 2015/02/16 16:23:54 schwarze Exp $
1.1       kristaps    2: .\"
1.17      kristaps    3: .\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.25      schwarze    4: .\" Copyright (c) 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>
1.1       kristaps    5: .\"
                      6: .\" Permission to use, copy, modify, and distribute this software for any
                      7: .\" purpose with or without fee is hereby granted, provided that the above
                      8: .\" copyright notice and this permission notice appear in all copies.
                      9: .\"
                     10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     11: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     12: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     13: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     17: .\"
1.38    ! schwarze   18: .Dd $Mdocdate: February 16 2015 $
1.1       kristaps   19: .Dt APROPOS 1
                     20: .Os
                     21: .Sh NAME
1.19      kristaps   22: .Nm apropos ,
                     23: .Nm whatis
1.5       kristaps   24: .Nd search manual page databases
1.1       kristaps   25: .Sh SYNOPSIS
                     26: .Nm
1.37      schwarze   27: .Op Fl acfhklw
1.13      schwarze   28: .Op Fl C Ar file
1.20      schwarze   29: .Op Fl M Ar path
                     30: .Op Fl m Ar path
1.24      schwarze   31: .Op Fl O Ar outkey
1.3       kristaps   32: .Op Fl S Ar arch
                     33: .Op Fl s Ar section
1.13      schwarze   34: .Ar expression ...
1.1       kristaps   35: .Sh DESCRIPTION
                     36: The
1.19      kristaps   37: .Nm apropos
                     38: and
                     39: .Nm whatis
                     40: utilities query manual page databases generated by
1.28      schwarze   41: .Xr makewhatis 8 ,
1.27      schwarze   42: evaluating
1.4       kristaps   43: .Ar expression
1.5       kristaps   44: for each file in each database.
1.30      schwarze   45: By default, they display the names, section numbers, and description lines
1.27      schwarze   46: of all matching manuals.
1.16      kristaps   47: .Pp
                     48: By default,
                     49: .Nm
                     50: searches for
1.28      schwarze   51: .Xr makewhatis 8
1.16      kristaps   52: databases in the default paths stipulated by
1.27      schwarze   53: .Xr man 1
                     54: and uses case-insensitive substring matching
                     55: .Pq the Cm = No operator
1.23      schwarze   56: over manual names and descriptions
                     57: .Pq the Li \&Nm No and Li \&Nd No macro keys .
                     58: Multiple terms imply pairwise
                     59: .Fl o .
1.31      schwarze   60: .Pp
1.19      kristaps   61: .Nm whatis
1.31      schwarze   62: is a synonym for
                     63: .Nm
                     64: .Fl f .
1.16      kristaps   65: .Pp
1.31      schwarze   66: The options are as follows:
1.1       kristaps   67: .Bl -tag -width Ds
1.31      schwarze   68: .It Fl a
                     69: Instead of showing only the title lines, show the complete manual pages,
                     70: just like
                     71: .Xr man 1
                     72: .Fl a
                     73: would.
1.32      schwarze   74: If the standard output is a terminal device and
                     75: .Fl c
                     76: is not specified, use
                     77: .Xr more 1
                     78: to paginate them.
                     79: In
                     80: .Fl a
                     81: mode, the options
1.36      schwarze   82: .Fl IKOTW
1.31      schwarze   83: described in the
                     84: .Xr mandoc 1
                     85: manual are also available.
1.13      schwarze   86: .It Fl C Ar file
                     87: Specify an alternative configuration
                     88: .Ar file
                     89: in
                     90: .Xr man.conf 5
                     91: format.
1.32      schwarze   92: .It Fl c
                     93: In
                     94: .Fl a
                     95: mode, copy the formatted manual pages to the standard output without using
                     96: .Xr more 1
                     97: to paginate them.
1.31      schwarze   98: .It Fl f
                     99: Search for all words in
                    100: .Ar expression
                    101: in manual page names only.
                    102: The search is case insensitive and matches whole words only.
                    103: In this mode, macro keys, comparison operators, and logical operators
                    104: are not available.
                    105: This overrides any earlier
                    106: .Fl k
1.34      schwarze  107: and
                    108: .Fl l
                    109: options.
1.35      schwarze  110: .It Fl h
                    111: Instead of showing the title lines, show the SYNOPSIS sections, just like
                    112: .Xr man 1
                    113: .Fl h
                    114: would.
1.31      schwarze  115: .It Fl k
                    116: Support the full
                    117: .Ar expression
                    118: syntax.
                    119: This overrides any earlier
                    120: .Fl f
1.34      schwarze  121: and
                    122: .Fl l
                    123: options.
1.31      schwarze  124: It is the default for
                    125: .Nm .
1.34      schwarze  126: .It Fl l
                    127: An alias for
                    128: .Xr mandoc 1
                    129: .Fl a .
                    130: This overrides any earlier
                    131: .Fl f ,
                    132: .Fl k ,
                    133: and
                    134: .Fl w
                    135: options.
1.20      schwarze  136: .It Fl M Ar path
1.7       kristaps  137: Use the colon-separated path instead of the default list of paths
                    138: searched for
1.28      schwarze  139: .Xr makewhatis 8
1.7       kristaps  140: databases.
                    141: Invalid paths, or paths without manual databases, are ignored.
1.20      schwarze  142: .It Fl m Ar path
1.9       schwarze  143: Prepend the colon-separated paths to the list of paths searched
1.6       kristaps  144: for
1.28      schwarze  145: .Xr makewhatis 8
1.5       kristaps  146: databases.
1.6       kristaps  147: Invalid paths, or paths without manual databases, are ignored.
1.24      schwarze  148: .It Fl O Ar outkey
                    149: Show the values associated with the key
                    150: .Ar outkey
                    151: instead of the manual descriptions.
1.3       kristaps  152: .It Fl S Ar arch
1.23      schwarze  153: Restrict the search to pages for the specified
                    154: .Xr machine 1
                    155: architecture.
                    156: .Ar arch
                    157: is case insensitive.
                    158: By default, pages for all architectures are shown.
                    159: .It Fl s Ar section
                    160: Restrict the search to the specified section of the manual.
                    161: By default, pages from all sections are shown.
1.1       kristaps  162: See
                    163: .Xr man 1
1.23      schwarze  164: for a listing of sections.
1.31      schwarze  165: .It Fl w
                    166: Instead of showing title lines, show the pathnames of the matching
                    167: manual pages, just like
                    168: .Xr man 1
                    169: .Fl w
                    170: would.
1.4       kristaps  171: .El
                    172: .Pp
1.23      schwarze  173: An
1.4       kristaps  174: .Ar expression
1.23      schwarze  175: consists of search terms joined by logical operators
                    176: .Fl a
                    177: .Pq and
                    178: and
                    179: .Fl o
                    180: .Pq or .
                    181: The
                    182: .Fl a
                    183: operator has precedence over
                    184: .Fl o
                    185: and both are evaluated left-to-right.
                    186: .Bl -tag -width Ds
                    187: .It \&( Ar expr No \&)
                    188: True if the subexpression
                    189: .Ar expr
                    190: is true.
                    191: .It Ar expr1 Fl a Ar expr2
                    192: True if both
                    193: .Ar expr1
                    194: and
                    195: .Ar expr2
                    196: are true (logical
1.27      schwarze  197: .Sq and ) .
1.23      schwarze  198: .It Ar expr1 Oo Fl o Oc Ar expr2
                    199: True if
                    200: .Ar expr1
                    201: and/or
                    202: .Ar expr2
                    203: evaluate to true (logical
1.27      schwarze  204: .Sq or ) .
1.23      schwarze  205: .It Ar term
                    206: True if
                    207: .Ar term
                    208: is satisfied.
                    209: This has syntax
1.27      schwarze  210: .Sm off
                    211: .Oo
                    212: .Op Ar key Op , Ar key ...
1.38    ! schwarze  213: .Pq Cm = | \(ti
1.27      schwarze  214: .Oc
1.29      schwarze  215: .Ar val ,
                    216: .Sm on
1.27      schwarze  217: where
                    218: .Ar key
1.4       kristaps  219: is an
                    220: .Xr mdoc 7
                    221: macro to query and
1.27      schwarze  222: .Ar val
1.4       kristaps  223: is its value.
1.10      kristaps  224: See
                    225: .Sx Macro Keys
                    226: for a list of available keys.
1.4       kristaps  227: Operator
1.27      schwarze  228: .Cm =
1.23      schwarze  229: evaluates a substring, while
1.38    ! schwarze  230: .Cm \(ti
1.23      schwarze  231: evaluates a regular expression.
                    232: .It Fl i Ar term
                    233: If
                    234: .Ar term
                    235: is a regular expression, it
                    236: is evaluated case-insensitively.
                    237: Has no effect on substring terms.
                    238: .El
1.1       kristaps  239: .Pp
1.27      schwarze  240: Results are sorted by manual sections and names, with output formatted as
1.23      schwarze  241: .Pp
1.27      schwarze  242: .D1 name[, name...](sec) \- description
1.23      schwarze  243: .Pp
                    244: Where
1.27      schwarze  245: .Dq name
                    246: is the manual's name,
                    247: .Dq sec
1.3       kristaps  248: is the manual section, and
1.27      schwarze  249: .Dq description
1.1       kristaps  250: is the manual's short description.
                    251: If an architecture is specified for the manual, it is displayed as
1.23      schwarze  252: .Pp
1.27      schwarze  253: .D1 name(sec/arch) \- description
1.23      schwarze  254: .Pp
                    255: Resulting manuals may be accessed as
                    256: .Pp
1.27      schwarze  257: .Dl $ man \-s sec name
1.23      schwarze  258: .Pp
                    259: If an architecture is specified in the output, use
                    260: .Pp
1.27      schwarze  261: .Dl $ man \-s sec \-S arch name
1.10      kristaps  262: .Ss Macro Keys
1.23      schwarze  263: Queries evaluate over a subset of
1.10      kristaps  264: .Xr mdoc 7
                    265: macros indexed by
1.28      schwarze  266: .Xr makewhatis 8 .
1.10      kristaps  267: In addition to the macro keys listed below, the special key
                    268: .Cm any
                    269: may be used to match any available macro key.
                    270: .Pp
                    271: Names and description:
                    272: .Bl -column "xLix" description -offset indent -compact
                    273: .It Li \&Nm Ta manual name
                    274: .It Li \&Nd Ta one-line manual description
1.24      schwarze  275: .It Li arch Ta machine architecture (case-insensitive)
                    276: .It Li sec  Ta manual section number
1.10      kristaps  277: .El
                    278: .Pp
                    279: Sections and cross references:
                    280: .Bl -column "xLix" description -offset indent -compact
                    281: .It Li \&Sh Ta section header (excluding standard sections)
                    282: .It Li \&Ss Ta subsection header
                    283: .It Li \&Xr Ta cross reference to another manual page
                    284: .It Li \&Rs Ta bibliographic reference
                    285: .El
                    286: .Pp
                    287: Semantic markup for command line utilities:
                    288: .Bl -column "xLix" description -offset indent -compact
                    289: .It Li \&Fl Ta command line options (flags)
                    290: .It Li \&Cm Ta command modifier
                    291: .It Li \&Ar Ta command argument
                    292: .It Li \&Ic Ta internal or interactive command
                    293: .It Li \&Ev Ta environmental variable
                    294: .It Li \&Pa Ta file system path
                    295: .El
                    296: .Pp
                    297: Semantic markup for function libraries:
                    298: .Bl -column "xLix" description -offset indent -compact
                    299: .It Li \&Lb Ta function library name
                    300: .It Li \&In Ta include file
                    301: .It Li \&Ft Ta function return type
                    302: .It Li \&Fn Ta function name
                    303: .It Li \&Fa Ta function argument type and name
                    304: .It Li \&Vt Ta variable type
                    305: .It Li \&Va Ta variable name
                    306: .It Li \&Dv Ta defined variable or preprocessor constant
                    307: .It Li \&Er Ta error constant
                    308: .It Li \&Ev Ta environmental variable
                    309: .El
                    310: .Pp
                    311: Various semantic markup:
                    312: .Bl -column "xLix" description -offset indent -compact
                    313: .It Li \&An Ta author name
                    314: .It Li \&Lk Ta hyperlink
                    315: .It Li \&Mt Ta Do mailto Dc hyperlink
                    316: .It Li \&Cd Ta kernel configuration declaration
                    317: .It Li \&Ms Ta mathematical symbol
                    318: .It Li \&Tn Ta tradename
                    319: .El
                    320: .Pp
                    321: Physical markup:
                    322: .Bl -column "xLix" description -offset indent -compact
                    323: .It Li \&Em Ta italic font or underline
                    324: .It Li \&Sy Ta boldface font
                    325: .It Li \&Li Ta typewriter font
                    326: .El
                    327: .Pp
                    328: Text production:
                    329: .Bl -column "xLix" description -offset indent -compact
                    330: .It Li \&St Ta reference to a standards document
                    331: .It Li \&At Ta At No version reference
                    332: .It Li \&Bx Ta Bx No version reference
                    333: .It Li \&Bsx Ta Bsx No version reference
                    334: .It Li \&Nx Ta Nx No version reference
                    335: .It Li \&Fx Ta Fx No version reference
                    336: .It Li \&Ox Ta Ox No version reference
                    337: .It Li \&Dx Ta Dx No version reference
                    338: .El
1.6       kristaps  339: .Sh ENVIRONMENT
1.33      schwarze  340: .Bl -tag -width MANPAGER
                    341: .It Ev MANPAGER
                    342: Any non-empty value of the environment variable
                    343: .Ev MANPAGER
                    344: will be used instead of the standard pagination program,
                    345: .Xr more 1 .
1.6       kristaps  346: .It Ev MANPATH
1.23      schwarze  347: The standard search path used by
                    348: .Xr man 1
                    349: may be changed by specifying a path in the
                    350: .Ev MANPATH
                    351: environment variable.
1.6       kristaps  352: Invalid paths, or paths without manual databases, are ignored.
1.9       schwarze  353: Overridden by
1.7       kristaps  354: .Fl M .
1.14      kristaps  355: If
                    356: .Ev MANPATH
1.23      schwarze  357: begins with a colon, it is appended to the default list;
                    358: if it ends with a colon, it is prepended to the default list;
                    359: or if it contains two adjacent colons,
                    360: the standard search path is inserted between the colons.
                    361: If none of these conditions are met, it overrides the
                    362: standard search path.
1.33      schwarze  363: .It Ev PAGER
                    364: Specifies the pagination program to use when
                    365: .Ev MANPAGER
                    366: is not defined.
                    367: If neither PAGER nor MANPAGER is defined,
                    368: .Pa /usr/bin/more Fl s
                    369: will be used.
1.13      schwarze  370: .El
                    371: .Sh FILES
                    372: .Bl -tag -width "/etc/man.conf" -compact
1.22      schwarze  373: .It Pa mandoc.db
1.13      schwarze  374: name of the
1.28      schwarze  375: .Xr makewhatis 8
1.13      schwarze  376: keyword database
                    377: .It Pa /etc/man.conf
                    378: default
                    379: .Xr man 1
                    380: configuration file
1.6       kristaps  381: .El
1.1       kristaps  382: .Sh EXIT STATUS
                    383: .Ex -std
                    384: .Sh EXAMPLES
                    385: Search for
1.23      schwarze  386: .Qq .cf
                    387: as a substring of manual names and descriptions:
1.4       kristaps  388: .Pp
1.23      schwarze  389: .Dl $ apropos .cf
1.4       kristaps  390: .Pp
1.11      kristaps  391: Include matches for
1.23      schwarze  392: .Qq .cnf
1.11      kristaps  393: and
1.23      schwarze  394: .Qq .conf
                    395: as well:
                    396: .Pp
                    397: .Dl $ apropos .cf .cnf .conf
                    398: .Pp
                    399: Search in names and descriptions using a regular expression:
1.4       kristaps  400: .Pp
1.38    ! schwarze  401: .Dl $ apropos \(aq\(tiset.?[ug]id\(aq
1.4       kristaps  402: .Pp
1.27      schwarze  403: Search for manuals in the library section mentioning both the
1.23      schwarze  404: .Qq optind
                    405: and the
1.4       kristaps  406: .Qq optarg
1.23      schwarze  407: variables:
                    408: .Pp
                    409: .Dl $ apropos \-s 3 Va=optind \-a Va=optarg
1.1       kristaps  410: .Pp
1.23      schwarze  411: Do exactly the same as calling
                    412: .Xr whatis 1
                    413: with the argument
                    414: .Qq ssh :
                    415: .Pp
1.38    ! schwarze  416: .Dl $ apropos \-\- \-i \(aqNm\(ti[[:<:]]ssh[[:>:]]\(aq
1.24      schwarze  417: .Pp
                    418: The following two invocations are equivalent:
                    419: .Pp
                    420: .D1 Li $ apropos -S Ar arch Li -s Ar section expression
                    421: .Bd -ragged -offset indent
                    422: .Li $ apropos \e( Ar expression Li \e)
1.38    ! schwarze  423: .Li -a arch\(ti^( Ns Ar arch Ns Li |any)$
        !           424: .Li -a sec\(ti^ Ns Ar section Ns Li $
1.24      schwarze  425: .Ed
1.1       kristaps  426: .Sh SEE ALSO
1.23      schwarze  427: .Xr man 1 ,
                    428: .Xr re_format 7 ,
1.28      schwarze  429: .Xr makewhatis 8
1.23      schwarze  430: .Sh HISTORY
1.30      schwarze  431: Part of the functionality of
                    432: .Nm whatis
                    433: was already provided by the former
                    434: .Nm manwhere
                    435: utility in
                    436: .Bx 1 .
                    437: The
1.23      schwarze  438: .Nm
1.30      schwarze  439: and
                    440: .Nm whatis
                    441: utilities first appeared in
1.23      schwarze  442: .Bx 2 .
1.30      schwarze  443: They were rewritten from scratch for
1.24      schwarze  444: .Ox 5.6 .
1.23      schwarze  445: .Pp
                    446: The
                    447: .Fl M
                    448: option and the
                    449: .Ev MANPATH
                    450: variable first appeared in
                    451: .Bx 4.3 ;
                    452: .Fl m
                    453: in
                    454: .Bx 4.3 Reno ;
                    455: .Fl C
                    456: in
                    457: .Bx 4.4 Lite1 ;
                    458: and
                    459: .Fl S
                    460: and
                    461: .Fl s
                    462: in
1.30      schwarze  463: .Ox 4.5
                    464: for
                    465: .Nm
                    466: and in
                    467: .Ox 5.6
                    468: for
                    469: .Nm whatis .
1.1       kristaps  470: .Sh AUTHORS
1.23      schwarze  471: .An -nosplit
                    472: .An Bill Joy
1.30      schwarze  473: wrote
                    474: .Nm manwhere
                    475: in 1977 and the original
1.23      schwarze  476: .Bx
1.1       kristaps  477: .Nm
1.30      schwarze  478: and
                    479: .Nm whatis
1.23      schwarze  480: in February 1979.
                    481: The current version was written by
1.24      schwarze  482: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
                    483: and
                    484: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .

CVSweb