summaryrefslogtreecommitdiffstats
path: root/man/en/makewhatis.8
blob: 227db4ccf135bec9dd21196c97fd67fb22108004 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
MAKEWHATIS(8)                        System Manager's Manual                        MAKEWHATIS(8)

NAME
       makewhatis - Create the whatis database

SYNOPSIS
       makewhatis [-u] [-v] [-w] [-s sections ] [-c [catpath]] [manpath]

DESCRIPTION
       makewhatis  reads  all  the manual pages contained in the given sections of manpath or the
       preformatted pages contained in the given sections of catpath.  For each page, it writes a
       line  in  the  whatis database; each line consists of the name of the page and a short de-
       scription, separated by a dash. The description is extracted using the content of the NAME
       section of the manual page.

       Since other languages use a different term for the NAME section, makewhatis recognizes the
       equivalent terms in Czech, Italian, Finnish, French, German and Spanish.

       If no manpath argument is given, /usr/man is assumed by default.

OPTIONS
       -u     Update database with new pages.

       -v     Verbose output

       -w     Use manpath obtained from `man --path`

       -s sections
              Looks in the sections of manpath or catpath.  If the option is absent, the  MANSECT
              env var will be used.  If it too is absent, the MANSECT setting in man.conf will be
              used.

       -c catpath
              The preformatted manual pages located in catpath are scanned. If  the  argument  is
              not   provided,   it  is  assumed  to  be  the  first  existing  directory  between
              /usr/man/preformat and /usr/man.

EXAMPLES
       To rebuild only /usr/X11R6/man/whatis and /usr/local/man/whatis

              makewhatis /usr/X11R6/man /usr/local/man

       To rebuild all the databases, including those of the Finnish, French and Italian  transla-
       tions

              LANGUAGE=fi:fr:it makewhatis -w

BUGS
       makewhatis  may  not  handle too well manual pages written with non-standard troff macros,
       such as the Tcl/Tk pages.

       makewhatis does not work on preformatted translations.

AUTHOR
       John W. Eaton was the original author of man.  Zeyd M. Ben-Halim released man 1.2, and An-
       dries  Brouwer  followed  up  with  versions  1.3  thru  1.5p.   Federico  Lucifredi <flu-
       cifredi@acm.org> is the current maintainer.

SEE ALSO
       apropos(1), man(1), whatis(1)

                                        September 19, 2005                          MAKEWHATIS(8)