manual/man/draft/man8/makewhatis.8

   1 .\"
   2 .\" Generated automatically from makewhatis.8.in by the
   3 .\" configure script.
   4 .\"
   5 .\" Copyright (c) 1999 Ottavio G. Rizzo <rizzo@pluto.linux.it>
   6 .\"
   7 .\" This is free documentation; you can redistribute it and/or
   8 .\" modify it under the terms of the GNU General Public License as
   9 .\" published by the Free Software Foundation; either version 2 of
  10 .\" the License, or (at your option) any later version.
  11 .\"
  12 .\" The GNU General Public License's references to "object code"
  13 .\" and "executables" are to be interpreted as the output of any
  14 .\" document formatting or typesetting system, including
  15 .\" intermediate and printed output.
  16 .\"
  17 .\" This manual is distributed in the hope that it will be useful,
  18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 .\" GNU General Public License for more details.
  21 .\"
  22 .\" You should have received a copy of the GNU General Public
  23 .\" License along with this manual; if not, write to the Free
  24 .\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
  25 .\" USA.
  26 .\"
  27 .\" Japanese Version Copyright (c) 1999 NAKANO Takeo all rights reserved.
  28 .\" Translated Mon 6 Dec 1999 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
  29 .\"
  30 .TH MAKEWHATIS 8 "22 January 1999"
  31 .\"O .SH NAME
  32 .SH Ì¾Á°
  33 .\"O makewhatis \- Create the whatis database
  34 makewhatis \- whatis ¥Ç¡¼¥¿¥Ù¡¼¥¹¤òÀ¸À®¤¹¤ë
  35 .\"O .SH SYNOPSIS
  36 .SH ½ñ¼°
  37 .BI "makewhatis [-u] [-v] [-w] [-s " sections " ] [-c [" catpath "]] [" manpath "]"
  38 .\"O .SH DESCRIPTION
  39 .SH ÀâÌÀ
  40 .\"O .B makewhatis
  41 .\"O reads all the manual pages contained in the given
  42 .\"O .IR sections " of " manpath
  43 .\"O or the preformatted pages contained in the given
  44 .\"O .IR sections " of " catpath .
  45 .\"O For each page, it writes a line in the whatis database; each line
  46 .\"O consists of the name of the page and a short description, separated
  47 .\"O by a dash. The description is extracted using the content of the
  48 .\"O NAME section of the manual page.
  49 .B makewhatis
  50 ¤Ï°ú¿ô¤ÇÍ¿¤¨¤é¤ì¤¿ \fImanpath\fP ¤Î¤¦¤Á¤Î \fIsections\fP
  51 ¤Ë¤¢¤ëÁ´¤Æ¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤ä¡¢ \fIcatpath\fP ¤Î¤¦¤Á¤Î
  52 \fIsections\fP ¤Ë¤¢¤ëÁ´¤Æ¤Î¥Õ¥©¡¼¥Þ¥Ã¥ÈºÑ¤ß¥Ú¡¼¥¸¤òÆÉ¤ß¹þ¤à¡£
  53 ¤½¤ì¤¾¤ì¤Î¥Ú¡¼¥¸¤ËÂÐ¤·¡¢
  54 .B makewhatis
  55 ¤Ï°ì¤Ä¤Î¹Ô¤ò whatis ¥Ç¡¼¥¿¥Ù¡¼¥¹¤Ë½ñ¤¹þ¤à¡£
  56 ³Æ¹Ô¤Ë¤Ï¥Ú¡¼¥¸¤ÎÌ¾Á°¤ÈÃ»¤¤ÀâÌÀ¤¬¡¢¥À¥Ã¥·¥å (\-) ¤Ç¶èÀÚ¤é¤ì¤¿¤«¤¿¤Á¤Ç
  57 µ½Ò¤µ¤ì¤ë¡£ÀâÌÀ¤Ï¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Î NAME (Ì¾Á°¡¦Ì¾¾Î) ¥»¥¯¥·¥ç¥ó
  58 ¤ÎÆâÍÆ¤«¤éÃê½Ð¤µ¤ì¤ë¡£
  59 .LP
  60 .\"O Since other languages use a different term for the NAME section,
  61 .\"O .B makewhatis
  62 .\"O recognizes the equivalent terms in Czech, Italian, Finnish, French,
  63 .\"O German and Spanish.
  64 ±Ñ¸ì°Ê³°¤Î¸À¸ì¤Ç¤Ï NAME °Ê³°¤ÎÍÑ¸ì¤ò¥»¥¯¥·¥ç¥óÌ¾¤ËÍÑ¤¤¤ë¤¿¤á¡¢
  65 .B makewhatis
  66 ¤Ï¤³¤ì¤ËÅù²Á¤ÊÃ±¸ì¤ò¥Á¥§¥³¸ì¡¢¥¤¥¿¥ê¥¢¸ì¡¢¥Õ¥£¥ó¥é¥ó¥É¸ì¡¢¥Õ¥é¥ó¥¹¸ì¡¢
  67 ¥É¥¤¥Ä¸ì¡¢¥¹¥Ú¥¤¥ó¸ì¤ËÂÐ¤·¤ÆÇ§¼±¤¹¤ë¡£
  68 .LP
  69 .BR ÌõÃí :
  70 JM ¤Ë¤¢¤ëÆüËÜ¸ì¥Ñ¥Ã¥Á¤òÅö¤Æ¤¿ makewhatis ¤Ï¡¢
  71 ÆüËÜ¸ì¤Î¥¿¥¤¥È¥ë¤ËÂÐ±þ¤·¤Æ¤¤¤Þ¤¹¡£
  72 .LP
  73 .\"O If no
  74 .\"O .I manpath
  75 .\"O argument is given,
  76 .\"O .I /usr/man
  77 .\"O is assumed by default.
  78 .I manpath
  79 °ú¿ô¤¬Í¿¤¨¤é¤ì¤Ê¤±¤ì¤Ð¡¢¥Ç¥Õ¥©¥ë¥È¤Ç¤Ï
  80 .I /usr/man
  81 ¤òÍÑ¤¤¤ë¡£
  82 .\"O .SH OPTIONS
  83 .SH ¥ª¥×¥·¥ç¥ó
  84 .TP
  85 .B -u
  86 .\"O Update database with new pages.
  87 ¥Ç¡¼¥¿¥Ù¡¼¥¹¤ò¿·¤·¤¤¥Ú¡¼¥¸¤Î¾ðÊó¤Ç¹¹¿·¤¹¤ë¡£
  88 .TP
  89 .B -v
  90 .\"O Verbose output
  91 ñÁÀå¤Ê½ÐÎÏ¤ò¤¹¤ë¡£
  92 .TP
  93 .B -w
  94 .\"O Use manpath obtained from `man --path`
  95 manpath ¤ò `man --path` ¤ÇÆÀ¤é¤ì¤ëÃÍ¤Ë¤¹¤ë¡£
  96 .TP
  97 .BI -s " sections"
  98 .\"O Looks in the
  99 .\"O .I sections
 100 .\"O of
 101 .\"O .IR manpath " or " catpath .
 102 .\"O If the option is absent, its value is assumed to be
 103 .\"O .I  \'1 2 3 4 5 6 7 8 9 n l\'
 104 .IR manpath " ¤Þ¤¿¤Ï " catpath
 105 ¤Î
 106 .I sections
 107 ¤ò¤ß¤ë¡£¤³¤Î¥ª¥×¥·¥ç¥ó¤ò¾ÊÎ¬¤¹¤ë¤È¡¢
 108 .I  \'1 2 3 4 5 6 7 8 9 n l\'
 109 ¤¬²¾Äê¤µ¤ì¤ë¡£
 110 .TP
 111 .BI -c " catpath"
 112 .\"O The preformatted manual pages located in
 113 .\"O .I catpath
 114 .\"O are scanned. If the argument is not provided, it is assumed to be the
 115 .\"O first existing directory between
 116 .\"O .IR /usr/man/preformat " and " /usr/man .
 117 .I catpath
 118 ¤ËÃÖ¤«¤ì¤¿¥Õ¥©¡¼¥Þ¥Ã¥ÈºÑ¤ß¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤ò¥¹¥¥ã¥ó¤¹¤ë¡£
 119 ¤³¤Î°ú¿ô¤ò¾ÊÎ¬¤¹¤ë¤È¡¢
 120 .IR /usr/man/preformat " ¤È " /usr/man
 121 ¤ÎÀè¤Ë¸«ÉÕ¤«¤Ã¤¿¤Û¤¦¤Î¥Ç¥£¥ì¥¯¥È¥ê¤¬²¾Äê¤µ¤ì¤ë¡£
 122 .\"O .SH EXAMPLES
 123 .SH Îã
 124 .PP
 125 .\"O To rebuild only
 126 .\"O .IR /usr/X11R6/man/whatis " and " /usr/local/man/whatis
 127 .IR /usr/X11R6/man/whatis " ¤È " /usr/local/man/whatis
 128 ¤À¤±¤òºÆ¹½ÃÛ¤¹¤ë¡£
 129 .IP
 130 makewhatis /usr/X11R6/man /usr/local/man
 131 .PP
 132 .\"O To rebuild all the databases, including those of the Finnish, French
 133 .\"O and Italian translations
 134 ¥Õ¥£¥ó¥é¥ó¥É¸ì¡¢¥Õ¥é¥ó¥¹¸ì¡¢¥¤¥¿¥ê¥¢¸ì¤ÎËÝÌõ¤ò´Þ¤á¡¢
 135 Á´¤Æ¤Î¥Ç¡¼¥¿¥Ù¡¼¥¹¤òºÆ¹½ÃÛ¤¹¤ë¡£
 136 .IP
 137 LANGUAGE=fi:fr:it makewhatis -w
 138 .\"O .SH BUGS
 139 .SH ¥Ð¥°
 140 .\"O .B makewhatis
 141 .\"O may not handle too well manual pages written with non-standard troff
 142 .\"O macros, such as the Tcl/Tk pages.
 143 .B makewhatis
 144 ¤ÏÉ¸½àÅª¤Ç¤Ê¤¤ troff ¤Çµ½Ò¤µ¤ì¤¿¥Þ¥Ë¥å¥¢¥Ú¡¼¥¸ (Tcl/Tk ¤Î¥Ú¡¼¥¸¤Ê¤É)
 145 ¤ò¤¢¤Þ¤ê¤¦¤Þ¤¯°·¤¦¤³¤È¤¬¤Ç¤¤Ê¤¤¡£
 146 .PP
 147 .\"O .B makewhatis
 148 .\"O does not work on preformatted translations.
 149 .B makewhatis
 150 ¤ÏËÝÌõÈÇ¤Î¥Õ¥©¡¼¥Þ¥Ã¥ÈºÑ¤ß¥Ú¡¼¥¸¤Ë¤ÏÆ°ºî¤Ç¤¤Ê¤¤¡£
 151 .\"O .SH SEE ALSO
 152 .SH ´ØÏ¢¹àÌÜ
 153 .BR apropos (1),
 154 .BR man (1),
 155 .BR whatis (1)