Commit drafts of man-1.6g posted at [JM:00196] to [JM:00206]

[linuxjm/jm.git] / manual / man / draft / man8 / makewhatis.8

.\"
.\" Generated automatically from makewhatis.8.in by the
.\" configure script.
.\"
.\" Copyright (c) 1999 Ottavio G. Rizzo <rizzo@pluto.linux.it>
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, write to the Free
.\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
.\" USA.
.\" 
.\" Japanese Version Copyright (c) 1999 NAKANO Takeo all rights reserved.
.\" Translated Mon 6 Dec 1999 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\"
.\" Updated Fri 4 Mar 2011 by TACHIBANA Akira <tati@kc5.so-net.ne.jp>
.\"
.TH MAKEWHATIS 8 "September 19, 2005"
.\"O .SH NAME
.\"O makewhatis \- Create the whatis database
.SH ̾Á°
makewhatis \- whatis ¥Ç¡¼¥¿¥Ù¡¼¥¹¤òÀ¸À®¤¹¤ë
.\"O .SH SYNOPSIS
.\"O .BI "makewhatis [-u] [-v] [-w] [-s " sections " ] [-c [" catpath "]] [" manpath "]"
.SH ½ñ¼°
.\"O .BI "makewhatis [-u] [-v] [-w] [-s " sections " ] [-c [" catpath "]] [" manpath "]"
.\"O:tati:¥½¡¼¥¹¤ò³Îǧ¤¹¤ë¤È¡¢¥³¥Þ¥ó¥É¥é¥¤¥ó¤Ï°Ê²¼¤Ç¤Ê¤¤¤È¤¤¤±¤Ê¤¤¤è¤¦¤Ë¸«¤¨¤ë
.BI "makewhatis [-u] [-v] [-s " sections " ] [-w] [" manpath "] [-c [" catpath "]]"

.\"O .SH DESCRIPTION
.\"O .B makewhatis
.\"O reads all the manual pages contained in the given
.\"O .IR sections " of " manpath 
.\"O or the preformatted pages contained in the given
.\"O .IR sections " of " catpath .
.\"O For each page, it writes a line in the whatis database; each line
.\"O consists of the name of the page and a short description, separated
.\"O by a dash. The description is extracted using the content of the
.\"O NAME section of the manual page.
.SH ÀâÌÀ
.B makewhatis
¤Ï \fImanpath\fP Ãæ¤Î \fIsections\fP ¤Ë¤¢¤ëÁ´¤Æ¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤ä¡¢
\fIcatpath\fP Ãæ¤Î \fIsections\fP ¤Ë¤¢¤ëÁ´¤Æ¤ÎÀ°·ÁºÑ¤ß¥Ú¡¼¥¸¤òÆɤ߹þ¤à¡£
¤½¤ì¤¾¤ì¤Î¥Ú¡¼¥¸¤ËÂФ·¡¢
.B makewhatis
¤Ï°ì¹Ô¤Î¾ðÊó¤ò whatis ¥Ç¡¼¥¿¥Ù¡¼¥¹¤Ë½ñ¤­¹þ¤à¡£
³Æ¹Ô¤Ë¤Ï¥Ú¡¼¥¸¤Î̾Á°¤È´Êñ¤ÊÀâÌÀ¤¬¡¢¥À¥Ã¥·¥å (\-) ¤Ç¶èÀÚ¤é¤ì¤¿¤«¤¿¤Á¤Ç
µ­½Ò¤µ¤ì¤ë¡£ÀâÌÀ¤Ï¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Î NAME (̾Á°¡¦Ì¾¾Î) ¥»¥¯¥·¥ç¥ó
¤ÎÆâÍƤ«¤éÃê½Ð¤µ¤ì¤ë¡£
.LP
.\"O Since other languages use a different term for the NAME section,
.\"O .B makewhatis
.\"O recognizes the equivalent terms in Czech, Italian, Finnish, French,
.\"O German and Spanish.
¸À¸ì¤Ë¤è¤Ã¤Æ NAME ¥»¥¯¥·¥ç¥ó¤Î¸«½Ð¤·¤Ë»È¤¦ÍѸ줬°Û¤Ê¤Ã¤Æ¤¤¤ë¡£
¤½¤³¤Ç
.B makewhatis
¤Ï±Ñ¸ì¤Î NAME ¤ËÁêÅö¤¹¤ë¡¢¥Á¥§¥³¸ì¡¢¥¤¥¿¥ê¥¢¸ì¡¢¥Õ¥£¥ó¥é¥ó¥É¸ì¡¢¥Õ¥é¥ó¥¹¸ì¡¢
¥É¥¤¥Ä¸ì¡¢¥¹¥Ú¥¤¥ó¸ì¤Îñ¸ì¤òǧ¼±¤¹¤ë¤è¤¦¤Ë¤Ê¤Ã¤Æ¤¤¤ë¡£
.LP
.BR ÌõÃí :
JM ¤Ë¤¢¤ëÆüËܸì¥Ñ¥Ã¥Á¤òÅö¤Æ¤¿ makewhatis ¤Ï¡¢
ÆüËܸì¤Î¥¿¥¤¥È¥ë¤ËÂбþ¤·¤Æ¤¤¤Þ¤¹¡£
.LP
.\"O If no
.\"O .I manpath
.\"O argument is given,
.\"O .I /usr/man
.\"O is assumed by default.
.I manpath
°ú¿ô¤¬»ØÄꤵ¤ì¤Ê¤±¤ì¤Ð¡¢¥Ç¥Õ¥©¥ë¥È¤Î
.I /usr/man
¤òÍѤ¤¤ë¡£
.\"O .SH OPTIONS
.SH ¥ª¥×¥·¥ç¥ó
.TP
.B -u
.\"O Update database with new pages.
¥Ç¡¼¥¿¥Ù¡¼¥¹¤ò¿·¤·¤¤¥Ú¡¼¥¸¤Î¾ðÊó¤Ç¹¹¿·¤¹¤ë¡£
.TP
.B -v
.\"O Verbose output
ñÁÀå¤Ê½ÐÎϤò¤¹¤ë¡£
.TP
.B -w
.\"O Use manpath obtained from `man --path`
manpath ¤ò `man --path` ¤ÇÆÀ¤é¤ì¤ëÃͤˤ¹¤ë¡£
.TP 
.BI -s " sections"
.\"O Looks in the
.\"O .I sections
.\"O of
.\"O .IR manpath " or " catpath .
.\"O If the option is absent, the MANSECT env var will be used.  If it too
.\"O is absent, the MANSECT setting in man.conf will be used.
.IR manpath " ¤Þ¤¿¤Ï " catpath
¤Î
.I sections
¤ò¸«¤ë¡£
¤³¤Î¥ª¥×¥·¥ç¥ó¤ò¾Êά¤¹¤ë¤È¡¢MANSECT ´Ä¶­ÊÑ¿ô¤¬ÍѤ¤¤é¤ì¤ë¡£
MANSECT ´Ä¶­ÊÑ¿ô¤âÀßÄꤵ¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç¤Ï¡¢man.conf ¤Ë¤¢¤ë MANSECT ¤Î
ÀßÄ꤬ÍѤ¤¤é¤ì¤ë¡£
.TP 
.BI -c " catpath"
.\"O The preformatted manual pages located in
.\"O .I catpath
.\"O are scanned. If the argument is not provided, it is assumed to be the
.\"O first existing directory between
.\"O .IR /usr/man/preformat " and " /usr/man .
.I catpath
¤ËÃÖ¤«¤ì¤¿À°·ÁºÑ¤ß¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤ò¥¹¥­¥ã¥ó¤¹¤ë¡£
¤³¤Î¥ª¥×¥·¥ç¥ó¤Î°ú¿ô¤ò¾Êά¤¹¤ë¤È¡¢
.IR /usr/man/preformat " ¤È " /usr/man
¤Î¤¦¤Á¡¢Â¸ºß¤¹¤ëºÇ½é¤Î¥Ç¥£¥ì¥¯¥È¥ê¤ò°ú¿ô¤Ë»ØÄꤷ¤¿¤È¸«¤Ê¤µ¤ì¤ë¡£
.\"O .SH EXAMPLES
.SH Îã
.PP
.\"O To rebuild only 
.\"O .IR /usr/X11R6/man/whatis " and " /usr/local/man/whatis
.IR /usr/X11R6/man/whatis " ¤È " /usr/local/man/whatis
¤À¤±¤òºÆ¹½ÃÛ¤¹¤ë¡£
.IP 
makewhatis /usr/X11R6/man /usr/local/man
.PP
.\"O To rebuild all the databases, including those of the Finnish, French
.\"O and Italian translations
¥Õ¥£¥ó¥é¥ó¥É¸ì¡¢¥Õ¥é¥ó¥¹¸ì¡¢¥¤¥¿¥ê¥¢¸ì¤ÎËÝÌõ¤ò´Þ¤á¡¢
Á´¤Æ¤Î¥Ç¡¼¥¿¥Ù¡¼¥¹¤òºÆ¹½ÃÛ¤¹¤ë¡£
.IP
LANGUAGE=fi:fr:it makewhatis -w
.\"O .SH BUGS
.\"O .B makewhatis
.\"O may not handle too well manual pages written with non-standard troff
.\"O macros, such as the Tcl/Tk pages.
.SH ¥Ð¥°
.B makewhatis
¤Ïɸ½àŪ¤Ç¤Ê¤¤ troff ¤Çµ­½Ò¤µ¤ì¤¿¥Þ¥Ë¥å¥¢¥Ú¡¼¥¸ (Tcl/Tk ¤Î¥Ú¡¼¥¸¤Ê¤É)
¤ò¤¢¤Þ¤ê¤¦¤Þ¤¯°·¤¦¤³¤È¤¬¤Ç¤­¤Ê¤¤¡£
.PP
.B makewhatis
.\"O does not work on preformatted translations.
¤ÏËÝÌõÈǤÎÀ°·ÁºÑ¤ß¥Ú¡¼¥¸¤Ç¤Ï¤¦¤Þ¤¯Æ°¤«¤Ê¤¤¡£
.\"O .SH AUTHOR
.\"O John W. Eaton was the original author of 
.\"O .BR "man" . 
.\"O Zeyd M. Ben-Halim released man 1.2, and Andries Brouwer followed up with versions 1.3 thru 1.5p.
.\"O Federico Lucifredi <flucifredi@acm.org> is the current maintainer.
.SH ºî¼Ô
.B "man"
¥Ñ¥Ã¥±¡¼¥¸¤Î¸¶ºî¼Ô¤Ï John W. Eaton ¤Ç¤¢¤ë¡£
Zeyd M. Ben-Halim ¤¬ man 1.2 ¤ò¥ê¥ê¡¼¥¹¤·¡¢°ú¤­Â³¤¤¤Æ Andries Brouwer ¤¬
versions 1.3 ¤«¤é 1.5p ¤Þ¤Ç¤ò¥ê¥ê¡¼¥¹¤·¤¿¡£
¸½ºß¤Î¥á¥ó¥Æ¥Ê¡¼¤Ï Federico Lucifredi <flucifredi@acm.org> ¤Ç¤¢¤ë¡£
.\"O .SH SEE ALSO
.SH ´ØÏ¢¹àÌÜ
.BR apropos (1),
.BR man (1),
.BR whatis (1)