apropos(1) - osol9

1apropos(1)                       User Commands                      apropos(1)
2
3
4

NAME

6       apropos - locate commands by keyword lookup
7

SYNOPSIS

9       apropos keyword...
10
11

DESCRIPTION

13       The  apropos  utility displays the man page name, section number, and a
14       short description for each man page whose NAME line  contains  keyword.
15       This  information  is  contained  in the /usr/share/man/windex database
16       created by catman(1M). If catman(1M) was not run, or was run  with  the
17       -n  option,  apropos  fails. Each word is considered separately and the
18       case of letters is ignored. Words which are part  of  other  words  are
19       considered;  for example, when looking for `compile', apropos finds all
20       instances of `compiler' also.
21
22
23       apropos is actually just the -k option to the man(1) command.
24

EXAMPLES

26       Example 1 To find a man page whose NAME line contains a keyword
27
28
29       Try
30
31
32         example% apropos password
33
34
35
36
37       and
38
39
40         example% apropos editor
41
42
43
44
45       If the line starts `filename(section) ...' you can run
46
47
48         man -s section filename
49
50
51
52
53       to display the man page for filename.
54
55
56       Example 2 To find the man page for the subroutine printf()
57
58
59       Try
60
61
62         example% apropos format
63
64
65
66
67       and then
68
69
70         example% man -s 3s printf
71
72
73
74
75       to get the manual page on the subroutine printf().
76
77

FILES

79       /usr/share/man/windex     table of contents and keyword database
80
81

ATTRIBUTES

83       See attributes(5) for descriptions of the following attributes:
84
85
86
87
88       ┌─────────────────────────────┬─────────────────────────────┐
89       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
90       ├─────────────────────────────┼─────────────────────────────┤
91       │Availability                 │SUNWdoc                      │
92       ├─────────────────────────────┼─────────────────────────────┤
93       │CSI                          │Enabled                      │
94       └─────────────────────────────┴─────────────────────────────┘
95

DIAGNOSTICS

100       /usr/share/man/windex: No such file or directory
101
102           This database does not exist. catman(1M) must be run to create it.
103
104
105
106
107SunOS 5.11                        20 Dec 1996                       apropos(1)