نام (NAME)

haredoc - خواندن و قالب‌بندی مستندات Hare

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

haredoc [-hanNt] [-F format] [-T tagset] [identifier|path]

توضیحات (DESCRIPTION)

دستور haredoc مستندات را از یک فایل منبع یا ماژول می‌خواند. اگر هیچ شناسه یا مسیری مشخص نشده باشد، مستندات از ماژول Hare موجود در دایرکتوری کاری جاری خوانده می‌شود، یا اگر دایرکتوری کاری جاری شامل ماژول Hare نباشد، از ریشه کتابخانه استاندارد خوانده خواهد شد (نگاه کنید به hare-module(5)).

اگر شناسه‌ای مشخص شود، ابتدا به عنوان یک اعلان (declaration) جستجو می‌شود. اگر اعلان مناسبی پیدا نشود، به جای آن به عنوان یک ماژول جستجو خواهد شد. شناسه ممکن است شامل یک :: در انتها باشد که در این صورت همواره به عنوان یک ماژول در نظر گرفته می‌شود. شناسه با استفاده از الگوریتم شرح داده شده در DEPENDENCY RESOLUTION در hare-module(5) تفکیک می‌شود.

گزینه‌ها (OPTIONS)

-h

چاپ متن راهنما.

-a

نمایش اعضای بدون مستندات.

-F format

انتخاب قالب خروجی (یکی از "html" یا "tty"). مقدار پیش‌فرض "tty" است.

-n

گنجاندن نام فایل‌ها و شماره خطوط اعلان‌های نماد در خروجی (تنها برای -Ftty اعمال می‌شود).

-N

چاپ نام فایل و شماره خط یک نماد منفرد در stdout و سپس خروج.

-t

غیرفعال کردن قالب HTML (تنها برای -Fhtml اعمال می‌شود).

-T tagset

تنظیم یا لغو تنظیم برچسب‌های ساخت. نگاه کنید به BUILD TAGS در hare-module(5).

سفارشی‌سازی رنگ‌ها (CUSTOMIZING COLORS)

مگر اینکه متغیر محیطی NO_COLOR روی یک رشته غیرخالی تنظیم شده باشد، رنگ‌ها در ترمینال با توالی‌های گریز ANSI SGR نمایش داده می‌شوند. این توالی‌ها را می‌توان با متغیر محیطی HAREDOC_COLORS سفارشی‌سازی کرد که از این قالب جداشده با فاصله خالی پیروی می‌کند:

HAREDOC_COLORS='key=seq key=seq ...'

هر مدخل key=seq یک توالی معتبر SGR به‌نام seq را به یک دسته‌بندی نحوی key اختصاص می‌دهد. یک seq معتبر باید تنها شامل ارقام و نقطه‌ویرگول باشد، یا یک کاراکتر زیرخط تک "_" باشد. در ادامه مدخل‌های پیش‌فرض اولیه آورده شده است:

1.: normal "0"
2.: primary "_" (-> normal)
3.: ident "_" (-> normal)
4.: comment "1"
5.: constant "_" (-> primary)
6.: function "_" (-> primary)
7.: global "_" (-> primary)
8.: typedef "_" (-> primary)
9.: import_alias "_" (-> normal)
10.: secondary "_" (-> normal)
11.: keyword "94"
12.: type "96"
13.: attribute "33"
14.: operator "1"
15.: punctuation "_" (-> normal)
16.: rune_string "91"
17.: number "95"
18.: label "_" (-> normal)

می‌توان هر تعداد مدخل را تعیین کرد. اگر یک seq برابر با زیرخط "_" باشد، توالی تعیین‌شده برای "normal" استفاده می‌شود، مگر اینکه key برابر با "constant"، "function"، "global" یا "typedef" باشد که در این حالت توالی تعیین‌شده برای "primary" به کار می‌رود. در غیر این صورت، چنانچه یک seq نامعتبر، خالی، سفید یا غایب باشد، توالی پیش‌فرض متناظر با آن اعمال خواهد شد.

برای مثال:

HAREDOC_COLORS='comment=3 primary=1;4 attribute=41' haredoc log::

محیط (ENVIRONMENT)

متغیرهای محیطی زیر بر اجرای haredoc اثر می‌گذارند:

HAREPATH	فهرست دایرکتوری‌ها برای جستجوی ماژول‌ها در آن‌ها. نگاه کنید به hare-module(5).
NO_COLOR	در صورت تنظیم روی یک رشته غیرخالی، تمام خروجی‌های رنگی را غیرفعال می‌کند.
HAREDOC_COLORS	نگاه کنید به بخش سفارشی‌سازی رنگ‌ها (CUSTOMIZING COLORS).
HAREDOC_HTML_SRC	رشته‌ای با ساختار fmt:: که به نشانی اینترنتی برای مرور برخط کد منبع یک نماد گسترش می‌یابد (برای -Fhtml استفاده می‌شود)؛ زمانی که مسیر فایل نسبت به دایرکتوری کاری و شماره خط به ترتیب به عنوان آرگومان‌های اول و دوم به fmt:: ارسال شوند.

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

haredoc(5)