نام (NAME)

chkhelp - بررسی فایل‌های متنی راهنمای معیارهای کارایی

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

$PCP_BINADM_DIR/chkhelp [-eHiOp?] [-D debug] [-n pmnsfile] helpfile [metricname ...]

توضیحات (DESCRIPTION)

دستور chkhelp سازگاری فایل‌های متن راهنمای Performance Co-Pilot را که توسط newhelp(1) تولید شده و توسط عامل‌های دامنه معیار کارایی (PMDAها) استفاده می‌شوند، بررسی می‌کند. این بررسی شامل پیمایش فایل‌ها و در صورت تمایل، نمایش مدخل‌های انتخاب‌شده است.

فایل‌های helpfile.dir و helpfile.pag توسط newhelp(1) ایجاد می‌شوند و فرض بر این است که از قبل وجود دارند.

بدون هیچ گزینه یا آرگومان‌های metricname، دستور chkhelp یکپارچگی ساختاری فایل‌های راهنما را بدون تولید خروجی اعتبارسنجی می‌کند.

اگر هرگونه آرگومان metricname مشخص شده باشد، تنها مدخل‌های راهنمای مربوط به همان معیارها پردازش خواهند شد.

اگر هیچ آرگومان metricnameی تعیین نشده باشد، باید حداقل یکی از گزینه‌های -i یا -p داده شود. گزینهٔ -i باعث پردازش مدخل‌های تمام دامنه‌های نمونه (instance domains) می‌شود (با نادیده گرفتن مدخل‌های معیارهای کارایی). گزینهٔ -p باعث نمایش مدخل‌های تمام معیارها می‌شود (با نادیده گرفتن مدخل‌های دامنه‌های نمونه).

هنگامی که مدخل‌های معیارها باید پردازش شوند (از طریق آرگومان‌های metricname یا گزینهٔ -p یا گزینهٔ -i)، گزینه‌های -O و -H به ترتیب درخواست نمایش متن راهنمای تک‌خطی و مفصل را می‌دهند. حالت پیش‌فرض -O است.

به‌طور معمول chkhelp بر روی فضای نام پیش‌فرض معیارهای کارایی (PMNS) عمل می‌کند؛ با این حال اگر گزینهٔ -n مشخص شده باشد، یک فضای نام جایگزین از فایل pmnsfile بارگذاری می‌شود.

گزینهٔ -e یک بررسی وجود را انجام می‌دهد که در آن تمام معیارهای تعیین‌شده از PMNS (توجه کنید، نه از helpfile) پیمایش شده، و فقط نام معیارهایی که هیچ متن راهنمایی برای آن‌ها وجود ندارد گزارش می‌شود. گزینهٔ -e با گزینه‌های -i و/یا -p مانعة‌الجمع است.

گزینه‌ها (OPTIONS)

گزینه‌های خط فرمان موجود عبارتند از:

-e

گزارش معیارهایی که فاقد متن راهنما هستند.

-H

نمایش متن راهنمای مفصل و خروج.

-i

پردازش تمام دامنه‌های نمونه (instance domains).

-n pmnsfile

بارگذاری یک فضای نام جایگزین معیارهای کارایی (PMNS(5)) از فایل pmnsfile.

-O

نمایش خلاصه راهنمای تک‌خطی.

-p

پردازش تمام معیارها (PMIDها).

-?

نمایش پیام نحوهٔ استفاده و خروج.

خطاها (DIAGNOSTICS)

دلایل گوناگونی وجود دارد که ممکن است یک پایگاه دادهٔ راهنما ناسازگار باشد؛ محتمل‌ترین دلیل این است که یک معیار کارایی در پایگاه داده، در PMNS بارگذاری‌شده تعریف نشده است.

محیط PCP (PCP ENVIRONMENT)

متغیرهای محیطی با پیشوند PCP_ برای تعیین پارامترهای نام فایل‌ها و دایرکتوری‌های استفاده‌شده توسط PCP به کار می‌روند. در هر نصب، فایل /etc/pcp.conf حاوی مقادیر محلی برای این متغیرها است. متغیر $PCP_CONF ممکن است برای تعیین یک فایل پیکربندی جایگزین استفاده شود، همان‌طور که در pcp.conf(5) شرح داده شده است.

برای متغیرهای محیطی مؤثر بر ابزارهای PCP، به pmGetOptions(3) مراجعه کنید.

گزینه‌های اشکال‌زدایی (DEBUGGING OPTIONS)

گزینهٔ -D یا --debug خروجی پیام‌های تشخیصی بیشتر را در stderr فعال می‌کند تا به ریشه‌یابی و بررسی مشکلات کمک کند، اگرچه این اطلاعات گاهی پیچیده بوده و اساساً به منظور راهنمایی برای توسعه‌دهندگان طراحی شده است تا کاربران نهایی. debug یک فهرست جداشده با کاما از گزینه‌های اشکال‌زدایی است؛ از pmdbg(1) همراه با گزینهٔ -l برای به‌دست آوردن فهرستی از گزینه‌های اشکال‌زدایی موجود و معانی آن‌ها استفاده کنید.

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

newhelp(1), PMAPI(3), pmLookupInDomText(3), pmLookupText(3), pcp.conf(5), pcp.env(5) و PMNS(5).