.\" Man page for whatis
.\"
.\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.)
.\"
.\" You may distribute under the terms of the GNU General Public
.\" License as specified in the file docs/COPYING.GPLv2 that comes with the
.\" man-db distribution.
.\"
.\" Sat Oct 29 13:09:31 GMT 1994  Wilf. (G.Wilford@ee.surrey.ac.uk)
.\"
.pc
.TH WHATIS 1 "2025-05-02" "2.13.1" "Manual pager utils"
.SH "نام (NAME)"
whatis \- نمایش توضیحات یک‌خطی صفحات راهنما
.SH "خلاصه دستور (SYNOPSIS)"
.B whatis
.RB [\| \-dlv?V \|]
.RB [\| \-r \||\| \-w\c
\|]
.RB [\| \-s
.IR list \|]
.RB [\| \-m
.IR system \|[\|,.\|.\|.\|]\|]
.RB [\| \-M
.IR path \|]
.RB [\| \-L
.IR locale \|]
.RB [\| \-C
.IR file \|]
.I name
\&.\|.\|.
.SH "توضیحات (DESCRIPTION)"
هر صفحه راهنما شامل توضیح مختصری در درون خود است.
دستور
.B whatis
نام‌های صفحات راهنما را جستجو کرده و توضیحات صفحه راهنما را برای هر
.I name
منطبق نمایش می‌دهد.
.PP
.I name
می‌تواند شامل نویسه‌های عام
.RB ( \-w )
یا یک عبارت باقاعده
.RB ( \-r )
باشد.
با استفاده از این گزینه‌ها، ممکن است لازم باشد
.I name
را درون گیومه قرار دهید یا نویسه‌های ویژه را با درج بک‌اسلش (\\) اسکیپ کنید تا پوسته از تفسیر آن‌ها جلوگیری کند.
.PP
پایگاه‌های داده
.B index
در حین جستجو استفاده می‌شوند و توسط برنامه
.B mandb
به‌روزرسانی می‌گردند.
بسته به نحوه نصب سیستم شما، این کار ممکن است از طریق یک وظیفه دوره‌ای کرون (cron job) اجرا شود، یا لازم باشد پس از نصب صفحات راهنمای جدید به‌صورت دستی اجرا گردد.
برای تولید یک پایگاه داده متنی سنتی
.B whatis
از پایگاه داده متناظر
.BR index ،
دستور زیر را اجرا کنید:
.PP
.B whatis \-M
.I manpath
.B \-w  '*' | sort >
.I manpath/whatis
.PP
که در آن
.I manpath
یک سلسله‌مراتب صفحه راهنما مانند
.IR /usr/man
است.
.SH "گزینه‌ها (OPTIONS)"
.TP
.BR \-d ", " \-\-debug
چاپ اطلاعات اشکال‌زدایی.
.TP
.BR \-v ", " \-\-verbose
چاپ پیام‌های هشدار با جزئیات بیشتر.
.TP
.BR \-r ", " \-\-regex
تفسیر هر
.I name
به عنوان یک عبارت باقاعده.
اگر یک
.I name
با هر بخشی از نام یک صفحه مطابقت داشته باشد، تطابق برقرار خواهد شد.
این گزینه به دلیل ماهیت جستجوهای پایگاه داده، موجب می‌شود
.B whatis
تا حدی کندتر عمل کند.
.TP
.BR \-w ", " \-\-wildcard
تفسیر هر
.I name
به عنوان الگویی حاوی نویسه‌های عام به سبک پوسته.
برای برقراری تطابق، یک
.I name
بسط‌یافته باید با کل نام صفحه مطابقت داشته باشد.
این گزینه به دلیل ماهیت جستجوهای پایگاه داده، موجب می‌شود
.B whatis
تا حدی کندتر عمل کند.
.TP
.BR \-l ", " \-\-long
عدم برش خروجی به اندازه عرض ترمینال.
به‌طور معمول، خروجی به اندازه عرض ترمینال کوتاه می‌شود تا از نتایج نامناسب ناشی از بخش‌های
.B NAME
بد نگارش‌شده جلوگیری شود.
.TP
\fB\-s\fR \fIlist\/\fR, \
\fB\-\-sections=\fIlist\/\fR, \
\fB\-\-section=\fIlist\fR
جستجو تنها در بخش‌های مشخص‌شده از صفحات راهنما.
آرگومان
.I list
فهرستی از بخش‌ها است که با دونقطه یا کاما از هم جدا شده‌اند.
اگر یک ورودی در
.I list
یک بخش ساده باشد (برای مثال "3")، فهرست نمایش‌داده‌شده از توضیحات شامل صفحاتی در بخش‌های "3"، "3perl"، "3x" و غیره خواهد بود؛
در حالی که اگر یک ورودی در
.I list
دارای پسوند باشد (برای مثال "3perl")، فهرست تنها شامل صفحاتی در همان بخش دقیق از صفحه راهنما خواهد بود.
.TP
\fB\-m\fR \fIsystem\fR\|[\|,.\|.\|.\|]\|, \
\fB\-\-systems=\fIsystem\fR\|[\|,.\|.\|.\|]
اگر این سیستم به نام‌های صفحات راهنمای سایر سیستم‌عامل‌ها دسترسی داشته باشد، می‌توان با استفاده از این گزینه به آن‌ها دسترسی پیدا کرد.
برای جستجوی نام‌های صفحات راهنمای NewOS، از گزینه
.B \-m
.BR NewOS
استفاده کنید.
.IP
مقدار مشخص‌شده برای
.I system
می‌تواند ترکیبی از نام‌های سیستم‌عامل‌ها باشد که با کاما از یکدیگر جدا شده‌اند.
برای گنجاندن جستجو در نام‌های صفحات راهنمای سیستم‌عامل بومی، نام سیستم
.B man
را در رشته آرگومان درج کنید.
این گزینه مقدار متغیر محیطی
.RB $ SYSTEM
را بازنویسی و لغو می‌کند.
.TP
.BI \-M\  path \fR,\ \fB\-\-manpath= path
مشخص کردن مجموعه‌ای جایگزین از سلسله‌مراتب صفحات راهنما برای جستجو، که با دونقطه از هم جدا شده‌اند.
به‌طور پیش‌فرض،
.B whatis
از متغیر محیطی
.RB $ MANPATH
استفاده می‌کند، مگر اینکه خالی باشد یا تنظیم نشده باشد؛ در این حالت، یک manpath مناسب را بر اساس متغیر محیطی
.RB $ PATH
شما تعیین خواهد کرد.
این گزینه محتوای متغیر
.RB $ MANPATH
را بازنویسی و لغو می‌کند.
.TP
.BI \-L\  locale \fR,\ \fB\-\-locale= locale
دستور
.B whatis
به‌طور معمول لوکال فعلی شما را با فراخوانی تابع C به نام
.BR setlocale (3)
تعیین می‌کند که متغیرهای محیطی گوناگون، از جمله احتمالاً
.RB $ LC_MESSAGES
و
.RB $ LANG
را بررسی می‌نماید.
برای لغو موقت مقدار تعیین‌شده، از این گزینه برای ارائه مستقیم رشته
.I locale
به
.B whatis
استفاده کنید.
توجه داشته باشید که این تغییر تا زمانی که جستجو برای صفحات عملاً آغاز نشود اعمال نخواهد شد.
خروجی‌هایی مانند پیام راهنما همواره بر اساس لوکال تعیین‌شده اولیه نمایش خواهند یافت.
.TP
.BI \-C\  file \fR,\ \fB\-\-config\-file= file
استفاده از این فایل پیکربندی کاربر به‌جای فایل پیش‌فرض در
.IR \(ti/.manpath .
.TP
.BR \-? ", " \-\-help
چاپ پیام راهنما و خروج.
.TP
.B \-\-usage
چاپ پیام کوتاه نحوه استفاده و خروج.
.TP
.BR \-V ", " \-\-version
نمایش اطلاعات نسخه برنامه.
.SH "وضعیت خروج (EXIT STATUS)"
.TP
.B 0
اجرای موفقیت‌آمیز برنامه.
.TP
.B 1
خطای نحوه استفاده، نحو یا فایل پیکربندی.
.TP
.B 2
خطای عملیاتی.
.TP
.B 16
هیچ موردی منطبق با معیارهای مشخص‌شده یافت نشد.
.SH "محیط (ENVIRONMENT)"
.TP
.B SYSTEM
اگر متغیر
.RB $ SYSTEM
تنظیم شده باشد، همان اثری را خواهد داشت که گویی به عنوان آرگومان به گزینه
.B \-m
داده شده است.
.TP
.B MANPATH
اگر متغیر
.RB $ MANPATH
تنظیم شده باشد، مقدار آن به عنوان مسیر جستجوی سلسله‌مراتب صفحات راهنما (جداشده با دونقطه) تفسیر می‌شود.
.IP
برای آگاهی از رفتار پیش‌فرض و جزئیات نحوه مدیریت این متغیر محیطی، به بخش
.B SEARCH PATH
در صفحه راهنمای
.BR manpath (5)
مراجعه کنید.
.TP
.B MANWIDTH
اگر متغیر
.RB $ MANWIDTH
تنظیم شده باشد، مقدار آن به عنوان عرض ترمینال استفاده می‌شود (گزینه
.B \-\-long
را ببینید).
اگر تنظیم نشده باشد، عرض ترمینال با استفاده از مقدار
.RB $ COLUMNS
و در صورت دسترسی با
.BR ioctl (2)
محاسبه می‌شود، و در غیر این صورت مقدار پیش‌فرض ۸۰ نویسه استفاده خواهد شد.
.SH "فایل‌ها (FILES)"
.TP
.I /usr/share/man/index.(bt|db|dir|pag)
حافظه نهان سنتی و سراسری پایگاه داده
.IR index .
.TP
.I /var/cache/man/index.(bt|db|dir|pag)
حافظه نهان پایگاه داده سراسری
.I index
سازگار با استاندارد FHS.
.TP
.I /usr/share/man/\|.\|.\|.\|/whatis
پایگاه داده متنی سنتی
.BR whatis .
.SH "همچنین ببینید (SEE ALSO)"
.BR apropos (1),
.BR man (1),
.BR mandb (8)
.SH "نویسندگان (AUTHORS)"
.nf
Wilf.\& (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).
.fi
.SH "اشکالات (BUGS)"
https://gitlab.com/man-db/man-db/\-/issues
.br
https://savannah.nongnu.org/bugs/?group=man\-db