نام (NAME)

man.conf — پرونده پیکربندی برای man

توضیحات (DESCRIPTION)

این پرونده پیکربندی برای ابزارهای man(1), apropos(1) و makewhatis(8) است. وجود این پرونده و تمام دستورالعمل‌های درون آن اختیاری است.

این یک پرونده متنی ASCII است. فاصله‌های خالی ابتدای خطوط، خطوطی که با ‘#’ آغاز می‌شوند و خطوط خالی نادیده گرفته می‌شوند. کلمات با فاصله خالی از یکدیگر جدا می‌شوند. نخستین کلمه در هر خط، نام یک دستورالعمل پیکربندی است.

دستورالعمل‌های زیر پشتیبانی می‌شوند:

manpath path

مسیر جستجوی پیش‌فرض (path) را برای man(1), apropos(1) و makewhatis(8) بازنویسی می‌کند. می‌توان از این دستورالعمل چندین بار برای تعیین چندین مسیر استفاده کرد؛ ترتیب قرارگیری آن‌ها ترتیب جستجوی صفحات راهنما را مشخص می‌کند.

هر مسیر درختی شامل زیردایرکتوری‌هایی است که نام آن‌ها از رشته‌های ‘man’ و/یا ‘cat’ به همراه نام بخش‌ها (معمولاً ارقام تک‌رقمی) تشکیل شده است. دایرکتوری‌های نوع اول باید حاوی صفحات راهنمای قالب‌بندی‌نشده در قالب‌های mdoc(7) و/یا man(7) باشند؛ نام پرونده‌ها باید به نام بخش که پیش از آن یک نقطه آمده ختم شود. دایرکتوری‌های نوع دوم باید حاوی صفحات راهنمای از پیش قالب‌بندی‌شده باشند؛ نام پرونده‌ها باید با ‘.0’ پایان یابد.

ایجاد یک پایگاه‌داده mandoc.db(5) با استفاده از makewhatis(8) در هر دایرکتوری پیکربندی‌شده با manpath توصیه می‌شود و برای کارکرد صحیح apropos(1) ضروری است؛ همچنین برای man(1) در سیستم‌عامل‌هایی مانند OpenBSD که هر صفحه راهنما را تنها با یک نام در سیستم پرونده نصب می‌کنند، حتی اگر چندین ابزار یا تابع را مستند کرده باشد، الزامی است.

output option [value]

مقدار پیش‌فرض یک گزینه خروجی را پیکربندی می‌کند. این دستورالعمل‌ها توسط گزینه‌های خط فرمان هم‌نام -O لغو (بازنویسی) می‌شوند. برای جزئیات بیشتر، راهنمای mandoc(1) را ببینید.

`option`	`value`	used by `-T`	purpose

`fragment`	none	`html`	چاپ تنها بخش بدنه
`includes`	string	`html`	مسیر پرونده‌های هدر
`indent`	integer	`ascii`, `utf8`	حاشیه چپ
`man`	string	`html`	مسیر پیوندهای Xr
`paper`	string	`ps`, `pdf`	اندازه کاغذ
`style`	string	`html`	پرونده CSS
`toc`	none	`html`	چاپ فهرست مطالب
`width`	integer	`ascii`, `utf8`	حاشیه راست

فایل‌ها (FILES)

/etc/man.conf

مثال‌ها (EXAMPLES)

پرونده پیکربندی زیر مقادیر پیش‌فرض را بازتولید می‌کند؛ نصب آن معادل نداشتن پرونده man.conf است.

manpath /usr/share/man
manpath /usr/X11R6/man
manpath /usr/local/man

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

apropos(1), man(1), makewhatis(8)

تاریخچه (HISTORY)

یک قالب نسبتاً پیچیده برای پرونده man.conf نخستین بار در 4.3BSD-Reno ظاهر شد. برای OpenBSD 5.8, با هدف سادگی، این قالب از ابتدا دوباره بازطراحی شد.

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

Ingo Schwarze <schwarze@openbsd.org>