.\" Generated by scdoc 1.11.4
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "haredoc" "1" "2026-06-01"
.PP
.SH "نام (NAME)"
.PP
haredoc \- خواندن و قالب‌بندی مستندات Hare
.PP
.SH "خلاصه دستور (SYNOPSIS)"
.PP
\fBharedoc\fR [-hanNt] [-F \fIformat\fR] [-T \fItagset\fR] [\fIidentifier\fR|\fIpath\fR]
.PP
.SH "توضیحات (DESCRIPTION)"
.PP
دستور \fBharedoc\fR مستندات را از یک فایل منبع یا ماژول می‌خواند.\& اگر هیچ شناسه یا
مسیری مشخص نشده باشد، مستندات از ماژول Hare موجود در دایرکتوری کاری جاری خوانده
می‌شود، یا اگر دایرکتوری کاری جاری شامل ماژول Hare نباشد، از ریشه کتابخانه استاندارد
خوانده خواهد شد (نگاه کنید به \fBhare-module\fR(5)).\&
.PP
اگر شناسه‌ای مشخص شود، ابتدا به عنوان یک اعلان (declaration) جستجو می‌شود.\& اگر
اعلان مناسبی پیدا نشود، به جای آن به عنوان یک ماژول جستجو خواهد شد.\& شناسه ممکن است
شامل یک :: در انتها باشد که در این صورت همواره به عنوان یک ماژول در نظر گرفته
می‌شود.\& شناسه با استفاده از الگوریتم شرح داده شده در \fBDEPENDENCY RESOLUTION\fR
در \fBhare-module\fR(5) تفکیک می‌شود.\&
.PP
.SH "گزینه‌ها (OPTIONS)"
.PP
\fB-h\fR
.RS 4
چاپ متن راهنما.\&
.PP
.RE
\fB-a\fR
.RS 4
نمایش اعضای بدون مستندات.\&
.PP
.RE
\fB-F\fR \fIformat\fR
.RS 4
انتخاب قالب خروجی (یکی از "html" یا "tty").\& مقدار پیش‌فرض "tty" است.\&
.PP
.RE
\fB-n\fR
.RS 4
گنجاندن نام فایل‌ها و شماره خطوط اعلان‌های نماد در خروجی (تنها برای \fB-Ftty\fR اعمال می‌شود).\&
.PP
.RE
\fB-N\fR
.RS 4
چاپ نام فایل و شماره خط یک نماد منفرد در stdout و سپس خروج.\&
.PP
.RE
\fB-t\fR
.RS 4
غیرفعال کردن قالب HTML (تنها برای \fB-Fhtml\fR اعمال می‌شود).\&
.PP
.RE
\fB-T\fR \fItagset\fR
.RS 4
تنظیم یا لغو تنظیم برچسب‌های ساخت.\& نگاه کنید به \fBBUILD TAGS\fR در \fBhare-module\fR(5).\&
.PP
.RE
.SH "سفارشی‌سازی رنگ‌ها (CUSTOMIZING COLORS)"
.PP
مگر اینکه متغیر محیطی \fBNO_COLOR\fR روی یک رشته غیرخالی تنظیم شده باشد، رنگ‌ها در
ترمینال با توالی‌های گریز ANSI SGR نمایش داده می‌شوند.\& این توالی‌ها را می‌توان با متغیر
محیطی \fBHAREDOC_COLORS\fR سفارشی‌سازی کرد که از این قالب جداشده با فاصله خالی پیروی می‌کند:
.PP
.RS 4
HAREDOC_COLORS='\&\fIkey\fR=\fIseq\fR \fIkey\fR=\fIseq\fR \fI.\&.\&.\&\fR'\&
.PP
.RE
هر مدخل \fIkey=seq\fR یک توالی معتبر SGR به‌نام \fIseq\fR را به یک دسته‌بندی نحوی \fIkey\fR
اختصاص می‌دهد.\& یک \fIseq\fR معتبر باید تنها شامل ارقام و نقطه‌ویرگول باشد، یا یک
کاراکتر زیرخط تک "_" باشد.\& در ادامه مدخل‌های پیش‌فرض اولیه آورده شده است:
.PP
.PD 0
.IP 1. 4
normal        "0"
.IP 2. 4
primary       "_" (-> normal)
.IP 3. 4
ident         "_" (-> normal)
.IP 4. 4
comment       "1"
.IP 5. 4
constant      "_" (-> primary)
.IP 6. 4
function      "_" (-> primary)
.IP 7. 4
global        "_" (-> primary)
.IP 8. 4
typedef       "_" (-> primary)
.IP 9. 4
import_alias  "_" (-> normal)
.IP 10. 4
secondary     "_" (-> normal)
.IP 11. 4
keyword       "94"
.IP 12. 4
type          "96"
.IP 13. 4
attribute     "33"
.IP 14. 4
operator      "1"
.IP 15. 4
punctuation   "_" (-> normal)
.IP 16. 4
rune_string   "91"
.IP 17. 4
number        "95"
.IP 18. 4
label         "_" (-> normal)
.PD
.PP
می‌توان هر تعداد مدخل را تعیین کرد.\& اگر یک \fIseq\fR برابر با زیرخط "_" باشد، توالی
تعیین‌شده برای "normal" استفاده می‌شود، مگر اینکه \fIkey\fR برابر با "constant"،
"function"، "global" یا "typedef" باشد که در این حالت توالی تعیین‌شده برای
"primary" به کار می‌رود.\& در غیر این صورت، چنانچه یک \fIseq\fR نامعتبر، خالی، سفید یا غایب
باشد، توالی پیش‌فرض متناظر با آن اعمال خواهد شد.\&
.PP
برای مثال:
.PP
.RS 4
HAREDOC_COLORS='\&comment=3 primary=1;4 attribute=41'\& haredoc log::
.PP
.RE
.SH "محیط (ENVIRONMENT)"
.PP
متغیرهای محیطی زیر بر اجرای \fBharedoc\fR اثر می‌گذارند:
.PP
.TS
l lx
l lx
l lx
l lx.
T{
\fBHAREPATH\fR
T}	T{
فهرست دایرکتوری‌ها برای جستجوی ماژول‌ها در آن‌ها.\& نگاه کنید به \fBhare-module\fR(5).\&
T}
T{
\fBNO_COLOR\fR
T}	T{
در صورت تنظیم روی یک رشته غیرخالی، تمام خروجی‌های رنگی را غیرفعال می‌کند.\&
T}
T{
\fBHAREDOC_COLORS\fR
T}	T{
نگاه کنید به بخش \fBسفارشی‌سازی رنگ‌ها (CUSTOMIZING COLORS)\fR.\&
T}
T{
\fBHAREDOC_HTML_SRC\fR
T}	T{
رشته‌ای با ساختار fmt:: که به نشانی اینترنتی برای مرور برخط کد منبع یک نماد گسترش می‌یابد (برای \fB-Fhtml\fR استفاده می‌شود)؛ زمانی که مسیر فایل نسبت به دایرکتوری کاری و شماره خط به ترتیب به عنوان آرگومان‌های اول و دوم به fmt:: ارسال شوند.\&
T}
.TE
.sp 1
.SH "همچنین ببینید (SEE ALSO)"
.PP
\fBharedoc\fR(5)