نام (NAME)

makewhatis — نمایه سازی پایگاه داده whatis و صفحات راهنما

خلاصه دستور (SYNOPSIS)

makewhatis [-aDnpQ] [-T utf8] [-C file] makewhatis [-aDnpQ] [-T utf8] dir ... makewhatis [-DnpQ] [-T utf8] -d dir [file ...] makewhatis [-Dnp] [-T utf8] -u dir [file ...] makewhatis [-DQ] -t file ...

توضیحات (DESCRIPTION)

ابزار makewhatis کلمات کلیدی را از صفحات راهنمای UNIX استخراج کرده و آن‌ها را برای بازیابی سریع توسط apropos(1), whatis(1) و گزینهٔ -k دستور man(1) در یک پایگاه داده نمایه می‌کند.

به‌طور پیش‌فرض، makewhatis با استفاده از فایل‌های mansection/[arch/]title.section و catsection/[arch/]title.0 درون هر dir یک پایگاه داده در آن دایرکتوری ایجاد می‌کند. پایگاه‌های داده موجود جایگزین می‌شوند. اگر یک دایرکتوری فاقد هرگونه صفحه راهنما باشد، هیچ پایگاه داده‌ای در آن دایرکتوری ایجاد نمی‌شود. اگر dir مشخص نشود، makewhatis از مسیرهای پیش‌فرض تعیین‌شده توسط man.conf(5) استفاده می‌کند.

آرگومان‌ها به شرح زیر هستند:

-a

استفاده از تمام دایرکتوری‌ها و فایل‌های یافت‌شده در زیر dir ....

-C file

مشخص کردن یک file پیکربندی جایگزین در قالب man.conf(5).

-D

نمایش تمامی فایل‌های اضافه‌شده یا حذف‌شده به نمایه. همراه با یک -D دوم، نمایش تمام کلمات کلیدی اضافه‌شده برای هر فایل.

-d dir

ادغام کردن (حذف و افزودن دوباره) file ... در پایگاه داده واقع در dir.

-n

عدم ایجاد یا تغییر هرگونه پایگاه داده؛ تنها پویش و تجزیه انجام می‌شود، و نام‌ها و توضیحات صفحات راهنما در خروجی استاندارد چاپ می‌شوند.

-p

چاپ هشدارهای مربوط به مشکلات احتمالی در صفحات راهنما در خروجی خطای استاندارد.

-Q

ساخت سریع پایگاه‌های داده با حجم کاهش‌یافته از طریق خواندن فقط بخش‌های NAME صفحات راهنما. پایگاه‌های داده حاصل معمولاً تنها حاوی نام‌ها و توضیحات خواهند بود.

-T utf8

استفاده از کدگذاری UTF-8 به‌جای ASCII برای رشته‌های ذخیره‌شده در پایگاه‌های داده.

-t file ...

بررسی files داده‌شده برای مشکلات احتمالی. دربردارنده -a, -n و -p. تمام پیام‌های تشخیصی در خروجی استاندارد چاپ می‌شوند؛ از خروجی خطای استاندارد استفاده نمی‌شود.

-u dir

حذف file ... از پایگاه داده واقع در dir. اگر این عمل باعث خالی شدن پایگاه داده شود، فایل پایگاه داده نیز حذف می‌شود.

در صورت بروز خطاهای مهلک در حین تجزیه، فایل متخلف در خروجی خطای استاندارد چاپ شده، از نمایه کنار گذاشته می‌شود، و تجزیه با فایل ورودی بعدی ادامه می‌یابد.

محیط (ENVIRONMENT)

MANPATH

فهرستی از دایرکتوری‌ها با جداکننده دونقطه برای ایجاد پایگاه‌های داده در آن‌ها. در صورت مشخص شدن یک آرگومان dir یا گزینه -t نادیده گرفته می‌شود.

فایل‌ها (FILES)

mandoc.db

پایگاه داده‌ای از صفحات راهنما متناسب با دایرکتوری فایل. این فایل در میان معماری‌ها و سیستم‌های گوناگون قابل حمل است، مادامی که ساختار سلسله‌مراتبی صفحات راهنما که نمایه می‌کند تغییر نکند.

/etc/man.conf

فایل پیکربندی پیش‌فرض man(1).

وضعیت خروج (EXIT STATUS)

ابزار makewhatis با یکی از مقادیر زیر خارج می‌شود:

0

هیچ خطایی رخ نداد.

5

آرگومان‌های خط فرمان نامعتبر مشخص شده‌اند. هیچ فایل ورودی خوانده نشده است.

6

یک خطای سیستم‌عامل رخ داد، برای نمونه اتمام حافظه یا خطا در دسترسی به فایل‌های ورودی. چنین خطاهایی باعث خروج فوری makewhatis می‌شوند، احتمالاً در میانه تجزیه یا قالب‌بندی یک فایل. پایگاه‌های داده خروجی خراب شده‌اند و باید حذف شوند.

همچنین ببینید (SEE ALSO)

apropos(1), man(1), whatis(1), man.conf(5)

تاریخچه (HISTORY)

ابزار makewhatis نخستین بار در 2BSD ظاهر شد. این ابزار به زبان perl(1) برای OpenBSD 2.7 و به زبان C برای OpenBSD 5.6 بازنویسی شد.

آرگومان dir نخستین بار در NetBSD 1.0 ، گزینه‌های -dpt در OpenBSD 2.7 ، گزینه -u در OpenBSD 3.4 و گزینه‌های -aCDnQT در OpenBSD 5.6 ظاهر شدند.

نویسندگان (AUTHORS)

Bill Joy نسخه اصلی makewhatis را در فوریه ۱۹۷۹ در BSD نوشت، Marc Espie نسخه Perl را در سال ۲۰۰۰ آغاز کرد، و نسخه کنونی makewhatis توسط Kristaps Dzonsons <kristaps@bsd.lv> و Ingo Schwarze <schwarze@openbsd.org> نوشته شده است.