نام (NAME)

apropos - جستجوی نامها و توضیحات صفحات راهنما

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

apropos [-dalv?V] [-e|-w|-r] [-s list] [-m system[,...]] [-M path] [-L locale] [-C file] keyword ...

توضیحات (DESCRIPTION)

هر صفحه راهنما شامل توضیح مختصری در درون خود است. دستور apropos این توضیحات را برای یافتن موارد منطبق با keyword (کلیدواژه) جستجو می‌کند.

keyword معمولاً یک عبارت باقاعده در نظر گرفته می‌شود، گویی از گزینه (-r) استفاده شده باشد؛ یا می‌تواند شامل نویسه‌های عام (-w) باشد، یا دقیقاً با کلیدواژه مطابقت داده شود (-e). هنگام استفاده از این گزینه‌ها، ممکن است لازم باشد keyword را درون گیومه قرار دهید یا نویسه‌های ویژه را با درج بک‌اسلش (\) اسکیپ کنید تا پوسته از تفسیر آن‌ها جلوگیری کند.

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

پایگاه داده‌ای که توسط apropos جستجو می‌شود، توسط برنامه mandb به‌روزرسانی می‌گردد. بسته به نحوه نصب سیستم شما، این کار ممکن است از طریق یک وظیفه دوره‌ای کرون (cron job) انجام شود، یا لازم باشد پس از نصب صفحات راهنمای جدید به‌صورت دستی اجرا گردد.

گزینهها (OPTIONS)

-d, --debug: چاپ اطلاعات اشکال‌زدایی.
-v, --verbose: چاپ پیام‌های هشدار با جزئیات بیشتر.
-r, --regex: تفسیر هر کلیدواژه به عنوان یک عبارت باقاعده. این رفتار پیش‌فرض است. هر کلیدواژه به‌طور مستقل با نام صفحات و بخش توضیحات تطبیق داده خواهد شد. این تطبیق می‌تواند با هر بخشی از هر دو مطابقت داشته باشد و به مرز کلمات محدود نمی‌شود.
-w, --wildcard: تفسیر هر کلیدواژه به عنوان یک الگو حاوی نویسه‌های عام (wildcard) به سبک پوسته. هر کلیدواژه به‌طور مستقل با نام صفحات و توضیحات تطبیق داده خواهد شد. اگر از گزینه --exact نیز استفاده شود، تطابق تنها در صورتی یافت می‌شود که کلیدواژه بسط‌یافته با کل یک توضیح یا نام صفحه مطابقت داشته باشد. در غیر این صورت، کلیدواژه مجاز است با مرز کلمات در بخش توضیحات نیز مطابقت یابد.
-e, --exact: تطبیق دقیق هر کلیدواژه با نام صفحات و بخش توضیحات.
-a, --and: تنها نمایش مواردی که با تمام کلیدواژه‌های ارائه‌شده مطابقت دارند. رفتار پیش‌فرض نمایش مواردی است که با هر یک از کلیدواژه‌ها همخوانی دارند.
-l, --long: عدم برش خروجی به اندازه عرض ترمینال. به‌طور معمول، خروجی به اندازه عرض ترمینال کوتاه می‌شود تا از نتایج نامناسب ناشی از بخش‌های NAME بد نگارش‌شده جلوگیری گردد.
-s list, --sections=list, --section=list: جستجو تنها در بخش‌های مشخص‌شده از صفحات راهنما. آرگومان list فهرستی از بخش‌ها است که با دونقطه یا کاما از هم جدا شده‌اند. اگر یک ورودی در list یک بخش ساده باشد (برای مثال "3")، فهرست نمایش‌داده‌شده از توضیحات شامل صفحاتی در بخش‌های "3"، "3perl"، "3x" و غیره خواهد بود؛ در حالی که اگر یک ورودی در list دارای پسوند باشد (برای مثال "3perl")، فهرست تنها شامل صفحاتی در همان بخش دقیق از صفحه راهنما خواهد بود.
-m system[,...], --systems=system[,...]: اگر سیستم جاری به توضیحات صفحات راهنمای سایر سیستم‌عامل‌ها دسترسی داشته باشد، می‌توان با استفاده از این گزینه آن‌ها را جستجو کرد. برای جستجوی توضیحات صفحات راهنمای NewOS، از گزینه -m NewOS استفاده کنید.

: مقدار مشخص‌شده برای system می‌تواند ترکیبی از نام‌های سیستم‌عامل‌ها باشد که با کاما از یکدیگر جدا شده‌اند. برای گنجاندن جستجو در توضیحات whatis سیستم‌عامل بومی، نام سیستم man را در رشته آرگومان درج کنید. این گزینه مقدار متغیر محیطی $SYSTEM را بازنویسی و لغو می‌کند.

-M path, --manpath=path: مشخص کردن مجموعه‌ای جایگزین از سلسله‌مراتب صفحات راهنما برای جستجو، که با دونقطه از هم جدا شده‌اند. به‌طور پیش‌فرض، apropos از متغیر محیطی $MANPATH استفاده می‌کند، مگر اینکه خالی باشد یا تنظیم نشده باشد؛ در این حالت، یک manpath مناسب را بر اساس متغیر محیطی $PATH شما تعیین خواهد کرد. این گزینه محتوای متغیر $MANPATH را بازنویسی و لغو می‌کند.
-L locale, --locale=locale: دستور apropos به‌طور معمول لوکال فعلی شما را با فراخوانی تابع C به نام setlocale(3) تعیین می‌کند که متغیرهای محیطی گوناگون، از جمله احتمالاً $LC_MESSAGES و $LANG را بررسی می‌نماید. برای لغو موقت مقدار تعیین‌شده، از این گزینه برای ارائه مستقیم رشته locale به apropos استفاده کنید. توجه داشته باشید که این تغییر تا زمانی که جستجو برای صفحات عملاً آغاز نشود اعمال نخواهد شد. خروجی‌هایی مانند پیام راهنما همواره بر اساس لوکال تعیین‌شده اولیه نمایش خواهند یافت.
-C file, --config-file=file: استفاده از این فایل پیکربندی کاربر به‌جای فایل پیش‌فرض در ~/.manpath.
-?, --help: چاپ پیام راهنما و خروج.
--usage: چاپ پیام کوتاه نحوه استفاده و خروج.
-V, --version: نمایش اطلاعات نسخه برنامه.

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

0: اجرای موفقیت‌آمیز برنامه.
1: خطای نحوه استفاده، نحو یا فایل پیکربندی.
2: خطای عملیاتی.
16: هیچ موردی منطبق با معیارهای مشخص‌شده یافت نشد.

محیط (ENVIRONMENT)

SYSTEM: اگر متغیر $SYSTEM تنظیم شده باشد، همان اثری را خواهد داشت که گویی به عنوان آرگومان به گزینه -m داده شده است.
MANPATH: اگر متغیر $MANPATH تنظیم شده باشد، مقدار آن به عنوان مسیر جستجوی سلسله‌مراتب صفحات راهنما (جداشده با دونقطه) تفسیر می‌شود.

: برای آگاهی از رفتار پیش‌فرض و جزئیات نحوه مدیریت این متغیر محیطی، به بخش SEARCH PATH در صفحه راهنمای manpath(5) مراجعه کنید.

MANWIDTH: اگر متغیر $MANWIDTH تنظیم شده باشد، مقدار آن به عنوان عرض ترمینال استفاده می‌شود (گزینه --long را ببینید). اگر تنظیم نشده باشد، عرض ترمینال با استفاده از مقدار $COLUMNS و در صورت دسترسی با ioctl(2) محاسبه می‌شود، و در غیر این صورت مقدار پیش‌فرض ۸۰ نویسه استفاده خواهد شد.
POSIXLY_CORRECT: اگر متغیر $POSIXLY_CORRECT تنظیم شده باشد (حتی با یک مقدار تهی)، جستجوی پیش‌فرض apropos به عنوان یک عبارت باقاعده گسترش‌یافته (-r) خواهد بود. امروزه در هر صورت این رفتار پیش‌فرض برنامه است.

فایلها (FILES)

/usr/share/man/index.(bt|db|dir|pag): حافظه نهان سنتی و سراسری پایگاه داده index.
/var/cache/man/index.(bt|db|dir|pag): حافظه نهان پایگاه داده سراسری index سازگار با استاندارد FHS.
/usr/share/man/.../whatis: پایگاه داده متنی سنتی whatis.

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

man(1), whatis(1), mandb(8)

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

Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).

گزارش اشکال (REPORTING BUGS)

https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db