.\"	$Id: man.conf.5,v 1.8 2020/02/10 14:42:10 schwarze Exp $
.\"
.\" Copyright (c) 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
.\"
.\" 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 February 10 2020
.Dt MAN.CONF 5
.Os
.Sh "نام (NAME)"
.Nm man.conf
.Nd پرونده پیکربندی برای man
.Sh "توضیحات (DESCRIPTION)"
این پرونده پیکربندی برای ابزارهای
.Xr man 1 ,
.Xr apropos 1
و
.Xr makewhatis 8
است.
وجود این پرونده و تمام دستورالعمل‌های درون آن اختیاری است.
.Pp
این یک پرونده متنی ASCII است.
فاصله‌های خالی ابتدای خطوط، خطوطی که با
.Sq #
آغاز می‌شوند و خطوط خالی نادیده گرفته می‌شوند.
کلمات با فاصله خالی از یکدیگر جدا می‌شوند.
نخستین کلمه در هر خط، نام یک دستورالعمل پیکربندی است.
.Pp
دستورالعمل‌های زیر پشتیبانی می‌شوند:
.Bl -tag -width Ds
.It Ic manpath Ar path
مسیر جستجوی پیش‌فرض
.Pq Ar path
را برای
.Xr man 1 ,
.Xr apropos 1
و
.Xr makewhatis 8
بازنویسی می‌کند.
می‌توان از این دستورالعمل چندین بار برای تعیین چندین مسیر استفاده کرد؛
ترتیب قرارگیری آن‌ها ترتیب جستجوی صفحات راهنما را مشخص می‌کند.
.Pp
هر مسیر درختی شامل زیردایرکتوری‌هایی است که نام آن‌ها از رشته‌های
.Sq man
و/یا
.Sq cat
به همراه نام بخش‌ها (معمولاً ارقام تک‌رقمی) تشکیل شده است.
دایرکتوری‌های نوع اول باید حاوی صفحات راهنمای قالب‌بندی‌نشده در قالب‌های
.Xr mdoc 7
و/یا
.Xr man 7
باشند؛ نام پرونده‌ها باید به نام بخش که پیش از آن یک نقطه آمده ختم شود.
دایرکتوری‌های نوع دوم باید حاوی صفحات راهنمای از پیش قالب‌بندی‌شده باشند؛
نام پرونده‌ها باید با
.Ql .0
پایان یابد.
.Pp
ایجاد یک پایگاه‌داده
.Xr mandoc.db 5
با استفاده از
.Xr makewhatis 8
در هر دایرکتوری پیکربندی‌شده با
.Ic manpath
توصیه می‌شود و برای کارکرد صحیح
.Xr apropos 1
ضروری است؛ همچنین برای
.Xr man 1
در سیستم‌عامل‌هایی مانند
.Ox
که هر صفحه راهنما را تنها با یک نام در سیستم پرونده نصب می‌کنند، حتی اگر چندین ابزار یا تابع را مستند کرده باشد، الزامی است.
.It Ic output Ar option Op Ar value
مقدار پیش‌فرض یک گزینه خروجی را پیکربندی می‌کند.
این دستورالعمل‌ها توسط گزینه‌های خط فرمان هم‌نام
.Fl O
لغو (بازنویسی) می‌شوند.
برای جزئیات بیشتر، راهنمای
.Xr mandoc 1
را ببینید.
.Pp
.Bl -column fragment integer "ascii, utf8" -compact
.It Ar option   Ta Ar value Ta used by Fl T Ta purpose
.It Ta Ta Ta
.It Ic fragment Ta none     Ta Cm html Ta چاپ تنها بخش بدنه
.It Ic includes Ta string   Ta Cm html Ta مسیر پرونده‌های هدر
.It Ic indent   Ta integer  Ta Cm ascii , utf8 Ta حاشیه چپ
.It Ic man      Ta string   Ta Cm html Ta مسیر پیوندهای \&Xr
.It Ic paper    Ta string   Ta Cm ps , pdf Ta اندازه کاغذ
.It Ic style    Ta string   Ta Cm html Ta پرونده CSS
.It Ic toc      Ta none     Ta Cm html Ta چاپ فهرست مطالب
.It Ic width    Ta integer  Ta Cm ascii , utf8 Ta حاشیه راست
.El
.El
.Sh "فایل‌ها (FILES)"
.Bl -tag -width /etc/examples/man.conf -compact
.It Pa /etc/man.conf
.El
.Sh "مثال‌ها (EXAMPLES)"
پرونده پیکربندی زیر مقادیر پیش‌فرض را بازتولید می‌کند؛
نصب آن معادل نداشتن پرونده
.Nm
است.
.Bd -literal -offset indent
manpath /usr/share/man
manpath /usr/X11R6/man
manpath /usr/local/man
.Ed
.Sh "همچنین ببینید (SEE ALSO)"
.Xr apropos 1 ,
.Xr man 1 ,
.Xr makewhatis 8
.Sh "تاریخچه (HISTORY)"
یک قالب نسبتاً پیچیده برای پرونده
.Nm
نخستین بار در
.Bx 4.3 Reno
ظاهر شد.
برای
.Ox 5.8 ,
با هدف سادگی، این قالب از ابتدا دوباره بازطراحی شد.
.Sh "نویسندگان (AUTHORS)"
.An Ingo Schwarze Aq Mt schwarze@openbsd.org