Return to apropos.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/apropos.1, Revision 1.3

1.3     ! kristaps    1: .\"    $Id: apropos.1,v 1.2 2011/10/08 12:24:40 kristaps Exp $
1.1       kristaps    2: .\"
                      3: .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
                      4: .\"
                      5: .\" Permission to use, copy, modify, and distribute this software for any
                      6: .\" purpose with or without fee is hereby granted, provided that the above
                      7: .\" copyright notice and this permission notice appear in all copies.
                      8: .\"
                      9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     16: .\"
1.3     ! kristaps   17: .Dd $Mdocdate: October 8 2011 $
1.1       kristaps   18: .Dt APROPOS 1
                     19: .Os
                     20: .Sh NAME
                     21: .Nm apropos
                     22: .Nd search the manual page database
                     23: .Sh SYNOPSIS
                     24: .Nm
1.3     ! kristaps   25: .Op Fl I
        !            26: .Op Fl S Ar arch
        !            27: .Op Fl s Ar section
1.1       kristaps   28: .Op Fl t Ar types
1.3     ! kristaps   29: .Ar pattern
1.1       kristaps   30: .Sh DESCRIPTION
                     31: The
                     32: .Nm
                     33: utility queries the manual page database.
                     34: Its arguments are as follows:
                     35: .Bl -tag -width Ds
1.3     ! kristaps   36: .It Fl S Ar arch
1.1       kristaps   37: Search only for a particular architecture.
1.3     ! kristaps   38: .It Fl s Ar cat
        !            39: Search only for a manual section.
1.1       kristaps   40: See
                     41: .Xr man 1
1.3     ! kristaps   42: for a listing of manual sections.
1.1       kristaps   43: .It Fl I
1.3     ! kristaps   44: Case-insensitive pattern matching.
1.1       kristaps   45: .It Fl t Ar types
                     46: Consider only types of keyword match, where
                     47: .Ar types
                     48: is a comma-separated list consisting of the following:
                     49: .Ar name ,
                     50: manual names;
                     51: .Ar func ,
                     52: function names;
                     53: .Ar utility ,
                     54: utility names;
                     55: .Ar incl ,
                     56: include files;
                     57: .Ar var ,
                     58: variable names;
                     59: .Ar stand ,
                     60: standards ;
                     61: .Ar auth ,
                     62: authors;
                     63: .Ar conf ,
                     64: configuration strings;
                     65: .Ar desc ,
                     66: descriptive text;
                     67: .Ar xref ,
                     68: cross-references.
                     69: .Ar path ,
                     70: file pathnames;
                     71: .Ar env ,
                     72: environment variables; or
                     73: .Ar err ,
                     74: error codes.
                     75: Specifying
                     76: .Ar all
                     77: will search for all types.
                     78: .It Ar key
                     79: The search key.
                     80: .El
                     81: .Pp
                     82: By default,
                     83: .Nm
1.3     ! kristaps   84: searches for pattern matches of
        !            85: .Ar pattern
1.1       kristaps   86: in manual names and descriptions
1.3     ! kristaps   87: and displays results sorted by manual title.
1.1       kristaps   88: Output is formatted as
                     89: .Pp
1.3     ! kristaps   90: .D1 title(sec) \- description
1.1       kristaps   91: .Pp
                     92: Where
                     93: .Qq title
                     94: is the manual's title (note multiple manual names may exist for one
                     95: title),
1.3     ! kristaps   96: .Qq sec
        !            97: is the manual section, and
1.1       kristaps   98: .Qq description
                     99: is the manual's short description.
                    100: If an architecture is specified for the manual, it is displayed as
                    101: .Pp
                    102: .D1 title(cat/arch) \- description
                    103: .Pp
                    104: Resulting manuals may be accessed as
                    105: .Pp
1.3     ! kristaps  106: .Dl $ man \-s sec title
1.1       kristaps  107: .Pp
                    108: If an architecture is specified in the output, use
                    109: .Pp
1.3     ! kristaps  110: .Dl $ man \-s sec \-S arch title
1.1       kristaps  111: .\" .Sh IMPLEMENTATION NOTES
                    112: .\" Not used in OpenBSD.
                    113: .\" .Sh RETURN VALUES
                    114: .\" For sections 2, 3, & 9 only.
                    115: .\" .Sh ENVIRONMENT
                    116: .\" For sections 1, 6, 7, & 8 only.
                    117: .\" .Sh FILES
                    118: .Sh EXIT STATUS
                    119: .Ex -std
                    120: .Sh EXAMPLES
                    121: Search for
                    122: .Qq optind
                    123: as a variable name in the library category:
                    124: .Pp
1.3     ! kristaps  125: .Dl $ apropos \-tvar \-s 3 optind
1.1       kristaps  126: .Pp
                    127: Search for all manuals referencing the term
                    128: .Qq POSIX
                    129: in any letter case:
                    130: .Pp
1.3     ! kristaps  131: .Dl $ apropos \-tall \-I posix
1.1       kristaps  132: .\" .Sh DIAGNOSTICS
                    133: .\" For sections 1, 4, 6, 7, & 8 only.
                    134: .\" .Sh ERRORS
                    135: .\" For sections 2, 3, & 9 only.
                    136: .Sh SEE ALSO
                    137: .Xr man 1 ,
                    138: .Xr mandoc 1 ,
                    139: .Xr re_format 7
                    140: .\" .Sh STANDARDS
                    141: .\" .Sh HISTORY
                    142: .Sh AUTHORS
                    143: The
                    144: .Nm
                    145: utility was written by
1.2       kristaps  146: .An Kristaps Dzonsons ,
                    147: .Mt kristaps@bsd.lv .
1.1       kristaps  148: .\" .Sh CAVEATS
                    149: .\" .Sh BUGS
                    150: .\" .Sh SECURITY CONSIDERATIONS
                    151: .\" Not used in OpenBSD.