.\" $Id: makewhatis.8,v 1.6 2017/05/17 22:27:12 schwarze Exp $ .\" .\" Copyright (c) 2011, 2012 Kristaps Dzonsons .\" Copyright (c) 2011, 2012, 2014, 2017 Ingo Schwarze .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. .\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" .Dd $Mdocdate: May 17 2017 $ .Dt MAKEWHATIS 8 .Os .Sh "نام (NAME)" .Nm makewhatis .Nd نمایه سازی پایگاه داده whatis و صفحات راهنما .Sh "خلاصه دستور (SYNOPSIS)" .Nm .Op Fl aDnpQ .Op Fl T Cm utf8 .Op Fl C Ar file .Nm .Op Fl aDnpQ .Op Fl T Cm utf8 .Ar dir ... .Nm .Op Fl DnpQ .Op Fl T Cm utf8 .Fl d Ar dir .Op Ar .Nm .Op Fl Dnp .Op Fl T Cm utf8 .Fl u Ar dir .Op Ar .Nm .Op Fl DQ .Fl t Ar .Sh "توضیحات (DESCRIPTION)" ابزار .Nm کلمات کلیدی را از صفحات راهنمای .Ux استخراج کرده و آن‌ها را برای بازیابی سریع توسط .Xr apropos 1 , .Xr whatis 1 و گزینهٔ .Fl k دستور .Xr man 1 در یک پایگاه داده نمایه می‌کند. .Pp به‌طور پیش‌فرض، .Nm با استفاده از فایل‌های .Sm off .Sy man Ar section Li / .Op Ar arch Li / .Ar title . section .Sm on و .Sm off .Sy cat Ar section Li / .Op Ar arch Li / .Ar title . Sy 0 .Sm on درون هر .Ar dir یک پایگاه داده در آن دایرکتوری ایجاد می‌کند. پایگاه‌های داده موجود جایگزین می‌شوند. اگر یک دایرکتوری فاقد هرگونه صفحه راهنما باشد، هیچ پایگاه داده‌ای در آن دایرکتوری ایجاد نمی‌شود. اگر .Ar dir مشخص نشود، .Nm از مسیرهای پیش‌فرض تعیین‌شده توسط .Xr man.conf 5 استفاده می‌کند. .Pp آرگومان‌ها به شرح زیر هستند: .Bl -tag -width "-C file" .It Fl a استفاده از تمام دایرکتوری‌ها و فایل‌های یافت‌شده در زیر .Ar dir ... . .It Fl C Ar file مشخص کردن یک .Ar file پیکربندی جایگزین در قالب .Xr man.conf 5 . .It Fl D نمایش تمامی فایل‌های اضافه‌شده یا حذف‌شده به نمایه. همراه با یک .Fl D دوم، نمایش تمام کلمات کلیدی اضافه‌شده برای هر فایل. .It Fl d Ar dir ادغام کردن (حذف و افزودن دوباره) .Ar در پایگاه داده واقع در .Ar dir . .It Fl n عدم ایجاد یا تغییر هرگونه پایگاه داده؛ تنها پویش و تجزیه انجام می‌شود، و نام‌ها و توضیحات صفحات راهنما در خروجی استاندارد چاپ می‌شوند. .It Fl p چاپ هشدارهای مربوط به مشکلات احتمالی در صفحات راهنما در خروجی خطای استاندارد. .It Fl Q ساخت سریع پایگاه‌های داده با حجم کاهش‌یافته از طریق خواندن فقط بخش‌های NAME صفحات راهنما. پایگاه‌های داده حاصل معمولاً تنها حاوی نام‌ها و توضیحات خواهند بود. .It Fl T Cm utf8 استفاده از کدگذاری UTF-8 به‌جای ASCII برای رشته‌های ذخیره‌شده در پایگاه‌های داده. .It Fl t Ar بررسی .Ar files داده‌شده برای مشکلات احتمالی. دربردارنده .Fl a , .Fl n و .Fl p . تمام پیام‌های تشخیصی در خروجی استاندارد چاپ می‌شوند؛ از خروجی خطای استاندارد استفاده نمی‌شود. .It Fl u Ar dir حذف .Ar از پایگاه داده واقع در .Ar dir . اگر این عمل باعث خالی شدن پایگاه داده شود، فایل پایگاه داده نیز حذف می‌شود. .El .Pp در صورت بروز خطاهای مهلک در حین تجزیه، فایل متخلف در خروجی خطای استاندارد چاپ شده، از نمایه کنار گذاشته می‌شود، و تجزیه با فایل ورودی بعدی ادامه می‌یابد. .Sh "محیط (ENVIRONMENT)" .Bl -tag -width MANPATH .It Ev MANPATH فهرستی از دایرکتوری‌ها با جداکننده دونقطه برای ایجاد پایگاه‌های داده در آن‌ها. در صورت مشخص شدن یک آرگومان .Ar dir یا گزینه .Fl t نادیده گرفته می‌شود. .El .Sh "فایل‌ها (FILES)" .Bl -tag -width Ds .It Pa mandoc.db پایگاه داده‌ای از صفحات راهنما متناسب با دایرکتوری فایل. این فایل در میان معماری‌ها و سیستم‌های گوناگون قابل حمل است، مادامی که ساختار سلسله‌مراتبی صفحات راهنما که نمایه می‌کند تغییر نکند. .It Pa /etc/man.conf فایل پیکربندی پیش‌فرض .Xr man 1 . .El .Sh "وضعیت خروج (EXIT STATUS)" ابزار .Nm با یکی از مقادیر زیر خارج می‌شود: .Pp .Bl -tag -width Ds -compact .It 0 هیچ خطایی رخ نداد. .It 5 آرگومان‌های خط فرمان نامعتبر مشخص شده‌اند. هیچ فایل ورودی خوانده نشده است. .It 6 یک خطای سیستم‌عامل رخ داد، برای نمونه اتمام حافظه یا خطا در دسترسی به فایل‌های ورودی. چنین خطاهایی باعث خروج فوری .Nm می‌شوند، احتمالاً در میانه تجزیه یا قالب‌بندی یک فایل. پایگاه‌های داده خروجی خراب شده‌اند و باید حذف شوند. .El .Sh "همچنین ببینید (SEE ALSO)" .Xr apropos 1 , .Xr man 1 , .Xr whatis 1 , .Xr man.conf 5 .Sh "تاریخچه (HISTORY)" ابزار .Nm نخستین بار در .Bx 2 ظاهر شد. این ابزار به زبان .Xr perl 1 برای .Ox 2.7 و به زبان C برای .Ox 5.6 بازنویسی شد. .Pp آرگومان .Ar dir نخستین بار در .Nx 1.0 ، گزینه‌های .Fl dpt در .Ox 2.7 ، گزینه .Fl u در .Ox 3.4 و گزینه‌های .Fl aCDnQT در .Ox 5.6 ظاهر شدند. .Sh "نویسندگان (AUTHORS)" .An -nosplit .An Bill Joy نسخه اصلی .Nm را در فوریه ۱۹۷۹ در .Bx نوشت، .An Marc Espie نسخه Perl را در سال ۲۰۰۰ آغاز کرد، و نسخه کنونی .Nm توسط .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv و .An Ingo Schwarze Aq Mt schwarze@openbsd.org نوشته شده است.